@servicetitan/docs-anvil-uikit-contrib 39.2.0 → 39.3.0

package/docs/tanstack-query-mobx/01-queries.mdx

@@ -127,7 +127,7 @@ These are additions to TanStack's standard options:
 | `autoInitialize` | `true` | Set `initialized` to `true` after first successful fetch. Set to `false` to control it manually |
 | `onSuccess` | `undefined` | Callback with query data after success. Also fires on `updateQueryData()` |
 | `onError` | `undefined` | Callback with error object after failure (after retries) |
-| `globalClient` | `undefined` | Use a shared page or app-level query client. See [Shared Clients](./04-shared-clients) |
+| `globalClient` | `undefined` | Use a shared page or app-level query client. See [Shared Clients](./shared-clients) |
 
 ## Query State
 

package/docs/tanstack-query-mobx/02-mutations.mdx

@@ -91,7 +91,7 @@ See all options at [TanStack Query useMutation reference](https://tanstack.com/q
 | Option | Description |
 |--------|-------------|
 | `invalidatedQueries` | Query keys to refetch after successful mutation |
-| `globalClient` | Use a shared page or app-level client (see [Shared Clients](./04-shared-clients)) |
+| `globalClient` | Use a shared page or app-level client (see [Shared Clients](./shared-clients)) |
 
 ## Mutation State
 

package/docs/tanstack-query-mobx/05-query-client-store.mdx

@@ -36,7 +36,7 @@ export const App: FC = provide({
 })(observer(() => <YourApp />));
 ```
 
-Custom config is only supported for local (component-scoped) clients. Shared clients (`'page'`, `'app'`) use consistent defaults across all MFEs — see [Shared Clients](./04-shared-clients).
+Custom config is only supported for local (component-scoped) clients. Shared clients (`'page'`, `'app'`) use consistent defaults across all MFEs — see [Shared Clients](./shared-clients).
 
 ## Defaults
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-anvil-uikit-contrib",
-    "version": "39.2.0",
+    "version": "39.3.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -8,7 +8,8 @@
         "directory": "docusaurus"
     },
     "files": [
-        "docs"
+        "docs",
+        "remark"
     ],
     "publishConfig": {
         "access": "public"
@@ -16,5 +17,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "6bbf9e0d01ace99f5b5d0200025300a0d5c82e94"
+    "gitHead": "2ea34fce3c87c88c274bcabaa0d23186b90d6d3d"
 }

package/remark/inline-demo-src.js

@@ -0,0 +1,179 @@
+/**
+ * Remark plugin that inlines demo source code at MDX compile time.
+ *
+ * For each <CodeDemo srcPath="<pkg>/<path>" /> (or <DemoCodeBlock>) in MDX,
+ * this plugin reads the file from disk and adds the contents as a `src` prop
+ * on the element. The CodeDemo component then renders that string in the
+ * "Source" tab without doing any runtime lookups.
+ *
+ * Why this exists: the previous approach was a runtime
+ * `require(`!!raw-loader!@servicetitan/${srcPath}`)` inside CodeDemo.
+ * Webpack expanded that template-literal require into a context module
+ * spanning every file under @servicetitan/*, which (a) ballooned the bundle
+ * by transitively pulling in vitest/node: imports and (b) crashed HMR in
+ * webpack's FileSystemInfo._resolveContextTimestamp on every edit.
+ * Resolving srcPath here at MDX compile time eliminates the context module
+ * entirely.
+ *
+ * Why this works under pnpm/yarn/npm: it uses Module.createRequire from the
+ * consumer's docusaurus directory, so resolution follows the consumer's
+ * actual node_modules layout instead of assuming scoped packages are
+ * hoisted as siblings.
+ *
+ * Usage (in the consumer's docusaurus.config.js, Docusaurus v3+):
+ *
+ *   beforeDefaultRemarkPlugins: [
+ *       require('@servicetitan/docs-anvil-uikit-contrib/remark/inline-demo-src')({
+ *           resolveFrom: __dirname,
+ *       }),
+ *   ]
+ *
+ * In Docusaurus v2 the plugin is a no-op: MDX 1's AST doesn't have the
+ * mdxJsxFlowElement/mdxJsxTextElement node types we look for, so the walk
+ * finds nothing and the consumer's existing CodeDemo runtime keeps working.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const Module = require('module');
+
+const TARGET_NAMES = new Set(['CodeDemo', 'DemoCodeBlock']);
+
+/**
+ * Builds a package-root resolver scoped to the host project's node_modules.
+ *
+ * `Module.createRequire` is given a fake file path inside `resolveFrom` so the
+ * resulting `require.resolve` walks node_modules starting from there. Without
+ * this, resolution would happen relative to this file's location
+ * (`packages/docs/remark/`), which lacks the demo packages.
+ */
+function makeFindPackageRoot(resolveFrom) {
+    const hostRequire = Module.createRequire(path.join(resolveFrom, 'noop.js'));
+    return name => {
+        try {
+            /* Preferred path: resolve `<pkg>/package.json` directly. */
+            return path.dirname(hostRequire.resolve(`${name}/package.json`));
+        } catch (err) {
+            /*
+             * Some packages have an `exports` field that omits `./package.json`,
+             * which makes the direct resolve throw ERR_PACKAGE_PATH_NOT_EXPORTED.
+             * Fall back to resolving the package's main entry, then walking up
+             * to the directory that actually contains package.json.
+             */
+            if (err.code !== 'ERR_PACKAGE_PATH_NOT_EXPORTED') {
+                throw err;
+            }
+            let dir = path.dirname(hostRequire.resolve(name));
+            while (!fs.existsSync(path.join(dir, 'package.json'))) {
+                const parent = path.dirname(dir);
+                if (parent === dir) {
+                    throw err;
+                }
+                dir = parent;
+            }
+            return dir;
+        }
+    };
+}
+
+/*
+ * Minimal in-tree visitor; avoids depending on `unist-util-visit` which is
+ * ESM-only and would force this CJS plugin to become async.
+ */
+function walk(node, fn) {
+    if (!node) {
+        return;
+    }
+    fn(node);
+    if (Array.isArray(node.children)) {
+        for (const child of node.children) {
+            walk(child, fn);
+        }
+    }
+}
+
+/**
+ * Reads an MDX JSX attribute's string value.
+ *
+ * For literal attributes (`srcPath="foo/bar"`) MDX 3 stores the string
+ * directly on `attr.value`. For expression attributes (`srcPath={...}`) it
+ * stores an object whose `.value` is the expression source — we don't try
+ * to evaluate that, we only handle plain string literals.
+ */
+function getAttrValue(attr) {
+    if (typeof attr.value === 'string') {
+        return attr.value;
+    }
+    if (attr.value && typeof attr.value === 'object' && 'value' in attr.value) {
+        return attr.value.value;
+    }
+    return undefined;
+}
+
+/**
+ * Plugin factory. Called once at config-load time with `{ resolveFrom }`,
+ * returns the actual remark plugin (a function returning a tree visitor).
+ *
+ * We use a factory instead of a bare plugin so each consumer can pass its
+ * own `__dirname` for module resolution.
+ */
+module.exports = function inlineDemoSrc(options = {}) {
+    const resolveFrom = options.resolveFrom || process.cwd();
+    const findPackageRoot = makeFindPackageRoot(resolveFrom);
+
+    return () => tree => {
+        walk(tree, node => {
+            /*
+             * Only MDX 3 JSX element nodes are interesting; v2's MDX 1 uses a
+             * different shape, so this plugin is a safe no-op there.
+             */
+            if (node.type !== 'mdxJsxFlowElement' && node.type !== 'mdxJsxTextElement') {
+                return;
+            }
+            if (!TARGET_NAMES.has(node.name)) {
+                return;
+            }
+            if (!Array.isArray(node.attributes)) {
+                return;
+            }
+            /* If the author already provided a `src` prop manually, leave it. */
+            if (node.attributes.some(a => a.name === 'src')) {
+                return;
+            }
+
+            const srcPathAttr = node.attributes.find(a => a.name === 'srcPath');
+            if (!srcPathAttr) {
+                return;
+            }
+            const srcPath = getAttrValue(srcPathAttr);
+            if (typeof srcPath !== 'string') {
+                return;
+            }
+
+            /*
+             * srcPath is "<package>/<file>" — split on the first slash so
+             * multi-segment subpaths like "table/src/demo/overview/table.tsx"
+             * are kept intact.
+             */
+            const slash = srcPath.indexOf('/');
+            if (slash < 0) {
+                return;
+            }
+            const pkg = srcPath.slice(0, slash);
+            const subpath = srcPath.slice(slash + 1);
+
+            const fullPath = path.join(findPackageRoot(`@servicetitan/${pkg}`), subpath);
+            const src = fs.readFileSync(fullPath, 'utf8');
+
+            /*
+             * Append a synthesized literal `src` attribute. MDX 3's compiler
+             * turns this into `src="..."` on the rendered element.
+             */
+            node.attributes.push({
+                type: 'mdxJsxAttribute',
+                name: 'src',
+                value: src,
+            });
+        });
+    };
+};