@adobe/spacecat-shared-data-access 2.13.2 → 2.14.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v2.14.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.13.3...@adobe/spacecat-shared-data-access-v2.14.0) (2025-04-11)
+
+
+### Features
+
+* add FixEntity for keeping track of the suggestion fixes ([#671](https://github.com/adobe/spacecat-shared/issues/671)) ([3be02da](https://github.com/adobe/spacecat-shared/commit/3be02da115cbb2d106e863ee715a5904aa2c75d2))
+
+# [@adobe/spacecat-shared-data-access-v2.13.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.13.2...@adobe/spacecat-shared-data-access-v2.13.3) (2025-04-08)
+
+
+### Bug Fixes
+
+* configuration shouldn't check for enabled if audit is enabledByDefault ([#675](https://github.com/adobe/spacecat-shared/issues/675)) ([0d8538a](https://github.com/adobe/spacecat-shared/commit/0d8538ac967e2a69a08ebc462530985780584f0e))
+
 # [@adobe/spacecat-shared-data-access-v2.13.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v2.13.1...@adobe/spacecat-shared-data-access-v2.13.2) (2025-04-01)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "2.13.2",
+  "version": "2.14.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {

package/src/models/base/entity.registry.js

@@ -17,6 +17,7 @@ import ApiKeyCollection from '../api-key/api-key.collection.js';
 import AuditCollection from '../audit/audit.collection.js';
 import ConfigurationCollection from '../configuration/configuration.collection.js';
 import ExperimentCollection from '../experiment/experiment.collection.js';
+import FixEntityCollection from '../fix-entity/fix-entity.collection.js';
 import ImportJobCollection from '../import-job/import-job.collection.js';
 import ImportUrlCollection from '../import-url/import-url.collection.js';
 import KeyEventCollection from '../key-event/key-event.collection.js';
@@ -31,6 +32,7 @@ import SuggestionCollection from '../suggestion/suggestion.collection.js';
 import ApiKeySchema from '../api-key/api-key.schema.js';
 import AuditSchema from '../audit/audit.schema.js';
 import ConfigurationSchema from '../configuration/configuration.schema.js';
+import FixEntitySchema from '../fix-entity/fix-entity.schema.js';
 import ExperimentSchema from '../experiment/experiment.schema.js';
 import ImportJobSchema from '../import-job/import-job.schema.js';
 import ImportUrlSchema from '../import-url/import-url.schema.js';
@@ -127,6 +129,7 @@ class EntityRegistry {
 EntityRegistry.registerEntity(ApiKeySchema, ApiKeyCollection);
 EntityRegistry.registerEntity(AuditSchema, AuditCollection);
 EntityRegistry.registerEntity(ConfigurationSchema, ConfigurationCollection);
+EntityRegistry.registerEntity(FixEntitySchema, FixEntityCollection);
 EntityRegistry.registerEntity(ExperimentSchema, ExperimentCollection);
 EntityRegistry.registerEntity(ImportJobSchema, ImportJobCollection);
 EntityRegistry.registerEntity(ImportUrlSchema, ImportUrlCollection);

package/src/models/configuration/configuration.model.js

@@ -80,19 +80,24 @@ class Configuration extends BaseModel {
     const siteId = site.getId();
     const orgId = site.getOrganizationId();
 
+    if (handler.disabled) {
+      const sites = handler.disabled.sites || [];
+      const orgs = handler.disabled.orgs || [];
+      if (sites.includes(siteId) || orgs.includes(orgId)) {
+        return false;
+      }
+    }
+
+    if (handler.enabledByDefault) {
+      return true;
+    }
     if (handler.enabled) {
       const sites = handler.enabled.sites || [];
       const orgs = handler.enabled.orgs || [];
       return sites.includes(siteId) || orgs.includes(orgId);
     }
 
-    if (handler.disabled) {
-      const sites = handler.disabled.sites || [];
-      const orgs = handler.disabled.orgs || [];
-      return !(sites.includes(siteId) || orgs.includes(orgId));
-    }
-
-    return handler.enabledByDefault;
+    return false;
   }
 
   isHandlerEnabledForOrg(type, org) {
@@ -101,15 +106,19 @@ class Configuration extends BaseModel {
 
     const orgId = org.getId();
 
-    if (handler.enabled) {
-      return handler.enabled.orgs?.includes(orgId);
+    if (handler.disabled && handler.disabled.orgs?.includes(orgId)) {
+      return false;
     }
 
-    if (handler.disabled) {
-      return !handler.disabled.orgs?.includes(orgId);
+    if (handler.enabledByDefault) {
+      return true;
+    }
+
+    if (handler.enabled) {
+      return handler.enabled.orgs?.includes(orgId);
     }
 
-    return handler.enabledByDefault;
+    return false;
   }
 
   #updatedHandler(type, entityId, enabled, entityKey) {

package/src/models/fix-entity/fix-entity.collection.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2025 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';
+
+/**
+ * SiteCandidateCollection - A collection class responsible for managing FixEntities.
+ * Extends the BaseCollection to provide specific methods for interacting with
+ * FixEntity records.
+ *
+ * @class FixEntityCollection
+ * @extends BaseCollection
+ */
+class FixEntityCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default FixEntityCollection;

package/src/models/fix-entity/fix-entity.model.js

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2025 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 BaseModel from '../base/base.model.js';
+
+/**
+ * FixEntity - A class representing a FixEntity for a Suggestion.
+ * Provides methods to access and manipulate FixEntity-specific data.
+ *
+ * @class FixEntity
+ * @extends BaseModel
+ */
+class FixEntity extends BaseModel {
+  static DEFAULT_UPDATED_BY = 'spacecat';
+
+  static STATUSES = {
+    PENDING: 'PENDING', // the fix is pending to be deployed
+    DEPLOYED: 'DEPLOYED', // the fix was successfully applied
+    PUBLISHED: 'PUBLISHED', // the fix is live in production
+    FAILED: 'FAILED', // failed to apply the fix
+    ROLLED_BACK: 'ROLLED_BACK', // the fix has been rolled_back
+  };
+}
+
+export default FixEntity;

package/src/models/fix-entity/fix-entity.schema.js

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2025 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, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import FixEntity from './fix-entity.model.js';
+import FixEntityCollection from './fix-entity.collection.js';
+import { Suggestion } from '../suggestion/index.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(FixEntity, FixEntityCollection)
+  .addReference('has_many', 'Suggestion', ['status'])
+  .addReference('belongs_to', 'Opportunity', ['status'])
+  .addAttribute('type', {
+    type: Object.values(Suggestion.TYPES),
+    required: true,
+    readOnly: true,
+  })
+  .addAttribute('executedBy', {
+    type: 'string',
+  })
+  .addAttribute('executedAt', {
+    type: 'string',
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('publishedAt', {
+    type: 'string',
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('changeDetails', {
+    type: 'any',
+    required: true,
+    validate: (value) => isNonEmptyObject(value),
+  })
+  .addAttribute('status', {
+    type: Object.values(FixEntity.STATUSES),
+    required: true,
+    default: FixEntity.STATUSES.PENDING,
+  });
+
+export default schema.build();

package/src/models/fix-entity/index.d.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2025 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, MultiStatusCreateResult, Opportunity, Suggestion,
+} from '../index';
+
+export interface FixEntity extends BaseModel {
+  getChangeDetails(): object;
+  getExecutedBy(): string;
+  getExecutedAt(): string;
+  getPublishedAt(): string;
+  addSuggestions(suggestions: object[]): Promise<MultiStatusCreateResult<Suggestion>>;
+  getSuggestions(): Promise<Suggestion>;
+  getOpportunityId(): string;
+  getOpportunity(): Promise<Opportunity>;
+  getStatus(): string;
+  getType(): string;
+  setChangeDetails(changeDetails: object): FixEntity;
+  setType(rank: number): FixEntity;
+  setStatus(status: string): FixEntity;
+  setExecutedBy(executedBy: string): FixEntity;
+}
+
+export interface FixEntityCollection extends BaseCollection<FixEntity> {
+  allByOpportunityId(opportunityId: string): Promise<FixEntity[]>;
+  allByOpportunityIdAndStatus(opportunityId: string, status: string): Promise<FixEntity[]>;
+  findByOpportunityId(opportunityId: string): Promise<FixEntity | null>;
+  findByOpportunityIdAndStatus(opportunityId: string, status: string): Promise<FixEntity | null>;
+}

package/src/models/fix-entity/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 FixEntity from './fix-entity.model.js';
+import FixEntityCollection from './fix-entity.collection.js';
+
+export {
+  FixEntity,
+  FixEntityCollection,
+};

package/src/models/index.d.ts

@@ -13,6 +13,7 @@
 export type * from './audit';
 export type * from './configuration';
 export type * from './base';
+export type * from './fix-entity';
 export type * from './experiment';
 export type * from './import-job';
 export type * from './import-url';

package/src/models/index.js

@@ -14,6 +14,7 @@ export * from './api-key/index.js';
 export * from './audit/index.js';
 export * from './base/index.js';
 export * from './configuration/index.js';
+export * from './fix-entity/index.js';
 export * from './experiment/index.js';
 export * from './import-job/index.js';
 export * from './import-url/index.js';

package/src/models/opportunity/index.d.ts

@@ -11,11 +11,12 @@
  */
 
 import type {
-  Audit, BaseCollection, BaseModel, MultiStatusCreateResult, Site, Suggestion,
+  Audit, BaseCollection, BaseModel, FixEntity, MultiStatusCreateResult, Site, Suggestion,
 } from '../index';
 
 export interface Opportunity extends BaseModel {
   addSuggestions(suggestions: object[]): Promise<MultiStatusCreateResult<Suggestion>>;
+  addFixEntities(fixEntities: object[]): Promise<MultiStatusCreateResult<FixEntity>>;
   getAudit(): Promise<Audit>;
   getAuditId(): string;
   getData(): object;
@@ -26,6 +27,7 @@ export interface Opportunity extends BaseModel {
   getSite(): Promise<Site>;
   getSiteId(): string;
   getStatus(): string;
+  getFixEntities(): Promise<FixEntity[]>;
   getSuggestions(): Promise<Suggestion[]>;
   getSuggestionsByStatus(status: string): Promise<Suggestion[]>;
   getSuggestionsByStatusAndRank(status: string, rank: string): Promise<Suggestion[]>;

package/src/models/opportunity/opportunity.model.js

@@ -55,6 +55,27 @@ class Opportunity extends BaseModel {
       .getCollection('SuggestionCollection')
       .createMany(childSuggestions, this);
   }
+
+  /**
+   * Adds the given fixEntities to this Opportunity. Sets this opportunity as the parent
+   * of each fixEntity, as such the opportunity ID does not need to be provided.
+   *
+   * @async
+   * @param {Array<Object>} fixEntities - An array of fixEntities objects to add.
+   * @return {Promise<{ createdItems: BaseModel[],
+   * errorItems: { item: Object, error: ValidationError }[] }>} - A promise that
+   * resolves to an object containing the created fixEntities items and any
+   * errors that occurred.
+   */
+  async addFixEntities(fixEntities) {
+    const childFixEntities = fixEntities.map((fixEntity) => ({
+      ...fixEntity,
+      [this.idName]: this.getId(),
+    }));
+    return this.entityRegistry
+      .getCollection('FixEntityCollection')
+      .createMany(childFixEntities, this);
+  }
 }
 
 export default Opportunity;

package/src/models/opportunity/opportunity.schema.js

@@ -29,6 +29,7 @@ const schema = new SchemaBuilder(Opportunity, OpportunityCollection)
   .addReference('belongs_to', 'Audit', ['updatedAt'], { required: false })
   .addReference('belongs_to', 'LatestAudit', ['updatedAt'], { required: false })
   .addReference('has_many', 'Suggestions', ['updatedAt'], { removeDependents: true })
+  .addReference('has_many', 'FixEntities', ['updatedAt'], { removeDependents: true })
   .addAttribute('runbook', {
     type: 'string',
     validate: (value) => !value || isValidUrl(value),

package/src/models/suggestion/index.d.ts

@@ -17,6 +17,8 @@ export interface Suggestion extends BaseModel {
   getKpiDeltas(): object;
   getOpportunity(): Promise<Opportunity>;
   getOpportunityId(): string;
+  getFixEntityId(): string;
+  getFixEntity(): Promise<object>;
   getRank(): number;
   getStatus(): string;
   getType(): string;
@@ -29,6 +31,7 @@ export interface Suggestion extends BaseModel {
 
 export interface SuggestionCollection extends BaseCollection<Suggestion> {
   allByOpportunityId(opportunityId: string): Promise<Suggestion[]>;
+  allByFixEntityId(fixEntityId: string): Promise<Suggestion[]>;
   allByOpportunityIdAndStatus(opportunityId: string, status: string): Promise<Suggestion[]>;
   bulkUpdateStatus(suggestions: Suggestion[], status: string): Promise<Suggestion[]>;
   findByOpportunityId(opportunityId: string): Promise<Suggestion | null>;

package/src/models/suggestion/suggestion.schema.js

@@ -26,6 +26,7 @@ Indexes Doc: https://electrodb.dev/en/modeling/indexes/
 
 const schema = new SchemaBuilder(Suggestion, SuggestionCollection)
   .addReference('belongs_to', 'Opportunity', ['status', 'rank'])
+  .addReference('belongs_to', 'FixEntity', ['updatedAt'], { required: false })
   .addAttribute('type', {
     type: Object.values(Suggestion.TYPES),
     required: true,