@classytic/arc 2.10.3 → 2.11.0

package/dist/utils-B2fNOD_i.mjs

@@ -1,929 +0,0 @@
-import { t as ArcError } from "./errors-D5c-5BJL.mjs";
-//#region src/utils/circuitBreaker.ts
-/**
-* Circuit Breaker Pattern
-*
-* Wraps external service calls with failure protection.
-* Prevents cascading failures by "opening" the circuit when
-* a service is failing, allowing it time to recover.
-*
-* States:
-* - CLOSED: Normal operation, requests pass through
-* - OPEN: Too many failures, all requests fail fast
-* - HALF_OPEN: Testing if service recovered, limited requests
-*
-* @example
-* import { CircuitBreaker } from '@classytic/arc/utils';
-*
-* const paymentBreaker = new CircuitBreaker(async (amount) => {
-*   return await stripe.charges.create({ amount });
-* }, {
-*   failureThreshold: 5,
-*   resetTimeout: 30000,
-*   timeout: 5000,
-* });
-*
-* try {
-*   const result = await paymentBreaker.call(100);
-* } catch (error) {
-*   // Handle failure or circuit open
-* }
-*/
-const CircuitState = {
-	CLOSED: "CLOSED",
-	OPEN: "OPEN",
-	HALF_OPEN: "HALF_OPEN"
-};
-var CircuitBreakerError = class extends Error {
-	state;
-	constructor(message, state) {
-		super(message);
-		this.name = "CircuitBreakerError";
-		this.state = state;
-	}
-};
-var CircuitBreaker = class {
-	state = CircuitState.CLOSED;
-	failures = 0;
-	successes = 0;
-	totalCalls = 0;
-	nextAttempt = 0;
-	lastCallAt = null;
-	openedAt = null;
-	failureThreshold;
-	resetTimeout;
-	timeout;
-	successThreshold;
-	fallback;
-	onStateChange;
-	onError;
-	name;
-	fn;
-	constructor(fn, options = {}) {
-		this.fn = fn;
-		this.failureThreshold = options.failureThreshold ?? 5;
-		this.resetTimeout = options.resetTimeout ?? 6e4;
-		this.timeout = options.timeout ?? 1e4;
-		this.successThreshold = options.successThreshold ?? 1;
-		this.fallback = options.fallback;
-		this.onStateChange = options.onStateChange;
-		this.onError = options.onError;
-		this.name = options.name ?? "CircuitBreaker";
-	}
-	/**
-	* Call the wrapped function with circuit breaker protection
-	*/
-	async call(...args) {
-		this.totalCalls++;
-		this.lastCallAt = Date.now();
-		if (this.state === CircuitState.OPEN) {
-			if (Date.now() < this.nextAttempt) {
-				const error = new CircuitBreakerError(`Circuit breaker is OPEN for ${this.name}`, CircuitState.OPEN);
-				if (this.fallback) return this.fallback(...args);
-				throw error;
-			}
-			this.setState(CircuitState.HALF_OPEN);
-		}
-		try {
-			const result = await this.executeWithTimeout(args);
-			this.onSuccess();
-			return result;
-		} catch (err) {
-			this.onFailure(err instanceof Error ? err : new Error(String(err)));
-			throw err;
-		}
-	}
-	/**
-	* Execute function with timeout
-	*/
-	async executeWithTimeout(args) {
-		return new Promise((resolve, reject) => {
-			const timeoutId = setTimeout(() => {
-				reject(/* @__PURE__ */ new Error(`Request timeout after ${this.timeout}ms`));
-			}, this.timeout);
-			this.fn(...args).then((result) => {
-				clearTimeout(timeoutId);
-				resolve(result);
-			}).catch((error) => {
-				clearTimeout(timeoutId);
-				reject(error);
-			});
-		});
-	}
-	/**
-	* Handle successful call
-	*/
-	onSuccess() {
-		this.failures = 0;
-		this.successes++;
-		if (this.state === CircuitState.HALF_OPEN) {
-			if (this.successes >= this.successThreshold) {
-				this.setState(CircuitState.CLOSED);
-				this.successes = 0;
-			}
-		}
-	}
-	/**
-	* Handle failed call
-	*/
-	onFailure(error) {
-		this.failures++;
-		this.successes = 0;
-		if (this.onError) this.onError(error);
-		if (this.state === CircuitState.HALF_OPEN || this.failures >= this.failureThreshold) {
-			this.setState(CircuitState.OPEN);
-			this.nextAttempt = Date.now() + this.resetTimeout;
-			this.openedAt = Date.now();
-		}
-	}
-	/**
-	* Change circuit state
-	*/
-	setState(newState) {
-		const oldState = this.state;
-		if (oldState !== newState) {
-			this.state = newState;
-			if (this.onStateChange) this.onStateChange(oldState, newState);
-		}
-	}
-	/**
-	* Manually open the circuit
-	*/
-	open() {
-		this.setState(CircuitState.OPEN);
-		this.nextAttempt = Date.now() + this.resetTimeout;
-		this.openedAt = Date.now();
-	}
-	/**
-	* Manually close the circuit
-	*/
-	close() {
-		this.failures = 0;
-		this.successes = 0;
-		this.setState(CircuitState.CLOSED);
-		this.openedAt = null;
-	}
-	/**
-	* Get current statistics
-	*/
-	getStats() {
-		return {
-			name: this.name,
-			state: this.state,
-			failures: this.failures,
-			successes: this.successes,
-			totalCalls: this.totalCalls,
-			openedAt: this.openedAt,
-			lastCallAt: this.lastCallAt
-		};
-	}
-	/**
-	* Get current state
-	*/
-	getState() {
-		return this.state;
-	}
-	/**
-	* Check if circuit is open
-	*/
-	isOpen() {
-		return this.state === CircuitState.OPEN;
-	}
-	/**
-	* Check if circuit is closed
-	*/
-	isClosed() {
-		return this.state === CircuitState.CLOSED;
-	}
-	/**
-	* Reset statistics
-	*/
-	reset() {
-		this.failures = 0;
-		this.successes = 0;
-		this.totalCalls = 0;
-		this.lastCallAt = null;
-		this.openedAt = null;
-		this.setState(CircuitState.CLOSED);
-	}
-};
-/**
-* Create a circuit breaker with sensible defaults
-*
-* @example
-* const emailBreaker = createCircuitBreaker(
-*   async (to, subject, body) => sendEmail(to, subject, body),
-*   { name: 'email-service' }
-* );
-*/
-function createCircuitBreaker(fn, options) {
-	return new CircuitBreaker(fn, options);
-}
-/**
-* Circuit breaker registry for managing multiple breakers
-*/
-var CircuitBreakerRegistry = class {
-	breakers = /* @__PURE__ */ new Map();
-	/**
-	* Register a circuit breaker
-	*/
-	register(name, fn, options) {
-		const breaker = new CircuitBreaker(fn, {
-			...options,
-			name
-		});
-		this.breakers.set(name, breaker);
-		return breaker;
-	}
-	/**
-	* Get a circuit breaker by name
-	*/
-	get(name) {
-		return this.breakers.get(name);
-	}
-	/**
-	* Get all breakers
-	*/
-	getAll() {
-		return this.breakers;
-	}
-	/**
-	* Get statistics for all breakers
-	*/
-	getAllStats() {
-		const stats = {};
-		for (const [name, breaker] of this.breakers.entries()) stats[name] = breaker.getStats();
-		return stats;
-	}
-	/**
-	* Reset all breakers
-	*/
-	resetAll() {
-		for (const breaker of this.breakers.values()) breaker.reset();
-	}
-	/**
-	* Open all breakers
-	*/
-	openAll() {
-		for (const breaker of this.breakers.values()) breaker.open();
-	}
-	/**
-	* Close all breakers
-	*/
-	closeAll() {
-		for (const breaker of this.breakers.values()) breaker.close();
-	}
-};
-/**
-* Create a new CircuitBreakerRegistry instance.
-* Use this instead of a global singleton — attach to fastify.arc or pass explicitly.
-*/
-function createCircuitBreakerRegistry() {
-	return new CircuitBreakerRegistry();
-}
-//#endregion
-//#region src/utils/compensation.ts
-/**
-* Run steps in order with automatic compensation on failure.
-*
-* @typeParam TCtx - Context type shared across steps (defaults to Record<string, unknown>)
-*/
-async function withCompensation(_name, steps, initialContext, hooks) {
-	const ctx = { ...initialContext };
-	const completedSteps = [];
-	const results = {};
-	const completed = [];
-	for (const step of steps) {
-		if (step.fireAndForget) {
-			completedSteps.push(step.name);
-			step.execute(ctx).then((result) => hooks?.onStepComplete?.(step.name, result), () => {});
-			continue;
-		}
-		try {
-			const result = await step.execute(ctx);
-			completedSteps.push(step.name);
-			results[step.name] = result;
-			completed.push({
-				step,
-				result
-			});
-			hooks?.onStepComplete?.(step.name, result);
-		} catch (err) {
-			const error = err instanceof Error ? err : new Error(String(err));
-			hooks?.onStepFailed?.(step.name, error);
-			const compensationErrors = await rollback(ctx, completed, hooks);
-			return {
-				success: false,
-				completedSteps,
-				results,
-				failedStep: step.name,
-				error: error.message,
-				...compensationErrors.length > 0 ? { compensationErrors } : {}
-			};
-		}
-	}
-	return {
-		success: true,
-		completedSteps,
-		results
-	};
-}
-async function rollback(ctx, completed, hooks) {
-	const errors = [];
-	for (let i = completed.length - 1; i >= 0; i--) {
-		const entry = completed[i];
-		if (!entry?.step.compensate) continue;
-		const compensateFn = entry.step.compensate;
-		try {
-			await compensateFn(ctx, entry.result);
-			hooks?.onCompensate?.(entry.step.name);
-		} catch (err) {
-			errors.push({
-				step: entry.step.name,
-				error: err instanceof Error ? err.message : String(err)
-			});
-		}
-	}
-	return errors;
-}
-function defineCompensation(name, steps) {
-	return {
-		name,
-		execute: (initialContext, hooks) => withCompensation(name, steps, initialContext, hooks)
-	};
-}
-//#endregion
-//#region src/utils/defineGuard.ts
-/** Hidden property key for guard context storage on the request object. */
-const GUARD_STORE_KEY = "__arcGuardContext";
-/**
-* Create a typed guard. See module JSDoc for usage.
-*/
-function defineGuard(config) {
-	const { name, resolve } = config;
-	const preHandler = async (req, reply) => {
-		const ctx = await resolve(req, reply);
-		if (!reply.sent) {
-			const store = req[GUARD_STORE_KEY] ?? {};
-			store[name] = ctx;
-			req[GUARD_STORE_KEY] = store;
-		}
-	};
-	return {
-		preHandler,
-		name,
-		from(req) {
-			const store = req[GUARD_STORE_KEY];
-			if (!store || !(name in store)) throw new Error(`Guard '${name}' not resolved on this request. Add it to routeGuards or the route's preHandler array.`);
-			return store[name];
-		}
-	};
-}
-//#endregion
-//#region src/utils/handleRaw.ts
-/**
-* Wrap a raw Fastify handler with Arc's response envelope and error handling.
-*
-* @param handler - Async function that receives `(request, reply)` and returns data.
-*   The return value is sent as `{ success: true, data }`. If it returns
-*   `undefined` or `null`, `{ success: true }` is sent (no `data` field).
-* @param statusCode - HTTP status code for successful responses (default: 200)
-*/
-function handleRaw(handler, statusCode = 200) {
-	return async (request, reply) => {
-		try {
-			const result = await handler(request, reply);
-			if (reply.sent) return;
-			if (result === void 0 || result === null) reply.code(statusCode).send({ success: true });
-			else reply.code(statusCode).send({
-				success: true,
-				data: result
-			});
-		} catch (err) {
-			if (reply.sent) return;
-			if (err instanceof ArcError) {
-				reply.code(err.statusCode).send(err.toJSON());
-				return;
-			}
-			const error = err;
-			const code = error.statusCode ?? error.status ?? 500;
-			reply.code(code).send({
-				success: false,
-				error: error.message ?? "Internal server error",
-				...error.code && { code: error.code }
-			});
-		}
-	};
-}
-//#endregion
-//#region src/utils/responseSchemas.ts
-/**
-* Base success response schema
-*/
-const successResponseSchema = {
-	type: "object",
-	properties: { success: {
-		type: "boolean",
-		example: true
-	} },
-	required: ["success"]
-};
-/**
-* Error response schema
-*/
-const errorResponseSchema = {
-	type: "object",
-	properties: {
-		success: {
-			type: "boolean",
-			example: false
-		},
-		error: {
-			type: "string",
-			description: "Error message"
-		},
-		code: {
-			type: "string",
-			description: "Error code"
-		},
-		message: {
-			type: "string",
-			description: "Detailed message"
-		}
-	},
-	required: ["success", "error"]
-};
-/**
-* Pagination schema - matches MongoKit/Arc runtime format
-*
-* Runtime format (flat fields):
-* { page, limit, total, pages, hasNext, hasPrev }
-*/
-const paginationSchema = {
-	type: "object",
-	properties: {
-		page: {
-			type: "integer",
-			example: 1
-		},
-		limit: {
-			type: "integer",
-			example: 20
-		},
-		total: {
-			type: "integer",
-			example: 100
-		},
-		pages: {
-			type: "integer",
-			example: 5
-		},
-		hasNext: {
-			type: "boolean",
-			example: true
-		},
-		hasPrev: {
-			type: "boolean",
-			example: false
-		}
-	},
-	required: [
-		"page",
-		"limit",
-		"total",
-		"pages",
-		"hasNext",
-		"hasPrev"
-	]
-};
-/**
-* Wrap a data schema in a success response
-*/
-function wrapResponse(dataSchema) {
-	return {
-		type: "object",
-		properties: {
-			success: {
-				type: "boolean",
-				example: true
-			},
-			data: dataSchema
-		},
-		required: ["success", "data"],
-		additionalProperties: true
-	};
-}
-/**
-* Create a list response schema with pagination - matches MongoKit/Arc runtime format
-*
-* Runtime format:
-* { success, docs: [...], page, limit, total, pages, hasNext, hasPrev }
-*
-* Note: Uses 'docs' array (not 'data') with flat pagination fields
-*/
-function listResponse(itemSchema) {
-	return {
-		type: "object",
-		properties: {
-			success: {
-				type: "boolean",
-				example: true
-			},
-			docs: {
-				type: "array",
-				items: itemSchema
-			},
-			page: {
-				type: "integer",
-				example: 1
-			},
-			limit: {
-				type: "integer",
-				example: 20
-			},
-			total: {
-				type: "integer",
-				example: 100
-			},
-			pages: {
-				type: "integer",
-				example: 5
-			},
-			hasNext: {
-				type: "boolean",
-				example: false
-			},
-			hasPrev: {
-				type: "boolean",
-				example: false
-			}
-		},
-		required: ["success", "docs"],
-		additionalProperties: true
-	};
-}
-/**
-* Create a single item response schema
-*
-* Runtime format: { success, data: {...} }
-*/
-function itemResponse(itemSchema) {
-	return wrapResponse(itemSchema);
-}
-/**
-* Create a create/update response schema
-*/
-function mutationResponse(itemSchema) {
-	return {
-		type: "object",
-		properties: {
-			success: {
-				type: "boolean",
-				example: true
-			},
-			data: itemSchema,
-			message: {
-				type: "string",
-				example: "Created successfully"
-			}
-		},
-		required: ["success", "data"],
-		additionalProperties: true
-	};
-}
-/**
-* Create a delete response schema
-*
-* Runtime format: { success, data: { message, id?, soft? } }
-*/
-function deleteResponse() {
-	return {
-		type: "object",
-		properties: {
-			success: {
-				type: "boolean",
-				example: true
-			},
-			data: {
-				type: "object",
-				properties: {
-					message: {
-						type: "string",
-						example: "Deleted successfully"
-					},
-					id: {
-						type: "string",
-						example: "507f1f77bcf86cd799439011"
-					},
-					soft: {
-						type: "boolean",
-						example: false
-					}
-				},
-				required: ["message"]
-			}
-		},
-		required: ["success"],
-		additionalProperties: true
-	};
-}
-const responses = {
-	200: (schema) => ({
-		description: "Successful response",
-		content: { "application/json": { schema } }
-	}),
-	201: (schema) => ({
-		description: "Created successfully",
-		content: { "application/json": { schema: mutationResponse(schema) } }
-	}),
-	400: {
-		description: "Bad Request",
-		content: { "application/json": { schema: {
-			...errorResponseSchema,
-			properties: {
-				...errorResponseSchema.properties,
-				code: {
-					type: "string",
-					example: "VALIDATION_ERROR"
-				},
-				details: {
-					type: "object",
-					properties: { errors: {
-						type: "array",
-						items: {
-							type: "object",
-							properties: {
-								field: { type: "string" },
-								message: { type: "string" }
-							}
-						}
-					} }
-				}
-			}
-		} } }
-	},
-	401: {
-		description: "Unauthorized",
-		content: { "application/json": { schema: {
-			...errorResponseSchema,
-			properties: {
-				...errorResponseSchema.properties,
-				code: {
-					type: "string",
-					example: "UNAUTHORIZED"
-				}
-			}
-		} } }
-	},
-	403: {
-		description: "Forbidden",
-		content: { "application/json": { schema: {
-			...errorResponseSchema,
-			properties: {
-				...errorResponseSchema.properties,
-				code: {
-					type: "string",
-					example: "FORBIDDEN"
-				}
-			}
-		} } }
-	},
-	404: {
-		description: "Not Found",
-		content: { "application/json": { schema: {
-			...errorResponseSchema,
-			properties: {
-				...errorResponseSchema.properties,
-				code: {
-					type: "string",
-					example: "NOT_FOUND"
-				}
-			}
-		} } }
-	},
-	409: {
-		description: "Conflict",
-		content: { "application/json": { schema: {
-			...errorResponseSchema,
-			properties: {
-				...errorResponseSchema.properties,
-				code: {
-					type: "string",
-					example: "CONFLICT"
-				}
-			}
-		} } }
-	},
-	500: {
-		description: "Internal Server Error",
-		content: { "application/json": { schema: {
-			...errorResponseSchema,
-			properties: {
-				...errorResponseSchema.properties,
-				code: {
-					type: "string",
-					example: "INTERNAL_ERROR"
-				}
-			}
-		} } }
-	}
-};
-const queryParams = {
-	pagination: {
-		page: {
-			type: "integer",
-			minimum: 1,
-			default: 1,
-			description: "Page number"
-		},
-		limit: {
-			type: "integer",
-			minimum: 1,
-			maximum: 100,
-			default: 20,
-			description: "Items per page"
-		}
-	},
-	sorting: { sort: {
-		type: "string",
-		description: "Sort field (prefix with - for descending)",
-		example: "-createdAt"
-	} },
-	filtering: {
-		select: {
-			description: "Fields to include (space-separated or object)",
-			example: "name email createdAt"
-		},
-		populate: {
-			description: "Relations to populate (comma-separated string or bracket-notation object)",
-			example: "author,category"
-		}
-	}
-};
-/**
-* Get standard list query parameters schema
-*/
-function getListQueryParams() {
-	return {
-		type: "object",
-		properties: {
-			...queryParams.pagination,
-			...queryParams.sorting,
-			...queryParams.filtering
-		},
-		additionalProperties: true
-	};
-}
-/**
-* Generic item schema that allows any properties.
-* Used as default when no user schema is provided.
-* Enables fast-json-stringify while still passing through all fields.
-*/
-const genericItemSchema = {
-	type: "object",
-	additionalProperties: true
-};
-/**
-* Recursively strip `example` keys from a schema object.
-* The `example` keyword is OpenAPI metadata — not standard JSON Schema —
-* and triggers Ajv strict mode errors when used on routes without the
-* `keywords: ['example']` AJV config (e.g., raw Fastify without createApp).
-*/
-function stripExamples(schema) {
-	if (schema === null || typeof schema !== "object") return schema;
-	if (Array.isArray(schema)) return schema.map(stripExamples);
-	const result = {};
-	for (const [key, value] of Object.entries(schema)) {
-		if (key === "example") continue;
-		result[key] = stripExamples(value);
-	}
-	return result;
-}
-/**
-* Get default response schemas for all CRUD operations.
-*
-* When routes have response schemas, Fastify compiles them with
-* fast-json-stringify for 2-3x faster serialization and prevents
-* accidental field disclosure.
-*
-* These defaults use `additionalProperties: true` so all fields pass through.
-* Override with specific schemas for full serialization performance + safety.
-*
-* Note: `example` properties are stripped from defaults so they work with
-* any Fastify instance (not just createApp which adds `keywords: ['example']`).
-*/
-function getDefaultCrudSchemas() {
-	return stripExamples({
-		list: {
-			querystring: getListQueryParams(),
-			response: { 200: listResponse(genericItemSchema) }
-		},
-		get: { response: { 200: itemResponse(genericItemSchema) } },
-		create: { response: { 201: mutationResponse(genericItemSchema) } },
-		update: { response: { 200: itemResponse(genericItemSchema) } },
-		delete: { response: { 200: deleteResponse() } }
-	});
-}
-//#endregion
-//#region src/utils/stateMachine.ts
-/**
-* Create a state machine for validating transitions
-*
-* @param name - Name of the state machine (used in error messages)
-* @param transitions - Map of actions to allowed source statuses
-* @param options - Additional options (history, guards, actions)
-* @returns State machine with can() and assert() methods
-*
-* @example
-* // Basic usage
-* const transferState = createStateMachine('Transfer', {
-*   approve: ['draft'],
-*   dispatch: ['approved'],
-*   receive: ['dispatched', 'in_transit'],
-*   cancel: ['draft', 'approved'],
-* });
-*
-* @example
-* // With guards and actions
-* const orderState = createStateMachine('Order', {
-*   approve: {
-*     from: ['pending'],
-*     to: 'approved',
-*     guard: ({ data }) => data.paymentConfirmed,
-*     before: ({ from, to }) => console.log(`Approving order from ${from} to ${to}`),
-*     after: ({ data }) => sendApprovalEmail(data.customerId),
-*   },
-* }, { trackHistory: true });
-*/
-function createStateMachine(name, transitions = {}, options = {}) {
-	const normalized = /* @__PURE__ */ new Map();
-	const history = options.trackHistory ? [] : void 0;
-	Object.entries(transitions).forEach(([action, allowed]) => {
-		if (Array.isArray(allowed)) normalized.set(action, { from: new Set(allowed) });
-		else if (typeof allowed === "object" && "from" in allowed) normalized.set(action, {
-			from: new Set(Array.isArray(allowed.from) ? allowed.from : [allowed.from]),
-			to: allowed.to,
-			guard: allowed.guard,
-			before: allowed.before,
-			after: allowed.after
-		});
-	});
-	const can = (action, status) => {
-		const transition = normalized.get(action);
-		if (!transition || !status) return false;
-		return transition.from.has(status);
-	};
-	const canAsync = async (action, status, context) => {
-		const transition = normalized.get(action);
-		if (!transition || !status) return false;
-		if (!transition.from.has(status)) return false;
-		if (transition.guard) try {
-			return await transition.guard({
-				from: status,
-				to: transition.to || "",
-				action,
-				data: context
-			});
-		} catch {
-			return false;
-		}
-		return true;
-	};
-	const assert = (action, status, errorFactory, message) => {
-		if (can(action, status)) return;
-		const errorMessage = message || `${name} cannot '${action}' when status is '${status || "unknown"}'`;
-		if (typeof errorFactory === "function") throw errorFactory(errorMessage);
-		throw new Error(errorMessage);
-	};
-	const recordTransition = (from, to, action, metadata) => {
-		if (history) history.push({
-			from,
-			to,
-			action,
-			timestamp: /* @__PURE__ */ new Date(),
-			metadata
-		});
-	};
-	const getHistory = () => {
-		return history ? [...history] : [];
-	};
-	const clearHistory = () => {
-		if (history) history.length = 0;
-	};
-	const getAvailableActions = (status) => {
-		const actions = [];
-		for (const [action, transition] of normalized.entries()) if (transition.from.has(status)) actions.push(action);
-		return actions;
-	};
-	return {
-		can,
-		canAsync,
-		assert,
-		recordTransition,
-		getHistory,
-		clearHistory,
-		getAvailableActions
-	};
-}
-//#endregion
-export { createCircuitBreakerRegistry as C, createCircuitBreaker as S, withCompensation as _, getListQueryParams as a, CircuitBreakerRegistry as b, mutationResponse as c, responses as d, successResponseSchema as f, defineCompensation as g, defineGuard as h, getDefaultCrudSchemas as i, paginationSchema as l, handleRaw as m, deleteResponse as n, itemResponse as o, wrapResponse as p, errorResponseSchema as r, listResponse as s, createStateMachine as t, queryParams as u, CircuitBreaker as v, CircuitState as x, CircuitBreakerError as y };