Aller au contenu
StudioCMS Docs
Site principal
Démo

schemas/config

Ce contenu n’est pas encore disponible dans votre langue.

Type Aliases

'Read the “', Type Aliases, '” section'

StudioCMSConfig

'Read the “', StudioCMSConfig, '” section'
type StudioCMSConfig = typeof StudioCMSOptionsSchema._output;

Defined in: studiocms/packages/studiocms/src/schemas/config/index.ts:104

StudioCMSOptions

'Read the “', StudioCMSOptions, '” section'
type StudioCMSOptions = typeof StudioCMSOptionsSchema._input;

Defined in: studiocms/packages/studiocms/src/schemas/config/index.ts:103

Variables

'Read the “', Variables, '” section'

StudioCMSOptionsSchema

'Read the “', StudioCMSOptionsSchema, '” section'
const StudioCMSOptionsSchema: ZodDefault<ZodOptional<ZodObject<{
  componentRegistry: ZodOptional<ZodRecord<ZodString, ZodString>>;
  dashboardConfig: ZodDefault<ZodOptional<ZodObject<{
     AuthConfig: ZodDefault<ZodOptional<ZodObject<..., ..., ..., ..., ...>>>;
     dashboardEnabled: ZodDefault<ZodOptional<ZodBoolean>>;
     dashboardRouteOverride: ZodOptional<ZodString>;
     developerConfig: ZodDefault<ZodOptional<ZodObject<..., ..., ..., ..., ...>>>;
     faviconURL: ZodDefault<ZodOptional<ZodString>>;
     inject404Route: ZodDefault<ZodOptional<ZodBoolean>>;
     versionCheck: ZodDefault<ZodOptional<ZodBoolean>>;
    }, "strip", ZodTypeAny, {
     AuthConfig: {
        enabled: boolean;
        providers: {
           auth0: boolean;
           discord: boolean;
           github: boolean;
           google: boolean;
           usernameAndPassword: boolean;
           usernameAndPasswordConfig: {
              allowUserRegistration: ...;
             };
          };
       };
     dashboardEnabled: boolean;
     dashboardRouteOverride: string;
     developerConfig: {
        demoMode:   | false
           | {
           password: ...;
           username: ...;
          };
       };
     faviconURL: string;
     inject404Route: boolean;
     versionCheck: boolean;
    }, {
     AuthConfig: {
        enabled: ... | ... | ...;
        providers: ... | ...;
       };
     dashboardEnabled: boolean;
     dashboardRouteOverride: string;
     developerConfig: {
        demoMode: ... | ... | ...;
       };
     faviconURL: string;
     inject404Route: boolean;
     versionCheck: boolean;
    }>>>;
  dateLocale: ZodDefault<ZodOptional<ZodString>>;
  dateTimeFormat: ZodDefault<ZodOptional<ZodType<DateTimeFormatOptions, ZodTypeDef, DateTimeFormatOptions>>>;
  dbStartPage: ZodDefault<ZodOptional<ZodBoolean>>;
  defaultFrontEndConfig: ZodDefault<ZodOptional<ZodUnion<[ZodDefault<ZodOptional<ZodObject<..., ..., ..., ..., ...>>>, ZodBoolean]>>>;
  imageService: ZodDefault<ZodOptional<ZodObject<{
     cdnPlugin: ZodOptional<ZodEnum<[...]>>;
    }, "strip", ZodTypeAny, {
     cdnPlugin: "cloudinary-js";
    }, {
     cdnPlugin: "cloudinary-js";
    }>>>;
  includedIntegrations: ZodDefault<ZodOptional<ZodObject<{
     robotsTXT: ZodDefault<ZodOptional<ZodUnion<...>>>;
    }, "strip", ZodTypeAny, {
     robotsTXT:   | boolean
        | RobotsConfig;
    }, {
     robotsTXT:   | boolean
        | RobotsConfig;
    }>>>;
  overrides: ZodDefault<ZodOptional<ZodObject<{
     CustomImageOverride: ZodOptional<ZodString>;
     FormattedDateOverride: ZodOptional<ZodString>;
    }, "strip", ZodTypeAny, {
     CustomImageOverride: string;
     FormattedDateOverride: string;
    }, {
     CustomImageOverride: string;
     FormattedDateOverride: string;
    }>>>;
  pageTypeOptions: ZodDefault<ZodOptional<ZodObject<{
     html: ZodDefault<ZodOptional<ZodObject<..., ..., ..., ..., ...>>>;
     markdown: ZodDefault<ZodOptional<ZodUnion<...>>>;
    }, "strip", ZodTypeAny, {
     html: {
        sanitize: {
           allowAttributes: ...;
           allowComments: ...;
           allowComponents: ...;
           allowCustomElements: ...;
           allowElements: ...;
           blockElements: ...;
           dropAttributes: ...;
           dropElements: ...;
          };
       };
     markdown:   | {
        flavor: "astro";
        sanitize: ... | ...;
       }
        | {
        autoLinkHeadings: boolean;
        callouts: ... | ... | ... | ...;
        discordSubtext: boolean;
        flavor: "studiocms";
        sanitize: ... | ...;
       };
    }, {
     html: {
        sanitize: ... | ...;
       };
     markdown:   | {
        flavor: "astro";
        sanitize: ... | ...;
       }
        | {
        autoLinkHeadings: ... | ... | ...;
        callouts: ... | ... | ... | ... | ...;
        discordSubtext: ... | ... | ...;
        flavor: "studiocms";
        sanitize: ... | ...;
       };
    }>>>;
  plugins: ZodOptional<ZodType<StudioCMSPlugin[], ZodTypeDef, StudioCMSPlugin[]>>;
  sdk: ZodEffects<ZodDefault<ZodOptional<ZodUnion<[ZodBoolean, ZodObject<{
     cacheConfig: ...;
    }, "strip", ZodTypeAny, {
     cacheConfig: ...;
    }, {
     cacheConfig: ...;
    }>]>>>, {
     cacheConfig: {
        enabled: boolean;
        lifetime: number;
       };
    },
     | undefined
     | boolean
     | {
     cacheConfig:   | boolean
        | {
        lifetime: string;
       };
    }>;
  verbose: ZodDefault<ZodOptional<ZodBoolean>>;
 }, "strip", ZodTypeAny, {
  componentRegistry: Record<string, string>;
  dashboardConfig: {
     AuthConfig: {
        enabled: boolean;
        providers: {
           auth0: boolean;
           discord: boolean;
           github: boolean;
           google: boolean;
           usernameAndPassword: boolean;
           usernameAndPasswordConfig: {
              allowUserRegistration: boolean;
             };
          };
       };
     dashboardEnabled: boolean;
     dashboardRouteOverride: string;
     developerConfig: {
        demoMode:   | false
           | {
           password: string;
           username: string;
          };
       };
     faviconURL: string;
     inject404Route: boolean;
     versionCheck: boolean;
    };
  dateLocale: string;
  dateTimeFormat: DateTimeFormatOptions;
  dbStartPage: boolean;
  defaultFrontEndConfig:   | boolean
     | {
     favicon: string;
     htmlDefaultHead: {
        attrs: Record<string, undefined | string | boolean>;
        content: string;
        tag:   | "title"
           | "base"
           | "link"
           | "style"
           | "meta"
           | "script"
           | "noscript"
           | "template";
       }[];
     htmlDefaultLanguage: string;
     injectQuickActionsMenu: boolean;
    };
  imageService: {
     cdnPlugin: "cloudinary-js";
    };
  includedIntegrations: {
     robotsTXT:   | boolean
        | RobotsConfig;
    };
  overrides: {
     CustomImageOverride: string;
     FormattedDateOverride: string;
    };
  pageTypeOptions: {
     html: {
        sanitize: {
           allowAttributes: Record<string, ...[]>;
           allowComments: boolean;
           allowComponents: boolean;
           allowCustomElements: boolean;
           allowElements: string[];
           blockElements: string[];
           dropAttributes: Record<string, ...[]>;
           dropElements: string[];
          };
       };
     markdown:   | {
        flavor: "astro";
        sanitize: {
           allowAttributes: Record<..., ...>;
           allowComments: boolean;
           allowComponents: boolean;
           allowCustomElements: boolean;
           allowElements: ...[];
           blockElements: ...[];
           dropAttributes: Record<..., ...>;
           dropElements: ...[];
          };
       }
        | {
        autoLinkHeadings: boolean;
        callouts: false | "github" | "obsidian" | "vitepress";
        discordSubtext: boolean;
        flavor: "studiocms";
        sanitize: {
           allowAttributes: Record<..., ...>;
           allowComments: boolean;
           allowComponents: boolean;
           allowCustomElements: boolean;
           allowElements: ...[];
           blockElements: ...[];
           dropAttributes: Record<..., ...>;
           dropElements: ...[];
          };
       };
    };
  plugins: StudioCMSPlugin[];
  sdk: {
     cacheConfig: {
        enabled: boolean;
        lifetime: number;
       };
    };
  verbose: boolean;
 }, {
  componentRegistry: Record<string, string>;
  dashboardConfig: {
     AuthConfig: {
        enabled: boolean;
        providers: {
           auth0: ... | ... | ...;
           discord: ... | ... | ...;
           github: ... | ... | ...;
           google: ... | ... | ...;
           usernameAndPassword: ... | ... | ...;
           usernameAndPasswordConfig: ... | ...;
          };
       };
     dashboardEnabled: boolean;
     dashboardRouteOverride: string;
     developerConfig: {
        demoMode:   | false
           | {
           password: string;
           username: string;
          };
       };
     faviconURL: string;
     inject404Route: boolean;
     versionCheck: boolean;
    };
  dateLocale: string;
  dateTimeFormat: DateTimeFormatOptions;
  dbStartPage: boolean;
  defaultFrontEndConfig:   | boolean
     | {
     favicon: string;
     htmlDefaultHead: {
        attrs: Record<..., ...>;
        content: string;
        tag:   | "title"
           | "base"
           | "link"
           | "style"
           | "meta"
           | "script"
           | "noscript"
           | "template";
       }[];
     htmlDefaultLanguage: string;
     injectQuickActionsMenu: boolean;
    };
  imageService: {
     cdnPlugin: "cloudinary-js";
    };
  includedIntegrations: {
     robotsTXT:   | boolean
        | RobotsConfig;
    };
  overrides: {
     CustomImageOverride: string;
     FormattedDateOverride: string;
    };
  pageTypeOptions: {
     html: {
        sanitize: {
           allowAttributes: ... | ...;
           allowComments: ... | ... | ...;
           allowComponents: ... | ... | ...;
           allowCustomElements: ... | ... | ...;
           allowElements: ... | ...;
           blockElements: ... | ...;
           dropAttributes: ... | ...;
           dropElements: ... | ...;
          };
       };
     markdown:   | {
        flavor: "astro";
        sanitize: {
           allowAttributes: ... | ...;
           allowComments: ... | ... | ...;
           allowComponents: ... | ... | ...;
           allowCustomElements: ... | ... | ...;
           allowElements: ... | ...;
           blockElements: ... | ...;
           dropAttributes: ... | ...;
           dropElements: ... | ...;
          };
       }
        | {
        autoLinkHeadings: boolean;
        callouts: false | "github" | "obsidian" | "vitepress";
        discordSubtext: boolean;
        flavor: "studiocms";
        sanitize: {
           allowAttributes: ... | ...;
           allowComments: ... | ... | ...;
           allowComponents: ... | ... | ...;
           allowCustomElements: ... | ... | ...;
           allowElements: ... | ...;
           blockElements: ... | ...;
           dropAttributes: ... | ...;
           dropElements: ... | ...;
          };
       };
    };
  plugins: StudioCMSPlugin[];
  sdk:   | boolean
     | {
     cacheConfig:   | boolean
        | {
        lifetime: string;
       };
    };
  verbose: boolean;
}>>>;

Defined in: studiocms/packages/studiocms/src/schemas/config/index.ts:25

References

'Read the “', References, '” section'

dashboardConfigSchema

'Read the “', dashboardConfigSchema, '” section'

Re-exports dashboardConfigSchema

DefaultFrontEndConfigSchema

'Read the “', DefaultFrontEndConfigSchema, '” section'

Re-exports DefaultFrontEndConfigSchema

FrontEndConfigSchema

'Read the “', FrontEndConfigSchema, '” section'

Re-exports FrontEndConfigSchema

imageServiceSchema

'Read the “', imageServiceSchema, '” section'

Re-exports imageServiceSchema

overridesSchema

'Read the “', overridesSchema, '” section'

Re-exports overridesSchema