@c15t/backend 0.0.1-rc.10

package/dist/db/schema/consent/index.d.ts

@@ -0,0 +1,4 @@
+export * from './registry';
+export * from './schema';
+export * from './table';
+//# sourceMappingURL=index.d.ts.map

package/dist/db/schema/consent/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/db/schema/consent/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC"}

package/dist/db/schema/consent/registry.d.ts

@@ -0,0 +1,318 @@
+import type { GenericEndpointContext, RegistryContext } from '../../../types';
+import type { Consent } from './schema';
+export interface FindConsentsParams {
+    subjectId?: string;
+    domainId?: string;
+    status?: string;
+    purposeIds?: string[];
+    includeInactive?: boolean;
+}
+export interface RevokeConsentParams {
+    consentId: string;
+    reason: string;
+    actor: string;
+    metadata?: Record<string, unknown>;
+    context?: GenericEndpointContext;
+}
+/**
+ * Creates and returns a set of consent-related adapter methods to interact with the database.
+ * These methods provide a consistent interface for creating, finding, and updating
+ * consent records while applying hooks and enforcing data validation rules.
+ *
+ * @param adapter - The database adapter used for direct database operations
+ * @param ctx - The context object containing the database adapter, hooks, and options
+ * @returns An object containing type-safe consent operations
+ *
+ * @example
+ * ```typescript
+ * const consentAdapter = createConsentAdapter(
+ *   databaseAdapter,
+ *   createWithHooks,
+ *   updateWithHooks,
+ *   c15tOptions
+ * );
+ *
+ * // Create a new consent record
+ * const consent = await consentAdapter.createConsent({
+ *   subjectId: 'sub_x1pftyoufsm7xgo1kv',
+ *   domainId: 'dom_x1pftyoufsm7xgo1kv',
+ *   purposeIds: ['pur_e8zyhgozr3im7xj59it'],
+ *   status: 'active'
+ * });
+ * ```
+ */
+export declare function consentRegistry({ adapter, ...ctx }: RegistryContext): {
+    /**
+     * Creates a new consent record in the database.
+     * Automatically sets creation timestamp and applies any
+     * configured hooks during the creation process.
+     *
+     * @param consent - Consent data to create (without id and timestamp)
+     * @param context - Optional endpoint context for hooks
+     * @returns The created consent with all fields populated
+     * @throws May throw an error if hooks prevent creation or if database operations fail
+     */
+    createConsent: (consent: Omit<Consent, "id" | "createdAt"> & Partial<Consent>, context?: GenericEndpointContext) => Promise<{
+        id: string;
+        subjectId: string;
+        status: "active" | "withdrawn" | "expired";
+        domainId: string;
+        purposeIds: string[];
+        givenAt: Date;
+        isActive: boolean;
+        history: {
+            actionType: "withdrawn" | "expired" | "given" | "updated";
+            timestamp: Date;
+            details?: Record<string, unknown> | undefined;
+            previousState?: Record<string, unknown> | undefined;
+            newState?: Record<string, unknown> | undefined;
+        }[];
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        policyId?: string | undefined;
+        withdrawalReason?: string | undefined;
+        validUntil?: Date | undefined;
+    }>;
+    /**
+     * Finds all consents matching specified filters.
+     * Returns consents with processed output fields according to the schema configuration.
+     *
+     * @param params - Filter parameters
+     * @returns Array of consents matching the criteria
+     */
+    findConsents: (params?: FindConsentsParams) => Promise<{
+        id: string;
+        subjectId: string;
+        status: "active" | "withdrawn" | "expired";
+        domainId: string;
+        purposeIds: string[];
+        givenAt: Date;
+        isActive: boolean;
+        history: {
+            actionType: "withdrawn" | "expired" | "given" | "updated";
+            timestamp: Date;
+            details?: Record<string, unknown> | undefined;
+            previousState?: Record<string, unknown> | undefined;
+            newState?: Record<string, unknown> | undefined;
+        }[];
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        policyId?: string | undefined;
+        withdrawalReason?: string | undefined;
+        validUntil?: Date | undefined;
+    }[]>;
+    /**
+     * Finds a consent by its unique ID.
+     * Returns the consent with processed output fields according to the schema configuration.
+     *
+     * @param consentId - The unique identifier of the consent
+     * @returns The consent object if found, null otherwise
+     */
+    findConsentById: (consentId: string) => Promise<{
+        id: string;
+        subjectId: string;
+        status: "active" | "withdrawn" | "expired";
+        domainId: string;
+        purposeIds: string[];
+        givenAt: Date;
+        isActive: boolean;
+        history: {
+            actionType: "withdrawn" | "expired" | "given" | "updated";
+            timestamp: Date;
+            details?: Record<string, unknown> | undefined;
+            previousState?: Record<string, unknown> | undefined;
+            newState?: Record<string, unknown> | undefined;
+        }[];
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        policyId?: string | undefined;
+        withdrawalReason?: string | undefined;
+        validUntil?: Date | undefined;
+    } | null>;
+    /**
+     * Finds all consents for a specific subject.
+     * Returns consents with processed output fields according to the schema configuration.
+     *
+     * @param subjectId - The subject ID to find consents for
+     * @returns Array of consents associated with the subject
+     */
+    findConsentsBySubjectId: (subjectId: string) => Promise<{
+        id: string;
+        subjectId: string;
+        status: "active" | "withdrawn" | "expired";
+        domainId: string;
+        purposeIds: string[];
+        givenAt: Date;
+        isActive: boolean;
+        history: {
+            actionType: "withdrawn" | "expired" | "given" | "updated";
+            timestamp: Date;
+            details?: Record<string, unknown> | undefined;
+            previousState?: Record<string, unknown> | undefined;
+            newState?: Record<string, unknown> | undefined;
+        }[];
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        policyId?: string | undefined;
+        withdrawalReason?: string | undefined;
+        validUntil?: Date | undefined;
+    }[]>;
+    /**
+     * Finds all consents for a specific domain.
+     * Returns consents with processed output fields according to the schema configuration.
+     *
+     * @param domainId - The domain ID to find consents for
+     * @returns Array of consents associated with the domain
+     */
+    findConsentsByDomainId: (domainId: string) => Promise<{
+        id: string;
+        subjectId: string;
+        status: "active" | "withdrawn" | "expired";
+        domainId: string;
+        purposeIds: string[];
+        givenAt: Date;
+        isActive: boolean;
+        history: {
+            actionType: "withdrawn" | "expired" | "given" | "updated";
+            timestamp: Date;
+            details?: Record<string, unknown> | undefined;
+            previousState?: Record<string, unknown> | undefined;
+            newState?: Record<string, unknown> | undefined;
+        }[];
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        policyId?: string | undefined;
+        withdrawalReason?: string | undefined;
+        validUntil?: Date | undefined;
+    }[]>;
+    /**
+     * Updates an existing consent record by ID.
+     * Applies any configured hooks during the update process and
+     * processes the output according to schema configuration.
+     *
+     * @param consentId - The unique identifier of the consent to update
+     * @param data - The fields to update on the consent record
+     * @param context - Optional endpoint context for hooks
+     * @returns The updated consent if successful, null if not found or hooks prevented update
+     */
+    updateConsent: (consentId: string, data: Partial<Consent>, context?: GenericEndpointContext) => Promise<{
+        id: string;
+        subjectId: string;
+        status: "active" | "withdrawn" | "expired";
+        domainId: string;
+        purposeIds: string[];
+        givenAt: Date;
+        isActive: boolean;
+        history: {
+            actionType: "withdrawn" | "expired" | "given" | "updated";
+            timestamp: Date;
+            details?: Record<string, unknown> | undefined;
+            previousState?: Record<string, unknown> | undefined;
+            newState?: Record<string, unknown> | undefined;
+        }[];
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        policyId?: string | undefined;
+        withdrawalReason?: string | undefined;
+        validUntil?: Date | undefined;
+    } | null>;
+    /**
+     * Updates consent status to withdrawn.
+     * Also records the withdrawal reason if provided.
+     *
+     * @param consentId - The unique identifier of the consent to update
+     * @param withdrawalReason - Optional reason for consentWithdrawal
+     * @param context - Optional endpoint context for hooks
+     * @returns The updated consent with withdrawn status
+     */
+    updateWithdrawal: (consentId: string, withdrawalReason?: string, context?: GenericEndpointContext) => Promise<{
+        id: string;
+        subjectId: string;
+        status: "active" | "withdrawn" | "expired";
+        domainId: string;
+        purposeIds: string[];
+        givenAt: Date;
+        isActive: boolean;
+        history: {
+            actionType: "withdrawn" | "expired" | "given" | "updated";
+            timestamp: Date;
+            details?: Record<string, unknown> | undefined;
+            previousState?: Record<string, unknown> | undefined;
+            newState?: Record<string, unknown> | undefined;
+        }[];
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        policyId?: string | undefined;
+        withdrawalReason?: string | undefined;
+        validUntil?: Date | undefined;
+    } | null>;
+    /**
+     * Revokes a consent and records the revocation details.
+     *
+     * @param params - Revocation parameters including reason and actor
+     * @returns The updated consent with revocation details
+     */
+    revokeConsent: ({ consentId, reason, actor, metadata, context, }: RevokeConsentParams) => Promise<{
+        id: string;
+        subjectId: string;
+        status: "active" | "withdrawn" | "expired";
+        domainId: string;
+        purposeIds: string[];
+        givenAt: Date;
+        isActive: boolean;
+        history: {
+            actionType: "withdrawn" | "expired" | "given" | "updated";
+            timestamp: Date;
+            details?: Record<string, unknown> | undefined;
+            previousState?: Record<string, unknown> | undefined;
+            newState?: Record<string, unknown> | undefined;
+        }[];
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        policyId?: string | undefined;
+        withdrawalReason?: string | undefined;
+        validUntil?: Date | undefined;
+    } | null>;
+    /**
+     * Gets all records associated with a consent.
+     *
+     * @param consentId - The ID of the consent
+     * @returns Array of records associated with the consent
+     */
+    getRecords: (consentId: string) => Promise<{
+        id: string;
+        actionType: string;
+        subjectId: string;
+        createdAt: Date;
+        updatedAt: Date;
+        details?: Record<string, unknown> | undefined;
+        consentId?: string | undefined;
+    }[]>;
+    /**
+     * Gets all consentWithdrawals associated with a consent.
+     *
+     * @param consentId - The ID of the consent
+     * @returns Array of consentWithdrawals associated with the consent
+     */
+    getWithdrawals: (consentId: string) => Promise<{
+        id: string;
+        subjectId: string;
+        createdAt: Date;
+        consentId: string;
+        updatedAt: Date;
+        withdrawalMethod: "subject-initiated" | "automatic-expiry" | "admin" | "api" | "other";
+        ipAddress?: string | undefined;
+        userAgent?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
+        withdrawalReason?: string | undefined;
+    }[]>;
+};
+//# sourceMappingURL=registry.d.ts.map

package/dist/db/schema/consent/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../../src/db/schema/consent/registry.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAEvE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAExC,MAAM,WAAW,kBAAkB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,sBAAsB,CAAC;CACjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,eAAe,CAAC,EAAE,OAAO,EAAE,GAAG,GAAG,EAAE,EAAE,eAAe;IAGlE;;;;;;;;;OASG;6BAEO,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,YACnD,sBAAsB;;;;;;;;;;;;;;;;;;;;;;IAkBjC;;;;;;OAMG;4BAC0B,kBAAkB;;;;;;;;;;;;;;;;;;;;;;IAqD/C;;;;;;OAMG;iCACgC,MAAM;;;;;;;;;;;;;;;;;;;;;;IAezC;;;;;;OAMG;yCACwC,MAAM;;;;;;;;;;;;;;;;;;;;;;IAmBjD;;;;;;OAMG;uCACsC,MAAM;;;;;;;;;;;;;;;;;;;;;;IAmB/C;;;;;;;;;OASG;+BAES,MAAM,QACX,OAAO,CAAC,OAAO,CAAC,YACZ,sBAAsB;;;;;;;;;;;;;;;;;;;;;;IAoBjC;;;;;;;;OAQG;kCAES,MAAM,qBACE,MAAM,YACf,sBAAsB;;;;;;;;;;;;;;;;;;;;;;IA2BjC;;;;;OAKG;sEAOA,mBAAmB;;;;;;;;;;;;;;;;;;;;;;IAsBtB;;;;;OAKG;4BAC2B,MAAM;;;;;;;;;IAoBpC;;;;;OAKG;gCAC+B,MAAM;;;;;;;;;;;;EA0BzC"}

package/dist/db/schema/consent/schema.d.ts

@@ -0,0 +1,135 @@
+import { z } from 'zod';
+/**
+ * Zod schema for validating consent entities.
+ *
+ * This defines the structure and validation rules for consent records:
+ * - Required fields: subjectId, domainId, purposeIds
+ * - Default value of 'active' for status
+ * - Default current date/time for creation timestamp
+ * - Includes audit trail of all changes
+ *
+ * @example
+ * ```typescript
+ * const consentData = {
+ *   id: 'cns_w5qufx2a66m7xkn3ty',
+ *   subjectId: 'sub_x1pftyoufsm7xgo1kv',
+ *   domainId: 'dom_x1pftyoufsm7xgo1kv',
+ *   purposeIds: ['pur_e8zyhgozr3im7xj59it'],
+ *   status: 'active',
+ *   givenAt: new Date(),
+ *   isActive: true,
+ *   history: [
+ *     {
+ *       actionType: 'given',
+ *       timestamp: new Date(),
+ *       details: { ip: '192.168.1.1' }
+ *     }
+ *   ]
+ * };
+ * ```
+ */
+export declare const consentHistorySchema: z.ZodObject<{
+    actionType: z.ZodEnum<["given", "withdrawn", "updated", "expired"]>;
+    timestamp: z.ZodDate;
+    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    previousState: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    newState: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    actionType: "withdrawn" | "expired" | "given" | "updated";
+    timestamp: Date;
+    details?: Record<string, unknown> | undefined;
+    previousState?: Record<string, unknown> | undefined;
+    newState?: Record<string, unknown> | undefined;
+}, {
+    actionType: "withdrawn" | "expired" | "given" | "updated";
+    timestamp: Date;
+    details?: Record<string, unknown> | undefined;
+    previousState?: Record<string, unknown> | undefined;
+    newState?: Record<string, unknown> | undefined;
+}>;
+export declare const consentSchema: z.ZodObject<{
+    id: z.ZodString;
+    subjectId: z.ZodString;
+    domainId: z.ZodString;
+    purposeIds: z.ZodArray<z.ZodString, "many">;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    policyId: z.ZodOptional<z.ZodString>;
+    ipAddress: z.ZodOptional<z.ZodString>;
+    userAgent: z.ZodOptional<z.ZodString>;
+    status: z.ZodDefault<z.ZodEnum<["active", "withdrawn", "expired"]>>;
+    withdrawalReason: z.ZodOptional<z.ZodString>;
+    givenAt: z.ZodDefault<z.ZodDate>;
+    validUntil: z.ZodOptional<z.ZodDate>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+    history: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        actionType: z.ZodEnum<["given", "withdrawn", "updated", "expired"]>;
+        timestamp: z.ZodDate;
+        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        previousState: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        newState: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        actionType: "withdrawn" | "expired" | "given" | "updated";
+        timestamp: Date;
+        details?: Record<string, unknown> | undefined;
+        previousState?: Record<string, unknown> | undefined;
+        newState?: Record<string, unknown> | undefined;
+    }, {
+        actionType: "withdrawn" | "expired" | "given" | "updated";
+        timestamp: Date;
+        details?: Record<string, unknown> | undefined;
+        previousState?: Record<string, unknown> | undefined;
+        newState?: Record<string, unknown> | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    subjectId: string;
+    status: "active" | "withdrawn" | "expired";
+    domainId: string;
+    purposeIds: string[];
+    givenAt: Date;
+    isActive: boolean;
+    history: {
+        actionType: "withdrawn" | "expired" | "given" | "updated";
+        timestamp: Date;
+        details?: Record<string, unknown> | undefined;
+        previousState?: Record<string, unknown> | undefined;
+        newState?: Record<string, unknown> | undefined;
+    }[];
+    ipAddress?: string | undefined;
+    userAgent?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
+    policyId?: string | undefined;
+    withdrawalReason?: string | undefined;
+    validUntil?: Date | undefined;
+}, {
+    id: string;
+    subjectId: string;
+    domainId: string;
+    purposeIds: string[];
+    ipAddress?: string | undefined;
+    userAgent?: string | undefined;
+    status?: "active" | "withdrawn" | "expired" | undefined;
+    metadata?: Record<string, unknown> | undefined;
+    policyId?: string | undefined;
+    withdrawalReason?: string | undefined;
+    givenAt?: Date | undefined;
+    validUntil?: Date | undefined;
+    isActive?: boolean | undefined;
+    history?: {
+        actionType: "withdrawn" | "expired" | "given" | "updated";
+        timestamp: Date;
+        details?: Record<string, unknown> | undefined;
+        previousState?: Record<string, unknown> | undefined;
+        newState?: Record<string, unknown> | undefined;
+    }[] | undefined;
+}>;
+/**
+ * Type definition for Consent
+ *
+ * This type represents the structure of a consent record
+ * as defined by the consentSchema. It includes all fields
+ * that are part of the consent entity and its history.
+ */
+export type Consent = z.infer<typeof consentSchema>;
+export type ConsentHistory = z.infer<typeof consentHistorySchema>;
+//# sourceMappingURL=schema.d.ts.map

package/dist/db/schema/consent/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/db/schema/consent/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;EAM/B,CAAC;AAEH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAexB,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}