@singularlogic/coreplatts 0.0.4 → 0.0.6

package/README.md

@@ -0,0 +1,166 @@
+# @singularlogic/coreplatts
+
+A TypeScript client library to access the **BUILDSPACE** identity and storage APIs.  
+Built to work with [Keycloak](https://www.keycloak.org/) and [MinIO](https://min.io/), this library wraps REST endpoints and handles authentication, token refresh, organization and folder management.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @singularlogic/coreplatts
+```
+
+---
+
+## 🚀 Getting Started
+
+### Create a client
+
+```ts
+import { Client } from '@singularlogic/coreplatts';
+
+const managementURL = 'https://api-buildspace.euinno.eu';
+const accountURL = 'https://account-buildspace.euinno.eu';
+
+const client = new Client(managementURL, accountURL);
+```
+
+---
+
+## 🔐 Authentication
+
+```ts
+const token = await client.login('user@example.com', 'password');
+console.log('Access token:', token.access_token);
+```
+
+Tokens are stored in `localStorage` or `sessionStorage` and automatically refreshed when expired.
+
+---
+
+## 👤 User Management
+
+```ts
+const me = await client.myUser(); // auto-includes access token
+console.log(me.username);
+```
+
+Register new users:
+
+```ts
+await client.register(
+  'new@user.com',
+  'password123',
+  'password123',
+  'First',
+  'Last'
+);
+```
+
+---
+
+## 🧑‍🤝‍🧑 Organizations (Groups)
+
+```ts
+const orgs = await client.allOrganizations();
+const myOrgs = await client.myOrganizations();
+
+const org = await client.organizationByName('MyOrg');
+
+await client.createOrganization('MyNewOrg');
+
+await client.addToOrganization('MyNewOrg', {
+  'user1@example.com': 'MEMBER',
+  'admin@example.com': 'ADMIN'
+});
+```
+
+---
+
+## 📂 Folder & File Management
+
+```ts
+const folder = await client.getFolderByName('project-data');
+console.log(folder.files);
+```
+
+You can also upload and download files using `Folder` and `File` methods.
+
+Example:
+
+```ts
+const file = await folder.getFileByName('report.pdf');
+await file.download();
+```
+
+---
+
+## 🔁 Automatic Token Handling
+
+All token-sensitive methods use a utility that:
+- Checks if the access token is expired
+- Refreshes it using `refresh_token` if needed
+- Uses `localStorage` or `sessionStorage` automatically
+
+---
+
+## 🧪 Example in Angular Service
+
+```ts
+import { Injectable } from '@angular/core';
+import { Client } from '@singularlogic/coreplatts';
+import { environment } from '../environments/environment';
+
+@Injectable({ providedIn: 'root' })
+export class AuthService {
+  client = new Client(environment.managementURL, environment.accountURL);
+
+  getCurrentUser() {
+    return this.client.myUser();
+  }
+}
+```
+
+---
+
+## 🧱 Core Classes
+
+### `Client`
+
+- Handles auth, session, and proxies to:
+  - `UserConsumer`
+  - `GroupConsumer`
+  - `BucketConsumer`
+  - `FolderConsumer`
+
+### `Folder`
+
+- Can fetch files
+- Can upload files with chunking and concurrency control
+
+### `File`
+
+- Can be downloaded by ID or name
+
+---
+
+## 📘 API Summary
+
+| Method | Description |
+|--------|-------------|
+| `login(email, password)` | Authenticate user |
+| `myUser()` | Get current user info |
+| `register(...)` | Create new user |
+| `allOrganizations()` | List all groups |
+| `createOrganization(name)` | Create group + bucket |
+| `addToOrganization(name, users)` | Assign roles |
+| `getFolderByName(name)` | Retrieve folder |
+| `getFolderByID(id)` | Retrieve folder by ID |
+| `removeOrganizationByID(id)` | Delete group and bucket |
+
+---
+
+## 📄 License
+
+MIT © [SingularLogic S.A.](https://www.singularlogic.eu)

package/dist/index.d.ts

@@ -155,7 +155,8 @@ declare class Client implements IClient$1 {
     private _bucketConsumer;
     private _folderConsumer;
     constructor(_managementURL: string, _accountURL: string);
-    private _setSession;
+    setSession(session: OidcToken): void;
+    getSessionVariable(key: string): string | null;
     login(email: string, password: string): Promise<OidcToken>;
     myUser(token?: string): Promise<User$1>;
     allOrganizations(token?: string): Promise<Group$1[]>;

package/dist/index.js

@@ -272,34 +272,40 @@ var BucketConsumer = class extends BaseConsumer {
 function withValidToken(fn, accountsAPI) {
   return function(...args) {
     return __async(this, null, function* () {
-      var _a;
-      const isBrowser = typeof window !== "undefined";
-      const storage = isBrowser ? (_a = window.sessionStorage) != null ? _a : window.localStorage : void 0;
+      const now = Math.floor(Date.now() / 1e3);
+      const storage = typeof window !== "undefined" ? window.sessionStorage : globalThis.sessionStorage;
       if (!storage) {
-        console.warn("\u26A0\uFE0F sessionStorage or localStorage not available. You must pass token manually.");
-        return Promise.resolve(fn.apply(this, args));
+        console.warn("\u26A0\uFE0F sessionStorage not available");
+        return fn.apply(this, args);
       }
-      const now = Math.floor(Date.now() / 1e3);
       let token = storage.getItem("access_token");
       let refreshToken = storage.getItem("refresh_token");
-      let exp = Number(storage.getItem("exp") || "0");
-      let refreshExp = Number(storage.getItem("refresh_exp") || "0");
-      if ((!exp || !refreshExp) && storage.getItem("id_token_claims_obj")) {
+      let exp = 0;
+      let refreshExp = 0;
+      const claimsRaw = storage.getItem("id_token_claims_obj");
+      if (claimsRaw) {
         try {
-          const claims = JSON.parse(storage.getItem("id_token_claims_obj"));
+          const claims = JSON.parse(claimsRaw);
           if (claims.exp) exp = claims.exp;
           if (claims.iat && claims.exp) {
-            const estimatedDuration = claims.exp - claims.iat;
-            refreshExp = claims.iat + 3 * estimatedDuration;
+            const duration = claims.exp - claims.iat;
+            refreshExp = claims.iat + 3 * duration;
           }
-        } catch (err) {
-          console.warn("\u26A0\uFE0F Could not parse id_token_claims_obj:", err);
+        } catch (e) {
+          console.warn("\u26A0\uFE0F Could not parse id_token_claims_obj:", e);
         }
+      } else {
+        exp = Number(storage.getItem("refresh_expires_in") || "0");
+        refreshExp = Number(storage.getItem("refresh_exp") || "0");
       }
-      if (!token || now >= exp) {
-        if (!refreshToken || now >= refreshExp) {
-          console.warn("\u26A0\uFE0F Session expired. Please log in again.");
-          return Promise.resolve(fn.apply(this, args));
+      if (!token || !refreshToken) {
+        console.warn("\u26A0\uFE0F No tokens found in sessionStorage.");
+        return fn.apply(this, args);
+      }
+      if (now >= exp) {
+        if (now >= refreshExp) {
+          console.warn("\u26A0\uFE0F Both access and refresh tokens expired.");
+          return fn.apply(this, args);
         }
         try {
           const response = yield fetch(`${accountsAPI}/user/refresh`, {
@@ -309,20 +315,20 @@ function withValidToken(fn, accountsAPI) {
           });
           if (!response.ok) throw new Error("Token refresh failed");
           const session = yield response.json();
+          token = session.access_token;
+          refreshToken = session.refresh_token;
           const newExp = now + session.expires_in;
           const newRefreshExp = now + session.refresh_expires_in;
-          storage.setItem("access_token", session.access_token);
-          storage.setItem("refresh_token", session.refresh_token);
-          storage.setItem("exp", String(newExp));
+          storage.setItem("access_token", token);
+          storage.setItem("refresh_token", refreshToken);
+          storage.setItem("refresh_expires_in", String(newExp));
           storage.setItem("refresh_exp", String(newRefreshExp));
-          token = session.access_token;
-        } catch (e) {
-          console.error("\u{1F510} Token refresh failed:", e);
+        } catch (err) {
+          console.error("\u{1F510} Token refresh failed:", err);
           throw new Error("Could not refresh session.");
         }
       }
-      const result = fn.apply(this, [...args, token]);
-      return result instanceof Promise ? result : Promise.resolve(result);
+      return yield fn.apply(this, [...args, token]);
     });
   };
 }
@@ -801,36 +807,37 @@ var Client = class {
     this.getFolderByName = withValidToken(this.getFolderByName.bind(this), _accountURL);
     this.getFolderByID = withValidToken(this.getFolderByID.bind(this), _accountURL);
   }
-  // public setSession(session: OidcToken): void {
-  //   const storage = typeof window !== "undefined" ? sessionStorage : global.sessionStorage;
-  //   if (storage) {
-  //       storage.setItem('token', session.access_token);
-  //       storage.setItem('refresh_token', session.refresh_token);
-  //       storage.setItem('exp', String(session.expires_in));
-  //       storage.setItem('refresh_exp', String(session.refresh_expires_in));
-  //   } else {
-  //       console.warn("Session storage is not available.");
-  //   }
-  // }
-  // public getSessionVariable(key: string): string | null {
-  //     const storage = typeof window !== "undefined" ? sessionStorage : global.sessionStorage;
-  //     return storage ? storage.getItem(key) : null;
-  // }
-  _setSession(session) {
+  setSession(session) {
+    const storage = typeof window !== "undefined" ? sessionStorage : global.sessionStorage;
     const now = Math.floor(Date.now() / 1e3);
-    if (typeof localStorage !== "undefined") {
-      localStorage.setItem("token", session.access_token);
-      localStorage.setItem("refresh_token", session.refresh_token);
-      localStorage.setItem("exp", String(now + session.expires_in));
-      localStorage.setItem("refresh_exp", String(now + session.refresh_expires_in));
+    if (storage) {
+      storage.setItem("access_token", session.access_token);
+      storage.setItem("refresh_token", session.refresh_token);
+      storage.setItem("refresh_expires_in", String(now + session.expires_in));
+      storage.setItem("refresh_exp", String(now + session.refresh_expires_in));
     } else {
-      console.warn("\u26A0\uFE0F Local Storage not available. You will need to pass tokens manually.");
+      console.warn("Session storage is not available.");
     }
   }
+  getSessionVariable(key) {
+    const storage = typeof window !== "undefined" ? sessionStorage : global.sessionStorage;
+    return storage ? storage.getItem(key) : null;
+  }
+  // private _setSession(session: OidcToken): void {
+  //   const now = Math.floor(Date.now() / 1000);
+  //   if (typeof localStorage !== "undefined") {
+  //     localStorage.setItem('token', session.access_token);
+  //     localStorage.setItem('refresh_token', session.refresh_token);
+  //     localStorage.setItem('exp', String(now + session.expires_in));
+  //     localStorage.setItem('refresh_exp', String(now + session.refresh_expires_in));
+  //   } else {
+  //     console.warn("⚠️ Local Storage not available. You will need to pass tokens manually.");
+  //   }
+  // }
   login(email, password) {
     return this._userConsumer.login(email, password).then(
       (resp) => {
-        this._setSession(resp);
+        this.setSession(resp);
         return resp;
       }
     );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singularlogic/coreplatts",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [