@tsed/adapters 8.11.1 → 8.11.2-rc.1

package/src/decorators/injectAdapter.spec.ts

@@ -1,292 +0,0 @@
-import {Injectable} from "@tsed/di";
-import {PlatformTest} from "@tsed/platform-http/testing";
-import {Name, Property} from "@tsed/schema";
-
-import {MemoryAdapter} from "../adapters/MemoryAdapter.js";
-import {Adapter} from "../domain/Adapter.js";
-import {adapter, InjectAdapter} from "./injectAdapter.js";
-
-describe("InjectAdapter", () => {
-  beforeEach(() => PlatformTest.create());
-  afterEach(() => PlatformTest.create());
-  describe("using decorator @InjectAdapter()", () => {
-    it("should inject adapter (model and collectionName)", async () => {
-      class Client {
-        @Property()
-        _id: string;
-
-        @Name("client_id")
-        clientId: string;
-      }
-
-      const stub = vi.fn();
-
-      @Injectable()
-      class Clients {
-        @InjectAdapter("client", Client)
-        adapter: Adapter<Client>;
-
-        $onInit() {
-          stub();
-        }
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(stub).toHaveBeenCalledWith();
-      expect(clients.adapter.collectionName).toBe("client");
-      expect(clients.adapter.model).toBe(Client);
-
-      const client = new Client();
-      client.clientId = "test";
-
-      await clients.adapter.create(client);
-
-      const items = (clients.adapter as MemoryAdapter<Client>).collection;
-      expect(items).toEqual([
-        {
-          _id: expect.any(String),
-          clientId: "test"
-        }
-      ]);
-    });
-    it("should inject adapter (model, collectionName and useAlias true)", async () => {
-      class Client {
-        @Property()
-        _id: string;
-
-        @Name("client_id")
-        clientId: string;
-      }
-
-      const stub = vi.fn();
-
-      @Injectable()
-      class Clients {
-        @InjectAdapter("client", Client, {useAlias: true})
-        adapter: Adapter<Client>;
-
-        $onInit() {
-          stub();
-        }
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(stub).toHaveBeenCalledWith();
-      expect(clients.adapter.collectionName).toBe("client");
-      expect(clients.adapter.model).toBe(Client);
-      expect(clients.adapter.useAlias).toEqual(true);
-
-      const client = new Client();
-      client.clientId = "test";
-
-      await clients.adapter.create(client);
-
-      const items = (clients.adapter as MemoryAdapter<Client>).collection;
-      expect(items).toEqual([
-        {
-          _id: expect.any(String),
-          client_id: "test"
-        }
-      ]);
-    });
-    it("should inject adapter (model only)", async () => {
-      class Client {}
-
-      @Injectable()
-      class Clients {
-        @InjectAdapter(Client)
-        adapter: Adapter<Client>;
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(clients.adapter.collectionName).toBe("Clients");
-      expect(clients.adapter.model).toBe(Client);
-    });
-    it("should inject adapter (model only 2)", async () => {
-      class Entity {}
-
-      @Injectable()
-      class Clients {
-        @InjectAdapter(Entity)
-        adapter: Adapter<Entity>;
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(clients.adapter.collectionName).toBe("Entities");
-      expect(clients.adapter.model).toBe(Entity);
-    });
-    it("should inject adapter (object)", async () => {
-      class Client {}
-
-      @Injectable()
-      class Clients {
-        @InjectAdapter({model: Client, indexes: {}})
-        adapter: Adapter<Client>;
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(clients.adapter.collectionName).toBe("Clients");
-      expect(clients.adapter.model).toBe(Client);
-    });
-    it("should inject adapter (without $onInit)", async () => {
-      class Client {}
-
-      @Injectable()
-      class Clients {
-        @InjectAdapter("client", Client)
-        adapter: Adapter<Client>;
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-    });
-  });
-  describe("using function adapter()", () => {
-    it("should inject adapter (model and collectionName)", async () => {
-      class Client {
-        @Property()
-        _id: string;
-
-        @Name("client_id")
-        clientId: string;
-      }
-
-      const stub = vi.fn();
-
-      @Injectable()
-      class Clients {
-        adapter = adapter("client", Client);
-
-        $onInit() {
-          stub();
-        }
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(stub).toHaveBeenCalledWith();
-      expect(clients.adapter.collectionName).toBe("client");
-      expect(clients.adapter.model).toBe(Client);
-
-      const client = new Client();
-      client.clientId = "test";
-
-      await clients.adapter.create(client);
-
-      const items = (clients.adapter as MemoryAdapter<Client>).collection;
-      expect(items).toEqual([
-        {
-          _id: expect.any(String),
-          clientId: "test"
-        }
-      ]);
-    });
-    it("should inject adapter (model, collectionName and useAlias true)", async () => {
-      class Client {
-        @Property()
-        _id: string;
-
-        @Name("client_id")
-        clientId: string;
-      }
-
-      const stub = vi.fn();
-
-      @Injectable()
-      class Clients {
-        adapter = adapter("client", Client, {useAlias: true});
-
-        $onInit() {
-          stub();
-        }
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(stub).toHaveBeenCalledWith();
-      expect(clients.adapter.collectionName).toBe("client");
-      expect(clients.adapter.model).toBe(Client);
-      expect(clients.adapter.useAlias).toEqual(true);
-
-      const client = new Client();
-      client.clientId = "test";
-
-      await clients.adapter.create(client);
-
-      const items = (clients.adapter as MemoryAdapter<Client>).collection;
-      expect(items).toEqual([
-        {
-          _id: expect.any(String),
-          client_id: "test"
-        }
-      ]);
-    });
-    it("should inject adapter (model only)", async () => {
-      class Client {}
-
-      @Injectable()
-      class Clients {
-        adapter = adapter(Client);
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(clients.adapter.collectionName).toBe("Clients");
-      expect(clients.adapter.model).toBe(Client);
-    });
-    it("should inject adapter (model only 2)", async () => {
-      class Entity {}
-
-      @Injectable()
-      class Clients {
-        adapter: Adapter<Entity> = adapter(Entity);
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(clients.adapter.collectionName).toBe("Entities");
-      expect(clients.adapter.model).toBe(Entity);
-    });
-    it("should inject adapter (object)", async () => {
-      class Client {}
-
-      @Injectable()
-      class Clients {
-        adapter = adapter({model: Client, indexes: {}});
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-      expect(clients.adapter.collectionName).toBe("Clients");
-      expect(clients.adapter.model).toBe(Client);
-    });
-    it("should inject adapter (without $onInit)", async () => {
-      class Client {}
-
-      @Injectable()
-      class Clients {
-        adapter = adapter("client", Client);
-      }
-
-      const clients = await PlatformTest.invoke<Clients>(Clients);
-
-      expect(clients.adapter).toBeInstanceOf(MemoryAdapter);
-    });
-  });
-});

package/src/decorators/injectAdapter.ts

@@ -1,62 +0,0 @@
-import {classOf, isClass, isString, Type} from "@tsed/core";
-import {Inject, inject} from "@tsed/di";
-
-import type {Adapter} from "../domain/Adapter.js";
-import {AdapterInvokeOptions, Adapters} from "../services/Adapters.js";
-
-function mapOptions(args: any[]): AdapterInvokeOptions {
-  return args.reduce((options: AdapterInvokeOptions, item, index) => {
-    if (isString(item)) {
-      return {
-        ...options,
-        collectionName: item
-      };
-    }
-
-    if (isClass(item) && classOf(item) !== Object) {
-      return {
-        ...options,
-        model: item
-      };
-    }
-
-    return {...options, ...item};
-  }, {});
-}
-
-export function adapter<Model>(options: AdapterInvokeOptions<Model>): Adapter<Model>;
-export function adapter<Model>(model: Type<Model>, options?: Partial<Omit<AdapterInvokeOptions, "client">>): Adapter<Model>;
-export function adapter<Model>(
-  collectionName: string,
-  model: Type<Model>,
-  options?: Partial<Omit<AdapterInvokeOptions, "collectionName" | "client">>
-): Adapter<Model>;
-export function adapter(...args: any[]) {
-  const options: AdapterInvokeOptions = mapOptions(args);
-  const adapters = inject(Adapters);
-
-  return adapters.invokeAdapter(options);
-}
-
-/**
- * Inject the adapter in the property.
- * @param options
- * @constructor
- */
-export function InjectAdapter(options: AdapterInvokeOptions): PropertyDecorator;
-export function InjectAdapter(model: Type<any>, options?: Partial<Omit<AdapterInvokeOptions, "client">>): PropertyDecorator;
-export function InjectAdapter(
-  collectionName: string,
-  model: Type<any>,
-  options?: Partial<Omit<AdapterInvokeOptions, "collectionName" | "client">>
-): PropertyDecorator;
-export function InjectAdapter(...args: any[]): PropertyDecorator {
-  const options: AdapterInvokeOptions = mapOptions(args);
-  const symbol = Symbol();
-
-  return Inject(Adapters, {
-    transform: (adapters: Adapters, {self}) => {
-      return (self[symbol] = self[symbol] || adapters.invokeAdapter(options));
-    }
-  });
-}

package/src/domain/Adapter.ts

@@ -1,114 +0,0 @@
-import {AjvService} from "@tsed/ajv";
-import {classOf, isArray, isPlainObject, nameOf, Type} from "@tsed/core";
-import {Configuration, Inject, Opts} from "@tsed/di";
-import {deserialize, JsonDeserializerOptions, JsonSerializerOptions, serialize} from "@tsed/json-mapper";
-import {getPropertiesStores} from "@tsed/schema";
-
-export interface AdapterConstructorOptions<T = any> extends Record<string, any> {
-  model: Type<T> | Object;
-  collectionName?: string;
-  useAlias?: string;
-  indexes?: {
-    [propertyKey: string]: Record<string, any>;
-  };
-}
-
-function getIndexes(model: any) {
-  return [...getPropertiesStores(model).entries()]
-    .filter(([, entity]) => entity.store.has("adapter:indexed"))
-    .map(([propertyKey, entity]) => {
-      return {
-        propertyKey: String(propertyKey),
-        options: entity.store.get("adapter:indexed")
-      };
-    });
-}
-
-function mapIndexes(indexes: {[p: string]: Record<string, any>} | {propertyKey: string; options: any}[]) {
-  return Object.entries(indexes).reduce((indexes: any[], [propertyKey, options]) => {
-    return indexes.concat({
-      propertyKey,
-      options
-    });
-  }, []);
-}
-
-function pluralize(name: string) {
-  return name.slice(-1) === "y" ? `${name.slice(0, name.length - 1)}ies` : name + "s";
-}
-
-export abstract class Adapter<Model = any> {
-  readonly model: Type<Model> | Object;
-  readonly collectionName: string;
-  readonly indexes: {propertyKey: string; options: any}[];
-  readonly useAlias: boolean = false;
-
-  @Inject()
-  protected ajvService: AjvService;
-
-  constructor(
-    @Opts options: AdapterConstructorOptions,
-    @Configuration() protected configuration: Configuration
-  ) {
-    this.model = options.model;
-    this.collectionName = options.collectionName || pluralize(nameOf(options.model));
-
-    let indexes = options.indexes || configuration.get(`adapters.${this.collectionName}.indexes`) || getIndexes(this.model);
-
-    if (!isArray(indexes)) {
-      indexes = mapIndexes(indexes);
-    }
-
-    this.indexes = indexes;
-    this.useAlias = !!options.useAlias;
-  }
-
-  async validate(value: Model): Promise<void> {
-    if (this.getModel()) {
-      await this.ajvService.validate(this.serialize(value), {
-        useAlias: this.useAlias,
-        type: this.model
-      });
-    }
-  }
-
-  abstract create(value: Partial<Omit<Model, "_id">>, expiresAt?: Date): Promise<Model>;
-
-  abstract update(id: string, value: Model, expiresAt?: Date): Promise<Model | undefined>;
-
-  abstract updateOne(predicate: Partial<Model>, value: Partial<Model>, expiresAt?: Date): Promise<Model | undefined>;
-
-  abstract upsert(id: string, value: Model, expiresAt?: Date): Promise<Model>;
-
-  abstract findOne(predicate: Partial<Model>): Promise<Model | undefined>;
-
-  abstract findById(id: string): Promise<Model | undefined>;
-
-  abstract findAll(predicate?: Partial<Model>): Promise<Model[]>;
-
-  abstract deleteOne(predicate: Partial<Model>): Promise<Model | undefined>;
-
-  abstract deleteMany(predicate: Partial<Model>): Promise<Model[]>;
-
-  abstract deleteById(id: string): Promise<Model | undefined>;
-
-  getModel() {
-    return (this.model as unknown) !== Object ? this.model : undefined;
-  }
-
-  protected deserialize(obj: any, opts?: JsonDeserializerOptions) {
-    return deserialize(obj, {
-      useAlias: this.useAlias,
-      ...opts,
-      type: this.getModel()
-    });
-  }
-
-  protected serialize(obj: any, opts?: JsonSerializerOptions) {
-    return serialize(obj, {
-      useAlias: this.useAlias,
-      ...opts,
-      type: isPlainObject(obj) ? this.getModel() : classOf(obj)
-    });
-  }
-}

package/src/domain/AdaptersSettings.ts

@@ -1,29 +0,0 @@
-import {Type} from "@tsed/core";
-
-import {Adapter} from "./Adapter.js";
-
-export interface AdaptersSettings {
-  /**
-   * Injectable service to manage database connexion
-   */
-  Adapter?: Type<Adapter>;
-  /**
-   *
-   */
-  lowdbDir?: string;
-  /**
-   * Use the connection name for the RedisAdapter.
-   */
-  connectionName?: string;
-
-  [key: string]: any;
-}
-
-declare global {
-  namespace TsED {
-    interface Configuration {
-      // @ts-ignore
-      adapters: AdaptersSettings;
-    }
-  }
-}

package/src/index.ts

@@ -1,11 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./adapters/FileSyncAdapter.js";
-export * from "./adapters/LowDbAdapter.js";
-export * from "./adapters/MemoryAdapter.js";
-export * from "./decorators/indexed.js";
-export * from "./decorators/injectAdapter.js";
-export * from "./domain/Adapter.js";
-export * from "./domain/AdaptersSettings.js";
-export * from "./services/Adapters.js";

package/src/services/Adapters.ts

@@ -1,21 +0,0 @@
-import {Type} from "@tsed/core";
-import {constant, inject, injectable} from "@tsed/di";
-
-import {MemoryAdapter} from "../adapters/MemoryAdapter.js";
-import {Adapter, AdapterConstructorOptions} from "../domain/Adapter.js";
-
-export interface AdapterInvokeOptions<Model = any> extends AdapterConstructorOptions<Model> {
-  adapter?: Type<Adapter<Model>>;
-}
-
-export class Adapters {
-  invokeAdapter<T = any>(options: AdapterInvokeOptions): Adapter<T> {
-    const {adapter = constant("adapters.Adapter", MemoryAdapter), ...props} = options;
-
-    return inject<Adapter<T>>(adapter, {
-      useOpts: props
-    });
-  }
-}
-
-injectable(Adapters);

package/vitest.config.mts

@@ -1,21 +0,0 @@
-// @ts-ignore
-import {presets} from "@tsed/vitest/presets";
-import {defineConfig} from "vitest/config";
-
-export default defineConfig(
-  {
-    ...presets,
-    test: {
-      ...presets.test,
-      coverage: {
-        ...presets.test.coverage,
-        thresholds: {
-          statements: 0,
-          branches: 0,
-          functions: 0,
-          lines: 0
-        }
-      }
-    }
-  }
-);