@tutorialkit-rb/types 0.1.4

package/dist/schemas/lesson.js

@@ -0,0 +1,10 @@
+import { z } from 'zod';
+import { baseSchema } from './common.js';
+export const lessonSchema = baseSchema.extend({
+    type: z.literal('lesson'),
+    scope: z.string().optional().describe('A prefix that all file paths must match to be visible in the file tree.'),
+    hideRoot: z
+        .boolean()
+        .optional()
+        .describe('If set to false, `/` is shown at the top of the file tree. Defaults to true.'),
+});

package/dist/schemas/metatags.d.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export declare const metaTagsSchema: z.ZodObject<{
+    image: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    image?: string | undefined;
+    description?: string | undefined;
+    title?: string | undefined;
+}, {
+    image?: string | undefined;
+    description?: string | undefined;
+    title?: string | undefined;
+}>;
+export type MetaTagsSchema = z.infer<typeof metaTagsSchema>;

package/dist/schemas/metatags.js

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export const metaTagsSchema = z.object({
+    image: z
+        .string()
+        .optional()
+        /**
+         * Ideally we would want to use `image` from:
+         * https://docs.astro.build/en/guides/images/#images-in-content-collections .
+         */
+        .describe('Image to show on social previews. A relative path is resolved to the public folder.'),
+    description: z.string().optional().describe('A description for metadata'),
+    title: z.string().optional().describe('A title to use specifically for metadata'),
+});

package/dist/schemas/part.d.ts

@@ -0,0 +1,382 @@
+import { z } from 'zod';
+export declare const partSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+    mainCommand: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>, z.ZodObject<{
+        command: z.ZodString;
+        title: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        title: string;
+        command: string;
+    }, {
+        title: string;
+        command: string;
+    }>]>>;
+    prepareCommands: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>, z.ZodObject<{
+        command: z.ZodString;
+        title: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        title: string;
+        command: string;
+    }, {
+        title: string;
+        command: string;
+    }>]>, "many">>;
+}, {
+    meta: z.ZodOptional<z.ZodObject<{
+        image: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        image?: string | undefined;
+        description?: string | undefined;
+        title?: string | undefined;
+    }, {
+        image?: string | undefined;
+        description?: string | undefined;
+        title?: string | undefined;
+    }>>;
+    custom: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    previews: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodTuple<[z.ZodNumber, z.ZodString], null>, z.ZodTuple<[z.ZodNumber, z.ZodString, z.ZodString], null>, z.ZodObject<{
+        port: z.ZodNumber;
+        title: z.ZodString;
+        pathname: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        title: string;
+        port: number;
+        pathname?: string | undefined;
+    }, {
+        title: string;
+        port: number;
+        pathname?: string | undefined;
+    }>]>, "many">]>>;
+    autoReload: z.ZodOptional<z.ZodBoolean>;
+    filesystem: z.ZodOptional<z.ZodObject<{
+        watch: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    }, "strip", z.ZodTypeAny, {
+        watch?: boolean | string[] | undefined;
+    }, {
+        watch?: boolean | string[] | undefined;
+    }>>;
+    template: z.ZodOptional<z.ZodString>;
+    terminal: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+        open: z.ZodOptional<z.ZodBoolean>;
+        panels: z.ZodUnion<[z.ZodLiteral<"output">, z.ZodLiteral<"terminal">, z.ZodEffects<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodLiteral<"output">, z.ZodLiteral<"terminal">]>, z.ZodTuple<[z.ZodUnion<[z.ZodLiteral<"output">, z.ZodLiteral<"terminal">]>, z.ZodString], null>, z.ZodObject<{
+            type: z.ZodUnion<[z.ZodLiteral<"output">, z.ZodLiteral<"terminal">]>;
+            id: z.ZodOptional<z.ZodString>;
+            title: z.ZodOptional<z.ZodString>;
+            allowRedirects: z.ZodOptional<z.ZodBoolean>;
+            allowCommands: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        }, "strict", z.ZodTypeAny, {
+            type: "output" | "terminal";
+            title?: string | undefined;
+            id?: string | undefined;
+            allowRedirects?: boolean | undefined;
+            allowCommands?: string[] | undefined;
+        }, {
+            type: "output" | "terminal";
+            title?: string | undefined;
+            id?: string | undefined;
+            allowRedirects?: boolean | undefined;
+            allowCommands?: string[] | undefined;
+        }>]>, "many">, ("output" | "terminal" | ["output" | "terminal", string] | {
+            type: "output" | "terminal";
+            title?: string | undefined;
+            id?: string | undefined;
+            allowRedirects?: boolean | undefined;
+            allowCommands?: string[] | undefined;
+        })[], ("output" | "terminal" | ["output" | "terminal", string] | {
+            type: "output" | "terminal";
+            title?: string | undefined;
+            id?: string | undefined;
+            allowRedirects?: boolean | undefined;
+            allowCommands?: string[] | undefined;
+        })[]>]>;
+        activePanel: z.ZodOptional<z.ZodNumber>;
+        allowRedirects: z.ZodOptional<z.ZodBoolean>;
+        allowCommands: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
+            type: "output" | "terminal";
+            title?: string | undefined;
+            id?: string | undefined;
+            allowRedirects?: boolean | undefined;
+            allowCommands?: string[] | undefined;
+        })[];
+        open?: boolean | undefined;
+        allowRedirects?: boolean | undefined;
+        allowCommands?: string[] | undefined;
+        activePanel?: number | undefined;
+    }, {
+        panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
+            type: "output" | "terminal";
+            title?: string | undefined;
+            id?: string | undefined;
+            allowRedirects?: boolean | undefined;
+            allowCommands?: string[] | undefined;
+        })[];
+        open?: boolean | undefined;
+        allowRedirects?: boolean | undefined;
+        allowCommands?: string[] | undefined;
+        activePanel?: number | undefined;
+    }>]>>;
+    focus: z.ZodOptional<z.ZodString>;
+    editor: z.ZodOptional<z.ZodUnion<[z.ZodOptional<z.ZodBoolean>, z.ZodObject<{
+        fileTree: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+            allowEdits: z.ZodUnion<[z.ZodBoolean, z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+        }, "strict", z.ZodTypeAny, {
+            allowEdits: string | boolean | string[];
+        }, {
+            allowEdits: string | boolean | string[];
+        }>]>>;
+    }, "strict", z.ZodTypeAny, {
+        fileTree?: boolean | {
+            allowEdits: string | boolean | string[];
+        } | undefined;
+    }, {
+        fileTree?: boolean | {
+            allowEdits: string | boolean | string[];
+        } | undefined;
+    }>]>>;
+    i18n: z.ZodOptional<z.ZodObject<{
+        partTemplate: z.ZodOptional<z.ZodString>;
+        editPageText: z.ZodOptional<z.ZodString>;
+        webcontainerLinkText: z.ZodOptional<z.ZodString>;
+        startWebContainerText: z.ZodOptional<z.ZodString>;
+        noPreviewNorStepsText: z.ZodOptional<z.ZodString>;
+        filesTitleText: z.ZodOptional<z.ZodString>;
+        fileTreeCreateFileText: z.ZodOptional<z.ZodString>;
+        fileTreeCreateFolderText: z.ZodOptional<z.ZodString>;
+        fileTreeActionNotAllowedText: z.ZodOptional<z.ZodString>;
+        fileTreeFileExistsAlreadyText: z.ZodOptional<z.ZodString>;
+        fileTreeAllowedPatternsText: z.ZodOptional<z.ZodString>;
+        confirmationText: z.ZodOptional<z.ZodString>;
+        prepareEnvironmentTitleText: z.ZodOptional<z.ZodString>;
+        defaultPreviewTitleText: z.ZodOptional<z.ZodString>;
+        reloadPreviewTitle: z.ZodOptional<z.ZodString>;
+        toggleTerminalButtonText: z.ZodOptional<z.ZodString>;
+        solveButtonText: z.ZodOptional<z.ZodString>;
+        resetButtonText: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        partTemplate?: string | undefined;
+        editPageText?: string | undefined;
+        webcontainerLinkText?: string | undefined;
+        startWebContainerText?: string | undefined;
+        noPreviewNorStepsText?: string | undefined;
+        filesTitleText?: string | undefined;
+        fileTreeCreateFileText?: string | undefined;
+        fileTreeCreateFolderText?: string | undefined;
+        fileTreeActionNotAllowedText?: string | undefined;
+        fileTreeFileExistsAlreadyText?: string | undefined;
+        fileTreeAllowedPatternsText?: string | undefined;
+        confirmationText?: string | undefined;
+        prepareEnvironmentTitleText?: string | undefined;
+        defaultPreviewTitleText?: string | undefined;
+        reloadPreviewTitle?: string | undefined;
+        toggleTerminalButtonText?: string | undefined;
+        solveButtonText?: string | undefined;
+        resetButtonText?: string | undefined;
+    }, {
+        partTemplate?: string | undefined;
+        editPageText?: string | undefined;
+        webcontainerLinkText?: string | undefined;
+        startWebContainerText?: string | undefined;
+        noPreviewNorStepsText?: string | undefined;
+        filesTitleText?: string | undefined;
+        fileTreeCreateFileText?: string | undefined;
+        fileTreeCreateFolderText?: string | undefined;
+        fileTreeActionNotAllowedText?: string | undefined;
+        fileTreeFileExistsAlreadyText?: string | undefined;
+        fileTreeAllowedPatternsText?: string | undefined;
+        confirmationText?: string | undefined;
+        prepareEnvironmentTitleText?: string | undefined;
+        defaultPreviewTitleText?: string | undefined;
+        reloadPreviewTitle?: string | undefined;
+        toggleTerminalButtonText?: string | undefined;
+        solveButtonText?: string | undefined;
+        resetButtonText?: string | undefined;
+    }>>;
+    editPageLink: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    openInStackBlitz: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+        projectTitle: z.ZodOptional<z.ZodString>;
+        projectDescription: z.ZodOptional<z.ZodString>;
+        projectTemplate: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"html">, z.ZodLiteral<"node">, z.ZodLiteral<"angular-cli">, z.ZodLiteral<"create-react-app">, z.ZodLiteral<"javascript">, z.ZodLiteral<"polymer">, z.ZodLiteral<"typescript">, z.ZodLiteral<"vue">]>>;
+    }, "strict", z.ZodTypeAny, {
+        projectTitle?: string | undefined;
+        projectDescription?: string | undefined;
+        projectTemplate?: "html" | "node" | "angular-cli" | "create-react-app" | "javascript" | "polymer" | "typescript" | "vue" | undefined;
+    }, {
+        projectTitle?: string | undefined;
+        projectDescription?: string | undefined;
+        projectTemplate?: "html" | "node" | "angular-cli" | "create-react-app" | "javascript" | "polymer" | "typescript" | "vue" | undefined;
+    }>]>>;
+    downloadAsZip: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+        filename: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        filename: string;
+    }, {
+        filename: string;
+    }>]>>;
+}>, {
+    title: z.ZodString;
+    slug: z.ZodOptional<z.ZodString>;
+}>, {
+    type: z.ZodLiteral<"part">;
+    chapters: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    lessons: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}>, "strip", z.ZodTypeAny, {
+    type: "part";
+    title: string;
+    custom?: Record<string, any> | undefined;
+    mainCommand?: string | [string, string] | {
+        title: string;
+        command: string;
+    } | undefined;
+    prepareCommands?: (string | [string, string] | {
+        title: string;
+        command: string;
+    })[] | undefined;
+    terminal?: boolean | {
+        panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
+            type: "output" | "terminal";
+            title?: string | undefined;
+            id?: string | undefined;
+            allowRedirects?: boolean | undefined;
+            allowCommands?: string[] | undefined;
+        })[];
+        open?: boolean | undefined;
+        allowRedirects?: boolean | undefined;
+        allowCommands?: string[] | undefined;
+        activePanel?: number | undefined;
+    } | undefined;
+    meta?: {
+        image?: string | undefined;
+        description?: string | undefined;
+        title?: string | undefined;
+    } | undefined;
+    previews?: boolean | (string | number | [number, string] | [number, string, string] | {
+        title: string;
+        port: number;
+        pathname?: string | undefined;
+    })[] | undefined;
+    autoReload?: boolean | undefined;
+    filesystem?: {
+        watch?: boolean | string[] | undefined;
+    } | undefined;
+    template?: string | undefined;
+    focus?: string | undefined;
+    editor?: boolean | {
+        fileTree?: boolean | {
+            allowEdits: string | boolean | string[];
+        } | undefined;
+    } | undefined;
+    i18n?: {
+        partTemplate?: string | undefined;
+        editPageText?: string | undefined;
+        webcontainerLinkText?: string | undefined;
+        startWebContainerText?: string | undefined;
+        noPreviewNorStepsText?: string | undefined;
+        filesTitleText?: string | undefined;
+        fileTreeCreateFileText?: string | undefined;
+        fileTreeCreateFolderText?: string | undefined;
+        fileTreeActionNotAllowedText?: string | undefined;
+        fileTreeFileExistsAlreadyText?: string | undefined;
+        fileTreeAllowedPatternsText?: string | undefined;
+        confirmationText?: string | undefined;
+        prepareEnvironmentTitleText?: string | undefined;
+        defaultPreviewTitleText?: string | undefined;
+        reloadPreviewTitle?: string | undefined;
+        toggleTerminalButtonText?: string | undefined;
+        solveButtonText?: string | undefined;
+        resetButtonText?: string | undefined;
+    } | undefined;
+    editPageLink?: string | boolean | undefined;
+    openInStackBlitz?: boolean | {
+        projectTitle?: string | undefined;
+        projectDescription?: string | undefined;
+        projectTemplate?: "html" | "node" | "angular-cli" | "create-react-app" | "javascript" | "polymer" | "typescript" | "vue" | undefined;
+    } | undefined;
+    downloadAsZip?: boolean | {
+        filename: string;
+    } | undefined;
+    slug?: string | undefined;
+    lessons?: string[] | undefined;
+    chapters?: string[] | undefined;
+}, {
+    type: "part";
+    title: string;
+    custom?: Record<string, any> | undefined;
+    mainCommand?: string | [string, string] | {
+        title: string;
+        command: string;
+    } | undefined;
+    prepareCommands?: (string | [string, string] | {
+        title: string;
+        command: string;
+    })[] | undefined;
+    terminal?: boolean | {
+        panels: "output" | "terminal" | ("output" | "terminal" | ["output" | "terminal", string] | {
+            type: "output" | "terminal";
+            title?: string | undefined;
+            id?: string | undefined;
+            allowRedirects?: boolean | undefined;
+            allowCommands?: string[] | undefined;
+        })[];
+        open?: boolean | undefined;
+        allowRedirects?: boolean | undefined;
+        allowCommands?: string[] | undefined;
+        activePanel?: number | undefined;
+    } | undefined;
+    meta?: {
+        image?: string | undefined;
+        description?: string | undefined;
+        title?: string | undefined;
+    } | undefined;
+    previews?: boolean | (string | number | [number, string] | [number, string, string] | {
+        title: string;
+        port: number;
+        pathname?: string | undefined;
+    })[] | undefined;
+    autoReload?: boolean | undefined;
+    filesystem?: {
+        watch?: boolean | string[] | undefined;
+    } | undefined;
+    template?: string | undefined;
+    focus?: string | undefined;
+    editor?: boolean | {
+        fileTree?: boolean | {
+            allowEdits: string | boolean | string[];
+        } | undefined;
+    } | undefined;
+    i18n?: {
+        partTemplate?: string | undefined;
+        editPageText?: string | undefined;
+        webcontainerLinkText?: string | undefined;
+        startWebContainerText?: string | undefined;
+        noPreviewNorStepsText?: string | undefined;
+        filesTitleText?: string | undefined;
+        fileTreeCreateFileText?: string | undefined;
+        fileTreeCreateFolderText?: string | undefined;
+        fileTreeActionNotAllowedText?: string | undefined;
+        fileTreeFileExistsAlreadyText?: string | undefined;
+        fileTreeAllowedPatternsText?: string | undefined;
+        confirmationText?: string | undefined;
+        prepareEnvironmentTitleText?: string | undefined;
+        defaultPreviewTitleText?: string | undefined;
+        reloadPreviewTitle?: string | undefined;
+        toggleTerminalButtonText?: string | undefined;
+        solveButtonText?: string | undefined;
+        resetButtonText?: string | undefined;
+    } | undefined;
+    editPageLink?: string | boolean | undefined;
+    openInStackBlitz?: boolean | {
+        projectTitle?: string | undefined;
+        projectDescription?: string | undefined;
+        projectTemplate?: "html" | "node" | "angular-cli" | "create-react-app" | "javascript" | "polymer" | "typescript" | "vue" | undefined;
+    } | undefined;
+    downloadAsZip?: boolean | {
+        filename: string;
+    } | undefined;
+    slug?: string | undefined;
+    lessons?: string[] | undefined;
+    chapters?: string[] | undefined;
+}>;
+export type PartSchema = z.infer<typeof partSchema>;

package/dist/schemas/part.js

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+import { baseSchema } from './common.js';
+export const partSchema = baseSchema.extend({
+    type: z.literal('part'),
+    chapters: z
+        .array(z.string())
+        .optional()
+        .describe('The list of chapters in this part. The order of this array defines the order of the chapters. If not specified a folder-based numbering system is used instead.'),
+    lessons: z
+        .array(z.string())
+        .optional()
+        .describe('The list of lessons in this part. The order of this array defines the order of the lessons. If not specified a folder-based numbering system is used instead.'),
+});