decap-cms-lib-util 3.8.0 → 3.8.2

package/dist/esm/backendUtil.js

@@ -1,9 +1,15 @@
 import flow from 'lodash/flow';
 import fromPairs from 'lodash/fromPairs';
 import { map } from 'lodash/fp';
-import { fromJS } from 'immutable';
+import { Map as ImmutableMap } from 'immutable';
 import unsentRequest from './unsentRequest';
 import APIError from './APIError';
+
+// A formatter yields a string, a Blob or parsed JSON depending on the requested
+// format, so its result is only known at the call site - hence `any`. Callers
+// narrow it themselves (e.g. `.then<Blob | string>(...)`).
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+
 export function filterByExtension(file, extension) {
   const path = file?.path || '';
   return path.endsWith(extension.startsWith('.') ? extension : `.${extension}`);
@@ -17,7 +23,10 @@ function catchFormatErrors(format, formatter) {
     }
   };
 }
-const responseFormatters = fromJS({
+
+// NOTE: `Map` rather than `fromJS` on purpose - the values are functions, which
+// `fromJS` would leave untouched anyway, and `Map` keeps them properly typed.
+const responseFormatters = ImmutableMap({
   json: async res => {
     const contentType = res.headers.get('Content-Type') || '';
     if (!contentType.startsWith('application/json') && !contentType.startsWith('text/json')) {

package/dist/esm/unsentRequest.js

@@ -31,6 +31,29 @@ function fetchWithTimeout(input, init) {
 function decodeParams(paramsString) {
   return List(paramsString.split('&')).map(s => List(s.split('=')).map(decodeURIComponent)).update(Map);
 }
+
+// Only `params` and `headers` are ever traversed as collections by the helpers
+// below; every other value of a request is passed straight through to `fetch`.
+const NESTED_REQUEST_KEYS = ['params', 'headers'];
+
+/**
+ * Turns a request-like object into a Map, converting only the keys the request
+ * helpers actually operate on.
+ *
+ * NOTE: this cannot be `fromJS`. immutable 4 recurses into any iterable, not
+ * just plain objects and arrays, so a `FormData` or `URLSearchParams` body
+ * would be turned into a collection and the `toJS()` in `toFetchArguments`
+ * would then hand `fetch` a plain object instead of the original body.
+ */
+function toRequestMap(req) {
+  return Map(req).withMutations(map => {
+    NESTED_REQUEST_KEYS.forEach(key => {
+      if (map.has(key)) {
+        map.set(key, fromJS(map.get(key)));
+      }
+    });
+  });
+}
 function fromURL(wholeURL) {
   const [url, allParamsString] = wholeURL.split('?');
   return Map({
@@ -41,7 +64,7 @@ function fromURL(wholeURL) {
   });
 }
 function fromFetchArguments(wholeURL, options) {
-  return fromURL(wholeURL).merge((options ? fromJS(options) : Map()).remove('url').remove('params'));
+  return fromURL(wholeURL).merge((options ? toRequestMap(options) : Map()).remove('url').remove('params'));
 }
 function encodeParams(params) {
   return params.entrySeq().map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`).join('&');
@@ -57,7 +80,7 @@ function maybeRequestArg(req) {
     return fromURL(req);
   }
   if (req) {
-    return fromJS(req);
+    return toRequestMap(req);
   }
   return Map();
 }

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "decap-cms-lib-util",
   "description": "Shared utilities for Decap CMS.",
-  "version": "3.8.0",
-  "repository": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-lib-util",
+  "version": "3.8.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-lib-util"
+  },
   "bugs": "https://github.com/decaporg/decap-cms/issues",
   "module": "dist/esm/index.js",
   "main": "dist/decap-cms-lib-util.js",
@@ -14,22 +17,22 @@
     "decap-cms"
   ],
   "sideEffects": false,
-  "scripts": {
-    "develop": "npm run build:esm -- --watch",
-    "build": "cross-env NODE_ENV=production webpack",
-    "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward --extensions \".js,.jsx,.ts,.tsx\""
-  },
   "dependencies": {
     "js-sha256": "^0.9.0",
     "localforage": "^1.7.3",
     "semaphore": "^1.1.0"
   },
   "peerDependencies": {
-    "immutable": "^3.7.6",
+    "common-tags": "1.8.2",
+    "immutable": "^4.3.9",
     "lodash": "^4.17.11"
   },
   "devDependencies": {
-    "common-tags": "^1.8.0"
+    "common-tags": "1.8.2"
   },
-  "gitHead": "ffe5ab7e61f4e7cb374a413bf9fe55f088d20ba2"
-}
+  "scripts": {
+    "develop": "pnpm run build:esm --watch",
+    "build": "cross-env NODE_ENV=production webpack",
+    "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward --extensions \".js,.jsx,.ts,.tsx\""
+  }
+}

package/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2016 Netlify <decap@p-m.si>
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/esm/types.js

@@ -1,7 +0,0 @@
-import { Map as ImmutableMap, List } from 'immutable';
-export function isImmutableMap(value) {
-  return ImmutableMap.isMap(value);
-}
-export function isImmutableList(value) {
-  return List.isList(value);
-}