@tidecloak/js 0.9.11

package/dist/types/src/IAMService.d.ts

@@ -0,0 +1,106 @@
+export { IAMServiceInstance as IAMService };
+export default IAMServiceInstance;
+declare const IAMServiceInstance: IAMService;
+/**
+ * Singleton IAMService wrapping the TideCloak client.
+ *
+ * Usage A: pass an onReady callback directly
+ * ```js
+ * import { IAMService } from 'tidecloak-js';
+ * import config from './tidecloak.config.json';
+ *
+ * IAMService.initIAM(config, authenticated => {
+ *   if (!authenticated) IAMService.doLogin();
+ * }).catch(console.error);
+ * ```
+ *
+ * Usage B: attach multiple listeners, then init
+ * ```js
+ * IAMService
+ *   .on('ready', auth => console.log('ready', auth))
+ *   .on('authError', err => console.error('Auth failed', err));
+ *
+ * await IAMService.initIAM(config);
+ * ```
+ */
+declare class IAMService {
+    _tc: TideCloak | null;
+    _config: Object | null;
+    _listeners: {};
+    /**
+     * Register an event listener.
+     * @param {'ready'|'initError'|'authSuccess'|'authError'|'authRefreshSuccess'|'authRefreshError'|'logout'|'tokenExpired'} event
+     * @param {Function} handler
+     * @returns {this}
+     */
+    on(event: "ready" | "initError" | "authSuccess" | "authError" | "authRefreshSuccess" | "authRefreshError" | "logout" | "tokenExpired", handler: Function): this;
+    /**
+     * Unregister an event listener.
+     * @param {string} event
+     * @param {Function} handler
+     * @returns {this}
+     */
+    off(event: string, handler: Function): this;
+    /** @private */
+    private _emit;
+    /**
+     * Load TideCloak configuration and instantiate the client once.
+     * @param {Object} config - TideCloak configuration object.
+     * @returns {Promise<Object|null>} The loaded config, or null on failure.
+     */
+    loadConfig(config: Object): Promise<Object | null>;
+    /**
+     * Initialize the TideCloak SSO client with silent SSO check.
+     * @param {Object} config - TideCloak configuration object.
+     * @param {Function} [onReady] - Optional callback for the 'ready' event.
+     * @returns {Promise<boolean>} true if authenticated, else false.
+     */
+    initIAM(config: Object, onReady?: Function): Promise<boolean>;
+    /** @private */
+    private getTideCloakClient;
+    /** @returns {Object} Loaded config */
+    getConfig(): Object;
+    /** @returns {boolean} Whether there's a valid token */
+    isLoggedIn(): boolean;
+    /** @returns {Promise<string>} Valid token (refreshing if needed) */
+    getToken(): Promise<string>;
+    /** Seconds until token expiry */
+    getTokenExp(): number;
+    /** @returns {string} ID token */
+    getIDToken(): string;
+    /** @returns {string} Username (preferred_username claim) */
+    getName(): string;
+    /**
+     *  @param {string} role - the name of the role to check
+     *  @returns {boolean} Whether the user has a given realm role */
+    hasRealmRole(role: string): boolean;
+    /**
+     * @param {string} role - the name of the role to check
+     * @param {string} [client] - optional client-ID (defaults to the configured adapter resource)
+     * @returns {boolean} - whether the user has that role
+     */
+    hasClientRole(role: string, client?: string): boolean;
+    /**
+     * @param {string} key - The name of the claim to retrieve from the Access token's payload.
+     * @returns {*} Custom claim from access token */
+    getValueFromToken(key: string): any;
+    /**
+     * @param {string} key - The name of the claim to retrieve from the ID token's payload.
+     * @returns {*} Custom claim from access token */
+    getValueFromIDToken(key: string): any;
+    /** Refreshes token if expired or about to expire */
+    updateIAMToken(): Promise<any>;
+    /** Force immediate refresh (min validity = -1) */
+    forceUpdateToken(): Promise<any>;
+    /** Start login redirect */
+    doLogin(): void;
+    /** Encrypt data via adapter */
+    doEncrypt(data: any): Promise<any>;
+    /** Decrypt data via adapter */
+    doDecrypt(data: any): Promise<any>;
+    /** Logout, clear cookie, then redirect */
+    doLogout(): void;
+    /** Base URL for Keycloak realm (no trailing slash) */
+    getBaseUrl(): any;
+}
+import TideCloak from "../lib/tidecloak";

package/dist/types/src/index.d.ts

@@ -0,0 +1,4 @@
+export function getHumanReadableObject(modelId: any, data: any, expiry: any): void;
+export { default as IAMService } from "./IAMService.js";
+export { default as TideCloak } from "../lib/tidecloak.js";
+export { bytesToBase64, base64ToBytes } from "../modules/tide-js/Cryptide/Serialization.js";

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@tidecloak/js",
+  "version": "0.9.11",
+  "description": "TideCloak client side JS SDK",
+  "main": "dist/cjs/src/index.js",
+  "module": "dist/esm/src/index.js",
+  "types": "dist/types/src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/src/index.js",
+      "types": "./dist/types/src/index.d.ts",
+      "require": "./dist/cjs/src/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "scripts/postinstall.js"
+  ],
+  "scripts": {
+    "postinstall": "node ./scripts/postinstall.js",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build": "npm run build:cjs && npm run build:esm && cp ./silent-check-sso.html dist/",
+    "prepare": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tide-foundation/tidecloak-js.git"
+  },
+  "author": "Tide",
+  "homepage": "https://tide.org",
+  "license": "https://tide.org/licenses_tcoc2-0-0-en",
+  "keywords": [
+    "security",
+    "tidecloak",
+    "tide",
+    "authentication",
+    "oidc",
+    "oauth2",
+    "authorization"
+  ],
+  "dependencies": {
+    "heimdall-tide": "^0.1.0"
+  }
+}

package/scripts/postinstall.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+const { copyFileSync, existsSync, mkdirSync } = require('fs');
+const { join, dirname, sep } = require('path');
+
+// find the nearest package.json upwards, but skip anything inside node_modules
+function findProjectRoot(startDir) {
+  let dir = startDir;
+  while (dir !== dirname(dir)) {
+    // if we're inside node_modules, ignore this level
+    if (!dir.split(sep).includes('node_modules') &&
+      existsSync(join(dir, 'package.json'))) {
+      return dir;
+    }
+    dir = dirname(dir);
+  }
+  return null;
+}
+
+// where npm/yarn was invoked (if available)
+const initialCwd = process.env.INIT_CWD || process.cwd();
+
+// find the first non-node_modules package.json above that
+const projectRoot = findProjectRoot(initialCwd) || process.cwd();
+
+// now build paths
+const pkgRoot = join(__dirname, '..');
+const source = join(pkgRoot, 'dist', 'silent-check-sso.html');
+const destDir = join(projectRoot, 'public');
+const destFile = join(destDir, 'silent-check-sso.html');
+
+// debug logging—remove in production
+console.log(`[tidecloak-js] initialCwd: ${initialCwd}`);
+console.log(`[tidecloak-js] projectRoot: ${projectRoot}`);
+
+// ensure public/ exists
+if (!existsSync(destDir)) {
+  mkdirSync(destDir, { recursive: true });
+  console.log(`[tidecloak-js] created directory ${destDir}`);
+}
+
+// copy the HTML file
+copyFileSync(source, destFile);
+console.log(`[tidecloak-js] copied silent-check-sso.html → ${destDir}/`);