npm - @instroc/client - Versions diffs - 1.0.0-alpha.1 → 1.0.0-alpha.4 - Mend

@instroc/client 1.0.0-alpha.1 → 1.0.0-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import * as zustand_vanilla from 'zustand/vanilla';
+import * as zustand_vanilla from "zustand/vanilla";
 /**
  * Shared config consumed by every @instroc/* SDK package. Lives in a single
@@ -6,30 +6,30 @@ import * as zustand_vanilla from 'zustand/vanilla';
  * functions, and storage in one shot — no provider tree required.
  */
 interface InstrocConfig {
-    /**
-     * BaaS project id — required for any SDK call that hits the backend.
-     * Null means the SDK is uninitialized; hooks return safe defaults
-     * (logged-out / loading=false / no project) until set.
-     */
-    projectId: string | null;
-    /**
-     * Base URL the SDK appends `${projectId}/...` paths to.
-     * Defaults to `/api/baas` so apps served behind the published-app router
-     * just work.
-     */
-    baseUrl: string;
-    /**
-     * If true, auth persists the session in localStorage and rehydrates on
-     * boot. Generated apps almost always want this; set false in tests or
-     * embed contexts where you don't want the session to leak across runs.
-     */
-    persistSession: boolean;
-    /**
-     * Optional API key for server-to-server data calls. Null in browser apps
-     * (auth is per-user via cookies/tokens). Reserved for SSR / Worker
-     * scenarios that may show up post-launch.
-     */
-    apiKey: string | null;
+  /**
+   * BaaS project id — required for any SDK call that hits the backend.
+   * Null means the SDK is uninitialized; hooks return safe defaults
+   * (logged-out / loading=false / no project) until set.
+   */
+  projectId: string | null;
+  /**
+   * Base URL the SDK appends `${projectId}/...` paths to.
+   * Defaults to `/api/baas` so apps served behind the published-app router
+   * just work.
+   */
+  baseUrl: string;
+  /**
+   * If true, auth persists the session in localStorage and rehydrates on
+   * boot. Generated apps almost always want this; set false in tests or
+   * embed contexts where you don't want the session to leak across runs.
+   */
+  persistSession: boolean;
+  /**
+   * Optional API key for server-to-server data calls. Null in browser apps
+   * (auth is per-user via cookies/tokens). Reserved for SSR / Worker
+   * scenarios that may show up post-launch.
+   */
+  apiKey: string | null;
 }
 /**
  * Caller-supplied init shape. projectId is required; everything else has a
@@ -37,7 +37,7 @@ interface InstrocConfig {
  * forward-compatible — adding a new optional field never breaks callers.
  */
 interface InitInstrocOptions extends Partial<InstrocConfig> {
-    projectId: string;
+  projectId: string;
 }
 /**
@@ -65,6 +65,52 @@ declare function initInstroc(options: InitInstrocOptions): void;
  * failures otherwise.
  */
 declare function resetInstroc(): void;
+/**
+ * Auto-init from the build-server bootstrap contract.
+ *
+ * The Instroc build server injects this snippet into the generated
+ * `index.html` before any module scripts:
+ *
+ *   <script>
+ *     window.__INSTROC_BOOTSTRAP__ = {
+ *       projectId: "...",
+ *       baseUrl:   "...",
+ *       apiKey:    "...",
+ *     };
+ *   </script>
+ *
+ * The SDK reads it on module load. No `process.env` substitution, no
+ * bundler-specific magic, no manual `initInstroc()` call from app code.
+ *
+ * Why a window global instead of `process.env`:
+ *   - Bundler-agnostic — works under vite, webpack, esbuild, swc
+ *   - Visible in view-source — debuggable in 2 seconds
+ *   - Loud failure — if the build is wrong the global is missing and
+ *     hooks can throw a clear error rather than silently sitting at
+ *     loading=true forever
+ *   - Easy to test — set the global before importing the module
+ *
+ * Module-script timing: classic `<script>` tags in `<head>` execute
+ * before any deferred module script (`<script type="module">`), so the
+ * global is set before this IIFE runs.
+ */
+declare global {
+  interface Window {
+    __INSTROC_BOOTSTRAP__?: {
+      projectId?: unknown;
+      baseUrl?: unknown;
+      apiKey?: unknown;
+    };
+  }
+}
+/**
+ * Throw a clear error if the SDK is asked to do something that requires a
+ * configured projectId but auto-init never seeded one. Used by hooks that
+ * make network requests; lets the failure surface immediately instead of
+ * leaving the UI stuck at `loading: true` forever when the build server
+ * forgot to inject the bootstrap.
+ */
+declare function assertInstrocConfigured(): void;
 /**
  * Read the current config synchronously. Use inside non-React code (event
  * handlers, fetch wrappers, the auth bootstrap effect). For React
@@ -96,4 +142,15 @@ declare function useInstrocConfig(): InstrocConfig;
  */
 declare function useInstrocReady(): boolean;
-export { type InitInstrocOptions, type InstrocConfig, configStore, getInstrocConfig, initInstroc, resetInstroc, setInstrocProjectId, useInstrocConfig, useInstrocReady };
+export {
+  type InitInstrocOptions,
+  type InstrocConfig,
+  assertInstrocConfigured,
+  configStore,
+  getInstrocConfig,
+  initInstroc,
+  resetInstroc,
+  setInstrocProjectId,
+  useInstrocConfig,
+  useInstrocReady,
+};

package/dist/index.js CHANGED Viewed

@@ -19,6 +19,33 @@ function initInstroc(options) {
 function resetInstroc() {
   configStore.setState({ ...DEFAULT_CONFIG }, true);
 }
+(function autoInitFromBootstrap() {
+  const bootstrap = globalThis.__INSTROC_BOOTSTRAP__;
+  if (!bootstrap)
+    return;
+  const projectId = typeof bootstrap.projectId === "string" && bootstrap.projectId.length > 0 ? bootstrap.projectId : null;
+  if (!projectId) {
+    console.error(
+      "[Instroc] window.__INSTROC_BOOTSTRAP__ is set but missing a non-empty projectId. Check the build-server's index.html generation."
+    );
+    return;
+  }
+  const baseUrl = typeof bootstrap.baseUrl === "string" && bootstrap.baseUrl.length > 0 ? bootstrap.baseUrl : null;
+  const apiKey = typeof bootstrap.apiKey === "string" && bootstrap.apiKey.length > 0 ? bootstrap.apiKey : null;
+  configStore.setState((prev) => ({
+    ...prev,
+    projectId,
+    ...baseUrl ? { baseUrl } : {},
+    ...apiKey ? { apiKey } : {}
+  }));
+})();
+function assertInstrocConfigured() {
+  if (configStore.getState().projectId)
+    return;
+  throw new Error(
+    "Instroc SDK not configured. Expected `window.__INSTROC_BOOTSTRAP__` to be set by the build server before the app loads, or `initInstroc({ projectId })` to be called manually in tests / multi-tenant setups."
+  );
+}
 function getInstrocConfig() {
   return configStore.getState();
 }
@@ -40,6 +67,7 @@ function useInstrocReady() {
   );
 }
 export {
+  assertInstrocConfigured,
   configStore,
   getInstrocConfig,
   initInstroc,

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@instroc/client",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.4",
   "description": "Shared config store for Instroc Cloud SDK packages — initInstroc(), useInstrocConfig(), and the singleton store consumed by @instroc/auth, @instroc/data, @instroc/functions",
   "type": "module",
   "main": "dist/index.js",
@@ -14,10 +14,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch"
-  },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"
   },
@@ -36,5 +32,9 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
   }
-}
+}