@webda/models 0.0.0-stage → 4.0.0-beta.3

package/lib/repositories/repository.d.ts

@@ -0,0 +1,238 @@
+import type { ArrayElement } from "@webda/tsc-esm";
+import type { QueryParameters, WebdaQLString } from "@webda/ql";
+import type { PrimaryKey, PrimaryKeyType, SettablePrimaryKey, WEBDA_EVENTS, ModelClass, PrimaryKeyAttributes } from "../storable.js";
+import type { Helpers, JSONed, NumericPropertyPaths, PropertyPaths, PropertyPathType } from "../types.js";
+import type { ModelRefWithCreate } from "../relations.js";
+/** Symbol key for test utilities on a repository (e.g. `clear()`). */
+export declare const WEBDA_TEST: unique symbol;
+/**
+ * Core repository interface - every repository must implement this
+ *
+ * Contains only the essential CRUD operations that work across
+ * all storage backends (SQL, NoSQL, in-memory, etc.)
+ */
+export interface CoreRepository<T extends ModelClass = ModelClass> {
+    /**
+     * Get the root model class for this repository
+     * @returns
+     */
+    getRootModel(): T;
+    /**
+     * In REST API, composite keys are represented as a string with the format "key1#key2#key3"
+     * We need a way to convert this string to the object
+     *
+     * @param uid serialized primary key
+     * @param forceObject if true, the result will be an object with the primary key fields
+     */
+    fromUID(uid: string, forceObject?: boolean): ModelRefWithCreate<InstanceType<T>>;
+    /**
+     * Parse the UID into the primary key
+     * @param uid
+     * @param forceObject
+     */
+    parseUID(uid: string, forceObject?: boolean): PrimaryKeyType<InstanceType<T>> | PrimaryKey<InstanceType<T>>;
+    /**
+     * Extract the primary key from the object
+     * @param object to extract the primary key from
+     * @param forceObject if true, the result will be an object with the primary key fields
+     */
+    getPrimaryKey<K>(object: any, forceObject?: boolean): K extends false ? PrimaryKeyType<InstanceType<T>> : PrimaryKey<InstanceType<T>>;
+    /**
+     * Get the UID of the object
+     * @param object to extract the primary key from
+     */
+    getUID(object: any): string;
+    /**
+     * Remove the primary key from the object
+     * @param object
+     */
+    excludePrimaryKey(object: any): any;
+    /**
+     * Refers to the object in the store
+     * @param pk primary key
+     */
+    ref(pk: SettablePrimaryKey<InstanceType<T>>): ModelRefWithCreate<InstanceType<T>>;
+    /**
+     * Get data from the store
+     * @param primaryKey
+     * @returns
+     */
+    get(primaryKey: PrimaryKeyType<InstanceType<T>>): Promise<Helpers<InstanceType<T>>>;
+    /**
+     * Create data in the store
+     * @param data
+     * @param save if false, create in-memory object without saving
+     * @returns
+     */
+    create(data: Helpers<InstanceType<T>>, save?: boolean): Promise<InstanceType<T>>;
+    /**
+     * Delete data from the store
+     * @param uid - Primary key or UID string
+     * @param conditionField - Field to check for condition (optional)
+     * @param condition - Value to check for condition (optional)
+     * @returns
+     */
+    delete<K extends PropertyPaths<InstanceType<T>>>(uid: PrimaryKeyType<InstanceType<T>> | string, conditionField?: K | null, condition?: PropertyPathType<InstanceType<T>, K> | JSONed<PropertyPathType<InstanceType<T>, K>>): Promise<void>;
+    /**
+     * Verify if the object exists
+     * @param uid
+     * @returns
+     */
+    exists(uid: PrimaryKeyType<InstanceType<T>> | string): Promise<boolean>;
+    /**
+     * Query the store
+     * @param query - the WebdaQL query, optionally with `?` or `:name` placeholders
+     * @param params - values for the placeholders: an array for `?`, an object for `:name`
+     * @returns
+     */
+    query(query: WebdaQLString<InstanceType<T>>, params?: QueryParameters): Promise<{
+        results: InstanceType<T>[];
+        continuationToken?: string;
+    }>;
+    /**
+     * Iterate over the store
+     * @param query - the WebdaQL query, optionally with `?` or `:name` placeholders
+     * @param params - values for the placeholders: an array for `?`, an object for `:name`
+     * @returns
+     */
+    iterate(query: WebdaQLString<InstanceType<T>>, params?: QueryParameters): AsyncGenerator<InstanceType<T>>;
+    /**
+     * Event listeners
+     */
+    on<K extends keyof InstanceType<T>[typeof WEBDA_EVENTS]>(event: K, listener: (data: InstanceType<T>[typeof WEBDA_EVENTS][K]) => void): void;
+    once<K extends keyof InstanceType<T>[typeof WEBDA_EVENTS]>(event: K, listener: (data: InstanceType<T>[typeof WEBDA_EVENTS][K]) => void): void;
+    off<K extends keyof InstanceType<T>[typeof WEBDA_EVENTS]>(event: K, listener: (data: InstanceType<T>[typeof WEBDA_EVENTS][K]) => void): void;
+    emit<K extends keyof InstanceType<T>[typeof WEBDA_EVENTS]>(event: K, payload: InstanceType<T>[typeof WEBDA_EVENTS][K]): Promise<void>;
+    [WEBDA_TEST]?: {
+        clear(): Promise<void>;
+    };
+}
+/**
+ * Update operations with optimistic locking support
+ *
+ * Most repositories should implement this to support updates
+ */
+export interface Updatable<T extends ModelClass = ModelClass> {
+    /**
+     * Replace entire object (full update)
+     * @param data - Complete object data including primary key
+     * @param conditionField - Field to check for optimistic locking (null = no check)
+     * @param condition - Expected value for condition field
+     */
+    update<K extends PropertyPaths<InstanceType<T>>>(data: Helpers<InstanceType<T>>, conditionField?: K | null, condition?: PropertyPathType<InstanceType<T>, K>): Promise<void>;
+    /**
+     * Partially update object (only specified fields)
+     * @param uid - Primary key of object to update
+     * @param data - Partial object data (only fields to update)
+     * @param conditionField - Field to check for optimistic locking (null = no check)
+     * @param condition - Expected value for condition field
+     */
+    patch<K extends PropertyPaths<InstanceType<T>>>(uid: PrimaryKeyType<InstanceType<T>> | string, data: Partial<Omit<InstanceType<T>, PrimaryKeyAttributes<InstanceType<T>>>>, conditionField?: K | null, condition?: PropertyPathType<InstanceType<T>, K> | JSONed<PropertyPathType<InstanceType<T>, K>>): Promise<void>;
+    /**
+     * Create or update object (insert if not exists, update if exists)
+     */
+    upsert(data: Helpers<InstanceType<T>>): Promise<InstanceType<T>>;
+}
+/**
+ * Atomic operations for NoSQL databases
+ *
+ * Only implement this for storage backends that support atomic updates
+ * (DynamoDB, MongoDB, Redis, etc.)
+ *
+ * SQL databases should NOT implement this - use transactions instead
+ */
+export interface AtomicOperations<T extends ModelClass = ModelClass> {
+    /**
+     * Atomically increment numeric field(s)
+     * @param primaryKeyOrUid - Primary key of object to update
+     * @param info - Fields to increment with optional values (default: 1)
+     * @param conditionField - Field to check for condition
+     * @param condition - Expected value for condition field
+     */
+    incrementAttributes<K extends PropertyPaths<InstanceType<T>>, L extends NumericPropertyPaths<InstanceType<T>>>(primaryKeyOrUid: PrimaryKeyType<InstanceType<T>> | string, info: ({
+        property: L;
+        value?: number;
+    } | L)[] | Record<L, number>, conditionField?: K | null, condition?: PropertyPathType<InstanceType<T>, K> | JSONed<PropertyPathType<InstanceType<T>, K>>): Promise<void>;
+    /**
+     * Atomically increment a single numeric field
+     * @param primaryKeyOrUid - Primary key of object to update
+     * @param info - Field to increment with optional value (default: 1)
+     * @param conditionField - Field to check for condition
+     * @param condition - Expected value for condition field
+     */
+    incrementAttribute<K extends PropertyPaths<InstanceType<T>>, L extends NumericPropertyPaths<InstanceType<T>>>(primaryKeyOrUid: PrimaryKeyType<InstanceType<T>> | string, info: {
+        property: L;
+        value?: number;
+    } | L, conditionField?: K | null, condition?: PropertyPathType<InstanceType<T>, K> | JSONed<PropertyPathType<InstanceType<T>, K>>): Promise<void>;
+    /**
+     * Atomically set a single attribute value
+     * @param primaryKeyOrUid - Primary key of object to update
+     * @param attribute - Attribute name to set
+     * @param value - New value for attribute
+     * @param conditionField - Field to check for condition
+     * @param condition - Expected value for condition field
+     */
+    setAttribute<K extends PropertyPaths<InstanceType<T>>, L extends PropertyPaths<InstanceType<T>>>(primaryKeyOrUid: PrimaryKeyType<InstanceType<T>> | string, attribute: K, value: PropertyPathType<InstanceType<T>, K>, conditionField?: L | null, condition?: PropertyPathType<InstanceType<T>, L> | JSONed<PropertyPathType<InstanceType<T>, L>>): Promise<void>;
+    /**
+     * Atomically remove an attribute
+     * @param primaryKeyOrUid - Primary key of object to update
+     * @param attribute - Attribute name to remove
+     * @param conditionField - Field to check for condition
+     * @param condition - Expected value for condition field
+     */
+    removeAttribute<L extends PropertyPaths<InstanceType<T>>, K extends PropertyPaths<InstanceType<T>>>(primaryKeyOrUid: PrimaryKeyType<InstanceType<T>> | string, attribute: K, conditionField?: L | null, condition?: PropertyPathType<InstanceType<T>, L> | JSONed<PropertyPathType<InstanceType<T>, L>>): Promise<void>;
+}
+/**
+ * Collection operations for nested arrays
+ *
+ * Only implement this for storage backends that support atomic array operations
+ * (DynamoDB, MongoDB, etc.)
+ */
+export interface CollectionOperations<T extends ModelClass = ModelClass> {
+    /**
+     * Add or update item in a collection (array field)
+     * @param primaryKeyOrUid - Primary key of object containing the collection
+     * @param collection - Name of the array field
+     * @param item - Item to add/update
+     * @param index - Position to insert (undefined = append to end)
+     * @param itemWriteConditionField - Field to check for condition on item
+     * @param itemWriteCondition - Expected value for condition field on item
+     */
+    upsertItemToCollection<K extends Extract<PropertyPaths<InstanceType<T>, any[]>, keyof InstanceType<T>>, L extends keyof ArrayElement<InstanceType<T>[K]>>(primaryKeyOrUid: PrimaryKeyType<InstanceType<T>> | string, collection: K, item: ArrayElement<InstanceType<T>[K]> | JSONed<ArrayElement<InstanceType<T>[K]>>, index?: number, itemWriteConditionField?: ArrayElement<InstanceType<T>[K]> extends object ? L : never, itemWriteCondition?: ArrayElement<InstanceType<T>[K]> extends object ? ArrayElement<InstanceType<T>[K]>[L] : ArrayElement<InstanceType<T>[K]> | null): Promise<void>;
+    /**
+     * Remove item from a collection by index
+     * @param primaryKeyOrUid - Primary key of object containing the collection
+     * @param collection - Name of the array field
+     * @param index - Position of item to remove
+     * @param itemWriteConditionField - Field to check for condition on item
+     * @param itemWriteCondition - Expected value for condition field on item
+     */
+    deleteItemFromCollection<K extends Extract<PropertyPaths<InstanceType<T>, any[]>, keyof InstanceType<T>>, L extends keyof ArrayElement<InstanceType<T>[K]>>(primaryKeyOrUid: PrimaryKeyType<InstanceType<T>> | string, collection: K, index: number, itemWriteConditionField?: L, itemWriteCondition?: ArrayElement<InstanceType<T>[K]>[L]): Promise<void>;
+}
+/**
+ * Type guard to check if repository supports atomic operations
+ * @param repo - the repository to check
+ * @returns true if atomic operations are supported
+ */
+export declare function supportsAtomicOperations<T extends ModelClass>(repo: CoreRepository<T>): repo is CoreRepository<T> & AtomicOperations<T>;
+/**
+ * Type guard to check if repository supports collection operations
+ * @param repo - the repository to check
+ * @returns true if collection operations are supported
+ */
+export declare function supportsCollectionOperations<T extends ModelClass>(repo: CoreRepository<T>): repo is CoreRepository<T> & CollectionOperations<T>;
+/**
+ * Full-featured repository combining all capabilities (backward compatible)
+ *
+ * This is the main interface that most code will interact with.
+ * It extends all specialized interfaces for backward compatibility.
+ *
+ * Note: All methods are inherited from:
+ * - CoreRepository: Basic CRUD, query, and key management
+ * - Updatable: Update, patch, and upsert operations
+ * - AtomicOperations: Atomic increment, setAttribute, removeAttribute
+ * - CollectionOperations: Array/collection manipulation
+ */
+export interface Repository<T extends ModelClass = ModelClass> extends CoreRepository<T>, Updatable<T>, AtomicOperations<T>, CollectionOperations<T> {
+}
+//# sourceMappingURL=repository.d.ts.map

package/lib/repositories/repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.d.ts","sourceRoot":"","sources":["../../src/repositories/repository.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAChE,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,UAAU,EACV,oBAAoB,EACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,oBAAoB,EAAE,aAAa,EAAE,gBAAgB,EAAc,MAAM,aAAa,CAAC;AACtH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAE1D,sEAAsE;AACtE,eAAO,MAAM,UAAU,eAAuB,CAAC;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAC/D;;;OAGG;IACH,YAAY,IAAI,CAAC,CAAC;IAElB;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjF;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5G;;;;OAIG;IACH,aAAa,CAAC,CAAC,EACb,MAAM,EAAE,GAAG,EACX,WAAW,CAAC,EAAE,OAAO,GACpB,CAAC,SAAS,KAAK,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnF;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,CAAC;IAE5B;;;OAGG;IACH,iBAAiB,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;IAEpC;;;OAGG;IACH,GAAG,CAAC,EAAE,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAElF;;;;OAIG;IACH,GAAG,CAAC,UAAU,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAEpF;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjF;;;;;;OAMG;IACH,MAAM,CAAC,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC7C,GAAG,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EAC7C,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EACzB,SAAS,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9F,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAExE;;;;;OAKG;IACH,KAAK,CACH,KAAK,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EACrC,MAAM,CAAC,EAAE,eAAe,GACvB,OAAO,CAAC;QACT,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC,CAAC;IAEH;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,eAAe,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1G;;OAEG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,EACrD,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GAChE,IAAI,CAAC;IACR,IAAI,CAAC,CAAC,SAAS,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,EACvD,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GAChE,IAAI,CAAC;IACR,GAAG,CAAC,CAAC,SAAS,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,EACtD,KAAK,EAAE,CAAC,EACR,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,GAChE,IAAI,CAAC;IACR,IAAI,CAAC,CAAC,SAAS,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,EACvD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,GAC/C,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,CAAC,UAAU,CAAC,CAAC,EAAE;QACb,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;KACxB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IAC1D;;;;;OAKG;IACH,MAAM,CAAC,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC7C,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC9B,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EACzB,SAAS,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAC/C,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC5C,GAAG,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EAC7C,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAC3E,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EACzB,SAAS,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9F,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CAClE;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IACjE;;;;;;OAMG;IACH,mBAAmB,CAAC,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,oBAAoB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC3G,eAAe,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EACzD,IAAI,EAAE,CAAC;QAAE,QAAQ,EAAE,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,CAAC,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,EACjE,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EACzB,SAAS,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9F,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;OAMG;IACH,kBAAkB,CAAC,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,oBAAoB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC1G,eAAe,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EACzD,IAAI,EAAE;QAAE,QAAQ,EAAE,CAAC,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,CAAC,EACzC,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EACzB,SAAS,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9F,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;;OAOG;IACH,YAAY,CAAC,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAC7F,eAAe,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EACzD,SAAS,EAAE,CAAC,EACZ,KAAK,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3C,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EACzB,SAAS,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9F,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;OAMG;IACH,eAAe,CAAC,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,SAAS,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAChG,eAAe,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EACzD,SAAS,EAAE,CAAC,EACZ,cAAc,CAAC,EAAE,CAAC,GAAG,IAAI,EACzB,SAAS,CAAC,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAC9F,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU;IACrE;;;;;;;;OAQG;IACH,sBAAsB,CACpB,CAAC,SAAS,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC,EAC/E,CAAC,SAAS,MAAM,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAEhD,eAAe,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EACzD,UAAU,EAAE,CAAC,EACb,IAAI,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACjF,KAAK,CAAC,EAAE,MAAM,EACd,uBAAuB,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK,EACrF,kBAAkB,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAChE,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACnC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAC1C,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;;OAOG;IACH,wBAAwB,CACtB,CAAC,SAAS,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,YAAY,CAAC,CAAC,CAAC,CAAC,EAC/E,CAAC,SAAS,MAAM,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAEhD,eAAe,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,EACzD,UAAU,EAAE,CAAC,EACb,KAAK,EAAE,MAAM,EACb,uBAAuB,CAAC,EAAE,CAAC,EAC3B,kBAAkB,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACvD,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,UAAU,EAC3D,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GACtB,IAAI,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAEjD;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,SAAS,UAAU,EAC/D,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GACtB,IAAI,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,CAErD;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,CAC3D,SAAQ,cAAc,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC;CAGtF"}

package/lib/repositories/repository.js

@@ -0,0 +1,19 @@
+/** Symbol key for test utilities on a repository (e.g. `clear()`). */
+export const WEBDA_TEST = Symbol("webda_test");
+/**
+ * Type guard to check if repository supports atomic operations
+ * @param repo - the repository to check
+ * @returns true if atomic operations are supported
+ */
+export function supportsAtomicOperations(repo) {
+    return typeof repo.incrementAttribute === "function";
+}
+/**
+ * Type guard to check if repository supports collection operations
+ * @param repo - the repository to check
+ * @returns true if collection operations are supported
+ */
+export function supportsCollectionOperations(repo) {
+    return typeof repo.upsertItemToCollection === "function";
+}
+//# sourceMappingURL=repository.js.map

package/lib/repositories/repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.js","sourceRoot":"","sources":["../../src/repositories/repository.ts"],"names":[],"mappings":"AAaA,sEAAsE;AACtE,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;AAyS/C;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CACtC,IAAuB;IAEvB,OAAO,OAAQ,IAAY,CAAC,kBAAkB,KAAK,UAAU,CAAC;AAChE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,4BAA4B,CAC1C,IAAuB;IAEvB,OAAO,OAAQ,IAAY,CAAC,sBAAsB,KAAK,UAAU,CAAC;AACpE,CAAC"}

package/lib/storable.d.ts

@@ -0,0 +1,200 @@
+import type { FilterAttributes, IsUnion, ReadonlyKeys } from "@webda/tsc-esm";
+import type { QueryParameters } from "@webda/ql";
+import { WEBDA_DIRTY } from "@webda/utils";
+import type { ModelRefWithCreate, ModelRelated } from "./relations.js";
+import type { JSONed, Settable } from "./types.js";
+/**
+ * Define the model primary key
+ */
+export declare const WEBDA_PRIMARY_KEY: unique symbol;
+/**
+ * REST API and other system may require a string representation of the primary key
+ * We concatenate the primary key fields with the separator '_'
+ *
+ * If one of these fields can contain a _ you can pick a different separator
+ */
+export declare const WEBDA_PRIMARY_KEY_SEPARATOR: unique symbol;
+/**
+ * Define the model plural key
+ * We might go back to a JSDoc @WebdaPlural annotation later
+ * @default <modelName>s
+ */
+export declare const WEBDA_PLURAL: unique symbol;
+/**
+ * Define the model events key
+ */
+export declare const WEBDA_EVENTS: unique symbol;
+/**
+ * Symbol for internal storage of model properties that require custom getters/setters (e.g. for handling multiple input types like Date).
+ */
+export declare const WEBDA_STORAGE: unique symbol;
+/**
+ * Define the events for the model
+ */
+export type Eventable = {
+    [WEBDA_EVENTS]?: any;
+};
+/**
+ * A Storable object is an object that can be stored in a database or anywhere else
+ * and can be retrieved later
+ *
+ * It has a primary key, a toJSON method and an Events object
+ *
+ */
+export interface Storable<T = any, PrimaryKeyProperties extends keyof T = any> extends Eventable {
+    /**
+     * Define the primary key for your model
+     */
+    [WEBDA_PRIMARY_KEY]: readonly PrimaryKeyProperties[];
+    /**
+     * Define the separator to use when concatenating primary key fields (for UUID generation)
+     */
+    [WEBDA_PRIMARY_KEY_SEPARATOR]?: string;
+    /**
+     * Define the plural for your model
+     */
+    [WEBDA_PLURAL]?: string;
+    /**
+     * Properties that are dirty and need to be saved
+     */
+    [WEBDA_DIRTY]?: Set<string>;
+    /**
+     * Return the primary key
+     */
+    getPrimaryKey(): IsUnion<PrimaryKeyProperties> extends true ? Pick<T, PrimaryKeyProperties> : T[PrimaryKeyProperties];
+    /**
+     * Return the string version of the primary key
+     */
+    getUUID(): string;
+    /**
+     * Load the serialized version of itself
+     */
+    load(params: any): this;
+}
+/**
+ * A concrete storable is a storable that has a constructor that can be used to create a new instance
+ */
+export type ConcreteStorable<T = any, K extends keyof T = any> = Storable<T, K> & (new (arg: any) => any);
+/**
+ * Constructor interface for Model classes.
+ *
+ * Provides static methods for CRUD operations, querying, and serialization.
+ */
+export interface ModelClass<S extends Storable = Storable> {
+    new (arg: any): S;
+    prototype: S;
+    ref<T extends ModelClass>(this: T, key: SettablePrimaryKey<InstanceType<T>>): ModelRefWithCreate<InstanceType<T>>;
+    iterate<T extends ModelClass>(this: T, query: string, params?: QueryParameters): AsyncGenerator<InstanceType<T>, any, any>;
+    create<T extends ModelClass>(this: T, data: ConstructorParameters<T>[0], save?: boolean): Promise<InstanceType<T>>;
+    query<T extends ModelClass>(this: T, query: string, params?: QueryParameters): Promise<{
+        results: InstanceType<T>[];
+        continuationToken?: string;
+    }>;
+    registerSerializer(overwrite?: boolean, identifier?: string): void;
+    getDeserializers<T extends ModelClass>(): Partial<Record<keyof InstanceType<T>, (value: any) => any>> | undefined;
+}
+/**
+ * Check if the object is a Model class
+ * @param object - the value to check
+ * @returns true if it is a ModelClass
+ */
+export declare function isModelClass(object: any): object is ModelClass;
+/**
+ * All storable need to have a constructor that take an object as argument
+ */
+export type StorableConstructor<T extends new (arg: any) => any = any> = new (arg: ConstructorParameters<T>[0]) => T;
+/** Extract the first parameter type of a `set` method, if present. */
+type FirstSetArg<X> = X extends {
+    set: (...args: infer A) => any;
+} ? A[0] : never;
+/** Resolve the accepted value type for an attribute: uses `set` arg if available, otherwise `JSONed<X> | X`. */
+type AttributeValue<X> = X extends {
+    set: Function;
+} ? FirstSetArg<X> : JSONed<X> | X;
+/** Keys where the `set` method's first arg is optional or includes undefined. */
+type OptionalArgKeys<T extends Storable> = {
+    [P in StorableAttributes<T>]-?: T[P] extends {
+        set: any;
+    } ? (undefined extends FirstSetArg<T[P]> ? P : never) : never;
+}[StorableAttributes<T>];
+/** Keys whose `set` arg is required (complement of OptionalArgKeys). */
+type RequiredArgKeys<T extends Storable> = Exclude<StorableAttributes<T>, OptionalArgKeys<T>>;
+/**
+ * Build the argument type for creating/updating a Storable.
+ *
+ * Properties with a required `set` arg are required; those with an optional `set` arg are optional.
+ */
+export type AttributesArgument<T extends Storable> = {
+    [P in Extract<RequiredArgKeys<T>, string | number>]: AttributeValue<T[P]>;
+} & {
+    [P in Extract<OptionalArgKeys<T>, string | number>]?: AttributeValue<T[P]>;
+};
+/**
+ * Resolve the primary key type: if T is a union of keys, returns `Pick<K, T>`;
+ * if T is a single key, returns `K[T]` directly.
+ */
+export type PK<K, T extends keyof K> = IsUnion<T> extends true ? Pick<K, T> : K[T];
+/**
+ * Get the primary key type of the object
+ *
+ * The main difference with the PrimaryKey<T> type is that if the primary key is a not union type, it will
+ * be returned as a single type, otherwise it will be returned as a Pick type
+ *
+ * The PrimaryKey<T> will always return a Pick type
+ */
+export type PrimaryKeyType<T extends Storable<any, any>> = PK<T, T[typeof WEBDA_PRIMARY_KEY][number]> & {
+    toString(): string;
+};
+/**
+ * A widened version of PrimaryKeyType that accepts setter-compatible values.
+ *
+ * For composite keys (objects), applies Settable to widen properties that have
+ * a `set()` method (e.g. ModelLink accepts string).
+ * For single keys (string/number), returns the type as-is.
+ */
+export type SettablePrimaryKey<T extends Storable<any, any>> = PrimaryKeyType<T> extends object ? Settable<PrimaryKeyType<T>> | PrimaryKeyType<T> : PrimaryKeyType<T>;
+/**
+ * Get the primary key of the object
+ *
+ * The main difference with the PrimaryKeyType<T> type is that it will always return a Pick type
+ *
+ * The PrimaryKeyType<T> will return a Pick type only if the primary key is a union type
+ */
+export type PrimaryKey<T extends Storable<any, any>> = Pick<T, T[typeof WEBDA_PRIMARY_KEY][number]> & {
+    toString(): string;
+};
+/**
+ * Get the primary key attributes of the object
+ */
+export type PrimaryKeyAttributes<T extends Storable<any, any>> = keyof PrimaryKey<T>;
+/**
+ * Compare two primary keys for equality
+ * @param a - the first primary key or storable
+ * @param b - the second primary key or storable
+ * @returns true if the keys are equal
+ */
+export declare function PrimaryKeyEquals(a: PrimaryKeyType<any> | Storable, b: PrimaryKeyType<any> | Storable): boolean;
+/**
+ * Check if the object is a Storable object
+ * @param object - the value to check
+ * @returns true if it is a Storable
+ */
+export declare function isStorable<T = any>(object: any): object is Storable<T>;
+/** Remove symbol-keyed properties from a type. */
+type ExcludeSymbols<T> = {
+    [P in keyof T as P extends symbol ? never : P]: T[P];
+};
+/**
+ * Get the model attributes without the internal properties
+ *
+ * Used for the create method
+ */
+export type StorableAttributes<T extends Storable, U = any> = FilterAttributes<Omit<ExcludeSymbols<T>, FilterAttributes<T, Function> | FilterAttributes<T, ModelRelated<any, any, any>> | ReadonlyKeys<T> | Extract<keyof T, symbol>>, U>;
+/**
+ * Get the model attributes without the primary key properties
+ *
+ * Used for the update method
+ */
+export type UpdatableAttributes<T extends Storable, U = any> = Exclude<StorableAttributes<T, U>, PrimaryKeyAttributes<T> | ReadonlyKeys<T>>;
+export {};
+//# sourceMappingURL=storable.d.ts.map

package/lib/storable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storable.d.ts","sourceRoot":"","sources":["../src/storable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEnD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAO,MAA8B,CAAC;AACtE;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,EAAE,OAAO,MAAwC,CAAC;AAC1F;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,OAAO,MAAoC,CAAC;AACvE;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,OAAO,MAAoC,CAAC;AACvE;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,OAAO,MAAqC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,YAAY,CAAC,CAAC,EAAE,GAAG,CAAC;CACtB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,oBAAoB,SAAS,MAAM,CAAC,GAAG,GAAG,CAAE,SAAQ,SAAS;IAC9F;;OAEG;IACH,CAAC,iBAAiB,CAAC,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACrD;;OAEG;IACH,CAAC,2BAA2B,CAAC,CAAC,EAAE,MAAM,CAAC;IACvC;;OAEG;IACH,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B;;OAEG;IACH,aAAa,IAAI,OAAO,CAAC,oBAAoB,CAAC,SAAS,IAAI,GAAG,IAAI,CAAC,CAAC,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,CAAC;IACtH;;OAEG;IACH,OAAO,IAAI,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,GAAG,IAAI,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC;AAE1G;;;;GAIG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,QAAQ,GAAG,QAAQ;IACvD,KAAK,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC;IAClB,SAAS,EAAE,CAAC,CAAC;IACb,GAAG,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IAClH,OAAO,CAAC,CAAC,SAAS,UAAU,EAC1B,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,eAAe,GACvB,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC7C,MAAM,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;IACnH,KAAK,CAAC,CAAC,SAAS,UAAU,EACxB,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,eAAe,GACvB,OAAO,CAAC;QACT,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;KAC5B,CAAC,CAAC;IACH,kBAAkB,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnE,gBAAgB,CAAC,CAAC,SAAS,UAAU,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC;CACnH;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,UAAU,CAM9D;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,KAAK,GAAG,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,IAAI,KAAK,GAAG,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAErH,sEAAsE;AACtE,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,GAAG,CAAA;CAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;AAElF,gHAAgH;AAChH,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,GAAG,EAAE,QAAQ,CAAA;CAAE,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAEtF,iFAAiF;AACjF,KAAK,eAAe,CAAC,CAAC,SAAS,QAAQ,IAAI;KACxC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;QAAE,GAAG,EAAE,GAAG,CAAA;KAAE,GAAG,CAAC,SAAS,SAAS,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK;CACtH,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEzB,wEAAwE;AACxE,KAAK,eAAe,CAAC,CAAC,SAAS,QAAQ,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;AAE9F;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,QAAQ,IAAI;KAClD,CAAC,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1E,GAAG;KACD,CAAC,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3E,CAAC;AAMF;;;GAGG;AACH,MAAM,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnF;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG;IACtG,QAAQ,IAAI,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,IACzD,cAAc,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;AACzG;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG;IACpG,QAAQ,IAAI,MAAM,CAAC;CACpB,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,UAAU,CAAC,CAAC,CAAC,CAAC;AAErF;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,cAAc,CAAC,GAAG,CAAC,GAAG,QAAQ,GAAG,OAAO,CAgB9G;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,QAAQ,CAAC,CAAC,CAAC,CAEtE;AAID,kDAAkD;AAClD,KAAK,cAAc,CAAC,CAAC,IAAI;KACtB,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrD,CAAC;AACF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,GAAG,GAAG,IAAI,gBAAgB,CAC5E,IAAI,CACF,cAAc,CAAC,CAAC,CAAC,EACf,gBAAgB,CAAC,CAAC,EAAE,QAAQ,CAAC,GAC7B,gBAAgB,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GAChD,YAAY,CAAC,CAAC,CAAC,GACf,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAC3B,EACD,CAAC,CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,GAAG,GAAG,IAAI,OAAO,CACpE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,EACxB,oBAAoB,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAC1C,CAAC"}

package/lib/storable.js

@@ -0,0 +1,66 @@
+import { WEBDA_DIRTY } from "@webda/utils";
+/**
+ * Define the model primary key
+ */
+export const WEBDA_PRIMARY_KEY = Symbol("Primary key");
+/**
+ * REST API and other system may require a string representation of the primary key
+ * We concatenate the primary key fields with the separator '_'
+ *
+ * If one of these fields can contain a _ you can pick a different separator
+ */
+export const WEBDA_PRIMARY_KEY_SEPARATOR = Symbol("Primary key separator");
+/**
+ * Define the model plural key
+ * We might go back to a JSDoc @WebdaPlural annotation later
+ * @default <modelName>s
+ */
+export const WEBDA_PLURAL = Symbol("Plural definition");
+/**
+ * Define the model events key
+ */
+export const WEBDA_EVENTS = Symbol("Events definition");
+/**
+ * Symbol for internal storage of model properties that require custom getters/setters (e.g. for handling multiple input types like Date).
+ */
+export const WEBDA_STORAGE = Symbol("Storage definition");
+/**
+ * Check if the object is a Model class
+ * @param object - the value to check
+ * @returns true if it is a ModelClass
+ */
+export function isModelClass(object) {
+    return (typeof object === "function" &&
+        typeof object.prototype?.getPrimaryKey === "function" &&
+        typeof object.getDeserializers === "function");
+}
+/**
+ * Compare two primary keys for equality
+ * @param a - the first primary key or storable
+ * @param b - the second primary key or storable
+ * @returns true if the keys are equal
+ */
+export function PrimaryKeyEquals(a, b) {
+    if (isStorable(a)) {
+        a = a.getPrimaryKey();
+    }
+    if (isStorable(b)) {
+        b = b.getPrimaryKey();
+    }
+    if (a instanceof Object && b instanceof Object) {
+        return (a.constructor === b.constructor &&
+            Object.keys(a)
+                .filter(k => typeof a[k] !== "function")
+                .every(key => a[key] === b[key]));
+    }
+    return a === b;
+}
+/**
+ * Check if the object is a Storable object
+ * @param object - the value to check
+ * @returns true if it is a Storable
+ */
+export function isStorable(object) {
+    return typeof object.getPrimaryKey === "function" && Array.isArray(object[WEBDA_PRIMARY_KEY]);
+}
+//# sourceMappingURL=storable.js.map

package/lib/storable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storable.js","sourceRoot":"","sources":["../src/storable.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAI3C;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAkB,MAAM,CAAC,aAAa,CAAC,CAAC;AACtE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAkB,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAC1F;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAkB,MAAM,CAAC,mBAAmB,CAAC,CAAC;AACvE;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAkB,MAAM,CAAC,mBAAmB,CAAC,CAAC;AACvE;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAkB,MAAM,CAAC,oBAAoB,CAAC,CAAC;AA+EzE;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,MAAW;IACtC,OAAO,CACL,OAAO,MAAM,KAAK,UAAU;QAC5B,OAAO,MAAM,CAAC,SAAS,EAAE,aAAa,KAAK,UAAU;QACrD,OAAO,MAAM,CAAC,gBAAgB,KAAK,UAAU,CAC9C,CAAC;AACJ,CAAC;AA8ED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,CAAiC,EAAE,CAAiC;IACnG,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAClB,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;IACxB,CAAC;IACD,IAAI,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;QAClB,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;IACxB,CAAC;IACD,IAAI,CAAC,YAAY,MAAM,IAAI,CAAC,YAAY,MAAM,EAAE,CAAC;QAC/C,OAAO,CACL,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,WAAW;YAC/B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;iBACX,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC;iBACvC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CACnC,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAU,MAAW;IAC7C,OAAO,OAAO,MAAM,CAAC,aAAa,KAAK,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAChG,CAAC"}