@c15t/backend 0.0.1-rc.10

package/dist/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,KAAK,mBAAmB,EAExB,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAUpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,YAAY,CAC3B,WAAW,SAAS,WAAW,EAC/B,WAAW,SAAS,WAAW,EAC9B,GAAG,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,EAAE,OAAO,EAAE,WAAW;SA6DjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kEA5C+B,UAAU;mBAGtC,MAAM,YAAY;6FAyCY;;;;;EAG9C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,eAAO,MAAM,MAAM,GAClB,WAAW,SAAS,WAAW,EAC/B,WAAW,SAAS,WAAW,EAE/B,KAAK,WAAW,EAChB,SAAS,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kEAlGwB,UAAU;mBAGtC,MAAM,YAAY;;CAoOlC,CAAC;AAIF,cAAc,QAAQ,CAAC;AACvB,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC"}

package/dist/api/middlewares/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * C15T Middleware Exports
+ *
+ * This barrel file exports all middlewares used by the C15T consent management system.
+ * Middlewares handle cross-cutting concerns like security, validation, and context
+ * enrichment for API endpoints.
+ *
+ * @module middlewares
+ *
+ * @remarks
+ * The middlewares in this directory implement various security and validation
+ * requirements for the consent management API. They can be applied globally to
+ * all routes or selectively to specific endpoint groups.
+ *
+ * Currently included middlewares:
+ * - Origin check middleware: Validates URLs against trusted origins to prevent CSRF
+ *   and open redirect vulnerabilities
+ *
+ * @example
+ * ```typescript
+ * // Import all middlewares
+ * import { originCheckMiddleware, originCheck } from '~/api/middlewares';
+ *
+ * // Apply middleware to a router
+ * const router = createRouter(endpoints, {
+ *   routerMiddleware: [
+ *     {
+ *       path: '/**',
+ *       middleware: originCheckMiddleware
+ *     }
+ *   ]
+ * });
+ *
+ * // Create a targeted middleware for a specific field
+ * const validateReturnUrl = originCheck(ctx => ctx.body?.returnUrl);
+ * ```
+ */
+export * from './origin-check';
+//# sourceMappingURL=index.d.ts.map

package/dist/api/middlewares/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/middlewares/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,cAAc,gBAAgB,CAAC"}

package/dist/api/middlewares/origin-check.d.ts

@@ -0,0 +1,82 @@
+import type { GenericEndpointContext } from '../../types';
+/**
+ * Middleware that validates request origins and callback URLs against trusted origins
+ *
+ * This middleware performs security checks to prevent cross-site request forgery (CSRF)
+ * and open redirect vulnerabilities by validating various URLs in the request against
+ * a list of trusted origins configured in the C15T context.
+ *
+ * @remarks
+ * The middleware checks the following URLs from request body and headers:
+ * - Origin/Referer header (when cookies are used and CSRF checks are enabled)
+ * - callbackURL
+ * - redirectTo
+ * - errorCallbackURL
+ * - newSubjectCallbackURL
+ *
+ * URLs are validated using exact matching for origins and wildcard pattern matching
+ * for hostnames. Relative URLs are allowed for callback URLs but must match a safe
+ * URL pattern.
+ *
+ * @throws {C15TError} Throws a FORBIDDEN error if any URL fails validation
+ *
+ * @example
+ * ```typescript
+ * import { c15tInstance } from '@c15t/backend';
+ * // This middleware is typically used in router configuration
+ * const router = createRouter(endpoints, {
+ *   routerMiddleware: [
+ *     {
+ *       path: '/**',
+ *       middleware: originCheckMiddleware
+ *     }
+ *   ]
+ * });
+ *
+ * // To configure trusted origins in your C15T options:
+ * const c15t = c15tInstance({
+ *   // Static list of trusted origins
+ *   trustedOrigins: [
+ *     'https://example.com',
+ *     'https://*.example.org'
+ *   ]
+ *
+ *   // Or a function to dynamically determine trusted origins
+ *   trustedOrigins: (request) => {
+ *     const host = new URL(request.url).host;
+ *     return [`https://${host}`, `http://${host}`];
+ *   }
+ * });
+ * ```
+ */
+export declare const originCheckMiddleware: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>;
+/**
+ * Creates a middleware that validates a specific URL against trusted origins
+ *
+ * This factory function creates a middleware for validating a single URL extracted
+ * from the request context against the list of trusted origins.
+ *
+ * @param getValue - A function that extracts the URL to validate from the endpoint context
+ * @returns A middleware that validates the extracted URL
+ * @throws {C15TError} Throws a FORBIDDEN error if the URL fails validation
+ *
+ * @remarks
+ * Unlike the more comprehensive originCheckMiddleware, this factory allows creating
+ * targeted middleware for specific URL fields or custom extraction logic.
+ *
+ * @example
+ * ```typescript
+ * // Create a middleware that validates the 'returnUrl' from request body
+ * const validateReturnUrl = originCheck(ctx => ctx.body?.returnUrl);
+ *
+ * // Use the middleware in a specific route
+ * router.post('/api/subscribe', validateReturnUrl, subscribeHandler);
+ *
+ * // Create a middleware that validates a URL from a custom header
+ * const validateHeaderUrl = originCheck(ctx =>
+ *   ctx.headers?.get('x-callback-url')
+ * );
+ * ```
+ */
+export declare const originCheck: (getValue: (ctx: GenericEndpointContext) => string) => (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<void>;
+//# sourceMappingURL=origin-check.d.ts.map

package/dist/api/middlewares/origin-check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"origin-check.d.ts","sourceRoot":"","sources":["../../../src/api/middlewares/origin-check.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AActD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,eAAO,MAAM,qBAAqB,wHAwFhC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,WAAW,GACvB,UAAU,CAAC,GAAG,EAAE,sBAAsB,KAAK,MAAM,2HA2E/C,CAAC"}

package/dist/api/middlewares/validate-context.d.ts

@@ -0,0 +1,38 @@
+import type { C15TContext } from '../../types';
+/**
+ * Middleware that validates the context for all routes
+ *
+ * This middleware ensures that the context object is properly structured and
+ * contains all required properties and services before allowing the request to proceed.
+ *
+ * @remarks
+ * The middleware performs comprehensive validation of:
+ * - Basic context structure
+ * - Required configuration options
+ * - Storage adapter availability
+ * - Logger availability
+ * - Plugin initialization status
+ * - Required services and dependencies
+ *
+ * @throws {C15TError} Throws appropriate errors for:
+ * - INVALID_CONFIGURATION: When context or options are invalid
+ * - STORAGE_ERROR: When storage adapter is not available
+ * - INITIALIZATION_FAILED: When required services failed to initialize
+ *
+ * @example
+ * ```typescript
+ * // Using with memory adapter
+ * const router = createRouter(endpoints, {
+ *   routerMiddleware: [
+ *     {
+ *       path: '/**',
+ *       middleware: validateContextMiddleware
+ *     }
+ *   ]
+ * });
+ * ```
+ */
+export declare const validateContextMiddleware: (inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<{
+    context: C15TContext;
+}>;
+//# sourceMappingURL=validate-context.d.ts.map

package/dist/api/middlewares/validate-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-context.d.ts","sourceRoot":"","sources":["../../../src/api/middlewares/validate-context.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAqDvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,yBAAyB;;EAuFpC,CAAC"}

package/dist/api/routes/__tests__/consent.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=consent.test.d.ts.map

package/dist/api/routes/__tests__/consent.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consent.test.d.ts","sourceRoot":"","sources":["../../../../src/api/routes/__tests__/consent.test.ts"],"names":[],"mappings":""}

package/dist/api/routes/__tests__/status.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=status.test.d.ts.map

package/dist/api/routes/__tests__/status.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.test.d.ts","sourceRoot":"","sources":["../../../../src/api/routes/__tests__/status.test.ts"],"names":[],"mappings":""}

package/dist/api/routes/error.d.ts

@@ -0,0 +1,57 @@
+export declare const error: {
+    <C extends [(import("better-call").InputContext<"/error", {
+        method: "GET";
+        metadata: {
+            openapi: {
+                description: string;
+                responses: {
+                    '400': {
+                        description: string;
+                        content: {
+                            'text/html': {
+                                schema: {
+                                    type: "string";
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            isAction: false;
+        };
+    } & {
+        use: any[];
+    }> | undefined)?]>(...inputCtx: C): Promise<C extends [{
+        asResponse: true;
+    }] ? Response : C extends [{
+        returnHeaders: true;
+    }] ? {
+        headers: Headers;
+        response: Response;
+    } : Response>;
+    options: {
+        method: "GET";
+        metadata: {
+            openapi: {
+                description: string;
+                responses: {
+                    '400': {
+                        description: string;
+                        content: {
+                            'text/html': {
+                                schema: {
+                                    type: "string";
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            isAction: false;
+        };
+    } & {
+        use: any[];
+    };
+    path: "/error";
+};
+//# sourceMappingURL=error.d.ts.map

package/dist/api/routes/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../src/api/routes/error.ts"],"names":[],"mappings":"AAgGA,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCjB,CAAC"}

package/dist/api/routes/generate-consent-receipt.d.ts

@@ -0,0 +1,130 @@
+import { z } from 'zod';
+/**
+ * Endpoint for generating a standardized consent receipt.
+ *
+ * This endpoint generates a detailed receipt document that provides formal proof of consent,
+ * following industry standards for consent documentation. The receipt includes comprehensive
+ * information about who gave consent, what they consented to, and all metadata associated
+ * with the consent event.
+ *
+ * Optionally, the receipt can include a cryptographic signature for verification purposes.
+ *
+ * @endpoint GET /consent/receipt
+ */
+export declare const generateConsentReceipt: {
+    <C extends [import("better-call").InputContext<"/consent/receipt", {
+        method: "GET";
+        query: z.ZodObject<{
+            consentId: z.ZodString;
+            includeSignature: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            consentId: string;
+            includeSignature: boolean;
+        }, {
+            consentId: string;
+            includeSignature?: boolean | undefined;
+        }>;
+    } & {
+        use: any[];
+    }>]>(...inputCtx: C): Promise<C extends [{
+        asResponse: true;
+    }] ? Response : C extends [{
+        returnHeaders: true;
+    }] ? {
+        headers: Headers;
+        response: {
+            success: boolean;
+            data: {
+                receipt: {
+                    version: string;
+                    jurisdiction: string;
+                    consentTimestamp: any;
+                    collectionMethod: any;
+                    consentReceiptID: string;
+                    publicKey: string;
+                    subject: {
+                        id: any;
+                        idType: string;
+                    };
+                    dataController: {
+                        id: any;
+                        name: any;
+                        on_behalf: never[];
+                    };
+                    policyURL: string;
+                    services: {
+                        service: string;
+                        purposes: {
+                            consentPurpose: string;
+                            purposeDescription: string;
+                            consentType: string;
+                            purposeCategory: string[];
+                            termination: string;
+                            thirdPartyDisclosure: boolean;
+                        }[];
+                    }[];
+                    sensitive: boolean;
+                    spiCat: never[];
+                    metadata: any;
+                };
+                receiptId: string;
+                timestamp: string;
+            };
+        };
+    } : {
+        success: boolean;
+        data: {
+            receipt: {
+                version: string;
+                jurisdiction: string;
+                consentTimestamp: any;
+                collectionMethod: any;
+                consentReceiptID: string;
+                publicKey: string;
+                subject: {
+                    id: any;
+                    idType: string;
+                };
+                dataController: {
+                    id: any;
+                    name: any;
+                    on_behalf: never[];
+                };
+                policyURL: string;
+                services: {
+                    service: string;
+                    purposes: {
+                        consentPurpose: string;
+                        purposeDescription: string;
+                        consentType: string;
+                        purposeCategory: string[];
+                        termination: string;
+                        thirdPartyDisclosure: boolean;
+                    }[];
+                }[];
+                sensitive: boolean;
+                spiCat: never[];
+                metadata: any;
+            };
+            receiptId: string;
+            timestamp: string;
+        };
+    }>;
+    options: {
+        method: "GET";
+        query: z.ZodObject<{
+            consentId: z.ZodString;
+            includeSignature: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            consentId: string;
+            includeSignature: boolean;
+        }, {
+            consentId: string;
+            includeSignature?: boolean | undefined;
+        }>;
+    } & {
+        use: any[];
+    };
+    path: "/consent/receipt";
+};
+//# sourceMappingURL=generate-consent-receipt.d.ts.map

package/dist/api/routes/generate-consent-receipt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-consent-receipt.d.ts","sourceRoot":"","sources":["../../../src/api/routes/generate-consent-receipt.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAYxB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0NlC,CAAC"}

package/dist/api/routes/get-consent-history.d.ts

@@ -0,0 +1,133 @@
+import { z } from 'zod';
+/**
+ * Endpoint for retrieving a subject's complete consent history.
+ *
+ * This endpoint returns comprehensive information about a subject's consent records,
+ * including all consent entries, withdrawals, related evidence records, and audit logs.
+ * It supports optional domain filtering and pagination to manage large result sets.
+ *
+ * @endpoint GET /consent/history
+ */
+export declare const getConsentHistory: {
+    <C extends [import("better-call").InputContext<"/consent/history", {
+        method: "GET";
+        query: z.ZodObject<{
+            subjectId: z.ZodString;
+            domain: z.ZodOptional<z.ZodString>;
+            limit: z.ZodDefault<z.ZodNumber>;
+            offset: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            subjectId: string;
+            limit: number;
+            offset: number;
+            domain?: string | undefined;
+        }, {
+            subjectId: string;
+            domain?: string | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+        }>;
+    } & {
+        use: any[];
+    }>]>(...inputCtx: C): Promise<C extends [{
+        asResponse: true;
+    }] ? Response : C extends [{
+        returnHeaders: true;
+    }] ? {
+        headers: Headers;
+        response: {
+            success: boolean;
+            data: {
+                consents: {
+                    id: string;
+                    domainId: string;
+                    status: string;
+                    givenAt: string;
+                    consentWithdrawals: {
+                        id: string;
+                        createdAt: string;
+                        reason: string | undefined;
+                        method: "subject-initiated" | "automatic-expiry" | "admin" | "api" | "other";
+                        actor: {};
+                        metadata: Record<string, unknown> | undefined;
+                    }[];
+                    consentRecords: {
+                        id: string;
+                        createdAt: string;
+                        type: string;
+                        details: string;
+                    }[];
+                }[];
+                auditLogs: {
+                    id: string;
+                    createdAt: string;
+                    actionType: string;
+                    details: Record<string, unknown>;
+                }[];
+                pagination: {
+                    total: number;
+                    offset: number;
+                    limit: number;
+                };
+            };
+        };
+    } : {
+        success: boolean;
+        data: {
+            consents: {
+                id: string;
+                domainId: string;
+                status: string;
+                givenAt: string;
+                consentWithdrawals: {
+                    id: string;
+                    createdAt: string;
+                    reason: string | undefined;
+                    method: "subject-initiated" | "automatic-expiry" | "admin" | "api" | "other";
+                    actor: {};
+                    metadata: Record<string, unknown> | undefined;
+                }[];
+                consentRecords: {
+                    id: string;
+                    createdAt: string;
+                    type: string;
+                    details: string;
+                }[];
+            }[];
+            auditLogs: {
+                id: string;
+                createdAt: string;
+                actionType: string;
+                details: Record<string, unknown>;
+            }[];
+            pagination: {
+                total: number;
+                offset: number;
+                limit: number;
+            };
+        };
+    }>;
+    options: {
+        method: "GET";
+        query: z.ZodObject<{
+            subjectId: z.ZodString;
+            domain: z.ZodOptional<z.ZodString>;
+            limit: z.ZodDefault<z.ZodNumber>;
+            offset: z.ZodDefault<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            subjectId: string;
+            limit: number;
+            offset: number;
+            domain?: string | undefined;
+        }, {
+            subjectId: string;
+            domain?: string | undefined;
+            limit?: number | undefined;
+            offset?: number | undefined;
+        }>;
+    } & {
+        use: any[];
+    };
+    path: "/consent/history";
+};
+//# sourceMappingURL=get-consent-history.d.ts.map

package/dist/api/routes/get-consent-history.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-consent-history.d.ts","sourceRoot":"","sources":["../../../src/api/routes/get-consent-history.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAcxB;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BA4CE,MAAM;;;;;;;;;;;;;;;;;;wBA0B9B,MAAM;+BACC,MAAM;gCACL,MAAM;6BACT,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;;;;;;;;;wBA7BJ,MAAM;;;;;;;;;;;;;;;;;;oBA0B9B,MAAM;2BACC,MAAM;4BACL,MAAM;yBACT,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BnC,CAAC"}