@adobe/spacecat-shared-data-access 1.39.1 → 1.41.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.41.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.40.0...@adobe/spacecat-shared-data-access-v1.41.0) (2024-08-09)
+
+
+### Features
+
+* Introduce scoped API keys ([#312](https://github.com/adobe/spacecat-shared/issues/312)) ([449d273](https://github.com/adobe/spacecat-shared/commit/449d2736154d7e92fb4a3d1f9f290e15e665aa5e))
+
+# [@adobe/spacecat-shared-data-access-v1.40.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.39.1...@adobe/spacecat-shared-data-access-v1.40.0) (2024-08-08)
+
+
+### Features
+
+* update import job models to include hashed key ([#318](https://github.com/adobe/spacecat-shared/issues/318)) ([cd90252](https://github.com/adobe/spacecat-shared/commit/cd902522629d13e2707b7a78a38bdffc5d6194c0))
+
 # [@adobe/spacecat-shared-data-access-v1.39.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.39.0...@adobe/spacecat-shared-data-access-v1.39.1) (2024-08-06)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.39.1",
+  "version": "1.41.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",

package/src/dto/import-job.js

@@ -28,7 +28,7 @@ export const ImportJobDto = {
   toDynamoItem: (importJob) => ({
     id: importJob.getId(),
     baseURL: importJob.getBaseURL(),
-    apiKey: importJob.getApiKey(),
+    hashedApiKey: importJob.getHashedApiKey(),
     options: importJob.getOptions(),
     startTime: importJob.getStartTime(),
     endTime: importJob.getEndTime(),
@@ -48,7 +48,7 @@ export const ImportJobDto = {
     const importJobData = {
       id: dynamoItem.id,
       baseURL: dynamoItem.baseURL,
-      apiKey: dynamoItem.apiKey,
+      hashedApiKey: dynamoItem.hashedApiKey,
       options: dynamoItem.options,
       startTime: dynamoItem.startTime,
       endTime: dynamoItem.endTime,

package/src/index.d.ts

@@ -455,9 +455,9 @@ export interface ImportJob {
   getId: () => string;
 
   /**
-   * Retrieves the apiKey of the import job.
+   * Retrieves the hashed apiKey of the import job.
    */
-  getApiKey: () => string;
+  getHashedApiKey: () => string;
 
   /**
    * Retrieves the status of the import job.

package/src/models/api-key.js

@@ -82,12 +82,14 @@ export const createApiKey = (data) => {
       throw new Error(`Scope name is not part of the pre-defined scopes: ${scope.name}`);
     }
 
-    if (hasText(scope.domains) && !Array.isArray(scope.domains)) {
-      throw new Error(`Scope domains should be an array: ${scope.domains}`);
-    }
-    for (const domain of scope.domains) {
-      if (!isValidUrl(domain)) {
-        throw new Error(`Invalid domain: ${domain}`);
+    if (scope.domains) {
+      if (!Array.isArray(scope.domains)) {
+        throw new Error(`Scope domains should be an array: ${scope.domains}`);
+      }
+      for (const domain of scope.domains) {
+        if (!isValidUrl(domain)) {
+          throw new Error(`Invalid domain: ${domain}`);
+        }
       }
     }
   }

package/src/models/importer/import-job.js

@@ -31,7 +31,7 @@ const ImportJob = (data) => {
   const self = Base(data);
 
   self.getBaseURL = () => self.state.baseURL;
-  self.getApiKey = () => self.state.apiKey;
+  self.getHashedApiKey = () => self.state.hashedApiKey;
   self.getOptions = () => self.state.options;
   self.getStartTime = () => self.state.startTime;
   self.getEndTime = () => self.state.endTime;
@@ -168,8 +168,8 @@ export const createImportJob = (data) => {
     throw new Error(`Invalid base URL: ${newState.baseURL}`);
   }
 
-  if (!isString(newState.apiKey)) {
-    throw new Error(`Invalid API key: ${newState.apiKey}`);
+  if (!isString(newState.hashedApiKey)) {
+    throw new Error(`Invalid API key: ${newState.hashedApiKey}`);
   }
 
   if (hasText(newState.startTime) && !isIsoDate(newState.startTime)) {

package/src/service/api-key/accessPatterns.js

@@ -33,7 +33,7 @@ export const getApiKeyByHashedKey = async (hashedKey, dynamoClient, log, config)
       ':hashedKey': hashedKey,
     },
   });
-  ApiKeyDto.fromDynamoItem(item);
+  return item ? ApiKeyDto.fromDynamoItem(item) : null;
 };
 
 /**