@picked/react 0.0.1-dev.1773729274420 → 0.0.1-dev.1773804563218

package/dist/hooks/client.d.ts

@@ -1,16 +1,16 @@
 import { ExperienceInstance, Picked } from '@picked/client';
 /**
- * Retrieves the Picked Client for the Experience Instance
- *
- * @returns The Picked client instance that provides access to experiences, steps, and other Picked functionality
+ * Retrieves the Picked Client for the Experience Instance.
+ * @returns The Picked client instance that provides access to experiences, steps, and other Picked functionality.
+ * @example
+ * const client = usePicked()
  */
 export declare function usePicked(): Picked;
 /**
- * Retrieves the Experience Store for the current Experience Instance
- *
- * @returns The Experience store instance that provides access to experience configuration and state
+ * Retrieves the Experience Store for the current Experience Instance.
+ * @returns The Experience store instance that provides access to experience configuration and state.
+ * @example
+ * const experience = useExperience()
  */
 export declare function useExperience(): ExperienceInstance;
-export declare const getPicked: typeof usePicked;
-export declare const getExperience: typeof useExperience;
 //# sourceMappingURL=client.d.ts.map

package/dist/hooks/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/hooks/client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAGhE;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAOlC;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,kBAAkB,CAOlD;AAGD,eAAO,MAAM,SAAS,kBAAY,CAAA;AAClC,eAAO,MAAM,aAAa,sBAAgB,CAAA"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/hooks/client.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAGhE;;;;;GAKG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAOlC;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,IAAI,kBAAkB,CAOlD"}

package/dist/hooks/client.js

@@ -1 +1 @@
-import{useContext as t}from"react";import{ExperienceContext as n,ClientContext as r}from"../context.js";function i(){const e=t(r);if(!e)throw new Error("usePicked must be used within a ClientProvider");return e}function o(){const e=t(n);if(!e)throw new Error("useExperience must be used within an ExperienceProvider");return e}const u=i,x=o;export{x as getExperience,u as getPicked,o as useExperience,i as usePicked};
+import{useContext as t}from"react";import{ExperienceContext as r,ClientContext as n}from"../context.js";function u(){const e=t(n);if(!e)throw new Error("usePicked must be used within a ClientProvider");return e}function c(){const e=t(r);if(!e)throw new Error("useExperience must be used within an ExperienceProvider");return e}export{c as useExperience,u as usePicked};

package/dist/hooks/field.d.ts

@@ -4,5 +4,5 @@ export interface GetFieldResponse {
     value: Store<FieldValue>;
     field: Store<Field | null>;
 }
-export declare function getField(id: string): GetFieldResponse;
+export declare function getField(key: string): GetFieldResponse;
 //# sourceMappingURL=field.d.ts.map

package/dist/hooks/field.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/hooks/field.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAGrC,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;IACxB,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAA;CAC3B;AAED,wBAAgB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,CAQrD"}
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../../src/hooks/field.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAGrC,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;IACxB,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAA;CAC3B;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAQtD"}

package/dist/hooks/field.js

@@ -1 +1 @@
-import{getPicked as s}from"./client.js";function r(e){const t=s(),n=t.fields.getById(e),o=t.responses.getByFieldId(e);return{field:n,value:o}}export{r as getField};
+import{usePicked as o}from"./client.js";function r(e){const t=o(),s=t.fields.getByKey(e),n=t.responses.getByFieldKey(e);return{field:s,value:n}}export{r as getField};

package/dist/hooks/index.d.ts

@@ -1,5 +1,10 @@
-export { usePicked, useExperience, getPicked, getExperience } from './client';
+/**
+ * @file Public re-exports for the hooks entry point.
+ */
+export { usePicked, useExperience } from './client';
 export { useStep, useSetStepContext } from './step';
+export type { StepContext } from './step';
 export { useSessionStorage, useLocalStorage } from './storage';
+export type { UseStorageOptions } from './storage';
 export * from './field';
 //# sourceMappingURL=index.d.ts.map

package/dist/hooks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAC7E,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAC9D,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AACnD,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAC9D,YAAY,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClD,cAAc,SAAS,CAAA"}

package/dist/hooks/index.js

@@ -1 +1 @@
-import{getExperience as o,getPicked as r,useExperience as p,usePicked as s}from"./client.js";import{useSetStepContext as i,useStep as u}from"./step.js";import{useLocalStorage as c,useSessionStorage as g}from"./storage.js";import{getField as m}from"./field.js";export{o as getExperience,m as getField,r as getPicked,p as useExperience,c as useLocalStorage,s as usePicked,g as useSessionStorage,i as useSetStepContext,u as useStep};
+import{useExperience as t,usePicked as r}from"./client.js";import{useSetStepContext as p,useStep as u}from"./step.js";import{useLocalStorage as S,useSessionStorage as f}from"./storage.js";import{getField as m}from"./field.js";export{m as getField,t as useExperience,S as useLocalStorage,r as usePicked,f as useSessionStorage,p as useSetStepContext,u as useStep};

package/dist/hooks/step.d.ts

@@ -2,21 +2,36 @@ import { Field, Response } from '@picked/client';
 type FieldWithValue = Field & {
     value: Response | undefined;
 };
-type StepWithLabel = {
+interface StepWithLabel {
     id: string;
     label: string;
-};
+}
 export interface StepContext {
     step: StepWithLabel;
     fields: FieldWithValue[];
     isActiveStep?: boolean;
 }
 export declare const StepContextProvider: import('react').Context<StepContext | null>;
+/**
+ * Returns the current step context, including step metadata and evaluated fields.
+ * Must be used within a component wrapped by `StepContextProvider`.
+ * @returns The step, its evaluated fields, and whether this is the active step.
+ * @example
+ * const { step, fields, isActiveStep } = useStep()
+ */
 export declare function useStep(): {
     step: StepWithLabel;
     fields: FieldWithValue[];
     isActiveStep: boolean;
 };
+/**
+ * Creates and returns step context stores for the given step ID.
+ * Evaluates field conditions reactively whenever fields or responses change.
+ * @param stepId - The ID of the step to set context for.
+ * @returns The step metadata, evaluated fields, and active step indicator.
+ * @example
+ * const { step, fields, isActiveStep } = useSetStepContext('step-123')
+ */
 export declare function useSetStepContext(stepId: string): {
     step: StepWithLabel;
     fields: FieldWithValue[];

package/dist/hooks/step.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"step.d.ts","sourceRoot":"","sources":["../../src/hooks/step.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAoC,MAAM,gBAAgB,CAAA;AAMvF,KAAK,cAAc,GAAG,KAAK,GAAG;IAAE,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAA;CAAE,CAAA;AAC7D,KAAK,aAAa,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAOlD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,EAAE,cAAc,EAAE,CAAA;IACxB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED,eAAO,MAAM,mBAAmB,6CAA0C,CAAA;AAE1E,wBAAgB,OAAO;;;;EAWtB;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM;;;;EA+F/C"}
+{"version":3,"file":"step.d.ts","sourceRoot":"","sources":["../../src/hooks/step.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAoC,MAAM,gBAAgB,CAAA;AAMvF,KAAK,cAAc,GAAG,KAAK,GAAG;IAAE,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAA;CAAE,CAAA;AAC7D,UAAU,aAAa;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd;AAOD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,aAAa,CAAA;IACnB,MAAM,EAAE,cAAc,EAAE,CAAA;IACxB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED,eAAO,MAAM,mBAAmB,6CAA0C,CAAA;AAE1E;;;;;;GAMG;AACH,wBAAgB,OAAO;;;;EAWtB;AAeD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM;;;;EA8G/C"}

package/dist/hooks/step.js

@@ -1 +1 @@
-import{createContext as w,useMemo as a,useContext as b}from"react";import{attach as E,createEffect as F,combine as R,createStore as A,sample as P}from"effector";import{evaluateRuleLogic as g}from"@picked/client";import{useUnit as k}from"effector-react";import{useStepRouter as y}from"../router/context.js";import{useExperience as D,usePicked as L}from"./client.js";const M=w(null);function B(){const e=b(M);if(!e)throw new Error("useStep must be used within a StepContextProvider");return{step:e.step,fields:e.fields,isActiveStep:e.isActiveStep??!1}}function G(e){const l=D(),s=L(),{activeStep:p}=y(),m=a(()=>p?.id===e,[p?.id,e]),{stepContext:S}=a(()=>{const o=E({source:R({steps:l.treeStore.map(i=>i.steps),fields:s.fields.listStore,responses:s.responses.listStore}),effect:F(async({steps:i,fields:r,responses:x})=>{const n=i.find(t=>t.id===e);if(!n)throw new Error(`Step with id "${e}" not found in the experience tree.`);const v=r.filter(t=>n.fieldIds.includes(t.id)),c=[];for(const t of v)t.condition?await g(s,t.condition)&&c.push(t):c.push(t);const C=c.map(t=>{const u=x.find(h=>h.fieldId===t.id)?.value;return{...t,value:u}});return{step:{id:n.id,label:n.label},fields:C}})}),f=A({step:{id:e,label:""},fields:[]});return f.on(o.doneData,(i,r)=>r),P({clock:[s.fields.listStore,s.responses.listStore],target:o}),o(),{stepContextFx:o,stepContext:f}},[e,s,l]),d=k(S);return{step:d?.step,fields:d?.fields||[],isActiveStep:m}}export{M as StepContextProvider,G as useSetStepContext,B as useStep};
+import{createContext as y,useMemo as m,useContext as E}from"react";import{combine as S,attach as F,createEffect as P,createStore as R,sample as k}from"effector";import{evaluateRuleLogic as A}from"@picked/client";import{useUnit as g}from"effector-react";import{useStepRouter as K}from"../router/context.js";import{useExperience as _,usePicked as B}from"./client.js";const D=y(null);function G(){const t=E(D);if(!t)throw new Error("useStep must be used within a StepContextProvider");return{step:t.step,fields:t.fields,isActiveStep:t.isActiveStep??!1}}function H(t){const l=_(),s=B(),{activeStep:f}=K(),x=m(()=>f?.id===t,[f?.id,t]),{stepContext:v}=m(()=>{const C=l.treeStore.map(o=>o.steps),h=S(C,s.steps.listStore,(o,i)=>i.filter(c=>o.includes(c.id))),r=F({source:S({steps:h,fields:s.fields.listStore,responses:s.responses.listStore}),mapParams:(o,i)=>i,effect:P(async({steps:o,fields:i,responses:c})=>{const n=o.find(e=>e.id===t);if(!n)throw new Error(`Step with id "${t}" not found in the experience tree.`);const w=i.filter(e=>(n.fieldIds??[]).includes(e.id)),p=[];for(const e of w)e.condition?await A(s,e.condition)&&p.push(e):p.push(e);const a={};for(const e of c)a[e.fieldKey]=e;const b=p.map(e=>({...e,value:a[e.key]?.value}));return{step:{id:n.id,label:n.name??n.label},fields:b}})}),u=R({step:{id:t,label:""},fields:[]});return u.on(r.doneData,(o,i)=>i),k({clock:[s.fields.listStore,s.responses.listStore],target:r}),r(),{stepContextFx:r,stepContext:u}},[t,s,l]),d=g(v);return{step:d.step,fields:d.fields,isActiveStep:x}}export{D as StepContextProvider,H as useSetStepContext,G as useStep};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@picked/react",
-  "version": "0.0.1-dev.1773729274420",
+  "version": "0.0.1-dev.1773804563218",
   "devDependencies": {
     "@picked/client": "workspace:*",
     "@repo/eslint-config": "workspace:*",
@@ -59,16 +59,33 @@
     "dist"
   ],
   "knip": {
+    "entry": [
+      "src/index.ts",
+      "src/server/index.ts",
+      "src/router/index.ts",
+      "src/form/index.ts",
+      "src/hooks/index.ts",
+      "src/plugins/framework/index.ts"
+    ],
+    "ignore": [
+      "eslint.config.js"
+    ],
     "ignoreBinaries": [
+      "attw",
       "knip",
       "jscpd",
       "eslint",
       "tsc"
+    ],
+    "ignoreDependencies": [
+      "@picked/client",
+      "@repo/eslint-config",
+      "@repo/typescript-config"
     ]
   },
   "module": "./dist/index.js",
   "peerDependencies": {
-    "@picked/client": "0.0.1-dev.1773729274420",
+    "@picked/client": "0.0.1-dev.1773804563218",
     "effector": "^23.3.0",
     "effector-react": "^23.3.0",
     "react": "19.2.2",