@blocksdiy/react-common 1.56.0 → 1.58.0

package/dist/iframe-communication/index.d.ts

@@ -1,5 +1,6 @@
-export type { ThemeMode, AppUpdate, PlatformApi, IframeApi, EditedElement, ElementData, ChatComponentPreview, } from "./types.js";
+export type { ThemeMode, AppUpdate, PlatformApi, IframeApi, EditedElement, ElementData, ChatComponentPreview, IframeBootData, } from "./types.js";
 export { BridgeProvider, type BridgeState } from "./bridge-provider.js";
 export { IframeBridgeProvider, usePlatform } from "./iframe-bridge-provider.js";
 export { PlatformBridgeProvider, PlatformBridgeIframe, useIframe } from "./platform-bridge-provider.js";
+export * from "./platform-app-link.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/iframe-communication/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/iframe-communication/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,SAAS,EACT,SAAS,EACT,WAAW,EACX,SAAS,EACT,aAAa,EACb,WAAW,EACX,oBAAoB,GACrB,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,cAAc,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/iframe-communication/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,SAAS,EACT,SAAS,EACT,WAAW,EACX,SAAS,EACT,aAAa,EACb,WAAW,EACX,oBAAoB,EACpB,cAAc,GACf,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,cAAc,EAAE,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC7E,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACrG,cAAc,qBAAqB,CAAC"}

package/dist/iframe-communication/index.js

@@ -3,3 +3,4 @@
 export { BridgeProvider } from "./bridge-provider.js";
 export { IframeBridgeProvider, usePlatform } from "./iframe-bridge-provider.js";
 export { PlatformBridgeProvider, PlatformBridgeIframe, useIframe } from "./platform-bridge-provider.js";
+export * from "./platform-app-link.js";

package/dist/iframe-communication/platform-app-link.d.ts

@@ -0,0 +1,19 @@
+/**
+ * A link from inside one app to another app on the platform — a solution's home page opening one
+ * of the solution's apps. Apps run on their own origins in the platform's iframe, so a plain link
+ * to another app can't leave the iframe; this one is a path in the app's OWN URL space,
+ * `/_platform/apps/<appId>/<route>`, that app-render catches before the app's router does and hands
+ * to the platform (`PlatformApi.onOpenApp`), which opens that app — at `<route>` when the app
+ * serves it, else where the app opens.
+ */
+export declare const PLATFORM_APP_LINK_PREFIX = "/_platform/apps/";
+export interface PlatformAppLink {
+    appId: string;
+    /** The route inside the app, `/`-led ("/board"); undefined for where the app opens. */
+    path?: string;
+}
+/** The link to another app: `platformAppLink("6ad2…", "/board")` → `/_platform/apps/6ad2…/board`. */
+export declare const platformAppLink: (appId: string, path?: string) => string;
+/** The app and route a platform app link names; null for any other path or a malformed id. */
+export declare const parsePlatformAppLink: (pathname: string) => PlatformAppLink | null;
+//# sourceMappingURL=platform-app-link.d.ts.map

package/dist/iframe-communication/platform-app-link.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform-app-link.d.ts","sourceRoot":"","sources":["../../src/iframe-communication/platform-app-link.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,qBAAqB,CAAC;AAI3D,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qGAAqG;AACrG,eAAO,MAAM,eAAe,GAAI,OAAO,MAAM,EAAE,OAAO,MAAM,KAAG,MACqC,CAAC;AAErG,8FAA8F;AAC9F,eAAO,MAAM,oBAAoB,GAAI,UAAU,MAAM,KAAG,eAAe,GAAG,IAUzE,CAAC"}

package/dist/iframe-communication/platform-app-link.js

@@ -0,0 +1,24 @@
+/**
+ * A link from inside one app to another app on the platform — a solution's home page opening one
+ * of the solution's apps. Apps run on their own origins in the platform's iframe, so a plain link
+ * to another app can't leave the iframe; this one is a path in the app's OWN URL space,
+ * `/_platform/apps/<appId>/<route>`, that app-render catches before the app's router does and hands
+ * to the platform (`PlatformApi.onOpenApp`), which opens that app — at `<route>` when the app
+ * serves it, else where the app opens.
+ */
+export const PLATFORM_APP_LINK_PREFIX = "/_platform/apps/";
+const APP_ID = /^[a-f0-9]{24}$/i;
+/** The link to another app: `platformAppLink("6ad2…", "/board")` → `/_platform/apps/6ad2…/board`. */
+export const platformAppLink = (appId, path) => `${PLATFORM_APP_LINK_PREFIX}${appId}${path && path !== "/" ? `/${path.replace(/^\/+/, "")}` : ""}`;
+/** The app and route a platform app link names; null for any other path or a malformed id. */
+export const parsePlatformAppLink = (pathname) => {
+    if (!pathname.startsWith(PLATFORM_APP_LINK_PREFIX)) {
+        return null;
+    }
+    const [appId, ...rest] = pathname.slice(PLATFORM_APP_LINK_PREFIX.length).split("/");
+    if (!appId || !APP_ID.test(appId)) {
+        return null;
+    }
+    const path = rest.filter(Boolean).join("/");
+    return path ? { appId, path: `/${path}` } : { appId };
+};

package/dist/iframe-communication/types.d.ts

@@ -25,12 +25,30 @@ export interface AppUpdate {
         darkVariables?: Record<string, string>;
     };
 }
+/**
+ * What app-render needs to boot, fetched by the platform as the iframe mounts: the answers to the
+ * two lookups app-render makes for itself when it runs on its own — its app by the frame's host
+ * (`get-app-by-domain`, with the frame's `?version=`) and the current user on it
+ * (`safe-users/current`). From the platform's origin they are same-origin, one round trip each,
+ * and they run while the frame is still loading. The same endpoints, so the same JSON; null for
+ * one the platform could not get, which app-render then asks for itself.
+ */
+export interface IframeBootData {
+    app: Record<string, unknown> | null;
+    user: Record<string, unknown> | null;
+}
 /**
  * Methods the platform (Remix parent window) exposes to the iframe (app-render).
  * Called by code running inside the iframe to communicate back to the platform.
  */
 export interface PlatformApi extends Methods {
     getToken: () => Promise<string>;
+    /**
+     * The frame's boot data (`IframeBootData`), asked the moment the bridge connects. A platform from
+     * before it has no such method, so app-render calls it expecting a rejection there and then
+     * looks itself up.
+     */
+    getBootData: () => Promise<IframeBootData>;
     onLogout: () => void;
     onIframePageChange: (args: {
         changeToPageId: string;
@@ -51,6 +69,18 @@ export interface PlatformApi extends Methods {
     }) => Promise<void>;
     onLoad: () => Promise<void>;
     chooseElement: (data: ElementData) => Promise<void>;
+    /**
+     * Opens another app on the platform — a platform app link clicked in the app
+     * (`parsePlatformAppLink`): at `path` when that app serves it, else where it opens; `newTab`
+     * for a modifier-click. A platform from before it has no such method, so app-render calls it
+     * expecting a rejection there.
+     */
+    onOpenApp: (args: {
+        appId: string;
+        path?: string;
+        search?: string;
+        newTab?: boolean;
+    }) => Promise<void>;
 }
 /**
  * A chat component the builder previews inside the app, in place of its routes: the react-live

package/dist/iframe-communication/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/iframe-communication/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEtC,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEpD,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACxC,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IAC1C,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,kBAAkB,EAAE,CAAC,IAAI,EAAE;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/F,uBAAuB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,eAAe,EAAE,CAAC,SAAS,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3G,kBAAkB,EAAE,CAAC,SAAS,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzG,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,aAAa,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,OAAO;IACxC,oBAAoB,EAAE,CAAC,IAAI,EAAE;QAAE,gBAAgB,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnG,WAAW,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,kBAAkB,EAAE,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,yBAAyB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,oBAAoB,EAAE,CAAC,YAAY,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,eAAe,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,iBAAiB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,mBAAmB,EAAE,CAAC,cAAc,EAAE,aAAa,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,gGAAgG;IAChG,sBAAsB,EAAE,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChF;;;;OAIG;IACH,wBAAwB,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D;;;;OAIG;IACH,iBAAiB,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAClE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/iframe-communication/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEtC,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEpD,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,WAAW,EAAE,WAAW,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACxC,CAAC;CACH;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,OAAO;IAC1C,QAAQ,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,CAAC;IAC3C,QAAQ,EAAE,MAAM,IAAI,CAAC;IACrB,kBAAkB,EAAE,CAAC,IAAI,EAAE;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/F,uBAAuB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,eAAe,EAAE,CAAC,SAAS,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3G,kBAAkB,EAAE,CAAC,SAAS,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzG,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,aAAa,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD;;;;;OAKG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACzG;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,SAAU,SAAQ,OAAO;IACxC,oBAAoB,EAAE,CAAC,IAAI,EAAE;QAAE,gBAAgB,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnG,WAAW,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,kBAAkB,EAAE,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,yBAAyB,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,oBAAoB,EAAE,CAAC,YAAY,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,eAAe,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,iBAAiB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,mBAAmB,EAAE,CAAC,cAAc,EAAE,aAAa,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,gGAAgG;IAChG,sBAAsB,EAAE,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChF;;;;OAIG;IACH,wBAAwB,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D;;;;OAIG;IACH,iBAAiB,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAClE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocksdiy/react-common",
-  "version": "1.56.0",
+  "version": "1.58.0",
   "type": "module",
   "description": "React common",
   "keywords": [],
@@ -37,9 +37,9 @@
     "@copilotkit/react-core": "1.70.2",
     "@radix-ui/react-slot": "^1.2.3",
     "@vapi-ai/web": "^2.5.2",
-    "penpal": "^8.0.0",
+    "penpal": "^8.0.1",
     "react": "^19.2.8",
-    "use-stick-to-bottom": "1.1.4"
+    "use-stick-to-bottom": "1.1.6"
   },
   "devDependencies": {
     "@blockscom/eslint-config": "4.6.4",