@picked/svelte 0.0.1-dev.1788925875333 → 0.0.1-dev.1793753513002

package/dist/hooks/action.d.ts

@@ -1,18 +1,40 @@
-/** @file Svelte hooks for consuming registered actions from the Picked client. */
-import { type Action, type ActionKeys, type ExperienceInstance } from '@picked/client';
-import { type Store } from 'effector';
+/** @file Svelte bindings for running actions registered with the Picked client. */
+import type { ActionBinding, ActionKeys, EvokableAction, ExperienceInstance, WorkflowActionKeys } from '@picked/client';
+import type { Store } from 'effector';
+export type { ActionBinding } from '@picked/client';
+/** A key `getActionResult` takes: any action key except one a workflow is triggered by. */
+type HostActionKey<K extends string> = K extends WorkflowActionKeys ? never : K;
 /**
- * Returns the reactive evokable action store for the given action key.
+ * Returns a store binding a component to an action a workflow is triggered by: `run` runs it
+ * through `client.actions.run`, and `status`, `response` and `error` follow the latest run.
+ * Nothing runs the action except `run`. Every caller binding the same key and experience gets
+ * the same store, and so shares one run state.
  *
- * When `options.experience` is provided, the wrapped call passes that
- * experience as the action's context, so manually-invoked handlers can
- * behave as if they were triggered by that experience — for example to
- * call `context.experience.close()` after a submit.
+ * @param {WorkflowActionKeys} actionKey - The key of an action a workflow is triggered by.
+ * @param {object} [options] - Optional invocation overrides.
+ * @param {ExperienceInstance} options.experience - Experience to bind as the action's context.
+ * @returns {Store<ActionBinding>} A store of the latest run's state, and `run`.
+ * @example
+ * ```svelte
+ * <script>
+ *   const callback = getAction('request-callback')
+ * </script>
+ * <button onclick={() => $callback.run()} disabled={$callback.status === 'running'}>Call me</button>
+ * ```
+ */
+export declare function getAction(actionKey: WorkflowActionKeys, options?: {
+    experience: ExperienceInstance;
+}): Store<ActionBinding>;
+/**
+ * Returns the reactive store of the callable action. Calling it runs the action with the
+ * arguments it is called with. When `options.experience` is provided, the call passes that
+ * experience as the action's context, so a handler can behave as if the experience triggered
+ * it, for example by calling `context.experience.close()` after a submit.
  *
- * @param {ActionKeys} actionKey - Action key from the workspace schema.
+ * @param {ActionKeys} actionKey - Action key from the workspace schema, or one the app registers.
  * @param {object} [options] - Optional invocation overrides.
  * @param {ExperienceInstance} options.experience - Experience to bind as the action's context.
- * @returns {Store<() => ReturnType<Action>>} A store containing the callable action function or undefined.
+ * @returns {Store<EvokableAction>} A store of the callable action.
  * @example
  * ```ts
  * const actionStore = getAction('log-event')
@@ -21,20 +43,27 @@ import { type Store } from 'effector';
  */
 export declare function getAction(actionKey: ActionKeys, options?: {
     experience: ExperienceInstance;
-}): Store<() => ReturnType<Action>>;
+}): Store<EvokableAction>;
 /**
- * Returns a reactive store holding the latest result of invoking the keyed action.
- * Re-evaluates automatically when the underlying action store updates.
+ * Returns a store of the latest result of running a host's action, evaluated again on each call, so
+ * on each component that reads it, and whenever the action, the responses or the fields change;
+ * with `options.experience`, it follows those changes while the experience's instance is listed in
+ * `client.experienceInstances`. Every caller reading the same key and experience gets the same
+ * store, so the action runs once per change, and once for the calls of one task. When the
+ * evaluation that started last throws, the store holds `undefined`. A key a workflow is triggered
+ * by is refused: its action posts to the Picked API on every run, so read it with
+ * {@link getAction}. At runtime a published action holds `undefined` here.
  *
- * @param {ActionKeys} actionKey - Action key from the workspace schema.
+ * @template {ActionKeys} K
+ * @param {K} actionKey - Action key of a host's action.
  * @param {object} [options] - Optional invocation overrides.
  * @param {ExperienceInstance} options.experience - Experience to bind as the action's context.
- * @returns {Store<string | string[] | boolean | void | undefined>} A store containing the latest action return value.
+ * @returns {Store<unknown>} A store of the action's latest result.
  * @example
  * ```ts
- * const result = getActionResult('is-logged-in')
+ * const loggedIn = getActionResult('is-logged-in')
  * ```
  */
-export declare function getActionResult(actionKey: ActionKeys, options?: {
+export declare function getActionResult<K extends ActionKeys>(actionKey: K & HostActionKey<K>, options?: {
     experience: ExperienceInstance;
-}): import("effector").StoreWritable<void | string | boolean | string[] | undefined>;
+}): Store<unknown>;

package/dist/hooks/action.js

@@ -1 +1 @@
-import{getPicked as e}from"./client.js";import"@picked/client";import{attach as t,createEffect as n,createEvent as r,createStore as i,sample as a}from"effector";function o(t,n){return e().actions.getEvokableAction(t,n)}function s(e,s){let c=o(e,s),l=i(void 0,{skipVoid:!1}),u=r(),d=t({source:c,mapParams:(e,t)=>t,effect:n(async e=>{if(e)return await e()})});return a({clock:u,target:d}),a({clock:d.doneData,target:l}),u(),a({clock:c,target:u}),l}export{o as getAction,s as getActionResult};
+import{getPicked as e}from"./client.js";function t(t,n){return e().actions.getActionBinding(t,n)}function n(t,n){let{actions:r}=e();return r.refreshActionResult(t,n),r.getActionResult(t,n)}export{t as getAction,n as getActionResult};

package/dist/hooks/index.d.ts

@@ -3,10 +3,10 @@ export { getPicked, getExperience } from './client';
 export { getPredicate, getPredicateResult } from './predicate';
 export { getFeature, getFeatureResult, getFeatureEnabled } from './feature';
 export { getAction, getActionResult } from './action';
-export { getStep, setStepContext, getStepContent } from './step';
+export type { ActionBinding } from './action';
+export { getStep, setStepContext, getStepContent, getStepLayoutContent } from './step';
 export { getContent } from './content';
 export { getReference, getReferences } from './reference';
 export { useUnit, getContextScope, setContextScope } from './stores';
 export { createSessionStorageStore, createLocalStorageStore } from './storage.js';
-export { getTrackRecommendationPresentEvent } from './events';
 export { createQuery, queryCache, queryPresets, type QueryResult, type QueryFactory, } from './create-query';

package/dist/hooks/index.js

@@ -1 +1 @@
-import{getExperience as e,getPicked as t}from"./client.js";import{getPredicate as n,getPredicateResult as r}from"./predicate.js";import{getFeature as i,getFeatureEnabled as a,getFeatureResult as o}from"./feature.js";import{getAction as s,getActionResult as c}from"./action.js";import{getStep as l,getStepContent as u,setStepContext as d}from"./step.js";import{getContent as f}from"./content.js";import{getReference as p,getReferences as m}from"./reference.js";import{getContextScope as h,setContextScope as g,useUnit as _}from"./stores.js";import{createLocalStorageStore as v,createSessionStorageStore as y}from"./storage.js";import{getTrackRecommendationPresentEvent as b}from"./events.js";import{createQuery as x,queryCache as S,queryPresets as C}from"./create-query/index.js";export{v as createLocalStorageStore,x as createQuery,y as createSessionStorageStore,s as getAction,c as getActionResult,f as getContent,h as getContextScope,e as getExperience,i as getFeature,a as getFeatureEnabled,o as getFeatureResult,t as getPicked,n as getPredicate,r as getPredicateResult,p as getReference,m as getReferences,l as getStep,u as getStepContent,b as getTrackRecommendationPresentEvent,S as queryCache,C as queryPresets,g as setContextScope,d as setStepContext,_ as useUnit};
+import{getExperience as e,getPicked as t}from"./client.js";import{getPredicate as n,getPredicateResult as r}from"./predicate.js";import{getFeature as i,getFeatureEnabled as a,getFeatureResult as o}from"./feature.js";import{getAction as s,getActionResult as c}from"./action.js";import{getStep as l,getStepContent as u,getStepLayoutContent as d,setStepContext as f}from"./step.js";import{getContent as p}from"./content.js";import{getReference as m,getReferences as h}from"./reference.js";import{getContextScope as g,setContextScope as _,useUnit as v}from"./stores.js";import{createLocalStorageStore as y,createSessionStorageStore as b}from"./storage.js";import{createQuery as x,queryCache as S,queryPresets as C}from"./create-query/index.js";export{y as createLocalStorageStore,x as createQuery,b as createSessionStorageStore,s as getAction,c as getActionResult,p as getContent,g as getContextScope,e as getExperience,i as getFeature,a as getFeatureEnabled,o as getFeatureResult,t as getPicked,n as getPredicate,r as getPredicateResult,m as getReference,h as getReferences,l as getStep,u as getStepContent,d as getStepLayoutContent,S as queryCache,C as queryPresets,_ as setContextScope,f as setStepContext,v as useUnit};

package/dist/hooks/step.d.ts

@@ -92,3 +92,17 @@ export declare function getStepContent(): Store<StepLayoutContent | null>;
  * ```
  */
 export declare function getStepContent<K extends keyof StepContentModelsMap>(): Store<ContentForStep<K> | null>;
+/**
+ * Returns a store of the current step's layout Content record, or `null` when the step has no
+ * layout content or it is not registered yet.
+ *
+ * The record carries its `contentModelKey`. Under a step context it is that step's layout; on the
+ * slot render path, the layout of the experience's content-bearing step.
+ *
+ * @returns {Store<Content | null>} A store of the layout Content record.
+ * @example
+ * ```svelte
+ * const record = getStepLayoutContent()
+ * ```
+ */
+export declare function getStepLayoutContent(): Store<Content | null>;

package/dist/hooks/step.js

@@ -1 +1 @@
-import{STEP_CONTEXT_KEY as e}from"../context.js";import{getExperience as t,getPicked as n}from"./client.js";import{getStepRouter as r}from"../router/context.js";import{getContext as i,setContext as a}from"svelte";import{combine as o}from"effector";import{createForm as s}from"../form/create-form.svelte";function c(t,i){let c=n(),{activeStep:l}=r(),u=l.map(e=>e?.key===t),d=c.steps.listStore.map(e=>e.find(e=>e.key===t)??{id:t,key:t,name:``,fieldKeys:[]}),f=d.map(e=>e.name),p=d.map(e=>e.fieldKeys),m=s(t,f,p,i),h=o(d,c.contents.indexStore,(e,t)=>e.layoutContentId?t[e.layoutContentId]??null:null,{skipVoid:!1}),g=h.map(e=>e?.data??null,{skipVoid:!1});return a(e,{step:d,layoutContentStore:h,content:g,isActive:u,isActiveStep:u,...m})}function l(t){let n=i(e);return t?.onBeforeSubmit&&n.form.onBeforeSubmit(t.onBeforeSubmit),t?.onSuccess&&n.form.onSuccess(t.onSuccess),t?.onError&&n.form.onError(t.onError),n}function u(){let t=i(e);return t?t.content:d().map(e=>e?.data??null,{skipVoid:!1})}function d(){let e=t(),r=n();return o(e.treeStore,r.contents.indexStore,(e,t)=>{let n=e.steps.find(e=>e.layoutContentId);return n?.layoutContentId?t[n.layoutContentId]??null:null})}export{l as getStep,u as getStepContent,c as setStepContext};
+import{STEP_CONTEXT_KEY as e}from"../context.js";import{getExperience as t,getPicked as n}from"./client.js";import{getStepRouter as r}from"../router/context.js";import{getContext as i,setContext as a}from"svelte";import{combine as o}from"effector";import{createForm as s}from"../form/create-form.svelte";function c(t,i){let c=n(),{activeStep:l}=r(),u=l.map(e=>e?.key===t),d=c.steps.listStore.map(e=>e.find(e=>e.key===t)??{id:t,key:t,name:``,fieldKeys:[]}),f=d.map(e=>e.name),p=d.map(e=>e.fieldKeys),m=s(t,f,p,i),h=o(d,c.contents.indexStore,(e,t)=>e.layoutContentId?t[e.layoutContentId]??null:null,{skipVoid:!1}),g=h.map(e=>e?.data??null,{skipVoid:!1});return a(e,{step:d,layoutContentStore:h,content:g,isActive:u,isActiveStep:u,...m})}function l(t){let n=i(e);return t?.onBeforeSubmit&&n.form.onBeforeSubmit(t.onBeforeSubmit),t?.onSuccess&&n.form.onSuccess(t.onSuccess),t?.onError&&n.form.onError(t.onError),n}function u(){let t=i(e);return t?t.content:f().map(e=>e?.data??null,{skipVoid:!1})}function d(){return i(e)?.layoutContentStore??f()}function f(){let e=t(),r=n();return o(e.treeStore,r.contents.indexStore,(e,t)=>{let n=e.steps.find(e=>e.layoutContentId);return n?.layoutContentId?t[n.layoutContentId]??null:null})}export{l as getStep,u as getStepContent,d as getStepLayoutContent,c as setStepContext};