@adobe/spacecat-shared-data-access 1.61.4 → 1.61.6

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-data-access-v1.61.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.61.5...@adobe/spacecat-shared-data-access-v1.61.6) (2024-12-30)
+
+
+### Bug Fixes
+
+* isNonEmptyArray from utils ([#512](https://github.com/adobe/spacecat-shared/issues/512)) ([21b87ed](https://github.com/adobe/spacecat-shared/commit/21b87edc507f20285355becd5d51a9b7010e9651))
+
+# [@adobe/spacecat-shared-data-access-v1.61.5](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.61.4...@adobe/spacecat-shared-data-access-v1.61.5) (2024-12-30)
+
+
+### Bug Fixes
+
+* replace expiresAt with recordExporesAt in ImportUrl ([#511](https://github.com/adobe/spacecat-shared/issues/511)) ([7349c9c](https://github.com/adobe/spacecat-shared/commit/7349c9c66659fae4b62edb27e2e03a83a0af2e13))
+
 # [@adobe/spacecat-shared-data-access-v1.61.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.61.3...@adobe/spacecat-shared-data-access-v1.61.4) (2024-12-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.61.4",
+  "version": "1.61.6",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@adobe/spacecat-shared-dynamo": "1.5.0",
-    "@adobe/spacecat-shared-utils": "1.25.0",
+    "@adobe/spacecat-shared-utils": "1.25.1",
     "@aws-sdk/client-dynamodb": "3.716.0",
     "@aws-sdk/lib-dynamodb": "3.716.0",
     "@types/joi": "17.2.3",

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

@@ -12,6 +12,7 @@
 
 import {
   hasText,
+  isNonEmptyArray,
   isNonEmptyObject,
   isObject,
 } from '@adobe/spacecat-shared-utils';
@@ -24,7 +25,6 @@ import { createAccessors } from '../../util/accessor.utils.js';
 import { guardId } from '../../util/guards.js';
 import {
   entityNameToAllPKValue,
-  isNonEmptyArray,
   removeElectroProperties,
 } from '../../util/util.js';
 

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

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+import { isNonEmptyArray, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 
 import { DataAccessError } from '../../errors/index.js';
 import { createAccessors } from '../../util/accessor.utils.js';
@@ -19,7 +19,6 @@ import {
   capitalize,
   entityNameToIdName,
   idNameToEntityName,
-  isNonEmptyArray,
 } from '../../util/util.js';
 
 import Reference from './reference.js';
@@ -204,6 +203,14 @@ class BaseModel {
     return this.record.updatedAt;
   }
 
+  /**
+   * Gets the expiration timestamp of the current entity.
+   * @returns {string} - The ISO string representing when the entity will expire.
+   */
+  getRecordExpiresAt() {
+    return this.record.recordExpiresAt;
+  }
+
   /**
    * Removes the current entity from the database. This method also removes any dependent
    * entities associated with the current entity. For example, if the current entity has

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

@@ -21,6 +21,7 @@ export interface BaseModel {
   _remove(): Promise<this>;
   getCreatedAt(): string;
   getId(): string;
+  getRecordExpiresAt(): string;
   getUpdatedAt(): string;
   remove(): Promise<this>;
   save(): Promise<this>;

package/src/v2/models/base/reference.js

@@ -10,13 +10,12 @@
  * governing permissions and limitations under the License.
  */
 
-import { hasText, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+import { hasText, isNonEmptyArray, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 
 import ReferenceError from '../../errors/reference.error.js';
 import {
   entityNameToCollectionName,
   entityNameToIdName,
-  isNonEmptyArray,
   keyNamesToMethodName,
   referenceToBaseMethodName,
 } from '../../util/util.js';

package/src/v2/models/base/schema.builder.js

@@ -11,7 +11,7 @@
  */
 
 import {
-  hasText, isBoolean, isInteger, isNonEmptyObject,
+  hasText, isBoolean, isInteger, isNonEmptyArray, isNonEmptyObject,
 } from '@adobe/spacecat-shared-utils';
 
 import { v4 as uuid, validate as uuidValidate } from 'uuid';
@@ -21,7 +21,7 @@ import {
   decapitalize,
   entityNameToAllPKValue,
   entityNameToIdName,
-  isNonEmptyArray,
+  isPositiveInteger,
 } from '../../util/util.js';
 
 import BaseModel from './base.model.js';
@@ -186,6 +186,29 @@ class SchemaBuilder {
     return this;
   }
 
+  /**
+   * Sets an expiry time for records in this entity.
+   * The record will be automatically removed by DynamoDB
+   *
+   * @param {number} ttlInDays - The time-to-live (TTL) in days.
+   * @returns {SchemaBuilder}
+   */
+  withRecordExpiry(ttlInDays) {
+    if (!isPositiveInteger(ttlInDays)) {
+      throw new SchemaBuilderError(this, 'TTL must be a positive integer.');
+    }
+
+    this.addAttribute('recordExpiresAt', {
+      type: 'number',
+      required: true,
+      readOnly: true,
+      default: () => Date.now() + ttlInDays * 24 * 60 * 60 * 1000,
+      set: () => Date.now() + ttlInDays * 24 * 60 * 60 * 1000,
+    });
+
+    return this;
+  }
+
   /**
    * By default a schema allows removes. This method allows
    * to disable removes for this entity. Note that this does

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

@@ -10,14 +10,13 @@
  * governing permissions and limitations under the License.
  */
 
-import { hasText, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
+import { hasText, isNonEmptyArray, isNonEmptyObject } from '@adobe/spacecat-shared-utils';
 
 import { SchemaError, SchemaValidationError } from '../../errors/index.js';
 import {
   classExtends,
   entityNameToCollectionName,
   entityNameToIdName,
-  isNonEmptyArray,
   isPositiveInteger,
   keyNamesToMethodName,
   modelNameToEntityName,

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

@@ -12,7 +12,7 @@
 
 /* c8 ignore start */
 
-import { isIsoDate, isValidUrl } from '@adobe/spacecat-shared-utils';
+import { isValidUrl } from '@adobe/spacecat-shared-utils';
 
 import SchemaBuilder from '../base/schema.builder.js';
 import ImportUrl from './import-url.model.js';
@@ -26,17 +26,8 @@ Indexes Doc: https://electrodb.dev/en/modeling/indexes/
  */
 
 const schema = new SchemaBuilder(ImportUrl, ImportUrlCollection)
+  .withRecordExpiry(ImportUrl.IMPORT_URL_EXPIRES_IN_DAYS)
   .addReference('belongs_to', 'ImportJob', ['status'])
-  .addAttribute('expiresAt', {
-    type: 'string',
-    required: true,
-    validate: (value) => isIsoDate(value),
-    default: () => {
-      const date = new Date();
-      date.setDate(date.getDate() + ImportUrl.IMPORT_URL_EXPIRES_IN_DAYS);
-      return date.toISOString();
-    },
-  })
   .addAttribute('file', {
     type: 'string',
   })

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

@@ -13,7 +13,6 @@
 import type { BaseCollection, BaseModel, ImportJob } from '../index';
 
 export interface ImportUrl extends BaseModel {
-  getExpiresAt(): string,
   getFile(): string,
   getImportJob(): Promise<ImportJob>,
   getImportJobId(): string,
@@ -21,7 +20,6 @@ export interface ImportUrl extends BaseModel {
   getReason(): string,
   getStatus(): string,
   getUrl(): string,
-  setExpiresAt(expiresAt: string): void,
   setFile(file: string): void,
   setImportJobId(importJobId: string): void,
   setPath(path: string): void,

package/src/v2/util/patcher.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
-import { isObject } from '@adobe/spacecat-shared-utils';
+import { isNonEmptyArray, isObject } from '@adobe/spacecat-shared-utils';
 
 import ValidationError from '../errors/validation.error.js';
 
@@ -25,7 +25,6 @@ import {
   guardSet,
   guardString,
 } from './index.js';
-import { isNonEmptyArray } from './util.js';
 
 /**
  * Checks if a property is read-only and throws an error if it is.

package/src/v2/util/util.js

@@ -80,8 +80,6 @@ const sanitizeIdAndAuditFields = (entityName, data) => {
 
 const incrementVersion = (version) => (isInteger(version) ? parseInt(version, 10) + 1 : 1);
 
-const isNonEmptyArray = (value) => Array.isArray(value) && value.length > 0;
-
 const zeroPad = (num, length) => {
   const str = String(num);
   return str.length >= length
@@ -99,7 +97,6 @@ export {
   entityNameToIdName,
   idNameToEntityName,
   incrementVersion,
-  isNonEmptyArray,
   isPositiveInteger,
   keyNamesToIndexName,
   keyNamesToMethodName,