@kingsy/viewer 2.25.7

package/dist/modules/tree/WorldTree.d.ts

@@ -0,0 +1,52 @@
+import TreeModel, { type Model } from 'tree-model';
+import { NodeRenderView } from './NodeRenderView.js';
+import { RenderTree } from './RenderTree.js';
+export type TreeNode = TreeModel.Node<NodeData>;
+export type SearchPredicate = (node: TreeNode) => boolean;
+export interface NodeData {
+    id: string;
+    raw: {
+        [prop: string]: any;
+    };
+    children: TreeNode[];
+    atomic: boolean;
+    nestedNodes?: TreeNode[];
+    subtreeId?: number;
+    renderView?: NodeRenderView | null;
+    instanced?: boolean;
+    color?: number;
+}
+export declare class WorldTree {
+    private renderTreeInstances;
+    private nodeMaps;
+    private readonly supressWarnings;
+    static readonly ROOT_ID = "ROOT";
+    private subtreeId;
+    constructor();
+    /** The root render tree will always be non-null because it will always contain the root */
+    getRenderTree(): RenderTree;
+    getRenderTree(subtreeId: string): RenderTree | null;
+    private tree;
+    _root: TreeNode;
+    get root(): TreeNode;
+    private get nextSubtreeId();
+    get nodeCount(): number;
+    isRoot(node: TreeNode): boolean;
+    isSubtreeRoot(node: TreeNode): boolean;
+    parse(model: Model<NodeData>): TreeNode;
+    addSubtree(node: TreeNode): void;
+    addNode(node: TreeNode, parent: TreeNode | null): void;
+    removeNode(node: TreeNode, removeChildren: boolean): void;
+    findAll(predicate: SearchPredicate, node?: TreeNode): Array<TreeNode>;
+    findId(id: string, subtreeId?: number): TreeNode[] | null;
+    /** TODO: Would rather not have this */
+    findSubtree(id: string): TreeNode | null;
+    getAncestors(node: TreeNode): Array<TreeNode>;
+    getInstances(subtreeId: string): {
+        [id: string]: Record<string, TreeNode>;
+    };
+    /** TO DO: We might want to add boolean as return type here too */
+    walk(predicate: SearchPredicate, node?: TreeNode): void;
+    walkAsync(predicate: SearchPredicate, node?: TreeNode): Promise<boolean>;
+    purge(subtreeId?: string): void;
+}

package/dist/modules/utils/AngleDamper.d.ts

@@ -0,0 +1,18 @@
+export declare const SETTLING_TIME: number;
+export declare const DECAY_MILLISECONDS = 50;
+/**
+ * The Damper class is a generic second-order critically damped system that does
+ * one linear step of the desired length of time. The only parameter is
+ * DECAY_MILLISECONDS. This common parameter makes all states converge at the
+ * same rate regardless of scale. xNormalization is a number to provide the
+ * rough scale of x, such that NIL_SPEED clamping also happens at roughly the
+ * same convergence for all states.
+ */
+export declare class AngleDamper {
+    private velocity;
+    private naturalFrequency;
+    constructor(decayMilliseconds?: number);
+    setDecayTime(decayMilliseconds: number): void;
+    protected wrapAngle(angle: number): number;
+    update(x: number, xGoal: number, timeStepMilliseconds: number, xNormalization: number): number;
+}

package/dist/modules/utils/Damper.d.ts

@@ -0,0 +1,17 @@
+export declare const SETTLING_TIME: number;
+export declare const DECAY_MILLISECONDS = 50;
+/**
+ * The Damper class is a generic second-order critically damped system that does
+ * one linear step of the desired length of time. The only parameter is
+ * DECAY_MILLISECONDS. This common parameter makes all states converge at the
+ * same rate regardless of scale. xNormalization is a number to provide the
+ * rough scale of x, such that NIL_SPEED clamping also happens at roughly the
+ * same convergence for all states.
+ */
+export declare class Damper {
+    private velocity;
+    private naturalFrequency;
+    constructor(decayMilliseconds?: number);
+    setDecayTime(decayMilliseconds: number): void;
+    update(x: number, xGoal: number, timeStepMilliseconds: number, xNormalization: number): number;
+}

package/dist/modules/utils/Logger.d.ts

@@ -0,0 +1,2 @@
+declare const Logger: JsLogger.GlobalLogger;
+export default Logger;

package/dist/type-augmentations/three-extensions.d.ts

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

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "@kingsy/viewer",
+  "version": "2.25.7",
+  "description": "A 3d viewer for KingSy, based on threejs.",
+  "homepage": "https://kingsy.systems",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kingsysystems/kingsy-server.git",
+    "directory": "packages/viewer"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "type": "module",
+  "sourceType": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./dist/assets/*": "./dist/assets/*",
+    "./assets/*": "./dist/assets/*"
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "NODE_ENV=production rollup --config",
+    "build:dev": "rollup --config",
+    "dev": "rollup --config --watch",
+    "prepack": "yarn build",
+    "lint:js": "eslint .",
+    "lint:tsc": "tsc --noEmit",
+    "lint": "yarn lint:js && yarn lint:tsc",
+    "lint:ci": "yarn lint:tsc",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:run": "vitest run"
+  },
+  "author": "AEC Systems",
+  "license": "Apache-2.0",
+  "keywords": [
+    "kingsy",
+    "aec",
+    "3d",
+    "3d viewer",
+    "threejs"
+  ],
+  "dependencies": {
+    "@kingsy/objectloader2": "^2.25.7",
+    "@kingsy/shared": "^2.25.7",
+    "@types/flat": "^5.0.2",
+    "earcut": "3.0.1",
+    "flat": "^5.0.2",
+    "js-logger": "1.6.1",
+    "lodash-es": "^4.17.21",
+    "polylabel": "2.0.1",
+    "string-to-color": "^2.2.2",
+    "three": "^0.140.0",
+    "three-mesh-bvh": "0.5.17",
+    "tree-model": "1.0.7",
+    "troika-three-text": "0.47.2",
+    "type-fest": "^4.15.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.18.2",
+    "@babel/eslint-parser": "^7.18.2",
+    "@babel/preset-env": "^7.20.2",
+    "@rollup/plugin-babel": "^5.3.1",
+    "@rollup/plugin-image": "^3.0.2",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/babel__core": "^7.20.1",
+    "@types/earcut": "3.0.0",
+    "@types/lodash-es": "4.17.12",
+    "@types/polylabel": "1.1.3",
+    "@types/three": "^0.140.0",
+    "@typescript-eslint/eslint-plugin": "^7.12.0",
+    "@typescript-eslint/parser": "^7.12.0",
+    "@vitest/ui": "^1.4.0",
+    "core-js": "^3.21.1",
+    "eslint": "^9.4.0",
+    "eslint-config-prettier": "^9.1.0",
+    "jsdom": "^24.0.0",
+    "prettier": "^2.5.1",
+    "regenerator-runtime": "^0.13.7",
+    "rollup": "^2.70.1",
+    "rollup-plugin-delete": "^2.0.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "typescript": "^4.5.4",
+    "vitest": "^1.4.0"
+  },
+  "gitHead": "5627e490f9a3ecadf19cc4686ad15f344d9ad2d3"
+}

package/readme.md

@@ -0,0 +1,30 @@
+# The KingSy Viewer
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/KingSySystems?style=social)](https://twitter.com/KingSySystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fkingsy.community&style=flat-square&logo=discourse&logoColor=white)](https://kingsy.community) [![website](https://img.shields.io/badge/https://-kingsy.systems-royalblue?style=flat-square)](https://kingsy.systems) [![docs](https://img.shields.io/badge/docs-kingsy.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://kingsy.guide/dev/) [![npm version](https://badge.fury.io/js/%40kingsy%2Fviewer.svg)](https://badge.fury.io/js/%40kingsy%2Fviewer)
+
+## Documentation
+
+Complete documentation [here](https://kingsy.guide/viewer/)
+Migration guide [here](https://kingsy.notion.site/Migration-Guide-b2b4118d34b544e9b9a848714348e7c7)
+
+## Examples
+
+You can find readily available examples in the documentation [here](https://kingsy.guide/viewer/basic-example.html)
+
+## Development
+
+- run `yarn` in the repo root to install and link all required dependencies.
+- run `yarn dev` in the viewer package (here) to start a dev build with automatic code refresing of the viewer code.
+- run `yarn dev` in the viewer-sandbox package to start the viewer sandbox.
+
+## Feedback
+
+We would love to hear your feedback in [this forum thread](https://kingsy.community/t/seeking-feedback-on-the-new-viewer-api-structure/7231).
+
+## Community
+
+If in trouble, the KingSy Community hangs out on [the forum](https://kingsy.community). Do join and introduce yourself! We're happy to help.
+
+## License
+
+Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@kingsy.systems).