@owlmeans/server-marketing-consent 0.1.18-rc.0

package/build/service.js

@@ -0,0 +1,146 @@
+import { randomUUID } from 'node:crypto';
+import { createLazyService } from '@owlmeans/context';
+import { consentStatus, MARKETING_CONSENT_SERVICE, resolveMarketingConsents, UnknownMarketingConsentError, } from '@owlmeans/marketing-consent';
+import { RecordExists } from '@owlmeans/resource';
+import { RES_MARKETING_CONSENT_LOG, RES_MARKETING_CONSENT_STATE } from './consts.js';
+import { subjectKey } from './subject.js';
+const nowIso = () => new Date().toISOString();
+/**
+ * Build the `MarketingConsentService`. Database-agnostic: both resources are resolved BY ALIAS
+ * from the context lazily, inside each method call — never imported or constructed here. A
+ * Mongo/Postgres extension package registers the actual resources at those aliases separately.
+ */
+export const makeMarketingConsentService = (opts = {}) => {
+    const alias = opts.alias ?? MARKETING_CONSENT_SERVICE;
+    const stateAlias = opts.state ?? RES_MARKETING_CONSENT_STATE;
+    const logAlias = opts.log ?? RES_MARKETING_CONSENT_LOG;
+    let memoizedDefinitions;
+    const definitions = () => {
+        memoizedDefinitions ??= resolveMarketingConsents(opts.config);
+        return memoizedDefinitions;
+    };
+    const listeners = [];
+    const ctx = () => service.assertCtx();
+    const states = () => ctx().resource(stateAlias);
+    const logs = () => ctx().resource(logAlias);
+    const appendLog = async (record) => {
+        await logs().create({ ...record, id: `log:${record.subject}:${randomUUID()}` });
+    };
+    const notify = async (subject, decisions) => {
+        for (const listener of listeners) {
+            try {
+                await listener({ subject, decisions });
+            }
+            catch (error) {
+                // A listener's failure never fails the write that triggered it.
+                console.error(`${alias}: observer failed for ${subjectKey(subject)}`, error);
+            }
+        }
+    };
+    const statusOf = (state, gpc) => consentStatus(definitions(), state?.decisions ?? [], {
+        gpc, termsAcceptedAt: state?.terms?.acceptedAt, termsVersion: state?.terms?.version,
+    });
+    /** Create-then-fall-back-to-update-on-`RecordExists`, the idiom `server-auth-session` uses for
+     * the same create-vs-update race on a natural-id resource. */
+    const upsertState = async (id, patch) => {
+        const existing = await states().load(id);
+        if (existing != null) {
+            return states().save({ ...existing, ...patch(existing) });
+        }
+        try {
+            return await states().create({ id, ...patch(null) });
+        }
+        catch (error) {
+            if (!(error instanceof RecordExists))
+                throw error;
+            const raced = await states().get(id);
+            return states().save({ ...raced, ...patch(raced) });
+        }
+    };
+    const service = createLazyService(alias, {
+        definitions,
+        status: async (subject, statusOpts) => {
+            const state = await states().load(subjectKey(subject));
+            return statusOf(state, statusOpts?.gpc);
+        },
+        save: async (subject, request) => {
+            const known = new Set(definitions().map(def => def.key));
+            const unknown = request.decisions.find(decision => !known.has(decision.key));
+            if (unknown != null) {
+                throw new UnknownMarketingConsentError(unknown.key);
+            }
+            const now = nowIso();
+            const decided = request.decisions.map(decision => {
+                // Safe: every key was just checked against `known` above.
+                const definition = definitions().find(def => def.key === decision.key);
+                return {
+                    key: decision.key, granted: decision.granted, revisedAt: definition.revisedAt,
+                    mode: definition.mode, decidedAt: now, source: request.source,
+                };
+            });
+            for (const decision of decided) {
+                await appendLog({
+                    subject: subjectKey(subject), userId: subject.userId, profileId: subject.profileId,
+                    entityId: subject.entityId, kind: 'consent', key: decision.key, granted: decision.granted,
+                    revisedAt: decision.revisedAt, mode: decision.mode, decidedAt: decision.decidedAt,
+                    source: decision.source, locale: request.locale, gpc: request.gpc,
+                });
+            }
+            const id = subjectKey(subject);
+            const saved = await upsertState(id, existing => {
+                const merged = new Map((existing?.decisions ?? []).map(decision => [decision.key, decision]));
+                decided.forEach(decision => merged.set(decision.key, decision));
+                return {
+                    subject: id, userId: subject.userId, profileId: subject.profileId, entityId: subject.entityId,
+                    decisions: [...merged.values()], gpc: request.gpc ?? existing?.gpc,
+                    createdAt: existing?.createdAt ?? now, updatedAt: now,
+                };
+            });
+            await notify(subject, decided);
+            return { ok: true, status: statusOf(saved, request.gpc) };
+        },
+        recordTerms: async (subject, acceptance, recordOpts) => {
+            const now = nowIso();
+            const source = recordOpts?.source ?? 'sign-in';
+            await appendLog({
+                subject: subjectKey(subject), userId: subject.userId, profileId: subject.profileId,
+                entityId: subject.entityId, kind: 'terms', documents: acceptance.documents,
+                notices: acceptance.notices, version: acceptance.version, decidedAt: now, source,
+                locale: acceptance.locale,
+            });
+            const id = subjectKey(subject);
+            const terms = {
+                documents: acceptance.documents, notices: acceptance.notices, version: acceptance.version,
+                locale: acceptance.locale, acceptedAt: now,
+            };
+            await upsertState(id, existing => ({
+                subject: id, userId: subject.userId, profileId: subject.profileId, entityId: subject.entityId,
+                decisions: existing?.decisions ?? [], terms,
+                createdAt: existing?.createdAt ?? now, updatedAt: now,
+            }));
+            return { ok: true };
+        },
+        isGranted: async (subject, key, grantOpts) => {
+            const view = await service.status(subject, grantOpts);
+            const item = view.items.find(candidate => candidate.definition.key === key);
+            if (item == null || item.status !== 'current')
+                return false;
+            return item.granted;
+        },
+        purge: async (subject) => {
+            await states().delete(subjectKey(subject));
+        },
+        observe: listener => {
+            listeners.push(listener);
+        },
+    });
+    return service;
+};
+/** Register the service, unless the application already registered its own under this alias. */
+export const appendMarketingConsentService = (context, opts = {}) => {
+    const alias = opts.alias ?? MARKETING_CONSENT_SERVICE;
+    if (!context.hasService(alias)) {
+        context.registerService(makeMarketingConsentService(opts));
+    }
+};
+//# sourceMappingURL=service.js.map

package/build/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD,OAAO,EACL,aAAa,EAAE,yBAAyB,EAAE,wBAAwB,EAAE,4BAA4B,GACjG,MAAM,6BAA6B,CAAA;AAKpC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGjD,OAAO,EAAE,yBAAyB,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAA;AAEpF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAwCzC,MAAM,MAAM,GAAG,GAAW,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;AAErD;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,IAAI,GAAuC,EAAE,EACpB,EAAE;IAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,yBAAyB,CAAA;IACrD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,IAAI,2BAA2B,CAAA;IAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,IAAI,yBAAyB,CAAA;IAEtD,IAAI,mBAA6D,CAAA;IACjE,MAAM,WAAW,GAAG,GAAiC,EAAE;QACrD,mBAAmB,KAAK,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC7D,OAAO,mBAAmB,CAAA;IAC5B,CAAC,CAAA;IAED,MAAM,SAAS,GAA+B,EAAE,CAAA;IAEhD,MAAM,GAAG,GAAG,GAA4B,EAAE,CAAC,OAAO,CAAC,SAAS,EAAyC,CAAA;IACrG,MAAM,MAAM,GAAG,GAA0C,EAAE,CACzD,GAAG,EAAE,CAAC,QAAQ,CAAwC,UAAU,CAAC,CAAA;IACnE,MAAM,IAAI,GAAG,GAAwC,EAAE,CACrD,GAAG,EAAE,CAAC,QAAQ,CAAsC,QAAQ,CAAC,CAAA;IAE/D,MAAM,SAAS,GAAG,KAAK,EAAE,MAA6C,EAAiB,EAAE;QACvF,MAAM,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,OAAO,MAAM,CAAC,OAAO,IAAI,UAAU,EAAE,EAAE,EAAE,CAAC,CAAA;IACjF,CAAC,CAAA;IAED,MAAM,MAAM,GAAG,KAAK,EAAE,OAAgC,EAAE,SAAqC,EAAiB,EAAE;QAC9G,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAA;YACxC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,gEAAgE;gBAChE,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,yBAAyB,UAAU,CAAC,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,CAAA;YAC9E,CAAC;QACH,CAAC;IACH,CAAC,CAAA;IAED,MAAM,QAAQ,GAAG,CACf,KAAyC,EAAE,GAAa,EAC5B,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,SAAS,IAAI,EAAE,EAAE;QACpF,GAAG,EAAE,eAAe,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO;KACpF,CAAC,CAAA;IAEF;kEAC8D;IAC9D,MAAM,WAAW,GAAG,KAAK,EACvB,EAAU,EAAE,KAA6F,EACnE,EAAE;QACxC,MAAM,QAAQ,GAAG,MAAM,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACxC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QAC3D,CAAC;QACD,IAAI,CAAC;YACH,OAAO,MAAM,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACtD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,CAAC,KAAK,YAAY,YAAY,CAAC;gBAAE,MAAM,KAAK,CAAA;YACjD,MAAM,KAAK,GAAG,MAAM,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACpC,OAAO,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QACrD,CAAC;IACH,CAAC,CAAA;IAED,MAAM,OAAO,GAA4B,iBAAiB,CAA0B,KAAK,EAAE;QACzF,WAAW;QAEX,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE;YACpC,MAAM,KAAK,GAAG,MAAM,MAAM,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAA;YACtD,OAAO,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,CAAC,CAAA;QACzC,CAAC;QAED,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;YAC/B,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;YACxD,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;YAC5E,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,MAAM,IAAI,4BAA4B,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;YACrD,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,EAAE,CAAA;YACpB,MAAM,OAAO,GAA+B,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAC3E,0DAA0D;gBAC1D,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,GAAG,CAAE,CAAA;gBACvE,OAAO;oBACL,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS;oBAC7E,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM;iBAC9D,CAAA;YACH,CAAC,CAAC,CAAA;YAEF,KAAK,MAAM,QAAQ,IAAI,OAAO,EAAE,CAAC;gBAC/B,MAAM,SAAS,CAAC;oBACd,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS;oBAClF,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO;oBACzF,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS;oBACjF,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG;iBAClE,CAAC,CAAA;YACJ,CAAC;YAED,MAAM,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;YAC9B,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE;gBAC7C,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;gBAC7F,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAA;gBAC/D,OAAO;oBACL,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC7F,SAAS,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,QAAQ,EAAE,GAAG;oBAClE,SAAS,EAAE,QAAQ,EAAE,SAAS,IAAI,GAAG,EAAE,SAAS,EAAE,GAAG;iBACtD,CAAA;YACH,CAAC,CAAC,CAAA;YAEF,MAAM,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAE9B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAA;QAC3D,CAAC;QAED,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,EAAE,CAAA;YACpB,MAAM,MAAM,GAAG,UAAU,EAAE,MAAM,IAAI,SAAS,CAAA;YAE9C,MAAM,SAAS,CAAC;gBACd,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS;gBAClF,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,SAAS;gBAC1E,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM;gBAChF,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B,CAAC,CAAA;YAEF,MAAM,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;YAC9B,MAAM,KAAK,GAAG;gBACZ,SAAS,EAAE,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO;gBACzF,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG;aAC3C,CAAA;YACD,MAAM,WAAW,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACjC,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC7F,SAAS,EAAE,QAAQ,EAAE,SAAS,IAAI,EAAE,EAAE,KAAK;gBAC3C,SAAS,EAAE,QAAQ,EAAE,SAAS,IAAI,GAAG,EAAE,SAAS,EAAE,GAAG;aACtD,CAAC,CAAC,CAAA;YAEH,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAA;QACrB,CAAC;QAED,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE;YAC3C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;YACrD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,KAAK,GAAG,CAAC,CAAA;YAC3E,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAA;YAE3D,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;QAED,KAAK,EAAE,KAAK,EAAC,OAAO,EAAC,EAAE;YACrB,MAAM,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAA;QAC5C,CAAC;QAED,OAAO,EAAE,QAAQ,CAAC,EAAE;YAClB,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC1B,CAAC;KACF,CAAC,CAAA;IAEF,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAED,gGAAgG;AAChG,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAC3C,OAAgC,EAAE,IAAI,GAAuC,EAAE,EACzE,EAAE;IACR,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,yBAAyB,CAAA;IACrD,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,CAAC,eAAe,CAAC,2BAA2B,CAAC,IAAI,CAAC,CAAC,CAAA;IAC5D,CAAC;AACH,CAAC,CAAA"}

package/build/subject.d.ts

@@ -0,0 +1,21 @@
+import type { AbstractRequest } from '@owlmeans/entrypoint';
+/** Who a consent decision or a terms acceptance is recorded for. */
+export interface MarketingConsentSubject {
+    userId: string;
+    profileId?: string;
+    entityId?: string;
+}
+/**
+ * Read the subject off an authenticated request.
+ *
+ * `entityId` is read ONLY from `req.entity?.id` — never `requireEntityKey`, never a slug. A
+ * deployment with no organization concept at all (an end-user-facing generated target app, say)
+ * registers no entity resolver, so `req.entity` stays `undefined` and `entityId` is simply absent
+ * here — that is a valid, expected shape, not an error.
+ *
+ * @throws {AuthForbidden} when the request carries no authenticated user.
+ */
+export declare const subjectOf: (req: AbstractRequest) => MarketingConsentSubject;
+/** One string key per subject — the state record's own `id`. */
+export declare const subjectKey: (subject: MarketingConsentSubject) => string;
+//# sourceMappingURL=subject.d.ts.map

package/build/subject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subject.d.ts","sourceRoot":"","sources":["../src/subject.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,oEAAoE;AACpE,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,SAAS,QAAS,eAAe,KAAG,uBAOhD,CAAA;AAED,gEAAgE;AAChE,eAAO,MAAM,UAAU,YAAa,uBAAuB,KAAG,MACY,CAAA"}

package/build/subject.js

@@ -0,0 +1,21 @@
+import { AuthForbidden } from '@owlmeans/auth';
+/**
+ * Read the subject off an authenticated request.
+ *
+ * `entityId` is read ONLY from `req.entity?.id` — never `requireEntityKey`, never a slug. A
+ * deployment with no organization concept at all (an end-user-facing generated target app, say)
+ * registers no entity resolver, so `req.entity` stays `undefined` and `entityId` is simply absent
+ * here — that is a valid, expected shape, not an error.
+ *
+ * @throws {AuthForbidden} when the request carries no authenticated user.
+ */
+export const subjectOf = (req) => {
+    const userId = req.auth?.userId;
+    if (userId == null || userId === '') {
+        throw new AuthForbidden('marketing-consent: no authenticated user');
+    }
+    return { userId, profileId: req.auth?.profileId, entityId: req.entity?.id };
+};
+/** One string key per subject — the state record's own `id`. */
+export const subjectKey = (subject) => `${subject.entityId ?? ''}|${subject.userId}|${subject.profileId ?? ''}`;
+//# sourceMappingURL=subject.js.map

package/build/subject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subject.js","sourceRoot":"","sources":["../src/subject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAU9C;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAoB,EAA2B,EAAE;IACzE,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,EAAE,MAAM,CAAA;IAC/B,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;QACpC,MAAM,IAAI,aAAa,CAAC,0CAA0C,CAAC,CAAA;IACrE,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,EAAE,CAAA;AAC7E,CAAC,CAAA;AAED,gEAAgE;AAChE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,OAAgC,EAAU,EAAE,CACrE,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,SAAS,IAAI,EAAE,EAAE,CAAA"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@owlmeans/server-marketing-consent",
+  "version": "0.1.18-rc.0",
+  "license": "MIT",
+  "description": "The server half of @owlmeans/marketing-consent — a database-agnostic MarketingConsentService (status/save/terms/purge over resources resolved by alias) plus the guarded status/save/terms entrypoint handlers.",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "sleep 2 && nodemon -e ts,tsx,json --watch src --exec \"tsc -p ./tsconfig.json\"",
+    "watch": "tsc -b -w --preserveWatchOutput --pretty",
+    "test": "bun test ./tests"
+  },
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "require": "./build/index.js",
+      "default": "./build/index.js",
+      "module": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "@owlmeans/auth": "^0.1.18-rc.31",
+    "@owlmeans/auth-common": "^0.1.18-rc.33",
+    "@owlmeans/context": "^0.1.18-rc.29",
+    "@owlmeans/entrypoint": "^0.1.18-rc.32",
+    "@owlmeans/error": "^0.1.18-rc.31",
+    "@owlmeans/marketing-consent": "^0.1.18-rc.0",
+    "@owlmeans/resource": "^0.1.18-rc.31",
+    "@owlmeans/server-api": "^0.1.18-rc.37",
+    "@owlmeans/server-auth-token": "^0.1.18-rc.18",
+    "@owlmeans/server-context": "^0.1.18-rc.32",
+    "@owlmeans/server-entrypoint": "^0.1.18-rc.31"
+  },
+  "peerDependencies": {
+    "ajv": "*"
+  },
+  "devDependencies": {
+    "@owlmeans/dep-config": "workspace:*",
+    "@owlmeans/static-resource": "^0.1.18-rc.29",
+    "@owlmeans/test": "^0.1.18-rc.29",
+    "@owlmeans/test-auth": "^0.1.18-rc.32",
+    "@types/bun": "^1.4.0",
+    "ajv": "^8.17.1",
+    "nodemon": "^3.1.14",
+    "typescript": "^7.0.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/consts.ts

@@ -0,0 +1,11 @@
+/**
+ * The two resource aliases a Mongo/Postgres extension package (`@owlmeans/marketing-consent-mongo`,
+ * `@owlmeans/marketing-consent-postgres` — later workstreams, not built yet) registers its concrete
+ * resources under.
+ *
+ * These string values matter beyond this package: a target project's generated resource FILE names
+ * are derived from an alias via a deterministic `resourceAlias()` helper elsewhere in the monorepo
+ * (`entity/type` -> `entity-type`). Keep them exactly as declared here.
+ */
+export const RES_MARKETING_CONSENT_STATE = 'marketing-consent-state'
+export const RES_MARKETING_CONSENT_LOG = 'marketing-consent-log'

package/src/handlers.ts

@@ -0,0 +1,44 @@
+import { MARKETING_CONSENT_SERVICE } from '@owlmeans/marketing-consent'
+import type { MarketingConsentEntrypoints } from '@owlmeans/marketing-consent'
+import { handlers } from '@owlmeans/server-api'
+import { refuseTokenAuth } from '@owlmeans/server-auth-token'
+import type { MarketingConsentContext, MarketingConsentService } from './service.js'
+import { subjectOf } from './subject.js'
+
+export interface MarketingConsentHandlerOptions {
+  serviceAlias?: string
+  /** Let an OAuth-minted access token save decisions or record terms too. Defaults to `false` —
+   * `status` is never token-refused regardless of this option. */
+  allowAccessTokens?: boolean
+}
+
+const serviceOf = (context: MarketingConsentContext, opts?: MarketingConsentHandlerOptions): MarketingConsentService =>
+  context.service<MarketingConsentService>(opts?.serviceAlias ?? MARKETING_CONSENT_SERVICE)
+
+/** GPC ("Sec-GPC: 1") read as a plain header — Fastify normalizes header names to lower case, and
+ * a repeated header arrives as an array, so only its first value is read. */
+const gpcOf = (headers: Record<string, string[] | string | undefined>): boolean => {
+  const raw = headers['sec-gpc']
+  return (Array.isArray(raw) ? raw[0] : raw) === '1'
+}
+
+export const marketingConsentStatus = (
+  protocol: MarketingConsentEntrypoints['status'], opts: MarketingConsentHandlerOptions = {},
+) => handlers<MarketingConsentContext>().request(protocol, async (req, context) =>
+  serviceOf(context, opts).status(subjectOf(req), { gpc: gpcOf(req.headers ?? {}) }))
+
+export const saveMarketingConsent = (
+  protocol: MarketingConsentEntrypoints['save'], opts: MarketingConsentHandlerOptions = {},
+) => handlers<MarketingConsentContext>().body(protocol, async (payload, context, req) => {
+  if (opts.allowAccessTokens !== true) refuseTokenAuth(req, 'marketing-consent-save')
+
+  return serviceOf(context, opts).save(subjectOf(req), payload)
+})
+
+export const recordTermsAcceptance = (
+  protocol: MarketingConsentEntrypoints['terms'], opts: MarketingConsentHandlerOptions = {},
+) => handlers<MarketingConsentContext>().body(protocol, async (payload, context, req) => {
+  if (opts.allowAccessTokens !== true) refuseTokenAuth(req, 'marketing-consent-terms')
+
+  return serviceOf(context, opts).recordTerms(subjectOf(req), payload)
+})

package/src/helper.ts

@@ -0,0 +1,18 @@
+import { bind } from '@owlmeans/server-entrypoint'
+import type { MarketingConsentEntrypoints } from '@owlmeans/marketing-consent'
+import { marketingConsentStatus, recordTermsAcceptance, saveMarketingConsent } from './handlers.js'
+import type { MarketingConsentHandlerOptions } from './handlers.js'
+
+/**
+ * Bind this package's handlers to a tree declared by `makeMarketingConsentProtocols` — one binding
+ * per protocol that needs a server implementation. `base` and `screen` carry no handler of their
+ * own (a mounting anchor and a frontend address, the same shape as `@owlmeans/oauth`'s own consent
+ * screens) and are left for the application's route tree to materialize.
+ */
+export const serveMarketingConsentEntrypoints = (
+  protocols: MarketingConsentEntrypoints, opts: MarketingConsentHandlerOptions = {},
+) => [
+  bind(protocols.status, marketingConsentStatus(protocols.status, opts)),
+  bind(protocols.save, saveMarketingConsent(protocols.save, opts)),
+  bind(protocols.terms, recordTermsAcceptance(protocols.terms, opts)),
+]

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './consts.js'
+export * from './model.js'
+export * from './subject.js'
+export * from './service.js'
+export * from './handlers.js'
+export * from './helper.js'

package/src/model.ts

@@ -0,0 +1,147 @@
+import type { JSONSchemaType } from 'ajv'
+import type { ResourceRecord } from '@owlmeans/resource'
+import type {
+  MarketingConsentDecision, MarketingConsentMode, MarketingConsentSource, TermsDocumentRef,
+} from '@owlmeans/marketing-consent'
+
+/**
+ * One subject's saved decisions, one record per subject (`id` = `subjectKey(subject)`).
+ *
+ * `decisions` is an ARRAY, never an object keyed by consent key. A dotted key such as
+ * `"marketing.email"` is read as a PATH by both Mongo dot-notation queries and Postgres jsonb path
+ * operators — an object-keyed shape breaks the moment a second consent key is added. This is the
+ * single most important shape decision in this package; the Mongo/Postgres extensions that will
+ * store this record must not "flatten" it into an object for convenience.
+ */
+export interface MarketingConsentStateRecord extends ResourceRecord {
+  id: string
+  /** `subjectKey(subjectOf(req))` — see `./subject.js`. Also this record's own `id`. */
+  subject: string
+  userId: string
+  profileId?: string
+  entityId?: string
+  decisions: MarketingConsentDecision[]
+  terms?: {
+    documents: TermsDocumentRef[]
+    notices?: TermsDocumentRef[]
+    version: string
+    locale?: string
+    acceptedAt: string
+  }
+  gpc?: boolean
+  createdAt: string
+  updatedAt: string
+}
+
+/**
+ * Append-only evidence of every decision and terms acceptance ever recorded — GDPR Art. 7(1)
+ * "demonstrate consent" material. Never updated or deleted, including on `purge()`: only the
+ * current-state record is cleared there.
+ */
+export interface MarketingConsentLogRecord extends ResourceRecord {
+  id: string
+  subject: string
+  userId: string
+  profileId?: string
+  entityId?: string
+  kind: 'consent' | 'terms'
+  /** Present when `kind === 'consent'`. */
+  key?: string
+  granted?: boolean
+  revisedAt?: string
+  mode?: MarketingConsentMode
+  /** Present when `kind === 'terms'`. */
+  documents?: TermsDocumentRef[]
+  notices?: TermsDocumentRef[]
+  version?: string
+  decidedAt: string
+  source: MarketingConsentSource
+  locale?: string
+  gpc?: boolean
+}
+
+// `@owlmeans/marketing-consent`'s own `TermsDocumentRefSchema` (in its `src/schemas.ts`) is not
+// exported, so the shape is re-declared here rather than imported.
+const TermsDocumentRefSchema: JSONSchemaType<TermsDocumentRef> = {
+  type: 'object',
+  properties: {
+    key: { type: 'string', minLength: 1, maxLength: 128 },
+    href: { type: 'string', minLength: 1, maxLength: 2048 },
+    revisedAt: { type: 'string', nullable: true },
+  },
+  required: ['key', 'href'],
+  additionalProperties: false,
+}
+
+const MarketingConsentDecisionSchema: JSONSchemaType<MarketingConsentDecision> = {
+  type: 'object',
+  properties: {
+    key: { type: 'string', minLength: 1, maxLength: 64 },
+    granted: { type: 'boolean' },
+    revisedAt: { type: 'string', minLength: 1 },
+    mode: { type: 'string', enum: ['opt-in', 'opt-out'] },
+    decidedAt: { type: 'string', minLength: 1 },
+    source: { type: 'string', enum: ['sign-in', 'settings', 'cookie', 'api'] },
+  },
+  required: ['key', 'granted', 'revisedAt', 'mode', 'decidedAt', 'source'],
+  additionalProperties: false,
+}
+
+/**
+ * Shared with the Mongo/Postgres extension packages this schema is built for — imported by them,
+ * never duplicated.
+ */
+export const MarketingConsentStateSchema: JSONSchemaType<MarketingConsentStateRecord> = {
+  type: 'object',
+  properties: {
+    id: { type: 'string', minLength: 1 },
+    subject: { type: 'string', minLength: 1 },
+    userId: { type: 'string', minLength: 1 },
+    profileId: { type: 'string', nullable: true },
+    entityId: { type: 'string', nullable: true },
+    decisions: { type: 'array', items: MarketingConsentDecisionSchema },
+    terms: {
+      type: 'object',
+      nullable: true,
+      properties: {
+        documents: { type: 'array', items: TermsDocumentRefSchema },
+        notices: { type: 'array', items: TermsDocumentRefSchema, nullable: true },
+        version: { type: 'string', minLength: 1 },
+        locale: { type: 'string', nullable: true },
+        acceptedAt: { type: 'string', minLength: 1 },
+      },
+      required: ['documents', 'version', 'acceptedAt'],
+      additionalProperties: false,
+    },
+    gpc: { type: 'boolean', nullable: true },
+    createdAt: { type: 'string', minLength: 1 },
+    updatedAt: { type: 'string', minLength: 1 },
+  },
+  required: ['id', 'subject', 'userId', 'decisions', 'createdAt', 'updatedAt'],
+  additionalProperties: false,
+}
+
+export const MarketingConsentLogSchema: JSONSchemaType<MarketingConsentLogRecord> = {
+  type: 'object',
+  properties: {
+    id: { type: 'string', minLength: 1 },
+    subject: { type: 'string', minLength: 1 },
+    userId: { type: 'string', minLength: 1 },
+    profileId: { type: 'string', nullable: true },
+    entityId: { type: 'string', nullable: true },
+    kind: { type: 'string', enum: ['consent', 'terms'] },
+    key: { type: 'string', nullable: true },
+    granted: { type: 'boolean', nullable: true },
+    revisedAt: { type: 'string', nullable: true },
+    mode: { type: 'string', enum: ['opt-in', 'opt-out'], nullable: true },
+    documents: { type: 'array', items: TermsDocumentRefSchema, nullable: true },
+    notices: { type: 'array', items: TermsDocumentRefSchema, nullable: true },
+    version: { type: 'string', nullable: true },
+    decidedAt: { type: 'string', minLength: 1 },
+    source: { type: 'string', enum: ['sign-in', 'settings', 'cookie', 'api'] },
+    locale: { type: 'string', nullable: true },
+    gpc: { type: 'boolean', nullable: true },
+  },
+  required: ['id', 'subject', 'userId', 'kind', 'decidedAt', 'source'],
+  additionalProperties: false,
+}