@adobe/helix-config-storage 1.7.14 → 1.8.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.8.0](https://github.com/adobe/helix-config-storage/compare/v1.7.14...v1.8.0) (2024-10-10)
+
+
+### Features
+
+* store created and lastModified in configs ([#45](https://github.com/adobe/helix-config-storage/issues/45)) ([f3d7b83](https://github.com/adobe/helix-config-storage/commit/f3d7b83f17cf80defe28b640c60a9cb50abfb392))
+
 ## [1.7.14](https://github.com/adobe/helix-config-storage/compare/v1.7.13...v1.7.14) (2024-10-09)
 
 

package/package.json

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

package/src/config-merge.js

@@ -21,6 +21,8 @@ const ROOT_PROPERTIES = {
   name: { atomic: true },
   title: { atomic: true },
   description: { atomic: true },
+  created: { atomic: true },
+  lastModified: { atomic: true },
   content: { atomic: true },
   code: { atomic: true },
   folders: {},

package/src/config-store.js

@@ -232,6 +232,19 @@ export class ConfigStore {
     this.key = type === 'org'
       ? `/orgs/${org}/${name || 'config'}.json`
       : `/orgs/${org}/${type}/${name}.json`;
+    this.now = new Date();
+  }
+
+  /**
+   * updates the created and lastModified time stamp on the data object to the current time.
+   * the created property is only set if it doesn't exist yet.
+   * @param {object} data
+   */
+  #updateTimeStamps(data) {
+    data.lastModified = this.now.toISOString();
+    if (!data.created) {
+      data.created = data.lastModified;
+    }
   }
 
   async #list(ctx) {
@@ -308,6 +321,9 @@ export class ConfigStore {
       updateContentSource(ctx, data.content);
       updateCodeSource(ctx, data.code);
     }
+    // we don't allow to define created
+    delete data.created;
+    this.#updateTimeStamps(data);
     const config = await this.getAggregatedConfig(ctx, data);
     await this.validate(ctx, config);
     await storage.put(this.key, JSON.stringify(data), 'application/json');
@@ -424,6 +440,8 @@ export class ConfigStore {
       updateCodeSource(ctx, config.code);
     }
     let oldConfig = buf ? JSON.parse(buf) : null;
+    config.created = oldConfig?.created;
+    this.#updateTimeStamps(config);
     let newConfig = config;
     if (this.type === 'sites') {
       // apply profile
@@ -452,6 +470,7 @@ export class ConfigStore {
 
     if (frag) {
       const data = deepPut(JSON.parse(buf), relPath, null);
+      this.#updateTimeStamps(data);
       const newConfig = await this.getAggregatedConfig(ctx, data);
       await this.validate(ctx, newConfig);
       await storage.put(this.key, JSON.stringify(data), 'application/json');

package/src/schemas/common.schema.json

@@ -11,6 +11,16 @@
       "type": "string",
       "description": "description for clarity. has no influence on the configuration."
     },
+    "created": {
+      "type": "string",
+      "format": "date-time",
+      "description": "the date and time this configuration was created."
+    },
+    "lastModified": {
+      "type": "string",
+      "format": "date-time",
+      "description": "the date and time this configuration was modified last."
+    },
     "keyValuePair": {
       "type": "object",
       "properties": {

package/src/schemas/org.schema.json

@@ -10,6 +10,8 @@
       "enum": [1],
       "default": 1
     },
+    "created": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/created" },
+    "lastModified": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/lastModified" },
     "title": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/title" },
     "description": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/description" },
     "users": {
@@ -26,7 +28,9 @@
     }
   },
   "required": [
-    "version"
+    "version",
+    "created",
+    "lastModified"
   ],
   "additionalProperties": false
 }

package/src/schemas/profile.schema.json

@@ -12,7 +12,8 @@
     },
     "title": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/title" },
     "description": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/description" },
-
+    "created": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/created" },
+    "lastModified": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/lastModified" },
     "content": {
       "$ref": "https://ns.adobe.com/helix/config/content"
     },
@@ -51,7 +52,9 @@
     }
   },
   "required": [
-    "version"
+    "version",
+    "created",
+    "lastModified"
   ],
   "additionalProperties": false
 }

package/src/schemas/site.schema.json

@@ -17,6 +17,8 @@
     },
     "title": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/title" },
     "description": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/description" },
+    "created": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/created" },
+    "lastModified": { "$ref": "https://ns.adobe.com/helix/config/common#/definitions/lastModified" },
 
     "content": {
       "$ref": "https://ns.adobe.com/helix/config/content"
@@ -68,7 +70,9 @@
   "required": [
     "version",
     "content",
-    "code"
+    "code",
+    "created",
+    "lastModified"
   ],
   "additionalProperties": false
 }