@qelos/web-sdk 3.1.28 → 3.1.30

package/README.md

@@ -1,47 +1,27 @@
-# @qelos/sdk
-
-SDK to use Qelos common API endpoints.
-
-Can be used for both backend and frontend applications.
+# @qelos/web-sdk
 
+A package to manage communication between a Plugin MFE to a QELOS application host.
 ## Installation
 
 ```shell
-npm install @qelos/sdk
+npm install @qelos/web-sdk
 ```
 
 ## Usage
 
 ```typescript
-// my-sdk.ts
-import QelosSDK from '@qelos/sdk';
+import { authorize, code } from "@qelos/web-sdk";
 
-const sdk = new QelosSDK({appUrl: 'https://yourdomain.com', fetch: window.fetch});
-export default sdk;
-```
-**Note:** You can inject a fetch-like function, such as `node-fetch` or any fetch equivalent.
-
-### Basic usage of SDK instance:
-```typescript jsx
-// MyPostsList.tsx
-import sdk from './my-sdk';
-
-function MyPostsList() {
-  const [posts, setPosts] = useState([]);
-  const [querySearch, setQuery] = useState([]);
-  useEffect(() => {
-    sdk.posts.getList({q: querySearch, limit: 50});
-  }, [querySearch]);
-
-  return (
-    <div>
-      <input type="text" placeholder="Search posts" onChange={e => setQuery(e.target.value)}/>
-      {
-        posts.map(post => <PostItem post={post} key={post._id}/>)
-      }
-    </div>
-  )
-}
+// authorize your micro-frontend application 
+// to recognize the user and tenant of host application:
+const { user, tenant } = authorize();
+
+
+// add the "code" parameter given from this web-sdk
+// it's a code created for this specific intercation with the user:
+fetch('/api/you-own-api', {
+  headers: { code }
+})
 ```
 
 Enjoy!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qelos/web-sdk",
-  "version": "3.1.28",
+  "version": "3.1.30",
   "description": "Frontend Web SDK for Qelos API",
   "main": "./dist/index.js",
   "scripts": {