bruce-models 7.1.110 → 7.1.111

package/dist/bruce-models.umd.js

@@ -17328,6 +17328,34 @@
     }
 
     (function (OntologyDocument) {
+        let ESummaryStatus;
+        (function (ESummaryStatus) {
+            // No summary is linked.
+            ESummaryStatus["None"] = "none";
+            // Produced from the PDF's current Version, so it can stand in for the PDF.
+            ESummaryStatus["Current"] = "current";
+            // Produced from another or an unknown Version. Keep it for review, but read the PDF instead.
+            ESummaryStatus["Outdated"] = "outdated";
+        })(ESummaryStatus = OntologyDocument.ESummaryStatus || (OntologyDocument.ESummaryStatus = {}));
+        /**
+         * Returns whether the record's summary may be used in place of its PDF.
+         * It is only current while its file exists and it was produced from the PDF's current Version.
+         * An unknown version counts as outdated, so a replaced PDF never passes its old summary off as current.
+         * @param record Record as returned by the API, including its nested ClientFile and SummaryClientFile.
+         */
+        function GetSummaryStatus(record) {
+            var _a;
+            if (!(record === null || record === void 0 ? void 0 : record["SummaryClientFile.ID"])) {
+                return ESummaryStatus.None;
+            }
+            const sourceVersion = record.SummarySourceVersion;
+            const currentVersion = (_a = record.ClientFile) === null || _a === void 0 ? void 0 : _a.Version;
+            if (!record.SummaryClientFile || sourceVersion == null || currentVersion == null) {
+                return ESummaryStatus.Outdated;
+            }
+            return Number(sourceVersion) === Number(currentVersion) ? ESummaryStatus.Current : ESummaryStatus.Outdated;
+        }
+        OntologyDocument.GetSummaryStatus = GetSummaryStatus;
         function GetListByOntologyId(params) {
             return __awaiter(this, void 0, void 0, function* () {
                 let { api, ontologyId, req: reqParams } = params;
@@ -17396,6 +17424,44 @@
             });
         }
         OntologyDocument.GetListByClientFileId = GetListByClientFileId;
+        /**
+         * Returns the documents that use the given ClientFile as their summary.
+         * GetListByClientFileId() only matches documents made of the file, so check both before deleting a file.
+         */
+        function GetListBySummaryClientFileId(params) {
+            return __awaiter(this, void 0, void 0, function* () {
+                let { api, clientFileId, req: reqParams } = params;
+                if (!clientFileId) {
+                    throw ("Client file ID is required.");
+                }
+                if (!api) {
+                    api = exports.ENVIRONMENT.Api().GetBruceApi();
+                }
+                const key = GetSummaryListCacheKey(clientFileId);
+                const cache = api.GetCacheItem(key, reqParams);
+                if (cache === null || cache === void 0 ? void 0 : cache.found) {
+                    return cache.data;
+                }
+                const req = new Promise((res, rej) => __awaiter(this, void 0, void 0, function* () {
+                    try {
+                        const data = yield api.GET(`ontology/documents?summary_client_file_id=${encodeURIComponent(clientFileId)}`, exports.Api.PrepReqParams(reqParams));
+                        res({
+                            ontologyDocuments: ParseListResponse(data)
+                        });
+                    }
+                    catch (e) {
+                        rej(e);
+                    }
+                }));
+                api.SetCacheItem({
+                    key,
+                    value: req,
+                    req: reqParams
+                });
+                return req;
+            });
+        }
+        OntologyDocument.GetListBySummaryClientFileId = GetListBySummaryClientFileId;
         function Update(params) {
             return __awaiter(this, void 0, void 0, function* () {
                 let { api, ontologyDocument: data, req: reqParams } = params;
@@ -17409,7 +17475,8 @@
                 if (data.ID) {
                     api.Cache.Remove(GetCacheKey(data.ID));
                 }
-                api.Cache.RemoveByStartsWith(GetListCacheKey(data["Ontology.ID"]));
+                // A save can move a document in or out of any list, eg: by linking a different summary file.
+                api.Cache.RemoveByStartsWith(GetListCacheKeyPrefix());
                 return {
                     ontologyDocument: ParseResponse(res)
                 };
@@ -17427,7 +17494,8 @@
                 }
                 yield api.DELETE(`ontology/document/${documentId}`, exports.Api.PrepReqParams(reqParams));
                 api.Cache.Remove(GetCacheKey(documentId));
-                api.Cache.RemoveByStartsWith(GetListCacheKey(documentId));
+                // Only the document ID is known here, not the lists it was part of.
+                api.Cache.RemoveByStartsWith(GetListCacheKeyPrefix());
             });
         }
         OntologyDocument.Delete = Delete;
@@ -17454,9 +17522,18 @@
         }
         OntologyDocument.GetCacheKey = GetCacheKey;
         function GetListCacheKey(id) {
-            return exports.Api.ECacheKey.Ontology + ":documents:" + id;
+            return GetListCacheKeyPrefix() + id;
         }
         OntologyDocument.GetListCacheKey = GetListCacheKey;
+        function GetSummaryListCacheKey(clientFileId) {
+            return GetListCacheKeyPrefix() + "summary:" + clientFileId;
+        }
+        OntologyDocument.GetSummaryListCacheKey = GetSummaryListCacheKey;
+        // Shared by every document list cache key.
+        function GetListCacheKeyPrefix() {
+            return exports.Api.ECacheKey.Ontology + ":documents:";
+        }
+        OntologyDocument.GetListCacheKeyPrefix = GetListCacheKeyPrefix;
     })(exports.OntologyDocument || (exports.OntologyDocument = {}));
     function parseObject$4(data) {
         if (data == null || data == undefined) {
@@ -24565,7 +24642,7 @@
     }
 
     // This is updated with the package.json version on build.
-    const VERSION = "7.1.110";
+    const VERSION = "7.1.111";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;