@clarify-labs/cli 0.11.4 → 0.11.5
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/output/cli.cjs +9 -17
- package/output/cli.cjs.map +1 -1
- package/output/cli.js +9 -17
- package/output/cli.js.map +1 -1
- package/output/core/adapters.d.ts +1 -1
- package/output/core/engine/engine.d.ts +2 -1
- package/output/core/plugin/hooks.d.ts +2 -2
- package/output/core/routing/route-analysis.d.ts +11 -0
- package/output/core/routing/route-resolution.d.ts +8 -0
- package/output/core/runtime/module-ids.d.ts +5 -0
- package/output/core/runtime/virtual-modules.d.ts +2 -1
- package/output/{engine-CJmXVTo5.js → engine-DuiJVdO8.js} +378 -220
- package/output/engine-DuiJVdO8.js.map +1 -0
- package/output/{engine-Cgc71w13.cjs → engine-VgAP_Ms6.cjs} +383 -219
- package/output/engine-VgAP_Ms6.cjs.map +1 -0
- package/output/index.cjs +1 -1
- package/output/index.js +1 -1
- package/output/parsers/content/content.d.ts +1 -1
- package/output/parsers/markdown/mdx.d.ts +1 -1
- package/output/parsers/routes/routes.d.ts +4 -5
- package/output/parsers/routes/routes.test-utils.d.ts +5 -3
- package/output/plugins/openapi/parser.d.ts +2 -2
- package/output/plugins/openapi/routes.d.ts +3 -0
- package/output/plugins/openapi/state.d.ts +7 -0
- package/output/types.d.ts +24 -9
- package/package.json +3 -3
- package/output/engine-CJmXVTo5.js.map +0 -1
- package/output/engine-Cgc71w13.cjs.map +0 -1
package/output/index.cjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
-
const require_engine = require("./engine-
|
|
2
|
+
const require_engine = require("./engine-VgAP_Ms6.cjs");
|
|
3
3
|
exports.ClarifyEngine = require_engine.ClarifyEngine;
|
|
4
4
|
exports.createClarifyEngine = require_engine.createClarifyEngine;
|
|
5
5
|
exports.createViteAdapter = require_engine.createViteAdapter;
|
package/output/index.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { d as defineConfig, n as createClarifyEngine, t as ClarifyEngine, u as createViteAdapter } from "./engine-DuiJVdO8.js";
|
|
2
2
|
export { ClarifyEngine, createClarifyEngine, createViteAdapter, defineConfig };
|
|
@@ -6,7 +6,7 @@ export type ProcessedMdxContent = {
|
|
|
6
6
|
export type ContentTransform = (input: ClarifyContentTransformInput) => Promise<ClarifyContentTransformInput> | ClarifyContentTransformInput;
|
|
7
7
|
export type ContentProcessor = {
|
|
8
8
|
processMdx(source: string, filePath?: string): Promise<ProcessedMdxContent>;
|
|
9
|
-
processText(source: string, kind: Exclude<ClarifyContentKind, '
|
|
9
|
+
processText(source: string, kind: Exclude<ClarifyContentKind, 'markdown+jsx'>, filePath?: string): Promise<string>;
|
|
10
10
|
};
|
|
11
11
|
export declare function createContentProcessor(transform?: ContentTransform): ContentProcessor;
|
|
12
12
|
/**
|
|
@@ -11,7 +11,7 @@ export declare function rehypeParseCodeBlocks(): (tree: HastNode) => void;
|
|
|
11
11
|
export declare const remarkPlugins: unknown[];
|
|
12
12
|
export declare const rehypePlugins: NonNullable<CompileOptions['rehypePlugins']>;
|
|
13
13
|
type ContentCompileDiagnosticOptions = {
|
|
14
|
-
format: 'markdown' | '
|
|
14
|
+
format: 'markdown' | 'markdown+jsx';
|
|
15
15
|
phase: 'syntax' | 'compilation';
|
|
16
16
|
error: unknown;
|
|
17
17
|
filePath?: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ContentRoute, ClarifyNavigationNode, ClarifyPagesConfig, ClarifyPagesGroup, ClarifyPagesItem, ClarifyRouteIntent, ClarifyTabsConfig, LocalizedNavigation, LocalizedTabbedNavigation, ResolvedClarifyLocalesConfig, TabbedNavigation } from '../../types.js';
|
|
1
|
+
import { ContentRoute, ClarifyNavigationNode, ClarifyPagesConfig, ClarifyPagesGroup, ClarifyPagesItem, ClarifyRouteIntent, ClarifyTabsConfig, LocalizedNavigation, LocalizedTabbedNavigation, MarkdownContentRoute, ResolvedClarifyLocalesConfig, TabbedNavigation } from '../../types.js';
|
|
2
2
|
import { ContentProcessor } from '../content/content.js';
|
|
3
3
|
export type FindContentRoutesOptions = {
|
|
4
4
|
contentProcessor?: ContentProcessor;
|
|
@@ -8,11 +8,10 @@ export declare function normalizePath(path: string): string;
|
|
|
8
8
|
export declare function basePathFromRef(ref: string): string;
|
|
9
9
|
export declare function openAPIPagePathFromRef(ref: string, tagFilter?: string[], explicitPath?: string): string;
|
|
10
10
|
export declare function routePathFromRef(ref: string, explicitPath?: string): string;
|
|
11
|
-
export declare function virtualModuleIdFromRef(ref: string): string;
|
|
12
11
|
export declare function localizedRoutePath(basePath: string, locale: string, _i18n: ResolvedClarifyLocalesConfig): string;
|
|
13
|
-
export declare function findContentRoutes(dir: string, base?: string, options?: FindContentRoutesOptions): Promise<
|
|
14
|
-
export declare function withAlternates(route:
|
|
15
|
-
export declare function findLocalizedContentRoutes(contentRoot: string, locales?: ResolvedClarifyLocalesConfig, options?: FindContentRoutesOptions): Promise<
|
|
12
|
+
export declare function findContentRoutes(dir: string, base?: string, options?: FindContentRoutesOptions): Promise<MarkdownContentRoute[]>;
|
|
13
|
+
export declare function withAlternates<T extends ContentRoute>(route: T, routes: ContentRoute[], locales: ResolvedClarifyLocalesConfig): T;
|
|
14
|
+
export declare function findLocalizedContentRoutes(contentRoot: string, locales?: ResolvedClarifyLocalesConfig, options?: FindContentRoutesOptions): Promise<MarkdownContentRoute[]>;
|
|
16
15
|
export declare function buildNavigation(routes: ContentRoute[]): ClarifyNavigationNode[];
|
|
17
16
|
export declare function routeIntentFromPagesItem(item: ClarifyPagesItem): ClarifyRouteIntent;
|
|
18
17
|
export declare function applyConfiguredPageRoutePaths(routes: ContentRoute[], tabs?: ClarifyTabsConfig, locales?: ResolvedClarifyLocalesConfig): ContentRoute[];
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { ContentRoute, ResolvedClarifyLocalesConfig } from '../../types.js';
|
|
2
|
-
type ContentRouteFixture = Partial<Omit<ContentRoute, 'kind' | 'meta' | 'module' | 'source'>> & {
|
|
1
|
+
import { ContentRoute, OpenAPIContentRoute, ResolvedClarifyLocalesConfig } from '../../types.js';
|
|
2
|
+
type ContentRouteFixture = Partial<Omit<ContentRoute, 'kind' | 'meta' | 'module' | 'source' | 'openapi'>> & {
|
|
3
3
|
kind?: ContentRoute['kind'];
|
|
4
4
|
title?: string;
|
|
5
5
|
description?: string;
|
|
@@ -9,7 +9,9 @@ type ContentRouteFixture = Partial<Omit<ContentRoute, 'kind' | 'meta' | 'module'
|
|
|
9
9
|
frontmatter?: ContentRoute['source']['frontmatter'];
|
|
10
10
|
content?: string;
|
|
11
11
|
sourceEditUrl?: string;
|
|
12
|
-
|
|
12
|
+
pageVirtualModuleId?: string;
|
|
13
|
+
contentVirtualModuleId?: string;
|
|
14
|
+
openapi?: OpenAPIContentRoute['openapi'];
|
|
13
15
|
meta?: Partial<ContentRoute['meta']>;
|
|
14
16
|
module?: Partial<ContentRoute['module']>;
|
|
15
17
|
source?: Partial<ContentRoute['source']>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ContentProcessor } from '../../parsers/content/content.js';
|
|
2
|
-
import { ContentDiagnostic,
|
|
2
|
+
import { ContentDiagnostic, ContentSection, OpenAPIContentRoute, OpenAPISpec } from '../../types.js';
|
|
3
3
|
export type OpenAPIParseResult = {
|
|
4
4
|
ok: true;
|
|
5
5
|
spec: OpenAPISpec;
|
|
@@ -7,7 +7,7 @@ export type OpenAPIParseResult = {
|
|
|
7
7
|
ok: false;
|
|
8
8
|
diagnostic: ContentDiagnostic;
|
|
9
9
|
};
|
|
10
|
-
export declare function findOpenAPIRoutes(dir: string, base?: string):
|
|
10
|
+
export declare function findOpenAPIRoutes(dir: string, base?: string): OpenAPIContentRoute[];
|
|
11
11
|
export declare function normalizeOpenAPISpecSectionIds(spec: OpenAPISpec): OpenAPISpec;
|
|
12
12
|
/** Filter an OpenAPI spec to only include paths that have at least one operation matching the given tags. */
|
|
13
13
|
export declare function filterSpecByTags(spec: OpenAPISpec, tags: string[]): OpenAPISpec;
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { ContentRoute, OpenAPIContentRoute, ResolvedClarifyLocalesConfig, ResolvedProjectConfig } from '../../types.js';
|
|
2
|
+
export declare function discoverOpenAPIRoutes(contentRoot: string, locales?: ResolvedClarifyLocalesConfig): OpenAPIContentRoute[];
|
|
3
|
+
export declare function expandConfiguredOpenAPIRoutes(routes: ContentRoute[], config: ResolvedProjectConfig): ContentRoute[];
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { VirtualModules } from '../../core/runtime/virtual-modules.js';
|
|
2
|
+
import { ClarifyHookContext, ContentRoute } from '../../types.js';
|
|
3
|
+
export declare class OpenAPIPluginState {
|
|
4
|
+
private readonly specModules;
|
|
5
|
+
enrichRoutes(routes: ContentRoute[], ctx: ClarifyHookContext): Promise<ContentRoute[]>;
|
|
6
|
+
contributeModules(modules: VirtualModules, routes: ContentRoute[]): VirtualModules;
|
|
7
|
+
}
|
package/output/types.d.ts
CHANGED
|
@@ -275,9 +275,16 @@ export type ContentRouteMeta = {
|
|
|
275
275
|
keywords?: string[];
|
|
276
276
|
sections?: ContentSection[];
|
|
277
277
|
};
|
|
278
|
-
export type
|
|
279
|
-
|
|
278
|
+
export type PageRouteModule = {
|
|
279
|
+
pageVirtualModuleId: string;
|
|
280
280
|
};
|
|
281
|
+
export type MarkdownRouteModule = PageRouteModule & {
|
|
282
|
+
contentVirtualModuleId: string;
|
|
283
|
+
};
|
|
284
|
+
export type OpenAPIRouteModule = PageRouteModule & {
|
|
285
|
+
contentVirtualModuleId?: never;
|
|
286
|
+
};
|
|
287
|
+
export type ContentRouteModule = MarkdownRouteModule | OpenAPIRouteModule;
|
|
281
288
|
export type OpenAPIContentRouteState = {
|
|
282
289
|
/** Operation tag filter applied to this route. Undefined means all operations. */
|
|
283
290
|
tagFilter?: string[];
|
|
@@ -298,7 +305,7 @@ export type ContentRouteSource = {
|
|
|
298
305
|
/** Public edit URL for this route's source file. */
|
|
299
306
|
sourceEditUrl?: string;
|
|
300
307
|
};
|
|
301
|
-
|
|
308
|
+
type ContentRouteBase = {
|
|
302
309
|
path: string;
|
|
303
310
|
basePath?: string;
|
|
304
311
|
locale?: string;
|
|
@@ -306,15 +313,22 @@ export type ContentRoute = {
|
|
|
306
313
|
/** Indicates this route is a bare alias for the default locale (e.g., /path instead of /locale/path). Should not be indexed. */
|
|
307
314
|
isBareAlias?: boolean;
|
|
308
315
|
alternates?: Record<string, string>;
|
|
309
|
-
kind: string;
|
|
310
316
|
meta: ContentRouteMeta;
|
|
311
|
-
module: ContentRouteModule;
|
|
312
317
|
source: ContentRouteSource;
|
|
313
|
-
/** OpenAPI-specific route state. Present only for OpenAPI routes. */
|
|
314
|
-
openapi?: OpenAPIContentRouteState;
|
|
315
318
|
diagnostic?: ContentDiagnostic;
|
|
316
319
|
artifacts?: ContentRouteArtifacts;
|
|
317
320
|
};
|
|
321
|
+
export type MarkdownContentRoute = ContentRouteBase & {
|
|
322
|
+
kind: 'markdown' | 'markdown+jsx';
|
|
323
|
+
module: MarkdownRouteModule;
|
|
324
|
+
openapi?: never;
|
|
325
|
+
};
|
|
326
|
+
export type OpenAPIContentRoute = ContentRouteBase & {
|
|
327
|
+
kind: 'openapi';
|
|
328
|
+
module: OpenAPIRouteModule;
|
|
329
|
+
openapi?: OpenAPIContentRouteState;
|
|
330
|
+
};
|
|
331
|
+
export type ContentRoute = MarkdownContentRoute | OpenAPIContentRoute;
|
|
318
332
|
export type ClarifyNavigationTab = {
|
|
319
333
|
type: 'tab';
|
|
320
334
|
path: string;
|
|
@@ -385,7 +399,7 @@ export type ClarifyRouteDiscoveryInput = {
|
|
|
385
399
|
locale?: string;
|
|
386
400
|
routes: ContentRoute[];
|
|
387
401
|
};
|
|
388
|
-
export type ClarifyContentKind = '
|
|
402
|
+
export type ClarifyContentKind = 'markdown' | 'markdown+jsx' | 'openapi';
|
|
389
403
|
export type ClarifyContentTransformInput = {
|
|
390
404
|
kind: ClarifyContentKind;
|
|
391
405
|
source: string;
|
|
@@ -449,8 +463,9 @@ export type ClarifyBuildHooks = {
|
|
|
449
463
|
'build:shouldRun'?: ClarifyInterceptHook;
|
|
450
464
|
'ssg:shouldRun'?: ClarifyInterceptHook;
|
|
451
465
|
};
|
|
466
|
+
export type ClarifyDevServerPostHook = () => void;
|
|
452
467
|
export type ClarifyDevHooks = {
|
|
453
|
-
'dev:configureServer'?: (server: ViteDevServer, ctx: ClarifyHookContext) => MaybePromise<void>;
|
|
468
|
+
'dev:configureServer'?: (server: ViteDevServer, ctx: ClarifyHookContext) => MaybePromise<void | ClarifyDevServerPostHook>;
|
|
454
469
|
};
|
|
455
470
|
export type ClarifyHooks = ClarifyLifecycleHooks & ClarifyPipelineHooks & ClarifyBuildHooks & ClarifyDevHooks;
|
|
456
471
|
export type ClarifyPlugin = {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@clarify-labs/cli",
|
|
3
|
-
"version": "0.11.
|
|
3
|
+
"version": "0.11.5",
|
|
4
4
|
"license": "AGPL-3.0-only",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"repository": {
|
|
@@ -39,8 +39,8 @@
|
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
41
|
"@apidevtools/swagger-parser": "^12.1.0",
|
|
42
|
-
"@clarify-labs/renderer": "0.11.
|
|
43
|
-
"@clarify-labs/templates": "0.11.
|
|
42
|
+
"@clarify-labs/renderer": "0.11.5",
|
|
43
|
+
"@clarify-labs/templates": "0.11.5",
|
|
44
44
|
"@mdx-js/mdx": "^3.1.1",
|
|
45
45
|
"@mdx-js/rollup": "^3.1.1",
|
|
46
46
|
"@modelcontextprotocol/sdk": "^1.29.0",
|