@wonderlandengine/editor-api 1.2.0-dev.0

package/dist/native.d.ts

@@ -0,0 +1,24 @@
+import { EditorData } from './data.js';
+interface NativeToolsAPI {
+    packageProject(destDir?: string): number;
+    loadFile(filename: string): number;
+    loadScene(filename: string, parent?: string): number;
+    awaitJob(jobId: number, cb: (success: boolean) => void): void;
+}
+interface NativeUiAPI {
+    freeImage(id: number): void;
+    loadImage(path: string, cb: (id: number) => void): void;
+    text(text: string): void;
+    label(text: string): void;
+    button(label: string): boolean;
+    image(id: number, width: number, height: number): boolean;
+    inputText(label: string, value: string): string | null;
+    dummy(width: number, height: number): void;
+    sameLine(offset: number): void;
+}
+declare global {
+    function _wl_internalBinding(moduleName: 'tools'): NativeToolsAPI;
+    function _wl_internalBinding(moduleName: 'ui'): NativeUiAPI;
+    function _wl_internalBinding(moduleName: 'data'): EditorData;
+}
+export {};

package/dist/native.js

@@ -0,0 +1 @@
+export {};

package/dist/tools.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Package the current project
+ * @param destDir Destination directory into which to package, default `'<project-root>/deploy'`.
+ * @returns Promise with that is rejected on package failure.
+ */
+export declare function packageProject(destDir?: string): Promise<void>;
+/**
+ * Load a file into current scene
+ *
+ * @param path Path to file to load
+ * @returns Promise with that is rejected on load failure.
+ */
+export declare function loadFile(path: string): Promise<void>;
+/**
+ * Load a scene file into current scene
+ *
+ * @param path Path to file to load
+ * @param options.parent Parent object to parent the scene to. `null`, `undefined` and `""` indicate
+ *        scene root.
+ * @returns Promise with that is rejected on load failure.
+ */
+export declare function loadScene(path: string, options: {
+    parent?: string;
+}): Promise<void>;

package/dist/tools.js

@@ -0,0 +1,42 @@
+const tools = _wl_internalBinding('tools');
+function awaitJob(jobId) {
+    return new Promise((resolve, reject) => {
+        tools.awaitJob(jobId, (success) => {
+            if (success)
+                resolve();
+            else
+                reject();
+        });
+    });
+}
+/**
+ * Package the current project
+ * @param destDir Destination directory into which to package, default `'<project-root>/deploy'`.
+ * @returns Promise with that is rejected on package failure.
+ */
+export function packageProject(destDir) {
+    const job = tools.packageProject(destDir);
+    return awaitJob(job);
+}
+/**
+ * Load a file into current scene
+ *
+ * @param path Path to file to load
+ * @returns Promise with that is rejected on load failure.
+ */
+export function loadFile(path) {
+    const job = tools.loadFile(path);
+    return awaitJob(job);
+}
+/**
+ * Load a scene file into current scene
+ *
+ * @param path Path to file to load
+ * @param options.parent Parent object to parent the scene to. `null`, `undefined` and `""` indicate
+ *        scene root.
+ * @returns Promise with that is rejected on load failure.
+ */
+export function loadScene(path, options) {
+    const job = tools.loadScene(path, options.parent);
+    return awaitJob(job);
+}

package/dist/ui.d.ts

@@ -0,0 +1,53 @@
+/** Image to be used in the {@ref Ui}. */
+export declare class UiImage {
+    _id: number;
+    constructor(id: number);
+    /** Manually mark this image as no longer needed */
+    free(): void;
+}
+/** Simple text */
+export declare const text: (text: string) => void;
+/** Label for the next UI element */
+export declare const label: (text: string) => void;
+/**
+ * Simple button
+ * @param label Label for the button.
+ * @returns `true` when pressed this frame.
+ *
+ * @example
+ * In a draw function of a plugin, use as follows:
+ * ```ts
+ * if(WLE.button('Click me!')) {
+ *     console.log('You clicked the button.');
+ * }
+ * ```
+ */
+export declare const button: (label: string) => boolean;
+/**
+ * Load a ui image. Any format supported by the editor is supported.
+ *
+ * @param filepath Path to the file.
+ * @returns Promise with the loaded UiImage
+ *
+ * @example
+ * In a draw function of a plugin, use as follows:
+ * ```ts
+ * this.thumbnail = null;
+ * loadUiImage("cache/plugins/my-plugin/downloads/thumbnail.png")
+ *     .then((img) => this.thumbnail = img);
+ * ```
+ *
+ * @see image()
+ */
+export declare function loadUiImage(filepath: string): Promise<UiImage>;
+export declare function image(image: UiImage, width: number, height: number): boolean;
+/**
+ * Text input field.
+ *
+ * @usage
+ * s = ui.inputText("change this:", s) || s;
+ */
+export declare const inputText: (label: string, value: string) => string | null;
+export declare function inputColor4(label: string, value: ArrayLike<number>): boolean;
+export declare const dummy: (width: number, height: number) => void;
+export declare const sameLine: (offset: number) => void;

package/dist/ui.js

@@ -0,0 +1,79 @@
+const ui = _wl_internalBinding('ui');
+/** Image to be used in the {@ref Ui}. */
+export class UiImage {
+    _id = -1;
+    constructor(id) {
+        this._id = id;
+    }
+    /** Manually mark this image as no longer needed */
+    free() {
+        if (this._id >= 0)
+            ui.freeImage(this._id);
+    }
+}
+/** Simple text */
+export const text = ui.text.bind(ui);
+/** Label for the next UI element */
+export const label = ui.label.bind(ui);
+/**
+ * Simple button
+ * @param label Label for the button.
+ * @returns `true` when pressed this frame.
+ *
+ * @example
+ * In a draw function of a plugin, use as follows:
+ * ```ts
+ * if(WLE.button('Click me!')) {
+ *     console.log('You clicked the button.');
+ * }
+ * ```
+ */
+export const button = ui.button.bind(ui);
+/**
+ * Load a ui image. Any format supported by the editor is supported.
+ *
+ * @param filepath Path to the file.
+ * @returns Promise with the loaded UiImage
+ *
+ * @example
+ * In a draw function of a plugin, use as follows:
+ * ```ts
+ * this.thumbnail = null;
+ * loadUiImage("cache/plugins/my-plugin/downloads/thumbnail.png")
+ *     .then((img) => this.thumbnail = img);
+ * ```
+ *
+ * @see image()
+ */
+export function loadUiImage(filepath) {
+    // Wrapper around a GL::Texture. People will be tempted calling
+    // this in weird places, so better just throw it on the JobSystem
+    // for the MainThread and spread it over time.
+    return new Promise((resolve, reject) => {
+        ui.loadImage(filepath, (id) => {
+            if (id < 0) {
+                reject();
+                return;
+            }
+            resolve(new UiImage(id));
+        });
+    });
+}
+export function image(image, width, height) {
+    // Since ImGui expects GL::Texture, we load the image for the user
+    // from filepath. Avoids them pulling in pngjs and other mistakes
+    return ui.image(image._id, width, height);
+}
+/**
+ * Text input field.
+ *
+ * @usage
+ * s = ui.inputText("change this:", s) || s;
+ */
+export const inputText = ui.inputText.bind(ui);
+export function inputColor4(label, value) {
+    // We can in-place edit Float32Array, probably even number array
+    return false;
+}
+export const dummy = ui.dummy.bind(ui);
+export const sameLine = ui.sameLine.bind(ui);

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@wonderlandengine/editor-api",
+  "version": "1.2.0-dev.0",
+  "description": "Wonderland Engine's Editor API for plugins - very experimental.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/WonderlandEngine/api.git"
+  },
+  "keywords": [
+    "webxr",
+    "wonderland",
+    "components"
+  ],
+  "author": "Wonderland GmbH",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://discord.wonderlandengine.com/"
+  },
+  "homepage": "https://wonderlandengine.com/editor/plugins/",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "defaults": "npm run build && npm run doc && node scripts/generate-defaults.mjs ./doc.json",
+    "pretty": "prettier --config ./prettierrc.json --write ./src",
+    "doc": "typedoc --entryPoints ./src/index.ts --tsconfig tsconfig.json --json ./doc.json",
+    "json-diff": "npm run defaults && npx json-diff ../../src/WonderlandEditor/defaults.json defaults.json",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {},
+  "devDependencies": {
+    "@types/node": "^18.11.9",
+    "prettier": "^2.8.0",
+    "typedoc": "^0.23.21",
+    "typescript": "^4.9.3"
+  },
+  "files": [
+      "dist"
+  ]
+}