@wildo-ai/saas-technical-doc 1.1.5 → 1.1.7

package/dist/esm/runtime/use-docs-provider-component.js

@@ -0,0 +1,42 @@
+/**
+ * Reading provider-contributed components on the documentation site (#1703) — the docs counterpart of
+ * the application's `useProviderComponentChoices` / `useProviderComponent`, over the same registry and
+ * the same status vocabulary (`ProviderComponentStatus`).
+ *
+ * **No one is asked for consent here, so the grant is always NONE.** The documentation site has no
+ * consent panel and no signed-in person's stored preference to read (a reader may be anonymous, and the
+ * auth provider is optional), so a component whose provider rests on a consent purpose never loads on
+ * this surface: it reports `CONSENT_REQUIRED` and downloads nothing. That is the same fail-closed default
+ * `useDocsProviderSdks` and `useDocsProviderScripts` apply to the provider's SDK and scripts, and it
+ * keeps the three halves of one provider — SDK, scripts, component — answering the same question the
+ * same way.
+ */
+import { useContext, useEffect, useState } from 'react';
+import { idleProviderComponentLoadState, startProviderComponentLoad, } from '@wildo-ai/external-connectors-public/techdoc';
+import { DocsProviderComponentsContext } from './DocsFrontendProviders.js';
+/** The documentation site grants no consent purpose: nobody is asked on this surface. */
+const NO_GRANTED_PURPOSES = Object.freeze([]);
+/**
+ * The providers that are BOTH live for this docs service and carry a component for this capability, in
+ * the order the service declared them. Empty outside `DocsFrontendProviders`.
+ */
+export function useDocsProviderComponentChoices(capability) {
+    return useContext(DocsProviderComponentsContext)?.listProviders(capability) ?? [];
+}
+/**
+ * Loads one provider's component for a capability. Pass `undefined` for the ref while nothing is chosen.
+ * The load runs in an effect, so it never runs during the Docusaurus prerender.
+ */
+export function useDocsProviderComponent(capability, providerRef) {
+    const registry = useContext(DocsProviderComponentsContext);
+    const [state, setState] = useState(() => idleProviderComponentLoadState());
+    useEffect(() => startProviderComponentLoad({
+        registry,
+        capability,
+        providerRef,
+        grantedConsentPurposes: NO_GRANTED_PURPOSES,
+        onState: setState,
+    }), [capability, providerRef, registry]);
+    return state;
+}
+//# sourceMappingURL=use-docs-provider-component.js.map

package/dist/esm/runtime/use-docs-provider-component.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-docs-provider-component.js","sourceRoot":"","sources":["../../../src/runtime/use-docs-provider-component.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACxD,OAAO,EACL,8BAA8B,EAC9B,0BAA0B,GAE3B,MAAM,8CAA8C,CAAC;AAGtD,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AAMxE,yFAAyF;AACzF,MAAM,mBAAmB,GAA8B,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AAEzE;;;GAGG;AACH,MAAM,UAAU,+BAA+B,CAAC,UAA8B;IAC5E,OAAO,UAAU,CAAC,6BAA6B,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;AACpF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACtC,UAA8B,EAC9B,WAA+B;IAE/B,MAAM,QAAQ,GAAG,UAAU,CAAC,6BAA6B,CAAC,CAAC;IAC3D,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAA6B,GAAG,EAAE,CAAC,8BAA8B,EAA6B,CAAC,CAAC;IAElI,SAAS,CACP,GAAG,EAAE,CAAC,0BAA0B,CAAC;QAC/B,QAAQ;QACR,UAAU;QACV,WAAW;QACX,sBAAsB,EAAE,mBAAmB;QAC3C,OAAO,EAAE,QAAQ;KAClB,CAAC,EACF,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAC,CACpC,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/**\n * Reading provider-contributed components on the documentation site (#1703) — the docs counterpart of\n * the application's `useProviderComponentChoices` / `useProviderComponent`, over the same registry and\n * the same status vocabulary (`ProviderComponentStatus`).\n *\n * **No one is asked for consent here, so the grant is always NONE.** The documentation site has no\n * consent panel and no signed-in person's stored preference to read (a reader may be anonymous, and the\n * auth provider is optional), so a component whose provider rests on a consent purpose never loads on\n * this surface: it reports `CONSENT_REQUIRED` and downloads nothing. That is the same fail-closed default\n * `useDocsProviderSdks` and `useDocsProviderScripts` apply to the provider's SDK and scripts, and it\n * keeps the three halves of one provider — SDK, scripts, component — answering the same question the\n * same way.\n */\n\nimport { useContext, useEffect, useState } from 'react';\nimport {\n  idleProviderComponentLoadState,\n  startProviderComponentLoad,\n  type ProviderComponentLoadState,\n} from '@wildo-ai/external-connectors-public/techdoc';\nimport type { ConsentPurpose, ProviderCapability } from '@wildo-ai/saas-models/public-runtime';\n\nimport { DocsProviderComponentsContext } from './DocsFrontendProviders';\nimport type { DocsProviderComponentType } from './provider-component-registry.techdoc';\n\n/** What `useDocsProviderComponent` returns: the shared load state, holding a React component. */\nexport type DocsProviderComponentState = ProviderComponentLoadState<DocsProviderComponentType>;\n\n/** The documentation site grants no consent purpose: nobody is asked on this surface. */\nconst NO_GRANTED_PURPOSES: readonly ConsentPurpose[] = Object.freeze([]);\n\n/**\n * The providers that are BOTH live for this docs service and carry a component for this capability, in\n * the order the service declared them. Empty outside `DocsFrontendProviders`.\n */\nexport function useDocsProviderComponentChoices(capability: ProviderCapability): ReadonlyArray<string> {\n  return useContext(DocsProviderComponentsContext)?.listProviders(capability) ?? [];\n}\n\n/**\n * Loads one provider's component for a capability. Pass `undefined` for the ref while nothing is chosen.\n * The load runs in an effect, so it never runs during the Docusaurus prerender.\n */\nexport function useDocsProviderComponent(\n  capability: ProviderCapability,\n  providerRef: string | undefined,\n): DocsProviderComponentState {\n  const registry = useContext(DocsProviderComponentsContext);\n  const [state, setState] = useState<DocsProviderComponentState>(() => idleProviderComponentLoadState<DocsProviderComponentType>());\n\n  useEffect(\n    () => startProviderComponentLoad({\n      registry,\n      capability,\n      providerRef,\n      grantedConsentPurposes: NO_GRANTED_PURPOSES,\n      onState: setState,\n    }),\n    [capability, providerRef, registry],\n  );\n\n  return state;\n}\n"]}

package/dist/esm/runtime/use-docs-provider-scripts.d.ts

@@ -20,11 +20,18 @@
  * inject a SECOND copy of an already-running script. Idempotence by `src` is
  * the real guard.
  *
- * It injects without awaiting: nothing on the docs surface mounts a component
- * that reads a vendor global. A docs component that ever does should await
- * `loadProviderScripts` instead, as the SaaS app's provider component registry
- * does.
+ * It injects without awaiting, and only for providers with NO registered
+ * component: a provider that contributes a component has its scripts loaded and
+ * AWAITED by the provider-component registry when that component is first shown
+ * (#1703), so a component reading a vendor global finds it.
  */
 import type { FrontendTechdocProviderRegistry } from './frontend-provider-registry.techdoc';
-export declare function useDocsProviderScripts(registry: FrontendTechdocProviderRegistry | undefined): void;
+import type { DocsProviderComponentRegistry } from './provider-component-registry.techdoc';
+export declare function useDocsProviderScripts(registry: FrontendTechdocProviderRegistry | undefined, 
+/**
+ * The docs provider-component registry (#1703). A provider with a registered component loads its
+ * scripts WITH that component, when a page first shows it, rather than on every documentation page —
+ * the rule the application follows too. This hook injects the rest.
+ */
+componentRegistry?: DocsProviderComponentRegistry): void;
 //# sourceMappingURL=use-docs-provider-scripts.d.ts.map

package/dist/esm/runtime/use-docs-provider-scripts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-docs-provider-scripts.d.ts","sourceRoot":"","sources":["../../../../src/runtime/use-docs-provider-scripts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAOH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAE5F,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,+BAA+B,GAAG,SAAS,GACpD,IAAI,CASN"}
+{"version":3,"file":"use-docs-provider-scripts.d.ts","sourceRoot":"","sources":["../../../src/runtime/use-docs-provider-scripts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAOH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAC5F,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAE3F,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,+BAA+B,GAAG,SAAS;AACrD;;;;GAIG;AACH,iBAAiB,CAAC,EAAE,6BAA6B,GAChD,IAAI,CAUN"}

package/dist/esm/runtime/use-docs-provider-scripts.js

@@ -20,21 +20,28 @@
  * inject a SECOND copy of an already-running script. Idempotence by `src` is
  * the real guard.
  *
- * It injects without awaiting: nothing on the docs surface mounts a component
- * that reads a vendor global. A docs component that ever does should await
- * `loadProviderScripts` instead, as the SaaS app's provider component registry
- * does.
+ * It injects without awaiting, and only for providers with NO registered
+ * component: a provider that contributes a component has its scripts loaded and
+ * AWAITED by the provider-component registry when that component is first shown
+ * (#1703), so a component reading a vendor global finds it.
  */
 import { useEffect } from 'react';
-import { collectDeclaredProviderScripts, injectProviderScripts, } from '@wildo-ai/external-connectors-public/techdoc';
-export function useDocsProviderScripts(registry) {
+import { collectProviderScriptsWithoutComponents, injectProviderScripts, } from '@wildo-ai/external-connectors-public/techdoc';
+export function useDocsProviderScripts(registry, 
+/**
+ * The docs provider-component registry (#1703). A provider with a registered component loads its
+ * scripts WITH that component, when a page first shows it, rather than on every documentation page —
+ * the rule the application follows too. This hook injects the rest.
+ */
+componentRegistry) {
     useEffect(() => {
         if (typeof document === 'undefined')
             return;
-        const scripts = collectDeclaredProviderScripts(registry?.modules.values());
+        const withComponents = [...(componentRegistry?.providersWithComponents() ?? [])].map((providerRef) => ({ providerRef }));
+        const scripts = collectProviderScriptsWithoutComponents(registry?.modules.values() ?? [], withComponents);
         if (scripts.length === 0)
             return;
         injectProviderScripts(scripts, document);
-    }, [registry]);
+    }, [registry, componentRegistry]);
 }
 //# sourceMappingURL=use-docs-provider-scripts.js.map

package/dist/esm/runtime/use-docs-provider-scripts.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-docs-provider-scripts.js","sourceRoot":"","sources":["../../../../src/runtime/use-docs-provider-scripts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EACL,8BAA8B,EAC9B,qBAAqB,GACtB,MAAM,8CAA8C,CAAC;AAGtD,MAAM,UAAU,sBAAsB,CACpC,QAAqD;IAErD,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,OAAO,QAAQ,KAAK,WAAW;YAAE,OAAO;QAE5C,MAAM,OAAO,GAAG,8BAA8B,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3E,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEjC,qBAAqB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;AACjB,CAAC","sourcesContent":["/**\n * Adds the third-party `<script>` tags every live docs provider declares.\n *\n * The techdoc's half of the DATA channel's executable surface (#332), beside\n * `useDocsProviderSdks` for the npm half. Before this, a docs provider's\n * declared `scripts` were read by nothing on this surface: only the website\n * injected them, which is how a declared script became a label elsewhere.\n * The injector itself is the ONE shared copy in\n * `@wildo-ai/external-connectors-public/techdoc` — a second copy of a DOM\n * mutation eventually disagrees about idempotence, and a vendor tag loaded\n * twice initialises twice.\n *\n * Effect-only, and that is not a detail: Docusaurus server-renders every page\n * at build time, where there is no `document` to inject into, and a vendor tag\n * must not run inside the build.\n *\n * Deliberately no teardown, for the same reason as the website hook: a vendor\n * tag installs a global and often starts work immediately. Removing the element\n * undoes neither, so a cleanup that removed it would only make the next mount\n * inject a SECOND copy of an already-running script. Idempotence by `src` is\n * the real guard.\n *\n * It injects without awaiting: nothing on the docs surface mounts a component\n * that reads a vendor global. A docs component that ever does should await\n * `loadProviderScripts` instead, as the SaaS app's provider component registry\n * does.\n */\n\nimport { useEffect } from 'react';\nimport {\n  collectDeclaredProviderScripts,\n  injectProviderScripts,\n} from '@wildo-ai/external-connectors-public/techdoc';\nimport type { FrontendTechdocProviderRegistry } from './frontend-provider-registry.techdoc';\n\nexport function useDocsProviderScripts(\n  registry: FrontendTechdocProviderRegistry | undefined,\n): void {\n  useEffect(() => {\n    if (typeof document === 'undefined') return;\n\n    const scripts = collectDeclaredProviderScripts(registry?.modules.values());\n    if (scripts.length === 0) return;\n\n    injectProviderScripts(scripts, document);\n  }, [registry]);\n}\n"]}
+{"version":3,"file":"use-docs-provider-scripts.js","sourceRoot":"","sources":["../../../src/runtime/use-docs-provider-scripts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EACL,uCAAuC,EACvC,qBAAqB,GACtB,MAAM,8CAA8C,CAAC;AAItD,MAAM,UAAU,sBAAsB,CACpC,QAAqD;AACrD;;;;GAIG;AACH,iBAAiD;IAEjD,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,OAAO,QAAQ,KAAK,WAAW;YAAE,OAAO;QAE5C,MAAM,cAAc,GAAG,CAAC,GAAG,CAAC,iBAAiB,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;QACzH,MAAM,OAAO,GAAG,uCAAuC,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC;QAC1G,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEjC,qBAAqB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC,EAAE,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACpC,CAAC","sourcesContent":["/**\n * Adds the third-party `<script>` tags every live docs provider declares.\n *\n * The techdoc's half of the DATA channel's executable surface (#332), beside\n * `useDocsProviderSdks` for the npm half. Before this, a docs provider's\n * declared `scripts` were read by nothing on this surface: only the website\n * injected them, which is how a declared script became a label elsewhere.\n * The injector itself is the ONE shared copy in\n * `@wildo-ai/external-connectors-public/techdoc` — a second copy of a DOM\n * mutation eventually disagrees about idempotence, and a vendor tag loaded\n * twice initialises twice.\n *\n * Effect-only, and that is not a detail: Docusaurus server-renders every page\n * at build time, where there is no `document` to inject into, and a vendor tag\n * must not run inside the build.\n *\n * Deliberately no teardown, for the same reason as the website hook: a vendor\n * tag installs a global and often starts work immediately. Removing the element\n * undoes neither, so a cleanup that removed it would only make the next mount\n * inject a SECOND copy of an already-running script. Idempotence by `src` is\n * the real guard.\n *\n * It injects without awaiting, and only for providers with NO registered\n * component: a provider that contributes a component has its scripts loaded and\n * AWAITED by the provider-component registry when that component is first shown\n * (#1703), so a component reading a vendor global finds it.\n */\n\nimport { useEffect } from 'react';\nimport {\n  collectProviderScriptsWithoutComponents,\n  injectProviderScripts,\n} from '@wildo-ai/external-connectors-public/techdoc';\nimport type { FrontendTechdocProviderRegistry } from './frontend-provider-registry.techdoc';\nimport type { DocsProviderComponentRegistry } from './provider-component-registry.techdoc';\n\nexport function useDocsProviderScripts(\n  registry: FrontendTechdocProviderRegistry | undefined,\n  /**\n   * The docs provider-component registry (#1703). A provider with a registered component loads its\n   * scripts WITH that component, when a page first shows it, rather than on every documentation page —\n   * the rule the application follows too. This hook injects the rest.\n   */\n  componentRegistry?: DocsProviderComponentRegistry,\n): void {\n  useEffect(() => {\n    if (typeof document === 'undefined') return;\n\n    const withComponents = [...(componentRegistry?.providersWithComponents() ?? [])].map((providerRef) => ({ providerRef }));\n    const scripts = collectProviderScriptsWithoutComponents(registry?.modules.values() ?? [], withComponents);\n    if (scripts.length === 0) return;\n\n    injectProviderScripts(scripts, document);\n  }, [registry, componentRegistry]);\n}\n"]}

package/dist/esm/runtime/use-docs-provider-sdks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-docs-provider-sdks.d.ts","sourceRoot":"","sources":["../../../../src/runtime/use-docs-provider-sdks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAQH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAE5F,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,+BAA+B,GAAG,SAAS,GACpD,IAAI,CA2BN"}
+{"version":3,"file":"use-docs-provider-sdks.d.ts","sourceRoot":"","sources":["../../../src/runtime/use-docs-provider-sdks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAQH,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAE5F,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,+BAA+B,GAAG,SAAS,GACpD,IAAI,CA2BN"}