studiocms 0.1.0-beta.7 → 0.1.0-beta.8

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

@@ -0,0 +1,455 @@
+import { z } from 'astro/zod';
+import type { PluggableList } from 'unified';
+export declare const FootnoteBackContentTemplateSchema: z.ZodFunction<z.ZodTuple<[z.ZodNumber, z.ZodNumber], z.ZodUnknown>, z.ZodUnion<[z.ZodArray<z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"comment">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "comment";
+}, {
+    value: string;
+    type: "comment";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"element">;
+    tagName: z.ZodString;
+    properties: z.ZodRecord<z.ZodString, z.ZodAny>;
+    children: z.ZodArray<z.ZodAny, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "element";
+    children: any[];
+    tagName: string;
+    properties: Record<string, any>;
+}, {
+    type: "element";
+    children: any[];
+    tagName: string;
+    properties: Record<string, any>;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "text";
+}, {
+    value: string;
+    type: "text";
+}>]>, "many">, z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"comment">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "comment";
+}, {
+    value: string;
+    type: "comment";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"element">;
+    tagName: z.ZodString;
+    properties: z.ZodRecord<z.ZodString, z.ZodAny>;
+    children: z.ZodArray<z.ZodAny, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "element";
+    children: any[];
+    tagName: string;
+    properties: Record<string, any>;
+}, {
+    type: "element";
+    children: any[];
+    tagName: string;
+    properties: Record<string, any>;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "text";
+}, {
+    value: string;
+    type: "text";
+}>]>, z.ZodString]>>;
+export declare const OptionsSchema: z.ZodObject<{
+    allowDangerousHtml: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    clobberPrefix: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    file: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+    footnoteBackContent: z.ZodOptional<z.ZodUnion<[z.ZodFunction<z.ZodTuple<[z.ZodNumber, z.ZodNumber], z.ZodUnknown>, z.ZodUnion<[z.ZodArray<z.ZodUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"comment">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "comment";
+    }, {
+        value: string;
+        type: "comment";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"element">;
+        tagName: z.ZodString;
+        properties: z.ZodRecord<z.ZodString, z.ZodAny>;
+        children: z.ZodArray<z.ZodAny, "many">;
+    }, "strip", z.ZodTypeAny, {
+        type: "element";
+        children: any[];
+        tagName: string;
+        properties: Record<string, any>;
+    }, {
+        type: "element";
+        children: any[];
+        tagName: string;
+        properties: Record<string, any>;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "text";
+    }, {
+        value: string;
+        type: "text";
+    }>]>, "many">, z.ZodUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"comment">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "comment";
+    }, {
+        value: string;
+        type: "comment";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"element">;
+        tagName: z.ZodString;
+        properties: z.ZodRecord<z.ZodString, z.ZodAny>;
+        children: z.ZodArray<z.ZodAny, "many">;
+    }, "strip", z.ZodTypeAny, {
+        type: "element";
+        children: any[];
+        tagName: string;
+        properties: Record<string, any>;
+    }, {
+        type: "element";
+        children: any[];
+        tagName: string;
+        properties: Record<string, any>;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "text";
+    }, {
+        value: string;
+        type: "text";
+    }>]>, z.ZodString]>>, z.ZodString, z.ZodNull]>>;
+    footnoteBackLabel: z.ZodOptional<z.ZodUnion<[z.ZodFunction<z.ZodTuple<[z.ZodNumber, z.ZodNumber], z.ZodUnknown>, z.ZodString>, z.ZodString, z.ZodNull]>>;
+    footnoteLabel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    footnoteLabelProperties: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodBoolean, z.ZodNumber, z.ZodString, z.ZodNull, z.ZodUndefined, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">]>>>>;
+    footnoteLabelTagName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    handlers: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+    passThrough: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
+    unknownHandler: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    file?: any;
+    allowDangerousHtml?: boolean | null | undefined;
+    clobberPrefix?: string | null | undefined;
+    footnoteBackContent?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string | {
+        value: string;
+        type: "comment";
+    } | {
+        type: "element";
+        children: any[];
+        tagName: string;
+        properties: Record<string, any>;
+    } | {
+        value: string;
+        type: "text";
+    } | ({
+        value: string;
+        type: "comment";
+    } | {
+        type: "element";
+        children: any[];
+        tagName: string;
+        properties: Record<string, any>;
+    } | {
+        value: string;
+        type: "text";
+    })[]) | null | undefined;
+    footnoteBackLabel?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string) | null | undefined;
+    footnoteLabel?: string | null | undefined;
+    footnoteLabelProperties?: Record<string, string | number | boolean | (string | number)[] | null | undefined> | null | undefined;
+    footnoteLabelTagName?: string | null | undefined;
+    handlers?: any;
+    passThrough?: string[] | null | undefined;
+    unknownHandler?: any;
+}, {
+    file?: any;
+    allowDangerousHtml?: boolean | null | undefined;
+    clobberPrefix?: string | null | undefined;
+    footnoteBackContent?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string | {
+        value: string;
+        type: "comment";
+    } | {
+        type: "element";
+        children: any[];
+        tagName: string;
+        properties: Record<string, any>;
+    } | {
+        value: string;
+        type: "text";
+    } | ({
+        value: string;
+        type: "comment";
+    } | {
+        type: "element";
+        children: any[];
+        tagName: string;
+        properties: Record<string, any>;
+    } | {
+        value: string;
+        type: "text";
+    })[]) | null | undefined;
+    footnoteBackLabel?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string) | null | undefined;
+    footnoteLabel?: string | null | undefined;
+    footnoteLabelProperties?: Record<string, string | number | boolean | (string | number)[] | null | undefined> | null | undefined;
+    footnoteLabelTagName?: string | null | undefined;
+    handlers?: any;
+    passThrough?: string[] | null | undefined;
+    unknownHandler?: any;
+}>;
+/**
+ * MDX Configuration Schema
+ *
+ * Allows customization of the MDX renderer
+ */
+export declare const mdxConfigSchema: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+    /** List of remark plugins (optional). */
+    remarkPlugins: z.ZodDefault<z.ZodOptional<z.ZodType<PluggableList, z.ZodTypeDef, PluggableList>>>;
+    /** List of rehype plugins (optional). */
+    rehypePlugins: z.ZodDefault<z.ZodOptional<z.ZodType<PluggableList, z.ZodTypeDef, PluggableList>>>;
+    /** List of recma plugins (optional); this is a new ecosystem, currently in beta, to transform esast trees (JavaScript) */
+    recmaPlugins: z.ZodDefault<z.ZodOptional<z.ZodType<PluggableList, z.ZodTypeDef, PluggableList>>>;
+    /** Options to pass through to remark-rehype (optional); the option allowDangerousHtml will always be set to true and the MDX nodes (see nodeTypes) are passed through; In particular, you might want to pass configuration for footnotes if your content is not in English. */
+    remarkRehypeOptions: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        allowDangerousHtml: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+        clobberPrefix: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        file: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+        footnoteBackContent: z.ZodOptional<z.ZodUnion<[z.ZodFunction<z.ZodTuple<[z.ZodNumber, z.ZodNumber], z.ZodUnknown>, z.ZodUnion<[z.ZodArray<z.ZodUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"comment">;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            type: "comment";
+        }, {
+            value: string;
+            type: "comment";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"element">;
+            tagName: z.ZodString;
+            properties: z.ZodRecord<z.ZodString, z.ZodAny>;
+            children: z.ZodArray<z.ZodAny, "many">;
+        }, "strip", z.ZodTypeAny, {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        }, {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"text">;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            type: "text";
+        }, {
+            value: string;
+            type: "text";
+        }>]>, "many">, z.ZodUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"comment">;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            type: "comment";
+        }, {
+            value: string;
+            type: "comment";
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"element">;
+            tagName: z.ZodString;
+            properties: z.ZodRecord<z.ZodString, z.ZodAny>;
+            children: z.ZodArray<z.ZodAny, "many">;
+        }, "strip", z.ZodTypeAny, {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        }, {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"text">;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            type: "text";
+        }, {
+            value: string;
+            type: "text";
+        }>]>, z.ZodString]>>, z.ZodString, z.ZodNull]>>;
+        footnoteBackLabel: z.ZodOptional<z.ZodUnion<[z.ZodFunction<z.ZodTuple<[z.ZodNumber, z.ZodNumber], z.ZodUnknown>, z.ZodString>, z.ZodString, z.ZodNull]>>;
+        footnoteLabel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        footnoteLabelProperties: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodBoolean, z.ZodNumber, z.ZodString, z.ZodNull, z.ZodUndefined, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">]>>>>;
+        footnoteLabelTagName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        handlers: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+        passThrough: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
+        unknownHandler: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        file?: any;
+        allowDangerousHtml?: boolean | null | undefined;
+        clobberPrefix?: string | null | undefined;
+        footnoteBackContent?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string | {
+            value: string;
+            type: "comment";
+        } | {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        } | {
+            value: string;
+            type: "text";
+        } | ({
+            value: string;
+            type: "comment";
+        } | {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        } | {
+            value: string;
+            type: "text";
+        })[]) | null | undefined;
+        footnoteBackLabel?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string) | null | undefined;
+        footnoteLabel?: string | null | undefined;
+        footnoteLabelProperties?: Record<string, string | number | boolean | (string | number)[] | null | undefined> | null | undefined;
+        footnoteLabelTagName?: string | null | undefined;
+        handlers?: any;
+        passThrough?: string[] | null | undefined;
+        unknownHandler?: any;
+    }, {
+        file?: any;
+        allowDangerousHtml?: boolean | null | undefined;
+        clobberPrefix?: string | null | undefined;
+        footnoteBackContent?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string | {
+            value: string;
+            type: "comment";
+        } | {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        } | {
+            value: string;
+            type: "text";
+        } | ({
+            value: string;
+            type: "comment";
+        } | {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        } | {
+            value: string;
+            type: "text";
+        })[]) | null | undefined;
+        footnoteBackLabel?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string) | null | undefined;
+        footnoteLabel?: string | null | undefined;
+        footnoteLabelProperties?: Record<string, string | number | boolean | (string | number)[] | null | undefined> | null | undefined;
+        footnoteLabelTagName?: string | null | undefined;
+        handlers?: any;
+        passThrough?: string[] | null | undefined;
+        unknownHandler?: any;
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    remarkPlugins: PluggableList;
+    rehypePlugins: PluggableList;
+    recmaPlugins: PluggableList;
+    remarkRehypeOptions: {
+        file?: any;
+        allowDangerousHtml?: boolean | null | undefined;
+        clobberPrefix?: string | null | undefined;
+        footnoteBackContent?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string | {
+            value: string;
+            type: "comment";
+        } | {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        } | {
+            value: string;
+            type: "text";
+        } | ({
+            value: string;
+            type: "comment";
+        } | {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        } | {
+            value: string;
+            type: "text";
+        })[]) | null | undefined;
+        footnoteBackLabel?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string) | null | undefined;
+        footnoteLabel?: string | null | undefined;
+        footnoteLabelProperties?: Record<string, string | number | boolean | (string | number)[] | null | undefined> | null | undefined;
+        footnoteLabelTagName?: string | null | undefined;
+        handlers?: any;
+        passThrough?: string[] | null | undefined;
+        unknownHandler?: any;
+    };
+}, {
+    remarkPlugins?: PluggableList | undefined;
+    rehypePlugins?: PluggableList | undefined;
+    recmaPlugins?: PluggableList | undefined;
+    remarkRehypeOptions?: {
+        file?: any;
+        allowDangerousHtml?: boolean | null | undefined;
+        clobberPrefix?: string | null | undefined;
+        footnoteBackContent?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string | {
+            value: string;
+            type: "comment";
+        } | {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        } | {
+            value: string;
+            type: "text";
+        } | ({
+            value: string;
+            type: "comment";
+        } | {
+            type: "element";
+            children: any[];
+            tagName: string;
+            properties: Record<string, any>;
+        } | {
+            value: string;
+            type: "text";
+        })[]) | null | undefined;
+        footnoteBackLabel?: string | ((args_0: number, args_1: number, ...args: unknown[]) => string) | null | undefined;
+        footnoteLabel?: string | null | undefined;
+        footnoteLabelProperties?: Record<string, string | number | boolean | (string | number)[] | null | undefined> | null | undefined;
+        footnoteLabelTagName?: string | null | undefined;
+        handlers?: any;
+        passThrough?: string[] | null | undefined;
+        unknownHandler?: any;
+    } | undefined;
+}>>>;

package/dist/schemas/config/mdx.js

@@ -0,0 +1,71 @@
+import { z } from "astro/zod";
+const CommentSchema = z.object({
+  // Define the schema for comments
+  type: z.literal("comment"),
+  value: z.string()
+});
+const ElementSchema = z.object({
+  // Define the schema for elements
+  type: z.literal("element"),
+  tagName: z.string(),
+  properties: z.record(z.any()),
+  children: z.array(z.any())
+});
+const TextSchema = z.object({
+  // Define the schema for text
+  type: z.literal("text"),
+  value: z.string()
+});
+const ElementContentSchema = z.union([CommentSchema, ElementSchema, TextSchema]);
+const FootnoteBackContentTemplateSchema = z.function().args(z.number(), z.number()).returns(
+  z.union([
+    z.array(ElementContentSchema),
+    // Array of ElementContent
+    ElementContentSchema,
+    // Single ElementContent
+    z.string()
+    // Or a string
+  ])
+);
+const FootnoteBackLabelTemplateSchema = z.function().args(z.number(), z.number()).returns(z.string());
+const HastPropertiesSchema = z.record(
+  z.union([
+    z.boolean(),
+    z.number(),
+    z.string(),
+    z.null(),
+    z.undefined(),
+    z.array(z.union([z.string(), z.number()]))
+  ])
+);
+const HandlersSchema = z.any();
+const MdastNodesSchema = z.object({ type: z.string() });
+const HandlerSchema = z.any();
+const OptionsSchema = z.object({
+  allowDangerousHtml: z.boolean().nullable().optional(),
+  clobberPrefix: z.string().nullable().optional(),
+  file: z.any().nullable().optional(),
+  footnoteBackContent: z.union([FootnoteBackContentTemplateSchema, z.string(), z.null()]).optional(),
+  footnoteBackLabel: z.union([FootnoteBackLabelTemplateSchema, z.string(), z.null()]).optional(),
+  footnoteLabel: z.string().nullable().optional(),
+  footnoteLabelProperties: HastPropertiesSchema.nullable().optional(),
+  footnoteLabelTagName: z.string().nullable().optional(),
+  handlers: HandlersSchema.nullable().optional(),
+  passThrough: z.array(MdastNodesSchema.shape.type).nullable().optional(),
+  unknownHandler: HandlerSchema.nullable().optional()
+});
+const mdxConfigSchema = z.object({
+  /** List of remark plugins (optional). */
+  remarkPlugins: z.custom().optional().default([]),
+  /** List of rehype plugins (optional). */
+  rehypePlugins: z.custom().optional().default([]),
+  /** List of recma plugins (optional); this is a new ecosystem, currently in beta, to transform esast trees (JavaScript) */
+  recmaPlugins: z.custom().optional().default([]),
+  /** Options to pass through to remark-rehype (optional); the option allowDangerousHtml will always be set to true and the MDX nodes (see nodeTypes) are passed through; In particular, you might want to pass configuration for footnotes if your content is not in English. */
+  remarkRehypeOptions: OptionsSchema.optional().default({})
+}).optional().default({});
+export {
+  FootnoteBackContentTemplateSchema,
+  OptionsSchema,
+  mdxConfigSchema
+};