@adobe/spacecat-shared-data-access 1.59.2 → 1.60.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.60.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.60.0...@adobe/spacecat-shared-data-access-v1.60.1) (2024-12-18)
+
+
+### Bug Fixes
+
+* removeElectroProperties ([#498](https://github.com/adobe/spacecat-shared/issues/498)) ([a21b188](https://github.com/adobe/spacecat-shared/commit/a21b1887d6872092679f9c5d02452e79711955e7))
+
+# [@adobe/spacecat-shared-data-access-v1.60.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.59.2...@adobe/spacecat-shared-data-access-v1.60.0) (2024-12-18)
+
+
+### Features
+
+* migrate entities to electrodb ([#484](https://github.com/adobe/spacecat-shared/issues/484)) ([e9a6310](https://github.com/adobe/spacecat-shared/commit/e9a6310dbdea4d44562432b794aa1e287ba9428d))
+
 # [@adobe/spacecat-shared-data-access-v1.59.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.59.1...@adobe/spacecat-shared-data-access-v1.59.2) (2024-12-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.59.2",
+  "version": "1.60.1",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {
@@ -10,7 +10,7 @@
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "scripts": {
-    "test:it": "mocha --spec \"test/it/**/*.test.js\"",
+    "test:it": "mocha --require ./test/it/fixtures.js --spec \"test/it/**/*.test.js\"",
     "test": "c8 mocha --spec \"test/unit/**/*.test.js\"",
     "lint": "eslint .",
     "clean": "rm -rf package-lock.json node_modules"

package/src/models/site/config.js

@@ -45,7 +45,7 @@ export const DEFAULT_CONFIG = {
 };
 
 // Function to validate incoming configuration
-function validateConfiguration(config) {
+export function validateConfiguration(config) {
   const { error, value } = configSchema.validate(config);
 
   if (error) {

package/src/service/audits/accessPatterns.js

@@ -21,7 +21,7 @@ import { createAudit } from '../../models/audit.js';
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} siteId - The ID of the site for which audits are being retrieved.
  * @param {string} [auditType] - Optional. The type of audits to retrieve.
  * @param {boolean} [ascending] - Optional. Determines if the audits should be sorted
@@ -61,7 +61,7 @@ export const getAuditsForSite = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} siteId - The ID of the site for which to retrieve the audit.
  * @param {string} auditType - The type of audit to retrieve.
  * @param auditedAt - The ISO 8601 timestamp of the audit.
@@ -88,7 +88,7 @@ export const getAuditForSite = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} auditType - The type of audits to retrieve.
  * @param {boolean} ascending - Determines if the audits should be sorted ascending
  * or descending by scores.
@@ -121,7 +121,7 @@ export const getLatestAudits = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} siteId - The ID of the site for which audits are being retrieved.
  * @returns {Promise<Readonly<Audit>[]>} A promise that resolves to an array of latest audits
  * for the specified site.
@@ -148,7 +148,7 @@ export const getLatestAuditsForSite = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} siteId - The ID of the site for which the latest audit is being retrieved.
  * @param {string} auditType - The type of audit to retrieve the latest instance of.
  * @returns {Promise<Audit|null>} A promise that resolves to the latest audit of the
@@ -174,7 +174,7 @@ export const getLatestAuditForSite = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {object} auditData - The audit data.
  * @returns {Promise<Readonly<Audit>>}
  */
@@ -261,7 +261,7 @@ async function removeAudits(
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} siteId - The ID of the site for which audits are being removed.
  * @returns {Promise<void>}
  */

package/src/service/experiments/accessPatterns.js

@@ -44,7 +44,7 @@ export const getExperiment = async (dynamoClient, config, siteId, experimentId,
  * Retrieves all experiments for a given siteId.
  * @param {*} dynamoClient - The DynamoDB client.
  * @param {*} config - The data access config.
- * @param {*} log  - the logger object
+ * @param {*} log  - the log object
  * @param {*} siteId - siteId of the experiment.
  * @param {*} experimentId - experiment id.
  * @returns {Promise<ReadonlyArray<SiteCandidate>>} A promise that resolves to
@@ -77,7 +77,7 @@ export const getExperiments = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {object} log - the logger object
+ * @param {object} log - the log object
  * @param {object} experimentData - The experiment data.
  * @returns {Promise<Readonly<SiteCandidate>>} A promise that resolves to newly created/updated
  * experiment

package/src/service/import-job/accessPatterns.js

@@ -118,7 +118,7 @@ export const updateImportJob = async (dynamoClient, config, log, importJob) => {
  * Removes an Import Job and all associated URLs.
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {ImportJob} importJob - The import job to remove.
  * @return {Promise<void>} A promise that resolves when the import job has been removed.
  */

package/src/service/import-url/accessPatterns.js

@@ -101,7 +101,7 @@ export const getImportUrlsByJobIdAndStatus = async (dynamoClient, config, log, j
  * Get Import Urls by Job ID, if no urls exist an empty array is returned.
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} jobId - The ID of the import job.
  * @returns {Promise<ImportUrl[]>}
  */
@@ -138,7 +138,7 @@ async function removeUrls(dynamoClient, config, urls) {
  * Remove all URLs associated with an import job.
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} jobId - The ID of the import job.
  * @return {Promise<void>} A promise that resolves when all URLs have been removed.
  */

package/src/service/index.js

@@ -13,14 +13,11 @@
 import { createClient } from '@adobe/spacecat-shared-dynamo';
 import { DynamoDB } from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
+
 import AWSXray from 'aws-xray-sdk';
 import { Service } from 'electrodb';
 
-import ModelFactory from '../v2/models/model.factory.js';
-import OpportunityCollection from '../v2/models/opportunity.collection.js';
-import SuggestionCollection from '../v2/models/suggestion.collection.js';
-import OpportunitySchema from '../v2/schema/opportunity.schema.js';
-import SuggestionSchema from '../v2/schema/suggestion.schema.js';
+import EntityRegistry from '../v2/models/base/entity.registry.js';
 
 import { auditFunctions } from './audits/index.js';
 import { keyEventFunctions } from './key-events/index.js';
@@ -51,11 +48,9 @@ const createElectroService = (client, config, log) => {
     log.debug(JSON.stringify(event, null, 4));
   };
   /* c8 ignore end */
+
   return new Service(
-    {
-      opportunity: OpportunitySchema,
-      suggestion: SuggestionSchema,
-    },
+    EntityRegistry.getEntities(),
     {
       client,
       table,
@@ -74,11 +69,11 @@ const createElectroService = (client, config, log) => {
  * tableNameImportJobs: string, pkAllImportJobs: string, indexNameAllImportJobs: string,
  * tableNameSiteTopPages: string, indexNameAllOrganizations: string,
  * indexNameAllOrganizationsByImsOrgId: string, pkAllOrganizations: string}} config configuration
- * @param {Logger} log logger
+ * @param {Logger} log log
  * @returns {object} data access object
  */
-export const createDataAccess = (config, log = console) => {
-  const dynamoClient = createClient(log);
+export const createDataAccess = (config, log = console, client = undefined) => {
+  const dynamoClient = createClient(log, client);
 
   const auditFuncs = auditFunctions(dynamoClient, config, log);
   const keyEventFuncs = keyEventFunctions(dynamoClient, config, log);
@@ -95,10 +90,8 @@ export const createDataAccess = (config, log = console) => {
   // electro-based data access objects
   const rawClient = createRawClient();
   const electroService = createElectroService(rawClient, config, log);
-  const modelFactory = new ModelFactory(electroService, log);
-
-  const Opportunity = modelFactory.getCollection(OpportunityCollection.name);
-  const Suggestion = modelFactory.getCollection(SuggestionCollection.name);
+  const entityRegistry = new EntityRegistry(electroService, log);
+  const collections = entityRegistry.getCollections();
 
   return {
     ...auditFuncs,
@@ -113,7 +106,6 @@ export const createDataAccess = (config, log = console) => {
     ...experimentFuncs,
     ...apiKeyFuncs,
     // electro-based data access objects
-    Opportunity,
-    Suggestion,
+    ...collections,
   };
 };

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

@@ -18,7 +18,7 @@ import { KeyEventDto } from '../../dto/key-event.js';
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {object} log - the logger object
+ * @param {object} log - the log object
  * @param {object} keyEventData - The key event data.
  * @returns {Promise<Readonly<KeyEvent>>} newly created key event
  */
@@ -43,7 +43,7 @@ export const addKeyEvent = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} siteId - The ID of the site for which key events are being retrieved.
  * @param {boolean} ascending - Determines if the key events should be sorted ascending
  * or descending by createdAt.
@@ -73,7 +73,7 @@ export const getKeyEventsForSite = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} keyEventId - The ID of the key event to remove.
  * @returns {Promise<void>}
  */

package/src/service/organizations/accessPatterns.js

@@ -81,7 +81,7 @@ export const getOrganizationByImsOrgID = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {object} organizationData - The organization data.
  * @returns {Promise<Readonly<Organization>>}
  */
@@ -106,7 +106,7 @@ export const addOrganization = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {Organization} organization - The organization.
  * @returns {Promise<Readonly<Organization>>} - The updated organization.
  */
@@ -139,7 +139,7 @@ export const updateOrganization = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} organizationId - The ID of the organization to remove.
  * @returns {Promise<void>}
  */

package/src/service/site-candidates/accessPatterns.js

@@ -58,7 +58,7 @@ export const getSiteCandidateByBaseURL = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {object} log - the logger object
+ * @param {object} log - the log object
  * @param {object} siteCandidateData - The site candidate data.
  * @returns {Promise<Readonly<SiteCandidate>>} newly created site candidate if hadn't created before
  */

package/src/service/sites/accessPatterns.js

@@ -89,7 +89,7 @@ export const getSitesToAudit = async (dynamoClient, config) => {
  * the list.
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} auditType - The type of audits to retrieve for the sites.
  * @param {boolean} [sortAuditsAscending=true] - Determines if the audits should be sorted in
  * ascending order.
@@ -138,7 +138,7 @@ export const getSitesWithLatestAudit = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} baseURL - The base URL of the site to retrieve.
  * @returns {Promise<Readonly<Site>|null>} A promise that resolves to the site object if found,
  * otherwise null.
@@ -168,7 +168,7 @@ export const getSiteByBaseURL = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} baseUrl - The base URL of the site to retrieve.
  * @param {string} auditType - The type of audits to retrieve for the site.
  * @param {boolean} [latestOnly=false] - Determines if only the latest audit should be retrieved.
@@ -215,7 +215,7 @@ export const getSiteByBaseURLWithAuditInfo = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} baseUrl - The base URL of the site to retrieve.
  * @param {string} auditType - The type of audits to retrieve for the site.
  * @returns {Promise<Readonly<Site>|null>} A promise that resolves to the site object
@@ -234,7 +234,7 @@ export const getSiteByBaseURLWithAudits = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} baseUrl - The base URL of the site to retrieve.
  * @param {string} auditType - The type of the latest audit to retrieve for the site.
  * @returns {Promise<Readonly<Site>|null>} A promise that resolves to the site object
@@ -272,7 +272,7 @@ export const getSitesByOrganizationID = async (
  * The sortAuditsAscending parameter can be used to change the sort order.
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} auditType - The type of audits to retrieve for the sites.
  * @param {string} organizationId - The organizationId to retrieve the sites.
  * @param {boolean} [sortAuditsAscending=true] - Determines if the audits should be sorted in
@@ -321,7 +321,7 @@ export const getSitesByOrganizationIDWithLatestAudits = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} siteId - The ID of the site to retrieve.
  * @returns {Promise<Readonly<Site>|null>} A promise that resolves to the site object if found,
  * otherwise null.
@@ -341,7 +341,7 @@ export const getSiteByID = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {object} siteData - The site data.
  * @returns {Promise<Readonly<Site>>}
  */
@@ -373,7 +373,7 @@ export const addSite = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {Site} site - The site.
  * @returns {Promise<Readonly<Site>>} - The updated site.
  */
@@ -399,7 +399,7 @@ export const updateSite = async (
  *
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} siteId - The ID of the site to remove.
  * @returns {Promise<void>}
  */
@@ -446,7 +446,7 @@ async function removeSites(
  * Removes all sites for an organization.
  * @param {DynamoDbClient} dynamoClient - The DynamoDB client.
  * @param {DataAccessConfig} config - The data access config.
- * @param {Logger} log - The logger.
+ * @param {Logger} log - The log.
  * @param {string} organizationId - The ID of the organization to remove the sites for.
  * @return {Promise<void>} A promise that resolves when all sites for the organization have been
  * removed.

package/src/v2/models/api-key/api-key.collection.js

@@ -0,0 +1,26 @@
+/*
+ * 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 BaseCollection from '../base/base.collection.js';
+
+/**
+ * ApiKeyCollection - A collection class responsible for managing ApiKey entities.
+ * Extends the BaseCollection to provide specific methods for interacting with ApiKey records.
+ *
+ * @class ApiKeyCollection
+ * @extends BaseCollection
+ */
+class ApiKeyCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default ApiKeyCollection;

package/src/v2/models/api-key/api-key.model.js

@@ -0,0 +1,59 @@
+/*
+ * 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 { isIsoDate } from '@adobe/spacecat-shared-utils';
+
+import BaseModel from '../base/base.model.js';
+
+/**
+ * ApiKey - A class representing an ApiKey entity.
+ * Provides methods to access and manipulate ApiKey-specific data.
+ *
+ * @class ApiKey
+ * @extends BaseModel
+ */
+class ApiKey extends BaseModel {
+  static SCOPE_NAMES = [
+    'sites.read_all',
+    'sites.write_all',
+    'organizations.read_all',
+    'organizations.write_all',
+    'audits.read_all',
+    'audits.write_all',
+    'imports.read',
+    'imports.write',
+    'imports.delete',
+    'imports.read_all',
+    'imports.all_domains',
+    'imports.assistant',
+  ];
+
+  isValid() {
+    const now = new Date();
+
+    if (isIsoDate(this.getDeletedAt()) && new Date(this.getDeletedAt()) < now) {
+      return false;
+    }
+
+    if (isIsoDate(this.getRevokedAt()) && new Date(this.getRevokedAt()) < now) {
+      return false;
+    }
+
+    if (isIsoDate(this.getExpiresAt()) && new Date(this.getExpiresAt()) < now) {
+      return false;
+    }
+
+    return true;
+  }
+}
+
+export default ApiKey;

package/src/v2/models/api-key/api-key.schema.js

@@ -0,0 +1,82 @@
+/*
+ * 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.
+ */
+
+/* c8 ignore start */
+
+import { isIsoDate, isValidUrl } from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import ApiKey from './api-key.model.js';
+import ApiKeyCollection from './api-key.collection.js';
+
+/*
+Schema Doc: https://electrodb.dev/en/modeling/schema/
+Attribute Doc: https://electrodb.dev/en/modeling/attributes/
+Indexes Doc: https://electrodb.dev/en/modeling/indexes/
+ */
+
+const schema = new SchemaBuilder(ApiKey, ApiKeyCollection)
+  .addAttribute('hashedApiKey', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('imsUserId', {
+    type: 'string',
+  })
+  .addAttribute('imsOrgId', {
+    type: 'string',
+  })
+  .addAttribute('name', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('deletedAt', {
+    type: 'string',
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('expiresAt', {
+    type: 'string',
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('revokedAt', {
+    type: 'string',
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('scopes', {
+    type: 'list',
+    required: true,
+    items: {
+      type: 'map',
+      properties: {
+        domains: {
+          type: 'list',
+          items: {
+            type: 'string',
+            validate: (value) => isValidUrl(value),
+          },
+        },
+        name: { type: ApiKey.SCOPE_NAMES },
+      },
+    },
+  })
+  .addIndex(
+    'byHashedApiKey',
+    { composite: ['hashedApiKey'] },
+    { composite: ['updatedAt'] },
+  )
+  .addIndex(
+    'byImsOrgIdAndImsUserId',
+    { composite: ['imsOrgId', 'imsUserId'] },
+    { composite: ['updatedAt'] },
+  );
+
+export default schema.build();

package/src/v2/models/api-key/index.d.ts

@@ -0,0 +1,37 @@
+/*
+ * 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 type { BaseCollection, BaseModel } from '../base';
+
+export interface ApiKey extends BaseModel {
+  getDeletedAt(): string | undefined;
+  getExpiresAt(): string | undefined;
+  getHashedApiKey(): string;
+  getImsOrgId(): string | undefined;
+  getImsUserId(): string | undefined;
+  getName(): string;
+  getRevokedAt(): string | undefined;
+  getScopes(): string[];
+  setDeletedAt(deletedAt: string): void;
+  setExpiresAt(expiresAt: string): void;
+  setHashedApiKey(hashedApiKey: string): void;
+  setImsOrgId(imsOrgId: string): void;
+  setImsUserId(imsUserId: string): void;
+  setName(name: string): void;
+  setRevokedAt(revokedAt: string): void;
+  setScopes(scopes: object[]): void;
+}
+
+export interface ApiKeyCollection extends BaseCollection<ApiKey> {
+  allByImsOrgIdAndImsUserId: (imsUserId: string, imsOrgId: string) => Promise<ApiKey[]>;
+  findByHashedApiKey: (hashedApiKey: string) => Promise<ApiKey | null>;
+}

package/src/v2/models/api-key/index.js

@@ -0,0 +1,19 @@
+/*
+ * 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 ApiKey from './api-key.model.js';
+import ApiKeyCollection from './api-key.collection.js';
+
+export {
+  ApiKey,
+  ApiKeyCollection,
+};

package/src/v2/models/audit/audit.collection.js

@@ -0,0 +1,26 @@
+/*
+ * 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 BaseCollection from '../base/base.collection.js';
+
+/**
+ * AuditCollection - A collection class responsible for managing Audit entities.
+ * Extends the BaseCollection to provide specific methods for interacting with Audit records.
+ *
+ * @class AuditCollection
+ * @extends BaseCollection
+ */
+class AuditCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default AuditCollection;