@elvishscout/mdstory 0.1.0 → 0.1.1

package/dist/base/chapter.js

@@ -1,4 +1,4 @@
-import handlebars from "handlebars";
+import Handlebars from "handlebars";
 import MarkdownIt from "markdown-it";
 import pluginAttrs from "markdown-it-attrs";
 const valueType = (value) => {
@@ -67,18 +67,22 @@ const createInputMarkdown = ({ name, type }) => {
 const useHelper = ({ inputs, sets, navs }, options) => {
     return {
         input(type, opt) {
+            let result = "";
             for (const name in opt.hash) {
                 const value = opt.hash[name];
                 inputs.push({ name, type, value });
                 if (options.format === "html") {
-                    return createInputHtml({ name, type, value, ...options });
+                    result = createInputHtml({ name, type, value, ...options });
                 }
-                return createInputMarkdown({ name, type });
+                else {
+                    result = createInputMarkdown({ name, type });
+                }
+                break;
             }
-            return "";
+            return new Handlebars.SafeString(result);
         },
         set(opt) {
-            return Object.entries(opt.hash)
+            const result = Object.entries(opt.hash)
                 .map(([name, value]) => {
                 const type = valueType(value);
                 sets.push({ name, type, value });
@@ -88,17 +92,16 @@ const useHelper = ({ inputs, sets, navs }, options) => {
                 return "";
             })
                 .join("");
+            return new Handlebars.SafeString(result);
         },
         nav(target, opt) {
-            const text = opt.fn(target).trim();
+            let result = "";
+            const text = opt.fn(this).trim();
             navs.push({ text, target });
             if (options.format === "html") {
-                return createSubmitButtonHtml({ target: target ?? "", children: text, ...options });
+                result = createSubmitButtonHtml({ target: target ?? "", children: text, ...options });
             }
-            return "";
-        },
-        br(num) {
-            return new Array(num ?? 1).fill("<br>").join();
+            return new Handlebars.SafeString(result);
         },
     };
 };
@@ -116,7 +119,7 @@ export class Chapter {
             sets: [],
             navs: [],
         };
-        const handle = handlebars.create();
+        const handle = Handlebars.create();
         handle.registerHelper(useHelper(fields, options));
         let text = handle.compile(this.template)(scope);
         if (options.format === "html") {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elvishscout/mdstory",
-  "version": "0.1.0",
-  "description": "An interactive story format based on Markdown and Handlebars with JavaScript support",
+  "version": "0.1.1",
+  "description": "An interactive story format based on Markdown and Handlebars with JavaScript support.",
   "main": "./dist/index.js",
   "type": "module",
   "files": [
@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build": "tsc",
-    "test": "node ./test/index.test.js"
+    "test": "tsx ./test/index.test.ts"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",
@@ -19,6 +19,7 @@
     "@types/node": "^22.14.1",
     "inquirer": "^12.6.0",
     "markdown-it-terminal": "^0.4.0",
+    "tsx": "^4.19.3",
     "typescript": "~5.7.2"
   },
   "dependencies": {
@@ -36,4 +37,4 @@
   ],
   "author": "Jiakai Jiang",
   "license": "ISC"
-}
+}

package/dist/types/base/chapter.d.ts

@@ -1,44 +0,0 @@
-import { ValueType, Value, ChapterHooks, Scope } from "./definitions.js";
-type MarkdownOptions = {};
-type HtmlOptions = {
-    tagMap?: Record<string, string>;
-};
-export type RenderOptions = ({
-    format: "markdown";
-} & MarkdownOptions) | ({
-    format: "html";
-} & HtmlOptions);
-type Fields = {
-    inputs: {
-        name: string;
-        type: ValueType;
-        value: Value;
-    }[];
-    sets: {
-        name: string;
-        type: ValueType;
-        value: Value;
-    }[];
-    navs: {
-        text: string;
-        target: string | null;
-    }[];
-};
-export type RenderResult = {
-    text: string;
-} & Fields;
-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, options: RenderOptions): RenderResult;
-}
-export {};

package/dist/types/base/definitions.d.ts

@@ -1,46 +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 MetadataSchema: z.ZodObject<{
-    title: z.ZodDefault<z.ZodString>;
-    globals: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodAny, string | number | boolean | JsonArray | JsonObject | null, any>>>;
-}, "strip", z.ZodTypeAny, {
-    title: string;
-    globals: Record<string, string | number | boolean | JsonArray | JsonObject | null>;
-}, {
-    title?: string | undefined;
-    globals?: Record<string, any> | 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 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 {};

package/dist/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/dist/types/base/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./definitions.js";
-export * from "./story.js";
-export * from "./chapter.js";
-export * from "./error.js";

package/dist/types/base/story.d.ts

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

package/dist/types/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./base/index.js";
-import { StoryBase } from "./base/index.js";
-export declare class Story extends StoryBase {
-    constructor(content: string);
-}