@scryme/chat 0.0.1

package/README.md

@@ -0,0 +1,166 @@
+# Scryme Chat TypeScript SDK (`@scryme/chat`)
+
+A high-performance, developer-friendly, fully typed TypeScript/JavaScript SDK for interacting with the Skyrme Chat V2 and V3 Enterprise APIs.
+
+Designed primarily for backend integrations, servers, and automated Machine-to-Machine (M2M) environments, this SDK provides unmatched DX with automatic OAuth2 token management, dynamic API proxying, and fluent nested helper chains.
+
+---
+
+## Features
+
+- **OAuth2 Client Credentials Grant**: Built-in, fully automated caching and renewal of M2M access tokens with timing-safe, proactive expiration buffers.
+- **Dynamic Method Proxying (`sdk.raw`)**: Automatic injection of Bearer token and Base URL headers into any of the 100+ generated V3 API endpoints with complete TypeScript autocompletion.
+- **Fluent Nested Namespaces**: High-level, developer-friendly helper routes (`sdk.workspace`, `sdk.channel`, `sdk.message`, etc.) for seamless workspace, department, team, and member administration.
+- **Isomorphic Support**: Works out-of-the-box in Node.js, Next.js (server/client), Vite, and React Native.
+
+---
+
+## Installation
+
+```bash
+npm install @scryme/chat
+# or
+pnpm add @scryme/chat
+# or
+yarn add @scryme/chat
+```
+
+---
+
+## Getting Started
+
+### 1. Initialize the SDK
+
+You can initialize `ScrymeSDK` using a static bearer token or using M2M client credentials (`clientId` and `clientSecret`) to enable auto-authentication.
+
+```typescript
+import { ScrymeSDK } from '@scryme/chat';
+
+// Option A: Machine-to-Machine (M2M) Auth (Highly recommended for servers/bots)
+const sdk = new ScrymeSDK({
+  baseURL: 'https://api.chat.scryme.tech',
+  clientId: 'm2m_client_abc123',
+  clientSecret: 'sk_m2m_secret_xyz789',
+});
+
+// Option B: Static Bearer Token Auth
+const sdkWithToken = new ScrymeSDK({
+  baseURL: 'https://api.chat.scryme.tech',
+  token: 'oat_your_token_here',
+});
+```
+
+---
+
+## Usage Guide
+
+### High-Level Fluent Namespaces (Excellent DX)
+
+For standard CRUD workflows, utilize our intuitive nested namespace chains:
+
+#### Workspaces
+```typescript
+// List all workspaces associated with the organization
+const workspaces = await sdk.workspace.list();
+
+// Provision/Create a new tenant workspace
+const newWorkspace = await sdk.workspace.create({
+  name: 'Acme Corp',
+  slug: 'acme-corp',
+  ownerEmail: 'admin@acme.com',
+  channels: ['general', 'engineering'],
+});
+
+// Retrieve detailed workspace metadata
+const workspace = await sdk.workspace.get('acme-corp');
+
+// Update workspace branding or details
+await sdk.workspace.update('acme-corp', {
+  name: 'Acme Corp International',
+  description: 'Updated team workspace',
+});
+
+// Delete a workspace
+await sdk.workspace.delete('acme-corp');
+```
+
+#### Workspace Members
+```typescript
+// List workspace members
+const members = await sdk.workspace.members.list('acme-corp');
+
+// Invite/Add a new member
+await sdk.workspace.members.add('acme-corp', {
+  email: 'developer@acme.com',
+  role: 'member',
+});
+
+// Remove a member
+await sdk.workspace.members.delete('acme-corp', 'member_id_xyz');
+```
+
+#### Channels & Messaging
+```typescript
+// List channels in a workspace
+const channels = await sdk.workspace.channels.list('acme-corp');
+
+// Create a new channel
+const channel = await sdk.workspace.channels.create('acme-corp', {
+  name: 'announcements',
+  type: 'text',
+});
+
+// Send a message to a channel
+await sdk.channel.message.create('channel_id_123', {
+  content: 'Hello Team! This is automated via our new TS SDK 🚀',
+});
+
+// Fetch channel messages
+const messages = await sdk.channel.message.list('channel_id_123', { limit: 10 });
+```
+
+---
+
+### Dynamic API Proxying (`sdk.raw`)
+
+If you need lower-level control or need to access raw Orval/Axios endpoints not wrapped in our helper namespaces, use `sdk.raw`.
+
+Every raw endpoint:
+1. Offers **full TypeScript types** for parameters, request body, and response.
+2. **Automatically injects** the required Bearer Authorization header (fetching or refreshing the M2M token on the fly).
+3. Resolves to the correct configured API Base URL.
+
+```typescript
+// Access lower-level generated controller methods directly
+const health = await sdk.raw.appControllerGetHealth();
+
+// User search
+const users = await sdk.raw.usersControllerSearchUsers({ q: 'alice' });
+
+// Fully typed update workspace webhook call
+const webhook = await sdk.raw.v3WebhooksControllerCreateWebhook('acme-corp', {
+  name: 'Slack Sync Sync',
+  url: 'https://hooks.slack.com/services/...',
+  events: ['message.created'],
+});
+```
+
+---
+
+## Development
+
+### Compile the SDK
+```bash
+pnpm build
+```
+
+### Run Unit Tests
+```bash
+pnpm test
+```
+
+---
+
+## License
+
+MIT © Skyrme Chat Enterprise

package/dist/client.d.ts

@@ -0,0 +1,2 @@
+export * from './custom-instance';
+export * from './generated/v3-client';

package/dist/client.js

@@ -0,0 +1,2 @@
+export * from './custom-instance';
+export * from './generated/v3-client';

package/dist/custom-instance.d.ts

@@ -0,0 +1,5 @@
+import { AxiosRequestConfig, AxiosError } from 'axios';
+export declare const AXIOS_INSTANCE: import("axios").AxiosInstance;
+export declare const customInstance: <T>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<T>;
+export type ErrorType<Error> = AxiosError<Error>;
+export type BodyType<Body> = Body;

package/dist/custom-instance.js

@@ -0,0 +1,100 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import axios from 'axios';
+// Helper to safely access env variables across Vite, Next.js and React Native
+var getEnv = function (name) {
+    var _a, _b, _c;
+    var g = globalThis;
+    // Try various common locations for env variables
+    // Avoid explicit import.meta to prevent TS1470
+    var env = ((_a = g.process) === null || _a === void 0 ? void 0 : _a.env) || ((_c = (_b = g.import) === null || _b === void 0 ? void 0 : _b.meta) === null || _c === void 0 ? void 0 : _c.env) || g.__env__;
+    if (!env)
+        return undefined;
+    return (env[name] || env["VITE_".concat(name)] || env["NEXT_PUBLIC_".concat(name)] || env["EXPO_PUBLIC_".concat(name)] || env["TAURI_".concat(name)]);
+};
+var getBaseURL = function () {
+    var url = '';
+    if (typeof window !== 'undefined') {
+        var customUrl = window.localStorage.getItem('CUSTOM_API_URL');
+        if (customUrl) {
+            url = customUrl;
+        }
+    }
+    if (!url) {
+        var isProd = (typeof process !== 'undefined' && process.env && process.env.NODE_ENV === 'production') ||
+            getEnv('NODE_ENV') === 'production' ||
+            (typeof window !== 'undefined' && window.location.hostname !== 'localhost' && window.location.hostname !== '127.0.0.1');
+        url = getEnv('API_URL') || getEnv('NEXT_PUBLIC_API_URL') || (isProd ? 'https://api.chat.scryme.tech' : 'http://localhost:3000');
+    }
+    return url.replace(/\/$/, '') + '/api';
+};
+export var AXIOS_INSTANCE = axios.create({
+    baseURL: getBaseURL(),
+    timeout: 10000,
+    withCredentials: true,
+});
+AXIOS_INSTANCE.interceptors.request.use(function (config) {
+    if (typeof window !== 'undefined') {
+        var getCookie = function (name) {
+            var _a;
+            var value = "; ".concat(document.cookie);
+            var parts = value.split("; ".concat(name, "="));
+            if (parts.length === 2)
+                return ((_a = parts.pop()) === null || _a === void 0 ? void 0 : _a.split(';').shift()) || null;
+            return null;
+        };
+        var token = window.localStorage.getItem('better-auth.session-token') ||
+            window.localStorage.getItem('better-auth.session_token') ||
+            window.localStorage.getItem('bearer_token');
+        if (!token) {
+            token =
+                getCookie('better-auth.session_token') ||
+                    getCookie('better-auth.session-token') ||
+                    getCookie('bearer_token');
+            if (token) {
+                window.localStorage.setItem('better-auth.session_token', token);
+                window.localStorage.setItem('better-auth.session-token', token);
+                window.localStorage.setItem('bearer_token', token);
+            }
+        }
+        else {
+            // Keep everything in sync
+            if (!window.localStorage.getItem('bearer_token')) {
+                window.localStorage.setItem('bearer_token', token);
+            }
+            if (!window.localStorage.getItem('better-auth.session_token')) {
+                window.localStorage.setItem('better-auth.session_token', token);
+            }
+            if (!window.localStorage.getItem('better-auth.session-token')) {
+                window.localStorage.setItem('better-auth.session-token', token);
+            }
+        }
+        if (token) {
+            config.headers.Authorization = "Bearer ".concat(token);
+        }
+    }
+    return config;
+});
+export var customInstance = function (config, options) {
+    var source = axios.CancelToken.source();
+    // Merge headers carefully so that options.headers does not overwrite config.headers completely
+    var mergedHeaders = __assign(__assign({}, config.headers), options === null || options === void 0 ? void 0 : options.headers);
+    var promise = AXIOS_INSTANCE(__assign(__assign(__assign({}, config), options), { headers: mergedHeaders, cancelToken: source.token })).then(function (_a) {
+        var data = _a.data;
+        return data;
+    });
+    // @ts-ignore
+    promise.cancel = function () {
+        source.cancel('Query was cancelled by React Query');
+    };
+    return promise;
+};