@adobe/spacecat-shared-data-access 1.59.2 → 1.60.0

package/src/v2/models/configuration/index.js

@@ -0,0 +1,19 @@
+/*
+ * 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 Configuration from './configuration.model.js';
+import ConfigurationCollection from './configuration.collection.js';
+
+export {
+  Configuration,
+  ConfigurationCollection,
+};

package/src/v2/models/experiment/experiment.collection.js

@@ -0,0 +1,26 @@
+/*
+ * 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 BaseCollection from '../base/base.collection.js';
+
+/**
+ * ExperimentCollection - A collection class responsible for managing Experiment entities.
+ * Extends the BaseCollection to provide specific methods for interacting with Experiment records.
+ *
+ * @class ExperimentCollection
+ * @extends BaseCollection
+ */
+class ExperimentCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default ExperimentCollection;

package/src/v2/models/experiment/experiment.model.js

@@ -0,0 +1,28 @@
+/*
+ * 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 BaseModel from '../base/base.model.js';
+
+export const DEFAULT_UPDATED_BY = 'spacecat';
+
+/**
+ * Experiment - A class representing an Experiment entity.
+ * Provides methods to access and manipulate Experiment-specific data.
+ *
+ * @class Experiment
+ * @extends BaseModel
+ */
+class Experiment extends BaseModel {
+  // add your custom methods or overrides here
+}
+
+export default Experiment;

package/src/v2/models/experiment/experiment.schema.js

@@ -0,0 +1,70 @@
+/*
+ * 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.
+ */
+
+/* c8 ignore start */
+
+import { isIsoDate, isNonEmptyObject, isValidUrl } from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import Experiment, { DEFAULT_UPDATED_BY } from './experiment.model.js';
+import ExperimentCollection from './experiment.collection.js';
+
+/*
+Schema Doc: https://electrodb.dev/en/modeling/schema/
+Attribute Doc: https://electrodb.dev/en/modeling/attributes/
+Indexes Doc: https://electrodb.dev/en/modeling/indexes/
+ */
+
+const schema = new SchemaBuilder(Experiment, ExperimentCollection)
+  .addReference('belongs_to', 'Site', ['expId', 'url', 'updatedAt'])
+  .addAttribute('conversionEventName', {
+    type: 'string',
+  })
+  .addAttribute('conversionEventValue', { type: 'string' })
+  .addAttribute('endDate', {
+    type: 'string',
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('expId', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('name', { type: 'string' })
+  .addAttribute('startDate', {
+    type: 'string',
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('status', {
+    type: ['ACTIVE', 'INACTIVE'],
+    required: true,
+  })
+  .addAttribute('type', { type: 'string' })
+  .addAttribute('url', {
+    type: 'string',
+    required: true,
+    validate: (value) => isValidUrl(value),
+  })
+  .addAttribute('updatedBy', {
+    type: 'string',
+    required: true,
+    default: DEFAULT_UPDATED_BY,
+  })
+  .addAttribute('variants', {
+    type: 'list',
+    items: {
+      type: 'any',
+      validate: (value) => isNonEmptyObject(value),
+    },
+    required: true,
+  });
+
+export default schema.build();

package/src/v2/models/experiment/index.d.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 type { BaseCollection, BaseModel, Site } from '../index';
+
+export interface Experiment extends BaseModel {
+  getConversionEventName(): string;
+  getConversionEventValue(): string;
+  getEndDate(): number;
+  getExpId(): string;
+  getName(): string;
+  getSite(): Promise<Site>;
+  getSiteId(): string;
+  getStartDate(): number;
+  getStatus(): string;
+  getType(): string;
+  getUrl(): string;
+  getVariants(): object;
+  setConversionEventName(conversionEventName: string): Experiment;
+  setConversionEventValue(conversionEventValue: string): Experiment;
+  setEndDate(endDate: number): Experiment;
+  setExpId(expId: string): Experiment;
+  setName(name: string): Experiment;
+  setStartDate(startDate: number): Experiment;
+  setStatus(status: string): Experiment;
+  setType(type: string): Experiment;
+  setUrl(url: string): Experiment;
+  setVariants(variants: object): Experiment;
+}
+
+export interface ExperimentCollection extends BaseCollection<Experiment> {
+  allBySiteId(siteId: string): Promise<Experiment[]>;
+  allBySiteIdAndExpId(siteId: string, expId: string): Promise<Experiment[]>;
+  findBySiteIdAndExpId(siteId: string, expId: string): Promise<Experiment | null>;
+  findBySiteIdAndExpIdAndUrl(
+    siteId: string,
+    expId: string,
+    url: string,
+  ): Promise<Experiment | null>;
+}

package/src/v2/models/experiment/index.js

@@ -0,0 +1,19 @@
+/*
+ * 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 Experiment from './experiment.model.js';
+import ExperimentCollection from './experiment.collection.js';
+
+export {
+  Experiment,
+  ExperimentCollection,
+};

package/src/v2/models/import-job/import-job.collection.js

@@ -0,0 +1,45 @@
+/*
+ * 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 { isIsoDate } from '@adobe/spacecat-shared-utils';
+
+import BaseCollection from '../base/base.collection.js';
+import { ValidationError } from '../../errors/index.js';
+
+/**
+ * ImportJobCollection - A collection class responsible for managing ImportJob entities.
+ * Extends the BaseCollection to provide specific methods for interacting with ImportJob records.
+ *
+ * @class ImportJobCollection
+ * @extends BaseCollection
+ */
+class ImportJobCollection extends BaseCollection {
+  async allByDateRange(startDate, endDate) {
+    if (!isIsoDate(startDate)) {
+      throw new ValidationError(`Invalid start date: ${startDate}`);
+    }
+
+    if (!isIsoDate(endDate)) {
+      throw new ValidationError(`Invalid end date: ${endDate}`);
+    }
+
+    return this.all({}, {
+      between: {
+        attribute: 'startedAt',
+        start: startDate,
+        end: endDate,
+      },
+    });
+  }
+}
+
+export default ImportJobCollection;

package/src/v2/models/import-job/import-job.model.js

@@ -0,0 +1,55 @@
+/*
+ * 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 BaseModel from '../base/base.model.js';
+
+/**
+ * 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,
+};
+
+/**
+ * ImportJob - A class representing an ImportJob entity.
+ * Provides methods to access and manipulate ImportJob-specific data.
+ *
+ * @class ImportJob
+ * @extends BaseModel
+ */
+class ImportJob extends BaseModel {
+  // add your custom methods or overrides here
+}
+
+export default ImportJob;

package/src/v2/models/import-job/import-job.schema.js

@@ -0,0 +1,152 @@
+/*
+ * 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.
+ */
+
+/* c8 ignore start */
+
+import {
+  isInteger,
+  isIsoDate,
+  isNumber,
+  isObject,
+  isValidUrl,
+} from '@adobe/spacecat-shared-utils';
+
+import SchemaBuilder from '../base/schema.builder.js';
+import ImportJob, { ImportJobStatus, ImportOptions } from './import-job.model.js';
+import ImportJobCollection from './import-job.collection.js';
+
+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 validateOptions = (options) => {
+  if (!isObject(options)) {
+    throw new Error(`Invalid options: ${options}`);
+  }
+
+  const invalidOptions = Object.keys(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(options).forEach((key) => {
+    if (ImportOptionTypeValidator[key]) {
+      ImportOptionTypeValidator[key](options[key]);
+    }
+  });
+
+  return true;
+};
+
+/*
+Schema Doc: https://electrodb.dev/en/modeling/schema/
+Attribute Doc: https://electrodb.dev/en/modeling/attributes/
+Indexes Doc: https://electrodb.dev/en/modeling/indexes/
+ */
+
+const schema = new SchemaBuilder(ImportJob, ImportJobCollection)
+  .addReference('has_many', 'ImportUrls')
+  .addAttribute('baseURL', {
+    type: 'string',
+    required: true,
+    validate: (value) => isValidUrl(value),
+  })
+  .addAttribute('duration', {
+    type: 'number',
+    default: 0,
+    validate: (value) => !value || isNumber(value),
+  })
+  .addAttribute('endedAt', {
+    type: 'string',
+    validate: (value) => !value || isIsoDate(value),
+  })
+  .addAttribute('failedCount', {
+    type: 'number',
+    default: 0,
+    validate: (value) => !value || isInteger(value),
+  })
+  .addAttribute('hasCustomHeaders', {
+    type: 'boolean',
+    default: false,
+  })
+  .addAttribute('hasCustomImportJs', {
+    type: 'boolean',
+    default: false,
+  })
+  .addAttribute('hashedApiKey', {
+    type: 'string',
+    required: true,
+  })
+  .addAttribute('importQueueId', {
+    type: 'string',
+  })
+  .addAttribute('initiatedBy', {
+    type: 'map',
+    properties: {
+      apiKeyName: { type: 'string' },
+      imsOrgId: { type: 'string' },
+      imsUserId: { type: 'string' },
+      userAgent: { type: 'string' },
+    },
+  })
+  .addAttribute('options', {
+    type: 'any',
+    validate: (value) => !value || validateOptions(value),
+  })
+  .addAttribute('redirectCount', {
+    type: 'number',
+    default: 0,
+    validate: (value) => !value || isInteger(value),
+  })
+  .addAttribute('status', {
+    type: Object.values(ImportJobStatus),
+    required: true,
+  })
+  .addAttribute('startedAt', {
+    type: 'string',
+    required: true,
+    readOnly: true,
+    default: () => new Date().toISOString(),
+    validate: (value) => isIsoDate(value),
+  })
+  .addAttribute('successCount', {
+    type: 'number',
+    default: 0,
+    validate: (value) => !value || isInteger(value),
+  })
+  .addAttribute('urlCount', {
+    type: 'number',
+    default: 0,
+    validate: (value) => !value || isInteger(value),
+  })
+  .addAllIndexWithComposite('startedAt')
+  .addIndex(
+    'byStatus',
+    { composite: ['status'] },
+    { composite: ['updatedAt'] },
+  );
+
+export default schema.build();

package/src/v2/models/import-job/index.d.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 type { BaseCollection, BaseModel } from '../base';
+
+export interface ImportJob extends BaseModel {
+  getBaseURL(): string,
+  getDuration(): number,
+  getEndedAt(): number,
+  getFailedCount(): number,
+  getHasCustomHeaders(): boolean,
+  getHasCustomImportJs(): boolean,
+  getHashedApiKey(): string,
+  getImportQueueId(): string,
+  getInitiatedBy(): string,
+  getOptions(): string,
+  getRedirectCount(): number,
+  getStatus(): string,
+  getStartedAt(): number,
+  getSuccessCount(): number,
+  getUrlCount(): number,
+  setBaseURL(baseURL: string): void,
+  setDuration(duration: number): void,
+  setEndedAt(endTime: number): void,
+  setFailedCount(failedCount: number): void,
+  setHasCustomHeaders(hasCustomHeaders: boolean): void,
+  setHasCustomImportJs(hasCustomImportJs: boolean): void,
+  setHashedApiKey(hashedApiKey: string): void,
+  setImportQueueId(importQueueId: string): void,
+  setInitiatedBy(initiatedBy: string): void,
+  setOptions(options: string): void,
+  setRedirectCount(redirectCount: number): void,
+  setStatus(status: string): void,
+  setStartedAt(startTime: number): void,
+  setSuccessCount(successCount: number): void,
+  setUrlCount(urlCount: number): void,
+}
+
+export interface ImportJobCollection extends BaseCollection<ImportJob> {
+  allByDateRange(startDate: number, endDate: number): Promise<ImportJob[]>;
+  allByStatus(status: string): Promise<ImportJob[]>;
+}

package/src/v2/models/import-job/index.js

@@ -0,0 +1,19 @@
+/*
+ * 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 ImportJob from './import-job.model.js';
+import ImportJobCollection from './import-job.collection.js';
+
+export {
+  ImportJob,
+  ImportJobCollection,
+};

package/src/v2/models/import-url/import-url.collection.js

@@ -0,0 +1,26 @@
+/*
+ * 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 BaseCollection from '../base/base.collection.js';
+
+/**
+ * ImportUrlCollection - A collection class responsible for managing ImportUrl entities.
+ * Extends the BaseCollection to provide specific methods for interacting with ImportUrl records.
+ *
+ * @class ImportUrlCollection
+ * @extends BaseCollection
+ */
+class ImportUrlCollection extends BaseCollection {
+  // add custom methods here
+}
+
+export default ImportUrlCollection;

package/src/v2/models/import-url/import-url.model.js

@@ -0,0 +1,28 @@
+/*
+ * 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 BaseModel from '../base/base.model.js';
+
+export const IMPORT_URL_EXPIRES_IN_DAYS = 30;
+
+/**
+ * ImportUrl - A class representing an ImportUrl entity.
+ * Provides methods to access and manipulate ImportUrl-specific data.
+ *
+ * @class ImportUrl
+ * @extends BaseModel
+ */
+class ImportUrl extends BaseModel {
+  // add your custom methods or overrides here
+}
+
+export default ImportUrl;

package/src/v2/models/import-url/import-url.schema.js

@@ -0,0 +1,59 @@
+/*
+ * 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.
+ */
+
+/* c8 ignore start */
+
+import { isIsoDate, isValidUrl } from '@adobe/spacecat-shared-utils';
+
+import { ImportUrlStatus } from '../import-job/import-job.model.js';
+import SchemaBuilder from '../base/schema.builder.js';
+import ImportUrl, { IMPORT_URL_EXPIRES_IN_DAYS } from './import-url.model.js';
+import ImportUrlCollection from './import-url.collection.js';
+
+/*
+Schema Doc: https://electrodb.dev/en/modeling/schema/
+Attribute Doc: https://electrodb.dev/en/modeling/attributes/
+Indexes Doc: https://electrodb.dev/en/modeling/indexes/
+ */
+
+const schema = new SchemaBuilder(ImportUrl, ImportUrlCollection)
+  .addReference('belongs_to', 'ImportJob', ['status'])
+  .addAttribute('expiresAt', {
+    type: 'string',
+    required: true,
+    validate: (value) => isIsoDate(value),
+    default: () => {
+      const date = new Date();
+      date.setDate(date.getDate() + IMPORT_URL_EXPIRES_IN_DAYS);
+      return date.toISOString();
+    },
+  })
+  .addAttribute('file', {
+    type: 'string',
+  })
+  .addAttribute('path', {
+    type: 'string',
+  })
+  .addAttribute('reason', {
+    type: 'string',
+  })
+  .addAttribute('status', {
+    type: Object.values(ImportUrlStatus),
+    required: true,
+  })
+  .addAttribute('url', {
+    type: 'string',
+    required: true,
+    validate: (value) => isValidUrl(value),
+  });
+
+export default schema.build();