@fumadocs/cli 0.2.0 → 1.0.0

package/dist/build/index.d.ts

@@ -1,128 +1,146 @@
+import { z } from 'zod';
 import * as ts_morph from 'ts-morph';
+import { Registry as Registry$1 } from 'shadcn/registry';
 
-type ImportPathMap = Record<string, string | {
-    type: 'component';
-    name: string;
-    file: string;
+type Output = z.infer<typeof rootSchema>;
+type NamespaceType = (typeof namespaces)[number];
+declare const namespaces: readonly ["components", "lib", "css", "route", "ui", "block"];
+declare const rootSchema: z.ZodObject<{
+    name: z.ZodString;
+    index: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    components: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        files: z.ZodArray<z.ZodObject<{
+            type: z.ZodLiteral<"components" | "lib" | "css" | "route" | "ui" | "block">;
+            path: z.ZodString;
+            target: z.ZodOptional<z.ZodString>;
+            content: z.ZodString;
+        }, z.core.$strip>>;
+        dependencies: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+        devDependencies: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNull]>>;
+        subComponents: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+
+type ComponentBuilder = ReturnType<typeof createComponentBuilder>;
+/**
+ * @param registry registry object
+ * @param packageJson parsed package json object
+ */
+declare function createComponentBuilder(registry: Registry, packageJson: PackageJson | undefined): {
+    registryDir: string;
+    registry: Registry;
+    getDepFromSpecifier(specifier: string): string;
+    getDepInfo(name: string): {
+        type: "runtime" | "dev";
+        name: string;
+        version: string | null;
+    } | undefined;
+    createSourceFile(file: string): Promise<ts_morph.SourceFile>;
+    getComponentByName(name: string): Component | undefined;
+    getSubComponent(file: string): {
+        component: Component;
+        file: ComponentFile;
+    } | undefined;
+};
+
+type SourceReference = {
+    type: 'file';
     /**
-     * Registry of the component, refer to the current registry if not specified
+     * Absolute path
      */
-    registry?: string;
+    file: string;
 } | {
     type: 'dependency';
-    name: string;
-}>;
+    dep: string;
+    specifier: string;
+} | {
+    type: 'sub-component';
+    resolved: {
+        type: 'local';
+        component: Component;
+        file: ComponentFile;
+    } | {
+        type: 'remote';
+        component: Component;
+        file: ComponentFile;
+        registryName: string;
+    };
+};
+type Reference = SourceReference | {
+    type: 'custom';
+    specifier: string;
+};
+
+type OnResolve = (reference: SourceReference) => Reference;
+interface ComponentFile {
+    type: NamespaceType;
+    path: string;
+    target?: string;
+}
 interface Component {
     name: string;
+    title?: string;
     description?: string;
-    files: (string | {
-        in: string;
-        out: string;
-    })[];
+    files: ComponentFile[];
     /**
      * Don't list the component in registry index file
      */
     unlisted?: boolean;
     /**
-     * Map imported file paths, extended from registry `mapImportPath` if defined.
+     * Map imported file paths, inherit from registry if not defined.
      */
-    mapImportPath?: ImportPathMap;
+    onResolve?: OnResolve;
 }
-type NamespaceType = 'components' | 'hooks' | 'lib';
 interface PackageJson {
     dependencies: Record<string, string>;
     devDependencies: Record<string, string>;
 }
 interface Registry {
+    name: string;
+    packageJson: string | PackageJson;
+    tsconfigPath: string;
+    components: Component[];
     /**
-     * The directory of registry, needed to resolve relative paths
+     * The directory of registry, used to resolve relative paths
      */
     dir: string;
-    /**
-     * Extend on existing registry
-     */
-    on?: Record<string, {
-        type: 'remote';
-        registry: Output;
-    } | {
-        type: 'local';
-        registry: Registry;
-    }>;
-    /**
-     * The root directory project, used to resolve config paths
-     */
-    rootDir: string;
-    namespaces?: Record<string, NamespaceType>;
-    tsconfigPath?: string;
-    packageJson?: string | PackageJson;
-    components: Component[];
     /**
      * Map import paths of components
      */
-    mapImportPath?: ImportPathMap;
-    dependencies?: Record<string, {
-        type: 'runtime' | 'dev';
-        version?: string;
-    }>;
-}
-interface Output {
-    index: OutputIndex[];
-    components: OutputComponent[];
-}
-interface OutputIndex {
-    name: string;
-    description?: string;
-}
-interface OutputFile {
-    path: string;
-    content: string;
+    onResolve?: OnResolve;
     /**
-     * Import reference path - path in `files`
+     * When a referenced file is not found in component files, this function is called.
      */
-    imports: Record<string, string>;
-}
-interface OutputComponent {
-    name: string;
-    files: OutputFile[];
-    dependencies: Record<string, string>;
-    devDependencies: Record<string, string>;
-    subComponents: string[];
+    onUnknownFile?: (absolutePath: string) => ComponentFile | undefined;
+    dependencies?: Record<string, string | null>;
+    devDependencies?: Record<string, string | null>;
 }
 declare function build(registry: Registry): Promise<Output>;
 
-interface DependencyInfo {
-    type: 'runtime' | 'dev';
-    version?: string;
-}
-type GetComponentResult = {
-    type: 'local';
-    registryName?: string;
-    component: Component;
-} | {
-    type: 'remote';
-    registryName: string;
-    component: OutputComponent;
-};
-type ComponentBuilder = ReturnType<typeof createComponentBuilder>;
-/**
- * @param registry registry object
- * @param packageJson parsed package json object
- */
-declare function createComponentBuilder(registry: Registry, packageJson: PackageJson | undefined): {
-    registryDir: string;
-    registry: Registry;
-    resolveDep(specifier: string): DependencyInfo & {
-        name: string;
-    };
-    createSourceFile(file: string): Promise<ts_morph.SourceFile>;
-    getComponentByName(name: string, registryName?: string): GetComponentResult | undefined;
-    resolveOutputPath(file: string, registryName?: string, namespace?: string): string;
-    getSubComponent(file: string): Component | undefined;
-};
+declare function toShadcnRegistry(out: Output, baseUrl: string): Registry$1;
 
-declare function writeOutput(dir: string, out: Output, options?: {
+declare function combineRegistry(...items: Output[]): Output;
+declare function writeShadcnRegistry(out: Output, options: {
+    dir: string;
+    /**
+     * Remove previous outputs
+     *
+     * @defaultValue false
+     */
+    cleanDir?: boolean;
+    baseUrl: string;
+}): Promise<void>;
+declare function writeFumadocsRegistry(out: Output, options: {
+    dir: string;
     /**
-     * Remove all content from the `dir` directory
+     * Remove previous outputs
      *
      * @defaultValue false
      */
@@ -130,4 +148,4 @@ declare function writeOutput(dir: string, out: Output, options?: {
     log?: boolean;
 }): Promise<void>;
 
-export { type Component, type ComponentBuilder, type DependencyInfo, type ImportPathMap, type NamespaceType, type Output, type OutputComponent, type OutputFile, type OutputIndex, type PackageJson, type Registry, build, createComponentBuilder, writeOutput };
+export { type Component, type ComponentBuilder, type ComponentFile, type OnResolve, type PackageJson, type Registry, build, combineRegistry, createComponentBuilder, toShadcnRegistry, writeFumadocsRegistry, writeShadcnRegistry };