@girder/core 3.2.7 → 5.0.0-a6

package/README.md

@@ -0,0 +1,61 @@
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+
+## Type Support for `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+
+If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+
+1. Disable the built-in TypeScript Extension
+    1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
+    2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
+2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+npm run build
+```
+
+### Run Unit Tests with [Vitest](https://vitest.dev/)
+
+```sh
+npm run test:unit
+```
+
+### Run End-to-End Tests with [Playwright](https://playwright.dev)
+
+```sh
+# Install browsers for the first run
+npx playwright install
+
+# When testing on CI, must build the project first
+npm run build
+
+# Runs the end-to-end tests
+npm run test:e2e
+# Runs the tests only on Chromium
+npm run test:e2e -- --project=chromium
+# Runs the tests of a specific file
+npm run test:e2e -- tests/example.spec.ts
+# Runs the tests in debug mode
+npm run test:e2e -- --debug
+```

package/package.json

@@ -1,34 +1,82 @@
 {
-    "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-a6",
+  "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"
+  },
+  "dependencies": {
+    "@girder/fontello": "^3.1.20",
+    "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": "^1.6.4"
+  }
 }

package/auth.js

@@ -1,152 +0,0 @@
-import _ from 'underscore';
-
-import UserModel from '@girder/core/models/UserModel';
-import events from '@girder/core/events';
-import { restRequest } from '@girder/core/rest';
-
-// TODO: this might need some fixing/testing, as it seems that
-// girder.corsAuth could be an override. See login doc below.
-var corsAuth = false;
-
-// TODO delete in next major version
-var cookie = {
-    findAll: function () {
-        var cookies = {};
-        _(document.cookie.split(';'))
-            .chain()
-            .map(function (m) {
-                return m.replace(/^\s+/, '').replace(/\s+$/, '');
-            })
-            .each(function (c) {
-                var arr = c.split('='),
-                    key = arr[0],
-                    value = null,
-                    size = _.size(arr);
-                if (size > 1) {
-                    value = arr.slice(1).join('');
-                }
-                cookies[key] = value;
-            });
-        return cookies;
-    },
-
-    find: function (name) {
-        var foundCookie = null,
-            list = this.findAll();
-
-        _.each(list, function (value, key) {
-            if (key === name) {
-                foundCookie = value;
-            }
-        });
-        return foundCookie;
-    }
-};
-
-var currentUser = null;
-var currentToken = window.localStorage.getItem('girderToken');
-
-function getCurrentUser() {
-    return currentUser;
-}
-
-function setCurrentUser(user) {
-    currentUser = user;
-}
-
-function getCurrentToken() {
-    return currentToken;
-}
-
-function setCurrentToken(token) {
-    currentToken = token;
-}
-
-function fetchCurrentUser() {
-    return restRequest({
-        method: 'GET',
-        url: '/user/me'
-    });
-}
-
-/**
- * Encode password using TextEncoder to support unicode
- */
-function basicAuthEncode(username, password) {
-    const encoder = new TextEncoder();
-    const data = encoder.encode(username + ':' + password);
-    return 'Basic ' + btoa(String.fromCharCode(...data));
-}
-
-/**
- * Log in to the server. If successful, sets the value of currentUser
- * and currentToken and triggers the "g:login" and "g:login.success".
- * On failure, triggers the "g:login.error" event.
- *
- * @param username The username or email to login as.
- * @param password The password to use.
- * @param cors If the girder server is on a different origin, set this
- *        to "true" to save the auth cookie on the current domain. Alternatively,
- *        you may set the global option "girder.corsAuth = true".
- * @param otpToken An optional one-time password to include with the login.
- */
-function login(username, password, cors = corsAuth, otpToken = null) {
-    var auth = basicAuthEncode(username, password);
-
-    const headers = {
-        Authorization: auth
-    };
-    if (_.isString(otpToken)) {
-        // Use _.isString to send header with empty string
-        headers['Girder-OTP'] = otpToken;
-    }
-    return restRequest({
-        method: 'GET',
-        url: '/user/authentication',
-        headers: headers,
-        error: null
-    }).then(function (response) {
-        response.user.token = response.authToken;
-
-        setCurrentUser(new UserModel(response.user));
-        setCurrentToken(response.user.token.token);
-
-        window.localStorage.setItem('girderToken', response.user.token.token);
-
-        events.trigger('g:login.success', response.user);
-        events.trigger('g:login', response);
-
-        return response.user;
-    }).fail(function (jqxhr) {
-        events.trigger('g:login.error', jqxhr.status, jqxhr);
-    });
-}
-
-function logout() {
-    return restRequest({
-        method: 'DELETE',
-        url: '/user/authentication'
-    }).done(function () {
-        setCurrentUser(null);
-        setCurrentToken(null);
-
-        window.localStorage.removeItem('girderToken');
-
-        events.trigger('g:login', null);
-        events.trigger('g:logout.success');
-    }).fail(function (jqxhr) {
-        events.trigger('g:logout.error', jqxhr.status, jqxhr);
-    });
-}
-
-export {
-    cookie,
-    corsAuth,
-    getCurrentUser,
-    setCurrentUser,
-    getCurrentToken,
-    setCurrentToken,
-    fetchCurrentUser,
-    login,
-    logout
-};

package/collections/ApiKeyCollection.js

@@ -1,9 +0,0 @@
-import ApiKeyModel from '@girder/core/models/ApiKeyModel';
-import Collection from '@girder/core/collections/Collection';
-
-var ApiKeyCollection = Collection.extend({
-    resourceName: 'api_key',
-    model: ApiKeyModel
-});
-
-export default ApiKeyCollection;

package/collections/AssetstoreCollection.js

@@ -1,9 +0,0 @@
-import AssetstoreModel from '@girder/core/models/AssetstoreModel';
-import Collection from '@girder/core/collections/Collection';
-
-var AssetstoreCollection = Collection.extend({
-    resourceName: 'assetstore',
-    model: AssetstoreModel
-});
-
-export default AssetstoreCollection;

package/collections/Collection.js

@@ -1,295 +0,0 @@
-import _ from 'underscore';
-import Backbone from 'backbone';
-
-import { localeComparator } from '@girder/core/misc';
-import Model from '@girder/core/models/Model';
-import { restRequest } from '@girder/core/rest';
-import { SORT_ASC } from '@girder/core/constants';
-
-/**
- * All collections should descend from this collection base class, which
- * provides nice utilities for pagination and sorting.
- */
-var Collection = Backbone.Collection.extend({
-    model: Model,
-    resourceName: null,
-
-    sortField: 'name',
-    sortDir: SORT_ASC,
-    comparator: localeComparator,
-
-    // Number of records to fetch per page
-    pageLimit: 25,
-    offset: 0,
-
-    // Alternative fetch URL
-    altUrl: null,
-
-    /**
-     * Append mode can be used to append pages to the collection rather than
-     * simply replacing its contents when a new page is fetched. For the sake
-     * of least surprise, this property should not be changed in the definition
-     * of collections, but after they are instantiated.
-     */
-    append: false,
-
-    /**
-     * Client-side filtering: set to a function that takes an instance of this
-     * collection's model and returns true for each instance that should be
-     * included in this collection.  For the sake of least surprise, this
-     * property should not be changed in the definition of collections, but
-     * after they are instantiated.
-     */
-    filterFunc: null,
-
-    /**
-     * If filtering and not appending, this stack is used to record the offsets
-     * at which prior pages had been fetched.
-     */
-    pageOffsetStack: null,
-
-    /**
-     * Number of items in the collection returned by 'girder-total-count' header
-     */
-    _totalCount: 0,
-
-    /**
-     * Returns a boolean of whether or not this collection has previous pages,
-     * i.e. if the offset of the current page start is > 0
-     */
-    hasPreviousPage: function () {
-        if (this.filterFunc) {
-            if (this.append) { return false; }
-            this.pageOffsetStack = this.pageOffsetStack || [];
-            return (this.pageOffsetStack.length > 1);
-        }
-        return this.offset - this.length > 0;
-    },
-
-    /**
-     * After you have called fetch() on a collection, this method will tell
-     * you whether there are more pages remaining to be fetched, or if you
-     * have hit the end.
-     */
-    hasNextPage: function () {
-        return this._hasMorePages;
-    },
-    /**
-     *  This value is populated whenever the list length exceeds the pageLimit.
-     *  It is used to determine how many pages are needed based on the page limit
-     *  it is retrieved from the response header 'girder-total-count'
-     *  @returns {number} total number of items retrieved
-     */
-    getTotalCount: function () {
-        return this._totalCount || 0;
-    },
-    /**
-     * Fetch the previous page of this collection, emitting g:changed when done.
-     */
-    fetchPreviousPage: function (params) {
-        if (this.filterFunc) {
-            if (this.append) {
-                this.offset = 0;
-            } else {
-                this.pageOffsetStack = this.pageOffsetStack || [];
-                if (this.pageOffsetStack.length) {
-                    this.pageOffsetStack.pop();
-                }
-
-                this.offset = (
-                    this.pageOffsetStack.length ? this.pageOffsetStack.pop() : 0
-                );
-            }
-        } else {
-            this.offset = Math.max(
-                0,
-                this.offset - this.length - this.pageLimit);
-        }
-        return this.fetch(_.extend({}, this.params, params || {}));
-    },
-
-    /**
-     * Fetch the next page of this collection, emitting g:changed when done.
-     */
-    fetchNextPage: function (params) {
-        return this.fetch(_.extend({}, this.params, params || {}));
-    },
-
-    /**
-     * @returns {number} the 0-indexed page number of the current page. Add 1 to this
-     * result when displaying it to the user.
-     *
-     * If this collection hasn't been fully initialized (i.e.: before any pages
-     * have been fetched), pageNum() may return a page number < 0 to signal that
-     * there is no "current page".
-     */
-    pageNum: function () {
-        if (this.filterFunc) {
-            if (this.append) { return 0; }
-            this.pageOffsetStack = this.pageOffsetStack || [];
-            return this.pageOffsetStack.length - 1;
-        }
-        return Math.ceil((this.offset - this.length) / this.pageLimit);
-    },
-
-    /**
-     * Sets a specific pagenumber for loading by calculating the offset
-     * @param {Number} pageNumber The 0 indexed page that should be loaded based on the pageLimit size
-     * @param {Object} params Additional parameters to pass to the fetch call
-     * @returns {Promise} a fetch promise to retrieve more data
-     */
-    fetchPage: function (pageNumber, params) {
-        // Make sure the page Number is within range, pageNumber is indexed at 0
-        if (!this.append && pageNumber * this.pageLimit < this._totalCount && pageNumber >= 0) {
-            this.offset = pageNumber * this.pageLimit;
-            return this.fetch(_.extend({}, this.params, params || {}));
-        }
-    },
-
-    /**
-     * Fetches the next page of this collection, replacing the existing models
-     * of this collection with the requested page. If the next page contains
-     * any records (i.e. it was not already on the last page), this will
-     * trigger g:changed.
-     * @param params Any additional parameters to be passed with the request.
-     * @param reset Set this to true to re-fetch the current page.
-     */
-    fetch: function (params, reset) {
-        if (this.altUrl === null && this.resourceName === null) {
-            throw new Error('An altUrl or resourceName must be set on the Collection.');
-        }
-
-        if (this.filterFunc && !this.append) {
-            this.pageOffsetStack = this.pageOffsetStack || [];
-        }
-
-        if (reset) {
-            if (this.filterFunc && !this.append) {
-                this.pageOffsetStack = [];
-            }
-            this.offset = 0;
-        } else {
-            this.params = params || {};
-        }
-
-        if (this.filterFunc && !this.append) {
-            this.pageOffsetStack.push(this.offset);
-        }
-
-        var limit = this.pageLimit > 0 ? this.pageLimit + 1 : 0;
-
-        var finalList = []; /* will be built up in pieces */
-
-        function fetchListFragment() {
-            var xhr = restRequest({
-                url: this.altUrl || this.resourceName,
-                data: _.extend({
-                    limit: limit,
-                    offset: this.offset,
-                    sort: this.sortField,
-                    sortdir: this.sortDir
-                }, this.params)
-            });
-
-            var result = xhr.then((list) => {
-                if (this.pageLimit > 0 && list.length > this.pageLimit) {
-                    // This means we have more pages to display still. Pop off
-                    // the extra that we fetched.
-                    list.pop();
-                    this._totalCount = xhr.getResponseHeader('girder-total-count');
-                    this._hasMorePages = true;
-                } else {
-                    this._hasMorePages = false;
-                }
-
-                var offsetDelta = list.length;
-
-                /*
-                 * If filtering, decorate the list with their pre-filtered
-                 * indexes.  The index will be needed when adjusting the offset.
-                 */
-                if (this.filterFunc) {
-                    var filter = this.filterFunc;
-                    list = (
-                        list
-                            .map(function (x, index) { return [index, x]; })
-                            .filter(function (tuple) {
-                                return filter(tuple[1]);
-                            })
-                    );
-                }
-
-                var numUsed = list.length;
-                var wantMorePages = (
-                    (this.pageLimit === 0) ||
-                    (finalList.length + numUsed < this.pageLimit)
-                );
-
-                /* page is complete */
-                if (!wantMorePages && this.pageLimit > 0) {
-                    /*
-                     * If we fetched more data than we needed to complete the
-                     * page, then newNumUsed will be < numUsed ...
-                     */
-                    var newNumUsed = this.pageLimit - finalList.length;
-                    if (numUsed > newNumUsed) {
-                        /*
-                         * ...therefore, entries are being left out at the end,
-                         * so they necessarily remain to be fetched.
-                         */
-                        this._hasMorePages = true;
-                        numUsed = newNumUsed;
-                    }
-
-                    /*
-                     * correct the offset: it must be advanced beyond the
-                     * last element that got used.
-                     */
-                    if (this.filterFunc) {
-                        /*
-                         * If filtering, consult the index for the last element
-                         * to be featured on this page.
-                         */
-                        offsetDelta = list[numUsed - 1][0] + 1;
-                    } else {
-                        /*
-                         * Otherwise, the first numUsed elements will be
-                         * unconditionally featured.
-                         */
-                        offsetDelta = numUsed;
-                    }
-                }
-
-                list = list.slice(0, numUsed);
-                /* If filtering, undecorate the list. */
-                if (this.filterFunc) {
-                    list = list.map(function (tuple) { return tuple[1]; });
-                }
-
-                finalList = finalList.concat(list);
-                this.offset += offsetDelta;
-
-                if (wantMorePages && this._hasMorePages) {
-                    return fetchListFragment.apply(this);
-                } else {
-                    if (finalList.length > 0 || reset) {
-                        if (this.append && !reset) {
-                            this.add(finalList);
-                        } else {
-                            this.reset(finalList);
-                        }
-                    }
-
-                    this.trigger('g:changed');
-                }
-                return undefined;
-            });
-            xhr.girder = { fetch: true };
-            return result;
-        }
-
-        return fetchListFragment.apply(this);
-    }
-});
-
-export default Collection;

package/collections/CollectionCollection.js

@@ -1,9 +0,0 @@
-import Collection from '@girder/core/collections/Collection';
-import CollectionModel from '@girder/core/models/CollectionModel';
-
-var CollectionCollection = Collection.extend({
-    resourceName: 'collection',
-    model: CollectionModel
-});
-
-export default CollectionCollection;

package/collections/FileCollection.js

@@ -1,11 +0,0 @@
-import Collection from '@girder/core/collections/Collection';
-import FileModel from '@girder/core/models/FileModel';
-
-var FileCollection = Collection.extend({
-    resourceName: 'file',
-    model: FileModel,
-
-    pageLimit: 100
-});
-
-export default FileCollection;

package/collections/FolderCollection.js

@@ -1,11 +0,0 @@
-import Collection from '@girder/core/collections/Collection';
-import FolderModel from '@girder/core/models/FolderModel';
-
-var FolderCollection = Collection.extend({
-    resourceName: 'folder',
-    model: FolderModel,
-
-    pageLimit: 100
-});
-
-export default FolderCollection;