squiffy-runtime 6.0.0-alpha.10 → 6.0.0-alpha.11

package/src/types.ts

@@ -0,0 +1,78 @@
+import {SquiffyEventHandler, SquiffyEventMap} from "./events.js";
+
+export interface SquiffyInitOptions {
+    element: HTMLElement;
+    story: Story;
+    scroll?: string,
+    persist?: boolean,
+    onSet?: (attribute: string, value: any) => void,
+}
+
+export interface SquiffySettings {
+    scroll: string,
+    persist: boolean,
+    onSet: (attribute: string, value: any) => void,
+}
+
+export interface SquiffyApi {
+    restart: () => void;
+    get: (attribute: string) => any;
+    set: (attribute: string, value: any) => void;
+    clickLink: (link: HTMLElement) => boolean;
+    update: (story: Story) => void;
+
+    on<E extends keyof SquiffyEventMap>(
+        event: E,
+        handler: SquiffyEventHandler<E>
+    ): () => void; // returns unsubscribe
+
+    off<E extends keyof SquiffyEventMap>(
+        event: E,
+        handler: SquiffyEventHandler<E>
+    ): void;
+
+    once<E extends keyof SquiffyEventMap>(
+        event: E,
+        handler: SquiffyEventHandler<E>
+    ): () => void;
+}
+
+// Previous versions of Squiffy had "squiffy", "get" and "set" as globals - we now pass these directly into JS functions.
+// We may tidy up this API at some point, though that would be a breaking change.
+interface SquiffyJsFunctionApi {
+    get: (attribute: string) => any;
+    set: (attribute: string, value: any) => void;
+    ui: {
+        transition: (f: any) => void;
+    };
+    story: {
+        go: (section: string) => void;
+    };
+}
+
+export interface Story {
+    js: ((
+        squiffy: SquiffyJsFunctionApi,
+        get: (attribute: string) => any,
+        set: (attribute: string, value: any) => void
+    ) => void)[];
+    start: string;
+    id?: string | null;
+    sections: Record<string, Section>;
+}
+
+export interface Section {
+    text?: string;
+    clear?: boolean;
+    attributes?: string[],
+    jsIndex?: number;
+    passages?: Record<string, Passage>;
+    passageCount?: number;
+}
+
+export interface Passage {
+    text?: string;
+    clear?: boolean;
+    attributes?: string[];
+    jsIndex?: number;
+}

package/src/utils.ts

@@ -0,0 +1,14 @@
+export function startsWith(string: string, prefix: string) {
+    return string.substring(0, prefix.length) === prefix;
+}
+
+export function rotate(options: string, current: string | null) {
+    const colon = options.indexOf(':');
+    if (colon == -1) {
+        return [options, current];
+    }
+    const next = options.substring(0, colon);
+    let remaining = options.substring(colon + 1);
+    if (current) remaining += ':' + current;
+    return [next, remaining];
+}