bruce-models 4.4.1 → 4.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/bruce-models.es5.js +20 -2
  2. package/dist/bruce-models.es5.js.map +1 -1
  3. package/dist/bruce-models.umd.js +16 -1
  4. package/dist/bruce-models.umd.js.map +1 -1
  5. package/dist/lib/bruce-models.js +1 -1
  6. package/dist/lib/entity/entity-table-view.js +19 -1
  7. package/dist/lib/entity/entity-table-view.js.map +1 -1
  8. package/dist/types/bruce-models.d.ts +1 -1
  9. package/dist/types/entity/entity-table-view.d.ts +39 -6
  10. package/package.json +1 -1
package/dist/lib/bruce-models.js CHANGED
@@ -100,5 +100,5 @@ __exportStar(require("./plugin/plugin"), exports);
100
100
  __exportStar(require("./environment"), exports);
101
101
  __exportStar(require("./data-source/data-source"), exports);
102
102
  // This is updated with the package.json version on build.
103
- exports.VERSION = "4.4.1";
103
+ exports.VERSION = "4.4.2";
104
104
  //# sourceMappingURL=bruce-models.js.map
package/dist/lib/entity/entity-table-view.js CHANGED
@@ -12,9 +12,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.EntityTableView = void 0;
13
13
  const api_1 = require("../api/api");
14
14
  const environment_1 = require("../environment");
15
- // TODO: comments when first MVP is done with using these requests.
15
+ /**
16
+ * Represents a Table View record.
17
+ * This is a record of how to display a collection of Entities.
18
+ */
16
19
  var EntityTableView;
17
20
  (function (EntityTableView) {
21
+ /**
22
+ * Returns a record matching the given viewId.
23
+ * @param params
24
+ */
18
25
  function Get(params) {
19
26
  return __awaiter(this, void 0, void 0, function* () {
20
27
  let { viewId, api, req } = params;
@@ -29,6 +36,10 @@ var EntityTableView;
29
36
  });
30
37
  }
31
38
  EntityTableView.Get = Get;
39
+ /**
40
+ * Returns the list of all available Table Views.
41
+ * @param params
42
+ */
32
43
  function GetList(params) {
33
44
  return __awaiter(this, void 0, void 0, function* () {
34
45
  if (!params) {
@@ -50,6 +61,9 @@ var EntityTableView;
50
61
  });
51
62
  }
52
63
  EntityTableView.GetList = GetList;
64
+ /**
65
+ * Creates or updates a Table View record.
66
+ */
53
67
  function Update(params) {
54
68
  return __awaiter(this, void 0, void 0, function* () {
55
69
  let { view, api, req } = params;
@@ -69,6 +83,10 @@ var EntityTableView;
69
83
  });
70
84
  }
71
85
  EntityTableView.Update = Update;
86
+ /**
87
+ * Deletes a Table View record.
88
+ * @param params
89
+ */
72
90
  function Delete(params) {
73
91
  return __awaiter(this, void 0, void 0, function* () {
74
92
  let { viewId, api, req } = params;
package/dist/lib/entity/entity-table-view.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"entity-table-view.js","sourceRoot":"","sources":["../../../src/entity/entity-table-view.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAEjC,gDAA6C;AAE7C,mEAAmE;AAEnE,IAAiB,eAAe,CA2F/B;AA3FD,WAAiB,eAAe;IAQ5B,SAAsB,GAAG,CAAC,MAIzB;;YAGG,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAClC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,GAAG,GAAG,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAE7B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,gBAAgB,MAAM,EAAE,EAAE,GAAG,CAAC,CAAC;YAEzD,OAAO;gBACH,IAAI,EAAE,GAAG;aACZ,CAAC;QACN,CAAC;KAAA;IAlBqB,mBAAG,MAkBxB,CAAA;IAED,SAAsB,OAAO,CAAC,MAG7B;;YAGG,IAAI,CAAC,MAAM,EAAE;gBACT,MAAM,GAAG,EAAE,CAAC;aACf;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;YACD,GAAG,GAAG,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAE7B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;YAChD,IAAI,KAAK,GAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAC;YACvB,IAAI,CAAC,KAAK,EAAE;gBACR,KAAK,GAAG,EAAE,CAAC;aACd;YAED,OAAO;gBACH,KAAK,EAAE,KAAK;aACf,CAAA;QACL,CAAC;KAAA;IAxBqB,uBAAO,UAwB5B,CAAA;IAED,SAAsB,MAAM,CAAC,MAI5B;;YAGG,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAChC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,GAAG,GAAG,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAE7B,IAAI,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,EAAE;gBACT,cAAc;gBACd,MAAM,GAAG,CAAC,CAAC;aACd;YACD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,gBAAgB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YAEhE,OAAO;gBACH,IAAI,EAAE,GAAG;aACZ,CAAC;QACN,CAAC;KAAA;IAvBqB,sBAAM,SAuB3B,CAAA;IAED,SAAsB,MAAM,CAAC,MAI5B;;YACG,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAClC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,GAAG,GAAG,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAC7B,OAAO,MAAM,GAAG,CAAC,MAAM,CAAC,gBAAgB,MAAM,EAAE,EAAE,GAAG,CAAC,CAAC;QAC3D,CAAC;KAAA;IAXqB,sBAAM,SAW3B,CAAA;AACL,CAAC,EA3FgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA2F/B"}
1
+ {"version":3,"file":"entity-table-view.js","sourceRoot":"","sources":["../../../src/entity/entity-table-view.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAGjC,gDAA6C;AAE7C;;;GAGG;AACH,IAAiB,eAAe,CAgI/B;AAhID,WAAiB,eAAe;IA8B5B;;;OAGG;IACH,SAAsB,GAAG,CAAC,MAIzB;;YAGG,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAClC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,GAAG,GAAG,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAE7B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,gBAAgB,MAAM,EAAE,EAAE,GAAG,CAAC,CAAC;YAEzD,OAAO;gBACH,IAAI,EAAE,GAAG;aACZ,CAAC;QACN,CAAC;KAAA;IAlBqB,mBAAG,MAkBxB,CAAA;IAED;;;OAGG;IACH,SAAsB,OAAO,CAAC,MAG7B;;YAGG,IAAI,CAAC,MAAM,EAAE;gBACT,MAAM,GAAG,EAAE,CAAC;aACf;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;YACD,GAAG,GAAG,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAE7B,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;YAChD,IAAI,KAAK,GAAG,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAC;YACvB,IAAI,CAAC,KAAK,EAAE;gBACR,KAAK,GAAG,EAAE,CAAC;aACd;YAED,OAAO;gBACH,KAAK,EAAE,KAAK;aACf,CAAA;QACL,CAAC;KAAA;IAxBqB,uBAAO,UAwB5B,CAAA;IAED;;OAEG;IACH,SAAsB,MAAM,CAAC,MAI5B;;YAGG,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAChC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,GAAG,GAAG,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAE7B,IAAI,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,EAAE;gBACT,cAAc;gBACd,MAAM,GAAG,CAAC,CAAC;aACd;YACD,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,gBAAgB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YAEhE,OAAO;gBACH,IAAI,EAAE,GAAG;aACZ,CAAC;QACN,CAAC;KAAA;IAvBqB,sBAAM,SAuB3B,CAAA;IAED;;;OAGG;IACH,SAAsB,MAAM,CAAC,MAI5B;;YACG,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC;YAClC,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,GAAG,GAAG,SAAG,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;YAC7B,OAAO,MAAM,GAAG,CAAC,MAAM,CAAC,gBAAgB,MAAM,EAAE,EAAE,GAAG,CAAC,CAAC;QAC3D,CAAC;KAAA;IAXqB,sBAAM,SAW3B,CAAA;AACL,CAAC,EAhIgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAgI/B"}
package/dist/types/bruce-models.d.ts CHANGED
@@ -82,4 +82,4 @@ export * from "./internal/uploader";
82
82
  export * from "./plugin/plugin";
83
83
  export * from "./environment";
84
84
  export * from "./data-source/data-source";
85
- export declare const VERSION = "4.4.1";
85
+ export declare const VERSION = "4.4.2";
package/dist/types/entity/entity-table-view.d.ts CHANGED
@@ -1,35 +1,68 @@
1
1
  import { Api } from "../api/api";
2
2
  import { BruceApi } from "../api/bruce-api";
3
+ import { Calculator } from "../calculator/calculator";
4
+ /**
5
+ * Represents a Table View record.
6
+ * This is a record of how to display a collection of Entities.
7
+ */
3
8
  export declare namespace EntityTableView {
4
- interface IView {
9
+ export interface IView {
5
10
  ID?: number;
6
11
  DisplayName: string;
7
12
  Description?: string;
8
- Settings?: any;
13
+ Settings?: {
14
+ columns?: IColumn[];
15
+ };
9
16
  }
10
- function Get(params: {
17
+ /**
18
+ * Represents a column in a table view.
19
+ */
20
+ interface IColumn {
21
+ name: string;
22
+ attrPath?: string;
23
+ type: "ATTRIBUTE" | "TEXT" | "NAME" | "CALCULATOR";
24
+ calcType?: "COLOR" | "NUMBER" | "TEXT";
25
+ calcValue?: Calculator.IField[];
26
+ }
27
+ /**
28
+ * Returns a record matching the given viewId.
29
+ * @param params
30
+ */
31
+ export function Get(params: {
11
32
  viewId: number;
12
33
  api?: BruceApi.Api;
13
34
  req?: Api.IReqParams;
14
35
  }): Promise<{
15
36
  view: IView;
16
37
  }>;
17
- function GetList(params?: {
38
+ /**
39
+ * Returns the list of all available Table Views.
40
+ * @param params
41
+ */
42
+ export function GetList(params?: {
18
43
  api?: BruceApi.Api;
19
44
  req?: Api.IReqParams;
20
45
  }): Promise<{
21
46
  views?: IView[];
22
47
  }>;
23
- function Update(params: {
48
+ /**
49
+ * Creates or updates a Table View record.
50
+ */
51
+ export function Update(params: {
24
52
  view: IView;
25
53
  api?: BruceApi.Api;
26
54
  req?: Api.IReqParams;
27
55
  }): Promise<{
28
56
  view: IView;
29
57
  }>;
30
- function Delete(params: {
58
+ /**
59
+ * Deletes a Table View record.
60
+ * @param params
61
+ */
62
+ export function Delete(params: {
31
63
  viewId: number;
32
64
  api?: BruceApi.Api;
33
65
  req?: Api.IReqParams;
34
66
  }): Promise<void>;
67
+ export {};
35
68
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bruce-models",
3
- "version": "4.4.1",
3
+ "version": "4.4.2",
4
4
  "description": "",
5
5
  "keywords": [],
6
6
  "main": "dist/bruce-models.umd.js",