@girder/core 3.2.7 → 5.0.0-a10

package/package.json

@@ -1,34 +1,83 @@
 {
-    "name": "@girder/core",
-    "version": "3.2.7",
-    "description": "Extensible data management platform",
-    "homepage": "https://girder.readthedocs.org",
-    "bugs": {
-        "url": "https://github.com/girder/girder/issues"
+  "name": "@girder/core",
+  "license": "Apache-2.0",
+  "version": "5.0.0-a10",
+  "type": "module",
+  "files": [
+    "dist-lib"
+  ],
+  "main": "./dist-lib/girder-core.umd.cjs",
+  "module": "./dist-lib/girder-core.js",
+  "types": "./dist-lib/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist-lib/index.d.ts",
+        "default": "./dist-lib/girder-core.js"
+      },
+      "require": {
+        "types": "./dist-lib/index.d.ts",
+        "default": "./dist-lib/girder-core.umd.cjs"
+      }
     },
-    "license": "Apache-2.0",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/girder/girder.git"
-    },
-    "dependencies": {
-        "as-jqplot": "^1.0.8",
-        "backbone": "^1.4.0",
-        "bootstrap": "^3.4.1",
-        "bootstrap-switch": "~3.3.4",
-        "eonasdan-bootstrap-datetimepicker": "^4.17",
-        "@girder/fontello": "*",
-        "jquery": "^3.7.0",
-        "jsoneditor": "~5.9.3",
-        "moment": "^2.24.0",
-        "moment-timezone": "^0.5.27",
-        "qrcode": "~1.4.4",
-        "remarkable": "^2.0.0",
-        "sprintf-js": "^1.1.2",
-        "swagger-ui-dist": "^5.7.2",
-        "typeface-open-sans": "^0.0.75",
-        "underscore": "^1.13.6",
-        "url-otpauth": "^2.0.0"
-    },
-    "main": "./index.js"
+    "./style.css": "./dist-lib/style.css"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "run-p type-check build-only",
+    "preview": "vite preview",
+    "test": "playwright test",
+    "show-coverage": "http-server coverage/report --port 8888 -o",
+    "build-only": "vite build",
+    "build-lib": "BUILD_LIB=true vite build",
+    "type-check": "vue-tsc --noEmit -p tsconfig.json --composite false",
+    "install-browsers": "playwright install --with-deps",
+    "prepublishOnly": "npm run build-lib"
+  },
+  "dependencies": {
+    "@girder/fontello": "^5.0.0-a7",
+    "apexcharts": "^4.5.0",
+    "backbone": "~1.4.0",
+    "bootstrap": "~3.4.1",
+    "bootstrap-switch": "~3.3.4",
+    "eonasdan-bootstrap-datetimepicker": "~4.17",
+    "jquery": "~3.5.1",
+    "jsoneditor": "~5.9.3",
+    "moment": "~2.24.0",
+    "moment-timezone": "~0.5.27",
+    "qrcode": "~1.4.4",
+    "remarkable": "~2.0.0",
+    "typeface-open-sans": "^0.0.75",
+    "underscore": "~1.13.6",
+    "url-otpauth": "~2.0.0",
+    "vue": "^3.2.47"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.34.3",
+    "@rollup/plugin-inject": "^5.0.3",
+    "@tsconfig/node18": "^2.0.1",
+    "@types/istanbul-lib-report": "^3.0.0",
+    "@types/istanbul-reports": "^3.0.1",
+    "@types/jsdom": "^21.1.1",
+    "@types/node": "^18.16.16",
+    "@types/pug": "^2.0.6",
+    "@vitejs/plugin-vue": "^4.2.3",
+    "@vue/test-utils": "^2.3.2",
+    "@vue/tsconfig": "^0.4.0",
+    "http-server": "^14.1.1",
+    "istanbul-lib-report": "^3.0.0",
+    "istanbul-reports": "^3.1.5",
+    "jsdom": "^22.0.0",
+    "npm-run-all": "^4.1.5",
+    "playwright": "^1.34.3",
+    "playwright-test-coverage": "^1.2.12",
+    "pug": "^3.0.2",
+    "stylus": "^0.54.5",
+    "typescript": "^5.0.4",
+    "v8-to-istanbul": "^9.1.0",
+    "vite": "^4.3.5",
+    "vite-plugin-dts": "^2.3.0",
+    "vite-plugin-static-copy": "^0.16.0",
+    "vue-tsc": "^2.2.10"
+  }
 }

package/index.js

@@ -1,31 +0,0 @@
-import * as auth from './auth';
-import * as collections from './collections';
-import * as constants from './constants';
-import * as dialog from './dialog';
-import * as misc from './misc';
-import * as models from './models';
-import * as rest from './rest';
-import * as utilities from './utilities';
-import * as views from './views';
-import events from './events';
-import router from './router';
-import version from './version';
-
-// This will be modified dynamically when plugins are loaded.
-var plugins = {};
-
-export {
-    auth,
-    collections,
-    constants,
-    dialog,
-    events,
-    misc,
-    models,
-    plugins,
-    rest,
-    router,
-    utilities,
-    version,
-    views
-};

package/main.js

@@ -1,21 +0,0 @@
-import $ from 'jquery';
-import _ from 'underscore';
-import Backbone from 'backbone';
-import moment from 'moment';
-import * as girder from '@girder/core';
-
-window.girder = girder;
-
-// Some cross-browser globals
-if (!window.console) {
-    window.console = {
-        log: $.noop,
-        error: $.noop
-    };
-}
-
-// For testing and convenience, available now because of testUtils.js reliance on $
-window.$ = $;
-window._ = _;
-window.moment = moment;
-window.Backbone = Backbone;

package/utilities/EventStream.js

@@ -1,177 +0,0 @@
-import $ from 'jquery';
-import _ from 'underscore';
-import Backbone from 'backbone';
-
-import { getApiRoot, restRequest } from '@girder/core/rest';
-
-/**
- * The EventStream type wraps window.EventSource to listen to the unified
- * per-user event channel endpoint using the SSE protocol. When events are
- * received on the SSE channel, this triggers a Backbone event of the form
- * 'g:event.<type>' where <type> is the value of the event type field.
- * Listeners can bind to specific event types on the channel.
- */
-function EventStream(settings) {
-    const defaults = {
-        timeout: null,
-        streamPath: '/notification/stream'
-    };
-
-    // User-provided settings from initialization
-    this.settings = _.extend(defaults, settings);
-    // Possible states are 'closed', 'stopped', 'started'
-    this._state = 'closed';
-    // Whether this is started (if so, holds the EventSource instance)
-    this._eventSource = null;
-
-    // Create context bindings only once, so they can be referenced when unbinding events
-    this._onVisibilityStateChange = _.bind(this._onVisibilityStateChange, this);
-    this._onMessage = _.bind(this._onMessage, this);
-    this._onError = _.bind(this._onError, this);
-
-    return _.extend(this, Backbone.Events);
-}
-
-EventStream.prototype._onVisibilityStateChange = function () {
-    if (document.visibilityState === 'visible' && this._state === 'stopped') {
-        this._start();
-    } else if (document.visibilityState === 'hidden' && this._state === 'started') {
-        this._stop();
-    }
-};
-
-EventStream.prototype._onMessage = function (e) {
-    let obj;
-    try {
-        obj = window.JSON.parse(e.data);
-    } catch (err) {
-        console.error('Invalid JSON from SSE stream: ' + e.data + ',' + err);
-        this.trigger('g:error', e);
-        return;
-    }
-    EventStream.setLastTimestamp(obj._girderTime);
-    this.trigger('g:event.' + obj.type, obj);
-};
-
-EventStream.prototype._onError = function () {
-    // The EventSource.onerror API does not provide the HTTP status code of the error, so send an Ajax HEAD request to
-    // capture the status code.
-    restRequest({
-        url: this.settings.streamPath,
-        method: 'HEAD',
-        error: null
-    })
-        .fail((jqXHR) => {
-            if (jqXHR.status === 503) {
-                // Notification stream is disabled, so close this EventStream
-                this.trigger('g:eventStream.disable', jqXHR);
-                this.close();
-            }
-        });
-    // In all other cases (HEAD doesn't fail, or fails with a non-503 code), assume this is a temporary outage and allow
-    // the EventStream to continue attempting to auto-connect
-};
-
-EventStream.prototype.open = function () {
-    if (!window.EventSource) {
-        console.error('EventSource is not supported on this platform.');
-        this.trigger('g:eventStream.disable');
-        return;
-    }
-    if (this._state !== 'closed') {
-        console.warn('EventStream should be closed.');
-        return;
-    }
-
-    this._state = 'stopped';
-    this._start();
-
-    document.addEventListener('visibilitychange', this._onVisibilityStateChange);
-};
-
-EventStream.prototype._start = function () {
-    if (this._state !== 'stopped') {
-        console.warn('EventStream should be stopped');
-        return;
-    }
-
-    const params = {};
-
-    if (this.settings.timeout) {
-        params.timeout = this.settings.timeout;
-    }
-
-    // Set the "since" argument to filter out notifications that have already been sent to this client.
-    const timestamp = EventStream.getLastTimestamp();
-    if (_.isNumber(timestamp)) {
-        params.since = timestamp;
-    }
-
-    const url = getApiRoot() + this.settings.streamPath + '?' + $.param(params);
-
-    this._eventSource = new window.EventSource(url);
-    this._eventSource.onmessage = this._onMessage;
-    this._eventSource.onerror = this._onError;
-
-    this._state = 'started';
-    this.trigger('g:eventStream.start');
-};
-
-EventStream.prototype._stop = function () {
-    if (this._state !== 'started') {
-        console.warn('EventStream should be started');
-        return;
-    }
-
-    this._eventSource.close();
-    this._eventSource = null;
-
-    this._state = 'stopped';
-    this.trigger('g:eventStream.stop');
-};
-
-EventStream.prototype.close = function () {
-    if (this._state === 'closed') {
-        console.warn('EventStream should not be closed');
-        return;
-    }
-
-    document.removeEventListener('visibilitychange', this._onVisibilityStateChange);
-
-    if (this._state === 'started') {
-        this._stop();
-    }
-
-    this._state = 'closed';
-    this.trigger('g:eventStream.close');
-};
-
-// Static methods
-EventStream._lastTimestamp = null;
-EventStream.setLastTimestamp = function (timestamp) {
-    try {
-        window.localStorage.setItem('sseTimestamp', timestamp);
-    } catch (e) {
-        // Ignore any errors raised by localStorage
-    }
-    EventStream._lastTimestamp = timestamp;
-};
-EventStream.getLastTimestamp = function () {
-    let timestamp;
-    try {
-        timestamp = parseInt(window.localStorage.getItem('sseTimestamp'), 10);
-    } catch (e) {
-        // Ignore any errors raised by localStorage
-    }
-    if (!_.isNaN(timestamp)) {
-        // An int was parsed
-        return timestamp;
-    } else {
-        // Value could not be gotten from localStorage, so return from fallback (which is also the default of null)f
-        return EventStream._lastTimestamp;
-    }
-};
-
-const eventStream = new EventStream();
-
-export default eventStream;

package/version.js

@@ -1,10 +0,0 @@
-/* global process */
-
-// Default value for external builds
-let version = null;
-
-try {
-    version = process.env.GIRDER_VERSION || null;
-} catch (e) {}
-
-export default version;