decap-cms-lib-util 3.8.1 → 3.9.0-beta.0

package/dist/esm/backendUtil.js

@@ -91,4 +91,29 @@ export async function getAllResponses(url, options = {}, linkHeaderRelName, next
 export function getPathDepth(path) {
   const depth = path.split('/').length;
   return depth;
+}
+
+/**
+ * Stable cache key for a files collection.
+ *
+ * decap-cms-core's `entriesByFiles` receives only the file list, never the
+ * collection name, so a backend that caches such a collection has to derive an
+ * identity from the paths themselves.
+ *
+ * Sorted before hashing so key identity does not depend on the order files
+ * happen to be listed in config.yml — reordering them must not orphan the
+ * cached rows. Hashed so a collection of many paths does not become a
+ * multi-kilobyte value repeated on every cached row.
+ *
+ * FNV-1a rather than a crypto digest: this needs to be deterministic, short and
+ * synchronous, not unforgeable. It lives here rather than in one backend
+ * because both Turbo backends need exactly the same key.
+ */
+export function collectionKeyForFiles(paths) {
+  let hash = 0x811c9dc5;
+  for (const char of [...paths].sort().join('\n')) {
+    hash ^= char.charCodeAt(0);
+    hash = Math.imul(hash, 0x01000193) >>> 0;
+  }
+  return `files:${paths.length}:${hash.toString(36)}`;
 }

package/dist/esm/index.js

@@ -6,7 +6,7 @@ import localForage from './localForage';
 import { isAbsolutePath, basename, fileExtensionWithSeparator, fileExtension } from './path';
 import { onlySuccessfulPromises, flowAsync, then } from './promise';
 import unsentRequest from './unsentRequest';
-import { filterByExtension, getAllResponses, parseLinkHeader, parseResponse, responseParser, getPathDepth } from './backendUtil';
+import { filterByExtension, collectionKeyForFiles, getAllResponses, parseLinkHeader, parseResponse, responseParser, getPathDepth } from './backendUtil';
 import loadScript from './loadScript';
 import getBlobSHA from './getBlobSHA';
 import { asyncLock } from './asyncLock';
@@ -29,6 +29,7 @@ export const DecapCmsLibUtil = {
   then,
   unsentRequest,
   filterByExtension,
+  collectionKeyForFiles,
   parseLinkHeader,
   parseResponse,
   responseParser,
@@ -68,4 +69,4 @@ export const DecapCmsLibUtil = {
   AccessTokenError,
   throwOnConflictingBranches
 };
-export { APIError, Cursor, CURSOR_COMPATIBILITY_SYMBOL, EditorialWorkflowError, EDITORIAL_WORKFLOW_ERROR, localForage, basename, fileExtensionWithSeparator, fileExtension, onlySuccessfulPromises, flowAsync, then, unsentRequest, filterByExtension, parseLinkHeader, getAllResponses, parseResponse, responseParser, loadScript, getBlobSHA, asyncLock, isAbsolutePath, getPathDepth, entriesByFiles, entriesByFolder, unpublishedEntries, getMediaDisplayURL, getMediaAsBlob, readFile, readFileMetadata, CMS_BRANCH_PREFIX, generateContentKey, isCMSLabel, labelToStatus, statusToLabel, DEFAULT_PR_BODY, MERGE_COMMIT_MESSAGE, isPreviewContext, getPreviewStatus, runWithLock, PreviewState, parseContentKey, createPointerFile, getLargeMediaFilteredMediaFiles, getLargeMediaPatternsFromGitAttributesFile, parsePointerFile, getPointerFileForMediaFileObj, branchFromContentKey, contentKeyFromBranch, blobToFileObj, requestWithBackoff, getDefaultBranchName, allEntriesByFolder, AccessTokenError, throwOnConflictingBranches };
+export { APIError, Cursor, CURSOR_COMPATIBILITY_SYMBOL, EditorialWorkflowError, EDITORIAL_WORKFLOW_ERROR, localForage, basename, fileExtensionWithSeparator, fileExtension, onlySuccessfulPromises, flowAsync, then, unsentRequest, filterByExtension, collectionKeyForFiles, parseLinkHeader, getAllResponses, parseResponse, responseParser, loadScript, getBlobSHA, asyncLock, isAbsolutePath, getPathDepth, entriesByFiles, entriesByFolder, unpublishedEntries, getMediaDisplayURL, getMediaAsBlob, readFile, readFileMetadata, CMS_BRANCH_PREFIX, generateContentKey, isCMSLabel, labelToStatus, statusToLabel, DEFAULT_PR_BODY, MERGE_COMMIT_MESSAGE, isPreviewContext, getPreviewStatus, runWithLock, PreviewState, parseContentKey, createPointerFile, getLargeMediaFilteredMediaFiles, getLargeMediaPatternsFromGitAttributesFile, parsePointerFile, getPointerFileForMediaFileObj, branchFromContentKey, contentKeyFromBranch, blobToFileObj, requestWithBackoff, getDefaultBranchName, allEntriesByFolder, AccessTokenError, throwOnConflictingBranches };

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "decap-cms-lib-util",
   "description": "Shared utilities for Decap CMS.",
-  "version": "3.8.1",
-  "repository": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-lib-util",
+  "version": "3.9.0-beta.0",
+  "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,23 +17,22 @@
     "decap-cms"
   ],
   "sideEffects": false,
-  "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\""
-  },
   "dependencies": {
-    "js-sha256": "catalog:",
-    "localforage": "catalog:",
-    "semaphore": "catalog:"
+    "js-sha256": "^0.9.0",
+    "localforage": "^1.7.3",
+    "semaphore": "^1.1.0"
   },
   "peerDependencies": {
-    "common-tags": "catalog:",
-    "immutable": "catalog:",
-    "lodash": "catalog:"
+    "common-tags": "1.8.2",
+    "immutable": "^4.3.9",
+    "lodash": "^4.17.11"
   },
   "devDependencies": {
-    "common-tags": "catalog:"
+    "common-tags": "1.8.2"
   },
-  "gitHead": "570c3e7fbc399c455729964b9b5fdec079846393"
-}
+  "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.