@openlup/platform 0.17.0 → 0.19.0

package/dist/communications/contracts/marketingSync.d.ts

@@ -0,0 +1,194 @@
+declare const subjectBrand: unique symbol, feedbackBrand: unique symbol, receiptBrand: unique symbol, readBrand: unique symbol;
+type Operation = "profile.sync" | "consent.read" | "erasure.request" | "erasure.read";
+type Mutation = "profile.sync" | "erasure.request";
+type SubjectReference = string & {
+    readonly [subjectBrand]: "opaque-subject";
+};
+export type SyncBinding = Readonly<{
+    account: string;
+    environment: string;
+    namespace: string;
+    mappingVersion: string;
+}>;
+export type SyncAudience = Readonly<{
+    kind: "account-wide";
+} | {
+    kind: "audience";
+    reference: string;
+}>;
+export type ProfileProjection = Readonly<{
+    email: string;
+    externalReference: string;
+    fields: Readonly<Partial<Record<"givenName" | "familyName" | "locale", string>>>;
+    properties: Readonly<Record<string, string | number | boolean>>;
+}>;
+type Payload = {
+    "profile.sync": {
+        projection: ProfileProjection;
+        consentEvidenceReference: string;
+    };
+    "consent.read": Readonly<Record<string, never>>;
+    "erasure.request": {
+        caseReference: string;
+        authorityReference: string;
+    };
+    "erasure.read": {
+        receipt: SyncReceipt<"erasure.request">;
+    };
+};
+export type SyncRequest<O extends Operation = Operation> = {
+    [K in O]: Readonly<{
+        binding: SyncBinding;
+        audience: SyncAudience;
+        subjectReference: SubjectReference;
+        requestId: string;
+        generation: number;
+        deadlineMs: number;
+        authorizationReference: string;
+        operation: K;
+        payload: Readonly<Payload[K]>;
+    }>;
+}[O];
+export type NegativeFeedback = Readonly<{
+    [feedbackBrand]: "provider-negative";
+    sourceReference: string;
+    occurredAtMs: number | null;
+    audience: SyncAudience;
+}> & Readonly<{
+    kind: "unsubscribe" | "complaint" | "manual_block";
+    outcome: "deny_permission";
+} | {
+    kind: "hard_bounce" | "invalid_address";
+    outcome: "deny_delivery";
+}>;
+export type ConsentReadback = Readonly<{
+    audience: SyncAudience;
+    observedAtMs: number;
+    remoteConsent: "subscribed" | "unsubscribed" | "pending" | "never_subscribed" | "unknown";
+    feedback: readonly NegativeFeedback[];
+    coverage: "complete" | "partial" | "unsupported";
+}>;
+export type SyncFailure<O extends Operation = Operation> = {
+    kind: "refused";
+    reason: "invalid_request" | "binding" | "provenance" | "stale" | "deadline" | "unsupported" | "verification_pending" | "restricted" | "identity_conflict" | "provider_refusal";
+} | {
+    kind: "retryable";
+    reason: "cooling" | "host" | "provider";
+    afterSeconds: number;
+} | ({
+    kind: "unknown";
+    reason: "dispatch_unresolved" | "acceptance_ambiguous" | "record_failed";
+} & (O extends Mutation ? {
+    receipt?: SyncReceipt<O>;
+} : {
+    receipt?: never;
+}));
+export type SyncReceipt<O extends Mutation> = Readonly<{
+    [receiptBrand]: O;
+    operation: O;
+    request: SyncRequest<O>;
+}>;
+type MutationSuccess<O extends Mutation> = {
+    kind: "accepted" | "acknowledged";
+    receipt: SyncReceipt<O>;
+    journal: "confirmed" | "unknown";
+};
+type Success = {
+    "profile.sync": MutationSuccess<"profile.sync">;
+    "consent.read": {
+        kind: "completed";
+        value: ConsentReadback;
+        journal: "confirmed" | "unknown";
+    };
+    "erasure.request": MutationSuccess<"erasure.request">;
+    "erasure.read": MutationSuccess<"erasure.request"> | {
+        kind: "completed";
+        receipt: SyncReceipt<"erasure.request">;
+        journal: "confirmed" | "unknown";
+        evidence: Readonly<{
+            [readBrand]: "provider-read";
+            readRequestId: string;
+            observedAtMs: number;
+            evidenceReference: string;
+            assurance: "provider_record_deleted" | "provider_erasure_confirmed";
+        }>;
+    };
+};
+export type SyncResult<O extends Operation = Operation> = {
+    [K in O]: Readonly<Pick<SyncRequest<K>, "binding" | "operation" | "subjectReference" | "requestId" | "generation">> & Readonly<Success[K] | SyncFailure<K>>;
+}[O];
+export type SyncCapabilities = Readonly<{
+    binding: SyncBinding;
+    audience: SyncAudience;
+    operations: Readonly<Record<Operation, {
+        state: "supported";
+        evidenceReference: string;
+        maxRequestBytes: number;
+        maxFeedbackItems: number;
+    } | {
+        state: "unsupported" | "verification_pending";
+    }>>;
+}>;
+export interface ProfileSyncPort {
+    sync(request: SyncRequest<"profile.sync">): Promise<SyncResult<"profile.sync">>;
+}
+export interface ConsentReadPort {
+    read(request: SyncRequest<"consent.read">): Promise<SyncResult<"consent.read">>;
+}
+export interface ErasurePort {
+    request(request: SyncRequest<"erasure.request">): Promise<SyncResult<"erasure.request">>;
+    read(request: SyncRequest<"erasure.read">): Promise<SyncResult<"erasure.read">>;
+}
+export interface MarketingSyncProvider {
+    readonly capabilities: SyncCapabilities;
+    readonly profiles: ProfileSyncPort;
+    readonly consent: ConsentReadPort;
+    readonly erasure: ErasurePort;
+}
+export type ConsentPushRequest = Readonly<Omit<SyncRequest<"profile.sync">, "operation" | "audience" | "payload"> & {
+    operation: "consent.push";
+} & ({
+    audience: Extract<SyncAudience, {
+        kind: "audience";
+    }>;
+    payload: Readonly<{
+        action: "grant";
+        consentEvidenceReference: string;
+    }>;
+} | {
+    audience: SyncAudience;
+    payload: Readonly<{
+        action: "withdraw";
+        consentEvidenceReference: string;
+    }>;
+})>;
+declare const pushReceiptBrand: unique symbol;
+type PushReceipt = Readonly<{
+    [pushReceiptBrand]: "consent.push";
+    operation: "consent.push";
+    request: ConsentPushRequest;
+}>;
+type PushFailure = Exclude<SyncFailure, {
+    kind: "unknown";
+}> | (Omit<Extract<SyncFailure, {
+    kind: "unknown";
+}>, "receipt"> & {
+    receipt?: PushReceipt;
+});
+export type ConsentPushResult = Readonly<Pick<ConsentPushRequest, "binding" | "operation" | "subjectReference" | "requestId" | "generation">> & Readonly<{
+    kind: "accepted" | "acknowledged";
+    receipt: PushReceipt;
+    journal: "confirmed" | "unknown";
+    reconcileRequired: boolean;
+} | PushFailure>;
+export interface ConsentPushPort {
+    readonly capabilities: SyncCapabilities & Readonly<{
+        operations: SyncCapabilities["operations"] & Readonly<{
+            "consent.push": SyncCapabilities["operations"]["profile.sync"] & Readonly<{
+                grantEffect: "audience" | "account-wide";
+            }>;
+        }>;
+    }>;
+    push(request: ConsentPushRequest): Promise<ConsentPushResult>;
+}
+export {};

package/dist/communications/contracts/marketingSync.js

@@ -0,0 +1 @@
+export {};

package/dist/communications/index.d.ts

@@ -44,3 +44,4 @@ export * from "./postgresDeliveryReconciliation.js";
 export * from "./postgresCommunicationSync.js";
 export * from "./postgresNotificationRecipients.js";
 export * from "./postgresConsentEvaluator.js";
+export type * from "./contracts/marketingSync.js";

package/dist/communications/klaviyo/consentPush.d.ts

@@ -0,0 +1,51 @@
+import type { ConsentPushRequest } from "../contracts/marketingSync.js";
+/** Private singleton translation. Local evidence is deliberately absent from wire attributes. */
+export declare function consentCommand(request: ConsentPushRequest, target: {
+    id: string;
+    email: string;
+}, listId: string | undefined): {
+    method: string;
+    path: string;
+    expected: number[];
+    body: {
+        data: {
+            type: string;
+            id: string;
+        }[];
+    };
+} | {
+    method: string;
+    path: string;
+    expected: number[];
+    body: {
+        data: {
+            relationships?: {
+                list: {
+                    data: {
+                        type: string;
+                        id: string | undefined;
+                    };
+                };
+            } | undefined;
+            type: string;
+            attributes: {
+                profiles: {
+                    data: {
+                        attributes: {
+                            email: string;
+                            subscriptions: {
+                                email: {
+                                    marketing: {
+                                        consent: string;
+                                    };
+                                };
+                            };
+                        };
+                        id?: string | undefined;
+                        type: string;
+                    }[];
+                };
+            };
+        };
+    };
+};

package/dist/communications/klaviyo/consentPush.js

@@ -0,0 +1,19 @@
+/** Private singleton translation. Local evidence is deliberately absent from wire attributes. */
+export function consentCommand(request, target, listId) {
+    if (request.payload.action === "withdraw" && request.audience.kind === "audience") {
+        if (!listId)
+            throw new Error("scope");
+        return { method: "DELETE", path: `/api/lists/${listId}/relationships/profiles`, expected: [204],
+            body: { data: [{ type: "profile", id: target.id }] } };
+    }
+    const grant = request.payload.action === "grant";
+    const type = grant ? "profile-subscription-bulk-create-job" : "profile-subscription-bulk-delete-job";
+    if (grant && !listId)
+        throw new Error("scope");
+    return { method: "POST", path: `/api/${type}s`, expected: [202], body: { data: { type,
+                attributes: { profiles: { data: [{ type: "profile", ...(grant ? { id: target.id } : {}), attributes: {
+                                    email: target.email, subscriptions: { email: { marketing: { consent: grant ? "SUBSCRIBED" : "UNSUBSCRIBED" } } },
+                                } }] } },
+                ...(grant ? { relationships: { list: { data: { type: "list", id: listId } } } } : {}),
+            } } };
+}

package/dist/communications/klaviyo/index.d.ts

@@ -0,0 +1,110 @@
+import type { ConsentPushPort, ConsentPushRequest, MarketingSyncProvider, ProfileProjection, SyncAudience, SyncBinding, SyncRequest } from "../contracts/marketingSync.js";
+import type { MarketingAutomationClaim, MarketingAutomationProviderPort, MarketingAutomationScope } from "../contracts/marketingAutomation.js";
+import type { NewsletterSyncProviderPort } from "../contracts/newsletter.js";
+type Request = SyncRequest | ConsentPushRequest;
+type Operation = Request["operation"];
+type Subject = {
+    binding: SyncBinding;
+    subjectReference: string;
+    generation: number;
+    erased: boolean;
+    id?: string;
+    email: string;
+    externalReference: string;
+    ownedFields: readonly (keyof ProfileProjection["fields"])[];
+    ownedProperties: readonly string[];
+};
+type LocalEvidence = {
+    binding: SyncBinding;
+    subjectReference: string;
+    audience: SyncAudience;
+    purpose: string;
+    action: "profile" | "grant" | "withdraw" | "erase";
+    current: boolean;
+    projection?: ProfileProjection;
+    caseReference?: string;
+    authorityReference?: string;
+    allPurposes?: boolean;
+};
+type Authorization = {
+    binding: SyncBinding;
+    subjectReference: string;
+    audience: SyncAudience;
+    operation: Operation;
+    expiresAtMs: number;
+};
+type Verification = {
+    binding: SyncBinding;
+    audience: SyncAudience;
+    evidenceReference: string;
+    revision: string;
+    operations: readonly Exclude<Operation, "erasure.read">[];
+    scopes: readonly string[];
+    noTrigger: {
+        profile: boolean;
+        accountWideGrant: boolean;
+        doi: boolean;
+    };
+    safeCreate: boolean;
+    safeListRemoval: boolean;
+    suppressionSafeAtEffect: boolean;
+    negativeSourcesComplete: boolean;
+    listMappings: Readonly<Record<string, SyncAudience>>;
+};
+type Storage = {
+    /** Shared plain mutable record for this account/environment, independent of CAS failure.
+     * Start quarantined after host restart; only explicit host reconciliation clears it.
+     * Every adapter namespace/instance uses the same record. Never reset it at construction. */
+    availability: {
+        account: string;
+        environment: string;
+        busy: boolean;
+        quarantined: boolean;
+    };
+    /** Shared across every adapter for the account. false proves no commit; throws may have committed. */
+    get(key: string): Promise<string | null>;
+    compareAndSwap(key: string, expected: string | null, value: string): Promise<boolean>;
+};
+type Configuration = {
+    binding: SyncBinding;
+    audience: SyncAudience;
+    /** Synchronous current host registry lookup; never parses an opaque subject reference. */
+    subjectMapper(subjectReference: string): Subject | undefined;
+    resolveCredential(): {
+        binding: SyncBinding;
+        key: string;
+    } | undefined;
+    authorizations: ReadonlyMap<string, Authorization>;
+    localEvidence: ReadonlyMap<string, LocalEvidence>;
+    storage: Storage;
+    verification?: Verification;
+    /** Private authenticated settlement facts from the host's existing reconciliation journal. */
+    grantSettlements?: ReadonlyMap<string, {
+        binding: SyncBinding;
+        subjectReference: string;
+        requestId: string;
+        source: "provider-read";
+        evidenceReference: string;
+        settledAtMs: number;
+    }>;
+    fetch?: typeof fetch;
+    now?: () => number;
+    maxRequestBytes?: number;
+    maxResponseBytes?: number;
+    maxFeedbackItems?: number;
+    timeoutMs?: number;
+    rateIntervalMs?: number;
+    legacy?: {
+        scope: MarketingAutomationScope;
+        claims: ReadonlyMap<string, {
+            claim: MarketingAutomationClaim;
+            request: Request;
+        }>;
+    };
+};
+/** Opt-in Node adapter; owner TEST evidence is required before any bound operation is enabled. */
+export declare function createKlaviyoMarketingAdapter(input: Configuration): MarketingSyncProvider & MarketingAutomationProviderPort & {
+    readonly consentPush: ConsentPushPort;
+    readonly newsletter: NewsletterSyncProviderPort;
+};
+export {};