@girder/core 3.2.7 → 5.0.0-a10

package/dist-lib/index.d.ts

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

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

@@ -7,42 +7,6 @@ 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');
 
@@ -85,12 +49,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 = {
@@ -140,7 +101,6 @@ function logout() {
 }
 
 export {
-    cookie,
     corsAuth,
     getCurrentUser,
     setCurrentUser,

package/{collections → dist-lib/src/collections}/AssetstoreCollection.js

@@ -3,7 +3,8 @@ import Collection from '@girder/core/collections/Collection';
 
 var AssetstoreCollection = Collection.extend({
     resourceName: 'assetstore',
-    model: AssetstoreModel
+    model: AssetstoreModel,
+    pageLimit: 1000
 });
 
 export default AssetstoreCollection;

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

@@ -15,7 +15,6 @@ var AccessType = {
 
 var AssetstoreType = {
     FILESYSTEM: 0,
-    GRIDFS: 1,
     S3: 2
 };
 

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

@@ -0,0 +1,23 @@
+declare const girder: {
+    $: any;
+    _: any;
+    Backbone: 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,46 @@
+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 origin = apiRoot.startsWith('/') ? window.origin : new URL(apiRoot).origin;
+  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 = new URL(href, origin).href;
+    document.head.appendChild(link);
+  });
+
+  // Since plugin JS files may implicitly depend on each other at import time, we can't load
+  // them in parallel. They already come to us in topoligically sorted order, so we can safely
+  // load them one after the other.
+  for (const href of staticFiles.js) {
+    await new Promise<void>((resolve) => {
+      const script = document.createElement('script');
+      script.type = 'text/javascript';
+      script.src = new URL(href, origin).href;
+      document.head.appendChild(script);
+      script.addEventListener('load', function() {
+        resolve();
+      });
+    });
+  };
+
+  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}

@@ -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.
  *
@@ -128,6 +121,18 @@ const restRequest = function (opts) {
     // Overwrite defaults with passed opts, but do not mutate opts
     const args = _.extend({}, defaults, opts);
 
+    try {
+        // If the data is too large for a GET or PUT request, convert it to a POST request.
+        // Girder's REST API handles this for all requests.
+        if ((!args.method || args.method === 'GET' || args.method === 'PUT') && args.data && !args.contentType) {
+            if (JSON.stringify(args.data).length > 1536) {
+                args.headers = args.header || {};
+                args.headers['X-HTTP-Method-Override'] = args.method || 'GET';
+                args.method = 'POST';
+            }
+        }
+    } catch (err) { }
+
     if (!args.url) {
         throw new Error('restRequest requires a "url" argument');
     }

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/{templates → dist-lib/src/templates}/body/assetstores.pug

@@ -31,21 +31,6 @@
             div
               b File creation permissions (octal):
               span.g-assetstore-perms  #{(assetstore.get('perms') || 0o600).toString(8)}
-          else if assetstore.get('type') === types.GRIDFS
-            div
-              b Type:
-              span.g-assetstore-type  GridFS
-            div
-              b Database name:
-              span.g-assetstore-root  #{assetstore.get('db')}
-            if assetstore.get('mongohost')
-              div
-                b Mongo Host URI:
-                span.g-assetstore-mongohost  #{assetstore.get('mongohost')}
-              if assetstore.get('replicaset')
-                div
-                  b Replica Set:
-                  span.g-assetstore-replicaset  #{assetstore.get('replicaset')}
           else if assetstore.get('type') === types.S3
             div
               b Type:

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