@adobe/spacecat-shared-data-access 1.38.2 → 1.39.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.39.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.38.2...@adobe/spacecat-shared-data-access-v1.39.0) (2024-07-31)
+
+
+### Features
+
+* Add API Key data attributes ([#306](https://github.com/adobe/spacecat-shared/issues/306)) ([37ddf55](https://github.com/adobe/spacecat-shared/commit/37ddf55f73acb9e6848dbe6a9292496a15d77ff0))
+
 # [@adobe/spacecat-shared-data-access-v1.38.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.38.1...@adobe/spacecat-shared-data-access-v1.38.2) (2024-07-27)
 
 

package/package.json

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

package/src/dto/api-key.js

@@ -0,0 +1,53 @@
+/*
+ * 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.
+ */
+
+import { createApiKey } from '../models/api-key.js';
+
+export const ApiKeyDto = {
+
+  /**
+     * Converts an ApiKey object into a DynamoDB item.
+     * @param apiKey
+     * @returns {{createdAt: *, name: *, imsUserId, scopes, revokedAt, key: *,
+     *          imsOrgId: *, expiresAt: *}}
+     */
+  toDynamoItem: (apiKey) => ({
+    hashedKey: apiKey.getHashedKey(),
+    name: apiKey.getName(),
+    imsUserId: apiKey.getImsUserId(),
+    imsOrgId: apiKey.getImsOrgId(),
+    createdAt: apiKey.getCreatedAt(),
+    expiresAt: apiKey.getExpiresAt(),
+    revokedAt: apiKey.getRevokedAt(),
+    scopes: apiKey.getScopes(),
+  }),
+
+  /**
+     * Converts a DynamoDB item into an ApiKey object.
+     * @param dynamoItem
+     * @returns {ApiKey}
+     */
+  fromDynamoItem: (dynamoItem) => {
+    const apiKeyData = {
+      hashedKey: dynamoItem.hashedKey,
+      name: dynamoItem.name,
+      imsUserId: dynamoItem.imsUserId,
+      imsOrgId: dynamoItem.imsOrgId,
+      createdAt: dynamoItem.createdAt,
+      expiresAt: dynamoItem.expiresAt,
+      revokedAt: dynamoItem.revokedAt,
+      scopes: dynamoItem.scopes,
+    };
+
+    return createApiKey(apiKeyData);
+  },
+};

package/src/index.d.ts

@@ -534,6 +534,57 @@ export interface ImportUrl {
 
 }
 
+/**
+ * Represents an API Key entity.
+ */
+export interface ApiKey {
+    /**
+     * Retrieves the ID of the API Key.
+     */
+    getId: () => string;
+
+    /**
+     * Retrieves the hashed key value of the API Key.
+     */
+    getHashedKey: () => string;
+
+    /**
+     * Retrieves the name of the API Key.
+     */
+    getName: () => string;
+
+    /**
+    * Retrieves the imsUserId of the API Key.
+    */
+    getImsUserId: () => string;
+
+    /**
+    * Retrieves the imsOrgId of the API key
+    */
+    getImsOrgId: () => string;
+
+    /**
+     * Retrieves the createdAt of the API Key.
+     */
+    getCreatedAt: () => string;
+
+    /**
+     * Retrieves the expiresAt of the API Key.
+     */
+    getExpiresAt: () => string;
+
+    /**
+     * Retrieves the revokedAt of the API Key.
+     */
+    getRevokedAt: () => string;
+
+    /**
+     * Retrieves the scopes of the API Key.
+     */
+    getScopes: () => string;
+
+}
+
 /**
  * Represents an experiment entity.
  */
@@ -722,6 +773,12 @@ export interface DataAccess {
       jobId: string,
       status: string,
     ) => Promise<ImportUrl[]>;
+  getApiKeyByHashedKey: (
+      hashedKey: string,
+    ) => Promise<ApiKey | null>;
+  createNewApiKey: (
+      apiKeyData: object,
+  ) => Promise<ApiKey>;
 
   // site candidate functions
   getSiteCandidateByBaseURL: (baseURL: string) => Promise<SiteCandidate>;
@@ -764,6 +821,7 @@ interface DataAccessConfig {
   tableNameImportJobs: string;
   tableNameImportUrls: string;
   tableNameExperiments: string;
+  tableNameApiKeys: string;
   indexNameAllKeyEventsBySiteId: string,
   indexNameAllSites: string;
   indexNameAllSitesOrganizations: string,
@@ -774,6 +832,7 @@ interface DataAccessConfig {
   indexNameAllImportJobsByStatus: string,
   indexNameAllImportJobsByDateRange: string,
   indexNameAllImportUrlsByJobIdAndStatus: string,
+  indexNameApiKeyByHashedKey: string,
   pkAllSites: string;
   pkAllLatestAudits: string;
   pkAllOrganizations: string;

package/src/index.js

@@ -25,6 +25,7 @@ const TABLE_NAME_SITE_TOP_PAGES = 'spacecat-services-site-top-pages-dev';
 const TABLE_NAME_IMPORT_JOBS = 'spacecat-services-import-jobs-dev';
 const TABLE_NAME_IMPORT_URLS = 'spacecat-services-import-urls-dev';
 const TABLE_NAME_EXPERIMENTS = 'spacecat-services-experiments-dev';
+const TABLE_NAME_API_KEYS = 'spacecat-services-api-keys-dev';
 
 const INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID = 'spacecat-services-key-events-by-site-id';
 const INDEX_NAME_ALL_SITES = 'spacecat-services-all-sites-dev';
@@ -36,6 +37,7 @@ const INDEX_NAME_ALL_SITES_ORGANIZATIONS = 'spacecat-services-all-sites-organiza
 const INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS = 'spacecat-services-all-import-jobs-by-status-dev';
 const INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE = 'spacecat-services-all-import-jobs-by-date-range-dev';
 const INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS = 'spacecat-services-all-import-urls-by-job-id-and-status-dev';
+const INDEX_NAME_API_KEY_BY_HASHED_KEY = 'spacecat-services-api-key-by-hashed-key-dev';
 
 const PK_ALL_SITES = 'ALL_SITES';
 const PK_ALL_CONFIGURATIONS = 'ALL_CONFIGURATIONS';
@@ -60,6 +62,7 @@ export default function dataAccessWrapper(fn) {
         DYNAMO_TABLE_NAME_IMPORT_JOBS = TABLE_NAME_IMPORT_JOBS,
         DYNAMO_TABLE_NAME_IMPORT_URLS = TABLE_NAME_IMPORT_URLS,
         DYNAMO_TABLE_NAME_EXPERIMENTS = TABLE_NAME_EXPERIMENTS,
+        DYNAMO_TABLE_NAME_API_KEYS = TABLE_NAME_API_KEYS,
         DYNAMO_INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID = INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID,
         DYNAMO_INDEX_NAME_ALL_SITES = INDEX_NAME_ALL_SITES,
         DYNAMO_INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE = INDEX_NAME_ALL_SITES_BY_DELIVERY_TYPE,
@@ -72,6 +75,7 @@ export default function dataAccessWrapper(fn) {
         DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE = INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE,
         DYNAMO_INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS =
         INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS,
+        DYNAMO_INDEX_NAME_API_KEY_BY_HASHED_KEY = INDEX_NAME_API_KEY_BY_HASHED_KEY,
       } = context.env;
 
       context.dataAccess = createDataAccess({
@@ -86,6 +90,7 @@ export default function dataAccessWrapper(fn) {
         tableNameImportJobs: DYNAMO_TABLE_NAME_IMPORT_JOBS,
         tableNameImportUrls: DYNAMO_TABLE_NAME_IMPORT_URLS,
         tableNameExperiments: DYNAMO_TABLE_NAME_EXPERIMENTS,
+        tableNameApiKeys: DYNAMO_TABLE_NAME_API_KEYS,
         indexNameAllKeyEventsBySiteId: DYNAMO_INDEX_NAME_ALL_KEY_EVENTS_BY_SITE_ID,
         indexNameAllSites: DYNAMO_INDEX_NAME_ALL_SITES,
         indexNameAllOrganizations: DYNAMO_INDEX_NAME_ALL_ORGANIZATIONS,
@@ -96,6 +101,7 @@ export default function dataAccessWrapper(fn) {
         indexNameAllImportJobsByStatus: DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS,
         indexNameAllImportJobsByDateRange: DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE,
         indexNameImportUrlsByJobIdAndStatus: DYNAMO_INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS,
+        indexNameApiKeyByHashedKey: DYNAMO_INDEX_NAME_API_KEY_BY_HASHED_KEY,
         pkAllSites: PK_ALL_SITES,
         pkAllOrganizations: PK_ALL_ORGANIZATIONS,
         pkAllLatestAudits: PK_ALL_LATEST_AUDITS,

package/src/models/api-key.js

@@ -0,0 +1,96 @@
+/*
+ * 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.
+ */
+
+import {
+  hasText, isIsoDate, isObject, isValidUrl,
+} from '@adobe/spacecat-shared-utils';
+import { Base } from './base.js';
+
+const scopeNames = ['sites.read_all', 'sites.write_all', 'organizations.read_all', 'organizations.write_all',
+  'audits.read_all', 'audits.write_all', 'imports.read', 'imports.write', 'imports.read_all'];
+
+const ApiKey = (data) => {
+  const self = Base(data);
+
+  self.getHashedKey = () => self.state.hashedKey;
+  self.getName = () => self.state.name;
+  self.getImsUserId = () => self.state.imsUserId;
+  self.getImsOrgId = () => self.state.imsOrgId;
+  self.getCreatedAt = () => self.state.createdAt;
+  self.getExpiresAt = () => self.state.expiresAt;
+  self.getRevokedAt = () => self.state.revokedAt;
+  self.getScopes = () => self.state.scopes;
+
+  return Object.freeze(self);
+};
+
+/**
+ * Creates a new ApiKey object.
+ * @param {Object} apiKeyData - The data for the ApiKey object.
+ * @returns {ApiKey} The new ApiKey object.
+ */
+export const createApiKey = (data) => {
+  const newState = { ...data };
+
+  if (!hasText(newState.hashedKey)) {
+    throw new Error(`Invalid Hashed Key: ${newState.hashedKey}`);
+  }
+
+  if (!hasText(newState.name)) {
+    throw new Error(`Invalid Name: ${newState.name}`);
+  }
+
+  if (hasText(newState.createdAt) && !isIsoDate(newState.createdAt)) {
+    throw new Error(`createdAt should be a valid ISO 8601 string: ${newState.createdAt}`);
+  }
+
+  if (!hasText(newState.createdAt)) {
+    newState.createdAt = new Date().toISOString();
+  }
+
+  if (hasText(newState.expiresAt) && !isIsoDate(newState.expiresAt)) {
+    throw new Error(`expiresAt should be a valid ISO 8601 string: ${newState.expiresAt}`);
+  }
+
+  if (hasText(newState.revokedAt) && !isIsoDate(newState.revokedAt)) {
+    throw new Error(`revokedAt should be a valid ISO 8601 string: ${newState.revokedAt}`);
+  }
+
+  if (!Array.isArray(newState.scopes)) {
+    throw new Error(`Invalid scopes: ${newState.scopes}`);
+  }
+
+  for (const scope of newState.scopes) {
+    if (!isObject(scope)) {
+      throw new Error(`Invalid scope: ${scope}`);
+    }
+
+    if (!hasText(scope.name)) {
+      throw new Error(`Invalid scope name: ${scope.name}`);
+    }
+
+    if (!scopeNames.includes(scope.name)) {
+      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}`);
+      }
+    }
+  }
+
+  return ApiKey(newState);
+};

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

@@ -0,0 +1,51 @@
+/*
+ * 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.
+ */
+
+import { ApiKeyDto } from '../../dto/api-key.js';
+
+/**
+ * Get ApiKey by Hashed Key
+ * @param {string} hashedKey
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @returns {Promise<ApiKeyDto>}
+ */
+export const getApiKeyByHashedKey = async (hashedKey, dynamoClient, log, config) => {
+  const item = await dynamoClient.query({
+    TableName: config.tableNameApiKeys,
+    IndexName: config.indexNameApiKeyByHashedKey,
+    KeyConditionExpression: '#hashedKey = :hashedKey',
+    ExpressionAttributeNames: {
+      '#hashedKey': 'hashedKey',
+    },
+    ExpressionAttributeValues: {
+      ':gsi1pk': config.pkApiKey,
+      ':hashedKey': hashedKey,
+    },
+  });
+  ApiKeyDto.fromDynamoItem(item);
+};
+
+/**
+ * Create new ApiKey
+ * @param {ApiKey} apiKey
+ * @param {DynamoClient} dynamoClient
+ * @param {Object} config
+ * @param {Logger} log
+ * @returns {Promise<ApiKeyDto>}
+ */
+export const createNewApiKey = async (apiKey, dynamoClient, config, log) => {
+  const item = ApiKeyDto.toDynamoItem(apiKey);
+  await dynamoClient.putItem(config.tableNameApiKeys, item, log);
+  return item;
+};

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

@@ -0,0 +1,18 @@
+/*
+ * 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.
+ */
+
+import { createNewApiKey, getApiKeyByHashedKey } from './accessPatterns.js';
+
+export const apiKeyFunctions = (dynamoClient, config, log) => ({
+  getApiKeyByHashedKey: (hashedKey) => getApiKeyByHashedKey(hashedKey, dynamoClient, log, config),
+  createNewApiKey: (apiKey) => createNewApiKey(apiKey, dynamoClient, config, log),
+});

package/src/service/index.js

@@ -21,6 +21,7 @@ import { siteTopPagesFunctions } from './site-top-pages/index.js';
 import { importJobFunctions } from './import-job/index.js';
 import { importUrlFunctions } from './import-url/index.js';
 import { experimentFunctions } from './experiments/index.js';
+import { apiKeyFunctions } from './api-key/index.js';
 
 /**
  * Creates a data access object.
@@ -48,6 +49,7 @@ export const createDataAccess = (config, log = console) => {
   const importJobFuncs = importJobFunctions(dynamoClient, config, log);
   const importUrlFuncs = importUrlFunctions(dynamoClient, config, log);
   const experimentFuncs = experimentFunctions(dynamoClient, config, log);
+  const apiKeyFuncs = apiKeyFunctions(dynamoClient, config, log);
 
   return {
     ...auditFuncs,
@@ -60,5 +62,6 @@ export const createDataAccess = (config, log = console) => {
     ...importJobFuncs,
     ...importUrlFuncs,
     ...experimentFuncs,
+    ...apiKeyFuncs,
   };
 };