@ossy/sdk-react 0.8.1 → 0.8.3

package/README.md

@@ -5,32 +5,32 @@ with react hooks you can use to fetch data.
 
 ## Getting started
 
-To use these hooks install the package **@ossy/cms-client-react**
+To use these hooks install the package **@ossy/sdk-react** along with **@ossy/sdk**:
 
 ```
-npm install @ossy/cms-client-react
+npm install @ossy/sdk-react @ossy/sdk
 ```
 
-Then we simply need to wrap our app in a <WorkspaceProvider /> that will
-handle data storage and configuration for us.
-You will need the workspaceId for the workspace you want to fetch data from.
-The workspaceId can be found in the list of workspaces you have access to or
-in the url when you view the resources in the UI.
+Create an SDK instance and wrap your app in `<WorkspaceProvider />` to handle
+data storage and configuration:
 
-```
+```jsx
 // App.jsx
-import { WorkspaceProvider } from '@ossy/cms-client-react'
+import { WorkspaceProvider } from '@ossy/sdk-react'
+import { SDK } from '@ossy/sdk'
 import { MyComponent } from './MyComponent.jsx'
 
+const sdk = new SDK({ baseUrl: 'https://your-api.example.com' })
+
 export const App = () => (
-  <WorkspaceProvider workspaceId="your-workspace-id">
+  <WorkspaceProvider sdk={sdk}>
     <MyComponent />
   </WorkspaceProvider>
 )
 ```
-```
+```jsx
 // MyComponent.jsx
-import { useResources } from '@ossy/cms-client-react'
+import { useResources } from '@ossy/sdk-react'
 
 export const MyComponent = () => {
   const { status, resources } = useResources('/folder/path/in/cms')
@@ -62,12 +62,12 @@ export const MyComponent = () => {
 ### useResources
 
 ```
-const { status, resources } = useResources('/')
+const { status, resources, loadResources } = useResources('/')
 ```
 
 **Parameters**
 
-- **path** - Folder path in the cms UI
+- **path** - (optional) Folder path in the cms UI. Defaults to `/` when omitted.
 
 **Returns**
 
@@ -78,6 +78,7 @@ Returns an object containing
   Possible values are: NotInitialized, Loading, Success, Error
 - **resources** - Array of resources, defaults to an empty array when
   loading is not Success
+- **loadResources** - Function to manually refetch the resource list
 
 ### useResource
 

package/build/sdk-react/src/useUsers.js

@@ -1 +1 @@
-import{useCallback as t,useEffect as a}from"react";import{useCache as s}from"./Cache.js";import{AsyncStatus as r}from"./asyncStatus.js";import{useSdk as o}from"./useSdk.js";var u=function(){var u=o(),i=s(["workspace","users"]),n=i.data,e=void 0===n?{status:r.NotInitialized,data:[]}:n,c=i.set,d=t(function(){c({status:r.Loading,data:[]}),u.users.list().then(function(t){return c({data:t,status:r.Success})}).catch(function(){return c({status:r.Error,data:[]})})},[u]);return a(function(){e.status===r.NotInitialized&&d()},[e]),{status:e.status,users:e.data,load:d}};export{u as useUsers};
+import{useCallback as t,useEffect as a}from"react";import{useCache as s}from"./Cache.js";import{AsyncStatus as r}from"./asyncStatus.js";import{useSdk as u}from"./useSdk.js";var o=function(){var o=u(),i=s(["users"]),n=i.data,e=void 0===n?{status:r.NotInitialized,data:[]}:n,c=i.set,d=t(function(){c({status:r.Loading,data:[]}),o.users.list().then(function(t){return c({data:t,status:r.Success})}).catch(function(){return c({status:r.Error,data:[]})})},[o]);return a(function(){e.status===r.NotInitialized&&d()},[e]),{status:e.status,users:e.data,load:d}};export{o as useUsers};

package/build/sdk-react/src/useWorkspace.js

@@ -1 +1 @@
-import{__assign as t,__spreadArray as s}from"../../node_modules/tslib/tslib.es6.js";import{useCallback as a,useEffect as r}from"react";import{useCache as e}from"./Cache.js";import{AsyncStatus as i}from"./asyncStatus.js";import{useSdk as o}from"./useSdk.js";var n=function(n){var u=o(),c=e(["workspace"]),d=c.data,p=void 0===d?{status:i.NotInitialized,data:{}}:d,f=c.set,k=a(function(){f({status:i.Loading,data:{}}),((null==n?void 0:n.id)?u.workspaces.get({id:n.id}):u.workspaces.current()).then(function(t){return f({data:t,status:i.Success})}).catch(function(){return f({status:i.Error,data:{}})})},[u]),m=a(function(a){return u.workspaces.createApiToken({description:a}).then(function(r){var e=r.id,i=r.token;return f({status:p.status,data:t(t({},p),{apiTokens:s(s([],p.apiTokens,!0),[{id:e,description:a}],!1)})}),i})},[u]),l=a(function(t){return u.workspaces.inviteUser({email:t})},[u]);return r(function(){p.status===i.NotInitialized&&k()},[p]),{status:p.status,workspace:p.data,loadWorkspace:k,createApiToken:m,inviteUser:l}};export{n as useWorkspace};
+import{__assign as t,__spreadArray as i}from"../../node_modules/tslib/tslib.es6.js";import{useCallback as a,useEffect as o}from"react";import{useCache as n}from"./Cache.js";import{AsyncStatus as s}from"./asyncStatus.js";import{useSdk as r}from"./useSdk.js";var e=function(e){var u=r(),d=n(["workspace"]),c=d.data,l=void 0===c?{status:s.NotInitialized,data:{}}:c,p=d.set,v=a(function(){p({status:s.Loading,data:{}}),((null==e?void 0:e.id)?u.workspaces.get({id:e.id}):u.workspaces.current()).then(function(t){return p({data:t,status:s.Success})}).catch(function(){return p({status:s.Error,data:{}})})},[u,null==e?void 0:e.id]),f=a(function(a){return u.workspaces.createApiToken({description:a}).then(function(o){var n=o.id,r=o.token;return p(function(o){var r,e,u,d;return{status:null!==(r=null==o?void 0:o.status)&&void 0!==r?r:s.NotInitialized,data:t(t({},null!==(e=null==o?void 0:o.data)&&void 0!==e?e:{}),{apiTokens:i(i([],null!==(d=null===(u=null==o?void 0:o.data)||void 0===u?void 0:u.apiTokens)&&void 0!==d?d:[],!0),[{id:n,description:a}],!1)})}}),r})},[u,p]),k=a(function(t){return u.workspaces.inviteUser({email:t})},[u]);return o(function(){l.status===s.NotInitialized&&v()},[l.status,v]),{status:l.status,workspace:l.data,loadWorkspace:v,createApiToken:f,inviteUser:k}};export{e as useWorkspace};

package/build/sdk-react/src/useWorkspaces.js

@@ -1 +1 @@
-import{__spreadArray as t}from"../../node_modules/tslib/tslib.es6.js";import{useCallback as a,useEffect as s}from"react";import{useCache as r}from"./Cache.js";import{AsyncStatus as o}from"./asyncStatus.js";import{useSdk as e}from"./useSdk.js";var n=["workspaces"],u=function(){var u=e(),i=r(n),c=i.set,d=i.data,f=void 0===d?{status:o.NotInitialized,data:[]}:d,m=a(function(){c({status:o.Loading,data:[]}),u.workspaces.list().then(function(t){return c({status:o.Success,data:t})}).catch(function(){return c({status:o.Error,data:[]})})},[u]),p=a(function(a){return u.workspaces.create({name:a}).then(function(a){return c({status:f.status,data:t(t([],f.data,!0),[a],!1)}),a})},[u]);return s(function(){f.status===o.NotInitialized&&m()},[f,m]),{status:f.status,workspaces:f.data,loadWorkspaces:m,createWorkspace:p}};export{u as useWorkspaces};
+import{__spreadArray as t}from"../../node_modules/tslib/tslib.es6.js";import{useCallback as a,useEffect as s}from"react";import{useCache as o}from"./Cache.js";import{AsyncStatus as r}from"./asyncStatus.js";import{useSdk as n}from"./useSdk.js";var e=["workspaces"],i=function(){var i=n(),u=o(e),c=u.set,d=u.data,l=void 0===d?{status:r.NotInitialized,data:[]}:d,f=a(function(){c({status:r.Loading,data:[]}),i.workspaces.list().then(function(t){return c({status:r.Success,data:t})}).catch(function(){return c({status:r.Error,data:[]})})},[i]),m=a(function(a){return i.workspaces.create({name:a}).then(function(a){return c(function(s){var o,n;return{status:null!==(o=null==s?void 0:s.status)&&void 0!==o?o:r.NotInitialized,data:t(t([],null!==(n=null==s?void 0:s.data)&&void 0!==n?n:[],!0),[a],!1)}}),a})},[i,c]);return s(function(){l.status===r.NotInitialized&&f()},[l,f]),{status:l.status,workspaces:l.data,loadWorkspaces:f,createWorkspace:m}};export{i as useWorkspaces};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ossy/sdk-react",
-  "description": "Sofware Development Kit React",
-  "version": "0.8.1",
+  "description": "Software Development Kit React",
+  "version": "0.8.3",
   "url": "git://github.com/ossy-se/packages/sdk-react",
   "source": "src/public.index.ts",
   "module": "build/sdk-react/src/public.index.js",
@@ -56,5 +56,5 @@
     "/build",
     "README.md"
   ],
-  "gitHead": "8cd0c560777ae9e2bd3f11d02fed26f5bc1e7d5f"
+  "gitHead": "4116cb86c14d3d9b01d3a2e37a9ce0835bbe7e41"
 }