@wildo-ai/saas-technical-doc 1.1.1 → 1.1.3

package/dist/esm/runtime/use-docs-auth-session.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-docs-auth-session.js","sourceRoot":"","sources":["../../../../src/runtime/use-docs-auth-session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,eAAe,EAA6B,MAAM,mBAAmB,CAAC;AAE/E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,kBAAkB;IAChC,MAAM,GAAG,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CACb,iEAAiE;YAC/D,2FAA2F,CAC9F,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import { useContext } from 'react';\nimport { DocsAuthContext, type DocsAuthContextValue } from './DocsAuthContext';\n\n/**\n * Read the current docs-site auth session.\n *\n * The three Docusaurus swizzles (Root, Navbar, DocItem — see\n * saas-technical-doc.md K-11) all consume the same hook:\n *\n *   - Navbar  : `session.status === 'authenticated' && session.claims.role === DocsRole.ORG_ADMIN`\n *               decides whether the \"Organization API\" link is rendered.\n *   - DocItem : on `/api/organization/*` routes, branches on the same\n *               check; if anonymous, deep-links to the SaaS app because\n *               handoff issuance requires a bearer.\n *   - Root    : the `<AuthExchangePage>` wired at `/auth/exchange` calls\n *               `beginExchange(code)` on mount.\n *\n * Throws when used outside `<DocsAuthProvider>` so misconfigured swizzles\n * fail loud during the Docusaurus build (rather than silently rendering\n * \"anonymous\" for every reader). This mirrors the pattern in\n * `saas-frontend-lib`'s `useAuthSession()`.\n *\n * Lives in its own file so editing the context value type does not\n * invalidate the hook's React Fast Refresh boundary, mirroring the\n * `useAuthSession.ts` / `AuthSessionContext.tsx` split.\n */\nexport function useDocsAuthSession(): DocsAuthContextValue {\n  const ctx = useContext(DocsAuthContext);\n  if (!ctx) {\n    throw new Error(\n      '`useDocsAuthSession` must be used within `<DocsAuthProvider>`. ' +\n        'Mount it via the Root swizzle on your Docusaurus site (see saas-technical-doc.md Step 6).',\n    );\n  }\n  return ctx;\n}\n"]}
+{"version":3,"file":"use-docs-auth-session.js","sourceRoot":"","sources":["../../../../src/runtime/use-docs-auth-session.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,eAAe,EAA6B,MAAM,mBAAmB,CAAC;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,kBAAkB;IAChC,MAAM,GAAG,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IACxC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,IAAI,KAAK,CACb,iEAAiE;YAC/D,2FAA2F,CAC9F,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import { useContext } from 'react';\nimport { DocsAuthContext, type DocsAuthContextValue } from './DocsAuthContext';\n\n/**\n * Read the current docs-site auth session.\n *\n * ONE Docusaurus swizzle consumes this hook today:\n *\n *   - Root    : the `<AuthExchangePage>` wired at `/auth/exchange` calls\n *               `beginExchange(code)` on mount.\n *\n * This list used to name three (Root, Navbar, DocItem). The Navbar swizzle\n * gating an \"Organization API\" link and the DocItem swizzle gating\n * `/api/organization/*` were never built, and there is no organization\n * OpenAPI section for them to gate — see `DocsRole` in\n * `docs-auth-session.schemas.ts` for the measurement. The hook's\n * role-carrying shape is unchanged and ready for such a surface; it simply\n * has no second or third consumer at present.\n *\n * Throws when used outside `<DocsAuthProvider>` so misconfigured swizzles\n * fail loud during the Docusaurus build (rather than silently rendering\n * \"anonymous\" for every reader). This mirrors the pattern in\n * `saas-frontend-lib`'s `useAuthSession()`.\n *\n * Lives in its own file so editing the context value type does not\n * invalidate the hook's React Fast Refresh boundary, mirroring the\n * `useAuthSession.ts` / `AuthSessionContext.tsx` split.\n */\nexport function useDocsAuthSession(): DocsAuthContextValue {\n  const ctx = useContext(DocsAuthContext);\n  if (!ctx) {\n    throw new Error(\n      '`useDocsAuthSession` must be used within `<DocsAuthProvider>`. ' +\n        'Mount it via the Root swizzle on your Docusaurus site (see saas-technical-doc.md Step 6).',\n    );\n  }\n  return ctx;\n}\n"]}

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

@@ -0,0 +1,21 @@
+/**
+ * Loads and starts the npm SDK of every live docs provider that declares one.
+ *
+ * The techdoc's half of the CODE channel (#332). Until this landed, the docs
+ * runtime hydrated a provider registry that nothing read — the registry was
+ * built, exposed through `useDocsFrontendProviderRegistry`, and no consumer did
+ * anything with it.
+ *
+ * Effect-only, and that is not a detail: Docusaurus server-renders every page
+ * at build time, so a vendor SDK started during the render would run inside the
+ * build process — or throw, reaching for a `window` that is not there. The
+ * runner refuses off-browser on its own; the effect keeps it from being asked
+ * in the first place.
+ *
+ * Teardown is real where the vendor offers one. An analytics or
+ * error-monitoring client that can be started and never stopped cannot honour a
+ * consent withdrawal.
+ */
+import type { FrontendTechdocProviderRegistry } from './frontend-provider-registry.techdoc';
+export declare function useDocsProviderSdks(registry: FrontendTechdocProviderRegistry | undefined): void;
+//# sourceMappingURL=use-docs-provider-sdks.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,49 @@
+/**
+ * Loads and starts the npm SDK of every live docs provider that declares one.
+ *
+ * The techdoc's half of the CODE channel (#332). Until this landed, the docs
+ * runtime hydrated a provider registry that nothing read — the registry was
+ * built, exposed through `useDocsFrontendProviderRegistry`, and no consumer did
+ * anything with it.
+ *
+ * Effect-only, and that is not a detail: Docusaurus server-renders every page
+ * at build time, so a vendor SDK started during the render would run inside the
+ * build process — or throw, reaching for a `window` that is not there. The
+ * runner refuses off-browser on its own; the effect keeps it from being asked
+ * in the first place.
+ *
+ * Teardown is real where the vendor offers one. An analytics or
+ * error-monitoring client that can be started and never stopped cannot honour a
+ * consent withdrawal.
+ */
+import { useEffect } from 'react';
+import { activateFrontendProviderSdks, } from '@wildo-ai/external-connectors-public/techdoc';
+import { AppFrontendType } from '@wildo-ai/saas-models/public-runtime';
+export function useDocsProviderSdks(registry) {
+    useEffect(() => {
+        if (registry === undefined)
+            return;
+        let unmounted = false;
+        let activated;
+        void activateFrontendProviderSdks({
+            surface: AppFrontendType.TECH_DOC,
+            modules: registry.modules.values(),
+            onDiagnostic: (diagnostic) => {
+                // eslint-disable-next-line no-console
+                console.warn(`[wildo-provider-sdk] ${diagnostic.kind}: ${diagnostic.message}`);
+            },
+        }).then((result) => {
+            activated = result;
+            // Activation is asynchronous and unmount is not: if the surface went away
+            // while a vendor bundle was still downloading, stop what we just started
+            // rather than leaving a client nobody can reach.
+            if (unmounted)
+                void result.deactivateAll();
+        });
+        return () => {
+            unmounted = true;
+            void activated?.deactivateAll();
+        };
+    }, [registry]);
+}
+//# sourceMappingURL=use-docs-provider-sdks.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-docs-provider-sdks.js","sourceRoot":"","sources":["../../../../src/runtime/use-docs-provider-sdks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EACL,4BAA4B,GAE7B,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAGvE,MAAM,UAAU,mBAAmB,CACjC,QAAqD;IAErD,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,QAAQ,KAAK,SAAS;YAAE,OAAO;QAEnC,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,IAAI,SAAoD,CAAC;QAEzD,KAAK,4BAA4B,CAAC;YAChC,OAAO,EAAE,eAAe,CAAC,QAAQ;YACjC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE;YAClC,YAAY,EAAE,CAAC,UAAU,EAAE,EAAE;gBAC3B,sCAAsC;gBACtC,OAAO,CAAC,IAAI,CAAC,wBAAwB,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;YACjF,CAAC;SACF,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACjB,SAAS,GAAG,MAAM,CAAC;YACnB,0EAA0E;YAC1E,yEAAyE;YACzE,iDAAiD;YACjD,IAAI,SAAS;gBAAE,KAAK,MAAM,CAAC,aAAa,EAAE,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,SAAS,GAAG,IAAI,CAAC;YACjB,KAAK,SAAS,EAAE,aAAa,EAAE,CAAC;QAClC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;AACjB,CAAC","sourcesContent":["/**\n * Loads and starts the npm SDK of every live docs provider that declares one.\n *\n * The techdoc's half of the CODE channel (#332). Until this landed, the docs\n * runtime hydrated a provider registry that nothing read — the registry was\n * built, exposed through `useDocsFrontendProviderRegistry`, and no consumer did\n * anything with it.\n *\n * Effect-only, and that is not a detail: Docusaurus server-renders every page\n * at build time, so a vendor SDK started during the render would run inside the\n * build process — or throw, reaching for a `window` that is not there. The\n * runner refuses off-browser on its own; the effect keeps it from being asked\n * in the first place.\n *\n * Teardown is real where the vendor offers one. An analytics or\n * error-monitoring client that can be started and never stopped cannot honour a\n * consent withdrawal.\n */\n\nimport { useEffect } from 'react';\nimport {\n  activateFrontendProviderSdks,\n  type ActivatedFrontendProviderSdks,\n} from '@wildo-ai/external-connectors-public/techdoc';\nimport { AppFrontendType } from '@wildo-ai/saas-models/public-runtime';\nimport type { FrontendTechdocProviderRegistry } from './frontend-provider-registry.techdoc';\n\nexport function useDocsProviderSdks(\n  registry: FrontendTechdocProviderRegistry | undefined,\n): void {\n  useEffect(() => {\n    if (registry === undefined) return;\n\n    let unmounted = false;\n    let activated: ActivatedFrontendProviderSdks | undefined;\n\n    void activateFrontendProviderSdks({\n      surface: AppFrontendType.TECH_DOC,\n      modules: registry.modules.values(),\n      onDiagnostic: (diagnostic) => {\n        // eslint-disable-next-line no-console\n        console.warn(`[wildo-provider-sdk] ${diagnostic.kind}: ${diagnostic.message}`);\n      },\n    }).then((result) => {\n      activated = result;\n      // Activation is asynchronous and unmount is not: if the surface went away\n      // while a vendor bundle was still downloading, stop what we just started\n      // rather than leaving a client nobody can reach.\n      if (unmounted) void result.deactivateAll();\n    });\n\n    return () => {\n      unmounted = true;\n      void activated?.deactivateAll();\n    };\n  }, [registry]);\n}\n"]}