@adobe/spacecat-shared-data-access 3.81.0 → 4.0.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [@adobe/spacecat-shared-data-access-v4.0.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.81.0...@adobe/spacecat-shared-data-access-v4.0.0) (2026-07-03)
+
+### ⚠ BREAKING CHANGES
+
+* **data-access:** drop startedAt/result/error from Preflight schema (SITES-47254) (#1740)
+
+### Features
+
+* **data-access:** drop startedAt/result/error from Preflight schema (SITES-47254) ([#1740](https://github.com/adobe/spacecat-shared/issues/1740)) ([5b728bb](https://github.com/adobe/spacecat-shared/commit/5b728bb623060289221e744088b9762a8acfe519)), closes [#2713](https://github.com/adobe/spacecat-shared/issues/2713) [#2713](https://github.com/adobe/spacecat-shared/issues/2713) [post-#2713](https://github.com/adobe/post-/issues/2713)
+
 ## [@adobe/spacecat-shared-data-access-v3.81.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v3.80.0...@adobe/spacecat-shared-data-access-v3.81.0) (2026-07-02)
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "3.81.0",
+  "version": "4.0.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {

package/src/models/async-job/index.d.ts

@@ -12,6 +12,13 @@
 
 import type { BaseCollection, BaseModel } from '../base';
 
+// Note on nullable return types: `postgrest.utils.js::normalizeModelValue()`
+// maps DB NULL → JS `undefined` (the key is skipped on `this.record`
+// entirely), so auto-generated getters return `T | undefined` — never
+// `T | null` — for nullable columns. Callers checking `=== null` on these
+// will silently miss the unfinished-job branch. Existing declarations
+// that read `... | null` predate this PR; the lifecycle additions below
+// match the runtime contract.
 export interface AsyncJob extends BaseModel {
     getStatus(): string;
     getResultLocation(): string;
@@ -20,6 +27,8 @@ export interface AsyncJob extends BaseModel {
     getError(): { code: string; message: string; details?: object } | null;
     getMetadata(): object | null;
     getRecordExpiressAt(): number;
+    getStartedAt(): string | undefined;
+    getEndedAt(): string | undefined;
     setStatus(status: string): void;
     setResultLocation(location: string): void;
     setResultType(type: string): void;
@@ -27,6 +36,8 @@ export interface AsyncJob extends BaseModel {
     setError(error: { code: string; message: string; details?: object }): void;
     setMetadata(metadata: object): void;
     setExpiresAt(expiresAt: number): void;
+    setStartedAt(startedAt: string): void;
+    setEndedAt(endedAt: string): void;
 }
 
 export interface AsyncJobCollection extends BaseCollection<AsyncJob> {

package/src/models/preflight/index.d.ts

@@ -12,6 +12,7 @@
 
 import type { AsyncJob, BaseCollection, BaseModel, Site } from '../index.js';
 
+// SITES-47254: startedAt/result/error live on AsyncJob — fetch via getAsyncJob().
 export interface Preflight extends BaseModel {
     getSiteId(): string;
     getSite(): Promise<Site>;
@@ -20,18 +21,14 @@ export interface Preflight extends BaseModel {
     getUrl(): string;
     getStatus(): string;
     getCreatedBy(): { email: string; displayName?: string };
-    getStartedAt(): string | null;
-    getEndedAt(): string | null;
-    getResult(): object | null;
-    getError(): { code: string; message: string } | null;
+    // `string | undefined` (not `| null`) because normalizeModelValue maps
+    // DB NULL → undefined on read — see AsyncJob/index.d.ts header.
+    getEndedAt(): string | undefined;
 
     setUrl(url: string): Preflight;
     setStatus(status: 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'CANCELLED'): Preflight;
     setCreatedBy(createdBy: { email: string; displayName?: string }): Preflight;
-    setStartedAt(startedAt: string): Preflight;
     setEndedAt(endedAt: string): Preflight;
-    setResult(result: object): Preflight;
-    setError(error: { code: string; message: string }): Preflight;
 }
 
 export interface PreflightCollection extends BaseCollection<Preflight> {

package/src/models/preflight/preflight.schema.js

@@ -17,6 +17,11 @@ import SchemaBuilder from '../base/schema.builder.js';
 import Preflight from './preflight.model.js';
 import PreflightCollection from './preflight.collection.js';
 
+// SITES-47254: `startedAt`, `result`, and `error` live only on AsyncJob now —
+// the underlying preflights table no longer carries them. Consumers fetch the
+// joined AsyncJob (e.g., `await preflight.getAsyncJob()`) for lifecycle
+// internals; `status` and `endedAt` remain here as a denormalized cache the
+// projector keeps in sync.
 const schema = new SchemaBuilder(Preflight, PreflightCollection)
   .addReference('belongs_to', 'Site', [], { required: true })
   .addReference('belongs_to', 'AsyncJob', [], { required: true })
@@ -30,34 +35,22 @@ const schema = new SchemaBuilder(Preflight, PreflightCollection)
     required: true,
     default: Preflight.Status.IN_PROGRESS,
   })
-  // `createdBy` and `error` use type 'any' (matching neighbor `result`) because
-  // ElectroDB's `map` type requires a `properties` schema for every sub-key,
-  // and the validate function below already enforces the precise shape — a
-  // duplicate `properties` declaration adds nothing. Declaring `type: 'map'`
-  // here without `properties` was the original definition and throws
-  // `InvalidAttributeDefinition` at Service construction, blocking any
-  // downstream consumer that builds a v1 `new Service(EntityRegistry.getEntities())`
-  // (e.g. spacecat-api-service `fixes.test.js`).
+  // `createdBy` uses type 'any' because ElectroDB's `map` type requires a
+  // `properties` schema for every sub-key, and the validate function below
+  // already enforces the precise shape — a duplicate `properties` declaration
+  // adds nothing. Declaring `type: 'map'` here without `properties` was the
+  // original definition and throws `InvalidAttributeDefinition` at Service
+  // construction, blocking any downstream consumer that builds a v1
+  // `new Service(EntityRegistry.getEntities())` (e.g. spacecat-api-service
+  // `fixes.test.js`).
   .addAttribute('createdBy', {
     type: 'any',
     required: true,
     validate: (value) => isObject(value) && typeof value.email === 'string' && value.email.length > 0,
   })
-  .addAttribute('startedAt', {
-    type: 'string',
-    validate: (value) => !value || isIsoDate(value),
-  })
   .addAttribute('endedAt', {
     type: 'string',
     validate: (value) => !value || isIsoDate(value),
-  })
-  .addAttribute('result', {
-    type: 'any',
-    validate: (value) => !value || isObject(value),
-  })
-  .addAttribute('error', {
-    type: 'any',
-    validate: (value) => !value || (isObject(value) && typeof value.code === 'string' && value.code.length > 0 && typeof value.message === 'string' && value.message.length > 0),
   });
 
 export default schema.build();