@fps-games/editor 0.1.0

package/dist/authoring-apply.d.ts

@@ -0,0 +1,21 @@
+import type { AuthoringApplyCommand, AuthoringApplyResult, AuthoringSourceRef, DocumentCommand, RuntimePatch } from '@fps-games/editor-core';
+export interface AuthoringRuntimePatchApplyAdapter<TDocument, TPatch = unknown> {
+    createPatchFromRuntimePatch(input: {
+        source: AuthoringSourceRef;
+        document: TDocument;
+        runtimePatch: RuntimePatch;
+    }): {
+        patch: TPatch;
+        label?: string;
+    } | null;
+}
+export interface CreateAuthoringApplyCommandOptions<TDocument, TPatch = unknown> {
+    source: AuthoringSourceRef;
+    document: TDocument;
+    runtimePatch: RuntimePatch;
+    adapter: AuthoringRuntimePatchApplyAdapter<TDocument, TPatch>;
+}
+export declare function createAuthoringApplyCommand<TDocument, TPatch = unknown>(options: CreateAuthoringApplyCommandOptions<TDocument, TPatch>): AuthoringApplyCommand<TPatch> | null;
+export declare function createDocumentCommandFromAuthoringApply<TDocument, TPatch = unknown>(command: AuthoringApplyCommand<TPatch>): DocumentCommand<TDocument, TPatch>;
+export declare function createAuthoringApplyResult<TDocument>(source: AuthoringSourceRef, document: TDocument): AuthoringApplyResult<TDocument>;
+//# sourceMappingURL=authoring-apply.d.ts.map

package/dist/authoring-apply.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authoring-apply.d.ts","sourceRoot":"","sources":["../src/authoring-apply.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,kBAAkB,EAClB,eAAe,EACf,YAAY,EACb,MAAM,wBAAwB,CAAC;AAEhC,MAAM,WAAW,iCAAiC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAC5E,2BAA2B,CAAC,KAAK,EAAE;QACjC,MAAM,EAAE,kBAAkB,CAAC;QAC3B,QAAQ,EAAE,SAAS,CAAC;QACpB,YAAY,EAAE,YAAY,CAAC;KAC5B,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,kCAAkC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAC7E,MAAM,EAAE,kBAAkB,CAAC;IAC3B,QAAQ,EAAE,SAAS,CAAC;IACpB,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,iCAAiC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;CAC/D;AAED,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,EACrE,OAAO,EAAE,kCAAkC,CAAC,SAAS,EAAE,MAAM,CAAC,GAC7D,qBAAqB,CAAC,MAAM,CAAC,GAAG,IAAI,CAoBtC;AAED,wBAAgB,uCAAuC,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,EACjF,OAAO,EAAE,qBAAqB,CAAC,MAAM,CAAC,GACrC,eAAe,CAAC,SAAS,EAAE,MAAM,CAAC,CAMpC;AAED,wBAAgB,0BAA0B,CAAC,SAAS,EAClD,MAAM,EAAE,kBAAkB,EAC1B,QAAQ,EAAE,SAAS,GAClB,oBAAoB,CAAC,SAAS,CAAC,CAMjC"}

package/dist/authoring-apply.js

@@ -0,0 +1,45 @@
+export function createAuthoringApplyCommand(options) {
+    const { source, document, runtimePatch, adapter } = options;
+    const binding = runtimePatch.sourceBinding;
+    if (!runtimePatch.applyable || !binding)
+        return null;
+    if (runtimePatch.applyTarget !== source.sourceType)
+        return null;
+    if (binding.sourceId !== source.sourceId || binding.sourceType !== source.sourceType)
+        return null;
+    const result = adapter.createPatchFromRuntimePatch({
+        source,
+        document,
+        runtimePatch,
+    });
+    if (!result)
+        return null;
+    return {
+        source: { ...source },
+        patch: result.patch,
+        label: result.label ?? runtimePatch.label ?? `Apply ${runtimePatch.runtimePropertyPath}`,
+        runtimePatch: cloneRuntimePatch(runtimePatch),
+    };
+}
+export function createDocumentCommandFromAuthoringApply(command) {
+    return {
+        type: 'document.patch',
+        patch: command.patch,
+        label: command.label,
+    };
+}
+export function createAuthoringApplyResult(source, document) {
+    return {
+        source: { ...source },
+        document,
+        applied: true,
+    };
+}
+function cloneRuntimePatch(patch) {
+    return {
+        ...patch,
+        sourceBinding: patch.sourceBinding ? { ...patch.sourceBinding } : patch.sourceBinding,
+        metadata: patch.metadata ? { ...patch.metadata } : undefined,
+    };
+}
+//# sourceMappingURL=authoring-apply.js.map

package/dist/authoring-apply.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authoring-apply.js","sourceRoot":"","sources":["../src/authoring-apply.ts"],"names":[],"mappings":"AAuBA,MAAM,UAAU,2BAA2B,CACzC,OAA8D;IAE9D,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAC5D,MAAM,OAAO,GAAG,YAAY,CAAC,aAAa,CAAC;IAC3C,IAAI,CAAC,YAAY,CAAC,SAAS,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IACrD,IAAI,YAAY,CAAC,WAAW,KAAK,MAAM,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAChE,IAAI,OAAO,CAAC,QAAQ,KAAK,MAAM,CAAC,QAAQ,IAAI,OAAO,CAAC,UAAU,KAAK,MAAM,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAElG,MAAM,MAAM,GAAG,OAAO,CAAC,2BAA2B,CAAC;QACjD,MAAM;QACN,QAAQ;QACR,YAAY;KACb,CAAC,CAAC;IACH,IAAI,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAEzB,OAAO;QACL,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,YAAY,CAAC,KAAK,IAAI,SAAS,YAAY,CAAC,mBAAmB,EAAE;QACxF,YAAY,EAAE,iBAAiB,CAAC,YAAY,CAAC;KAC9C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uCAAuC,CACrD,OAAsC;IAEtC,OAAO;QACL,IAAI,EAAE,gBAAgB;QACtB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK;KACrB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,MAA0B,EAC1B,QAAmB;IAEnB,OAAO;QACL,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE;QACrB,QAAQ;QACR,OAAO,EAAE,IAAI;KACd,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAmB;IAC5C,OAAO;QACL,GAAG,KAAK;QACR,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa;QACrF,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS;KAC7D,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+import { type DocumentAdapter } from '@fps-games/editor-core';
+import { type BrowserHost, type BrowserHostOptions } from '@fps-games/editor-browser';
+import { type BabylonRuntimeGlobal, type CanonicalMaterialChange, type CanonicalOutlineChange, type CanonicalTransformChange, type EditorGameLike, type RuntimeNode, type RuntimeScene } from '@fps-games/editor-babylon';
+import { type ForgePlayBridgeHostOptions, type RegisterEditorRuntimeResult } from '@fps-games/editor-forge-play';
+import { EDITOR_COMMAND_NAME, EDITOR_EVENT_NAME, EDITOR_POST_MESSAGE, type EditorCapabilities, type EditorRuntime, type EditorRuntimeChange, type EditorTool, type PersistentBinding, type SelectionSource } from '@fps-games/editor-protocol';
+export * from './local-editor-harness';
+export * from './authoring-apply';
+export type MaybePromise<T> = T | Promise<T>;
+export interface EditorAdapterContext {
+    browserHost: BrowserHost;
+    engine?: unknown;
+    scene: RuntimeScene | null;
+    game: EditorGameLike | null;
+}
+export interface PersistentBindingAdapter {
+    resolveBinding(node: RuntimeNode, context: EditorAdapterContext): PersistentBinding | null;
+}
+export interface SceneAdapter {
+    normalizeSelection?(args: {
+        source: SelectionSource;
+        rawEntity: unknown;
+        context: EditorAdapterContext;
+    }): RuntimeNode | null;
+    getSelectedEntities?(): RuntimeNode[];
+    shouldHandleViewportSelection?(): boolean;
+    duplicateSelected?(args: {
+        selected: RuntimeNode;
+        binding: PersistentBinding | null;
+        context: EditorAdapterContext;
+    }): MaybePromise<{
+        rootNode?: RuntimeNode | null;
+        nodeId?: string | null;
+    } | boolean | null>;
+    onSelectionCommitted?(entity: RuntimeNode | null, context: EditorAdapterContext): void;
+}
+export interface AssetAdapter {
+    handleCommand?(name: string, params: Record<string, unknown>, context: EditorAdapterContext): MaybePromise<boolean>;
+}
+export interface EditorDocumentAdapter extends DocumentAdapter {
+    applyTransformChange?(change: CanonicalTransformChange, context: EditorAdapterContext): boolean;
+    applyMaterialChange?(change: CanonicalMaterialChange, context: EditorAdapterContext): boolean;
+    applyOutlineChange?(change: CanonicalOutlineChange, context: EditorAdapterContext): boolean;
+    beginTransformBatch?(): void;
+    endTransformBatch?(): void;
+}
+export interface EditorLifecycleAdapter {
+    getGame?(): EditorGameLike | null;
+    onModeChanged?(mode: 'edit' | 'play', context: EditorAdapterContext): void;
+    onSetTool?(tool: EditorTool, context: EditorAdapterContext): void;
+    onFocusSelected?(selected: RuntimeNode | null, context: EditorAdapterContext): void;
+    onDuplicateSelected?(selected: RuntimeNode | null, context: EditorAdapterContext): MaybePromise<boolean | void>;
+    showInspector?(): MaybePromise<void>;
+    hideInspector?(): MaybePromise<void>;
+}
+export interface BabylonForgePlayEditorOptions {
+    platformBridge?: ForgePlayBridgeHostOptions;
+    browserHost?: BrowserHost;
+    browserHostOptions?: BrowserHostOptions;
+    engine?: unknown;
+    scene?: RuntimeScene | (() => RuntimeScene | null) | null;
+    canvas?: HTMLCanvasElement | string | null;
+    game?: EditorGameLike | (() => EditorGameLike | null) | null;
+    babylon?: BabylonRuntimeGlobal | null;
+    capabilities?: EditorCapabilities;
+    documentAdapter: EditorDocumentAdapter;
+    assetAdapter?: AssetAdapter;
+    sceneAdapter: SceneAdapter;
+    lifecycleAdapter?: EditorLifecycleAdapter;
+    persistentBindingAdapter: PersistentBindingAdapter;
+    autoRegister?: boolean;
+    registerLegacyProxy?: boolean;
+    installLegacyBypass?: boolean;
+    inspectorUrl?: string;
+    loadGizmoModules?: () => Promise<unknown[]>;
+}
+export interface BabylonForgePlayEditor {
+    runtime: EditorRuntime;
+    browserHost: BrowserHost;
+    register(): RegisterEditorRuntimeResult;
+    dispose(): void;
+}
+export declare function createBabylonForgePlayEditor(options: BabylonForgePlayEditorOptions): BabylonForgePlayEditor;
+export type { DocumentAdapter, EditorRuntime, EditorRuntimeChange, };
+export { EDITOR_COMMAND_NAME, EDITOR_EVENT_NAME, EDITOR_POST_MESSAGE, };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,eAAe,EAIrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAEL,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACxB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EAEnB,KAAK,WAAW,EAChB,KAAK,YAAY,EAClB,MAAM,2BAA2B,CAAC;AAQnC,OAAO,EAOL,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EACjC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,KAAK,kBAAkB,EAGvB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACrB,MAAM,4BAA4B,CAAC;AAEpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAElC,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE7C,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,WAAW,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,oBAAoB,GAAG,iBAAiB,GAAG,IAAI,CAAC;CAC5F;AAED,MAAM,WAAW,YAAY;IAC3B,kBAAkB,CAAC,CAAC,IAAI,EAAE;QACxB,MAAM,EAAE,eAAe,CAAC;QACxB,SAAS,EAAE,OAAO,CAAC;QACnB,OAAO,EAAE,oBAAoB,CAAC;KAC/B,GAAG,WAAW,GAAG,IAAI,CAAC;IACvB,mBAAmB,CAAC,IAAI,WAAW,EAAE,CAAC;IACtC,6BAA6B,CAAC,IAAI,OAAO,CAAC;IAC1C,iBAAiB,CAAC,CAAC,IAAI,EAAE;QACvB,QAAQ,EAAE,WAAW,CAAC;QACtB,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;QAClC,OAAO,EAAE,oBAAoB,CAAC;KAC/B,GAAG,YAAY,CAAC;QAAE,QAAQ,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;IAC7F,oBAAoB,CAAC,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACxF;AAED,MAAM,WAAW,YAAY;IAC3B,aAAa,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,oBAAoB,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;CACrH;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,oBAAoB,CAAC,CAAC,MAAM,EAAE,wBAAwB,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC;IAChG,mBAAmB,CAAC,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC;IAC9F,kBAAkB,CAAC,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC;IAC5F,mBAAmB,CAAC,IAAI,IAAI,CAAC;IAC7B,iBAAiB,CAAC,IAAI,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,IAAI,cAAc,GAAG,IAAI,CAAC;IAClC,aAAa,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAC3E,SAAS,CAAC,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAClE,eAAe,CAAC,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACpF,mBAAmB,CAAC,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,EAAE,OAAO,EAAE,oBAAoB,GAAG,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAChH,aAAa,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;IACrC,aAAa,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,6BAA6B;IAC5C,cAAc,CAAC,EAAE,0BAA0B,CAAC;IAC5C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,YAAY,GAAG,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAC1D,MAAM,CAAC,EAAE,iBAAiB,GAAG,MAAM,GAAG,IAAI,CAAC;IAC3C,IAAI,CAAC,EAAE,cAAc,GAAG,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7D,OAAO,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACtC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,eAAe,EAAE,qBAAqB,CAAC;IACvC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,YAAY,EAAE,YAAY,CAAC;IAC3B,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,EAAE,WAAW,CAAC;IACzB,QAAQ,IAAI,2BAA2B,CAAC;IACxC,OAAO,IAAI,IAAI,CAAC;CACjB;AAqGD,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,6BAA6B,GAAG,sBAAsB,CAmc3G;AAED,YAAY,EACV,eAAe,EACf,aAAa,EACb,mBAAmB,GACpB,CAAC;AAEF,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,GACpB,CAAC"}