@c15t/node-sdk 3.0.0-alpha.2 → 3.0.0-alpha.4

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@c15t/node-sdk",
-	"version": "3.0.0-alpha.2",
-	"description": "Type-safe Node.js SDK for hosted and self-hosted c15t consent APIs, consent records, privacy preferences, and backend automation.",
+	"version": "3.0.0-alpha.4",
+	"description": "Typed client for the c15t consent API: check consent, link users, record consents and publish legal documents from server code.",
 	"keywords": [
 		"c15t",
 		"ccpa",
@@ -35,6 +35,7 @@
 		"dist-types"
 	],
 	"type": "module",
+	"sideEffects": false,
 	"main": "./dist/index.js",
 	"types": "./dist-types/index.d.ts",
 	"exports": {
@@ -51,7 +52,7 @@
 	},
 	"scripts": {
 		"build": "bun prebuild && rslib build && bun ../../scripts/normalize-dist-types.mjs",
-		"check-types": "bun prebuild && tsc --noEmit",
+		"check-types": "bun prebuild && tsc --noEmit && tsc -p tsconfig.type-tests.json",
 		"check-types:test": "bun prebuild && tsc -p tsconfig.test.json",
 		"dev": "sh -c 'bun prebuild && rslib build --no-dts --no-clean && rslib build --watch --no-dts --no-clean'",
 		"fmt": "bun oxfmt .",
@@ -61,21 +62,14 @@
 		"test:watch": "bun prebuild && vitest"
 	},
 	"dependencies": {
-		"@c15t/backend": "3.0.0-alpha.2",
-		"@c15t/schema": "3.0.0-alpha.1"
+		"@c15t/schema": "3.0.0-alpha.3"
 	},
 	"devDependencies": {
+		"@c15t/backend": "3.0.0-alpha.4",
 		"@c15t/typescript-config": "0.0.1",
 		"@c15t/vitest-config": "1.0.0",
-		"@electric-sql/pglite": "0.4.2",
-		"@libsql/kysely-libsql": "^0.4.1",
-		"@types/better-sqlite3": "^7.6.13",
-		"@types/express": "^5.0.6",
 		"@types/node": "25.5.0",
-		"@types/pg": "8.20.0",
 		"genversion": "3.2.0",
-		"kysely-pglite": "^0.6.1",
-		"msw": "^2.14.6",
 		"typescript": "7.0.2"
 	}
 }

package/dist-types/endpoints/consent.d.ts

@@ -1,16 +0,0 @@
-import type { CheckConsentOutput, CheckConsentQuery } from '@c15t/schema/types';
-import type { FetcherContext } from '../fetcher.js';
-import type { FetchOptions, ResponseContext } from '../types.js';
-/**
- * API endpoint path for consent check
- */
-export declare const CONSENT_CHECK_PATH = "/consents/check";
-/**
- * Check consent status for an external ID
- *
- * @param context - Fetcher context
- * @param query - Query parameters (externalId required)
- * @param options - Optional fetch options
- * @returns Consent check response
- */
-export declare const checkConsent: (context: FetcherContext, query: CheckConsentQuery, options?: FetchOptions<CheckConsentOutput, never, CheckConsentQuery>) => Promise<ResponseContext<CheckConsentOutput>>;

package/dist-types/endpoints/index.d.ts

@@ -1,4 +0,0 @@
-export { CONSENT_CHECK_PATH, checkConsent } from './consent.js';
-export { INIT_PATH, init } from './init.js';
-export { STATUS_PATH, status } from './status.js';
-export { createSubject, getSubject, listSubjects, patchSubject, SUBJECTS_PATH, } from './subjects.js';

package/dist-types/endpoints/init.d.ts

@@ -1,15 +0,0 @@
-import type { InitOutput } from '@c15t/schema/types';
-import type { FetcherContext } from '../fetcher.js';
-import type { FetchOptions, ResponseContext } from '../types.js';
-/**
- * API endpoint path for init
- */
-export declare const INIT_PATH = "/init";
-/**
- * Initialize consent manager
- *
- * @param context - Fetcher context
- * @param options - Optional fetch options
- * @returns Init response with jurisdiction, location, translations, branding
- */
-export declare const init: (context: FetcherContext, options?: FetchOptions<InitOutput>) => Promise<ResponseContext<InitOutput>>;

package/dist-types/endpoints/status.d.ts

@@ -1,15 +0,0 @@
-import type { StatusOutput } from '@c15t/schema/types';
-import type { FetcherContext } from '../fetcher.js';
-import type { FetchOptions, ResponseContext } from '../types.js';
-/**
- * API endpoint path for status
- */
-export declare const STATUS_PATH = "/status";
-/**
- * Get API status
- *
- * @param context - Fetcher context
- * @param options - Optional fetch options
- * @returns Status response
- */
-export declare const status: (context: FetcherContext, options?: FetchOptions<StatusOutput>) => Promise<ResponseContext<StatusOutput>>;

package/dist-types/endpoints/subjects.d.ts

@@ -1,45 +0,0 @@
-import type { GetSubjectOutput, GetSubjectQuery, ListSubjectsOutput, ListSubjectsQuery, PatchSubjectFullInput, PatchSubjectOutput, PostSubjectInput, PostSubjectOutput } from '@c15t/schema/types';
-import type { FetcherContext } from '../fetcher.js';
-import type { FetchOptions, ResponseContext } from '../types.js';
-/**
- * API endpoint paths for subjects
- */
-export declare const SUBJECTS_PATH = "/subjects";
-/**
- * Create a new subject with consent preferences
- *
- * @param context - Fetcher context
- * @param input - Subject creation input
- * @param options - Optional fetch options
- * @returns Created subject response
- */
-export declare const createSubject: (context: FetcherContext, input: PostSubjectInput, options?: FetchOptions<PostSubjectOutput, PostSubjectInput>) => Promise<ResponseContext<PostSubjectOutput>>;
-/**
- * Get a subject by ID
- *
- * @param context - Fetcher context
- * @param id - Subject ID
- * @param query - Optional query parameters
- * @param options - Optional fetch options
- * @returns Subject data response
- */
-export declare const getSubject: (context: FetcherContext, id: string, query?: GetSubjectQuery, options?: FetchOptions<GetSubjectOutput, never, GetSubjectQuery>) => Promise<ResponseContext<GetSubjectOutput>>;
-/**
- * Update a subject (link external ID or update preferences)
- *
- * @param context - Fetcher context
- * @param id - Subject ID
- * @param input - Patch input with externalId or other fields
- * @param options - Optional fetch options
- * @returns Updated subject response
- */
-export declare const patchSubject: (context: FetcherContext, id: string, input: Omit<PatchSubjectFullInput, 'id'>, options?: FetchOptions<PatchSubjectOutput, Omit<PatchSubjectFullInput, 'id'>>) => Promise<ResponseContext<PatchSubjectOutput>>;
-/**
- * List subjects with optional filtering
- *
- * @param context - Fetcher context
- * @param query - Query parameters for filtering
- * @param options - Optional fetch options
- * @returns List of subjects
- */
-export declare const listSubjects: (context: FetcherContext, query?: ListSubjectsQuery, options?: FetchOptions<ListSubjectsOutput, never, ListSubjectsQuery>) => Promise<ResponseContext<ListSubjectsOutput>>;

package/dist-types/error.d.ts

@@ -1,85 +0,0 @@
-/**
- * C15TError - Custom error class for typed error handling
- *
- * @example
- * ```typescript
- * import { C15TError } from '@c15t/node-sdk';
- *
- * try {
- *   const subject = (await client.getSubject('sub_123')).unwrap();
- * } catch (error) {
- *   if (error instanceof C15TError) {
- *     console.log(error.status); // 404
- *     console.log(error.code);   // 'NOT_FOUND'
- *     console.log(error.details);
- *   }
- * }
- * ```
- */
-export declare class C15TError extends Error {
-    /**
-     * HTTP status code of the error response
-     */
-    readonly status: number;
-    /**
-     * Error code for programmatic error identification
-     */
-    readonly code?: string;
-    /**
-     * Additional error details
-     */
-    readonly details?: Record<string, unknown> | null;
-    /**
-     * Original cause of the error (if any)
-     */
-    readonly cause?: unknown;
-    constructor(options: {
-        message: string;
-        status: number;
-        code?: string;
-        details?: Record<string, unknown> | null;
-        cause?: unknown;
-    });
-    /**
-     * Check if the error is a specific HTTP status code
-     */
-    isStatus(status: number): boolean;
-    /**
-     * Check if the error is a not found error (404)
-     */
-    isNotFound(): boolean;
-    /**
-     * Check if the error is a validation error (400)
-     */
-    isValidationError(): boolean;
-    /**
-     * Check if the error is an authentication error (401)
-     */
-    isUnauthorized(): boolean;
-    /**
-     * Check if the error is a forbidden error (403)
-     */
-    isForbidden(): boolean;
-    /**
-     * Check if the error is a server error (5xx)
-     */
-    isServerError(): boolean;
-    /**
-     * Check if the error is a network error
-     */
-    isNetworkError(): boolean;
-    /**
-     * Convert error to a plain object for serialization
-     */
-    toJSON(): {
-        name: string;
-        message: string;
-        status: number;
-        code?: string;
-        details?: Record<string, unknown> | null;
-    };
-}
-/**
- * Type guard to check if an error is a C15TError
- */
-export declare const isC15TError: (error: unknown) => error is C15TError;

package/dist-types/fetcher.d.ts

@@ -1,37 +0,0 @@
-import type { FetchOptions, ResponseContext, RetryConfig } from './types.js';
-/**
- * Default retry configuration
- */
-export declare const DEFAULT_RETRY_CONFIG: RetryConfig;
-/**
- * Default timeout in milliseconds (30 seconds)
- */
-export declare const DEFAULT_TIMEOUT_MS = 30000;
-/**
- * Base context for fetcher operations
- */
-export interface FetcherContext {
-    baseUrl: string;
-    headers: Record<string, string>;
-    retryConfig: RetryConfig;
-    debug: boolean;
-    timeout: number;
-}
-/**
- * Creates a response context object with Result-like helper methods
- */
-export declare const createResponseContext: <T>(isSuccess: boolean, data?: T | null, error?: {
-    message: string;
-    status: number;
-    code?: string;
-    cause?: unknown;
-    details?: Record<string, unknown> | null;
-} | null, response?: Response | null) => ResponseContext<T>;
-/**
- * Resolves a URL path against the base URL
- */
-export declare const resolveUrl: (baseUrl: string, path: string) => string;
-/**
- * Makes an HTTP request with retry logic
- */
-export declare const fetcher: <ResponseType, BodyType = unknown, QueryType = unknown>(context: FetcherContext, path: string, options?: FetchOptions<ResponseType, BodyType, QueryType>) => Promise<ResponseContext<ResponseType>>;

package/dist-types/headers.d.ts

@@ -1,3 +0,0 @@
-export declare const C15T_VERSION_HEADERS: {
-    readonly 'x-c15t-version': "3.0.0-alpha.2";
-};

package/dist-types/types.d.ts

@@ -1,234 +0,0 @@
-/**
- * Configuration options for the C15T SDK client
- */
-export interface C15TClientOptions {
-    /**
-     * Base URL for the API server.
-     * If not provided, falls back to C15T_API_URL environment variable.
-     * @example "https://api.example.com"
-     */
-    baseUrl?: string;
-    /**
-     * Authentication token (if needed).
-     * If not provided, falls back to C15T_API_TOKEN environment variable.
-     * @example "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
-     */
-    token?: string;
-    /**
-     * Additional headers to include with each request
-     */
-    headers?: Record<string, string>;
-    /**
-     * Prefix path for API endpoints
-     * @default "/"
-     */
-    prefix?: string;
-    /**
-     * Retry configuration for failed requests
-     */
-    retryConfig?: RetryConfig;
-    /**
-     * Enable debug mode to log requests and responses.
-     * Can also be enabled via C15T_DEBUG=true environment variable.
-     * @default false
-     * @example
-     * ```typescript
-     * const client = c15tClient({
-     *   baseUrl: 'https://api.example.com',
-     *   debug: true,
-     * });
-     * // Console output:
-     * // [c15t] GET /status (142ms) -> 200
-     * ```
-     */
-    debug?: boolean;
-    /**
-     * Request timeout in milliseconds.
-     * Requests exceeding this timeout will be aborted.
-     * @default 30000 (30 seconds)
-     * @example
-     * ```typescript
-     * const client = c15tClient({
-     *   baseUrl: 'https://api.example.com',
-     *   timeout: 5000, // 5 seconds
-     * });
-     * ```
-     */
-    timeout?: number;
-}
-/**
- * Retry configuration for HTTP requests
- */
-export interface RetryConfig {
-    /**
-     * Maximum number of retry attempts
-     * @default 3
-     */
-    maxRetries?: number;
-    /**
-     * Initial delay in milliseconds before the first retry
-     * @default 100
-     */
-    initialDelayMs?: number;
-    /**
-     * Factor by which the delay increases for each subsequent retry
-     * @default 2
-     */
-    backoffFactor?: number;
-    /**
-     * Array of HTTP status codes that should trigger a retry
-     * @default [500, 502, 503, 504]
-     */
-    retryableStatusCodes?: number[];
-    /**
-     * Array of HTTP status codes that should never be retried
-     * @default [400, 401, 403, 404]
-     */
-    nonRetryableStatusCodes?: number[];
-    /**
-     * Whether to retry on network errors
-     * @default true
-     */
-    retryOnNetworkError?: boolean;
-}
-/**
- * Response context returned from API requests.
- *
- * Provides Result-like helper methods for ergonomic error handling.
- */
-export interface ResponseContext<T = unknown> {
-    /**
-     * Response data returned by the API
-     */
-    data: T | null;
-    /**
-     * Original fetch Response object
-     */
-    response: Response | null;
-    /**
-     * Error information if the request failed
-     */
-    error: {
-        /**
-         * Error message describing what went wrong
-         */
-        message: string;
-        /**
-         * HTTP status code or custom error code
-         */
-        status: number;
-        /**
-         * Optional error code for more specific error identification
-         */
-        code?: string;
-        /**
-         * Optional cause of the error
-         */
-        cause?: unknown;
-        /**
-         * Optional additional details about the error
-         */
-        details?: Record<string, unknown> | null;
-    } | null;
-    /**
-     * Whether the request was successful
-     */
-    ok: boolean;
-    /**
-     * Unwraps the response data, throwing an error if the request failed.
-     *
-     * @throws {Error} If the request was not successful
-     * @returns The response data
-     *
-     * @example
-     * ```typescript
-     * const subject = (await client.getSubject('sub_123')).unwrap();
-     * ```
-     */
-    unwrap: () => T;
-    /**
-     * Unwraps the response data, returning a default value if the request failed.
-     *
-     * @param defaultValue - The value to return if the request failed
-     * @returns The response data or the default value
-     *
-     * @example
-     * ```typescript
-     * const subject = (await client.getSubject('sub_123')).unwrapOr(defaultSubject);
-     * ```
-     */
-    unwrapOr: (defaultValue: T) => T;
-    /**
-     * Unwraps the response data, throwing a custom error message if the request failed.
-     *
-     * @param message - Custom error message to throw
-     * @throws {Error} With the provided message if the request was not successful
-     * @returns The response data
-     *
-     * @example
-     * ```typescript
-     * const subject = (await client.getSubject('sub_123')).expect('Subject not found');
-     * ```
-     */
-    expect: (message: string) => T;
-    /**
-     * Maps the response data to a new value if successful.
-     *
-     * @param fn - Function to transform the data
-     * @returns A new ResponseContext with the transformed data
-     *
-     * @example
-     * ```typescript
-     * const name = (await client.getSubject('sub_123')).map(s => s.name);
-     * ```
-     */
-    map: <U>(fn: (data: T) => U) => ResponseContext<U>;
-}
-/**
- * Options for individual fetch requests
- */
-export interface FetchOptions<ResponseType = unknown, BodyType = unknown, QueryType = unknown> {
-    /**
-     * HTTP method for the request
-     * @default 'GET'
-     */
-    method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
-    /**
-     * Request body to send with the request
-     */
-    body?: BodyType;
-    /**
-     * Query parameters to include in the request URL
-     */
-    query?: QueryType;
-    /**
-     * Custom headers to include with this specific request
-     */
-    headers?: Record<string, string>;
-    /**
-     * Whether to throw an error when the response is not successful
-     * @default false
-     */
-    throw?: boolean;
-    /**
-     * Callback function to execute on successful response
-     */
-    onSuccess?: (context: ResponseContext<ResponseType>) => void | Promise<void>;
-    /**
-     * Callback function to execute on error response
-     */
-    onError?: (context: ResponseContext<ResponseType>, path: string) => void | Promise<void>;
-    /**
-     * Request-specific retry configuration
-     */
-    retryConfig?: RetryConfig;
-    /**
-     * Request timeout in milliseconds.
-     * Overrides the global timeout for this specific request.
-     * @example
-     * ```typescript
-     * await client.getSubject('sub_123', undefined, { timeout: 5000 });
-     * ```
-     */
-    timeout?: number;
-}