@fjell/cache 4.6.10 → 4.6.13

package/dist/Operations.d.ts

@@ -0,0 +1,70 @@
+import { ComKey, Item, ItemQuery, LocKeyArray, PriKey } from '@fjell/core';
+import { ClientApi } from '@fjell/client-api';
+import { Coordinate } from '@fjell/registry';
+import { CacheMap } from './CacheMap';
+export interface Operations<V extends Item<S, L1, L2, L3, L4, L5>, S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never> {
+    /**
+     * Retrieves all the items that match the query from cache or API.
+     * Items are cached automatically after retrieval.
+     */
+    all(query?: ItemQuery, locations?: LocKeyArray<L1, L2, L3, L4, L5> | []): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]>;
+    /**
+     * Retrieves the first item that matches the query from cache or API.
+     * Item is cached automatically after retrieval.
+     */
+    one(query?: ItemQuery, locations?: LocKeyArray<L1, L2, L3, L4, L5> | []): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V | null]>;
+    /**
+     * Creates a new item via API and caches it.
+     */
+    create(item: Partial<Item<S, L1, L2, L3, L4, L5>>, locations?: LocKeyArray<L1, L2, L3, L4, L5> | []): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
+    /**
+     * Gets an item by key from cache or API and caches it.
+     */
+    get(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V | null]>;
+    /**
+     * Retrieves an item from cache if available, otherwise from API.
+     * Returns null as first element if item was already in cache.
+     */
+    retrieve(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5> | null, V | null]>;
+    /**
+     * Removes an item via API and from cache.
+     */
+    remove(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>): Promise<CacheMap<V, S, L1, L2, L3, L4, L5>>;
+    /**
+     * Updates an item via API and caches the result.
+     */
+    update(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>, item: Partial<Item<S, L1, L2, L3, L4, L5>>): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
+    /**
+     * Executes an action on an item via API and caches the result.
+     */
+    action(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>, action: string, body?: any): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
+    /**
+     * Executes an action on all items matching criteria via API and caches results.
+     */
+    allAction(action: string, body?: any, locations?: LocKeyArray<L1, L2, L3, L4, L5> | []): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]>;
+    /**
+     * Executes a facet query on an item via API (pass-through, no caching).
+     */
+    facet(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>, facet: string, params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, any]>;
+    /**
+     * Executes a facet query on all items matching criteria via API (pass-through, no caching).
+     */
+    allFacet(facet: string, params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>, locations?: LocKeyArray<L1, L2, L3, L4, L5> | []): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, any]>;
+    /**
+     * Finds items using a finder method via API and caches results.
+     */
+    find(finder: string, params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>, locations?: LocKeyArray<L1, L2, L3, L4, L5> | []): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V[]]>;
+    /**
+     * Finds a single item using a finder method via API and caches result.
+     */
+    findOne(finder: string, params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>, locations?: LocKeyArray<L1, L2, L3, L4, L5> | []): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
+    /**
+     * Sets an item directly in cache without API call.
+     */
+    set(key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>, item: Item<S, L1, L2, L3, L4, L5>): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>, V]>;
+    /**
+     * Resets the cache, clearing all cached items.
+     */
+    reset(): Promise<[CacheMap<V, S, L1, L2, L3, L4, L5>]>;
+}
+export declare const createOperations: <V extends Item<S, L1, L2, L3, L4, L5>, S extends string, L1 extends string = never, L2 extends string = never, L3 extends string = never, L4 extends string = never, L5 extends string = never>(api: ClientApi<V, S, L1, L2, L3, L4, L5>, coordinate: Coordinate<S, L1, L2, L3, L4, L5>, cacheMap: CacheMap<V, S, L1, L2, L3, L4, L5>, pkType: S) => Operations<V, S, L1, L2, L3, L4, L5>;

package/dist/Operations.es.js

@@ -0,0 +1,39 @@
+import { all } from './ops/all.es.js';
+import { one } from './ops/one.es.js';
+import { create } from './ops/create.es.js';
+import { get } from './ops/get.es.js';
+import { retrieve } from './ops/retrieve.es.js';
+import { remove } from './ops/remove.es.js';
+import { update } from './ops/update.es.js';
+import { action } from './ops/action.es.js';
+import { allAction } from './ops/allAction.es.js';
+import { facet } from './ops/facet.es.js';
+import { allFacet } from './ops/allFacet.es.js';
+import { find } from './ops/find.es.js';
+import { findOne } from './ops/findOne.es.js';
+import { set } from './ops/set.es.js';
+import { reset } from './ops/reset.es.js';
+
+// Import all operation functions
+const createOperations = (api, coordinate, cacheMap, pkType)=>{
+    return {
+        all: (query, locations)=>all(api, cacheMap, pkType, query, locations),
+        one: (query, locations)=>one(api, cacheMap, pkType, query, locations),
+        create: (item, locations)=>create(api, cacheMap, pkType, item, locations),
+        get: (key)=>get(api, cacheMap, pkType, key),
+        retrieve: (key)=>retrieve(api, cacheMap, pkType, key),
+        remove: (key)=>remove(api, cacheMap, key),
+        update: (key, item)=>update(api, cacheMap, pkType, key, item),
+        action: (key, actionName, body)=>action(api, cacheMap, pkType, key, actionName, body),
+        allAction: (actionName, body, locations)=>allAction(api, cacheMap, pkType, actionName, body, locations),
+        facet: (key, facetName, params)=>facet(api, cacheMap, key, facetName, params),
+        allFacet: (facetName, params, locations)=>allFacet(api, cacheMap, facetName, params, locations),
+        find: (finder, params, locations)=>find(api, cacheMap, pkType, finder, params, locations),
+        findOne: (finder, params, locations)=>findOne(api, cacheMap, pkType, finder, params, locations),
+        set: (key, item)=>set(cacheMap, pkType, key, item),
+        reset: ()=>reset(coordinate)
+    };
+};
+
+export { createOperations };
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiT3BlcmF0aW9ucy5lcy5qcyIsInNvdXJjZXMiOltdLCJzb3VyY2VzQ29udGVudCI6W10sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OzsifQ==