@wonderlandengine/editor-api 1.4.7 → 1.5.0-rc.2

package/dist/data.d.ts

@@ -1,4 +1,4 @@
-export declare let data: EditorData;
+export declare let data: ProjectData;
 /** Object reference */
 export type ObjectReference = string | null;
 /** Mesh reference */
@@ -23,6 +23,8 @@ export type ImageReference = string | null;
 export type AnimationReference = string | null;
 /** Particle effect reference */
 export type ParticleEffectReference = string | null;
+/** Plugin reference */
+export type PluginReference = string | null;
 /** Project type */
 export declare enum ProjectType {
     Website = "website",
@@ -37,7 +39,17 @@ export declare enum RecordType {
     /** A dictionary (key-value pairs) of records */
     Dict = 2,
     /** A dictionary (key-value pairs) of records with stable indices */
-    IdDict = 3
+    IdDict = 3,
+    Value = 4,
+    Bool = 5,
+    Int = 6,
+    Uint = 7,
+    Float = 8,
+    Double = 9,
+    String = 10,
+    Id = 11,
+    Enum = 12,
+    EnumInt = 13
 }
 export declare class Access {
     recordType?: () => RecordType;
@@ -129,6 +141,7 @@ export declare class RenderingSettings extends Access {
     usePreZ: boolean;
     useMultiDraw: boolean;
     useTextureStreaming: boolean;
+    deferSkinningCompilation: boolean;
     sky: SkySettings;
     bloom: BloomSettings;
     hdr: HdrSettings;
@@ -155,9 +168,6 @@ export declare class EditorSettings extends Access {
     };
     importPhysicalAsPhongMaterials: boolean;
 }
-/** Plugins settings */
-export declare class PluginsSettings extends Access {
-}
 /** PWA settings */
 export declare class PWASettings extends Access {
     enable: boolean;
@@ -279,7 +289,6 @@ export interface Settings extends Access {
     editor: EditorSettings;
     runtime: RuntimeSettings;
     scripting: ScriptingSettings;
-    plugins: PluginsSettings;
     xr: XRSettings;
     physx: PhysXSettings;
     localization: LocalizationSettings;
@@ -298,6 +307,8 @@ export declare class Resource extends Access {
     name: string;
     link: Link | null;
     packageAlways: boolean;
+    resourceKey: string;
+    resourceId: number;
 }
 /** Image resource */
 export declare class ImageResource extends Resource {
@@ -809,15 +820,23 @@ export declare class LanguageResource extends Resource {
 export declare class ParticleEffectResource extends Resource {
     name: string;
 }
+/** Plugin resource */
+export declare class PluginResource extends Resource {
+    name: string;
+    /** Whether this plugin is enabled */
+    enabled: boolean;
+}
 /** File resource */
 export declare class FileResource extends Resource {
     fileName: string;
     importerName: string;
     importPhysicalAsPhongMaterials: boolean;
 }
-export declare class ResourceSection<T> {
+export type ResourceSection<T> = {
+    add(): T;
+} & {
     [key: string]: T;
-}
+};
 /**
  * Access to Wonderland Editor's data.
  *
@@ -835,7 +854,7 @@ export declare class ResourceSection<T> {
  *    WL.data.objects[123].components[0].text.text
  * ```
  */
-export interface EditorData {
+export interface ProjectData {
     /** Project settings */
     settings: Settings;
     /** List of scene file paths */
@@ -864,4 +883,6 @@ export interface EditorData {
     languages: ResourceSection<LanguageResource>;
     /** Particle effect resources */
     particleEffects: ResourceSection<ParticleEffectResource>;
+    /** Particle effect resources */
+    plugins: ResourceSection<PluginResource>;
 }

package/dist/data.js

@@ -23,8 +23,17 @@ export var RecordType;
     RecordType[RecordType["Dict"] = 2] = "Dict";
     /** A dictionary (key-value pairs) of records with stable indices */
     RecordType[RecordType["IdDict"] = 3] = "IdDict";
+    RecordType[RecordType["Value"] = 4] = "Value";
+    RecordType[RecordType["Bool"] = 5] = "Bool";
+    RecordType[RecordType["Int"] = 6] = "Int";
+    RecordType[RecordType["Uint"] = 7] = "Uint";
+    RecordType[RecordType["Float"] = 8] = "Float";
+    RecordType[RecordType["Double"] = 9] = "Double";
+    RecordType[RecordType["String"] = 10] = "String";
+    RecordType[RecordType["Id"] = 11] = "Id";
+    RecordType[RecordType["Enum"] = 12] = "Enum";
+    RecordType[RecordType["EnumInt"] = 13] = "EnumInt";
 })(RecordType || (RecordType = {}));
-;
 export class Access {
     recordType;
     exists;
@@ -55,13 +64,13 @@ export class Access {
     }
 }
 if (ApiObject) {
-    Object.assign(ApiObject, {
-        keys: Access.prototype.keys,
-        values: Access.prototype.values,
-        entries: Access.prototype.entries,
-        toValue: Access.prototype.toValue,
-        toJSON: Access.prototype.toJSON,
-        [Symbol.iterator]: Access.prototype[Symbol.iterator],
+    Object.defineProperties(ApiObject, {
+        keys: { value: Access.prototype.keys, enumerable: false },
+        values: { value: Access.prototype.values, enumerable: false },
+        entries: { value: Access.prototype.entries, enumerable: false },
+        toValue: { value: Access.prototype.toValue, enumerable: false },
+        toJSON: { value: Access.prototype.toJSON, enumerable: false },
+        [Symbol.iterator]: { value: Access.prototype[Symbol.iterator], enumerable: false },
     });
 }
 /** Project settings */
@@ -141,6 +150,7 @@ export class RenderingSettings extends Access {
     usePreZ = false;
     useMultiDraw = false;
     useTextureStreaming = true;
+    deferSkinningCompilation = false;
     sky = new SkySettings();
     bloom = new BloomSettings();
     hdr = new HdrSettings();
@@ -167,9 +177,6 @@ export class EditorSettings extends Access {
     };
     importPhysicalAsPhongMaterials = true;
 }
-/** Plugins settings */
-export class PluginsSettings extends Access {
-}
 /** PWA settings */
 export class PWASettings extends Access {
     enable = false;
@@ -309,6 +316,8 @@ export class Resource extends Access {
     name = '';
     link = null;
     packageAlways = false;
+    resourceKey = "0";
+    resourceId = 0;
 }
 /** Image resource */
 export class ImageResource extends Resource {
@@ -829,11 +838,15 @@ export class LanguageResource extends Resource {
 export class ParticleEffectResource extends Resource {
     name = 'particleEffect';
 }
+/** Plugin resource */
+export class PluginResource extends Resource {
+    name = 'plugin';
+    /** Whether this plugin is enabled */
+    enabled = true;
+}
 /** File resource */
 export class FileResource extends Resource {
     fileName = '';
     importerName = '';
     importPhysicalAsPhongMaterials = true;
 }
-export class ResourceSection {
-}

package/dist/editor-state.d.ts

@@ -0,0 +1,15 @@
+export interface Camera {
+    lookAt(target: [number, number, number]): void;
+}
+export interface SceneViewState {
+    camera: Camera;
+}
+export interface EditorState {
+    /** `true` if baking is in progress. */
+    baking: boolean;
+    sceneView: SceneViewState;
+}
+declare global {
+    function _wl_internalBinding(moduleName: 'editorState'): EditorState;
+}
+export declare const editorState: EditorState;

package/dist/editor-state.js

@@ -0,0 +1 @@
+export const editorState = _wl_internalBinding('editorState');

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export * from './data.js';
+export * from './editor-state.js';
 export * as ui from './ui.js';
 export * as tools from './tools.js';
-export * from './project.js';
 export * from './workspace.js';
 /** Editor plugin */
 export declare class EditorPlugin {

package/dist/index.js

@@ -1,9 +1,9 @@
 export * from './data.js';
+export * from './editor-state.js';
 import * as ui_1 from './ui.js';
 export { ui_1 as ui };
 import * as tools_1 from './tools.js';
 export { tools_1 as tools };
-export * from './project.js';
 export * from './workspace.js';
 /** Editor plugin */
 export class EditorPlugin {

package/dist/native.d.ts

@@ -1,12 +1,15 @@
-import { EditorData } from './data.js';
+import { ProjectData } from './data.js';
 import { Workspace } from './workspace.js';
 interface NativeToolsAPI {
+    newSubProject(name: string, filename?: string, projectKind?: string): boolean;
+    switchProject(id: number): void;
     packageProject(destDir?: string): number;
     loadFile(filename: string): number;
     loadScene(filename: string, parent?: string): number;
     awaitJob(jobId: number, cb: (success: boolean) => void): void;
     openBrowser(url: string): void;
     computeMeshBounds(meshId: string, out: Float32Array): void;
+    saveProject(): void;
 }
 interface NativeUiAPI {
     freeImage(id: number): void;
@@ -30,51 +33,11 @@ interface NativeUiAPI {
     inputInt(label: string, value: number): number | null;
     inputInt3(label: string, value: Int32Array): boolean;
 }
-/** Project paths */
-export interface Project {
-    /**
-     * Root directory of the project
-     *
-     * Directory in which the project file resides in.
-     */
-    readonly root: string;
-    /**
-     * Project filename
-     *
-     * File only without the root directory.
-     */
-    readonly filename: string;
-    /**
-     * Project deploy path
-     * @returns `<root>/deploy`
-     */
-    readonly deployPath: string;
-    /**
-     * Project cache path
-     * @returns `<root>/cache`
-     */
-    readonly cachePath: string;
-    /**
-     * Project package.json path
-     * @returns `<root>/package.json`
-     */
-    readonly packageJsonPath: string;
-    /**
-     * Project node_modules path
-     * @returns `<root>/node_modules`
-     */
-    readonly nodeModulesPath: string;
-    /**
-     * Project shaders path
-     * @returns `<root>/shaders`
-     */
-    readonly shadersPath: string;
-}
 declare global {
     function _wl_internalBinding(moduleName: 'tools'): NativeToolsAPI;
     function _wl_internalBinding(moduleName: 'ui'): NativeUiAPI;
-    function _wl_internalBinding(moduleName: 'data'): EditorData;
-    function _wl_internalBinding(moduleName: 'project'): Project;
+    /** @todo Remove/deprecate */
+    function _wl_internalBinding(moduleName: 'data'): ProjectData;
     function _wl_internalBinding(moduleName: 'workspace'): Workspace;
 }
 export {};

package/dist/tools.d.ts

@@ -1,5 +1,7 @@
 /** @hidden */
 export declare function awaitJob(jobId: number): Promise<void>;
+export declare const newSubProject: (name: string, filename?: string, projectKind?: string) => boolean;
+export declare const switchProject: (id: number) => void;
 /**
  * Package the current project
  * @param destDir Destination directory into which to package, default `'<project-root>/deploy'`.
@@ -31,3 +33,4 @@ export declare function loadScene(path: string, options: {
  */
 export declare const openBrowser: (url: string) => void;
 export declare const computeMeshBounds: (meshId: string, out: Float32Array) => void;
+export declare const saveProject: () => void;

package/dist/tools.js

@@ -10,6 +10,8 @@ export function awaitJob(jobId) {
         });
     });
 }
+export const newSubProject = tools.newSubProject.bind(tools);
+export const switchProject = tools.switchProject.bind(tools);
 /**
  * Package the current project
  * @param destDir Destination directory into which to package, default `'<project-root>/deploy'`.
@@ -48,3 +50,4 @@ export function loadScene(path, options) {
  */
 export const openBrowser = tools.openBrowser.bind(tools);
 export const computeMeshBounds = tools.computeMeshBounds.bind(tools);
+export const saveProject = tools.saveProject.bind(tools);

package/dist/workspace.d.ts

@@ -1,10 +1,65 @@
-/** @todo: Give access to each projects using: getProject(filename). */
+import { ProjectData } from './data.js';
 /**
  * Workspace access.
  *
  * Allows to read the current workspace setup.
  */
 export interface Workspace {
-    mainFilename: string;
+    /**
+     * Workspace projects
+     *
+     * The main project is always at index/id 0
+     */
+    readonly projects: Array<ProjectData>;
+    projectId(filename: String): number;
+    /**
+     * Root directory of the project
+     *
+     * Directory in which the project file resides in.
+     */
+    readonly root: string;
+    /**
+     * Main project filename
+     *
+     * Filename relative to the workspace root directory.
+     *
+     * @deprecated Use the per-project accessors instead
+     */
+    readonly filename: string;
+    /**
+     * Main project filename
+     *
+     * Filename relative to the workspace root directory.
+     */
+    readonly mainFilename: string;
+    /**
+     * Project deploy path
+     * @returns `<root>/deploy`
+     */
+    readonly deployPath: string;
+    /**
+     * Project cache path
+     * @returns `<root>/cache`
+     */
+    readonly cachePath: string;
+    /**
+     * Project package.json path
+     * @returns `<root>/package.json`
+     */
+    readonly packageJsonPath: string;
+    /**
+     * Project node_modules path
+     * @returns `<root>/node_modules`
+     */
+    readonly nodeModulesPath: string;
+    /**
+     * Project shaders path
+     * @returns `<root>/shaders`
+     */
+    readonly shadersPath: string;
 }
 export declare const workspace: Workspace;
+/**
+ * @deprecated Use the {@link workspace} export instead
+ */
+export declare const project: Workspace;

package/dist/workspace.js

@@ -1,2 +1,5 @@
-/** @todo: Give access to each projects using: getProject(filename). */
 export const workspace = _wl_internalBinding('workspace');
+/**
+ * @deprecated Use the {@link workspace} export instead
+ */
+export const project = workspace;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wonderlandengine/editor-api",
-  "version": "1.4.7",
+  "version": "1.5.0-rc.2",
   "description": "Wonderland Engine's Editor API for plugins - very experimental.",
   "main": "./dist/index.js",
   "module": "./dist/index.js",

package/dist/project.d.ts

@@ -1 +0,0 @@
-export declare const project: import("./native.js").Project;

package/dist/project.js

@@ -1 +0,0 @@
-export const project = _wl_internalBinding('project');