@shopware-ag/dive - npm Package Compare versions

Comparing version 1.16.1 to 1.16.2

build/dive.d.ts

@@ -144,2 +144,3 @@ import { ShadowMapType, ToneMapping, WebGLRenderer, Scene, Camera, PerspectiveCamera, Box3, Vector3Like, Texture, Object3D, Color, Mesh, ColorRepresentation, Intersection, Vector2, Raycaster, Vector3 } from 'three';
 interface SET_BACKGROUND {
+    DESCRIPTION: 'Set the background color of the scene.';
     PAYLOAD: {
@@ -152,2 +153,3 @@ color: string | number;
 interface RESET_CAMERA {
+    DESCRIPTION: 'Reset the camera to its initial position and rotation.';
     PAYLOAD: {
@@ -160,2 +162,3 @@ duration: number;
 interface SET_CAMERA_LAYER {
+    DESCRIPTION: 'Sets the camera layer to a certain layer.';
     PAYLOAD: {
@@ -168,2 +171,3 @@ layer: 'LIVE' | 'EDITOR';
 interface ZOOM_CAMERA {
+    DESCRIPTION: 'Zooms the camera in or out by a certain amount.';
     PAYLOAD: {
@@ -177,2 +181,3 @@ direction: 'IN' | 'OUT';
 interface SET_GIZMO_MODE {
+    DESCRIPTION: "Sets the gizmo's mode.";
     PAYLOAD: {
@@ -185,2 +190,3 @@ mode: 'translate' | 'rotate' | 'scale';
 interface SET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Sets the camera position and target.';
     PAYLOAD: {
@@ -194,2 +200,3 @@ position: Vector3Like;
 interface MOVE_CAMERA {
+    DESCRIPTION: 'Moves the camera to a new position and target.';
     PAYLOAD: {
@@ -209,2 +216,3 @@ position: Vector3Like;
 interface PLACE_ON_FLOOR {
+    DESCRIPTION: 'Places an object on the floor.';
     PAYLOAD: {
@@ -285,2 +293,3 @@ id: string;
 interface GET_ALL_OBJECTS {
+    readonly DESCRIPTION: 'Retrieves all objects in the scene.';
     PAYLOAD: Map<string, COMEntity>;
@@ -291,2 +300,3 @@ RETURN: Map<string, COMEntity>;
 interface GET_OBJECTS {
+    DESCRIPTION: 'Returns a list of objects of given IDs.';
     PAYLOAD: {
@@ -299,2 +309,3 @@ ids: string[];
 interface ADD_OBJECT {
+    DESCRIPTION: 'Adds an object to the scene.';
     PAYLOAD: COMEntity;
@@ -305,2 +316,3 @@ RETURN: boolean;
 interface DELETE_OBJECT {
+    DESCRIPTION: 'Deletes an object from the scene.';
     PAYLOAD: Partial<COMEntity> & {
@@ -313,2 +325,3 @@ id: string;
 interface UPDATE_OBJECT {
+    DESCRIPTION: 'Updates an existing object.';
     PAYLOAD: Partial<COMEntity> & {
@@ -321,2 +334,3 @@ id: string;
 interface MODEL_LOADED {
+    DESCRIPTION: 'Is triggered when a model is loaded.';
     PAYLOAD: {
@@ -329,2 +343,3 @@ id: string;
 interface UPDATE_SCENE {
+    DESCRIPTION: 'Updates global scene data.';
     PAYLOAD: {
@@ -341,2 +356,3 @@ name?: string;
 interface GENERATE_MEDIA {
+    DESCRIPTION: 'Generates a screenshot, stores it in a Blob and writes the URL into the payload.';
     PAYLOAD: ({
@@ -372,2 +388,3 @@ position: Vector3Like;
 interface GET_ALL_SCENE_DATA {
+    DESCRIPTION: 'Retrieves all current scene data.';
     PAYLOAD: object;
@@ -378,2 +395,3 @@ RETURN: SceneData;
 interface SELECT_OBJECT {
+    DESCRIPTION: 'Selects an existing object.';
     PAYLOAD: Partial<COMEntity> & {
@@ -386,2 +404,3 @@ id: string;
 interface DESELECT_OBJECT {
+    DESCRIPTION: 'Deselects an existing object.';
     PAYLOAD: Partial<COMEntity> & {
@@ -394,2 +413,3 @@ id: string;
 interface GET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Returns the current camera position and target.';
     PAYLOAD: object;
@@ -403,2 +423,3 @@ RETURN: {
 interface DROP_IT {
+    DESCRIPTION: 'Places an object on top of an underlying object or the floor.';
     PAYLOAD: {
@@ -411,2 +432,3 @@ id: string;
 interface SET_GIZMO_VISIBILITY {
+    DESCRIPTION: "Sets the gizmo's visibility.";
     PAYLOAD: boolean;
@@ -417,2 +439,3 @@ RETURN: boolean;
 interface COMPUTE_ENCOMPASSING_VIEW {
+    DESCRIPTION: 'Calculates the camera position and target to view the whole scene. (experimental)';
     PAYLOAD: object;
@@ -822,2 +845,3 @@ RETURN: {
 interface USE_TOOL {
+    DESCRIPTION: 'Activates a specific tool from the toolbox.';
     PAYLOAD: {
@@ -830,2 +854,3 @@ tool: ToolType;
 interface SET_PARENT {
+    DESCRIPTION: 'Attach an object to another object.';
     PAYLOAD: {
@@ -843,2 +868,3 @@ object: Partial<COMEntity> & {
 interface EXPORT_SCENE {
+    DESCRIPTION: 'Exports the current scene to a blob and returns the URL.';
     PAYLOAD: {
@@ -850,3 +876,3 @@ type: keyof DIVESceneFileType;
 
-type Actions = {
+interface Actions {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
@@ -878,3 +904,3 @@ GET_ALL_OBJECTS: GET_ALL_OBJECTS;
     EXPORT_SCENE: EXPORT_SCENE;
-};
+}
 
@@ -881,0 +907,0 @@ type EventListener<Action extends keyof Actions> = (payload: Actions[Action]['PAYLOAD']) => void;

package.json

 {
     "name": "@shopware-ag/dive",
-    "version": "1.16.1",
+    "version": "1.16.2",
     "description": "Shopware Spatial Framework",
@@ -52,2 +52,3 @@ "type": "module",
         "ts-node": "^10.9.2",
+        "tsc": "^2.0.4",
         "tsup": "^8.0.2",
@@ -58,11 +59,18 @@ "typescript": "^5.4.5",
     "scripts": {
-        "build": "tsup && yarn genmd",
-        "watch": "tsup --watch",
+        "build": "tsup",
+        "dev": "tsup --watch",
         "lint": "eslint",
-        "prettier-check": "prettier --check .",
-        "prettier-fix": "prettier --write .",
+        "lint:actions": "yarn lint:actions:transpile && yarn lint:actions:check && yarn lint:actions:cleanup",
+        "lint:actions:transpile": "yarn tsc --resolveJsonModule --esModuleInterop ci/lint/lint-actions.ts && mv ci/lint/lint-actions.js ci/lint/lint-actions.cjs",
+        "lint:actions:check": "yarn node ci/lint/lint-actions.cjs",
+        "lint:actions:cleanup": "node -e \"require('fs').unlinkSync('ci/lint/lint-actions.cjs')\"",
+        "prettier:check": "prettier --check .",
+        "prettier:fix": "prettier --write .",
         "unit": "jest",
         "coverage": "jest --coverage",
-        "genmd": "node ./scripts/genmd.js"
+        "generate-readme": "yarn generate-readme:transpile && yarn generate-readme:write && yarn generate-readme:cleanup",
+        "generate-readme:transpile": "yarn tsc --resolveJsonModule --esModuleInterop ci/readme/generate-readme.ts && mv ci/readme/generate-readme.js ci/readme/generate-readme.cjs",
+        "generate-readme:write": "node ci/readme/generate-readme.cjs",
+        "generate-readme:cleanup": "node -e \"require('fs').unlinkSync('ci/readme/generate-readme.cjs')\""
     }
 }

README.md

@@ -0,2 +1,10 @@
+<!--
 
+
+This file is automatically generated
+You can find the template in ci/readme/template/TEMPLATE_README.md
+
+
+-->
+
 <p align="center">
@@ -42,2 +50,6 @@ <img alt="DIVE logo" src="./assets/svg/dive.svg" style="width: 100%; height: auto; max-height: 500px;">
 
+# Formatter
+
+DIVE uses Prettier as a preconfigured formatter.
+
 #### Setup in Shopware
@@ -204,33 +216,215 @@
 
-| Action                                                                           | Description                                                                                        |
-| :------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |
-| [GET_ALL_SCENE_DATA](./src/com/actions/scene/getallscenedata.ts)                 | Return all scene data that is currently set                                                        |
-| [GET_ALL_OBJECTS](./src/com/actions/object/getallobjects.ts)                     | Return a map of all objects                                                                        |
-| [GET_OBJECTS](./src/com/actions/object/getobjects.ts)                            | Return an array of all objects with given ids                                                      |
-| [ADD_OBJECT](./src/com/actions/object/addobject.ts)                              | Add an object to the scene                                                                         |
-| [UPDATE_OBJECT](./src/com/actions/object/updateobject.ts)                        | Update an existing object                                                                          |
-| [DELETE_OBJECT](./src/com/actions/object/deleteobject.ts)                        | Delete an existing object                                                                          |
-| [SELECT_OBJECT](./src/com/actions/object/selectobject.ts)                        | Select an existing object in the scene                                                             |
-| [DESELECT_OBJECT](./src/com/actions/object/deselectobject.ts)                    | Deselect an existing object in the scene                                                           |
-| [SET_BACKGROUND](./src/com/actions/scene/setbackground.ts)                       | Set a background color                                                                             |
-| [DROP_IT](./src/com/actions/object/model/dropit.ts)                              | Places the model onto the next underlying object's bounding box                                    |
-| [PLACE_ON_FLOOR](./src/com/actions/object/model/placeonfloor.ts)                 | Places the model onto the floor (zero plane)                                                       |
-| [SET_CAMERA_TRANSFORM](./src/com/actions/camera/setcameratransform.ts)           | Set camera transformation (w/o animation, used to initially set up camera)                         |
-| [GET_CAMERA_TRANSFORM](./src/com/actions/camera/getcameratransform.ts)           | Return currenty camera transformation                                                              |
-| [MOVE_CAMERA](./src/com/actions/camera/movecamera.ts)                            | Move camera to a specific position or the position of a previously defined POV (with an animation) |
-| [RESET_CAMERA](./src/com/actions/camera/resetcamera.ts)                          | Reset camera to original position after MOVE_CAMERA was performed                                  |
-| [COMPUTE_ENCOMPASSING_VIEW](./src/com/actions/camera/computeencompassingview.ts) | Calculates the camera position and target to view the whole scene                                  |
-| [SET_CAMERA_LAYER](./src/com/actions/camera/setcameralayer.ts)                   | Set camera layer to switch between live view and editor view                                       |
-| [ZOOM_CAMERA](./src/com/actions/camera/zoomcamera.ts)                            | Zoom in or out                                                                                     |
-| [SET_GIZMO_MODE](./src/com/actions/toolbox/select/setgizmomode.ts)               | Set gizmo mode                                                                                     |
-| [SET_GIZMO_VISIBILITY](./src/com/actions/toolbox/select/setgizmovisibility.ts)   | Set gizmo visibility                                                                               |
-| [USE_TOOL](./src/com/actions/toolbox/usetool.ts)                                 | Use a specific tool                                                                                |
-| [MODEL_LOADED](./src/com/actions/object/model/modelloaded.ts)                    | Is performed when a model file is completely loaded                                                |
-| [UPDATE_SCENE](./src/com/actions/scene/updatescene.ts)                           | Update scene data                                                                                  |
-| [GENERATE_MEDIA](./src/com/actions/media/generatemedia.ts)                       | Generate a screenshot with the specified parameters                                                |
-| [SET_PARENT](./src/com/actions/object/setparent.ts)                              | Sets an objects parent                                                                             |
-| [EXPORT_SCENE](./src/com/actions/scene/exportscene.ts)                           | Exports a scene to a glb, saves it to a blob and returns the associated uri                        |
-
-# Formatter
-
-DIVE uses Prettier as a preconfigured formatter.
+<table>
+    <tr>
+        <th>Actions</th>
+        <th>Description</th>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> ADD_OBJECT </a>
+        </td>
+        <td>
+            Adds an object to the scene.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> COMPUTE_ENCOMPASSING_VIEW </a>
+        </td>
+        <td>
+            Calculates the camera position and target to view the whole scene. (experimental)
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> DELETE_OBJECT </a>
+        </td>
+        <td>
+            Deletes an object from the scene.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> DESELECT_OBJECT </a>
+        </td>
+        <td>
+            Deselects an existing object.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> DROP_IT </a>
+        </td>
+        <td>
+            Places an object on top of an underlying object or the floor.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> EXPORT_SCENE </a>
+        </td>
+        <td>
+            Exports the current scene to a blob and returns the URL.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> GENERATE_MEDIA </a>
+        </td>
+        <td>
+            Generates a screenshot, stores it in a Blob and writes the URL into the payload.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> GET_ALL_OBJECTS </a>
+        </td>
+        <td>
+            Retrieves all objects in the scene.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> GET_ALL_SCENE_DATA </a>
+        </td>
+        <td>
+            Retrieves all current scene data.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> GET_CAMERA_TRANSFORM </a>
+        </td>
+        <td>
+            Returns the current camera position and target.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> GET_OBJECTS </a>
+        </td>
+        <td>
+            Returns a list of objects of given IDs.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> MODEL_LOADED </a>
+        </td>
+        <td>
+            Is triggered when a model is loaded.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> MOVE_CAMERA </a>
+        </td>
+        <td>
+            Moves the camera to a new position and target.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> PLACE_ON_FLOOR </a>
+        </td>
+        <td>
+            Places an object on the floor.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> RESET_CAMERA </a>
+        </td>
+        <td>
+            Reset the camera to its initial position and rotation.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> SELECT_OBJECT </a>
+        </td>
+        <td>
+            Selects an existing object.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> SET_BACKGROUND </a>
+        </td>
+        <td>
+            Set the background color of the scene.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> SET_CAMERA_LAYER </a>
+        </td>
+        <td>
+            Sets the camera layer to a certain layer.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> SET_CAMERA_TRANSFORM </a>
+        </td>
+        <td>
+            Sets the camera position and target.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> SET_GIZMO_MODE </a>
+        </td>
+        <td>
+            Sets the gizmo's mode.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> SET_GIZMO_VISIBILITY </a>
+        </td>
+        <td>
+            Sets the gizmo's visibility.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> SET_PARENT </a>
+        </td>
+        <td>
+            Attach an object to another object.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> UPDATE_OBJECT </a>
+        </td>
+        <td>
+            Updates an existing object.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> UPDATE_SCENE </a>
+        </td>
+        <td>
+            Updates global scene data.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> USE_TOOL </a>
+        </td>
+        <td>
+            Activates a specific tool from the toolbox.
+        </td>
+    </tr>
+    <tr>
+        <td>
+            <a href=".undefined"> ZOOM_CAMERA </a>
+        </td>
+        <td>
+            Zooms the camera in or out by a certain amount.
+        </td>
+    </tr>
+</table>

src/com/actions/camera/computeencompassingview.ts

 import { Vector3Like } from 'three';
 
 export default interface COMPUTE_ENCOMPASSING_VIEW {
+    DESCRIPTION: 'Calculates the camera position and target to view the whole scene. (experimental)';
     PAYLOAD: object;
@@ -5,0 +6,0 @@ RETURN: {

src/com/actions/camera/getcameratransform.ts

 import { Vector3Like } from 'three';
 
 export default interface GET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Returns the current camera position and target.';
     PAYLOAD: object;
@@ -5,0 +6,0 @@ RETURN: {

src/com/actions/camera/movecamera.ts

 import { Vector3Like } from 'three';
 
 export default interface MOVE_CAMERA {
+    DESCRIPTION: 'Moves the camera to a new position and target.';
     PAYLOAD:
@@ -5,0 +6,0 @@ | {

src/com/actions/camera/resetcamera.ts

 export default interface RESET_CAMERA {
+    DESCRIPTION: 'Reset the camera to its initial position and rotation.';
     PAYLOAD: { duration: number };
     RETURN: boolean;
 }

src/com/actions/camera/setcameralayer.ts

 export default interface SET_CAMERA_LAYER {
+    DESCRIPTION: 'Sets the camera layer to a certain layer.';
     PAYLOAD: { layer: 'LIVE' | 'EDITOR' };
     RETURN: boolean;
 }

src/com/actions/camera/setcameratransform.ts

 import { Vector3Like } from 'three';
 
 export default interface SET_CAMERA_TRANSFORM {
+    DESCRIPTION: 'Sets the camera position and target.';
     PAYLOAD: {
@@ -5,0 +6,0 @@ position: Vector3Like;

src/com/actions/camera/zoomcamera.ts

 export default interface ZOOM_CAMERA {
+    DESCRIPTION: 'Zooms the camera in or out by a certain amount.';
     PAYLOAD: { direction: 'IN' | 'OUT'; by: number };
     RETURN: boolean;
 }

src/com/actions/index.ts

@@ -28,3 +28,3 @@ import SET_BACKGROUND from './scene/setbackground.ts';
 
-export type Actions = {
+export interface Actions {
     GET_ALL_SCENE_DATA: GET_ALL_SCENE_DATA;
@@ -56,2 +56,2 @@ GET_ALL_OBJECTS: GET_ALL_OBJECTS;
     EXPORT_SCENE: EXPORT_SCENE;
-};
+}

src/com/actions/media/generatemedia.ts

 import { Vector3Like } from 'three';
 
 export default interface GENERATE_MEDIA {
+    DESCRIPTION: 'Generates a screenshot, stores it in a Blob and writes the URL into the payload.';
     PAYLOAD: (
@@ -5,0 +6,0 @@ | {

src/com/actions/object/addobject.ts

 import { COMEntity } from '../../types';
 
 export default interface ADD_OBJECT {
+    DESCRIPTION: 'Adds an object to the scene.';
     PAYLOAD: COMEntity;
     RETURN: boolean;
 }

src/com/actions/object/deleteobject.ts

 import { COMEntity } from '../../types';
 
 export default interface DELETE_OBJECT {
+    DESCRIPTION: 'Deletes an object from the scene.';
     PAYLOAD: Partial<COMEntity> & { id: string };
     RETURN: boolean;
 }

src/com/actions/object/deselectobject.ts

 import { COMEntity } from '../../types';
 
 export default interface DESELECT_OBJECT {
+    DESCRIPTION: 'Deselects an existing object.';
     PAYLOAD: Partial<COMEntity> & { id: string };
     RETURN: boolean;
 }

src/com/actions/object/getallobjects.ts

 import { COMEntity } from '../../types';
 
 export default interface GET_ALL_OBJECTS {
+    readonly DESCRIPTION: 'Retrieves all objects in the scene.';
     PAYLOAD: Map<string, COMEntity>;
     RETURN: Map<string, COMEntity>;
 }

src/com/actions/object/getobjects.ts

 import { COMEntity } from '../../types';
 
 export default interface GET_OBJECTS {
+    DESCRIPTION: 'Returns a list of objects of given IDs.';
     PAYLOAD: { ids: string[] };
     RETURN: COMEntity[];
 }

src/com/actions/object/model/dropit.ts

 export default interface DROP_IT {
+    DESCRIPTION: 'Places an object on top of an underlying object or the floor.';
     PAYLOAD: { id: string };
     RETURN: boolean;
 }

src/com/actions/object/model/modelloaded.ts

 export default interface MODEL_LOADED {
+    DESCRIPTION: 'Is triggered when a model is loaded.';
     PAYLOAD: { id: string };
     RETURN: boolean;
 }

src/com/actions/object/model/placeonfloor.ts

 export default interface PLACE_ON_FLOOR {
+    DESCRIPTION: 'Places an object on the floor.';
     PAYLOAD: { id: string };
     RETURN: boolean;
 }

src/com/actions/object/selectobject.ts

 import { COMEntity } from '../../types';
 
 export default interface SELECT_OBJECT {
+    DESCRIPTION: 'Selects an existing object.';
     PAYLOAD: Partial<COMEntity> & { id: string };
     RETURN: boolean;
 }

src/com/actions/object/setparent.ts

 import { type COMEntity } from '../../types';
 
 export default interface SET_PARENT {
+    DESCRIPTION: 'Attach an object to another object.';
     PAYLOAD: {
@@ -5,0 +6,0 @@ object: Partial<COMEntity> & { id: string };

src/com/actions/object/updateobject.ts

 import { COMEntity } from '../../types';
 
 export default interface UPDATE_OBJECT {
+    DESCRIPTION: 'Updates an existing object.';
     PAYLOAD: Partial<COMEntity> & { id: string };
     RETURN: boolean;
 }

src/com/actions/scene/exportscene.ts

 import { type DIVESceneFileType } from '../../../types';
 
 export default interface EXPORT_SCENE {
+    DESCRIPTION: 'Exports the current scene to a blob and returns the URL.';
     PAYLOAD: { type: keyof DIVESceneFileType };
     RETURN: Promise<string | null>;
 }

src/com/actions/scene/getallscenedata.ts

@@ -27,4 +27,5 @@ import { Vector3Like } from 'three';
 export default interface GET_ALL_SCENE_DATA {
+    DESCRIPTION: 'Retrieves all current scene data.';
     PAYLOAD: object;
     RETURN: SceneData;
 }

src/com/actions/scene/setbackground.ts

 export default interface SET_BACKGROUND {
+    DESCRIPTION: 'Set the background color of the scene.';
     PAYLOAD: { color: string | number };
     RETURN: boolean;
 }

src/com/actions/scene/updatescene.ts

 export default interface UPDATE_SCENE {
+    DESCRIPTION: 'Updates global scene data.';
     PAYLOAD: {
@@ -3,0 +4,0 @@ name?: string;

src/com/actions/toolbox/select/setgizmomode.ts

 export default interface SET_GIZMO_MODE {
+    DESCRIPTION: "Sets the gizmo's mode.";
     PAYLOAD: { mode: 'translate' | 'rotate' | 'scale' };
     RETURN: boolean;
 }

src/com/actions/toolbox/transform/setgizmovisible.ts

 export default interface SET_GIZMO_VISIBILITY {
+    DESCRIPTION: "Sets the gizmo's visibility.";
     PAYLOAD: boolean;
     RETURN: boolean;
 }

src/com/actions/toolbox/usetool.ts

 import { type ToolType } from '../../../toolbox/Toolbox';
 
 export default interface USE_TOOL {
+    DESCRIPTION: 'Activates a specific tool from the toolbox.';
     PAYLOAD: { tool: ToolType };
     RETURN: boolean;
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1057376

increased by0.89%

Lines of code

18722

increased by0.36%

Number of lines in readme file

429

increased by82.55%

Worsened metrics

Dev dependency count

18

increased by5.88%

No dependency changes