bruce-models 7.1.98 → 7.1.100

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

@@ -64,7 +64,8 @@ export declare namespace Api {
         EntityHistoricDataSeries = "entityhistoricdataseries",
         EntityHistoricDataAnalysis = "entityhistoricdataanalysis",
         EntityHistoricDataPage = "entityhistoricdatapage",
-        AccountLimits = "accountlimits"
+        AccountLimits = "accountlimits",
+        WorkflowType = "workflowtype"
     }
     let DEFAULT_CACHE_DURATION: number;
     let TEMPLATE_ACCOUNT_ID: string;

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

@@ -117,4 +117,5 @@ export * from "./util/math-utils";
 export * from "./util/object-utils";
 export * from "./util/path-utils";
 export * from "./util/url-utils";
-export declare const VERSION = "7.1.98";
+export * from "./workflow/workflow-type";
+export declare const VERSION = "7.1.100";

package/dist/types/export/export-nsx.d.ts

@@ -2,15 +2,103 @@ import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
 import { PendingAction } from "../server/pending-action";
 export declare namespace ExportNsx {
+    interface IAccountBackupParams {
+        "ClientFileDownloadConcurrency"?: number;
+        "TilesetDownloadConcurrency"?: number;
+        "ReusePreviousBackupFileBodies"?: boolean;
+        "BaseBackup.StorePath"?: string;
+        [key: string]: any;
+    }
     interface IAccountBackupRes extends PendingAction.IAction {
         URL: string;
     }
+    interface IAccountBackupCompletionReport {
+        Message?: string;
+        "Account.ID"?: string;
+        "Created.UTC"?: string;
+        FileName?: string;
+        StorePath?: string;
+        "Size.Bytes"?: number;
+        "Download.URL"?: string;
+    }
+    interface IAccountBackupStats {
+        Counts?: any;
+        Timing?: any;
+        DatabaseBackedExport?: any;
+        RawConceptExport?: any;
+        TilesetFileExport?: any;
+        BaseAwareReuse?: {
+            Enabled?: boolean;
+            Strategy?: string;
+            BaseFound?: boolean;
+            "Base.StorePath"?: string;
+            "Base.Bytes"?: number;
+            Fallback?: string;
+            [key: string]: any;
+        };
+        [key: string]: any;
+    }
+    interface IAccountBackupPendingActionResult extends IAccountBackupCompletionReport {
+        RawConceptCounts?: any;
+        TilesetFiles?: any;
+        Report?: IAccountBackupCompletionReport;
+        Stats?: IAccountBackupStats;
+    }
+    interface IParsedAccountBackupResult {
+        accountId?: string;
+        createdUtc?: string;
+        fileName?: string;
+        storePath?: string;
+        sizeBytes?: number;
+        downloadUrl?: string;
+        message?: string;
+        report?: IAccountBackupCompletionReport;
+        stats?: IAccountBackupStats;
+        raw: IAccountBackupPendingActionResult | null;
+    }
+    interface IAccountBackupListRes {
+        files: string[];
+        nsxFiles: string[];
+    }
+    interface IDeleteAccountBackupRes {
+        Deleted: boolean;
+        FileName: string;
+        StorePath: string;
+    }
     /**
      * Starts a whole-account NSX backup export job.
      * The generated NSX file is stored in the account's configured backup file store.
      */
     function AccountBackup(params?: {
         api?: BruceApi.Api;
+        backup?: IAccountBackupParams;
         req?: Api.IReqParams;
     }): Promise<IAccountBackupRes>;
+    /**
+     * Returns available account backup files, including whole-account NSX backups.
+     */
+    function GetAccountBackupList(params?: {
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<IAccountBackupListRes>;
+    /**
+     * Downloads a saved whole-account NSX backup file.
+     */
+    function DownloadAccountBackup(params: {
+        api?: BruceApi.Api;
+        fileName: string;
+        req?: Api.IReqParams;
+    }): Promise<Blob | string | any>;
+    /**
+     * Deletes a saved whole-account NSX backup file.
+     */
+    function DeleteAccountBackup(params: {
+        api?: BruceApi.Api;
+        fileName: string;
+        req?: Api.IReqParams;
+    }): Promise<IDeleteAccountBackupRes>;
+    /**
+     * Parses the completed Pending Action result from running AccountBackup.
+     */
+    function ParseAccountBackupResult(paResult: string | Object | PendingAction.IAction<any>): IParsedAccountBackupResult;
 }

package/dist/types/server/pending-action.d.ts

@@ -9,14 +9,14 @@ export declare namespace PendingAction {
     /**
      * Describes a pending action record.
      */
-    interface IAction {
+    interface IAction<TResult = string> {
         ID: number;
         "CreatedBy.Application": string;
         "Created"?: string;
         "Updated"?: string;
         "Completed"?: string;
         "CreatedByUser.ID": string;
-        Result: string;
+        Result: TResult;
         Progress: number;
         Description: string;
         Status: EStatus;
@@ -30,6 +30,12 @@ export declare namespace PendingAction {
         Complete = "COMPLETE",
         Failed = "FAILED"
     }
+    /**
+     * Available server-side Pending Action result encodings.
+     */
+    enum EResultFormat {
+        JSON = "JSON"
+    }
     /**
      * Describes a pending action message record.
      */
@@ -55,12 +61,13 @@ export declare namespace PendingAction {
      * @param params
      * @returns
      */
-    function Get(params: {
+    function Get<TResult = string>(params: {
         api?: BruceApi.Api;
         actionId: number;
+        result?: EResultFormat;
         req?: Api.IReqParams;
     }): Promise<{
-        action: IAction;
+        action: IAction<TResult>;
     }>;
     /**
      * Returns a list of pending action records by their IDs.
@@ -134,15 +141,16 @@ export declare namespace PendingAction {
      * });
      * // Action will resolve as null if it was disposed early.
      */
-    function OnCompletion(params: {
+    function OnCompletion<TResult = string>(params: {
         api?: BruceApi.Api;
         actionId: number;
         interval?: number;
         isDisposed?: () => boolean;
         onMessage?: (message: IMessage) => void;
+        result?: EResultFormat;
         req?: Api.IReqParams;
     }): Promise<{
-        action: IAction | null;
+        action: IAction<TResult> | null;
         messages: IMessage[];
     }>;
 }

package/dist/types/workflow/workflow-type.d.ts

@@ -0,0 +1,158 @@
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+type WorkflowTypeId = number | string;
+type WorkflowStatusId = number | string;
+/**
+ * Describes the "Workflow Type" concept within Nextspace.
+ * The API names this record Workflow Item Type.
+ */
+export declare namespace WorkflowType {
+    /**
+     * Describes a workflow type record.
+     */
+    interface IType {
+        ID?: number;
+        DisplayName?: string;
+        Description?: string;
+        Color?: string;
+        "Default.Status.ID"?: number;
+        "Default.Queue.ID"?: number;
+        "Default.EntityType.ID"?: string;
+        StatusSettingsDiagram?: any;
+        [key: string]: any;
+    }
+    /**
+     * Describes a workflow status record returned by workflow type status calls.
+     */
+    interface IStatus {
+        ID?: number;
+        Type?: string;
+        DisplayName?: string;
+        Description?: string;
+        Color?: string;
+        IsEnd?: boolean;
+        "NextStatus.ID"?: number[];
+        [key: string]: any;
+    }
+    type IBruceWorkflowItemType = IType;
+    /**
+     * Gets a workflow type by ID.
+     * @param params
+     */
+    function Get(params: {
+        api?: BruceApi.Api;
+        workflowTypeId: WorkflowTypeId;
+        req?: Api.IReqParams;
+    }): Promise<{
+        workflowType: IType;
+    }>;
+    /**
+     * Gets all workflow types.
+     * @param params
+     */
+    function GetList(params?: {
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        workflowTypes: IType[];
+    }>;
+    /**
+     * Creates or updates a workflow type.
+     * This calls: POST workflow/type/{workflow_type_id} where 0 creates new.
+     * @param params
+     */
+    function Update(params: {
+        api?: BruceApi.Api;
+        workflowType: IType;
+        req?: Api.IReqParams;
+    }): Promise<{
+        workflowType: IType;
+    }>;
+    /**
+     * Deletes a workflow type by ID.
+     * @param params
+     */
+    function Delete(params: {
+        api?: BruceApi.Api;
+        workflowTypeId: WorkflowTypeId;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    /**
+     * Gets the workflow statuses enabled for a workflow type.
+     * @param params
+     */
+    function GetStatuses(params: {
+        api?: BruceApi.Api;
+        workflowTypeId: WorkflowTypeId;
+        req?: Api.IReqParams;
+    }): Promise<{
+        statuses: IStatus[];
+    }>;
+    /**
+     * Adds statuses to the list enabled for a workflow type.
+     * @param params
+     */
+    function AddStatuses(params: {
+        api?: BruceApi.Api;
+        workflowTypeId: WorkflowTypeId;
+        workflowStatusIds: WorkflowStatusId[];
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    /**
+     * Removes statuses from the list enabled for a workflow type.
+     * @param params
+     */
+    function RemoveStatuses(params: {
+        api?: BruceApi.Api;
+        workflowTypeId: WorkflowTypeId;
+        workflowStatusIds: WorkflowStatusId[];
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    /**
+     * Normalizes response from workflow type get/update endpoints.
+     */
+    function ParseResponse(response: IType | {
+        WorkflowType?: IType;
+        WorkflowItemType?: IType;
+        BruceWorkflowItemType?: IType;
+        Result?: IType | string;
+    } | string | any): IType;
+    /**
+     * Normalizes response from workflow type list endpoints.
+     */
+    function ParseListResponse(response: Api.IList<IType> | IType[] | {
+        WorkflowTypes?: IType[];
+        WorkflowItemTypes?: IType[];
+        BruceWorkflowItemTypes?: IType[];
+        Result?: Api.IList<IType> | IType[] | string;
+    } | string | any): IType[];
+    /**
+     * Normalizes response from workflow type status list endpoints.
+     */
+    function ParseStatusListResponse(response: Api.IList<IStatus> | IStatus[] | {
+        Statuses?: IStatus[];
+        WorkflowStatuses?: IStatus[];
+        WorkflowItemStatuses?: IStatus[];
+        BruceWorkflowItemStatuses?: IStatus[];
+        Result?: Api.IList<IStatus> | IStatus[] | string;
+    } | string | any): IStatus[];
+    /**
+     * Returns cache identifier for a workflow type by ID.
+     * @param id
+     * @returns
+     */
+    function GetCacheKey(id: WorkflowTypeId): string;
+    /**
+     * Returns cache identifier for the workflow type list.
+     * @returns
+     */
+    function GetListCacheKey(): string;
+    /**
+     * Returns cache identifier for the statuses enabled for a workflow type.
+     * @param workflowTypeId
+     * @returns
+     */
+    function GetStatusesCacheKey(workflowTypeId: WorkflowTypeId): string;
+}
+export import WorkflowItemType = WorkflowType;
+export {};

package/package.json

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