@girder/core 3.2.2 → 5.0.0-beta.0

package/dist-lib/girder-swagger.js

@@ -0,0 +1,64 @@
+/* eslint-env jquery */
+$(function () {
+    var apiRoot = $('#g-global-info-apiroot').text().replace(
+        '%HOST%', window.location.origin);
+    if (!apiRoot) {
+        apiRoot = window.location.origin + window.location.pathname;
+    }
+    var swaggerUi = new window.SwaggerUIBundle({
+        url: apiRoot + '/describe',
+        dom_id: '#swagger-ui-container',
+        supportHeaderParams: false,
+        supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
+        onComplete: function () {
+            addApiKeyAuthorization();
+        },
+        onFailure: function (data) {
+            if (console) {
+                console.log('Unable to Load SwaggerUI');
+                console.log(data);
+            }
+        },
+        docExpansion: 'none',
+        jsonEditor: false,
+        apisSorter: 'alpha',
+        operationsSorter: sortOperations,
+        defaultModelRendering: 'model',
+        showRequestHeaders: false,
+        validatorUrl: null,
+        tryItOutEnabled: true,
+        defaultModelsExpandDepth: -1,
+        deepLinking: true
+    });
+
+    var methodOrder = ['get', 'put', 'post', 'patch', 'delete'];
+
+    // Comparator to sort operations by path and method.
+    // Methods not in the pre-defined ordered list are placed at the end and
+    // sorted alphabetically.
+    function sortOperations(op1, op2) {
+        var pathCmp = op1.get('path').localeCompare(op2.get('path'));
+        if (pathCmp !== 0) {
+            return pathCmp;
+        }
+        var index1 = methodOrder.indexOf(op1.get('method'));
+        var index2 = methodOrder.indexOf(op2.get('method'));
+        if (index1 > -1 && index2 > -1) {
+            return index1 > index2 ? 1 : (index1 < index2 ? -1 : 0);
+        }
+        if (index1 > -1) {
+            return -1;
+        }
+        if (index2 > -1) {
+            return 1;
+        }
+        return op1.get('method').localeCompare(op2.get('method'));
+    }
+
+    function addApiKeyAuthorization() {
+        const girderToken = localStorage.getItem('girderToken');
+        if (girderToken) {
+            swaggerUi.preauthorizeApiKey('Girder-Token', girderToken);
+        }
+    }
+});

package/dist-lib/index.d.ts

@@ -0,0 +1 @@
+export * from './src/index'

package/{auth.js → dist-lib/src/auth.js}

@@ -8,7 +8,6 @@ import { restRequest } from '@girder/core/rest';
 // 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 = {};
@@ -44,7 +43,7 @@ var cookie = {
 };
 
 var currentUser = null;
-var currentToken = window.localStorage.getItem('girderToken');
+var currentToken = cookie.find('girderToken');
 
 function getCurrentUser() {
     return currentUser;
@@ -85,12 +84,9 @@ function basicAuthEncode(username, password) {
  *
  * @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) {
+function login(username, password, otpToken = null) {
     var auth = basicAuthEncode(username, password);
 
     const headers = {
@@ -111,7 +107,11 @@ function login(username, password, cors = corsAuth, otpToken = null) {
         setCurrentUser(new UserModel(response.user));
         setCurrentToken(response.user.token.token);
 
-        window.localStorage.setItem('girderToken', response.user.token.token);
+        if (!cookie.find('girderToken')) {
+            // For cross-origin requests, we should write the token into
+            // this document's cookie also.
+            document.cookie = 'girderToken=' + getCurrentToken();
+        }
 
         events.trigger('g:login.success', response.user);
         events.trigger('g:login', response);
@@ -130,8 +130,6 @@ function logout() {
         setCurrentUser(null);
         setCurrentToken(null);
 
-        window.localStorage.removeItem('girderToken');
-
         events.trigger('g:login', null);
         events.trigger('g:logout.success');
     }).fail(function (jqxhr) {

package/dist-lib/src/index.d.ts

@@ -0,0 +1,22 @@
+declare const girder: {
+    $: any;
+    _: any;
+    moment: any;
+    initializeDefaultApp: (apiRoot: string, el?: string | HTMLElement) => Promise<unknown>;
+    auth: any;
+    collections: any;
+    constants: any;
+    dialog: any;
+    events: any;
+    misc: any;
+    models: any;
+    plugins: {};
+    pluginUtils: any;
+    rest: any;
+    router: any;
+    utilities: any;
+    version: any;
+    views: any;
+};
+export type Girder = typeof girder;
+export { girder, };

package/dist-lib/src/index.ts

@@ -0,0 +1,80 @@
+import $ from 'jquery';
+
+import _ from 'underscore';
+
+import Backbone from 'backbone';
+
+import moment from 'moment';
+
+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 pluginUtils from './pluginUtils';
+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';
+
+const initializeDefaultApp = async (apiRoot: string, el: string | HTMLElement = 'body') => {
+    return new Promise((resolve, reject) => {
+        $(() => {
+            rest.setApiRoot(apiRoot);
+            events.trigger('g:appload.before');
+            rest.restRequest({
+                url: `system/public_settings`,
+                method: 'GET',
+            }).done((resp: any) => {
+                const app = new views.App({
+                    el,
+                    parentView: null,
+                    contactEmail: resp['core.contact_email_address'],
+                    privacyNoticeHref: resp['core.privacy_notice'],
+                    brandName: resp['core.brand_name'],
+                    bannerColor: resp['core.banner_color'],
+                    registrationPolicy: resp['core.registration_policy'],
+                    enablePasswordLogin: resp['core.enable_password_login'],
+                });
+                app.render();
+                document.title = resp['core.brand_name'];
+                events.trigger('g:appload.after', app);
+                resolve(app);
+            }).fail((resp: any) => {
+                events.trigger('g:error', resp);
+                reject(new Error("Could not retrieve public settings from server."));
+            });
+        });
+    });
+};
+
+const girder = {
+    $,
+    _,
+    Backbone,
+    moment,
+    initializeDefaultApp,
+    auth,
+    collections,
+    constants,
+    dialog,
+    events,
+    misc,
+    models,
+    plugins: {},
+    pluginUtils,
+    rest,
+    router,
+    utilities,
+    version,
+    views
+};
+
+export type Girder = typeof girder;
+
+export {
+    girder,
+};

package/dist-lib/src/main.ts

@@ -0,0 +1,37 @@
+import { girder } from '.';
+
+declare global {
+  interface Window {
+    girder: typeof girder;
+  }
+}
+window.girder = girder;
+
+interface StaticFilesSpec {
+  css: string[],
+  js: string[],
+}
+
+const apiRoot = import.meta.env.VITE_API_ROOT ?? '/api/v1';
+
+(async () => {
+  const staticFilesResp = await fetch(`${apiRoot}/system/plugin_static_files`);
+  const staticFiles: StaticFilesSpec = await staticFilesResp.json();
+
+  staticFiles.css.forEach((href) => {
+    const link = document.createElement('link');
+    link.rel = 'stylesheet';
+    link.type = 'text/css';
+    link.href = href;
+    document.head.appendChild(link);
+  });
+
+  staticFiles.js.forEach((src) => {
+    const script = document.createElement('script');
+    script.type = 'text/javascript';
+    script.src = src;
+    document.head.appendChild(script);
+  })
+
+  await girder.initializeDefaultApp(apiRoot);
+})();

package/{models → dist-lib/src/models}/FolderModel.js

@@ -20,7 +20,7 @@ var FolderModel = AccessControlledModel.extend({
         return restRequest({
             url: `${this.resourceName}/${this.id}/contents`,
             method: 'DELETE'
-        }).done((resp) => {
+        }).done(() => {
             this.trigger('g:success');
         }).fail((err) => {
             this.trigger('g:error', err);

package/{rest.js → dist-lib/src/rest.js}

@@ -3,7 +3,7 @@ import _ from 'underscore';
 import Backbone from 'backbone';
 
 import events from '@girder/core/events';
-import { getCurrentToken, setCurrentUser, setCurrentToken } from '@girder/core/auth';
+import { getCurrentToken, cookie } from '@girder/core/auth';
 
 let apiRoot;
 var uploadHandlers = {};
@@ -31,13 +31,6 @@ function setApiRoot(root) {
     apiRoot = root.replace(/\/$/, '');
 }
 
-// Initialize the API root (at JS load time)
-// This could be overridden when the App is started, but we need sensible defaults so models, etc.
-// can be easily used without having to start an App or explicitly set these values
-setApiRoot(
-    $('#g-global-info-apiroot').text().replace('%HOST%', window.location.origin) || '/api/v1'
-);
-
 /**
  * Make a request to the REST API.
  *
@@ -70,13 +63,11 @@ const restRequest = function (opts) {
     const defaults = {
         // the default 'method' is 'GET', as set by 'jquery.ajax'
 
-        girderToken: getCurrentToken() || window.localStorage.getItem('girderToken'),
+        girderToken: getCurrentToken() || cookie.find('girderToken'),
 
         error: (error, status) => {
             let info;
             if (error.status === 401) {
-                setCurrentUser(null);
-                setCurrentToken(null);
                 events.trigger('g:loginUi');
                 info = {
                     text: 'You must log in to view this resource',

package/{routes.js → dist-lib/src/routes.js}

@@ -1,5 +1,3 @@
-/* eslint-disable import/first */
-
 import router from '@girder/core/router';
 import events from '@girder/core/events';
 import eventStream from '@girder/core/utilities/EventStream';
@@ -10,14 +8,76 @@ import { restRequest } from '@girder/core/rest';
  * Admin
  */
 import AdminView from '@girder/core/views/body/AdminView';
-router.route('admin', 'admin', function () {
-    events.trigger('g:navigateTo', AdminView);
-});
 
 /**
  * Assetstores
  */
 import AssetstoresView from '@girder/core/views/body/AssetstoresView';
+
+/**
+ * Collections
+ */
+import CollectionsView from '@girder/core/views/body/CollectionsView';
+
+/**
+ * Collection
+ */
+import CollectionView from '@girder/core/views/body/CollectionView';
+
+/**
+ * Folder
+ */
+import FolderView from '@girder/core/views/body/FolderView';
+
+/**
+ * FrontPage
+ */
+import FrontPageView from '@girder/core/views/body/FrontPageView';
+
+/**
+ * Groups
+ */
+import GroupsView from '@girder/core/views/body/GroupsView';
+
+/**
+ * Group
+ */
+import GroupView from '@girder/core/views/body/GroupView';
+
+/**
+ * Item
+ */
+import ItemView from '@girder/core/views/body/ItemView';
+
+/**
+ * Plugins
+ */
+import PluginsView from '@girder/core/views/body/PluginsView';
+import UsersView from '@girder/core/views/body/UsersView';
+
+/**
+ * SystemConfiguration
+ */
+import SystemConfigurationView from '@girder/core/views/body/SystemConfigurationView';
+
+/**
+ * UserAccount
+ */
+import UserAccountView from '@girder/core/views/body/UserAccountView';
+import UserModel from '@girder/core/models/UserModel';
+
+/**
+ * User
+ */
+import UserView from '@girder/core/views/body/UserView';
+
+/**
+ * SearchResults
+ */
+import SearchResultsView from '@girder/core/views/body/SearchResultsView';
+router.route('admin', 'admin', function () {
+    events.trigger('g:navigateTo', AdminView);
+});
 router.route('assetstores', 'assetstores', function (params) {
     events.trigger('g:navigateTo', AssetstoresView, {
         assetstoreEdit: params.dialog === 'assetstoreedit' ? params.dialogid : false
@@ -26,20 +86,10 @@ router.route('assetstores', 'assetstores', function (params) {
 router.route('assetstore/:id/import', 'assetstoreImport', function (assetstoreId) {
     AssetstoresView.import(assetstoreId);
 });
-
-/**
- * Collections
- */
-import CollectionsView from '@girder/core/views/body/CollectionsView';
 router.route('collections', 'collections', function (params) {
     events.trigger('g:navigateTo', CollectionsView, params || {});
     events.trigger('g:highlightItem', 'CollectionsView');
 });
-
-/**
- * Collection
- */
-import CollectionView from '@girder/core/views/body/CollectionView';
 router.route('collection/:id', 'collectionAccess', function (cid, params) {
     CollectionView.fetchAndInit(cid, {
         access: params.dialog === 'access',
@@ -60,11 +110,6 @@ router.route('collection/:id/folder/:id', 'collectionFolder', function (cid, fol
         itemCreate: params.dialog === 'itemcreate'
     });
 });
-
-/**
- * Folder
- */
-import FolderView from '@girder/core/views/body/FolderView';
 router.route('folder/:id', 'folder', function (id, params) {
     FolderView.fetchAndInit(id, {
         upload: params.dialog === 'upload',
@@ -74,28 +119,13 @@ router.route('folder/:id', 'folder', function (id, params) {
         itemCreate: params.dialog === 'itemcreate'
     });
 });
-
-/**
- * FrontPage
- */
-import FrontPageView from '@girder/core/views/body/FrontPageView';
 router.route('', 'index', function () {
     events.trigger('g:navigateTo', FrontPageView);
 });
-
-/**
- * Groups
- */
-import GroupsView from '@girder/core/views/body/GroupsView';
 router.route('groups', 'groups', function (params) {
     events.trigger('g:navigateTo', GroupsView, params || {});
     events.trigger('g:highlightItem', 'GroupsView');
 });
-
-/**
- * Group
- */
-import GroupView from '@girder/core/views/body/GroupView';
 router.route('group/:id', 'groupView', function (groupId, params) {
     GroupView.fetchAndInit(groupId, {
         edit: params.dialog === 'edit'
@@ -107,11 +137,6 @@ router.route('group/:id/:tab', 'groupView', function (groupId, tab, params) {
         tab: tab
     });
 });
-
-/**
- * Item
- */
-import ItemView from '@girder/core/views/body/ItemView';
 router.route('item/:id', 'item', function (itemId, params) {
     ItemView.fetchAndInit(itemId, {
         edit: params.dialog === 'itemedit',
@@ -119,29 +144,12 @@ router.route('item/:id', 'item', function (itemId, params) {
         upload: params.dialog === 'upload' ? params.dialogid : false
     });
 });
-
-/**
- * Plugins
- */
-import PluginsView from '@girder/core/views/body/PluginsView';
-import UsersView from '@girder/core/views/body/UsersView';
 router.route('plugins', 'plugins', function () {
     events.trigger('g:navigateTo', PluginsView);
 });
-
-/**
- * SystemConfiguration
- */
-import SystemConfigurationView from '@girder/core/views/body/SystemConfigurationView';
 router.route('settings', 'settings', function () {
     events.trigger('g:navigateTo', SystemConfigurationView);
 });
-
-/**
- * UserAccount
- */
-import UserAccountView from '@girder/core/views/body/UserAccountView';
-import UserModel from '@girder/core/models/UserModel';
 router.route('useraccount/:id/:tab', 'accountTab', function (id, tab) {
     UserAccountView.fetchAndInit(id, tab);
 });
@@ -197,11 +205,6 @@ router.route('users', 'users', function (params) {
     events.trigger('g:navigateTo', UsersView, params || {});
     events.trigger('g:highlightItem', 'UsersView');
 });
-
-/**
- * User
- */
-import UserView from '@girder/core/views/body/UserView';
 router.route('user/:id', 'user', function (userId, params) {
     UserView.fetchAndInit(userId, {
         folderCreate: params.dialog === 'foldercreate',
@@ -218,11 +221,6 @@ router.route('user/:id/folder/:id', 'userFolder', function (userId, folderId, pa
         itemCreate: params.dialog === 'itemcreate'
     });
 });
-
-/**
- * SearchResults
- */
-import SearchResultsView from '@girder/core/views/body/SearchResultsView';
 router.route('search/results', 'SearchResults', function (params) {
     events.trigger('g:navigateTo', SearchResultsView, {
         query: params.query,

package/{stylesheets → dist-lib/src/stylesheets}/layout/global.styl

@@ -9,7 +9,7 @@ body
   word-wrap break-word
 
 i
-  -webkit-font-smoothing antialiased
+  font-smoothing antialiased
 
 a
   cursor pointer

package/{stylesheets → dist-lib/src/stylesheets}/widgets/userOtpManagementWidget.styl

@@ -136,7 +136,7 @@
       font-size 20px
 
 // Responsive Goodness
-@media screen and (max-width 1156px)
+@media screen and (max-width1156px)
   .g-account-otp-container
     .g-account-otp-steps
       .g-account-otp-step
@@ -146,7 +146,7 @@
               &:before
                 display none
 
-@media screen and (max-width 960px)
+@media screen and (max-width960px)
   .g-account-otp-container
     .g-account-otp-steps
       .g-account-otp-step

package/{templates → dist-lib/src/templates}/body/frontPage.pug

@@ -1,6 +1,6 @@
 .g-frontpage-header
   .g-frontpage-logo-container
-    img.g-frontpage-logo(src=require('@girder/core/assets/Girder_Mark.png'))
+    img.g-frontpage-logo(src='/Girder_Mark.png')
   .g-frontpage-title-container
     .g-frontpage-title #{brandName}
     .g-frontpage-subtitle Data management platform

package/dist-lib/src/version.js

@@ -0,0 +1,8 @@
+/* global process */
+
+const versionRaw = process.env.GIRDER_VERSION || null;
+
+// Enforce that it's a string or null to make TypeScript happy
+const version = versionRaw === null ? null : `${versionRaw}`;
+
+export default version;

package/{views → dist-lib/src/views}/View.js

@@ -5,7 +5,8 @@ import events from '@girder/core/events';
 import eventStream from '@girder/core/utilities/EventStream';
 
 var View = Backbone.View.extend({
-    constructor: function (opts) { // eslint-disable-line backbone/no-constructor
+    // eslint-disable-next-line backbone/no-constructor
+    constructor: function (opts) {
         if (opts && _.has(opts, 'parentView')) {
             if (opts.parentView) {
                 opts.parentView.registerChildView(this);

package/{views → dist-lib/src/views}/layout/LoginView.js

@@ -26,7 +26,7 @@ var LoginView = View.extend({
             const loginName = this.$('#g-login').val();
             const password = this.$('#g-password').val();
             const otpToken = this.$('#g-login-otp-group').hasClass('hidden') ? null : this.$('#g-login-otp').val();
-            login(loginName, password, undefined, otpToken)
+            login(loginName, password, otpToken)
                 .done(() => {
                     this.$el.modal('hide');
                 })

package/{views → dist-lib/src/views}/layout/RegisterView.js

@@ -1,7 +1,7 @@
 import UserModel from '@girder/core/models/UserModel';
 import View from '@girder/core/views/View';
 import events from '@girder/core/events';
-import { getCurrentUser, setCurrentUser, getCurrentToken, setCurrentToken } from '@girder/core/auth';
+import { getCurrentUser, setCurrentUser, getCurrentToken, setCurrentToken, corsAuth } from '@girder/core/auth';
 import { handleClose, handleOpen } from '@girder/core/dialog';
 
 import RegisterDialogTemplate from '@girder/core/templates/layout/registerDialog.pug';
@@ -44,7 +44,10 @@ var RegisterView = View.extend({
                     if (authToken.token) {
                         setCurrentUser(user);
                         setCurrentToken(authToken.token);
-                        window.localStorage.setItem('girderToken', getCurrentToken());
+
+                        if (corsAuth) {
+                            document.cookie = 'girderToken=' + getCurrentToken();
+                        }
 
                         events.trigger('g:login');
                     } else {

package/{views → dist-lib/src/views}/widgets/ApiKeyListWidget.js

@@ -38,7 +38,7 @@ var ApiKeyListWidget = View.extend({
             }
         },
 
-        'click .g-api-key-new': function (e) {
+        'click .g-api-key-new': function () {
             this._renderEditWidget();
         },
 

package/{views → dist-lib/src/views}/widgets/DateTimeRangeWidget.js

@@ -5,7 +5,8 @@ import View from '@girder/core/views/View';
 
 import dateTimeRangeWidgetTemplate from '@girder/core/templates/widgets/dateTimeRangeWidget.pug';
 
-import 'eonasdan-bootstrap-datetimepicker'; // /src/js/bootstrap-datetimepicker.js'
+// Momentjs is not require()'d in the way this library expects
+// import 'eonasdan-bootstrap-datetimepicker'; // /src/js/bootstrap-datetimepicker.js'
 import 'eonasdan-bootstrap-datetimepicker/build/css/bootstrap-datetimepicker.css';
 
 /**

package/{views → dist-lib/src/views}/widgets/DateTimeWidget.js

@@ -5,7 +5,8 @@ import View from '@girder/core/views/View';
 
 import dateTimeWidgetTemplate from '@girder/core/templates/widgets/dateTimeWidget.pug';
 
-import 'eonasdan-bootstrap-datetimepicker'; // /src/js/bootstrap-datetimepicker.js'
+// Momentjs is not require()'d in the way this library expects
+// import 'eonasdan-bootstrap-datetimepicker'; // /src/js/bootstrap-datetimepicker.js'
 import 'eonasdan-bootstrap-datetimepicker/build/css/bootstrap-datetimepicker.css';
 
 /**

package/{views → dist-lib/src/views}/widgets/ItemListWidget.js

@@ -272,7 +272,7 @@ var ItemListWidget = View.extend({
             }
 
             // Event handler for loading images declared once
-            const onLoadImage = (event) => {
+            const onLoadImage = () => {
                 if (this.observer) {
                     this.centerSelected();
                 }