squiffy-runtime 6.0.0-alpha.14 → 6.0.0-alpha.17

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2024 Alex Warren, textadventures.co.uk and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/dist/animation.d.ts

@@ -0,0 +1,11 @@
+export declare class Animation {
+    animations: {
+        [name: string]: (el: HTMLElement, params: Record<string, any>, onComplete: () => void, loop: boolean) => void;
+    };
+    linkAnimations: Map<HTMLElement, () => void>;
+    registerAnimation(name: string, handler: (el: HTMLElement, params: Record<string, any>, onComplete: () => void, loop: boolean) => void): void;
+    runAnimation(name: string, el: HTMLElement, params: Record<string, any>, onComplete: () => void, loop: boolean): void;
+    addLinkAnimation(link: HTMLElement, fn: () => void): void;
+    runLinkAnimation(link: HTMLElement): void;
+    constructor();
+}

package/dist/events.d.ts

@@ -1,7 +1,13 @@
-type LinkType = 'section' | 'passage' | 'rotate' | 'sequence';
 export type SquiffyEventMap = {
     linkClick: {
-        linkType: LinkType;
+        linkType: string;
+    };
+    set: {
+        attribute: string;
+        value: any;
+    };
+    canGoBackChanged: {
+        canGoBack: boolean;
     };
 };
 export type SquiffyEventHandler<E extends keyof SquiffyEventMap> = (payload: SquiffyEventMap[E]) => void;
@@ -12,4 +18,3 @@ export declare class Emitter<Events extends Record<string, any>> {
     once<E extends keyof Events>(event: E, handler: (p: Events[E]) => void): () => void;
     emit<E extends keyof Events>(event: E, payload: Events[E]): void;
 }
-export {};

package/dist/import.d.ts

@@ -0,0 +1,4 @@
+import * as animejs from "animejs";
+export declare const imports: {
+    animejs: typeof animejs;
+};

package/dist/linkHandler.d.ts

@@ -0,0 +1,8 @@
+import { HandleLinkResult } from './types.plugins.js';
+export declare class LinkHandler {
+    linkHandlers: {
+        [type: string]: (el: HTMLElement) => HandleLinkResult;
+    };
+    registerLinkHandler(type: string, handler: (el: HTMLElement) => HandleLinkResult): void;
+    handleLink(link: HTMLElement): [found: boolean, type: string, result: HandleLinkResult];
+}

package/dist/pluginManager.d.ts

@@ -0,0 +1,23 @@
+import { TextProcessor } from './textProcessor.js';
+import { SquiffyPlugin } from './types.plugins.js';
+import { State } from './state.js';
+import { LinkHandler } from './linkHandler.js';
+import { Emitter, SquiffyEventMap } from './events.js';
+import { Animation } from './animation.js';
+export declare class PluginManager {
+    outputElement: HTMLElement;
+    textProcessor: TextProcessor;
+    state: State;
+    linkHandler: LinkHandler;
+    getSectionText: (name: string) => string | null;
+    getPassageText: (name: string) => string | null;
+    processText: (text: string, inline: boolean) => string;
+    addTransition: (fn: () => Promise<void>) => void;
+    emitter: Emitter<SquiffyEventMap>;
+    plugins: SquiffyPlugin[];
+    animation: Animation;
+    constructor(outputElement: HTMLElement, textProcessor: TextProcessor, state: State, linkHandler: LinkHandler, getSectionText: (name: string) => string | null, getPassageText: (name: string) => string | null, processText: (text: string, inline: boolean) => string, addTransition: (fn: () => Promise<void>) => void, animation: Animation, emitter: Emitter<SquiffyEventMap>);
+    add(plugin: SquiffyPlugin): void | Promise<void>;
+    onWrite(el: HTMLElement): void;
+    onLoad(): void;
+}

package/dist/squiffy.runtime.d.ts

@@ -1,3 +1,3 @@
 import { SquiffyApi, SquiffyInitOptions } from './types.js';
-export type { SquiffyApi } from "./types.js";
-export declare const init: (options: SquiffyInitOptions) => SquiffyApi;
+export type { SquiffyApi } from './types.js';
+export declare const init: (options: SquiffyInitOptions) => Promise<SquiffyApi>;