@picked/client 0.0.1-dev.1794460939512 → 0.0.1-dev.1794524488993
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/.tsbuildinfo +1 -1
- package/dist/{api-DpESrsVW.js → api-BPgIOr9M.js} +1 -1
- package/dist/{api-CwgMIHfV.cjs → api-CPcoVcOk.cjs} +1 -1
- package/dist/cjs/client.d.ts +161 -0
- package/dist/cjs/client.d.ts.map +1 -0
- package/dist/cjs/data-source/api.d.ts +60 -0
- package/dist/cjs/data-source/api.d.ts.map +1 -0
- package/dist/cjs/data-source/preview-unavailable.d.ts +21 -0
- package/dist/cjs/data-source/preview-unavailable.d.ts.map +1 -0
- package/dist/cjs/data-source/provider.d.ts +108 -0
- package/dist/cjs/data-source/provider.d.ts.map +1 -0
- package/dist/cjs/data-source/registry.d.ts +26 -0
- package/dist/cjs/data-source/registry.d.ts.map +1 -0
- package/dist/cjs/data-source/request-observer.d.ts +75 -0
- package/dist/cjs/data-source/request-observer.d.ts.map +1 -0
- package/dist/cjs/data-source/virtual-data.d.ts +19 -0
- package/dist/cjs/data-source/virtual-data.d.ts.map +1 -0
- package/dist/cjs/entities/action/action.d.ts +156 -0
- package/dist/cjs/entities/action/action.d.ts.map +1 -0
- package/dist/cjs/entities/component/component.d.ts +91 -0
- package/dist/cjs/entities/component/component.d.ts.map +1 -0
- package/dist/cjs/entities/component/lazyComponent.d.ts +11 -0
- package/dist/cjs/entities/component/lazyComponent.d.ts.map +1 -0
- package/dist/cjs/entities/condition/condition.d.ts +29 -0
- package/dist/cjs/entities/condition/condition.d.ts.map +1 -0
- package/dist/cjs/entities/content/content.d.ts +53 -0
- package/dist/cjs/entities/content/content.d.ts.map +1 -0
- package/dist/cjs/entities/content/reference.d.ts +101 -0
- package/dist/cjs/entities/content/reference.d.ts.map +1 -0
- package/dist/cjs/entities/experience/experience.d.ts +228 -0
- package/dist/cjs/entities/experience/experience.d.ts.map +1 -0
- package/dist/cjs/entities/experience-instance/action-result.d.ts +69 -0
- package/dist/cjs/entities/experience-instance/action-result.d.ts.map +1 -0
- package/dist/cjs/entities/experience-instance/experience-instance.d.ts +112 -0
- package/dist/cjs/entities/experience-instance/experience-instance.d.ts.map +1 -0
- package/dist/cjs/entities/feature/feature.d.ts +158 -0
- package/dist/cjs/entities/feature/feature.d.ts.map +1 -0
- package/dist/cjs/entities/field/field.d.ts +135 -0
- package/dist/cjs/entities/field/field.d.ts.map +1 -0
- package/dist/cjs/entities/field/policies.d.ts +35 -0
- package/dist/cjs/entities/field/policies.d.ts.map +1 -0
- package/dist/cjs/entities/framework/framework.d.ts +45 -0
- package/dist/cjs/entities/framework/framework.d.ts.map +1 -0
- package/dist/cjs/entities/history/history.d.ts +25 -0
- package/dist/cjs/entities/history/history.d.ts.map +1 -0
- package/dist/cjs/entities/plugin/plugin.d.ts +50 -0
- package/dist/cjs/entities/plugin/plugin.d.ts.map +1 -0
- package/dist/cjs/entities/predicate/predicate.d.ts +48 -0
- package/dist/cjs/entities/predicate/predicate.d.ts.map +1 -0
- package/dist/cjs/entities/response/response-validation.d.ts +75 -0
- package/dist/cjs/entities/response/response-validation.d.ts.map +1 -0
- package/dist/cjs/entities/response/response.d.ts +69 -0
- package/dist/cjs/entities/response/response.d.ts.map +1 -0
- package/dist/cjs/entities/session/session.d.ts +55 -0
- package/dist/cjs/entities/session/session.d.ts.map +1 -0
- package/dist/cjs/entities/step/step.d.ts +56 -0
- package/dist/cjs/entities/step/step.d.ts.map +1 -0
- package/dist/cjs/entities/workspace/workspace.d.ts +37 -0
- package/dist/cjs/entities/workspace/workspace.d.ts.map +1 -0
- package/dist/cjs/exports.d.ts +34 -0
- package/dist/cjs/exports.d.ts.map +1 -0
- package/dist/cjs/form/build-responses.d.ts +18 -0
- package/dist/cjs/form/build-responses.d.ts.map +1 -0
- package/dist/cjs/form/create-field-evaluator.d.ts +28 -0
- package/dist/cjs/form/create-field-evaluator.d.ts.map +1 -0
- package/dist/cjs/form/create-field-validation.d.ts +60 -0
- package/dist/cjs/form/create-field-validation.d.ts.map +1 -0
- package/dist/cjs/form/create-form.d.ts +155 -0
- package/dist/cjs/form/create-form.d.ts.map +1 -0
- package/dist/cjs/form/create-submit-pipeline.d.ts +116 -0
- package/dist/cjs/form/create-submit-pipeline.d.ts.map +1 -0
- package/dist/cjs/form/get-step-fields.d.ts +19 -0
- package/dist/cjs/form/get-step-fields.d.ts.map +1 -0
- package/dist/cjs/form/index.d.ts +11 -0
- package/dist/cjs/form/index.d.ts.map +1 -0
- package/dist/cjs/index.d.ts +27 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/lifecycle/condition-selection.d.ts +146 -0
- package/dist/cjs/lifecycle/condition-selection.d.ts.map +1 -0
- package/dist/cjs/lifecycle/lifecycle.d.ts +48 -0
- package/dist/cjs/lifecycle/lifecycle.d.ts.map +1 -0
- package/dist/cjs/lifecycle/rules-logic.d.ts +25 -0
- package/dist/cjs/lifecycle/rules-logic.d.ts.map +1 -0
- package/dist/cjs/lifecycle/state-snapshot.d.ts +38 -0
- package/dist/cjs/lifecycle/state-snapshot.d.ts.map +1 -0
- package/dist/cjs/logic-engine.d.ts +38 -0
- package/dist/cjs/logic-engine.d.ts.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/picked.d.ts +468 -0
- package/dist/cjs/picked.d.ts.map +1 -0
- package/dist/cjs/plugins/create-experience/create-experience.d.ts +221 -0
- package/dist/cjs/plugins/create-experience/create-experience.d.ts.map +1 -0
- package/dist/cjs/plugins/create-experience/index.d.ts +6 -0
- package/dist/cjs/plugins/create-experience/index.d.ts.map +1 -0
- package/dist/cjs/plugins/create-experience/plugin.d.ts +9 -0
- package/dist/cjs/plugins/create-experience/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/create-experience/serialization.d.ts +6 -0
- package/dist/cjs/plugins/create-experience/serialization.d.ts.map +1 -0
- package/dist/cjs/plugins/dom-observer/index.d.ts +3 -0
- package/dist/cjs/plugins/dom-observer/index.d.ts.map +1 -0
- package/dist/cjs/plugins/dom-observer/plugin.d.ts +50 -0
- package/dist/cjs/plugins/dom-observer/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/dynamic-experiences/hash.d.ts +105 -0
- package/dist/cjs/plugins/dynamic-experiences/hash.d.ts.map +1 -0
- package/dist/cjs/plugins/dynamic-experiences/index.d.ts +8 -0
- package/dist/cjs/plugins/dynamic-experiences/index.d.ts.map +1 -0
- package/dist/cjs/plugins/dynamic-experiences/index.js +1 -1
- package/dist/cjs/plugins/dynamic-experiences/plugin.d.ts +53 -0
- package/dist/cjs/plugins/dynamic-experiences/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/dynamic-experiences/types.d.ts +48 -0
- package/dist/cjs/plugins/dynamic-experiences/types.d.ts.map +1 -0
- package/dist/cjs/plugins/experience-browser-storage/index.d.ts +2 -0
- package/dist/cjs/plugins/experience-browser-storage/index.d.ts.map +1 -0
- package/dist/cjs/plugins/experience-browser-storage/plugin.d.ts +7 -0
- package/dist/cjs/plugins/experience-browser-storage/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/history-browser-storage/index.d.ts +2 -0
- package/dist/cjs/plugins/history-browser-storage/index.d.ts.map +1 -0
- package/dist/cjs/plugins/history-browser-storage/plugin.d.ts +7 -0
- package/dist/cjs/plugins/history-browser-storage/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/responses-browser-storage/index.d.ts +2 -0
- package/dist/cjs/plugins/responses-browser-storage/index.d.ts.map +1 -0
- package/dist/cjs/plugins/responses-browser-storage/plugin.d.ts +18 -0
- package/dist/cjs/plugins/responses-browser-storage/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/responses-indexeddb/index.d.ts +2 -0
- package/dist/cjs/plugins/responses-indexeddb/index.d.ts.map +1 -0
- package/dist/cjs/plugins/responses-indexeddb/plugin.d.ts +3 -0
- package/dist/cjs/plugins/responses-indexeddb/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/single-page-app/index.d.ts +3 -0
- package/dist/cjs/plugins/single-page-app/index.d.ts.map +1 -0
- package/dist/cjs/plugins/single-page-app/plugin.d.ts +32 -0
- package/dist/cjs/plugins/single-page-app/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/telemetry/emit.d.ts +18 -0
- package/dist/cjs/plugins/telemetry/emit.d.ts.map +1 -0
- package/dist/cjs/plugins/telemetry/index.d.ts +4 -0
- package/dist/cjs/plugins/telemetry/index.d.ts.map +1 -0
- package/dist/cjs/plugins/telemetry/plugin-summary.d.ts +10 -0
- package/dist/cjs/plugins/telemetry/plugin-summary.d.ts.map +1 -0
- package/dist/cjs/plugins/telemetry/plugin.d.ts +47 -0
- package/dist/cjs/plugins/telemetry/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/web-components/index.d.ts +2 -0
- package/dist/cjs/plugins/web-components/index.d.ts.map +1 -0
- package/dist/cjs/plugins/web-components/plugin.d.ts +4 -0
- package/dist/cjs/plugins/web-components/plugin.d.ts.map +1 -0
- package/dist/cjs/plugins/window-object/index.d.ts +2 -0
- package/dist/cjs/plugins/window-object/index.d.ts.map +1 -0
- package/dist/cjs/plugins/window-object/plugin.d.ts +9 -0
- package/dist/cjs/plugins/window-object/plugin.d.ts.map +1 -0
- package/dist/cjs/preview/index.d.ts +18 -0
- package/dist/cjs/preview/index.d.ts.map +1 -0
- package/dist/cjs/preview-bridge/index.d.ts +14 -0
- package/dist/cjs/preview-bridge/index.d.ts.map +1 -0
- package/dist/cjs/preview-channel.d.ts +16 -0
- package/dist/cjs/preview-channel.d.ts.map +1 -0
- package/dist/cjs/preview-receiver/apply-ops.d.ts +32 -0
- package/dist/cjs/preview-receiver/apply-ops.d.ts.map +1 -0
- package/dist/cjs/preview-receiver/index.d.ts +32 -0
- package/dist/cjs/preview-receiver/index.d.ts.map +1 -0
- package/dist/cjs/preview-receiver/protocol.d.ts +69 -0
- package/dist/cjs/preview-receiver/protocol.d.ts.map +1 -0
- package/dist/cjs/schema-registry.d.ts +240 -0
- package/dist/cjs/schema-registry.d.ts.map +1 -0
- package/dist/cjs/server/hydrate.d.ts +21 -0
- package/dist/cjs/server/hydrate.d.ts.map +1 -0
- package/dist/cjs/server/index.d.ts +28 -0
- package/dist/cjs/server/index.d.ts.map +1 -0
- package/dist/cjs/server/index.js +1 -1
- package/dist/cjs/server/serialize.d.ts +89 -0
- package/dist/cjs/server/serialize.d.ts.map +1 -0
- package/dist/cjs/storage.d.ts +6 -0
- package/dist/cjs/storage.d.ts.map +1 -0
- package/dist/cjs/typed-content.d.ts +30 -0
- package/dist/cjs/typed-content.d.ts.map +1 -0
- package/dist/cjs/utils/api-url.d.ts +2 -0
- package/dist/cjs/utils/api-url.d.ts.map +1 -0
- package/dist/cjs/utils/client-telemetry.d.ts +25 -0
- package/dist/cjs/utils/client-telemetry.d.ts.map +1 -0
- package/dist/cjs/utils/content-path.d.ts +37 -0
- package/dist/cjs/utils/content-path.d.ts.map +1 -0
- package/dist/cjs/utils/devtools-experience.d.ts +4 -0
- package/dist/cjs/utils/devtools-experience.d.ts.map +1 -0
- package/dist/cjs/utils/dom.d.ts +20 -0
- package/dist/cjs/utils/dom.d.ts.map +1 -0
- package/dist/cjs/utils/events.d.ts +129 -0
- package/dist/cjs/utils/events.d.ts.map +1 -0
- package/dist/cjs/utils/global-obj.d.ts +10 -0
- package/dist/cjs/utils/global-obj.d.ts.map +1 -0
- package/dist/cjs/utils/html-asset-value.d.ts +20 -0
- package/dist/cjs/utils/html-asset-value.d.ts.map +1 -0
- package/dist/cjs/utils/id.d.ts +11 -0
- package/dist/cjs/utils/id.d.ts.map +1 -0
- package/dist/cjs/utils/indexed-db.d.ts +12 -0
- package/dist/cjs/utils/indexed-db.d.ts.map +1 -0
- package/dist/cjs/utils/inert-script-report.d.ts +40 -0
- package/dist/cjs/utils/inert-script-report.d.ts.map +1 -0
- package/dist/cjs/utils/logger.d.ts +3 -0
- package/dist/cjs/utils/logger.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/get-next-node-from-action.d.ts +25 -0
- package/dist/cjs/utils/node-tree/get-next-node-from-action.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/get-next-node-from-condition.d.ts +17 -0
- package/dist/cjs/utils/node-tree/get-next-node-from-condition.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/get-next-node.d.ts +3 -0
- package/dist/cjs/utils/node-tree/get-next-node.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/get-origin-node.d.ts +3 -0
- package/dist/cjs/utils/node-tree/get-origin-node.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/min-max-steps-to-leaf.d.ts +21 -0
- package/dist/cjs/utils/node-tree/min-max-steps-to-leaf.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/min-max-steps-to-origin.d.ts +23 -0
- package/dist/cjs/utils/node-tree/min-max-steps-to-origin.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/next-reachable-step-nodes.d.ts +37 -0
- package/dist/cjs/utils/node-tree/next-reachable-step-nodes.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/node-adjacency.d.ts +50 -0
- package/dist/cjs/utils/node-tree/node-adjacency.d.ts.map +1 -0
- package/dist/cjs/utils/node-tree/node-tree-index.d.ts +57 -0
- package/dist/cjs/utils/node-tree/node-tree-index.d.ts.map +1 -0
- package/dist/cjs/utils/nodes.d.ts +7 -0
- package/dist/cjs/utils/nodes.d.ts.map +1 -0
- package/dist/cjs/utils/object.d.ts +49 -0
- package/dist/cjs/utils/object.d.ts.map +1 -0
- package/dist/cjs/utils/picked-config.d.ts +39 -0
- package/dist/cjs/utils/picked-config.d.ts.map +1 -0
- package/dist/cjs/utils/preview-session.d.ts +12 -0
- package/dist/cjs/utils/preview-session.d.ts.map +1 -0
- package/dist/cjs/utils/rehydrate-scripts.d.ts +50 -0
- package/dist/cjs/utils/rehydrate-scripts.d.ts.map +1 -0
- package/dist/cjs/utils/render-string.d.ts +24 -0
- package/dist/cjs/utils/render-string.d.ts.map +1 -0
- package/dist/cjs/utils/rules-logic.d.ts +36 -0
- package/dist/cjs/utils/rules-logic.d.ts.map +1 -0
- package/dist/cjs/utils/search-params.d.ts +26 -0
- package/dist/cjs/utils/search-params.d.ts.map +1 -0
- package/dist/cjs/utils/storage.d.ts +385 -0
- package/dist/cjs/utils/storage.d.ts.map +1 -0
- package/dist/cjs/utils/supports.d.ts +97 -0
- package/dist/cjs/utils/supports.d.ts.map +1 -0
- package/dist/cjs/utils/user-timing.d.ts +21 -0
- package/dist/cjs/utils/user-timing.d.ts.map +1 -0
- package/dist/cjs/utils/version.d.ts +2 -0
- package/dist/cjs/utils/version.d.ts.map +1 -0
- package/dist/esm/index.js +2 -2
- package/dist/esm/plugins/dynamic-experiences/index.js +2 -2
- package/dist/esm/server/index.js +2 -2
- package/dist/{plugin-UA4qhlvs.cjs → plugin-C-4rIh44.cjs} +1 -1
- package/dist/{plugin-C7lY7wA0.js → plugin-C9tjxmv9.js} +2 -2
- package/dist/{preview-unavailable-D5JVXP6H.js → preview-unavailable-7lhCKSQG.js} +1 -1
- package/dist/{preview-unavailable-DcA7cGAO.cjs → preview-unavailable-CG-i-Ish.cjs} +1 -1
- package/dist/{provider-ZrjYdXty.cjs → provider-BA1KvzJM.cjs} +1 -1
- package/dist/{provider-B3lHhG5v.js → provider-CAsL7WcN.js} +1 -1
- package/dist/types/client.d.ts +7 -7
- package/dist/types/data-source/provider.d.ts +3 -3
- package/dist/types/data-source/registry.d.ts +1 -1
- package/dist/types/data-source/virtual-data.d.ts +1 -1
- package/dist/types/entities/action/action.d.ts +3 -3
- package/dist/types/entities/component/component.d.ts +4 -4
- package/dist/types/entities/condition/condition.d.ts +1 -1
- package/dist/types/entities/content/reference.d.ts +1 -1
- package/dist/types/entities/experience/experience.d.ts +7 -7
- package/dist/types/entities/experience-instance/action-result.d.ts +1 -1
- package/dist/types/entities/experience-instance/experience-instance.d.ts +6 -6
- package/dist/types/entities/feature/feature.d.ts +2 -2
- package/dist/types/entities/field/field.d.ts +2 -2
- package/dist/types/entities/framework/framework.d.ts +3 -3
- package/dist/types/entities/history/history.d.ts +1 -1
- package/dist/types/entities/plugin/plugin.d.ts +1 -1
- package/dist/types/entities/predicate/predicate.d.ts +2 -2
- package/dist/types/entities/response/response-validation.d.ts +2 -2
- package/dist/types/entities/response/response.d.ts +5 -5
- package/dist/types/entities/step/step.d.ts +1 -1
- package/dist/types/exports.d.ts +20 -20
- package/dist/types/form/build-responses.d.ts +1 -1
- package/dist/types/form/create-field-evaluator.d.ts +2 -2
- package/dist/types/form/create-field-validation.d.ts +3 -3
- package/dist/types/form/create-form.d.ts +5 -5
- package/dist/types/form/create-submit-pipeline.d.ts +6 -6
- package/dist/types/form/get-step-fields.d.ts +3 -3
- package/dist/types/form/index.d.ts +9 -9
- package/dist/types/index.d.ts +25 -25
- package/dist/types/lifecycle/condition-selection.d.ts +3 -3
- package/dist/types/lifecycle/lifecycle.d.ts +2 -2
- package/dist/types/lifecycle/rules-logic.d.ts +2 -2
- package/dist/types/lifecycle/state-snapshot.d.ts +2 -2
- package/dist/types/picked.d.ts +74 -74
- package/dist/types/plugins/create-experience/create-experience.d.ts +8 -8
- package/dist/types/plugins/create-experience/index.d.ts +4 -4
- package/dist/types/plugins/create-experience/plugin.d.ts +2 -2
- package/dist/types/plugins/dom-observer/index.d.ts +1 -1
- package/dist/types/plugins/dom-observer/plugin.d.ts +1 -1
- package/dist/types/plugins/dynamic-experiences/index.d.ts +3 -3
- package/dist/types/plugins/dynamic-experiences/plugin.d.ts +3 -3
- package/dist/types/plugins/experience-browser-storage/index.d.ts +1 -1
- package/dist/types/plugins/experience-browser-storage/plugin.d.ts +1 -1
- package/dist/types/plugins/history-browser-storage/index.d.ts +1 -1
- package/dist/types/plugins/history-browser-storage/plugin.d.ts +1 -1
- package/dist/types/plugins/responses-browser-storage/index.d.ts +1 -1
- package/dist/types/plugins/responses-browser-storage/plugin.d.ts +1 -1
- package/dist/types/plugins/responses-indexeddb/index.d.ts +1 -1
- package/dist/types/plugins/responses-indexeddb/plugin.d.ts +1 -1
- package/dist/types/plugins/single-page-app/index.d.ts +2 -2
- package/dist/types/plugins/single-page-app/plugin.d.ts +1 -1
- package/dist/types/plugins/telemetry/index.d.ts +2 -2
- package/dist/types/plugins/telemetry/plugin.d.ts +1 -1
- package/dist/types/plugins/web-components/index.d.ts +1 -1
- package/dist/types/plugins/web-components/plugin.d.ts +1 -1
- package/dist/types/plugins/window-object/index.d.ts +1 -1
- package/dist/types/plugins/window-object/plugin.d.ts +2 -2
- package/dist/types/preview/index.d.ts +6 -6
- package/dist/types/preview-channel.d.ts +1 -1
- package/dist/types/preview-receiver/index.d.ts +1 -1
- package/dist/types/preview-receiver/protocol.d.ts +1 -1
- package/dist/types/schema-registry.d.ts +2 -2
- package/dist/types/server/hydrate.d.ts +2 -2
- package/dist/types/server/index.d.ts +9 -9
- package/dist/types/server/serialize.d.ts +1 -1
- package/dist/types/storage.d.ts +1 -1
- package/dist/types/typed-content.d.ts +2 -2
- package/dist/types/utils/client-telemetry.d.ts +1 -1
- package/dist/types/utils/dom.d.ts +1 -1
- package/dist/types/utils/events.d.ts +5 -5
- package/dist/types/utils/global-obj.d.ts +1 -1
- package/dist/types/utils/node-tree/get-next-node-from-action.d.ts +1 -1
- package/dist/types/utils/node-tree/get-next-node-from-condition.d.ts +1 -1
- package/dist/types/utils/node-tree/get-next-node.d.ts +1 -1
- package/dist/types/utils/node-tree/get-origin-node.d.ts +1 -1
- package/dist/types/utils/node-tree/min-max-steps-to-leaf.d.ts +2 -2
- package/dist/types/utils/node-tree/min-max-steps-to-origin.d.ts +2 -2
- package/dist/types/utils/node-tree/next-reachable-step-nodes.d.ts +2 -2
- package/dist/types/utils/node-tree/node-adjacency.d.ts +1 -1
- package/dist/types/utils/node-tree/node-tree-index.d.ts +2 -2
- package/dist/types/utils/nodes.d.ts +1 -1
- package/dist/types/utils/picked-config.d.ts +1 -1
- package/dist/types/utils/rules-logic.d.ts +2 -2
- package/dist/types/utils/storage.d.ts +1 -1
- package/package.json +141 -56
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
/** @file Experience entity — Effector stores, types, and lifecycle helpers for Picked experiences. */
|
|
2
|
+
import { type Effect, type EventCallable, type Store } from 'effector';
|
|
3
|
+
import type { AdaptedComponent } from '../component/component.js';
|
|
4
|
+
import type { Condition } from '../condition/condition.js';
|
|
5
|
+
import type { ExperienceStep } from '../step/step.js';
|
|
6
|
+
import type { Framework } from '../framework/framework.js';
|
|
7
|
+
import type { Picked } from '../../picked.js';
|
|
8
|
+
import type { LogicRule, LogicValue } from '../../logic-engine.js';
|
|
9
|
+
import type { NodeTreeIndex } from '../../utils/node-tree/node-tree-index.js';
|
|
10
|
+
export type ExperiencesListStore = ReturnType<typeof createExperienceIndex>;
|
|
11
|
+
/** Per-experience reactive entity returned by `createExperience`. */
|
|
12
|
+
export interface ExperienceStore {
|
|
13
|
+
id: string;
|
|
14
|
+
key: string;
|
|
15
|
+
name: string;
|
|
16
|
+
/** A `flow` is driven by its flow graph; a `page` is a single step the server renders. */
|
|
17
|
+
type: 'flow' | 'page';
|
|
18
|
+
configStore: Store<{
|
|
19
|
+
name: string;
|
|
20
|
+
decisionLogic?: LogicRule | LogicValue;
|
|
21
|
+
targetSelectors: ExperienceTarget[];
|
|
22
|
+
initializeOpenLogic?: LogicRule | LogicValue;
|
|
23
|
+
}>;
|
|
24
|
+
treeStore: Store<{
|
|
25
|
+
steps: ExperienceStep[];
|
|
26
|
+
nodes: ExperienceNode[];
|
|
27
|
+
edges: ExperienceEdge[];
|
|
28
|
+
conditions: Condition[];
|
|
29
|
+
}>;
|
|
30
|
+
/**
|
|
31
|
+
* The experience's flow graph, indexed for constant-time reads: node and edge
|
|
32
|
+
* lookups, plus a table of the min/max steps from every node to a leaf and back
|
|
33
|
+
* to an origin. Derived from the experience record, so it rebuilds when that
|
|
34
|
+
* record updates and a table read costs a map lookup.
|
|
35
|
+
*/
|
|
36
|
+
nodeTreeStore: Store<NodeTreeIndex>;
|
|
37
|
+
componentStore: Store<{
|
|
38
|
+
name: string;
|
|
39
|
+
component: AdaptedComponent;
|
|
40
|
+
frameworkStore: Store<Framework | undefined>;
|
|
41
|
+
} | undefined>;
|
|
42
|
+
actions: ExperienceAction[];
|
|
43
|
+
/** Effector event that merges a partial experience update into this store. */
|
|
44
|
+
merge: (payload: {
|
|
45
|
+
experience: Partial<Experience>;
|
|
46
|
+
strategy: 'override';
|
|
47
|
+
}) => void;
|
|
48
|
+
/**
|
|
49
|
+
* Per-experience initialise effect. Attaches over `configStore` and spawns one
|
|
50
|
+
* instance per matched DOM target.
|
|
51
|
+
*/
|
|
52
|
+
initialiseFx: Effect<LaunchExperienceOptions | undefined, void, Error>;
|
|
53
|
+
/**
|
|
54
|
+
* Per-experience gate evaluation effect. Attaches over `client.preconditionPassedStore`,
|
|
55
|
+
* the session's `isUser` slice, and `configStore`. Returns true when the experience
|
|
56
|
+
* should be initialised.
|
|
57
|
+
*/
|
|
58
|
+
shouldInitialiseFx: Effect<void, boolean, Error>;
|
|
59
|
+
/**
|
|
60
|
+
* Public event — requests initialisation, gated by `shouldInitialiseFx`. When the
|
|
61
|
+
* gate passes, the sample graph fires `prepareExperienceContentFx` and `initialiseFx`
|
|
62
|
+
* in parallel so content loading does not delay initialisation.
|
|
63
|
+
*/
|
|
64
|
+
initialiseRequested: EventCallable<LaunchExperienceOptions | undefined>;
|
|
65
|
+
/**
|
|
66
|
+
* Public event — requests initialisation directly, bypassing the `shouldInitialiseFx`
|
|
67
|
+
* gate. Fires `prepareExperienceContentFx` and `initialiseFx` in parallel.
|
|
68
|
+
*/
|
|
69
|
+
initialiseDirectly: EventCallable<LaunchExperienceOptions | undefined>;
|
|
70
|
+
/**
|
|
71
|
+
* Prepares per-experience CMS content by calling `client.contentLoader` and
|
|
72
|
+
* registering returned blobs into `client.contents`. Driven by the sample graph
|
|
73
|
+
* on `initialiseRequested`/`initialiseDirectly`; can also be called directly for
|
|
74
|
+
* speculative prefetch (e.g. Visibility-driven warm-up). Failure-tolerant:
|
|
75
|
+
* always resolves `true` even when the loader rejects, so initialisation is
|
|
76
|
+
* never blocked by content failures.
|
|
77
|
+
*/
|
|
78
|
+
prepareExperienceContentFx: Effect<void, boolean, Error>;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Creates an Effector store for a single experience.
|
|
82
|
+
*
|
|
83
|
+
* @template T - Factory parameter type.
|
|
84
|
+
* @param {T} params - The client instance and experience data.
|
|
85
|
+
* @param {Picked} params.client - The Picked client instance the experience is bound to.
|
|
86
|
+
* @param {Experience} params.experience - The experience definition to wrap in stores and effects.
|
|
87
|
+
* @returns {ReturnType<typeof createExperienceFactory>} An experience store with config, tree, fields, and component sub-stores.
|
|
88
|
+
* @example
|
|
89
|
+
* ```typescript
|
|
90
|
+
* const store = createExperience({ client, experience })
|
|
91
|
+
* ```
|
|
92
|
+
*/
|
|
93
|
+
export declare function createExperience(params: {
|
|
94
|
+
client: Picked;
|
|
95
|
+
experience: Experience;
|
|
96
|
+
}): ExperienceStore;
|
|
97
|
+
/** Options for launching an experience. */
|
|
98
|
+
export interface LaunchExperienceOptions {
|
|
99
|
+
/** When true, the experience will be opened immediately after initialization. */
|
|
100
|
+
initialiseOpen?: boolean;
|
|
101
|
+
/** When true, the experience's condition logic is skipped and it is launched unconditionally. */
|
|
102
|
+
bypassCondition?: boolean;
|
|
103
|
+
}
|
|
104
|
+
/** Options for opening an experience. Same as {@link LaunchExperienceOptions} without `initialiseOpen`. */
|
|
105
|
+
export type OpenExperienceOptions = Omit<LaunchExperienceOptions, 'initialiseOpen'>;
|
|
106
|
+
declare const createExperienceIndexFactory: ({ client }: {
|
|
107
|
+
client: Picked;
|
|
108
|
+
}) => {
|
|
109
|
+
/** Registers an experience in the index. If an experience with the same ID already exists, it is merged. */
|
|
110
|
+
register: EventCallable<Experience>;
|
|
111
|
+
/** Returns a derived store for an experience by its ID. The store value is `undefined` when no match exists. */
|
|
112
|
+
get: (id: Experience['id']) => Store<ExperienceStore | undefined>;
|
|
113
|
+
/** @deprecated Use `experiences.get(id)` instead. */
|
|
114
|
+
getById: (id: Experience['id']) => Store<ExperienceStore | undefined>;
|
|
115
|
+
/** Returns a derived store for an experience by its key. The store value is `undefined` when no match exists. */
|
|
116
|
+
getByKey: (key: Experience['key']) => Store<ExperienceStore | undefined>;
|
|
117
|
+
/** Effector effect that launches an experience by its key. */
|
|
118
|
+
launch: Effect<{
|
|
119
|
+
key: string;
|
|
120
|
+
options?: LaunchExperienceOptions;
|
|
121
|
+
} | {
|
|
122
|
+
id: string;
|
|
123
|
+
options?: LaunchExperienceOptions;
|
|
124
|
+
}, void, Error>;
|
|
125
|
+
/** Effector effect that opens an experience's existing instances, or launches it with `initialiseOpen` if none exist. */
|
|
126
|
+
open: Effect<{
|
|
127
|
+
key: string;
|
|
128
|
+
options?: OpenExperienceOptions;
|
|
129
|
+
} | {
|
|
130
|
+
id: string;
|
|
131
|
+
options?: OpenExperienceOptions;
|
|
132
|
+
}, void, Error>;
|
|
133
|
+
/** Derived store containing all registered experiences as an array. */
|
|
134
|
+
listStore: Store<ExperienceStore[]>;
|
|
135
|
+
/** Effector effect that conditionally initialises every registered experience. */
|
|
136
|
+
initialiseExperiencesFx: Effect<void, void, Error>;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* Creates an Effector-based index for registering and retrieving experiences.
|
|
140
|
+
*
|
|
141
|
+
* @template T - Factory parameter type.
|
|
142
|
+
* @param {T} params - The client instance.
|
|
143
|
+
* @returns {ReturnType<typeof createExperienceIndexFactory>} An experience index with register, getById, getByKey, launch, and open methods.
|
|
144
|
+
* @example
|
|
145
|
+
* ```typescript
|
|
146
|
+
* const index = createExperienceIndex({ client })
|
|
147
|
+
* ```
|
|
148
|
+
*/
|
|
149
|
+
export declare function createExperienceIndex<T extends Parameters<typeof createExperienceIndexFactory>[0]>(params: T): ReturnType<typeof createExperienceIndexFactory>;
|
|
150
|
+
export type ExperienceNode = StepNode | ConditionNode | LaunchExperienceNode | OriginNode | ActionNode;
|
|
151
|
+
export interface ExperienceAction {
|
|
152
|
+
id: string;
|
|
153
|
+
action: string;
|
|
154
|
+
}
|
|
155
|
+
export interface ActionNode extends BaseNode {
|
|
156
|
+
type: 'action';
|
|
157
|
+
actionId?: string;
|
|
158
|
+
actionKey?: string;
|
|
159
|
+
name?: string;
|
|
160
|
+
/** Key of the field the action's resolved value is stored in. */
|
|
161
|
+
successFieldKey?: string;
|
|
162
|
+
/** Key of the field the action's failure, `{ code, message }`, is stored in. */
|
|
163
|
+
failureFieldKey?: string;
|
|
164
|
+
}
|
|
165
|
+
export interface BaseNode {
|
|
166
|
+
id: string;
|
|
167
|
+
type: string;
|
|
168
|
+
}
|
|
169
|
+
export interface StepNode extends BaseNode {
|
|
170
|
+
type: 'step';
|
|
171
|
+
stepId: string;
|
|
172
|
+
stepKey?: string;
|
|
173
|
+
name?: string;
|
|
174
|
+
}
|
|
175
|
+
export interface ConditionNode extends BaseNode {
|
|
176
|
+
type: 'condition';
|
|
177
|
+
conditionId: string;
|
|
178
|
+
conditionKey?: string;
|
|
179
|
+
}
|
|
180
|
+
export interface LaunchExperienceNode extends BaseNode {
|
|
181
|
+
type: 'experience';
|
|
182
|
+
experienceId: string;
|
|
183
|
+
experienceKey: string;
|
|
184
|
+
}
|
|
185
|
+
export interface OriginNode extends BaseNode {
|
|
186
|
+
type: 'origin';
|
|
187
|
+
}
|
|
188
|
+
export interface ExperienceEdge {
|
|
189
|
+
id: string;
|
|
190
|
+
sourceNodeId: string;
|
|
191
|
+
destinationNodeId: string;
|
|
192
|
+
sourceHandle?: string;
|
|
193
|
+
}
|
|
194
|
+
export interface ExperienceTarget {
|
|
195
|
+
selector: string;
|
|
196
|
+
placement: 'replace' | 'append' | 'prepend' | 'before' | 'after';
|
|
197
|
+
}
|
|
198
|
+
export interface Experience {
|
|
199
|
+
id: string;
|
|
200
|
+
key: string;
|
|
201
|
+
name: string;
|
|
202
|
+
/** A `flow` is driven by its flow graph; a `page` is a single step the server renders. Absent reads as `flow`. */
|
|
203
|
+
type?: 'flow' | 'page';
|
|
204
|
+
componentName?: string;
|
|
205
|
+
component?: AdaptedComponent;
|
|
206
|
+
initializeOpen?: LogicRule | LogicValue;
|
|
207
|
+
actions?: ExperienceAction[];
|
|
208
|
+
/** Decision logic that controls whether this experience is initialised. */
|
|
209
|
+
condition?: LogicRule | LogicValue;
|
|
210
|
+
edges: ExperienceEdge[];
|
|
211
|
+
nodes: ExperienceNode[];
|
|
212
|
+
targets: ExperienceTarget[];
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* Conditionally initialises every registered experience by dispatching the index-level
|
|
216
|
+
* `initialiseExperiencesFx` effect, which attaches over `client.experiences.listStore`
|
|
217
|
+
* and runs each experience's per-store `shouldInitialiseFx` and `initialiseFx`.
|
|
218
|
+
*
|
|
219
|
+
* @param {Picked} client - The Picked client instance.
|
|
220
|
+
* @returns {Promise<void>} Resolves when all per-experience initialisations settle.
|
|
221
|
+
* @example
|
|
222
|
+
* ```typescript
|
|
223
|
+
* await initialiseExperiences(client)
|
|
224
|
+
* ```
|
|
225
|
+
*/
|
|
226
|
+
export declare const initialiseExperiences: (client: Picked) => Promise<void>;
|
|
227
|
+
export {};
|
|
228
|
+
//# sourceMappingURL=experience.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"experience.d.ts","sourceRoot":"","sources":["../../../../src/entities/experience/experience.ts"],"names":[],"mappings":"AAAA,sGAAsG;AACtG,OAAO,EAOL,KAAK,MAAM,EACX,KAAK,aAAa,EAElB,KAAK,KAAK,EACX,MAAM,UAAU,CAAA;AAEjB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAG1C,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAG/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAA;AAG1E,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAE3E,qEAAqE;AACrE,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,0FAA0F;IAC1F,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACrB,WAAW,EAAE,KAAK,CAAC;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,aAAa,CAAC,EAAE,SAAS,GAAG,UAAU,CAAA;QACtC,eAAe,EAAE,gBAAgB,EAAE,CAAA;QACnC,mBAAmB,CAAC,EAAE,SAAS,GAAG,UAAU,CAAA;KAC7C,CAAC,CAAA;IACF,SAAS,EAAE,KAAK,CAAC;QACf,KAAK,EAAE,cAAc,EAAE,CAAA;QACvB,KAAK,EAAE,cAAc,EAAE,CAAA;QACvB,KAAK,EAAE,cAAc,EAAE,CAAA;QACvB,UAAU,EAAE,SAAS,EAAE,CAAA;KACxB,CAAC,CAAA;IACF;;;;;OAKG;IACH,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAA;IACnC,cAAc,EAAE,KAAK,CACjB;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,SAAS,EAAE,gBAAgB,CAAA;QAC3B,cAAc,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC,CAAA;KAC7C,GACD,SAAS,CACZ,CAAA;IACD,OAAO,EAAE,gBAAgB,EAAE,CAAA;IAC3B,8EAA8E;IAC9E,KAAK,EAAE,CAAC,OAAO,EAAE;QAAE,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;QAAC,QAAQ,EAAE,UAAU,CAAA;KAAE,KAAK,IAAI,CAAA;IACnF;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC,uBAAuB,GAAG,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,CAAA;IACtE;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;IAChD;;;;OAIG;IACH,mBAAmB,EAAE,aAAa,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAA;IACvE;;;OAGG;IACH,kBAAkB,EAAE,aAAa,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAA;IACtE;;;;;;;OAOG;IACH,0BAA0B,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA;CACzD;AA2ND;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;CACvB,GAAG,eAAe,CAElB;AAED,2CAA2C;AAC3C,MAAM,WAAW,uBAAuB;IACtC,iFAAiF;IACjF,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,iGAAiG;IACjG,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,2GAA2G;AAC3G,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAA;AAEnF,QAAA,MAAM,4BAA4B,eAA8B;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;IAsK9E,4GAA4G;;IAE5G,gHAAgH;cA1GjG,UAAU,CAAC,IAAI,CAAC;IA4G/B,qDAAqD;;IAErD,iHAAiH;oBAhG5F,UAAU,CAAC,KAAK,CAAC,KAAG,KAAK,CAAC,eAAe,GAAG,SAAS,CAAC;IAkG3E,8DAA8D;;aArFjD,MAAM;kBAAY,uBAAuB;;YAC1C,MAAM;kBAAY,uBAAuB;;IAsFrD,yHAAyH;;aAtD5G,MAAM;kBAAY,qBAAqB;;YACxC,MAAM;kBAAY,qBAAqB;;IAuDnD,uEAAuE;;IAEvE,kFAAkF;;CAGpF,CAAA;AAEF;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,UAAU,CAAC,OAAO,4BAA4B,CAAC,CAAC,CAAC,CAAC,EAChG,MAAM,EAAE,CAAC,GACR,UAAU,CAAC,OAAO,4BAA4B,CAAC,CAEjD;AAED,MAAM,MAAM,cAAc,GACxB,QAAQ,GAAG,aAAa,GAAG,oBAAoB,GAAG,UAAU,GAAG,UAAU,CAAA;AAC3E,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;CAEf;AAED,MAAM,WAAW,UAAW,SAAQ,QAAQ;IAC1C,IAAI,EAAE,QAAQ,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,iEAAiE;IACjE,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,gFAAgF;IAChF,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,IAAI,EAAE,WAAW,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,oBAAqB,SAAQ,QAAQ;IACpD,IAAI,EAAE,YAAY,CAAA;IAClB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,UAAW,SAAQ,QAAQ;IAC1C,IAAI,EAAE,QAAQ,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,CAAA;IACpB,iBAAiB,EAAE,MAAM,CAAA;IACzB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAA;CACjE;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,kHAAkH;IAClH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,gBAAgB,CAAA;IAC5B,cAAc,CAAC,EAAE,SAAS,GAAG,UAAU,CAAA;IACvC,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC5B,2EAA2E;IAC3E,SAAS,CAAC,EAAE,SAAS,GAAG,UAAU,CAAA;IAClC,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB,KAAK,EAAE,cAAc,EAAE,CAAA;IACvB,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAC5B;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,WAAkB,MAAM,KAAG,OAAO,CAAC,IAAI,CAExE,CAAA"}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/** @file Converts how an action settled into the responses of its success and failure field. */
|
|
2
|
+
import type { FieldBase, FieldValue } from '../field/field.js';
|
|
3
|
+
/** How an action node's action settled. */
|
|
4
|
+
export type ActionResult = {
|
|
5
|
+
succeeded: true;
|
|
6
|
+
value: unknown;
|
|
7
|
+
} | {
|
|
8
|
+
succeeded: false;
|
|
9
|
+
error: unknown;
|
|
10
|
+
};
|
|
11
|
+
/** The `{ code, message }` stored in the failure field of an action that failed. */
|
|
12
|
+
interface ActionFailure {
|
|
13
|
+
code: string;
|
|
14
|
+
message: string;
|
|
15
|
+
}
|
|
16
|
+
/** The type and multiplicity of a field, which decide what it can hold. */
|
|
17
|
+
interface FieldShape {
|
|
18
|
+
type: FieldBase['type'];
|
|
19
|
+
multiple: boolean;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Describes a thrown value as `{ code, message }`: `code` is its string `code`, else its
|
|
23
|
+
* `name`, else `"ERROR"`.
|
|
24
|
+
*
|
|
25
|
+
* @param {unknown} error - The value the action threw or rejected with.
|
|
26
|
+
* @returns {ActionFailure} The failure payload.
|
|
27
|
+
* @example
|
|
28
|
+
* toFailurePayload(new TypeError('boom')) // { code: 'TypeError', message: 'boom' }
|
|
29
|
+
*/
|
|
30
|
+
export declare function toFailurePayload(error: unknown): ActionFailure;
|
|
31
|
+
/**
|
|
32
|
+
* Converts a value to the shape a field holds: an object field keeps it as JSON, a text field
|
|
33
|
+
* keeps a string and JSON-encodes anything else, a number field keeps a finite number, a
|
|
34
|
+
* boolean field takes its truthiness, and a multiple field wraps a single value and converts
|
|
35
|
+
* each item. A nullish value converts to `null`.
|
|
36
|
+
*
|
|
37
|
+
* @param {FieldShape} field - The type and multiplicity of the field.
|
|
38
|
+
* @param {unknown} value - The value to convert.
|
|
39
|
+
* @returns {FieldValue | undefined} The converted value, or `undefined` when the field cannot hold it.
|
|
40
|
+
* @example
|
|
41
|
+
* coerceToField({ type: 'text', multiple: true }, 'a') // ['a']
|
|
42
|
+
*/
|
|
43
|
+
export declare function coerceToField(field: FieldShape, value: unknown): FieldValue | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* Builds the responses of an action's success field and failure field. The resolved value is written under the
|
|
46
|
+
* success field key, or `{ code, message }` under the failure field key, converted to that
|
|
47
|
+
* field's type, and `null` is written under the other key when that field exists. A value
|
|
48
|
+
* its field cannot hold is logged and written as `null`. A key that names no registered field
|
|
49
|
+
* is logged and has no entry.
|
|
50
|
+
*
|
|
51
|
+
* @param {object} node - The action node that ran.
|
|
52
|
+
* @param {string} node.id - The node's ID.
|
|
53
|
+
* @param {string} [node.successFieldKey] - The key of the field the resolved value is stored in.
|
|
54
|
+
* @param {string} [node.failureFieldKey] - The key of the field the failure is stored in.
|
|
55
|
+
* @param {ReadonlyArray<FieldShape & { key: string }>} fields - The registered fields.
|
|
56
|
+
* @param {ActionResult} result - How the node's action settled.
|
|
57
|
+
* @returns {Record<string, FieldValue>} The responses keyed by field key.
|
|
58
|
+
* @example
|
|
59
|
+
* successAndFailureFieldResponses(node, fields, { succeeded: true, value: { orderId: 'A1' } })
|
|
60
|
+
*/
|
|
61
|
+
export declare function successAndFailureFieldResponses(node: {
|
|
62
|
+
id: string;
|
|
63
|
+
successFieldKey?: string;
|
|
64
|
+
failureFieldKey?: string;
|
|
65
|
+
}, fields: ReadonlyArray<FieldShape & {
|
|
66
|
+
key: string;
|
|
67
|
+
}>, result: ActionResult): Record<string, FieldValue>;
|
|
68
|
+
export {};
|
|
69
|
+
//# sourceMappingURL=action-result.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"action-result.d.ts","sourceRoot":"","sources":["../../../../src/entities/experience-instance/action-result.ts"],"names":[],"mappings":"AAAA,gGAAgG;AAChG,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAa,MAAM,gBAAgB,CAAA;AAGtE,2CAA2C;AAC3C,MAAM,MAAM,YAAY,GACtB;IAAE,SAAS,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,SAAS,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAA;AAE5E,oFAAoF;AACpF,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,2EAA2E;AAC3E,UAAU,UAAU;IAClB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,CAAA;IACvB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAgBD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,aAAa,CAK9D;AA+DD;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU,GAAG,SAAS,CAavF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,+BAA+B,CAC7C,IAAI,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,eAAe,CAAC,EAAE,MAAM,CAAA;CAAE,EACxE,MAAM,EAAE,aAAa,CAAC,UAAU,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,EACnD,MAAM,EAAE,YAAY,GACnB,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CA8B5B"}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
/** @file Experience instance — Effector stores and lifecycle for a single experience. */
|
|
2
|
+
import { type Effect, type EventCallable, type Store } from 'effector';
|
|
3
|
+
import type { Experience, ExperienceNode, ExperienceStore, ExperienceTarget, LaunchExperienceOptions } from '../experience/experience.js';
|
|
4
|
+
import type { Component } from '../component/component.js';
|
|
5
|
+
import type { Framework } from '../framework/framework.js';
|
|
6
|
+
import type { ExperienceStep } from '../step/step.js';
|
|
7
|
+
import type { Picked } from '../../picked.js';
|
|
8
|
+
import type { HistoryEntry } from '../history/history.js';
|
|
9
|
+
export interface ExperienceInstance {
|
|
10
|
+
id: string;
|
|
11
|
+
experienceKey: Experience['key'];
|
|
12
|
+
experienceId: Experience['id'];
|
|
13
|
+
/** Static name snapshot captured at spawn time. Use `configStore` for the latest (reactive) value. */
|
|
14
|
+
experienceName: string;
|
|
15
|
+
configStore: ExperienceStore['configStore'];
|
|
16
|
+
target: HTMLElement | undefined;
|
|
17
|
+
componentStore: ExperienceStore['componentStore'];
|
|
18
|
+
/**
|
|
19
|
+
* Reactive store of the resolved `{ component, framework }` pair for this instance, derived via `combine` over the instance's `componentStore` and `client.frameworks.listStore`. Resolves to `null` when either side is missing.
|
|
20
|
+
*/
|
|
21
|
+
componentAndFrameworkStore: Store<{
|
|
22
|
+
component: Component;
|
|
23
|
+
framework: Framework;
|
|
24
|
+
} | null>;
|
|
25
|
+
stateStore: Store<'transitioning' | 'ready'>;
|
|
26
|
+
isOpenStore: Store<boolean>;
|
|
27
|
+
open: EventCallable<void>;
|
|
28
|
+
close: EventCallable<void>;
|
|
29
|
+
toggleOpen: EventCallable<void>;
|
|
30
|
+
setOpen: EventCallable<boolean>;
|
|
31
|
+
treeStore: ExperienceStore['treeStore'];
|
|
32
|
+
currentNodeStore: Store<ExperienceNode | null>;
|
|
33
|
+
/**
|
|
34
|
+
* The step currently on screen. Only step nodes update it, so it deliberately
|
|
35
|
+
* retains the last resolved step — rather than blanking to `null` — while the
|
|
36
|
+
* engine transits ANY non-step node (an action running or a condition
|
|
37
|
+
* evaluating). Both `StepRouter` bindings keep rendering this step during those
|
|
38
|
+
* transits instead of flashing empty; it is `null` only before the first step
|
|
39
|
+
* resolves. This "hold last step" contract intentionally applies to every
|
|
40
|
+
* non-step transit, not just async actions.
|
|
41
|
+
*/
|
|
42
|
+
currentStepStore: Store<ExperienceStep | null>;
|
|
43
|
+
previousStepStore: Store<ExperienceStep | null>;
|
|
44
|
+
nextReachableStepNodesStore: Store<ExperienceNode[]>;
|
|
45
|
+
stepsToOriginStore: Store<number[]>;
|
|
46
|
+
stepsToLeafStore: Store<number[]>;
|
|
47
|
+
goToNextStep: EventCallable<void>;
|
|
48
|
+
goToPreviousStep: EventCallable<void>;
|
|
49
|
+
goToStepById: EventCallable<string>;
|
|
50
|
+
goToStepByKey: EventCallable<string>;
|
|
51
|
+
stepsHistoryStore: Store<HistoryEntry[]>;
|
|
52
|
+
/**
|
|
53
|
+
* Per-instance mount effect. Attached over `componentAndFrameworkStore` so the render call always receives the current resolved component+framework pair.
|
|
54
|
+
*/
|
|
55
|
+
mountFx: Effect<void, void, Error>;
|
|
56
|
+
}
|
|
57
|
+
export type ExperienceInstanceIndex = ReturnType<typeof createExperienceInstanceIndex>;
|
|
58
|
+
export interface ExperienceInstanceTarget {
|
|
59
|
+
selector: HTMLElement[];
|
|
60
|
+
placement: ExperienceTarget['placement'];
|
|
61
|
+
}
|
|
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, }: {
|
|
68
|
+
client: Picked;
|
|
69
|
+
experience: ExperienceStore;
|
|
70
|
+
target?: HTMLElement;
|
|
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;
|
|
79
|
+
}) => ExperienceInstance;
|
|
80
|
+
/**
|
|
81
|
+
* Creates an experience instance with lifecycle stores and navigation logic.
|
|
82
|
+
*
|
|
83
|
+
* @param {Parameters<typeof createExperienceInstanceFactory>[0]} params - Factory parameters including the client and experience store.
|
|
84
|
+
* @returns {ExperienceInstance} The created experience instance.
|
|
85
|
+
* @example
|
|
86
|
+
* ```typescript
|
|
87
|
+
* const instance = createExperienceInstance({ client, experience })
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
export declare function createExperienceInstance<T extends Parameters<typeof createExperienceInstanceFactory>[0]>(params: T): ReturnType<typeof createExperienceInstanceFactory>;
|
|
91
|
+
declare const createExperienceInstanceIndexFactory: ({ client }: {
|
|
92
|
+
client: Picked;
|
|
93
|
+
}) => {
|
|
94
|
+
spawn: (experience: ExperienceStore, target: HTMLElement, options?: LaunchExperienceOptions) => void;
|
|
95
|
+
adopt: (instance: ExperienceInstance) => () => void;
|
|
96
|
+
getByExperienceKey: (key: Experience['key']) => Store<ExperienceInstance[]>;
|
|
97
|
+
getByExperienceId: (id: Experience['id']) => Store<ExperienceInstance[]>;
|
|
98
|
+
listStore: Store<ExperienceInstance[]>;
|
|
99
|
+
};
|
|
100
|
+
/**
|
|
101
|
+
* Creates an index that tracks all experience instances keyed by experience ID.
|
|
102
|
+
*
|
|
103
|
+
* @param {Parameters<typeof createExperienceInstanceIndexFactory>[0]} params - Factory parameters including the client.
|
|
104
|
+
* @returns {ExperienceInstanceIndex} The created experience-instance index.
|
|
105
|
+
* @example
|
|
106
|
+
* ```typescript
|
|
107
|
+
* const index = createExperienceInstanceIndex({ client })
|
|
108
|
+
* ```
|
|
109
|
+
*/
|
|
110
|
+
export declare function createExperienceInstanceIndex<T extends Parameters<typeof createExperienceInstanceIndexFactory>[0]>(params: T): ReturnType<typeof createExperienceInstanceIndexFactory>;
|
|
111
|
+
export {};
|
|
112
|
+
//# sourceMappingURL=experience-instance.d.ts.map
|
|
@@ -0,0 +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;AAMtD,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,uBAqnBF,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"}
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
/** @file Feature entity — Effector stores and registry for A/B test features with persistent bucketing. */
|
|
2
|
+
import { type EventCallable, type Store } from 'effector';
|
|
3
|
+
import type { Picked } from '../../picked.js';
|
|
4
|
+
import type { FeatureValueFor } from '../../schema-registry.js';
|
|
5
|
+
/** One arm of a feature, as published in the project config. */
|
|
6
|
+
export interface FeatureVariant {
|
|
7
|
+
/** Stable identity. `true` and `false` name the structural arms. */
|
|
8
|
+
key: string;
|
|
9
|
+
/** What the site receives when a visitor lands in this arm. */
|
|
10
|
+
value: boolean | string;
|
|
11
|
+
/** Share of traffic relative to the other arms, reduced by their greatest common divisor. */
|
|
12
|
+
weight: number;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* What a feature's arms serve, as published in the project config. A feature registered
|
|
16
|
+
* from SDK code carries neither field, so an absent pair means the shape is unknown.
|
|
17
|
+
*/
|
|
18
|
+
export interface FeatureShape {
|
|
19
|
+
/** What the feature's arms serve. */
|
|
20
|
+
valueType?: 'boolean' | 'text';
|
|
21
|
+
/** The arms a text feature serves. A boolean feature splits on `weight`. */
|
|
22
|
+
variants?: readonly FeatureVariant[];
|
|
23
|
+
}
|
|
24
|
+
export interface Feature extends FeatureShape {
|
|
25
|
+
key: string;
|
|
26
|
+
name: string;
|
|
27
|
+
decide: () => boolean | Promise<boolean> | string | Promise<string>;
|
|
28
|
+
storage?: 'local' | 'session';
|
|
29
|
+
/** Admin on/off flag from the Picked project config. Undefined for manually-registered features. */
|
|
30
|
+
enabled?: boolean;
|
|
31
|
+
/** Traffic-allocation percentage (0-100) from the Picked project config. Undefined for manually-registered features. */
|
|
32
|
+
weight?: number;
|
|
33
|
+
}
|
|
34
|
+
export type FeaturesStore = ReturnType<typeof createFeatureIndexFactory>;
|
|
35
|
+
export interface FeatureIndexItem {
|
|
36
|
+
id: string;
|
|
37
|
+
feature: Feature & {
|
|
38
|
+
id: string;
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
export interface ResolvedFeature {
|
|
42
|
+
id: string;
|
|
43
|
+
bucket: boolean | string;
|
|
44
|
+
key: string;
|
|
45
|
+
storage?: 'local' | 'session';
|
|
46
|
+
}
|
|
47
|
+
export interface FeatureBaseBucket extends FeatureShape {
|
|
48
|
+
name: string;
|
|
49
|
+
key: string;
|
|
50
|
+
id: string;
|
|
51
|
+
/** Admin on/off flag from the Picked project config. Undefined for manually-registered features. */
|
|
52
|
+
enabled?: boolean;
|
|
53
|
+
/** Traffic-allocation percentage (0-100) from the Picked project config. Undefined for manually-registered features. */
|
|
54
|
+
weight?: number;
|
|
55
|
+
}
|
|
56
|
+
export interface UnresolvedFeatureBucket extends FeatureBaseBucket {
|
|
57
|
+
isResolved: false;
|
|
58
|
+
getBucket: () => Promise<{
|
|
59
|
+
id: string;
|
|
60
|
+
bucket: string | boolean;
|
|
61
|
+
}>;
|
|
62
|
+
}
|
|
63
|
+
export interface ResolvedFeatureBucket extends FeatureBaseBucket {
|
|
64
|
+
isResolved: true;
|
|
65
|
+
getBucket: () => {
|
|
66
|
+
id: string;
|
|
67
|
+
bucket: string | boolean;
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
export type FeatureBucket = UnresolvedFeatureBucket | ResolvedFeatureBucket;
|
|
71
|
+
/**
|
|
72
|
+
* A feature's resolved bucket. `TValue` narrows to a text feature's declared arms when
|
|
73
|
+
* the schema registry is augmented, and stays `string | boolean` otherwise.
|
|
74
|
+
*
|
|
75
|
+
* @param {string | boolean} TValue - The value the feature resolves to.
|
|
76
|
+
*/
|
|
77
|
+
export interface FeatureResult<TValue extends string | boolean = string | boolean> {
|
|
78
|
+
id: string;
|
|
79
|
+
bucket: TValue;
|
|
80
|
+
}
|
|
81
|
+
/** The bucket an evokable feature answers with, or undefined while its feature is unregistered. */
|
|
82
|
+
export type FeatureBucketValue = boolean | string | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* Reads a bucket back out of its stored text.
|
|
85
|
+
*
|
|
86
|
+
* Storage holds a bucket as raw text, so this is the inverse of the write: `'true'` and
|
|
87
|
+
* `'false'` are the two booleans and every other value is a named variant. A variant named
|
|
88
|
+
* literally `true` or `false` therefore comes back as a boolean.
|
|
89
|
+
*
|
|
90
|
+
* @param {string} value - Stored text, or the value side of a `?picked-feature=` override.
|
|
91
|
+
* @returns {boolean | string} The boolean bucket, or the variant name unchanged.
|
|
92
|
+
* @example
|
|
93
|
+
* ```typescript
|
|
94
|
+
* parseBucket('true') // true
|
|
95
|
+
* parseBucket('variant-a') // 'variant-a'
|
|
96
|
+
* ```
|
|
97
|
+
*/
|
|
98
|
+
export declare function parseBucket(value: string): boolean | string;
|
|
99
|
+
/** A `?picked-feature=` override, split into the feature it names and the bucket it forces. */
|
|
100
|
+
export interface FeatureOverride {
|
|
101
|
+
id: string;
|
|
102
|
+
bucket: boolean | string;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Reads one `?picked-feature=<id>:<value>` parameter.
|
|
106
|
+
*
|
|
107
|
+
* Splits on the first colon: the text before it names the feature, and all the text
|
|
108
|
+
* after it is the bucket, colons included. `opening-hours:09:00-17:00` forces
|
|
109
|
+
* `09:00-17:00`. Feature and variant keys are lowercase letters, numbers and hyphens,
|
|
110
|
+
* which is what makes the first colon the boundary.
|
|
111
|
+
*
|
|
112
|
+
* @param {string} param - One `picked-feature` parameter value, without its key.
|
|
113
|
+
* @returns {FeatureOverride | null} The override, or null when the parameter names no feature or forces no value.
|
|
114
|
+
* @example
|
|
115
|
+
* ```typescript
|
|
116
|
+
* parseFeatureOverride('hero-layout:video-hero') // { id: 'hero-layout', bucket: 'video-hero' }
|
|
117
|
+
* parseFeatureOverride('opening-hours:09:00-17:00') // { id: 'opening-hours', bucket: '09:00-17:00' }
|
|
118
|
+
* ```
|
|
119
|
+
*/
|
|
120
|
+
export declare function parseFeatureOverride(param: string): FeatureOverride | null;
|
|
121
|
+
declare const createFeatureIndexFactory: ({ client }: {
|
|
122
|
+
client: Picked;
|
|
123
|
+
}) => {
|
|
124
|
+
register: EventCallable<{
|
|
125
|
+
id: string;
|
|
126
|
+
feature: Feature;
|
|
127
|
+
}>;
|
|
128
|
+
getById: (id: string) => Store<FeatureBucket | undefined>;
|
|
129
|
+
getByName: (name: string) => Store<FeatureIndexItem | undefined>;
|
|
130
|
+
listStore: Store<FeatureBucket[]>;
|
|
131
|
+
getEvokableFeature: (featureName: string) => Store<() => Promise<FeatureBucketValue>>;
|
|
132
|
+
getFeatureResult: <K extends string>(featureName: K) => Store<FeatureResult<FeatureValueFor<K>> | undefined>;
|
|
133
|
+
};
|
|
134
|
+
/**
|
|
135
|
+
* Creates a feature index with lifecycle stores and registration logic.
|
|
136
|
+
*
|
|
137
|
+
* @template T - Factory parameter type.
|
|
138
|
+
* @param {T} params - Factory parameters including the client.
|
|
139
|
+
* @returns {ReturnType<typeof createFeatureIndexFactory>} The feature index with register, getById, getByName, listStore, getEvokableFeature, and getFeatureResult methods.
|
|
140
|
+
* @example
|
|
141
|
+
* ```ts
|
|
142
|
+
* const features = createFeatureIndex({ client })
|
|
143
|
+
* features.register('test-feature-1', { key: 'test', name: 'Test Feature', decide: () => true })
|
|
144
|
+
* ```
|
|
145
|
+
*/
|
|
146
|
+
export declare function createFeatureIndex<T extends Parameters<typeof createFeatureIndexFactory>[0]>(params: T): ReturnType<typeof createFeatureIndexFactory>;
|
|
147
|
+
/**
|
|
148
|
+
* Convenience helper that dispatches `features.register` with object-payload shape.
|
|
149
|
+
*
|
|
150
|
+
* @param {string} name - Feature id.
|
|
151
|
+
* @param {Feature} feature - The feature config.
|
|
152
|
+
* @param {FeaturesStore} features - The features index.
|
|
153
|
+
* @example
|
|
154
|
+
* setupFeature('winter-sale', { key: 'v1', name: 'Winter sale', decide: () => true }, featuresIndex)
|
|
155
|
+
*/
|
|
156
|
+
export declare const setupFeature: (name: string, feature: Feature, features: FeaturesStore) => void;
|
|
157
|
+
export {};
|
|
158
|
+
//# sourceMappingURL=feature.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feature.d.ts","sourceRoot":"","sources":["../../../../src/entities/feature/feature.ts"],"names":[],"mappings":"AAAA,2GAA2G;AAC3G,OAAO,EAQL,KAAK,aAAa,EAElB,KAAK,KAAK,EACX,MAAM,UAAU,CAAA;AAEjB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAI5D,gEAAgE;AAChE,MAAM,WAAW,cAAc;IAC7B,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAA;IACX,+DAA+D;IAC/D,KAAK,EAAE,OAAO,GAAG,MAAM,CAAA;IACvB,6FAA6F;IAC7F,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,qCAAqC;IACrC,SAAS,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;IAC9B,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,SAAS,cAAc,EAAE,CAAA;CACrC;AAED,MAAM,WAAW,OAAQ,SAAQ,YAAY;IAC3C,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IACnE,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B,oGAAoG;IACpG,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,wHAAwH;IACxH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAExE,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,OAAO,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;CAClC;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,GAAG,MAAM,CAAA;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC9B;AAED,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,EAAE,EAAE,MAAM,CAAA;IACV,oGAAoG;IACpG,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,wHAAwH;IACxH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,uBAAwB,SAAQ,iBAAiB;IAChE,UAAU,EAAE,KAAK,CAAA;IACjB,SAAS,EAAE,MAAM,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC,CAAA;CACnE;AAED,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,UAAU,EAAE,IAAI,CAAA;IAChB,SAAS,EAAE,MAAM;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAA;CAC1D;AAED,MAAM,MAAM,aAAa,GAAG,uBAAuB,GAAG,qBAAqB,CAAA;AAE3E;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO;IAC/E,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;CACf;AAED,mGAAmG;AACnG,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;AAqB7D;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAU3D;AAED,+FAA+F;AAC/F,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,OAAO,GAAG,MAAM,CAAA;CACzB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI,CAa1E;AAED,QAAA,MAAM,yBAAyB,eAA8B;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;YAoBzC,MAAM;iBAAW,OAAO;;kBAoQvC,MAAM;sBAqBF,MAAM;;sCA+DU,MAAM,KAAG,KAAK,CAAC,MAAM,OAAO,CAAC,kBAAkB,CAAC,CAAC;uBAoEhE,CAAC,SAAS,MAAM,eAC3B,CAAC,KACb,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CAqBvD,CAAA;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAC,CAAC,CAAC,EAC1F,MAAM,EAAE,CAAC,GACR,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAE9C;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,SAAU,MAAM,WAAW,OAAO,YAAY,aAAa,SAEnF,CAAA"}
|