bruce-models 4.8.8 → 4.8.9

package/dist/lib/bruce-models.js

@@ -103,5 +103,5 @@ __exportStar(require("./plugin/plugin"), exports);
 __exportStar(require("./environment"), exports);
 __exportStar(require("./data-source/data-source"), exports);
 // This is updated with the package.json version on build.
-exports.VERSION = "4.8.8";
+exports.VERSION = "4.8.9";
 //# sourceMappingURL=bruce-models.js.map

package/dist/lib/data-lab/data-lab.js

@@ -24,6 +24,48 @@ var DataLab;
         EReqKey["Primary"] = "PrimarySelection";
         EReqKey["Secondary"] = "SecondarySelection";
     })(EReqKey = DataLab.EReqKey || (DataLab.EReqKey = {}));
+    /**
+     * Returns the list of saved queries in the account.
+     * @param params
+     * @returns
+     */
+    function GetList(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!params) {
+                params = {};
+            }
+            let { api, req } = params;
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
+            const res = yield api.GET("entities/datalab/savedQueries", api_1.Api.PrepReqParams(req));
+            return {
+                queries: (res === null || res === void 0 ? void 0 : res.Items) ? res.Items : []
+            };
+        });
+    }
+    DataLab.GetList = GetList;
+    /**
+     * Returns a saved query by ID.
+     * @param params
+     * @returns
+     */
+    function Get(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, queryId, req } = params;
+            if (queryId) {
+                throw new Error("queryId is required.");
+            }
+            if (!api) {
+                api = environment_1.ENVIRONMENT.Api().GetBruceApi();
+            }
+            const res = yield api.GET(`entities/datalab/savedQuery/${queryId}`, api_1.Api.PrepReqParams(req));
+            return {
+                query: res
+            };
+        });
+    }
+    DataLab.Get = Get;
     /**
      * Runs a DataLab query.
      * @param params

package/dist/lib/data-lab/data-lab.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-lab.js","sourceRoot":"","sources":["../../../src/data-lab/data-lab.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAEjC,gDAA6C;AAG7C;;;;GAIG;AACH,IAAiB,OAAO,CAyFvB;AAzFD,WAAiB,OAAO;IAcpB,IAAY,OAGX;IAHD,WAAY,OAAO;QACf,uCAA4B,CAAA;QAC5B,2CAAgC,CAAA;IACpC,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB;IAED;;;;OAIG;IACH,SAAsB,GAAG,CAAC,MAiBzB;;YAQG,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;YACjF,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;aACzB;YACD,IAAI,CAAC,IAAI,EAAE;gBACP,IAAI,GAAG,CAAC,CAAC;aACZ;YACD,IAAI,CAAC,IAAI,EAAE;gBACP,IAAI,GAAG,EAAE,CAAC;aACb;YAED,IAAI,GAAG,GAAG,IAAI,CAAC;YACf,IAAI,QAAQ,EAAE;gBACV,GAAG,GAAG,mDAAmD,CAAC;aAC7D;iBACI;gBACD,GAAG,GAAG,wCAAwC,GAAG,SAAS,IAAI,SAAS,IAAI,gBAAgB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;aAClH;YAED,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,EACpB,KAAK,EACL,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAC/B,CAAC;YACF,MAAM,IAAI,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACtD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC;oBACvB,GAAG,CAAC;wBACA,QAAQ,EAAE,IAAI,CAAC,KAAK;wBACpB,UAAU,EAAE,IAAI,CAAC,YAAY;qBAChC,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAhEqB,WAAG,MAgExB,CAAA;AACL,CAAC,EAzFgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAyFvB"}
+{"version":3,"file":"data-lab.js","sourceRoot":"","sources":["../../../src/data-lab/data-lab.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAEjC,gDAA6C;AAM7C;;;;GAIG;AACH,IAAiB,OAAO,CAgNvB;AAhND,WAAiB,OAAO;IA+BpB,IAAY,OAGX;IAHD,WAAY,OAAO;QACf,uCAA4B,CAAA;QAC5B,2CAAgC,CAAA;IACpC,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB;IAmDD;;;;OAIG;IACH,SAAsB,OAAO,CAAC,MAG7B;;YAGG,IAAI,CAAC,MAAM,EAAE;gBACT,MAAM,GAAG,EAAS,CAAC;aACtB;YACD,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAC1B,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,+BAA+B,EAAE,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YACnF,OAAO;gBACH,OAAO,EAAE,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,EAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;aACvC,CAAA;QACL,CAAC;KAAA;IAlBqB,eAAO,UAkB5B,CAAA;IAED;;;;OAIG;IACH,SAAsB,GAAG,CAAC,MAIzB;;YAGG,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAEnC,IAAI,OAAO,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;aAC3C;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,+BAA+B,OAAO,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YAE5F,OAAO;gBACH,KAAK,EAAE,GAAG;aACb,CAAA;QACL,CAAC;KAAA;IArBqB,WAAG,MAqBxB,CAAA;IAED;;;;OAIG;IACH,SAAsB,GAAG,CAAC,MAiBzB;;YAQG,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;YACjF,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;aACzB;YACD,IAAI,CAAC,IAAI,EAAE;gBACP,IAAI,GAAG,CAAC,CAAC;aACZ;YACD,IAAI,CAAC,IAAI,EAAE;gBACP,IAAI,GAAG,EAAE,CAAC;aACb;YAED,IAAI,GAAG,GAAG,IAAI,CAAC;YACf,IAAI,QAAQ,EAAE;gBACV,GAAG,GAAG,mDAAmD,CAAC;aAC7D;iBACI;gBACD,GAAG,GAAG,wCAAwC,GAAG,SAAS,IAAI,SAAS,IAAI,gBAAgB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;aAClH;YAED,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,EACpB,KAAK,EACL,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAC/B,CAAC;YACF,MAAM,IAAI,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACtD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC;oBACvB,GAAG,CAAC;wBACA,QAAQ,EAAE,IAAI,CAAC,KAAK;wBACpB,UAAU,EAAE,IAAI,CAAC,YAAY;qBAChC,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QAChB,CAAC;KAAA;IAhEqB,WAAG,MAgExB,CAAA;AACL,CAAC,EAhNgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAgNvB"}

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

@@ -85,4 +85,4 @@ export * from "./internal/uploader";
 export * from "./plugin/plugin";
 export * from "./environment";
 export * from "./data-source/data-source";
-export declare const VERSION = "4.8.8";
+export declare const VERSION = "4.8.9";

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

@@ -1,17 +1,35 @@
 import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
 import { Entity as E } from "../entity/entity";
+import { UTC } from "../common/utc";
+type _any = any;
 /**
  * Describes the "Data Lab" concept within Nextspace.
  * Data lab is a query tool that allows users to search for entities.
  * Data lab queries can be saved for reuse.
  */
 export declare namespace DataLab {
+    /**
+     * Describes a saved query.
+     * When retrieving the list it will have a reduced set of properties.
+     * Eg: missing the criteria and action.
+     */
+    interface ISavedQuery {
+        ID?: number;
+        DisplayName: string;
+        Description?: string;
+        "Created.DateTime"?: UTC.IUTC;
+        "CreatedBy.User.ID"?: string;
+        MatchingEntitiesAction?: any;
+        PrimarySelectionCriteria?: {
+            Items: ICriterion[];
+        };
+    }
     interface IQuery {
         [EReqKey.Primary]: {
             OrderBy?: string;
             SortOrder?: Api.ESortOrderStr;
-            Items: any[];
+            Items: ICriterion[];
         };
         [EReqKey.Secondary]?: any;
         Action?: string;
@@ -22,6 +40,65 @@ export declare namespace DataLab {
         Primary = "PrimarySelection",
         Secondary = "SecondarySelection"
     }
+    interface ICriterion extends _any {
+        key?: "attribute" | "entityType" | "root" | string;
+        LogicOperator?: "AND" | "OR" | string;
+    }
+    type CriterionAttrOperator = ">" | "<" | ">=" | "<=" | "=" | "EQUALS TO" | "CONTAINS" | "STARTS WITH" | "ENDS WITH" | "NULLOREMPTY" | "NULL" | "IS BETWEEN";
+    type CriterionValueOption = "USER" | "CONST" | "PRIMARY" | null;
+    /**
+     * Criterion for filtering against an Entity's attribute.
+     */
+    interface ICriterionAttribute extends ICriterion {
+        key: "attribute";
+        AttributeValue?: {
+            AttributePath?: string;
+            OperandA?: string | number;
+            Operator?: CriterionAttrOperator;
+            ValueOption?: CriterionValueOption;
+            SelectedValueOptionA?: CriterionValueOption;
+        };
+    }
+    /**
+     * Criterion for filtering against Entities that sit inside a specified Entity Type.
+     */
+    interface ICriterionEntityType extends ICriterion {
+        key: "entityType";
+        EntityType?: {
+            "EntityType.ID"?: string;
+        };
+    }
+    /**
+     * Criterion for filtering against Entities that sit inside an assembly hierarchy.
+     * Specify either one or many root Entity IDs to restrict the search to.
+     */
+    interface ICriterionWithinAssembly extends ICriterion {
+        key: "root";
+        RootID?: string | string[];
+    }
+    /**
+     * Returns the list of saved queries in the account.
+     * @param params
+     * @returns
+     */
+    function GetList(params?: {
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        queries: ISavedQuery[];
+    }>;
+    /**
+     * Returns a saved query by ID.
+     * @param params
+     * @returns
+     */
+    function Get(params: {
+        queryId: number;
+        api?: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        query: ISavedQuery;
+    }>;
     /**
      * Runs a DataLab query.
      * @param params
@@ -41,3 +118,4 @@ export declare namespace DataLab {
         totalCount?: number;
     }>;
 }
+export {};

package/package.json

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