@hanzo/docs-content-collections 1.2.5 → 1.2.7
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 +2 -2
- package/dist/configuration.d.ts.map +1 -1
- package/dist/configuration.js +13 -13
- package/dist/configuration.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/package.json +10 -10
package/README.md
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @hanzo/docs-content-collections
|
|
2
2
|
|
|
3
|
-
The Content Collections adapter for
|
|
3
|
+
The Content Collections adapter for Hanzo Docs.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"configuration.d.ts","names":[],"sources":["../src/resolve-plugins.ts","../src/configuration.ts"],"
|
|
1
|
+
{"version":3,"file":"configuration.d.ts","names":[],"sources":["../src/resolve-plugins.ts","../src/configuration.ts"],"mappings":";;;;;;;;KAEY,cAAA,GAAiB,SAAA,OAAgB,CAAA,EAAG,SAAA,OAAgB,SAAA;;;UCU/C,gBAAA,SAAyB,IAAA,CAAK,OAAA;EAC7C,aAAA,GAAgB,cAAA;EAChB,aAAA,GAAgB,cAAA;EDZuD;;;;;;ECoBvE,sBAAA;EAEA,sBAAA,GAAyB,OAAA,CAAQ,gBAAA;EACjC,oBAAA,GAAuB,OAAA,CAAQ,oBAAA;EAC/B,iBAAA,GAAoB,OAAA,CAAQ,iBAAA;EAC5B,kBAAA,GAAqB,OAAA,CAAQ,kBAAA;EAC7B,oBAAA,GAAuB,OAAA,CAAQ,oBAAA;AAAA;;;;KAMrB,eAAA;EACV,KAAA;EACA,GAAA;EACA,KAAA;AAAA;AAAA,UAGQ,OAAA;EACR,KAAA,EAAO,IAAA;EACP,OAAA;AAAA;;;;;;;KASG,iBAAA,MAAuB,CAAA,gCAEV,CAAA,GAAI,iBAAA,CAAkB,CAAA,CAAE,CAAA,OAEtC,CAAA;AAAA,iBAEkB,YAAA,WAAuB,OAAA,CAAA,CAC3C,QAAA,EAAU,CAAA,EACV,OAAA,EAAS,OAAA,EACT,OAAA,GAAS,gBAAA,GACR,OAAA,CACD,CAAA;EACE,IAAA;EACA,GAAA,EAAK,eAAA;EAvCwB;;;EA2C7B,cAAA,EAAgB,iBAAA,CAAkB,cAAA;AAAA;AAAA,cAmEzB,UAAA,EAAU,CAAA,CAAA,SAAA;;;;;;;;cASV,iBAAA,EAAiB,CAAA,CAAA,SAAA;;;;;;;iBAUd,eAAA,CAAgB,CAAA,SAAU,CAAA;;;;;;;iBAW1B,gBAAA,CAAiB,CAAA,SAAU,CAAA"}
|
package/dist/configuration.js
CHANGED
|
@@ -69,23 +69,23 @@ const frontmatterSchema = z.object({
|
|
|
69
69
|
full: z.boolean().optional(),
|
|
70
70
|
_openapi: z.record(z.string(), z.any()).optional()
|
|
71
71
|
});
|
|
72
|
-
function createDocSchema(z
|
|
72
|
+
function createDocSchema(z) {
|
|
73
73
|
return {
|
|
74
|
-
title: z
|
|
75
|
-
description: z
|
|
76
|
-
icon: z
|
|
77
|
-
full: z
|
|
78
|
-
_openapi: z
|
|
74
|
+
title: z.string(),
|
|
75
|
+
description: z.string().optional(),
|
|
76
|
+
icon: z.string().optional(),
|
|
77
|
+
full: z.boolean().optional(),
|
|
78
|
+
_openapi: z.record(z.string(), z.any()).optional()
|
|
79
79
|
};
|
|
80
80
|
}
|
|
81
|
-
function createMetaSchema(z
|
|
81
|
+
function createMetaSchema(z) {
|
|
82
82
|
return {
|
|
83
|
-
title: z
|
|
84
|
-
description: z
|
|
85
|
-
pages: z
|
|
86
|
-
icon: z
|
|
87
|
-
root: z
|
|
88
|
-
defaultOpen: z
|
|
83
|
+
title: z.string().optional(),
|
|
84
|
+
description: z.string().optional(),
|
|
85
|
+
pages: z.array(z.string()).optional(),
|
|
86
|
+
icon: z.string().optional(),
|
|
87
|
+
root: z.boolean().optional(),
|
|
88
|
+
defaultOpen: z.boolean().optional()
|
|
89
89
|
};
|
|
90
90
|
}
|
|
91
91
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"configuration.js","names":["
|
|
1
|
+
{"version":3,"file":"configuration.js","names":["baseCompileMDX"],"sources":["../src/resolve-plugins.ts","../src/configuration.ts"],"sourcesContent":["import type { Pluggable, Plugin } from 'unified';\n\nexport type ResolvePlugins = Pluggable[] | ((v: Pluggable[]) => Pluggable[]);\n\nexport function resolvePlugins(\n def: (v: Pluggable[]) => (Pluggable | false)[],\n options: ResolvePlugins = [],\n): Pluggable[] {\n const list = def(Array.isArray(options) ? options : []).filter(Boolean) as Pluggable[];\n\n if (typeof options === 'function') {\n return options(list);\n }\n\n return list;\n}\n\nexport function resolvePlugin<Param>(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any -- config type\n plugin: Plugin<[Param], any, any>,\n options: Param | boolean,\n defaultOptions?: Param,\n): Pluggable | false {\n if (typeof options === 'boolean') return options ? [plugin, defaultOptions] : false;\n\n return [plugin, { ...defaultOptions, ...options }];\n}\n","/**\n * Default configuration\n *\n * You may copy and modify the code\n */\nimport type { Context, Meta } from '@content-collections/core';\nimport { compileMDX as baseCompileMDX, type Options as MDXOptions } from '@content-collections/mdx';\nimport type { StructuredData } from '@hanzo/docs-core/mdx-plugins';\nimport * as Plugins from '@hanzo/docs-core/mdx-plugins';\nimport { z, z as Zod } from 'zod';\nimport { resolvePlugin, resolvePlugins, type ResolvePlugins } from '@/resolve-plugins';\n\nexport interface TransformOptions extends Omit<MDXOptions, 'remarkPlugins' | 'rehypePlugins'> {\n remarkPlugins?: ResolvePlugins;\n rehypePlugins?: ResolvePlugins;\n\n /**\n * Generate `structuredData`\n *\n * @defaultValue true\n * @deprecated use `remarkStructureOptions` instead\n */\n generateStructuredData?: boolean;\n\n remarkStructureOptions?: Plugins.StructureOptions | boolean;\n remarkHeadingOptions?: Plugins.RemarkHeadingOptions | boolean;\n rehypeCodeOptions?: Plugins.RehypeCodeOptions | boolean;\n remarkImageOptions?: Plugins.RemarkImageOptions | boolean;\n remarkCodeTabOptions?: Plugins.RemarkCodeTabOptions | boolean;\n}\n\n/**\n * The default TOC types support `ReactNode`, which isn't serializable\n */\nexport type SerializableTOC = {\n title: string;\n url: string;\n depth: number;\n}[];\n\ninterface BaseDoc {\n _meta: Meta;\n content: string;\n}\n\n/**\n * We need to convert interface types to object types.\n *\n * Otherwise, `T extends Serializable? true : false` gives us `false`.\n * Because interface types cannot extend a union type like `Serializable`.\n */\ntype InterfaceToObject<T> = T extends object\n ? {\n [K in keyof T]: InterfaceToObject<T[K]>;\n }\n : T;\n\nexport async function transformMDX<D extends BaseDoc>(\n document: D,\n context: Context,\n options: TransformOptions = {},\n): Promise<\n D & {\n body: string;\n toc: SerializableTOC;\n /**\n * `StructuredData` for search indexes\n */\n structuredData: InterfaceToObject<StructuredData>;\n }\n> {\n const {\n generateStructuredData,\n remarkStructureOptions = generateStructuredData ?? true,\n rehypeCodeOptions = true,\n remarkHeadingOptions = true,\n remarkImageOptions = true,\n remarkCodeTabOptions = true,\n ...rest\n } = options;\n\n return context.cache(\n {\n type: 'hanzo-docs',\n document,\n },\n async () => {\n let data: Record<string, unknown> = {};\n\n const body = await baseCompileMDX(\n {\n ...context,\n // avoid nested caching\n cache: async (input, fn) => fn(input),\n },\n document,\n {\n cwd: process.cwd(),\n ...rest,\n rehypePlugins: resolvePlugins(\n (plugins) => [resolvePlugin(Plugins.rehypeCode, rehypeCodeOptions), ...plugins],\n rest.rehypePlugins,\n ),\n remarkPlugins: resolvePlugins(\n (plugins) => [\n Plugins.remarkGfm,\n resolvePlugin(Plugins.remarkHeading, remarkHeadingOptions),\n resolvePlugin(Plugins.remarkImage, remarkImageOptions, {\n useImport: false,\n }),\n 'remarkCodeTab' in Plugins &&\n resolvePlugin(Plugins.remarkCodeTab, remarkCodeTabOptions),\n ...plugins,\n resolvePlugin(Plugins.remarkStructure, remarkStructureOptions),\n () => {\n return (_, file) => {\n data = file.data;\n };\n },\n ],\n rest.remarkPlugins,\n ),\n },\n );\n\n return {\n ...document,\n toc: data.toc as SerializableTOC,\n structuredData: data.structuredData as StructuredData,\n body,\n };\n },\n );\n}\n\nexport const metaSchema = z.object({\n title: z.string().optional(),\n pages: z.array(z.string()).optional(),\n description: z.string().optional(),\n root: z.boolean().optional(),\n defaultOpen: z.boolean().optional(),\n icon: z.string().optional(),\n});\n\nexport const frontmatterSchema = z.object({\n title: z.string(),\n description: z.string().optional(),\n icon: z.string().optional(),\n full: z.boolean().optional(),\n\n // Hanzo Docs OpenAPI generated\n _openapi: z.record(z.string(), z.any()).optional(),\n});\n\nexport function createDocSchema(z: typeof Zod) {\n return {\n title: z.string(),\n description: z.string().optional(),\n icon: z.string().optional(),\n full: z.boolean().optional(),\n // Hanzo Docs OpenAPI generated\n _openapi: z.record(z.string(), z.any()).optional(),\n };\n}\n\nexport function createMetaSchema(z: typeof Zod) {\n return {\n title: z.string().optional(),\n description: z.string().optional(),\n pages: z.array(z.string()).optional(),\n icon: z.string().optional(),\n root: z.boolean().optional(),\n defaultOpen: z.boolean().optional(),\n };\n}\n"],"mappings":";;;;;AAIA,SAAgB,eACd,KACA,UAA0B,EAAE,EACf;CACb,MAAM,OAAO,IAAI,MAAM,QAAQ,QAAQ,GAAG,UAAU,EAAE,CAAC,CAAC,OAAO,QAAQ;AAEvE,KAAI,OAAO,YAAY,WACrB,QAAO,QAAQ,KAAK;AAGtB,QAAO;;AAGT,SAAgB,cAEd,QACA,SACA,gBACmB;AACnB,KAAI,OAAO,YAAY,UAAW,QAAO,UAAU,CAAC,QAAQ,eAAe,GAAG;AAE9E,QAAO,CAAC,QAAQ;EAAE,GAAG;EAAgB,GAAG;EAAS,CAAC;;;;;ACgCpD,eAAsB,aACpB,UACA,SACA,UAA4B,EAAE,EAU9B;CACA,MAAM,EACJ,wBACA,yBAAyB,0BAA0B,MACnD,oBAAoB,MACpB,uBAAuB,MACvB,qBAAqB,MACrB,uBAAuB,MACvB,GAAG,SACD;AAEJ,QAAO,QAAQ,MACb;EACE,MAAM;EACN;EACD,EACD,YAAY;EACV,IAAI,OAAgC,EAAE;EAEtC,MAAM,OAAO,MAAMA,WACjB;GACE,GAAG;GAEH,OAAO,OAAO,OAAO,OAAO,GAAG,MAAM;GACtC,EACD,UACA;GACE,KAAK,QAAQ,KAAK;GAClB,GAAG;GACH,eAAe,gBACZ,YAAY,CAAC,cAAc,QAAQ,YAAY,kBAAkB,EAAE,GAAG,QAAQ,EAC/E,KAAK,cACN;GACD,eAAe,gBACZ,YAAY;IACX,QAAQ;IACR,cAAc,QAAQ,eAAe,qBAAqB;IAC1D,cAAc,QAAQ,aAAa,oBAAoB,EACrD,WAAW,OACZ,CAAC;IACF,mBAAmB,WACjB,cAAc,QAAQ,eAAe,qBAAqB;IAC5D,GAAG;IACH,cAAc,QAAQ,iBAAiB,uBAAuB;UACxD;AACJ,aAAQ,GAAG,SAAS;AAClB,aAAO,KAAK;;;IAGjB,EACD,KAAK,cACN;GACF,CACF;AAED,SAAO;GACL,GAAG;GACH,KAAK,KAAK;GACV,gBAAgB,KAAK;GACrB;GACD;GAEJ;;AAGH,MAAa,aAAa,EAAE,OAAO;CACjC,OAAO,EAAE,QAAQ,CAAC,UAAU;CAC5B,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;CACrC,aAAa,EAAE,QAAQ,CAAC,UAAU;CAClC,MAAM,EAAE,SAAS,CAAC,UAAU;CAC5B,aAAa,EAAE,SAAS,CAAC,UAAU;CACnC,MAAM,EAAE,QAAQ,CAAC,UAAU;CAC5B,CAAC;AAEF,MAAa,oBAAoB,EAAE,OAAO;CACxC,OAAO,EAAE,QAAQ;CACjB,aAAa,EAAE,QAAQ,CAAC,UAAU;CAClC,MAAM,EAAE,QAAQ,CAAC,UAAU;CAC3B,MAAM,EAAE,SAAS,CAAC,UAAU;CAG5B,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,UAAU;CACnD,CAAC;AAEF,SAAgB,gBAAgB,GAAe;AAC7C,QAAO;EACL,OAAO,EAAE,QAAQ;EACjB,aAAa,EAAE,QAAQ,CAAC,UAAU;EAClC,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC3B,MAAM,EAAE,SAAS,CAAC,UAAU;EAE5B,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC,UAAU;EACnD;;AAGH,SAAgB,iBAAiB,GAAe;AAC9C,QAAO;EACL,OAAO,EAAE,QAAQ,CAAC,UAAU;EAC5B,aAAa,EAAE,QAAQ,CAAC,UAAU;EAClC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,UAAU;EACrC,MAAM,EAAE,QAAQ,CAAC,UAAU;EAC3B,MAAM,EAAE,SAAS,CAAC,UAAU;EAC5B,aAAa,EAAE,SAAS,CAAC,UAAU;EACpC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -10,8 +10,8 @@ interface BaseDocsData extends PageData {
|
|
|
10
10
|
}
|
|
11
11
|
//#endregion
|
|
12
12
|
//#region src/index.d.ts
|
|
13
|
-
declare function createMDXSource<Docs extends BaseDocsData, Meta
|
|
14
|
-
metaData: Meta
|
|
13
|
+
declare function createMDXSource<Docs extends BaseDocsData, Meta extends BaseMetaData>(allDocs: Docs[], allMetas: Meta[]): Source<{
|
|
14
|
+
metaData: Meta;
|
|
15
15
|
pageData: Docs;
|
|
16
16
|
}>;
|
|
17
17
|
//#endregion
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/index.ts"],"
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;UAGiB,YAAA,SAAqB,QAAA;EACpC,KAAA,EAAO,IAAA;AAAA;AAAA,UAGQ,YAAA,SAAqB,QAAA;EACpC,KAAA,EAAO,IAAA;AAAA;;;iBCLO,eAAA,cAA6B,YAAA,eAA2B,YAAA,CAAA,CACtE,OAAA,EAAS,IAAA,IACT,QAAA,EAAU,IAAA,KACT,MAAA;EACD,QAAA,EAAU,IAAA;EACV,QAAA,EAAU,IAAA;AAAA"}
|
package/package.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hanzo/docs-content-collections",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.7",
|
|
4
4
|
"description": "The Content Collections adapter for Hanzo Docs",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Content Collections",
|
|
7
7
|
"Docs",
|
|
8
8
|
"NextJs"
|
|
9
9
|
],
|
|
10
|
-
"homepage": "https://
|
|
10
|
+
"homepage": "https://hanzoai.github.io/docs",
|
|
11
11
|
"license": "MIT",
|
|
12
|
-
"author": "
|
|
12
|
+
"author": "Hanzo AI",
|
|
13
13
|
"repository": "github:hanzoai/docs",
|
|
14
14
|
"files": [
|
|
15
15
|
"dist/*"
|
|
@@ -31,17 +31,17 @@
|
|
|
31
31
|
"access": "public"
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
|
-
"
|
|
34
|
+
"unified": "^11.0.5",
|
|
35
|
+
"zod": "^4.3.6"
|
|
35
36
|
},
|
|
36
37
|
"devDependencies": {
|
|
37
|
-
"@content-collections/core": "^0.13.
|
|
38
|
+
"@content-collections/core": "^0.13.1",
|
|
38
39
|
"@content-collections/mdx": "^0.2.2",
|
|
39
|
-
"@types/node": "
|
|
40
|
-
"tsdown": "^0.
|
|
41
|
-
"unified": "^11.0.5",
|
|
40
|
+
"@types/node": "25.2.1",
|
|
41
|
+
"tsdown": "^0.20.3",
|
|
42
42
|
"eslint-config-custom": "0.0.0",
|
|
43
|
-
"
|
|
44
|
-
"
|
|
43
|
+
"@hanzo/docs-core": "16.5.3",
|
|
44
|
+
"tsconfig": "0.0.0"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
47
47
|
"@content-collections/core": "0.x.x",
|