@dreamboard-games/sdk 0.4.0-alpha.1 → 0.4.0-alpha.3

package/dist/protocol-BP193lva.d.ts

@@ -0,0 +1,267 @@
+type RuntimeJson = null | boolean | number | string | RuntimeJson[] | {
+    [key: string]: RuntimeJson;
+};
+type CanonicalJson = null | boolean | number | string | CanonicalJson[] | {
+    [key: string]: CanonicalJson;
+};
+declare function canonicalizePluginRuntimeJson(value: unknown): CanonicalJson;
+declare function encodeCanonicalPluginRuntimeJson(value: unknown): string;
+declare function digestPluginRuntimeJson(value: unknown): string;
+
+type PlayerId = string;
+interface PluginPlayerSummary {
+    readonly playerId: PlayerId;
+    readonly displayName: string;
+    readonly color?: string;
+}
+interface PluginSessionDescriptor {
+    readonly sessionId: string;
+    /** Turn order is the order of this array. */
+    readonly players: readonly PluginPlayerSummary[];
+}
+interface InteractionCommitPolicy {
+    readonly mode: "manual" | "autoWhenReady";
+}
+type InputSelection = {
+    readonly mode: "single";
+} | {
+    readonly mode: "many";
+    readonly min: number;
+    readonly max?: number;
+    readonly distinct?: boolean;
+};
+interface InputDomainDependencyCase {
+    readonly when: Readonly<Record<string, string>>;
+    readonly domain: InputDomain;
+}
+type InputDomainDependencies = {
+    readonly mode: "eager";
+    readonly dependentCases: readonly InputDomainDependencyCase[];
+} | {
+    readonly mode: "lazy";
+    readonly dependsOn: readonly string[];
+    readonly resolver: {
+        readonly interactionKey?: string;
+        readonly inputKey: string;
+    };
+};
+interface InputDomain {
+    readonly type: string;
+    readonly selection?: InputSelection;
+    readonly dependencies?: InputDomainDependencies;
+    readonly [key: string]: RuntimeJson | InputSelection | InputDomainDependencies | undefined;
+}
+interface InteractionChoiceOption {
+    readonly value: string | null;
+    readonly label: string;
+    readonly icon?: string;
+    readonly badge?: string;
+    readonly description?: string;
+    readonly disabled?: boolean;
+    readonly disabledReason?: string;
+}
+interface InteractionInputDescriptor {
+    readonly key: string;
+    readonly kind: string;
+    readonly domain: InputDomain;
+    readonly defaultValue?: RuntimeJson;
+}
+type InteractionAvailability = {
+    readonly status: "available";
+} | {
+    readonly status: "notYourTurn";
+    readonly reason: string;
+} | {
+    readonly status: "insufficientResources";
+    readonly reason: string;
+    readonly missingResources: Readonly<Record<string, number>>;
+} | {
+    readonly status: "blocked";
+    readonly reason: string;
+    readonly code?: string;
+};
+interface InteractionDiagnosticReason {
+    readonly ruleId: string;
+    readonly errorCode: string;
+}
+interface InteractionDescriptorBase<Interaction extends string = string> {
+    readonly phaseName: string;
+    readonly interactionKey: Interaction;
+    readonly interactionId: string;
+    readonly zoneId?: string;
+    readonly zoneIds?: readonly string[];
+    readonly commit: InteractionCommitPolicy;
+    readonly descriptorDigest?: string;
+    readonly actorSeat?: number;
+    readonly draftDigest?: string;
+    readonly inputs: readonly InteractionInputDescriptor[];
+    readonly cost?: Readonly<Record<string, RuntimeJson>>;
+    readonly currentResources?: Readonly<Record<string, RuntimeJson>>;
+    readonly availability: InteractionAvailability;
+    readonly reasons?: readonly InteractionDiagnosticReason[];
+}
+type ActionInteractionDescriptor<Interaction extends string = string> = InteractionDescriptorBase<Interaction> & {
+    readonly kind: "action";
+};
+interface InteractionContextOption {
+    readonly id: string;
+    readonly label?: string;
+}
+interface InteractionContext {
+    readonly to: string;
+    readonly title?: string;
+    readonly payload?: Readonly<Record<string, RuntimeJson>>;
+    readonly options?: readonly InteractionContextOption[];
+}
+type PromptInteractionDescriptor<Interaction extends string = string> = InteractionDescriptorBase<Interaction> & {
+    readonly kind: "prompt";
+    readonly context: InteractionContext;
+};
+type InteractionDescriptor<Interaction extends string = string> = ActionInteractionDescriptor<Interaction> | PromptInteractionDescriptor<Interaction>;
+interface ZoneHandlesSnapshot<Interaction extends string = string> {
+    readonly cardIds: readonly string[];
+    readonly cardViewsById: Readonly<Record<string, string>>;
+    readonly playableByCardId: Readonly<Record<string, readonly InteractionDescriptor<Interaction>[]>>;
+}
+interface SimultaneousPhaseSnapshot {
+    readonly phaseName: string;
+    readonly interactionId: string;
+    readonly actorIds: readonly PlayerId[];
+    readonly sealedPlayerIds: readonly PlayerId[];
+    readonly pendingPlayerIds: readonly PlayerId[];
+}
+interface PluginGameplayFrame<View = unknown, Phase extends string = string, Stage extends string = string, Interaction extends string = string> {
+    readonly gameVersion: number;
+    readonly actionSetVersion: string;
+    readonly perspectivePlayerId: PlayerId | null;
+    readonly view: View | null;
+    readonly flow: {
+        readonly currentPhase: Phase | null;
+        readonly currentStage: Stage | null;
+        readonly activePlayers: readonly PlayerId[];
+        readonly simultaneousPhase: SimultaneousPhaseSnapshot | null;
+    };
+    readonly availableInteractions: ReadonlyArray<InteractionDescriptor<Interaction>>;
+    readonly zones: Readonly<Record<string, ZoneHandlesSnapshot<Interaction>>>;
+}
+interface ReducerSeatProjectionBundle {
+    readonly currentStage?: string | null;
+    readonly stageSeats?: readonly string[];
+    readonly simultaneousPhase?: SimultaneousPhaseSnapshot | null;
+    readonly interactionsByRef?: unknown;
+    readonly seats: Readonly<Record<string, {
+        readonly view?: unknown;
+        readonly availableInteractionRefs?: unknown;
+        readonly zones?: unknown;
+    }>>;
+}
+interface ReducerBoardStaticProjection {
+    readonly view: RuntimeJson;
+    readonly hash?: string;
+    readonly manifestVersion?: string;
+}
+
+declare const DREAMBOARD_PLUGIN_PROTOCOL: "dreamboard-plugin";
+declare const DREAMBOARD_PLUGIN_PROTOCOL_VERSION: 3;
+interface ValidationResult {
+    readonly valid: boolean;
+    readonly errorCode?: string;
+    readonly message?: string;
+}
+type SubmissionResult = {
+    readonly accepted: true;
+} | {
+    readonly accepted: false;
+    readonly errorCode: string;
+    readonly message?: string;
+};
+interface PluginInteractionBasis {
+    readonly gameVersion: number;
+    readonly actionSetVersion: string;
+    readonly perspectivePlayerId: PlayerId | null;
+}
+interface ValidateInteractionCommand {
+    readonly type: "interaction.validate";
+    readonly requestId: string;
+    readonly basis: PluginInteractionBasis;
+    readonly interactionId: string;
+    readonly params: RuntimeJson;
+}
+interface SubmitInteractionCommand {
+    readonly type: "interaction.submit";
+    readonly requestId: string;
+    readonly basis: PluginInteractionBasis;
+    readonly interactionId: string;
+    readonly params: RuntimeJson;
+}
+type HostToPluginPayload = {
+    readonly type: "runtime.init";
+    readonly session: PluginSessionDescriptor;
+} | {
+    readonly type: "gameplay.frame";
+    readonly frame: PluginGameplayFrame;
+} | {
+    readonly type: "interaction.validation-result";
+    readonly requestId: string;
+    readonly result: ValidationResult;
+} | {
+    readonly type: "interaction.submit-result";
+    readonly requestId: string;
+    readonly result: SubmissionResult;
+};
+type PluginToHostPayload = {
+    readonly type: "runtime.ready";
+} | {
+    readonly type: "runtime.ack";
+    /** Echoes the host envelope sequence. It is delivery order only. */
+    readonly sequence: number;
+    readonly clientReceivedAtMs?: number;
+    readonly clientRenderedAtMs?: number;
+} | ValidateInteractionCommand | SubmitInteractionCommand | {
+    readonly type: "runtime.error";
+    readonly message: string;
+    readonly code?: string;
+};
+interface PluginProtocolEnvelope<Payload> {
+    readonly protocol: typeof DREAMBOARD_PLUGIN_PROTOCOL;
+    readonly version: typeof DREAMBOARD_PLUGIN_PROTOCOL_VERSION;
+    readonly channelId: string;
+    /** Delivery order only. It is not a game revision. */
+    readonly sequence: number;
+    readonly payload: Payload;
+}
+type HostToPluginEnvelope = PluginProtocolEnvelope<HostToPluginPayload>;
+type PluginToHostEnvelope = PluginProtocolEnvelope<PluginToHostPayload>;
+interface PluginProtocolFrame {
+    readonly id: string;
+    readonly frame: PluginGameplayFrame;
+    readonly projectionDigest: string;
+}
+interface PluginProtocolTape {
+    readonly session: PluginSessionDescriptor;
+    readonly frames: readonly PluginProtocolFrame[];
+    readonly steps: readonly PluginProtocolStep[];
+}
+type PluginProtocolStep = {
+    readonly id: string;
+    readonly kind: "host.frame";
+    readonly frameId: string;
+} | {
+    readonly id: string;
+    readonly kind: "client.validate";
+    readonly fromFrameId: string;
+    readonly requestDigest: string;
+    readonly response: ValidationResult;
+} | {
+    readonly id: string;
+    readonly kind: "client.submit";
+    readonly fromFrameId: string;
+    readonly requestDigest: string;
+    readonly response: SubmissionResult;
+};
+type ActionSetVersionInput = {
+    readonly gameVersion: number;
+    readonly availableInteractions: readonly InteractionDescriptor[];
+};
+
+export { type ActionInteractionDescriptor as A, type RuntimeJson as B, type CanonicalJson as C, DREAMBOARD_PLUGIN_PROTOCOL as D, type SubmissionResult as E, type SubmitInteractionCommand as F, type ValidationResult as G, type HostToPluginEnvelope as H, type InputDomain as I, canonicalizePluginRuntimeJson as J, digestPluginRuntimeJson as K, encodeCanonicalPluginRuntimeJson as L, type PlayerId as P, type ReducerBoardStaticProjection as R, type SimultaneousPhaseSnapshot as S, type ValidateInteractionCommand as V, type ZoneHandlesSnapshot as Z, type ActionSetVersionInput as a, DREAMBOARD_PLUGIN_PROTOCOL_VERSION as b, type HostToPluginPayload as c, type InputDomainDependencies as d, type InputDomainDependencyCase as e, type InputSelection as f, type InteractionAvailability as g, type InteractionChoiceOption as h, type InteractionCommitPolicy as i, type InteractionContext as j, type InteractionContextOption as k, type InteractionDescriptor as l, type InteractionDiagnosticReason as m, type InteractionInputDescriptor as n, type PluginGameplayFrame as o, type PluginInteractionBasis as p, type PluginPlayerSummary as q, type PluginProtocolEnvelope as r, type PluginProtocolFrame as s, type PluginProtocolStep as t, type PluginProtocolTape as u, type PluginSessionDescriptor as v, type PluginToHostEnvelope as w, type PluginToHostPayload as x, type PromptInteractionDescriptor as y, type ReducerSeatProjectionBundle as z };

package/dist/reducer/advanced.js

@@ -10,7 +10,7 @@ import {
   isManifestScopedSchema,
   markManifestScopedSchema,
   resolveManifestPlayerIds
-} from "../chunk-7LZZEI25.js";
+} from "../chunk-N6ZDIMRB.js";
 import "../chunk-PZ5AY32C.js";
 
 // src/reducer/client-param-schemas.ts

package/dist/reducer-contract.js

@@ -1,6 +1,6 @@
 import {
   materializeManifestTable
-} from "./chunk-XXBSIPJX.js";
+} from "./chunk-CP35NPPY.js";
 import {
   REDUCER_CONTRACT_VERSION,
   zod_exports

package/dist/reducer.js

@@ -128,7 +128,7 @@ import {
   spendPlayerResourcesInPlace,
   transferPlayerResources,
   transferPlayerResourcesInPlace
-} from "./chunk-7LZZEI25.js";
+} from "./chunk-N6ZDIMRB.js";
 import {
   REDUCER_CONTRACT_VERSION,
   builders_exports,
@@ -141,7 +141,7 @@ import {
 import {
   RuntimeJsonSchema,
   assertJsonWithinLimits
-} from "./chunk-AEUXCFGM.js";
+} from "./chunk-PF7L4BMG.js";
 import "./chunk-PZ5AY32C.js";
 
 // src/reducer/schema-helpers.ts