@elvishscout/mdstory 0.1.3 → 0.2.0

package/dist/base/story.js

@@ -1,82 +0,0 @@
-import { ChapterHooksSchema, StoryHooksSchema, } from "./definitions.js";
-import { Chapter } from "./chapter.js";
-import { ChapterNotFoundError, InvalidInputError } from "./error.js";
-const parstInput = (type, text) => {
-    if (type === "boolean") {
-        return text === "on";
-    }
-    if (type === "number") {
-        return text ? Number(text) : null;
-    }
-    if (type === "object") {
-        return text ? JSON.parse(text) : null;
-    }
-    return text;
-};
-const parseFormData = (formData, { inputs, sets }) => {
-    const target = formData.get("@target") || null;
-    const updates = Object.fromEntries([...inputs, ...sets].map(({ name, type }) => {
-        const value = formData.get(name);
-        try {
-            return [name, parstInput(type, value)];
-        }
-        catch {
-            throw new InvalidInputError(name, value);
-        }
-    }));
-    return { target, updates };
-};
-export class StoryBase {
-    constructor({ metadata, chapters, entry, script, stylesheet }) {
-        const realChapters = Object.fromEntries(Object.entries(chapters).map(([id, { title, template, script }]) => {
-            const hooks = (script && ChapterHooksSchema.parse(new Function(script)())) || {};
-            return [id, new Chapter({ id, title, template, hooks })];
-        }));
-        this.metadata = metadata;
-        this.globals = metadata.globals ?? {};
-        this.chapters = realChapters;
-        this.entry = (entry && realChapters[entry]) || null;
-        this.hooks = (script && StoryHooksSchema.parse(new Function(script)())) || {};
-        this.stylesheet = stylesheet;
-        this.assets = metadata.assets ?? {};
-    }
-    async play(prompt, options) {
-        if (this.hooks.onStart) {
-            this.hooks.onStart(this.globals);
-        }
-        const assetsUrl = Object.fromEntries(Object.entries(this.assets).map(([name, { url }]) => [name, url]));
-        let chapter = this.entry;
-        while (chapter) {
-            let scope = this.globals;
-            scope = Object.assign(scope, assetsUrl);
-            if (chapter.hooks.onEnter) {
-                const modified = chapter.hooks.onEnter(this.globals);
-                if (modified !== undefined) {
-                    scope = Object.assign(scope, modified);
-                }
-            }
-            const renderResult = chapter.render(scope, this.assets, options);
-            const promptResult = await prompt({ chapter, ...renderResult });
-            const { target, updates } = promptResult instanceof FormData ? parseFormData(promptResult, renderResult) : promptResult;
-            let modifiedTarget = target;
-            let modifiedUpdates = updates;
-            if (chapter.hooks.onLeave) {
-                const modified = chapter.hooks.onLeave(updates, this.globals);
-                if (modified !== undefined) {
-                    modifiedUpdates = Object.assign(updates, modified);
-                }
-            }
-            if (chapter.hooks.onNavigate) {
-                const modified = chapter.hooks.onNavigate(target, updates, this.globals);
-                if (modified !== undefined) {
-                    modifiedTarget = modified;
-                }
-            }
-            this.globals = Object.assign(this.globals, modifiedUpdates);
-            if (modifiedTarget !== null && !(modifiedTarget in this.chapters)) {
-                throw new ChapterNotFoundError(modifiedTarget);
-            }
-            chapter = modifiedTarget !== null ? this.chapters[modifiedTarget] : null;
-        }
-    }
-}

package/types/base/chapter.d.ts

@@ -1,50 +0,0 @@
-import { ValueType, Value, ChapterHooks, Scope, Asset } from "./definitions.js";
-export type Renderer = {
-    input?: ({ name, type, value }: {
-        name: string;
-        type: ValueType;
-        value: string;
-    }) => string;
-    nav?: ({ target, children }: {
-        target: string | null;
-        children: string;
-    }) => string;
-};
-export type RenderOptions = {
-    format: "markdown" | "html" | Renderer;
-    html?: boolean;
-};
-export type RenderResult = {
-    text: string;
-} & Fields;
-type Fields = {
-    inputs: {
-        name: string;
-        type: ValueType;
-        value: Value;
-    }[];
-    sets: {
-        name: string;
-        type: ValueType;
-        value: Value;
-    }[];
-    navs: {
-        text: string;
-        target: string | null;
-    }[];
-};
-export type ChapterOptions = {
-    id: string;
-    title: string;
-    template: string;
-    hooks: ChapterHooks;
-};
-export declare class Chapter {
-    id: string;
-    title: string;
-    template: string;
-    hooks: ChapterHooks;
-    constructor({ id, title, template, hooks }: ChapterOptions);
-    render(scope: Scope, assets: Record<string, Asset> | undefined, { format, html }: RenderOptions): RenderResult;
-}
-export {};

package/types/base/definitions.d.ts

@@ -1,113 +0,0 @@
-import { z } from "zod";
-type JsonPrimitive = number | string | boolean | null;
-type JsonArray = JsonValue[];
-type JsonObject = {
-    [key: string]: JsonValue;
-};
-type JsonValue = JsonPrimitive | JsonArray | JsonObject;
-export declare const ValueSchema: z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>;
-export declare const ScopeSchema: z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>;
-export declare const AssetSchema: z.ZodUnion<[z.ZodEffects<z.ZodString, {
-    url: string;
-    mime?: string | undefined;
-}, string>, z.ZodObject<{
-    url: z.ZodString;
-    mime: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    url: string;
-    mime?: string | undefined;
-}, {
-    url: string;
-    mime?: string | undefined;
-}>]>;
-export declare const AssetsSchema: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodEffects<z.ZodString, {
-    url: string;
-    mime?: string | undefined;
-}, string>, z.ZodObject<{
-    url: z.ZodString;
-    mime: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    url: string;
-    mime?: string | undefined;
-}, {
-    url: string;
-    mime?: string | undefined;
-}>]>>;
-export declare const MetadataSchema: z.ZodObject<{
-    title: z.ZodOptional<z.ZodString>;
-    author: z.ZodOptional<z.ZodString>;
-    email: z.ZodOptional<z.ZodString>;
-    globals: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>>;
-    assets: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodEffects<z.ZodString, {
-        url: string;
-        mime?: string | undefined;
-    }, string>, z.ZodObject<{
-        url: z.ZodString;
-        mime: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        mime?: string | undefined;
-    }, {
-        url: string;
-        mime?: string | undefined;
-    }>]>>>;
-}, "strip", z.ZodTypeAny, {
-    title?: string | undefined;
-    author?: string | undefined;
-    email?: string | undefined;
-    globals?: Record<string, string | number | boolean | JsonArray | JsonObject | null> | undefined;
-    assets?: Record<string, {
-        url: string;
-        mime?: string | undefined;
-    }> | undefined;
-}, {
-    title?: string | undefined;
-    author?: string | undefined;
-    email?: string | undefined;
-    globals?: Record<string, any> | undefined;
-    assets?: Record<string, string | {
-        url: string;
-        mime?: string | undefined;
-    }> | undefined;
-}>;
-export declare const StoryHooksSchema: z.ZodObject<{
-    onStart: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>], z.ZodUnknown>, z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>, z.ZodVoid]>>>;
-}, "strip", z.ZodTypeAny, {
-    onStart?: ((args_0: Record<string, any>, ...args: unknown[]) => void | Record<string, string | number | boolean | JsonArray | JsonObject | null>) | undefined;
-}, {
-    onStart?: ((args_0: Record<string, string | number | boolean | JsonArray | JsonObject | null>, ...args: unknown[]) => void | Record<string, any>) | undefined;
-}>;
-export declare const ChapterHooksSchema: z.ZodObject<{
-    onEnter: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>], z.ZodUnknown>, z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>, z.ZodVoid]>>>;
-    onLeave: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>], z.ZodUnknown>, z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>, z.ZodVoid]>>>;
-    onNavigate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodUnion<[z.ZodString, z.ZodNull]>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>, z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>], z.ZodUnknown>, z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNull]>, z.ZodVoid]>>>;
-}, "strip", z.ZodTypeAny, {
-    onEnter?: ((args_0: Record<string, any>, ...args: unknown[]) => void | Record<string, string | number | boolean | JsonArray | JsonObject | null>) | undefined;
-    onLeave?: ((args_0: Record<string, any>, args_1: Record<string, any>, ...args: unknown[]) => void | Record<string, string | number | boolean | JsonArray | JsonObject | null>) | undefined;
-    onNavigate?: ((args_0: string | null, args_1: Record<string, any>, args_2: Record<string, any>, ...args: unknown[]) => string | void | null) | undefined;
-}, {
-    onEnter?: ((args_0: Record<string, string | number | boolean | JsonArray | JsonObject | null>, ...args: unknown[]) => void | Record<string, any>) | undefined;
-    onLeave?: ((args_0: Record<string, string | number | boolean | JsonArray | JsonObject | null>, args_1: Record<string, string | number | boolean | JsonArray | JsonObject | null>, ...args: unknown[]) => void | Record<string, any>) | undefined;
-    onNavigate?: ((args_0: string | null, args_1: Record<string, string | number | boolean | JsonArray | JsonObject | null>, args_2: Record<string, string | number | boolean | JsonArray | JsonObject | null>, ...args: unknown[]) => string | void | null) | undefined;
-}>;
-export type Value = z.infer<typeof ValueSchema>;
-export type Scope = z.infer<typeof ScopeSchema>;
-export type Asset = z.infer<typeof AssetSchema>;
-export type Metadata = z.infer<typeof MetadataSchema>;
-export type StoryHooks = z.infer<typeof StoryHooksSchema>;
-export type ChapterHooks = z.infer<typeof ChapterHooksSchema>;
-export type ValueType = "string" | "number" | "boolean" | "object";
-export type ChapterBody = {
-    title: string;
-    template: string;
-    script: string;
-};
-export type StoryBody = {
-    metadata: Metadata;
-    chapters: Record<string, ChapterBody>;
-    entry: string | null;
-    script: string;
-    stylesheet: string;
-};
-export type StoryAssets = Record<string, string>;
-export {};

package/types/base/error.d.ts

@@ -1,20 +0,0 @@
-export declare class InvalidMetadataError extends Error {
-    content: string;
-    constructor(content: string, message?: string);
-}
-export declare class DuplicateIdError extends Error {
-    id: string;
-    constructor(id: string, message?: string);
-}
-export declare class EmptyChapterIdError extends Error {
-    constructor(message?: string);
-}
-export declare class ChapterNotFoundError extends Error {
-    target: string | null;
-    constructor(target: string | null, message?: string);
-}
-export declare class InvalidInputError extends Error {
-    name: string;
-    input: string | null;
-    constructor(name: string, input: string | null, message?: string);
-}

package/types/base/parser.d.ts

@@ -1,2 +0,0 @@
-import { StoryBody } from "./definitions.js";
-export declare const parseStoryContent: (content: string) => StoryBody;

package/types/base/story.d.ts

@@ -1,19 +0,0 @@
-import { StoryBody, StoryHooks, Scope, Metadata, Asset } from "./definitions.js";
-import { Chapter, RenderOptions, RenderResult } from "./chapter.js";
-export type StoryPrompt = (props: {
-    chapter: Chapter;
-} & RenderResult) => Promise<{
-    target: string | null;
-    updates: Scope;
-} | FormData>;
-export declare class StoryBase {
-    metadata: Metadata;
-    globals: Scope;
-    chapters: Record<string, Chapter>;
-    entry: Chapter | null;
-    hooks: StoryHooks;
-    stylesheet: string;
-    assets: Record<string, Asset>;
-    constructor({ metadata, chapters, entry, script, stylesheet }: StoryBody);
-    play(prompt: StoryPrompt, options: RenderOptions): Promise<void>;
-}