@adobe/spacecat-shared-data-access 1.2.7 → 1.3.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.3.1](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.3.0...@adobe/spacecat-shared-data-access-v1.3.1) (2023-12-16)
+
+
+### Bug Fixes
+
+* type def / jsdoc ([#61](https://github.com/adobe-rnd/spacecat-shared/issues/61)) ([078f9e6](https://github.com/adobe-rnd/spacecat-shared/commit/078f9e6855d3f475f3a746561758aaefb5cb3c79))
+
+# [@adobe/spacecat-shared-data-access-v1.3.0](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.2.7...@adobe/spacecat-shared-data-access-v1.3.0) (2023-12-16)
+
+
+### Features
+
+* add audit config ([#59](https://github.com/adobe-rnd/spacecat-shared/issues/59)) ([f851862](https://github.com/adobe-rnd/spacecat-shared/commit/f8518623a8b8e4e337b3c44a16b65724a953596a))
+
 # [@adobe/spacecat-shared-data-access-v1.2.7](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.2.6...@adobe/spacecat-shared-data-access-v1.2.7) (2023-12-11)
 
 

package/package.json

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

package/src/dto/site.js

@@ -11,6 +11,7 @@
  */
 
 import { createSite } from '../models/site.js';
+import AuditConfig from '../models/site/audit-config.js';
 
 /**
  * Data transfer object for Site.
@@ -30,6 +31,7 @@ export const SiteDto = {
     createdAt: site.getCreatedAt(),
     updatedAt: site.getUpdatedAt(),
     GSI1PK: 'ALL_SITES',
+    auditConfig: AuditConfig.toDynamoItem(site.getAuditConfig()),
   }),
 
   /**
@@ -46,6 +48,7 @@ export const SiteDto = {
       isLive: dynamoItem.isLive,
       createdAt: dynamoItem.createdAt,
       updatedAt: dynamoItem.updatedAt,
+      auditConfig: dynamoItem.auditConfig,
     };
 
     return createSite(siteData);

package/src/index.d.ts

@@ -20,9 +20,45 @@ export interface Audit {
   getExpiresAt: () => Date;
   getFullAuditRef: () => string;
   isLive: () => boolean;
+  isError: () => boolean;
   getScores: () => object;
 }
 
+/**
+ * AuditConfigType defines the structure for specific audit type configurations
+ */
+export interface AuditConfigType {
+  /**
+   * Returns true if the audit type is disabled for the site. If an audit type is disabled, no
+   * audits of that type will be scheduled for the site.
+   * @returns True if the audit type is disabled for the site
+   */
+  disabled(): boolean;
+}
+
+/**
+ * AuditConfig defines the structure for the overall audit configuration of a site
+ */
+export interface AuditConfig {
+  /**
+   * Returns true if audits are disabled for the site. If audits are disabled, no audits will be
+   * scheduled for the site. Overrides any audit type specific configurations.
+   * @returns True if audits are disabled for the site
+   */
+  auditsDisabled: () => boolean;
+  /**
+   * Returns the audit config for a specific audit type. The audit type is the key.
+   * @param auditType The audit type to get the config for
+   * @returns The audit config for the audit type
+   */
+  getAuditTypeConfig: (auditType: string) => AuditConfigType;
+  /**
+   * Returns the audit configs for all audit types. The keys are the audit types.
+   * @returns The audit configs for all audit types
+   */
+  getAuditTypeConfigs: () => object;
+}
+
 export interface Site {
   getId: () => string;
   getBaseURL: () => string;
@@ -30,6 +66,7 @@ export interface Site {
   getImsOrgId: () => string;
   getCreatedAt: () => string;
   getUpdatedAt: () => string;
+  getAuditConfig: () => AuditConfig;
   getAudits: () => Audit[];
   isLive: () => boolean;
   setAudits: (audits: Audit[]) => Site;

package/src/models/audit.js

@@ -61,6 +61,7 @@ const Audit = (data = {}) => {
   self.getExpiresAt = () => self.state.expiresAt;
   self.getFullAuditRef = () => self.state.fullAuditRef;
   self.isLive = () => self.state.isLive;
+  self.isError = () => hasText(self.getAuditResult().runtimeError?.code);
   self.getScores = () => self.getAuditResult().scores;
 
   return Object.freeze(self);

package/src/models/site/audit-config-type.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2023 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.
+ */
+
+const AuditConfigType = (data = {}, allAuditsDisabled = false) => ({
+  disabled: () => allAuditsDisabled || data.disabled || false,
+});
+
+AuditConfigType.fromDynamoItem = (dynamoItem) => {
+  const auditConfigTypeData = {
+    disabled: dynamoItem.disabled,
+  };
+  return AuditConfigType(auditConfigTypeData);
+};
+
+AuditConfigType.toDynamoItem = (auditConfigType) => ({
+  disabled: auditConfigType.disabled(),
+});
+
+export default AuditConfigType;

package/src/models/site/audit-config.js

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2023 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 AuditConfigType from './audit-config-type.js';
+
+/**
+ * Initializes the audit type configs. If auditsDisabled is true, all audit types will be disabled.
+ * @param {object} auditTypeConfigs - Object containing audit type configs.
+ * @param {boolean} auditsDisabled - Flag indicating if all audits are disabled.
+ * @return {object} Object containing audit type configs.
+ */
+function getAuditTypeConfigs(auditTypeConfigs, auditsDisabled) {
+  return Object.entries(auditTypeConfigs || {}).reduce((acc, [key, value]) => {
+    acc[key] = AuditConfigType(value, auditsDisabled);
+    return acc;
+  }, {});
+}
+
+const AuditConfig = (data = {}) => {
+  const auditTypeConfigs = getAuditTypeConfigs(data.auditTypeConfigs, data.auditsDisabled);
+  return {
+    auditsDisabled: () => data.auditsDisabled || false,
+    getAuditTypeConfigs: () => auditTypeConfigs,
+    getAuditTypeConfig: (type) => auditTypeConfigs[type],
+  };
+};
+
+AuditConfig.fromDynamoItem = (dynamoItem) => AuditConfig(dynamoItem);
+
+AuditConfig.toDynamoItem = (auditConfig) => ({
+  auditsDisabled: auditConfig.auditsDisabled(),
+  auditTypeConfigs: Object.entries(auditConfig.getAuditTypeConfigs())
+    .reduce((acc, [key, value]) => {
+      acc[key] = AuditConfigType.toDynamoItem(value);
+      return acc;
+    }, {}),
+});
+
+export default AuditConfig;

package/src/models/site.js

@@ -10,8 +10,10 @@
  * governing permissions and limitations under the License.
  */
 
-import { hasText, isValidUrl } from '@adobe/spacecat-shared-utils';
+import { hasText, isObject, isValidUrl } from '@adobe/spacecat-shared-utils';
+
 import { Base } from './base.js';
+import AuditConfig from './site/audit-config.js';
 
 /**
  * Creates a new Site.
@@ -22,6 +24,7 @@ import { Base } from './base.js';
 const Site = (data = {}) => {
   const self = Base(data);
 
+  self.getAuditConfig = () => self.state.auditConfig;
   self.getAudits = () => self.state.audits;
   self.getBaseURL = () => self.state.baseURL;
   self.getGitHubURL = () => self.state.gitHubURL;
@@ -135,5 +138,14 @@ export const createSite = (data) => {
     newState.audits = [];
   }
 
+  if (!isObject(newState.auditConfig)) {
+    newState.auditConfig = {
+      auditsDisabled: false,
+      auditTypeConfigs: {},
+    };
+  }
+
+  newState.auditConfig = AuditConfig(newState.auditConfig);
+
   return Site(newState);
 };