@tutorialkit-rb/types 1.5.2-rb.0.1.0

package/dist/schemas/tutorial.d.ts

@@ -0,0 +1,378 @@
+import { z } from 'zod';
+export declare const tutorialSchema: z.ZodObject<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;
+    }>]>>;
+}>, {
+    type: z.ZodLiteral<"tutorial">;
+    logoLink: z.ZodOptional<z.ZodString>;
+    parts: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    lessons: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}>, "strip", z.ZodTypeAny, {
+    type: "tutorial";
+    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;
+    lessons?: string[] | undefined;
+    logoLink?: string | undefined;
+    parts?: string[] | undefined;
+}, {
+    type: "tutorial";
+    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;
+    lessons?: string[] | undefined;
+    logoLink?: string | undefined;
+    parts?: string[] | undefined;
+}>;
+export type TutorialSchema = z.infer<typeof tutorialSchema>;

package/dist/schemas/tutorial.js

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

package/dist/utils/interpolation.d.ts

@@ -0,0 +1 @@
+export declare function interpolateString(template: string, variables: Record<string, string | number>): string;

package/dist/utils/interpolation.js

@@ -0,0 +1,6 @@
+export function interpolateString(template, variables) {
+    for (const [variable, value] of Object.entries(variables)) {
+        template = template.replace(`\${${variable}}`, value.toString());
+    }
+    return template;
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@tutorialkit-rb/types",
+  "version": "1.5.2-rb.0.1.0",
+  "description": "Types for TutorialKit",
+  "author": "StackBlitz Inc.",
+  "type": "module",
+  "bugs": "https://github.com/stackblitz/tutorialkit/issues",
+  "homepage": "https://github.com/stackblitz/tutorialkit",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Bakaface/tutorialkit.rb",
+    "directory": "packages/types"
+  },
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "dev": "pnpm run build --watch --preserveWatchOutput",
+    "test": "vitest"
+  },
+  "dependencies": {
+    "zod": "3.23.8"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.5",
+    "vitest": "^3.0.5"
+  },
+  "keywords": [
+    "ruby",
+    "rails",
+    "wasm"
+  ]
+}