@c15t/backend 1.5.0 → 1.6.0

package/src/contracts/consent/post.contract.ts

@@ -8,26 +8,26 @@ const baseConsentSchema = z.object({
 	externalSubjectId: z.string().optional(),
 	domain: z.string(),
 	type: PolicyTypeSchema,
-	metadata: z.record(z.unknown()).optional(),
+	metadata: z.record(z.string(), z.unknown()).optional(),
 });
 
 // Cookie banner needs preferences
 const cookieBannerSchema = baseConsentSchema.extend({
 	type: z.literal('cookie_banner'),
-	preferences: z.record(z.boolean()),
+	preferences: z.record(z.string(), z.boolean()),
 });
 
 // Policy based consent just needs the policy ID
 const policyBasedSchema = baseConsentSchema.extend({
 	type: z.enum(['privacy_policy', 'dpa', 'terms_and_conditions']),
 	policyId: z.string().optional(),
-	preferences: z.record(z.boolean()).optional(),
+	preferences: z.record(z.string(), z.boolean()).optional(),
 });
 
 // Other consent types just need the base fields
 const otherConsentSchema = baseConsentSchema.extend({
 	type: z.enum(['marketing_communications', 'age_verification', 'other']),
-	preferences: z.record(z.boolean()).optional(),
+	preferences: z.record(z.string(), z.boolean()).optional(),
 });
 
 export const postConsentContract = oc
@@ -67,69 +67,69 @@ Use this endpoint to record user consent and maintain a compliant consent manage
 		// Input validation errors
 		INPUT_VALIDATION_FAILED: {
 			status: 422,
-			message: 'Invalid input parameters',
 			data: z.object({
 				formErrors: z.array(z.string()),
 				fieldErrors: z.record(z.string(), z.array(z.string())),
 			}),
+			error: 'Invalid input parameters',
 		},
 		// Subject errors
 		SUBJECT_CREATION_FAILED: {
 			status: 400,
-			message: 'Failed to create or find subject',
 			data: z.object({
 				subjectId: z.string().optional(),
 				externalSubjectId: z.string().optional(),
 			}),
+			error: 'Failed to create or find subject',
 		},
 		// Domain errors
 		DOMAIN_CREATION_FAILED: {
 			status: 500,
-			message: 'Failed to create or find domain',
 			data: z.object({
 				domain: z.string(),
 			}),
+			error: 'Failed to create or find domain',
 		},
 		// Policy errors
 		POLICY_NOT_FOUND: {
 			status: 404,
-			message: 'Policy not found',
 			data: z.object({
 				policyId: z.string(),
 				type: z.string(),
 			}),
+			error: 'Policy not found',
 		},
 		POLICY_INACTIVE: {
 			status: 409,
-			message: 'Policy is not active',
 			data: z.object({
 				policyId: z.string(),
 				type: z.string(),
 			}),
+			error: 'Policy is not active',
 		},
 		POLICY_CREATION_FAILED: {
 			status: 500,
-			message: 'Failed to create or find policy',
 			data: z.object({
 				type: z.string(),
 			}),
+			error: 'Failed to create or find policy',
 		},
 		// Purpose errors
 		PURPOSE_CREATION_FAILED: {
 			status: 500,
-			message: 'Failed to create consent purpose',
 			data: z.object({
 				purposeCode: z.string(),
 			}),
+			error: 'Failed to create consent purpose',
 		},
 		// Transaction errors
 		CONSENT_CREATION_FAILED: {
 			status: 500,
-			message: 'Failed to create consent record',
 			data: z.object({
 				subjectId: z.string(),
 				domain: z.string(),
 			}),
+			error: 'Failed to create consent record',
 		},
 	})
 	.input(
@@ -149,7 +149,7 @@ Use this endpoint to record user consent and maintain a compliant consent manage
 			type: PolicyTypeSchema,
 			status: z.string(),
 			recordId: z.string(),
-			metadata: z.record(z.unknown()).optional(),
+			metadata: z.record(z.string(), z.unknown()).optional(),
 			givenAt: z.date(),
 		})
 	);

package/src/contracts/consent/show-banner.contract.test.ts

@@ -39,6 +39,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 						translations: baseTranslations.en,
 						language: 'en',
 					},
+					branding: 'c15t',
 				};
 
 				const result = validateOutput(validOutput);
@@ -84,6 +85,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 							translations: baseTranslations.en,
 							language: 'en',
 						},
+						branding: 'c15t',
 					};
 
 					const result = validateOutput(output);
@@ -106,6 +108,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 						translations: baseTranslations.en,
 						language: 'en',
 					},
+					branding: 'c15t',
 				};
 
 				const result = validateOutput(output);
@@ -129,6 +132,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 						translations: baseTranslations.en,
 						language: 'en',
 					},
+					branding: 'c15t',
 				};
 
 				const result = validateOutput(output);
@@ -150,6 +154,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 						translations: baseTranslations.en,
 						language: 'en',
 					},
+					branding: 'c15t',
 				};
 
 				const result = validateOutput(output);
@@ -171,6 +176,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 						translations: baseTranslations.en,
 						language: 'en',
 					},
+					branding: 'c15t',
 				};
 
 				// Need to use type assertion to bypass TypeScript
@@ -195,6 +201,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 						translations: baseTranslations.en,
 						language: 'en',
 					},
+					branding: 'c15t',
 				};
 
 				const falseOutput = {
@@ -211,6 +218,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 						translations: baseTranslations.en,
 						language: 'en',
 					},
+					branding: 'c15t',
 				};
 
 				expect(validateOutput(trueOutput)?.success).toBe(true);
@@ -232,6 +240,7 @@ describe('Show Consent Banner Contract Custom Tests', () => {
 						translations: baseTranslations.en,
 						language: 'en',
 					},
+					branding: 'c15t',
 				};
 
 				// Need to use type assertion to bypass TypeScript

package/src/contracts/consent/show-banner.contract.ts

@@ -1,5 +1,6 @@
 import { oc } from '@orpc/contract';
 import { z } from 'zod';
+import { branding } from '~/types';
 import { JurisdictionInfoSchema } from '../shared/jurisdiction.schema';
 
 const TitleDescriptionSchema = z.object({
@@ -67,5 +68,6 @@ Use this endpoint to implement geo-targeted consent banners and ensure complianc
 				language: z.string(),
 				translations: TranslationsSchema,
 			}),
+			branding: z.enum(branding),
 		})
 	);

package/src/contracts/consent/verify.contract.ts

@@ -8,24 +8,20 @@ import { PolicyTypeSchema } from '~/schema';
  */
 
 // Input schema based on VerifyConsentRequestBody
-const verifyConsentInputSchema = z
-	.object({
-		subjectId: z.string().optional(),
-		externalSubjectId: z.string().optional(),
-		domain: z.string(),
-		type: PolicyTypeSchema,
-		policyId: z.string().optional(),
-		preferences: z.array(z.string()).optional(),
-	})
-	.strict();
+const verifyConsentInputSchema = z.strictObject({
+	subjectId: z.string().optional(),
+	externalSubjectId: z.string().optional(),
+	domain: z.string(),
+	type: PolicyTypeSchema,
+	policyId: z.string().optional(),
+	preferences: z.array(z.string()).optional(),
+});
 
 // Minimal consent schema based on the response interface
-const consentSchema = z
-	.object({
-		id: z.string(),
-		purposeIds: z.array(z.string()),
-	})
-	.passthrough(); // Allow additional properties
+const consentSchema = z.looseObject({
+	id: z.string(),
+	purposeIds: z.array(z.string()),
+}); // Allow additional properties
 
 // Output schema based on VerifyConsentResponse
 export const verifyConsentContract = oc
@@ -56,64 +52,64 @@ Use this endpoint to ensure compliance with privacy regulations and to verify us
 		// Input validation errors
 		INPUT_VALIDATION_FAILED: {
 			status: 422,
-			message: 'Invalid input parameters',
 			data: z.object({
 				formErrors: z.array(z.string()),
 				fieldErrors: z.record(z.string(), z.array(z.string()).optional()),
 			}),
+			error: 'Invalid input parameters',
 		},
 		// Subject errors
 		SUBJECT_NOT_FOUND: {
 			status: 404,
-			message: 'Subject not found',
 			data: z.object({
 				subjectId: z.string().optional(),
 				externalSubjectId: z.string().optional(),
 			}),
+			error: 'Subject not found',
 		},
 		// Domain errors
 		DOMAIN_NOT_FOUND: {
 			status: 404,
-			message: 'Domain not found',
 			data: z.object({
 				domain: z.string(),
 			}),
+			error: 'Domain not found',
 		},
 		// Policy errors
 		POLICY_NOT_FOUND: {
 			status: 404,
-			message: 'Policy not found or invalid',
 			data: z.object({
 				policyId: z.string(),
 				type: z.string(),
 			}),
+			error: 'Policy not found or invalid',
 		},
 		// Purpose errors
 		PURPOSES_NOT_FOUND: {
 			status: 404,
-			message: 'Could not find all specified purposes',
 			data: z.object({
 				preferences: z.array(z.string()),
 				foundPurposes: z.array(z.string()),
 			}),
+			error: 'Could not find all specified purposes',
 		},
 		// Cookie banner specific errors
 		COOKIE_BANNER_PREFERENCES_REQUIRED: {
 			status: 400,
-			message: 'Preferences are required for cookie banner consent',
 			data: z.object({
 				type: z.literal('cookie_banner'),
 			}),
+			error: 'Preferences are required for cookie banner consent',
 		},
 		// Consent errors
 		NO_CONSENT_FOUND: {
 			status: 404,
-			message: 'No consent found for the given policy',
 			data: z.object({
 				policyId: z.string(),
 				subjectId: z.string(),
 				domainId: z.string(),
 			}),
+			error: 'No consent found for the given policy',
 		},
 	})
 	.input(verifyConsentInputSchema)

package/src/core.ts

@@ -47,6 +47,9 @@ export type Route = {
  * // Handle an incoming request
  * const response = await instance.handler(request);
  * ```
+ *
+ * @deprecated Will be removed in the next major version. Update to `@c15t/backend/v2`, view migration guide for more details.
+ * @see https://c15t.com/docs/self-host/migrate-from-v1
  */
 export interface C15TInstance<PluginTypes extends C15TPlugin[] = C15TPlugin[]> {
 	/**
@@ -101,6 +104,9 @@ export interface C15TInstance<PluginTypes extends C15TPlugin[] = C15TPlugin[]> {
  * Creates a new c15t consent management instance.
  *
  * This version provides a unified handler that works with oRPC to handle requests.
+ *
+ * @deprecated Will be removed in the next major version. Update to `@c15t/backend/v2`, view migration guide for more details.
+ * @see https://c15t.com/docs/self-host/migrate-from-v1
  */
 export const c15tInstance = <PluginTypes extends C15TPlugin[] = C15TPlugin[]>(
 	options: C15TOptions<PluginTypes>
@@ -457,3 +463,4 @@ export const c15tInstance = <PluginTypes extends C15TPlugin[] = C15TPlugin[]>(
 
 export type { C15TPlugin, C15TOptions, C15TContext };
 export type { ContractsInputs, ContractsOutputs } from './contracts';
+export { version } from './version';

package/src/handlers/consent/show-banner/handler.ts

@@ -1,21 +1,20 @@
 import type { Translations } from '@c15t/translations';
-import { ORPCError } from '@orpc/server';
 import { os } from '~/contracts';
 import {
 	type JurisdictionCode,
 	JurisdictionMessages,
 } from '~/contracts/shared/jurisdiction.schema';
-import type { C15TContext } from '~/types';
+import type { Branding, C15TContext } from '~/types';
 import { checkJurisdiction } from './geo';
 import { getTranslations } from './translations';
 
 function getHeaders(headers: Headers | undefined) {
 	if (!headers) {
-		throw new ORPCError('LOCATION_DETECTION_FAILED', {
-			data: {
-				reason: 'No headers found in request context',
-			},
-		});
+		return {
+			countryCode: null,
+			regionCode: null,
+			acceptLanguage: null,
+		};
 	}
 
 	// Add this conversion to ensure headers are always string or null
@@ -57,6 +56,7 @@ function buildResponse({
 	location,
 	acceptLanguage,
 	customTranslations,
+	branding = 'c15t',
 }: {
 	shouldShowBanner: boolean;
 
@@ -67,12 +67,14 @@ function buildResponse({
 	location: { countryCode: string | null; regionCode: string | null };
 	acceptLanguage: string | null;
 	customTranslations: Record<string, Partial<Translations>> | undefined;
+	branding?: Branding;
 }) {
 	return {
 		showConsentBanner: shouldShowBanner,
 		jurisdiction,
 		location,
 		translations: getTranslations(acceptLanguage, customTranslations),
+		branding,
 	};
 }
 
@@ -83,9 +85,8 @@ function buildResponse({
 export const showConsentBanner = os.consent.showBanner.handler(
 	({ context }) => {
 		const typedContext = context as C15TContext;
-		const { customTranslations, disableGeoLocation } =
+		const { customTranslations, disableGeoLocation, branding } =
 			typedContext.options.advanced ?? {};
-
 		const { countryCode, regionCode, acceptLanguage } = getHeaders(
 			typedContext.headers
 		);
@@ -100,6 +101,7 @@ export const showConsentBanner = os.consent.showBanner.handler(
 				location: { countryCode: null, regionCode: null },
 				acceptLanguage,
 				customTranslations,
+				branding,
 			});
 		}
 
@@ -115,6 +117,7 @@ export const showConsentBanner = os.consent.showBanner.handler(
 			location: { countryCode, regionCode },
 			acceptLanguage,
 			customTranslations,
+			branding,
 		});
 	}
 );

package/src/handlers/consent/show-banner/translations.ts

@@ -1,8 +1,8 @@
 import {
-	type CompleteTranslations,
-	type Translations,
 	baseTranslations,
+	type CompleteTranslations,
 	deepMergeTranslations,
+	type Translations,
 } from '@c15t/translations';
 
 type SupportedBaseLanguage = keyof typeof baseTranslations;

package/src/init.ts

@@ -1,4 +1,4 @@
-import { Resource } from '@opentelemetry/resources';
+import { resourceFromAttributes } from '@opentelemetry/resources';
 import { NodeSDK } from '@opentelemetry/sdk-node';
 import { ConsoleSpanExporter } from '@opentelemetry/sdk-trace-base';
 import { defu } from 'defu';
@@ -11,14 +11,14 @@ import { version } from '../package.json';
 import { generateId } from './pkgs/data-model/fields/id-generator';
 import type { EntityName } from './pkgs/data-model/schema/types';
 import {
-	ERROR_CODES,
-	type SDKResult,
-	type TelemetryConfig,
 	createTelemetryOptions,
+	ERROR_CODES,
 	fail,
 	failAsync,
 	ok,
 	promiseToResult,
+	type SDKResult,
+	type TelemetryConfig,
 } from './pkgs/results';
 
 import type { DoubleTieOptions } from './pkgs/types/options';
@@ -113,7 +113,7 @@ export const init = async <P extends C15TPlugin[]>(
 				telemetryInitialized = false;
 			} else {
 				// Create a telemetry resource with provided values or safe defaults
-				const resource = new Resource({
+				const resource = resourceFromAttributes({
 					'service.name': String(appName),
 					'service.version': String(version || '1.0.0'),
 					...(telemetryOptions?.defaultAttributes || {}),
@@ -196,7 +196,10 @@ export const init = async <P extends C15TPlugin[]>(
 			const generateIdFunc = ({
 				model,
 				size = 16,
-			}: { model: EntityName; size?: number }) => {
+			}: {
+				model: EntityName;
+				size?: number;
+			}) => {
 				return (
 					finalOptions?.advanced?.generateId?.({ model, size }) ||
 					generateId(getConsentTables(finalOptions)[model].entityPrefix)

package/src/middleware/openapi/index.ts

@@ -7,5 +7,5 @@
  * - Documentation UI
  */
 
-export { createOpenAPIConfig, createDefaultOpenAPIOptions } from './config';
-export { createOpenAPISpec, createDocsUI } from './handlers';
+export { createDefaultOpenAPIOptions, createOpenAPIConfig } from './config';
+export { createDocsUI, createOpenAPISpec } from './handlers';

package/src/pkgs/api-router/hooks/__tests__/processor.test.ts

@@ -1,4 +1,4 @@
-import { type Mock, beforeEach, describe, expect, test, vi } from 'vitest';
+import { beforeEach, describe, expect, type Mock, test, vi } from 'vitest';
 import type { HookEndpointContext } from '~/pkgs/types';
 import { runAfterHooks, runBeforeHooks } from '../processor';
 

package/src/pkgs/data-model/fields/index.ts

@@ -4,39 +4,34 @@
  * This module provides field definition utilities for the data model system.
  */
 
-// Export core types
-export type {
-	FieldType,
-	Field,
-	FieldConfig,
-	Primitive,
-	JsonValue,
-} from './field-types';
-
-// Export factory functions
-export { COMMON_TIMEZONES } from './field-factory';
-
 // Export field options
 export type {
+	DateFieldOptions,
 	NumberFieldOptions,
 	StringFieldOptions,
-	DateFieldOptions,
 } from './field-factory';
 
+// Export factory functions
+export { COMMON_TIMEZONES } from './field-factory';
+// Export field inference utilities
+export type {
+	InferFieldInput,
+	InferFieldOutput,
+} from './field-inference';
+// Export core types
+export type {
+	Field,
+	FieldConfig,
+	FieldType,
+	JsonValue,
+	Primitive,
+} from './field-types';
 // Export ID generator
 export { generateId } from './id-generator';
-
 // Export SuperJSON utilities
 export {
-	getDatabaseType,
 	type DatabaseType,
+	getDatabaseType,
 } from './superjson-utils';
-
 // Export Zod utilities
 export { validateField } from './zod-fields';
-
-// Export field inference utilities
-export type {
-	InferFieldOutput,
-	InferFieldInput,
-} from './field-inference';

package/src/pkgs/data-model/fields/zod-fields.ts

@@ -5,34 +5,22 @@ import type { Field, FieldType } from './field-types';
  * Base Zod schema for field configuration options
  */
 const fieldConfigSchema = z.object({
-	required: z.boolean().default(true),
-	returned: z.boolean().default(true),
-	input: z.boolean().default(true),
-	defaultValue: z.union([z.any(), z.function().returns(z.any())]).optional(),
+	required: z.boolean().prefault(true),
+	returned: z.boolean().prefault(true),
+	input: z.boolean().prefault(true),
+	defaultValue: z.any().optional(),
 	transform: z
 		.object({
-			input: z
-				.function()
-				.args(z.any())
-				.returns(z.union([z.any(), z.promise(z.any())]))
-				.optional(),
-			output: z
-				.function()
-				.args(z.any())
-				.returns(z.union([z.any(), z.promise(z.any())]))
-				.optional(),
+			input: z.any().optional(),
+			output: z.any().optional(),
 		})
 		.optional(),
-	validator: z
-		.function()
-		.args(z.any())
-		.returns(z.union([z.string(), z.null()]))
-		.optional(),
+	validator: z.any().optional(),
 	unique: z.boolean().optional(),
 	indexed: z.boolean().optional(),
-	sortable: z.boolean().default(true),
+	sortable: z.boolean().prefault(true),
 	fieldName: z.string().optional(),
-	bigint: z.boolean().default(false),
+	bigint: z.boolean().prefault(false),
 });
 
 /**
@@ -68,8 +56,8 @@ export const dateFieldSchema = fieldConfigSchema.extend({
 	type: z.literal('date'),
 	minDate: z.date().optional(),
 	maxDate: z.date().optional(),
-	dateOnly: z.boolean().default(false),
-	format: z.record(z.unknown()).optional(),
+	dateOnly: z.boolean().prefault(false),
+	format: z.record(z.string(), z.unknown()).optional(),
 });
 
 /**
@@ -77,9 +65,9 @@ export const dateFieldSchema = fieldConfigSchema.extend({
  */
 export const timezoneFieldSchema = fieldConfigSchema.extend({
 	type: z.literal('timezone'),
-	validateTimezone: z.boolean().default(true),
+	validateTimezone: z.boolean().prefault(true),
 	suggestedValues: z.array(z.string()).optional(),
-	restrictToSuggestedValues: z.boolean().default(false),
+	restrictToSuggestedValues: z.boolean().prefault(false),
 });
 
 /**
@@ -87,7 +75,7 @@ export const timezoneFieldSchema = fieldConfigSchema.extend({
  */
 export const jsonFieldSchema = fieldConfigSchema.extend({
 	type: z.literal('json'),
-	validateJson: z.boolean().default(true),
+	validateJson: z.boolean().prefault(true),
 });
 
 /**

package/src/pkgs/data-model/hooks/index.ts

@@ -31,9 +31,10 @@
  * });
  * ```
  */
-export type { DatabaseHook } from './types';
+
 export { createWithHooks } from './create-hooks';
+export type { DatabaseHook } from './types';
 export { updateWithHooks } from './update-hooks';
 export { updateManyWithHooks } from './update-many-hooks';
+export { processAfterHooksForMany, processHooks } from './utils';
 export { getWithHooks } from './with-hooks-factory';
-export { processHooks, processAfterHooksForMany } from './utils';

package/src/pkgs/data-model/index.ts

@@ -7,9 +7,7 @@
 
 // Re-export field-related exports
 export * from './fields';
-
-// Re-export schema-related exports
-export * from './schema';
-
 // Re-export hook-related exports
 export * from './hooks';
+// Re-export schema-related exports
+export * from './schema';

package/src/pkgs/data-model/schema/index.ts

@@ -4,17 +4,16 @@
  * This module provides schema definition utilities for the data model system.
  */
 
+// Re-export all the table definitions
+export * from './schemas';
 // Export core types
 export type {
-	SchemaDefinition,
-	TableDefinition,
-	EntityTypeMap,
 	EntityField,
 	EntityInput,
 	EntityName,
-	PluginSchema,
 	EntityOutput,
+	EntityTypeMap,
+	PluginSchema,
+	SchemaDefinition,
+	TableDefinition,
 } from './types';
-
-// Re-export all the table definitions
-export * from './schemas';

package/src/pkgs/data-model/schema/schemas.ts

@@ -5,11 +5,11 @@
  * It serves as the central hub for accessing all schema definitions.
  */
 
-// Export the complete schema tables directly from their source locations
-export * from '~/schema/subject';
+export * from '~/schema/audit-log';
 export * from '~/schema/consent';
 export * from '~/schema/consent-policy';
 export * from '~/schema/consent-purpose';
 export * from '~/schema/consent-record';
 export * from '~/schema/domain';
-export * from '~/schema/audit-log';
+// Export the complete schema tables directly from their source locations
+export * from '~/schema/subject';