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

package/src/dto/key-event.js

@@ -1,52 +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 { createKeyEvent } from '../models/key-event.js';
-
-/**
- * Data transfer object for Key Event.
- */
-export const KeyEventDto = {
-  /**
-     * Converts a DynamoDB item into a KeyEvent object.
-     * @param {object } dynamoItem - DynamoDB item.
-     * @returns {Readonly<KeyEvent>} KeyEvent object.
-     */
-  fromDynamoItem: (dynamoItem) => {
-    const keyEventData = {
-      id: dynamoItem.id,
-      siteId: dynamoItem.siteId,
-      name: dynamoItem.name,
-      type: dynamoItem.type,
-      time: dynamoItem.time,
-      createdAt: dynamoItem.createdAt,
-      updatedAt: dynamoItem.updatedAt,
-    };
-
-    return createKeyEvent(keyEventData);
-  },
-
-  /**
-     * Converts a KeyEvent object into a DynamoDB item.
-     * @param {Readonly<KeyEvent>} keyEvent - KeyEvent object.
-     * @returns {object} DynamoDB item.
-     */
-  toDynamoItem: (keyEvent) => ({
-    id: keyEvent.getId(),
-    siteId: keyEvent.getSiteId(),
-    name: keyEvent.getName(),
-    type: keyEvent.getType(),
-    time: keyEvent.getTime(),
-    createdAt: keyEvent.getCreatedAt(),
-    updatedAt: keyEvent.getUpdatedAt(),
-  }),
-};

package/src/dto/organization.js

@@ -1,54 +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 { Config } from '../models/site/config.js';
-import { createOrganization } from '../models/organization.js';
-
-/**
- * Data transfer object for Organization.
- */
-export const OrganizationDto = {
-  /**
-     * Converts an Organization object into a DynamoDB item.
-     * @param {Readonly<Organization>} organization - Organization object.
-     * @returns {{createdAt, baseURL, GSI1PK: string, id, imsOrgId, updatedAt}}
-     */
-  toDynamoItem: (organization) => ({
-    id: organization.getId(),
-    name: organization.getName(),
-    imsOrgId: organization.getImsOrgId(),
-    createdAt: organization.getCreatedAt(),
-    updatedAt: organization.getUpdatedAt(),
-    GSI1PK: 'ALL_ORGANIZATIONS',
-    config: Config.toDynamoItem(organization.getConfig()),
-    fulfillableItems: organization.getFulfillableItems(),
-  }),
-
-  /**
-     * Converts a DynamoDB item into a Organization object.
-     * @param {object } dynamoItem - DynamoDB item.
-     * @returns {Readonly<Organization>} Organization object.
-     */
-  fromDynamoItem: (dynamoItem) => {
-    const organizationData = {
-      id: dynamoItem.id,
-      name: dynamoItem.name,
-      imsOrgId: dynamoItem.imsOrgId,
-      createdAt: dynamoItem.createdAt,
-      updatedAt: dynamoItem.updatedAt,
-      config: dynamoItem.config,
-      fulfillableItems: dynamoItem.fulfillableItems,
-    };
-
-    return createOrganization(organizationData);
-  },
-};

package/src/dto/site-candidate.js

@@ -1,54 +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 { createSiteCandidate } from '../models/site-candidate.js';
-
-/**
- * Data transfer object for Site Candidate.
- */
-export const SiteCandidateDto = {
-  /**
-   * Converts a Site Candidate object into a DynamoDB item.
-   * @param {Readonly<SiteCandidate>} siteCandidate - Site Candidate object.
-   * @returns {{baseURL, siteId, source, status, createdAt, updatedAt, updatedBy}}
-   */
-  toDynamoItem: (siteCandidate) => ({
-    baseURL: siteCandidate.getBaseURL(),
-    hlxConfig: siteCandidate.getHlxConfig(),
-    siteId: siteCandidate.getSiteId(),
-    source: siteCandidate.getSource(),
-    status: siteCandidate.getStatus(),
-    createdAt: siteCandidate.getCreatedAt(),
-    updatedAt: siteCandidate.getUpdatedAt(),
-    updatedBy: siteCandidate.getUpdatedBy(),
-  }),
-
-  /**
-   * Converts a DynamoDB item into Site Candidate object;
-   * @param {object } dynamoItem - DynamoDB item.
-   * @returns {Readonly<SiteCandidate>} SiteCandidate object.
-   */
-  fromDynamoItem: (dynamoItem) => {
-    const siteCandidateData = {
-      baseURL: dynamoItem.baseURL,
-      hlxConfig: dynamoItem.hlxConfig,
-      siteId: dynamoItem.siteId,
-      source: dynamoItem.source,
-      status: dynamoItem.status,
-      createdAt: dynamoItem.createdAt,
-      updatedAt: dynamoItem.updatedAt,
-      updatedBy: dynamoItem.updatedBy,
-    };
-
-    return createSiteCandidate(siteCandidateData);
-  },
-};

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

@@ -1,52 +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 { createSiteTopPage } from '../models/site-top-page.js';
-
-export function padWithZeros(number) {
-  return String(number).padStart(12, '0');
-}
-
-export const SiteTopPageDto = {
-/**
-   * Converts a SiteTopPage object into a DynamoDB item.
-   * @param {Readonly<SiteTopPage>} siteTopPage - SiteTopPage object.
-   * @returns {{siteId, url, traffic, source, geo, importedAt, SK: string}}
-   */
-  toDynamoItem: (siteTopPage) => ({
-    siteId: siteTopPage.getSiteId(),
-    url: siteTopPage.getURL(),
-    traffic: siteTopPage.getTraffic(),
-    topKeyword: siteTopPage.getTopKeyword(),
-    source: siteTopPage.getSource(),
-    geo: siteTopPage.getGeo(),
-    importedAt: siteTopPage.getImportedAt(),
-    SK: `${siteTopPage.getSource()}#${siteTopPage.getGeo()}#${padWithZeros(siteTopPage.getTraffic())}`,
-  }),
-
-  /**
-   * Converts a DynamoDB item into a SiteTopPage object.
-   * @param {
-   *   {siteId, url, traffic, topKeyword, source, geo, importedAt, SK: string}
-   * } item - DynamoDB item.
-   * @returns {SiteTopPage}
-   */
-  fromDynamoItem: (item) => createSiteTopPage({
-    siteId: item.siteId,
-    url: item.url,
-    traffic: item.traffic,
-    topKeyword: item.topKeyword,
-    source: item.source,
-    geo: item.geo,
-    importedAt: item.importedAt,
-  }),
-};

package/src/dto/site.js

@@ -1,62 +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 { createSite } from '../models/site.js';
-import { Config } from '../models/site/config.js';
-
-/**
- * Data transfer object for Site.
- */
-export const SiteDto = {
-  /**
-   * Converts a Site object into a DynamoDB item.
-   * @param {Readonly<Site>} site - Site object.
-   * @returns {{createdAt, baseURL, GSI1PK: string, id, organizationId, updatedAt}}
-   */
-  toDynamoItem: (site) => ({
-    id: site.getId(),
-    baseURL: site.getBaseURL(),
-    deliveryType: site.getDeliveryType(),
-    gitHubURL: site.getGitHubURL() || '',
-    hlxConfig: site.getHlxConfig(),
-    organizationId: site.getOrganizationId() || '',
-    isLive: site.isLive(),
-    isLiveToggledAt: site.getIsLiveToggledAt(),
-    createdAt: site.getCreatedAt(),
-    updatedAt: site.getUpdatedAt(),
-    GSI1PK: 'ALL_SITES',
-    config: Config.toDynamoItem(site.getConfig()),
-  }),
-
-  /**
-   * Converts a DynamoDB item into a Site object.
-   * @param {object } dynamoItem - DynamoDB item.
-   * @returns {Readonly<Site>} Site object.
-   */
-  fromDynamoItem: (dynamoItem) => {
-    const siteData = {
-      id: dynamoItem.id,
-      baseURL: dynamoItem.baseURL,
-      deliveryType: dynamoItem.deliveryType,
-      gitHubURL: dynamoItem.gitHubURL,
-      hlxConfig: dynamoItem.hlxConfig,
-      organizationId: dynamoItem.organizationId,
-      isLive: dynamoItem.isLive,
-      isLiveToggledAt: dynamoItem.isLiveToggledAt,
-      createdAt: dynamoItem.createdAt,
-      updatedAt: dynamoItem.updatedAt,
-      config: dynamoItem.config,
-    };
-
-    return createSite(siteData);
-  },
-};

package/src/models/api-key/api-key.js

@@ -1,182 +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, isObject, isValidUrl,
-} from '@adobe/spacecat-shared-utils';
-import { Base } from '../base.js';
-
-// List of known scope names that can be used with scoped API keys
-const scopeNames = [
-  'sites.read_all',
-  'sites.write_all',
-  'organizations.read_all',
-  'organizations.write_all',
-  'audits.read_all',
-  'audits.write_all',
-  'imports.read',
-  'imports.write',
-  'imports.delete',
-  'imports.read_all',
-  'imports.all_domains',
-  'imports.assistant',
-];
-
-const ApiKey = (data) => {
-  const self = Base(data);
-
-  self.getHashedApiKey = () => self.state.hashedApiKey;
-  self.getName = () => self.state.name;
-  self.getImsUserId = () => self.state.imsUserId;
-  self.getImsOrgId = () => self.state.imsOrgId;
-  self.getCreatedAt = () => self.state.createdAt;
-  self.getExpiresAt = () => self.state.expiresAt;
-  self.getRevokedAt = () => self.state.revokedAt;
-  self.getDeletedAt = () => self.state.deletedAt;
-  self.getScopes = () => self.state.scopes;
-
-  /**
-   * Checks if the apiKey is valid.
-   * @returns {boolean} True if the apiKey is valid, false otherwise
-   */
-  self.isValid = () => {
-    const now = new Date();
-
-    if (self.state.deletedAt && new Date(self.state.deletedAt) < now) {
-      return false;
-    }
-
-    if (self.state.revokedAt && new Date(self.state.revokedAt) < now) {
-      return false;
-    }
-
-    if (self.state.expiresAt && new Date(self.state.expiresAt) < now) {
-      return false;
-    }
-
-    return true;
-  };
-
-  /**
-   * Updates the state of the ApiKey.
-   * @param key - The key to update.
-   * @param value - The new value.
-   * @param validator - An optional validation function to use before updating the value.
-   * @returns {ApiKey} The updated ApiKey object.
-   */
-  const updateState = (key, value, validator) => {
-    if (validator && typeof validator === 'function') {
-      validator(value);
-    }
-
-    self.state[key] = value;
-    self.touch();
-
-    return self;
-  };
-
-  /**
-   * Updates the deletedAt attribute of the ApiKey.
-   * @param {string} deletedAt - The deletedAt timestamp - ISO 8601 date string.
-   */
-  self.updateDeletedAt = (deletedAt) => updateState('deletedAt', deletedAt, (value) => {
-    if (!isIsoDate(value)) {
-      throw new Error(`Invalid deletedAt during update: ${value}. Must be a valid ISO 8601 date string.`);
-    }
-  });
-
-  /**
-   * Updates the expiresAt attribute of the ApiKey.
-   * @param {string} expiresAt - The expiresAt timestamp - ISO 8601 date string.
-   */
-  self.updateExpiresAt = (expiresAt) => updateState('expiresAt', expiresAt, (value) => {
-    if (!isIsoDate(value)) {
-      throw new Error(`Invalid expiresAt during update: ${value}. Must be a valid ISO 8601 date string.`);
-    }
-  });
-
-  /**
-   * Updates the revokedAt attribute of the ApiKey.
-   * @param {string} revokedAt - The revokedAt timestamp - ISO 8601 date string.
-   */
-  self.updateRevokedAt = (revokedAt) => updateState('revokedAt', revokedAt, (value) => {
-    if (!isIsoDate(value)) {
-      throw new Error(`Invalid revokedAt during update: ${value}. Must be a valid ISO 8601 date string.`);
-    }
-  });
-
-  return Object.freeze(self);
-};
-
-/**
- * Creates a new ApiKey object.
- * @param {Object} apiKeyData - The data for the ApiKey object.
- * @returns {ApiKey} The new ApiKey object.
- */
-export const createApiKey = (apiKeyData) => {
-  const newState = { ...apiKeyData };
-
-  if (!hasText(newState.hashedApiKey)) {
-    throw new Error(`Invalid Hashed API Key: ${newState.hashedApiKey}`);
-  }
-
-  if (!hasText(newState.name)) {
-    throw new Error(`Invalid Name: ${newState.name}`);
-  }
-
-  if (hasText(newState.createdAt) && !isIsoDate(newState.createdAt)) {
-    throw new Error(`createdAt should be a valid ISO 8601 string: ${newState.createdAt}`);
-  }
-
-  if (!hasText(newState.createdAt)) {
-    newState.createdAt = new Date().toISOString();
-  }
-
-  if (hasText(newState.expiresAt) && !isIsoDate(newState.expiresAt)) {
-    throw new Error(`expiresAt should be a valid ISO 8601 string: ${newState.expiresAt}`);
-  }
-
-  if (hasText(newState.revokedAt) && !isIsoDate(newState.revokedAt)) {
-    throw new Error(`revokedAt should be a valid ISO 8601 string: ${newState.revokedAt}`);
-  }
-
-  if (!Array.isArray(newState.scopes)) {
-    throw new Error(`Invalid scopes: ${newState.scopes}`);
-  }
-
-  for (const scope of newState.scopes) {
-    if (!isObject(scope)) {
-      throw new Error(`Invalid scope: ${scope}`);
-    }
-
-    if (!hasText(scope.name)) {
-      throw new Error(`Invalid scope name: ${scope.name}`);
-    }
-
-    if (!scopeNames.includes(scope.name)) {
-      throw new Error(`Scope name is not part of the pre-defined scopes: ${scope.name}`);
-    }
-
-    if (scope.domains) {
-      if (!Array.isArray(scope.domains)) {
-        throw new Error(`Scope domains should be an array: ${scope.domains}`);
-      }
-      for (const domain of scope.domains) {
-        if (!isValidUrl(domain)) {
-          throw new Error(`Invalid domain: ${domain}`);
-        }
-      }
-    }
-  }
-
-  return ApiKey(newState);
-};

package/src/models/audit.js

@@ -1,146 +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, isIsoDate, isObject } from '@adobe/spacecat-shared-utils';
-import { Base } from './base.js';
-
-// some of these unused exports are being imported from other projects. Handle with care.
-export const AUDIT_TYPE_404 = '404';
-export const AUDIT_TYPE_BROKEN_BACKLINKS = 'broken-backlinks';
-export const AUDIT_TYPE_EXPERIMENTATION = 'experimentation';
-export const AUDIT_TYPE_ORGANIC_KEYWORDS = 'organic-keywords';
-export const AUDIT_TYPE_ORGANIC_TRAFFIC = 'organic-traffic';
-export const AUDIT_TYPE_CWV = 'cwv';
-export const AUDIT_TYPE_LHS_DESKTOP = 'lhs-desktop';
-export const AUDIT_TYPE_LHS_MOBILE = 'lhs-mobile';
-export const AUDIT_TYPE_EXPERIMENTATION_ESS_MONTHLY = 'experimentation-ess-monthly';
-export const AUDIT_TYPE_EXPERIMENTATION_ESS_DAILY = 'experimentation-ess-daily';
-
-const EXPIRES_IN_DAYS = 30 * 6;
-
-const AUDIT_TYPE_PROPERTIES = {
-  [AUDIT_TYPE_LHS_DESKTOP]: ['performance', 'seo', 'accessibility', 'best-practices'],
-  [AUDIT_TYPE_LHS_MOBILE]: ['performance', 'seo', 'accessibility', 'best-practices'],
-};
-
-/**
- * Validates if the auditResult contains the required properties for the given audit type.
- * @param {object} auditResult - The audit result to validate.
- * @param {string} auditType - The type of the audit.
- * @returns {boolean} - True if valid, false otherwise.
- */
-const validateScores = (auditResult, auditType) => {
-  if (isObject(auditResult.runtimeError)) {
-    return true;
-  }
-
-  if ((auditType === AUDIT_TYPE_LHS_DESKTOP || auditType === AUDIT_TYPE_LHS_MOBILE)
-      && !isObject(auditResult.scores)) {
-    throw new Error(`Missing scores property for audit type '${auditType}'`);
-  }
-
-  const expectedProperties = AUDIT_TYPE_PROPERTIES[auditType];
-
-  if (expectedProperties) {
-    for (const prop of expectedProperties) {
-      if (!(prop in auditResult.scores)) {
-        throw new Error(`Missing expected property '${prop}' for audit type '${auditType}'`);
-      }
-    }
-  }
-
-  return true;
-};
-
-/**
- * Creates a new Audit.
- * @param {object } data - audit data
- * @returns {Readonly<Audit>} audit - new audit
- */
-const Audit = (data = {}) => {
-  const self = Base(data);
-
-  self.getSiteId = () => self.state.siteId;
-  self.getAuditedAt = () => self.state.auditedAt;
-  self.getAuditResult = () => self.state.auditResult;
-  self.getAuditType = () => self.state.auditType.toLowerCase();
-  self.getExpiresAt = () => self.state.expiresAt;
-  self.getFullAuditRef = () => self.state.fullAuditRef;
-  self.isLive = () => self.state.isLive;
-  self.isError = () => hasText(self.getAuditResult().runtimeError?.code);
-  self.getPreviousAuditResult = () => self.state.previousAuditResult;
-  self.setPreviousAuditResult = (previousAuditResult) => {
-    validateScores(previousAuditResult, self.getAuditType());
-    self.state.previousAuditResult = previousAuditResult;
-  };
-  self.getScores = () => self.getAuditResult().scores;
-
-  return Object.freeze(self);
-};
-
-function isValidAuditResult(auditResult) {
-  return isObject(auditResult) || Array.isArray(auditResult);
-}
-
-/**
- * Creates a new Audit.
- *
- * @param {object} data - audit data
- * @returns {Readonly<Audit>} audit - new audit
- */
-export const createAudit = (data) => {
-  const newState = { ...data };
-
-  if (!hasText(newState.siteId)) {
-    throw new Error('Site ID must be provided');
-  }
-
-  if (!isIsoDate(newState.auditedAt)) {
-    throw new Error('Audited at must be a valid ISO date');
-  }
-
-  if (!hasText(newState.auditType)) {
-    throw new Error('Audit type must be provided');
-  }
-
-  if (!isValidAuditResult(newState.auditResult)) {
-    throw new Error('Audit result must be an object or an array');
-  }
-
-  if (!newState.auditResult.scores) {
-    newState.auditResult.scores = {};
-  }
-  validateScores(data.auditResult, data.auditType);
-
-  if (data.previousAuditResult && !isValidAuditResult(data.previousAuditResult)) {
-    throw new Error('Previous audit result must be an object or an array');
-  }
-
-  if (data.previousAuditResult) {
-    validateScores(data.previousAuditResult, data.auditType);
-  }
-
-  if (!hasText(newState.fullAuditRef)) {
-    throw new Error('Full audit ref must be provided');
-  }
-
-  if (!newState.expiresAt) {
-    newState.expiresAt = new Date(newState.auditedAt);
-    newState.expiresAt.setDate(newState.expiresAt.getDate() + EXPIRES_IN_DAYS);
-  }
-
-  if (!Object.prototype.hasOwnProperty.call(newState, 'isLive')) {
-    newState.isLive = false;
-  }
-
-  return Audit(newState);
-};

package/src/models/base.js

@@ -1,42 +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 { v4 as uuidv4 } from 'uuid';
-import { isString } from '@adobe/spacecat-shared-utils';
-
-/**
- * Base model.
- *
- * @param {object} data data
- * @returns {Base} base model
- */
-export const Base = (data = {}) => {
-  const self = { state: { ...data } };
-  const newRecord = !isString(self.state.id);
-  const nowISO = new Date().toISOString();
-
-  if (newRecord) {
-    self.state.id = uuidv4();
-    self.state.createdAt = nowISO;
-    self.state.updatedAt = nowISO;
-  }
-
-  self.getId = () => self.state.id;
-  self.getCreatedAt = () => self.state.createdAt;
-  self.getUpdatedAt = () => self.state.updatedAt;
-
-  self.touch = () => {
-    self.state.updatedAt = new Date().toISOString();
-  };
-
-  return self;
-};