squiffy-runtime 6.0.0-alpha.9 → 6.0.0-beta.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2026 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,21 @@
+export type AnimationHandler = (el: HTMLElement, params: Record<string, any>, onComplete: () => void, loop: boolean) => void;
+export interface AnimationOptions {
+    initiallyHidden?: boolean;
+}
+interface RegisteredAnimation {
+    handler: AnimationHandler;
+    options: AnimationOptions;
+}
+export declare class Animation {
+    animations: {
+        [name: string]: RegisteredAnimation;
+    };
+    linkAnimations: Map<HTMLElement, () => void>;
+    registerAnimation(name: string, handler: AnimationHandler, options?: AnimationOptions): void;
+    isInitiallyHidden(name: string): boolean;
+    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();
+}
+export {};

package/dist/events.d.ts

@@ -0,0 +1,20 @@
+export type SquiffyEventMap = {
+    linkClick: {
+        linkType: string;
+    };
+    set: {
+        attribute: string;
+        value: any;
+    };
+    canGoBackChanged: {
+        canGoBack: boolean;
+    };
+};
+export type SquiffyEventHandler<E extends keyof SquiffyEventMap> = (payload: SquiffyEventMap[E]) => void;
+export declare class Emitter<Events extends Record<string, any>> {
+    private listeners;
+    on<E extends keyof Events>(event: E, handler: (p: Events[E]) => void): () => void;
+    off<E extends keyof Events>(event: E, handler: (p: Events[E]) => void): void;
+    once<E extends keyof Events>(event: E, handler: (p: Events[E]) => void): () => void;
+    emit<E extends keyof Events>(event: E, payload: Events[E]): void;
+}

package/dist/import.d.ts

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

package/dist/inputValidation.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Input validation for Squiffy stories.
+ *
+ * Handles HTML5 form validation constraints (required, minlength, pattern, etc.)
+ * and disables section/passage links until all inputs in the current section are valid.
+ */
+/**
+ * Check if all inputs in the given element are valid according to HTML5 validation constraints.
+ */
+export declare function areInputsValid(sectionElement: HTMLElement | null): boolean;
+/**
+ * Update the enabled/disabled state of all section and passage links
+ * based on whether all inputs are currently valid.
+ */
+export declare function updateLinkStates(sectionElement: HTMLElement | null): void;
+/**
+ * Set up input validation listeners on all inputs in the given section element.
+ * This should be called whenever new content is added to the section.
+ */
+export declare function setupInputValidation(sectionElement: HTMLElement | null): void;

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.css

@@ -0,0 +1,143 @@
+/* Core Squiffy Runtime Styles */
+
+/* Link styles */
+a.squiffy-link
+{
+    text-decoration: underline;
+    text-decoration-color: Blue;
+    color: Blue;
+    cursor: pointer;
+    transition: color 0.4s ease-in-out, text-decoration-color 0.4s ease-in-out;
+}
+
+/* Rotate/sequence links - visually distinct as they update in-place rather than advancing the story */
+a.squiffy-link[data-handler="rotate"],
+a.squiffy-link[data-handler="sequence"] {
+    text-decoration-style: dotted;
+}
+
+/* Disabled link states */
+a.squiffy-link.disabled,
+div.squiffy-output-section:not(:last-child) a.squiffy-link,
+div.squiffy-output-section.links-disabled a.squiffy-link
+{
+    text-decoration: inherit;
+    text-decoration-color: transparent;
+    color: inherit !important;
+    cursor: inherit;
+    pointer-events: none;
+}
+
+/* Links disabled due to input validation */
+a.squiffy-link.validation-disabled
+{
+    text-decoration: inherit;
+    text-decoration-color: transparent;
+    color: #999 !important;
+    cursor: not-allowed;
+    pointer-events: none;
+    opacity: 0.6;
+}
+
+/* Invalid input field states */
+input.squiffy-invalid,
+textarea.squiffy-invalid,
+select.squiffy-invalid
+{
+    border-color: #dc3545 !important;
+    box-shadow: 0 0 0 0.2rem rgba(220, 53, 69, 0.25);
+}
+
+/* Valid input field states (optional, provides positive feedback) */
+input:not([disabled]):valid,
+textarea:not([disabled]):valid,
+select:not([disabled]):valid
+{
+    border-color: #28a745;
+}
+
+/* Focus state for invalid inputs */
+input.squiffy-invalid:focus,
+textarea.squiffy-invalid:focus,
+select.squiffy-invalid:focus
+{
+    outline: none;
+    border-color: #dc3545 !important;
+    box-shadow: 0 0 0 0.2rem rgba(220, 53, 69, 0.5);
+}
+
+/* Header button styles */
+button.squiffy-header-button
+{
+    text-decoration: underline;
+    color: Blue;
+    cursor: pointer;
+    background: none;
+    border: none;
+    font-family: inherit;
+}
+
+/* Output block spacing */
+div.squiffy-output-block:not(:last-child),
+div.squiffy-output-passage:not(:last-child),
+div.squiffy-output-section:not(:last-child)
+{
+    margin-bottom: 1em;
+    border-bottom: 1px solid #ccc;
+}
+
+/* Fade animations */
+.fade-out {
+    opacity: 0;
+    transition: opacity 200ms;
+}
+
+.fade-in {
+    opacity: 1;
+    transition: opacity 200ms;
+}
+
+/* Continue animation - click to proceed */
+.squiffy-continue {
+    text-decoration: underline;
+    text-decoration-color: Blue;
+    color: Blue;
+    cursor: pointer;
+}
+
+/* Style: pulse - fades in and out */
+.squiffy-continue-pulse {
+    animation: squiffy-pulse 1.5s ease-in-out infinite;
+}
+
+@keyframes squiffy-pulse {
+    0%, 100% { opacity: 1; }
+    50% { opacity: 0.4; }
+}
+
+/* Style: glow - pulsing glow effect */
+.squiffy-continue-glow {
+    animation: squiffy-glow 1.5s ease-in-out infinite;
+}
+
+@keyframes squiffy-glow {
+    0%, 100% { text-shadow: 0 0 4px rgba(0, 0, 255, 0.5); }
+    50% { text-shadow: 0 0 12px rgba(0, 0, 255, 0.8), 0 0 20px rgba(0, 0, 255, 0.4); }
+}
+
+/* Style: bounce - subtle vertical bounce */
+.squiffy-continue-bounce {
+    display: inline-block;
+    animation: squiffy-bounce 0.6s ease-in-out infinite;
+}
+
+@keyframes squiffy-bounce {
+    0%, 100% { transform: translateY(0); }
+    50% { transform: translateY(-4px); }
+}
+
+/* Style: wave - character spans need special handling for underline */
+.squiffy-continue-wave {
+    text-decoration: none;
+    border-bottom: 1px solid Blue;
+}

package/dist/squiffy.runtime.d.ts

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