@isrd-isi-edu/ermrestjs 2.0.0 → 2.0.1

package/js/core.js

@@ -205,6 +205,10 @@ import {
      */
     function Catalogs(server) {
         this._server = server;
+
+        /**
+         * @type {{[catalogId: string]: Catalog}}
+         */
         this._catalogs = {};
     }
 
@@ -243,21 +247,28 @@ import {
         get: function (id, dontFetchSchema) {
             // do introspection here and return a promise
 
-            var self = this, defer = ConfigService.q.defer(), catalog;
+            const defer = ConfigService.q.defer();
+            let catalog;
 
             // create a new catalog object if the object has not been created before
             if (id in this._catalogs) {
-                catalog = self._catalogs[id];
+                catalog = this._catalogs[id];
             } else {
-                catalog = new Catalog(self._server, id);
+                catalog = new Catalog(this._server, id);
             }
 
             // make sure the catalog is introspected.
             // the introspect function might or might not
-            catalog._introspect(dontFetchSchema).then(function () {
-                self._catalogs[id] = catalog;
+            catalog._introspect(dontFetchSchema).then(() => {
+                /**
+                 * TODO the catalog id might have changed if the version was corrected.
+                 * with the current implementation, the next time this function is called,
+                 * it will not use the cached catalog and will create a new one (so a new request).
+                 * We might be able to improve this in the future.
+                 */
+                this._catalogs[id] = catalog;
                 defer.resolve(catalog);
-            }).catch(function (error) {
+            }).catch((error) => {
                 defer.reject(error);
             });
 
@@ -318,6 +329,11 @@ import {
         // this property is needed by _determineDisplayName
         this.name = id;
 
+        /**
+         * Indicates whether the version in the catalog ID was corrected to match the server's snaptime.
+         */
+        this.versionCorrected = false;
+
         this._nameStyle = {}; // Used in the displayname to store the name styles.
 
         // NOTE we still haven't fetched the catalog, so we don't have the catalog annotation here.
@@ -460,21 +476,28 @@ import {
          * @private
          */
         _introspect: function (dontFetchSchema) {
-            var defer = ConfigService.q.defer(), self = this;
+            var defer = ConfigService.q.defer();
 
             // load the catalog (or use the one that is cached)
-            this._get().then(function(response) {
-                self.snaptime = response.snaptime;
+            this._get().then((response) => {
+                this.snaptime = response.snaptime;
+                
+                let versionCorrected = false;
+                if (isStringAndNotEmpty(this.version) && this.version !== this.snaptime) {
+                    this.version = this.snaptime;
+                    this.id = this.id.split("@")[0] + "@" + this.version;
+                    this.versionCorrected = true;
+                }
 
                 if ("features" in response) {
-                    for (var k in self.features) {
-                        self.features[k] = response.features[k];
+                    for (var k in this.features) {
+                        this.features[k] = response.features[k];
                     }
                 }
 
-                self.annotations = new Annotations();
+                this.annotations = new Annotations();
                 for (var uri in response.annotations) {
-                    self.annotations._push(new Annotation("catalog", uri, response.annotations[uri]));
+                    this.annotations._push(new Annotation("catalog", uri, response.annotations[uri]));
                 }
 
                 /**
@@ -482,7 +505,7 @@ import {
                  * This should be done before initializing tables because tables require this field.
                  * @type {boolean|null}
                  */
-                self.isGenerated = _processACLAnnotation(self.annotations, _annotations.GENERATED, false);
+                this.isGenerated = _processACLAnnotation(this.annotations, _annotations.GENERATED, false);
 
                 /**
                  * whether catalog is immutable.
@@ -491,32 +514,32 @@ import {
                  * null: annotation is not defined
                  * @type {boolean|null}
                  */
-                self.isImmutable = _processACLAnnotation(self.annotations, _annotations.IMMUTABLE, null);
+                this.isImmutable = _processACLAnnotation(this.annotations, _annotations.IMMUTABLE, null);
 
                 /**
                  * whether catalog is non-deletable
                  * @type {boolean}
                  */
-                self.isNonDeletable = _processACLAnnotation(self.annotations, _annotations.NON_DELETABLE, false);
+                this.isNonDeletable = _processACLAnnotation(this.annotations, _annotations.NON_DELETABLE, false);
 
                 /**
                  * this will make sure the nameStyle is populated on the catalog as well,
                  * so schema can use it.
                  */
-                _determineDisplayName(self, true);
+                _determineDisplayName(this, true);
 
-                if (dontFetchSchema === true || self._schemaFetched) {
-                    defer.resolve();
+                if (dontFetchSchema === true || this._schemaFetched) {
+                    defer.resolve({ versionCorrected });
                 } else {
                     // load all schemas
-                    self._fetchSchema().then(function () {
-                        defer.resolve();
-                    }).catch(function (err) {
+                    this._fetchSchema().then(() => {
+                        defer.resolve({ versionCorrected });
+                    }).catch((err) => {
                         throw err;
                     });
                 }
 
-            }).catch(function (response) {
+            }).catch((response) => {
                 defer.reject(ErrorService.responseToError(response));
             });
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@isrd-isi-edu/ermrestjs",
   "description": "ERMrest client library in JavaScript",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "license": "Apache-2.0",
   "engines": {
     "node": ">= 20.0.0",
@@ -54,7 +54,7 @@
     "spark-md5": "^3.0.0",
     "terser": "^5.43.1",
     "typescript": "~5.8.3",
-    "vite": "^6.3.6",
+    "vite": "^6.4.1",
     "vite-plugin-compression2": "^2.2.1"
   },
   "devDependencies": {

package/src/index.ts

@@ -16,6 +16,7 @@ import {
   ConflictError,
   IntegrityConflictError,
   DuplicateConflictError,
+  SnapshotNotFoundError,
   PreconditionFailedError,
   InternalServerError,
   BadGatewayError,
@@ -170,6 +171,7 @@ export {
   ConflictError,
   IntegrityConflictError,
   DuplicateConflictError,
+  SnapshotNotFoundError,
   PreconditionFailedError,
   InternalServerError,
   BadGatewayError,

package/src/models/errors.ts

@@ -96,6 +96,12 @@ export class DuplicateConflictError extends ConflictError {
   }
 }
 
+export class SnapshotNotFoundError extends ERMrestError {
+  constructor(status: string, message: string, subMessage?: string) {
+    super(_HTTPErrorCodes.CONFLICT, _errorStatus.SNAPSHOT_NOT_FOUND, message, subMessage);
+  }
+}
+
 export class PreconditionFailedError extends ERMrestError {
   constructor(status: string, message: string) {
     const usedStatus = isStringAndNotEmpty(status) ? status : _errorStatus.PRECONDITION_FAILED;

package/src/models/reference/reference.ts

@@ -122,13 +122,15 @@ export const resolve = async (uri: string, contextHeaderParams?: any): Promise<R
   await onload();
   //added try block to make sure it rejects all parse() related error
   // It should have been taken care by outer try but did not work
-  const location = parse(uri);
+  const loc = parse(uri);
 
-  const server = ermrestFactory.getServer(location.service, contextHeaderParams);
+  console.log(loc.catalog);
 
-  const catalog = await server.catalogs.get(location.catalog);
+  const server = ermrestFactory.getServer(loc.service, contextHeaderParams);
 
-  return new Reference(location, catalog);
+  const catalog = await server.catalogs.get(loc.catalog);
+
+  return new Reference(loc, catalog);
 };
 
 /**

package/src/services/error.ts

@@ -1,7 +1,9 @@
+import moment from 'moment-timezone';
+
 // models
 import { Reference } from '@isrd-isi-edu/ermrestjs/src/models/reference';
 
-import { contextHeaderName, _operationsFlag } from '@isrd-isi-edu/ermrestjs/src/utils/constants';
+import { contextHeaderName, _operationsFlag, _dataFormats } from '@isrd-isi-edu/ermrestjs/src/utils/constants';
 import {
   ERMrestError,
   NoConnectionError,
@@ -18,12 +20,15 @@ import {
   IntegrityConflictError,
   DuplicateConflictError,
   ConflictError,
+  SnapshotNotFoundError,
 } from '@isrd-isi-edu/ermrestjs/src/models/errors';
 import { fixedEncodeURIComponent } from '@isrd-isi-edu/ermrestjs/src/utils/value-utils';
 
 // legacy
+
 import { parse } from '@isrd-isi-edu/ermrestjs/js/parser';
 import { ermrestFactory } from '@isrd-isi-edu/ermrestjs/js/core';
+import HistoryService from '@isrd-isi-edu/ermrestjs/src/services/history';
 
 export default class ErrorService {
   /**
@@ -121,7 +126,20 @@ export default class ErrorService {
     const conflictErrorPrefix = ['409 Conflict\nThe request conflicts with the state of the server. ', 'Request conflicts with state of server.'];
     let siteAdminMsg = '\nIf you have trouble removing dependencies please contact the site administrator.';
 
-    if (generatedErrMessage.indexOf('violates foreign key constraint') > -1 && actionFlag === _operationsFlag.DELETE) {
+    if (generatedErrMessage.indexOf('Requested catalog revision ') > -1 && generatedErrMessage.indexOf('is prior to any known revision.') > -1) {
+      const match = generatedErrMessage.match(/Requested catalog revision "([^"]+)"/);
+      const snapshot = match ? match[1] : '';
+      let formattedTime = '';
+      if (snapshot) {
+        formattedTime = HistoryService.snapshotToDatetimeISO(snapshot, true);
+        if (formattedTime) {
+          formattedTime = moment(formattedTime).format(_dataFormats.DATETIME.display);
+        }
+      }
+      const newMessage = `The requested snapshot time ${formattedTime ? '(' + formattedTime + ') ' : ''}is older than any available history.`;
+
+      return new SnapshotNotFoundError(errorStatusText, newMessage);
+    } else if (generatedErrMessage.indexOf('violates foreign key constraint') > -1 && actionFlag === _operationsFlag.DELETE) {
       let referenceTable: any = '';
 
       let detail: string | number = generatedErrMessage.search(/DETAIL:/g);

package/src/utils/constants.ts

@@ -327,6 +327,7 @@ export const _errorStatus = Object.freeze({
   INVALID_PAGE: 'Invalid Page Criteria',
   INVALID_SERVER_RESPONSE: 'Invalid Server Response',
   UNSUPPORTED_FILTERS: 'Unsupported Filters',
+  SNAPSHOT_NOT_FOUND: 'Snapshot Not Found',
 });
 
 export const _errorMessage = Object.freeze({