@arcaelas/dynamite 1.0.18 → 1.0.23

package/src/src/core/table.d.ts

@@ -0,0 +1,81 @@
+import type { InferAttributes, QueryOperator, WhereOptions } from "../@types/index";
+import { TransactionContext } from "./client";
+import { SCHEMA } from "./decorator";
+type SimpleWhereOptions<M> = {
+    order?: "ASC" | "DESC" | {
+        [key: string]: "ASC" | "DESC";
+    };
+    offset?: number;
+    skip?: number;
+    limit?: number;
+    attributes?: (keyof InferAttributes<M>)[];
+    include?: NonNullable<WhereOptions<M>["include"]>;
+    _includeTrashed?: boolean;
+};
+type Noop = (...args: any) => any;
+interface Schema {
+    name: string;
+    primary_key: string;
+    columns: {
+        [K: string]: {
+            get: Noop;
+            set: Noop;
+            store: {
+                [K: string]: any;
+                relation: {
+                    type: "HasMany" | "HasOne" | "BelognsTo" | "ManyToMany";
+                    local: string;
+                    foreign: string;
+                    pivot?: string;
+                };
+            };
+        };
+    };
+}
+export default class Table<T = any> {
+    static [SCHEMA]: Schema;
+    private readonly _relationCache;
+    constructor(props?: Partial<T>);
+    toJSON(): Record<string, unknown>;
+    /**
+     * @description Mapea nombres de propiedades TypeScript a nombres de columnas de DB
+     * @param data Objeto con propiedades TypeScript
+     * @returns Objeto con nombres de columnas de DB
+     */
+    private _mapPropertiesToDB;
+    /**
+     * @description Mapea nombres de columnas de DB a nombres de propiedades TypeScript
+     * @param data Objeto con nombres de columnas de DB
+     * @returns Objeto con propiedades TypeScript
+     */
+    private static _mapDBToProperties;
+    /**
+     * @description Convierte la instancia a un payload listo para DynamoDB
+     * @returns Objeto con nombres de columnas de DB y valores apropiados
+     */
+    private _toDBPayload;
+    toString(): string;
+    save(): Promise<boolean>;
+    update(data: Partial<InferAttributes<T>>): Promise<boolean>;
+    destroy(): Promise<null>;
+    forceDestroy(): Promise<null>;
+    attach<R>(RelatedModel: new () => R, related_id: string, pivot_data?: Record<string, any>): Promise<void>;
+    detach<R>(RelatedModel: new () => R, related_id: string): Promise<void>;
+    /**
+     * Sincronizar relación ManyToMany reemplazando todas las relaciones existentes
+     * @param RelatedModel Modelo relacionado
+     * @param related_ids Array de IDs a sincronizar
+     */
+    sync<R>(RelatedModel: new () => R, related_ids: string[]): Promise<void>;
+    static create<M extends Table>(this: new (data: any) => M, data: Partial<InferAttributes<M>>, tx?: TransactionContext): Promise<M>;
+    static update<M extends Table>(this: new (data: any) => M, updates: Partial<InferAttributes<M>>, filters: Partial<InferAttributes<M>>, tx?: TransactionContext): Promise<number>;
+    static delete<M extends Table>(this: new (data: any) => M, filters: Partial<InferAttributes<M>>, tx?: TransactionContext): Promise<number>;
+    static where<M extends Table>(this: new (props?: any) => M, key: keyof InferAttributes<M>, value: any, options?: SimpleWhereOptions<M>): Promise<M[]>;
+    static where<M extends Table>(this: new (props?: any) => M, key: keyof InferAttributes<M>, operator: QueryOperator, value: any, options?: SimpleWhereOptions<M>): Promise<M[]>;
+    static where<M extends Table>(this: new (props?: any) => M, query: object, options?: SimpleWhereOptions<M>): Promise<M[]>;
+    static first<M extends Table>(this: new (props?: any) => M, field_or_filters: any, operator_or_value?: any, value_or_options?: any): Promise<M | undefined>;
+    static last<M extends Table>(this: new (props?: any) => M, field_or_filters?: any, operator_or_value?: any): Promise<M | undefined>;
+    static withTrashed<M extends Table>(this: new (props?: any) => M, filters?: any, options?: WhereOptions<M>): Promise<M[]>;
+    static onlyTrashed<M extends Table>(this: new (props?: any) => M, filters?: any, options?: WhereOptions<M>): Promise<M[]>;
+}
+export {};