@playcraft/cli 0.1.65 → 0.1.67

package/templates/preview-runtime/v1/types/host.d.ts

@@ -0,0 +1,29 @@
+import type { ApplicationResult, Capabilities, Operation, RawDocuments, Receipt, SessionBinding, ImageResourceData, ImageResourceRequest, ImageRefreshTarget, ImageRefreshReceipt } from './protocol.js';
+export interface HostState {
+    connection: 'idle' | 'connecting' | 'ready' | 'error' | 'disposed';
+    draftRevision: number;
+    documents: RawDocuments;
+    capabilities?: Capabilities;
+    result?: ApplicationResult;
+    error?: string;
+}
+export interface HostOptions {
+    iframe: HTMLIFrameElement;
+    targetOrigin: string;
+    /** Opaque sandbox mode keeps the frame isolated from the platform's origin. */
+    transport?: 'origin' | 'opaque-sandbox';
+    binding: SessionBinding;
+    documents: RawDocuments;
+    onState?: (state: HostState) => void;
+    resolveImage?(request: Pick<ImageResourceRequest, 'documentId' | 'path' | 'value'>, signal: AbortSignal): Promise<ImageResourceData>;
+}
+export declare function createParameterHost(options: HostOptions): {
+    getState: () => HostState;
+    connect(): Promise<Capabilities>;
+    patch(operations: Operation[], phase?: "preview" | "commit"): Promise<Receipt>;
+    refreshImages(images: ImageRefreshTarget[]): Promise<ImageRefreshReceipt>;
+    dispose(options?: {
+        notifyRuntime?: boolean;
+    }): void;
+};
+export type ParameterHost = ReturnType<typeof createParameterHost>;

package/templates/preview-runtime/v1/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './protocol.js';
+export * from './adapters.js';
+export { createParameterHost } from './host.js';
+export { createParameterRuntime } from './runtime.js';
+export { connectPreviewRuntime, readWorkspacePreviewContext } from './preview.js';
+export * from './level-editor.js';

package/templates/preview-runtime/v1/types/level-editor.d.ts

@@ -0,0 +1,123 @@
+export type LevelEditorBinding = {
+    workspaceId: string;
+    directoryName: string;
+    editorId: string;
+    dataContractVersion: number;
+    executionContractHash: string;
+};
+export type LevelEditorIdentity = LevelEditorBinding & {
+    protocolVersion: 1;
+    hostSessionId: string;
+    frameEpoch: number;
+    runtimeInstanceId: string;
+};
+export type LevelEditorContext = {
+    documents: Record<string, unknown>;
+    selection: Record<string, string | number>;
+    draftRevision: number;
+    mode: 'edit' | 'play';
+    signal: AbortSignal;
+};
+export type LevelEditorGameAdapter = {
+    enterEdit(context: LevelEditorContext): void | Promise<void>;
+    loadLevel(context: LevelEditorContext): void | Promise<void>;
+    afterRender(context: LevelEditorContext): void | Promise<void>;
+    dispose(context: {
+        signal: AbortSignal;
+        reason: string;
+    }): void | Promise<void>;
+};
+export type LevelEditorLifecycle = {
+    version: 1;
+    canCancel: true;
+    requiresNewFrameOnFailure: true;
+    applicationTimeoutMs: number;
+    disposeTimeoutMs: number;
+    maxPendingSnapshots: number;
+};
+export type LevelEditorCapabilities = LevelEditorIdentity & {
+    commands: string[];
+    lifecycle?: LevelEditorLifecycle;
+};
+export type LevelEditorApplication = LevelEditorIdentity & {
+    applied: true;
+    draftRevision: number;
+    mode: 'edit' | 'play';
+};
+export type LevelEditorRuntimeOptions = {
+    binding: LevelEditorBinding;
+    commands: readonly string[];
+    adapter: LevelEditorGameAdapter;
+    applicationTimeoutMs?: number;
+    disposeTimeoutMs?: number;
+    maxPendingSnapshots?: number;
+};
+export declare class LevelEditorFrameResetError extends Error {
+    readonly reason: string;
+    readonly code = "LEVEL_EDITOR_FRAME_RESET_REQUIRED";
+    readonly requiresNewFrame = true;
+    constructor(reason: string, cause?: unknown);
+}
+export declare function isLevelEditorFrameResetError(value: unknown): boolean;
+/** Receipts follow the real game callbacks; a declaration alone cannot claim application. */
+export declare function createLevelEditorRuntime(options: LevelEditorRuntimeOptions): {
+    hello(value: unknown): LevelEditorCapabilities;
+    snapshot(value: unknown): Promise<LevelEditorApplication>;
+    cancel(value: unknown): {
+        cancelled: boolean;
+        requiresNewFrame: boolean;
+        workspaceId: string;
+        directoryName: string;
+        editorId: string;
+        dataContractVersion: number;
+        executionContractHash: string;
+        protocolVersion: 1;
+        hostSessionId: string;
+        frameEpoch: number;
+        runtimeInstanceId: string;
+    };
+    dispose(value?: unknown): Promise<void>;
+};
+/** The immutable development build stamps its contract; the host supplies only the parent origin. */
+export declare function readLevelEditorPreviewContext(): {
+    binding: LevelEditorBinding;
+    parentOrigin: string;
+};
+export declare function connectLevelEditorRuntime(options: Parameters<typeof createLevelEditorRuntime>[0] & {
+    parentOrigin: string;
+}): {
+    runtime: {
+        hello(value: unknown): LevelEditorCapabilities;
+        snapshot(value: unknown): Promise<LevelEditorApplication>;
+        cancel(value: unknown): {
+            cancelled: boolean;
+            requiresNewFrame: boolean;
+            workspaceId: string;
+            directoryName: string;
+            editorId: string;
+            dataContractVersion: number;
+            executionContractHash: string;
+            protocolVersion: 1;
+            hostSessionId: string;
+            frameEpoch: number;
+            runtimeInstanceId: string;
+        };
+        dispose(value?: unknown): Promise<void>;
+    };
+    dispose(): Promise<void>;
+};
+export declare function createLevelEditorHost(options: {
+    iframe: HTMLIFrameElement;
+    targetOrigin: string;
+    binding: LevelEditorBinding;
+    opaque?: boolean;
+    frameEpoch?: number;
+    requestTimeoutMs?: number;
+    connectTimeoutMs?: number;
+}): {
+    connect(): Promise<LevelEditorCapabilities>;
+    snapshot(input: Pick<LevelEditorContext, "documents" | "selection" | "draftRevision" | "mode">, request?: {
+        signal?: AbortSignal;
+    }): Promise<LevelEditorApplication>;
+    dispose(): void;
+};