@isrd-isi-edu/ermrestjs 2.0.0

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@isrd-isi-edu/ermrestjs",
+  "description": "ERMrest client library in JavaScript",
+  "version": "2.0.0",
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">= 20.0.0",
+    "npm": ">=6.0.0"
+  },
+  "main": "dist/ermrest.js",
+  "module": "dist/ermrest.min.js",
+  "types": "dist/ermrest.d.ts",
+  "files": [
+    "dist",
+    "js",
+    "src",
+    "tsconfig.json",
+    "vite.config.mts"
+  ],
+  "scripts": {
+    "build": "tsc && vite build",
+    "pretest": "make deps-test && make dist-w-deps",
+    "deploy": "make deploy",
+    "test": "make test",
+    "lint": "eslint src js --quiet",
+    "lint-w-warn": "eslint src js",
+    "format": "prettier --write src"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/informatics-isi-edu/ermrestjs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/informatics-isi-edu/ermrestjs/issues"
+  },
+  "homepage": "https://github.com/informatics-isi-edu/ermrestjs#readme",
+  "keywords": [
+    "database",
+    "rest",
+    "postgresql",
+    "library"
+  ],
+  "dependencies": {
+    "@types/markdown-it": "^14.1.2",
+    "@types/q": "^1.5.8",
+    "axios": "1.12.2",
+    "handlebars": "4.7.8",
+    "lz-string": "^1.5.0",
+    "markdown-it": "12.3.2",
+    "moment": "2.29.4",
+    "moment-timezone": "0.5.48",
+    "mustache": "x",
+    "q": "1.5.1",
+    "spark-md5": "^3.0.0",
+    "terser": "^5.43.1",
+    "typescript": "~5.8.3",
+    "vite": "^6.3.6",
+    "vite-plugin-compression2": "^2.2.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.36.0",
+    "@isrd-isi-edu/ermrest-data-utils": "0.0.5",
+    "@types/node": "^24.6.1",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "file-api": "^0.10.4",
+    "globals": "^16.4.0",
+    "jasmine": "2.5.3",
+    "jasmine-expect": "3.7.1",
+    "jasmine-spec-reporter": "2.5.0",
+    "nock": "13.5.4",
+    "prettier": "^3.6.2",
+    "require-reload": "^0.2.2",
+    "rollup-plugin-visualizer": "^6.0.3",
+    "typescript-eslint": "^8.45.0",
+    "vite-plugin-dts": "^4.5.4"
+  }
+}

package/src/index.ts

@@ -0,0 +1,204 @@
+/**
+ * This file contains the functions and classes that we want to expose for standalone javascript ermrest bundle
+ * vite will attach these to 'ERMrest' namespace which will allow accessing them using `window.ERMrest`
+ */
+import moment from 'moment-timezone';
+
+// model
+import {
+  ERMrestError,
+  TimedOutError,
+  BadRequestError,
+  QueryTimeoutError,
+  UnauthorizedError,
+  ForbiddenError,
+  NotFoundError,
+  ConflictError,
+  IntegrityConflictError,
+  DuplicateConflictError,
+  PreconditionFailedError,
+  InternalServerError,
+  BadGatewayError,
+  ServiceUnavailableError,
+  NoConnectionError,
+  InvalidFacetOperatorError,
+  InvalidCustomFacetOperatorError,
+  InvalidFilterOperatorError,
+  InvalidSortCriteria,
+  InvalidPageCriteria,
+  InvalidInputError,
+  InvalidServerResponse,
+  MalformedURIError,
+  NoDataChangedError,
+  BatchUnlinkResponse,
+  BatchDeleteResponse,
+  UnsupportedFilters,
+} from '@isrd-isi-edu/ermrestjs/src/models/errors';
+
+// services
+import CatalogService from '@isrd-isi-edu/ermrestjs/src/services/catalog';
+import ConfigService from '@isrd-isi-edu/ermrestjs/src/services/config';
+import ErrorService from '@isrd-isi-edu/ermrestjs/src/services/error';
+import AuthnService from '@isrd-isi-edu/ermrestjs/src/services/authn';
+import HTTPService from '@isrd-isi-edu/ermrestjs/src/services/http';
+
+// utils
+import { contextHeaderName, ENV_IS_NODE } from '@isrd-isi-edu/ermrestjs/src/utils/constants';
+import { fixedEncodeURIComponent } from '@isrd-isi-edu/ermrestjs/src/utils/value-utils';
+import { renderMarkdown } from '@isrd-isi-edu/ermrestjs/src/utils/markdown-utils';
+
+// legacy imports
+import { Checksum, Upload } from '@isrd-isi-edu/ermrestjs/js/hatrac';
+import { onload, getElapsedTime } from '@isrd-isi-edu/ermrestjs/js/setup/node';
+import printf from '@isrd-isi-edu/ermrestjs/js/format';
+import { resolve, _createPage } from '@isrd-isi-edu/ermrestjs/src/models/reference';
+import { ermrestFactory } from '@isrd-isi-edu/ermrestjs/js/core';
+import { parse, createPath, createSearchPath, createLocation } from '@isrd-isi-edu/ermrestjs/js/parser';
+import {
+  _currDate,
+  decodeFacet,
+  encodeFacet,
+  encodeFacetString,
+  _formatUtils,
+  processMarkdownPattern,
+  renderMustacheTemplate,
+  _validateMustacheTemplate,
+} from '@isrd-isi-edu/ermrestjs/js/utils/helpers';
+import {
+  AttributeGroupColumn,
+  AttributeGroupReference,
+  AttributeGroupLocation,
+  BucketAttributeGroupReference,
+} from '@isrd-isi-edu/ermrestjs/js/ag_reference';
+import { BinaryPredicate } from '@isrd-isi-edu/ermrestjs/js/filters';
+import { DataPath } from '@isrd-isi-edu/ermrestjs/js/datapath';
+import HandlebarsService from '@isrd-isi-edu/ermrestjs/src/services/handlebars';
+import { Exporter } from '@isrd-isi-edu/ermrestjs/js/export';
+import validateJSONLD from '@isrd-isi-edu/ermrestjs/js/json_ld_validator.js';
+import HistoryService from '@isrd-isi-edu/ermrestjs/src/services/history';
+
+const logError = ErrorService.logError;
+const responseToError = ErrorService.responseToError;
+
+const configure = ConfigService.configure;
+const appLinkFn = ConfigService.setAppLinkFn;
+const setClientConfig = ConfigService.setClientConfig;
+const systemColumnsHeuristicsMode = ConfigService.setSystemColumnsHeuristicsMode;
+const resetUserCookie = ConfigService.resetUserCookie;
+const setUserCookie = ConfigService.setUserCookie;
+
+const setClientSession = AuthnService.setClientSession;
+
+const _certifyContextHeader = HTTPService.certifyContextHeader;
+const setHTTP401Handler = HTTPService.setHTTP401Handler;
+const onHTTPSuccess = HTTPService.setOnHTTPSuccess;
+
+const renderHandlebarsTemplate = HandlebarsService.render;
+
+const _clearConstraintNames = CatalogService.clearConstraintNames;
+
+// chaise relies on moment
+if (!ENV_IS_NODE) {
+  window.moment = moment;
+}
+
+export {
+  // services
+  // ConfigService,
+  // ErrorService,
+  // HTTPService,
+  AuthnService,
+  Exporter,
+  HistoryService,
+
+  // constants
+  contextHeaderName,
+
+  // functions
+  resolve,
+  configure,
+  appLinkFn,
+  _certifyContextHeader,
+  ermrestFactory,
+  fixedEncodeURIComponent,
+  decodeFacet,
+  encodeFacet,
+  setClientConfig,
+  /**
+   * @deprecated
+   * use `AuthnService.setClientSession` instead
+   */
+  setClientSession,
+  systemColumnsHeuristicsMode,
+  onHTTPSuccess,
+  setHTTP401Handler,
+  getElapsedTime,
+  onload,
+
+  // markdown/template/print
+  processMarkdownPattern,
+  renderHandlebarsTemplate,
+  renderMarkdown,
+  renderMustacheTemplate,
+
+  // parser
+  parse,
+  createPath,
+  createSearchPath,
+  createLocation,
+
+  // attribute group
+  AttributeGroupColumn,
+  AttributeGroupReference,
+  AttributeGroupLocation,
+  BucketAttributeGroupReference,
+
+  // hatrac
+  Upload,
+  Checksum,
+
+  // error:
+  logError,
+  responseToError,
+  ERMrestError,
+  TimedOutError,
+  BadRequestError,
+  QueryTimeoutError,
+  UnauthorizedError,
+  ForbiddenError,
+  NotFoundError,
+  ConflictError,
+  IntegrityConflictError,
+  DuplicateConflictError,
+  PreconditionFailedError,
+  InternalServerError,
+  BadGatewayError,
+  ServiceUnavailableError,
+  NoConnectionError,
+  InvalidFacetOperatorError,
+  InvalidCustomFacetOperatorError,
+  InvalidFilterOperatorError,
+  InvalidSortCriteria,
+  InvalidPageCriteria,
+  InvalidInputError,
+  InvalidServerResponse,
+  MalformedURIError,
+  NoDataChangedError,
+  BatchUnlinkResponse,
+  BatchDeleteResponse,
+  UnsupportedFilters,
+
+  // used for testing
+  resetUserCookie,
+  setUserCookie,
+  printf,
+  _clearConstraintNames,
+  _createPage,
+  _formatUtils,
+  encodeFacetString,
+  _validateMustacheTemplate,
+  _currDate,
+  BinaryPredicate,
+  DataPath,
+  validateJSONLD,
+};

package/src/models/comment.ts

@@ -0,0 +1,14 @@
+export type CommentType =
+  | {
+      value: string;
+      isHTML: boolean;
+      unformatted: string;
+      displayMode: CommentDisplayModes;
+    }
+  | false
+  | null;
+
+export enum CommentDisplayModes {
+  INLINE = 'inline',
+  TOOLTIP = 'tooltip',
+}

package/src/models/deferred-promise.ts

@@ -0,0 +1,16 @@
+/**
+ * TODO I added this to replace the usage of Q.defer().
+ * But doing so broke the flow-control of chaise. We should investigate this later so we can remove Q.
+ */
+export default class DeferredPromise<T> {
+  promise: Promise<T>;
+  resolve!: (value: T | PromiseLike<T>) => void;
+  reject!: (reason?: any) => void;
+
+  constructor() {
+    this.promise = new Promise<T>((resolve, reject) => {
+      this.resolve = resolve;
+      this.reject = reject;
+    });
+  }
+}

package/src/models/display-name.ts

@@ -0,0 +1,5 @@
+export type DisplayName = {
+  value: string | null;
+  isHTML: boolean;
+  unformatted?: string | null;
+};