@avytrix/nestjs-drizzle-crud 0.0.0-stage → 3.6.0

package/dist/core/interfaces/query.interface.d.ts

@@ -0,0 +1,112 @@
+import type { SortColumn, SortOrder } from "../types/sql.types";
+import type { RelationsConfig, SqlOperationOptions, SqlSearchOptions } from "./sql-crud-config.interface";
+export interface FilterOperators {
+    eq?: unknown;
+    neq?: unknown;
+    gt?: unknown;
+    gte?: unknown;
+    lt?: unknown;
+    lte?: unknown;
+    like?: string;
+    ilike?: string;
+    in?: unknown[];
+    notIn?: unknown[];
+    between?: [unknown, unknown];
+    isNull?: boolean | "true" | "false";
+    isNotNull?: boolean | "true" | "false";
+    startsWith?: string;
+    endsWith?: string;
+    contains?: string;
+    iStartsWith?: string;
+    iEndsWith?: string;
+    iContains?: string;
+    arrayContains?: unknown[];
+    arrayOverlaps?: unknown[];
+    jsonContains?: unknown;
+}
+export type FilterOperator = keyof FilterOperators;
+export type FilterScalar = string | number | boolean | bigint | Date;
+export type ColumnFilter = FilterScalar | FilterScalar[] | FilterOperators | null | undefined;
+export interface FilterGroup {
+    and?: CrudFilter[];
+    or?: CrudFilter[];
+    not?: CrudFilter;
+}
+export type CrudFilter = FilterGroup & {
+    [key: string]: ColumnFilter | CrudFilter | CrudFilter[] | CollectionFilter;
+};
+export interface CollectionFilter {
+    some?: CrudFilter;
+    none?: CrudFilter;
+    every?: CrudFilter;
+}
+export type CollectionQuantifier = keyof CollectionFilter;
+export type SortInput = string | Array<string | SortColumn>;
+export interface CursorPaginationOptions {
+    cursor?: string | null;
+    after?: string | null;
+    limit?: number;
+    sortBy?: SortInput;
+    sortOrder?: SortOrder;
+    count?: boolean;
+}
+export interface CrudPage<T, Total extends number | null = number> {
+    data: T[];
+    total: Total;
+    page: number;
+    limit: number;
+    hasMore?: boolean;
+}
+export interface UncountedCrudPage<T> extends CrudPage<T, null> {
+    hasMore: boolean;
+}
+export type RelationCounts = string[] | Record<string, true | CrudFilter>;
+export interface CountByRow<V = unknown> {
+    value: V;
+    count: number;
+}
+export interface CursorPage<T> {
+    data: T[];
+    limit: number;
+    nextCursor: string | null;
+    total?: number;
+}
+export interface CrudAllowlists {
+    filterableColumns?: string[];
+    sortableColumns?: string[];
+    selectableColumns?: string[];
+    searchableColumns?: string[];
+    loadableRelations?: string[];
+    writableRelations?: string[];
+    writableColumns?: string[];
+}
+export type BulkMode = "set" | "perItem";
+export interface UpsertOptions {
+    conflictTarget?: string | string[];
+    update?: string[];
+}
+export interface ParseCrudQueryOptions extends CrudAllowlists {
+    relations?: RelationsConfig;
+    primaryKey?: string;
+    searchColumns?: string[];
+    allowTrash?: boolean;
+    ignore?: string[];
+}
+export interface ParsedCrudQuery {
+    filters: CrudFilter;
+    pagination: {
+        page?: number;
+        limit?: number;
+        sortBy?: SortColumn[];
+        cursor?: string | null;
+        count?: boolean;
+        withCount?: boolean;
+    };
+    sort: SortColumn[];
+    select?: string[];
+    relations?: string[];
+    search?: SqlSearchOptions;
+    counts?: string[];
+    options: SqlOperationOptions;
+    isCursor: boolean;
+}

package/dist/core/interfaces/query.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=query.interface.js.map

package/dist/core/interfaces/query.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.interface.js","sourceRoot":"","sources":["../../../src/core/interfaces/query.interface.ts"],"names":[],"mappings":""}

package/dist/core/interfaces/scope.interface.d.ts

@@ -0,0 +1,3 @@
+export type CrudContextValue = Record<string, unknown>;
+export type CrudScopeValues = Record<string, unknown>;
+export type CrudScope = CrudScopeValues | ((context: CrudContextValue) => CrudScopeValues | null);

package/dist/core/interfaces/scope.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=scope.interface.js.map

package/dist/core/interfaces/scope.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scope.interface.js","sourceRoot":"","sources":["../../../src/core/interfaces/scope.interface.ts"],"names":[],"mappings":""}

package/dist/core/interfaces/sql-crud-config.interface.d.ts

@@ -0,0 +1,87 @@
+import type { PrimaryKeyType, SortColumn, SqlDialect } from "../types/sql.types";
+import type { CrudEventBus } from "../events/crud-event-bus";
+import type { BulkMode, CrudAllowlists, RelationCounts } from "./query.interface";
+import type { CrudContextValue, CrudScope } from "./scope.interface";
+export type RelationType = "belongsTo" | "hasMany" | "manyToMany";
+export interface RelationConfig {
+    table: any;
+    type?: RelationType;
+    localKey?: string;
+    references?: string;
+    foreignKey?: string;
+    parentKey?: string;
+    through?: any;
+    throughLocalKey?: string;
+    throughForeignKey?: string;
+    orderBy?: SortColumn[];
+    relations?: RelationsConfig;
+}
+export interface RelationNode {
+    name: string;
+    config: RelationConfig;
+    children: RelationNode[];
+    joined?: boolean;
+}
+export interface SelectTree {
+    base: string[];
+    relations: Record<string, SelectTree>;
+}
+export type RelationsConfig = Record<string, RelationConfig>;
+export type SqlSearchMode = "ilike" | "fullText";
+export interface SqlSearchOptions {
+    term: string;
+    columns: string[];
+    mode?: SqlSearchMode;
+}
+export interface SqlCrudConfig extends CrudAllowlists {
+    dialect: SqlDialect;
+    db: any;
+    table: any;
+    primaryKey: string;
+    primaryKeyType?: PrimaryKeyType;
+    softDelete?: {
+        enabled: boolean;
+        column: string;
+    };
+    timestamps?: {
+        createdAt: string;
+        updatedAt: string;
+    };
+    pagination?: {
+        defaultLimit: number;
+        maxLimit: number;
+    };
+    defaultSort?: SortColumn[];
+    sql?: {
+        caseSensitive: boolean;
+        useReturning: boolean;
+        jsonSupport: boolean;
+        enableFullTextSearch: boolean;
+    };
+    relations?: RelationsConfig;
+    scope?: CrudScope;
+    versionColumn?: string;
+    events?: CrudEventBus;
+}
+export interface SqlOperationOptions {
+    transaction?: any;
+    relations?: string[];
+    select?: string[];
+    search?: SqlSearchOptions;
+    hooks?: {
+        skipBefore?: boolean;
+        skipAfter?: boolean;
+    };
+    lock?: "update" | "share" | "none";
+    forNoKeyUpdate?: boolean;
+    withDeleted?: boolean;
+    onlyDeleted?: boolean;
+    skipAllowlists?: boolean;
+    bulkMode?: BulkMode;
+    counts?: RelationCounts;
+    context?: CrudContextValue;
+    skipScope?: boolean;
+    skipEvents?: boolean;
+    expectedVersion?: number;
+    expectedVersions?: Record<string, number>;
+}

package/dist/core/interfaces/sql-crud-config.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sql-crud-config.interface.js.map

package/dist/core/interfaces/sql-crud-config.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql-crud-config.interface.js","sourceRoot":"","sources":["../../../src/core/interfaces/sql-crud-config.interface.ts"],"names":[],"mappings":""}

package/dist/core/types/sql.types.d.ts

@@ -0,0 +1,7 @@
+export type SqlDialect = "postgresql" | "mysql";
+export type PrimaryKeyType = "serial" | "bigserial" | "int" | "bigint" | "uuid";
+export type SortOrder = "asc" | "desc";
+export interface SortColumn {
+    column: string;
+    order?: SortOrder;
+}

package/dist/core/types/sql.types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sql.types.js.map

package/dist/core/types/sql.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sql.types.js","sourceRoot":"","sources":["../../../src/core/types/sql.types.ts"],"names":[],"mappings":""}

package/dist/core/utils/cursor.d.ts

@@ -0,0 +1,2 @@
+export declare function encodeCursor(values: unknown[], signature: string): string;
+export declare function decodeCursor(cursor: string, signature: string, length: number): unknown[];

package/dist/core/utils/cursor.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeCursor = encodeCursor;
+exports.decodeCursor = decodeCursor;
+const common_1 = require("@nestjs/common");
+function encodeCursor(values, signature) {
+    const body = {
+        s: signature,
+        v: values.map((value) => typeof value === "bigint" ? { $b: value.toString() } : value),
+    };
+    return Buffer.from(JSON.stringify(body)).toString("base64url");
+}
+function decodeCursor(cursor, signature, length) {
+    let body;
+    try {
+        body = JSON.parse(Buffer.from(cursor, "base64url").toString("utf8"));
+    }
+    catch {
+        throw new common_1.BadRequestException("Invalid cursor");
+    }
+    if (!body ||
+        typeof body !== "object" ||
+        !Array.isArray(body.v) ||
+        body.v.length !== length) {
+        throw new common_1.BadRequestException("Invalid cursor");
+    }
+    if (body.s !== signature) {
+        throw new common_1.BadRequestException("The cursor was made for a different sort; start again without one");
+    }
+    return body.v.map((value) => {
+        if (!value || typeof value !== "object")
+            return value;
+        if (typeof value.$b !== "string") {
+            throw new common_1.BadRequestException("Invalid cursor");
+        }
+        try {
+            return BigInt(value.$b);
+        }
+        catch {
+            throw new common_1.BadRequestException("Invalid cursor");
+        }
+    });
+}
+//# sourceMappingURL=cursor.js.map

package/dist/core/utils/cursor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cursor.js","sourceRoot":"","sources":["../../../src/core/utils/cursor.ts"],"names":[],"mappings":";;;;AAAA,2CAAqD;AAYrD,sBAA6B,MAAiB,EAAE,SAAiB;IAChE,MAAM,IAAI,GAAe;QACxB,CAAC,EAAE,SAAS;QACZ,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACvB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAC5D;KACD,CAAC;IACF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAChE,CAAC;AAID,sBACC,MAAc,EACd,SAAiB,EACjB,MAAc;IAEd,IAAI,IAAgB,CAAC;IACrB,IAAI,CAAC;QACJ,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IACtE,CAAC;IAAC,MAAM,CAAC;QACR,MAAM,IAAI,4BAAmB,CAAC,gBAAgB,CAAC,CAAC;IACjD,CAAC;IACD,IACC,CAAC,IAAI;QACL,OAAO,IAAI,KAAK,QAAQ;QACxB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,EACvB,CAAC;QACF,MAAM,IAAI,4BAAmB,CAAC,gBAAgB,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,IAAI,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,4BAAmB,CAC5B,mEAAmE,CACnE,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAU,EAAE,EAAE;QAChC,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QACtD,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,EAAE,CAAC;YAClC,MAAM,IAAI,4BAAmB,CAAC,gBAAgB,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC;YACJ,OAAO,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzB,CAAC;QAAC,MAAM,CAAC;YACR,MAAM,IAAI,4BAAmB,CAAC,gBAAgB,CAAC,CAAC;QACjD,CAAC;IACF,CAAC,CAAC,CAAC;AACJ,CAAC"}

package/dist/core/utils/merge-config.d.ts

@@ -0,0 +1,2 @@
+export declare function isPlainObject(value: unknown): value is Record<string, any>;
+export declare function mergeCrudConfig<C extends Record<string, any>>(base: C, override: Record<string, any> | undefined): C;

package/dist/core/utils/merge-config.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPlainObject = isPlainObject;
+exports.mergeCrudConfig = mergeCrudConfig;
+const NESTED_KEYS = ["softDelete", "timestamps", "pagination", "sql"];
+function isPlainObject(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        !Array.isArray(value) &&
+        !(value instanceof Date));
+}
+function mergeCrudConfig(base, override) {
+    const out = { ...base, ...(override ?? {}) };
+    for (const key of NESTED_KEYS) {
+        const a = base?.[key];
+        const b = override?.[key];
+        if (isPlainObject(a) && isPlainObject(b))
+            out[key] = { ...a, ...b };
+    }
+    return out;
+}
+//# sourceMappingURL=merge-config.js.map

package/dist/core/utils/merge-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge-config.js","sourceRoot":"","sources":["../../../src/core/utils/merge-config.ts"],"names":[],"mappings":";;;;AAGA,MAAM,WAAW,GAAG,CAAC,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,CAAU,CAAC;AAE/E,uBAA8B,KAAc;IAC3C,OAAO,CACN,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CACxB,CAAC;AACH,CAAC;AAKD,yBACC,IAAO,EACP,QAAyC;IAEzC,MAAM,GAAG,GAAwB,EAAE,GAAG,IAAI,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;IAClE,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC;QACtB,MAAM,CAAC,GAAG,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,aAAa,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC;YAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;IACrE,CAAC;IACD,OAAO,GAAQ,CAAC;AACjB,CAAC"}

package/dist/core/utils/query-parser.d.ts

@@ -0,0 +1,4 @@
+import type { ParseCrudQueryOptions, ParsedCrudQuery } from "../interfaces/query.interface";
+export declare const MAX_FILTER_DEPTH = 32;
+export declare function assertFilterDepth(filters: unknown): void;
+export declare function parseCrudQuery(query: Record<string, unknown> | null | undefined, table: any, options?: ParseCrudQueryOptions): ParsedCrudQuery;