@wyndlass/app-sdk 0.0.0 → 1.1.0

package/dist/contract/data-weather.d.ts

@@ -0,0 +1,421 @@
+/**
+ * A WMO weather code in Wyndlass's words; the weather condition leaf compares against these.
+ */
+export type Condition = "clear" | "mostly-clear" | "partly-cloudy" | "cloudy" | "fog" | "drizzle" | "freezing-drizzle" | "rain" | "freezing-rain" | "snow" | "snow-grains" | "showers" | "snow-showers" | "thunderstorm" | "hail-thunderstorm" | "unknown";
+/**
+ * The data service's weather for a place (ADR 0069): now and the days ahead, in the units asked, and the facts the weather condition leaf reads, always metric. A value the provider does not give is left out.
+ */
+export interface Weather {
+    place: {
+        lat: number;
+        lon: number;
+    };
+    /**
+     * metric: °C and km/h; imperial: °F and mph.
+     */
+    units: "metric" | "imperial";
+    /**
+     * The place's IANA time zone.
+     */
+    timeZone: string;
+    current: {
+        at: string;
+        temperature: number;
+        apparentTemperature?: number;
+        condition: Condition;
+        code: number;
+        isDay: boolean;
+        humidity?: number;
+        windSpeed?: number;
+        windDirection?: number;
+        precipitationProbability?: number;
+    };
+    /**
+     * @maxItems 7
+     */
+    daily: [] | [
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        }
+    ] | [
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        }
+    ] | [
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        }
+    ] | [
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        }
+    ] | [
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        }
+    ] | [
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        }
+    ] | [
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        },
+        {
+            date: string;
+            high: number;
+            low: number;
+            condition: Condition;
+            /**
+             * The WMO weather code.
+             */
+            code: number;
+            precipitationProbability?: number;
+            sunrise?: string;
+            sunset?: string;
+        }
+    ];
+    /**
+     * What the weather condition leaf (condition.schema.json) reads.
+     */
+    facts: {
+        temperatureC: number;
+        condition: Condition;
+        precipitationProbability?: number;
+        windKph: number;
+        /**
+         * False until a source of alerts is added.
+         */
+        alertActive: boolean;
+    };
+}

package/dist/contract/data-weather.js

@@ -0,0 +1,3 @@
+// Copied from protocol/generated/ts/data-weather.d.ts by app-sdk/scripts/copy-protocol.mjs: edit the source, then run `pnpm --filter @wyndlass/app-sdk copy-protocol`.
+/* Generated from protocol/schemas by scripts/generate.mjs. Do not edit. */
+export {};

package/dist/contract/player-api-event.d.ts

@@ -0,0 +1,253 @@
+/**
+ * An event the controller emits (protocol/player-api.json, ADR 0050): to apps that subscribed on the screen, and in the ring player.events reads. Told apart by type.
+ */
+export type PlayerAPIEvent = StateChanged | ContentUpdated | ItemStart | ItemEnd | ItemError | ConnectionChanged | AudioChanged | DisplayChanged | TimeChanged | AppCommand | AppFailed | AppHeld;
+/**
+ * RFC 3339 timestamp with offset.
+ */
+export type CommonTimestamp = string;
+/**
+ * idle: nothing to play; stopped: the standby screen.
+ */
+export type PlayerApiStatusState = "starting" | "playing" | "paused" | "stopped" | "idle" | "error";
+/**
+ * Who caused a change: the player itself, an app on the screen, or a remote caller whose principal core relayed.
+ */
+export type PlayerApiCommonBy = {
+    kind: "player";
+} | {
+    kind: "app";
+    /**
+     * The app's id (app-definition).
+     */
+    app: string;
+    instance: string;
+} | {
+    kind: "remote";
+    principal: CommonPrincipalRef;
+};
+/**
+ * A principal, e.g. user:u_123, agent:fleet-guardian, device:dev_...
+ */
+export type CommonPrincipalRef = string;
+/**
+ * Lowercase hex SHA-256 digest.
+ */
+export type CommonSha256 = string;
+/**
+ * A zone of the screen; main until compositions have zones.
+ */
+export type PlayerApiCommonZone = string;
+/**
+ * Media item id (asset, app, composition, playlist or live source).
+ */
+export type CommonMediaId = string;
+/**
+ * Whether the player is connected to Wyndlass (NATS).
+ */
+export type PlayerApiCommonConnection = "online" | "offline";
+/**
+ * The app's id (app-definition), where the layout carries it (appInfo).
+ */
+export type AppId = string;
+/**
+ * The app's element, as a path of element ids from the outermost layout (ADR 0053, decision 13).
+ */
+export type ElementPath = string;
+export interface StateChanged {
+    type: "state.changed";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    state: PlayerApiStatusState;
+    previous: PlayerApiStatusState;
+    by: PlayerApiCommonBy;
+}
+export interface ContentUpdated {
+    type: "content.updated";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    manifest: CommonSha256;
+    previous?: CommonSha256;
+}
+export interface ItemStart {
+    type: "item.start";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    zone: PlayerApiCommonZone;
+    item: CommonItemRef;
+    blob: CommonSha256;
+    contentType: string;
+    startedAt: CommonTimestamp;
+    durationMs?: number;
+    /**
+     * The transition the item's entry asked for and the one the player played (WP-0056): a crossfade it could not play, between two native videos on a host that holds one, plays as a cut. Absent when the entry asked for none.
+     */
+    transition?: {
+        asked: "cut" | "crossfade";
+        played: "cut" | "crossfade";
+    };
+    /**
+     * The layout element the item plays in, as a path of element ids from the outermost layout (ADR 0053, decision 13; WP-0056); `loop` for a playlist playing on its own. Absent for the screen's own loop.
+     */
+    element?: string;
+}
+/**
+ * A pinned reference to a media item version.
+ */
+export interface CommonItemRef {
+    id: CommonMediaId;
+    version: number;
+}
+export interface ItemEnd {
+    type: "item.end";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    zone: PlayerApiCommonZone;
+    item: CommonItemRef;
+    blob: CommonSha256;
+    endedAt: CommonTimestamp;
+    /**
+     * replaced: a new manifest; finished: the app ended its slot.
+     */
+    reason: "completed" | "skipped" | "stopped" | "error" | "replaced" | "finished";
+    /**
+     * The layout element the item plays in, as a path of element ids from the outermost layout (ADR 0053, decision 13; WP-0056); `loop` for a playlist playing on its own. Absent for the screen's own loop.
+     */
+    element?: string;
+}
+export interface ItemError {
+    type: "item.error";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    zone: PlayerApiCommonZone;
+    item: CommonItemRef;
+    blob: CommonSha256;
+    code: string;
+    message: string;
+}
+export interface ConnectionChanged {
+    type: "connection.changed";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    connection: PlayerApiCommonConnection;
+}
+export interface AudioChanged {
+    type: "audio.changed";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    audio: PlayerApiCommonAudio;
+    by: PlayerApiCommonBy;
+}
+/**
+ * The player's own level, not the operating system's.
+ */
+export interface PlayerApiCommonAudio {
+    volume: number;
+    muted: boolean;
+}
+export interface DisplayChanged {
+    type: "display.changed";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    display: PlayerApiCommonDisplay;
+    by: PlayerApiCommonBy;
+}
+export interface PlayerApiCommonDisplay {
+    power: "on" | "standby" | "unknown";
+    brightness?: number;
+}
+export interface TimeChanged {
+    type: "time.changed";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    reason: "clock-adjusted" | "time-zone-changed";
+}
+export interface AppCommand {
+    type: "app.command";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    name: string;
+    /**
+     * Any JSON the sender gave.
+     */
+    argument?: {
+        [k: string]: unknown | undefined;
+    };
+    by: PlayerApiCommonBy;
+}
+/**
+ * An app on the screen could not run, or misbehaved (WP-0100). The rest of its layout plays on.
+ */
+export interface AppFailed {
+    type: "app.failed";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    item: CommonItemRef1;
+    app?: AppId;
+    element?: ElementPath;
+    /**
+     * load: its bundle did not import. shape: it exports no element class the host can define, or (a customer's app) no way to take its context. unsupported: it needs a newer Player API or WebView than this screen has, or it is a customer's app and this screen's page was never handed its port (WP-0100 part b). error: it threw three times in a minute, and was stopped. late: it was not ready by its deadline, and shows as it is. overran: an enter or exit ran past its clip.
+     */
+    reason: "load" | "shape" | "unsupported" | "error" | "late" | "overran";
+    /**
+     * The name of what it threw (TypeError), for error, load and shape. Never its message, which could carry anything the app holds.
+     */
+    error?: string;
+}
+/**
+ * A pinned reference to a media item version.
+ */
+export interface CommonItemRef1 {
+    id: CommonMediaId;
+    version: number;
+}
+/**
+ * An app version held back on this screen until the next manifest, after the page stopped answering twice within an hour while it was on screen (WP-0100). Its element is drawn empty meanwhile.
+ */
+export interface AppHeld {
+    type: "app.held";
+    /**
+     * The event's place in this player's sequence since it started; player.events pages by it.
+     */
+    seq: number;
+    at: CommonTimestamp;
+    item: CommonItemRef;
+    app?: AppId;
+    /**
+     * How many times the page stopped answering in the last hour with this app on screen.
+     */
+    hangs: number;
+}

package/dist/contract/player-api-event.js

@@ -0,0 +1,3 @@
+// Copied from protocol/generated/ts/player-api-event.d.ts by app-sdk/scripts/copy-protocol.mjs: edit the source, then run `pnpm --filter @wyndlass/app-sdk copy-protocol`.
+/* Generated from protocol/schemas by scripts/generate.mjs. Do not edit. */
+export {};