@adobe/helix-shared-config 10.0.1 → 10.0.3

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/helix-shared-config-v10.0.3](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config-v10.0.2...@adobe/helix-shared-config-v10.0.3) (2023-04-11)
+
+
+### Bug Fixes
+
+* **deps:** update dependency lru-cache to v9 ([#783](https://github.com/adobe/helix-shared/issues/783)) ([1b454af](https://github.com/adobe/helix-shared/commit/1b454afdcf6a21cf70fcb888fea22a41628abb94))
+
+# [@adobe/helix-shared-config-v10.0.2](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config-v10.0.1...@adobe/helix-shared-config-v10.0.2) (2023-03-21)
+
+
+### Bug Fixes
+
+* **deps:** update dependency lru-cache to v8 ([#774](https://github.com/adobe/helix-shared/issues/774)) ([07aa5ba](https://github.com/adobe/helix-shared/commit/07aa5ba969f6043bdf5d07e760d99dcb22f511d7))
+
 # [@adobe/helix-shared-config-v10.0.1](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config-v10.0.0...@adobe/helix-shared-config-v10.0.1) (2023-02-22)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-shared-config",
-  "version": "10.0.1",
+  "version": "10.0.3",
   "description": "Shared modules of the Helix Project - config",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -36,9 +36,9 @@
     "ajv": "8.12.0",
     "ajv-formats": "2.1.1",
     "cookie": "0.5.0",
-    "fs-extra": "11.1.0",
+    "fs-extra": "11.1.1",
     "ignore": "5.2.4",
-    "lru-cache": "7.14.1",
+    "lru-cache": "9.0.1",
     "object-hash": "3.0.0",
     "uri-js": "4.4.1",
     "yaml": "2.2.1"

package/src/MountConfig.d.ts

@@ -0,0 +1,110 @@
+/*
+ * Copyright 2023 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+export interface MountConfig {
+  /**
+   * Defines a mapping between mount points and source URLs.
+   * Mount points **must** start with a slash (`/`) but may not end with one.
+   */
+  mountpoints: {
+    [k: string]: string|MountPoint;
+  };
+
+  /**
+   * Mapping from subtrees to single sources for catch-all folder support.
+   */
+  folders?: {
+    /**
+     * This interface was referenced by `undefined`'s JSON-Schema definition
+     * via the `patternProperty` "^/.*[^/]$".
+     */
+    [k: string]: string;
+  };
+
+  /**
+   * Matches the given resource path against the mount points and returns the mount point if found.
+   * The mount point will also include a `relPath` property, which denotes the relative path
+   * from the mount points root.
+   *
+   * @param {string} resourcePath The resource path
+   * @returns {MountPoint|null} The matched mount point or {@code null}.
+   */
+  match(resourcePath): MatchResult|null;
+}
+
+export interface MatchResult extends MountPoint {
+  relPath:string;
+}
+
+export interface MountPoint extends OnedriveMountPoint, GoogleMountPoint, MarkupMountPoint {}
+
+/**
+ * Defines the target URL where content should be retrieved from.
+ */
+export interface BaseMountPoint {
+  path: string;
+
+  url: string;
+
+  /**
+   * mountpoint type
+   */
+  type?: 'onedrive' | 'google' | 'markup';
+
+  /**
+   * encrypted credentials.
+   */
+  credentials?: string[];
+
+  /**
+   * computed content-bus id.
+   */
+  contentBusId?: string;
+}
+
+/**
+ * Mountpoint to a sharepoint/onedrive root.
+ */
+export interface OnedriveMountPoint extends BaseMountPoint {
+  /**
+   * suffix for markup type
+   */
+  suffix?: string;
+  /**
+   * Onedrive tenant id. If missing, it is computed from url.
+   */
+  tenantId?: string;
+  /**
+   * drive item id for google type
+   */
+  id?: string;
+}
+
+/**
+ * Mountpoint to a googledrive root.
+ */
+export interface GoogleMountPoint extends BaseMountPoint {
+  /**
+   * drive item id
+   */
+  id?: string;
+}
+
+/**
+ * Mountpoint to a markup source root.
+ */
+export interface MarkupMountPoint extends BaseMountPoint {
+  /**
+   * suffix
+   * @example '.raw.html'
+   */
+  suffix?: string;
+}

package/src/fetchconfig/cache.js

@@ -10,9 +10,9 @@
  * governing permissions and limitations under the License.
  */
 
-import LRU from 'lru-cache';
+import { LRUCache } from 'lru-cache';
 
-let lru = new LRU({ max: 1000, ttl: 60 * 1000 });
+let lru = new LRUCache({ max: 1000, ttl: 60 * 1000 });
 
 /**
  * Returns a memoized version of the function `fn`.
@@ -74,7 +74,7 @@ export function cache(fn, opts = {}) {
  * @param {number} opts.max maximum size of the cache
  */
 export const options = (opts) => {
-  lru = new LRU(opts);
+  lru = new LRUCache(opts);
 
   return cache;
 };

package/src/index.d.ts

@@ -11,3 +11,4 @@
  */
 export * from './config-wrapper';
 export * from './ModifiersConfig';
+export * from './MountConfig';