@adobe/helix-config 2.3.1 → 2.3.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.3.2](https://github.com/adobe/helix-config/compare/v2.3.1...v2.3.2) (2024-04-08)
+
+
+### Bug Fixes
+
+* add support for granular crud ([7f1eb43](https://github.com/adobe/helix-config/commit/7f1eb434afbd809cd8fa11ba314815c0edb7cbb8)), closes [#38](https://github.com/adobe/helix-config/issues/38)
+
 ## [2.3.1](https://github.com/adobe/helix-config/compare/v2.3.0...v2.3.1) (2024-04-06)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-config",
-  "version": "2.3.1",
+  "version": "2.3.2",
   "description": "Helix Config",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/storage/config-store.js

@@ -9,8 +9,28 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import { Response } from '@adobe/fetch';
 import { HelixStorage } from './storage.js';
+import { StatusCodeError } from './status-code-error.js';
+import { jsonGet, jsonPut } from './utils.js';
+
+const FRAGMENTS = {
+  sites: {
+    content: 'object',
+    code: 'object',
+    folders: 'object',
+    headers: 'object',
+    metadata: 'object',
+    sidekick: 'object',
+    cdn: 'object',
+    'cdn/prod': 'object',
+    'cdn/preview': 'object',
+    'cdn/live': 'object',
+    access: 'object',
+    'access/admin': 'object',
+    'access/preview': 'object',
+    'access/live': 'object',
+  },
+};
 
 /**
  * General purpose config store.
@@ -20,7 +40,6 @@ export class ConfigStore {
    * @param {string} org the org id
    * @param {string} type store type (org, sites, profiles, secrets, users)
    * @param {string} name config name
-   * @param {string }ref the ref
    */
   constructor(org, type = 'org', name = 'config') {
     if (!org) {
@@ -37,46 +56,74 @@ export class ConfigStore {
       : `/orgs/${this.org}/${this.type}/${this.name}.json`;
   }
 
-  async create(ctx) {
+  async create(ctx, data, relPath = '') {
+    if (relPath) {
+      throw new StatusCodeError(409, 'create not supported on substructures.');
+    }
     const storage = HelixStorage.fromContext(ctx).configBus();
     if (await storage.head(this.key)) {
-      return new Response('', { status: 409 });
+      throw new StatusCodeError(409, 'config already exists.');
     }
-    await storage.put(this.key, JSON.stringify(ctx.data), 'application/json');
-    await this.purge(ctx, null, ctx.data);
-    return new Response('', { status: 201 });
+    await storage.put(this.key, JSON.stringify(data), 'application/json');
+    await this.purge(ctx, null, data);
   }
 
-  async read(ctx) {
+  async read(ctx, relPath = '') {
     const storage = HelixStorage.fromContext(ctx).configBus();
     const buf = await storage.get(this.key);
     if (!buf) {
-      return new Response('', { status: 404 });
+      return null;
     }
-    return new Response(buf, {
-      headers: {
-        'content-type': 'application/json',
-      },
-    });
+    let obj = JSON.parse(buf);
+    if (relPath) {
+      const fragment = FRAGMENTS[this.type][relPath];
+      if (!fragment) {
+        throw new StatusCodeError(400, 'invalid object path.');
+      }
+      obj = jsonGet(obj, relPath);
+    }
+    return obj;
   }
 
-  async update(ctx) {
+  async update(ctx, data, relPath = '') {
     const storage = HelixStorage.fromContext(ctx).configBus();
     const buf = await storage.get(this.key);
     const old = buf ? JSON.parse(buf) : null;
-    await storage.put(this.key, JSON.stringify(ctx.data), 'application/json');
-    await this.purge(ctx, old, ctx.data);
-    return new Response('', { status: 202 });
+    if (relPath) {
+      if (!old) {
+        throw new StatusCodeError(404, 'config not found.');
+      }
+      const fragment = FRAGMENTS[this.type][relPath];
+      if (!fragment) {
+        throw new StatusCodeError(400, 'invalid object path.');
+      }
+      // eslint-disable-next-line no-param-reassign
+      data = jsonPut(JSON.parse(buf), relPath, data);
+    }
+
+    await storage.put(this.key, JSON.stringify(data), 'application/json');
+    await this.purge(ctx, old, data);
   }
 
-  async remove(ctx) {
+  async remove(ctx, relPath) {
     const storage = HelixStorage.fromContext(ctx).configBus();
     const buf = await storage.get(this.key);
-    if (buf) {
-      await storage.remove(this.key);
-      await this.purge(ctx, JSON.parse(buf), null);
+    if (!buf) {
+      throw new StatusCodeError(404, 'config not found.');
     }
-    return new Response('', { status: 204 });
+    if (relPath) {
+      const fragment = FRAGMENTS[this.type][relPath];
+      if (!fragment) {
+        throw new StatusCodeError(400, 'invalid object path.');
+      }
+      const data = jsonPut(JSON.parse(buf), relPath, null);
+      await storage.put(this.key, JSON.stringify(data), 'application/json');
+      await this.purge(ctx, JSON.parse(buf), data);
+      return;
+    }
+
+    await storage.remove(this.key);
+    await this.purge(ctx, JSON.parse(buf), null);
   }
 
   // eslint-disable-next-line class-methods-use-this,no-unused-vars

package/src/storage/status-code-error.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2024 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 class StatusCodeError extends Error {
+  /**
+   * Creates a new StatusCodeError.
+   * @param {number} statusCode The status code.
+   * @param {string} message The error message.
+   */
+  constructor(statusCode, message) {
+    super(message);
+    this.statusCode = statusCode;
+  }
+}

package/src/storage/utils.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2024 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 function jsonGet(obj, path) {
+  return path.split('/').reduce((o, p) => o[p], obj);
+}
+
+export function jsonPut(obj, path, value) {
+  const parts = path.split('/');
+  const last = parts.pop();
+  const parent = parts.reduce((o, p) => {
+    if (!(p in o)) {
+      // eslint-disable-next-line no-param-reassign
+      o[p] = {};
+    }
+    return o[p];
+  }, obj);
+  if (value === null) {
+    delete parent[last];
+  } else {
+    parent[last] = value;
+  }
+  return obj;
+}