@reform-society/agera-core 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -218,6 +218,88 @@ type FetchBasinJWTOptions = {
 };
 declare function fetchBasinJWT(endpoint: string, storage: StorageAccessor, storageKey: string, options?: FetchBasinJWTOptions): Promise<string>;
 //#endregion
+//#region src/lifecycle.d.ts
+type NormalizedResult = {
+  delivery: "observed" | "unobserved";
+  operation: string;
+  operationStatus: "acknowledged" | "pending" | "completed" | "rejected" | "unknown";
+  contactStatus: "created" | "updated" | "unknown";
+  contactEvidence: "provider" | "inferred" | "unknown";
+  paymentStatus: "unknown" | "pending" | "succeeded" | "failed";
+  paymentEvidence: "provider" | "inferred" | "unknown";
+  nextAction?: {
+    type: "redirect" | "poll" | "verify";
+    url?: string;
+  };
+  outcome?: string;
+  extensions?: Record<string, unknown>;
+};
+type EventSourceKind = "form-submit" | "element-action";
+type EventSource = {
+  client: string;
+  integration?: string;
+  kind?: EventSourceKind;
+  formId?: string;
+  triggerId?: string;
+  pagePath: string;
+};
+type RequestSnapshot = {
+  fields: Record<string, unknown>;
+  context: Record<string, unknown>;
+  config: Record<string, unknown>;
+  method: string;
+  delivery: "wait" | "background";
+  body?: unknown;
+};
+type EventEnvelope = {
+  schemaVersion: 1;
+  eventId: string;
+  occurredAt: string;
+  source: EventSource;
+  context: Record<string, unknown>;
+  result: NormalizedResult;
+  submissionId?: string;
+  flowId?: string;
+  attemptId?: string;
+  conversionId?: string;
+  request?: RequestSnapshot;
+};
+type LifecycleEvent = EventEnvelope & ({
+  type: "crm.dispatched";
+  submissionId: string;
+  request: RequestSnapshot;
+} | {
+  type: "crm.response";
+  submissionId: string;
+  request: RequestSnapshot;
+  response: {
+    httpStatus: number;
+    raw: unknown;
+  };
+} | {
+  type: "crm.failed" | "crm.cancelled";
+  submissionId: string;
+  request: RequestSnapshot;
+} | {
+  type: "element.entered" | "element.clicked" | "element.viewed" | "step.changed";
+} | {
+  type: "flow.started" | "flow.returned" | "flow.verified" | "flow.failed";
+  flowId: string;
+  attemptId: string;
+});
+type LifecycleType = LifecycleEvent["type"];
+declare function unknownResult(delivery?: NormalizedResult["delivery"]): NormalizedResult;
+/** Serializable copies omit functions, DOM handles, and cyclic references. */
+declare function snapshot<T>(value: T): T;
+declare function createLifecycleBus(onError?: () => void): {
+  on: <T extends LifecycleType>(type: T | "*", listener: (event: LifecycleEvent & {
+    type: T;
+  }) => unknown) => () => void;
+  emit: (event: LifecycleEvent) => void;
+  clear(): void;
+};
+declare function normalizeResult(value: unknown, httpStatus?: number): NormalizedResult;
+//#endregion
 //#region src/crm-types.d.ts
 type CounterUpdateConfig = {
   name: string;
@@ -303,12 +385,14 @@ type CrmOutcome = {
   status: "succeeded";
   httpStatus: number;
   response: Record<string, unknown> | null;
+  normalized?: NormalizedResult;
 } | {
   status: "accepted";
 } | {
   status: "rejected";
   httpStatus: number;
   response: Record<string, unknown> | null;
+  normalized?: NormalizedResult;
 } | {
   status: "failed";
   cause: unknown;
@@ -321,88 +405,6 @@ declare function executeCrm(gateway: CrmGateway, command: CrmCommand, options?:
   signal?: AbortSignal;
 }): Promise<CrmOutcome>;
 //#endregion
-//#region src/lifecycle.d.ts
-type NormalizedResult = {
-  delivery: "observed" | "unobserved";
-  operation: string;
-  operationStatus: "acknowledged" | "pending" | "completed" | "rejected" | "unknown";
-  contactStatus: "created" | "updated" | "unknown";
-  contactEvidence: "provider" | "inferred" | "unknown";
-  paymentStatus: "unknown" | "pending" | "succeeded" | "failed";
-  paymentEvidence: "provider" | "inferred" | "unknown";
-  nextAction?: {
-    type: "redirect" | "poll" | "verify";
-    url?: string;
-  };
-  outcome?: string;
-  extensions?: Record<string, unknown>;
-};
-type EventSourceKind = "form-submit" | "element-action";
-type EventSource = {
-  client: string;
-  integration?: string;
-  kind?: EventSourceKind;
-  formId?: string;
-  triggerId?: string;
-  pagePath: string;
-};
-type RequestSnapshot = {
-  fields: Record<string, unknown>;
-  context: Record<string, unknown>;
-  config: Record<string, unknown>;
-  method: string;
-  delivery: "wait" | "background";
-  body?: unknown;
-};
-type EventEnvelope = {
-  schemaVersion: 1;
-  eventId: string;
-  occurredAt: string;
-  source: EventSource;
-  context: Record<string, unknown>;
-  result: NormalizedResult;
-  submissionId?: string;
-  flowId?: string;
-  attemptId?: string;
-  conversionId?: string;
-  request?: RequestSnapshot;
-};
-type LifecycleEvent = EventEnvelope & ({
-  type: "crm.dispatched";
-  submissionId: string;
-  request: RequestSnapshot;
-} | {
-  type: "crm.response";
-  submissionId: string;
-  request: RequestSnapshot;
-  response: {
-    httpStatus: number;
-    raw: unknown;
-  };
-} | {
-  type: "crm.failed" | "crm.cancelled";
-  submissionId: string;
-  request: RequestSnapshot;
-} | {
-  type: "element.entered" | "element.clicked" | "element.viewed" | "step.changed";
-} | {
-  type: "flow.started" | "flow.returned" | "flow.verified" | "flow.failed";
-  flowId: string;
-  attemptId: string;
-});
-type LifecycleType = LifecycleEvent["type"];
-declare function unknownResult(delivery?: NormalizedResult["delivery"]): NormalizedResult;
-/** Serializable copies omit functions, DOM handles, and cyclic references. */
-declare function snapshot<T>(value: T): T;
-declare function createLifecycleBus(onError?: () => void): {
-  on: <T extends LifecycleType>(type: T | "*", listener: (event: LifecycleEvent & {
-    type: T;
-  }) => unknown) => () => void;
-  emit: (event: LifecycleEvent) => void;
-  clear(): void;
-};
-declare function normalizeResult(value: unknown, httpStatus?: number): NormalizedResult;
-//#endregion
 //#region src/tracking.d.ts
 type ValueResolver = string | number | boolean | null | undefined | ValueResolver[] | {
   [key: string]: ValueResolver;
@@ -571,6 +573,7 @@ type CrmFetchOptions = {
   sourceUrl?: string;
   deviceType?: DeviceType;
   method?: "POST" | "PATCH" | "PUT";
+  signal?: AbortSignal;
 };
 declare function crmFetch(url: string, payload: Record<string, unknown> | object, options?: CrmFetchOptions): Promise<CrmFetchResult>;
 //#endregion

package/dist/index.js

@@ -754,41 +754,6 @@ async function fetchBasinJWT(endpoint, storage, storageKey, options = {}) {
 	}
 }
 //#endregion
-//#region src/crm-submission.ts
-function isAbortError(error) {
-	return typeof error === "object" && error !== null && "name" in error && error.name === "AbortError";
-}
-async function executeCrm(gateway, command, options = {}) {
-	const { signal } = options;
-	if (signal?.aborted) return { status: "aborted" };
-	try {
-		const result = await gateway({
-			client: command.client,
-			method: command.method ?? "POST",
-			delivery: command.delivery ?? "wait",
-			payload: command.payload,
-			signal
-		});
-		if (result.kind === "accepted") return { status: "accepted" };
-		const { ok, status, data } = result.response;
-		return ok ? {
-			status: "succeeded",
-			httpStatus: status,
-			response: data
-		} : {
-			status: "rejected",
-			httpStatus: status,
-			response: data
-		};
-	} catch (error) {
-		if (signal?.aborted || isAbortError(error)) return { status: "aborted" };
-		return {
-			status: "failed",
-			cause: error
-		};
-	}
-}
-//#endregion
 //#region src/lifecycle.ts
 function unknownResult(delivery = "unobserved") {
 	return {
@@ -894,6 +859,45 @@ function normalizeResult(value, httpStatus) {
 	return result;
 }
 //#endregion
+//#region src/crm-submission.ts
+function isAbortError$1(error) {
+	return typeof error === "object" && error !== null && "name" in error && error.name === "AbortError";
+}
+async function executeCrm(gateway, command, options = {}) {
+	const { signal } = options;
+	if (signal?.aborted) return { status: "aborted" };
+	try {
+		const result = await gateway({
+			client: command.client,
+			method: command.method ?? "POST",
+			delivery: command.delivery ?? "wait",
+			payload: command.payload,
+			signal
+		});
+		if (result.kind === "accepted") return { status: "accepted" };
+		const { ok, status, data, cancelled, normalized } = result.response;
+		if (cancelled) return { status: "aborted" };
+		const extra = normalized !== void 0 ? { normalized: normalizeResult(normalized, status) } : {};
+		return ok ? {
+			status: "succeeded",
+			httpStatus: status,
+			response: data,
+			...extra
+		} : {
+			status: "rejected",
+			httpStatus: status,
+			response: data,
+			...extra
+		};
+	} catch (error) {
+		if (signal?.aborted || isAbortError$1(error)) return { status: "aborted" };
+		return {
+			status: "failed",
+			cause: error
+		};
+	}
+}
+//#endregion
 //#region src/tracking.ts
 function firstDefined(values) {
 	return values.find((value) => value !== void 0 && value !== "");
@@ -1414,19 +1418,43 @@ function getOrCreateVisitorId(storage) {
 //#endregion
 //#region src/crm-fetch.ts
 const noop = () => {};
+function isRecord$1(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+function isAbortError(error) {
+	return isRecord$1(error) && error.name === "AbortError";
+}
+/** Unwrap the v1 lifecycle envelope `{ schemaVersion: 1, raw, result }` when present. */
+function unwrapEnvelope(raw, status) {
+	if (isRecord$1(raw) && raw.schemaVersion === 1 && Object.hasOwn(raw, "raw") && isRecord$1(raw.result)) return {
+		data: raw.raw,
+		normalized: normalizeResult(raw.result, status)
+	};
+	return { data: raw };
+}
 async function crmFetch(url, payload, options = {}) {
-	const { waitForResponse = true, sourceUrl, deviceType, method = "POST" } = options;
+	const { waitForResponse = true, sourceUrl, deviceType, method = "POST", signal } = options;
 	const body = JSON.stringify(payload);
-	const headers = { "Content-Type": "application/json" };
+	const headers = {
+		"Content-Type": "application/json",
+		"X-Agera-Response-Version": "1"
+	};
 	if (sourceUrl) headers["x-source"] = sourceUrl;
 	if (deviceType !== void 0) headers["x-device-type"] = deviceType;
+	if (signal?.aborted) return {
+		ok: false,
+		status: 0,
+		data: null,
+		cancelled: true
+	};
 	if (!waitForResponse) {
 		try {
 			fetch(url, {
 				method,
 				headers,
 				body,
-				keepalive: true
+				keepalive: true,
+				signal
 			}).catch(noop);
 		} catch {}
 		return {
@@ -1439,18 +1467,25 @@ async function crmFetch(url, payload, options = {}) {
 		const response = await fetch(url, {
 			method,
 			headers,
-			body
+			body,
+			signal
 		});
-		let data = null;
+		let raw = null;
 		try {
-			data = await response.json();
+			raw = await response.json();
 		} catch {}
 		return {
 			ok: response.ok,
 			status: response.status,
-			data
+			...unwrapEnvelope(raw, response.status)
+		};
+	} catch (error) {
+		if (signal?.aborted || isAbortError(error)) return {
+			ok: false,
+			status: 0,
+			data: null,
+			cancelled: true
 		};
-	} catch {
 		return {
 			ok: false,
 			status: 0,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reform-society/agera-core",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "DOM-free core logic for Agera",
   "type": "module",
   "main": "dist/index.js",