@clubays/clubgate-sdk 0.2.0 → 0.3.0

package/dist/index.cjs

@@ -41,6 +41,7 @@ var timeoutMs = 1e4;
 var seq = 0;
 var listening = false;
 var pending = /* @__PURE__ */ new Map();
+var navListeners = /* @__PURE__ */ new Set();
 function init(options = {}) {
   if (options.hostOrigin !== void 0) {
     let normalized;
@@ -58,7 +59,14 @@ function init(options = {}) {
 }
 function onMessage(e) {
   if (e.origin !== hostOrigin || e.source !== window.parent) return;
-  const { id, result, error } = e.data || {};
+  const data = e.data || {};
+  if (data.type === "nav.go") {
+    if (typeof data.path === "string") {
+      navListeners.forEach((cb) => cb(data.path));
+    }
+    return;
+  }
+  const { id, result, error } = data;
   if (typeof id !== "number") return;
   const p = pending.get(id);
   if (!p) return;
@@ -66,14 +74,16 @@ function onMessage(e) {
   clearTimeout(p.timer);
   error ? p.reject(new ClubgateError(error)) : p.resolve(result);
 }
+function ensureListening() {
+  if (typeof window === "undefined" || listening) return;
+  window.addEventListener("message", onMessage);
+  listening = true;
+}
 function request(method, params, opts = {}) {
   if (typeof window === "undefined" || window.parent === window) {
     return Promise.reject(new ClubgateError("not_embedded"));
   }
-  if (!listening) {
-    window.addEventListener("message", onMessage);
-    listening = true;
-  }
+  ensureListening();
   return new Promise((resolve, reject) => {
     const id = ++seq;
     const timer = setTimeout(() => {
@@ -104,6 +114,24 @@ var clubgate = {
   },
   profile: {
     get: () => request("profile.get")
+  },
+  nav: {
+    /**
+     * Tell the host the app's current route (e.g. "/profile?tab=a") so it can
+     * mirror it into the browser URL. Must start with a single "/".
+     */
+    set: (path) => request("nav.set", { path }),
+    /**
+     * Called when the host URL changes from outside the app (back/forward,
+     * pasted link). Returns an unsubscribe function.
+     */
+    onChange: (cb) => {
+      ensureListening();
+      navListeners.add(cb);
+      return () => {
+        navListeners.delete(cb);
+      };
+    }
   }
 };
 var clubays = clubgate;

package/dist/index.d.cts

@@ -50,6 +50,18 @@ declare const clubgate: {
     profile: {
         get: () => Promise<ClubgateProfile>;
     };
+    nav: {
+        /**
+         * Tell the host the app's current route (e.g. "/profile?tab=a") so it can
+         * mirror it into the browser URL. Must start with a single "/".
+         */
+        set: (path: string) => Promise<boolean>;
+        /**
+         * Called when the host URL changes from outside the app (back/forward,
+         * pasted link). Returns an unsubscribe function.
+         */
+        onChange: (cb: (path: string) => void) => () => void;
+    };
 };
 /** @deprecated use `clubgate` */
 declare const clubays: {
@@ -71,6 +83,18 @@ declare const clubays: {
     profile: {
         get: () => Promise<ClubgateProfile>;
     };
+    nav: {
+        /**
+         * Tell the host the app's current route (e.g. "/profile?tab=a") so it can
+         * mirror it into the browser URL. Must start with a single "/".
+         */
+        set: (path: string) => Promise<boolean>;
+        /**
+         * Called when the host URL changes from outside the app (back/forward,
+         * pasted link). Returns an unsubscribe function.
+         */
+        onChange: (cb: (path: string) => void) => () => void;
+    };
 };
 /** @deprecated use `ClubgateError` */
 declare const ClubaysError: typeof ClubgateError;

package/dist/index.d.ts

@@ -50,6 +50,18 @@ declare const clubgate: {
     profile: {
         get: () => Promise<ClubgateProfile>;
     };
+    nav: {
+        /**
+         * Tell the host the app's current route (e.g. "/profile?tab=a") so it can
+         * mirror it into the browser URL. Must start with a single "/".
+         */
+        set: (path: string) => Promise<boolean>;
+        /**
+         * Called when the host URL changes from outside the app (back/forward,
+         * pasted link). Returns an unsubscribe function.
+         */
+        onChange: (cb: (path: string) => void) => () => void;
+    };
 };
 /** @deprecated use `clubgate` */
 declare const clubays: {
@@ -71,6 +83,18 @@ declare const clubays: {
     profile: {
         get: () => Promise<ClubgateProfile>;
     };
+    nav: {
+        /**
+         * Tell the host the app's current route (e.g. "/profile?tab=a") so it can
+         * mirror it into the browser URL. Must start with a single "/".
+         */
+        set: (path: string) => Promise<boolean>;
+        /**
+         * Called when the host URL changes from outside the app (back/forward,
+         * pasted link). Returns an unsubscribe function.
+         */
+        onChange: (cb: (path: string) => void) => () => void;
+    };
 };
 /** @deprecated use `ClubgateError` */
 declare const ClubaysError: typeof ClubgateError;

package/dist/index.js

@@ -13,6 +13,7 @@ var timeoutMs = 1e4;
 var seq = 0;
 var listening = false;
 var pending = /* @__PURE__ */ new Map();
+var navListeners = /* @__PURE__ */ new Set();
 function init(options = {}) {
   if (options.hostOrigin !== void 0) {
     let normalized;
@@ -30,7 +31,14 @@ function init(options = {}) {
 }
 function onMessage(e) {
   if (e.origin !== hostOrigin || e.source !== window.parent) return;
-  const { id, result, error } = e.data || {};
+  const data = e.data || {};
+  if (data.type === "nav.go") {
+    if (typeof data.path === "string") {
+      navListeners.forEach((cb) => cb(data.path));
+    }
+    return;
+  }
+  const { id, result, error } = data;
   if (typeof id !== "number") return;
   const p = pending.get(id);
   if (!p) return;
@@ -38,14 +46,16 @@ function onMessage(e) {
   clearTimeout(p.timer);
   error ? p.reject(new ClubgateError(error)) : p.resolve(result);
 }
+function ensureListening() {
+  if (typeof window === "undefined" || listening) return;
+  window.addEventListener("message", onMessage);
+  listening = true;
+}
 function request(method, params, opts = {}) {
   if (typeof window === "undefined" || window.parent === window) {
     return Promise.reject(new ClubgateError("not_embedded"));
   }
-  if (!listening) {
-    window.addEventListener("message", onMessage);
-    listening = true;
-  }
+  ensureListening();
   return new Promise((resolve, reject) => {
     const id = ++seq;
     const timer = setTimeout(() => {
@@ -76,6 +86,24 @@ var clubgate = {
   },
   profile: {
     get: () => request("profile.get")
+  },
+  nav: {
+    /**
+     * Tell the host the app's current route (e.g. "/profile?tab=a") so it can
+     * mirror it into the browser URL. Must start with a single "/".
+     */
+    set: (path) => request("nav.set", { path }),
+    /**
+     * Called when the host URL changes from outside the app (back/forward,
+     * pasted link). Returns an unsubscribe function.
+     */
+    onChange: (cb) => {
+      ensureListening();
+      navListeners.add(cb);
+      return () => {
+        navListeners.delete(cb);
+      };
+    }
   }
 };
 var clubays = clubgate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clubays/clubgate-sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "SDK for building Clubays miniapps",
   "type": "module",
   "license": "MIT",
@@ -37,6 +37,10 @@
     "bin"
   ],
   "sideEffects": false,
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "typecheck": "tsc --noEmit"
+  },
   "devDependencies": {
     "tsup": "^8.0.0",
     "typescript": "^5.6.0"
@@ -46,9 +50,5 @@
   },
   "dependencies": {
     "archiver": "^7.0.1"
-  },
-  "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
-    "typecheck": "tsc --noEmit"
   }
-}
+}