@adobe/spacecat-shared-tokowaka-client 1.5.8 → 1.6.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-tokowaka-client-v1.6.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.8...@adobe/spacecat-shared-tokowaka-client-v1.6.0) (2026-01-29)
+
+
+### Features
+
+* new flag opted added in edgeoptimizeconfig ([#1294](https://github.com/adobe/spacecat-shared/issues/1294)) ([8386e38](https://github.com/adobe/spacecat-shared/commit/8386e3805e9e67c18e4569428bef7ac5723eb991))
+
 # [@adobe/spacecat-shared-tokowaka-client-v1.5.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-tokowaka-client-v1.5.7...@adobe/spacecat-shared-tokowaka-client-v1.5.8) (2026-01-27)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-tokowaka-client",
-  "version": "1.5.8",
+  "version": "1.6.0",
   "description": "Tokowaka Client for SpaceCat - Edge optimization config management",
   "type": "module",
   "engines": {

package/src/index.js

@@ -290,7 +290,7 @@ class TokowakaClient {
    * @param {boolean} options.enhancements - Whether to enable enhancements (default: true)
    * @returns {Promise<Object>} - Object with s3Path and metaconfig
    */
-  async createMetaconfig(url, siteId, options = {}) {
+  async createMetaconfig(url, siteId, options = {}, metadata = {}) {
     if (!hasText(url)) {
       throw this.#createError('URL is required', HTTP_BAD_REQUEST);
     }
@@ -316,8 +316,7 @@ class TokowakaClient {
       patches: {},
     };
 
-    const s3Path = await this.uploadMetaconfig(url, metaconfig);
-
+    const s3Path = await this.uploadMetaconfig(url, metaconfig, metadata);
     this.log.info(`Created new Tokowaka metaconfig for ${normalizedHostName} at ${s3Path}`);
 
     return metaconfig;
@@ -331,7 +330,7 @@ class TokowakaClient {
    * @param {Object} options - Optional configuration
    * @returns {Promise<Object>} - Object with s3Path and metaconfig
    */
-  async updateMetaconfig(url, siteId, options = {}) {
+  async updateMetaconfig(url, siteId, options = {}, metadata = {}) {
     if (!hasText(url)) {
       throw this.#createError('URL is required', HTTP_BAD_REQUEST);
     }
@@ -371,8 +370,7 @@ class TokowakaClient {
       ...(hasPrerender && { prerender }),
     };
 
-    const s3Path = await this.uploadMetaconfig(url, metaconfig);
-
+    const s3Path = await this.uploadMetaconfig(url, metaconfig, metadata);
     this.log.info(`Updated Tokowaka metaconfig for ${normalizedHostName} at ${s3Path}`);
 
     return metaconfig;
@@ -382,9 +380,10 @@ class TokowakaClient {
    * Uploads domain-level metaconfig to S3
    * @param {string} url - Full URL (used to extract domain)
    * @param {Object} metaconfig - Metaconfig object (siteId, apiKeys, prerender)
+   * @param {Object} metadata - Optional S3 user-defined metadata (key-value pairs)
    * @returns {Promise<string>} - S3 key of uploaded metaconfig
-   */
-  async uploadMetaconfig(url, metaconfig) {
+  */
+  async uploadMetaconfig(url, metaconfig, metadata = {}) {
     if (!hasText(url)) {
       throw this.#createError('URL is required', HTTP_BAD_REQUEST);
     }
@@ -397,12 +396,19 @@ class TokowakaClient {
     const bucketName = this.deployBucketName;
 
     try {
-      const command = new PutObjectCommand({
+      const putObjectParams = {
         Bucket: bucketName,
         Key: s3Path,
         Body: JSON.stringify(metaconfig, null, 2),
         ContentType: 'application/json',
-      });
+      };
+
+      // Add user-defined metadata if provided
+      if (isNonEmptyObject(metadata)) {
+        putObjectParams.Metadata = metadata;
+      }
+
+      const command = new PutObjectCommand(putObjectParams);
 
       await this.s3Client.send(command);
       this.log.info(`Successfully uploaded metaconfig to s3://${bucketName}/${s3Path}`);

package/test/index.test.js

@@ -454,6 +454,43 @@ describe('TokowakaClient', () => {
         expect(error.status).to.equal(500);
       }
     });
+
+    it('should upload metaconfig with user-defined metadata when provided', async () => {
+      const metaconfig = {
+        siteId: 'site-123',
+        prerender: true,
+      };
+      const metadata = {
+        'last-modified-by': 'john@example.com',
+        'created-by': 'admin',
+      };
+
+      const s3Path = await client.uploadMetaconfig('https://example.com/page1', metaconfig, metadata);
+
+      expect(s3Path).to.equal('opportunities/example.com/config');
+
+      const command = s3Client.send.firstCall.args[0];
+      expect(command.input.Bucket).to.equal('test-bucket');
+      expect(command.input.Key).to.equal('opportunities/example.com/config');
+      expect(command.input.ContentType).to.equal('application/json');
+      expect(JSON.parse(command.input.Body)).to.deep.equal(metaconfig);
+      expect(command.input.Metadata).to.deep.equal(metadata);
+    });
+
+    it('should upload metaconfig without Metadata field when metadata is empty object', async () => {
+      const metaconfig = {
+        siteId: 'site-123',
+        prerender: true,
+      };
+
+      const s3Path = await client.uploadMetaconfig('https://example.com/page1', metaconfig, {});
+
+      expect(s3Path).to.equal('opportunities/example.com/config');
+
+      const command = s3Client.send.firstCall.args[0];
+      expect(command.input.Bucket).to.equal('test-bucket');
+      expect(command.input.Metadata).to.be.undefined;
+    });
   });
 
   describe('createMetaconfig', () => {
@@ -567,6 +604,50 @@ describe('TokowakaClient', () => {
       const command = s3Client.send.firstCall.args[0];
       expect(command.input.Key).to.equal('opportunities/example.com/config');
     });
+
+    it('should include user-defined metadata when metadata is provided', async () => {
+      const siteId = 'site-123';
+      const url = 'https://www.example.com/page1';
+      const noSuchKeyError = new Error('NoSuchKey');
+      noSuchKeyError.name = 'NoSuchKey';
+      s3Client.send.onFirstCall().rejects(noSuchKeyError);
+
+      await client.createMetaconfig(url, siteId, {}, { 'last-modified-by': 'john@example.com' });
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.deep.equal({
+        'last-modified-by': 'john@example.com',
+      });
+    });
+
+    it('should not include metadata when metadata is empty object', async () => {
+      const siteId = 'site-123';
+      const url = 'https://www.example.com/page1';
+      const noSuchKeyError = new Error('NoSuchKey');
+      noSuchKeyError.name = 'NoSuchKey';
+      s3Client.send.onFirstCall().rejects(noSuchKeyError);
+
+      await client.createMetaconfig(url, siteId, {}, {});
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.be.undefined;
+    });
+
+    it('should not include metadata when metadata is not provided', async () => {
+      const siteId = 'site-123';
+      const url = 'https://www.example.com/page1';
+      const noSuchKeyError = new Error('NoSuchKey');
+      noSuchKeyError.name = 'NoSuchKey';
+      s3Client.send.onFirstCall().rejects(noSuchKeyError);
+
+      await client.createMetaconfig(url, siteId);
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.be.undefined;
+    });
   });
 
   describe('updateMetaconfig', () => {
@@ -1308,6 +1389,47 @@ describe('TokowakaClient', () => {
       expect(result).to.have.property('prerender');
       expect(result.prerender).to.deep.equal(prerenderConfig);
     });
+
+    it('should include user-defined metadata when metadata is provided', async () => {
+      const siteId = 'site-456';
+      const url = 'https://www.example.com';
+
+      await client.updateMetaconfig(url, siteId, {
+        tokowakaEnabled: true,
+      }, { 'last-modified-by': 'jane@example.com' });
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.deep.equal({
+        'last-modified-by': 'jane@example.com',
+      });
+    });
+
+    it('should not include metadata when metadata is empty object', async () => {
+      const siteId = 'site-456';
+      const url = 'https://www.example.com';
+
+      await client.updateMetaconfig(url, siteId, {
+        tokowakaEnabled: true,
+      }, {});
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.be.undefined;
+    });
+
+    it('should not include metadata when metadata is not provided', async () => {
+      const siteId = 'site-456';
+      const url = 'https://www.example.com';
+
+      await client.updateMetaconfig(url, siteId, {
+        tokowakaEnabled: true,
+      });
+
+      // Second call is the uploadMetaconfig
+      const uploadCommand = s3Client.send.secondCall.args[0];
+      expect(uploadCommand.input.Metadata).to.be.undefined;
+    });
   });
 
   describe('uploadConfig', () => {