@adobe/spacecat-shared-data-access 1.17.2 → 1.18.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.18.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.17.2...@adobe/spacecat-shared-data-access-v1.18.0) (2024-02-23)
+
+
+### Features
+
+* fulfillable items support on Organization ([#160](https://github.com/adobe/spacecat-shared/issues/160)) ([7bc5bfc](https://github.com/adobe/spacecat-shared/commit/7bc5bfc596171f6007eb759c282681b29b138672))
+
 # [@adobe/spacecat-shared-data-access-v1.17.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.17.1...@adobe/spacecat-shared-data-access-v1.17.2) (2024-02-17)
 
 

package/package.json

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

package/src/dto/organization.js

@@ -30,6 +30,7 @@ export const OrganizationDto = {
     updatedAt: organization.getUpdatedAt(),
     GSI1PK: 'ALL_ORGANIZATIONS',
     config: Config.toDynamoItem(organization.getConfig()),
+    fulfillableItems: organization.getFulfillableItems(),
   }),
 
   /**
@@ -45,6 +46,7 @@ export const OrganizationDto = {
       createdAt: dynamoItem.createdAt,
       updatedAt: dynamoItem.updatedAt,
       config: dynamoItem.config,
+      fulfillableItems: dynamoItem.fulfillableItems,
     };
 
     return createOrganization(organizationData);

package/src/index.d.ts

@@ -100,6 +100,10 @@ export interface Config {
 
 }
 
+export interface FulfillableItems {
+  items: string[];
+}
+
 /**
  * AuditConfig defines the structure for the overall audit configuration of a site.
  */
@@ -313,6 +317,12 @@ export interface Organization {
    * @returns {Config} The current audit configuration.
    */
   getConfig: () => Config;
+
+  /**
+   * Retrieves the fulfillable items object for the org.
+   * @returns {FulfillableItems} The current fulfillable items object.
+   */
+  getFulfillableItems: () => FulfillableItems;
 }
 
 export interface Configuration {

package/src/models/organization.js

@@ -29,6 +29,7 @@ const Organization = (data = {}) => {
   self.getConfig = () => self.state.config;
   self.getName = () => self.state.name;
   self.getImsOrgId = () => self.state.imsOrgId;
+  self.getFulfillableItems = () => self.state.fulfillableItems;
 
   /**
      * Updates the IMS Org ID belonging to the organization.
@@ -77,6 +78,18 @@ const Organization = (data = {}) => {
 
     return self;
   };
+
+  self.updateFulfillableItems = (fulfillableItems) => {
+    if (!isObject(fulfillableItems)) {
+      throw new Error('Fulfillable items object must be provided');
+    }
+
+    self.state.fulfillableItems = fulfillableItems;
+    self.touch();
+
+    return self;
+  };
+
   return Object.freeze(self);
 };