vite-plugin-decap-cms 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,248 @@
+import * as vite from 'vite';
+import { Plugin } from 'vite';
+import * as yaml from 'yaml';
+import * as decap_cms_core from 'decap-cms-core';
+import { CmsEventListener, CMS, CmsFieldMarkdown, CmsField, CmsFieldMeta, CmsCollectionFile, CmsConfig, CmsLocalBackend, CmsBackend, CmsFieldStringOrText, CmsFieldBase, CmsCollection } from 'decap-cms-core';
+
+interface CmsHookContext {
+    app: CMS;
+}
+type CmsEventHookContext = CmsHookContext & Parameters<CmsEventListener['handler']>[0];
+type ScriptOptions = {
+    [event in `on${Capitalize<CmsEventListener['name']>}`]?: (ctx: CmsEventHookContext) => Promise<void> | void;
+} & {
+    /**
+     * Called when the admin UI is initialized.
+     * This hook is run in the browser.
+     * @param ctx
+     */
+    onInitialized?(ctx: CmsHookContext): Promise<void> | void;
+    /**
+     * Called when the config is written in builds.
+     * This hook is run in Node.js.
+     */
+    onGenerated?(): Promise<void> | void;
+    /**
+     * Called when the config is written.
+     * This hook is run in both Vite build and serve commands.
+     * This hook is run in Node.js.
+     */
+    onConfigUpdated?(): Promise<void> | void;
+    onPreSave?(ctx: CmsEventHookContext): Promise<void> | void;
+    /**
+     * Skip initializing until you call `CMS.init`
+     *
+     * ```ts
+     * // Browser
+     * window.CMS.init()
+     * // Node.js
+     * import cms from 'decap-cms-app'
+     *
+     * cms.init()
+     * ```
+     */
+    useManualInitialization?: boolean;
+};
+
+type CamelToSnakeCase<S extends string, I extends string = never> = S extends `${infer T}${infer U}` ? S extends I ? S : `${T extends Capitalize<T> ? '_' : ''}${Lowercase<T>}${CamelToSnakeCase<U>}` : S;
+type KeysToSnakeCase<T> = {
+    [K in keyof T as CamelToSnakeCase<string & K, 'i18n'>]: T[K];
+};
+type CamelCase<S extends string> = S extends `${infer P1}_${infer P2}${infer P3}` ? `${Lowercase<P1>}${Uppercase<P2>}${CamelCase<P3>}` : Lowercase<S>;
+type KeysToCamelCase<T> = {
+    [K in keyof T as CamelCase<string & K>]: T[K] extends {} ? KeysToCamelCase<T[K]> : T[K];
+};
+type PickRequired<O extends object, K extends keyof O> = Omit<O, K> & Required<Pick<O, K>>;
+type CollectionType = 'file' | 'folder';
+type DecapCmsMarkdownFieldRenderOptions = KeysToCamelCase<Omit<CmsFieldMarkdown, 'widget' | 'default' | 'editorComponents'>>;
+type DecapCmsField = KeysToCamelCase<CmsField>;
+type DecapCmsFieldType = NonNullable<Exclude<CmsField, CmsFieldMeta>['widget']>;
+type DecapCmsWidget = Exclude<CmsField, CmsFieldStringOrText | CmsFieldMeta> | (CmsFieldBase & PickRequired<CmsFieldStringOrText, 'widget'>);
+type DecapCmsFieldWidget<Name extends DecapCmsFieldType> = DecapCmsWidget extends infer K ? K extends DecapCmsWidget ? Name extends K['widget'] ? K : never : never : never;
+type DecapCmsCollectionFile = KeysToCamelCase<Omit<CmsCollectionFile, 'fields'>> & {
+    fields: DecapCmsField[];
+};
+type BaseDecapCmsCollection<Props> = KeysToCamelCase<Omit<CmsCollection, 'files' | 'fields'>> & Props;
+type DecapCmsCollection<Type extends CollectionType = CollectionType> = Type extends 'folder' ? BaseDecapCmsCollection<{
+    fields: DecapCmsField[];
+}> : Type extends 'file' ? BaseDecapCmsCollection<{
+    files: DecapCmsCollectionFile[];
+}> : never;
+type DecapCmsConfig = KeysToCamelCase<Omit<CmsConfig, 'local_backend' | 'backend' | 'collections' | 'load_config_file'>> & {
+    backend: {
+        local?: boolean | 'dev' | KeysToCamelCase<CmsLocalBackend>;
+        /**
+         * Overwrite the branch specified in `backend.branch`
+         * - true: always use current branch
+         * - false: always use the branch in the configuration
+         * - 'dev': only use the current branch when locally writing
+         * - 'prod': ony use the current branch when building the site
+         * @default false
+         */
+        useCurrentBranch?: boolean | 'dev' | 'prod';
+    } & KeysToCamelCase<CmsBackend>;
+    collections: DecapCmsCollection[];
+    /**
+     * The subfolder for where to write the CMS configuration (config.yml):
+     * - '' for the {@link Options.dir}
+     * @default 'admin'
+     */
+    dir?: string;
+};
+type CdnLinkOptions = string | {
+    version?: string;
+    base?: string;
+};
+interface LoginPageOptions {
+    title?: string;
+    head?: string[];
+}
+type YmlStringifyOptions = Parameters<typeof yaml.stringify>;
+interface Options {
+    /**
+     * How to load Decap CMS
+     * @default
+     * { method: 'cdn'}
+     */
+    load?: {
+        method: 'cdn';
+        options?: CdnLinkOptions;
+    };
+    /**
+     * Log when the configuration is being written or skipped
+     */
+    debug?: boolean;
+    /**
+     * The folder where to write all /admin/ files.
+     * Will create an `admin` folder at this path if it does not exist.
+     *
+     * @default vite.Config.publicDir
+     */
+    dir?: string;
+    /**
+     * Options for the index.html (login page) file
+     */
+    login?: LoginPageOptions;
+    config: DecapCmsConfig;
+    /**
+     * Run custom JS to enhance the CMS
+     */
+    script?: ScriptOptions;
+    /**
+     * Yml stringify options for writing the config.yml file
+     */
+    yml?: {
+        replacer?: NonNullable<YmlStringifyOptions[1]>;
+        options?: NonNullable<YmlStringifyOptions[2]>;
+    };
+}
+
+declare function getGitData(): {
+    readonly branch: string | undefined;
+    readonly commitSha: string | undefined;
+};
+declare function createField<T extends DecapCmsFieldType>(widget: T, data: Omit<DecapCmsFieldWidget<T>, 'widget'>): DecapCmsFieldWidget<T>;
+declare function createFolderCollection(data: DecapCmsCollection<'folder'>): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "files" | "fields">> & {
+    fields: DecapCmsField[];
+};
+declare function createFile(data: DecapCmsCollectionFile): DecapCmsCollectionFile;
+declare function createFileCollection(data: DecapCmsCollection<'file'>): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "files" | "fields">> & {
+    files: DecapCmsCollectionFile[];
+};
+type OverwriteOptions = Omit<CmsFieldBase, 'name'> & {
+    /**
+     * Hide this field in the CMS editor UI.
+     * @default false
+     */
+    hidden?: boolean;
+};
+type VitePressPageFrontmatterKeys = 'title' | 'titleTemplate' | 'description' | 'head' | 'body';
+interface BaseVitePressFieldOptions<Keys extends string> {
+    overwrites?: Partial<Record<Keys, OverwriteOptions>>;
+}
+interface VitePressFieldOptions extends BaseVitePressFieldOptions<VitePressPageFrontmatterKeys> {
+    additionalFields?: DecapCmsField[];
+    /**
+     * Options for the markdown editor in the CMS
+     */
+    markdownOptions?: DecapCmsMarkdownFieldRenderOptions;
+}
+type VitePressDefaultThemeFrontmatterKeys = 'navbar' | 'sidebar' | 'aside' | 'outline' | 'lastUpdated' | 'editLink' | 'footer' | 'pageClass';
+type VitePressDefaultThemeFieldOptions = BaseVitePressFieldOptions<VitePressDefaultThemeFrontmatterKeys>;
+declare class VitePress {
+    /**
+     * Create fields for:
+     * - navbar
+     * - sidebar
+     * - aside
+     * - outline
+     * - lastUpdated
+     * - editLink
+     * - footer
+     * - pageClass
+     *
+     * Does not create the default page fields, such as title and description.
+     * @param options Options for overwriting field data
+     * @see https://vitepress.dev/reference/frontmatter-config#default-theme-only
+     */
+    static createDefaultThemeNormalPageFields(options?: VitePressDefaultThemeFieldOptions): DecapCmsField[];
+    /**
+     * Create fields for:
+     * - title
+     * - titleTemplate
+     * - description
+     * - head
+     * @param options.overwrites Overwrite data, such as labels, for the fields
+     * @see https://vitepress.dev/reference/frontmatter-config
+     */
+    static createDefaultPageFields(options?: VitePressFieldOptions): DecapCmsField[];
+    static createDefaultPageFolderCollection(name: string, folder: string, options?: VitePressFieldOptions & {
+        collection?: Partial<Omit<DecapCmsCollection<'folder'>, 'name' | 'fields' | 'folder'>>;
+    }): DecapCmsCollection<'folder'>;
+    static createDefaultPageFile(name: string, file: string, options?: VitePressFieldOptions & {
+        collection?: Partial<Omit<DecapCmsCollectionFile, 'name' | 'file'>>;
+    }): DecapCmsCollectionFile;
+    static createDefaultPageFileCollection(name: string, files: Parameters<typeof VitePress['createDefaultPageFile']>[], options?: {
+        collection?: Partial<Omit<DecapCmsCollection<'file'>, 'name' | 'files'>>;
+    }): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "files" | "fields">> & {
+        files: DecapCmsCollectionFile[];
+    };
+}
+
+declare function VitePluginDecapCMS(options: Options): {
+    name: string;
+    configResolved(this: void, config: Readonly<Omit<vite.UserConfig, "plugins" | "css" | "assetsInclude" | "optimizeDeps" | "worker" | "build"> & {
+        configFile: string | undefined;
+        configFileDependencies: string[];
+        inlineConfig: vite.InlineConfig;
+        root: string;
+        base: string;
+        publicDir: string;
+        cacheDir: string;
+        command: "build" | "serve";
+        mode: string;
+        isWorker: boolean;
+        isProduction: boolean;
+        envDir: string;
+        env: Record<string, any>;
+        resolve: Required<vite.ResolveOptions> & {
+            alias: vite.Alias[];
+        };
+        plugins: readonly Plugin<any>[];
+        css: vite.ResolvedCSSOptions;
+        esbuild: false | vite.ESBuildOptions;
+        server: vite.ResolvedServerOptions;
+        build: vite.ResolvedBuildOptions;
+        preview: vite.ResolvedPreviewOptions;
+        ssr: vite.ResolvedSSROptions;
+        assetsInclude: (file: string) => boolean;
+        logger: vite.Logger;
+        createResolver: (options?: Partial<vite.InternalResolveOptions> | undefined) => vite.ResolveFn;
+        optimizeDeps: vite.DepOptimizationOptions;
+        worker: vite.ResolvedWorkerOptions;
+        appType: vite.AppType;
+        experimental: vite.ExperimentalOptions;
+    } & vite.PluginHookUtils>): Promise<void>;
+};
+
+export { type CdnLinkOptions, type CollectionType, type DecapCmsCollection, type DecapCmsCollectionFile, type DecapCmsConfig, type DecapCmsField, type DecapCmsFieldType, type DecapCmsFieldWidget, type DecapCmsMarkdownFieldRenderOptions, type KeysToCamelCase, type KeysToSnakeCase, type LoginPageOptions, type Options, type OverwriteOptions, VitePress, type VitePressDefaultThemeFieldOptions, type VitePressDefaultThemeFrontmatterKeys, type VitePressFieldOptions, type VitePressPageFrontmatterKeys, createField, createFile, createFileCollection, createFolderCollection, VitePluginDecapCMS as default, getGitData };

package/dist/index.d.ts

@@ -0,0 +1,248 @@
+import * as vite from 'vite';
+import { Plugin } from 'vite';
+import * as yaml from 'yaml';
+import * as decap_cms_core from 'decap-cms-core';
+import { CmsEventListener, CMS, CmsFieldMarkdown, CmsField, CmsFieldMeta, CmsCollectionFile, CmsConfig, CmsLocalBackend, CmsBackend, CmsFieldStringOrText, CmsFieldBase, CmsCollection } from 'decap-cms-core';
+
+interface CmsHookContext {
+    app: CMS;
+}
+type CmsEventHookContext = CmsHookContext & Parameters<CmsEventListener['handler']>[0];
+type ScriptOptions = {
+    [event in `on${Capitalize<CmsEventListener['name']>}`]?: (ctx: CmsEventHookContext) => Promise<void> | void;
+} & {
+    /**
+     * Called when the admin UI is initialized.
+     * This hook is run in the browser.
+     * @param ctx
+     */
+    onInitialized?(ctx: CmsHookContext): Promise<void> | void;
+    /**
+     * Called when the config is written in builds.
+     * This hook is run in Node.js.
+     */
+    onGenerated?(): Promise<void> | void;
+    /**
+     * Called when the config is written.
+     * This hook is run in both Vite build and serve commands.
+     * This hook is run in Node.js.
+     */
+    onConfigUpdated?(): Promise<void> | void;
+    onPreSave?(ctx: CmsEventHookContext): Promise<void> | void;
+    /**
+     * Skip initializing until you call `CMS.init`
+     *
+     * ```ts
+     * // Browser
+     * window.CMS.init()
+     * // Node.js
+     * import cms from 'decap-cms-app'
+     *
+     * cms.init()
+     * ```
+     */
+    useManualInitialization?: boolean;
+};
+
+type CamelToSnakeCase<S extends string, I extends string = never> = S extends `${infer T}${infer U}` ? S extends I ? S : `${T extends Capitalize<T> ? '_' : ''}${Lowercase<T>}${CamelToSnakeCase<U>}` : S;
+type KeysToSnakeCase<T> = {
+    [K in keyof T as CamelToSnakeCase<string & K, 'i18n'>]: T[K];
+};
+type CamelCase<S extends string> = S extends `${infer P1}_${infer P2}${infer P3}` ? `${Lowercase<P1>}${Uppercase<P2>}${CamelCase<P3>}` : Lowercase<S>;
+type KeysToCamelCase<T> = {
+    [K in keyof T as CamelCase<string & K>]: T[K] extends {} ? KeysToCamelCase<T[K]> : T[K];
+};
+type PickRequired<O extends object, K extends keyof O> = Omit<O, K> & Required<Pick<O, K>>;
+type CollectionType = 'file' | 'folder';
+type DecapCmsMarkdownFieldRenderOptions = KeysToCamelCase<Omit<CmsFieldMarkdown, 'widget' | 'default' | 'editorComponents'>>;
+type DecapCmsField = KeysToCamelCase<CmsField>;
+type DecapCmsFieldType = NonNullable<Exclude<CmsField, CmsFieldMeta>['widget']>;
+type DecapCmsWidget = Exclude<CmsField, CmsFieldStringOrText | CmsFieldMeta> | (CmsFieldBase & PickRequired<CmsFieldStringOrText, 'widget'>);
+type DecapCmsFieldWidget<Name extends DecapCmsFieldType> = DecapCmsWidget extends infer K ? K extends DecapCmsWidget ? Name extends K['widget'] ? K : never : never : never;
+type DecapCmsCollectionFile = KeysToCamelCase<Omit<CmsCollectionFile, 'fields'>> & {
+    fields: DecapCmsField[];
+};
+type BaseDecapCmsCollection<Props> = KeysToCamelCase<Omit<CmsCollection, 'files' | 'fields'>> & Props;
+type DecapCmsCollection<Type extends CollectionType = CollectionType> = Type extends 'folder' ? BaseDecapCmsCollection<{
+    fields: DecapCmsField[];
+}> : Type extends 'file' ? BaseDecapCmsCollection<{
+    files: DecapCmsCollectionFile[];
+}> : never;
+type DecapCmsConfig = KeysToCamelCase<Omit<CmsConfig, 'local_backend' | 'backend' | 'collections' | 'load_config_file'>> & {
+    backend: {
+        local?: boolean | 'dev' | KeysToCamelCase<CmsLocalBackend>;
+        /**
+         * Overwrite the branch specified in `backend.branch`
+         * - true: always use current branch
+         * - false: always use the branch in the configuration
+         * - 'dev': only use the current branch when locally writing
+         * - 'prod': ony use the current branch when building the site
+         * @default false
+         */
+        useCurrentBranch?: boolean | 'dev' | 'prod';
+    } & KeysToCamelCase<CmsBackend>;
+    collections: DecapCmsCollection[];
+    /**
+     * The subfolder for where to write the CMS configuration (config.yml):
+     * - '' for the {@link Options.dir}
+     * @default 'admin'
+     */
+    dir?: string;
+};
+type CdnLinkOptions = string | {
+    version?: string;
+    base?: string;
+};
+interface LoginPageOptions {
+    title?: string;
+    head?: string[];
+}
+type YmlStringifyOptions = Parameters<typeof yaml.stringify>;
+interface Options {
+    /**
+     * How to load Decap CMS
+     * @default
+     * { method: 'cdn'}
+     */
+    load?: {
+        method: 'cdn';
+        options?: CdnLinkOptions;
+    };
+    /**
+     * Log when the configuration is being written or skipped
+     */
+    debug?: boolean;
+    /**
+     * The folder where to write all /admin/ files.
+     * Will create an `admin` folder at this path if it does not exist.
+     *
+     * @default vite.Config.publicDir
+     */
+    dir?: string;
+    /**
+     * Options for the index.html (login page) file
+     */
+    login?: LoginPageOptions;
+    config: DecapCmsConfig;
+    /**
+     * Run custom JS to enhance the CMS
+     */
+    script?: ScriptOptions;
+    /**
+     * Yml stringify options for writing the config.yml file
+     */
+    yml?: {
+        replacer?: NonNullable<YmlStringifyOptions[1]>;
+        options?: NonNullable<YmlStringifyOptions[2]>;
+    };
+}
+
+declare function getGitData(): {
+    readonly branch: string | undefined;
+    readonly commitSha: string | undefined;
+};
+declare function createField<T extends DecapCmsFieldType>(widget: T, data: Omit<DecapCmsFieldWidget<T>, 'widget'>): DecapCmsFieldWidget<T>;
+declare function createFolderCollection(data: DecapCmsCollection<'folder'>): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "files" | "fields">> & {
+    fields: DecapCmsField[];
+};
+declare function createFile(data: DecapCmsCollectionFile): DecapCmsCollectionFile;
+declare function createFileCollection(data: DecapCmsCollection<'file'>): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "files" | "fields">> & {
+    files: DecapCmsCollectionFile[];
+};
+type OverwriteOptions = Omit<CmsFieldBase, 'name'> & {
+    /**
+     * Hide this field in the CMS editor UI.
+     * @default false
+     */
+    hidden?: boolean;
+};
+type VitePressPageFrontmatterKeys = 'title' | 'titleTemplate' | 'description' | 'head' | 'body';
+interface BaseVitePressFieldOptions<Keys extends string> {
+    overwrites?: Partial<Record<Keys, OverwriteOptions>>;
+}
+interface VitePressFieldOptions extends BaseVitePressFieldOptions<VitePressPageFrontmatterKeys> {
+    additionalFields?: DecapCmsField[];
+    /**
+     * Options for the markdown editor in the CMS
+     */
+    markdownOptions?: DecapCmsMarkdownFieldRenderOptions;
+}
+type VitePressDefaultThemeFrontmatterKeys = 'navbar' | 'sidebar' | 'aside' | 'outline' | 'lastUpdated' | 'editLink' | 'footer' | 'pageClass';
+type VitePressDefaultThemeFieldOptions = BaseVitePressFieldOptions<VitePressDefaultThemeFrontmatterKeys>;
+declare class VitePress {
+    /**
+     * Create fields for:
+     * - navbar
+     * - sidebar
+     * - aside
+     * - outline
+     * - lastUpdated
+     * - editLink
+     * - footer
+     * - pageClass
+     *
+     * Does not create the default page fields, such as title and description.
+     * @param options Options for overwriting field data
+     * @see https://vitepress.dev/reference/frontmatter-config#default-theme-only
+     */
+    static createDefaultThemeNormalPageFields(options?: VitePressDefaultThemeFieldOptions): DecapCmsField[];
+    /**
+     * Create fields for:
+     * - title
+     * - titleTemplate
+     * - description
+     * - head
+     * @param options.overwrites Overwrite data, such as labels, for the fields
+     * @see https://vitepress.dev/reference/frontmatter-config
+     */
+    static createDefaultPageFields(options?: VitePressFieldOptions): DecapCmsField[];
+    static createDefaultPageFolderCollection(name: string, folder: string, options?: VitePressFieldOptions & {
+        collection?: Partial<Omit<DecapCmsCollection<'folder'>, 'name' | 'fields' | 'folder'>>;
+    }): DecapCmsCollection<'folder'>;
+    static createDefaultPageFile(name: string, file: string, options?: VitePressFieldOptions & {
+        collection?: Partial<Omit<DecapCmsCollectionFile, 'name' | 'file'>>;
+    }): DecapCmsCollectionFile;
+    static createDefaultPageFileCollection(name: string, files: Parameters<typeof VitePress['createDefaultPageFile']>[], options?: {
+        collection?: Partial<Omit<DecapCmsCollection<'file'>, 'name' | 'files'>>;
+    }): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "files" | "fields">> & {
+        files: DecapCmsCollectionFile[];
+    };
+}
+
+declare function VitePluginDecapCMS(options: Options): {
+    name: string;
+    configResolved(this: void, config: Readonly<Omit<vite.UserConfig, "plugins" | "css" | "assetsInclude" | "optimizeDeps" | "worker" | "build"> & {
+        configFile: string | undefined;
+        configFileDependencies: string[];
+        inlineConfig: vite.InlineConfig;
+        root: string;
+        base: string;
+        publicDir: string;
+        cacheDir: string;
+        command: "build" | "serve";
+        mode: string;
+        isWorker: boolean;
+        isProduction: boolean;
+        envDir: string;
+        env: Record<string, any>;
+        resolve: Required<vite.ResolveOptions> & {
+            alias: vite.Alias[];
+        };
+        plugins: readonly Plugin<any>[];
+        css: vite.ResolvedCSSOptions;
+        esbuild: false | vite.ESBuildOptions;
+        server: vite.ResolvedServerOptions;
+        build: vite.ResolvedBuildOptions;
+        preview: vite.ResolvedPreviewOptions;
+        ssr: vite.ResolvedSSROptions;
+        assetsInclude: (file: string) => boolean;
+        logger: vite.Logger;
+        createResolver: (options?: Partial<vite.InternalResolveOptions> | undefined) => vite.ResolveFn;
+        optimizeDeps: vite.DepOptimizationOptions;
+        worker: vite.ResolvedWorkerOptions;
+        appType: vite.AppType;
+        experimental: vite.ExperimentalOptions;
+    } & vite.PluginHookUtils>): Promise<void>;
+};
+
+export { type CdnLinkOptions, type CollectionType, type DecapCmsCollection, type DecapCmsCollectionFile, type DecapCmsConfig, type DecapCmsField, type DecapCmsFieldType, type DecapCmsFieldWidget, type DecapCmsMarkdownFieldRenderOptions, type KeysToCamelCase, type KeysToSnakeCase, type LoginPageOptions, type Options, type OverwriteOptions, VitePress, type VitePressDefaultThemeFieldOptions, type VitePressDefaultThemeFrontmatterKeys, type VitePressFieldOptions, type VitePressPageFrontmatterKeys, createField, createFile, createFileCollection, createFolderCollection, VitePluginDecapCMS as default, getGitData };