decap-cms-lib-util 3.2.0 → 3.3.1

package/src/index.ts

@@ -1,213 +0,0 @@
-import APIError from './APIError';
-import Cursor, { CURSOR_COMPATIBILITY_SYMBOL } from './Cursor';
-import EditorialWorkflowError, { EDITORIAL_WORKFLOW_ERROR } from './EditorialWorkflowError';
-import AccessTokenError from './AccessTokenError';
-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 loadScript from './loadScript';
-import getBlobSHA from './getBlobSHA';
-import { asyncLock } from './asyncLock';
-import {
-  entriesByFiles,
-  entriesByFolder,
-  unpublishedEntries,
-  getMediaDisplayURL,
-  getMediaAsBlob,
-  runWithLock,
-  blobToFileObj,
-  allEntriesByFolder,
-} from './implementation';
-import {
-  readFile,
-  readFileMetadata,
-  isPreviewContext,
-  getPreviewStatus,
-  PreviewState,
-  requestWithBackoff,
-  getDefaultBranchName,
-  throwOnConflictingBranches,
-} from './API';
-import {
-  CMS_BRANCH_PREFIX,
-  generateContentKey,
-  isCMSLabel,
-  labelToStatus,
-  statusToLabel,
-  DEFAULT_PR_BODY,
-  MERGE_COMMIT_MESSAGE,
-  parseContentKey,
-  branchFromContentKey,
-  contentKeyFromBranch,
-} from './APIUtils';
-import {
-  createPointerFile,
-  getLargeMediaFilteredMediaFiles,
-  getLargeMediaPatternsFromGitAttributesFile,
-  parsePointerFile,
-  getPointerFileForMediaFileObj,
-} from './git-lfs';
-
-import type { PointerFile as PF } from './git-lfs';
-import type { FetchError as FE, ApiRequest as AR } from './API';
-import type {
-  Implementation as I,
-  ImplementationEntry as IE,
-  UnpublishedEntryDiff as UED,
-  UnpublishedEntry as UE,
-  ImplementationMediaFile as IMF,
-  ImplementationFile as IF,
-  DisplayURLObject as DUO,
-  DisplayURL as DU,
-  Credentials as Cred,
-  User as U,
-  Entry as E,
-  PersistOptions as PO,
-  AssetProxy as AP,
-  Config as C,
-  UnpublishedEntryMediaFile as UEMF,
-  DataFile as DF,
-} from './implementation';
-import type { AsyncLock as AL } from './asyncLock';
-
-export type AsyncLock = AL;
-export type Implementation = I;
-export type ImplementationEntry = IE;
-export type UnpublishedEntryDiff = UED;
-export type UnpublishedEntry = UE;
-export type ImplementationMediaFile = IMF;
-export type ImplementationFile = IF;
-export type DisplayURL = DU;
-export type DisplayURLObject = DUO;
-export type Credentials = Cred;
-export type User = U;
-export type Entry = E;
-export type UnpublishedEntryMediaFile = UEMF;
-export type PersistOptions = PO;
-export type AssetProxy = AP;
-export type ApiRequest = AR;
-export type Config = C;
-export type FetchError = FE;
-export type PointerFile = PF;
-export type DataFile = DF;
-
-export const DecapCmsLibUtil = {
-  APIError,
-  Cursor,
-  CURSOR_COMPATIBILITY_SYMBOL,
-  EditorialWorkflowError,
-  EDITORIAL_WORKFLOW_ERROR,
-  localForage,
-  basename,
-  fileExtensionWithSeparator,
-  fileExtension,
-  onlySuccessfulPromises,
-  flowAsync,
-  then,
-  unsentRequest,
-  filterByExtension,
-  parseLinkHeader,
-  parseResponse,
-  responseParser,
-  loadScript,
-  getBlobSHA,
-  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,
-  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/src/loadScript.js

@@ -1,24 +0,0 @@
-/**
- * Simple script loader that returns a promise.
- */
-export default function loadScript(url) {
-  return new Promise((resolve, reject) => {
-    let done = false;
-    const head = document.getElementsByTagName('head')[0];
-    const script = document.createElement('script');
-    script.src = url;
-    script.onload = script.onreadystatechange = function () {
-      if (
-        !done &&
-        (!this.readyState || this.readyState === 'loaded' || this.readyState === 'complete')
-      ) {
-        done = true;
-        resolve();
-      } else {
-        reject();
-      }
-    };
-    script.onerror = error => reject(error);
-    head.appendChild(script);
-  });
-}

package/src/localForage.ts

@@ -1,21 +0,0 @@
-import localForage from 'localforage';
-
-function localForageTest() {
-  const testKey = 'localForageTest';
-  localForage
-    .setItem(testKey, { expires: Date.now() + 300000 })
-    .then(() => {
-      localForage.removeItem(testKey);
-    })
-    .catch(err => {
-      if (err.code === 22) {
-        const message = 'Unable to set localStorage key. Quota exceeded! Full disk?';
-        console.warn(message);
-      }
-      console.log(err);
-    });
-}
-
-localForageTest();
-
-export default localForage;

package/src/path.ts

@@ -1,86 +0,0 @@
-const absolutePath = new RegExp('^(?:[a-z]+:)?//', 'i');
-
-function normalizePath(path: string) {
-  return path.replace(/[\\/]+/g, '/');
-}
-
-export function isAbsolutePath(path: string) {
-  return absolutePath.test(path);
-}
-
-/**
- * Return the last portion of a path. Similar to the Unix basename command.
- * @example Usage example
- *   path.basename('/foo/bar/baz/asdf/quux.html')
- *   // returns
- *   'quux.html'
- *
- *   path.basename('/foo/bar/baz/asdf/quux.html', '.html')
- *   // returns
- *   'quux'
- */
-export function basename(p: string, ext = '') {
-  // Special case: Normalize will modify this to '.'
-  if (p === '') {
-    return p;
-  }
-  // Normalize the string first to remove any weirdness.
-  p = normalizePath(p);
-  // Get the last part of the string.
-  const sections = p.split('/');
-  const lastPart = sections[sections.length - 1];
-  // Special case: If it's empty, then we have a string like so: foo/
-  // Meaning, 'foo' is guaranteed to be a directory.
-  if (lastPart === '' && sections.length > 1) {
-    return sections[sections.length - 2];
-  }
-  // Remove the extension, if need be.
-  if (ext.length > 0) {
-    const lastPartExt = lastPart.slice(-ext.length);
-    if (lastPartExt === ext) {
-      return lastPart.slice(0, -ext.length);
-    }
-  }
-  return lastPart;
-}
-
-/**
- * Return the extension of the path, from the last '.' to end of string in the
- * last portion of the path. If there is no '.' in the last portion of the path
- * or the first character of it is '.', then it returns an empty string.
- * @example Usage example
- *   path.fileExtensionWithSeparator('index.html')
- *   // returns
- *   '.html'
- */
-export function fileExtensionWithSeparator(p: string) {
-  p = normalizePath(p);
-  const sections = p.split('/');
-  p = sections.pop() as string;
-  // Special case: foo/file.ext/ should return '.ext'
-  if (p === '' && sections.length > 0) {
-    p = sections.pop() as string;
-  }
-  if (p === '..') {
-    return '';
-  }
-  const i = p.lastIndexOf('.');
-  if (i === -1 || i === 0) {
-    return '';
-  }
-  return p.slice(i);
-}
-
-/**
- * Return the extension of the path, from after the last '.' to end of string in the
- * last portion of the path. If there is no '.' in the last portion of the path
- * or the first character of it is '.', then it returns an empty string.
- * @example Usage example
- *   path.fileExtension('index.html')
- *   // returns
- *   'html'
- */
-export function fileExtension(p: string) {
-  const ext = fileExtensionWithSeparator(p);
-  return ext === '' ? ext : ext.slice(1);
-}

package/src/promise.ts

@@ -1,21 +0,0 @@
-import flow from 'lodash/flow';
-
-export function then<T, V>(fn: (r: T) => V) {
-  return (p: Promise<T>) => Promise.resolve(p).then(fn);
-}
-
-const filterPromiseSymbol = Symbol('filterPromiseSymbol');
-
-export function onlySuccessfulPromises(promises: Promise<unknown>[]) {
-  return Promise.all(promises.map(p => p.catch(() => filterPromiseSymbol))).then(results =>
-    results.filter(result => result !== filterPromiseSymbol),
-  );
-}
-
-function wrapFlowAsync(fn: Function) {
-  return async (arg: unknown) => fn(await arg);
-}
-
-export function flowAsync(fns: Function[]) {
-  return flow(fns.map(fn => wrapFlowAsync(fn)));
-}

package/src/stega.ts

@@ -1,134 +0,0 @@
-import { vercelStegaEncode } from '@vercel/stega';
-
-import { isImmutableMap, isImmutableList } from './types';
-
-import type { Map as ImmutableMap, List } from 'immutable';
-import type { CmsField } from 'decap-cms-core';
-
-/**
- * Context passed to encode functions, containing the current state of the encoding process
- */
-interface EncodeContext {
-  fields: CmsField[]; // Available CMS fields at current level
-  path: string; // Path to current value in object tree
-  visit: (value: unknown, fields: CmsField[], path: string) => unknown; // Visitor for recursive traversal
-}
-
-/**
- * Get the fields that should be used for encoding nested values
- */
-function getNestedFields(f?: CmsField): CmsField[] {
-  if (f) {
-    if ('types' in f) {
-      return f.types ?? [];
-    }
-    if ('fields' in f) {
-      return f.fields ?? [];
-    }
-    if ('field' in f) {
-      return f.field ? [f.field] : [];
-    }
-    return [f];
-  }
-  return [];
-}
-
-/**
- * Encode a string value by appending steganographic data
- * For markdown fields, encode each paragraph separately
- */
-function encodeString(value: string, { fields, path }: EncodeContext): string {
-  const stega = vercelStegaEncode({ decap: path });
-  const isMarkdown = fields[0]?.widget === 'markdown';
-
-  if (isMarkdown && value.includes('\n\n')) {
-    const blocks = value.split(/(\n\n+)/);
-    return blocks.map(block => (block.trim() ? block + stega : block)).join('');
-  }
-  return value + stega;
-}
-
-/**
- * Encode a list of values, handling both simple values and nested objects/lists
- * For typed lists, use the type field to determine which fields to use
- */
-function encodeList(list: List<unknown>, ctx: EncodeContext): List<unknown> {
-  let newList = list;
-  for (let i = 0; i < newList.size; i++) {
-    const item = newList.get(i);
-    if (isImmutableMap(item)) {
-      const itemType = item.get('type');
-      if (typeof itemType === 'string') {
-        // For typed items, look up fields based on type
-        const field = ctx.fields.find(f => f.name === itemType);
-        const newItem = ctx.visit(item, getNestedFields(field), `${ctx.path}.${i}`);
-        newList = newList.set(i, newItem);
-      } else {
-        // For untyped items, use current fields
-        const newItem = ctx.visit(item, ctx.fields, `${ctx.path}.${i}`);
-        newList = newList.set(i, newItem);
-      }
-    } else {
-      // For simple values, use first field if available
-      const field = ctx.fields[0];
-      const newItem = ctx.visit(item, field ? [field] : [], `${ctx.path}.${i}`);
-      if (newItem !== item) {
-        newList = newList.set(i, newItem);
-      }
-    }
-  }
-  return newList;
-}
-
-/**
- * Encode a map of values, looking up the appropriate field for each key
- * and recursively encoding nested values
- */
-function encodeMap(
-  map: ImmutableMap<string, unknown>,
-  ctx: EncodeContext,
-): ImmutableMap<string, unknown> {
-  let newMap = map;
-  for (const [key, val] of newMap.entrySeq().toArray()) {
-    const field = ctx.fields.find(f => f.name === key);
-    if (field) {
-      const fields = getNestedFields(field);
-      const newVal = ctx.visit(val, fields, ctx.path ? `${ctx.path}.${key}` : key);
-      if (newVal !== val) {
-        newMap = newMap.set(key, newVal);
-      }
-    }
-  }
-  return newMap;
-}
-
-/**
- * Main entry point for encoding steganographic data into entry values
- * Uses a visitor pattern with caching to handle recursive structures
- */
-export function encodeEntry(value: unknown, fields: List<ImmutableMap<string, unknown>>) {
-  const plainFields = fields.toJS() as CmsField[];
-  const cache = new Map();
-
-  function visit(value: unknown, fields: CmsField[], path = '') {
-    const cached = cache.get(path);
-    if (cached === value) return value;
-
-    const ctx: EncodeContext = { fields, path, visit };
-    let result;
-    if (isImmutableList(value)) {
-      result = encodeList(value, ctx);
-    } else if (isImmutableMap(value)) {
-      result = encodeMap(value, ctx);
-    } else if (typeof value === 'string') {
-      result = encodeString(value, ctx);
-    } else {
-      result = value;
-    }
-
-    cache.set(path, result);
-    return result;
-  }
-
-  return visit(value, plainFields);
-}

package/src/types/semaphore.d.ts

@@ -1,5 +0,0 @@
-declare module 'semaphore' {
-  export type Semaphore = { take: (f: Function) => void; leave: () => void };
-  const semaphore: (count: number) => Semaphore;
-  export default semaphore;
-}

package/src/types.ts

@@ -1,9 +0,0 @@
-import { Map as ImmutableMap, List } from 'immutable';
-
-export function isImmutableMap(value: unknown): value is ImmutableMap<string, unknown> {
-  return ImmutableMap.isMap(value);
-}
-
-export function isImmutableList(value: unknown): value is List<unknown> {
-  return List.isList(value);
-}

package/src/unsentRequest.js

@@ -1,133 +0,0 @@
-import { fromJS, List, Map } from 'immutable';
-import curry from 'lodash/curry';
-import flow from 'lodash/flow';
-import isString from 'lodash/isString';
-
-function isAbortControllerSupported() {
-  if (typeof window !== 'undefined') {
-    return !!window.AbortController;
-  }
-  return false;
-}
-
-const timeout = 60;
-
-function fetchWithTimeout(input, init) {
-  if ((init && init.signal) || !isAbortControllerSupported()) {
-    return fetch(input, init);
-  }
-  const controller = new AbortController();
-  const timeoutId = setTimeout(() => controller.abort(), timeout * 1000);
-  return fetch(input, { ...init, signal: controller.signal })
-    .then(res => {
-      clearTimeout(timeoutId);
-      return res;
-    })
-    .catch(e => {
-      if (e.name === 'AbortError' || e.name === 'DOMException') {
-        throw new Error(`Request timed out after ${timeout} seconds`);
-      }
-      throw e;
-    });
-}
-
-function decodeParams(paramsString) {
-  return List(paramsString.split('&'))
-    .map(s => List(s.split('=')).map(decodeURIComponent))
-    .update(Map);
-}
-
-function fromURL(wholeURL) {
-  const [url, allParamsString] = wholeURL.split('?');
-  return Map({ url, ...(allParamsString ? { params: decodeParams(allParamsString) } : {}) });
-}
-
-function fromFetchArguments(wholeURL, options) {
-  return fromURL(wholeURL).merge(
-    (options ? fromJS(options) : Map()).remove('url').remove('params'),
-  );
-}
-
-function encodeParams(params) {
-  return params
-    .entrySeq()
-    .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
-    .join('&');
-}
-
-function toURL(req) {
-  return `${req.get('url')}${req.get('params') ? `?${encodeParams(req.get('params'))}` : ''}`;
-}
-
-function toFetchArguments(req) {
-  return [toURL(req), req.remove('url').remove('params').toJS()];
-}
-
-function maybeRequestArg(req) {
-  if (isString(req)) {
-    return fromURL(req);
-  }
-  if (req) {
-    return fromJS(req);
-  }
-  return Map();
-}
-
-function ensureRequestArg(func) {
-  return req => func(maybeRequestArg(req));
-}
-
-function ensureRequestArg2(func) {
-  return (arg, req) => func(arg, maybeRequestArg(req));
-}
-
-// This actually performs the built request object
-const performRequest = ensureRequestArg(req => {
-  const args = toFetchArguments(req);
-  return fetchWithTimeout(...args);
-});
-
-// Each of the following functions takes options and returns another
-// function that performs the requested action on a request.
-const getCurriedRequestProcessor = flow([ensureRequestArg2, curry]);
-
-function getPropSetFunction(path) {
-  return getCurriedRequestProcessor((val, req) => req.setIn(path, val));
-}
-
-function getPropMergeFunction(path) {
-  return getCurriedRequestProcessor((obj, req) => req.updateIn(path, (p = Map()) => p.merge(obj)));
-}
-
-const withMethod = getPropSetFunction(['method']);
-const withBody = getPropSetFunction(['body']);
-const withNoCache = getPropSetFunction(['cache'])('no-cache');
-const withParams = getPropMergeFunction(['params']);
-const withHeaders = getPropMergeFunction(['headers']);
-
-// withRoot sets a root URL, unless the URL is already absolute
-const absolutePath = new RegExp('^(?:[a-z]+:)?//', 'i');
-const withRoot = getCurriedRequestProcessor((root, req) =>
-  req.update('url', p => {
-    if (absolutePath.test(p)) {
-      return p;
-    }
-    return root && p && p[0] !== '/' && root[root.length - 1] !== '/'
-      ? `${root}/${p}`
-      : `${root}${p}`;
-  }),
-);
-
-export default {
-  toURL,
-  fromURL,
-  fromFetchArguments,
-  performRequest,
-  withMethod,
-  withBody,
-  withHeaders,
-  withParams,
-  withRoot,
-  withNoCache,
-  fetchWithTimeout,
-};

package/webpack.config.js

@@ -1,3 +0,0 @@
-const { getConfig } = require('../../scripts/webpack.js');
-
-module.exports = getConfig();