@farming-labs/farmjs 0.2.92 → 0.2.95

package/README.md

@@ -26,8 +26,9 @@ export default withDocs(
 ```
 
 Farm discovers `docs.config.ts` from the application root. The wrapper writes
-Farm's native `docs` configuration and leaves routing, development middleware,
-and production output to `@farm.js/core`. A different path can
+an adapter runtime descriptor into Farm's `docs` configuration. Farm uses that
+versioned contract to load page rendering, server behavior, and MDX integration
+from `@farming-labs/farmjs` without selecting a docs theme itself. A different path can
 be provided explicitly:
 
 ```ts
@@ -36,6 +37,21 @@ export default withDocs(defineConfig({}), {
 });
 ```
 
+Import the selected theme from the application-owned global stylesheet. This
+also gives the application a normal place for project-specific overrides:
+
+```css
+/* src/app/globals.css */
+@import "@farming-labs/theme/pixel-border/css";
+
+:root {
+  --color-fd-primary: #8b5cf6;
+}
+```
+
+The theme factory in `docs.config.ts` and the CSS entrypoint must describe the
+same theme.
+
 ## Server wrapper
 
 `withDocs()` is the normal integration. The lower-level server wrapper is

package/dist/config.d.ts

@@ -1,8 +1,11 @@
 import type { DocsConfig } from "@farming-labs/docs";
+import { type FarmDocsRuntimeAdapter } from "./runtime.js";
 export interface FarmDocsCoreConfig extends Partial<DocsConfig> {
     enabled?: boolean;
     configPath?: string;
     config?: Partial<DocsConfig>;
+    /** Runtime entrypoints owned by the official Farm adapter. */
+    adapter?: FarmDocsRuntimeAdapter;
 }
 export interface FarmDocsAdapterOptions {
     /** Enable the docs runtime. Defaults to true when withDocs is used. */

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAErD,MAAM,WAAW,kBAAmB,SAAQ,OAAO,CAAC,UAAU,CAAC;IAC7D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,sBAAsB;IACrC,uEAAuE;IACvE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,kBAAkB,CAAC,OAAO,SAAS,cAAc,IAAI,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG;IACvF,IAAI,EAAE,kBAAkB,CAAC;CAC1B,CAAC;AAOF;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,OAAO,SAAS,cAAc,EACrD,UAAU,EAAE,OAAO,EACnB,OAAO,GAAE,sBAA2B,GACnC,kBAAkB,CAAC,OAAO,CAAC,CAoB7B"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAA0B,KAAK,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAEnF,MAAM,WAAW,kBAAmB,SAAQ,OAAO,CAAC,UAAU,CAAC;IAC7D,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7B,8DAA8D;IAC9D,OAAO,CAAC,EAAE,sBAAsB,CAAC;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC,uEAAuE;IACvE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,kBAAkB,CAAC,OAAO,SAAS,cAAc,IAAI,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG;IACvF,IAAI,EAAE,kBAAkB,CAAC;CAC1B,CAAC;AAOF;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,OAAO,SAAS,cAAc,EACrD,UAAU,EAAE,OAAO,EACnB,OAAO,GAAE,sBAA2B,GACnC,kBAAkB,CAAC,OAAO,CAAC,CAqB7B"}

package/dist/config.js

@@ -1,3 +1,4 @@
+import { farmDocsRuntimeAdapter } from "./runtime.js";
 function normalizeExistingDocs(value) {
     if (!value || value === true)
         return {};
@@ -18,6 +19,7 @@ export function withDocs(farmConfig, options = {}) {
         docs: {
             ...existing,
             enabled,
+            adapter: farmDocsRuntimeAdapter,
             ...(options.configPath ? { configPath: options.configPath } : {}),
             ...(options.config
                 ? {

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AA0BA,SAAS,qBAAqB,CAAC,KAA6B;IAC1D,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,EAAE,CAAC;IACxC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACtB,UAAmB,EACnB,UAAkC,EAAE;IAEpC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC;IAExC,OAAO;QACL,GAAG,UAAU;QACb,IAAI,EAAE;YACJ,GAAG,QAAQ;YACX,OAAO;YACP,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACjE,GAAG,CAAC,OAAO,CAAC,MAAM;gBAChB,CAAC,CAAC;oBACE,MAAM,EAAE;wBACN,GAAG,QAAQ,CAAC,MAAM;wBAClB,GAAG,OAAO,CAAC,MAAM;qBAClB;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAA+B,MAAM,cAAc,CAAC;AA4BnF,SAAS,qBAAqB,CAAC,KAA6B;IAC1D,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,EAAE,CAAC;IACxC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,QAAQ,CACtB,UAAmB,EACnB,UAAkC,EAAE;IAEpC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC;IAExC,OAAO;QACL,GAAG,UAAU;QACb,IAAI,EAAE;YACJ,GAAG,QAAQ;YACX,OAAO;YACP,OAAO,EAAE,sBAAsB;YAC/B,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACjE,GAAG,CAAC,OAAO,CAAC,MAAM;gBAChB,CAAC,CAAC;oBACE,MAAM,EAAE;wBACN,GAAG,QAAQ,CAAC,MAAM;wBAClB,GAAG,OAAO,CAAC,MAAM;qBAClB;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR;KACF,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -3,5 +3,6 @@ export { loadDocsContent, loadDocsNavTree, flattenNavTree, type ContentPage, typ
 export { createDocsServer, type DocsServer, type DocsServerLoadResult } from "./server.js";
 export { FarmDocsPage } from "./react.js";
 export { docsMdx } from "./vite.js";
+export { FARM_DOCS_ADAPTER_ID, FARM_DOCS_ADAPTER_PROTOCOL, farmDocsRuntimeAdapter, type FarmDocsRuntimeAdapter, } from "./runtime.js";
 export { createFarmjsApiReference } from "./api-reference.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,eAAe,EACf,eAAe,EACf,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,QAAQ,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAAE,KAAK,UAAU,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,eAAe,EACf,eAAe,EACf,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,QAAQ,GACd,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAAE,KAAK,UAAU,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,sBAAsB,EACtB,KAAK,sBAAsB,GAC5B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -3,5 +3,6 @@ export { loadDocsContent, loadDocsNavTree, flattenNavTree, } from "./content.js"
 export { createDocsServer } from "./server.js";
 export { FarmDocsPage } from "./react.js";
 export { docsMdx } from "./vite.js";
+export { FARM_DOCS_ADAPTER_ID, FARM_DOCS_ADAPTER_PROTOCOL, farmDocsRuntimeAdapter, } from "./runtime.js";
 export { createFarmjsApiReference } from "./api-reference.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,GAKT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,eAAe,EACf,eAAe,EACf,cAAc,GAMf,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAA8C,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,GAKT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,eAAe,EACf,eAAe,EACf,cAAc,GAMf,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,gBAAgB,EAA8C,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,sBAAsB,GAEvB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/runtime.d.ts

@@ -0,0 +1,18 @@
+/** Stable identifier used by Farm core to discover the official docs runtime. */
+export declare const FARM_DOCS_ADAPTER_ID: "@farming-labs/farmjs";
+/**
+ * Versioned boundary between Farm core and the official adapter.
+ *
+ * Increment this only when Farm must change how it loads an adapter entrypoint.
+ */
+export declare const FARM_DOCS_ADAPTER_PROTOCOL: 1;
+export interface FarmDocsRuntimeAdapter {
+    id: typeof FARM_DOCS_ADAPTER_ID;
+    protocol: typeof FARM_DOCS_ADAPTER_PROTOCOL;
+    server: "@farming-labs/farmjs/server";
+    react: "@farming-labs/farmjs/react";
+    vite: "@farming-labs/farmjs/vite";
+}
+/** Serializable runtime descriptor placed in Farm's resolved docs config. */
+export declare const farmDocsRuntimeAdapter: FarmDocsRuntimeAdapter;
+//# sourceMappingURL=runtime.d.ts.map

package/dist/runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,eAAO,MAAM,oBAAoB,EAAG,sBAA+B,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAG,CAAU,CAAC;AAErD,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,OAAO,oBAAoB,CAAC;IAChC,QAAQ,EAAE,OAAO,0BAA0B,CAAC;IAC5C,MAAM,EAAE,6BAA6B,CAAC;IACtC,KAAK,EAAE,4BAA4B,CAAC;IACpC,IAAI,EAAE,2BAA2B,CAAC;CACnC;AAED,6EAA6E;AAC7E,eAAO,MAAM,sBAAsB,EAAE,sBAMnC,CAAC"}

package/dist/runtime.js

@@ -0,0 +1,17 @@
+/** Stable identifier used by Farm core to discover the official docs runtime. */
+export const FARM_DOCS_ADAPTER_ID = "@farming-labs/farmjs";
+/**
+ * Versioned boundary between Farm core and the official adapter.
+ *
+ * Increment this only when Farm must change how it loads an adapter entrypoint.
+ */
+export const FARM_DOCS_ADAPTER_PROTOCOL = 1;
+/** Serializable runtime descriptor placed in Farm's resolved docs config. */
+export const farmDocsRuntimeAdapter = Object.freeze({
+    id: FARM_DOCS_ADAPTER_ID,
+    protocol: FARM_DOCS_ADAPTER_PROTOCOL,
+    server: "@farming-labs/farmjs/server",
+    react: "@farming-labs/farmjs/react",
+    vite: "@farming-labs/farmjs/vite",
+});
+//# sourceMappingURL=runtime.js.map

package/dist/runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA,iFAAiF;AACjF,MAAM,CAAC,MAAM,oBAAoB,GAAG,sBAA+B,CAAC;AAEpE;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAU,CAAC;AAUrD,6EAA6E;AAC7E,MAAM,CAAC,MAAM,sBAAsB,GAA2B,MAAM,CAAC,MAAM,CAAC;IAC1E,EAAE,EAAE,oBAAoB;IACxB,QAAQ,EAAE,0BAA0B;IACpC,MAAM,EAAE,6BAA6B;IACrC,KAAK,EAAE,4BAA4B;IACnC,IAAI,EAAE,2BAA2B;CAClC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/farmjs",
-  "version": "0.2.92",
+  "version": "0.2.95",
   "description": "Farm.js adapter for @farming-labs/docs",
   "keywords": [
     "docs",
@@ -52,6 +52,11 @@
       "types": "./dist/vite.d.ts",
       "import": "./dist/vite.js",
       "default": "./dist/vite.js"
+    },
+    "./runtime": {
+      "types": "./dist/runtime.d.ts",
+      "import": "./dist/runtime.js",
+      "default": "./dist/runtime.js"
     }
   },
   "dependencies": {
@@ -72,8 +77,8 @@
     "typescript": "^5.9.3",
     "vite": "^7.3.5",
     "vitest": "^4.1.8",
-    "@farming-labs/docs": "0.2.93",
-    "@farming-labs/theme": "0.2.93"
+    "@farming-labs/docs": "0.2.95",
+    "@farming-labs/theme": "0.2.95"
   },
   "peerDependencies": {
     "@farm.js/core": "^0.1.0-beta.19",