@ossy/sdk-react 3.0.9 → 3.11.0

package/build/packages/sdk-react/src/Cache.js

@@ -1 +1 @@
-import{__assign as r}from"../../../node_modules/tslib/tslib.es6.js";import t,{createContext as e,useContext as n,useReducer as u,useRef as a,useCallback as o,useMemo as c}from"react";import{AsyncStatus as i}from"./asyncStatus.js";import{emptyEntry as f}from"./cacheEntry.js";var s=e({}),l="SET",d="INVALIDATE",v=function(e){var n=e.get,v=e.set,y=e.getInitialState;return function(e){var h,p=null!==(h=null==y?void 0:y())&&void 0!==h?h:{},g=u(function(r){var t=r.set,e=r.get,n=r.getInitialState;return function(r,u){var a,o=null!==(a=null==n?void 0:n())&&void 0!==a?a:{};switch(void 0===r&&(r=o),u.type){case l:var c=void 0;if("function"==typeof u.data){var i=e(u.cacheKey,r);c=u.data(i)}else c=u.data;return t(u.cacheKey,c,r);case d:for(var s=r,v=0,y=u.keys;v<y.length;v++){var h=y[v];s=t(h,f(),s)}return s;default:return r}}}({set:v,get:n,getInitialState:y}),void 0,function(){return p}),E=g[0],S=g[1],m=a(new Set),w=a(new Map),I=o(function(){m.current.forEach(function(r){return r()})},[]),b=o(function(r){return function(t){S({type:l,cacheKey:r,data:t}),I()}},[I]),A=o(function(r){return n(r,E)},[E,n]),K=o(function(r){var t=n(r,E);return null!=t?t:f()},[E,n]),j=o(function(r,t){S({type:l,cacheKey:r,data:"function"==typeof t?function(r){return t(null!=r?r:f())}:t}),I()},[I]),k=o(function(r){var t=Array.isArray(r)?r:[r];w.current.forEach(function(r,e){t.includes(e)&&w.current.delete(e)}),S({type:d,keys:t}),I()},[I]),L=o(function(r){return m.current.add(r),function(){return m.current.delete(r)}},[]),P=o(function(t,e){var n=w.current.get(t);if(n)return n;j(t,function(t){return r(r({},t),{status:i.Loading,error:null})});var u=e().then(function(r){return j(t,{status:i.Success,data:r,error:null}),r}).catch(function(r){var e=r instanceof Error?r:new Error(String(r));throw j(t,{status:i.Error,data:void 0,error:e}),e}).finally(function(){w.current.delete(t)});return w.current.set(t,u),u},[j]),T=c(function(){return{getEntry:K,setEntry:j,invalidate:k,subscribe:L,fetch:P}},[K,j,k,L,P]);return t.createElement(s.Provider,{value:{get:A,set:b,readStore:T}},e.children)}},y=function(){var r=n(s).readStore;if(!r)throw new Error("useReadCacheStore requires WorkspaceProvider");return r};export{s as CacheContext,v as createCache,y as useReadCacheStore};
+import{__assign as r}from"../../../node_modules/tslib/tslib.es6.js";import t,{createContext as n,useContext as e,useRef as u,useReducer as o,useCallback as c,useMemo as i}from"react";import{AsyncStatus as a}from"./asyncStatus.js";import{emptyEntry as f}from"./cacheEntry.js";import{bumpGeneration as s,readGeneration as l,isCurrentGeneration as v}from"./fetchGeneration.js";var d=n({}),h=function(n){var e=n.get,h=n.set,m=n.getInitialState;return function(n){var p,y=u(null!==(p=null==m?void 0:m())&&void 0!==p?p:{}),g=o(function(r){return r+1},0)[1],E=u(new Set),S=u(new Map),w=u(new Map),b=c(function(){E.current.forEach(function(r){return r()})},[]),j=c(function(r){y.current=r,g(),b()},[b]),M=c(function(r){return e(r,y.current)},[e]),A=c(function(r){return function(t){var n=e(r,y.current),u="function"==typeof t?t(n):t;j(h(r,u,y.current))}},[e,h,j]),k=c(function(r){var t=e(r,y.current);return null!=t?t:f()},[e]),P=c(function(r,t){var n,u=null!==(n=e(r,y.current))&&void 0!==n?n:f(),o="function"==typeof t?t(u):t;j(h(r,o,y.current))},[e,h,j]),q=c(function(r){for(var t=Array.isArray(r)?r:[r],n=y.current,e=0,u=t;e<u.length;e++){var o=u[e];S.current.delete(o),s(w.current,o),n=h(o,f(),n)}j(n)},[h,j]),x=c(function(r){var t=y.current;if(t instanceof Map&&"function"==typeof r){for(var n=t,e=!1,u=0,o=Array.from(t.keys());u<o.length;u++){var c=o[u];r(c)&&(S.current.delete(c),n=h(c,f(),n),e=!0)}e&&j(n)}},[h,j]),C=c(function(r){return E.current.add(r),function(){return E.current.delete(r)}},[]),G=c(function(t,n){var e=S.current.get(t);if(e)return e;var u=l(w.current,t),o=function(){return v(w.current,t,u)};P(t,function(t){return t.status===a.Success?r(r({},t),{error:null}):r(r({},t),{status:a.Loading,error:null})});var c=n().then(function(r){return o()?(P(t,{status:a.Success,data:r,error:null}),r):r}).catch(function(r){var n=r instanceof Error?r:new Error(String(r));throw o()&&P(t,{status:a.Error,data:void 0,error:n}),n}).finally(function(){o()&&S.current.delete(t)});return S.current.set(t,c),c},[P]),I=i(function(){return{getEntry:k,setEntry:P,invalidate:q,invalidateMatching:x,subscribe:C,fetch:G}},[k,P,q,x,C,G]);return t.createElement(d.Provider,{value:{get:M,set:A,readStore:I}},n.children)}},m=function(){var r=e(d).readStore;if(!r)throw new Error("useReadCacheStore requires WorkspaceProvider");return r};export{d as CacheContext,h as createCache,m as useReadCacheStore};

package/build/packages/sdk-react/src/WorkspaceProvider.js

@@ -1 +1 @@
-import r,{createContext as e,useMemo as t}from"react";import{createCache as n,useReadCacheStore as o}from"./Cache.js";import{createMapCache as a}from"./cacheUtils.js";import{ReactSdk as i}from"./react-sdk.js";import{usePushInvalidation as m}from"./usePushInvalidation.js";var l=e({}),s=n(a());function c(r){var e=r.sdk,t=o();return m(e,t),null}var u=function(e){var n=e.sdk,o=e.enablePushInvalidation,a=void 0!==o&&o,m=e.children,u=t(function(){return i.from(n)},[n]);return r.createElement(s,null,r.createElement(l.Provider,{value:{sdk:u}},a&&r.createElement(c,{sdk:u}),m))};export{l as Context,u as WorkspaceProvider};
+import r,{createContext as e,useMemo as t}from"react";import{createCache as n,useReadCacheStore as o}from"./Cache.js";import{createMapCache as a}from"./cacheUtils.js";import{ReactSdk as i}from"./react-sdk.js";import{usePushInvalidation as m}from"./usePushInvalidation.js";var u=e({}),c=n(a());function l(r){var e=r.sdk,t=o();return m(e,t),null}var s=function(e){var n=e.sdk,o=e.enablePushInvalidation,a=void 0!==o&&o,m=e.children,s=t(function(){return i.from(n)},[n]),d=t(function(){return{sdk:s}},[s]);return r.createElement(c,null,r.createElement(u.Provider,{value:d},a&&r.createElement(l,{sdk:s}),m))};export{u as Context,s as WorkspaceProvider};

package/build/packages/sdk-react/src/cacheKey.js

@@ -1 +1 @@
-import{resolveActionId as o}from"./action.js";import{normalizeLocation as t}from"./normalizeLocation.js";import{stableSerialize as n}from"./stableSerialize.js";function r(o,t){return"projection:".concat(o,":").concat(t)}function s(s,i){var c,a=o(s);if("@ossy/resources/actions/list"===a){var e=null==i?void 0:i.location;return"location:".concat(t("string"==typeof e?e:void 0))}if("@ossy/resources/actions/search"===a)return"search:".concat(n(null!=i?i:{}));if("@ossy/resources/actions/get"===a){var l=null!==(c=null==i?void 0:i.resourceId)&&void 0!==c?c:null==i?void 0:i.id;return"resource:".concat(null!=l?l:"")}if("@ossy/booking/actions/list"===a)return"action:@ossy/booking/actions/list";if("@ossy/platform/actions/list-task-runs"===a){var u=null==i?void 0:i.workspaceId;return r("@ossy/platform/data/task-run-list",String(null!=u?u:""))}var f=n(i);return f?"action:".concat(a,":").concat(f):"action:".concat(a)}export{s as cacheKey,r as projectionKey};
+import{stableSerialize as o}from"./stableSerialize.js";import{normalizeLocation as t}from"./normalizeLocation.js";import{resolveActionId as n}from"./action.js";var r=["limit","offset","sortBy","sortOrder","sort"];function i(o){return"location:".concat(t(o))}function c(o){return"list:".concat(t(o),":")}function s(o,t){return"projection:".concat(o,":").concat(t)}function a(a,e){var l,u=n(a);if("@ossy/resources/actions/list"===u){var f=null==e?void 0:e.location,v=t("string"==typeof f?f:void 0),d=function(o){if(!o||"object"!=typeof o)return null;for(var t={},n=!1,i=0,c=r;i<c.length;i++){var s=c[i];void 0!==o[s]&&null!==o[s]&&""!==o[s]&&(t[s]=o[s],n=!0)}return n?t:null}(e);return d?"".concat(c(v)).concat(o(d)):i(v)}if("@ossy/resources/actions/search"===u)return"search:".concat(o(null!=e?e:{}));if("@ossy/resources/actions/get"===u){var m=null!==(l=null==e?void 0:e.resourceId)&&void 0!==l?l:null==e?void 0:e.id;return"resource:".concat(null!=m?m:"")}if("@ossy/booking/actions/list"===u)return"action:@ossy/booking/actions/list";if("@ossy/platform/actions/list-task-runs"===u){var p=null==e?void 0:e.workspaceId;return s("@ossy/platform/data/task-run-list",String(null!=p?p:""))}var y=o(e);return y?"action:".concat(u,":").concat(y):"action:".concat(u)}export{a as cacheKey,i as locationListCacheKey,c as locationListCachePrefix,s as projectionKey};

package/build/packages/sdk-react/src/fetchGeneration.js

@@ -0,0 +1 @@
+function n(n,t){var r,u=(null!==(r=n.get(t))&&void 0!==r?r:0)+1;return n.set(t,u),u}function t(n,t){var r;return null!==(r=n.get(t))&&void 0!==r?r:0}function r(n,r,u){return t(n,r)===u}export{n as bumpGeneration,r as isCurrentGeneration,t as readGeneration};

package/build/packages/sdk-react/src/public.index.js

@@ -1 +1 @@
-export{AsyncStatus}from"./asyncStatus.js";export{normalizeLocation}from"./normalizeLocation.js";export{ReactSdk}from"./react-sdk.js";export{resolveActionId,toActionRef}from"./action.js";export{Context,WorkspaceProvider}from"./WorkspaceProvider.js";export{PushInvalidationSubscriber}from"./PushInvalidationSubscriber.js";export{useSdk}from"./useSdk.js";export{useRead}from"./useRead.js";export{usePushInvalidation}from"./usePushInvalidation.js";export{applyOptimisticResource,rollbackOptimisticResource}from"./optimisticResource.js";export{cacheKey,projectionKey}from"./cacheKey.js";export{stableSerialize}from"./stableSerialize.js";export{useReadCacheStore}from"./Cache.js";
+export{AsyncStatus}from"./asyncStatus.js";export{normalizeLocation}from"./normalizeLocation.js";export{ReactSdk}from"./react-sdk.js";export{resolveActionId,toActionRef}from"./action.js";export{Context,WorkspaceProvider}from"./WorkspaceProvider.js";export{PushInvalidationSubscriber}from"./PushInvalidationSubscriber.js";export{useSdk}from"./useSdk.js";export{useRead}from"./useRead.js";export{usePushInvalidation}from"./usePushInvalidation.js";export{applyOptimisticResource,rollbackOptimisticResource}from"./optimisticResource.js";export{cacheKey,locationListCacheKey,locationListCachePrefix,projectionKey}from"./cacheKey.js";export{stableSerialize}from"./stableSerialize.js";export{useReadCacheStore}from"./Cache.js";

package/build/packages/sdk-react/src/usePushInvalidation.js

@@ -1 +1 @@
-import{useEffect as i}from"react";function n(n,o){i(function(){if((null==n?void 0:n.workspaceId)&&"function"==typeof n.subscribePush)return n.subscribePush({onMessage:function(i){var n;(null===(n=null==i?void 0:i.invalidate)||void 0===n?void 0:n.length)&&o.invalidate(i.invalidate)}})},[n,o])}export{n as usePushInvalidation};
+import{useEffect as i}from"react";import{locationListCachePrefix as t}from"./cacheKey.js";function n(n,o){i(function(){if((null==n?void 0:n.workspaceId)&&"function"==typeof n.subscribePush)return n.subscribePush({onMessage:function(i){var n;if(null===(n=null==i?void 0:i.invalidate)||void 0===n?void 0:n.length)for(var e=function(i){if("string"==typeof i&&i.startsWith("location:")){var n=i.slice(9),e=t(n);return o.invalidateMatching(function(t){return t===i||t.startsWith(e)}),"continue"}o.invalidate(i)},r=0,a=i.invalidate;r<a.length;r++){e(a[r])}}})},[n,o])}export{n as usePushInvalidation};

package/build/packages/sdk-react/src/useSdk.js

@@ -1 +1 @@
-import{__awaiter as e,__generator as r}from"../../../node_modules/tslib/tslib.es6.js";import{useContext as t,useRef as o,useCallback as i,useMemo as n}from"react";import{cacheKey as s}from"./cacheKey.js";import{Context as c}from"./WorkspaceProvider.js";import{useReadCacheStore as u}from"./Cache.js";import{useRead as a}from"./useRead.js";import{rollbackOptimisticResource as d,applyOptimisticResource as m}from"./optimisticResource.js";function l(){var l=this,f=t(c).sdk,p=u(),v=o(new Map),h=i(function(e){p.invalidate(e)},[p]),k=i(function(e,r){return f.invoke(e,r)},[f]),j=i(function(t,o,i){return e(l,void 0,void 0,function(){var e,n;return r(this,function(r){switch(r.label){case 0:e=null,(null==i?void 0:i.resourceId)&&(e=m(p,i))&&v.current.set(i.resourceId,e),r.label=1;case 1:return r.trys.push([1,3,,4]),[4,f.invoke(t,o)];case 2:return[2,r.sent()];case 3:throw n=r.sent(),(null==i?void 0:i.resourceId)&&(d(p,i.resourceId,e),v.current.delete(i.resourceId)),n;case 4:return[2]}})})},[f,p]);return n(function(){return{invoke:k,invokeOptimistic:j,read:a,invalidate:h,cacheKey:s,sdk:f}},[k,j,h,f])}export{l as useSdk};
+import{__awaiter as r,__generator as e}from"../../../node_modules/tslib/tslib.es6.js";import{useContext as t,useRef as n,useCallback as i,useMemo as o}from"react";import{locationListCacheKey as c,locationListCachePrefix as a,cacheKey as s}from"./cacheKey.js";import{Context as u}from"./WorkspaceProvider.js";import{useReadCacheStore as d}from"./Cache.js";import{useRead as l}from"./useRead.js";import{rollbackOptimisticResource as m,applyOptimisticResource as v}from"./optimisticResource.js";import{normalizeLocation as f}from"./normalizeLocation.js";function p(){var p=this,h=t(u).sdk,j=d(),k=n(j);k.current=j;var I=n(new Map),b=i(function(r){k.current.invalidate(r)},[]),M=i(function(r){k.current.invalidateMatching(r)},[]),g=i(function(r){var e=f(r),t=c(e),n=a(e);k.current.invalidateMatching(function(r){return r===t||r.startsWith(n)})},[]),w=i(function(r,e){return h.invoke(r,e)},[h]),y=i(function(t,n,i){return r(p,void 0,void 0,function(){var r,o,c;return e(this,function(e){switch(e.label){case 0:r=k.current,o=null,(null==i?void 0:i.resourceId)&&(o=v(r,i))&&I.current.set(i.resourceId,o),e.label=1;case 1:return e.trys.push([1,3,,4]),[4,h.invoke(t,n)];case 2:return[2,e.sent()];case 3:throw c=e.sent(),(null==i?void 0:i.resourceId)&&(m(r,i.resourceId,o),I.current.delete(i.resourceId)),c;case 4:return[2]}})})},[h]);return o(function(){return{invoke:w,invokeOptimistic:y,read:l,invalidate:b,invalidateMatching:M,invalidateLocation:g,cacheKey:s,sdk:h}},[w,y,b,M,g,h])}export{p as useSdk};

package/build/public.index.d.ts

@@ -84,6 +84,10 @@ declare const WorkspaceProvider: ({ sdk, enablePushInvalidation, children, }: Pr
  */
 declare function PushInvalidationSubscriber(): null;
 
+/** Exact unpaginated list key for a folder location. */
+declare function locationListCacheKey(location?: string): string;
+/** Prefix used for paginated/sorted list variants of a folder. */
+declare function locationListCachePrefix(location?: string): string;
 declare function projectionKey(projectionId: string, scopeId: string): string;
 declare function cacheKey(action: ActionRef | string, payload?: Record<string, unknown>): string;
 
@@ -110,6 +114,8 @@ interface ReadCacheStore {
     getEntry: (key: string) => CacheEntry;
     setEntry: (key: string, entry: CacheEntry | ((prev: CacheEntry) => CacheEntry)) => void;
     invalidate: (key: string | string[]) => void;
+    /** Clear every cache entry whose key matches the predicate (e.g. location list variants). */
+    invalidateMatching: (match: (key: string) => boolean) => void;
     subscribe: (listener: Listener) => () => void;
     fetch: <T>(key: string, fetcher: () => Promise<T>) => Promise<T>;
 }
@@ -136,6 +142,9 @@ interface SdkApi {
     invokeOptimistic: (action: Parameters<ReactSdk['invoke']>[0], payload?: Record<string, unknown>, optimistic?: OptimisticResourceEvent) => ReturnType<ReactSdk['invoke']>;
     read: typeof useRead;
     invalidate: (key: string | string[]) => void;
+    invalidateMatching: (match: (key: string) => boolean) => void;
+    /** Invalidate unpaginated + paginated list cache entries for a folder. */
+    invalidateLocation: (location: string) => void;
     cacheKey: typeof cacheKey;
     sdk: ReactSdk;
 }
@@ -154,5 +163,5 @@ declare function usePushInvalidation(sdk: {
 /** Deterministic JSON for cache keys — sorted object keys, no Ramda. */
 declare function stableSerialize(value: unknown): string;
 
-export { AsyncStatus, Context, PushInvalidationSubscriber, ReactSdk, WorkspaceProvider, applyOptimisticResource, cacheKey, normalizeLocation, projectionKey, resolveActionId, rollbackOptimisticResource, stableSerialize, toActionRef, usePushInvalidation, useRead, useReadCacheStore, useSdk };
+export { AsyncStatus, Context, PushInvalidationSubscriber, ReactSdk, WorkspaceProvider, applyOptimisticResource, cacheKey, locationListCacheKey, locationListCachePrefix, normalizeLocation, projectionKey, resolveActionId, rollbackOptimisticResource, stableSerialize, toActionRef, usePushInvalidation, useRead, useReadCacheStore, useSdk };
 export type { ActionRef, AsyncStatusType, Config, OptimisticResourceEvent, ReadOptions, ReadResult, SdkApi, WorkspaceProviderProps };

package/build/types/Cache.d.ts

@@ -11,9 +11,16 @@ export interface ReadCacheStore {
     getEntry: (key: string) => CacheEntry;
     setEntry: (key: string, entry: CacheEntry | ((prev: CacheEntry) => CacheEntry)) => void;
     invalidate: (key: string | string[]) => void;
+    /** Clear every cache entry whose key matches the predicate (e.g. location list variants). */
+    invalidateMatching: (match: (key: string) => boolean) => void;
     subscribe: (listener: Listener) => () => void;
     fetch: <T>(key: string, fetcher: () => Promise<T>) => Promise<T>;
 }
+/**
+ * Keep the store object identity stable across cache writes.
+ * `getEntry` used to close over `state`, so every completed read rebuilt
+ * `useSdk()` and retriggered `useEffect(..., [sdk])` loaders (~0.5s flicker).
+ */
 export declare const createCache: ({ get: _get, set: _set, getInitialState, }: CacheConfig) => (props: any) => React.JSX.Element;
 export declare const useCache: (cacheKey: string, defaultValue?: unknown) => {
     data: any;

package/build/types/cacheKey.d.ts

@@ -1,3 +1,7 @@
 import { type ActionRef } from './action';
+/** Exact unpaginated list key for a folder location. */
+export declare function locationListCacheKey(location?: string): string;
+/** Prefix used for paginated/sorted list variants of a folder. */
+export declare function locationListCachePrefix(location?: string): string;
 export declare function projectionKey(projectionId: string, scopeId: string): string;
 export declare function cacheKey(action: ActionRef | string, payload?: Record<string, unknown>): string;

package/build/types/fetchGeneration.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generation tokens for read-cache fetches.
+ * invalidate() bumps the token so orphaned in-flight responses cannot write.
+ */
+export function bumpGeneration(generations: any, key: any): any;
+export function readGeneration(generations: any, key: any): any;
+export function isCurrentGeneration(generations: any, key: any, generation: any): boolean;

package/build/types/useSdk.d.ts

@@ -7,6 +7,9 @@ export interface SdkApi {
     invokeOptimistic: (action: Parameters<ReactSdk['invoke']>[0], payload?: Record<string, unknown>, optimistic?: OptimisticResourceEvent) => ReturnType<ReactSdk['invoke']>;
     read: typeof useRead;
     invalidate: (key: string | string[]) => void;
+    invalidateMatching: (match: (key: string) => boolean) => void;
+    /** Invalidate unpaginated + paginated list cache entries for a folder. */
+    invalidateLocation: (location: string) => void;
     cacheKey: typeof cacheKey;
     sdk: ReactSdk;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ossy/sdk-react",
   "description": "Software Development Kit React",
-  "version": "3.0.9",
+  "version": "3.11.0",
   "url": "git://github.com/ossy-se/packages/sdk-react",
   "source": "src/public.index.ts",
   "main": "./build/packages/sdk-react/src/public.index.js",
@@ -17,7 +17,7 @@
   "scripts": {
     "start": "",
     "build": "rollup -c rollup.config.js",
-    "test": ""
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --verbose"
   },
   "browserslist": {
     "production": [
@@ -37,7 +37,9 @@
     "@babel/eslint-parser": "^7.15.8",
     "@babel/preset-env": "^7.26.0",
     "@babel/preset-react": "^7.24.1",
-    "@babel/preset-typescript": "^7.26.0"
+    "@babel/preset-typescript": "^7.26.0",
+    "@jest/globals": "^30.2.0",
+    "jest": "^30.2.0"
   },
   "peerDependencies": {
     "@ossy/fold": ">=1.0.0 <4.0.0",
@@ -53,5 +55,5 @@
     "/build",
     "README.md"
   ],
-  "gitHead": "908fae28675f6c3c179d4c2eecb451e8a1af886e"
+  "gitHead": "53ff8456920e09151c9d88df4a6c3ee958d811eb"
 }