@combeenation/3d-viewer 5.1.2 → 5.2.0-alpha1

package/package.json

@@ -1,88 +1,76 @@
-{
-  "name": "@combeenation/3d-viewer",
-  "description": "Combeenation 3D Viewer",
-  "version": "5.1.2",
-  "homepage": "https://github.com/Combeenation/3d-viewer#readme",
-  "keywords": [],
-  "author": "",
-  "license": "Apache 2.0",
-  "contributors": [],
-  "main": "dist/lib-cjs/index.js",
-  "module": "dist/lib-cjs/index.js",
-  "typings": "dist/lib-cjs/index.d.ts",
-  "directories": {
-    "doc": "docs"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Combeenation/3d-viewer.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Combeenation/3d-viewer/issues"
-  },
-  "scripts": {
-    "dev": "cross-env NODE_ENV='dev' webpack-dev-server --config build/webpack.conf.js --progress --colors --debug --hot",
-    "dist-full": "cross-env NODE_ENV='production' webpack --config build/webpack.conf.js --progress --colors && npm run replace-version",
-    "dist-cjs": "tsc --project src/commonjs.tsconfig.json && npm run replace-version",
-    "dist-es6": "tsc --project src/es6.tsconfig.json && npm run replace-version",
-    "replace-version": "cross-env replace \"@VERSION@\" $npm_package_version dist -r",
-    "generate-profile": "cross-env NODE_ENV='dev' webpack --config build/webpack.conf.js --profile --json > dist/webpack-stats.json",
-    "bundle-analyzer": "npm generate-profile && webpack-bundle-analyzer --host 0.0.0.0 --port 8080 dist/webpack-stats.json",
-    "docs-publish": "typedoc --tsconfig src/tsconfig.json --media doc/assets --out docs",
-    "docs-local": "typedoc --tsconfig src/tsconfig.json --media doc/assets --out docs-local",
-    "types": "tsc --project src/declaration.tsconfig.json",
-    "pub-final": "npm run dist-cjs && npm publish",
-    "pub-alpha": "npm run dist-cjs && npm publish --tag alpha",
-    "pub-beta": "npm run dist-cjs && npm publish --tag beta",
-    "pub-rc": "npm run dist-cjs && npm publish --tag rc",
-    "pack": "npm run dist-cjs && npm pack",
-    "pack-to-cjs": "npm run dist-cjs && npm pack --pack-destination=\"/mnt/c/Data/dev/custom-js/MichaelTest/PbrAssetTest\"",
-    "format": "prettier --write ."
-  },
-  "dependencies": {
-    "@babylonjs/core": "5.21.0",
-    "@babylonjs/loaders": "5.21.0",
-    "@babylonjs/materials": "5.21.0",
-    "@babylonjs/serializers": "5.21.0",
-    "eventemitter3": "^4.0.0",
-    "gsap": "^3.5.1",
-    "lodash-es": "^4.17.15"
-  },
-  "devDependencies": {
-    "@combeenation/prettier-config": "^0.0.1",
-    "@types/lodash": "^4.14",
-    "@types/lodash-es": "^4.17",
-    "bundle-loader": "^0.5.6",
-    "clean-webpack-plugin": "^3.0.0",
-    "clipboard-polyfill": "^2.8.6",
-    "copy-webpack-plugin": "^7.0.0",
-    "cross-env": "^7.0.2",
-    "css-loader": "^3.2.0",
-    "extract-text-webpack-plugin": "^4.0.0-beta.0",
-    "file-loader": "^4.2.0",
-    "html-loader": "^0.5.5",
-    "html-webpack-plugin": "^3.2.0",
-    "prettier": "^2.5.1",
-    "replace": "1.2.0",
-    "source-map-loader": "^0.2.4",
-    "style-loader": "^1.0.0",
-    "ts-loader": "^6.2.2",
-    "tslib": "^1.11.1",
-    "typedoc": "^0.20",
-    "typedoc-plugin-merge-modules": "^1.0.0",
-    "typedoc-plugin-pages": "^1.1.0",
-    "typescript": "^4.0.5",
-    "uglifyjs-webpack-plugin": "^2.2.0",
-    "url-loader": "^2.2.0",
-    "webpack": "^4.42.1",
-    "webpack-bundle-analyzer": "^3.6.0",
-    "webpack-cli": "^3.3.11",
-    "webpack-dev-server": "^3.11.2",
-    "webpack-merge": "^4.2.2"
-  },
-  "prettier": "@combeenation/prettier-config"
-}
+{
+  "name": "@combeenation/3d-viewer",
+  "version": "5.2.0-alpha1",
+  "description": "Combeenation 3D Viewer",
+  "homepage": "https://github.com/Combeenation/3d-viewer#readme",
+  "bugs": {
+    "url": "https://github.com/Combeenation/3d-viewer/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Combeenation/3d-viewer.git"
+  },
+  "license": "Apache 2.0",
+  "author": "",
+  "contributors": [],
+  "main": "dist/lib-cjs/index.js",
+  "module": "dist/lib-cjs/index.js",
+  "typings": "dist/lib-cjs/index.d.ts",
+  "directories": {
+    "doc": "docs"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "bundle-analyzer": "npm run generate-profile && webpack-bundle-analyzer dist/webpack-stats.json dist/lib-full",
+    "dev": "cross-env NODE_ENV='dev' webpack serve --config build/webpack.conf.js --progress --hot",
+    "dist-cjs": "tsc --project commonjs.tsconfig.json && npm run replace-version",
+    "dist-es6": "tsc --project es6.tsconfig.json && npm run replace-version",
+    "dist-full": "cross-env NODE_ENV='production' webpack --config build/webpack.conf.js --progress && npm run replace-version",
+    "docs-local": "typedoc --tsconfig tsconfig.json --media doc/assets --out docs-local",
+    "docs-publish": "typedoc --tsconfig tsconfig.json --media doc/assets --out docs",
+    "format": "prettier --write .",
+    "generate-profile": "cross-env NODE_ENV='dev' webpack --config build/webpack.conf.js --profile --json > dist/webpack-stats.json",
+    "pack": "npm run dist-cjs && npm pack",
+    "pack-to-cjs": "npm run dist-cjs && npm pack --pack-destination=\"/mnt/c/Data/dev/custom-js/MichaelTest/PbrAssetTest\"",
+    "pub-alpha": "npm run dist-cjs && npm publish --tag alpha",
+    "pub-beta": "npm run dist-cjs && npm publish --tag beta",
+    "pub-final": "npm run dist-cjs && npm publish",
+    "pub-rc": "npm run dist-cjs && npm publish --tag rc",
+    "replace-version": "cross-env replace \"@VERSION@\" $npm_package_version dist -r",
+    "types": "tsc --project declaration.tsconfig.json"
+  },
+  "prettier": "@combeenation/prettier-config",
+  "dependencies": {
+    "@babylonjs/core": "5.25.0",
+    "@babylonjs/loaders": "5.25.0",
+    "@babylonjs/materials": "5.25.0",
+    "@babylonjs/serializers": "5.25.0",
+    "eventemitter3": "^4.0.7",
+    "gsap": "^3.11.2",
+    "lodash-es": "^4.17.21"
+  },
+  "devDependencies": {
+    "@combeenation/prettier-config": "^0.0.3",
+    "@combeenation/ts-config": "^0.0.2",
+    "@knodes/typedoc-plugin-pages": "^0.23.1",
+    "@types/lodash-es": "^4.17.6",
+    "clean-webpack-plugin": "^4.0.0",
+    "cross-env": "^7.0.3",
+    "html-webpack-plugin": "^5.5.0",
+    "prettier": "^2.7.1",
+    "replace": "^1.2.1",
+    "terser-webpack-plugin": "^5.3.6",
+    "ts-loader": "^9.4.1",
+    "typedoc": "^0.23.15",
+    "typedoc-plugin-merge-modules": "^4.0.1",
+    "typescript": "^4.8.4",
+    "webpack": "^5.74.0",
+    "webpack-bundle-analyzer": "^4.6.1",
+    "webpack-cli": "^4.10.0",
+    "webpack-dev-server": "^4.11.1",
+    "webpack-merge": "^5.8.0"
+  }
+}

package/src/api/classes/animationInterface.ts

@@ -1,10 +1,10 @@
-/**
- * An Interface defining the basic functionality of an animation.
- */
-interface AnimationInterface {
-  play(): Promise<AnimationInterface>;
-
-  pause(): AnimationInterface;
-
-  kill(): AnimationInterface;
-}
+/**
+ * An Interface defining the basic functionality of an animation.
+ */
+export interface AnimationInterface {
+  play(): Promise<AnimationInterface>;
+
+  pause(): AnimationInterface;
+
+  kill(): AnimationInterface;
+}

package/src/api/classes/dottedPath.ts

@@ -1,181 +1,181 @@
-export class DottedPath {
-  static DELIMITER: string = '.';
-
-  static SAFE_CHAR: string = '·';
-
-  public parts: string[] = [];
-
-  /**
-   * Magic factory function that creates a DottedPath based on the argument type.
-   */
-  public static create(dottedPath?: DottedPathArgument): DottedPath {
-    if (dottedPath?.constructor === DottedPath) {
-      return (dottedPath as DottedPath).clone();
-    }
-    if (dottedPath?.constructor === String) {
-      return DottedPath.createFromPath(dottedPath as string);
-    }
-    if (dottedPath?.constructor === Array) {
-      return DottedPath.createFromParts(dottedPath as string[]);
-    }
-    return DottedPath.createEmpty();
-  }
-
-  /**
-   * Creates a DottedPath from a string.
-   * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
-   * E.g. "part1.part2.'part.3'.part_4"
-   */
-  public static createFromPath(path: string): DottedPath {
-    if (path.length === 0) {
-      return this.createEmpty();
-    }
-    if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
-      const bd = '[\'|"]';
-      const search = new RegExp(`${bd}(.*)${bd}`, 'g');
-      let matches = search.exec(path);
-      while (matches !== null) {
-        const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
-        path = path.replace(_search, this.sanitizePart(matches[1]));
-        matches = search.exec(path);
-      }
-    }
-    return this.createFromParts(path.split(DottedPath.DELIMITER));
-  }
-
-  /**
-   * Creates a DottedPath from a string list.
-   */
-  public static createFromParts(parts: string[]): DottedPath {
-    const dottedPath = new DottedPath();
-    parts.forEach(part => dottedPath.addPart(part));
-    return dottedPath;
-  }
-
-  /**
-   * Creates an empty DottedPath.
-   */
-  public static createEmpty(): DottedPath {
-    return new DottedPath();
-  }
-
-  /**
-   * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
-   * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
-   * (i) Does not trim whitespace.
-   */
-  public static sanitizePart(part: string): string {
-    return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
-  }
-
-  /**
-   * Constructor
-   */
-  private constructor() {}
-
-  /**
-   * The path.
-   * (i) Does not return an empty dot for no path.
-   */
-  get path(): string {
-    return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
-  }
-
-  /**
-   * The first part.
-   */
-  get firstPart(): string | null {
-    if (this.parts.length > 0) {
-      return this.parts[0];
-    }
-    return null;
-  }
-
-  /**
-   * The last part.
-   */
-  get lastPart(): string | null {
-    if (this.parts.length > 0) {
-      return this.parts[this.parts.length - 1];
-    }
-    return null;
-  }
-
-  /**
-   * Gets the tokens to each leaf of the DottedPath tree.
-   * E.g. "part1.part2.part_3" will return an array like
-   *      ["part1", "part1.part2", "part1.part2.part_3"]
-   */
-  get leafTokens(): string[] {
-    let parents: string[] = [];
-    return this.parts.map(part => {
-      parents.push(part);
-      return DottedPath.create(parents).path;
-    });
-  }
-
-  /**
-   * Removes the first part and returns it.
-   */
-  public shiftPart(): string | undefined {
-    return this.parts.shift();
-  }
-
-  /**
-   * Adds part to the beginning of parts list.
-   */
-  public unshiftPart(part: string, duplicateCheck: boolean = false): DottedPath {
-    part = DottedPath.sanitizePart(part);
-    if (duplicateCheck && this.firstPart === part) {
-      return this;
-    }
-    this.parts.unshift(part);
-    return this;
-  }
-
-  /**
-   * Adds part to the end of parts list.
-   * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
-   */
-  public addPart(part: string, duplicateCheck: boolean = false): DottedPath {
-    if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
-      return this;
-    }
-    part = DottedPath.sanitizePart(part);
-    if (duplicateCheck && this.lastPart === part) {
-      return this;
-    }
-    this.parts.push(part);
-    return this;
-  }
-
-  /**
-   * Adds multiple parts to the end of parts list.
-   */
-  public addParts(parts: string[], duplicateCheck: boolean = false): DottedPath {
-    parts.forEach(part => this.addPart(part, duplicateCheck));
-    return this;
-  }
-
-  /**
-   * Removes the last part and returns it.
-   */
-  public popPart(): string | undefined {
-    return this.parts.pop();
-  }
-
-  public toString(): string {
-    return this.path;
-  }
-
-  public valueOf(): string {
-    return this.path;
-  }
-
-  /**
-   * Clones the DottedPath.
-   */
-  public clone(): DottedPath {
-    return DottedPath.createFromParts(this.parts);
-  }
-}
+export class DottedPath {
+  static DELIMITER: string = '.';
+
+  static SAFE_CHAR: string = '·';
+
+  public parts: string[] = [];
+
+  /**
+   * Magic factory function that creates a DottedPath based on the argument type.
+   */
+  public static create(dottedPath?: DottedPathArgument): DottedPath {
+    if (dottedPath?.constructor === DottedPath) {
+      return (dottedPath as DottedPath).clone();
+    }
+    if (dottedPath?.constructor === String) {
+      return DottedPath.createFromPath(dottedPath as string);
+    }
+    if (dottedPath?.constructor === Array) {
+      return DottedPath.createFromParts(dottedPath as string[]);
+    }
+    return DottedPath.createEmpty();
+  }
+
+  /**
+   * Creates a DottedPath from a string.
+   * Allows patterns with unsafe characters wrapped in apostrophes or quotes.
+   * E.g. "part1.part2.'part.3'.part_4"
+   */
+  public static createFromPath(path: string): DottedPath {
+    if (path.length === 0) {
+      return this.createEmpty();
+    }
+    if (path.indexOf("'") > -1 || path.indexOf('"') > -1) {
+      const bd = '[\'|"]';
+      const search = new RegExp(`${bd}(.*)${bd}`, 'g');
+      let matches = search.exec(path);
+      while (matches !== null) {
+        const _search = new RegExp(`${bd}${matches[1]}${bd}`, 'g');
+        path = path.replace(_search, this.sanitizePart(matches[1]));
+        matches = search.exec(path);
+      }
+    }
+    return this.createFromParts(path.split(DottedPath.DELIMITER));
+  }
+
+  /**
+   * Creates a DottedPath from a string list.
+   */
+  public static createFromParts(parts: string[]): DottedPath {
+    const dottedPath = new DottedPath();
+    parts.forEach(part => dottedPath.addPart(part));
+    return dottedPath;
+  }
+
+  /**
+   * Creates an empty DottedPath.
+   */
+  public static createEmpty(): DottedPath {
+    return new DottedPath();
+  }
+
+  /**
+   * Sanitizes given part: replaces all characters like {@link DottedPath.DELIMITER}
+   * with a "safe" character like {@link DottedPath.SAFE_CHAR}.
+   * (i) Does not trim whitespace.
+   */
+  public static sanitizePart(part: string): string {
+    return part.split(DottedPath.DELIMITER).join(DottedPath.SAFE_CHAR);
+  }
+
+  /**
+   * Constructor
+   */
+  private constructor() {}
+
+  /**
+   * The path.
+   * (i) Does not return an empty dot for no path.
+   */
+  get path(): string {
+    return this.parts.length > 0 ? this.parts.join(DottedPath.DELIMITER) : '';
+  }
+
+  /**
+   * The first part.
+   */
+  get firstPart(): string | null {
+    if (this.parts.length > 0) {
+      return this.parts[0];
+    }
+    return null;
+  }
+
+  /**
+   * The last part.
+   */
+  get lastPart(): string | null {
+    if (this.parts.length > 0) {
+      return this.parts[this.parts.length - 1];
+    }
+    return null;
+  }
+
+  /**
+   * Gets the tokens to each leaf of the DottedPath tree.
+   * E.g. "part1.part2.part_3" will return an array like
+   *      ["part1", "part1.part2", "part1.part2.part_3"]
+   */
+  get leafTokens(): string[] {
+    let parents: string[] = [];
+    return this.parts.map(part => {
+      parents.push(part);
+      return DottedPath.create(parents).path;
+    });
+  }
+
+  /**
+   * Removes the first part and returns it.
+   */
+  public shiftPart(): string | undefined {
+    return this.parts.shift();
+  }
+
+  /**
+   * Adds part to the beginning of parts list.
+   */
+  public unshiftPart(part: string, duplicateCheck: boolean = false): DottedPath {
+    part = DottedPath.sanitizePart(part);
+    if (duplicateCheck && this.firstPart === part) {
+      return this;
+    }
+    this.parts.unshift(part);
+    return this;
+  }
+
+  /**
+   * Adds part to the end of parts list.
+   * (i) Does not add a part if the last char already is the delimiter or if an empty string was passed.
+   */
+  public addPart(part: string, duplicateCheck: boolean = false): DottedPath {
+    if (part.length < 1 || this.lastPart === DottedPath.DELIMITER) {
+      return this;
+    }
+    part = DottedPath.sanitizePart(part);
+    if (duplicateCheck && this.lastPart === part) {
+      return this;
+    }
+    this.parts.push(part);
+    return this;
+  }
+
+  /**
+   * Adds multiple parts to the end of parts list.
+   */
+  public addParts(parts: string[], duplicateCheck: boolean = false): DottedPath {
+    parts.forEach(part => this.addPart(part, duplicateCheck));
+    return this;
+  }
+
+  /**
+   * Removes the last part and returns it.
+   */
+  public popPart(): string | undefined {
+    return this.parts.pop();
+  }
+
+  public toString(): string {
+    return this.path;
+  }
+
+  public valueOf(): string {
+    return this.path;
+  }
+
+  /**
+   * Clones the DottedPath.
+   */
+  public clone(): DottedPath {
+    return DottedPath.createFromParts(this.parts);
+  }
+}