@picked/client 0.0.1-dev.1789541668638 → 0.0.1-dev.1793756239746
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/LICENSE +1 -0
- package/README.md +34 -158
- package/dist/.tsbuildinfo +1 -1
- package/dist/{api-C7q_7vxn.js → api-B5i4XuCs.js} +1 -1
- package/dist/api-DMYLC1At.cjs +1 -0
- package/dist/cjs/form/index.js +1 -1
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/logic-engine.js +1 -0
- package/dist/cjs/plugins/dom-observer/index.js +1 -1
- package/dist/cjs/plugins/dynamic-experiences/index.js +1 -1
- package/dist/cjs/plugins/experience-browser-storage/index.js +1 -1
- package/dist/cjs/plugins/responses-browser-storage/index.js +1 -1
- package/dist/cjs/plugins/telemetry/index.js +1 -1
- package/dist/cjs/server/index.js +1 -1
- package/dist/cjs/storage.js +1 -0
- package/dist/dom-7g2LZCIp.cjs +1 -0
- package/dist/{dom-BqcToNL0.js → dom-v6ulxr_z.js} +1 -5
- package/dist/esm/form/index.js +5 -16
- package/dist/esm/index.js +465 -505
- package/dist/esm/logic-engine.js +208 -0
- package/dist/esm/plugins/dom-observer/index.js +1 -1
- package/dist/esm/plugins/dynamic-experiences/index.js +4 -4
- package/dist/esm/plugins/experience-browser-storage/index.js +12 -10
- package/dist/esm/plugins/responses-browser-storage/index.js +2 -6
- package/dist/esm/plugins/telemetry/index.js +26 -15
- package/dist/esm/preview/index.js +1 -2
- package/dist/esm/server/index.js +40 -36
- package/dist/esm/storage.js +1 -0
- package/dist/{experience-instance-B9S6Yf0N.js → experience-instance-4D6Yk-h0.js} +323 -260
- package/dist/experience-instance-D2FAkiPx.cjs +1 -0
- package/dist/plugin-CVLK5ZLV.cjs +1 -0
- package/dist/plugin-C_cLCzXK.js +256 -0
- package/dist/preview-channel-BMOEreho.cjs +1 -0
- package/dist/{preview-channel-CSr96XAo.js → preview-channel-CLXVoL_j.js} +2 -5
- package/dist/preview-unavailable-BAhTGDAp.cjs +1 -0
- package/dist/{version-CPKulHMH.js → preview-unavailable-OHRfSIId.js} +100 -61
- package/dist/provider-BFZgizAt.cjs +1 -0
- package/dist/provider-dD92LNPP.js +115 -0
- package/dist/{rules-logic-HesIUCu6.js → rules-logic-9hh8y_1b.js} +1 -1
- package/dist/rules-logic-VUbvWqdi.cjs +1 -0
- package/dist/types/data-source/preview-unavailable.d.ts +18 -0
- package/dist/types/data-source/preview-unavailable.d.ts.map +1 -0
- package/dist/types/data-source/provider.d.ts +5 -0
- package/dist/types/data-source/provider.d.ts.map +1 -1
- package/dist/types/data-source/request-observer.d.ts +21 -8
- package/dist/types/data-source/request-observer.d.ts.map +1 -1
- package/dist/types/entities/action/action.d.ts +94 -23
- package/dist/types/entities/action/action.d.ts.map +1 -1
- package/dist/types/entities/experience-instance/experience-instance.d.ts +14 -1
- package/dist/types/entities/experience-instance/experience-instance.d.ts.map +1 -1
- package/dist/types/exports.d.ts +1 -0
- package/dist/types/exports.d.ts.map +1 -1
- package/dist/types/index.d.ts +2 -2
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/lifecycle/rules-logic.d.ts.map +1 -1
- package/dist/types/logic-engine.d.ts +9 -0
- package/dist/types/logic-engine.d.ts.map +1 -1
- package/dist/types/picked.d.ts +38 -8
- package/dist/types/picked.d.ts.map +1 -1
- package/dist/types/plugins/dynamic-experiences/index.d.ts +1 -0
- package/dist/types/plugins/dynamic-experiences/index.d.ts.map +1 -1
- package/dist/types/plugins/dynamic-experiences/plugin.d.ts.map +1 -1
- package/dist/types/plugins/dynamic-experiences/types.d.ts +5 -2
- package/dist/types/plugins/dynamic-experiences/types.d.ts.map +1 -1
- package/dist/types/plugins/experience-browser-storage/plugin.d.ts.map +1 -1
- package/dist/types/plugins/telemetry/plugin.d.ts +2 -0
- package/dist/types/plugins/telemetry/plugin.d.ts.map +1 -1
- package/dist/types/schema-registry.d.ts +34 -0
- package/dist/types/schema-registry.d.ts.map +1 -1
- package/dist/types/server/serialize.d.ts +1 -0
- package/dist/types/server/serialize.d.ts.map +1 -1
- package/dist/types/storage.d.ts +6 -0
- package/dist/types/storage.d.ts.map +1 -0
- package/dist/types/typed-content.d.ts +14 -1
- package/dist/types/typed-content.d.ts.map +1 -1
- package/dist/types/utils/events.d.ts +4 -0
- package/dist/types/utils/events.d.ts.map +1 -1
- package/dist/types/utils/rules-logic.d.ts +3 -2
- package/dist/types/utils/rules-logic.d.ts.map +1 -1
- package/dist/types/utils/search-params.d.ts +20 -0
- package/dist/types/utils/search-params.d.ts.map +1 -1
- package/package.json +39 -13
- package/dist/api-Ctvh1qkk.cjs +0 -1
- package/dist/docs/_root.css +0 -101
- package/dist/docs/explanation/conditions-and-the-logic-engine.md +0 -94
- package/dist/docs/explanation/content-references.md +0 -99
- package/dist/docs/explanation/feature-flag-allocation.md +0 -218
- package/dist/docs/explanation/how-picked-works.md +0 -124
- package/dist/docs/explanation/how-pickedql-works.md +0 -76
- package/dist/docs/explanation/pages-and-flows.md +0 -64
- package/dist/docs/explanation/the-content-model.md +0 -87
- package/dist/docs/explanation/the-two-apis.md +0 -68
- package/dist/docs/explanation/why-server-side-rendering.md +0 -76
- package/dist/docs/explanation/workspaces-and-versions.md +0 -71
- package/dist/docs/how-to/add-a-step-field-or-action.md +0 -43
- package/dist/docs/how-to/analytics/index.md +0 -316
- package/dist/docs/how-to/archive-or-delete-a-workspace.md +0 -46
- package/dist/docs/how-to/authenticate-the-cli.md +0 -97
- package/dist/docs/how-to/authenticate-with-a-magic-link.md +0 -40
- package/dist/docs/how-to/authenticate-with-a-password.md +0 -51
- package/dist/docs/how-to/authenticate-with-an-api-key.md +0 -51
- package/dist/docs/how-to/authenticate-with-oauth.md +0 -40
- package/dist/docs/how-to/build-a-flow.md +0 -83
- package/dist/docs/how-to/connect-the-mcp-server.md +0 -38
- package/dist/docs/how-to/create-a-content-entry.md +0 -48
- package/dist/docs/how-to/create-a-project.md +0 -29
- package/dist/docs/how-to/create-an-experience.md +0 -42
- package/dist/docs/how-to/create-and-revoke-an-api-key.md +0 -42
- package/dist/docs/how-to/debug-with-the-chrome-extension.md +0 -57
- package/dist/docs/how-to/define-a-page-layout.md +0 -46
- package/dist/docs/how-to/fill-and-publish-a-page.md +0 -66
- package/dist/docs/how-to/install-the-gtm-template.md +0 -84
- package/dist/docs/how-to/install-the-sdk.md +0 -93
- package/dist/docs/how-to/install-the-vite-plugin.md +0 -69
- package/dist/docs/how-to/invite-and-remove-members.md +0 -35
- package/dist/docs/how-to/point-one-entry-at-another.md +0 -61
- package/dist/docs/how-to/preview-a-workspace.md +0 -28
- package/dist/docs/how-to/publish-a-workspace.md +0 -30
- package/dist/docs/how-to/read-a-feature-flag.md +0 -113
- package/dist/docs/how-to/read-a-referenced-entry.md +0 -109
- package/dist/docs/how-to/register-a-component.md +0 -55
- package/dist/docs/how-to/register-an-action-handler.md +0 -67
- package/dist/docs/how-to/render-a-step-form.md +0 -131
- package/dist/docs/how-to/render-an-unpublished-preview.md +0 -41
- package/dist/docs/how-to/reuse-a-section.md +0 -53
- package/dist/docs/how-to/reuse-a-step-field-or-action.md +0 -28
- package/dist/docs/how-to/roll-back-a-published-version.md +0 -26
- package/dist/docs/how-to/run-an-ab-test.md +0 -49
- package/dist/docs/how-to/run-code-on-a-form-submission.md +0 -125
- package/dist/docs/how-to/server-render-a-page.md +0 -81
- package/dist/docs/how-to/set-a-content-security-policy.md +0 -32
- package/dist/docs/how-to/set-up-mfa.md +0 -69
- package/dist/docs/how-to/switch-workspaces.md +0 -122
- package/dist/docs/how-to/upload-and-use-an-asset.mdx +0 -73
- package/dist/docs/how-to/validate-a-field.md +0 -52
- package/dist/docs/how-to/write-a-condition.md +0 -45
- package/dist/docs/how-to/write-a-predicate.md +0 -60
- package/dist/docs/index.md +0 -59
- package/dist/docs/reference/dashboard/actions.mdx +0 -53
- package/dist/docs/reference/dashboard/api-keys.mdx +0 -38
- package/dist/docs/reference/dashboard/conditions.mdx +0 -42
- package/dist/docs/reference/dashboard/content/asset-library.mdx +0 -63
- package/dist/docs/reference/dashboard/content/blocks.mdx +0 -57
- package/dist/docs/reference/dashboard/content/content-entries.mdx +0 -95
- package/dist/docs/reference/dashboard/content/models.mdx +0 -108
- package/dist/docs/reference/dashboard/content/pages.mdx +0 -61
- package/dist/docs/reference/dashboard/experiences.mdx +0 -51
- package/dist/docs/reference/dashboard/features.mdx +0 -154
- package/dist/docs/reference/dashboard/fields.mdx +0 -106
- package/dist/docs/reference/dashboard/flow-builder/canvas.mdx +0 -58
- package/dist/docs/reference/dashboard/flow-builder/condition-builder.md +0 -57
- package/dist/docs/reference/dashboard/flow-builder/keyboard-shortcuts.md +0 -72
- package/dist/docs/reference/dashboard/flow-builder/nodes.md +0 -63
- package/dist/docs/reference/dashboard/projects.mdx +0 -44
- package/dist/docs/reference/dashboard/reports.mdx +0 -43
- package/dist/docs/reference/dashboard/steps.mdx +0 -37
- package/dist/docs/reference/dashboard/team-management.md +0 -29
- package/dist/docs/reference/dashboard/workspace-versioning.mdx +0 -30
- package/dist/docs/reference/dashboard/workspaces.mdx +0 -76
- package/dist/docs/reference/delivery-api/experience-content.md +0 -152
- package/dist/docs/reference/delivery-api/index.md +0 -45
- package/dist/docs/reference/delivery-api/preview-caching-crawling.md +0 -79
- package/dist/docs/reference/delivery-api/project-config.md +0 -65
- package/dist/docs/reference/delivery-api/workspace-schema.md +0 -85
- package/dist/docs/reference/glossary.md +0 -181
- package/dist/docs/reference/management-api/authentication.md +0 -74
- package/dist/docs/reference/management-api/authorization-and-scopes.md +0 -285
- package/dist/docs/reference/management-api/error-handling.md +0 -233
- package/dist/docs/reference/management-api/pagination.md +0 -192
- package/dist/docs/reference/pickedql/data-sources.md +0 -174
- package/dist/docs/reference/pickedql/dimensions.md +0 -103
- package/dist/docs/reference/pickedql/filtering.md +0 -64
- package/dist/docs/reference/pickedql/index.md +0 -18
- package/dist/docs/reference/pickedql/schema.md +0 -172
- package/dist/docs/reference/pickedql/virtual-functions.md +0 -248
- package/dist/docs/reference/sdk/actions.md +0 -30
- package/dist/docs/reference/sdk/analytics-events.md +0 -445
- package/dist/docs/reference/sdk/conditions.md +0 -147
- package/dist/docs/reference/sdk/content-security-policy.md +0 -21
- package/dist/docs/reference/sdk/content.md +0 -213
- package/dist/docs/reference/sdk/experiences.md +0 -51
- package/dist/docs/reference/sdk/features.md +0 -256
- package/dist/docs/reference/sdk/fields.md +0 -255
- package/dist/docs/reference/sdk/index.md +0 -68
- package/dist/docs/reference/sdk/plugins/create-experience.md +0 -123
- package/dist/docs/reference/sdk/plugins/dynamic-experiences.md +0 -74
- package/dist/docs/reference/sdk/plugins/index.md +0 -29
- package/dist/docs/reference/sdk/plugins/window-object.md +0 -25
- package/dist/docs/reference/sdk/predicates.md +0 -43
- package/dist/docs/reference/sdk/ssr/index.md +0 -33
- package/dist/docs/reference/sdk/ssr/rendering-and-hydration.md +0 -103
- package/dist/docs/reference/sdk/ssr/serialize.md +0 -80
- package/dist/docs/reference/sdk/ssr/slots-and-placements.md +0 -59
- package/dist/docs/reference/sdk/steps.md +0 -86
- package/dist/docs/reference/sdk/type-generation.md +0 -196
- package/dist/docs/reference/tools/chrome-extension.md +0 -16
- package/dist/docs/reference/tools/cli.md +0 -146
- package/dist/docs/reference/tools/image-optimisation-service.md +0 -104
- package/dist/docs/reference/tools/mcp.md +0 -90
- package/dist/docs/reference/tools/vite-plugin.md +0 -163
- package/dist/docs/tutorials/first-api-call.md +0 -228
- package/dist/docs/tutorials/first-experience-in-the-dashboard.mdx +0 -143
- package/dist/docs/tutorials/first-experience.mdx +0 -254
- package/dist/docs/tutorials/first-server-rendered-page.mdx +0 -186
- package/dist/dom-DlLH3FxV.cjs +0 -1
- package/dist/experience-instance-D8rOg6We.cjs +0 -1
- package/dist/plugin-ChafFq6S.js +0 -194
- package/dist/plugin-Dn25Gffy.cjs +0 -1
- package/dist/preview-channel-Cx0e6fye.cjs +0 -1
- package/dist/provider-B8wvmeC8.js +0 -98
- package/dist/provider-BBLlQOjV.cjs +0 -1
- package/dist/rules-logic-CGZIYgAI.cjs +0 -1
- package/dist/version-CLjPfmxk.cjs +0 -1
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
import "./logger-DMN6TxJJ.js";
|
|
2
|
+
import { n as e, t } from "./api-B5i4XuCs.js";
|
|
3
|
+
import { r as n, t as r } from "./registry-CXZv0uLg.js";
|
|
4
|
+
//#region src/data-source/request-observer.ts
|
|
5
|
+
function i(e, t) {
|
|
6
|
+
try {
|
|
7
|
+
return e?.onRequest(t) ?? {};
|
|
8
|
+
} catch {
|
|
9
|
+
return {};
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
function a(e, t, n, r) {
|
|
13
|
+
try {
|
|
14
|
+
e.onSettled?.(t, n, r);
|
|
15
|
+
} catch {}
|
|
16
|
+
}
|
|
17
|
+
function o(e, t) {
|
|
18
|
+
return t === void 0 ? { stage: e } : t instanceof Error || t instanceof DOMException ? {
|
|
19
|
+
stage: e,
|
|
20
|
+
errorName: t.name,
|
|
21
|
+
errorMessage: t.message
|
|
22
|
+
} : {
|
|
23
|
+
stage: e,
|
|
24
|
+
errorName: typeof t
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
async function s(e, t, n) {
|
|
28
|
+
let r = i(e?.(), t), s, c;
|
|
29
|
+
try {
|
|
30
|
+
let e = await n(r.headers, (e) => {
|
|
31
|
+
s = e;
|
|
32
|
+
}, (e, t) => {
|
|
33
|
+
c = o(e, t);
|
|
34
|
+
});
|
|
35
|
+
return a(r, e !== null, s, c), e;
|
|
36
|
+
} catch (e) {
|
|
37
|
+
throw a(r, !1, s, c), e;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
//#endregion
|
|
41
|
+
//#region src/data-source/provider.ts
|
|
42
|
+
var c = "bundle", l = "api";
|
|
43
|
+
async function u() {
|
|
44
|
+
try {
|
|
45
|
+
let e = await import("virtual:picked/data");
|
|
46
|
+
return n(e) ? e : null;
|
|
47
|
+
} catch {
|
|
48
|
+
return null;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
function d(e) {
|
|
52
|
+
if (e === void 0 || n(e)) return e;
|
|
53
|
+
}
|
|
54
|
+
function f(n) {
|
|
55
|
+
let { apiUrl: i, projectId: a, previewToken: o, signal: f, getRequestObserver: p } = n, m = !!o, h = m ? l : n.mode, g = d(m ? void 0 : n.bundle), _ = m ? void 0 : n.projectConfig, v = n.getContent, y = {
|
|
56
|
+
mode: h ?? l,
|
|
57
|
+
manifest: null,
|
|
58
|
+
previewUnavailable: !1
|
|
59
|
+
}, b, x, S = /* @__PURE__ */ new Map();
|
|
60
|
+
function C() {
|
|
61
|
+
if (h === l) return Promise.resolve(null);
|
|
62
|
+
if (g) return Promise.resolve(g);
|
|
63
|
+
let e = r();
|
|
64
|
+
return e ? Promise.resolve(e) : (b ??= u(), b);
|
|
65
|
+
}
|
|
66
|
+
function w(e) {
|
|
67
|
+
y.mode = e ? c : l, y.manifest = e ? e.manifestMetadata : null;
|
|
68
|
+
}
|
|
69
|
+
async function T() {
|
|
70
|
+
if (_) return w(await C()), _;
|
|
71
|
+
let t = await C();
|
|
72
|
+
return w(t), t ? t.projectConfig : h === c ? null : s(p, "project-config", (t, n, r) => e(i, a, {
|
|
73
|
+
...o !== void 0 && { previewToken: o },
|
|
74
|
+
...f !== void 0 && { signal: f },
|
|
75
|
+
...t !== void 0 && { headers: t },
|
|
76
|
+
...r !== void 0 && { onFailure: r },
|
|
77
|
+
onResponse: (e) => {
|
|
78
|
+
y.previewUnavailable = m && e === 404, n?.(e);
|
|
79
|
+
}
|
|
80
|
+
}));
|
|
81
|
+
}
|
|
82
|
+
async function E(e, n) {
|
|
83
|
+
let r = o === void 0 ? void 0 : { previewToken: o };
|
|
84
|
+
if (v) return v(e, r);
|
|
85
|
+
let l = await C();
|
|
86
|
+
if (w(l), l) try {
|
|
87
|
+
return await l.experienceContent(e, r);
|
|
88
|
+
} catch {
|
|
89
|
+
return `${e.id}`, null;
|
|
90
|
+
}
|
|
91
|
+
if (h === c) return null;
|
|
92
|
+
let u = n ?? f;
|
|
93
|
+
return s(p, "experience-content", (n, r, s) => t(i, a, e.id, {
|
|
94
|
+
...o !== void 0 && { previewToken: o },
|
|
95
|
+
...u !== void 0 && { signal: u },
|
|
96
|
+
...n !== void 0 && { headers: n },
|
|
97
|
+
...r !== void 0 && { onResponse: r },
|
|
98
|
+
...s !== void 0 && { onFailure: s }
|
|
99
|
+
}));
|
|
100
|
+
}
|
|
101
|
+
return {
|
|
102
|
+
meta: y,
|
|
103
|
+
getProjectConfig: () => (x ??= T(), x),
|
|
104
|
+
getContent: (e, t) => {
|
|
105
|
+
let n = S.get(e.id);
|
|
106
|
+
if (n) return n;
|
|
107
|
+
let r = E(e, t?.signal).finally(() => {
|
|
108
|
+
S.delete(e.id);
|
|
109
|
+
});
|
|
110
|
+
return S.set(e.id, r), r;
|
|
111
|
+
}
|
|
112
|
+
};
|
|
113
|
+
}
|
|
114
|
+
//#endregion
|
|
115
|
+
export { f as createPickedDataProvider };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
const e=require("./object-CIkt7Fkr.cjs");function t(t){return t!==null&&!e.t(t)}async function n(e,t,n){return await e.evaluateRuleLogicFx({rule:t,context:n})}Object.defineProperty(exports,"n",{enumerable:!0,get:function(){return t}}),Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return n}});
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/** @file The error a preview read raises when its token names a workspace that no longer exists. */
|
|
2
|
+
/**
|
|
3
|
+
* Raised when a preview token's project config answers 404: the token still verifies, but the
|
|
4
|
+
* workspace it names has been deleted. The published configuration is still available.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* if (error instanceof PreviewUnavailableError) readPublishedConfig()
|
|
8
|
+
*/
|
|
9
|
+
export declare class PreviewUnavailableError extends Error {
|
|
10
|
+
/**
|
|
11
|
+
* Builds the error for one project's preview.
|
|
12
|
+
*
|
|
13
|
+
* @param {string} projectId - The project whose preview was requested.
|
|
14
|
+
* @example new PreviewUnavailableError('proj_1')
|
|
15
|
+
*/
|
|
16
|
+
constructor(projectId: string);
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=preview-unavailable.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"preview-unavailable.d.ts","sourceRoot":"","sources":["../../../src/data-source/preview-unavailable.ts"],"names":[],"mappings":"AAAA,oGAAoG;AAEpG;;;;;;GAMG;AACH,qBAAa,uBAAwB,SAAQ,KAAK;IAChD;;;;;OAKG;IACH,YAAY,SAAS,EAAE,MAAM,EAK5B;CACF"}
|
|
@@ -51,6 +51,11 @@ export interface PickedDataProviderMeta {
|
|
|
51
51
|
mode: PickedDataMode;
|
|
52
52
|
/** The bundle's manifest metadata, or `null` when not reading from a bundle. */
|
|
53
53
|
manifest: PickedManifestMetadata | null;
|
|
54
|
+
/**
|
|
55
|
+
* `true` once a preview token's project config has answered 404: the token verifies but the
|
|
56
|
+
* workspace it names no longer exists.
|
|
57
|
+
*/
|
|
58
|
+
previewUnavailable: boolean;
|
|
54
59
|
}
|
|
55
60
|
/** Resolves this session's project config and per-experience CMS content. */
|
|
56
61
|
export interface PickedDataProvider {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/data-source/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAE3F,OAAO,KAAK,EACV,aAAa,EACb,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,sCAAsC,CAAA;AAE7C,OAAO,EAEL,KAAK,gCAAgC,EACtC,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEpD,uEAAuE;AACvE,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,KAAK,CAAA;AAQ7C,oDAAoD;AACpD,MAAM,WAAW,yBAAyB;IACxC,sFAAsF;IACtF,MAAM,EAAE,MAAM,CAAA;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B,sFAAsF;IACtF,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,sFAAsF;IACtF,UAAU,CAAC,EAAE,aAAa,CAAA;IAC1B,sFAAsF;IACtF,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,2FAA2F;IAC3F,kBAAkB,CAAC,EAAE,gCAAgC,CAAA;CACtD;AAED,4DAA4D;AAC5D,MAAM,WAAW,sBAAsB;IACrC,yDAAyD;IACzD,IAAI,EAAE,cAAc,CAAA;IACpB,gFAAgF;IAChF,QAAQ,EAAE,sBAAsB,GAAG,IAAI,CAAA;
|
|
1
|
+
{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/data-source/provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAE3F,OAAO,KAAK,EACV,aAAa,EACb,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,sCAAsC,CAAA;AAE7C,OAAO,EAEL,KAAK,gCAAgC,EACtC,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEpD,uEAAuE;AACvE,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,KAAK,CAAA;AAQ7C,oDAAoD;AACpD,MAAM,WAAW,yBAAyB;IACxC,sFAAsF;IACtF,MAAM,EAAE,MAAM,CAAA;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B,sFAAsF;IACtF,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,sFAAsF;IACtF,UAAU,CAAC,EAAE,aAAa,CAAA;IAC1B,sFAAsF;IACtF,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,2FAA2F;IAC3F,kBAAkB,CAAC,EAAE,gCAAgC,CAAA;CACtD;AAED,4DAA4D;AAC5D,MAAM,WAAW,sBAAsB;IACrC,yDAAyD;IACzD,IAAI,EAAE,cAAc,CAAA;IACpB,gFAAgF;IAChF,QAAQ,EAAE,sBAAsB,GAAG,IAAI,CAAA;IACvC;;;OAGG;IACH,kBAAkB,EAAE,OAAO,CAAA;CAC5B;AAED,6EAA6E;AAC7E,MAAM,WAAW,kBAAkB;IACjC,wFAAwF;IACxF,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAA;IACrC,4FAA4F;IAC5F,gBAAgB,EAAE,MAAM,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAA;IACrD,oGAAoG;IACpG,UAAU,EAAE,CACV,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EACvC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,KAC/B,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC,CAAA;CAC/C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,wBAAwB,IAAI,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAYlF;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAA;AAyB9B;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,GAAG,kBAAkB,CA2L/F"}
|
|
@@ -8,12 +8,23 @@
|
|
|
8
8
|
*/
|
|
9
9
|
/** Which delivery API endpoint a request is for. */
|
|
10
10
|
export type DeliveryAPIEndpoint = 'project-config' | 'experience-content';
|
|
11
|
+
/** Where a delivery API request failed; mirrors the stages `@picked/delivery-api-client` reports. */
|
|
12
|
+
export type DeliveryAPIFailureStage = 'network' | 'status' | 'parse' | 'shape';
|
|
13
|
+
/** How a delivery API request failed. */
|
|
14
|
+
export interface DeliveryAPIFailure {
|
|
15
|
+
/** The stage the request failed at. */
|
|
16
|
+
stage: DeliveryAPIFailureStage;
|
|
17
|
+
/** The thrown error's name, or the type of a thrown non-error. Absent when nothing was thrown. */
|
|
18
|
+
errorName?: string;
|
|
19
|
+
/** The thrown error's message. Absent when nothing was thrown or the value had none. */
|
|
20
|
+
errorMessage?: string;
|
|
21
|
+
}
|
|
11
22
|
/** A request in flight, from the observer's point of view. */
|
|
12
23
|
export interface ObservedRequest {
|
|
13
24
|
/** Headers to merge into this request, such as `traceparent`. */
|
|
14
25
|
headers?: Record<string, string>;
|
|
15
|
-
/** Called once the request has settled, with the HTTP status when the server answered. */
|
|
16
|
-
onSettled?: (ok: boolean, status?: number) => void;
|
|
26
|
+
/** Called once the request has settled, with the HTTP status when the server answered and the failure when it failed. */
|
|
27
|
+
onSettled?: (ok: boolean, status?: number, failure?: DeliveryAPIFailure) => void;
|
|
17
28
|
}
|
|
18
29
|
/** Receives delivery API requests as they are made. */
|
|
19
30
|
export interface DeliveryAPIRequestObserver {
|
|
@@ -37,10 +48,11 @@ export declare function beginObservedRequest(observer: DeliveryAPIRequestObserve
|
|
|
37
48
|
* @param {ObservedRequest} observed - The handle returned when the request began.
|
|
38
49
|
* @param {boolean} ok - Whether the request produced a usable result.
|
|
39
50
|
* @param {number} [status] - HTTP status the server answered with, when it answered.
|
|
51
|
+
* @param {DeliveryAPIFailure} [failure] - How the request failed, when it did.
|
|
40
52
|
* @returns {void}
|
|
41
|
-
* @example settleObservedRequest(observed,
|
|
53
|
+
* @example settleObservedRequest(observed, false, undefined, { stage: 'network' })
|
|
42
54
|
*/
|
|
43
|
-
export declare function settleObservedRequest(observed: ObservedRequest, ok: boolean, status?: number): void;
|
|
55
|
+
export declare function settleObservedRequest(observed: ObservedRequest, ok: boolean, status?: number, failure?: DeliveryAPIFailure): void;
|
|
44
56
|
/**
|
|
45
57
|
* Runs a delivery API fetch with the observer wrapped around it.
|
|
46
58
|
*
|
|
@@ -49,14 +61,15 @@ export declare function settleObservedRequest(observed: ObservedRequest, ok: boo
|
|
|
49
61
|
* request, and the same handle receives the outcome.
|
|
50
62
|
*
|
|
51
63
|
* `run` reports the HTTP status through the `onResponse` callback it is handed.
|
|
52
|
-
* A fetch that never reached the server leaves the status absent.
|
|
64
|
+
* A fetch that never reached the server leaves the status absent. It reports where it failed
|
|
65
|
+
* through the `onFailure` callback it is handed.
|
|
53
66
|
*
|
|
54
67
|
* @template T - The value the fetch resolves to.
|
|
55
68
|
* @param {DeliveryAPIRequestObserverSource} [source] - Supplies the observer for this request.
|
|
56
69
|
* @param {DeliveryAPIEndpoint} endpoint - Which endpoint is being called.
|
|
57
|
-
* @param {(headers?: Record<string, string>, onResponse?: (status: number) => void) => Promise<T | null>} run - The fetch to perform.
|
|
70
|
+
* @param {(headers?: Record<string, string>, onResponse?: (status: number) => void, onFailure?: (stage: DeliveryAPIFailureStage, error?: unknown) => void) => Promise<T | null>} run - The fetch to perform.
|
|
58
71
|
* @returns {Promise<T | null>} Whatever the fetch resolved to.
|
|
59
|
-
* @example observeDeliveryAPIRequest(source, 'project-config', (headers, onResponse) => fetchProject(url, id, { headers, onResponse }))
|
|
72
|
+
* @example observeDeliveryAPIRequest(source, 'project-config', (headers, onResponse, onFailure) => fetchProject(url, id, { headers, onResponse, onFailure }))
|
|
60
73
|
*/
|
|
61
|
-
export declare function observeDeliveryAPIRequest<T>(source: DeliveryAPIRequestObserverSource | undefined, endpoint: DeliveryAPIEndpoint, run: (headers?: Record<string, string>, onResponse?: (status: number) => void) => Promise<T | null>): Promise<T | null>;
|
|
74
|
+
export declare function observeDeliveryAPIRequest<T>(source: DeliveryAPIRequestObserverSource | undefined, endpoint: DeliveryAPIEndpoint, run: (headers?: Record<string, string>, onResponse?: (status: number) => void, onFailure?: (stage: DeliveryAPIFailureStage, error?: unknown) => void) => Promise<T | null>): Promise<T | null>;
|
|
62
75
|
//# sourceMappingURL=request-observer.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"request-observer.d.ts","sourceRoot":"","sources":["../../../src/data-source/request-observer.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,oDAAoD;AACpD,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG,oBAAoB,CAAA;AAEzE,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,
|
|
1
|
+
{"version":3,"file":"request-observer.d.ts","sourceRoot":"","sources":["../../../src/data-source/request-observer.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,oDAAoD;AACpD,MAAM,MAAM,mBAAmB,GAAG,gBAAgB,GAAG,oBAAoB,CAAA;AAEzE,qGAAqG;AACrG,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAA;AAE9E,yCAAyC;AACzC,MAAM,WAAW,kBAAkB;IACjC,uCAAuC;IACvC,KAAK,EAAE,uBAAuB,CAAA;IAC9B,kGAAkG;IAClG,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wFAAwF;IACxF,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,yHAAyH;IACzH,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAA;CACjF;AAED,uDAAuD;AACvD,MAAM,WAAW,0BAA0B;IACzC,oFAAoF;IACpF,SAAS,EAAE,CAAC,QAAQ,EAAE,mBAAmB,KAAK,eAAe,CAAA;CAC9D;AAED,yFAAyF;AACzF,MAAM,MAAM,gCAAgC,GAAG,MAAM,0BAA0B,GAAG,IAAI,GAAG,SAAS,CAAA;AAElG;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,0BAA0B,GAAG,IAAI,GAAG,SAAS,EACvD,QAAQ,EAAE,mBAAmB,GAC5B,eAAe,CAOjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,eAAe,EACzB,EAAE,EAAE,OAAO,EACX,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,kBAAkB,GAC3B,IAAI,CAMN;AAmBD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,yBAAyB,CAAC,CAAC,EAC/C,MAAM,EAAE,gCAAgC,GAAG,SAAS,EACpD,QAAQ,EAAE,mBAAmB,EAC7B,GAAG,EAAE,CACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAChC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,EACrC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,uBAAuB,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,KAClE,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,GACrB,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAsBnB"}
|
|
@@ -12,7 +12,17 @@ export interface ActionContext {
|
|
|
12
12
|
experience: ExperienceInstance;
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* What an action receives first: the state snapshot, the call's arguments, and, when the
|
|
16
|
+
* caller set a signal or a timeout, or an ActionNode runs the action, a signal that aborts
|
|
17
|
+
* once the caller stops waiting. An ActionNode stops waiting when the visitor leaves it.
|
|
18
|
+
*/
|
|
19
|
+
export type ActionSnapshot = StateSnapshot & {
|
|
20
|
+
args: unknown[];
|
|
21
|
+
signal?: AbortSignal;
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* A named callable function that receives a state snapshot, action args, and a context, and
|
|
25
|
+
* returns or resolves to its response.
|
|
16
26
|
*
|
|
17
27
|
* `context` is an {@link ActionContext} only when the action is executed as an
|
|
18
28
|
* ActionNode in an experience flow. It is `null` for every other invocation path,
|
|
@@ -21,47 +31,108 @@ export interface ActionContext {
|
|
|
21
31
|
* validation/visibility). Rule-logic paths evaluate the action against a snapshot
|
|
22
32
|
* only and have no triggering instance.
|
|
23
33
|
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
34
|
+
* While an ActionNode's action runs, its experience ignores `goToNextStep`, `goToStepById`
|
|
35
|
+
* and `goToStepByKey`, so the action's outcome picks the branch. `goToPreviousStep` moves the
|
|
36
|
+
* visitor back, and the flow then drops the outcome. Open-state events (`open`, `close`,
|
|
37
|
+
* `toggleOpen`, `setOpen`) on `context.experience` take effect at once, and the flow still
|
|
38
|
+
* moves on when the action settles.
|
|
39
|
+
*
|
|
40
|
+
* Whatever the action returns, or resolves to, is its response: `client.actions.run`
|
|
41
|
+
* resolves to it, and a rule reading `actions.<key>` sees it when it is a logic value.
|
|
30
42
|
*
|
|
31
43
|
* When executed as an ActionNode, only a thrown error (or rejected promise) routes to
|
|
32
|
-
* the `onFail` edge. Every resolved value
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* throw on the failure case, e.g. `if (!response.ok) throw new Error(...)`. Outside a
|
|
36
|
-
* flow (manual invocation, rule logic) the return value is used directly and this
|
|
37
|
-
* branching does not apply.
|
|
44
|
+
* the `onFail` edge. Every resolved value, `false` and `undefined` included, routes to
|
|
45
|
+
* `onSuccess`. An action that maps an API response to the failure branch must therefore
|
|
46
|
+
* throw on the failure case, e.g. `if (!response.ok) throw new Error(...)`.
|
|
38
47
|
*/
|
|
39
|
-
export type Action = (snapshot:
|
|
40
|
-
|
|
41
|
-
|
|
48
|
+
export type Action = (snapshot: ActionSnapshot, context: ActionContext | null) => unknown;
|
|
49
|
+
/** How `client.actions.run` runs an action. */
|
|
50
|
+
export interface ActionRunOptions {
|
|
51
|
+
/** The arguments the action receives in its snapshot's `args`. */
|
|
52
|
+
args?: unknown[];
|
|
53
|
+
/** The experience the action runs for, handed to it as its context. */
|
|
54
|
+
experience?: ExperienceInstance;
|
|
55
|
+
/** Stops the run, rejecting with the signal's reason. */
|
|
56
|
+
signal?: AbortSignal;
|
|
57
|
+
/** The longest the run may take before it rejects with a `TimeoutError`. */
|
|
58
|
+
timeoutMs?: number;
|
|
59
|
+
}
|
|
60
|
+
/** Where the latest run a framework binding started stands. */
|
|
61
|
+
export interface ActionRunState {
|
|
62
|
+
status: 'idle' | 'running' | 'succeeded' | 'failed';
|
|
63
|
+
/** The response of the latest run, once it succeeded. */
|
|
64
|
+
response: unknown;
|
|
65
|
+
/** What the latest run threw, once it failed. */
|
|
66
|
+
error: unknown;
|
|
67
|
+
}
|
|
68
|
+
/** How one run a framework binding started ended. */
|
|
69
|
+
export type SettledActionRun = {
|
|
70
|
+
status: 'succeeded';
|
|
71
|
+
response: unknown;
|
|
72
|
+
} | {
|
|
73
|
+
status: 'failed';
|
|
74
|
+
error: unknown;
|
|
75
|
+
};
|
|
76
|
+
/** The state of the latest run a binding started, and `run` to start one. */
|
|
77
|
+
export interface ActionBinding extends ActionRunState {
|
|
78
|
+
/** Runs the action with these arguments, resolving to how the run ended; never rejects. */
|
|
79
|
+
run: (...args: unknown[]) => Promise<SettledActionRun>;
|
|
80
|
+
}
|
|
81
|
+
/** The callable action: calling it runs the action with the arguments it is called with. */
|
|
82
|
+
export type EvokableAction = (...args: unknown[]) => ReturnType<Action>;
|
|
83
|
+
/** The callable action that also carries its binding: calling it runs the action as is. */
|
|
84
|
+
export type ActionHandle = EvokableAction & ActionBinding;
|
|
85
|
+
/** The action index a client holds. */
|
|
42
86
|
export type ActionsStore = ReturnType<typeof createActionIndexFactory>;
|
|
87
|
+
/** One registered action. */
|
|
43
88
|
export interface ActionIndexItem {
|
|
44
89
|
key: string;
|
|
45
90
|
action: Action;
|
|
91
|
+
/** True when the dynamic-experiences plugin registered the action from the project config. */
|
|
92
|
+
published: boolean;
|
|
93
|
+
}
|
|
94
|
+
/** What registering an action takes. */
|
|
95
|
+
export interface ActionRegistration {
|
|
96
|
+
key: string;
|
|
97
|
+
action: Action;
|
|
98
|
+
/** Marks an action registered from the project config; a host's own action omits it. */
|
|
99
|
+
published?: boolean;
|
|
46
100
|
}
|
|
101
|
+
/** The options the per-key stores take. */
|
|
102
|
+
type PerKeyOptions = {
|
|
103
|
+
experience: ExperienceInstance;
|
|
104
|
+
} | undefined;
|
|
105
|
+
/** Gives the store built for a key and experience, building it the first time. */
|
|
106
|
+
type PerKey<T> = ((actionKey: string, options?: PerKeyOptions) => T) & {
|
|
107
|
+
/** Gives the store built for the key and experience, or `undefined` when there is none. */
|
|
108
|
+
find: (actionKey: string, options?: PerKeyOptions) => T | undefined;
|
|
109
|
+
};
|
|
47
110
|
declare const createActionIndexFactory: ({ client }: {
|
|
48
111
|
client: Picked;
|
|
49
112
|
}) => {
|
|
50
|
-
register: EventCallable<
|
|
51
|
-
|
|
52
|
-
action: Action;
|
|
53
|
-
}>;
|
|
113
|
+
register: EventCallable<ActionRegistration>;
|
|
114
|
+
unregister: EventCallable<string>;
|
|
54
115
|
getByKey: (key: string) => Store<Action | undefined>;
|
|
55
116
|
listStore: Store<ActionIndexItem[]>;
|
|
56
|
-
getEvokableAction:
|
|
117
|
+
getEvokableAction: PerKey<Store<EvokableAction>>;
|
|
118
|
+
getActionBinding: PerKey<Store<ActionHandle>>;
|
|
119
|
+
getActionResult: (actionKey: string, options?: {
|
|
120
|
+
experience: ExperienceInstance;
|
|
121
|
+
}) => Store<unknown>;
|
|
122
|
+
refreshActionResult: (actionKey: string, options?: {
|
|
123
|
+
experience: ExperienceInstance;
|
|
124
|
+
}) => void;
|
|
125
|
+
isActionResultQueued: (actionKey: string, options?: {
|
|
57
126
|
experience: ExperienceInstance;
|
|
58
|
-
}) =>
|
|
127
|
+
}) => boolean;
|
|
128
|
+
run: (key: string, options?: ActionRunOptions) => Promise<unknown>;
|
|
129
|
+
isPublished: (key: string) => boolean;
|
|
59
130
|
};
|
|
60
131
|
/**
|
|
61
132
|
* Creates an action index with lifecycle stores and registration logic.
|
|
62
133
|
*
|
|
63
134
|
* @param {object} params - Factory parameters including the client.
|
|
64
|
-
* @returns {ReturnType<typeof createActionIndexFactory>} The action index with register, getByKey, listStore, and
|
|
135
|
+
* @returns {ReturnType<typeof createActionIndexFactory>} The action index with register, unregister, getByKey, listStore, the evokable, binding and result stores, refreshActionResult, isActionResultQueued, run and isPublished.
|
|
65
136
|
* @example
|
|
66
137
|
* ```ts
|
|
67
138
|
* const actions = createActionIndex({ client })
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../../src/entities/action/action.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,OAAO,
|
|
1
|
+
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../../src/entities/action/action.ts"],"names":[],"mappings":"AAAA,uFAAuF;AACvF,OAAO,EASL,KAAK,aAAa,EAGlB,KAAK,KAAK,EAEX,MAAM,UAAU,CAAA;AAGjB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAA;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAA;AAEpF;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,sEAAsE;IACtE,UAAU,EAAE,kBAAkB,CAAA;CAC/B;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,WAAW,CAAA;CAAE,CAAA;AAEtF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI,KAAK,OAAO,CAAA;AAEzF,+CAA+C;AAC/C,MAAM,WAAW,gBAAgB;IAC/B,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,EAAE,CAAA;IAChB,uEAAuE;IACvE,UAAU,CAAC,EAAE,kBAAkB,CAAA;IAC/B,yDAAyD;IACzD,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,4EAA4E;IAC5E,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,+DAA+D;AAC/D,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAA;IACnD,yDAAyD;IACzD,QAAQ,EAAE,OAAO,CAAA;IACjB,iDAAiD;IACjD,KAAK,EAAE,OAAO,CAAA;CACf;AAED,qDAAqD;AACrD,MAAM,MAAM,gBAAgB,GAC1B;IAAE,MAAM,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAA;AAEnF,6EAA6E;AAC7E,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,2FAA2F;IAC3F,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAA;CACvD;AAED,4FAA4F;AAC5F,MAAM,MAAM,cAAc,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,UAAU,CAAC,MAAM,CAAC,CAAA;AAEvE,2FAA2F;AAC3F,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG,aAAa,CAAA;AAEzD,uCAAuC;AACvC,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAEtE,6BAA6B;AAC7B,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,8FAA8F;IAC9F,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,wCAAwC;AACxC,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,wFAAwF;IACxF,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAyBD,2CAA2C;AAC3C,KAAK,aAAa,GAAG;IAAE,UAAU,EAAE,kBAAkB,CAAA;CAAE,GAAG,SAAS,CAAA;AAEnE,kFAAkF;AAClF,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,CAAC,CAAC,GAAG;IACrE,2FAA2F;IAC3F,IAAI,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,CAAC,GAAG,SAAS,CAAA;CACpE,CAAA;AA2CD,QAAA,MAAM,wBAAwB,eAA8B;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;;oBA+DrD,MAAM;;;;iCAmUhB,MAAM,YACP;QAAE,UAAU,EAAE,kBAAkB,CAAA;KAAE,KAC3C,KAAK,CAAC,OAAO,CAAC;qCAmBJ,MAAM,YACP;QAAE,UAAU,EAAE,kBAAkB,CAAA;KAAE,KAC3C,IAAI;sCAoBM,MAAM,YACP;QAAE,UAAU,EAAE,kBAAkB,CAAA;KAAE,KAC3C,OAAO;eA9Nc,MAAM,YAAW,gBAAgB,KAAQ,OAAO,CAAC,OAAO,CAAC;uBA6OvD,MAAM,KAAG,OAAO;CAiB1C,CAAA;AAsBF;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC,CAAC,CAAC,EACxF,MAAM,EAAE,CAAC,GACR,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAE7C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,QAAS,MAAM,UAAU,MAAM,WAAW,YAAY,KAAG,IAEhF,CAAA"}
|
|
@@ -59,11 +59,23 @@ export interface ExperienceInstanceTarget {
|
|
|
59
59
|
selector: HTMLElement[];
|
|
60
60
|
placement: ExperienceTarget['placement'];
|
|
61
61
|
}
|
|
62
|
-
|
|
62
|
+
/**
|
|
63
|
+
* How a slot-rendered instance reads an `initializeOpen` of `null` or `undefined`: `'rule'` leaves
|
|
64
|
+
* it closed and `'rendered'` opens it. A boolean or a rule decides the same way under both.
|
|
65
|
+
*/
|
|
66
|
+
export type SlotOpenPolicy = 'rule' | 'rendered';
|
|
67
|
+
declare const createExperienceInstanceFactory: ({ client, experience, target, options, deferOpen, slotOpen, }: {
|
|
63
68
|
client: Picked;
|
|
64
69
|
experience: ExperienceStore;
|
|
65
70
|
target?: HTMLElement;
|
|
66
71
|
options?: LaunchExperienceOptions;
|
|
72
|
+
/**
|
|
73
|
+
* Leaves the instance to `experienceInstances.adopt`: creation emits nothing, and the instance
|
|
74
|
+
* evaluates its open state and runs its flow only while it is adopted.
|
|
75
|
+
*/
|
|
76
|
+
deferOpen?: boolean;
|
|
77
|
+
/** How a missing `initializeOpen` reads for a slot-rendered instance. */
|
|
78
|
+
slotOpen?: SlotOpenPolicy;
|
|
67
79
|
}) => ExperienceInstance;
|
|
68
80
|
/**
|
|
69
81
|
* Creates an experience instance with lifecycle stores and navigation logic.
|
|
@@ -80,6 +92,7 @@ declare const createExperienceInstanceIndexFactory: ({ client }: {
|
|
|
80
92
|
client: Picked;
|
|
81
93
|
}) => {
|
|
82
94
|
spawn: (experience: ExperienceStore, target: HTMLElement, options?: LaunchExperienceOptions) => void;
|
|
95
|
+
adopt: (instance: ExperienceInstance) => () => void;
|
|
83
96
|
getByExperienceKey: (key: Experience['key']) => Store<ExperienceInstance[]>;
|
|
84
97
|
getByExperienceId: (id: Experience['id']) => Store<ExperienceInstance[]>;
|
|
85
98
|
listStore: Store<ExperienceInstance[]>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"experience-instance.d.ts","sourceRoot":"","sources":["../../../../src/entities/experience-instance/experience-instance.ts"],"names":[],"mappings":"AAAA,yFAAyF;AACzF,OAAO,EAOL,KAAK,MAAM,EACX,KAAK,aAAa,EAGlB,KAAK,KAAK,EACX,MAAM,UAAU,CAAA;AAEjB,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACxB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAiB1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;
|
|
1
|
+
{"version":3,"file":"experience-instance.d.ts","sourceRoot":"","sources":["../../../../src/entities/experience-instance/experience-instance.ts"],"names":[],"mappings":"AAAA,yFAAyF;AACzF,OAAO,EAOL,KAAK,MAAM,EACX,KAAK,aAAa,EAGlB,KAAK,KAAK,EACX,MAAM,UAAU,CAAA;AAEjB,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACxB,MAAM,0BAA0B,CAAA;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAiB1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAKtD,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,UAAU,CAAC,KAAK,CAAC,CAAA;IAChC,YAAY,EAAE,UAAU,CAAC,IAAI,CAAC,CAAA;IAC9B,sGAAsG;IACtG,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,eAAe,CAAC,aAAa,CAAC,CAAA;IAC3C,MAAM,EAAE,WAAW,GAAG,SAAS,CAAA;IAC/B,cAAc,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAA;IACjD;;OAEG;IACH,0BAA0B,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,SAAS,CAAC;QAAC,SAAS,EAAE,SAAS,CAAA;KAAE,GAAG,IAAI,CAAC,CAAA;IACxF,UAAU,EAAE,KAAK,CAAC,eAAe,GAAG,OAAO,CAAC,CAAA;IAC5C,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;IAC3B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,CAAA;IACzB,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,CAAA;IAC1B,UAAU,EAAE,aAAa,CAAC,IAAI,CAAC,CAAA;IAC/B,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;IAC/B,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAA;IACvC,gBAAgB,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IAC9C;;;;;;;;OAQG;IACH,gBAAgB,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IAC9C,iBAAiB,EAAE,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,CAAA;IAC/C,2BAA2B,EAAE,KAAK,CAAC,cAAc,EAAE,CAAC,CAAA;IACpD,kBAAkB,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAA;IACnC,gBAAgB,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAA;IACjC,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC,CAAA;IACjC,gBAAgB,EAAE,aAAa,CAAC,IAAI,CAAC,CAAA;IACrC,YAAY,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACnC,aAAa,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IACpC,iBAAiB,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CAAA;IACxC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;CACnC;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,OAAO,6BAA6B,CAAC,CAAA;AACtF,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,WAAW,EAAE,CAAA;IACvB,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAA;CACzC;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,UAAU,CAAA;AAiBhD,QAAA,MAAM,+BAA+B,kEAQhC;IACD,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,eAAe,CAAA;IAC3B,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,OAAO,CAAC,EAAE,uBAAuB,CAAA;IACjC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,yEAAyE;IACzE,QAAQ,CAAC,EAAE,cAAc,CAAA;CAC1B,uBA4mBF,CAAA;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CACtC,CAAC,SAAS,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC,CAAC,CAAC,EAC/D,MAAM,EAAE,CAAC,GAAG,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAE/D;AAED,QAAA,MAAM,oCAAoC,eAA8B;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;wBA4H1E,eAAe,UACnB,WAAW,YACT,uBAAuB;sBAyDV,kBAAkB,KAAG,MAAM,IAAI;8BAtCvB,UAAU,CAAC,KAAK,CAAC;4BAiBnB,UAAU,CAAC,IAAI,CAAC;;CAmD/C,CAAA;AAEF;;;;;;;;;GASG;AACH,wBAAgB,6BAA6B,CAC3C,CAAC,SAAS,UAAU,CAAC,OAAO,oCAAoC,CAAC,CAAC,CAAC,CAAC,EACpE,MAAM,EAAE,CAAC,GAAG,UAAU,CAAC,OAAO,oCAAoC,CAAC,CAEpE"}
|
package/dist/types/exports.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ export { rehydrateScripts, buildRehydrateBootstrap, PICKED_SCRIPT_TYPE, PICKED_M
|
|
|
6
6
|
export { isHtmlAssetValue } from './utils/html-asset-value';
|
|
7
7
|
export type { HtmlAssetValue } from './utils/html-asset-value';
|
|
8
8
|
export { isPreviewSession, PREVIEW_TOKEN_PARAM } from './utils/preview-session';
|
|
9
|
+
export { PreviewUnavailableError } from './data-source/preview-unavailable';
|
|
9
10
|
export { onInertScriptSubtrees, reportInertScriptSubtrees, resetInertScriptReport, } from './utils/inert-script-report';
|
|
10
11
|
export * from './utils/supports';
|
|
11
12
|
export * from './utils/storage';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../src/exports.ts"],"names":[],"mappings":"AAAA,8IAA8I;AAC9I,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAGjC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,YAAY,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC/E,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,6BAA6B,CAAA;AAEpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,mBAAmB,iBAAiB,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,GACjB,MAAM,8BAA8B,CAAA;AACrC,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAEpE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,YAAa,mBAAmB,KAAG,MAI3D,CAAA;AAED,YAAY,EACV,uBAAuB,EACvB,qBAAqB,GACtB,MAAM,kCAAkC,CAAA"}
|
|
1
|
+
{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../src/exports.ts"],"names":[],"mappings":"AAAA,8IAA8I;AAC9I,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAGjC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,yBAAyB,EACzB,oBAAoB,GACrB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,YAAY,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAA;AAC3E,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,GACvB,MAAM,6BAA6B,CAAA;AAEpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,mBAAmB,iBAAiB,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAA;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,gBAAgB,GACjB,MAAM,8BAA8B,CAAA;AACrC,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAEpE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,YAAa,mBAAmB,KAAG,MAI3D,CAAA;AAED,YAAY,EACV,uBAAuB,EACvB,qBAAqB,GACtB,MAAM,kCAAkC,CAAA"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -22,6 +22,6 @@ export type * from './utils/events';
|
|
|
22
22
|
export type * from './utils/search-params';
|
|
23
23
|
export type * from './entities/response/response';
|
|
24
24
|
export { Picked } from './picked';
|
|
25
|
-
export type { ActionKeys, ContentForStep, ExperienceKeys, FeatureKeys, FeatureValueFor, FieldKeys, FieldKeysForStep, FieldValueFor, KnownActionKeys, KnownExperienceKeys, KnownFeatureKeys, KnownFieldKeys, KnownStepKeys, PickedSchemaRegistry, ReferencedContent, StepContentModelsMap, StepKeys, StepLayoutContent, TypedContent, } from './schema-registry';
|
|
26
|
-
export { toTypedContentStore } from './typed-content';
|
|
25
|
+
export type { ActionKeys, ContentForStep, ContentModelKeys, ContentRecordOf, ExperienceKeys, FeatureKeys, FeatureValueFor, FieldKeys, FieldKeysForStep, FieldValueFor, KnownActionKeys, KnownExperienceKeys, KnownFeatureKeys, KnownFieldKeys, KnownStepKeys, PickedSchemaRegistry, ReferencedContent, WorkflowActionKeys, StepContentModelsMap, StepKeys, StepLayoutContent, TypedContent, } from './schema-registry';
|
|
26
|
+
export { isContentOfModel, toTypedContentStore } from './typed-content';
|
|
27
27
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,4GAA4G;AAC5G,cAAc,WAAW,CAAA;AACzB,mBAAmB,UAAU,CAAA;AAC7B,mBAAmB,0BAA0B,CAAA;AAC7C,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,4BAA4B,CAAA;AAC/C,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,oCAAoC,CAAA;AACvD,mBAAmB,oDAAoD,CAAA;AACvE,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,sBAAsB,CAAA;AACzC,mBAAmB,4BAA4B,CAAA;AAC/C,mBAAmB,wBAAwB,CAAA;AAC3C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,4BAA4B,CAAA;AAC/C,mBAAmB,0BAA0B,CAAA;AAC7C,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,4BAA4B,CAAA;AAC/C,mBAAmB,gBAAgB,CAAA;AACnC,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,8BAA8B,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,YAAY,EACV,UAAU,EACV,cAAc,EACd,cAAc,EACd,WAAW,EACX,eAAe,EACf,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,QAAQ,EACR,iBAAiB,EACjB,YAAY,GACb,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,4GAA4G;AAC5G,cAAc,WAAW,CAAA;AACzB,mBAAmB,UAAU,CAAA;AAC7B,mBAAmB,0BAA0B,CAAA;AAC7C,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,4BAA4B,CAAA;AAC/C,mBAAmB,8BAA8B,CAAA;AACjD,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,oCAAoC,CAAA;AACvD,mBAAmB,oDAAoD,CAAA;AACvE,mBAAmB,kCAAkC,CAAA;AACrD,mBAAmB,sBAAsB,CAAA;AACzC,mBAAmB,4BAA4B,CAAA;AAC/C,mBAAmB,wBAAwB,CAAA;AAC3C,mBAAmB,2BAA2B,CAAA;AAC9C,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,4BAA4B,CAAA;AAC/C,mBAAmB,0BAA0B,CAAA;AAC7C,mBAAmB,gCAAgC,CAAA;AACnD,mBAAmB,4BAA4B,CAAA;AAC/C,mBAAmB,gBAAgB,CAAA;AACnC,mBAAmB,uBAAuB,CAAA;AAC1C,mBAAmB,8BAA8B,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,YAAY,EACV,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,WAAW,EACX,eAAe,EACf,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,QAAQ,EACR,iBAAiB,EACjB,YAAY,GACb,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"rules-logic.d.ts","sourceRoot":"","sources":["../../../src/lifecycle/rules-logic.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAClG,OAAO,EAAU,KAAK,MAAM,EAAE,MAAM,UAAU,CAAA;AAG9C,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"rules-logic.d.ts","sourceRoot":"","sources":["../../../src/lifecycle/rules-logic.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAClG,OAAO,EAAU,KAAK,MAAM,EAAE,MAAM,UAAU,CAAA;AAG9C,OAAO,KAAK,EAEV,WAAW,EACX,SAAS,EAGV,MAAM,iBAAiB,CAAA;AAExB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAEvC,oGAAoG;AACpG,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,SAAS,CAAA;IACf,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AA4KD;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE;IAChD,MAAM,EAAE,MAAM,CAAA;CACf,GAAG,MAAM,CAAC,uBAAuB,EAAE,OAAO,EAAE,KAAK,CAAC,CAElD"}
|
|
@@ -16,6 +16,15 @@ export interface LogicRule {
|
|
|
16
16
|
export type LogicContext = {
|
|
17
17
|
[key: string]: LogicValue;
|
|
18
18
|
} | LogicValue;
|
|
19
|
+
/**
|
|
20
|
+
* Every operator this engine dispatches, from both places a dispatch can live. An entry in
|
|
21
|
+
* `operations` joins by being added to it; a case in `apply`'s switch joins through
|
|
22
|
+
* `CONTROL_OPERATORS`, and `logic-engine.test.ts` fails when one is missing from there.
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* OPERATORS.includes('regexp_matches') // true
|
|
26
|
+
*/
|
|
27
|
+
export declare const OPERATORS: readonly string[];
|
|
19
28
|
/**
|
|
20
29
|
* Evaluates a JSON Logic expression against a data context.
|
|
21
30
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logic-engine.d.ts","sourceRoot":"","sources":["../../src/logic-engine.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,CAAA;AAEpG,MAAM,MAAM,UAAU,GAClB,cAAc,GACd,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,UAAU,CAAC,GACpC,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC,GACjD,OAAO,CAAC,cAAc,CAAC,CAAA;AAE3B,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;CAC1B;AAED,KAAK,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAA;AAEnC,MAAM,MAAM,cAAc,
|
|
1
|
+
{"version":3,"file":"logic-engine.d.ts","sourceRoot":"","sources":["../../src/logic-engine.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,CAAA;AAEpG,MAAM,MAAM,UAAU,GAClB,cAAc,GACd,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,UAAU,CAAC,GACpC,CAAC,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC,GACjD,OAAO,CAAC,cAAc,CAAC,CAAA;AAE3B,MAAM,WAAW,WAAW;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;CAC1B;AAED,KAAK,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAA;AAEnC,MAAM,MAAM,cAAc,GACxB,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,EAAE,GAAG,cAAc,EAAE,CAAA;AAE3F,MAAM,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,GAAG,cAAc,EAAE,CAAA;CACjD;AAED,MAAM,MAAM,YAAY,GACpB;IACE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;CAC1B,GACD,UAAU,CAAA;AA0Td;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,EAAE,SAAS,MAAM,EAAuD,CAAA;AAE9F;;;;;;;GAOG;AAEH,wBAAsB,KAAK,CACzB,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,SAAS,EAC3C,IAAI,CAAC,EAAE,YAAY,GAClB,OAAO,CAAC,UAAU,CAAC,CAmJrB"}
|
package/dist/types/picked.d.ts
CHANGED
|
@@ -29,8 +29,11 @@ import type { SessionEntity } from './entities/session/session';
|
|
|
29
29
|
* virtual data module is available; remains `null` otherwise.
|
|
30
30
|
*/
|
|
31
31
|
export interface PickedDataSource {
|
|
32
|
-
/**
|
|
33
|
-
|
|
32
|
+
/**
|
|
33
|
+
* `'build'` when build-mode prefetch JSON was used, `'dev'` when the dev-mode runtime fetch was
|
|
34
|
+
* used, `'snapshot'` when the committed `picked.snapshot.json` was.
|
|
35
|
+
*/
|
|
36
|
+
mode: 'dev' | 'build' | 'snapshot';
|
|
34
37
|
/** ISO 8601 timestamp from the manifest. `null` in dev mode where no manifest is written. */
|
|
35
38
|
fetchedAt: string | null;
|
|
36
39
|
/** The `versionId` recorded by the source, when known. */
|
|
@@ -62,6 +65,11 @@ export declare class Picked {
|
|
|
62
65
|
seeded: string;
|
|
63
66
|
resolved: string;
|
|
64
67
|
} | null;
|
|
68
|
+
/**
|
|
69
|
+
* `true` when this page arrived with a preview token whose workspace no longer exists, and the
|
|
70
|
+
* published configuration is being served in its place.
|
|
71
|
+
*/
|
|
72
|
+
previewUnavailable: boolean;
|
|
65
73
|
/**
|
|
66
74
|
* Content fetcher selected by `dynamicExperiencesPlugin`'s resolution chain. Called
|
|
67
75
|
* by each experience's `prepareExperienceContentFx` (fired in parallel with
|
|
@@ -125,6 +133,7 @@ export declare class Picked {
|
|
|
125
133
|
};
|
|
126
134
|
readonly experienceInstances: {
|
|
127
135
|
spawn: (experience: import(".").ExperienceStore, target: HTMLElement, options?: LaunchExperienceOptions) => void;
|
|
136
|
+
adopt: (instance: import(".").ExperienceInstance) => () => void;
|
|
128
137
|
getByExperienceKey: (key: Experience['key']) => Store<import(".").ExperienceInstance[]>;
|
|
129
138
|
getByExperienceId: (id: Experience['id']) => Store<import(".").ExperienceInstance[]>;
|
|
130
139
|
listStore: Store<import(".").ExperienceInstance[]>;
|
|
@@ -243,15 +252,35 @@ export declare class Picked {
|
|
|
243
252
|
}>;
|
|
244
253
|
};
|
|
245
254
|
readonly actions: {
|
|
246
|
-
register: EventCallable<
|
|
247
|
-
|
|
248
|
-
action: Action;
|
|
249
|
-
}>;
|
|
255
|
+
register: EventCallable<import(".").ActionRegistration>;
|
|
256
|
+
unregister: EventCallable<string>;
|
|
250
257
|
getByKey: (key: string) => Store<Action | undefined>;
|
|
251
258
|
listStore: Store<import(".").ActionIndexItem[]>;
|
|
252
|
-
getEvokableAction: (actionKey: string, options?: {
|
|
259
|
+
getEvokableAction: ((actionKey: string, options?: {
|
|
260
|
+
experience: import(".").ExperienceInstance;
|
|
261
|
+
} | undefined) => Store<import(".").EvokableAction>) & {
|
|
262
|
+
find: (actionKey: string, options?: {
|
|
263
|
+
experience: import(".").ExperienceInstance;
|
|
264
|
+
} | undefined) => Store<import(".").EvokableAction> | undefined;
|
|
265
|
+
};
|
|
266
|
+
getActionBinding: ((actionKey: string, options?: {
|
|
267
|
+
experience: import(".").ExperienceInstance;
|
|
268
|
+
} | undefined) => Store<import(".").ActionHandle>) & {
|
|
269
|
+
find: (actionKey: string, options?: {
|
|
270
|
+
experience: import(".").ExperienceInstance;
|
|
271
|
+
} | undefined) => Store<import(".").ActionHandle> | undefined;
|
|
272
|
+
};
|
|
273
|
+
getActionResult: (actionKey: string, options?: {
|
|
274
|
+
experience: import(".").ExperienceInstance;
|
|
275
|
+
}) => Store<unknown>;
|
|
276
|
+
refreshActionResult: (actionKey: string, options?: {
|
|
277
|
+
experience: import(".").ExperienceInstance;
|
|
278
|
+
}) => void;
|
|
279
|
+
isActionResultQueued: (actionKey: string, options?: {
|
|
253
280
|
experience: import(".").ExperienceInstance;
|
|
254
|
-
}) =>
|
|
281
|
+
}) => boolean;
|
|
282
|
+
run: (key: string, options?: import(".").ActionRunOptions) => Promise<unknown>;
|
|
283
|
+
isPublished: (key: string) => boolean;
|
|
255
284
|
};
|
|
256
285
|
/**
|
|
257
286
|
* Memoized condition-evaluation results keyed by rule hash. Populated by the
|
|
@@ -306,6 +335,7 @@ export declare class Picked {
|
|
|
306
335
|
* @param {string} [options.previewToken] - Preview token, forcing a live read.
|
|
307
336
|
* @param {AbortSignal} [options.signal] - Signal applied to an API read.
|
|
308
337
|
* @returns {Promise<ProjectConfig>} The project configuration.
|
|
338
|
+
* @throws {PreviewUnavailableError} When the preview token names a workspace that no longer exists.
|
|
309
339
|
* @throws {Error} When the configuration cannot be resolved from any source.
|
|
310
340
|
* @example
|
|
311
341
|
* const config = await client.getProjectConfig()
|