@tutorialkit-rb/types 1.5.2-rb.0.1.0

package/README.md

@@ -0,0 +1,13 @@
+# @tutorialkit/types
+
+Collection of schemas and type definitions used by a TutorialKit project.
+
+In particular, this contains the schema for TutorialKit's main content format: parts, chapters, and lessons.
+
+## License
+
+MIT
+
+Copyright (c) 2024–present [StackBlitz][stackblitz]
+
+[stackblitz]: https://stackblitz.com/

package/dist/default-localization.d.ts

@@ -0,0 +1,20 @@
+export declare const DEFAULT_LOCALIZATION: {
+    partTemplate: string;
+    noPreviewNorStepsText: string;
+    startWebContainerText: string;
+    editPageText: string;
+    webcontainerLinkText: string;
+    filesTitleText: string;
+    fileTreeCreateFileText: string;
+    fileTreeCreateFolderText: string;
+    fileTreeActionNotAllowedText: string;
+    fileTreeFileExistsAlreadyText: string;
+    fileTreeAllowedPatternsText: string;
+    confirmationText: string;
+    prepareEnvironmentTitleText: string;
+    defaultPreviewTitleText: string;
+    reloadPreviewTitle: string;
+    toggleTerminalButtonText: string;
+    solveButtonText: string;
+    resetButtonText: string;
+};

package/dist/default-localization.js

@@ -0,0 +1,20 @@
+export const DEFAULT_LOCALIZATION = {
+    partTemplate: 'Part ${index}: ${title}',
+    noPreviewNorStepsText: 'No preview to run nor steps to show',
+    startWebContainerText: 'Run this tutorial',
+    editPageText: 'Edit this page',
+    webcontainerLinkText: 'Powered by WebContainers',
+    filesTitleText: 'Files',
+    fileTreeCreateFileText: 'Create file',
+    fileTreeCreateFolderText: 'Create folder',
+    fileTreeActionNotAllowedText: 'This action is not allowed',
+    fileTreeFileExistsAlreadyText: 'File exists on filesystem already',
+    fileTreeAllowedPatternsText: 'Created files and folders must match following patterns:',
+    confirmationText: 'OK',
+    prepareEnvironmentTitleText: 'Preparing Environment',
+    defaultPreviewTitleText: 'Preview',
+    reloadPreviewTitle: 'Reload Preview',
+    toggleTerminalButtonText: 'Toggle Terminal',
+    solveButtonText: 'Solve',
+    resetButtonText: 'Reset',
+};

package/dist/entities/index.d.ts

@@ -0,0 +1,61 @@
+import type { I18nSchema } from '../schemas/i18n.js';
+import type { ChapterSchema, CustomSchema, LessonSchema, PartSchema } from '../schemas/index.js';
+import type { MetaTagsSchema } from '../schemas/metatags.js';
+export type * from './nav.js';
+export type FileDescriptor = {
+    path: string;
+    type: 'file' | 'folder';
+};
+export type Files = Record<string, string | Uint8Array>;
+export type FilesystemError = 'FILE_EXISTS' | 'FOLDER_EXISTS';
+/**
+ * This tuple contains a "ref" which points to a file to fetch with the `LessonFilesFetcher` and
+ * the list of file paths included by that ref.
+ */
+export type FilesRefList = [ref: string, files: string[]];
+export interface LessonLink {
+    href: string;
+    title: string;
+}
+export interface Part {
+    id: string;
+    order: number;
+    slug: string;
+    data: PartSchema;
+    chapters: Record<Chapter['id'], Chapter>;
+}
+export interface Chapter {
+    id: string;
+    order: number;
+    slug: string;
+    data: ChapterSchema;
+}
+export interface Lesson<T = unknown> {
+    id: string;
+    order: number;
+    data: LessonSchema;
+    part?: {
+        id: Part['id'];
+        title: string;
+    };
+    chapter?: {
+        id: Chapter['id'];
+        title: string;
+    };
+    slug: string;
+    filepath: string;
+    editPageLink?: string;
+    files: FilesRefList;
+    solution: FilesRefList;
+    next?: LessonLink;
+    prev?: LessonLink;
+    Markdown: T;
+}
+export type I18n = Required<NonNullable<I18nSchema>>;
+export type MetaTagsConfig = MetaTagsSchema;
+export type CustomConfig = CustomSchema;
+export interface Tutorial {
+    logoLink?: string;
+    parts: Record<Part['id'], Part>;
+    lessons: Lesson[];
+}

package/dist/entities/index.js

@@ -0,0 +1 @@
+export {};

package/dist/entities/nav.d.ts

@@ -0,0 +1,8 @@
+export interface NavItem {
+    id: string;
+    title: string;
+    type?: 'part' | 'chapter' | 'lesson';
+    href?: string;
+    sections?: NavItem[];
+}
+export type NavList = NavItem[];

package/dist/entities/nav.js

@@ -0,0 +1 @@
+export {};

package/dist/files-ref.d.ts

@@ -0,0 +1 @@
+export declare function folderPathToFilesRef(pathToFolder: string): string;

package/dist/files-ref.js

@@ -0,0 +1,3 @@
+export function folderPathToFilesRef(pathToFolder) {
+    return encodeURIComponent(pathToFolder.replaceAll(/[\/\\]+/g, '-').replaceAll('_', '')) + '.json';
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export type * from './entities/index.js';
+export * from './schemas/index.js';
+export * from './files-ref.js';
+export { interpolateString } from './utils/interpolation.js';
+export { DEFAULT_LOCALIZATION } from './default-localization.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './schemas/index.js';
+export * from './files-ref.js';
+export { interpolateString } from './utils/interpolation.js';
+export { DEFAULT_LOCALIZATION } from './default-localization.js';

package/dist/schemas/chapter.d.ts

@@ -0,0 +1,379 @@
+import { z } from 'zod';
+export declare const chapterSchema: 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<"chapter">;
+    lessons: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}>, "strip", z.ZodTypeAny, {
+    type: "chapter";
+    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;
+}, {
+    type: "chapter";
+    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;
+}>;
+export type ChapterSchema = z.infer<typeof chapterSchema>;

package/dist/schemas/chapter.js

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