bruce-models 7.1.109 → 7.1.111

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.
@@ -140,5 +140,5 @@ __exportStar(require("./workflow/workflow-item"), exports);
140
140
  __exportStar(require("./workflow/workflow-schedule"), exports);
141
141
  __exportStar(require("./workflow/workflow-type"), exports);
142
142
  // This is updated with the package.json version on build.
143
- exports.VERSION = "7.1.109";
143
+ exports.VERSION = "7.1.111";
144
144
  //# sourceMappingURL=bruce-models.js.map
@@ -14,6 +14,34 @@ const api_1 = require("../api/api");
14
14
  const environment_1 = require("../environment");
15
15
  var OntologyDocument;
16
16
  (function (OntologyDocument) {
17
+ let ESummaryStatus;
18
+ (function (ESummaryStatus) {
19
+ // No summary is linked.
20
+ ESummaryStatus["None"] = "none";
21
+ // Produced from the PDF's current Version, so it can stand in for the PDF.
22
+ ESummaryStatus["Current"] = "current";
23
+ // Produced from another or an unknown Version. Keep it for review, but read the PDF instead.
24
+ ESummaryStatus["Outdated"] = "outdated";
25
+ })(ESummaryStatus = OntologyDocument.ESummaryStatus || (OntologyDocument.ESummaryStatus = {}));
26
+ /**
27
+ * Returns whether the record's summary may be used in place of its PDF.
28
+ * It is only current while its file exists and it was produced from the PDF's current Version.
29
+ * An unknown version counts as outdated, so a replaced PDF never passes its old summary off as current.
30
+ * @param record Record as returned by the API, including its nested ClientFile and SummaryClientFile.
31
+ */
32
+ function GetSummaryStatus(record) {
33
+ var _a;
34
+ if (!(record === null || record === void 0 ? void 0 : record["SummaryClientFile.ID"])) {
35
+ return ESummaryStatus.None;
36
+ }
37
+ const sourceVersion = record.SummarySourceVersion;
38
+ const currentVersion = (_a = record.ClientFile) === null || _a === void 0 ? void 0 : _a.Version;
39
+ if (!record.SummaryClientFile || sourceVersion == null || currentVersion == null) {
40
+ return ESummaryStatus.Outdated;
41
+ }
42
+ return Number(sourceVersion) === Number(currentVersion) ? ESummaryStatus.Current : ESummaryStatus.Outdated;
43
+ }
44
+ OntologyDocument.GetSummaryStatus = GetSummaryStatus;
17
45
  function GetListByOntologyId(params) {
18
46
  return __awaiter(this, void 0, void 0, function* () {
19
47
  let { api, ontologyId, req: reqParams } = params;
@@ -82,6 +110,44 @@ var OntologyDocument;
82
110
  });
83
111
  }
84
112
  OntologyDocument.GetListByClientFileId = GetListByClientFileId;
113
+ /**
114
+ * Returns the documents that use the given ClientFile as their summary.
115
+ * GetListByClientFileId() only matches documents made of the file, so check both before deleting a file.
116
+ */
117
+ function GetListBySummaryClientFileId(params) {
118
+ return __awaiter(this, void 0, void 0, function* () {
119
+ let { api, clientFileId, req: reqParams } = params;
120
+ if (!clientFileId) {
121
+ throw ("Client file ID is required.");
122
+ }
123
+ if (!api) {
124
+ api = environment_1.ENVIRONMENT.Api().GetBruceApi();
125
+ }
126
+ const key = GetSummaryListCacheKey(clientFileId);
127
+ const cache = api.GetCacheItem(key, reqParams);
128
+ if (cache === null || cache === void 0 ? void 0 : cache.found) {
129
+ return cache.data;
130
+ }
131
+ const req = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
132
+ try {
133
+ const data = yield api.GET(`ontology/documents?summary_client_file_id=${encodeURIComponent(clientFileId)}`, api_1.Api.PrepReqParams(reqParams));
134
+ res({
135
+ ontologyDocuments: ParseListResponse(data)
136
+ });
137
+ }
138
+ catch (e) {
139
+ rej(e);
140
+ }
141
+ }));
142
+ api.SetCacheItem({
143
+ key,
144
+ value: req,
145
+ req: reqParams
146
+ });
147
+ return req;
148
+ });
149
+ }
150
+ OntologyDocument.GetListBySummaryClientFileId = GetListBySummaryClientFileId;
85
151
  function Update(params) {
86
152
  return __awaiter(this, void 0, void 0, function* () {
87
153
  let { api, ontologyDocument: data, req: reqParams } = params;
@@ -95,7 +161,8 @@ var OntologyDocument;
95
161
  if (data.ID) {
96
162
  api.Cache.Remove(GetCacheKey(data.ID));
97
163
  }
98
- api.Cache.RemoveByStartsWith(GetListCacheKey(data["Ontology.ID"]));
164
+ // A save can move a document in or out of any list, eg: by linking a different summary file.
165
+ api.Cache.RemoveByStartsWith(GetListCacheKeyPrefix());
99
166
  return {
100
167
  ontologyDocument: ParseResponse(res)
101
168
  };
@@ -113,7 +180,8 @@ var OntologyDocument;
113
180
  }
114
181
  yield api.DELETE(`ontology/document/${documentId}`, api_1.Api.PrepReqParams(reqParams));
115
182
  api.Cache.Remove(GetCacheKey(documentId));
116
- api.Cache.RemoveByStartsWith(GetListCacheKey(documentId));
183
+ // Only the document ID is known here, not the lists it was part of.
184
+ api.Cache.RemoveByStartsWith(GetListCacheKeyPrefix());
117
185
  });
118
186
  }
119
187
  OntologyDocument.Delete = Delete;
@@ -140,9 +208,18 @@ var OntologyDocument;
140
208
  }
141
209
  OntologyDocument.GetCacheKey = GetCacheKey;
142
210
  function GetListCacheKey(id) {
143
- return api_1.Api.ECacheKey.Ontology + ":documents:" + id;
211
+ return GetListCacheKeyPrefix() + id;
144
212
  }
145
213
  OntologyDocument.GetListCacheKey = GetListCacheKey;
214
+ function GetSummaryListCacheKey(clientFileId) {
215
+ return GetListCacheKeyPrefix() + "summary:" + clientFileId;
216
+ }
217
+ OntologyDocument.GetSummaryListCacheKey = GetSummaryListCacheKey;
218
+ // Shared by every document list cache key.
219
+ function GetListCacheKeyPrefix() {
220
+ return api_1.Api.ECacheKey.Ontology + ":documents:";
221
+ }
222
+ OntologyDocument.GetListCacheKeyPrefix = GetListCacheKeyPrefix;
146
223
  })(OntologyDocument = exports.OntologyDocument || (exports.OntologyDocument = {}));
147
224
  function parseObject(data) {
148
225
  if (data == null || data == undefined) {
@@ -1 +1 @@
1
- {"version":3,"file":"ontology-document.js","sourceRoot":"","sources":["../../../src/entity/ontology-document.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAGjC,gDAA6C;AAE7C,IAAiB,gBAAgB,CA0KhC;AA1KD,WAAiB,gBAAgB;IAa7B,SAAsB,mBAAmB,CAAC,MAIzC;;YAGG,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACjD,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE;gBACzC,MAAK,CAAC,0BAA0B,CAAC,CAAC;aACrC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;YACxC,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC/C,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YAED,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,kCAAkC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBACrI,GAAG,CAAC;wBACA,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC;qBAC7C,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YAEH,GAAG,CAAC,YAAY,CAAC;gBACb,GAAG;gBACH,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAvCqB,oCAAmB,sBAuCxC,CAAA;IAED,SAAsB,qBAAqB,CAAC,MAI3C;;YAGG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACnD,IAAI,CAAC,YAAY,EAAE;gBACf,MAAK,CAAC,6BAA6B,CAAC,CAAC;aACxC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC/C,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YAED,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,qCAAqC,kBAAkB,CAAC,YAAY,CAAC,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBAClI,GAAG,CAAC;wBACA,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC;qBAC7C,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YAEH,GAAG,CAAC,YAAY,CAAC;gBACb,GAAG;gBACH,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAvCqB,sCAAqB,wBAuC1C,CAAA;IAED,SAAsB,MAAM,CAAC,MAI5B;;YAGG,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,IAAI,CAAC,IAAI,EAAE;gBACP,IAAI,GAAG,EAAa,CAAC;aACxB;YAED,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YACpF,IAAI,IAAI,CAAC,EAAE,EAAE;gBACT,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;aAC1C;YACD,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YACnE,OAAO;gBACH,gBAAgB,EAAE,aAAa,CAAC,GAAG,CAAC;aACvC,CAAC;QACN,CAAC;KAAA;IAvBqB,uBAAM,SAuB3B,CAAA;IAED,SAAsB,MAAM,CAAC,MAI5B;;YACG,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACjD,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE;gBACzC,MAAK,CAAC,mCAAmC,CAAC,CAAC;aAC9C;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,CAAC,MAAM,CAAC,qBAAqB,UAAU,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAClF,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;YAC1C,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC;QAC9D,CAAC;KAAA;IAhBqB,uBAAM,SAgB3B,CAAA;IAED,SAAgB,aAAa,CAAC,QAA4F;;QACtH,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,YAAY,GAAG,MAAA,WAAW,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,mCAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC;QACnE,OAAO,MAAA,MAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,mCACxB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,gBAAgB,mCAC9B,YAAY,mCACZ,MAAM,CAAC;IAClB,CAAC;IAPe,8BAAa,gBAO5B,CAAA;IAED,SAAgB,iBAAiB,CAAC,QAAgK;;QAC9L,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,YAAY,GAAG,MAAA,WAAW,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,mCAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC;QACnE,MAAM,IAAI,GAAG,MAAA,MAAA,MAAA,MAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCACnB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,KAAK,mCACnB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB,mCACzB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,iBAAiB,mCAC/B,YAAY,mCACZ,MAAM,CAAC;QAEd,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACrB,OAAO,IAAI,CAAC;SACf;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAde,kCAAiB,oBAchC,CAAA;IAED,SAAgB,WAAW,CAAC,EAAmB;QAC3C,OAAO,SAAG,CAAC,SAAS,CAAC,QAAQ,GAAG,YAAY,GAAG,EAAE,CAAC;IACtD,CAAC;IAFe,4BAAW,cAE1B,CAAA;IAED,SAAgB,eAAe,CAAC,EAAmB;QAC/C,OAAO,SAAG,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,GAAG,EAAE,CAAC;IACvD,CAAC;IAFe,gCAAe,kBAE9B,CAAA;AACL,CAAC,EA1KgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QA0KhC;AAED,SAAS,WAAW,CAAC,IAAS;IAC1B,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,SAAS,EAAE;QACnC,OAAO,IAAI,CAAC;KACf;IACD,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QACzB,IAAI;YACA,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC3B;QACD,WAAM;YACF,OAAO,IAAI,CAAC;SACf;KACJ;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}
1
+ {"version":3,"file":"ontology-document.js","sourceRoot":"","sources":["../../../src/entity/ontology-document.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAAiC;AAGjC,gDAA6C;AAE7C,IAAiB,gBAAgB,CAwQhC;AAxQD,WAAiB,gBAAgB;IAwB7B,IAAY,cAOX;IAPD,WAAY,cAAc;QACtB,wBAAwB;QACxB,+BAAa,CAAA;QACb,2EAA2E;QAC3E,qCAAmB,CAAA;QACnB,6FAA6F;QAC7F,uCAAqB,CAAA;IACzB,CAAC,EAPW,cAAc,GAAd,+BAAc,KAAd,+BAAc,QAOzB;IAED;;;;;OAKG;IACH,SAAgB,gBAAgB,CAAC,MAAe;;QAC5C,IAAI,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAG,sBAAsB,CAAC,CAAA,EAAE;YACnC,OAAO,cAAc,CAAC,IAAI,CAAC;SAC9B;QACD,MAAM,aAAa,GAAG,MAAM,CAAC,oBAAoB,CAAC;QAClD,MAAM,cAAc,GAAG,MAAA,MAAM,CAAC,UAAU,0CAAE,OAAO,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,iBAAiB,IAAI,aAAa,IAAI,IAAI,IAAI,cAAc,IAAI,IAAI,EAAE;YAC9E,OAAO,cAAc,CAAC,QAAQ,CAAC;SAClC;QACD,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC;IAC/G,CAAC;IAVe,iCAAgB,mBAU/B,CAAA;IAED,SAAsB,mBAAmB,CAAC,MAIzC;;YAGG,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACjD,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE;gBACzC,MAAK,CAAC,0BAA0B,CAAC,CAAC;aACrC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;YACxC,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC/C,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YAED,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,kCAAkC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBACrI,GAAG,CAAC;wBACA,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC;qBAC7C,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YAEH,GAAG,CAAC,YAAY,CAAC;gBACb,GAAG;gBACH,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAvCqB,oCAAmB,sBAuCxC,CAAA;IAED,SAAsB,qBAAqB,CAAC,MAI3C;;YAGG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACnD,IAAI,CAAC,YAAY,EAAE;gBACf,MAAK,CAAC,6BAA6B,CAAC,CAAC;aACxC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC/C,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YAED,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,qCAAqC,kBAAkB,CAAC,YAAY,CAAC,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBAClI,GAAG,CAAC;wBACA,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC;qBAC7C,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YAEH,GAAG,CAAC,YAAY,CAAC;gBACb,GAAG;gBACH,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAvCqB,sCAAqB,wBAuC1C,CAAA;IAED;;;OAGG;IACH,SAAsB,4BAA4B,CAAC,MAIlD;;YAGG,IAAI,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACnD,IAAI,CAAC,YAAY,EAAE;gBACf,MAAK,CAAC,6BAA6B,CAAC,CAAC;aACxC;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,GAAG,sBAAsB,CAAC,YAAY,CAAC,CAAC;YACjD,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC/C,IAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,EAAE;gBACd,OAAO,KAAK,CAAC,IAAI,CAAC;aACrB;YAED,MAAM,GAAG,GAAiB,IAAI,OAAO,CAAC,CAAO,GAAG,EAAE,GAAG,EAAE,EAAE;gBACrD,IAAI;oBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,6CAA6C,kBAAkB,CAAC,YAAY,CAAC,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;oBAC1I,GAAG,CAAC;wBACA,iBAAiB,EAAE,iBAAiB,CAAC,IAAI,CAAC;qBAC7C,CAAC,CAAC;iBACN;gBACD,OAAO,CAAC,EAAE;oBACN,GAAG,CAAC,CAAC,CAAC,CAAC;iBACV;YACL,CAAC,CAAA,CAAC,CAAC;YAEH,GAAG,CAAC,YAAY,CAAC;gBACb,GAAG;gBACH,KAAK,EAAE,GAAG;gBACV,GAAG,EAAE,SAAS;aACjB,CAAC,CAAC;YACH,OAAO,GAAG,CAAC;QACf,CAAC;KAAA;IAvCqB,6CAA4B,+BAuCjD,CAAA;IAED,SAAsB,MAAM,CAAC,MAI5B;;YAGG,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YAC7D,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YACD,IAAI,CAAC,IAAI,EAAE;gBACP,IAAI,GAAG,EAAa,CAAC;aACxB;YAED,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YACpF,IAAI,IAAI,CAAC,EAAE,EAAE;gBACT,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;aAC1C;YACD,6FAA6F;YAC7F,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,CAAC,CAAC;YACtD,OAAO;gBACH,gBAAgB,EAAE,aAAa,CAAC,GAAG,CAAC;aACvC,CAAC;QACN,CAAC;KAAA;IAxBqB,uBAAM,SAwB3B,CAAA;IAED,SAAsB,MAAM,CAAC,MAI5B;;YACG,IAAI,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;YACjD,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE;gBACzC,MAAK,CAAC,mCAAmC,CAAC,CAAC;aAC9C;YACD,IAAI,CAAC,GAAG,EAAE;gBACN,GAAG,GAAG,yBAAW,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;aACzC;YAED,MAAM,GAAG,CAAC,MAAM,CAAC,qBAAqB,UAAU,EAAE,EAAE,SAAG,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;YAClF,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC;YAC1C,oEAAoE;YACpE,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,qBAAqB,EAAE,CAAC,CAAC;QAC1D,CAAC;KAAA;IAjBqB,uBAAM,SAiB3B,CAAA;IAED,SAAgB,aAAa,CAAC,QAA4F;;QACtH,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,YAAY,GAAG,MAAA,WAAW,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,mCAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC;QACnE,OAAO,MAAA,MAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,mCACxB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,gBAAgB,mCAC9B,YAAY,mCACZ,MAAM,CAAC;IAClB,CAAC;IAPe,8BAAa,gBAO5B,CAAA;IAED,SAAgB,iBAAiB,CAAC,QAAgK;;QAC9L,MAAM,MAAM,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,YAAY,GAAG,MAAA,WAAW,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,mCAAI,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC;QACnE,MAAM,IAAI,GAAG,MAAA,MAAA,MAAA,MAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCACnB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,KAAK,mCACnB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB,mCACzB,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,iBAAiB,mCAC/B,YAAY,mCACZ,MAAM,CAAC;QAEd,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACrB,OAAO,IAAI,CAAC;SACf;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAde,kCAAiB,oBAchC,CAAA;IAED,SAAgB,WAAW,CAAC,EAAmB;QAC3C,OAAO,SAAG,CAAC,SAAS,CAAC,QAAQ,GAAG,YAAY,GAAG,EAAE,CAAC;IACtD,CAAC;IAFe,4BAAW,cAE1B,CAAA;IAED,SAAgB,eAAe,CAAC,EAAmB;QAC/C,OAAO,qBAAqB,EAAE,GAAG,EAAE,CAAC;IACxC,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,SAAgB,sBAAsB,CAAC,YAAoB;QACvD,OAAO,qBAAqB,EAAE,GAAG,UAAU,GAAG,YAAY,CAAC;IAC/D,CAAC;IAFe,uCAAsB,yBAErC,CAAA;IAED,2CAA2C;IAC3C,SAAgB,qBAAqB;QACjC,OAAO,SAAG,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,CAAC;IAClD,CAAC;IAFe,sCAAqB,wBAEpC,CAAA;AACL,CAAC,EAxQgB,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAwQhC;AAED,SAAS,WAAW,CAAC,IAAS;IAC1B,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,SAAS,EAAE;QACnC,OAAO,IAAI,CAAC;KACf;IACD,IAAI,OAAO,IAAI,IAAI,QAAQ,EAAE;QACzB,IAAI;YACA,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAC3B;QACD,WAAM;YACF,OAAO,IAAI,CAAC;SACf;KACJ;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}
@@ -122,4 +122,4 @@ export * from "./util/url-utils";
122
122
  export * from "./workflow/workflow-item";
123
123
  export * from "./workflow/workflow-schedule";
124
124
  export * from "./workflow/workflow-type";
125
- export declare const VERSION = "7.1.109";
125
+ export declare const VERSION = "7.1.111";
@@ -7,12 +7,28 @@ export declare namespace OntologyDocument {
7
7
  "Ontology.ID"?: number | string;
8
8
  "ClientFile.ID"?: string;
9
9
  Purpose?: string;
10
+ "SummaryClientFile.ID"?: string | null;
11
+ SummarySourceVersion?: number | null;
12
+ SourcePageCount?: number | null;
10
13
  Created?: string;
11
14
  Updated?: string;
12
15
  ClientFile?: ClientFile.IFile;
16
+ SummaryClientFile?: ClientFile.IFile;
13
17
  Ontology?: any;
14
18
  [key: string]: any;
15
19
  }
20
+ enum ESummaryStatus {
21
+ None = "none",
22
+ Current = "current",
23
+ Outdated = "outdated"
24
+ }
25
+ /**
26
+ * Returns whether the record's summary may be used in place of its PDF.
27
+ * It is only current while its file exists and it was produced from the PDF's current Version.
28
+ * An unknown version counts as outdated, so a replaced PDF never passes its old summary off as current.
29
+ * @param record Record as returned by the API, including its nested ClientFile and SummaryClientFile.
30
+ */
31
+ function GetSummaryStatus(record: IRecord): ESummaryStatus;
16
32
  function GetListByOntologyId(params: {
17
33
  api?: BruceApi.Api;
18
34
  ontologyId: number | string;
@@ -27,6 +43,17 @@ export declare namespace OntologyDocument {
27
43
  }): Promise<{
28
44
  ontologyDocuments: IRecord[];
29
45
  }>;
46
+ /**
47
+ * Returns the documents that use the given ClientFile as their summary.
48
+ * GetListByClientFileId() only matches documents made of the file, so check both before deleting a file.
49
+ */
50
+ function GetListBySummaryClientFileId(params: {
51
+ api?: BruceApi.Api;
52
+ clientFileId: string;
53
+ req?: Api.IReqParams;
54
+ }): Promise<{
55
+ ontologyDocuments: IRecord[];
56
+ }>;
30
57
  function Update(params: {
31
58
  api?: BruceApi.Api;
32
59
  ontologyDocument: IRecord;
@@ -50,4 +77,6 @@ export declare namespace OntologyDocument {
50
77
  } | string | any): IRecord[];
51
78
  function GetCacheKey(id: number | string): string;
52
79
  function GetListCacheKey(id: number | string): string;
80
+ function GetSummaryListCacheKey(clientFileId: string): string;
81
+ function GetListCacheKeyPrefix(): string;
53
82
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bruce-models",
3
- "version": "7.1.109",
3
+ "version": "7.1.111",
4
4
  "description": "",
5
5
  "keywords": [],
6
6
  "main": "dist/bruce-models.umd.js",