@adobe/spacecat-shared-data-access 1.61.18 → 2.0.0

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);
-};

package/src/models/key-event.js

@@ -1,81 +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 } from '@adobe/spacecat-shared-utils';
-
-import { Base } from './base.js';
-
-export const KEY_EVENT_TYPES = {
-  PERFORMANCE: 'PERFORMANCE',
-  SEO: 'SEO',
-  CONTENT: 'CONTENT',
-  CODE: 'CODE',
-  THIRD_PARTY: 'THIRD PARTY',
-  EXPERIMENTATION: 'EXPERIMENTATION',
-  NETWORK: 'NETWORK',
-  STATUS_CHANGE: 'STATUS CHANGE',
-};
-
-/**
- * Creates a new Key Event.
- *
- * @param {object} data - key event data
- * @returns {Readonly<KeyEvent>} new key event
- */
-const KeyEvent = (data = {}) => {
-  const self = Base(data);
-
-  self.getName = () => self.state.name;
-  self.getSiteId = () => self.state.siteId;
-  self.getType = () => self.state.type;
-  self.getTime = () => self.state.time;
-
-  // no set functions since all values are required at creation time
-
-  return Object.freeze(self);
-};
-
-/**
- * Creates a new Key Event.
- *
- * @param {object} data - key event data
- * @returns {Readonly<KeyEvent>} new key event
- */
-export const createKeyEvent = (data) => {
-  const newState = { ...data };
-
-  if (!hasText(newState.siteId)) {
-    throw new Error('Required field "siteId" is missing');
-  }
-
-  if (!hasText(newState.name)) {
-    throw new Error('Required field "name" is missing');
-  }
-
-  if (!hasText(newState.type)) {
-    throw new Error('Required field "type" is missing');
-  }
-
-  if (!Object.values(KEY_EVENT_TYPES).includes(newState.type.toUpperCase())) {
-    throw new Error(`Unknown value for "type": ${newState.type}`);
-  }
-
-  if (hasText(newState.time) && !isIsoDate(newState.time)) {
-    throw new Error('"Time" should be a valid ISO string');
-  }
-
-  if (!hasText(newState.time)) {
-    newState.time = new Date().toISOString();
-  }
-
-  return KeyEvent(newState);
-};

package/src/models/organization.js

@@ -1,120 +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, isObject } from '@adobe/spacecat-shared-utils';
-
-import { Base } from './base.js';
-import { Config, DEFAULT_CONFIG } from './site/config.js';
-
-export const DEFAULT_ORGANIZATION_ID = 'default';
-
-/**
- * Creates a new Organization.
- *
- * @param {object} data - organization data
- * @returns {Readonly<Organization>} organization - new organization
- */
-const Organization = (data = {}) => {
-  const self = Base(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.
-     * @param {string} imsOrgId - The IMS Org ID.
-     * @return {Base} The updated organization.
-     */
-  self.updateImsOrgId = (imsOrgId) => {
-    if (!hasText(imsOrgId)) {
-      throw new Error('IMS Org ID must be provided');
-    }
-
-    self.state.imsOrgId = imsOrgId;
-    self.touch();
-
-    return self;
-  };
-
-  /**
- * Updates the organization name.
- * @param {string} name - The name of the organization.
- * @return {Base} The updated organization.
- */
-  self.updateName = (name) => {
-    if (!hasText(name)) {
-      throw new Error('Org name must be provided');
-    }
-
-    self.state.name = name;
-    self.touch();
-
-    return self;
-  };
-
-  /**
- * Updates the organization config.
- * @param {string} config - The Org config.
- * @return {Base} The updated organization.
- */
-  self.updateConfig = (config) => {
-    if (!isObject(config)) {
-      throw new Error('Config must be provided');
-    }
-
-    self.state.config = Config(config);
-    self.touch();
-
-    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);
-};
-
-/**
- * Creates a new Organization.
- *
- * @param {object} data - organization data
- * @returns {Readonly<Organization>} organization - new organization
- */
-export const createOrganization = (data) => {
-  const newState = { ...data };
-
-  if (!isObject(newState.config)) {
-    newState.config = { ...DEFAULT_CONFIG };
-  }
-
-  if (!hasText(newState.name)) {
-    throw new Error('Org name must be provided');
-  }
-
-  if (!hasText(newState.imsOrgId)) {
-    newState.imsOrgId = DEFAULT_ORGANIZATION_ID;
-  }
-
-  newState.config = Config(newState.config);
-
-  return Organization(newState);
-};

package/src/models/site-candidate.js

@@ -1,111 +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, isObject, isValidUrl } from '@adobe/spacecat-shared-utils';
-
-import { Base } from './base.js';
-
-export const DEFAULT_UPDATED_BY = 'spacecat';
-
-export const SITE_CANDIDATE_SOURCES = {
-  SPACECAT_SLACK_BOT: 'SPACECAT_SLACK_BOT',
-  RUM: 'RUM',
-  CDN: 'CDN',
-};
-
-export const SITE_CANDIDATE_STATUS = {
-  PENDING: 'PENDING', // site candidate notification sent and waiting for human input
-  IGNORED: 'IGNORED', // site candidate discarded: not to be added to star catalogue
-  APPROVED: 'APPROVED', // site candidate is added to star catalogue
-  ERROR: 'ERROR', // site candidate is discovered
-};
-
-/**
- * Creates a new Site Candidate.
- *
- * @param {object} data - site candidate data
- * @returns {Readonly<SiteCandidate>} new site candidate
- */
-const SiteCandidate = (data = {}) => {
-  const self = Base({
-    updatedBy: DEFAULT_UPDATED_BY,
-    ...data,
-  });
-  delete self.state.id; // no id property used in SiteCandidate modal
-
-  self.getBaseURL = () => self.state.baseURL;
-  self.getHlxConfig = () => self.state.hlxConfig;
-  self.getSiteId = () => self.state.siteId;
-  self.getSource = () => self.state.source;
-  self.getStatus = () => self.state.status;
-  self.getUpdatedBy = () => self.state.updatedBy;
-
-  self.setSiteId = (siteId) => {
-    self.state.siteId = siteId;
-    self.touch();
-    return self;
-  };
-
-  self.setHlxConfig = (hlxConfig) => {
-    self.state.hlxConfig = hlxConfig;
-    self.touch();
-    return self;
-  };
-
-  self.setSource = (source) => {
-    self.state.source = source;
-    self.touch();
-    return self;
-  };
-
-  self.setStatus = (status) => {
-    self.state.status = status;
-    self.touch();
-    return self;
-  };
-
-  self.setUpdatedBy = (updatedBy) => {
-    self.state.updatedBy = updatedBy;
-    self.touch();
-    return self;
-  };
-
-  return Object.freeze(self);
-};
-
-/**
- * Creates a new Site Candidate.
- *
- * @param {object} data - site candidate data
- * @returns {Readonly<SiteCandidate>} new site candidate
- */
-export const createSiteCandidate = (data) => {
-  const newState = { ...data };
-
-  if (!isValidUrl(newState.baseURL)) {
-    throw new Error(`Base URL must be a valid URL: ${newState.baseURL}`);
-  }
-
-  if (newState.hlxConfig && !isObject(newState.hlxConfig)) {
-    throw new Error(`HLX Config must be an object: ${newState.hlxConfig}`);
-  }
-
-  if (!newState.hlxConfig) {
-    newState.hlxConfig = {};
-  }
-
-  if (!hasText(newState.updatedBy)) {
-    newState.updatedBy = DEFAULT_UPDATED_BY;
-  }
-
-  return SiteCandidate(newState);
-};

package/src/models/site-top-page.js

@@ -1,62 +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, isInteger, isIsoDate, isValidUrl,
-} from '@adobe/spacecat-shared-utils';
-import { Base } from './base.js';
-
-export const DEFAULT_GEO = 'global';
-
-const SiteTopPage = (data = {}) => {
-  const self = Base(data);
-
-  self.getSiteId = () => self.state.siteId;
-  self.getURL = () => self.state.url;
-  self.getTraffic = () => self.state.traffic;
-  self.getTopKeyword = () => self.state.topKeyword;
-  self.getSource = () => self.state.source.toLowerCase();
-  self.getGeo = () => self.state.geo;
-  self.getImportedAt = () => self.state.importedAt;
-
-  return Object.freeze(self);
-};
-
-export const createSiteTopPage = (data) => {
-  const newState = { ...data };
-
-  if (!hasText(newState.siteId)) {
-    throw new Error('Site ID must be provided');
-  }
-
-  if (!isValidUrl(newState.url)) {
-    throw new Error('Valid Url must be provided');
-  }
-
-  if (!isInteger(newState.traffic)) {
-    throw new Error('Traffic must be provided');
-  }
-
-  if (!hasText(newState.source)) {
-    throw new Error('Source must be provided');
-  }
-
-  if (!hasText(newState.geo)) {
-    newState.geo = DEFAULT_GEO;
-  }
-
-  if (!isIsoDate(newState.importedAt)) {
-    throw new Error('Imported at must be a valid ISO date');
-  }
-
-  return SiteTopPage(newState);
-};

package/src/models/site.js

@@ -1,218 +0,0 @@
-/*
- * 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 { hasText, isObject, isValidUrl } from '@adobe/spacecat-shared-utils';
-
-import { Base } from './base.js';
-import { Config, DEFAULT_CONFIG } from './site/config.js';
-import { DEFAULT_ORGANIZATION_ID } from './organization.js';
-
-export const DELIVERY_TYPES = {
-  AEM_CS: 'aem_cs',
-  AEM_EDGE: 'aem_edge',
-  OTHER: 'other',
-};
-
-export const DEFAULT_DELIVERY_TYPE = DELIVERY_TYPES.AEM_EDGE;
-
-/**
- * Creates a new Site.
- *
- * @param {object} data - site data
- * @returns {Readonly<Site>} site - new site
- */
-const Site = (data = {}) => {
-  const self = Base(data);
-
-  self.getAudits = () => self.state.audits;
-  self.getBaseURL = () => self.state.baseURL;
-  self.getConfig = () => self.state.config;
-  self.getDeliveryType = () => self.state.deliveryType;
-  self.getGitHubURL = () => self.state.gitHubURL;
-  self.getHlxConfig = () => self.state.hlxConfig;
-  self.getOrganizationId = () => self.state.organizationId;
-  self.isLive = () => self.state.isLive;
-  self.getIsLiveToggledAt = () => self.state.isLiveToggledAt;
-
-  // TODO: updating the baseURL is not supported yet, it will require a transact write
-  //  on dynamodb (put then delete) since baseURL is part of the primary key, something like:
-  // const updateSiteBaseURL = async (oldBaseURL, updatedSiteData) => {
-  //   const params = {
-  //     TransactItems: [
-  //       {
-  //         Put: {
-  //           TableName: 'YourSiteTableName',
-  //           Item: updatedSiteData,
-  //         },
-  //       },
-  //       {
-  //         Delete: {
-  //           TableName: 'YourSiteTableName',
-  //           Key: {
-  //             baseURL: oldBaseURL,
-  //           },
-  //         },
-  //       },
-  //     ],
-  //   };
-  //
-  //   await dynamoDbClient.transactWrite(params).promise();
-  //
-  //   return createSite(updatedSiteData);
-  // };
-  /*  self.updateBaseURL = (baseURL) => {
-    if (!isValidUrl(baseURL)) {
-      throw new Error('Base URL must be a valid URL');
-    }
-
-    self.state.baseURL = baseURL;
-    self.touch();
-
-    return self;
-  }; */
-
-  /**
-   * Updates the site config.
-   * @param {string} config - The Site config.
-   * @return {Base} The updated site.
-   */
-  self.updateConfig = (config) => {
-    if (!isObject(config)) {
-      throw new Error('Config must be provided');
-    }
-
-    self.state.config = Config(config);
-    self.touch();
-
-    return self;
-  };
-
-  self.updateDeliveryType = (deliveryType) => {
-    if (!Object.values(DELIVERY_TYPES).includes(deliveryType)) {
-      throw new Error(`Invalid delivery type: ${deliveryType}`);
-    }
-
-    self.state.deliveryType = deliveryType;
-    self.touch();
-
-    return self;
-  };
-
-  /**
-   * Updates the GitHub URL belonging to the site.
-   * @param {string} gitHubURL - The GitHub URL.
-   * @return {Base} The updated site.
-   */
-  self.updateGitHubURL = (gitHubURL) => {
-    if (!isValidUrl(gitHubURL)) {
-      throw new Error('GitHub URL must be a valid URL');
-    }
-
-    self.state.gitHubURL = gitHubURL;
-    self.touch();
-
-    return self;
-  };
-
-  /**
-   * Updates the Helix Configuration for this site.
-   * @param {object} hlxConfig - The Helix Configuration.
-   * @throws {Error} If the provided Helix Configuration is not an object.
-   * @return {Base} The updated site.
-   */
-  self.updateHlxConfig = (hlxConfig) => {
-    if (!isObject(hlxConfig)) {
-      throw new Error('HLX Config must be an object');
-    }
-
-    self.state.hlxConfig = hlxConfig;
-    self.touch();
-
-    return self;
-  };
-
-  /**
-   * Updates the organizationId the site belongs to.
-   * @param {string} organizationId - The Org ID.
-   * @return {Base} The updated site.
-   */
-  self.updateOrganizationId = (organizationId) => {
-    self.state.organizationId = organizationId;
-    self.touch();
-
-    return self;
-  };
-
-  self.setAudits = (audits) => {
-    self.state.audits = audits;
-    return self;
-  };
-
-  /**
-   * Sets whether the site is live.
-   * @return {Base} The updated site.
-   */
-  self.toggleLive = () => {
-    self.state.isLive = !self.state.isLive;
-    self.state.isLiveToggledAt = new Date().toISOString();
-    return self;
-  };
-
-  return Object.freeze(self);
-};
-
-/**
- * Creates a new Site.
- *
- * @param {object} data - site data
- * @returns {Readonly<Site>} site - new site
- */
-export const createSite = (data) => {
-  const newState = { ...data };
-
-  if (!isValidUrl(newState.baseURL)) {
-    throw new Error(`Base URL must be a valid URL: ${newState.baseURL}`);
-  }
-
-  if (newState.hlxConfig && !isObject(newState.hlxConfig)) {
-    throw new Error(`HLX Config must be an object: ${newState.hlxConfig}`);
-  }
-
-  if (!newState.hlxConfig) {
-    newState.hlxConfig = {};
-  }
-
-  if (!hasText(newState.organizationId)) {
-    newState.organizationId = DEFAULT_ORGANIZATION_ID;
-  }
-
-  newState.deliveryType = newState.deliveryType || DEFAULT_DELIVERY_TYPE;
-  if (!Object.values(DELIVERY_TYPES).includes(newState.deliveryType)) {
-    throw new Error(`Invalid delivery type: ${newState.deliveryType}`);
-  }
-
-  if (!Object.prototype.hasOwnProperty.call(newState, 'isLive')) {
-    newState.isLive = false;
-  }
-
-  if (!Array.isArray(newState.audits)) {
-    newState.audits = [];
-  }
-
-  if (!isObject(newState.config)) {
-    newState.config = { ...DEFAULT_CONFIG };
-  }
-
-  newState.config = Config(newState.config);
-
-  return Site(newState);
-};