@singularlogic/coreplatts 0.0.3 → 0.0.5

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.js

@@ -272,18 +272,16 @@ 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;
-      if (!storage) {
-        console.warn("\u26A0\uFE0F sessionStorage or localStorage not available. You must pass token manually.");
+      const isStorageAvailable = typeof localStorage !== "undefined";
+      const now = Math.floor(Date.now() / 1e3);
+      if (!isStorageAvailable) {
+        console.warn("\u26A0\uFE0F localStorage not available. You must pass token manually.");
         return Promise.resolve(fn.apply(this, args));
       }
-      const now = Math.floor(Date.now() / 1e3);
-      let token = storage.getItem("token");
-      const refreshToken = storage.getItem("refresh_token");
-      const exp = Number(storage.getItem("exp") || "0");
-      const refreshExp = Number(storage.getItem("refresh_exp") || "0");
+      let token = localStorage.getItem("token");
+      const refreshToken = localStorage.getItem("refresh_token");
+      const exp = Number(localStorage.getItem("exp") || "0");
+      const refreshExp = Number(localStorage.getItem("refresh_exp") || "0");
       if (!token || now >= exp) {
         if (!refreshToken || now >= refreshExp) {
           console.warn("\u26A0\uFE0F Session expired. Please log in again.");
@@ -299,10 +297,10 @@ function withValidToken(fn, accountsAPI) {
           const session = yield response.json();
           const newExp = now + session.expires_in;
           const newRefreshExp = now + session.refresh_expires_in;
-          storage.setItem("token", session.access_token);
-          storage.setItem("refresh_token", session.refresh_token);
-          storage.setItem("exp", String(newExp));
-          storage.setItem("refresh_exp", String(newRefreshExp));
+          localStorage.setItem("token", session.access_token);
+          localStorage.setItem("refresh_token", session.refresh_token);
+          localStorage.setItem("exp", String(newExp));
+          localStorage.setItem("refresh_exp", String(newRefreshExp));
           token = session.access_token;
         } catch (e) {
           console.error("\u{1F510} Token refresh failed:", e);

package/package.json

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