studiocms 0.1.0-beta.10

package/dist/schemas/config/index.js

@@ -0,0 +1,95 @@
+import { z } from "astro/zod";
+import { overridesSchema } from "./componentoverrides.js";
+import { dashboardConfigSchema } from "./dashboard.js";
+import { DefaultFrontEndConfigSchema, FrontEndConfigSchema } from "./defaultFrontend.js";
+import { imageServiceSchema } from "./imageService.js";
+import { includedIntegrationsSchema } from "./integrations.js";
+import {
+  StudioCMSRendererConfigSchema,
+  TransformToProcessor
+} from "./rendererConfig.js";
+import { SDKSchema } from "./sdk.js";
+const StudioCMSOptionsSchema = z.object({
+  /**
+   * Project Initialization Page - Used during First Time Setup to initialize the database
+   *
+   * @default true
+   */
+  dbStartPage: z.boolean().optional().default(true),
+  /**
+   * Renderer Configuration
+   *
+   * Allows customization of the current renderer being used
+   */
+  rendererConfig: StudioCMSRendererConfigSchema,
+  /**
+   * Allows customization of the Image Service Options
+   */
+  imageService: imageServiceSchema,
+  /**
+   * Default Frontend Configuration
+   *
+   * Allows customization of the default frontend configuration
+   *
+   * @default true
+   */
+  defaultFrontEndConfig: DefaultFrontEndConfigSchema,
+  /**
+   * Allows customization of the Dashboard Configuration
+   */
+  dashboardConfig: dashboardConfigSchema,
+  /**
+   * Allows enabling and disabling of the included integrations
+   */
+  includedIntegrations: includedIntegrationsSchema,
+  /**
+   * Date Locale used for formatting dates
+   */
+  dateLocale: z.string().optional().default("en-us"),
+  /**
+   * DateTime Format Options
+   */
+  dateTimeFormat: z.custom().optional().default({
+    year: "numeric",
+    month: "short",
+    day: "numeric"
+  }),
+  /**
+   * Component Overrides - Allows for customizing the components used in StudioCMS
+   */
+  overrides: overridesSchema,
+  /**
+   * Whether to show verbose output
+   * @default false
+   */
+  verbose: z.boolean().optional().default(false),
+  /**
+   * Add Plugins to the StudioCMS
+   */
+  plugins: z.custom().optional(),
+  /**
+   * SDKSchema is a Zod schema that validates the SDK configuration.
+   * It can either be a boolean or an object containing cache configuration.
+   *
+   * If it is a boolean, it defaults to `true` and transforms into an object
+   * with default cache configuration.
+   *
+   * If it is an object, it must contain the `cacheConfig` property which is
+   * validated by the `SDKCacheSchema`.
+   */
+  sdk: SDKSchema,
+  /**
+   * Component Registry
+   */
+  componentRegistry: z.record(z.string()).optional()
+}).optional().default({});
+export {
+  DefaultFrontEndConfigSchema,
+  FrontEndConfigSchema,
+  StudioCMSOptionsSchema,
+  StudioCMSRendererConfigSchema,
+  TransformToProcessor,
+  dashboardConfigSchema,
+  imageServiceSchema,
+  overridesSchema
+};

package/dist/schemas/config/integrations.d.ts

@@ -0,0 +1,14 @@
+import { z } from 'astro/zod';
+import type { RobotsConfig } from '../../lib/robots/types.js';
+export declare const includedIntegrationsSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+    /**
+     * Allows the user to enable/disable the use of the StudioCMS Custom `astro-robots-txt` Integration
+     *
+     * @default robotsTXT: { policy: [ { userAgent: ['*'], allow: ['/'], disallow: ['/dashboard/'] } ] }
+     */
+    robotsTXT: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodType<RobotsConfig, z.ZodTypeDef, RobotsConfig>, z.ZodBoolean]>>>;
+}, "strip", z.ZodTypeAny, {
+    robotsTXT: boolean | RobotsConfig;
+}, {
+    robotsTXT?: boolean | RobotsConfig | undefined;
+}>>>;

package/dist/schemas/config/integrations.js

@@ -0,0 +1,12 @@
+import { z } from "astro/zod";
+const includedIntegrationsSchema = z.object({
+  /**
+   * Allows the user to enable/disable the use of the StudioCMS Custom `astro-robots-txt` Integration
+   *
+   * @default robotsTXT: { policy: [ { userAgent: ['*'], allow: ['/'], disallow: ['/dashboard/'] } ] }
+   */
+  robotsTXT: z.union([z.custom(), z.boolean()]).optional().default(true)
+}).optional().default({});
+export {
+  includedIntegrationsSchema
+};

package/dist/schemas/config/markdoc.d.ts

@@ -0,0 +1,172 @@
+import { z } from 'astro/zod';
+export declare const TagSchema: z.ZodObject<{
+    $$mdtype: z.ZodLiteral<"Tag">;
+    name: z.ZodDefault<z.ZodString>;
+    attributes: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    children: z.ZodDefault<z.ZodArray<z.ZodAny, "many">>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    $$mdtype: "Tag";
+    attributes: Record<string, any>;
+    children: any[];
+}, {
+    $$mdtype: "Tag";
+    name?: string | undefined;
+    attributes?: Record<string, any> | undefined;
+    children?: any[] | undefined;
+}>;
+declare const RenderableTreeNodesSchema: z.ZodUnion<[z.ZodArray<z.ZodUnion<[z.ZodObject<{
+    $$mdtype: z.ZodLiteral<"Tag">;
+    name: z.ZodDefault<z.ZodString>;
+    attributes: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    children: z.ZodDefault<z.ZodArray<z.ZodAny, "many">>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    $$mdtype: "Tag";
+    attributes: Record<string, any>;
+    children: any[];
+}, {
+    $$mdtype: "Tag";
+    name?: string | undefined;
+    attributes?: Record<string, any> | undefined;
+    children?: any[] | undefined;
+}>, z.ZodUnion<[z.ZodUnion<[z.ZodNull, z.ZodBoolean, z.ZodNumber, z.ZodString]>, z.ZodArray<z.ZodUnion<[z.ZodNull, z.ZodBoolean, z.ZodNumber, z.ZodString]>, "many">, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodNull, z.ZodBoolean, z.ZodNumber, z.ZodString]>>]>]>, "many">, z.ZodUnion<[z.ZodObject<{
+    $$mdtype: z.ZodLiteral<"Tag">;
+    name: z.ZodDefault<z.ZodString>;
+    attributes: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    children: z.ZodDefault<z.ZodArray<z.ZodAny, "many">>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    $$mdtype: "Tag";
+    attributes: Record<string, any>;
+    children: any[];
+}, {
+    $$mdtype: "Tag";
+    name?: string | undefined;
+    attributes?: Record<string, any> | undefined;
+    children?: any[] | undefined;
+}>, z.ZodUnion<[z.ZodUnion<[z.ZodNull, z.ZodBoolean, z.ZodNumber, z.ZodString]>, z.ZodArray<z.ZodUnion<[z.ZodNull, z.ZodBoolean, z.ZodNumber, z.ZodString]>, "many">, z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodNull, z.ZodBoolean, z.ZodNumber, z.ZodString]>>]>]>]>;
+type CustomMarkDocRendererNodes = z.infer<typeof RenderableTreeNodesSchema>;
+export type markdocRenderer = (nodes: CustomMarkDocRendererNodes) => Promise<string>;
+declare const MarkdocRendererSchema: z.ZodObject<{
+    name: z.ZodString;
+    renderer: z.ZodType<markdocRenderer, z.ZodTypeDef, markdocRenderer>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    renderer: markdocRenderer;
+}, {
+    name: string;
+    renderer: markdocRenderer;
+}>;
+export interface MarkdocRenderer extends z.infer<typeof MarkdocRendererSchema> {
+}
+export declare const markdocConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+    /**
+     * The MarkDoc Content Renderer to use for rendering pages and posts
+     *
+     * Can be one of the following: `html`, `react-static`, or a custom renderer
+     */
+    renderType: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"html">, z.ZodLiteral<"react-static">, z.ZodType<MarkdocRenderer, z.ZodTypeDef, MarkdocRenderer>]>>>;
+    /**
+     * The MarkDoc Arg Parse to use for rendering pages and posts
+     */
+    argParse: z.ZodOptional<z.ZodObject<{
+        file: z.ZodOptional<z.ZodString>;
+        slots: z.ZodOptional<z.ZodBoolean>;
+        location: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        file?: string | undefined;
+        slots?: boolean | undefined;
+        location?: boolean | undefined;
+    }, {
+        file?: string | undefined;
+        slots?: boolean | undefined;
+        location?: boolean | undefined;
+    }>>;
+    /**
+     * The MarkDoc Transform Config to use for rendering pages and posts
+     *
+     * @see https://markdoc.dev/docs/config
+     */
+    transformConfig: z.ZodOptional<z.ZodObject<{
+        nodes: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>>>;
+        tags: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>>>;
+        variables: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+        functions: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+        partials: z.ZodOptional<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+        validation: z.ZodOptional<z.ZodOptional<z.ZodObject<{
+            parents: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
+            validateFunctions: z.ZodOptional<z.ZodBoolean>;
+            environment: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            parents?: any[] | undefined;
+            validateFunctions?: boolean | undefined;
+            environment?: string | undefined;
+        }, {
+            parents?: any[] | undefined;
+            validateFunctions?: boolean | undefined;
+            environment?: string | undefined;
+        }>>>;
+    }, "strip", z.ZodTypeAny, {
+        tags?: Record<string, {}> | undefined;
+        validation?: {
+            parents?: any[] | undefined;
+            validateFunctions?: boolean | undefined;
+            environment?: string | undefined;
+        } | undefined;
+        nodes?: Record<string, {}> | undefined;
+        variables?: Record<string, any> | undefined;
+        functions?: Record<string, any> | undefined;
+        partials?: Record<string, any> | undefined;
+    }, {
+        tags?: Record<string, {}> | undefined;
+        validation?: {
+            parents?: any[] | undefined;
+            validateFunctions?: boolean | undefined;
+            environment?: string | undefined;
+        } | undefined;
+        nodes?: Record<string, {}> | undefined;
+        variables?: Record<string, any> | undefined;
+        functions?: Record<string, any> | undefined;
+        partials?: Record<string, any> | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    renderType: "html" | MarkdocRenderer | "react-static";
+    argParse?: {
+        file?: string | undefined;
+        slots?: boolean | undefined;
+        location?: boolean | undefined;
+    } | undefined;
+    transformConfig?: {
+        tags?: Record<string, {}> | undefined;
+        validation?: {
+            parents?: any[] | undefined;
+            validateFunctions?: boolean | undefined;
+            environment?: string | undefined;
+        } | undefined;
+        nodes?: Record<string, {}> | undefined;
+        variables?: Record<string, any> | undefined;
+        functions?: Record<string, any> | undefined;
+        partials?: Record<string, any> | undefined;
+    } | undefined;
+}, {
+    renderType?: "html" | MarkdocRenderer | "react-static" | undefined;
+    argParse?: {
+        file?: string | undefined;
+        slots?: boolean | undefined;
+        location?: boolean | undefined;
+    } | undefined;
+    transformConfig?: {
+        tags?: Record<string, {}> | undefined;
+        validation?: {
+            parents?: any[] | undefined;
+            validateFunctions?: boolean | undefined;
+            environment?: string | undefined;
+        } | undefined;
+        nodes?: Record<string, {}> | undefined;
+        variables?: Record<string, any> | undefined;
+        functions?: Record<string, any> | undefined;
+        partials?: Record<string, any> | undefined;
+    } | undefined;
+}>>>;
+export {};

package/dist/schemas/config/markdoc.js

@@ -0,0 +1,68 @@
+import { z } from "astro/zod";
+const PrimitiveSchema = z.union([z.null(), z.boolean(), z.number(), z.string()]);
+const ScalarSchema = z.union([
+  PrimitiveSchema,
+  z.array(PrimitiveSchema),
+  z.record(PrimitiveSchema)
+]);
+const TagSchema = z.object({
+  $$mdtype: z.literal("Tag"),
+  // The constant readonly property
+  name: z.string().default("div"),
+  // Default to 'div'
+  attributes: z.record(z.any()).default({}),
+  // Allow any key-value pairs
+  children: z.array(z.any()).default([])
+  // Array of RenderableTreeNode, default is empty array
+});
+const RenderableTreeNodeSchema = z.union([TagSchema, ScalarSchema]);
+const RenderableTreeNodesSchema = z.union([
+  z.array(RenderableTreeNodeSchema),
+  RenderableTreeNodeSchema
+]);
+const MarkdocRendererSchema = z.object({
+  name: z.string(),
+  renderer: z.custom()
+});
+const ParserArgsSchema = z.object({
+  file: z.string().optional(),
+  slots: z.boolean().optional(),
+  location: z.boolean().optional()
+});
+const ConfigTypeSchema = z.object({
+  nodes: z.record(
+    z.object({}).partial()
+    // Apply partial on the object inside the record
+  ).optional(),
+  tags: z.record(z.object({})).optional(),
+  variables: z.record(z.any()).optional(),
+  functions: z.record(z.any()).optional(),
+  partials: z.record(z.any()).optional(),
+  validation: z.object({
+    parents: z.array(z.any()).optional(),
+    validateFunctions: z.boolean().optional(),
+    environment: z.string().optional()
+  }).optional()
+}).partial();
+const markdocConfigSchema = z.object({
+  /**
+   * The MarkDoc Content Renderer to use for rendering pages and posts
+   *
+   * Can be one of the following: `html`, `react-static`, or a custom renderer
+   */
+  renderType: z.union([z.literal("html"), z.literal("react-static"), z.custom()]).optional().default("html"),
+  /**
+   * The MarkDoc Arg Parse to use for rendering pages and posts
+   */
+  argParse: ParserArgsSchema.optional(),
+  /**
+   * The MarkDoc Transform Config to use for rendering pages and posts
+   *
+   * @see https://markdoc.dev/docs/config
+   */
+  transformConfig: ConfigTypeSchema.optional()
+}).optional().default({});
+export {
+  TagSchema,
+  markdocConfigSchema
+};