@adobe/spacecat-shared-data-access 1.61.19 → 2.0.1

package/src/models/configuration.js

@@ -1,194 +0,0 @@
-/*
- * 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 Joi from 'joi';
-
-const Configuration = (data = {}) => {
-  const state = { ...data };
-  const self = { state };
-  self.getSlackRoles = () => self.state.slackRoles;
-  self.getJobs = () => self.state.jobs;
-  self.getVersion = () => self.state.version;
-  self.getQueues = () => self.state.queues;
-  self.getHandlers = () => self.state.handlers;
-  self.getHandler = (type) => self.state.handlers[type];
-  self.addHandler = (type, handlerData) => {
-    state.handlers = state.handlers || {};
-    state.handlers[type] = { ...handlerData };
-  };
-  self.getSlackRoleMembersByRole = (role) => {
-    const roles = self.getSlackRoles();
-    return roles ? roles[role] : [];
-  };
-  self.getEnabledSiteIdsForHandler = (type) => {
-    const handler = state.handlers?.[type];
-    return handler?.enabled?.sites || [];
-  };
-  self.isHandlerEnabledForSite = (type, site) => {
-    const handler = state.handlers[type];
-    if (!handler) return false;
-
-    const siteId = site.getId();
-    const orgId = site.getOrganizationId();
-
-    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;
-  };
-
-  self.isHandlerEnabledForOrg = (type, org) => {
-    const handler = state.handlers[type];
-    if (!handler) return false;
-
-    const orgId = org.getId();
-
-    if (handler.enabled) {
-      return handler.enabled.orgs.includes(orgId);
-    }
-
-    if (handler.disabled) {
-      return !handler.disabled.orgs.includes(orgId);
-    }
-
-    return handler.enabledByDefault;
-  };
-
-  const updateHandlerOrgs = (type, orgId, enabled) => {
-    const handler = state.handlers[type];
-    if (!handler) return;
-
-    if (enabled) {
-      if (handler.enabledByDefault) {
-        handler.disabled.orgs = handler.disabled.orgs?.filter((id) => id !== orgId) || [];
-      } else {
-        handler.enabled = handler.enabled || { orgs: [] };
-        handler.enabled.orgs = Array.from(new Set([...(handler.enabled?.orgs || []), orgId]));
-      }
-    } else if (handler.enabledByDefault) {
-      handler.disabled = handler.disabled || { orgs: [] };
-      handler.disabled.orgs = Array.from(new Set([...(handler.disabled?.orgs || []), orgId]));
-    } else {
-      handler.enabled.orgs = handler.enabled.orgs?.filter((id) => id !== orgId) || [];
-    }
-  };
-
-  const updateHandlerSites = (type, siteId, enabled) => {
-    const handler = state.handlers[type];
-    if (!handler) return;
-
-    if (enabled) {
-      if (handler.enabledByDefault) {
-        handler.disabled.sites = handler.disabled.sites?.filter((id) => id !== siteId) || [];
-      } else {
-        handler.enabled = handler.enabled || { sites: [] };
-        handler.enabled.sites = Array.from(new Set([...(handler.enabled.sites || []), siteId]));
-      }
-    } else if (handler.enabledByDefault) {
-      handler.disabled = handler.disabled || { sites: [] };
-      handler.disabled.sites = Array.from(new Set([...(handler.disabled.sites || []), siteId]));
-    } else {
-      handler.enabled.sites = handler.enabled.sites?.filter((id) => id !== siteId) || [];
-    }
-  };
-
-  self.enableHandlerForSite = (type, site) => {
-    const siteId = site.getId();
-    if (self.isHandlerEnabledForSite(type, site)) return;
-
-    updateHandlerSites(type, siteId, true);
-  };
-
-  self.enableHandlerForOrg = (type, org) => {
-    const orgId = org.getId();
-    if (self.isHandlerEnabledForOrg(type, org)) return;
-
-    updateHandlerOrgs(type, orgId, true);
-  };
-
-  self.disableHandlerForSite = (type, site) => {
-    const siteId = site.getId();
-    if (!self.isHandlerEnabledForSite(type, site)) return;
-
-    updateHandlerSites(type, siteId, false);
-  };
-
-  self.disableHandlerForOrg = (type, org) => {
-    const orgId = org.getId();
-    if (!self.isHandlerEnabledForOrg(type, org)) return;
-
-    updateHandlerOrgs(type, orgId, false);
-  };
-
-  return Object.freeze(self);
-};
-
-/**
- *
- * @param configuration
- * @returns {any}
- */
-
-export const checkConfiguration = (configuration) => {
-  const schema = Joi.object({
-    version: Joi.number().required(),
-    queues: Joi.object().required(),
-    handlers: Joi.object().pattern(Joi.string(), Joi.object(
-      {
-        enabled: Joi.object({
-          sites: Joi.array().items(Joi.string()),
-          orgs: Joi.array().items(Joi.string()),
-        }),
-        disabled: Joi.object({
-          sites: Joi.array().items(Joi.string()),
-          orgs: Joi.array().items(Joi.string()),
-        }),
-        enabledByDefault: Joi.boolean().required(),
-        dependencies: Joi.array().items(Joi.object(
-          {
-            handler: Joi.string(),
-            actions: Joi.array().items(Joi.string()),
-          },
-        )),
-      },
-    )),
-    jobs: Joi.array().required(),
-  }).unknown(true);
-  const { error, value } = schema.validate(configuration);
-
-  if (error) {
-    throw new Error(`Configuration validation error: ${error.message}`);
-  }
-
-  return value; // Validated and sanitized configuration
-};
-
-/**
- * Creates a new Configuration.
- *
- * @param {object} data - configuration data
- * @returns {Readonly<Configuration>} configuration - new configuration
- */
-export const createConfiguration = (data) => {
-  const value = checkConfiguration(data);
-  const newState = { ...value };
-  return Configuration(newState);
-};

package/src/models/experiment.js

@@ -1,67 +0,0 @@
-/*
- * 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 { hasText } from '@adobe/spacecat-shared-utils';
-
-import { Base } from './base.js';
-
-export const DEFAULT_UPDATED_BY = 'spacecat';
-
-/**
- * Creates a new Experiment.
- *
- * @param {object} data - experiment data
- * @returns {Readonly<SiteCandidate>} new experiment
- */
-const Experiment = (data = {}) => {
-  const self = Base(data);
-
-  self.getSiteId = () => self.state.siteId;
-  self.getExperimentId = () => self.state.experimentId;
-  self.getName = () => self.state.name;
-  self.getUrl = () => self.state.url;
-  self.getStatus = () => self.state.status;
-  self.getType = () => self.state.type;
-  self.getStartDate = () => self.state.startDate;
-  self.getEndDate = () => self.state.endDate;
-  self.getVariants = () => self.state.variants;
-  self.getUpdatedAt = () => self.state.updatedAt;
-  self.getUpdatedBy = () => self.state.updatedBy;
-  self.getConversionEventName = () => self.state.conversionEventName;
-  self.getConversionEventValue = () => self.state.conversionEventValue;
-
-  return Object.freeze(self);
-};
-
-/**
- * Creates a new Experiment.
- *
- * @param {object} data - experiment data
- * @returns {Readonly<SiteCandidate>} new experiment
- */
-export const createExperiment = (data) => {
-  const newState = { ...data };
-
-  if (!hasText(newState.siteId)) {
-    throw new Error('Site ID must be provided');
-  }
-
-  if (!hasText(newState.experimentId)) {
-    throw new Error('Experiment ID must be provided');
-  }
-
-  if (!hasText(newState.updatedBy)) {
-    newState.updatedBy = DEFAULT_UPDATED_BY;
-  }
-
-  return Experiment(newState);
-};

package/src/models/importer/import-constants.js

@@ -1,40 +0,0 @@
-/*
- * 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.
- */
-
-/**
- * Supported Import Options.
- */
-export const ImportOptions = {
-  ENABLE_JAVASCRIPT: 'enableJavascript',
-  PAGE_LOAD_TIMEOUT: 'pageLoadTimeout',
-};
-
-/**
- * Import Job Status types.
- * Any changes to this object needs to be reflected in the index.d.ts file as well.
- */
-export const ImportJobStatus = {
-  RUNNING: 'RUNNING',
-  COMPLETE: 'COMPLETE',
-  FAILED: 'FAILED',
-  STOPPED: 'STOPPED',
-};
-
-/**
- * ImportURL Status types.
- * Any changes to this object needs to be reflected in the index.d.ts file as well.
- */
-export const ImportUrlStatus = {
-  PENDING: 'PENDING',
-  REDIRECT: 'REDIRECT',
-  ...ImportJobStatus,
-};

package/src/models/importer/import-job.js

@@ -1,252 +0,0 @@
-/*
- * 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 {
-  hasText, isIsoDate, isValidUrl, isObject, isString, isNumber, isInteger, isBoolean,
-} from '@adobe/spacecat-shared-utils';
-import { Base } from '../base.js';
-import { ImportJobStatus, ImportOptions } from './import-constants.js';
-
-/**
- * Creates a new ImportJob object.
- *
- * @param {Object} data - The data for the ImportJob object.
- * @returns {ImportJob} The new ImportJob object.
- */
-const ImportJob = (data) => {
-  const self = Base(data);
-
-  // generate get methods for all properties of our base object
-  self.getBaseURL = () => self.state.baseURL;
-  self.getHashedApiKey = () => self.state.hashedApiKey;
-  self.getOptions = () => self.state.options;
-  self.getStartTime = () => self.state.startTime;
-  self.getEndTime = () => self.state.endTime;
-  self.getDuration = () => self.state.duration;
-  self.getStatus = () => self.state.status;
-  self.getUrlCount = () => self.state.urlCount;
-  self.getSuccessCount = () => self.state.successCount;
-  self.getFailedCount = () => self.state.failedCount;
-  self.getRedirectCount = () => self.state.redirectCount;
-  self.getImportQueueId = () => self.state.importQueueId;
-  self.getInitiatedBy = () => self.state.initiatedBy;
-  self.hasCustomHeaders = () => self.state.hasCustomHeaders || false;
-  self.hasCustomImportJs = () => self.state.hasCustomImportJs || false;
-
-  /**
-   * Updates the state of the ImportJob.
-   * @param key - The key to update.
-   * @param value - The new value.
-   * @param validator - An optional validation function to use before updating the value.
-   * @returns {ImportJob} The updated ImportJob object.
-   */
-  const updateState = (key, value, validator) => {
-    if (validator && typeof validator === 'function') {
-      validator(value);
-    }
-
-    self.state[key] = value;
-    self.touch();
-
-    return self;
-  };
-
-  /**
-   * Updates the end time of the ImportJob.
-   * @param {string} endTime - The new end time in JavaScript ISO date string in Zulu (UTC)
-   * timezone. eg. 2024-05-29T14:36:00.000Z.
-   */
-  self.updateEndTime = (endTime) => updateState('endTime', endTime, (value) => {
-    if (!isIsoDate(value)) {
-      throw new Error(`Invalid end time during update: ${endTime}`);
-    }
-  });
-
-  /**
-   * Updates the duration of the ImportJob.
-   * @param {number} duration - The new duration.
-   */
-  self.updateDuration = (duration) => updateState('duration', duration, (value) => {
-    if (!isNumber(value)) {
-      throw new Error(`Invalid duration during update: ${value}`);
-    }
-  });
-
-  /**
-   * Updates the status of the ImportJob.
-   * @param {string} status - The new status.
-   */
-  self.updateStatus = (status) => updateState('status', status, (value) => {
-    if (!Object.values(ImportJobStatus).includes(value)) {
-      throw new Error(`Invalid Import Job status during update: ${value}`);
-    }
-  });
-
-  /**
-   * Updates the Url count of the ImportJob
-   * @param {number} urlCount - The new url count.
-   */
-  self.updateUrlCount = (urlCount) => updateState('urlCount', urlCount, (value) => {
-    if (!isInteger(value)) {
-      throw new Error(`Invalid url count during update: ${value}`);
-    }
-  });
-
-  /**
-   * Updates the success count of the ImportJob.
-   * @param {number} successCount - The new success count.
-   * @returns {ImportJob} The updated ImportJob object.
-   */
-  self.updateSuccessCount = (successCount) => updateState('successCount', successCount, (value) => {
-    if (!isInteger(value) || value < 0) {
-      throw new Error(`Invalid success count during update: ${value}`);
-    }
-  });
-
-  /**
-   * Updates the failed count of the ImportJob.
-   * @param {number} failedCount - The new failed count.
-   * @returns {ImportJob} The updated ImportJob object.
-   */
-  self.updateFailedCount = (failedCount) => updateState('failedCount', failedCount, (value) => {
-    if (!isInteger(value) || value < 0) {
-      throw new Error(`Invalid failed count during update: ${value}`);
-    }
-  });
-
-  /**
-   * Updates the redirect count of the ImportJob.
-   * @param {number} redirectCount - The new redirect count.
-   * @returns {ImportJob} The updated ImportJob object.
-   */
-  self.updateRedirectCount = (redirectCount) => updateState('redirectCount', redirectCount, (value) => {
-    if (!isInteger(value) || value < 0) {
-      throw new Error(`Invalid redirect count during update: ${value}`);
-    }
-  });
-
-  /**
-   * Updates the import queue id of the ImportJob.
-   * @param {string} importQueueId - The new import queue id.
-   * @returns {ImportJob} The updated ImportJob object.
-   */
-  self.updateImportQueueId = (importQueueId) => updateState(
-    'importQueueId',
-    importQueueId,
-    (value) => {
-      if (!hasText(importQueueId)) {
-        throw new Error(`Invalid import queue id during update: ${value}`);
-      }
-    },
-  );
-
-  /**
-   * Update the hasCustomHeaders value to true if the ImportJob has custom headers, false otherwise.
-   * @param {boolean} hasCustomHeaders - The new value for hasCustomHeaders.
-   * @return {ImportJob} The updated ImportJob object.
-   */
-  self.updateHasCustomHeaders = (hasCustomHeaders) => updateState('hasCustomHeaders', hasCustomHeaders, (value) => {
-    if (!isBoolean(value)) {
-      throw new Error(`Invalid hasCustomHeaders value: ${value}`);
-    }
-  });
-
-  /**
-   * Update the hasCustomImportJs value to true if the ImportJob has custom import js, false
-   * otherwise.
-   * @param {boolean} hasCustomImportJs - The new value for hasCustomImportJs.
-   * @return {ImportJob} The updated ImportJob object.
-   */
-  self.updateHasCustomImportJs = (hasCustomImportJs) => updateState('hasCustomImportJs', hasCustomImportJs, (value) => {
-    if (!isBoolean(value)) {
-      throw new Error(`Invalid hasCustomImportJs value: ${value}`);
-    }
-  });
-
-  return Object.freeze(self);
-};
-
-/**
- * Creates a new ImportJob object.
- * @param {Object} data - The data for the ImportJob object.
- * @returns {ImportJob} The new ImportJob object.
- */
-export const createImportJob = (data) => {
-  // Define a list of data type validators for each import option
-  const ImportOptionTypeValidator = {
-    [ImportOptions.ENABLE_JAVASCRIPT]: (value) => {
-      if (value !== true && value !== false) {
-        throw new Error(`Invalid value for ${ImportOptions.ENABLE_JAVASCRIPT}: ${value}`);
-      }
-    },
-    [ImportOptions.PAGE_LOAD_TIMEOUT]: (value) => {
-      if (!isInteger(value) || value < 0) {
-        throw new Error(`Invalid value for ${ImportOptions.PAGE_LOAD_TIMEOUT}: ${value}`);
-      }
-    },
-  };
-
-  const newState = { ...data };
-
-  // set default values for the start time if one is not provided
-  if (!hasText(newState.startTime)) {
-    newState.startTime = new Date().toISOString();
-  }
-
-  if (!isValidUrl(newState.baseURL)) {
-    throw new Error(`Invalid base URL: ${newState.baseURL}`);
-  }
-
-  if (!isString(newState.hashedApiKey)) {
-    throw new Error(`Invalid API key: ${newState.hashedApiKey}`);
-  }
-
-  if (hasText(newState.startTime) && !isIsoDate(newState.startTime)) {
-    throw new Error('"StartTime" should be a valid ISO string');
-  }
-
-  if (!Object.values(ImportJobStatus).includes(newState.status)) {
-    throw new Error(`Invalid Import Job status ${newState.status}`);
-  }
-
-  if (newState.options) {
-    if (!isObject(newState.options)) {
-      throw new Error(`Invalid options: ${newState.options}`);
-    }
-
-    const invalidOptions = Object.keys(newState.options).filter(
-      (key) => !Object.values(ImportOptions)
-        .some((value) => value.toLowerCase() === key.toLowerCase()),
-    );
-
-    if (invalidOptions.length > 0) {
-      throw new Error(`Invalid options: ${invalidOptions}`);
-    }
-
-    // validate each option for it's expected data type
-    Object.keys(newState.options).forEach((key) => {
-      if (ImportOptionTypeValidator[key]) {
-        ImportOptionTypeValidator[key](data.options[key]);
-      }
-    });
-  }
-
-  if (newState.hasCustomImportJs && !isBoolean(newState.hasCustomImportJs)) {
-    throw new Error(`Invalid hasCustomImportJs value: ${newState.hasCustomImportJs}`);
-  }
-
-  if (newState.hasCustomHeaders && !isBoolean(newState.hasCustomHeaders)) {
-    throw new Error(`Invalid hasCustomHeaders value: ${newState.hasCustomHeaders}`);
-  }
-
-  return ImportJob(newState);
-};

package/src/models/importer/import-url.js

@@ -1,115 +0,0 @@
-/*
- * 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 { hasText, isValidUrl } from '@adobe/spacecat-shared-utils';
-import { Base } from '../base.js';
-import { ImportUrlStatus } from './import-constants.js';
-
-export const IMPORT_URL_EXPIRES_IN_DAYS = 30;
-
-/**
- * Creates a new ImportUrl object
- *
- * @param {Object} data
- * @returns {ImportUrl}
- */
-const ImportUrl = (data) => {
-  const self = Base(data);
-
-  self.getJobId = () => self.state.jobId;
-  self.getUrl = () => self.state.url;
-  self.getStatus = () => self.state.status;
-  self.getReason = () => self.state.reason;
-  // Absolute path to the resource that is being imported for the given URL
-  self.getPath = () => self.state.path;
-  // Resulting path and filename of the imported .docx file
-  self.getFile = () => self.state.file;
-  // Expiration date for the URL
-  self.getExpiresAt = () => self.state.expiresAt;
-
-  /**
-   * Updates the state of the ImportJob.
-   * @param key - The key to update.
-   * @param value - The new value.
-   * @param {Function} validator - An optional validation function to use before updating the value.
-   * The validator can return false to indicate that the value isn't worth throwing an exception,
-   * but continue to use the previous value.
-   */
-  const updateState = (key, value, validator) => {
-    if (validator && typeof validator === 'function') {
-      // a validator can return true or false to indicate if the value is valid
-      // however if a validator throws an error, it is considered critical and invalid.
-      if (!validator(value)) {
-        return self;
-      }
-    }
-
-    self.state[key] = value;
-    self.touch();
-
-    return self;
-  };
-
-  /**
-   * Updates the status of the ImportUrl
-   */
-  self.setStatus = (status) => updateState('status', status, (value) => {
-    if (!ImportUrlStatus[value]) {
-      throw new Error(`Invalid Import URL status during update: ${value}`);
-    }
-    return true;
-  });
-
-  /**
-   * Updates the reason that the import of this URL was not successful.
-   */
-  self.setReason = (reason) => updateState('reason', reason, hasText);
-
-  /**
-   * Updates the path of the ImportUrl
-   */
-  self.setPath = (path) => updateState('path', path, hasText);
-
-  /**
-   * Updates the file of the ImportUrl. This is the path and file name of the file which
-   * was imported.
-   */
-  self.setFile = (file) => updateState('file', file, hasText);
-
-  return Object.freeze(self);
-};
-
-/**
- * Creates a new ImportUrl object
- */
-export const createImportUrl = (data) => {
-  const newState = { ...data };
-
-  if (!isValidUrl(newState.url)) {
-    throw new Error(`Invalid Url: ${newState.url}`);
-  }
-
-  if (!hasText(newState.jobId)) {
-    throw new Error(`Invalid Job ID: ${newState.jobId}`);
-  }
-
-  if (!Object.values(ImportUrlStatus).includes(newState.status)) {
-    throw new Error(`Invalid Import URL status: ${newState.status}`);
-  }
-
-  if (!newState.expiresAt) {
-    newState.expiresAt = new Date();
-    newState.expiresAt.setDate(newState.expiresAt.getDate() + IMPORT_URL_EXPIRES_IN_DAYS);
-  }
-
-  return ImportUrl(newState);
-};