@dreamboard-games/sdk 0.2.1-alpha.0 → 0.2.1-alpha.1

package/dist/{ThemeProvider-fy0_QzgO.d.ts → ThemeProvider-BBMVT3KG.d.ts}

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { CSSProperties, ReactNode } from 'react';
-import { _ as Theme, a0 as ThemeOverride } from './hex-board-view-D_07hO6O.js';
+import { _ as Theme, a0 as ThemeOverride } from './hex-board-view-1iAyJRFn.js';
 
 /**
  * The set of preset theme ids ships in `@dreamboard-games/sdk/ui`. Authors

package/dist/attributes-BeRyboMS.d.ts

@@ -0,0 +1,279 @@
+declare const DREAMBOARD_BROWSER_INTERACTION_PROTOCOL_NAME: "dreamboard-browser-interaction";
+declare const DREAMBOARD_BROWSER_INTERACTION_PROTOCOL_VERSION: "2.0.0";
+declare const BROWSER_INTERACTION_ATTRIBUTES: {
+    readonly protocol: "data-dreamboard-browser-protocol";
+    readonly surface: "data-dreamboard-browser-surface";
+    readonly scope: "data-dreamboard-browser-scope";
+    readonly role: "data-dreamboard-browser-role";
+    readonly intent: "data-dreamboard-browser-intent";
+    readonly interactionKey: "data-dreamboard-interaction-key";
+    readonly interactionId: "data-dreamboard-interaction-id";
+    readonly descriptorDigest: "data-dreamboard-descriptor-digest";
+    readonly draftDigest: "data-dreamboard-draft-digest";
+    readonly readiness: "data-dreamboard-readiness";
+    readonly inputKey: "data-dreamboard-input-key";
+    readonly candidateValue: "data-dreamboard-candidate-value";
+    readonly candidateState: "data-dreamboard-candidate-state";
+    readonly actuatorKind: "data-dreamboard-actuator-kind";
+    readonly enabled: "data-dreamboard-actuator-enabled";
+    readonly actuatorId: "data-dreamboard-actuator-id";
+    readonly semanticEffects: "data-dreamboard-semantic-effects";
+    readonly acceptedEffectPatterns: "data-dreamboard-accepted-effect-patterns";
+    readonly preparationPatterns: "data-dreamboard-preparation-patterns";
+    readonly preparesIntent: "data-dreamboard-prepares-intent";
+    readonly preparesInputKey: "data-dreamboard-prepares-input-key";
+    readonly preparesCandidateValue: "data-dreamboard-prepares-candidate-value";
+    readonly preparesActuatorKind: "data-dreamboard-prepares-actuator-kind";
+    readonly diagnostic: "data-dreamboard-browser-diagnostic";
+};
+declare const BROWSER_INTERACTION_RECORD_ROLES: readonly ["interaction", "actuator"];
+declare const GAMEPLAY_BROWSER_INTERACTION_SURFACE: "gameplay";
+declare const GAMEPLAY_BROWSER_INTERACTION_INTENTS: readonly ["arm", "reveal", "invoke", "select", "toggle", "increment", "decrement", "fill", "submit"];
+declare const GAMEPLAY_BROWSER_INTERACTION_EFFECT_KINDS: readonly ["setCandidate", "adjustResource", "setScalar", "commit", "invoke"];
+declare const BROWSER_INTERACTION_READINESS_VALUES: readonly ["ready", "blocked", "unavailable"];
+declare const BROWSER_INTERACTION_CANDIDATE_STATES: readonly ["selected", "unselected", "mixed"];
+declare const BROWSER_INTERACTION_ACTUATOR_KINDS: readonly ["click", "fill", "keyboard", "pointer"];
+
+type CanonicalBrowserInteractionValue = null | boolean | number | string | readonly CanonicalBrowserInteractionValue[] | {
+    readonly [key: string]: CanonicalBrowserInteractionValue;
+};
+declare function encodeCanonicalCandidateValue(value: unknown): string;
+declare function decodeCanonicalCandidateValue(encoded: string): CanonicalBrowserInteractionValue;
+declare function compareStableJson(a: unknown, b: unknown): number;
+
+type BrowserInteractionSurface = string;
+type BrowserInteractionIntent = string;
+type GameplayBrowserInteractionSurface = typeof GAMEPLAY_BROWSER_INTERACTION_SURFACE;
+type GameplayBrowserInteractionIntent = (typeof GAMEPLAY_BROWSER_INTERACTION_INTENTS)[number];
+type GameplayBrowserInteractionEffectKind = (typeof GAMEPLAY_BROWSER_INTERACTION_EFFECT_KINDS)[number];
+type BrowserInteractionReadiness = (typeof BROWSER_INTERACTION_READINESS_VALUES)[number];
+type BrowserInteractionCandidateState = (typeof BROWSER_INTERACTION_CANDIDATE_STATES)[number];
+type BrowserInteractionActuatorKind = (typeof BROWSER_INTERACTION_ACTUATOR_KINDS)[number];
+interface BrowserInteractionProtocolIdentity {
+    readonly name: "dreamboard-browser-interaction";
+    readonly version: "2.0.0";
+}
+type BrowserInteractionSurfaceEffect = {
+    readonly kind: string;
+    readonly [key: string]: CanonicalBrowserInteractionValue;
+};
+interface BrowserInteractionScalarPattern {
+    readonly field: string;
+    readonly min?: number;
+    readonly max?: number;
+    readonly integer?: boolean;
+}
+type BrowserInteractionEffectPattern<Effect extends BrowserInteractionSurfaceEffect = BrowserInteractionSurfaceEffect> = {
+    readonly kind: "exact";
+    readonly effect: Effect;
+} | {
+    readonly kind: "match";
+    readonly effectKind: Effect["kind"] & string;
+    readonly fields?: Readonly<Record<string, CanonicalBrowserInteractionValue>>;
+    readonly scalar?: BrowserInteractionScalarPattern;
+};
+type GameplaySemanticEffect = {
+    readonly kind: "setCandidate";
+    readonly inputKey: string;
+    readonly candidateValue: CanonicalBrowserInteractionValue;
+    readonly beforeSelected: boolean;
+    readonly afterSelected: boolean;
+} | {
+    readonly kind: "adjustResource";
+    readonly inputKey: string;
+    readonly resourceKey: CanonicalBrowserInteractionValue;
+    readonly delta: -1 | 1;
+} | {
+    readonly kind: "setScalar";
+    readonly inputKey: string;
+    readonly value: number;
+} | {
+    readonly kind: "commit";
+} | {
+    readonly kind: "invoke";
+};
+type GameplaySemanticEffectPattern = BrowserInteractionEffectPattern<GameplaySemanticEffect>;
+interface BrowserInteractionDiagnostic {
+    readonly code: "ambiguous-actuator" | "ambiguous-effect-match" | "ambiguous-preparation-pattern" | "disabled-effect-actuator" | "duplicate-accepted-effect-pattern-match" | "duplicate-enabled-actuator" | "duplicate-enabled-effect-actuator" | "effect-actuator-kind-incompatibility" | "effect-intent-incompatibility" | "invalid-candidate" | "invalid-effect-payload" | "invalid-effect-pattern" | "invalid-protocol" | "invalid-record" | "invalid-scalar-argument" | "missing-effect" | "orphan-actuator" | "preparation-cycle" | "surface-intent-collision" | "unknown-surface-effect" | "unknown-intent" | "unknown-surface" | "unavailable-actuator";
+    readonly severity: "error" | "warning";
+    readonly message: string;
+    readonly surface?: BrowserInteractionSurface;
+    readonly scopeId?: string;
+    readonly interactionKey?: string;
+    readonly intent?: BrowserInteractionIntent;
+    readonly actuatorId?: string;
+}
+interface BrowserInteractionRawRecord {
+    readonly attributes: Readonly<Record<string, string | boolean | null | undefined>>;
+}
+interface BrowserInteractionPreparationTarget {
+    readonly intent: BrowserInteractionIntent;
+    readonly inputKey?: string;
+    readonly candidateValue?: CanonicalBrowserInteractionValue;
+    readonly candidateValueKey?: string;
+    readonly actuatorKind?: BrowserInteractionActuatorKind;
+}
+interface BrowserInteractionActuator {
+    readonly actuatorId: string;
+    readonly intent: BrowserInteractionIntent;
+    readonly descriptorDigest?: string;
+    readonly draftDigest?: string;
+    readonly inputKey?: string;
+    readonly candidateValue?: CanonicalBrowserInteractionValue;
+    readonly candidateValueKey?: string;
+    readonly candidateState?: BrowserInteractionCandidateState;
+    readonly enabled: boolean;
+    readonly actuatorKind: BrowserInteractionActuatorKind;
+    readonly semanticEffects: readonly BrowserInteractionSurfaceEffect[];
+    readonly acceptedEffectPatterns: readonly BrowserInteractionEffectPattern[];
+    readonly preparationPatterns: readonly BrowserInteractionEffectPattern[];
+    readonly prepares?: BrowserInteractionPreparationTarget;
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+}
+interface BrowserInteractionEntity {
+    readonly interactionKey: string;
+    readonly interactionId: string;
+    readonly descriptorDigest?: string;
+    readonly draftDigest?: string;
+    readonly readiness: BrowserInteractionReadiness;
+    readonly actuators: readonly BrowserInteractionActuator[];
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+}
+type BrowserGameplayInteraction = BrowserInteractionEntity;
+interface BrowserInteractionSemanticSurfaceSnapshot<Surface extends BrowserInteractionSurface = BrowserInteractionSurface> {
+    readonly surface: Surface;
+    readonly scopeId: string;
+    readonly interactions: readonly BrowserInteractionEntity[];
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+}
+interface BrowserGameplaySurfaceSnapshot {
+    readonly surface: GameplayBrowserInteractionSurface;
+    readonly scopeId: string;
+    readonly interactions: readonly BrowserGameplayInteraction[];
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+}
+interface BrowserInteractionUnknownSurfaceSnapshot {
+    readonly surface: BrowserInteractionSurface;
+    readonly scopeId: string;
+    readonly interactions?: never;
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+}
+type BrowserInteractionSurfaceSnapshot = BrowserGameplaySurfaceSnapshot | BrowserInteractionSemanticSurfaceSnapshot | BrowserInteractionUnknownSurfaceSnapshot;
+interface BrowserInteractionSnapshot {
+    readonly protocol: BrowserInteractionProtocolIdentity;
+    readonly surfaces: readonly BrowserInteractionSurfaceSnapshot[];
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+}
+interface BrowserInteractionSurfaceDefinition<Surface extends BrowserInteractionSurface = BrowserInteractionSurface, Intent extends BrowserInteractionIntent = BrowserInteractionIntent, EffectKind extends string = string> {
+    readonly surface: Surface;
+    readonly intents: readonly Intent[];
+    readonly effectKinds?: readonly EffectKind[];
+}
+interface BrowserInteractionRegistry {
+    readonly surfaces: ReadonlyMap<BrowserInteractionSurface, BrowserInteractionSurfaceDefinition>;
+}
+interface BrowserInteractionIntentRequest {
+    readonly surface: BrowserInteractionSurface;
+    readonly scopeId?: string;
+    readonly interactionKey?: string;
+    readonly interactionId?: string;
+    readonly intent: BrowserInteractionIntent;
+    readonly inputKey?: string;
+    readonly candidateValue?: unknown;
+    readonly candidateValueKey?: string;
+    readonly actuatorKind?: BrowserInteractionActuatorKind;
+    readonly allowDisabled?: boolean;
+}
+interface BrowserInteractionEffectRequest<Effect extends BrowserInteractionSurfaceEffect = BrowserInteractionSurfaceEffect> {
+    readonly surface: BrowserInteractionSurface;
+    readonly scopeId?: string;
+    readonly interactionKey?: string;
+    readonly interactionId?: string;
+    readonly effect: Effect;
+    readonly allowDisabled?: boolean;
+}
+type GameplayBrowserInteractionEffectRequest = BrowserInteractionEffectRequest<GameplaySemanticEffect>;
+interface BrowserInteractionResolutionSuccess {
+    readonly ok: true;
+    readonly actuator: BrowserInteractionActuator;
+    readonly surface: BrowserInteractionSurface;
+    readonly scopeId: string;
+    readonly interactionKey: string;
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+}
+interface BrowserInteractionResolutionFailure {
+    readonly ok: false;
+    readonly code: "ambiguous" | "invalid-snapshot" | "not-found" | "preparation-required" | "unavailable";
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+    readonly preparation?: readonly BrowserInteractionActuator[];
+}
+type BrowserInteractionResolution = BrowserInteractionResolutionSuccess | BrowserInteractionResolutionFailure;
+interface BrowserInteractionEffectResolutionSuccess {
+    readonly ok: true;
+    readonly actuator: BrowserInteractionActuator;
+    readonly surface: BrowserInteractionSurface;
+    readonly scopeId: string;
+    readonly interactionKey: string;
+    readonly match: "exact" | "accepted-pattern";
+    readonly effect: BrowserInteractionSurfaceEffect;
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+}
+interface BrowserInteractionEffectResolutionFailure {
+    readonly ok: false;
+    readonly code: "ambiguous" | "invalid-effect" | "invalid-snapshot" | "not-found" | "preparation-required" | "unavailable";
+    readonly diagnostics: readonly BrowserInteractionDiagnostic[];
+    readonly preparation?: readonly BrowserInteractionActuator[];
+}
+type BrowserInteractionEffectResolution = BrowserInteractionEffectResolutionSuccess | BrowserInteractionEffectResolutionFailure;
+
+type BrowserInteractionAttributeMap = Record<string, string | boolean>;
+interface BrowserInteractionRootAttributesInput {
+    readonly surface: string;
+    readonly scopeId: string;
+    readonly interactionKey: string;
+    readonly interactionId: string;
+    readonly descriptorDigest?: string;
+    readonly draftDigest?: string;
+    readonly readiness: BrowserInteractionReadiness;
+}
+interface BrowserInteractionActuatorAttributesInput {
+    readonly surface: string;
+    readonly scopeId: string;
+    readonly interactionKey: string;
+    readonly interactionId: string;
+    readonly descriptorDigest?: string;
+    readonly draftDigest?: string;
+    readonly intent: BrowserInteractionIntent;
+    readonly inputKey?: string;
+    readonly candidateValue?: unknown;
+    readonly candidateState?: BrowserInteractionCandidateState;
+    readonly enabled?: boolean;
+    readonly actuatorKind: BrowserInteractionActuatorKind;
+    readonly actuatorId?: string;
+    readonly semanticEffects?: readonly BrowserInteractionSurfaceEffect[];
+    readonly acceptedEffectPatterns?: readonly BrowserInteractionEffectPattern[];
+    readonly preparationPatterns?: readonly BrowserInteractionEffectPattern[];
+    readonly prepares?: BrowserInteractionPreparationTarget;
+}
+declare function createBrowserInteractionRootAttributes(input: BrowserInteractionRootAttributesInput): BrowserInteractionAttributeMap;
+declare function createBrowserInteractionActuatorAttributes(input: BrowserInteractionActuatorAttributesInput): BrowserInteractionAttributeMap;
+type GameplayInteractionRootAttributesInput = Omit<BrowserInteractionRootAttributesInput, "surface">;
+type GameplayActuatorAttributesInput = Omit<BrowserInteractionActuatorAttributesInput, "surface" | "intent" | "semanticEffects" | "acceptedEffectPatterns" | "preparationPatterns"> & {
+    readonly intent: GameplayBrowserInteractionIntent;
+    readonly semanticEffects?: readonly GameplaySemanticEffect[];
+    readonly acceptedEffectPatterns?: readonly GameplaySemanticEffectPattern[];
+    readonly preparationPatterns?: readonly GameplaySemanticEffectPattern[];
+};
+declare function createGameplayInteractionRootAttributes(input: GameplayInteractionRootAttributesInput): BrowserInteractionAttributeMap;
+declare function createGameplayActuatorAttributes(input: GameplayActuatorAttributesInput): BrowserInteractionAttributeMap;
+declare function createBrowserInteractionActuatorKey(input: {
+    readonly surface: string;
+    readonly scopeId: string;
+    readonly interactionKey: string;
+    readonly intent: BrowserInteractionIntent;
+    readonly inputKey?: string;
+    readonly candidateValueKey?: string;
+    readonly actuatorKind: BrowserInteractionActuatorKind;
+}): string;
+
+export { createBrowserInteractionActuatorAttributes as $, type BrowserInteractionResolutionFailure as A, BROWSER_INTERACTION_ACTUATOR_KINDS as B, type BrowserInteractionResolutionSuccess as C, type BrowserInteractionRootAttributesInput as D, type BrowserInteractionScalarPattern as E, type BrowserInteractionSemanticSurfaceSnapshot as F, type BrowserInteractionSnapshot as G, type BrowserInteractionSurface as H, type BrowserInteractionSurfaceDefinition as I, type BrowserInteractionSurfaceEffect as J, type BrowserInteractionSurfaceSnapshot as K, type BrowserInteractionUnknownSurfaceSnapshot as L, type CanonicalBrowserInteractionValue as M, DREAMBOARD_BROWSER_INTERACTION_PROTOCOL_NAME as N, DREAMBOARD_BROWSER_INTERACTION_PROTOCOL_VERSION as O, GAMEPLAY_BROWSER_INTERACTION_EFFECT_KINDS as P, GAMEPLAY_BROWSER_INTERACTION_INTENTS as Q, GAMEPLAY_BROWSER_INTERACTION_SURFACE as R, type GameplayActuatorAttributesInput as S, type GameplayBrowserInteractionEffectKind as T, type GameplayBrowserInteractionEffectRequest as U, type GameplayBrowserInteractionIntent as V, type GameplayBrowserInteractionSurface as W, type GameplayInteractionRootAttributesInput as X, type GameplaySemanticEffect as Y, type GameplaySemanticEffectPattern as Z, compareStableJson as _, BROWSER_INTERACTION_ATTRIBUTES as a, createBrowserInteractionActuatorKey as a0, createBrowserInteractionRootAttributes as a1, createGameplayActuatorAttributes as a2, createGameplayInteractionRootAttributes as a3, decodeCanonicalCandidateValue as a4, encodeCanonicalCandidateValue as a5, BROWSER_INTERACTION_CANDIDATE_STATES as b, BROWSER_INTERACTION_READINESS_VALUES as c, BROWSER_INTERACTION_RECORD_ROLES as d, type BrowserGameplayInteraction as e, type BrowserGameplaySurfaceSnapshot as f, type BrowserInteractionActuator as g, type BrowserInteractionActuatorAttributesInput as h, type BrowserInteractionActuatorKind as i, type BrowserInteractionAttributeMap as j, type BrowserInteractionCandidateState as k, type BrowserInteractionDiagnostic as l, type BrowserInteractionEffectPattern as m, type BrowserInteractionEffectRequest as n, type BrowserInteractionEffectResolution as o, type BrowserInteractionEffectResolutionFailure as p, type BrowserInteractionEffectResolutionSuccess as q, type BrowserInteractionEntity as r, type BrowserInteractionIntent as s, type BrowserInteractionIntentRequest as t, type BrowserInteractionPreparationTarget as u, type BrowserInteractionProtocolIdentity as v, type BrowserInteractionRawRecord as w, type BrowserInteractionReadiness as x, type BrowserInteractionRegistry as y, type BrowserInteractionResolution as z };