bruce-models 4.1.4 → 4.1.6

package/dist/types/account/account-limits.d.ts

@@ -0,0 +1,186 @@
+import { Api, ApiGetters, GuardianApi, IDictionary } from "../bruce-models";
+export declare namespace AccountLimits {
+    enum ELimit {
+        MaxProjectViewCount = "MaxProjectViewCount",
+        MaxStorageUseGigabytes = "MaxStorageUseGigabytes",
+        MaxEntitiesCount = "MaxEntitiesCount",
+        MaxFileImportSizeGigabytes = "MaxFileImportSizeGigabytes",
+        OperatorAccessAllowed = "OperatorAccessAllowed",
+        DenyPublicAccess = "DenyPublicAccess",
+        EnableSSOLogin = "EnableSSOLogin",
+        EnableSSOLoginAutoRedirect = "EnableSSOLoginAutoRedirect"
+    }
+    type Limit = ELimit | string;
+    /**
+     * Represents a limit for an account.
+     * The value type of interest is determined by the limit key.
+     */
+    interface ILimit {
+        "Numeric": number;
+        "String": string;
+        "Boolean": boolean;
+    }
+    /**
+     * Returns a dictionary of limits for the given account.
+     * @param params
+     * @returns
+     */
+    function GetLimits(params: {
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        limits: IDictionary<ILimit>;
+    }>;
+    /**
+     * Returns a numeric limit for the given account.
+     * @param params
+     */
+    function GetNumericLimit(params: {
+        key: Limit;
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+        onErrorValue: any;
+        onEmptyValue: number;
+    }): Promise<number>;
+    /**
+     * Returns a boolean limit for the given account.
+     * @param params
+     */
+    function GetBooleanLimit(params: {
+        key: Limit;
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+        onErrorValue: any;
+        onEmptyValue: boolean;
+    }): Promise<boolean>;
+    /**
+     * Returns a string limit for the given account.
+     * @param params
+     */
+    function GetStringLimit(params: {
+        key: Limit;
+        accountId: string;
+        api?: GuardianApi.Api;
+        req?: Api.IReqParams;
+        onErrorValue: any;
+        onEmptyValue: string;
+    }): Promise<string>;
+    /**
+     * Functions for validating if a user can do things sit here.
+     */
+    namespace Assert {
+        /**
+         * Returns if project view creation is allowed for the account.
+         */
+        function GetCanCreateProjectView(params: {
+            accountId?: string;
+            getters?: ApiGetters;
+        }): Promise<{
+            allowed: boolean;
+            errorText?: string;
+        }>;
+        /**
+         * Returns the project view limit for an account.
+         * If -1 is returned then it is unlimited.
+         * @param params
+         * @returns
+         */
+        function GetProjectViewLimit(params: {
+            accountId?: string;
+            api?: GuardianApi.Api;
+        }): Promise<number>;
+        /**
+         * Returns if file uploads are allowed for the account.
+         */
+        function GetCanUploadFile(params: {
+            accountId?: string;
+            getters?: ApiGetters;
+            fileSize?: number;
+            thoroughCheck?: boolean;
+        }): Promise<{
+            allowed: boolean;
+            errorText?: string;
+        }>;
+        /**
+         * Returns the file limit for an account.
+         * If -1 is returned then it is unlimited.
+         * @param params
+         * @returns
+         */
+        function GetFileGBLimit(params: {
+            accountId?: string;
+            api?: GuardianApi.Api;
+        }): Promise<number>;
+        /**
+         * Returns the maximum file import size for an account.
+         * If -1 is returned then it is unlimited.
+         * @param params
+         * @returns
+         */
+        function GetMaxImportSizeGB(params: {
+            accountId?: string;
+            api?: GuardianApi.Api;
+        }): Promise<number>;
+        /**
+         * Returns if entity creation is allowed for the account.
+         */
+        function GetCanCreateEntity(params: {
+            accountId?: string;
+            getters?: ApiGetters;
+            count?: number;
+        }): Promise<{
+            allowed: boolean;
+            errorText?: string;
+        }>;
+        /**
+         * Returns the entity limit for an account.
+         * If -1 is returned then it is unlimited.
+         */
+        function GetEntityLimit(params: {
+            accountId?: string;
+            api?: GuardianApi.Api;
+        }): Promise<number>;
+        /**
+         * Returns if Operator access is allowed for the account.
+         * @param params
+         * @returns
+         */
+        function GetCanOpenOperator(params: {
+            accountId?: string;
+            api?: GuardianApi.Api;
+        }): Promise<{
+            allowed: boolean;
+            errorText?: string;
+        }>;
+        /**
+         * Returns SSO login settings for the account.
+         * @param params
+         * @returns
+         */
+        function GetSSOLoginSettings(params: {
+            accountId?: string;
+            api?: GuardianApi.Api;
+        }): Promise<{
+            enabled: boolean;
+            autoRedirect: boolean;
+            errorText?: string;
+        }>;
+        /**
+         * Returns if public access is denied to this account.
+         * @param params
+         * @returns
+         */
+        function GetDenyPublicAccess(params: {
+            accountId?: string;
+            api?: GuardianApi.Api;
+        }): Promise<boolean>;
+    }
+    /**
+     * Cache key for requesting account limits for a specific account.
+     * @param accountId
+     */
+    function GetLimitsCacheKey(accountId: string): string;
+}

package/dist/types/api/api.d.ts

@@ -53,7 +53,8 @@ export declare namespace Api {
         PluginIndexFile = "pluginindexfile",
         EntityHistoricData = "entityhistoricdata",
         EntityHistoricDataRec = "entityhistoricdatarec",
-        EntityHistoricDataStats = "entityhistoricdatastats"
+        EntityHistoricDataStats = "entityhistoricdatastats",
+        AccountLimits = "accountlimits"
     }
     const DEFAULT_CACHE_DURATION: number;
     const TEMPLATE_ACCOUNT_ID = "template";

package/dist/types/bruce-models.d.ts

@@ -39,6 +39,7 @@ export * from "./entity/entity-coords";
 export * from "./entity/entity-type-visual-settings";
 export * from "./entity/entity-attribute";
 export * from "./entity/entity-historic-data";
+export * from "./entity-type-model/comment";
 export * from "./client-file/client-file";
 export * from "./program-key/program-key";
 export * from "./project/zoom-control";
@@ -63,6 +64,7 @@ export * from "./account/account";
 export * from "./account/account-settings";
 export * from "./account/account-invite";
 export * from "./account/account-features";
+export * from "./account/account-limits";
 export * from "./util/encrypt-utils";
 export * from "./util/math-utils";
 export * from "./util/object-utils";
@@ -79,4 +81,4 @@ export * from "./internal/uploader";
 export * from "./plugin/plugin";
 export * from "./environment";
 export * from "./data-source/data-source";
-export declare const VERSION = "4.1.4";
+export declare const VERSION = "4.1.6";

package/dist/types/common/utc.d.ts

@@ -24,6 +24,31 @@ export declare namespace UTC {
         ss: number;
         y: number;
     }
+    /**
+     * Returns an ISO 8601 string representation of the provided date.
+     * @param utc
+     */
+    function ToString(utc: IUTC): string;
     function ToDate(utc: IUTC): Date;
-    function FromDate(date: Date): IUTC;
+    function FromDate(utc: Date): IUTC;
+    /**
+     * Returns how many seconds have passed between two dates.
+     * If the second date is not provided, it will be the current date.
+     * @param from
+     * @param to
+     * @returns
+     */
+    function GetPassedSeconds(from: IUTC, to?: IUTC): number;
+    /**
+     * Returns a human-readable string that describes how much time has passed since the provided date.
+     * @param utc
+     */
+    function GetPassedTime(utc: IUTC): string;
+    /**
+     * Returns a human-readable string that describes the provided date.
+     * If a timezone is not provided then it will use the locale timezone.
+     * @param utc
+     * @param timezone
+     */
+    function GetDateTime(utc: IUTC, timezone?: string): string;
 }

package/dist/types/entity-type-model/comment.d.ts

@@ -0,0 +1,71 @@
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+import { UTC } from "../common/utc";
+import { Entity } from "../entity/entity";
+import { ProjectViewBookmark } from "../project/project-view-bookmark";
+/**
+ * Generic comment record and related functions.
+ * This uses Entity records with a specific Entity Type.
+ * This replaced the original comment system and allows for comments to be placed on any Entity, or by themselves.
+ */
+export declare namespace Comment {
+    const ENTITY_TYPE_ID = "COMMENTS";
+    const REPLY_RELATIONSHIP_TYPE_ID = "COMMENTS_REPLY";
+    enum EType {
+        Comment = "COMMENT",
+        Reply = "REPLY"
+    }
+    /**
+     * Represents a comment Entity record.
+     */
+    interface IRecord extends Entity.IEntity {
+        viewId: string;
+        bookmarkId?: string;
+        text: string;
+        type: EType;
+        lastUpdateTime?: UTC.IUTC;
+        updates?: number;
+        entityId?: string;
+        edited?: boolean;
+        camera?: ProjectViewBookmark.Web3d.ICamera;
+        parentId?: string;
+    }
+    /**
+     * Returns a list of comments based on the provided filter.
+     * @param params
+     * @returns
+     */
+    function GetList(params: {
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+        filter: {
+            viewId?: string;
+            bookmarkId?: string;
+            userId?: string;
+            amount?: number;
+            index?: number;
+            text?: string;
+            entityId?: string;
+        };
+    }): Promise<{
+        comments: IRecord[];
+    }>;
+    /**
+     * Ensure the Entity Type exists.
+     * If it does not exist, it will be created.
+     * @param params
+     */
+    function AssertEntityType(params: {
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    /**
+     * Ensure the Relation Type exists.
+     * If it does not exist, it will be created.
+     * @param params
+     */
+    function AssertRelationType(params: {
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+}

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

@@ -241,6 +241,7 @@ export declare namespace ProjectViewBookmark {
         interface IRelationship {
             typeId: string;
             entityIds?: string[];
+            width?: number;
         }
         interface IRelationMetadata {
             parentEntityId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bruce-models",
-    "version": "4.1.4",
+    "version": "4.1.6",
     "description": "",
     "keywords": [],
     "main": "dist/bruce-models.umd.js",