@kosdev-code/kos-ui-sdk 2.1.7 → 2.1.9

package/core/util/container-utils.d.ts

@@ -4,24 +4,116 @@ import { IKosModelContainer } from '../core/kos-container-model';
 interface Identifiable {
     id: string;
 }
+/**
+ * Function that transforms an entity, typically to update its id property before container insertion.
+ * Useful for normalizing ids or adding prefixes/suffixes.
+ */
 export type IdMapper = <D extends Identifiable = Identifiable>(entity: D) => D;
 type Container = IKosContainerModel<any, any> | IKosModelContainer<any>;
+/**
+ * Parameters for resolving container deltas.
+ * @template T - The container type
+ * @template D - The entity type with an id property
+ */
 interface ResolveParams<T extends Container, D> {
+    /** The container to synchronize */
     container: T;
+    /** Callback to create a new item when an entity is added */
     onAddItem: (entity: D) => any;
+    /** Optional callback when an item is removed, receives the id to remove */
     onRemoveItem?: (id: string) => any;
+    /** Optional callback when an existing item needs updating */
     onUpdateItem?: (entity: D, existingModel: any) => any;
+    /** Optional mapper to transform entity ids before processing */
     idMapper?: IdMapper;
 }
+/**
+ * Creates a function that synchronizes a container with a new list of entities.
+ * Handles additions, removals, and optional updates to keep the container in sync.
+ *
+ * @template T - Container type implementing IKosModelContainer
+ * @template D - Entity type with an id property
+ * @param params - Configuration for resolving deltas
+ * @returns A function that accepts entities and synchronizes the container
+ *
+ * @example
+ * const syncUsers = resolveContainerDeltas({
+ *   container: userContainer,
+ *   onAddItem: (user) => User.instance(user.id).options(user).build(),
+ *   onUpdateItem: (user, existing) => existing.update(user),
+ *   onRemoveItem: (id) => id
+ * });
+ * syncUsers(newUserList);
+ */
 export declare const resolveContainerDeltas: <T extends IKosModelContainer<any>, D extends Identifiable>({ container, onAddItem, onUpdateItem, onRemoveItem, idMapper, }: ResolveParams<T, D>) => (entities: D[]) => void;
+/**
+ * Creates a function that synchronizes a container model's list with new entities.
+ * Simpler alternative to resolveContainerDeltas that directly invokes callbacks for each addition and removal.
+ *
+ * @template T - Container model type implementing IKosContainerModel
+ * @template D - Entity type with an id property
+ * @param params - Configuration for resolving deltas
+ * @returns A function that accepts entities and synchronizes by invoking callbacks
+ *
+ * @example
+ * const syncLayers = resolveListDeltas({
+ *   container: layerContainer,
+ *   onAddItem: (layer) => addLayer(layer),
+ *   onRemoveItem: (id) => removeLayer(id)
+ * });
+ * syncLayers(newLayerList);
+ */
 export declare const resolveListDeltas: <T extends IKosContainerModel<any, any>, D extends Identifiable>({ container, onAddItem, onRemoveItem, idMapper, }: ResolveParams<T, D>) => (entities: D[]) => void;
+/**
+ * Parameters for resolving deltas on plain item arrays (not container models).
+ * @template T - Current item type with an id property
+ * @template D - New entity type with an id property
+ */
 interface ResolveItemsParams<T extends Identifiable, D> {
+    /** The current array of items to synchronize */
     items: T[];
+    /** Callback invoked for each entity to add */
     onAddItem: (entity: D) => void;
+    /** Callback invoked for each id to remove */
     onRemoveItem: (id: string) => void;
+    /** Optional mapper to transform entity ids before processing */
     idMapper?: IdMapper;
 }
+/**
+ * Creates a function that synchronizes a plain array of items with new entities.
+ * Does not require a container model - works with any array of identifiable items.
+ *
+ * @template T - Current item type with an id property
+ * @template D - New entity type with an id property
+ * @param params - Configuration including the items array and callbacks
+ * @returns A function that accepts entities and synchronizes the array
+ *
+ * @example
+ * const currentItems = [{ id: '1', name: 'Item 1' }];
+ * const syncItems = resolveItemListDeltas({
+ *   items: currentItems,
+ *   onAddItem: (item) => currentItems.push(item),
+ *   onRemoveItem: (id) => {
+ *     const index = currentItems.findIndex(i => i.id === id);
+ *     if (index >= 0) currentItems.splice(index, 1);
+ *   }
+ * });
+ * syncItems(newItems);
+ */
 export declare const resolveItemListDeltas: <T extends Identifiable, D extends Identifiable>({ items, onAddItem, onRemoveItem, idMapper, }: ResolveItemsParams<T, D>) => (entities: D[]) => void;
+/**
+ * Removes a prefix from an id string if present.
+ * Useful for normalizing ids that may have parent or namespace prefixes.
+ *
+ * @param id - The id string to process
+ * @param prefix - The prefix to remove (defaults to "parent-")
+ * @returns The id with the prefix removed, or the original id if prefix not found
+ *
+ * @example
+ * processId("parent-123") // returns "123"
+ * processId("parent-abc", "parent-") // returns "abc"
+ * processId("child-456", "parent-") // returns "child-456"
+ */
 export declare const processId: (id: string, prefix?: string) => string;
 export {};
 //# sourceMappingURL=container-utils.d.ts.map

package/core/util/container-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"container-utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/core/util/container-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;CACZ;AAqBD,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;AAE/E,KAAK,SAAS,GAAG,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;AACxE,UAAU,aAAa,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC;IAC5C,SAAS,EAAE,CAAC,CAAC;IACb,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,GAAG,CAAC;IAC9B,YAAY,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,GAAG,CAAC;IACnC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,GAAG,KAAK,GAAG,CAAC;IACtD,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAID,eAAO,MAAM,sBAAsB,+HAO9B,cAAc,CAAC,EAAE,CAAC,CAAC,gBACX,CAAC,EAAE,SAkBb,CAAC;AAEJ,eAAO,MAAM,iBAAiB,sHAMzB,cAAc,CAAC,EAAE,CAAC,CAAC,gBACX,CAAC,EAAE,SAKb,CAAC;AAEJ,UAAU,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC;IACpD,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;IAC/B,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AACD,eAAO,MAAM,qBAAqB,kGAM7B,mBAAmB,CAAC,EAAE,CAAC,CAAC,gBAChB,CAAC,EAAE,SAKb,CAAC;AAEJ,eAAO,MAAM,SAAS,OAAQ,MAAM,4BAMnC,CAAC"}
+{"version":3,"file":"container-utils.d.ts","sourceRoot":"","sources":["../../../../../../packages/sdk/kos-ui-sdk/src/core/util/container-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,UAAU,YAAY;IACpB,EAAE,EAAE,MAAM,CAAC;CACZ;AAqBD;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;AAE/E,KAAK,SAAS,GAAG,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;AAExE;;;;GAIG;AACH,UAAU,aAAa,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC;IAC5C,mCAAmC;IACnC,SAAS,EAAE,CAAC,CAAC;IACb,4DAA4D;IAC5D,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,GAAG,CAAC;IAC9B,2EAA2E;IAC3E,YAAY,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,GAAG,CAAC;IACnC,6DAA6D;IAC7D,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,aAAa,EAAE,GAAG,KAAK,GAAG,CAAC;IACtD,gEAAgE;IAChE,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAKD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,sBAAsB,+HAO9B,cAAc,CAAC,EAAE,CAAC,CAAC,gBACX,CAAC,EAAE,SAkBb,CAAC;AAEJ;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB,sHAMzB,cAAc,CAAC,EAAE,CAAC,CAAC,gBACX,CAAC,EAAE,SAKb,CAAC;AAEJ;;;;GAIG;AACH,UAAU,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC;IACpD,gDAAgD;IAChD,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,8CAA8C;IAC9C,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;IAC/B,6CAA6C;IAC7C,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,gEAAgE;IAChE,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,qBAAqB,kGAM7B,mBAAmB,CAAC,EAAE,CAAC,CAAC,gBAChB,CAAC,EAAE,SAKb,CAAC;AAEJ;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,SAAS,OAAQ,MAAM,4BAMnC,CAAC"}