schema

Type Aliases

StudioCMSDevAppsConfig

type StudioCMSDevAppsConfig = {
  appsConfig: {
     libSQLViewer: {
        enabled: boolean;
        endpoint: string;
     };
     wpImporter: {
        enabled: boolean;
        endpoint: string;
     };
  };
  endpoint: string;
  verbose: boolean;
};

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.

Type Declaration

appsConfig

appsConfig: {
  libSQLViewer: {
     enabled: boolean;
     endpoint: string;
  };
  wpImporter: {
     enabled: boolean;
     endpoint: string;
  };
} = AppsConfigSchema;

appsConfig.libSQLViewer

libSQLViewer: {
  enabled: boolean;
  endpoint: string;
} = libSQL;

appsConfig.libSQLViewer.enabled

enabled: boolean;

appsConfig.libSQLViewer.endpoint

endpoint: string;

appsConfig.wpImporter

wpImporter: {
  enabled: boolean;
  endpoint: string;
} = wpAPI;

appsConfig.wpImporter.enabled

enabled: boolean;

appsConfig.wpImporter.endpoint

endpoint: string;

endpoint

endpoint: string;

verbose

verbose: boolean;

---

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<StudioCMSDevAppsConfig>;

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.