schema

Type Aliases

StudioCMSDevAppsConfig

type StudioCMSDevAppsConfig = z.infer<typeof StudioCMSDevAppsSchema>;

Defined in: studiocms/packages/studiocms_devapps/src/schema/index.ts:108

Represents the configuration type for StudioCMS development applications. This type is derived from the output of the StudioCMSDevAppsSchema.

---

StudioCMSDevAppsOptions

type StudioCMSDevAppsOptions = typeof StudioCMSDevAppsSchema._input;

Defined in: studiocms/packages/studiocms_devapps/src/schema/index.ts:102

Represents the options for StudioCMS development applications.

This type is derived from the _input property of the StudioCMSDevAppsSchema object.

Variables

AppsConfigSchema

const AppsConfigSchema: ZodEffects<ZodDefault<ZodOptional<ZodObject<{
  libSQLViewer: ZodUnion<[ZodBoolean, ZodObject<{
     endpoint: ZodDefault<ZodOptional<...>>;
    }, "strip", ZodTypeAny, {
     endpoint: string;
    }, {
     endpoint: string;
    }>]>;
  wpImporter: ZodUnion<[ZodBoolean, ZodObject<{
     endpoint: ZodDefault<ZodOptional<...>>;
    }, "strip", ZodTypeAny, {
     endpoint: string;
    }, {
     endpoint: string;
    }>]>;
 }, "strip", ZodTypeAny, {
  libSQLViewer:   | boolean
     | {
     endpoint: string;
    };
  wpImporter:   | boolean
     | {
     endpoint: string;
    };
 }, {
  libSQLViewer:   | boolean
     | {
     endpoint: string;
    };
  wpImporter:   | boolean
     | {
     endpoint: string;
    };
 }>>>, {
  libSQLViewer: {
     enabled: boolean;
     endpoint: string;
    };
  wpImporter: {
     enabled: boolean;
     endpoint: string;
    };
 },
  | undefined
  | {
  libSQLViewer:   | boolean
     | {
     endpoint: string;
    };
  wpImporter:   | boolean
     | {
     endpoint: string;
    };
}>;

Defined in: studiocms/packages/studiocms_devapps/src/schema/index.ts:26

Schema for the configuration of StudioCMS development applications.

This schema defines the configuration options for the following applications:

• Astro DB LibSQL Viewer App: Controlled by the libSQLViewer property.
• StudioCMS WP API Importer App: Controlled by the wpImporter property.

The schema provides default values and transformation logic to ensure the configuration is in the expected format.

Returns

An object with the transformed configuration:

• libSQLViewer - An object with an enabled property indicating the app’s status.
• wpImporter - An object with enabled and endpoint properties for the app’s configuration.

---

StudioCMSDevAppsSchema

const StudioCMSDevAppsSchema: ZodDefault<ZodOptional<ZodObject<{
  appsConfig: ZodEffects<ZodDefault<ZodOptional<ZodObject<{
     libSQLViewer: ZodUnion<[..., ...]>;
     wpImporter: ZodUnion<[..., ...]>;
    }, "strip", ZodTypeAny, {
     libSQLViewer:   | boolean
        | {
        endpoint: ...;
       };
     wpImporter:   | boolean
        | {
        endpoint: ...;
       };
    }, {
     libSQLViewer:   | boolean
        | {
        endpoint: ...;
       };
     wpImporter:   | boolean
        | {
        endpoint: ...;
       };
    }>>>, {
     libSQLViewer: {
        enabled: boolean;
        endpoint: string;
       };
     wpImporter: {
        enabled: boolean;
        endpoint: string;
       };
    },
     | undefined
     | {
     libSQLViewer:   | boolean
        | {
        endpoint: string;
       };
     wpImporter:   | boolean
        | {
        endpoint: string;
       };
    }>;
  endpoint: ZodDefault<ZodOptional<ZodString>>;
  verbose: ZodDefault<ZodOptional<ZodBoolean>>;
 }, "strip", ZodTypeAny, {
  appsConfig: {
     libSQLViewer: {
        enabled: boolean;
        endpoint: string;
       };
     wpImporter: {
        enabled: boolean;
        endpoint: string;
       };
    };
  endpoint: string;
  verbose: boolean;
 }, {
  appsConfig: {
     libSQLViewer:   | boolean
        | {
        endpoint: string;
       };
     wpImporter:   | boolean
        | {
        endpoint: string;
       };
    };
  endpoint: string;
  verbose: boolean;
}>>>;

Defined in: studiocms/packages/studiocms_devapps/src/schema/index.ts:88

Schema definition for StudioCMS development applications configuration.

This schema defines the structure of the configuration object for StudioCMS development applications. It includes the following properties:

• endpoint (optional): A string representing the endpoint for the dev apps. Defaults to ‘_studiocms-devapps’.
• verbose (optional): A boolean indicating whether verbose logging is enabled. Defaults to false.
• appsConfig: The configuration schema for the applications.

The entire schema is optional and defaults to an empty object if not provided.