refactor!: explicitly set resource name

Author: alexzarbn

package-lock.json

@@ -29,21 +29,18 @@
 		"@types/jest": "^26.0.20",
 		"@typescript-eslint/eslint-plugin": "^4.19.0",
 		"@typescript-eslint/parser": "^4.19.0",
+		"change-case": "^4.1.2",
 		"eslint": "^7.22.0",
 		"eslint-config-prettier": "^8.1.0",
 		"jest": "^26.6.3",
-		"lodash.camelcase": "^4.3.0",
 		"miragejs": "^0.1.41",
 		"prettier": "2.2.1",
 		"rimraf": "^2.6.2",
 		"ts-jest": "^26.5",
 		"typescript": "^4.2"
 	},
 	"dependencies": {
-		"@types/pluralize": "^0.0.29",
-		"axios": "^0.21.1",
-		"change-case": "^4.1.2",
-		"pluralize": "^8.0.0"
+		"axios": "^0.21.1"
 	},
 	"bugs": {
 		"url": "https://github.com/tailflow/laravel-orion-ts/issues"

package.json

@@ -14,7 +14,7 @@ export class UrlBuilder {
 		Relations = ExtractModelRelationsType<M>,
 		Key = ExtractModelKeyType<M>
 	>(model: ModelConstructor<M, Attributes, PersistedAttributes, Relations, Key>): string {
-		return Orion.getApiUrl() + '/' + (model.prototype as M).$getResourceName();
+		return Orion.getApiUrl() + '/' + (model.prototype as M).$resource();
 	}
 
 	public static getResourceUrl<M extends Model>(model: Model): string {
@@ -35,9 +35,7 @@ export class UrlBuilder {
 		relationConstructor: ModelConstructor<R, Attributes, PersistedAttributes, Relations, Key>
 	): string {
 		return (
-			UrlBuilder.getResourceUrl(parent) +
-			'/' +
-			(relationConstructor.prototype as R).$getResourceName()
+			UrlBuilder.getResourceUrl(parent) + '/' + (relationConstructor.prototype as R).$resource()
 		);
 	}
 }

src/builders/urlBuilder.ts

@@ -1,6 +1,4 @@
 import { QueryBuilder } from './drivers/default/builders/queryBuilder';
-import pluralize from 'pluralize';
-import { noCase, snakeCase } from 'change-case';
 import { ModelConstructor } from './contracts/modelConstructor';
 import { AxiosResponse } from 'axios';
 import { DefaultPersistedAttributes } from './types/defaultPersistedAttributes';
@@ -30,6 +28,8 @@ export abstract class Model<
 		}
 	}
 
+	public abstract $resource(): string;
+
 	public static $query<M extends Model>(this: ModelConstructor<M>): QueryBuilder<M> {
 		return new QueryBuilder<M>(this);
 	}
@@ -97,11 +97,7 @@ export abstract class Model<
 		return this.$getKey() === model.$getKey();
 	}
 
-	public $getResourceName(): string {
-		return snakeCase(pluralize(noCase(this.constructor.name)));
-	}
-
-	protected $init() {
+	protected $init(): void {
 		if (!this.$attributes) {
 			this.$attributes = {} as AllAttributes;
 		}

src/model.ts

@@ -12,6 +12,10 @@ export default class Post extends Model<
 		user: User;
 	}
 > {
+	$resource(): string {
+		return 'posts';
+	}
+
 	public user(): BelongsTo<User> {
 		return new BelongsTo(User, this);
 	}

tests/stubs/models/post.ts

@@ -5,6 +5,10 @@ import { BelongsToMany } from '../../../src/drivers/default/relations/belongsToM
 export default class Tag extends Model<{
 	content: string;
 }> {
+	$resource(): string {
+		return 'tags';
+	}
+
 	public posts(): BelongsToMany<Post> {
 		return new BelongsToMany(Post, this);
 	}

tests/stubs/models/tag.ts

@@ -2,4 +2,8 @@ import { Model } from '../../../src/model';
 
 export default class User extends Model<{
 	name: string;
-}> {}
+}> {
+	$resource(): string {
+		return 'users';
+	}
+}

tests/stubs/models/user.ts

@@ -19,6 +19,6 @@ describe('Model tests', () => {
 	});
 
 	test('getting resource name', () => {
-		expect(Post.prototype.$getResourceName()).toBe('posts');
+		expect(Post.prototype.$resource()).toBe('posts');
 	});
 });