@blocksdiy/react-common 1.55.2 → 1.57.0
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.
- package/dist/iframe-communication/index.d.ts +1 -0
- package/dist/iframe-communication/index.d.ts.map +1 -1
- package/dist/iframe-communication/index.js +1 -0
- package/dist/iframe-communication/platform-app-link.d.ts +19 -0
- package/dist/iframe-communication/platform-app-link.d.ts.map +1 -0
- package/dist/iframe-communication/platform-app-link.js +24 -0
- package/dist/iframe-communication/types.d.ts +12 -0
- package/dist/iframe-communication/types.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -2,4 +2,5 @@ export type { ThemeMode, AppUpdate, PlatformApi, IframeApi, EditedElement, Eleme
|
|
|
2
2
|
export { BridgeProvider, type BridgeState } from "./bridge-provider.js";
|
|
3
3
|
export { IframeBridgeProvider, usePlatform } from "./iframe-bridge-provider.js";
|
|
4
4
|
export { PlatformBridgeProvider, PlatformBridgeIframe, useIframe } from "./platform-bridge-provider.js";
|
|
5
|
+
export * from "./platform-app-link.js";
|
|
5
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +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"}
|
|
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;AACrG,cAAc,qBAAqB,CAAC"}
|
|
@@ -3,3 +3,4 @@
|
|
|
3
3
|
export { BridgeProvider } from "./bridge-provider.js";
|
|
4
4
|
export { IframeBridgeProvider, usePlatform } from "./iframe-bridge-provider.js";
|
|
5
5
|
export { PlatformBridgeProvider, PlatformBridgeIframe, useIframe } from "./platform-bridge-provider.js";
|
|
6
|
+
export * from "./platform-app-link.js";
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A link from inside one app to another app on the platform — a solution's home page opening one
|
|
3
|
+
* of the solution's apps. Apps run on their own origins in the platform's iframe, so a plain link
|
|
4
|
+
* to another app can't leave the iframe; this one is a path in the app's OWN URL space,
|
|
5
|
+
* `/_platform/apps/<appId>/<route>`, that app-render catches before the app's router does and hands
|
|
6
|
+
* to the platform (`PlatformApi.onOpenApp`), which opens that app — at `<route>` when the app
|
|
7
|
+
* serves it, else where the app opens.
|
|
8
|
+
*/
|
|
9
|
+
export declare const PLATFORM_APP_LINK_PREFIX = "/_platform/apps/";
|
|
10
|
+
export interface PlatformAppLink {
|
|
11
|
+
appId: string;
|
|
12
|
+
/** The route inside the app, `/`-led ("/board"); undefined for where the app opens. */
|
|
13
|
+
path?: string;
|
|
14
|
+
}
|
|
15
|
+
/** The link to another app: `platformAppLink("6ad2…", "/board")` → `/_platform/apps/6ad2…/board`. */
|
|
16
|
+
export declare const platformAppLink: (appId: string, path?: string) => string;
|
|
17
|
+
/** The app and route a platform app link names; null for any other path or a malformed id. */
|
|
18
|
+
export declare const parsePlatformAppLink: (pathname: string) => PlatformAppLink | null;
|
|
19
|
+
//# sourceMappingURL=platform-app-link.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A link from inside one app to another app on the platform — a solution's home page opening one
|
|
3
|
+
* of the solution's apps. Apps run on their own origins in the platform's iframe, so a plain link
|
|
4
|
+
* to another app can't leave the iframe; this one is a path in the app's OWN URL space,
|
|
5
|
+
* `/_platform/apps/<appId>/<route>`, that app-render catches before the app's router does and hands
|
|
6
|
+
* to the platform (`PlatformApi.onOpenApp`), which opens that app — at `<route>` when the app
|
|
7
|
+
* serves it, else where the app opens.
|
|
8
|
+
*/
|
|
9
|
+
export const PLATFORM_APP_LINK_PREFIX = "/_platform/apps/";
|
|
10
|
+
const APP_ID = /^[a-f0-9]{24}$/i;
|
|
11
|
+
/** The link to another app: `platformAppLink("6ad2…", "/board")` → `/_platform/apps/6ad2…/board`. */
|
|
12
|
+
export const platformAppLink = (appId, path) => `${PLATFORM_APP_LINK_PREFIX}${appId}${path && path !== "/" ? `/${path.replace(/^\/+/, "")}` : ""}`;
|
|
13
|
+
/** The app and route a platform app link names; null for any other path or a malformed id. */
|
|
14
|
+
export const parsePlatformAppLink = (pathname) => {
|
|
15
|
+
if (!pathname.startsWith(PLATFORM_APP_LINK_PREFIX)) {
|
|
16
|
+
return null;
|
|
17
|
+
}
|
|
18
|
+
const [appId, ...rest] = pathname.slice(PLATFORM_APP_LINK_PREFIX.length).split("/");
|
|
19
|
+
if (!appId || !APP_ID.test(appId)) {
|
|
20
|
+
return null;
|
|
21
|
+
}
|
|
22
|
+
const path = rest.filter(Boolean).join("/");
|
|
23
|
+
return path ? { appId, path: `/${path}` } : { appId };
|
|
24
|
+
};
|
|
@@ -51,6 +51,18 @@ export interface PlatformApi extends Methods {
|
|
|
51
51
|
}) => Promise<void>;
|
|
52
52
|
onLoad: () => Promise<void>;
|
|
53
53
|
chooseElement: (data: ElementData) => Promise<void>;
|
|
54
|
+
/**
|
|
55
|
+
* Opens another app on the platform — a platform app link clicked in the app
|
|
56
|
+
* (`parsePlatformAppLink`): at `path` when that app serves it, else where it opens; `newTab`
|
|
57
|
+
* for a modifier-click. A platform from before it has no such method, so app-render calls it
|
|
58
|
+
* expecting a rejection there.
|
|
59
|
+
*/
|
|
60
|
+
onOpenApp: (args: {
|
|
61
|
+
appId: string;
|
|
62
|
+
path?: string;
|
|
63
|
+
search?: string;
|
|
64
|
+
newTab?: boolean;
|
|
65
|
+
}) => Promise<void>;
|
|
54
66
|
}
|
|
55
67
|
/**
|
|
56
68
|
* A chat component the builder previews inside the app, in place of its routes: the react-live
|
|
@@ -1 +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;
|
|
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;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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blocksdiy/react-common",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.57.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "React common",
|
|
6
6
|
"keywords": [],
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"@types/react": "^19.2.18",
|
|
47
47
|
"babel-plugin-react-compiler": "^1.0.0",
|
|
48
48
|
"eslint-plugin-react": "^7.37.5",
|
|
49
|
-
"eslint-plugin-react-hooks": "^7.
|
|
49
|
+
"eslint-plugin-react-hooks": "^7.1.1",
|
|
50
50
|
"jest": "^29.7.0",
|
|
51
51
|
"ts-jest": "^29.2.5",
|
|
52
52
|
"tsc-alias": "^1.8.10",
|