refactor: rename resource module to rest crud module

Author: Char2sGu

scripts/rename.js

@@ -0,0 +1,19 @@
+const fs = require("fs");
+const pathLib = require("path");
+
+function rename(dirPath, replaceFrom, replaceTo) {
+  const names = fs.readdirSync(dirPath);
+  names.forEach((name) => {
+    const path = pathLib.join(dirPath, name);
+    const stat = fs.statSync(path);
+    const newPath = pathLib.join(dirPath, name.replace(replaceFrom, replaceTo));
+    if (path == newPath) return;
+    if (stat.isDirectory()) rename(path, replaceFrom, replaceTo);
+    console.debug(`${path} -> ${newPath}`);
+    fs.renameSync(path, newPath);
+  });
+}
+
+const [, , ...args] = process.argv;
+
+rename(...args);

src/file/file-record.adapter.ts

@@ -1,12 +1,12 @@
 import * as orm from "@deepkit/orm"; // temporary workaround: we have to use namespace import here as a temporary workaround, otherwise the application will not be able to bootstrap
 import { RequestContext } from "src/core/request-context";
 import { InjectDatabaseSession } from "src/database/database.tokens";
-import { ResourceCrudAdapter } from "src/resource/resource-crud-adapter.interface";
+import { RestCrudAdapter } from "src/rest-crud/rest-crud-crud-adapter.interface";
 import { User } from "src/user/user.entity";
 
 import { FileRecord } from "./file-record.entity";
 
-export class FileRecordAdapter implements ResourceCrudAdapter<FileRecord> {
+export class FileRecordAdapter implements RestCrudAdapter<FileRecord> {
   constructor(
     private db: InjectDatabaseSession,
     private context: RequestContext,

src/file/file.controller.ts

@@ -15,13 +15,13 @@ import { HttpRangeParser } from "src/common/http-range-parser.service";
 import { RequestContext } from "src/core/request-context";
 import { InjectDatabaseSession } from "src/database/database.tokens";
 import { FileEngine } from "src/file-engine/file-engine.interface";
-import { ResourceFilterMapFactory } from "src/resource/models/resource-filter-map-factory";
+import { RestCrudFilterMapFactory } from "src/rest-crud/models/rest-crud-filter-map-factory";
 import {
   ResourceList,
   ResourcePagination,
-} from "src/resource/models/resource-list";
-import { ResourceOrderMap } from "src/resource/models/resource-order-map";
-import { ResourceCrudHandler } from "src/resource/resource-crud-handler.service";
+} from "src/rest-crud/models/rest-crud-list";
+import { ResourceOrderMap } from "src/rest-crud/models/rest-crud-order-map";
+import { ResourceCrudHandler } from "src/rest-crud/rest-crud-crud-handler.service";
 import { User } from "src/user/user.entity";
 
 import { FileRecord } from "./file-record.entity";
@@ -168,7 +168,7 @@ export class FileController {
 }
 
 const models = {
-  filter: ResourceFilterMapFactory.build<FileRecord>([]),
+  filter: RestCrudFilterMapFactory.build<FileRecord>([]),
 };
 
 interface FileRecordListParameters {

src/file/file.module.ts

@@ -1,6 +1,6 @@
 import { createModule } from "@deepkit/app";
 import { HttpRangeParser } from "src/common/http-range-parser.service";
-import { ResourceModule } from "src/resource/resource.module";
+import { ResourceModule } from "src/rest-crud/resource.module";
 
 import { FileController } from "./file.controller";
 import { FileRecordAdapter } from "./file-record.adapter";

src/resource/resource.module.ts

@@ -7,9 +7,9 @@ import {
   ReflectionProperty,
 } from "@deepkit/type";
 
-import { ResourceFilterMapFactory } from "./resource-filter-map-factory";
+import { RestCrudFilterMapFactory } from "./rest-crud-filter-map-factory";
 
-describe("ResourceFilterMapFactory", () => {
+describe("RestCrudFilterMapFactory", () => {
   class MyEntity {
     id: number & AutoIncrement & PrimaryKey = 0;
     ref1!: MyEntity & Reference;
@@ -19,7 +19,7 @@ describe("ResourceFilterMapFactory", () => {
   }
 
   it("should work", async () => {
-    const s = ResourceFilterMapFactory.build<MyEntity>("all", "include");
+    const s = RestCrudFilterMapFactory.build<MyEntity>("all", "include");
     expect(s.getPropertyNames()).toEqual(["id", "ref1"]);
     expectOperatorMap(s.getProperty("id"), ReflectionKind.number);
     expectOperatorMap(s.getProperty("ref1"), ReflectionKind.number);

src/resource/models/resource-filter-map-factory.spec.ts renamed to src/rest-crud/models/rest-crud-filter-map-factory.spec.ts

@@ -10,10 +10,10 @@ import {
 
 import {
   AddPropertyOptions,
-  ResourceQueryModelFactory,
-} from "./resource-query-model-factory";
+  RestCrudQueryModelFactory,
+} from "./rest-crud-query-model-factory";
 
-export class ResourceFilterMapFactory extends ResourceQueryModelFactory {
+export class RestCrudFilterMapFactory extends RestCrudQueryModelFactory {
   static override build<Entity>(
     fields: FilterableField<Entity>[] | "all",
     strategy?: "include" | "exclude",
@@ -46,7 +46,7 @@ export class ResourceFilterMapFactory extends ResourceQueryModelFactory {
       : fieldSchema;
     return {
       name: fieldSchema.name,
-      type: ResourceFilterMapFactory.buildOperatorMap(fieldSchemaToUse),
+      type: RestCrudFilterMapFactory.buildOperatorMap(fieldSchemaToUse),
       optional: true,
     };
   }

src/resource/models/resource-filter-map-factory.ts renamed to src/rest-crud/models/rest-crud-filter-map-factory.ts

@@ -1,8 +1,8 @@
 import { FieldName, QuerySelector } from "@deepkit/orm";
 
-import { ResourceFilterMapFactory } from "./resource-filter-map-factory";
+import { RestCrudFilterMapFactory } from "./rest-crud-filter-map-factory";
 
-export type ResourceFilterOperator = Extract<
+export type RestCrudFilterOperator = Extract<
   keyof QuerySelector<unknown>,
   | "$eq"
   | "$gt"
@@ -16,26 +16,26 @@ export type ResourceFilterOperator = Extract<
   | "$regex"
 >;
 
-export type ResourceFilterOperatorMultiValue = Extract<
-  ResourceFilterOperator,
+export type RestCrudFilterOperatorMultiValue = Extract<
+  RestCrudFilterOperator,
   "$in" | "$nin"
 >;
 
 // jsdoc link
 // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-ResourceFilterMapFactory;
+RestCrudFilterMapFactory;
 
 /**
- * @deprecated - Use {@link ResourceFilterMapFactory} instead. It's
+ * @deprecated - Use {@link RestCrudFilterMapFactory} instead. It's
  * impossible to implement relation field filtering via pure-types because
  * DeepKit removes the types of type-decorators at runtime.
  */
-export type ResourceFilterMap<
+export type RestCrudFilterMap<
   Entity,
   Field extends FieldName<Entity> = FieldName<Entity>,
 > = {
   [Key in Field]?: {
-    [Operator in ResourceFilterOperator]?: Operator extends ResourceFilterOperatorMultiValue
+    [Operator in RestCrudFilterOperator]?: Operator extends RestCrudFilterOperatorMultiValue
       ? Entity[Key][]
       : Entity[Key];
   };

src/resource/models/resource-filter-map.ts renamed to src/rest-crud/models/rest-crud-filter-map.ts

@@ -1,11 +1,11 @@
 import { Positive, PositiveNoZero } from "@deepkit/type";
 
-export interface ResourceList<Entity> {
+export interface RestCrudList<Entity> {
   total: number;
   items: Entity[];
 }
 
-export interface ResourcePagination {
+export interface RestCrudPagination {
   limit: number & PositiveNoZero;
   offset: number & Positive;
 }

src/resource/models/resource-list.ts renamed to src/rest-crud/models/rest-crud-list.ts

@@ -1,10 +1,10 @@
 import { FieldName } from "@deepkit/orm";
 
-export type ResourceOrder = "asc" | "desc";
+export type RestCrudOrder = "asc" | "desc";
 
-export type ResourceOrderMap<
+export type RestCrudOrderMap<
   Entity,
   Field extends FieldName<Entity> = FieldName<Entity>,
 > = {
-  [Key in Field]?: ResourceOrder;
+  [Key in Field]?: RestCrudOrder;
 };

src/resource/models/resource-order-map.ts renamed to src/rest-crud/models/rest-crud-order-map.ts

@@ -7,11 +7,11 @@ import {
 
 import {
   AddPropertyOptions,
-  ResourceQueryModelFactory,
-} from "./resource-query-model-factory";
+  RestCrudQueryModelFactory,
+} from "./rest-crud-query-model-factory";
 
-describe("ResourceQueryModelFactory", () => {
-  class TestingFactory extends ResourceQueryModelFactory {
+describe("RestCrudQueryModelFactory", () => {
+  class TestingFactory extends RestCrudQueryModelFactory {
     protected static override selectValidFields<Entity>(
       entitySchema: ReflectionClass<any>,
     ): FieldName<Entity>[] {

src/resource/models/resource-query-model-factory.spec.ts renamed to src/rest-crud/models/rest-crud-query-model-factory.spec.ts

@@ -6,9 +6,9 @@ import {
   ReflectionProperty,
 } from "@deepkit/type";
 
-class ResourceQueryModel {}
+class RestCrudQueryModel {}
 
-export abstract class ResourceQueryModelFactory {
+export abstract class RestCrudQueryModelFactory {
   protected constructor() {}
 
   static build<Entity>(
@@ -17,7 +17,7 @@ export abstract class ResourceQueryModelFactory {
     entityType?: ReceiveType<Entity>,
   ): ReflectionClass<any> {
     const entitySchema = ReflectionClass.from(entityType);
-    const modelSchema = ReflectionClass.from(ResourceQueryModel).clone();
+    const modelSchema = ReflectionClass.from(RestCrudQueryModel).clone();
     fields = this.selectFields(entitySchema, fields, strategy);
     fields.forEach((field) => {
       const fieldSchema = entitySchema.getProperty(field);

src/resource/models/resource-query-model-factory.ts renamed to src/rest-crud/models/rest-crud-query-model-factory.ts

@@ -1,5 +1,5 @@
 import * as orm from "@deepkit/orm"; // We have to use namespace import here as a temporary workaround, otherwise the application will not be able to bootstrap. This will be fixed in the next release.
 
-export abstract class ResourceCrudAdapter<Entity> {
+export abstract class RestCrudAdapter<Entity> {
   abstract query(): orm.Query<Entity>;
 }

src/resource/resource-crud-adapter.interface.ts renamed to src/rest-crud/rest-crud-crud-adapter.interface.ts

@@ -5,14 +5,14 @@ import { FieldName, FilterQuery } from "@deepkit/orm";
 import { ReflectionClass, TypeClass } from "@deepkit/type";
 import { appendFilter } from "src/common/orm";
 
-import { ResourceList, ResourcePagination } from "./models/resource-list";
-import { ResourceOrderMap } from "./models/resource-order-map";
-import { ResourceCrudAdapter } from "./resource-crud-adapter.interface";
+import { RestCrudList, RestCrudPagination } from "./models/rest-crud-list";
+import { RestCrudOrderMap } from "./models/rest-crud-order-map";
+import { RestCrudAdapter } from "./rest-crud-crud-adapter.interface";
 
-export class ResourceCrudHandler<Entity> {
+export class RestCrudHandler<Entity> {
   private adapterSchema;
   private entitySchema;
-  constructor(private adapter: ResourceCrudAdapter<Entity>) {
+  constructor(private adapter: RestCrudAdapter<Entity>) {
     const adapterClassType = adapter.constructor as ClassType<typeof adapter>;
     this.adapterSchema = ReflectionClass.from(adapterClassType);
     const adapterType = this.adapterSchema.type as TypeClass;
@@ -21,8 +21,8 @@ export class ResourceCrudHandler<Entity> {
   }
 
   async list(
-    { pagination, filter, order }: ResourceListingOptions<Entity>, //
-  ): Promise<ResourceList<Entity>> {
+    { pagination, filter, order }: RestCrudListingOptions<Entity>, //
+  ): Promise<RestCrudList<Entity>> {
     let query = this.adapter.query();
     if (filter) query = this.applyFilterMap(query, filter);
     const total = await query.count();
@@ -42,7 +42,7 @@ export class ResourceCrudHandler<Entity> {
 
   applyPagination(
     query: orm.Query<Entity>,
-    { limit, offset }: ResourcePagination,
+    { limit, offset }: RestCrudPagination,
   ): orm.Query<Entity> {
     if (limit) query = query.limit(limit);
     if (offset) query = query.skip(offset);
@@ -74,7 +74,7 @@ export class ResourceCrudHandler<Entity> {
 
   applyOrderMap<Entity>(
     query: orm.Query<Entity>,
-    orderMap: ResourceOrderMap<Entity, any>,
+    orderMap: RestCrudOrderMap<Entity, any>,
   ): orm.Query<Entity> {
     Object.entries(orderMap).forEach(([field, order]) => {
       query = query.orderBy(field as FieldName<Entity>, order);
@@ -83,8 +83,8 @@ export class ResourceCrudHandler<Entity> {
   }
 }
 
-export interface ResourceListingOptions<Entity> {
-  pagination: ResourcePagination;
+export interface RestCrudListingOptions<Entity> {
+  pagination: RestCrudPagination;
   filter?: object;
-  order?: ResourceOrderMap<Entity>;
+  order?: RestCrudOrderMap<Entity>;
 }

src/resource/resource-crud-handler.service.ts renamed to src/rest-crud/rest-crud-crud-handler.service.ts

@@ -0,0 +1,26 @@
+import { createModule } from "@deepkit/app";
+import { ClassType } from "@deepkit/core";
+
+import { RestCrudAdapter } from "./rest-crud-crud-adapter.interface";
+import { RestCrudHandler } from "./rest-crud-crud-handler.service";
+
+export class RestCrudModule<Entity> extends createModule({
+  providers: [{ provide: RestCrudHandler, scope: "http" }],
+  exports: [RestCrudHandler],
+}) {
+  adapter?: ClassType<RestCrudAdapter<Entity>>;
+
+  withAdapter(adapter: this["adapter"]): this {
+    this.adapter = adapter;
+    return this;
+  }
+
+  override process(): void {
+    if (!this.adapter) throw new Error("Adapter not specified");
+    this.addProvider({
+      provide: RestCrudAdapter,
+      useClass: this.adapter,
+      scope: "http",
+    });
+  }
+}