bruce-models 3.5.1 → 3.5.3

package/dist/types/client-file/client-file.d.ts

@@ -7,17 +7,6 @@ import { Uploader } from "../internal/uploader";
  * A client file is a record of a file uploaded to Bruce.
  */
 export declare namespace ClientFile {
-    /**
-     * Returns cache identifier for a client file by ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("123");
-     *     api.Cache.Remove(key);
-     * }
-     * @param fileId
-     * @returns
-     */
-    function GetCacheKey(fileId: string): string;
     /**
      * Describes a client file record.
      */
@@ -192,4 +181,15 @@ export declare namespace ClientFile {
             req?: Api.IReqParams;
         }): Promise<IResult>;
     }
+    /**
+     * Returns cache identifier for a client file by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param fileId
+     * @returns
+     */
+    function GetCacheKey(fileId: string): string;
 }

package/dist/types/custom-form/custom-form.d.ts

@@ -6,28 +6,6 @@ import { CustomFormContent } from "./custom-form-content";
  * Custom forms are dynamic dialogs that get populated with Entity data.
  */
 export declare namespace CustomForm {
-    /**
-     * Returns cache identifier for a Custom Form by ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey(1);
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id: number): string;
-    /**
-     * Returns cache identifier for a list of Custom Forms by Entity Type ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("123");
-     *     api.Cache.Remove(key);
-     * }
-     * @param typeId
-     * @returns
-     */
-    function GetListCacheKey(typeId: string): string;
     /**
      * Describes a custom form record.
      */
@@ -91,4 +69,26 @@ export declare namespace CustomForm {
     }): Promise<{
         form: IForm;
     }>;
+    /**
+     * Returns cache identifier for a Custom Form by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id: number): string;
+    /**
+     * Returns cache identifier for a list of Custom Forms by Entity Type ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param typeId
+     * @returns
+     */
+    function GetListCacheKey(typeId: string): string;
 }

package/dist/types/data-lab/data-lab.d.ts

@@ -7,10 +7,6 @@ import { Entity as E } from "../entity/entity";
  * Data lab queries can be saved for reuse.
  */
 export declare namespace DataLab {
-    enum EReqKey {
-        Primary = "PrimarySelection",
-        Secondary = "SecondarySelection"
-    }
     interface IQuery {
         [EReqKey.Primary]: {
             Items: any[];
@@ -20,6 +16,10 @@ export declare namespace DataLab {
         PrimaryEntityTypeID?: string;
         PrimaryEntityID?: string;
     }
+    enum EReqKey {
+        Primary = "PrimarySelection",
+        Secondary = "SecondarySelection"
+    }
     /**
      * Runs a DataLab query.
      * @param params

package/dist/types/data-source/data-source.d.ts

@@ -2,27 +2,6 @@ import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
 import { EntityAttribute } from "../entity/entity-attribute";
 export declare namespace DataSource {
-    /**
-     * Returns cache identifier for a data source by ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey(1);
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id: number): string;
-    /**
-     * Returns cache identifier for a list of data sources.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @returns
-     */
-    function GetListCacheKey(): string;
     /**
      * Describes a data source record.
      */
@@ -82,4 +61,25 @@ export declare namespace DataSource {
         api?: BruceApi.Api;
         req?: Api.IReqParams;
     }): Promise<any>;
+    /**
+     * Returns cache identifier for a data source by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey(1);
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id: number): string;
+    /**
+     * Returns cache identifier for a list of data sources.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
+    function GetListCacheKey(): string;
 }

package/dist/types/entity/entity-attachment-type.d.ts

@@ -6,28 +6,6 @@ type Type = EntityAttachmentType.EType | string;
  * It is a record that describes the purpose of an attachment.
  */
 export declare namespace EntityAttachmentType {
-    /**
-     * Returns cache identifier for an attachment type by ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("123");
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id: Type): string;
-    /**
-     * Returns cache identifier for a list of attachment types.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @param typeId
-     * @returns
-     */
-    function GetListCacheKey(): string;
     /**
      * Describes an attachment type record.
      */
@@ -72,5 +50,27 @@ export declare namespace EntityAttachmentType {
     }): Promise<{
         attachmentTypes: IType[];
     }>;
+    /**
+     * Returns cache identifier for an attachment type by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id: Type): string;
+    /**
+     * Returns cache identifier for a list of attachment types.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @param typeId
+     * @returns
+     */
+    function GetListCacheKey(): string;
 }
 export {};

package/dist/types/entity/entity-attachment.d.ts

@@ -9,28 +9,6 @@ type Type = EntityAttachmentType.EType | string;
  * The same file can be attached to multiple entities.
  */
 export declare namespace EntityAttachment {
-    /**
-     * Returns cache identifier for an attachment by ID.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("123");
-     *     api.Cache.Remove(key);
-     * }
-     * @param id
-     * @returns
-     */
-    function GetCacheKey(id: number): string;
-    /**
-     * Returns cache identifier for a list of attachments for an entity.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param typeId
-     * @returns
-     */
-    function GetListCacheKey(entityId: string): string;
     /**
      * Describes an attachment record.
      */
@@ -104,5 +82,27 @@ export declare namespace EntityAttachment {
     }): Promise<{
         attachment: IAttachment;
     }>;
+    /**
+     * Returns cache identifier for an attachment by ID.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("123");
+     *     api.Cache.Remove(key);
+     * }
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id: number): string;
+    /**
+     * Returns cache identifier for a list of attachments for an entity.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param typeId
+     * @returns
+     */
+    function GetListCacheKey(entityId: string): string;
 }
 export {};

package/dist/types/entity/entity-attribute.d.ts

@@ -2,15 +2,6 @@
  * Describes an entity type schema attribute.
  */
 export declare namespace EntityAttribute {
-    enum EType {
-        String = "String",
-        Double = "Double",
-        Integer = "Integer",
-        Datetime = "Datetime",
-        Structure = "Structure",
-        Geometry = "Geometry",
-        Boolean = "Boolean"
-    }
     /**
      * Describes an entity attribute.
      * This sits within an entity type schema.
@@ -30,6 +21,15 @@ export declare namespace EntityAttribute {
         IsFamilyAttributeDefault?: boolean;
         Sources?: string[];
     }
+    enum EType {
+        String = "String",
+        Double = "Double",
+        Integer = "Integer",
+        Datetime = "Datetime",
+        Structure = "Structure",
+        Geometry = "Geometry",
+        Boolean = "Boolean"
+    }
     /**
      * Describes additional metadata for an attribute.
      */

package/dist/types/project/project-view.d.ts

@@ -11,28 +11,10 @@ import { ProjectViewSelection } from "./project-view-selection";
  * It will describe what panels to show and how, it will also describe all possible ways data can be displayed.
  */
 export declare namespace ProjectView {
-    /**
-     * Returns cache identifier for a project view.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetCacheKey("abc");
-     *     api.Cache.Remove(key);
-     * }
-     * @param viewId
-     * @returns
-     */
-    function GetCacheKey(viewId: string): string;
-    /**
-     * Returns cache identifier for a list of project views.
-     * Example: {
-     *     const api: BruceApi.Api = ...;
-     *     const key = GetListCacheKey();
-     *     api.Cache.Remove(key);
-     * }
-     * @returns
-     */
-    function GetListCacheKey(): string;
     const DEFAULT_DATA_VERSION = 2;
+    const TYPE_WEB_3D_NAVIGATOR = "WEB_3D_NAVIGATOR";
+    const TYPE_WEB_2D_NAVIGATOR = "WEB_2D_NAVIGATOR";
+    const DEFAULT_TYPE = "WEB_3D_NAVIGATOR";
     /**
      * Describes a project view record.
      */
@@ -40,6 +22,7 @@ export declare namespace ProjectView {
         ID?: string;
         Name: string;
         Description?: string;
+        Type?: typeof TYPE_WEB_3D_NAVIGATOR | typeof TYPE_WEB_2D_NAVIGATOR | string;
         "CreatedByUser.ID"?: string;
         CreatedTime?: UTC.IUTC;
         DefaultUISlideID?: string;
@@ -117,6 +100,7 @@ export declare namespace ProjectView {
      */
     function GetList(params: {
         api?: BruceApi.Api;
+        type?: typeof TYPE_WEB_3D_NAVIGATOR | typeof TYPE_WEB_2D_NAVIGATOR | string;
         req?: Api.IReqParams;
     }): Promise<{
         views: IView[];
@@ -142,4 +126,26 @@ export declare namespace ProjectView {
     }): Promise<{
         view: IView;
     }>;
+    /**
+     * Returns cache identifier for a project view.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param viewId
+     * @returns
+     */
+    function GetCacheKey(viewId: string): string;
+    /**
+     * Returns cache identifier for a list of project views.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @param type optional filter for the type of project view.
+     * @returns
+     */
+    function GetListCacheKey(type?: string): string;
 }

package/dist/types/project/zoom-control.d.ts

@@ -4,15 +4,6 @@ import { Style } from "../bruce-models";
  * between a min-max distance of an entity to the camera.
  */
 export declare namespace ZoomControl {
-    /**
-     * Available display types for a menu item.
-     */
-    enum EDisplayType {
-        Hidden = "hidden",
-        Point = "point",
-        Geometry = "geometry",
-        Model3D = "3d"
-    }
     /**
      * Describes a menu item's zoom control row.
      * Typically there is an array of these for a menu item.
@@ -26,4 +17,13 @@ export declare namespace ZoomControl {
         LODCategoryID?: string;
         LODLevel?: number | string;
     }
+    /**
+     * Available display types for a menu item.
+     */
+    enum EDisplayType {
+        Hidden = "hidden",
+        Point = "point",
+        Geometry = "geometry",
+        Model3D = "3d"
+    }
 }

package/package.json

@@ -1,78 +1,78 @@
-{
-  "name": "bruce-models",
-  "version": "3.5.1",
-  "description": "",
-  "keywords": [],
-  "main": "dist/bruce-models.umd.js",
-  "module": "dist/bruce-models.es5.js",
-  "typings": "dist/types/bruce-models.d.ts",
-  "files": [
-    "dist"
-  ],
-  "author": "MatveyL <matveylavrinovich@gmail.com>",
-  "repository": {
-    "type": "git",
-    "url": ""
-  },
-  "license": "ISC",
-  "engines": {
-    "node": ">=6.0.0"
-  },
-  "scripts": {
-    "prebuild": "rimraf dist",
-    "build": "tsc --module commonjs && rollup -c rollup.config.ts",
-    "docs": "typedoc ./src/bruce-models.ts --out ./docs",
-    "start": "rollup -c rollup.config.ts -w",
-    "test": "jest \"./test/unit\"",
-    "test-db": "jest \"./test/db\"",
-    "test:watch": "jest --watch",
-    "test:prod": "npm run test -- --no-cache"
-  },
-  "jest": {
-    "transform": {
-      ".(ts|tsx)": "ts-jest"
-    },
-    "testEnvironment": "node",
-    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js"
-    ],
-    "setupFiles": [
-      "./setup-jest.js"
-    ]
-  },
-  "devDependencies": {
-    "@types/jest": "^23.3.14",
-    "@types/lodash": "^4.14.195",
-    "@types/node": "^10.11.0",
-    "colors": "^1.3.2",
-    "coveralls": "^3.0.2",
-    "cross-env": "^5.2.0",
-    "husky": "^1.0.1",
-    "jest": "^23.6.0",
-    "jest-config": "^23.6.0",
-    "lodash.camelcase": "^4.3.0",
-    "prompt": "^1.0.0",
-    "replace-in-file": "^3.4.2",
-    "rimraf": "^2.6.2",
-    "rollup": "^0.67.0",
-    "rollup-plugin-commonjs": "^9.1.8",
-    "rollup-plugin-json": "^3.1.0",
-    "rollup-plugin-node-resolve": "^3.4.0",
-    "rollup-plugin-sourcemaps": "^0.4.2",
-    "rollup-plugin-typescript2": "^0.18.0",
-    "shelljs": "^0.8.3",
-    "ts-jest": "^23.10.2",
-    "ts-node": "^7.0.1",
-    "typedoc": "^0.24.8",
-    "typescript": "^5.0.4",
-    "ws": "^8.13.0"
-  },
-  "dependencies": {
-    "isomorphic-fetch": "^3.0.0",
-    "tslib": "^2.4.0",
-    "util": "^0.12.4"
-  }
-}
+{
+    "name": "bruce-models",
+    "version": "3.5.3",
+    "description": "",
+    "keywords": [],
+    "main": "dist/bruce-models.umd.js",
+    "module": "dist/bruce-models.es5.js",
+    "typings": "dist/types/bruce-models.d.ts",
+    "files": [
+        "dist"
+    ],
+    "author": "MatveyL <matveylavrinovich@gmail.com>",
+    "repository": {
+        "type": "git",
+        "url": ""
+    },
+    "license": "ISC",
+    "engines": {
+        "node": ">=6.0.0"
+    },
+    "scripts": {
+        "prebuild": "rimraf dist",
+        "build": "node ./pre-build.js && tsc --module commonjs && rollup -c rollup.config.ts",
+        "docs": "typedoc ./src/bruce-models.ts --out ./docs",
+        "start": "rollup -c rollup.config.ts -w",
+        "test": "jest \"./test/unit\"",
+        "test-db": "jest \"./test/db\"",
+        "test:watch": "jest --watch",
+        "test:prod": "npm run test -- --no-cache"
+    },
+    "jest": {
+        "transform": {
+            ".(ts|tsx)": "ts-jest"
+        },
+        "testEnvironment": "node",
+        "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+        "moduleFileExtensions": [
+            "ts",
+            "tsx",
+            "js"
+        ],
+        "setupFiles": [
+            "./setup-jest.js"
+        ]
+    },
+    "devDependencies": {
+        "@types/jest": "^23.3.14",
+        "@types/lodash": "^4.14.195",
+        "@types/node": "^10.11.0",
+        "colors": "^1.3.2",
+        "coveralls": "^3.0.2",
+        "cross-env": "^5.2.0",
+        "husky": "^1.0.1",
+        "jest": "^23.6.0",
+        "jest-config": "^23.6.0",
+        "lodash.camelcase": "^4.3.0",
+        "prompt": "^1.0.0",
+        "replace-in-file": "^3.4.2",
+        "rimraf": "^2.6.2",
+        "rollup": "^0.67.0",
+        "rollup-plugin-commonjs": "^9.1.8",
+        "rollup-plugin-json": "^3.1.0",
+        "rollup-plugin-node-resolve": "^3.4.0",
+        "rollup-plugin-sourcemaps": "^0.4.2",
+        "rollup-plugin-typescript2": "^0.18.0",
+        "shelljs": "^0.8.3",
+        "ts-jest": "^23.10.2",
+        "ts-node": "^7.0.1",
+        "typedoc": "^0.24.8",
+        "typescript": "^5.0.4",
+        "ws": "^8.13.0"
+    },
+    "dependencies": {
+        "isomorphic-fetch": "^3.0.0",
+        "tslib": "^2.4.0",
+        "util": "^0.12.4"
+    }
+}