@e22m4u/js-repository 0.8.0 → 0.8.2

package/src/repository/repository.d.ts

@@ -0,0 +1,183 @@
+import {ModelId} from '../types.js';
+import {Flatten} from '../types.js';
+import {ModelData} from '../types.js';
+import {PartialBy} from '../types.js';
+import {Service} from '@e22m4u/js-service';
+import {Adapter} from '../adapter/index.js';
+import {WhereClause} from '../filter/index.js';
+import {FilterClause} from '../filter/index.js';
+import {ItemFilterClause} from '../filter/index.js';
+import {ServiceContainer} from '@e22m4u/js-service';
+import {DEFAULT_PRIMARY_KEY_PROPERTY_NAME} from '../definition/index.js';
+
+/**
+ * Repository.
+ */
+export declare class Repository<
+  Data extends object = ModelData,
+  IdType extends ModelId = ModelId,
+  IdName extends string = typeof DEFAULT_PRIMARY_KEY_PROPERTY_NAME,
+  FlatData extends object = Flatten<Data>,
+> extends Service {
+  // it fixes unused generic bug
+  private _Data?: Data;
+  private _IdType?: IdType;
+  private _IdName?: IdName;
+  private _FlatData?: FlatData;
+
+  /**
+   * Model name.
+   */
+  get modelName(): string;
+
+  /**
+   * Datasource name.
+   */
+  get datasourceName(): string;
+
+  /**
+   * Constructor.
+   *
+   * @param container
+   * @param modelName
+   */
+  constructor(container: ServiceContainer, modelName: string);
+
+  /**
+   * Get adapter.
+   */
+  getAdapter(): Promise<Adapter>;
+
+  /**
+   * Create.
+   *
+   * @param data
+   * @param filter
+   */
+  create(
+    data: WithOptionalId<FlatData, IdName>,
+    filter?: ItemFilterClause<FlatData>,
+  ): Promise<FlatData>;
+
+  /**
+   * Replace by id.
+   *
+   * @param id
+   * @param data
+   * @param filter
+   */
+  replaceById(
+    id: IdType,
+    data: WithoutId<FlatData, IdName>,
+    filter?: ItemFilterClause<FlatData>,
+  ): Promise<FlatData>;
+
+  /**
+   * Replace or create.
+   *
+   * @param data
+   * @param filter
+   */
+  replaceOrCreate(
+    data: WithOptionalId<FlatData, IdName>,
+    filter?: ItemFilterClause<FlatData>,
+  ): Promise<FlatData>;
+
+  /**
+   * Patch.
+   *
+   * @param data
+   * @param where
+   */
+  patch(
+    data: PartialWithoutId<FlatData, IdName>,
+    where?: WhereClause<FlatData>,
+  ): Promise<number>;
+
+  /**
+   * Patch by id.
+   *
+   * @param id
+   * @param data
+   * @param filter
+   */
+  patchById(
+    id: IdType,
+    data: PartialWithoutId<FlatData, IdName>,
+    filter?: ItemFilterClause<FlatData>,
+  ): Promise<FlatData>;
+
+  /**
+   * Find.
+   *
+   * @param filter
+   */
+  find(filter?: FilterClause<FlatData>): Promise<FlatData[]>;
+
+  /**
+   * Find one.
+   *
+   * @param filter
+   */
+  findOne(filter?: FilterClause<FlatData>): Promise<FlatData | undefined>;
+
+  /**
+   * Find by id.
+   *
+   * @param id
+   * @param filter
+   */
+  findById(id: IdType, filter?: ItemFilterClause<FlatData>): Promise<FlatData>;
+
+  /**
+   * Delete.
+   *
+   * @param where
+   */
+  delete(where?: WhereClause<FlatData>): Promise<number>;
+
+  /**
+   * Delete by id.
+   *
+   * @param id
+   */
+  deleteById(id: IdType): Promise<boolean>;
+
+  /**
+   * Exists.
+   *
+   * @param id
+   */
+  exists(id: IdType): Promise<boolean>;
+
+  /**
+   * Count.
+   *
+   * @param where
+   */
+  count(where?: WhereClause<FlatData>): Promise<number>;
+}
+
+/**
+ * Removes id field.
+ */
+export declare type WithoutId<
+  Data extends object,
+  IdName extends string = 'id',
+> = Flatten<Omit<Data, IdName>>;
+
+/**
+ * Makes fields as optional and remove id field.
+ */
+export declare type PartialWithoutId<
+  Data extends object,
+  IdName extends string = 'id',
+> = Flatten<Partial<Omit<Data, IdName>>>;
+
+/**
+ * Makes the required id field as optional.
+ */
+export declare type WithOptionalId<
+  Data extends object,
+  IdName extends string = 'id',
+> = Flatten<Data extends {[K in IdName]: any} ? PartialBy<Data, IdName> : Data>;

package/src/types.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Free-form object with open properties.
+ */
+export declare type AnyObject = {
+  [property: string]: unknown;
+};
+
+/**
+ * Makes specific field as optional.
+ */
+export declare type PartialBy<T, K extends keyof T> = Omit<T, K> &
+  Partial<Pick<T, K>>;
+
+/**
+ * Model data.
+ */
+export declare type ModelData = Record<string, unknown>;
+
+/**
+ * Model id.
+ */
+export declare type ModelId = unknown;
+
+/**
+ * Flatten.
+ */
+type Identity<T> = T;
+export declare type Flatten<T> = Identity<{[k in keyof T]: T[k]}>;
+
+/**
+ * A callable type with the "new" operator
+ * allows class and constructor.
+ */
+export interface Constructor<T = unknown> {
+  new (...args: any[]): T;
+}
+
+/**
+ * Representing a value or promise. This type is used
+ * to represent results of synchronous/asynchronous
+ * resolution of values.
+ */
+export type ValueOrPromise<T> = T | PromiseLike<T>;

package/src/types.js

@@ -0,0 +1 @@
+export {};

package/src/utils/capitalize.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Capitalize.
+ *
+ * @param string
+ */
+export declare function capitalize(string: string): string;

package/src/utils/clone-deep.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Clone deep.
+ *
+ * @param value
+ */
+export declare function cloneDeep<T>(value: T): T;

package/src/utils/exclude-object-keys.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Exclude object keys.
+ *
+ * @param obj
+ * @param keys
+ */
+export declare function excludeObjectKeys<T extends object>(
+  obj: T,
+  keys: string | string[],
+): Partial<T>;

package/src/utils/get-value-by-path.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Get value by path.
+ *
+ * @param obj
+ * @param path
+ * @param orElse
+ */
+export declare function getValueByPath(
+  obj: object,
+  path: string,
+  orElse?: unknown,
+): unknown;

package/src/utils/index.d.ts

@@ -0,0 +1,12 @@
+export * from './is-promise.js';
+export * from './capitalize.js';
+export * from './clone-deep.js';
+export * from './singularize.js';
+export * from './is-deep-equal.js';
+export * from './like-to-regexp.js';
+export * from './is-plain-object.js';
+export * from './string-to-regexp.js';
+export * from './get-value-by-path.js';
+export * from './select-object-keys.js';
+export * from './exclude-object-keys.js';
+export * from './model-name-to-model-key.js';

package/src/utils/is-deep-equal.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Is deep equal.
+ *
+ * @param firstValue
+ * @param secondValue
+ */
+export declare function isDeepEqual(
+  firstValue: unknown,
+  secondValue: unknown,
+): boolean;

package/src/utils/is-plain-object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Is plain object.
+ *
+ * @param value
+ */
+export declare function isPlainObject(value: unknown): boolean;

package/src/utils/is-promise.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Check whether a value is a Promise-like
+ * instance. Recognizes both native promises
+ * and third-party promise libraries.
+ *
+ * @param value
+ */
+export declare function isPromise<T>(
+  value: T | PromiseLike<T> | undefined
+): value is PromiseLike<T>;

package/src/utils/like-to-regexp.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Преобразует SQL LIKE-шаблон в объект RegExp.
+ *
+ * Экранирует специальные символы регулярных выражений,
+ * чтобы они обрабатывались как обычные символы, и преобразует
+ * SQL wildcards (% и _) в их эквиваленты в регулярных выражениях.
+ *
+ * @param pattern
+ * @param isCaseInsensitive
+ */
+export function likeToRegexp(
+  pattern: string,
+  isCaseInsensitive?: boolean,
+): RegExp;

package/src/utils/model-name-to-model-key.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Model name to model key.
+ * 
+ * @param modelName
+ */
+export function modelNameToModelKey(modelName: string): string;

package/src/utils/select-object-keys.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Select object keys.
+ *
+ * @param obj
+ * @param keys
+ */
+export declare function selectObjectKeys<T extends object>(
+  obj: T,
+  keys: string[],
+): Partial<T>;

package/src/utils/singularize.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Singularize.
+ *
+ * @param noun
+ */
+export declare function singularize(noun: string): string;

package/src/utils/string-to-regexp.d.ts

@@ -0,0 +1,10 @@
+/**
+ * String to regexp.
+ *
+ * @param pattern
+ * @param flags
+ */
+export declare function stringToRegexp(
+  pattern: string | RegExp,
+  flags?: string,
+): RegExp;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "target": "es2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "allowJs": true
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./src/**/*.js"
+  ]
+}

package/jsconfig.json

@@ -1,7 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext"
-  }
-}

package/src/chai.js

@@ -1,9 +0,0 @@
-import * as chaiModule from 'chai';
-import chaiSpies from 'chai-spies';
-import chaiAsPromised from 'chai-as-promised';
-const chai = {...chaiModule};
-
-chaiSpies(chai, chai.util);
-chaiAsPromised(chai, chai.util);
-
-export {chai};