scratch-storage 6.1.11 → 6.2.1

package/dist/types/WebHelper.d.ts

@@ -4,12 +4,18 @@ import { ScratchGetRequest, ScratchSendRequest, Tool } from './Tool';
 import { AssetType } from './AssetType';
 import { DataFormat } from './DataFormat';
 /**
- * @typedef {function} UrlFunction - A function which computes a URL from asset information.
- * @param {Asset} - The asset for which the URL should be computed.
- * @returns {(string|object)} - A string representing the URL for the asset request OR an object with configuration for
- *                              the underlying fetch call (necessary for configuring e.g. authentication)
+ * The result of a UrlFunction, which can be a string URL or a full request configuration
+ * object, or a promise for either of those.
+ *
+ * If set to null or undefined, the WebHelper will skip that store and move on to the
+ * next one. This allows stores to be registered that only provide a subset of their
+ * declared asset types at a given time.
  */
-export type UrlFunction = (asset: Asset) => string | ScratchGetRequest | ScratchSendRequest;
+type RequestFnResult = null | undefined | string | ScratchGetRequest | ScratchSendRequest;
+/**
+ * A function which computes a URL from asset information.
+ */
+export type UrlFunction = (asset: Asset) => RequestFnResult | Promise<RequestFnResult>;
 interface StoreRecord {
     types: string[];
     get: UrlFunction;

package/dist/web/scratch-storage.js

@@ -4886,7 +4886,12 @@ function WebHelper_toPrimitive(t, r) { if ("object" != typeof t || !t) return t;
 
 
 
-const ensureRequestConfig = reqConfig => {
+/**
+ * Ensure that the provided request configuration is in object form, converting from
+ * string if necessary.
+ */
+const ensureRequestConfig = async reqConfig => {
+  reqConfig = await reqConfig;
   if (typeof reqConfig === 'string') {
     return {
       url: reqConfig
@@ -4955,8 +4960,8 @@ class WebHelper extends Helper {
    * @param {DataFormat} dataFormat - The file format / file extension of the asset to fetch: PNG, JPG, etc.
    * @returns {Promise.<Asset>} A promise for the contents of the asset.
    */
-  load(assetType, assetId, dataFormat) {
-    /** @type {Array.<{url:string, result:*}>} List of URLs attempted & errors encountered. */
+  async load(assetType, assetId, dataFormat) {
+    /** @type {unknown[]} List of errors encountered while attempting to load the asset. */
     const errors = [];
     const stores = this.stores.slice().filter(store => store.types.indexOf(assetType.name) >= 0);
     // New empty asset but it doesn't have data yet
@@ -4965,33 +4970,29 @@ class WebHelper extends Helper {
     if (assetType.name === 'Project') {
       tool = this.projectTool;
     }
-    let storeIndex = 0;
-    const tryNextSource = err => {
-      if (err) {
-        errors.push(err);
-      }
-      const store = stores[storeIndex++];
-      /** @type {UrlFunction} */
+    for (const store of stores) {
       const reqConfigFunction = store && store.get;
       if (reqConfigFunction) {
-        const reqConfig = ensureRequestConfig(reqConfigFunction(asset));
-        if (reqConfig === false) {
-          return tryNextSource();
-        }
-        return tool.get(reqConfig).then(body => {
+        try {
+          const reqConfig = await ensureRequestConfig(reqConfigFunction(asset));
+          if (!reqConfig) {
+            continue;
+          }
+          const body = await tool.get(reqConfig);
           if (body) {
             asset.setData(body, dataFormat);
             return asset;
           }
-          return tryNextSource();
-        }).catch(tryNextSource);
-      } else if (errors.length > 0) {
-        return Promise.reject(errors);
+        } catch (err) {
+          errors.push(err);
+        }
       }
-      // no stores matching asset
-      return Promise.resolve(null);
-    };
-    return tryNextSource();
+    }
+    if (errors.length > 0) {
+      return Promise.reject(errors);
+    }
+    // no stores matching asset
+    return Promise.resolve(null);
   }
   /**
    * Create or update an asset with provided data. The create function is called if no asset id is provided
@@ -5001,33 +5002,38 @@ class WebHelper extends Helper {
    * @param {?string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
    * @returns {Promise.<object>} A promise for the response from the create or update request
    */
-  store(assetType, dataFormat, data, assetId) {
+  async store(assetType, dataFormat, data, assetId) {
     const asset = new Asset(assetType, assetId, dataFormat);
     // If we have an asset id, we should update, otherwise create to get an id
     const create = assetId === '' || assetId === null || typeof assetId === 'undefined';
-    // Use the first store with the appropriate asset type and url function
-    const store = this.stores.filter(s =>
+    const candidateStores = this.stores.filter(s =>
     // Only use stores for the incoming asset type
     s.types.indexOf(assetType.name) !== -1 && (
     // Only use stores that have a create function if this is a create request
     // or an update function if this is an update request
-    create && s.create || s.update))[0];
+    create && s.create || s.update));
     const method = create ? 'post' : 'put';
-    if (!store) return Promise.reject(new Error('No appropriate stores'));
+    if (candidateStores.length === 0) {
+      return Promise.reject(new Error('No appropriate stores'));
+    }
     let tool = this.assetTool;
     if (assetType.name === 'Project') {
       tool = this.projectTool;
     }
-    const reqConfig = ensureRequestConfig(
-    // The non-nullability of this gets checked above while looking up the store.
-    // Making TS understand that is going to require code refactoring which we currently don't
-    // feel safe to do.
-    create ? store.create(asset) : store.update(asset));
-    const reqBodyConfig = Object.assign({
-      body: data,
-      method
-    }, reqConfig);
-    return tool.send(reqBodyConfig).then(body => {
+    for (const store of candidateStores) {
+      const reqConfig = await ensureRequestConfig(
+      // The non-nullability of this gets checked above while looking up the store.
+      // Making TS understand that is going to require code refactoring which we currently don't
+      // feel safe to do.
+      create ? store.create(asset) : store.update(asset));
+      if (!reqConfig) {
+        continue;
+      }
+      const reqBodyConfig = Object.assign({
+        body: data,
+        method
+      }, reqConfig);
+      let body = await tool.send(reqBodyConfig);
       // xhr makes it difficult to both send FormData and
       // automatically parse a JSON response. So try to parse
       // everything as JSON.
@@ -5044,7 +5050,8 @@ class WebHelper extends Helper {
       return Object.assign({
         id: body['content-name'] || assetId
       }, body);
-    });
+    }
+    return Promise.reject(new Error('No store could handle the request'));
   }
 }
 ;// ./src/ScratchStorage.ts