@ossy/sdk 1.25.2 → 1.26.0

package/build/public.index.d.ts

@@ -68,6 +68,15 @@ declare const WorkspacesDisableService: Action<{
     service: any;
 }>;
 declare const WorkspacesGetUsers: Action;
+declare const WorkspacesAddMember: Action<{
+    userId: string;
+    workspaceId: string;
+    createdBy?: string;
+}>;
+declare const WorkspacesRemoveMember: Action<{
+    userId: string;
+    workspaceId: string;
+}>;
 declare const UserCurrentGet: Action;
 declare const UserCurrentGetHistory: Action;
 declare const UserCurrentUpdate: Action<{
@@ -190,6 +199,15 @@ declare class SDK {
     };
     get users(): {
         list: (_payload?: Required<{} | undefined>) => Promise<any>;
+        addWorkspace: (_payload?: Required<{
+            userId: string;
+            workspaceId: string;
+            createdBy?: string;
+        } | undefined>) => Promise<any>;
+        removeWorkspace: (_payload?: Required<{
+            userId: string;
+            workspaceId: string;
+        } | undefined>) => Promise<any>;
     };
     get currentUser(): {
         get: (_payload?: Required<{} | undefined>) => Promise<any>;
@@ -273,4 +291,34 @@ declare class SDK {
     makeRequest: <T extends Action>(action: T) => (_payload?: Required<T["payload"]>) => Promise<any>;
 }
 
-export { ApiTokenCreate, ApiTokenGetAll, ApiTokenInvalidate, AuthGetAuthenticatedUser, AuthGetAuthenticatedUserHistory, AuthGetUser, AuthSignIn, AuthSignOff, AuthSignUp, AuthVerifyInvitation, AuthVerifySignIn, ResourceUpdateAccess, ResourcesCreate, ResourcesCreateDirectory, ResourcesGet, ResourcesList, ResourcesMove, ResourcesRemove, ResourcesRename, ResourcesSearch, ResourcesUpdateContent, ResourcesUpload, ResourcesUploadNamedVersion, SDK, UserCurrentGet, UserCurrentGetHistory, UserCurrentUpdate, WorkspacesCreate, WorkspacesCreateApiToken, WorkspacesDisableService, WorkspacesEnableService, WorkspacesGet, WorkspacesGetApiTokens, WorkspacesGetCurrent, WorkspacesGetResourceTemplates, WorkspacesGetUsers, WorkspacesImportResourceTemplates, WorkspacesInviteUser, WorkspacesList };
+/**
+ * Unified interface for all SDK adapters.
+ *
+ * Adapters translate the generic `dispatch` / `query` calls into
+ * concrete operations — direct MongoDB writes (EventStoreAdapter),
+ * HTTP calls (HttpAdapter), or an in-memory store (InMemoryAdapter).
+ *
+ * Action names follow the pattern `{domain}/{verb}`, e.g.:
+ *   - `workspaces/create`
+ *   - `resources/create`
+ *   - `user/join-workspace`
+ *
+ * Query names follow the same pattern, e.g.:
+ *   - `workspaces/list`
+ *   - `resources/list`
+ *   - `resources/search`
+ */
+interface OssySdkAdapter {
+    /**
+     * Dispatch a write action. Returns the resulting entity/resource,
+     * or null for fire-and-forget operations.
+     */
+    dispatch(action: string, payload: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Execute a read query. Returns the matching data.
+     */
+    query(name: string, params?: Record<string, unknown>): Promise<unknown>;
+}
+
+export { ApiTokenCreate, ApiTokenGetAll, ApiTokenInvalidate, AuthGetAuthenticatedUser, AuthGetAuthenticatedUserHistory, AuthGetUser, AuthSignIn, AuthSignOff, AuthSignUp, AuthVerifyInvitation, AuthVerifySignIn, ResourceUpdateAccess, ResourcesCreate, ResourcesCreateDirectory, ResourcesGet, ResourcesList, ResourcesMove, ResourcesRemove, ResourcesRename, ResourcesSearch, ResourcesUpdateContent, ResourcesUpload, ResourcesUploadNamedVersion, SDK, UserCurrentGet, UserCurrentGetHistory, UserCurrentUpdate, WorkspacesAddMember, WorkspacesCreate, WorkspacesCreateApiToken, WorkspacesDisableService, WorkspacesEnableService, WorkspacesGet, WorkspacesGetApiTokens, WorkspacesGetCurrent, WorkspacesGetResourceTemplates, WorkspacesGetUsers, WorkspacesImportResourceTemplates, WorkspacesInviteUser, WorkspacesList, WorkspacesRemoveMember };
+export type { OssySdkAdapter };

package/build/public.index.js

@@ -1 +1 @@
-const e={VisualContentDescriptors:"@ossy/tasks/visual-content-descriptors",ResizeCommonWeb:"@ossy/tasks/resize-common-web"},t={Queued:"queued",InProgress:"in progress",Success:"success",Failed:"failed"};class s{static of(e){return new s(e)}constructor(e){this.http=null==e?void 0:e.http,this.resources=e.resources}get(e={}){const t="string"==typeof e?{id:e}:e;return t.location=s.location,this.resources.search({query:t})}getUnprocessed(){return this.resources.search({$and:[{$or:[{"content.nextReevaluation":{$exists:!1}},{"content.nextReevaluation":null},{"content.nextReevaluation":{$lt:Date.now()}}]},{"content.status":{$in:["queued","failed"]}},{location:"/@ossy/tasks/"},{type:{$regex:"^@ossy/media-tasks"}}]})}create({type:i,resourceId:n}){if(!Object.values(e).includes(i))throw new Error(`Task type ${i} does not exist`);if(!n)throw new Error("Resource ID is required");return this.resources.create({type:i,location:s.location,name:`[${t.Queued}] ${n}`,content:{resourceId:n,status:t.Queued,result:void 0}})}}s.location="/@ossy/tasks/";const i={id:"api-tokens.get-all",endpoint:"/users/me/tokens",method:"GET"},n={id:"api-tokens.create",endpoint:"/users/me/tokens",method:"POST"},o={id:"api-tokens.invalidate",endpoint:"/users/me/tokens/:id",method:"DELETE"},r={id:"workspaces.get-all",endpoint:"/workspaces",method:"GET"},a={id:"workspaces.get-current",endpoint:"/workspaces/current",method:"GET"},d={id:"workspaces.get",endpoint:"/workspaces/:id",method:"GET"},u={id:"workspaces.create",endpoint:"/workspaces",method:"POST"},h={id:"workspaces.import-resource-templates",endpoint:"/resource-templates",method:"POST"},c={id:"workspaces.get-resource-templates",endpoint:"/resource-templates",method:"GET"},p={id:"workspaces.create-api-token",endpoint:"/tokens",method:"POST"},m={id:"workspaces.get-api-tokens",endpoint:"/tokens",method:"GET"},k={id:"workspaces.invite-user",endpoint:"/invitations",method:"POST"},l={id:"workspaces.enable-service",endpoint:"/services/enable",method:"POST"},b={id:"workspaces.disable-service",endpoint:"/services/disable",method:"POST"},g={id:"workspaces.get-users",endpoint:"/users",method:"GET"},T={id:"user.get",endpoint:"/users/me",method:"GET"},R={id:"user.get-history",endpoint:"/users/me/history",method:"GET"},q={id:"user.update",endpoint:"/users/me",method:"PUT"},y={id:"resources.create-directory",endpoint:"/resources",method:"POST",payload:{type:"directory"}},w={id:"resources.create",endpoint:"/resources",method:"POST"},v={id:"resources.upload",endpoint:"/resources",method:"POST"},f={id:"resources.upload-named-version",endpoint:"/resources/:id/:name",method:"PUT"},E={id:"resources.get",endpoint:"/resources/:id",method:"GET"},P={id:"resources.list",endpoint:"/resources?:search",method:"GET"},U={id:"resources.search",endpoint:"/resources/search",method:"POST"},O={id:"resources.update-access",endpoint:"/resources/:id/access",method:"PUT"},S={id:"resources.remove",endpoint:"/resources/:id",method:"DELETE"},G={id:"resources.update-content",endpoint:"/resources/:id/content",method:"PUT"},j={id:"resources.move",endpoint:"/resources/:id/location",method:"PUT"},I={id:"resources.rename",endpoint:"/resources/:id/name",method:"PUT"},z={id:"auth.sign-up",endpoint:"/users/sign-up",method:"POST"},$={id:"auth.sign-in",endpoint:"/users/sign-in",method:"POST"},x={id:"auth.verify-sign-in",endpoint:"/users/verify-sign-in?token=:token",method:"GET"},C={id:"auth.verify-invitation",endpoint:"/workspaces/:workspaceId/invitations?token=:token",method:"GET"},D={id:"auth.get-authenticated-user",endpoint:"/users/me",method:"GET"},A={id:"auth.get-authenticated-user-history",endpoint:"/users/me/history",method:"GET"},L={id:"auth.get-user",endpoint:"/users/:id",method:"GET"},Q={id:"auth.sign-off",endpoint:"/users/sign-off",method:"GET"};class N{static of(e){return new N(e)}constructor(e){this.baseUrl="https://api.ossy.se/api/v0",this.makeRequest=e=>t=>{let s={};(t||e.payload)&&(s=Object.assign(Object.assign({},e.payload||{}),t||{}));let i="apiUrl"in s?null==s?void 0:s.apiUrl:this.baseUrl,n="workspaceId"in s?s.workspaceId:this.workspaceId,o="authorization"in s?s.authorization:this.authorization,r=e.endpoint;if(s){const t=Object.keys(s);r=e.endpoint,r=t.reduce((e,t)=>e.replace(`:${t}`,`${s[t]}`),e.endpoint)}const a=`${i}${r}`,d={method:e.method,credentials:"include",headers:{"Content-Type":"application/json"}};return n&&(d.headers=Object.assign(Object.assign({},d.headers),{workspaceId:n})),o&&(d.headers=Object.assign(Object.assign({},d.headers),{Authorization:o})),"GET"!==d.method&&s&&(d.body=JSON.stringify(s)),fetch(a,d).then(e=>{const t=e.headers.get("Content-Type")||"",s=e.status;return 400===s?e.json().then(e=>Promise.reject(e.error)):[200,204].includes(s)?t.includes("application/json")?e.json():e:Promise.reject(e)})},this.updateConfig(e)}updateConfig(e){this.baseUrl=e.apiUrl||this.baseUrl,this.workspaceId=e.workspaceId||this.workspaceId,this.authorization=e.authorization||this.authorization}get apiTokens(){return{list:this.makeRequest(i).bind(this),create:this.makeRequest(n).bind(this),invalidate:this.makeRequest(o).bind(this)}}get workspaces(){return{current:this.makeRequest(a).bind(this),list:this.makeRequest(r).bind(this),get:this.makeRequest(d).bind(this),create:this.makeRequest(u).bind(this),importResourceTemplates:this.makeRequest(h).bind(this),getResourceTemplates:this.makeRequest(c).bind(this),createApiToken:this.makeRequest(p).bind(this),getApiTokens:this.makeRequest(m).bind(this),inviteUser:this.makeRequest(k).bind(this),enableService:this.makeRequest(l).bind(this),disableService:this.makeRequest(b).bind(this)}}get users(){return{list:this.makeRequest(g).bind(this)}}get currentUser(){return{get:this.makeRequest(T).bind(this),update:this.makeRequest(q).bind(this),history:this.makeRequest(R).bind(this)}}get resources(){return{createDirectory:this.makeRequest(y).bind(this),create:this.makeRequest(w).bind(this),access:this.makeRequest(O).bind(this),upload:({location:e="/",file:t})=>{const s={type:t.type,location:e,name:t.name,size:t.size};return this.makeRequest(v)(s).then(e=>fetch(e.content.uploadUrl,{method:"PUT",body:t}).then(()=>e))},uploadNamedVersion:({id:e,name:t,file:s})=>{const i={id:e,name:t,size:s.size};this.makeRequest(f)(i).then(e=>fetch(e.content.uploadUrl,{method:"PUT",body:s}).then(()=>e))},get:this.makeRequest(E).bind(this),list:e=>{const t=new URLSearchParams(Object.assign({},e)).toString();return this.makeRequest(P)({search:t})},search:this.makeRequest(U).bind(this),remove:this.makeRequest(S).bind(this),updateContent:this.makeRequest(G).bind(this),move:this.makeRequest(j).bind(this),rename:this.makeRequest(I).bind(this)}}get auth(){return{signUp:this.makeRequest(z).bind(this),signIn:this.makeRequest($).bind(this),verifySignIn:this.makeRequest(x).bind(this),verifyInvitation:this.makeRequest(C).bind(this),getAuthenticatedUser:this.makeRequest(D).bind(this),getAuthenticatedUserHistory:this.makeRequest(A).bind(this),getUser:this.makeRequest(L).bind(this),signOff:this.makeRequest(Q).bind(this)}}get tasks(){return s.of({resources:this.resources})}}export{n as ApiTokenCreate,i as ApiTokenGetAll,o as ApiTokenInvalidate,D as AuthGetAuthenticatedUser,A as AuthGetAuthenticatedUserHistory,L as AuthGetUser,$ as AuthSignIn,Q as AuthSignOff,z as AuthSignUp,C as AuthVerifyInvitation,x as AuthVerifySignIn,O as ResourceUpdateAccess,w as ResourcesCreate,y as ResourcesCreateDirectory,E as ResourcesGet,P as ResourcesList,j as ResourcesMove,S as ResourcesRemove,I as ResourcesRename,U as ResourcesSearch,G as ResourcesUpdateContent,v as ResourcesUpload,f as ResourcesUploadNamedVersion,N as SDK,t as TaskStatus,e as Tasks,T as UserCurrentGet,R as UserCurrentGetHistory,q as UserCurrentUpdate,u as WorkspacesCreate,p as WorkspacesCreateApiToken,b as WorkspacesDisableService,l as WorkspacesEnableService,d as WorkspacesGet,m as WorkspacesGetApiTokens,a as WorkspacesGetCurrent,c as WorkspacesGetResourceTemplates,g as WorkspacesGetUsers,h as WorkspacesImportResourceTemplates,k as WorkspacesInviteUser,r as WorkspacesList};
+const e={VisualContentDescriptors:"@ossy/tasks/visual-content-descriptors",ResizeCommonWeb:"@ossy/tasks/resize-common-web"},t={Queued:"queued",InProgress:"in progress",Success:"success",Failed:"failed"};class s{static of(e){return new s(e)}constructor(e){this.http=null==e?void 0:e.http,this.resources=e.resources}get(e={}){const t="string"==typeof e?{id:e}:e;return t.location=s.location,this.resources.search({query:t})}getUnprocessed(){return this.resources.search({$and:[{$or:[{"content.nextReevaluation":{$exists:!1}},{"content.nextReevaluation":null},{"content.nextReevaluation":{$lt:Date.now()}}]},{"content.status":{$in:["queued","failed"]}},{location:"/@ossy/tasks/"},{type:{$regex:"^@ossy/media-tasks"}}]})}create({type:i,resourceId:o}){if(!Object.values(e).includes(i))throw new Error(`Task type ${i} does not exist`);if(!o)throw new Error("Resource ID is required");return this.resources.create({type:i,location:s.location,name:`[${t.Queued}] ${o}`,content:{resourceId:o,status:t.Queued,result:void 0}})}}s.location="/@ossy/tasks/";const i={id:"api-tokens.get-all",endpoint:"/users/me/tokens",method:"GET"},o={id:"api-tokens.create",endpoint:"/users/me/tokens",method:"POST"},n={id:"api-tokens.invalidate",endpoint:"/users/me/tokens/:id",method:"DELETE"},r={id:"workspaces.get-all",endpoint:"/workspaces",method:"GET"},a={id:"workspaces.get-current",endpoint:"/workspaces/current",method:"GET"},d={id:"workspaces.get",endpoint:"/workspaces/:id",method:"GET"},u={id:"workspaces.create",endpoint:"/workspaces",method:"POST"},h={id:"workspaces.import-resource-templates",endpoint:"/resource-templates",method:"POST"},c={id:"workspaces.get-resource-templates",endpoint:"/resource-templates",method:"GET"},p={id:"workspaces.create-api-token",endpoint:"/tokens",method:"POST"},m={id:"workspaces.get-api-tokens",endpoint:"/tokens",method:"GET"},k={id:"workspaces.invite-user",endpoint:"/invitations",method:"POST"},l={id:"workspaces.enable-service",endpoint:"/services/enable",method:"POST"},b={id:"workspaces.disable-service",endpoint:"/services/disable",method:"POST"},g={id:"workspaces.get-users",endpoint:"/users",method:"GET"},T={id:"workspaces.add-member",endpoint:"/users/:userId/workspaces",method:"POST"},R={id:"workspaces.remove-member",endpoint:"/users/:userId/workspaces/:workspaceId",method:"DELETE"},q={id:"user.get",endpoint:"/users/me",method:"GET"},w={id:"user.get-history",endpoint:"/users/me/history",method:"GET"},y={id:"user.update",endpoint:"/users/me",method:"PUT"},v={id:"resources.create-directory",endpoint:"/resources",method:"POST",payload:{type:"directory"}},E={id:"resources.create",endpoint:"/resources",method:"POST"},f={id:"resources.upload",endpoint:"/resources",method:"POST"},P={id:"resources.upload-named-version",endpoint:"/resources/:id/:name",method:"PUT"},O={id:"resources.get",endpoint:"/resources/:id",method:"GET"},U={id:"resources.list",endpoint:"/resources?:search",method:"GET"},S={id:"resources.search",endpoint:"/resources/search",method:"POST"},G={id:"resources.update-access",endpoint:"/resources/:id/access",method:"PUT"},I={id:"resources.remove",endpoint:"/resources/:id",method:"DELETE"},j={id:"resources.update-content",endpoint:"/resources/:id/content",method:"PUT"},z={id:"resources.move",endpoint:"/resources/:id/location",method:"PUT"},$={id:"resources.rename",endpoint:"/resources/:id/name",method:"PUT"},x={id:"auth.sign-up",endpoint:"/users/sign-up",method:"POST"},C={id:"auth.sign-in",endpoint:"/users/sign-in",method:"POST"},D={id:"auth.verify-sign-in",endpoint:"/users/verify-sign-in?token=:token",method:"GET"},A={id:"auth.verify-invitation",endpoint:"/workspaces/:workspaceId/invitations?token=:token",method:"GET"},L={id:"auth.get-authenticated-user",endpoint:"/users/me",method:"GET"},Q={id:"auth.get-authenticated-user-history",endpoint:"/users/me/history",method:"GET"},W={id:"auth.get-user",endpoint:"/users/:id",method:"GET"},N={id:"auth.sign-off",endpoint:"/users/sign-off",method:"GET"};class V{static of(e){return new V(e)}constructor(e){this.baseUrl="https://api.ossy.se/api/v0",this.makeRequest=e=>t=>{let s={};(t||e.payload)&&(s=Object.assign(Object.assign({},e.payload||{}),t||{}));let i="apiUrl"in s?null==s?void 0:s.apiUrl:this.baseUrl,o="workspaceId"in s?s.workspaceId:this.workspaceId,n="authorization"in s?s.authorization:this.authorization,r=e.endpoint;if(s){const t=Object.keys(s);r=e.endpoint,r=t.reduce((e,t)=>e.replace(`:${t}`,`${s[t]}`),e.endpoint)}const a=`${i}${r}`,d={method:e.method,credentials:"include",headers:{"Content-Type":"application/json"}};return o&&(d.headers=Object.assign(Object.assign({},d.headers),{workspaceId:o})),n&&(d.headers=Object.assign(Object.assign({},d.headers),{Authorization:n})),"GET"!==d.method&&s&&(d.body=JSON.stringify(s)),fetch(a,d).then(e=>{const t=e.headers.get("Content-Type")||"",s=e.status;return 400===s?e.json().then(e=>Promise.reject(e.error)):[200,204].includes(s)?t.includes("application/json")?e.json():e:Promise.reject(e)})},this.updateConfig(e)}updateConfig(e){this.baseUrl=e.apiUrl||this.baseUrl,this.workspaceId=e.workspaceId||this.workspaceId,this.authorization=e.authorization||this.authorization}get apiTokens(){return{list:this.makeRequest(i).bind(this),create:this.makeRequest(o).bind(this),invalidate:this.makeRequest(n).bind(this)}}get workspaces(){return{current:this.makeRequest(a).bind(this),list:this.makeRequest(r).bind(this),get:this.makeRequest(d).bind(this),create:this.makeRequest(u).bind(this),importResourceTemplates:this.makeRequest(h).bind(this),getResourceTemplates:this.makeRequest(c).bind(this),createApiToken:this.makeRequest(p).bind(this),getApiTokens:this.makeRequest(m).bind(this),inviteUser:this.makeRequest(k).bind(this),enableService:this.makeRequest(l).bind(this),disableService:this.makeRequest(b).bind(this)}}get users(){return{list:this.makeRequest(g).bind(this),addWorkspace:this.makeRequest(T).bind(this),removeWorkspace:this.makeRequest(R).bind(this)}}get currentUser(){return{get:this.makeRequest(q).bind(this),update:this.makeRequest(y).bind(this),history:this.makeRequest(w).bind(this)}}get resources(){return{createDirectory:this.makeRequest(v).bind(this),create:this.makeRequest(E).bind(this),access:this.makeRequest(G).bind(this),upload:({location:e="/",file:t})=>{const s={type:t.type,location:e,name:t.name,size:t.size};return this.makeRequest(f)(s).then(e=>fetch(e.content.uploadUrl,{method:"PUT",body:t}).then(()=>e))},uploadNamedVersion:({id:e,name:t,file:s})=>{const i={id:e,name:t,size:s.size};this.makeRequest(P)(i).then(e=>fetch(e.content.uploadUrl,{method:"PUT",body:s}).then(()=>e))},get:this.makeRequest(O).bind(this),list:e=>{const t=new URLSearchParams(Object.assign({},e)).toString();return this.makeRequest(U)({search:t})},search:this.makeRequest(S).bind(this),remove:this.makeRequest(I).bind(this),updateContent:this.makeRequest(j).bind(this),move:this.makeRequest(z).bind(this),rename:this.makeRequest($).bind(this)}}get auth(){return{signUp:this.makeRequest(x).bind(this),signIn:this.makeRequest(C).bind(this),verifySignIn:this.makeRequest(D).bind(this),verifyInvitation:this.makeRequest(A).bind(this),getAuthenticatedUser:this.makeRequest(L).bind(this),getAuthenticatedUserHistory:this.makeRequest(Q).bind(this),getUser:this.makeRequest(W).bind(this),signOff:this.makeRequest(N).bind(this)}}get tasks(){return s.of({resources:this.resources})}}export{o as ApiTokenCreate,i as ApiTokenGetAll,n as ApiTokenInvalidate,L as AuthGetAuthenticatedUser,Q as AuthGetAuthenticatedUserHistory,W as AuthGetUser,C as AuthSignIn,N as AuthSignOff,x as AuthSignUp,A as AuthVerifyInvitation,D as AuthVerifySignIn,G as ResourceUpdateAccess,E as ResourcesCreate,v as ResourcesCreateDirectory,O as ResourcesGet,U as ResourcesList,z as ResourcesMove,I as ResourcesRemove,$ as ResourcesRename,S as ResourcesSearch,j as ResourcesUpdateContent,f as ResourcesUpload,P as ResourcesUploadNamedVersion,V as SDK,t as TaskStatus,e as Tasks,q as UserCurrentGet,w as UserCurrentGetHistory,y as UserCurrentUpdate,T as WorkspacesAddMember,u as WorkspacesCreate,p as WorkspacesCreateApiToken,b as WorkspacesDisableService,l as WorkspacesEnableService,d as WorkspacesGet,m as WorkspacesGetApiTokens,a as WorkspacesGetCurrent,c as WorkspacesGetResourceTemplates,g as WorkspacesGetUsers,h as WorkspacesImportResourceTemplates,k as WorkspacesInviteUser,r as WorkspacesList,R as WorkspacesRemoveMember};

package/build/types/Actions.d.ts

@@ -35,6 +35,15 @@ export declare const WorkspacesDisableService: Action<{
     service: any;
 }>;
 export declare const WorkspacesGetUsers: Action;
+export declare const WorkspacesAddMember: Action<{
+    userId: string;
+    workspaceId: string;
+    createdBy?: string;
+}>;
+export declare const WorkspacesRemoveMember: Action<{
+    userId: string;
+    workspaceId: string;
+}>;
 export declare const UserCurrentGet: Action;
 export declare const UserCurrentGetHistory: Action;
 export declare const UserCurrentUpdate: Action<{

package/build/types/adapter.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Unified interface for all SDK adapters.
+ *
+ * Adapters translate the generic `dispatch` / `query` calls into
+ * concrete operations — direct MongoDB writes (EventStoreAdapter),
+ * HTTP calls (HttpAdapter), or an in-memory store (InMemoryAdapter).
+ *
+ * Action names follow the pattern `{domain}/{verb}`, e.g.:
+ *   - `workspaces/create`
+ *   - `resources/create`
+ *   - `user/join-workspace`
+ *
+ * Query names follow the same pattern, e.g.:
+ *   - `workspaces/list`
+ *   - `resources/list`
+ *   - `resources/search`
+ */
+export interface OssySdkAdapter {
+    /**
+     * Dispatch a write action. Returns the resulting entity/resource,
+     * or null for fire-and-forget operations.
+     */
+    dispatch(action: string, payload: Record<string, unknown>): Promise<unknown>;
+    /**
+     * Execute a read query. Returns the matching data.
+     */
+    query(name: string, params?: Record<string, unknown>): Promise<unknown>;
+}

package/build/types/public.index.d.ts

@@ -2,3 +2,4 @@ export { Tasks, TaskStatus } from './tasks-client.js';
 export * from '@ossy/types';
 export * from './sdk';
 export * from './Actions';
+export type { OssySdkAdapter } from './adapter.js';

package/build/types/sdk.d.ts

@@ -48,6 +48,15 @@ export declare class SDK {
     };
     get users(): {
         list: (_payload?: Required<{} | undefined>) => Promise<any>;
+        addWorkspace: (_payload?: Required<{
+            userId: string;
+            workspaceId: string;
+            createdBy?: string;
+        } | undefined>) => Promise<any>;
+        removeWorkspace: (_payload?: Required<{
+            userId: string;
+            workspaceId: string;
+        } | undefined>) => Promise<any>;
     };
     get currentUser(): {
         get: (_payload?: Required<{} | undefined>) => Promise<any>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ossy/sdk",
   "description": "Software Development Kit for interacting with our services",
-  "version": "1.25.2",
+  "version": "1.26.0",
   "url": "git://github.com/ossy-se/packages/sdk",
   "source": "src/public.index.ts",
   "main": "build/public.index.js",
@@ -21,7 +21,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@ossy/types": "^1.25.2"
+    "@ossy/types": "^1.26.0"
   },
   "scripts": {
     "start": "",
@@ -36,5 +36,5 @@
     "/build",
     "README.md"
   ],
-  "gitHead": "6e44e53bf3c9b5c14c5bc2b0a02e60a590389b55"
+  "gitHead": "40e96d148d991ef4ad60fe9090f19b836ff8eb00"
 }