@adobe/spacecat-shared-utils 1.12.2 → 1.13.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.13.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.12.3...@adobe/spacecat-shared-utils-v1.13.0) (2024-02-29)
+
+
+### Features
+
+* helper to detect audits are disabled ([#173](https://github.com/adobe/spacecat-shared/issues/173)) ([e698a76](https://github.com/adobe/spacecat-shared/commit/e698a76899399a7155175527b47c0fe5528b123a))
+
+# [@adobe/spacecat-shared-utils-v1.12.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.12.2...@adobe/spacecat-shared-utils-v1.12.3) (2024-02-28)
+
+
+### Bug Fixes
+
+* enhance dateAfterDays ([189895a](https://github.com/adobe/spacecat-shared/commit/189895acc254703ae90bdebb965346ffe39350c3))
+
 # [@adobe/spacecat-shared-utils-v1.12.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.12.1...@adobe/spacecat-shared-utils-v1.12.2) (2024-02-27)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.12.2",
+  "version": "1.13.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "main": "src/index.js",
@@ -42,5 +42,8 @@
     "@adobe/fetch": "4.1.1",
     "@aws-sdk/client-s3": "3.521.0",
     "@aws-sdk/client-sqs": "3.521.0"
+  },
+  "peerDependencies": {
+    "@adobe/spacecat-shared-data-access": "1.x"
   }
 }

package/src/functions.js

@@ -169,6 +169,7 @@ const arrayEquals = (a, b) => isArray(a)
  * Calculates the date after a specified number of days from the current date.
  *
  * @param {number} days - The number of days to add to the current date.
+ * @param {string=} dateString - The reference date in string format.
  * @returns {Date} A new Date object representing the calculated date after the specified days.
  * @throws {TypeError} If the provided 'days' parameter is not a number.
  * @throws {RangeError} If the calculated date is outside the valid JavaScript date range.
@@ -178,9 +179,9 @@ const arrayEquals = (a, b) => isArray(a)
  * const sevenDaysLater = dateAfterDays(7);
  * console.log(sevenDaysLater); // Outputs a Date object representing the date 7 days from now
  */
-function dateAfterDays(days) {
-  const currentDate = new Date();
-  currentDate.setDate(currentDate.getDate() + days);
+function dateAfterDays(days, dateString) {
+  const currentDate = !dateString ? new Date() : new Date(dateString);
+  currentDate.setUTCDate(currentDate.getDate() + days);
   return currentDate;
 }
 

package/src/helpers.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { isString } from './functions.js';
+import { hasText, isString } from './functions.js';
 
 /**
  * Resolves the name of the secret based on the function version.
@@ -19,7 +19,7 @@ import { isString } from './functions.js';
  * @param {string} defaultPath - The default path for the secret.
  * @returns {string} - The resolved secret name.
  */
-const resolveSecretsName = (opts, ctx, defaultPath) => {
+export function resolveSecretsName(opts, ctx, defaultPath) {
   let funcVersion = ctx?.func?.version;
 
   if (!isString(funcVersion)) {
@@ -33,8 +33,25 @@ const resolveSecretsName = (opts, ctx, defaultPath) => {
   funcVersion = /^ci\d+$/i.test(funcVersion) ? 'ci' : funcVersion;
 
   return `${defaultPath}/${funcVersion}`;
-};
+}
 
-export {
-  resolveSecretsName,
-};
+export function isAuditsDisabled(site, organization, auditType) {
+  // return early if all audits are disabled for the organization
+  if (organization.getAuditConfig().auditsDisabled()) {
+    return true;
+  }
+
+  // return early if all audits are disabled for the site
+  if (site.getAuditConfig().auditsDisabled()) {
+    return true;
+  }
+
+  if (hasText(auditType)) {
+    const disabledAtOrg = organization.getAuditConfig().getAuditTypeConfig(auditType)?.disabled();
+    const disabledAtSite = site.getAuditConfig().getAuditTypeConfig(auditType)?.disabled();
+
+    return !!disabledAtOrg || !!disabledAtSite;
+  }
+
+  return false;
+}

package/src/index.d.ts

@@ -35,13 +35,13 @@ export function toBoolean(value: unknown): boolean;
 
 export function isValidUrl(urlString: string): boolean;
 
-export function dateAfterDays(days: number): Date;
+export function dateAfterDays(days: number, dateString: string): Date;
 
 export function sqsWrapper(fn: (message: object, context: object) => Promise<Response>):
-  (request: object, context: object) => Promise<Response>;
+    (request: object, context: object) => Promise<Response>;
 
 export function sqsEventAdapter(fn: (message: object, context: object) => Promise<Response>):
-  (request: object, context: object) => Promise<Response>;
+    (request: object, context: object) => Promise<Response>;
 
 /**
  * Prepends 'https://' schema to the URL if it's not already present.
@@ -91,3 +91,20 @@ declare function composeBaseURL(domain: string): string;
  * @returns a promise that resolves the composed audit URL.
  */
 declare function composeAuditURL(url: string): Promise<string>;
+
+/**
+ * Checks whether audits are disabled for a given site by inspecting the audit configurations
+ * in the respective organization and site models.
+ *
+ * If the optional parameter `auditType` is NOT provided, only the root-level "auditsDisabled" flag
+ * in the site and organization is checked.
+ *
+ * If the optional parameter `auditType` is provided, then the specific audit configuration for the
+ * specified type is also checked.
+ *
+ * @param {object} site - The site object.
+ * @param {object} organization - The organization object.
+ * @param {string} [auditType] - The type of audit.
+ * @returns {boolean} - True if the audit(s) are disabled, otherwise false.
+ */
+declare function isAuditsDisabled(site: object, organization: object, auditType?: string): boolean

package/src/index.js

@@ -27,7 +27,10 @@ export {
   dateAfterDays,
 } from './functions.js';
 
-export { resolveSecretsName } from './helpers.js';
+export {
+  isAuditsDisabled,
+  resolveSecretsName,
+} from './helpers.js';
 
 export { sqsWrapper } from './sqs.js';
 export { sqsEventAdapter } from './sqs.js';