@babylonjs/inspector 8.27.2 → 8.28.1-preview

package/lib/index.d.ts

@@ -0,0 +1,193 @@
+import { IInspectorOptions } from '@babylonjs/core/Debug/debugLayer.js';
+import { Scene } from '@babylonjs/core/scene.js';
+import { IDisposable } from '@babylonjs/core/index.js';
+
+declare const Contract: unique symbol;
+/**
+ * This interface must be implemented by all service contracts.
+ */
+interface IService<ContractIdentity extends symbol> {
+    /**
+     * @internal
+     */
+    readonly [Contract]?: ContractIdentity;
+}
+type ExtractContractIdentity<ServiceContract extends IService<symbol>> = ServiceContract extends IService<infer ContractIdentity> ? ContractIdentity : never;
+type ExtractContractIdentities<ServiceContracts extends IService<symbol>[]> = {
+    [Index in keyof ServiceContracts]: ExtractContractIdentity<ServiceContracts[Index]>;
+};
+type UnionToIntersection<Union> = (Union extends any ? (k: Union) => void : never) extends (k: infer Intersection) => void ? Intersection : never;
+type MaybePromise<T> = T | Promise<T>;
+/**
+ * A factory function responsible for creating a service instance.
+ * Consumed services are passed as arguments to the factory function.
+ * The returned value must implement all produced services, and may IDisposable.
+ * If not services are produced, the returned value may implement IDisposable, otherwise it may return void.
+ */
+type ServiceFactory<Produces extends IService<symbol>[], Consumes extends IService<symbol>[]> = (...dependencies: [...Consumes, abortSignal?: AbortSignal]) => MaybePromise<Produces extends [] ? Partial<IDisposable> | void : Partial<IDisposable> & UnionToIntersection<Produces[number]>>;
+/**
+ * Defines a service, which is a logical unit that consumes other services (dependencies), and optionally produces services that can be consumed by other services (dependents).
+ */
+type ServiceDefinition<Produces extends IService<symbol>[] = [], Consumes extends IService<symbol>[] = []> = {
+    /**
+     * A human readable name for the service to help with debugging.
+     */
+    friendlyName: string;
+    /**
+     * A function that instantiates the service.
+     */
+    factory: ServiceFactory<Produces, Consumes>;
+} & (Produces extends [] ? {
+    /**
+     * An empty list or undefined, since the type specification has indicated no contracts are produced.
+     */
+    produces?: [];
+} : {
+    /**
+     * The list of contract identities that this service produces for consumption by other services.
+     */
+    produces: ExtractContractIdentities<Produces>;
+}) & (Consumes extends [] ? {
+    /**
+     * An empty list or undefined, since the type specification has indicated that no other services are consumed.
+     */
+    consumes?: [];
+} : {
+    /**
+     * The list of contract identities of other services that this service consumes.
+     */
+    consumes: ExtractContractIdentities<Consumes>;
+});
+
+type WeaklyTypedServiceDefinition = Omit<ServiceDefinition<IService<symbol>[] | [], IService<symbol>[] | []>, "factory"> & {
+    /**
+     * A factory function responsible for creating a service instance.
+     */
+    factory: (...args: any) => ReturnType<ServiceDefinition<IService<symbol>[] | [], IService<symbol>[] | []>["factory"]>;
+};
+
+type ExtensionMetadata = {
+    /**
+     * The name of the extension.
+     */
+    readonly name: string;
+    /**
+     * The description of the extension.
+     */
+    readonly description: string;
+    /**
+     * The keywords of the extension.
+     */
+    readonly keywords: readonly string[];
+};
+type ExtensionModule = {
+    /**
+     * The default export of the module (e.g. export default).
+     */
+    default: {
+        /**
+         * The services that are included with the extension.
+         */
+        serviceDefinitions?: readonly WeaklyTypedServiceDefinition[];
+    };
+};
+/**
+ * Represents a query to fetch subset ranges of extension metadata from a feed.
+ */
+interface IExtensionMetadataQuery {
+    /**
+     * The total number of extensions that satisfy the query.
+     */
+    readonly totalCount: number;
+    /**
+     * Fetches a range of extension metadata from the feed.
+     * @param index The index of the first extension to fetch.
+     * @param count The number of extensions to fetch.
+     * @returns A promise that resolves to the extension metadata.
+     */
+    getExtensionMetadataAsync(index: number, count: number): Promise<readonly ExtensionMetadata[]>;
+}
+/**
+ * Represents a feed/source of extensions.
+ */
+interface IExtensionFeed {
+    /**
+     * The name of the feed.
+     */
+    readonly name: string;
+    /**
+     * Creates an extension metadata query given a filter.
+     * @param filter The filter to apply to the query.
+     * @returns A promise that resolves to the extension metadata query.
+     */
+    queryExtensionsAsync(filter?: string): Promise<IExtensionMetadataQuery>;
+    /**
+     * Gets the extension module for the specified extension.
+     * @param name The name of the extension.
+     * @returns A promise that resolves to the extension module.
+     */
+    getExtensionModuleAsync(name: string): Promise<ExtensionModule | undefined>;
+}
+
+type ToolbarMode = "full" | "compact";
+/**
+ * Options for configuring the shell service.
+ */
+type ShellServiceOptions = {
+    /**
+     * The default width of the left side pane.
+     */
+    leftPaneDefaultWidth?: number;
+    /**
+     * The minimum width of the left side pane.
+     */
+    leftPaneMinWidth?: number;
+    /**
+     * The default width of the right side pane.
+     */
+    rightPaneDefaultWidth?: number;
+    /**
+     * The minimum width of the right side pane.
+     */
+    rightPaneMinWidth?: number;
+    /**
+     * The mode of the toolbars.
+     * Can be either "full" (default) or "compact".
+     * In "full" mode, toolbars are displayed above and below the side panes.
+     * In "compact" mode, toolbars are displayed at the top and bottom of the left and right side panes.
+     */
+    toolbarMode?: ToolbarMode;
+};
+
+type ModularToolOptions = {
+    /**
+     * The container element where the tool will be rendered.
+     */
+    containerElement: HTMLElement;
+    /**
+     * The service definitions to be registered with the tool.
+     */
+    serviceDefinitions: readonly WeaklyTypedServiceDefinition[];
+    /**
+     * Whether the tool should allow user selection of the theme (e.g. dark/light/system).
+     */
+    isThemeable?: boolean;
+    /**
+     * The extension feeds that provide optional extensions the user can install.
+     */
+    extensionFeeds?: readonly IExtensionFeed[];
+} & ShellServiceOptions;
+
+type InspectorV2Options = Pick<ModularToolOptions, "serviceDefinitions" | "isThemeable"> & {
+    isExtensible?: boolean;
+};
+declare function IsInspectorVisible(): boolean;
+declare function ShowInspector(scene: Scene, options?: Partial<IInspectorOptions & InspectorV2Options>): void;
+declare function HideInspector(): void;
+declare class Inspector {
+    static get IsVisible(): boolean;
+    static Show(scene: Scene, userOptions: Partial<IInspectorOptions>): void;
+    static Hide(): void;
+}
+
+export { HideInspector, Inspector, IsInspectorVisible, ShowInspector };

package/lib/index.js

@@ -0,0 +1,102 @@
+export { H as HideInspector, e as Inspector, I as IsInspectorVisible, d as ShowInspector } from './index-BTnAB6ls.js';
+import 'react/jsx-runtime';
+import '@fluentui/react-components';
+import '@babylonjs/core/Engines/engineStore.js';
+import '@babylonjs/core/Misc/observable.js';
+import 'react';
+import '@fluentui/react-icons';
+import 'react-dom/client';
+import 'usehooks-ts';
+import '@babylonjs/core/Misc/logger.js';
+import '@babylonjs/core/Misc/deferred.js';
+import '@babylonjs/core/Misc/asyncLock.js';
+import '@fluentui/react-motion-components-preview';
+import '@babylonjs/core/FrameGraph/frameGraphUtils.js';
+import '@babylonjs/core/Gizmos/cameraGizmo.js';
+import '@babylonjs/core/Gizmos/lightGizmo.js';
+import '@babylonjs/core/Rendering/utilityLayerRenderer.js';
+import '@babylonjs/core/Bones/bone.js';
+import '@babylonjs/core/Cameras/camera.js';
+import '@babylonjs/core/Gizmos/gizmoManager.js';
+import '@babylonjs/core/Lights/light.js';
+import '@babylonjs/core/Meshes/abstractMesh.js';
+import '@babylonjs/core/node.js';
+import '@babylonjs/core/Maths/math.color.js';
+import '@babylonjs/core/Maths/math.vector.js';
+import '@babylonjs/addons/msdfText/fontAsset.js';
+import '@babylonjs/addons/msdfText/textRenderer.js';
+import '@babylonjs/core/Debug/physicsViewer.js';
+import '@babylonjs/core/Materials/Textures/texture.js';
+import '@babylonjs/core/Materials/materialFlags.js';
+import '@babylonjs/core/Materials/standardMaterial.js';
+import '@babylonjs/core/Meshes/Builders/groundBuilder.js';
+import '@babylonjs/core/Misc/tools.js';
+import '@babylonjs/materials/grid/gridMaterial.js';
+import '@babylonjs/core/Misc/typeStore.js';
+import '@babylonjs/core/Animations/animationGroup.js';
+import '@babylonjs/core/Animations/animationPropertiesOverride.js';
+import '@babylonjs/core/Cameras/arcRotateCamera.js';
+import '@babylonjs/core/Cameras/followCamera.js';
+import '@babylonjs/core/Cameras/freeCamera.js';
+import '@babylonjs/core/Cameras/targetCamera.js';
+import '@babylonjs/core/scene.js';
+import '@babylonjs/core/FrameGraph/frameGraph.js';
+import '@babylonjs/core/Lights/directionalLight.js';
+import '@babylonjs/core/Lights/hemisphericLight.js';
+import '@babylonjs/core/Lights/pointLight.js';
+import '@babylonjs/core/Lights/rectAreaLight.js';
+import '@babylonjs/core/Lights/shadowLight.js';
+import '@babylonjs/core/Lights/spotLight.js';
+import '@babylonjs/core/Lights/Shadows/cascadedShadowGenerator.js';
+import '@babylonjs/core/Lights/Shadows/shadowGenerator.js';
+import '@babylonjs/core/Lights/Shadows/shadowGeneratorSceneComponent.js';
+import '@babylonjs/core/Materials/material.js';
+import '@babylonjs/core/Materials/multiMaterial.js';
+import '@babylonjs/core/Materials/PBR/pbrBaseMaterial.js';
+import '@babylonjs/core/Materials/PBR/pbrBaseSimpleMaterial.js';
+import '@babylonjs/core/Materials/PBR/pbrMaterial.js';
+import '@babylonjs/materials/sky/skyMaterial.js';
+import '@babylonjs/core/Engines/engine.js';
+import '@babylonjs/core/Engines/constants.js';
+import '@babylonjs/core/Particles/particleSystem.js';
+import '@babylonjs/core/Misc/fileTools.js';
+import '@babylonjs/core/Meshes/mesh.js';
+import '@babylonjs/core/Debug/skeletonViewer.js';
+import '@babylonjs/core/Meshes/buffer.js';
+import '@babylonjs/core/Meshes/Builders/linesBuilder.js';
+import '@babylonjs/core/Meshes/instancedMesh.js';
+import '@babylonjs/core/Rendering/renderingManager.js';
+import '@babylonjs/core/Rendering/edgesRenderer.js';
+import '@babylonjs/core/Rendering/outlineRenderer.js';
+import '@babylonjs/core/Misc/gradients.js';
+import '@babylonjs/core/Materials/Node/Blocks/gradientBlock.js';
+import '@babylonjs/core/Particles/attractor.js';
+import '@babylonjs/core/Meshes/Builders/sphereBuilder.js';
+import '@babylonjs/core/Meshes/transformNode.js';
+import '@babylonjs/core/Physics/v2/IPhysicsEnginePlugin.js';
+import '@babylonjs/core/Physics/v2/physicsEngineComponent.js';
+import '@babylonjs/core/PostProcesses/postProcess.js';
+import '@babylonjs/core/Materials/Textures/cubeTexture.js';
+import '@babylonjs/core/Materials/imageProcessingConfiguration.js';
+import '@babylonjs/core/Bones/skeleton.js';
+import '@babylonjs/core/Sprites/sprite.js';
+import '@babylonjs/core/Materials/Textures/baseTexture.js';
+import '@babylonjs/core/Materials/Textures/multiRenderTarget.js';
+import '@babylonjs/core/Materials/Textures/renderTargetTexture.js';
+import '@babylonjs/core/Materials/Textures/thinTexture.js';
+import '@fluentui-contrib/react-virtualizer';
+import '@babylonjs/core/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent.js';
+import '@babylonjs/core/Sprites/spriteSceneComponent.js';
+import '@babylonjs/core/Materials/Textures/dynamicTexture.js';
+import '@babylonjs/core/Misc/dataStorage.js';
+import '@babylonjs/core/Instrumentation/engineInstrumentation.js';
+import '@babylonjs/core/Instrumentation/sceneInstrumentation.js';
+import '@babylonjs/core/Engines/AbstractEngine/abstractEngine.timeQuery.js';
+import '@babylonjs/core/Engines/Extensions/engine.query.js';
+import '@babylonjs/core/Engines/WebGPU/Extensions/engine.query.js';
+import '@babylonjs/core/Misc/PerformanceViewer/performanceViewerCollectionStrategies.js';
+import '@babylonjs/core/Misc/pressureObserverWrapper.js';
+import '@babylonjs/core/Engines/abstractEngine.js';
+import '@babylonjs/core/Events/pointerEvents.js';
+import '@babylonjs/addons/atmosphere/atmosphere.js';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/package.json

@@ -1,59 +1,43 @@
 {
     "name": "@babylonjs/inspector",
-    "version": "8.27.2",
-    "module": "dist/babylon.inspector.bundle.js",
-    "main": "dist/babylon.inspector.bundle.js",
-    "esnext": "dist/babylon.inspector.bundle.js",
-    "typings": "dist/babylon.inspector.module.d.ts",
+    "version": "8.28.1-preview",
+    "type": "module",
+    "main": "lib/index.js",
+    "module": "lib/index.js",
+    "esnext": "lib/index.js",
+    "types": "lib/index.d.ts",
     "files": [
-        "dist/**/*.*",
+        "lib/**/*.js",
+        "lib/**/*.d.ts",
+        "lib/**/*.map",
         "readme.md",
         "license.md"
     ],
-    "scripts": {
-        "build": "npm run clean && npm run build:prod && npm run build:declaration",
-        "build:dev": "webpack --env development",
-        "build:prod": "webpack --env production",
-        "build:declaration": "build-tools -c pud --config ./config.json",
-        "clean": "rimraf dist"
-    },
-    "dependencies": {
-        "@fortawesome/fontawesome-svg-core": "^6.1.0",
-        "@fortawesome/free-regular-svg-icons": "^6.0.0",
-        "@fortawesome/free-solid-svg-icons": "^6.0.0"
-    },
     "peerDependencies": {
         "@babylonjs/addons": "^8.0.0",
         "@babylonjs/core": "^8.0.0",
         "@babylonjs/gui": "^8.0.0",
-        "@babylonjs/gui-editor": "^8.0.0",
         "@babylonjs/loaders": "^8.0.0",
         "@babylonjs/materials": "^8.0.0",
         "@babylonjs/serializers": "^8.0.0",
-        "@types/react": ">=16.7.3",
-        "@types/react-dom": ">=16.0.9"
-    },
-    "devDependencies": {
-        "@babylonjs/addons": "^8.27.2",
-        "@babylonjs/core": "^8.27.2",
-        "@babylonjs/gui": "^8.27.2",
-        "@babylonjs/gui-editor": "^8.27.2",
-        "@babylonjs/loaders": "^8.27.2",
-        "@babylonjs/materials": "^8.27.2",
-        "@babylonjs/serializers": "^8.27.2",
-        "@lts/gui": "1.0.0",
+        "@fluentui-contrib/react-virtualizer": "^0.1.0",
+        "@fluentui/react-components": "^9.62.0",
+        "@fluentui/react-icons": "^2.0.271",
         "react": "^18.2.0",
-        "react-dom": "^18.2.0"
+        "react-dom": "^18.2.0",
+        "usehooks-ts": "^3.1.1"
     },
     "keywords": [
         "3D",
         "javascript",
         "html5",
         "webgl",
-        "babylon.js"
+        "babylon.js",
+        "inspector",
+        "diagnostic",
+        "debug"
     ],
     "license": "Apache-2.0",
-    "sideEffects": true,
     "homepage": "https://www.babylonjs.com",
     "repository": {
         "type": "git",
@@ -62,4 +46,4 @@
     "bugs": {
         "url": "https://github.com/BabylonJS/Babylon.js/issues"
     }
-}
+}

package/readme.md

@@ -1,26 +1,23 @@
-# Babylon.js inspector module
+# BabylonJS Inspector
 
-For usage documentation please visit https://doc.babylonjs.com/how_to/debug_layer.
+The Babylon Inspector is a diagnostic tool that makes it possible to view and edit the scene graph, properties of entities within the scene, and more.
 
-# Installation instructions
+Documentation and samples coming soon!
 
-To install using npm :
+## Installation
 
-```shell
-npm install @babylonjs/core @babylonjs/inspector
-```
-
-# How to use
-
-Afterwards it can be imported to your project using:
+Install the package using npm:
 
-```javascript
-import "@babylonjs/core/Debug/debugLayer";
-import "@babylonjs/inspector";
+```bash
+npm install @babylonjs/inspector@preview
 ```
 
-The first line will ensure you can access the property debugLayer of the scene while the second will ensure the inspector can be used within your scene.
+The simplest way to use the `Inspector` is to call the `ShowInspector` function, passing in your scene:
 
-This is a great example where code splitting or conditional loading could be used to ensure you are not delivering the inspector if not part of your final app.
+```ts
+import { ShowInspector } from "@babylonjs/inspector";
 
-For more information you can have a look at our [ES6 dedicated documentation](https://doc.babylonjs.com/features/es6_support).
+// Your code that sets up a Babylon.js scene
+
+ShowInspector(scene);
+```