vite-plugin-decap-cms 0.3.0 → 0.4.0

package/dist/index.d.cts

@@ -1,8 +1,8 @@
 import { Plugin } from 'vite';
 import * as yaml from 'yaml';
+import { ExecOptions } from 'node:child_process';
 import * as decap_cms_core from 'decap-cms-core';
 import { CmsEventListener, CMS, EditorComponentOptions, Formatter, CmsFieldMarkdown, CmsField, CmsFieldMeta, CmsCollectionFile, CmsConfig, CmsLocalBackend, CmsBackend, CmsFieldStringOrText, CmsFieldBase, CmsCollection } from 'decap-cms-core';
-import { ExecOptions } from 'child_process';
 
 interface CmsHookContext {
     app: CMS;
@@ -83,13 +83,14 @@ type ScriptOptions = {
 
 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];
+    [K in keyof T as CamelToSnakeCase<string & K, 'i18n'>]: T[K] extends boolean ? T[K] : T[K] extends {} ? T[K] extends unknown[] ? KeysToSnakeCase<T[K][number]>[] : KeysToSnakeCase<T[K]> : 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];
+    [K in keyof T as CamelCase<string & K>]: T[K] extends boolean ? T[K] : T[K] extends {} ? T[K] extends unknown[] ? KeysToCamelCase<T[K][number]>[] : KeysToCamelCase<T[K]> : T[K];
 };
 type PickRequired<O extends object, K extends keyof O> = Omit<O, K> & Required<Pick<O, K>>;
+
 type EnvContextOption = boolean | 'dev' | 'prod';
 type EnvDevContextOption = Exclude<EnvContextOption, 'prod'>;
 type CollectionType = 'file' | 'folder';
@@ -99,11 +100,11 @@ 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[];
+    fields: DecapCmsField[] | CmsField[];
 };
 type BaseDecapCmsCollection<Props> = KeysToCamelCase<Omit<CmsCollection, 'files' | 'fields'>> & Props;
 type DecapCmsCollection<Type extends CollectionType = CollectionType> = Type extends 'folder' ? BaseDecapCmsCollection<{
-    fields: DecapCmsField[];
+    fields: DecapCmsField[] | CmsField[];
 }> : Type extends 'file' ? BaseDecapCmsCollection<{
     files: DecapCmsCollectionFile[];
 }> : never;
@@ -182,6 +183,26 @@ interface DecapProxyOptions {
      * @default 8081
      */
     port?: number;
+    /**
+     * Undocumented.
+     *
+     * Option for the process environment variable 'MODE'.
+     * @default 'fs'
+     */
+    mode?: 'git' | 'fs';
+    /**
+     * Option for the process environment variable 'GIT_REPO_DIRECTORY'.
+     *
+     * The full local path to the git repo
+     * @default 'process.cwd()'
+     */
+    gitRepoDirectory?: string;
+    /**
+     * Option for the process environment variable 'LOG_LEVEL'.
+     *
+     * @default 'info'
+     */
+    logLevel?: string;
     /**
      * Pass any option to use in the child process
      * @default undefined
@@ -231,18 +252,6 @@ interface Options {
     };
 }
 
-declare function getGitData(): {
-    getBranch(): string | undefined;
-    getCommitSha(): 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, "fields" | "files">> & {
-    fields: DecapCmsField[];
-};
-declare function createFile(data: DecapCmsCollectionFile): DecapCmsCollectionFile;
-declare function createFileCollection(data: DecapCmsCollection<'file'>): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "fields" | "files">> & {
-    files: DecapCmsCollectionFile[];
-};
 type OverwriteOptions = Omit<CmsFieldBase, 'name'> & {
     /**
      * Hide this field in the CMS editor UI.
@@ -255,12 +264,15 @@ type OverwriteOptions = Omit<CmsFieldBase, 'name'> & {
      */
     deleted?: boolean;
 };
+declare function createOverwriteableField<T extends DecapCmsFieldType>(widget: T, data: Omit<DecapCmsFieldWidget<T>, 'widget'>, overwrites?: OverwriteOptions): DecapCmsFieldWidget<T> | DecapCmsFieldWidget<'hidden'> | undefined;
+
 type VitePressPageFrontmatterKeys = 'title' | 'titleTemplate' | 'description' | 'head' | 'body';
 interface BaseVitePressFieldOptions<Keys extends string> {
-    overwrites?: Partial<Record<Keys, OverwriteOptions>>;
+    overwrites?: Partial<Record<Keys, OverwriteOptions>> & Partial<OverwriteOptions>;
 }
+type VitePressAdditionalField = DecapCmsField | CmsField;
 interface VitePressFieldOptions extends BaseVitePressFieldOptions<VitePressPageFrontmatterKeys> {
-    additionalFields?: DecapCmsField[];
+    additionalFields?: VitePressAdditionalField[];
     /**
      * Options for the markdown editor in the CMS
      */
@@ -269,7 +281,7 @@ interface VitePressFieldOptions extends BaseVitePressFieldOptions<VitePressPageF
 type VitePressDefaultThemeFrontmatterKeys = 'layout' | 'navbar' | 'sidebar' | 'aside' | 'outline' | 'lastUpdated' | 'editLink' | 'footer' | 'pageClass';
 type VitePressDefaultThemeFieldOptions = BaseVitePressFieldOptions<VitePressDefaultThemeFrontmatterKeys>;
 type VitePressHomePageFrontmatterKeys = 'hero' | 'heroName' | 'heroText' | 'heroTagline' | 'heroImage' | 'heroActions' | 'heroActionTheme' | 'heroActionText' | 'heroActionLink' | 'heroActionTarget' | 'heroActionRel' | 'features' | 'featuresTitle' | 'featuresDetails' | 'featuresIcon' | 'featuresLink' | 'featuresLinkText' | 'featuresRel' | 'featuresTarget';
-type VitePressHomePageFieldOptions = BaseVitePressFieldOptions<VitePressHomePageFrontmatterKeys>;
+type VitePressHomePageFieldOptions = BaseVitePressFieldOptions<VitePressHomePageFrontmatterKeys> & Partial<Record<'additionalHeroFields' | 'additionalHeroActionFields' | 'additionalFeatureFields', VitePressAdditionalField[]>>;
 declare class VitePress {
     /**
      * Create fields for:
@@ -287,17 +299,18 @@ declare class VitePress {
      * @param options Options for overwriting field data
      * @see https://vitepress.dev/reference/frontmatter-config#default-theme-only
      */
-    static createDefaultThemeNormalPageFields(options?: VitePressDefaultThemeFieldOptions): DecapCmsField[];
+    static createDefaultThemeNormalPageFields(options?: VitePressDefaultThemeFieldOptions): CmsField[];
     /**
      * Create fields for:
      * - title
      * - titleTemplate
      * - description
      * - head
+     * - body (field for writing the markdown in the file)
      * @param options.overwrites Overwrite data, such as labels, for the fields
      * @see https://vitepress.dev/reference/frontmatter-config
      */
-    static createDefaultPageFields(options?: VitePressFieldOptions): DecapCmsField[];
+    static createDefaultPageFields(options?: VitePressFieldOptions): CmsField[];
     /**
      * Create fields for:
      * - layout: home (not overwriteable)
@@ -306,7 +319,7 @@ declare class VitePress {
      *
      * The object fields (`features`, `hero`, `heroActions`) can not be hidden and deleted.
      */
-    static createHomePageFields(options?: VitePressHomePageFieldOptions): ((CmsFieldBase & decap_cms_core.CmsFieldList) | (CmsFieldBase & decap_cms_core.CmsFieldHidden) | undefined)[];
+    static createHomePageFields(options?: VitePressHomePageFieldOptions): CmsField[];
     static createDefaultPageFolderCollection(name: string, folder: string, options?: VitePressFieldOptions & {
         collection?: Partial<Omit<DecapCmsCollection<'folder'>, 'name' | 'fields' | 'folder'>>;
     }): DecapCmsCollection<'folder'>;
@@ -320,6 +333,46 @@ declare class VitePress {
     };
 }
 
+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, "fields" | "files">> & {
+    fields: DecapCmsField[] | CmsField[];
+};
+declare function createFile(data: DecapCmsCollectionFile): DecapCmsCollectionFile;
+declare function createFileCollection(data: DecapCmsCollection<'file'>): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "fields" | "files">> & {
+    files: DecapCmsCollectionFile[];
+};
+declare function fieldToSnakeCase(field: DecapCmsField | CmsField): CmsField;
+type SharedAction<Type> = (Type extends (string | undefined) ? true : Type extends (unknown[] | undefined) ? true : false) extends true ? ({
+    /**
+     * The action to take when combining options from shared and collection options:
+     * - append: if specified in another collection, the new options will be appended to the shared value
+     * - overwrite: if specified in another collection, the new options will overwrite the share value
+     * @default 'overwrite'
+     */
+    action?: 'append' | 'overwrite';
+    value: Type;
+} | Type) : Type;
+type PartialIf<If extends boolean, T> = If extends true ? Partial<T> : T;
+type Invert<T extends boolean> = T extends true ? false : true;
+type SharedDecapCmsCollection<Type extends CollectionType> = Omit<DecapCmsCollection<Type>, 'fields' | 'files'>;
+type SharedDecapCmsCollectionOptions<Type extends CollectionType> = {
+    [K in keyof SharedDecapCmsCollection<Type>]: SharedAction<SharedDecapCmsCollection<Type>[K]>;
+};
+interface SharedOptions<Parent extends boolean = true> extends Pick<Exclude<SharedAction<string>, string>, 'action'> {
+    /**
+     * Changes the types on where required name fields (name, labels) must be defined:
+     * on the shared or collection options.
+     * @default true
+     */
+    requiredNameOnChildOptions?: Parent;
+}
+declare function createSharedCollectionOptions<Type extends CollectionType = CollectionType, Parent extends boolean = true, ChildType extends CollectionType = Type>(shared: PartialIf<Parent, SharedDecapCmsCollectionOptions<Type>>, options?: SharedOptions<Parent>): (collection: PartialIf<Invert<Parent>, SharedDecapCmsCollection<ChildType>>) => SharedDecapCmsCollection<ChildType>;
+
+declare function getGitData(): {
+    getBranch(): string | undefined;
+    getCommitSha(): string | undefined;
+};
+
 declare function VitePluginDecapCMS(options: Options): Plugin;
 
-export { type CdnLinkOptions, type CollectionType, type DecapCmsCollection, type DecapCmsCollectionFile, type DecapCmsConfig, type DecapCmsField, type DecapCmsFieldType, type DecapCmsFieldWidget, type DecapCmsMarkdownFieldRenderOptions, type DecapProxyOptions, type EnvContextOption, type EnvDevContextOption, type HeadConfig, type KeysToCamelCase, type KeysToSnakeCase, type LoginPageOptions, type Options, type OverwriteOptions, VitePress, type VitePressDefaultThemeFieldOptions, type VitePressDefaultThemeFrontmatterKeys, type VitePressFieldOptions, type VitePressHomePageFieldOptions, type VitePressHomePageFrontmatterKeys, type VitePressPageFrontmatterKeys, createField, createFile, createFileCollection, createFolderCollection, VitePluginDecapCMS as default, getGitData };
+export { type CdnLinkOptions, type CollectionType, type DecapCmsCollection, type DecapCmsCollectionFile, type DecapCmsConfig, type DecapCmsField, type DecapCmsFieldType, type DecapCmsFieldWidget, type DecapCmsMarkdownFieldRenderOptions, type DecapProxyOptions, type EnvContextOption, type EnvDevContextOption, type HeadConfig, type KeysToCamelCase, type KeysToSnakeCase, type LoginPageOptions, type Options, type OverwriteOptions, type SharedDecapCmsCollection, type SharedDecapCmsCollectionOptions, type SharedOptions, VitePress, type VitePressAdditionalField, type VitePressDefaultThemeFieldOptions, type VitePressDefaultThemeFrontmatterKeys, type VitePressFieldOptions, type VitePressHomePageFieldOptions, type VitePressHomePageFrontmatterKeys, type VitePressPageFrontmatterKeys, createField, createFile, createFileCollection, createFolderCollection, createOverwriteableField, createSharedCollectionOptions, VitePluginDecapCMS as default, fieldToSnakeCase, getGitData };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { Plugin } from 'vite';
 import * as yaml from 'yaml';
+import { ExecOptions } from 'node:child_process';
 import * as decap_cms_core from 'decap-cms-core';
 import { CmsEventListener, CMS, EditorComponentOptions, Formatter, CmsFieldMarkdown, CmsField, CmsFieldMeta, CmsCollectionFile, CmsConfig, CmsLocalBackend, CmsBackend, CmsFieldStringOrText, CmsFieldBase, CmsCollection } from 'decap-cms-core';
-import { ExecOptions } from 'child_process';
 
 interface CmsHookContext {
     app: CMS;
@@ -83,13 +83,14 @@ type ScriptOptions = {
 
 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];
+    [K in keyof T as CamelToSnakeCase<string & K, 'i18n'>]: T[K] extends boolean ? T[K] : T[K] extends {} ? T[K] extends unknown[] ? KeysToSnakeCase<T[K][number]>[] : KeysToSnakeCase<T[K]> : 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];
+    [K in keyof T as CamelCase<string & K>]: T[K] extends boolean ? T[K] : T[K] extends {} ? T[K] extends unknown[] ? KeysToCamelCase<T[K][number]>[] : KeysToCamelCase<T[K]> : T[K];
 };
 type PickRequired<O extends object, K extends keyof O> = Omit<O, K> & Required<Pick<O, K>>;
+
 type EnvContextOption = boolean | 'dev' | 'prod';
 type EnvDevContextOption = Exclude<EnvContextOption, 'prod'>;
 type CollectionType = 'file' | 'folder';
@@ -99,11 +100,11 @@ 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[];
+    fields: DecapCmsField[] | CmsField[];
 };
 type BaseDecapCmsCollection<Props> = KeysToCamelCase<Omit<CmsCollection, 'files' | 'fields'>> & Props;
 type DecapCmsCollection<Type extends CollectionType = CollectionType> = Type extends 'folder' ? BaseDecapCmsCollection<{
-    fields: DecapCmsField[];
+    fields: DecapCmsField[] | CmsField[];
 }> : Type extends 'file' ? BaseDecapCmsCollection<{
     files: DecapCmsCollectionFile[];
 }> : never;
@@ -182,6 +183,26 @@ interface DecapProxyOptions {
      * @default 8081
      */
     port?: number;
+    /**
+     * Undocumented.
+     *
+     * Option for the process environment variable 'MODE'.
+     * @default 'fs'
+     */
+    mode?: 'git' | 'fs';
+    /**
+     * Option for the process environment variable 'GIT_REPO_DIRECTORY'.
+     *
+     * The full local path to the git repo
+     * @default 'process.cwd()'
+     */
+    gitRepoDirectory?: string;
+    /**
+     * Option for the process environment variable 'LOG_LEVEL'.
+     *
+     * @default 'info'
+     */
+    logLevel?: string;
     /**
      * Pass any option to use in the child process
      * @default undefined
@@ -231,18 +252,6 @@ interface Options {
     };
 }
 
-declare function getGitData(): {
-    getBranch(): string | undefined;
-    getCommitSha(): 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, "fields" | "files">> & {
-    fields: DecapCmsField[];
-};
-declare function createFile(data: DecapCmsCollectionFile): DecapCmsCollectionFile;
-declare function createFileCollection(data: DecapCmsCollection<'file'>): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "fields" | "files">> & {
-    files: DecapCmsCollectionFile[];
-};
 type OverwriteOptions = Omit<CmsFieldBase, 'name'> & {
     /**
      * Hide this field in the CMS editor UI.
@@ -255,12 +264,15 @@ type OverwriteOptions = Omit<CmsFieldBase, 'name'> & {
      */
     deleted?: boolean;
 };
+declare function createOverwriteableField<T extends DecapCmsFieldType>(widget: T, data: Omit<DecapCmsFieldWidget<T>, 'widget'>, overwrites?: OverwriteOptions): DecapCmsFieldWidget<T> | DecapCmsFieldWidget<'hidden'> | undefined;
+
 type VitePressPageFrontmatterKeys = 'title' | 'titleTemplate' | 'description' | 'head' | 'body';
 interface BaseVitePressFieldOptions<Keys extends string> {
-    overwrites?: Partial<Record<Keys, OverwriteOptions>>;
+    overwrites?: Partial<Record<Keys, OverwriteOptions>> & Partial<OverwriteOptions>;
 }
+type VitePressAdditionalField = DecapCmsField | CmsField;
 interface VitePressFieldOptions extends BaseVitePressFieldOptions<VitePressPageFrontmatterKeys> {
-    additionalFields?: DecapCmsField[];
+    additionalFields?: VitePressAdditionalField[];
     /**
      * Options for the markdown editor in the CMS
      */
@@ -269,7 +281,7 @@ interface VitePressFieldOptions extends BaseVitePressFieldOptions<VitePressPageF
 type VitePressDefaultThemeFrontmatterKeys = 'layout' | 'navbar' | 'sidebar' | 'aside' | 'outline' | 'lastUpdated' | 'editLink' | 'footer' | 'pageClass';
 type VitePressDefaultThemeFieldOptions = BaseVitePressFieldOptions<VitePressDefaultThemeFrontmatterKeys>;
 type VitePressHomePageFrontmatterKeys = 'hero' | 'heroName' | 'heroText' | 'heroTagline' | 'heroImage' | 'heroActions' | 'heroActionTheme' | 'heroActionText' | 'heroActionLink' | 'heroActionTarget' | 'heroActionRel' | 'features' | 'featuresTitle' | 'featuresDetails' | 'featuresIcon' | 'featuresLink' | 'featuresLinkText' | 'featuresRel' | 'featuresTarget';
-type VitePressHomePageFieldOptions = BaseVitePressFieldOptions<VitePressHomePageFrontmatterKeys>;
+type VitePressHomePageFieldOptions = BaseVitePressFieldOptions<VitePressHomePageFrontmatterKeys> & Partial<Record<'additionalHeroFields' | 'additionalHeroActionFields' | 'additionalFeatureFields', VitePressAdditionalField[]>>;
 declare class VitePress {
     /**
      * Create fields for:
@@ -287,17 +299,18 @@ declare class VitePress {
      * @param options Options for overwriting field data
      * @see https://vitepress.dev/reference/frontmatter-config#default-theme-only
      */
-    static createDefaultThemeNormalPageFields(options?: VitePressDefaultThemeFieldOptions): DecapCmsField[];
+    static createDefaultThemeNormalPageFields(options?: VitePressDefaultThemeFieldOptions): CmsField[];
     /**
      * Create fields for:
      * - title
      * - titleTemplate
      * - description
      * - head
+     * - body (field for writing the markdown in the file)
      * @param options.overwrites Overwrite data, such as labels, for the fields
      * @see https://vitepress.dev/reference/frontmatter-config
      */
-    static createDefaultPageFields(options?: VitePressFieldOptions): DecapCmsField[];
+    static createDefaultPageFields(options?: VitePressFieldOptions): CmsField[];
     /**
      * Create fields for:
      * - layout: home (not overwriteable)
@@ -306,7 +319,7 @@ declare class VitePress {
      *
      * The object fields (`features`, `hero`, `heroActions`) can not be hidden and deleted.
      */
-    static createHomePageFields(options?: VitePressHomePageFieldOptions): ((CmsFieldBase & decap_cms_core.CmsFieldList) | (CmsFieldBase & decap_cms_core.CmsFieldHidden) | undefined)[];
+    static createHomePageFields(options?: VitePressHomePageFieldOptions): CmsField[];
     static createDefaultPageFolderCollection(name: string, folder: string, options?: VitePressFieldOptions & {
         collection?: Partial<Omit<DecapCmsCollection<'folder'>, 'name' | 'fields' | 'folder'>>;
     }): DecapCmsCollection<'folder'>;
@@ -320,6 +333,46 @@ declare class VitePress {
     };
 }
 
+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, "fields" | "files">> & {
+    fields: DecapCmsField[] | CmsField[];
+};
+declare function createFile(data: DecapCmsCollectionFile): DecapCmsCollectionFile;
+declare function createFileCollection(data: DecapCmsCollection<'file'>): KeysToCamelCase<Omit<decap_cms_core.CmsCollection, "fields" | "files">> & {
+    files: DecapCmsCollectionFile[];
+};
+declare function fieldToSnakeCase(field: DecapCmsField | CmsField): CmsField;
+type SharedAction<Type> = (Type extends (string | undefined) ? true : Type extends (unknown[] | undefined) ? true : false) extends true ? ({
+    /**
+     * The action to take when combining options from shared and collection options:
+     * - append: if specified in another collection, the new options will be appended to the shared value
+     * - overwrite: if specified in another collection, the new options will overwrite the share value
+     * @default 'overwrite'
+     */
+    action?: 'append' | 'overwrite';
+    value: Type;
+} | Type) : Type;
+type PartialIf<If extends boolean, T> = If extends true ? Partial<T> : T;
+type Invert<T extends boolean> = T extends true ? false : true;
+type SharedDecapCmsCollection<Type extends CollectionType> = Omit<DecapCmsCollection<Type>, 'fields' | 'files'>;
+type SharedDecapCmsCollectionOptions<Type extends CollectionType> = {
+    [K in keyof SharedDecapCmsCollection<Type>]: SharedAction<SharedDecapCmsCollection<Type>[K]>;
+};
+interface SharedOptions<Parent extends boolean = true> extends Pick<Exclude<SharedAction<string>, string>, 'action'> {
+    /**
+     * Changes the types on where required name fields (name, labels) must be defined:
+     * on the shared or collection options.
+     * @default true
+     */
+    requiredNameOnChildOptions?: Parent;
+}
+declare function createSharedCollectionOptions<Type extends CollectionType = CollectionType, Parent extends boolean = true, ChildType extends CollectionType = Type>(shared: PartialIf<Parent, SharedDecapCmsCollectionOptions<Type>>, options?: SharedOptions<Parent>): (collection: PartialIf<Invert<Parent>, SharedDecapCmsCollection<ChildType>>) => SharedDecapCmsCollection<ChildType>;
+
+declare function getGitData(): {
+    getBranch(): string | undefined;
+    getCommitSha(): string | undefined;
+};
+
 declare function VitePluginDecapCMS(options: Options): Plugin;
 
-export { type CdnLinkOptions, type CollectionType, type DecapCmsCollection, type DecapCmsCollectionFile, type DecapCmsConfig, type DecapCmsField, type DecapCmsFieldType, type DecapCmsFieldWidget, type DecapCmsMarkdownFieldRenderOptions, type DecapProxyOptions, type EnvContextOption, type EnvDevContextOption, type HeadConfig, type KeysToCamelCase, type KeysToSnakeCase, type LoginPageOptions, type Options, type OverwriteOptions, VitePress, type VitePressDefaultThemeFieldOptions, type VitePressDefaultThemeFrontmatterKeys, type VitePressFieldOptions, type VitePressHomePageFieldOptions, type VitePressHomePageFrontmatterKeys, type VitePressPageFrontmatterKeys, createField, createFile, createFileCollection, createFolderCollection, VitePluginDecapCMS as default, getGitData };
+export { type CdnLinkOptions, type CollectionType, type DecapCmsCollection, type DecapCmsCollectionFile, type DecapCmsConfig, type DecapCmsField, type DecapCmsFieldType, type DecapCmsFieldWidget, type DecapCmsMarkdownFieldRenderOptions, type DecapProxyOptions, type EnvContextOption, type EnvDevContextOption, type HeadConfig, type KeysToCamelCase, type KeysToSnakeCase, type LoginPageOptions, type Options, type OverwriteOptions, type SharedDecapCmsCollection, type SharedDecapCmsCollectionOptions, type SharedOptions, VitePress, type VitePressAdditionalField, type VitePressDefaultThemeFieldOptions, type VitePressDefaultThemeFrontmatterKeys, type VitePressFieldOptions, type VitePressHomePageFieldOptions, type VitePressHomePageFrontmatterKeys, type VitePressPageFrontmatterKeys, createField, createFile, createFileCollection, createFolderCollection, createOverwriteableField, createSharedCollectionOptions, VitePluginDecapCMS as default, fieldToSnakeCase, getGitData };