@knocklabs/react 0.11.17 → 0.11.18
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/CHANGELOG.md +6 -0
- package/dist/cjs/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.js +1 -1
- package/dist/cjs/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.js.map +1 -1
- package/dist/esm/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.mjs +36 -36
- package/dist/esm/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.mjs.map +1 -1
- package/dist/types/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.d.ts +2 -2
- package/dist/types/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.d.ts.map +1 -1
- package/package.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const
|
|
1
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const _=require("@knocklabs/client"),b=require("@knocklabs/react-core"),y=require("./helpers.js"),v=e=>e.reduce((t,s)=>({...t,[s.key]:s}),{}),h=(e,t,s,r)=>{var o,l,u,a,n,d,c,f;const i=!!((a=(u=(l=(o=r.byKey)==null?void 0:o.one)==null?void 0:l.metadata)==null?void 0:u.opts)!=null&&a.includeThrottled)||!!((f=(c=(d=(n=r.byKey)==null?void 0:n.all)==null?void 0:d.metadata)==null?void 0:c.opts)!=null&&f.includeThrottled);return e.bypass_global_group_limit?"returned":e.key===s.resolved?t.throttled&&!i?"throttled":"returned":"queried"},G=(e,t,s,r)=>{var l,u,a,n;const i=!!((n=(a=(u=(l=r.byType)==null?void 0:l.one)==null?void 0:u.metadata)==null?void 0:a.opts)!=null&&n.includeThrottled),o=r.byType.one;if(o.size===0)return"queried";if(e.bypass_global_group_limit){const c=[...o.values()][0];return e.key!==c.key?"queried":"returned"}return e.key===s.resolved?t.throttled&&!i?"throttled":"returned":"queried"},S=(e,t,s,r)=>{var n,d,c,f;const i=r.byType.all;if(i.size===0)return"queried";const o=[...i.values()],l=o[0],u=v(o);return(f=(c=(d=(n=r.byType)==null?void 0:n.all)==null?void 0:d.metadata)==null?void 0:c.opts)!=null&&f.includeThrottled?u[e.key]?"returned":"queried":(l.bypass_global_group_limit||l.key===s.resolved)&&u[e.key]?t.throttled?e.bypass_global_group_limit?"returned":"throttled":"returned":"queried"},T=(e,t,s,r)=>{var i,o;if(r.byKey)return h(e,t,s,r);if((i=r.byType)!=null&&i.all)return S(e,t,s,r);if((o=r.byType)!=null&&o.one)return G(e,t,s,r)},m=(e,t,s)=>{if(!s||s.status==="open")return{status:void 0};const r={byKey:(s.results.byKey||{})[e.key],byType:(s.results.byType||{})[e.type]};if(!!!(r.byKey||r.byType))return{status:void 0};const o=T(e,t,s,r);return o?{status:o,query:r}:{status:void 0}},U=(e,t)=>{const s={};return((t==null?void 0:t.reason)==="not_in_target_audience"||(t==null?void 0:t.reason)==="target_conditions_not_met")&&(s.targetable={status:!1,reason:t.reason,message:t.message}),((t==null?void 0:t.reason)==="marked_as_archived"||(e.steps||[]).every(r=>!!r.message.archived_at))&&(s.archived={status:!0}),(t==null?void 0:t.reason)==="guide_not_active"&&(s.active={status:!1}),s},R=({active:e,targetable:t,archived:s})=>!(!e.status||!t.status||s.status),p=({activatable:e,selectable:t})=>!(!e.status||!t.status),q=(e,t,s,r)=>{const{ineligibleGuides:i,location:o}=s,l=i[e.key],u=U(e,l),a={active:(u==null?void 0:u.active)||{status:!0},targetable:(u==null?void 0:u.targetable)||{status:!0},archived:(u==null?void 0:u.archived)||{status:!1},activatable:{status:_.checkActivatable(e,o)},selectable:m(e,s,r)},n={...a,isEligible:R(a),isQualified:p(a)};return{...e,orderIndex:t,annotation:n}},C=(e,t)=>({__typename:"UncommittedGuide",key:e,orderIndex:t,active:!1,bypass_global_group_limit:!1,annotation:{isEligible:!1,isQualified:!1,active:{status:!1},selectable:{status:void 0}}}),K=e=>{var a;const{client:t}=b.useGuideContext(),s=b.useStore(t.store,n=>{const d=_.checkStateIfThrottled(n);return{location:n.location,guides:n.guides,guideGroups:n.guideGroups,ineligibleGuides:n.ineligibleGuides,debug:n.debug,counter:n.counter,queries:n.queries,throttled:d}});if(!((a=s.debug)!=null&&a.debugging))return;const r=Object.entries(s.queries)[0];if(!r||r[1].status==="loading")return{status:"error",error:"no_guides_fetched",message:"Loading..."};const i=s.guideGroups[0];if(!i)return{status:"error",error:"no_guide_group",message:"No guide group found"};const o=t.getStage(),l=i.display_sequence.map((n,d)=>{const c=s.guides[n];return c?q(c,d,s,o):C(n,d)}),u=Object.keys(e.focusedGuideKeys||{})[0];if((o==null?void 0:o.status)==="closed"&&u){const n=l.find(d=>d.key===u);if(!n)return{status:"error",error:"focus_unknown_guide",message:`Unable to display \`${u}\`, ${y.FOCUS_ERRORS.focusUnknownGuide.toLowerCase()}.`};if(g(n))return{status:"error",error:"focus_uncommitted_guide",message:`Unable to display \`${u}\`, ${y.FOCUS_ERRORS.focusUncommittedGuide.toLowerCase()}.`};if(!n.annotation.selectable.status)return{status:"error",error:"focus_unselectable_guide",message:`Unable to display \`${u}\`, ${y.FOCUS_ERRORS.focusUnselectableGuide.toLowerCase()}.`}}return{status:"ok",guides:l}},g=e=>typeof e=="object"&&e!==null&&"__typename"in e&&e.__typename==="UncommittedGuide";exports.isUncommittedGuide=g;exports.resolveIsQualified=p;exports.useInspectGuideClientStore=K;
|
|
2
2
|
//# sourceMappingURL=useInspectGuideClientStore.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useInspectGuideClientStore.js","sources":["../../../../../../../src/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.ts"],"sourcesContent":["import {\n KnockGuide,\n KnockGuideClientGroupStage,\n KnockGuideClientStoreState,\n KnockGuideIneligibilityMarker,\n KnockGuideSelectionResult,\n type ToolbarV2RunConfig,\n checkActivatable,\n checkStateIfThrottled,\n} from \"@knocklabs/client\";\nimport { useGuideContext, useStore } from \"@knocklabs/react-core\";\n\nimport { FOCUS_ERRORS } from \"./helpers\";\n\nconst byKey = <T extends { key: string }>(items: T[]) => {\n return items.reduce((acc, item) => ({ ...acc, [item.key]: item }), {});\n};\n\n/**\n * This is the main module that will house core logic for the toolbar. It hooks\n * into the guide client state store, extracts relevant data for debugging, and\n * transforms it into easily consumable data for the toolbar - namely\n * \"annotating\" guides for its various statuses to display.\n */\n\n// Active: `true` status = good\ntype ActiveStatus = {\n status: boolean;\n};\n\n// Targetable: `true` status = good\ntype TargetableStatusTrue = {\n status: true;\n};\ntype TargetableStatusFalse = {\n status: false;\n reason: string;\n message: string;\n};\ntype TargetableStatus = TargetableStatusTrue | TargetableStatusFalse;\n\ntype ActivatableStatus = {\n status: boolean;\n};\n\n// Archived: `false` status = good\ntype ArchivedStatus = {\n status: boolean;\n};\n\n// Selectable:\n// - \"returned\": Queried and resolved to return the guide from useGuide(s).\n// - \"throttled\": Queried and resolved but being throttled, so not yet returned.\n// - \"queried\": Queried but not resolved, because there are other higher\n// priority guides that are ahead of this guide in the query result.\n// - undefined: Not reachable with any of the given queries and filters.\ntype SelectionResultByLimit = {\n one?: KnockGuideSelectionResult;\n all?: KnockGuideSelectionResult;\n};\ntype SelectionResultByQuery = {\n key?: SelectionResultByLimit;\n type?: SelectionResultByLimit;\n};\ntype SelectableStatusPresent = {\n status: \"returned\" | \"throttled\" | \"queried\";\n query: SelectionResultByQuery;\n};\ntype SelectableStatusAbsent = {\n status: undefined;\n};\ntype SelectableStatus = SelectableStatusPresent | SelectableStatusAbsent;\n\nexport type AnnotatedStatuses = {\n // Individual eligibility statuses:\n active: ActiveStatus;\n targetable: TargetableStatus;\n archived: ArchivedStatus;\n // Individual qualified statuses:\n activatable: ActivatableStatus;\n selectable: SelectableStatus;\n};\n\ntype GuideAnnotation = AnnotatedStatuses & {\n // Resolved eligibility based on active, targetable and archived statuses,\n // which are backend driven evaluation results that are exposed for debugging.\n isEligible: boolean;\n\n // Resolved display qualification based on an activatable status, which\n // informs \"when\" and \"where\" an eligible guide can be displayed to user.\n isQualified: boolean;\n};\n\nexport type AnnotatedGuide = KnockGuide & {\n orderIndex: number;\n annotation: GuideAnnotation;\n\n // Legacy fields, typed only to make tsc happy when we prune these out.\n activation_location_rules?: KnockGuide[\"activation_url_patterns\"];\n priority?: number;\n};\n\n// Exists and ordered in control but absent in switchboard (therefore not\n// included in the api response), which implies a newly created guide that has\n// never been published to switchboard.\nexport type UncommittedGuide = {\n __typename: \"UncommittedGuide\";\n orderIndex: number;\n key: KnockGuide[\"key\"];\n active: false;\n bypass_global_group_limit: false;\n annotation: {\n isEligible: false;\n isQualified: false;\n active: {\n status: false;\n };\n selectable: {\n status: undefined;\n };\n };\n};\n\nexport type InspectionResultOk = {\n status: \"ok\";\n guides: (AnnotatedGuide | UncommittedGuide)[];\n};\ntype InspectionResultError = {\n status: \"error\";\n error:\n | \"no_guides_fetched\"\n | \"no_guide_group\"\n | \"focus_unknown_guide\"\n | \"focus_uncommitted_guide\"\n | \"focus_unselectable_guide\";\n message: string;\n};\ntype InspectionResult = InspectionResultOk | InspectionResultError;\n\ntype StoreStateSnapshot = Pick<\n KnockGuideClientStoreState,\n | \"location\"\n | \"guides\"\n | \"guideGroups\"\n | \"ineligibleGuides\"\n | \"debug\"\n | \"counter\"\n | \"queries\"\n> & {\n throttled: boolean;\n};\n\nconst inferSelectByKeyReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const includeThrottled =\n !!query.key?.one?.metadata?.opts?.includeThrottled ||\n !!query.key?.all?.metadata?.opts?.includeThrottled;\n\n // If unthrottled, then it should always be returned.\n if (guide.bypass_global_group_limit) {\n return \"returned\";\n }\n\n // If resolved, expect this guide to be returned unless being throttled.\n if (guide.key === stage.resolved) {\n if (snapshot.throttled && !includeThrottled) {\n return \"throttled\";\n }\n return \"returned\";\n }\n\n // If queried but not resolved, it means this guide is being shadowed by\n // another guide with higher priority because throttled guides can be\n // displayed only one at a time.\n return \"queried\";\n};\n\nconst inferSelectOneByTypeReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const includeThrottled = !!query.type?.one?.metadata?.opts?.includeThrottled;\n\n const result = query.type!.one!;\n if (result.size === 0) {\n return \"queried\";\n }\n\n // There may be multiple unthrottled guides of the same type, being queried\n // by type to return a single guide, for example: useGuide({ type: \"card\" }).\n //\n // So it is possible for an unthrottled guide to be shadowed by another\n // unthrottled guide of the same type with higher priority, so we need to\n // look at the query result to determine its return status.\n if (guide.bypass_global_group_limit) {\n const guides = [...result.values()];\n const first = guides[0]!;\n\n if (guide.key !== first.key) {\n // Being shadowed by another guide with higher priority.\n return \"queried\";\n }\n return \"returned\";\n }\n\n // If resolved, expect this guide to be returned unless being throttled.\n if (guide.key === stage.resolved) {\n if (snapshot.throttled && !includeThrottled) {\n return \"throttled\";\n }\n return \"returned\";\n }\n\n // If queried but not resolved, it means this guide is being shadowed by\n // another guide with higher priority because throttled guides can be\n // displayed only one at a time.\n return \"queried\";\n};\n\nconst inferSelectAllByTypeReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const result = query.type!.all!;\n if (result.size === 0) {\n return \"queried\";\n }\n\n const guides = [...result.values()];\n const first = guides[0]!;\n\n // Might want to consider moving this up to do once.\n const guidesByKey: Record<KnockGuide[\"key\"], KnockGuide> = byKey(guides);\n\n // If includeThrottled given, then expect all selected guides to be returned.\n const includeThrottled = !!query.type?.all?.metadata?.opts?.includeThrottled;\n if (includeThrottled) {\n return guidesByKey[guide.key] ? \"returned\" : \"queried\";\n }\n\n // If the first selected guide is unthrottled or resolved, then we should\n // have at minimum one guide to return, and potentially more based on whether\n // we are throttling currently and which other guides are unthrottled.\n if (first.bypass_global_group_limit || first.key === stage.resolved) {\n if (!guidesByKey[guide.key]) {\n return \"queried\";\n }\n if (snapshot.throttled) {\n return guide.bypass_global_group_limit ? \"returned\" : \"throttled\";\n }\n return \"returned\";\n }\n\n return \"queried\";\n};\n\nconst inferSelectReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n) => {\n // Querying by key can only return up to a max of one guide, regardless of\n // useGuide or useGuides, and should take precedence in status designation.\n if (query.key) {\n return inferSelectByKeyReturnStatus(guide, snapshot, stage, query);\n }\n\n if (query.type?.all) {\n return inferSelectAllByTypeReturnStatus(guide, snapshot, stage, query);\n }\n if (query.type?.one) {\n return inferSelectOneByTypeReturnStatus(guide, snapshot, stage, query);\n }\n\n // Should not happen but just for completeness.\n return undefined;\n};\n\nconst toSelectableStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage | undefined,\n): SelectableStatus => {\n if (!stage || stage.status === \"open\") {\n return { status: undefined };\n }\n\n const query = {\n key: (stage.results.key || {})[guide.key],\n type: (stage.results.type || {})[guide.type],\n };\n\n const queried = Boolean(query.key || query.type);\n if (!queried) {\n // No present query in the current location can select this guide.\n return { status: undefined };\n }\n\n const status = inferSelectReturnStatus(guide, snapshot, stage, query);\n if (!status) {\n return { status: undefined };\n }\n\n return { status, query };\n};\n\nconst toIneligibilityStatus = (\n guide: KnockGuide,\n marker?: KnockGuideIneligibilityMarker,\n): Partial<AnnotatedStatuses> => {\n const statuses: Partial<AnnotatedStatuses> = {};\n\n if (\n marker?.reason === \"not_in_target_audience\" ||\n marker?.reason === \"target_conditions_not_met\"\n ) {\n statuses.targetable = {\n status: false,\n reason: marker.reason,\n message: marker.message,\n };\n }\n\n if (\n marker?.reason === \"marked_as_archived\" ||\n (guide.steps || []).every((s) => !!s.message.archived_at)\n ) {\n statuses.archived = {\n status: true,\n };\n }\n\n if (marker?.reason === \"guide_not_active\") {\n statuses.active = {\n status: false,\n };\n }\n\n return statuses;\n};\n\nconst resolveIsEligible = ({\n active,\n targetable,\n archived,\n}: AnnotatedStatuses) => {\n if (!active.status) return false;\n if (!targetable.status) return false;\n if (archived.status) return false;\n return true;\n};\n\nexport const resolveIsQualified = ({\n activatable,\n selectable,\n}: AnnotatedStatuses) => {\n if (!activatable.status) return false;\n if (!selectable.status) return false;\n return true;\n};\n\nconst annotateGuide = (\n guide: KnockGuide,\n orderIndex: number,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage | undefined,\n): AnnotatedGuide => {\n const { ineligibleGuides, location } = snapshot;\n const marker = ineligibleGuides[guide.key];\n const ineligiblity = toIneligibilityStatus(guide, marker);\n\n const statuses: AnnotatedStatuses = {\n // isEligible:\n active: ineligiblity?.active || { status: true },\n targetable: ineligiblity?.targetable || { status: true },\n archived: ineligiblity?.archived || { status: false },\n // isQualified:\n activatable: { status: checkActivatable(guide, location) },\n selectable: toSelectableStatus(guide, snapshot, stage),\n };\n\n const annotation: GuideAnnotation = {\n ...statuses,\n isEligible: resolveIsEligible(statuses),\n isQualified: resolveIsQualified(statuses),\n };\n\n return {\n ...guide,\n orderIndex,\n annotation,\n };\n};\n\nconst newUncommittedGuide = (key: KnockGuide[\"key\"], orderIndex: number) =>\n ({\n __typename: \"UncommittedGuide\",\n key,\n orderIndex,\n active: false,\n bypass_global_group_limit: false,\n annotation: {\n isEligible: false,\n isQualified: false,\n active: {\n status: false,\n },\n selectable: {\n status: undefined,\n },\n },\n }) as UncommittedGuide;\n\nexport const useInspectGuideClientStore = (\n runConfig: ToolbarV2RunConfig,\n): InspectionResult | undefined => {\n const { client } = useGuideContext();\n\n // Extract a snapshot of the client store state for debugging.\n const snapshot: StoreStateSnapshot = useStore(client.store, (state) => {\n const throttled = checkStateIfThrottled(state);\n\n return {\n location: state.location,\n guides: state.guides,\n guideGroups: state.guideGroups,\n ineligibleGuides: state.ineligibleGuides,\n debug: state.debug,\n counter: state.counter,\n queries: state.queries,\n throttled,\n };\n });\n\n // Not in debugging session, so noop.\n if (!snapshot.debug?.debugging) {\n return undefined;\n }\n\n // No recorded fetch requests, which implies an inflight request loading.\n const req = Object.entries(snapshot.queries)[0];\n if (!req || req[1].status === \"loading\") {\n return {\n status: \"error\",\n error: \"no_guides_fetched\",\n message: \"Loading...\",\n };\n }\n\n // Should always be a default group so this should never happen.\n const defaultGroup = snapshot.guideGroups[0];\n if (!defaultGroup) {\n return {\n status: \"error\",\n error: \"no_guide_group\",\n message: \"No guide group found\",\n };\n }\n\n const groupStage = client.getStage();\n\n // Annotate guides for various eligibility, activation and query statuses\n // that are useful for debugging purposes.\n const orderedGuides = defaultGroup.display_sequence.map((guideKey, index) => {\n const guide = snapshot.guides[guideKey];\n if (!guide) {\n return newUncommittedGuide(guideKey, index);\n }\n\n return annotateGuide(guide, index, snapshot, groupStage);\n });\n\n // Check if the focused guide actually exists and is selectable on the page.\n const focusedGuideKey = Object.keys(runConfig.focusedGuideKeys || {})[0];\n if (groupStage?.status === \"closed\" && focusedGuideKey) {\n const foundGuide = orderedGuides.find((g) => g.key === focusedGuideKey);\n\n // No such guide exists for the given focused guide key.\n if (!foundGuide) {\n return {\n status: \"error\",\n error: \"focus_unknown_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUnknownGuide.toLowerCase()}.`,\n };\n }\n\n // This guide exists but has never been committed and published, so it is\n // not present in the API response.\n if (isUncommittedGuide(foundGuide)) {\n return {\n status: \"error\",\n error: \"focus_uncommitted_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUncommittedGuide.toLowerCase()}.`,\n };\n }\n\n // This guide exists and is present in the response, but it is not queried\n // in the current page so it is impossible to force render this guide.\n if (!foundGuide.annotation.selectable.status) {\n return {\n status: \"error\",\n error: \"focus_unselectable_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUnselectableGuide.toLowerCase()}.`,\n };\n }\n }\n\n return {\n status: \"ok\",\n guides: orderedGuides,\n };\n};\n\nexport const isUncommittedGuide = (input: unknown): input is UncommittedGuide =>\n typeof input === \"object\" &&\n input !== null &&\n \"__typename\" in input &&\n (input as UncommittedGuide).__typename === \"UncommittedGuide\";\n"],"names":["byKey","items","reduce","acc","item","key","inferSelectByKeyReturnStatus","guide","snapshot","stage","query","includeThrottled","one","metadata","opts","all","bypass_global_group_limit","resolved","throttled","inferSelectOneByTypeReturnStatus","type","result","size","first","values","inferSelectAllByTypeReturnStatus","guides","guidesByKey","inferSelectReturnStatus","toSelectableStatus","status","undefined","results","Boolean","toIneligibilityStatus","marker","statuses","reason","targetable","message","steps","every","s","archived_at","archived","active","resolveIsEligible","resolveIsQualified","activatable","selectable","annotateGuide","orderIndex","ineligibleGuides","location","ineligiblity","checkActivatable","annotation","isEligible","isQualified","newUncommittedGuide","__typename","useInspectGuideClientStore","runConfig","client","useGuideContext","useStore","store","state","checkStateIfThrottled","guideGroups","debug","counter","queries","debugging","req","Object","entries","error","defaultGroup","groupStage","getStage","orderedGuides","display_sequence","map","guideKey","index","focusedGuideKey","keys","focusedGuideKeys","foundGuide","find","g","FOCUS_ERRORS","focusUnknownGuide","toLowerCase","isUncommittedGuide","focusUncommittedGuide","focusUnselectableGuide","input"],"mappings":"kLAcMA,EAAoCC,GACjCA,EAAMC,OAAO,CAACC,EAAKC,KAAU,CAAE,GAAGD,EAAK,CAACC,EAAKC,GAAG,EAAGD,CAAK,GAAI,CAAA,CAAE,EAyIjEE,EAA+BA,CACnCC,EACAC,EACAC,EACAC,IACsC,qBACtC,MAAMC,EACJ,CAAC,GAACD,GAAAA,GAAAA,GAAAA,EAAAA,EAAML,MAANK,YAAAA,EAAWE,MAAXF,YAAAA,EAAgBG,WAAhBH,YAAAA,EAA0BI,OAA1BJ,MAAAA,EAAgCC,mBAClC,CAAC,GAACD,GAAAA,GAAAA,GAAAA,EAAAA,EAAML,MAANK,YAAAA,EAAWK,MAAXL,YAAAA,EAAgBG,WAAhBH,YAAAA,EAA0BI,OAA1BJ,MAAAA,EAAgCC,kBAGpC,OAAIJ,EAAMS,0BACD,WAILT,EAAMF,MAAQI,EAAMQ,SAClBT,EAASU,WAAa,CAACP,EAClB,YAEF,WAMF,SACT,EAEMQ,EAAmCA,CACvCZ,EACAC,EACAC,EACAC,IACsC,aACtC,MAAMC,EAAmB,CAAC,GAACD,GAAAA,GAAAA,GAAAA,EAAAA,EAAMU,OAANV,YAAAA,EAAYE,MAAZF,YAAAA,EAAiBG,WAAjBH,YAAAA,EAA2BI,OAA3BJ,MAAAA,EAAiCC,kBAEtDU,EAASX,EAAMU,KAAMR,IACvBS,GAAAA,EAAOC,OAAS,EACX,MAAA,UAST,GAAIf,EAAMS,0BAA2B,CAE7BO,MAAAA,EADS,CAAC,GAAGF,EAAOG,QAAQ,EACb,CAAC,EAElBjB,OAAAA,EAAMF,MAAQkB,EAAMlB,IAEf,UAEF,UAAA,CAILE,OAAAA,EAAMF,MAAQI,EAAMQ,SAClBT,EAASU,WAAa,CAACP,EAClB,YAEF,WAMF,SACT,EAEMc,EAAmCA,CACvClB,EACAC,EACAC,EACAC,IACsC,aAChCW,MAAAA,EAASX,EAAMU,KAAML,IACvBM,GAAAA,EAAOC,OAAS,EACX,MAAA,UAGT,MAAMI,EAAS,CAAC,GAAGL,EAAOG,QAAQ,EAC5BD,EAAQG,EAAO,CAAC,EAGhBC,EAAqD3B,EAAM0B,CAAM,EAIvE,OAD2BhB,GAAAA,GAAAA,GAAAA,EAAAA,EAAMU,OAANV,YAAAA,EAAYK,MAAZL,YAAAA,EAAiBG,WAAjBH,YAAAA,EAA2BI,OAA3BJ,MAAAA,EAAiCC,iBAEnDgB,EAAYpB,EAAMF,GAAG,EAAI,WAAa,WAM3CkB,EAAMP,2BAA6BO,EAAMlB,MAAQI,EAAMQ,WACpDU,EAAYpB,EAAMF,GAAG,EAGtBG,EAASU,UACJX,EAAMS,0BAA4B,WAAa,YAEjD,WAGF,SACT,EAEMY,EAA0BA,CAC9BrB,EACAC,EACAC,EACAC,IACG,SAGH,GAAIA,EAAML,IACR,OAAOC,EAA6BC,EAAOC,EAAUC,EAAOC,CAAK,EAG/DA,IAAAA,EAAAA,EAAMU,OAANV,MAAAA,EAAYK,IACd,OAAOU,EAAiClB,EAAOC,EAAUC,EAAOC,CAAK,EAEnEA,IAAAA,EAAAA,EAAMU,OAANV,MAAAA,EAAYE,IACd,OAAOO,EAAiCZ,EAAOC,EAAUC,EAAOC,CAAK,CAKzE,EAEMmB,EAAqBA,CACzBtB,EACAC,EACAC,IACqB,CACrB,GAAI,CAACA,GAASA,EAAMqB,SAAW,OACtB,MAAA,CAAEA,OAAQC,MAAU,EAG7B,MAAMrB,EAAQ,CACZL,KAAMI,EAAMuB,QAAQ3B,KAAO,CAAC,GAAGE,EAAMF,GAAG,EACxCe,MAAOX,EAAMuB,QAAQZ,MAAQ,CAAA,GAAIb,EAAMa,IAAI,CAC7C,EAGA,GAAI,CADYa,GAAQvB,EAAML,KAAOK,EAAMU,MAGlC,MAAA,CAAEU,OAAQC,MAAU,EAG7B,MAAMD,EAASF,EAAwBrB,EAAOC,EAAUC,EAAOC,CAAK,EACpE,OAAKoB,EAIE,CAAEA,OAAAA,EAAQpB,MAAAA,CAAM,EAHd,CAAEoB,OAAQC,MAAU,CAI/B,EAEMG,EAAwBA,CAC5B3B,EACA4B,IAC+B,CAC/B,MAAMC,EAAuC,CAAC,EAE9C,QACED,GAAAA,YAAAA,EAAQE,UAAW,2BACnBF,GAAAA,YAAAA,EAAQE,UAAW,+BAEnBD,EAASE,WAAa,CACpBR,OAAQ,GACRO,OAAQF,EAAOE,OACfE,QAASJ,EAAOI,OAClB,KAIAJ,GAAAA,YAAAA,EAAQE,UAAW,uBAClB9B,EAAMiC,OAAS,CAAA,GAAIC,MAAOC,GAAM,CAAC,CAACA,EAAEH,QAAQI,WAAW,KAExDP,EAASQ,SAAW,CAClBd,OAAQ,EACV,IAGEK,GAAAA,YAAAA,EAAQE,UAAW,qBACrBD,EAASS,OAAS,CAChBf,OAAQ,EACV,GAGKM,CACT,EAEMU,EAAoBA,CAAC,CACzBD,OAAAA,EACAP,WAAAA,EACAM,SAAAA,CACiB,IACb,GAACC,EAAOf,QACR,CAACQ,EAAWR,QACZc,EAASd,QAIFiB,EAAqBA,CAAC,CACjCC,YAAAA,EACAC,WAAAA,CACiB,IACb,GAACD,EAAYlB,QACb,CAACmB,EAAWnB,QAIZoB,EAAgBA,CACpB3C,EACA4C,EACA3C,EACAC,IACmB,CACb,KAAA,CAAE2C,iBAAAA,EAAkBC,SAAAA,CAAAA,EAAa7C,EACjC2B,EAASiB,EAAiB7C,EAAMF,GAAG,EACnCiD,EAAepB,EAAsB3B,EAAO4B,CAAM,EAElDC,EAA8B,CAElCS,QAAQS,GAAAA,YAAAA,EAAcT,SAAU,CAAEf,OAAQ,EAAK,EAC/CQ,YAAYgB,GAAAA,YAAAA,EAAchB,aAAc,CAAER,OAAQ,EAAK,EACvDc,UAAUU,GAAAA,YAAAA,EAAcV,WAAY,CAAEd,OAAQ,EAAM,EAEpDkB,YAAa,CAAElB,OAAQyB,EAAAA,iBAAiBhD,EAAO8C,CAAQ,CAAE,EACzDJ,WAAYpB,EAAmBtB,EAAOC,EAAUC,CAAK,CACvD,EAEM+C,EAA8B,CAClC,GAAGpB,EACHqB,WAAYX,EAAkBV,CAAQ,EACtCsB,YAAaX,EAAmBX,CAAQ,CAC1C,EAEO,MAAA,CACL,GAAG7B,EACH4C,WAAAA,EACAK,WAAAA,CACF,CACF,EAEMG,EAAsBA,CAACtD,EAAwB8C,KAClD,CACCS,WAAY,mBACZvD,IAAAA,EACA8C,WAAAA,EACAN,OAAQ,GACR7B,0BAA2B,GAC3BwC,WAAY,CACVC,WAAY,GACZC,YAAa,GACbb,OAAQ,CACNf,OAAQ,EACV,EACAmB,WAAY,CACVnB,OAAQC,MAAAA,CACV,CAEJ,GAEW8B,EACXC,GACiC,OAC3B,KAAA,CAAEC,OAAAA,GAAWC,kBAAgB,EAG7BxD,EAA+ByD,EAAAA,SAASF,EAAOG,MAAkBC,GAAA,CAC/DjD,MAAAA,EAAYkD,wBAAsBD,CAAK,EAEtC,MAAA,CACLd,SAAUc,EAAMd,SAChB3B,OAAQyC,EAAMzC,OACd2C,YAAaF,EAAME,YACnBjB,iBAAkBe,EAAMf,iBACxBkB,MAAOH,EAAMG,MACbC,QAASJ,EAAMI,QACfC,QAASL,EAAMK,QACftD,UAAAA,CACF,CAAA,CACD,EAGG,GAAA,GAACV,EAAAA,EAAS8D,QAAT9D,MAAAA,EAAgBiE,WACZ1C,OAIT,MAAM2C,EAAMC,OAAOC,QAAQpE,EAASgE,OAAO,EAAE,CAAC,EAC9C,GAAI,CAACE,GAAOA,EAAI,CAAC,EAAE5C,SAAW,UACrB,MAAA,CACLA,OAAQ,QACR+C,MAAO,oBACPtC,QAAS,YACX,EAIIuC,MAAAA,EAAetE,EAAS6D,YAAY,CAAC,EAC3C,GAAI,CAACS,EACI,MAAA,CACLhD,OAAQ,QACR+C,MAAO,iBACPtC,QAAS,sBACX,EAGIwC,MAAAA,EAAahB,EAAOiB,SAAS,EAI7BC,EAAgBH,EAAaI,iBAAiBC,IAAI,CAACC,EAAUC,IAAU,CACrE9E,MAAAA,EAAQC,EAASkB,OAAO0D,CAAQ,EACtC,OAAK7E,EAIE2C,EAAc3C,EAAO8E,EAAO7E,EAAUuE,CAAU,EAH9CpB,EAAoByB,EAAUC,CAAK,CAGW,CACxD,EAGKC,EAAkBX,OAAOY,KAAKzB,EAAU0B,kBAAoB,CAAA,CAAE,EAAE,CAAC,EACnET,IAAAA,GAAAA,YAAAA,EAAYjD,UAAW,UAAYwD,EAAiB,CACtD,MAAMG,EAAaR,EAAcS,KAAYC,GAAAA,EAAEtF,MAAQiF,CAAe,EAGtE,GAAI,CAACG,EACI,MAAA,CACL3D,OAAQ,QACR+C,MAAO,sBACPtC,QAAS,uBAAuB+C,CAAe,OAAOM,EAAAA,aAAaC,kBAAkBC,aAAa,GACpG,EAKEC,GAAAA,EAAmBN,CAAU,EACxB,MAAA,CACL3D,OAAQ,QACR+C,MAAO,0BACPtC,QAAS,uBAAuB+C,CAAe,OAAOM,EAAAA,aAAaI,sBAAsBF,aAAa,GACxG,EAKF,GAAI,CAACL,EAAWjC,WAAWP,WAAWnB,OAC7B,MAAA,CACLA,OAAQ,QACR+C,MAAO,2BACPtC,QAAS,uBAAuB+C,CAAe,OAAOM,EAAAA,aAAaK,uBAAuBH,aAAa,GACzG,CACF,CAGK,MAAA,CACLhE,OAAQ,KACRJ,OAAQuD,CACV,CACF,EAEac,EAAsBG,GACjC,OAAOA,GAAU,UACjBA,IAAU,MACV,eAAgBA,GACfA,EAA2BtC,aAAe"}
|
|
1
|
+
{"version":3,"file":"useInspectGuideClientStore.js","sources":["../../../../../../../src/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.ts"],"sourcesContent":["import {\n KnockGuide,\n KnockGuideClientGroupStage,\n KnockGuideClientStoreState,\n KnockGuideIneligibilityMarker,\n KnockGuideSelectionResult,\n type ToolbarV2RunConfig,\n checkActivatable,\n checkStateIfThrottled,\n} from \"@knocklabs/client\";\nimport { useGuideContext, useStore } from \"@knocklabs/react-core\";\n\nimport { FOCUS_ERRORS } from \"./helpers\";\n\nconst byKey = <T extends { key: string }>(items: T[]) => {\n return items.reduce((acc, item) => ({ ...acc, [item.key]: item }), {});\n};\n\n/**\n * This is the main module that will house core logic for the toolbar. It hooks\n * into the guide client state store, extracts relevant data for debugging, and\n * transforms it into easily consumable data for the toolbar - namely\n * \"annotating\" guides for its various statuses to display.\n */\n\n// Active: `true` status = good\ntype ActiveStatus = {\n status: boolean;\n};\n\n// Targetable: `true` status = good\ntype TargetableStatusTrue = {\n status: true;\n};\ntype TargetableStatusFalse = {\n status: false;\n reason: string;\n message: string;\n};\ntype TargetableStatus = TargetableStatusTrue | TargetableStatusFalse;\n\ntype ActivatableStatus = {\n status: boolean;\n};\n\n// Archived: `false` status = good\ntype ArchivedStatus = {\n status: boolean;\n};\n\n// Selectable:\n// - \"returned\": Queried and resolved to return the guide from useGuide(s).\n// - \"throttled\": Queried and resolved but being throttled, so not yet returned.\n// - \"queried\": Queried but not resolved, because there are other higher\n// priority guides that are ahead of this guide in the query result.\n// - undefined: Not reachable with any of the given queries and filters.\ntype SelectionResultByLimit = {\n one?: KnockGuideSelectionResult;\n all?: KnockGuideSelectionResult;\n};\ntype SelectionResultByQuery = {\n byKey?: SelectionResultByLimit;\n byType?: SelectionResultByLimit;\n};\ntype SelectableStatusPresent = {\n status: \"returned\" | \"throttled\" | \"queried\";\n query: SelectionResultByQuery;\n};\ntype SelectableStatusAbsent = {\n status: undefined;\n};\ntype SelectableStatus = SelectableStatusPresent | SelectableStatusAbsent;\n\nexport type AnnotatedStatuses = {\n // Individual eligibility statuses:\n active: ActiveStatus;\n targetable: TargetableStatus;\n archived: ArchivedStatus;\n // Individual qualified statuses:\n activatable: ActivatableStatus;\n selectable: SelectableStatus;\n};\n\ntype GuideAnnotation = AnnotatedStatuses & {\n // Resolved eligibility based on active, targetable and archived statuses,\n // which are backend driven evaluation results that are exposed for debugging.\n isEligible: boolean;\n\n // Resolved display qualification based on an activatable status, which\n // informs \"when\" and \"where\" an eligible guide can be displayed to user.\n isQualified: boolean;\n};\n\nexport type AnnotatedGuide = KnockGuide & {\n orderIndex: number;\n annotation: GuideAnnotation;\n\n // Legacy fields, typed only to make tsc happy when we prune these out.\n activation_location_rules?: KnockGuide[\"activation_url_patterns\"];\n priority?: number;\n};\n\n// Exists and ordered in control but absent in switchboard (therefore not\n// included in the api response), which implies a newly created guide that has\n// never been published to switchboard.\nexport type UncommittedGuide = {\n __typename: \"UncommittedGuide\";\n orderIndex: number;\n key: KnockGuide[\"key\"];\n active: false;\n bypass_global_group_limit: false;\n annotation: {\n isEligible: false;\n isQualified: false;\n active: {\n status: false;\n };\n selectable: {\n status: undefined;\n };\n };\n};\n\nexport type InspectionResultOk = {\n status: \"ok\";\n guides: (AnnotatedGuide | UncommittedGuide)[];\n};\ntype InspectionResultError = {\n status: \"error\";\n error:\n | \"no_guides_fetched\"\n | \"no_guide_group\"\n | \"focus_unknown_guide\"\n | \"focus_uncommitted_guide\"\n | \"focus_unselectable_guide\";\n message: string;\n};\ntype InspectionResult = InspectionResultOk | InspectionResultError;\n\ntype StoreStateSnapshot = Pick<\n KnockGuideClientStoreState,\n | \"location\"\n | \"guides\"\n | \"guideGroups\"\n | \"ineligibleGuides\"\n | \"debug\"\n | \"counter\"\n | \"queries\"\n> & {\n throttled: boolean;\n};\n\nconst inferSelectByKeyReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const includeThrottled =\n !!query.byKey?.one?.metadata?.opts?.includeThrottled ||\n !!query.byKey?.all?.metadata?.opts?.includeThrottled;\n\n // If unthrottled, then it should always be returned.\n if (guide.bypass_global_group_limit) {\n return \"returned\";\n }\n\n // If resolved, expect this guide to be returned unless being throttled.\n if (guide.key === stage.resolved) {\n if (snapshot.throttled && !includeThrottled) {\n return \"throttled\";\n }\n return \"returned\";\n }\n\n // If queried but not resolved, it means this guide is being shadowed by\n // another guide with higher priority because throttled guides can be\n // displayed only one at a time.\n return \"queried\";\n};\n\nconst inferSelectOneByTypeReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const includeThrottled =\n !!query.byType?.one?.metadata?.opts?.includeThrottled;\n\n const result = query.byType!.one!;\n if (result.size === 0) {\n return \"queried\";\n }\n\n // There may be multiple unthrottled guides of the same type, being queried\n // by type to return a single guide, for example: useGuide({ type: \"card\" }).\n //\n // So it is possible for an unthrottled guide to be shadowed by another\n // unthrottled guide of the same type with higher priority, so we need to\n // look at the query result to determine its return status.\n if (guide.bypass_global_group_limit) {\n const guides = [...result.values()];\n const first = guides[0]!;\n\n if (guide.key !== first.key) {\n // Being shadowed by another guide with higher priority.\n return \"queried\";\n }\n return \"returned\";\n }\n\n // If resolved, expect this guide to be returned unless being throttled.\n if (guide.key === stage.resolved) {\n if (snapshot.throttled && !includeThrottled) {\n return \"throttled\";\n }\n return \"returned\";\n }\n\n // If queried but not resolved, it means this guide is being shadowed by\n // another guide with higher priority because throttled guides can be\n // displayed only one at a time.\n return \"queried\";\n};\n\nconst inferSelectAllByTypeReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const result = query.byType!.all!;\n if (result.size === 0) {\n return \"queried\";\n }\n\n const guides = [...result.values()];\n const first = guides[0]!;\n\n // Might want to consider moving this up to do once.\n const guidesByKey: Record<KnockGuide[\"key\"], KnockGuide> = byKey(guides);\n\n // If includeThrottled given, then expect all selected guides to be returned.\n const includeThrottled =\n !!query.byType?.all?.metadata?.opts?.includeThrottled;\n if (includeThrottled) {\n return guidesByKey[guide.key] ? \"returned\" : \"queried\";\n }\n\n // If the first selected guide is unthrottled or resolved, then we should\n // have at minimum one guide to return, and potentially more based on whether\n // we are throttling currently and which other guides are unthrottled.\n if (first.bypass_global_group_limit || first.key === stage.resolved) {\n if (!guidesByKey[guide.key]) {\n return \"queried\";\n }\n if (snapshot.throttled) {\n return guide.bypass_global_group_limit ? \"returned\" : \"throttled\";\n }\n return \"returned\";\n }\n\n return \"queried\";\n};\n\nconst inferSelectReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n) => {\n // Querying by key can only return up to a max of one guide, regardless of\n // useGuide or useGuides, and should take precedence in status designation.\n if (query.byKey) {\n return inferSelectByKeyReturnStatus(guide, snapshot, stage, query);\n }\n\n if (query.byType?.all) {\n return inferSelectAllByTypeReturnStatus(guide, snapshot, stage, query);\n }\n if (query.byType?.one) {\n return inferSelectOneByTypeReturnStatus(guide, snapshot, stage, query);\n }\n\n // Should not happen but just for completeness.\n return undefined;\n};\n\nconst toSelectableStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage | undefined,\n): SelectableStatus => {\n if (!stage || stage.status === \"open\") {\n return { status: undefined };\n }\n\n const query = {\n byKey: (stage.results.byKey || {})[guide.key],\n byType: (stage.results.byType || {})[guide.type],\n };\n\n const queried = Boolean(query.byKey || query.byType);\n if (!queried) {\n // No present query in the current location can select this guide.\n return { status: undefined };\n }\n\n const status = inferSelectReturnStatus(guide, snapshot, stage, query);\n if (!status) {\n return { status: undefined };\n }\n\n return { status, query };\n};\n\nconst toIneligibilityStatus = (\n guide: KnockGuide,\n marker?: KnockGuideIneligibilityMarker,\n): Partial<AnnotatedStatuses> => {\n const statuses: Partial<AnnotatedStatuses> = {};\n\n if (\n marker?.reason === \"not_in_target_audience\" ||\n marker?.reason === \"target_conditions_not_met\"\n ) {\n statuses.targetable = {\n status: false,\n reason: marker.reason,\n message: marker.message,\n };\n }\n\n if (\n marker?.reason === \"marked_as_archived\" ||\n (guide.steps || []).every((s) => !!s.message.archived_at)\n ) {\n statuses.archived = {\n status: true,\n };\n }\n\n if (marker?.reason === \"guide_not_active\") {\n statuses.active = {\n status: false,\n };\n }\n\n return statuses;\n};\n\nconst resolveIsEligible = ({\n active,\n targetable,\n archived,\n}: AnnotatedStatuses) => {\n if (!active.status) return false;\n if (!targetable.status) return false;\n if (archived.status) return false;\n return true;\n};\n\nexport const resolveIsQualified = ({\n activatable,\n selectable,\n}: AnnotatedStatuses) => {\n if (!activatable.status) return false;\n if (!selectable.status) return false;\n return true;\n};\n\nconst annotateGuide = (\n guide: KnockGuide,\n orderIndex: number,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage | undefined,\n): AnnotatedGuide => {\n const { ineligibleGuides, location } = snapshot;\n const marker = ineligibleGuides[guide.key];\n const ineligiblity = toIneligibilityStatus(guide, marker);\n\n const statuses: AnnotatedStatuses = {\n // isEligible:\n active: ineligiblity?.active || { status: true },\n targetable: ineligiblity?.targetable || { status: true },\n archived: ineligiblity?.archived || { status: false },\n // isQualified:\n activatable: { status: checkActivatable(guide, location) },\n selectable: toSelectableStatus(guide, snapshot, stage),\n };\n\n const annotation: GuideAnnotation = {\n ...statuses,\n isEligible: resolveIsEligible(statuses),\n isQualified: resolveIsQualified(statuses),\n };\n\n return {\n ...guide,\n orderIndex,\n annotation,\n };\n};\n\nconst newUncommittedGuide = (key: KnockGuide[\"key\"], orderIndex: number) =>\n ({\n __typename: \"UncommittedGuide\",\n key,\n orderIndex,\n active: false,\n bypass_global_group_limit: false,\n annotation: {\n isEligible: false,\n isQualified: false,\n active: {\n status: false,\n },\n selectable: {\n status: undefined,\n },\n },\n }) as UncommittedGuide;\n\nexport const useInspectGuideClientStore = (\n runConfig: ToolbarV2RunConfig,\n): InspectionResult | undefined => {\n const { client } = useGuideContext();\n\n // Extract a snapshot of the client store state for debugging.\n const snapshot: StoreStateSnapshot = useStore(client.store, (state) => {\n const throttled = checkStateIfThrottled(state);\n\n return {\n location: state.location,\n guides: state.guides,\n guideGroups: state.guideGroups,\n ineligibleGuides: state.ineligibleGuides,\n debug: state.debug,\n counter: state.counter,\n queries: state.queries,\n throttled,\n };\n });\n\n // Not in debugging session, so noop.\n if (!snapshot.debug?.debugging) {\n return undefined;\n }\n\n // No recorded fetch requests, which implies an inflight request loading.\n const req = Object.entries(snapshot.queries)[0];\n if (!req || req[1].status === \"loading\") {\n return {\n status: \"error\",\n error: \"no_guides_fetched\",\n message: \"Loading...\",\n };\n }\n\n // Should always be a default group so this should never happen.\n const defaultGroup = snapshot.guideGroups[0];\n if (!defaultGroup) {\n return {\n status: \"error\",\n error: \"no_guide_group\",\n message: \"No guide group found\",\n };\n }\n\n const groupStage = client.getStage();\n\n // Annotate guides for various eligibility, activation and query statuses\n // that are useful for debugging purposes.\n const orderedGuides = defaultGroup.display_sequence.map((guideKey, index) => {\n const guide = snapshot.guides[guideKey];\n if (!guide) {\n return newUncommittedGuide(guideKey, index);\n }\n\n return annotateGuide(guide, index, snapshot, groupStage);\n });\n\n // Check if the focused guide actually exists and is selectable on the page.\n const focusedGuideKey = Object.keys(runConfig.focusedGuideKeys || {})[0];\n if (groupStage?.status === \"closed\" && focusedGuideKey) {\n const foundGuide = orderedGuides.find((g) => g.key === focusedGuideKey);\n\n // No such guide exists for the given focused guide key.\n if (!foundGuide) {\n return {\n status: \"error\",\n error: \"focus_unknown_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUnknownGuide.toLowerCase()}.`,\n };\n }\n\n // This guide exists but has never been committed and published, so it is\n // not present in the API response.\n if (isUncommittedGuide(foundGuide)) {\n return {\n status: \"error\",\n error: \"focus_uncommitted_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUncommittedGuide.toLowerCase()}.`,\n };\n }\n\n // This guide exists and is present in the response, but it is not queried\n // in the current page so it is impossible to force render this guide.\n if (!foundGuide.annotation.selectable.status) {\n return {\n status: \"error\",\n error: \"focus_unselectable_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUnselectableGuide.toLowerCase()}.`,\n };\n }\n }\n\n return {\n status: \"ok\",\n guides: orderedGuides,\n };\n};\n\nexport const isUncommittedGuide = (input: unknown): input is UncommittedGuide =>\n typeof input === \"object\" &&\n input !== null &&\n \"__typename\" in input &&\n (input as UncommittedGuide).__typename === \"UncommittedGuide\";\n"],"names":["byKey","items","reduce","acc","item","key","inferSelectByKeyReturnStatus","guide","snapshot","stage","query","includeThrottled","one","metadata","opts","all","bypass_global_group_limit","resolved","throttled","inferSelectOneByTypeReturnStatus","byType","result","size","first","values","inferSelectAllByTypeReturnStatus","guides","guidesByKey","inferSelectReturnStatus","toSelectableStatus","status","undefined","results","type","Boolean","toIneligibilityStatus","marker","statuses","reason","targetable","message","steps","every","s","archived_at","archived","active","resolveIsEligible","resolveIsQualified","activatable","selectable","annotateGuide","orderIndex","ineligibleGuides","location","ineligiblity","checkActivatable","annotation","isEligible","isQualified","newUncommittedGuide","__typename","useInspectGuideClientStore","runConfig","client","useGuideContext","useStore","store","state","checkStateIfThrottled","guideGroups","debug","counter","queries","debugging","req","Object","entries","error","defaultGroup","groupStage","getStage","orderedGuides","display_sequence","map","guideKey","index","focusedGuideKey","keys","focusedGuideKeys","foundGuide","find","g","FOCUS_ERRORS","focusUnknownGuide","toLowerCase","isUncommittedGuide","focusUncommittedGuide","focusUnselectableGuide","input"],"mappings":"kLAcMA,EAAoCC,GACjCA,EAAMC,OAAO,CAACC,EAAKC,KAAU,CAAE,GAAGD,EAAK,CAACC,EAAKC,GAAG,EAAGD,CAAK,GAAI,CAAA,CAAE,EAyIjEE,EAA+BA,CACnCC,EACAC,EACAC,EACAC,IACsC,qBACtC,MAAMC,EACJ,CAAC,GAACD,GAAAA,GAAAA,GAAAA,EAAAA,EAAMV,QAANU,YAAAA,EAAaE,MAAbF,YAAAA,EAAkBG,WAAlBH,YAAAA,EAA4BI,OAA5BJ,MAAAA,EAAkCC,mBACpC,CAAC,GAACD,GAAAA,GAAAA,GAAAA,EAAAA,EAAMV,QAANU,YAAAA,EAAaK,MAAbL,YAAAA,EAAkBG,WAAlBH,YAAAA,EAA4BI,OAA5BJ,MAAAA,EAAkCC,kBAGtC,OAAIJ,EAAMS,0BACD,WAILT,EAAMF,MAAQI,EAAMQ,SAClBT,EAASU,WAAa,CAACP,EAClB,YAEF,WAMF,SACT,EAEMQ,EAAmCA,CACvCZ,EACAC,EACAC,EACAC,IACsC,aACtC,MAAMC,EACJ,CAAC,GAACD,GAAAA,GAAAA,GAAAA,EAAAA,EAAMU,SAANV,YAAAA,EAAcE,MAAdF,YAAAA,EAAmBG,WAAnBH,YAAAA,EAA6BI,OAA7BJ,MAAAA,EAAmCC,kBAEjCU,EAASX,EAAMU,OAAQR,IACzBS,GAAAA,EAAOC,OAAS,EACX,MAAA,UAST,GAAIf,EAAMS,0BAA2B,CAE7BO,MAAAA,EADS,CAAC,GAAGF,EAAOG,QAAQ,EACb,CAAC,EAElBjB,OAAAA,EAAMF,MAAQkB,EAAMlB,IAEf,UAEF,UAAA,CAILE,OAAAA,EAAMF,MAAQI,EAAMQ,SAClBT,EAASU,WAAa,CAACP,EAClB,YAEF,WAMF,SACT,EAEMc,EAAmCA,CACvClB,EACAC,EACAC,EACAC,IACsC,aAChCW,MAAAA,EAASX,EAAMU,OAAQL,IACzBM,GAAAA,EAAOC,OAAS,EACX,MAAA,UAGT,MAAMI,EAAS,CAAC,GAAGL,EAAOG,QAAQ,EAC5BD,EAAQG,EAAO,CAAC,EAGhBC,EAAqD3B,EAAM0B,CAAM,EAKvE,OADIhB,GAAAA,GAAAA,GAAAA,EAAAA,EAAMU,SAANV,YAAAA,EAAcK,MAAdL,YAAAA,EAAmBG,WAAnBH,YAAAA,EAA6BI,OAA7BJ,MAAAA,EAAmCC,iBAE9BgB,EAAYpB,EAAMF,GAAG,EAAI,WAAa,WAM3CkB,EAAMP,2BAA6BO,EAAMlB,MAAQI,EAAMQ,WACpDU,EAAYpB,EAAMF,GAAG,EAGtBG,EAASU,UACJX,EAAMS,0BAA4B,WAAa,YAEjD,WAGF,SACT,EAEMY,EAA0BA,CAC9BrB,EACAC,EACAC,EACAC,IACG,SAGH,GAAIA,EAAMV,MACR,OAAOM,EAA6BC,EAAOC,EAAUC,EAAOC,CAAK,EAG/DA,IAAAA,EAAAA,EAAMU,SAANV,MAAAA,EAAcK,IAChB,OAAOU,EAAiClB,EAAOC,EAAUC,EAAOC,CAAK,EAEnEA,IAAAA,EAAAA,EAAMU,SAANV,MAAAA,EAAcE,IAChB,OAAOO,EAAiCZ,EAAOC,EAAUC,EAAOC,CAAK,CAKzE,EAEMmB,EAAqBA,CACzBtB,EACAC,EACAC,IACqB,CACrB,GAAI,CAACA,GAASA,EAAMqB,SAAW,OACtB,MAAA,CAAEA,OAAQC,MAAU,EAG7B,MAAMrB,EAAQ,CACZV,OAAQS,EAAMuB,QAAQhC,OAAS,CAAC,GAAGO,EAAMF,GAAG,EAC5Ce,QAASX,EAAMuB,QAAQZ,QAAU,CAAA,GAAIb,EAAM0B,IAAI,CACjD,EAGA,GAAI,CADYC,GAAQxB,EAAMV,OAASU,EAAMU,QAGpC,MAAA,CAAEU,OAAQC,MAAU,EAG7B,MAAMD,EAASF,EAAwBrB,EAAOC,EAAUC,EAAOC,CAAK,EACpE,OAAKoB,EAIE,CAAEA,OAAAA,EAAQpB,MAAAA,CAAM,EAHd,CAAEoB,OAAQC,MAAU,CAI/B,EAEMI,EAAwBA,CAC5B5B,EACA6B,IAC+B,CAC/B,MAAMC,EAAuC,CAAC,EAE9C,QACED,GAAAA,YAAAA,EAAQE,UAAW,2BACnBF,GAAAA,YAAAA,EAAQE,UAAW,+BAEnBD,EAASE,WAAa,CACpBT,OAAQ,GACRQ,OAAQF,EAAOE,OACfE,QAASJ,EAAOI,OAClB,KAIAJ,GAAAA,YAAAA,EAAQE,UAAW,uBAClB/B,EAAMkC,OAAS,CAAA,GAAIC,MAAOC,GAAM,CAAC,CAACA,EAAEH,QAAQI,WAAW,KAExDP,EAASQ,SAAW,CAClBf,OAAQ,EACV,IAGEM,GAAAA,YAAAA,EAAQE,UAAW,qBACrBD,EAASS,OAAS,CAChBhB,OAAQ,EACV,GAGKO,CACT,EAEMU,EAAoBA,CAAC,CACzBD,OAAAA,EACAP,WAAAA,EACAM,SAAAA,CACiB,IACb,GAACC,EAAOhB,QACR,CAACS,EAAWT,QACZe,EAASf,QAIFkB,EAAqBA,CAAC,CACjCC,YAAAA,EACAC,WAAAA,CACiB,IACb,GAACD,EAAYnB,QACb,CAACoB,EAAWpB,QAIZqB,EAAgBA,CACpB5C,EACA6C,EACA5C,EACAC,IACmB,CACb,KAAA,CAAE4C,iBAAAA,EAAkBC,SAAAA,CAAAA,EAAa9C,EACjC4B,EAASiB,EAAiB9C,EAAMF,GAAG,EACnCkD,EAAepB,EAAsB5B,EAAO6B,CAAM,EAElDC,EAA8B,CAElCS,QAAQS,GAAAA,YAAAA,EAAcT,SAAU,CAAEhB,OAAQ,EAAK,EAC/CS,YAAYgB,GAAAA,YAAAA,EAAchB,aAAc,CAAET,OAAQ,EAAK,EACvDe,UAAUU,GAAAA,YAAAA,EAAcV,WAAY,CAAEf,OAAQ,EAAM,EAEpDmB,YAAa,CAAEnB,OAAQ0B,EAAAA,iBAAiBjD,EAAO+C,CAAQ,CAAE,EACzDJ,WAAYrB,EAAmBtB,EAAOC,EAAUC,CAAK,CACvD,EAEMgD,EAA8B,CAClC,GAAGpB,EACHqB,WAAYX,EAAkBV,CAAQ,EACtCsB,YAAaX,EAAmBX,CAAQ,CAC1C,EAEO,MAAA,CACL,GAAG9B,EACH6C,WAAAA,EACAK,WAAAA,CACF,CACF,EAEMG,EAAsBA,CAACvD,EAAwB+C,KAClD,CACCS,WAAY,mBACZxD,IAAAA,EACA+C,WAAAA,EACAN,OAAQ,GACR9B,0BAA2B,GAC3ByC,WAAY,CACVC,WAAY,GACZC,YAAa,GACbb,OAAQ,CACNhB,OAAQ,EACV,EACAoB,WAAY,CACVpB,OAAQC,MAAAA,CACV,CAEJ,GAEW+B,EACXC,GACiC,OAC3B,KAAA,CAAEC,OAAAA,GAAWC,kBAAgB,EAG7BzD,EAA+B0D,EAAAA,SAASF,EAAOG,MAAkBC,GAAA,CAC/DlD,MAAAA,EAAYmD,wBAAsBD,CAAK,EAEtC,MAAA,CACLd,SAAUc,EAAMd,SAChB5B,OAAQ0C,EAAM1C,OACd4C,YAAaF,EAAME,YACnBjB,iBAAkBe,EAAMf,iBACxBkB,MAAOH,EAAMG,MACbC,QAASJ,EAAMI,QACfC,QAASL,EAAMK,QACfvD,UAAAA,CACF,CAAA,CACD,EAGG,GAAA,GAACV,EAAAA,EAAS+D,QAAT/D,MAAAA,EAAgBkE,WACZ3C,OAIT,MAAM4C,EAAMC,OAAOC,QAAQrE,EAASiE,OAAO,EAAE,CAAC,EAC9C,GAAI,CAACE,GAAOA,EAAI,CAAC,EAAE7C,SAAW,UACrB,MAAA,CACLA,OAAQ,QACRgD,MAAO,oBACPtC,QAAS,YACX,EAIIuC,MAAAA,EAAevE,EAAS8D,YAAY,CAAC,EAC3C,GAAI,CAACS,EACI,MAAA,CACLjD,OAAQ,QACRgD,MAAO,iBACPtC,QAAS,sBACX,EAGIwC,MAAAA,EAAahB,EAAOiB,SAAS,EAI7BC,EAAgBH,EAAaI,iBAAiBC,IAAI,CAACC,EAAUC,IAAU,CACrE/E,MAAAA,EAAQC,EAASkB,OAAO2D,CAAQ,EACtC,OAAK9E,EAIE4C,EAAc5C,EAAO+E,EAAO9E,EAAUwE,CAAU,EAH9CpB,EAAoByB,EAAUC,CAAK,CAGW,CACxD,EAGKC,EAAkBX,OAAOY,KAAKzB,EAAU0B,kBAAoB,CAAA,CAAE,EAAE,CAAC,EACnET,IAAAA,GAAAA,YAAAA,EAAYlD,UAAW,UAAYyD,EAAiB,CACtD,MAAMG,EAAaR,EAAcS,KAAYC,GAAAA,EAAEvF,MAAQkF,CAAe,EAGtE,GAAI,CAACG,EACI,MAAA,CACL5D,OAAQ,QACRgD,MAAO,sBACPtC,QAAS,uBAAuB+C,CAAe,OAAOM,EAAAA,aAAaC,kBAAkBC,aAAa,GACpG,EAKEC,GAAAA,EAAmBN,CAAU,EACxB,MAAA,CACL5D,OAAQ,QACRgD,MAAO,0BACPtC,QAAS,uBAAuB+C,CAAe,OAAOM,EAAAA,aAAaI,sBAAsBF,aAAa,GACxG,EAKF,GAAI,CAACL,EAAWjC,WAAWP,WAAWpB,OAC7B,MAAA,CACLA,OAAQ,QACRgD,MAAO,2BACPtC,QAAS,uBAAuB+C,CAAe,OAAOM,EAAAA,aAAaK,uBAAuBH,aAAa,GACzG,CACF,CAGK,MAAA,CACLjE,OAAQ,KACRJ,OAAQwD,CACV,CACF,EAEac,EAAsBG,GACjC,OAAOA,GAAU,UACjBA,IAAU,MACV,eAAgBA,GACfA,EAA2BtC,aAAe"}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { checkStateIfThrottled as
|
|
2
|
-
import { useGuideContext as
|
|
3
|
-
import { FOCUS_ERRORS as
|
|
1
|
+
import { checkStateIfThrottled as b, checkActivatable as _ } from "@knocklabs/client";
|
|
2
|
+
import { useGuideContext as p, useStore as g } from "@knocklabs/react-core";
|
|
3
|
+
import { FOCUS_ERRORS as y } from "./helpers.mjs";
|
|
4
4
|
const v = (e) => e.reduce((t, s) => ({
|
|
5
5
|
...t,
|
|
6
6
|
[s.key]: s
|
|
7
7
|
}), {}), h = (e, t, s, r) => {
|
|
8
8
|
var u, a, n, l, o, d, c, f;
|
|
9
|
-
const i = !!((l = (n = (a = (u = r.
|
|
9
|
+
const i = !!((l = (n = (a = (u = r.byKey) == null ? void 0 : u.one) == null ? void 0 : a.metadata) == null ? void 0 : n.opts) != null && l.includeThrottled) || !!((f = (c = (d = (o = r.byKey) == null ? void 0 : o.all) == null ? void 0 : d.metadata) == null ? void 0 : c.opts) != null && f.includeThrottled);
|
|
10
10
|
return e.bypass_global_group_limit ? "returned" : e.key === s.resolved ? t.throttled && !i ? "throttled" : "returned" : "queried";
|
|
11
11
|
}, G = (e, t, s, r) => {
|
|
12
12
|
var a, n, l, o;
|
|
13
|
-
const i = !!((o = (l = (n = (a = r.
|
|
13
|
+
const i = !!((o = (l = (n = (a = r.byType) == null ? void 0 : a.one) == null ? void 0 : n.metadata) == null ? void 0 : l.opts) != null && o.includeThrottled), u = r.byType.one;
|
|
14
14
|
if (u.size === 0)
|
|
15
15
|
return "queried";
|
|
16
16
|
if (e.bypass_global_group_limit) {
|
|
@@ -20,33 +20,33 @@ const v = (e) => e.reduce((t, s) => ({
|
|
|
20
20
|
return e.key === s.resolved ? t.throttled && !i ? "throttled" : "returned" : "queried";
|
|
21
21
|
}, m = (e, t, s, r) => {
|
|
22
22
|
var o, d, c, f;
|
|
23
|
-
const i = r.
|
|
23
|
+
const i = r.byType.all;
|
|
24
24
|
if (i.size === 0)
|
|
25
25
|
return "queried";
|
|
26
26
|
const u = [...i.values()], a = u[0], n = v(u);
|
|
27
|
-
return (f = (c = (d = (o = r.
|
|
28
|
-
},
|
|
27
|
+
return (f = (c = (d = (o = r.byType) == null ? void 0 : o.all) == null ? void 0 : d.metadata) == null ? void 0 : c.opts) != null && f.includeThrottled ? n[e.key] ? "returned" : "queried" : (a.bypass_global_group_limit || a.key === s.resolved) && n[e.key] ? t.throttled ? e.bypass_global_group_limit ? "returned" : "throttled" : "returned" : "queried";
|
|
28
|
+
}, T = (e, t, s, r) => {
|
|
29
29
|
var i, u;
|
|
30
|
-
if (r.
|
|
30
|
+
if (r.byKey)
|
|
31
31
|
return h(e, t, s, r);
|
|
32
|
-
if ((i = r.
|
|
32
|
+
if ((i = r.byType) != null && i.all)
|
|
33
33
|
return m(e, t, s, r);
|
|
34
|
-
if ((u = r.
|
|
34
|
+
if ((u = r.byType) != null && u.one)
|
|
35
35
|
return G(e, t, s, r);
|
|
36
|
-
},
|
|
36
|
+
}, S = (e, t, s) => {
|
|
37
37
|
if (!s || s.status === "open")
|
|
38
38
|
return {
|
|
39
39
|
status: void 0
|
|
40
40
|
};
|
|
41
41
|
const r = {
|
|
42
|
-
|
|
43
|
-
|
|
42
|
+
byKey: (s.results.byKey || {})[e.key],
|
|
43
|
+
byType: (s.results.byType || {})[e.type]
|
|
44
44
|
};
|
|
45
|
-
if (!!!(r.
|
|
45
|
+
if (!!!(r.byKey || r.byType))
|
|
46
46
|
return {
|
|
47
47
|
status: void 0
|
|
48
48
|
};
|
|
49
|
-
const u =
|
|
49
|
+
const u = T(e, t, s, r);
|
|
50
50
|
return u ? {
|
|
51
51
|
status: u,
|
|
52
52
|
query: r
|
|
@@ -64,14 +64,14 @@ const v = (e) => e.reduce((t, s) => ({
|
|
|
64
64
|
}), (t == null ? void 0 : t.reason) === "guide_not_active" && (s.active = {
|
|
65
65
|
status: !1
|
|
66
66
|
}), s;
|
|
67
|
-
},
|
|
67
|
+
}, K = ({
|
|
68
68
|
active: e,
|
|
69
69
|
targetable: t,
|
|
70
70
|
archived: s
|
|
71
|
-
}) => !(!e.status || !t.status || s.status),
|
|
71
|
+
}) => !(!e.status || !t.status || s.status), q = ({
|
|
72
72
|
activatable: e,
|
|
73
73
|
selectable: t
|
|
74
|
-
}) => !(!e.status || !t.status),
|
|
74
|
+
}) => !(!e.status || !t.status), R = (e, t, s, r) => {
|
|
75
75
|
const {
|
|
76
76
|
ineligibleGuides: i,
|
|
77
77
|
location: u
|
|
@@ -88,20 +88,20 @@ const v = (e) => e.reduce((t, s) => ({
|
|
|
88
88
|
},
|
|
89
89
|
// isQualified:
|
|
90
90
|
activatable: {
|
|
91
|
-
status:
|
|
91
|
+
status: _(e, u)
|
|
92
92
|
},
|
|
93
|
-
selectable:
|
|
93
|
+
selectable: S(e, s, r)
|
|
94
94
|
}, o = {
|
|
95
95
|
...l,
|
|
96
|
-
isEligible:
|
|
97
|
-
isQualified:
|
|
96
|
+
isEligible: K(l),
|
|
97
|
+
isQualified: q(l)
|
|
98
98
|
};
|
|
99
99
|
return {
|
|
100
100
|
...e,
|
|
101
101
|
orderIndex: t,
|
|
102
102
|
annotation: o
|
|
103
103
|
};
|
|
104
|
-
},
|
|
104
|
+
}, w = (e, t) => ({
|
|
105
105
|
__typename: "UncommittedGuide",
|
|
106
106
|
key: e,
|
|
107
107
|
orderIndex: t,
|
|
@@ -117,12 +117,12 @@ const v = (e) => e.reduce((t, s) => ({
|
|
|
117
117
|
status: void 0
|
|
118
118
|
}
|
|
119
119
|
}
|
|
120
|
-
}),
|
|
120
|
+
}), O = (e) => {
|
|
121
121
|
var l;
|
|
122
122
|
const {
|
|
123
123
|
client: t
|
|
124
|
-
} =
|
|
125
|
-
const d =
|
|
124
|
+
} = p(), s = g(t.store, (o) => {
|
|
125
|
+
const d = b(o);
|
|
126
126
|
return {
|
|
127
127
|
location: o.location,
|
|
128
128
|
guides: o.guides,
|
|
@@ -152,7 +152,7 @@ const v = (e) => e.reduce((t, s) => ({
|
|
|
152
152
|
};
|
|
153
153
|
const u = t.getStage(), a = i.display_sequence.map((o, d) => {
|
|
154
154
|
const c = s.guides[o];
|
|
155
|
-
return c ?
|
|
155
|
+
return c ? R(c, d, s, u) : w(o, d);
|
|
156
156
|
}), n = Object.keys(e.focusedGuideKeys || {})[0];
|
|
157
157
|
if ((u == null ? void 0 : u.status) === "closed" && n) {
|
|
158
158
|
const o = a.find((d) => d.key === n);
|
|
@@ -160,29 +160,29 @@ const v = (e) => e.reduce((t, s) => ({
|
|
|
160
160
|
return {
|
|
161
161
|
status: "error",
|
|
162
162
|
error: "focus_unknown_guide",
|
|
163
|
-
message: `Unable to display \`${n}\`, ${
|
|
163
|
+
message: `Unable to display \`${n}\`, ${y.focusUnknownGuide.toLowerCase()}.`
|
|
164
164
|
};
|
|
165
|
-
if (
|
|
165
|
+
if (C(o))
|
|
166
166
|
return {
|
|
167
167
|
status: "error",
|
|
168
168
|
error: "focus_uncommitted_guide",
|
|
169
|
-
message: `Unable to display \`${n}\`, ${
|
|
169
|
+
message: `Unable to display \`${n}\`, ${y.focusUncommittedGuide.toLowerCase()}.`
|
|
170
170
|
};
|
|
171
171
|
if (!o.annotation.selectable.status)
|
|
172
172
|
return {
|
|
173
173
|
status: "error",
|
|
174
174
|
error: "focus_unselectable_guide",
|
|
175
|
-
message: `Unable to display \`${n}\`, ${
|
|
175
|
+
message: `Unable to display \`${n}\`, ${y.focusUnselectableGuide.toLowerCase()}.`
|
|
176
176
|
};
|
|
177
177
|
}
|
|
178
178
|
return {
|
|
179
179
|
status: "ok",
|
|
180
180
|
guides: a
|
|
181
181
|
};
|
|
182
|
-
},
|
|
182
|
+
}, C = (e) => typeof e == "object" && e !== null && "__typename" in e && e.__typename === "UncommittedGuide";
|
|
183
183
|
export {
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
184
|
+
C as isUncommittedGuide,
|
|
185
|
+
q as resolveIsQualified,
|
|
186
|
+
O as useInspectGuideClientStore
|
|
187
187
|
};
|
|
188
188
|
//# sourceMappingURL=useInspectGuideClientStore.mjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useInspectGuideClientStore.mjs","sources":["../../../../../../../src/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.ts"],"sourcesContent":["import {\n KnockGuide,\n KnockGuideClientGroupStage,\n KnockGuideClientStoreState,\n KnockGuideIneligibilityMarker,\n KnockGuideSelectionResult,\n type ToolbarV2RunConfig,\n checkActivatable,\n checkStateIfThrottled,\n} from \"@knocklabs/client\";\nimport { useGuideContext, useStore } from \"@knocklabs/react-core\";\n\nimport { FOCUS_ERRORS } from \"./helpers\";\n\nconst byKey = <T extends { key: string }>(items: T[]) => {\n return items.reduce((acc, item) => ({ ...acc, [item.key]: item }), {});\n};\n\n/**\n * This is the main module that will house core logic for the toolbar. It hooks\n * into the guide client state store, extracts relevant data for debugging, and\n * transforms it into easily consumable data for the toolbar - namely\n * \"annotating\" guides for its various statuses to display.\n */\n\n// Active: `true` status = good\ntype ActiveStatus = {\n status: boolean;\n};\n\n// Targetable: `true` status = good\ntype TargetableStatusTrue = {\n status: true;\n};\ntype TargetableStatusFalse = {\n status: false;\n reason: string;\n message: string;\n};\ntype TargetableStatus = TargetableStatusTrue | TargetableStatusFalse;\n\ntype ActivatableStatus = {\n status: boolean;\n};\n\n// Archived: `false` status = good\ntype ArchivedStatus = {\n status: boolean;\n};\n\n// Selectable:\n// - \"returned\": Queried and resolved to return the guide from useGuide(s).\n// - \"throttled\": Queried and resolved but being throttled, so not yet returned.\n// - \"queried\": Queried but not resolved, because there are other higher\n// priority guides that are ahead of this guide in the query result.\n// - undefined: Not reachable with any of the given queries and filters.\ntype SelectionResultByLimit = {\n one?: KnockGuideSelectionResult;\n all?: KnockGuideSelectionResult;\n};\ntype SelectionResultByQuery = {\n key?: SelectionResultByLimit;\n type?: SelectionResultByLimit;\n};\ntype SelectableStatusPresent = {\n status: \"returned\" | \"throttled\" | \"queried\";\n query: SelectionResultByQuery;\n};\ntype SelectableStatusAbsent = {\n status: undefined;\n};\ntype SelectableStatus = SelectableStatusPresent | SelectableStatusAbsent;\n\nexport type AnnotatedStatuses = {\n // Individual eligibility statuses:\n active: ActiveStatus;\n targetable: TargetableStatus;\n archived: ArchivedStatus;\n // Individual qualified statuses:\n activatable: ActivatableStatus;\n selectable: SelectableStatus;\n};\n\ntype GuideAnnotation = AnnotatedStatuses & {\n // Resolved eligibility based on active, targetable and archived statuses,\n // which are backend driven evaluation results that are exposed for debugging.\n isEligible: boolean;\n\n // Resolved display qualification based on an activatable status, which\n // informs \"when\" and \"where\" an eligible guide can be displayed to user.\n isQualified: boolean;\n};\n\nexport type AnnotatedGuide = KnockGuide & {\n orderIndex: number;\n annotation: GuideAnnotation;\n\n // Legacy fields, typed only to make tsc happy when we prune these out.\n activation_location_rules?: KnockGuide[\"activation_url_patterns\"];\n priority?: number;\n};\n\n// Exists and ordered in control but absent in switchboard (therefore not\n// included in the api response), which implies a newly created guide that has\n// never been published to switchboard.\nexport type UncommittedGuide = {\n __typename: \"UncommittedGuide\";\n orderIndex: number;\n key: KnockGuide[\"key\"];\n active: false;\n bypass_global_group_limit: false;\n annotation: {\n isEligible: false;\n isQualified: false;\n active: {\n status: false;\n };\n selectable: {\n status: undefined;\n };\n };\n};\n\nexport type InspectionResultOk = {\n status: \"ok\";\n guides: (AnnotatedGuide | UncommittedGuide)[];\n};\ntype InspectionResultError = {\n status: \"error\";\n error:\n | \"no_guides_fetched\"\n | \"no_guide_group\"\n | \"focus_unknown_guide\"\n | \"focus_uncommitted_guide\"\n | \"focus_unselectable_guide\";\n message: string;\n};\ntype InspectionResult = InspectionResultOk | InspectionResultError;\n\ntype StoreStateSnapshot = Pick<\n KnockGuideClientStoreState,\n | \"location\"\n | \"guides\"\n | \"guideGroups\"\n | \"ineligibleGuides\"\n | \"debug\"\n | \"counter\"\n | \"queries\"\n> & {\n throttled: boolean;\n};\n\nconst inferSelectByKeyReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const includeThrottled =\n !!query.key?.one?.metadata?.opts?.includeThrottled ||\n !!query.key?.all?.metadata?.opts?.includeThrottled;\n\n // If unthrottled, then it should always be returned.\n if (guide.bypass_global_group_limit) {\n return \"returned\";\n }\n\n // If resolved, expect this guide to be returned unless being throttled.\n if (guide.key === stage.resolved) {\n if (snapshot.throttled && !includeThrottled) {\n return \"throttled\";\n }\n return \"returned\";\n }\n\n // If queried but not resolved, it means this guide is being shadowed by\n // another guide with higher priority because throttled guides can be\n // displayed only one at a time.\n return \"queried\";\n};\n\nconst inferSelectOneByTypeReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const includeThrottled = !!query.type?.one?.metadata?.opts?.includeThrottled;\n\n const result = query.type!.one!;\n if (result.size === 0) {\n return \"queried\";\n }\n\n // There may be multiple unthrottled guides of the same type, being queried\n // by type to return a single guide, for example: useGuide({ type: \"card\" }).\n //\n // So it is possible for an unthrottled guide to be shadowed by another\n // unthrottled guide of the same type with higher priority, so we need to\n // look at the query result to determine its return status.\n if (guide.bypass_global_group_limit) {\n const guides = [...result.values()];\n const first = guides[0]!;\n\n if (guide.key !== first.key) {\n // Being shadowed by another guide with higher priority.\n return \"queried\";\n }\n return \"returned\";\n }\n\n // If resolved, expect this guide to be returned unless being throttled.\n if (guide.key === stage.resolved) {\n if (snapshot.throttled && !includeThrottled) {\n return \"throttled\";\n }\n return \"returned\";\n }\n\n // If queried but not resolved, it means this guide is being shadowed by\n // another guide with higher priority because throttled guides can be\n // displayed only one at a time.\n return \"queried\";\n};\n\nconst inferSelectAllByTypeReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const result = query.type!.all!;\n if (result.size === 0) {\n return \"queried\";\n }\n\n const guides = [...result.values()];\n const first = guides[0]!;\n\n // Might want to consider moving this up to do once.\n const guidesByKey: Record<KnockGuide[\"key\"], KnockGuide> = byKey(guides);\n\n // If includeThrottled given, then expect all selected guides to be returned.\n const includeThrottled = !!query.type?.all?.metadata?.opts?.includeThrottled;\n if (includeThrottled) {\n return guidesByKey[guide.key] ? \"returned\" : \"queried\";\n }\n\n // If the first selected guide is unthrottled or resolved, then we should\n // have at minimum one guide to return, and potentially more based on whether\n // we are throttling currently and which other guides are unthrottled.\n if (first.bypass_global_group_limit || first.key === stage.resolved) {\n if (!guidesByKey[guide.key]) {\n return \"queried\";\n }\n if (snapshot.throttled) {\n return guide.bypass_global_group_limit ? \"returned\" : \"throttled\";\n }\n return \"returned\";\n }\n\n return \"queried\";\n};\n\nconst inferSelectReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n) => {\n // Querying by key can only return up to a max of one guide, regardless of\n // useGuide or useGuides, and should take precedence in status designation.\n if (query.key) {\n return inferSelectByKeyReturnStatus(guide, snapshot, stage, query);\n }\n\n if (query.type?.all) {\n return inferSelectAllByTypeReturnStatus(guide, snapshot, stage, query);\n }\n if (query.type?.one) {\n return inferSelectOneByTypeReturnStatus(guide, snapshot, stage, query);\n }\n\n // Should not happen but just for completeness.\n return undefined;\n};\n\nconst toSelectableStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage | undefined,\n): SelectableStatus => {\n if (!stage || stage.status === \"open\") {\n return { status: undefined };\n }\n\n const query = {\n key: (stage.results.key || {})[guide.key],\n type: (stage.results.type || {})[guide.type],\n };\n\n const queried = Boolean(query.key || query.type);\n if (!queried) {\n // No present query in the current location can select this guide.\n return { status: undefined };\n }\n\n const status = inferSelectReturnStatus(guide, snapshot, stage, query);\n if (!status) {\n return { status: undefined };\n }\n\n return { status, query };\n};\n\nconst toIneligibilityStatus = (\n guide: KnockGuide,\n marker?: KnockGuideIneligibilityMarker,\n): Partial<AnnotatedStatuses> => {\n const statuses: Partial<AnnotatedStatuses> = {};\n\n if (\n marker?.reason === \"not_in_target_audience\" ||\n marker?.reason === \"target_conditions_not_met\"\n ) {\n statuses.targetable = {\n status: false,\n reason: marker.reason,\n message: marker.message,\n };\n }\n\n if (\n marker?.reason === \"marked_as_archived\" ||\n (guide.steps || []).every((s) => !!s.message.archived_at)\n ) {\n statuses.archived = {\n status: true,\n };\n }\n\n if (marker?.reason === \"guide_not_active\") {\n statuses.active = {\n status: false,\n };\n }\n\n return statuses;\n};\n\nconst resolveIsEligible = ({\n active,\n targetable,\n archived,\n}: AnnotatedStatuses) => {\n if (!active.status) return false;\n if (!targetable.status) return false;\n if (archived.status) return false;\n return true;\n};\n\nexport const resolveIsQualified = ({\n activatable,\n selectable,\n}: AnnotatedStatuses) => {\n if (!activatable.status) return false;\n if (!selectable.status) return false;\n return true;\n};\n\nconst annotateGuide = (\n guide: KnockGuide,\n orderIndex: number,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage | undefined,\n): AnnotatedGuide => {\n const { ineligibleGuides, location } = snapshot;\n const marker = ineligibleGuides[guide.key];\n const ineligiblity = toIneligibilityStatus(guide, marker);\n\n const statuses: AnnotatedStatuses = {\n // isEligible:\n active: ineligiblity?.active || { status: true },\n targetable: ineligiblity?.targetable || { status: true },\n archived: ineligiblity?.archived || { status: false },\n // isQualified:\n activatable: { status: checkActivatable(guide, location) },\n selectable: toSelectableStatus(guide, snapshot, stage),\n };\n\n const annotation: GuideAnnotation = {\n ...statuses,\n isEligible: resolveIsEligible(statuses),\n isQualified: resolveIsQualified(statuses),\n };\n\n return {\n ...guide,\n orderIndex,\n annotation,\n };\n};\n\nconst newUncommittedGuide = (key: KnockGuide[\"key\"], orderIndex: number) =>\n ({\n __typename: \"UncommittedGuide\",\n key,\n orderIndex,\n active: false,\n bypass_global_group_limit: false,\n annotation: {\n isEligible: false,\n isQualified: false,\n active: {\n status: false,\n },\n selectable: {\n status: undefined,\n },\n },\n }) as UncommittedGuide;\n\nexport const useInspectGuideClientStore = (\n runConfig: ToolbarV2RunConfig,\n): InspectionResult | undefined => {\n const { client } = useGuideContext();\n\n // Extract a snapshot of the client store state for debugging.\n const snapshot: StoreStateSnapshot = useStore(client.store, (state) => {\n const throttled = checkStateIfThrottled(state);\n\n return {\n location: state.location,\n guides: state.guides,\n guideGroups: state.guideGroups,\n ineligibleGuides: state.ineligibleGuides,\n debug: state.debug,\n counter: state.counter,\n queries: state.queries,\n throttled,\n };\n });\n\n // Not in debugging session, so noop.\n if (!snapshot.debug?.debugging) {\n return undefined;\n }\n\n // No recorded fetch requests, which implies an inflight request loading.\n const req = Object.entries(snapshot.queries)[0];\n if (!req || req[1].status === \"loading\") {\n return {\n status: \"error\",\n error: \"no_guides_fetched\",\n message: \"Loading...\",\n };\n }\n\n // Should always be a default group so this should never happen.\n const defaultGroup = snapshot.guideGroups[0];\n if (!defaultGroup) {\n return {\n status: \"error\",\n error: \"no_guide_group\",\n message: \"No guide group found\",\n };\n }\n\n const groupStage = client.getStage();\n\n // Annotate guides for various eligibility, activation and query statuses\n // that are useful for debugging purposes.\n const orderedGuides = defaultGroup.display_sequence.map((guideKey, index) => {\n const guide = snapshot.guides[guideKey];\n if (!guide) {\n return newUncommittedGuide(guideKey, index);\n }\n\n return annotateGuide(guide, index, snapshot, groupStage);\n });\n\n // Check if the focused guide actually exists and is selectable on the page.\n const focusedGuideKey = Object.keys(runConfig.focusedGuideKeys || {})[0];\n if (groupStage?.status === \"closed\" && focusedGuideKey) {\n const foundGuide = orderedGuides.find((g) => g.key === focusedGuideKey);\n\n // No such guide exists for the given focused guide key.\n if (!foundGuide) {\n return {\n status: \"error\",\n error: \"focus_unknown_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUnknownGuide.toLowerCase()}.`,\n };\n }\n\n // This guide exists but has never been committed and published, so it is\n // not present in the API response.\n if (isUncommittedGuide(foundGuide)) {\n return {\n status: \"error\",\n error: \"focus_uncommitted_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUncommittedGuide.toLowerCase()}.`,\n };\n }\n\n // This guide exists and is present in the response, but it is not queried\n // in the current page so it is impossible to force render this guide.\n if (!foundGuide.annotation.selectable.status) {\n return {\n status: \"error\",\n error: \"focus_unselectable_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUnselectableGuide.toLowerCase()}.`,\n };\n }\n }\n\n return {\n status: \"ok\",\n guides: orderedGuides,\n };\n};\n\nexport const isUncommittedGuide = (input: unknown): input is UncommittedGuide =>\n typeof input === \"object\" &&\n input !== null &&\n \"__typename\" in input &&\n (input as UncommittedGuide).__typename === \"UncommittedGuide\";\n"],"names":["byKey","items","reduce","acc","item","key","inferSelectByKeyReturnStatus","guide","snapshot","stage","query","includeThrottled","one","metadata","opts","all","bypass_global_group_limit","resolved","throttled","inferSelectOneByTypeReturnStatus","type","result","size","first","values","inferSelectAllByTypeReturnStatus","guides","guidesByKey","inferSelectReturnStatus","toSelectableStatus","status","undefined","results","Boolean","toIneligibilityStatus","marker","statuses","reason","targetable","message","steps","every","s","archived_at","archived","active","resolveIsEligible","resolveIsQualified","activatable","selectable","annotateGuide","orderIndex","ineligibleGuides","location","ineligiblity","checkActivatable","annotation","isEligible","isQualified","newUncommittedGuide","__typename","useInspectGuideClientStore","runConfig","client","useGuideContext","useStore","store","state","checkStateIfThrottled","guideGroups","debug","counter","queries","debugging","req","Object","entries","error","defaultGroup","groupStage","getStage","orderedGuides","display_sequence","map","guideKey","index","focusedGuideKey","keys","focusedGuideKeys","foundGuide","find","g","FOCUS_ERRORS","focusUnknownGuide","toLowerCase","isUncommittedGuide","focusUncommittedGuide","focusUnselectableGuide","input"],"mappings":";;;AAcA,MAAMA,IAAQ,CAA4BC,MACjCA,EAAMC,OAAO,CAACC,GAAKC,OAAU;AAAA,EAAE,GAAGD;AAAAA,EAAK,CAACC,EAAKC,GAAG,GAAGD;AAAK,IAAI,CAAA,CAAE,GAyIjEE,IAA+BA,CACnCC,GACAC,GACAC,GACAC,MACsC;;AACtC,QAAMC,IACJ,CAAC,GAACD,KAAAA,KAAAA,KAAAA,IAAAA,EAAML,QAANK,gBAAAA,EAAWE,QAAXF,gBAAAA,EAAgBG,aAAhBH,gBAAAA,EAA0BI,SAA1BJ,QAAAA,EAAgCC,qBAClC,CAAC,GAACD,KAAAA,KAAAA,KAAAA,IAAAA,EAAML,QAANK,gBAAAA,EAAWK,QAAXL,gBAAAA,EAAgBG,aAAhBH,gBAAAA,EAA0BI,SAA1BJ,QAAAA,EAAgCC;AAGpC,SAAIJ,EAAMS,4BACD,aAILT,EAAMF,QAAQI,EAAMQ,WAClBT,EAASU,aAAa,CAACP,IAClB,cAEF,aAMF;AACT,GAEMQ,IAAmCA,CACvCZ,GACAC,GACAC,GACAC,MACsC;;AACtC,QAAMC,IAAmB,CAAC,GAACD,KAAAA,KAAAA,KAAAA,IAAAA,EAAMU,SAANV,gBAAAA,EAAYE,QAAZF,gBAAAA,EAAiBG,aAAjBH,gBAAAA,EAA2BI,SAA3BJ,QAAAA,EAAiCC,mBAEtDU,IAASX,EAAMU,KAAMR;AACvBS,MAAAA,EAAOC,SAAS;AACX,WAAA;AAST,MAAIf,EAAMS,2BAA2B;AAE7BO,UAAAA,IADS,CAAC,GAAGF,EAAOG,QAAQ,EACb,CAAC;AAElBjB,WAAAA,EAAMF,QAAQkB,EAAMlB,MAEf,YAEF;AAAA,EAAA;AAILE,SAAAA,EAAMF,QAAQI,EAAMQ,WAClBT,EAASU,aAAa,CAACP,IAClB,cAEF,aAMF;AACT,GAEMc,IAAmCA,CACvClB,GACAC,GACAC,GACAC,MACsC;;AAChCW,QAAAA,IAASX,EAAMU,KAAML;AACvBM,MAAAA,EAAOC,SAAS;AACX,WAAA;AAGT,QAAMI,IAAS,CAAC,GAAGL,EAAOG,QAAQ,GAC5BD,IAAQG,EAAO,CAAC,GAGhBC,IAAqD3B,EAAM0B,CAAM;AAIvE,UAD2BhB,KAAAA,KAAAA,KAAAA,IAAAA,EAAMU,SAANV,gBAAAA,EAAYK,QAAZL,gBAAAA,EAAiBG,aAAjBH,gBAAAA,EAA2BI,SAA3BJ,QAAAA,EAAiCC,mBAEnDgB,EAAYpB,EAAMF,GAAG,IAAI,aAAa,aAM3CkB,EAAMP,6BAA6BO,EAAMlB,QAAQI,EAAMQ,aACpDU,EAAYpB,EAAMF,GAAG,IAGtBG,EAASU,YACJX,EAAMS,4BAA4B,aAAa,cAEjD,aAGF;AACT,GAEMY,IAA0BA,CAC9BrB,GACAC,GACAC,GACAC,MACG;;AAGH,MAAIA,EAAML;AACR,WAAOC,EAA6BC,GAAOC,GAAUC,GAAOC,CAAK;AAG/DA,OAAAA,IAAAA,EAAMU,SAANV,QAAAA,EAAYK;AACd,WAAOU,EAAiClB,GAAOC,GAAUC,GAAOC,CAAK;AAEnEA,OAAAA,IAAAA,EAAMU,SAANV,QAAAA,EAAYE;AACd,WAAOO,EAAiCZ,GAAOC,GAAUC,GAAOC,CAAK;AAKzE,GAEMmB,IAAqBA,CACzBtB,GACAC,GACAC,MACqB;AACrB,MAAI,CAACA,KAASA,EAAMqB,WAAW;AACtB,WAAA;AAAA,MAAEA,QAAQC;AAAAA,IAAU;AAG7B,QAAMrB,IAAQ;AAAA,IACZL,MAAMI,EAAMuB,QAAQ3B,OAAO,CAAC,GAAGE,EAAMF,GAAG;AAAA,IACxCe,OAAOX,EAAMuB,QAAQZ,QAAQ,CAAA,GAAIb,EAAMa,IAAI;AAAA,EAC7C;AAGA,MAAI,CADYa,GAAQvB,EAAML,OAAOK,EAAMU;AAGlC,WAAA;AAAA,MAAEU,QAAQC;AAAAA,IAAU;AAG7B,QAAMD,IAASF,EAAwBrB,GAAOC,GAAUC,GAAOC,CAAK;AACpE,SAAKoB,IAIE;AAAA,IAAEA,QAAAA;AAAAA,IAAQpB,OAAAA;AAAAA,EAAM,IAHd;AAAA,IAAEoB,QAAQC;AAAAA,EAAU;AAI/B,GAEMG,IAAwBA,CAC5B3B,GACA4B,MAC+B;AAC/B,QAAMC,IAAuC,CAAC;AAE9C,WACED,KAAAA,gBAAAA,EAAQE,YAAW,6BACnBF,KAAAA,gBAAAA,EAAQE,YAAW,iCAEnBD,EAASE,aAAa;AAAA,IACpBR,QAAQ;AAAA,IACRO,QAAQF,EAAOE;AAAAA,IACfE,SAASJ,EAAOI;AAAAA,EAClB,MAIAJ,KAAAA,gBAAAA,EAAQE,YAAW,yBAClB9B,EAAMiC,SAAS,CAAA,GAAIC,MAAOC,CAAAA,MAAM,CAAC,CAACA,EAAEH,QAAQI,WAAW,OAExDP,EAASQ,WAAW;AAAA,IAClBd,QAAQ;AAAA,EACV,KAGEK,KAAAA,gBAAAA,EAAQE,YAAW,uBACrBD,EAASS,SAAS;AAAA,IAChBf,QAAQ;AAAA,EACV,IAGKM;AACT,GAEMU,IAAoBA,CAAC;AAAA,EACzBD,QAAAA;AAAAA,EACAP,YAAAA;AAAAA,EACAM,UAAAA;AACiB,MACb,GAACC,EAAOf,UACR,CAACQ,EAAWR,UACZc,EAASd,SAIFiB,IAAqBA,CAAC;AAAA,EACjCC,aAAAA;AAAAA,EACAC,YAAAA;AACiB,MACb,GAACD,EAAYlB,UACb,CAACmB,EAAWnB,SAIZoB,IAAgBA,CACpB3C,GACA4C,GACA3C,GACAC,MACmB;AACb,QAAA;AAAA,IAAE2C,kBAAAA;AAAAA,IAAkBC,UAAAA;AAAAA,EAAAA,IAAa7C,GACjC2B,IAASiB,EAAiB7C,EAAMF,GAAG,GACnCiD,IAAepB,EAAsB3B,GAAO4B,CAAM,GAElDC,IAA8B;AAAA;AAAA,IAElCS,SAAQS,KAAAA,gBAAAA,EAAcT,WAAU;AAAA,MAAEf,QAAQ;AAAA,IAAK;AAAA,IAC/CQ,aAAYgB,KAAAA,gBAAAA,EAAchB,eAAc;AAAA,MAAER,QAAQ;AAAA,IAAK;AAAA,IACvDc,WAAUU,KAAAA,gBAAAA,EAAcV,aAAY;AAAA,MAAEd,QAAQ;AAAA,IAAM;AAAA;AAAA,IAEpDkB,aAAa;AAAA,MAAElB,QAAQyB,EAAiBhD,GAAO8C,CAAQ;AAAA,IAAE;AAAA,IACzDJ,YAAYpB,EAAmBtB,GAAOC,GAAUC,CAAK;AAAA,EACvD,GAEM+C,IAA8B;AAAA,IAClC,GAAGpB;AAAAA,IACHqB,YAAYX,EAAkBV,CAAQ;AAAA,IACtCsB,aAAaX,EAAmBX,CAAQ;AAAA,EAC1C;AAEO,SAAA;AAAA,IACL,GAAG7B;AAAAA,IACH4C,YAAAA;AAAAA,IACAK,YAAAA;AAAAA,EACF;AACF,GAEMG,IAAsBA,CAACtD,GAAwB8C,OAClD;AAAA,EACCS,YAAY;AAAA,EACZvD,KAAAA;AAAAA,EACA8C,YAAAA;AAAAA,EACAN,QAAQ;AAAA,EACR7B,2BAA2B;AAAA,EAC3BwC,YAAY;AAAA,IACVC,YAAY;AAAA,IACZC,aAAa;AAAA,IACbb,QAAQ;AAAA,MACNf,QAAQ;AAAA,IACV;AAAA,IACAmB,YAAY;AAAA,MACVnB,QAAQC;AAAAA,IAAAA;AAAAA,EACV;AAEJ,IAEW8B,IAA6BA,CACxCC,MACiC;;AAC3B,QAAA;AAAA,IAAEC,QAAAA;AAAAA,MAAWC,EAAgB,GAG7BxD,IAA+ByD,EAASF,EAAOG,OAAQC,CAAUA,MAAA;AAC/DjD,UAAAA,IAAYkD,EAAsBD,CAAK;AAEtC,WAAA;AAAA,MACLd,UAAUc,EAAMd;AAAAA,MAChB3B,QAAQyC,EAAMzC;AAAAA,MACd2C,aAAaF,EAAME;AAAAA,MACnBjB,kBAAkBe,EAAMf;AAAAA,MACxBkB,OAAOH,EAAMG;AAAAA,MACbC,SAASJ,EAAMI;AAAAA,MACfC,SAASL,EAAMK;AAAAA,MACftD,WAAAA;AAAAA,IACF;AAAA,EAAA,CACD;AAGG,MAAA,GAACV,IAAAA,EAAS8D,UAAT9D,QAAAA,EAAgBiE;AACZ1C;AAIT,QAAM2C,IAAMC,OAAOC,QAAQpE,EAASgE,OAAO,EAAE,CAAC;AAC9C,MAAI,CAACE,KAAOA,EAAI,CAAC,EAAE5C,WAAW;AACrB,WAAA;AAAA,MACLA,QAAQ;AAAA,MACR+C,OAAO;AAAA,MACPtC,SAAS;AAAA,IACX;AAIIuC,QAAAA,IAAetE,EAAS6D,YAAY,CAAC;AAC3C,MAAI,CAACS;AACI,WAAA;AAAA,MACLhD,QAAQ;AAAA,MACR+C,OAAO;AAAA,MACPtC,SAAS;AAAA,IACX;AAGIwC,QAAAA,IAAahB,EAAOiB,SAAS,GAI7BC,IAAgBH,EAAaI,iBAAiBC,IAAI,CAACC,GAAUC,MAAU;AACrE9E,UAAAA,IAAQC,EAASkB,OAAO0D,CAAQ;AACtC,WAAK7E,IAIE2C,EAAc3C,GAAO8E,GAAO7E,GAAUuE,CAAU,IAH9CpB,EAAoByB,GAAUC,CAAK;AAAA,EAGW,CACxD,GAGKC,IAAkBX,OAAOY,KAAKzB,EAAU0B,oBAAoB,CAAA,CAAE,EAAE,CAAC;AACnET,OAAAA,KAAAA,gBAAAA,EAAYjD,YAAW,YAAYwD,GAAiB;AACtD,UAAMG,IAAaR,EAAcS,KAAMC,CAAMA,MAAAA,EAAEtF,QAAQiF,CAAe;AAGtE,QAAI,CAACG;AACI,aAAA;AAAA,QACL3D,QAAQ;AAAA,QACR+C,OAAO;AAAA,QACPtC,SAAS,uBAAuB+C,CAAe,OAAOM,EAAaC,kBAAkBC,aAAa;AAAA,MACpG;AAKEC,QAAAA,EAAmBN,CAAU;AACxB,aAAA;AAAA,QACL3D,QAAQ;AAAA,QACR+C,OAAO;AAAA,QACPtC,SAAS,uBAAuB+C,CAAe,OAAOM,EAAaI,sBAAsBF,aAAa;AAAA,MACxG;AAKF,QAAI,CAACL,EAAWjC,WAAWP,WAAWnB;AAC7B,aAAA;AAAA,QACLA,QAAQ;AAAA,QACR+C,OAAO;AAAA,QACPtC,SAAS,uBAAuB+C,CAAe,OAAOM,EAAaK,uBAAuBH,aAAa;AAAA,MACzG;AAAA,EACF;AAGK,SAAA;AAAA,IACLhE,QAAQ;AAAA,IACRJ,QAAQuD;AAAAA,EACV;AACF,GAEac,IAAqBA,CAACG,MACjC,OAAOA,KAAU,YACjBA,MAAU,QACV,gBAAgBA,KACfA,EAA2BtC,eAAe;"}
|
|
1
|
+
{"version":3,"file":"useInspectGuideClientStore.mjs","sources":["../../../../../../../src/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.ts"],"sourcesContent":["import {\n KnockGuide,\n KnockGuideClientGroupStage,\n KnockGuideClientStoreState,\n KnockGuideIneligibilityMarker,\n KnockGuideSelectionResult,\n type ToolbarV2RunConfig,\n checkActivatable,\n checkStateIfThrottled,\n} from \"@knocklabs/client\";\nimport { useGuideContext, useStore } from \"@knocklabs/react-core\";\n\nimport { FOCUS_ERRORS } from \"./helpers\";\n\nconst byKey = <T extends { key: string }>(items: T[]) => {\n return items.reduce((acc, item) => ({ ...acc, [item.key]: item }), {});\n};\n\n/**\n * This is the main module that will house core logic for the toolbar. It hooks\n * into the guide client state store, extracts relevant data for debugging, and\n * transforms it into easily consumable data for the toolbar - namely\n * \"annotating\" guides for its various statuses to display.\n */\n\n// Active: `true` status = good\ntype ActiveStatus = {\n status: boolean;\n};\n\n// Targetable: `true` status = good\ntype TargetableStatusTrue = {\n status: true;\n};\ntype TargetableStatusFalse = {\n status: false;\n reason: string;\n message: string;\n};\ntype TargetableStatus = TargetableStatusTrue | TargetableStatusFalse;\n\ntype ActivatableStatus = {\n status: boolean;\n};\n\n// Archived: `false` status = good\ntype ArchivedStatus = {\n status: boolean;\n};\n\n// Selectable:\n// - \"returned\": Queried and resolved to return the guide from useGuide(s).\n// - \"throttled\": Queried and resolved but being throttled, so not yet returned.\n// - \"queried\": Queried but not resolved, because there are other higher\n// priority guides that are ahead of this guide in the query result.\n// - undefined: Not reachable with any of the given queries and filters.\ntype SelectionResultByLimit = {\n one?: KnockGuideSelectionResult;\n all?: KnockGuideSelectionResult;\n};\ntype SelectionResultByQuery = {\n byKey?: SelectionResultByLimit;\n byType?: SelectionResultByLimit;\n};\ntype SelectableStatusPresent = {\n status: \"returned\" | \"throttled\" | \"queried\";\n query: SelectionResultByQuery;\n};\ntype SelectableStatusAbsent = {\n status: undefined;\n};\ntype SelectableStatus = SelectableStatusPresent | SelectableStatusAbsent;\n\nexport type AnnotatedStatuses = {\n // Individual eligibility statuses:\n active: ActiveStatus;\n targetable: TargetableStatus;\n archived: ArchivedStatus;\n // Individual qualified statuses:\n activatable: ActivatableStatus;\n selectable: SelectableStatus;\n};\n\ntype GuideAnnotation = AnnotatedStatuses & {\n // Resolved eligibility based on active, targetable and archived statuses,\n // which are backend driven evaluation results that are exposed for debugging.\n isEligible: boolean;\n\n // Resolved display qualification based on an activatable status, which\n // informs \"when\" and \"where\" an eligible guide can be displayed to user.\n isQualified: boolean;\n};\n\nexport type AnnotatedGuide = KnockGuide & {\n orderIndex: number;\n annotation: GuideAnnotation;\n\n // Legacy fields, typed only to make tsc happy when we prune these out.\n activation_location_rules?: KnockGuide[\"activation_url_patterns\"];\n priority?: number;\n};\n\n// Exists and ordered in control but absent in switchboard (therefore not\n// included in the api response), which implies a newly created guide that has\n// never been published to switchboard.\nexport type UncommittedGuide = {\n __typename: \"UncommittedGuide\";\n orderIndex: number;\n key: KnockGuide[\"key\"];\n active: false;\n bypass_global_group_limit: false;\n annotation: {\n isEligible: false;\n isQualified: false;\n active: {\n status: false;\n };\n selectable: {\n status: undefined;\n };\n };\n};\n\nexport type InspectionResultOk = {\n status: \"ok\";\n guides: (AnnotatedGuide | UncommittedGuide)[];\n};\ntype InspectionResultError = {\n status: \"error\";\n error:\n | \"no_guides_fetched\"\n | \"no_guide_group\"\n | \"focus_unknown_guide\"\n | \"focus_uncommitted_guide\"\n | \"focus_unselectable_guide\";\n message: string;\n};\ntype InspectionResult = InspectionResultOk | InspectionResultError;\n\ntype StoreStateSnapshot = Pick<\n KnockGuideClientStoreState,\n | \"location\"\n | \"guides\"\n | \"guideGroups\"\n | \"ineligibleGuides\"\n | \"debug\"\n | \"counter\"\n | \"queries\"\n> & {\n throttled: boolean;\n};\n\nconst inferSelectByKeyReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const includeThrottled =\n !!query.byKey?.one?.metadata?.opts?.includeThrottled ||\n !!query.byKey?.all?.metadata?.opts?.includeThrottled;\n\n // If unthrottled, then it should always be returned.\n if (guide.bypass_global_group_limit) {\n return \"returned\";\n }\n\n // If resolved, expect this guide to be returned unless being throttled.\n if (guide.key === stage.resolved) {\n if (snapshot.throttled && !includeThrottled) {\n return \"throttled\";\n }\n return \"returned\";\n }\n\n // If queried but not resolved, it means this guide is being shadowed by\n // another guide with higher priority because throttled guides can be\n // displayed only one at a time.\n return \"queried\";\n};\n\nconst inferSelectOneByTypeReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const includeThrottled =\n !!query.byType?.one?.metadata?.opts?.includeThrottled;\n\n const result = query.byType!.one!;\n if (result.size === 0) {\n return \"queried\";\n }\n\n // There may be multiple unthrottled guides of the same type, being queried\n // by type to return a single guide, for example: useGuide({ type: \"card\" }).\n //\n // So it is possible for an unthrottled guide to be shadowed by another\n // unthrottled guide of the same type with higher priority, so we need to\n // look at the query result to determine its return status.\n if (guide.bypass_global_group_limit) {\n const guides = [...result.values()];\n const first = guides[0]!;\n\n if (guide.key !== first.key) {\n // Being shadowed by another guide with higher priority.\n return \"queried\";\n }\n return \"returned\";\n }\n\n // If resolved, expect this guide to be returned unless being throttled.\n if (guide.key === stage.resolved) {\n if (snapshot.throttled && !includeThrottled) {\n return \"throttled\";\n }\n return \"returned\";\n }\n\n // If queried but not resolved, it means this guide is being shadowed by\n // another guide with higher priority because throttled guides can be\n // displayed only one at a time.\n return \"queried\";\n};\n\nconst inferSelectAllByTypeReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n): SelectableStatusPresent[\"status\"] => {\n const result = query.byType!.all!;\n if (result.size === 0) {\n return \"queried\";\n }\n\n const guides = [...result.values()];\n const first = guides[0]!;\n\n // Might want to consider moving this up to do once.\n const guidesByKey: Record<KnockGuide[\"key\"], KnockGuide> = byKey(guides);\n\n // If includeThrottled given, then expect all selected guides to be returned.\n const includeThrottled =\n !!query.byType?.all?.metadata?.opts?.includeThrottled;\n if (includeThrottled) {\n return guidesByKey[guide.key] ? \"returned\" : \"queried\";\n }\n\n // If the first selected guide is unthrottled or resolved, then we should\n // have at minimum one guide to return, and potentially more based on whether\n // we are throttling currently and which other guides are unthrottled.\n if (first.bypass_global_group_limit || first.key === stage.resolved) {\n if (!guidesByKey[guide.key]) {\n return \"queried\";\n }\n if (snapshot.throttled) {\n return guide.bypass_global_group_limit ? \"returned\" : \"throttled\";\n }\n return \"returned\";\n }\n\n return \"queried\";\n};\n\nconst inferSelectReturnStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage,\n query: SelectionResultByQuery,\n) => {\n // Querying by key can only return up to a max of one guide, regardless of\n // useGuide or useGuides, and should take precedence in status designation.\n if (query.byKey) {\n return inferSelectByKeyReturnStatus(guide, snapshot, stage, query);\n }\n\n if (query.byType?.all) {\n return inferSelectAllByTypeReturnStatus(guide, snapshot, stage, query);\n }\n if (query.byType?.one) {\n return inferSelectOneByTypeReturnStatus(guide, snapshot, stage, query);\n }\n\n // Should not happen but just for completeness.\n return undefined;\n};\n\nconst toSelectableStatus = (\n guide: KnockGuide,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage | undefined,\n): SelectableStatus => {\n if (!stage || stage.status === \"open\") {\n return { status: undefined };\n }\n\n const query = {\n byKey: (stage.results.byKey || {})[guide.key],\n byType: (stage.results.byType || {})[guide.type],\n };\n\n const queried = Boolean(query.byKey || query.byType);\n if (!queried) {\n // No present query in the current location can select this guide.\n return { status: undefined };\n }\n\n const status = inferSelectReturnStatus(guide, snapshot, stage, query);\n if (!status) {\n return { status: undefined };\n }\n\n return { status, query };\n};\n\nconst toIneligibilityStatus = (\n guide: KnockGuide,\n marker?: KnockGuideIneligibilityMarker,\n): Partial<AnnotatedStatuses> => {\n const statuses: Partial<AnnotatedStatuses> = {};\n\n if (\n marker?.reason === \"not_in_target_audience\" ||\n marker?.reason === \"target_conditions_not_met\"\n ) {\n statuses.targetable = {\n status: false,\n reason: marker.reason,\n message: marker.message,\n };\n }\n\n if (\n marker?.reason === \"marked_as_archived\" ||\n (guide.steps || []).every((s) => !!s.message.archived_at)\n ) {\n statuses.archived = {\n status: true,\n };\n }\n\n if (marker?.reason === \"guide_not_active\") {\n statuses.active = {\n status: false,\n };\n }\n\n return statuses;\n};\n\nconst resolveIsEligible = ({\n active,\n targetable,\n archived,\n}: AnnotatedStatuses) => {\n if (!active.status) return false;\n if (!targetable.status) return false;\n if (archived.status) return false;\n return true;\n};\n\nexport const resolveIsQualified = ({\n activatable,\n selectable,\n}: AnnotatedStatuses) => {\n if (!activatable.status) return false;\n if (!selectable.status) return false;\n return true;\n};\n\nconst annotateGuide = (\n guide: KnockGuide,\n orderIndex: number,\n snapshot: StoreStateSnapshot,\n stage: KnockGuideClientGroupStage | undefined,\n): AnnotatedGuide => {\n const { ineligibleGuides, location } = snapshot;\n const marker = ineligibleGuides[guide.key];\n const ineligiblity = toIneligibilityStatus(guide, marker);\n\n const statuses: AnnotatedStatuses = {\n // isEligible:\n active: ineligiblity?.active || { status: true },\n targetable: ineligiblity?.targetable || { status: true },\n archived: ineligiblity?.archived || { status: false },\n // isQualified:\n activatable: { status: checkActivatable(guide, location) },\n selectable: toSelectableStatus(guide, snapshot, stage),\n };\n\n const annotation: GuideAnnotation = {\n ...statuses,\n isEligible: resolveIsEligible(statuses),\n isQualified: resolveIsQualified(statuses),\n };\n\n return {\n ...guide,\n orderIndex,\n annotation,\n };\n};\n\nconst newUncommittedGuide = (key: KnockGuide[\"key\"], orderIndex: number) =>\n ({\n __typename: \"UncommittedGuide\",\n key,\n orderIndex,\n active: false,\n bypass_global_group_limit: false,\n annotation: {\n isEligible: false,\n isQualified: false,\n active: {\n status: false,\n },\n selectable: {\n status: undefined,\n },\n },\n }) as UncommittedGuide;\n\nexport const useInspectGuideClientStore = (\n runConfig: ToolbarV2RunConfig,\n): InspectionResult | undefined => {\n const { client } = useGuideContext();\n\n // Extract a snapshot of the client store state for debugging.\n const snapshot: StoreStateSnapshot = useStore(client.store, (state) => {\n const throttled = checkStateIfThrottled(state);\n\n return {\n location: state.location,\n guides: state.guides,\n guideGroups: state.guideGroups,\n ineligibleGuides: state.ineligibleGuides,\n debug: state.debug,\n counter: state.counter,\n queries: state.queries,\n throttled,\n };\n });\n\n // Not in debugging session, so noop.\n if (!snapshot.debug?.debugging) {\n return undefined;\n }\n\n // No recorded fetch requests, which implies an inflight request loading.\n const req = Object.entries(snapshot.queries)[0];\n if (!req || req[1].status === \"loading\") {\n return {\n status: \"error\",\n error: \"no_guides_fetched\",\n message: \"Loading...\",\n };\n }\n\n // Should always be a default group so this should never happen.\n const defaultGroup = snapshot.guideGroups[0];\n if (!defaultGroup) {\n return {\n status: \"error\",\n error: \"no_guide_group\",\n message: \"No guide group found\",\n };\n }\n\n const groupStage = client.getStage();\n\n // Annotate guides for various eligibility, activation and query statuses\n // that are useful for debugging purposes.\n const orderedGuides = defaultGroup.display_sequence.map((guideKey, index) => {\n const guide = snapshot.guides[guideKey];\n if (!guide) {\n return newUncommittedGuide(guideKey, index);\n }\n\n return annotateGuide(guide, index, snapshot, groupStage);\n });\n\n // Check if the focused guide actually exists and is selectable on the page.\n const focusedGuideKey = Object.keys(runConfig.focusedGuideKeys || {})[0];\n if (groupStage?.status === \"closed\" && focusedGuideKey) {\n const foundGuide = orderedGuides.find((g) => g.key === focusedGuideKey);\n\n // No such guide exists for the given focused guide key.\n if (!foundGuide) {\n return {\n status: \"error\",\n error: \"focus_unknown_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUnknownGuide.toLowerCase()}.`,\n };\n }\n\n // This guide exists but has never been committed and published, so it is\n // not present in the API response.\n if (isUncommittedGuide(foundGuide)) {\n return {\n status: \"error\",\n error: \"focus_uncommitted_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUncommittedGuide.toLowerCase()}.`,\n };\n }\n\n // This guide exists and is present in the response, but it is not queried\n // in the current page so it is impossible to force render this guide.\n if (!foundGuide.annotation.selectable.status) {\n return {\n status: \"error\",\n error: \"focus_unselectable_guide\",\n message: `Unable to display \\`${focusedGuideKey}\\`, ${FOCUS_ERRORS.focusUnselectableGuide.toLowerCase()}.`,\n };\n }\n }\n\n return {\n status: \"ok\",\n guides: orderedGuides,\n };\n};\n\nexport const isUncommittedGuide = (input: unknown): input is UncommittedGuide =>\n typeof input === \"object\" &&\n input !== null &&\n \"__typename\" in input &&\n (input as UncommittedGuide).__typename === \"UncommittedGuide\";\n"],"names":["byKey","items","reduce","acc","item","key","inferSelectByKeyReturnStatus","guide","snapshot","stage","query","includeThrottled","one","metadata","opts","all","bypass_global_group_limit","resolved","throttled","inferSelectOneByTypeReturnStatus","byType","result","size","first","values","inferSelectAllByTypeReturnStatus","guides","guidesByKey","inferSelectReturnStatus","toSelectableStatus","status","undefined","results","type","Boolean","toIneligibilityStatus","marker","statuses","reason","targetable","message","steps","every","s","archived_at","archived","active","resolveIsEligible","resolveIsQualified","activatable","selectable","annotateGuide","orderIndex","ineligibleGuides","location","ineligiblity","checkActivatable","annotation","isEligible","isQualified","newUncommittedGuide","__typename","useInspectGuideClientStore","runConfig","client","useGuideContext","useStore","store","state","checkStateIfThrottled","guideGroups","debug","counter","queries","debugging","req","Object","entries","error","defaultGroup","groupStage","getStage","orderedGuides","display_sequence","map","guideKey","index","focusedGuideKey","keys","focusedGuideKeys","foundGuide","find","g","FOCUS_ERRORS","focusUnknownGuide","toLowerCase","isUncommittedGuide","focusUncommittedGuide","focusUnselectableGuide","input"],"mappings":";;;AAcA,MAAMA,IAAQ,CAA4BC,MACjCA,EAAMC,OAAO,CAACC,GAAKC,OAAU;AAAA,EAAE,GAAGD;AAAAA,EAAK,CAACC,EAAKC,GAAG,GAAGD;AAAK,IAAI,CAAA,CAAE,GAyIjEE,IAA+BA,CACnCC,GACAC,GACAC,GACAC,MACsC;;AACtC,QAAMC,IACJ,CAAC,GAACD,KAAAA,KAAAA,KAAAA,IAAAA,EAAMV,UAANU,gBAAAA,EAAaE,QAAbF,gBAAAA,EAAkBG,aAAlBH,gBAAAA,EAA4BI,SAA5BJ,QAAAA,EAAkCC,qBACpC,CAAC,GAACD,KAAAA,KAAAA,KAAAA,IAAAA,EAAMV,UAANU,gBAAAA,EAAaK,QAAbL,gBAAAA,EAAkBG,aAAlBH,gBAAAA,EAA4BI,SAA5BJ,QAAAA,EAAkCC;AAGtC,SAAIJ,EAAMS,4BACD,aAILT,EAAMF,QAAQI,EAAMQ,WAClBT,EAASU,aAAa,CAACP,IAClB,cAEF,aAMF;AACT,GAEMQ,IAAmCA,CACvCZ,GACAC,GACAC,GACAC,MACsC;;AACtC,QAAMC,IACJ,CAAC,GAACD,KAAAA,KAAAA,KAAAA,IAAAA,EAAMU,WAANV,gBAAAA,EAAcE,QAAdF,gBAAAA,EAAmBG,aAAnBH,gBAAAA,EAA6BI,SAA7BJ,QAAAA,EAAmCC,mBAEjCU,IAASX,EAAMU,OAAQR;AACzBS,MAAAA,EAAOC,SAAS;AACX,WAAA;AAST,MAAIf,EAAMS,2BAA2B;AAE7BO,UAAAA,IADS,CAAC,GAAGF,EAAOG,QAAQ,EACb,CAAC;AAElBjB,WAAAA,EAAMF,QAAQkB,EAAMlB,MAEf,YAEF;AAAA,EAAA;AAILE,SAAAA,EAAMF,QAAQI,EAAMQ,WAClBT,EAASU,aAAa,CAACP,IAClB,cAEF,aAMF;AACT,GAEMc,IAAmCA,CACvClB,GACAC,GACAC,GACAC,MACsC;;AAChCW,QAAAA,IAASX,EAAMU,OAAQL;AACzBM,MAAAA,EAAOC,SAAS;AACX,WAAA;AAGT,QAAMI,IAAS,CAAC,GAAGL,EAAOG,QAAQ,GAC5BD,IAAQG,EAAO,CAAC,GAGhBC,IAAqD3B,EAAM0B,CAAM;AAKvE,UADIhB,KAAAA,KAAAA,KAAAA,IAAAA,EAAMU,WAANV,gBAAAA,EAAcK,QAAdL,gBAAAA,EAAmBG,aAAnBH,gBAAAA,EAA6BI,SAA7BJ,QAAAA,EAAmCC,mBAE9BgB,EAAYpB,EAAMF,GAAG,IAAI,aAAa,aAM3CkB,EAAMP,6BAA6BO,EAAMlB,QAAQI,EAAMQ,aACpDU,EAAYpB,EAAMF,GAAG,IAGtBG,EAASU,YACJX,EAAMS,4BAA4B,aAAa,cAEjD,aAGF;AACT,GAEMY,IAA0BA,CAC9BrB,GACAC,GACAC,GACAC,MACG;;AAGH,MAAIA,EAAMV;AACR,WAAOM,EAA6BC,GAAOC,GAAUC,GAAOC,CAAK;AAG/DA,OAAAA,IAAAA,EAAMU,WAANV,QAAAA,EAAcK;AAChB,WAAOU,EAAiClB,GAAOC,GAAUC,GAAOC,CAAK;AAEnEA,OAAAA,IAAAA,EAAMU,WAANV,QAAAA,EAAcE;AAChB,WAAOO,EAAiCZ,GAAOC,GAAUC,GAAOC,CAAK;AAKzE,GAEMmB,IAAqBA,CACzBtB,GACAC,GACAC,MACqB;AACrB,MAAI,CAACA,KAASA,EAAMqB,WAAW;AACtB,WAAA;AAAA,MAAEA,QAAQC;AAAAA,IAAU;AAG7B,QAAMrB,IAAQ;AAAA,IACZV,QAAQS,EAAMuB,QAAQhC,SAAS,CAAC,GAAGO,EAAMF,GAAG;AAAA,IAC5Ce,SAASX,EAAMuB,QAAQZ,UAAU,CAAA,GAAIb,EAAM0B,IAAI;AAAA,EACjD;AAGA,MAAI,CADYC,GAAQxB,EAAMV,SAASU,EAAMU;AAGpC,WAAA;AAAA,MAAEU,QAAQC;AAAAA,IAAU;AAG7B,QAAMD,IAASF,EAAwBrB,GAAOC,GAAUC,GAAOC,CAAK;AACpE,SAAKoB,IAIE;AAAA,IAAEA,QAAAA;AAAAA,IAAQpB,OAAAA;AAAAA,EAAM,IAHd;AAAA,IAAEoB,QAAQC;AAAAA,EAAU;AAI/B,GAEMI,IAAwBA,CAC5B5B,GACA6B,MAC+B;AAC/B,QAAMC,IAAuC,CAAC;AAE9C,WACED,KAAAA,gBAAAA,EAAQE,YAAW,6BACnBF,KAAAA,gBAAAA,EAAQE,YAAW,iCAEnBD,EAASE,aAAa;AAAA,IACpBT,QAAQ;AAAA,IACRQ,QAAQF,EAAOE;AAAAA,IACfE,SAASJ,EAAOI;AAAAA,EAClB,MAIAJ,KAAAA,gBAAAA,EAAQE,YAAW,yBAClB/B,EAAMkC,SAAS,CAAA,GAAIC,MAAOC,CAAAA,MAAM,CAAC,CAACA,EAAEH,QAAQI,WAAW,OAExDP,EAASQ,WAAW;AAAA,IAClBf,QAAQ;AAAA,EACV,KAGEM,KAAAA,gBAAAA,EAAQE,YAAW,uBACrBD,EAASS,SAAS;AAAA,IAChBhB,QAAQ;AAAA,EACV,IAGKO;AACT,GAEMU,IAAoBA,CAAC;AAAA,EACzBD,QAAAA;AAAAA,EACAP,YAAAA;AAAAA,EACAM,UAAAA;AACiB,MACb,GAACC,EAAOhB,UACR,CAACS,EAAWT,UACZe,EAASf,SAIFkB,IAAqBA,CAAC;AAAA,EACjCC,aAAAA;AAAAA,EACAC,YAAAA;AACiB,MACb,GAACD,EAAYnB,UACb,CAACoB,EAAWpB,SAIZqB,IAAgBA,CACpB5C,GACA6C,GACA5C,GACAC,MACmB;AACb,QAAA;AAAA,IAAE4C,kBAAAA;AAAAA,IAAkBC,UAAAA;AAAAA,EAAAA,IAAa9C,GACjC4B,IAASiB,EAAiB9C,EAAMF,GAAG,GACnCkD,IAAepB,EAAsB5B,GAAO6B,CAAM,GAElDC,IAA8B;AAAA;AAAA,IAElCS,SAAQS,KAAAA,gBAAAA,EAAcT,WAAU;AAAA,MAAEhB,QAAQ;AAAA,IAAK;AAAA,IAC/CS,aAAYgB,KAAAA,gBAAAA,EAAchB,eAAc;AAAA,MAAET,QAAQ;AAAA,IAAK;AAAA,IACvDe,WAAUU,KAAAA,gBAAAA,EAAcV,aAAY;AAAA,MAAEf,QAAQ;AAAA,IAAM;AAAA;AAAA,IAEpDmB,aAAa;AAAA,MAAEnB,QAAQ0B,EAAiBjD,GAAO+C,CAAQ;AAAA,IAAE;AAAA,IACzDJ,YAAYrB,EAAmBtB,GAAOC,GAAUC,CAAK;AAAA,EACvD,GAEMgD,IAA8B;AAAA,IAClC,GAAGpB;AAAAA,IACHqB,YAAYX,EAAkBV,CAAQ;AAAA,IACtCsB,aAAaX,EAAmBX,CAAQ;AAAA,EAC1C;AAEO,SAAA;AAAA,IACL,GAAG9B;AAAAA,IACH6C,YAAAA;AAAAA,IACAK,YAAAA;AAAAA,EACF;AACF,GAEMG,IAAsBA,CAACvD,GAAwB+C,OAClD;AAAA,EACCS,YAAY;AAAA,EACZxD,KAAAA;AAAAA,EACA+C,YAAAA;AAAAA,EACAN,QAAQ;AAAA,EACR9B,2BAA2B;AAAA,EAC3ByC,YAAY;AAAA,IACVC,YAAY;AAAA,IACZC,aAAa;AAAA,IACbb,QAAQ;AAAA,MACNhB,QAAQ;AAAA,IACV;AAAA,IACAoB,YAAY;AAAA,MACVpB,QAAQC;AAAAA,IAAAA;AAAAA,EACV;AAEJ,IAEW+B,IAA6BA,CACxCC,MACiC;;AAC3B,QAAA;AAAA,IAAEC,QAAAA;AAAAA,MAAWC,EAAgB,GAG7BzD,IAA+B0D,EAASF,EAAOG,OAAQC,CAAUA,MAAA;AAC/DlD,UAAAA,IAAYmD,EAAsBD,CAAK;AAEtC,WAAA;AAAA,MACLd,UAAUc,EAAMd;AAAAA,MAChB5B,QAAQ0C,EAAM1C;AAAAA,MACd4C,aAAaF,EAAME;AAAAA,MACnBjB,kBAAkBe,EAAMf;AAAAA,MACxBkB,OAAOH,EAAMG;AAAAA,MACbC,SAASJ,EAAMI;AAAAA,MACfC,SAASL,EAAMK;AAAAA,MACfvD,WAAAA;AAAAA,IACF;AAAA,EAAA,CACD;AAGG,MAAA,GAACV,IAAAA,EAAS+D,UAAT/D,QAAAA,EAAgBkE;AACZ3C;AAIT,QAAM4C,IAAMC,OAAOC,QAAQrE,EAASiE,OAAO,EAAE,CAAC;AAC9C,MAAI,CAACE,KAAOA,EAAI,CAAC,EAAE7C,WAAW;AACrB,WAAA;AAAA,MACLA,QAAQ;AAAA,MACRgD,OAAO;AAAA,MACPtC,SAAS;AAAA,IACX;AAIIuC,QAAAA,IAAevE,EAAS8D,YAAY,CAAC;AAC3C,MAAI,CAACS;AACI,WAAA;AAAA,MACLjD,QAAQ;AAAA,MACRgD,OAAO;AAAA,MACPtC,SAAS;AAAA,IACX;AAGIwC,QAAAA,IAAahB,EAAOiB,SAAS,GAI7BC,IAAgBH,EAAaI,iBAAiBC,IAAI,CAACC,GAAUC,MAAU;AACrE/E,UAAAA,IAAQC,EAASkB,OAAO2D,CAAQ;AACtC,WAAK9E,IAIE4C,EAAc5C,GAAO+E,GAAO9E,GAAUwE,CAAU,IAH9CpB,EAAoByB,GAAUC,CAAK;AAAA,EAGW,CACxD,GAGKC,IAAkBX,OAAOY,KAAKzB,EAAU0B,oBAAoB,CAAA,CAAE,EAAE,CAAC;AACnET,OAAAA,KAAAA,gBAAAA,EAAYlD,YAAW,YAAYyD,GAAiB;AACtD,UAAMG,IAAaR,EAAcS,KAAMC,CAAMA,MAAAA,EAAEvF,QAAQkF,CAAe;AAGtE,QAAI,CAACG;AACI,aAAA;AAAA,QACL5D,QAAQ;AAAA,QACRgD,OAAO;AAAA,QACPtC,SAAS,uBAAuB+C,CAAe,OAAOM,EAAaC,kBAAkBC,aAAa;AAAA,MACpG;AAKEC,QAAAA,EAAmBN,CAAU;AACxB,aAAA;AAAA,QACL5D,QAAQ;AAAA,QACRgD,OAAO;AAAA,QACPtC,SAAS,uBAAuB+C,CAAe,OAAOM,EAAaI,sBAAsBF,aAAa;AAAA,MACxG;AAKF,QAAI,CAACL,EAAWjC,WAAWP,WAAWpB;AAC7B,aAAA;AAAA,QACLA,QAAQ;AAAA,QACRgD,OAAO;AAAA,QACPtC,SAAS,uBAAuB+C,CAAe,OAAOM,EAAaK,uBAAuBH,aAAa;AAAA,MACzG;AAAA,EACF;AAGK,SAAA;AAAA,IACLjE,QAAQ;AAAA,IACRJ,QAAQwD;AAAAA,EACV;AACF,GAEac,IAAqBA,CAACG,MACjC,OAAOA,KAAU,YACjBA,MAAU,QACV,gBAAgBA,KACfA,EAA2BtC,eAAe;"}
|
|
@@ -28,8 +28,8 @@ type SelectionResultByLimit = {
|
|
|
28
28
|
all?: KnockGuideSelectionResult;
|
|
29
29
|
};
|
|
30
30
|
type SelectionResultByQuery = {
|
|
31
|
-
|
|
32
|
-
|
|
31
|
+
byKey?: SelectionResultByLimit;
|
|
32
|
+
byType?: SelectionResultByLimit;
|
|
33
33
|
};
|
|
34
34
|
type SelectableStatusPresent = {
|
|
35
35
|
status: "returned" | "throttled" | "queried";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useInspectGuideClientStore.d.ts","sourceRoot":"","sources":["../../../../../../../src/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAIV,yBAAyB,EACzB,KAAK,kBAAkB,EAGxB,MAAM,mBAAmB,CAAC;AAS3B;;;;;GAKG;AAGH,KAAK,YAAY,GAAG;IAClB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAGF,KAAK,oBAAoB,GAAG;IAC1B,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AACF,KAAK,qBAAqB,GAAG;IAC3B,MAAM,EAAE,KAAK,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,KAAK,gBAAgB,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAErE,KAAK,iBAAiB,GAAG;IACvB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAGF,KAAK,cAAc,GAAG;IACpB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAQF,KAAK,sBAAsB,GAAG;IAC5B,GAAG,CAAC,EAAE,yBAAyB,CAAC;IAChC,GAAG,CAAC,EAAE,yBAAyB,CAAC;CACjC,CAAC;AACF,KAAK,sBAAsB,GAAG;IAC5B,
|
|
1
|
+
{"version":3,"file":"useInspectGuideClientStore.d.ts","sourceRoot":"","sources":["../../../../../../../src/modules/guide/components/Toolbar/V2/useInspectGuideClientStore.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAIV,yBAAyB,EACzB,KAAK,kBAAkB,EAGxB,MAAM,mBAAmB,CAAC;AAS3B;;;;;GAKG;AAGH,KAAK,YAAY,GAAG;IAClB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAGF,KAAK,oBAAoB,GAAG;IAC1B,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AACF,KAAK,qBAAqB,GAAG;IAC3B,MAAM,EAAE,KAAK,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,KAAK,gBAAgB,GAAG,oBAAoB,GAAG,qBAAqB,CAAC;AAErE,KAAK,iBAAiB,GAAG;IACvB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAGF,KAAK,cAAc,GAAG;IACpB,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAQF,KAAK,sBAAsB,GAAG;IAC5B,GAAG,CAAC,EAAE,yBAAyB,CAAC;IAChC,GAAG,CAAC,EAAE,yBAAyB,CAAC;CACjC,CAAC;AACF,KAAK,sBAAsB,GAAG;IAC5B,KAAK,CAAC,EAAE,sBAAsB,CAAC;IAC/B,MAAM,CAAC,EAAE,sBAAsB,CAAC;CACjC,CAAC;AACF,KAAK,uBAAuB,GAAG;IAC7B,MAAM,EAAE,UAAU,GAAG,WAAW,GAAG,SAAS,CAAC;IAC7C,KAAK,EAAE,sBAAsB,CAAC;CAC/B,CAAC;AACF,KAAK,sBAAsB,GAAG;IAC5B,MAAM,EAAE,SAAS,CAAC;CACnB,CAAC;AACF,KAAK,gBAAgB,GAAG,uBAAuB,GAAG,sBAAsB,CAAC;AAEzE,MAAM,MAAM,iBAAiB,GAAG;IAE9B,MAAM,EAAE,YAAY,CAAC;IACrB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,EAAE,cAAc,CAAC;IAEzB,WAAW,EAAE,iBAAiB,CAAC;IAC/B,UAAU,EAAE,gBAAgB,CAAC;CAC9B,CAAC;AAEF,KAAK,eAAe,GAAG,iBAAiB,GAAG;IAGzC,UAAU,EAAE,OAAO,CAAC;IAIpB,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,eAAe,CAAC;IAG5B,yBAAyB,CAAC,EAAE,UAAU,CAAC,yBAAyB,CAAC,CAAC;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACvB,MAAM,EAAE,KAAK,CAAC;IACd,yBAAyB,EAAE,KAAK,CAAC;IACjC,UAAU,EAAE;QACV,UAAU,EAAE,KAAK,CAAC;QAClB,WAAW,EAAE,KAAK,CAAC;QACnB,MAAM,EAAE;YACN,MAAM,EAAE,KAAK,CAAC;SACf,CAAC;QACF,UAAU,EAAE;YACV,MAAM,EAAE,SAAS,CAAC;SACnB,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,IAAI,CAAC;IACb,MAAM,EAAE,CAAC,cAAc,GAAG,gBAAgB,CAAC,EAAE,CAAC;CAC/C,CAAC;AACF,KAAK,qBAAqB,GAAG;IAC3B,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EACD,mBAAmB,GACnB,gBAAgB,GAChB,qBAAqB,GACrB,yBAAyB,GACzB,0BAA0B,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,KAAK,gBAAgB,GAAG,kBAAkB,GAAG,qBAAqB,CAAC;AAkOnE,eAAO,MAAM,kBAAkB,GAAI,8BAGhC,iBAAiB,YAInB,CAAC;AAsDF,eAAO,MAAM,0BAA0B,GACrC,WAAW,kBAAkB,KAC5B,gBAAgB,GAAG,SAgGrB,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,gBAIE,CAAC"}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@knocklabs/react",
|
|
3
3
|
"description": "A set of React components to build notification experiences powered by Knock",
|
|
4
4
|
"author": "@knocklabs",
|
|
5
|
-
"version": "0.11.
|
|
5
|
+
"version": "0.11.18",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"main": "dist/cjs/index.js",
|
|
8
8
|
"module": "dist/esm/index.mjs",
|
|
@@ -78,15 +78,15 @@
|
|
|
78
78
|
"@radix-ui/react-dialog": "^1.1.15",
|
|
79
79
|
"@radix-ui/react-hover-card": "^1.1.15",
|
|
80
80
|
"@telegraph/button": ">=0.6.0",
|
|
81
|
-
"@telegraph/combobox": ">=0.2.
|
|
81
|
+
"@telegraph/combobox": ">=0.2.6",
|
|
82
82
|
"@telegraph/icon": ">=0.5.0",
|
|
83
83
|
"@telegraph/layout": ">=0.5.0",
|
|
84
|
-
"@telegraph/segmented-control": ">=0.2.
|
|
85
|
-
"@telegraph/select": ">=0.0.
|
|
86
|
-
"@telegraph/tag": ">=0.2.
|
|
84
|
+
"@telegraph/segmented-control": ">=0.2.4",
|
|
85
|
+
"@telegraph/select": ">=0.0.89",
|
|
86
|
+
"@telegraph/tag": ">=0.2.1",
|
|
87
87
|
"@telegraph/toggle": ">=0.1.3",
|
|
88
88
|
"@telegraph/tokens": ">=0.2.0",
|
|
89
|
-
"@telegraph/tooltip": ">=0.2.
|
|
89
|
+
"@telegraph/tooltip": ">=0.2.2",
|
|
90
90
|
"@telegraph/typography": ">=0.4.0",
|
|
91
91
|
"clsx": "^2.1.1",
|
|
92
92
|
"lodash.debounce": "^4.0.8",
|
|
@@ -94,7 +94,7 @@
|
|
|
94
94
|
},
|
|
95
95
|
"devDependencies": {
|
|
96
96
|
"@codecov/vite-plugin": "^1.9.1",
|
|
97
|
-
"@tanstack/react-router": "1.
|
|
97
|
+
"@tanstack/react-router": "1.168.21",
|
|
98
98
|
"@telegraph/style-engine": "^0.3.2",
|
|
99
99
|
"@testing-library/dom": "^10.4.1",
|
|
100
100
|
"@testing-library/react": "^16.3.2",
|