@farming-labs/next 0.2.119 → 0.2.121
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/README.md +30 -1
- package/dist/api-reference-CTAOPJih.d.mts +49 -0
- package/dist/api-reference-banner-q98BnSRL.mjs +94 -0
- package/dist/api-reference.d.mts +3 -46
- package/dist/api-reference.mjs +10 -90
- package/dist/config-2dZm_AHg.mjs +2345 -0
- package/dist/config-yzp9kyZ0.d.mts +21 -0
- package/dist/config.d.mts +2 -7
- package/dist/config.mjs +1 -2254
- package/dist/core-DRyvBL8l.mjs +16 -0
- package/dist/fumadocs-api-page.d.mts +4 -1
- package/dist/fumadocs-api-page.mjs +16 -2
- package/dist/fumadocs-renderer.d.mts +13 -0
- package/dist/fumadocs-renderer.mjs +13 -0
- package/dist/index.d.mts +3 -3
- package/dist/index.mjs +3 -2
- package/dist/layout.mjs +1 -1
- package/dist/mdx-plugins/remark-code-group.d.mts +7 -2
- package/dist/mdx-plugins/remark-code-group.mjs +2 -2
- package/dist/mdx-plugins/remark-heading.mjs +1 -1
- package/dist/mdx-plugins/remark-markdown-alternate.mjs +1 -1
- package/package.json +9 -4
- package/dist/code-block-themes-CCE5ViGj.mjs +0 -25
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
//#region src/mdx-plugins/core.ts
|
|
2
|
+
let compilerEntry;
|
|
3
|
+
try {
|
|
4
|
+
compilerEntry = import.meta.resolve("@farming-labs/docs/mdx");
|
|
5
|
+
} catch (error) {
|
|
6
|
+
if (error.code !== "ERR_PACKAGE_PATH_NOT_EXPORTED") throw error;
|
|
7
|
+
}
|
|
8
|
+
const helpers = compilerEntry ? await import(compilerEntry) : {
|
|
9
|
+
...await import("@farming-labs/docs"),
|
|
10
|
+
...await import("@farming-labs/docs/server")
|
|
11
|
+
};
|
|
12
|
+
const { remarkCodeGroup, applyDocsMarkdownHeadingAnchors, encodeDocsHeadingTocUrls, withDocsMarkdownRenderableHeadings, isolateDocsMarkdownPromptReferences } = helpers;
|
|
13
|
+
const toDocsMarkdownUrl = helpers.toDocsMarkdownUrl ?? (await import("@farming-labs/docs")).toDocsMarkdownUrl;
|
|
14
|
+
|
|
15
|
+
//#endregion
|
|
16
|
+
export { toDocsMarkdownUrl as a, remarkCodeGroup as i, encodeDocsHeadingTocUrls as n, withDocsMarkdownRenderableHeadings as o, isolateDocsMarkdownPromptReferences as r, applyDocsMarkdownHeadingAnchors as t };
|
|
@@ -1,8 +1,11 @@
|
|
|
1
|
+
import { DocsConfig } from "@farming-labs/docs";
|
|
1
2
|
import * as react from "react";
|
|
2
3
|
import * as fumadocs_openapi_ui0 from "fumadocs-openapi/ui";
|
|
4
|
+
import { CreateOpenAPIPageOptions } from "fumadocs-openapi/ui";
|
|
3
5
|
|
|
4
6
|
//#region src/fumadocs-api-page.d.ts
|
|
7
|
+
declare function resolveFumadocsOpenAPIPageOptions(config: DocsConfig): CreateOpenAPIPageOptions;
|
|
5
8
|
/** Client boundary for Fumadocs OpenAPI's interactive renderer. */
|
|
6
9
|
declare const FumadocsOpenAPIPage: react.FC<fumadocs_openapi_ui0.OpenAPIPageProps>;
|
|
7
10
|
//#endregion
|
|
8
|
-
export { FumadocsOpenAPIPage as default };
|
|
11
|
+
export { FumadocsOpenAPIPage as default, resolveFumadocsOpenAPIPageOptions };
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
"use client";
|
|
2
2
|
|
|
3
|
+
import docsConfig from "@farming-labs/next-internal-docs-config";
|
|
3
4
|
import { jsx, jsxs } from "react/jsx-runtime";
|
|
4
5
|
import { createOpenAPIPage } from "fumadocs-openapi/ui";
|
|
5
6
|
|
|
@@ -28,8 +29,21 @@ function renderApiReferenceOperationLayout(slots) {
|
|
|
28
29
|
}) : null]
|
|
29
30
|
});
|
|
30
31
|
}
|
|
32
|
+
function resolveFumadocsOpenAPIPageOptions(config) {
|
|
33
|
+
const renderer = config.apiReference && typeof config.apiReference === "object" ? config.apiReference.renderer : void 0;
|
|
34
|
+
const pageOptions = { ...renderer && typeof renderer === "object" && renderer.name === "fumadocs" ? renderer.options : void 0 };
|
|
35
|
+
delete pageOptions.disableCache;
|
|
36
|
+
delete pageOptions.proxyUrl;
|
|
37
|
+
return {
|
|
38
|
+
...pageOptions,
|
|
39
|
+
content: {
|
|
40
|
+
renderOperationLayout: renderApiReferenceOperationLayout,
|
|
41
|
+
...pageOptions.content
|
|
42
|
+
}
|
|
43
|
+
};
|
|
44
|
+
}
|
|
31
45
|
/** Client boundary for Fumadocs OpenAPI's interactive renderer. */
|
|
32
|
-
const FumadocsOpenAPIPage = createOpenAPIPage(
|
|
46
|
+
const FumadocsOpenAPIPage = createOpenAPIPage(resolveFumadocsOpenAPIPageOptions(docsConfig));
|
|
33
47
|
|
|
34
48
|
//#endregion
|
|
35
|
-
export { FumadocsOpenAPIPage as default };
|
|
49
|
+
export { FumadocsOpenAPIPage as default, resolveFumadocsOpenAPIPageOptions };
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { ApiReferenceRendererConfig } from "@farming-labs/docs";
|
|
2
|
+
import { CreateOpenAPIPageOptions } from "fumadocs-openapi/ui";
|
|
3
|
+
import { OpenAPIOptions } from "fumadocs-openapi/server";
|
|
4
|
+
|
|
5
|
+
//#region src/fumadocs-renderer.d.ts
|
|
6
|
+
/** Options supported by the bundled Fumadocs OpenAPI renderer. */
|
|
7
|
+
type FumadocsApiReferenceRendererOptions = CreateOpenAPIPageOptions & Pick<OpenAPIOptions, "disableCache" | "proxyUrl">;
|
|
8
|
+
/**
|
|
9
|
+
* Configure the bundled Fumadocs OpenAPI renderer with fully typed upstream options.
|
|
10
|
+
*/
|
|
11
|
+
declare function fumadocsRenderer(options?: FumadocsApiReferenceRendererOptions): ApiReferenceRendererConfig;
|
|
12
|
+
//#endregion
|
|
13
|
+
export { FumadocsApiReferenceRendererOptions, fumadocsRenderer };
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
//#region src/fumadocs-renderer.ts
|
|
2
|
+
/**
|
|
3
|
+
* Configure the bundled Fumadocs OpenAPI renderer with fully typed upstream options.
|
|
4
|
+
*/
|
|
5
|
+
function fumadocsRenderer(options = {}) {
|
|
6
|
+
return {
|
|
7
|
+
name: "fumadocs",
|
|
8
|
+
options: { ...options }
|
|
9
|
+
};
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
//#endregion
|
|
13
|
+
export { fumadocsRenderer };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { a as createNextApiReferencePage, c as getNextApiReferenceSourceState, i as createNextApiReferenceLayout, l as resolveApiReferenceConfig, n as buildNextOpenApiDocument, r as createNextApiReference, s as getNextApiReferenceMode, u as withNextApiReferenceBanner } from "./api-reference-CTAOPJih.mjs";
|
|
2
2
|
import { createDocsAPI, createDocsMCPAPI } from "./api.mjs";
|
|
3
3
|
import { GeneratedChangelogEntry, createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams } from "./changelog.mjs";
|
|
4
|
-
import { withDocs } from "./config.mjs";
|
|
5
|
-
export { type GeneratedChangelogEntry, buildNextOpenApiDocument, createDocsAPI, createDocsMCPAPI, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withDocs, withNextApiReferenceBanner };
|
|
4
|
+
import { i as WithDocsOptions, n as DocsMdxPlugin, r as DocsMdxValue, t as withDocs } from "./config-yzp9kyZ0.mjs";
|
|
5
|
+
export { type DocsMdxPlugin, type DocsMdxValue, type GeneratedChangelogEntry, type WithDocsOptions, buildNextOpenApiDocument, createDocsAPI, createDocsMCPAPI, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withDocs, withNextApiReferenceBanner };
|
package/dist/index.mjs
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import { withDocs } from "./config.mjs";
|
|
1
|
+
import { t as withDocs } from "./config-2dZm_AHg.mjs";
|
|
2
2
|
import { createDocsAPI, createDocsMCPAPI } from "./api.mjs";
|
|
3
|
-
import {
|
|
3
|
+
import { a as withNextApiReferenceBanner } from "./api-reference-banner-q98BnSRL.mjs";
|
|
4
|
+
import { buildNextOpenApiDocument, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig } from "./api-reference.mjs";
|
|
4
5
|
import { createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams } from "./changelog.mjs";
|
|
5
6
|
|
|
6
7
|
export { buildNextOpenApiDocument, createDocsAPI, createDocsMCPAPI, createNextApiReference, createNextApiReferenceLayout, createNextApiReferencePage, createNextChangelogEntryMetadata, createNextChangelogEntryPage, createNextChangelogIndexMetadata, createNextChangelogIndexPage, createNextChangelogStaticParams, getNextApiReferenceMode, getNextApiReferenceSourceState, resolveApiReferenceConfig, withDocs, withNextApiReferenceBanner };
|
package/dist/layout.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import DocsClientCallbacks from "./client-callbacks.mjs";
|
|
2
|
-
import { withNextApiReferenceBanner } from "./api-reference.mjs";
|
|
2
|
+
import { a as withNextApiReferenceBanner } from "./api-reference-banner-q98BnSRL.mjs";
|
|
3
3
|
import { emitDocsTelemetryProjectEvent } from "@farming-labs/docs";
|
|
4
4
|
import { Fragment, jsx, jsxs } from "react/jsx-runtime";
|
|
5
5
|
import { createDocsLayout, createDocsMetadata } from "@farming-labs/theme";
|
|
@@ -1,2 +1,7 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
1
|
+
import * as Core from "@farming-labs/docs";
|
|
2
|
+
import * as Server from "@farming-labs/docs/server";
|
|
3
|
+
|
|
4
|
+
//#region src/mdx-plugins/core.d.ts
|
|
5
|
+
declare const remarkCodeGroup: typeof Server.remarkCodeGroup, applyDocsMarkdownHeadingAnchors: typeof Core.applyDocsMarkdownHeadingAnchors, encodeDocsHeadingTocUrls: typeof Core.encodeDocsHeadingTocUrls, withDocsMarkdownRenderableHeadings: typeof Core.withDocsMarkdownRenderableHeadings, isolateDocsMarkdownPromptReferences: typeof Core.isolateDocsMarkdownPromptReferences;
|
|
6
|
+
//#endregion
|
|
7
|
+
export { remarkCodeGroup as default };
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { i as remarkCodeGroup } from "../core-DRyvBL8l.mjs";
|
|
2
2
|
|
|
3
|
-
export {
|
|
3
|
+
export { remarkCodeGroup as default };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { n as encodeDocsHeadingTocUrls, o as withDocsMarkdownRenderableHeadings, r as isolateDocsMarkdownPromptReferences, t as applyDocsMarkdownHeadingAnchors } from "../core-DRyvBL8l.mjs";
|
|
2
2
|
import { remarkHeading as remarkHeading$1 } from "fumadocs-core/mdx-plugins/remark-heading";
|
|
3
3
|
|
|
4
4
|
//#region src/mdx-plugins/remark-heading.ts
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@farming-labs/next",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.121",
|
|
4
4
|
"description": "Next.js adapter for @farming-labs/docs — MDX config wrapper",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"docs",
|
|
@@ -29,6 +29,11 @@
|
|
|
29
29
|
"default": "./dist/api-reference.mjs"
|
|
30
30
|
},
|
|
31
31
|
"./api-reference.css": "./styles/api-reference.css",
|
|
32
|
+
"./fumadocs-renderer": {
|
|
33
|
+
"types": "./dist/fumadocs-renderer.d.mts",
|
|
34
|
+
"import": "./dist/fumadocs-renderer.mjs",
|
|
35
|
+
"default": "./dist/fumadocs-renderer.mjs"
|
|
36
|
+
},
|
|
32
37
|
"./api": {
|
|
33
38
|
"types": "./dist/api.d.mts",
|
|
34
39
|
"import": "./dist/api.mjs",
|
|
@@ -109,11 +114,11 @@
|
|
|
109
114
|
"tsdown": "^0.20.3",
|
|
110
115
|
"typescript": "^5.9.3",
|
|
111
116
|
"vitest": "^4.1.8",
|
|
112
|
-
"@farming-labs/docs": "0.2.
|
|
113
|
-
"@farming-labs/theme": "0.2.
|
|
117
|
+
"@farming-labs/docs": "0.2.121",
|
|
118
|
+
"@farming-labs/theme": "0.2.121"
|
|
114
119
|
},
|
|
115
120
|
"peerDependencies": {
|
|
116
|
-
"@farming-labs/docs": ">=0.2.
|
|
121
|
+
"@farming-labs/docs": ">=0.2.121",
|
|
117
122
|
"@farming-labs/theme": ">=0.0.1",
|
|
118
123
|
"next": ">=16.0.0",
|
|
119
124
|
"react": ">=19.2.0",
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import { existsSync, readFileSync } from "node:fs";
|
|
2
|
-
import { join } from "node:path";
|
|
3
|
-
|
|
4
|
-
//#region src/code-block-themes.ts
|
|
5
|
-
const DEFAULT_CODE_BLOCK_THEMES = {
|
|
6
|
-
light: "github-light",
|
|
7
|
-
dark: "github-dark"
|
|
8
|
-
};
|
|
9
|
-
const SHADCN_CODE_BLOCK_THEMES = {
|
|
10
|
-
light: "github-light-default",
|
|
11
|
-
dark: "vesper"
|
|
12
|
-
};
|
|
13
|
-
const SHADCN_THEME_IMPORT = /(?:from\s*|import\s*)["']@farming-labs\/theme\/shadcn["']/;
|
|
14
|
-
function resolveCodeBlockThemes({ root, configPath, theme }) {
|
|
15
|
-
const configFile = join(root, configPath);
|
|
16
|
-
const fallback = existsSync(configFile) && SHADCN_THEME_IMPORT.test(readFileSync(configFile, "utf8")) ? SHADCN_CODE_BLOCK_THEMES : DEFAULT_CODE_BLOCK_THEMES;
|
|
17
|
-
const codeBlock = theme?.ui?.codeBlock;
|
|
18
|
-
return {
|
|
19
|
-
light: codeBlock?.theme ?? fallback.light,
|
|
20
|
-
dark: codeBlock?.darkTheme ?? fallback.dark
|
|
21
|
-
};
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
//#endregion
|
|
25
|
-
export { resolveCodeBlockThemes as t };
|