@blastlauncher/client-core 0.0.0-stage → 3.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Yukai Huang
+
+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/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @blastlauncher/client-core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Blast's client-core package.
+Emitted ESM and TypeScript declarations for Node.js 24.20+.
+See https://github.com/BlastLauncher/blast for documentation.

package/dist/controller.d.ts

@@ -0,0 +1,219 @@
+import type { SceneMessage } from "@blastlauncher/protocol";
+import { type OutboundEvent } from "./nodes.js";
+import { type FormInput, type FormFieldView } from "./form-view.js";
+export type { FormFieldView } from "./form-view.js";
+import { type KeyInput, type Platform } from "./shortcut.js";
+export type ControllerInput = FormInput | {
+    type: "search";
+    text: string;
+} | {
+    type: "move";
+    direction: "up" | "down" | "left" | "right";
+}
+/** Pointer selection of a list item or grid cell by its view id. */
+ | {
+    type: "select";
+    id: string;
+} | {
+    type: "primary";
+} | {
+    type: "openActions";
+} | {
+    type: "closeActions";
+} | {
+    type: "actionsQuery";
+    text: string;
+} | {
+    type: "key";
+    key: KeyInput;
+} | {
+    type: "back";
+} | {
+    type: "openDropdown";
+} | {
+    type: "dropdownQuery";
+    text: string;
+} | {
+    type: "chooseDropdown";
+} | {
+    type: "toastAction";
+    index: number;
+} | {
+    type: "alert";
+    confirm: boolean;
+    remember?: boolean;
+};
+export type Effect = {
+    type: "quit";
+} | {
+    type: "schedule";
+    ms: number;
+    token: string;
+};
+export type ControllerResult = {
+    events: OutboundEvent[];
+    effects: Effect[];
+    /** A `key` input matched a shortcut, so the embedder should not also treat the press as text. */
+    handled?: true;
+};
+export type ViewKind = "list" | "grid" | "detail" | "form" | "menu-bar" | "empty";
+export type RowView = {
+    /** The selection id for items, the node id for section headers. */
+    id: string;
+    kind: "item" | "section" | "unsupported";
+    title: string;
+    subtitle: string;
+    accessories: string;
+    icon: boolean;
+    /** Items in a section header's section. */
+    count: number | null;
+    selected: boolean;
+    iconLabel: string;
+    iconTint?: string;
+    /** The row as one line, for clients that do not lay columns out. */
+    text: string;
+};
+export type GridCellView = {
+    id: string;
+    title: string;
+    subtitle: string;
+    /** The cell content as short text: image source name or color. */
+    content: string;
+    selected: boolean;
+};
+export type GridRowView = {
+    id: string | null;
+    header: string;
+    cells: GridCellView[];
+};
+export type ActionRowView = {
+    id: string;
+    kind: "action" | "submenu" | "section";
+    title: string;
+    shortcut: string;
+    selected: boolean;
+};
+export type DropdownOptionView = {
+    value: string;
+    title: string;
+    section: string;
+    current: boolean;
+    selected: boolean;
+};
+export type MenuRowView = {
+    id: string;
+    kind: "item" | "submenu" | "section";
+    title: string;
+    subtitle: string;
+    shortcut: string;
+    disabled: boolean;
+    selected: boolean;
+};
+export type ControllerView = {
+    kind: ViewKind;
+    title: string;
+    navigation: {
+        canGoBack: boolean;
+    };
+    loading: boolean;
+    search: {
+        text: string;
+        placeholder: string;
+    };
+    rows: RowView[];
+    grid: GridRowView[] | null;
+    selectedId: string | null;
+    emptyText: string;
+    empty: {
+        title: string;
+        description: string;
+        iconLabel: string;
+        iconTint?: string;
+    } | null;
+    detail: string;
+    primary: {
+        title: string;
+        shortcut: string;
+        enabled: boolean;
+    };
+    actions: {
+        open: boolean;
+        title: string;
+        query: string;
+        /** Titles of the submenus entered so far. */
+        breadcrumb: string[];
+        rows: ActionRowView[];
+        /** Index among the selectable rows, -1 when there are none. */
+        selectedIndex: number;
+    };
+    dropdown: {
+        label: string;
+        tooltip: string;
+        open: boolean;
+        query: string;
+        options: DropdownOptionView[];
+        selectedIndex: number;
+    } | null;
+    feedback: {
+        toast: {
+            style: string;
+            title: string;
+            message: string;
+            actions: {
+                title: string;
+                shortcut: string;
+            }[];
+        } | null;
+        /** Only while the HUD window is open. */
+        hud: {
+            title: string;
+        } | null;
+        alert: {
+            title: string;
+            message: string;
+            rememberUserChoice: boolean;
+            remember: boolean;
+            primary: {
+                title: string;
+                style: string;
+            } | null;
+            dismiss: {
+                title: string;
+                style: string;
+            } | null;
+        } | null;
+    };
+    menuBar: {
+        title: string;
+        tooltip: string;
+        loading: boolean;
+        path: string[];
+        rows: MenuRowView[];
+        selectedId: string | null;
+    } | null;
+    form: {
+        fields: FormFieldView[];
+        focusId: string | null;
+    } | null;
+    requests: {
+        quit: boolean;
+        /** The last scene asked the client to clear the search bar. */
+        clearSearch: boolean;
+    };
+};
+export type Controller = {
+    scene(message: SceneMessage | undefined): ControllerResult;
+    input(action: ControllerInput): ControllerResult;
+    /** A delay requested by a `schedule` effect has passed. Unknown tokens are ignored. */
+    tick(token: string): ControllerResult;
+    view(): ControllerView;
+    subscribe(listener: (view: ControllerView) => void): () => void;
+};
+export type ControllerOptions = {
+    platform: Platform;
+    /** Overrides how long a HUD stays visible. */
+    hudDurationMs?: number;
+    /** Overrides how long success and failure toasts stay visible. */
+    toastDurationMs?: number;
+};
+export declare function createController(options: ControllerOptions): Controller;