@digitaldefiance/node-express-suite 3.11.32 → 3.12.0

package/src/interfaces/openApi/decoratorOptions.js

@@ -0,0 +1,734 @@
+"use strict";
+/**
+ * @fileoverview Decorator options interfaces for the Express Suite decorator API.
+ * Provides TypeScript interfaces for all decorator configuration options.
+ * @module interfaces/openApi/decoratorOptions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isApiControllerOptions = isApiControllerOptions;
+exports.isRouteDecoratorOptions = isRouteDecoratorOptions;
+exports.isAuthDecoratorOptions = isAuthDecoratorOptions;
+exports.isParamDecoratorOptions = isParamDecoratorOptions;
+exports.isParamMetadata = isParamMetadata;
+exports.isReturnsDecoratorOptions = isReturnsDecoratorOptions;
+exports.isResponseMetadata = isResponseMetadata;
+exports.isPaginatedDecoratorOptions = isPaginatedDecoratorOptions;
+exports.isCacheDecoratorOptions = isCacheDecoratorOptions;
+exports.isRateLimitDecoratorOptions = isRateLimitDecoratorOptions;
+exports.isTransactionalDecoratorOptions = isTransactionalDecoratorOptions;
+exports.isApiParamDecoratorOptions = isApiParamDecoratorOptions;
+exports.isOpenAPIParamMetadata = isOpenAPIParamMetadata;
+exports.isApiRequestBodyDecoratorOptions = isApiRequestBodyDecoratorOptions;
+exports.isLifecycleMetadata = isLifecycleMetadata;
+exports.isApiSchemaDecoratorOptions = isApiSchemaDecoratorOptions;
+exports.isApiPropertyDecoratorOptions = isApiPropertyDecoratorOptions;
+exports.isSchemaPropertyMetadata = isSchemaPropertyMetadata;
+exports.isSchemaMetadata = isSchemaMetadata;
+exports.isApiOperationDecoratorOptions = isApiOperationDecoratorOptions;
+exports.isApiExampleDecoratorOptions = isApiExampleDecoratorOptions;
+exports.isAuthMetadata = isAuthMetadata;
+exports.isValidationMetadata = isValidationMetadata;
+exports.isMiddlewareMetadata = isMiddlewareMetadata;
+exports.isTransactionMetadata = isTransactionMetadata;
+const zod_1 = require("zod");
+/**
+ * Type guard to check if an object is a valid ApiControllerOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ApiControllerOptions interface
+ */
+function isApiControllerOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.tags !== undefined) {
+        if (!Array.isArray(options.tags) ||
+            !options.tags.every((t) => typeof t === 'string')) {
+            return false;
+        }
+    }
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    if (options.deprecated !== undefined &&
+        typeof options.deprecated !== 'boolean') {
+        return false;
+    }
+    if (options.name !== undefined && typeof options.name !== 'string') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid RouteDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches RouteDecoratorOptions interface
+ */
+function isRouteDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.middleware !== undefined && !Array.isArray(options.middleware)) {
+        return false;
+    }
+    if (options.auth !== undefined && typeof options.auth !== 'boolean') {
+        return false;
+    }
+    if (options.cryptoAuth !== undefined &&
+        typeof options.cryptoAuth !== 'boolean') {
+        return false;
+    }
+    if (options.rawJson !== undefined && typeof options.rawJson !== 'boolean') {
+        return false;
+    }
+    if (options.transaction !== undefined &&
+        typeof options.transaction !== 'boolean') {
+        return false;
+    }
+    if (options.transactionTimeout !== undefined &&
+        typeof options.transactionTimeout !== 'number') {
+        return false;
+    }
+    if (options.summary !== undefined && typeof options.summary !== 'string') {
+        return false;
+    }
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    if (options.tags !== undefined) {
+        if (!Array.isArray(options.tags) ||
+            !options.tags.every((t) => typeof t === 'string')) {
+            return false;
+        }
+    }
+    if (options.operationId !== undefined &&
+        typeof options.operationId !== 'string') {
+        return false;
+    }
+    if (options.deprecated !== undefined &&
+        typeof options.deprecated !== 'boolean') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid AuthDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches AuthDecoratorOptions interface
+ */
+function isAuthDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.failureStatusCode !== undefined &&
+        typeof options.failureStatusCode !== 'number') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ParamDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ParamDecoratorOptions interface
+ */
+function isParamDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    if (options.required !== undefined && typeof options.required !== 'boolean') {
+        return false;
+    }
+    if (options.deprecated !== undefined &&
+        typeof options.deprecated !== 'boolean') {
+        return false;
+    }
+    // schema and example can be complex types, basic validation only
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ParamMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches ParamMetadata interface
+ */
+function isParamMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    if (typeof metadata.index !== 'number') {
+        return false;
+    }
+    const validTypes = [
+        'param',
+        'body',
+        'query',
+        'header',
+        'user',
+        'eciesUser',
+        'req',
+        'res',
+        'next',
+    ];
+    if (typeof metadata.type !== 'string' ||
+        !validTypes.includes(metadata.type)) {
+        return false;
+    }
+    if (metadata.name !== undefined && typeof metadata.name !== 'string') {
+        return false;
+    }
+    if (metadata.options !== undefined &&
+        !isParamDecoratorOptions(metadata.options)) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ReturnsDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ReturnsDecoratorOptions interface
+ */
+function isReturnsDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    // example can be any type
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ResponseMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches ResponseMetadata interface
+ */
+function isResponseMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    if (typeof metadata.statusCode !== 'number') {
+        return false;
+    }
+    if (metadata.schema !== undefined && typeof metadata.schema !== 'string') {
+        return false;
+    }
+    if (metadata.description !== undefined &&
+        typeof metadata.description !== 'string') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid PaginatedDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches PaginatedDecoratorOptions interface
+ */
+function isPaginatedDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.defaultPageSize !== undefined &&
+        typeof options.defaultPageSize !== 'number') {
+        return false;
+    }
+    if (options.maxPageSize !== undefined &&
+        typeof options.maxPageSize !== 'number') {
+        return false;
+    }
+    if (options.useOffset !== undefined &&
+        typeof options.useOffset !== 'boolean') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid CacheDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches CacheDecoratorOptions interface
+ */
+function isCacheDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (typeof options.ttl !== 'number') {
+        return false;
+    }
+    if (options.keyPrefix !== undefined &&
+        typeof options.keyPrefix !== 'string') {
+        return false;
+    }
+    if (options.varyByUser !== undefined &&
+        typeof options.varyByUser !== 'boolean') {
+        return false;
+    }
+    if (options.varyByQuery !== undefined) {
+        if (!Array.isArray(options.varyByQuery) ||
+            !options.varyByQuery.every((q) => typeof q === 'string')) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid RateLimitDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches RateLimitDecoratorOptions interface
+ */
+function isRateLimitDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (typeof options.requests !== 'number') {
+        return false;
+    }
+    if (typeof options.window !== 'number') {
+        return false;
+    }
+    if (options.message !== undefined && typeof options.message !== 'string') {
+        return false;
+    }
+    if (options.byUser !== undefined && typeof options.byUser !== 'boolean') {
+        return false;
+    }
+    if (options.keyGenerator !== undefined &&
+        typeof options.keyGenerator !== 'function') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid TransactionalDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches TransactionalDecoratorOptions interface
+ */
+function isTransactionalDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.timeout !== undefined && typeof options.timeout !== 'number') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ApiParamDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ApiParamDecoratorOptions interface
+ */
+function isApiParamDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    if (options.required !== undefined && typeof options.required !== 'boolean') {
+        return false;
+    }
+    if (options.deprecated !== undefined &&
+        typeof options.deprecated !== 'boolean') {
+        return false;
+    }
+    if (options.enum !== undefined) {
+        if (!Array.isArray(options.enum) ||
+            !options.enum.every((e) => typeof e === 'string')) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid OpenAPIParamMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches OpenAPIParamMetadata interface
+ */
+function isOpenAPIParamMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    if (typeof metadata.name !== 'string') {
+        return false;
+    }
+    const validLocations = ['path', 'query', 'header', 'cookie'];
+    if (typeof metadata.in !== 'string' ||
+        !validLocations.includes(metadata.in)) {
+        return false;
+    }
+    if (!metadata.options || !isApiParamDecoratorOptions(metadata.options)) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ApiRequestBodyDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ApiRequestBodyDecoratorOptions interface
+ */
+function isApiRequestBodyDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    // schema is required and can be string or ZodSchema
+    if (options.schema === undefined) {
+        return false;
+    }
+    if (typeof options.schema !== 'string' &&
+        !(options.schema instanceof zod_1.z.ZodType)) {
+        return false;
+    }
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    if (options.required !== undefined && typeof options.required !== 'boolean') {
+        return false;
+    }
+    if (options.contentType !== undefined &&
+        typeof options.contentType !== 'string') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid LifecycleMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches LifecycleMetadata interface
+ */
+function isLifecycleMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    const validateCallbackArray = (arr) => {
+        if (!Array.isArray(arr)) {
+            return false;
+        }
+        return arr.every((cb) => typeof cb === 'function');
+    };
+    if (metadata.onSuccess !== undefined &&
+        !validateCallbackArray(metadata.onSuccess)) {
+        return false;
+    }
+    if (metadata.onError !== undefined &&
+        !validateCallbackArray(metadata.onError)) {
+        return false;
+    }
+    if (metadata.before !== undefined &&
+        !validateCallbackArray(metadata.before)) {
+        return false;
+    }
+    if (metadata.after !== undefined && !validateCallbackArray(metadata.after)) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ApiSchemaDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ApiSchemaDecoratorOptions interface
+ */
+function isApiSchemaDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.name !== undefined && typeof options.name !== 'string') {
+        return false;
+    }
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ApiPropertyDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ApiPropertyDecoratorOptions interface
+ */
+function isApiPropertyDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.type !== undefined && typeof options.type !== 'string') {
+        return false;
+    }
+    if (options.format !== undefined && typeof options.format !== 'string') {
+        return false;
+    }
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    if (options.required !== undefined && typeof options.required !== 'boolean') {
+        return false;
+    }
+    if (options.nullable !== undefined && typeof options.nullable !== 'boolean') {
+        return false;
+    }
+    if (options.minimum !== undefined && typeof options.minimum !== 'number') {
+        return false;
+    }
+    if (options.maximum !== undefined && typeof options.maximum !== 'number') {
+        return false;
+    }
+    if (options.minLength !== undefined &&
+        typeof options.minLength !== 'number') {
+        return false;
+    }
+    if (options.maxLength !== undefined &&
+        typeof options.maxLength !== 'number') {
+        return false;
+    }
+    if (options.pattern !== undefined && typeof options.pattern !== 'string') {
+        return false;
+    }
+    if (options.$ref !== undefined && typeof options.$ref !== 'string') {
+        return false;
+    }
+    if (options.enum !== undefined) {
+        if (!Array.isArray(options.enum) ||
+            !options.enum.every((e) => typeof e === 'string')) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid SchemaPropertyMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches SchemaPropertyMetadata interface
+ */
+function isSchemaPropertyMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    if (typeof metadata.propertyKey !== 'string') {
+        return false;
+    }
+    if (!metadata.options || !isApiPropertyDecoratorOptions(metadata.options)) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid SchemaMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches SchemaMetadata interface
+ */
+function isSchemaMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    if (typeof metadata.name !== 'string') {
+        return false;
+    }
+    if (!metadata.options || !isApiSchemaDecoratorOptions(metadata.options)) {
+        return false;
+    }
+    if (!Array.isArray(metadata.properties)) {
+        return false;
+    }
+    if (!metadata.properties.every((p) => isSchemaPropertyMetadata(p))) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ApiOperationDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ApiOperationDecoratorOptions interface
+ */
+function isApiOperationDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    if (options.summary !== undefined && typeof options.summary !== 'string') {
+        return false;
+    }
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    if (options.tags !== undefined) {
+        if (!Array.isArray(options.tags) ||
+            !options.tags.every((t) => typeof t === 'string')) {
+            return false;
+        }
+    }
+    if (options.operationId !== undefined &&
+        typeof options.operationId !== 'string') {
+        return false;
+    }
+    if (options.deprecated !== undefined &&
+        typeof options.deprecated !== 'boolean') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ApiExampleDecoratorOptions.
+ * @param obj - Object to validate
+ * @returns True if object matches ApiExampleDecoratorOptions interface
+ */
+function isApiExampleDecoratorOptions(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const options = obj;
+    // value is required
+    if (options.value === undefined) {
+        return false;
+    }
+    if (options.name !== undefined && typeof options.name !== 'string') {
+        return false;
+    }
+    if (options.summary !== undefined && typeof options.summary !== 'string') {
+        return false;
+    }
+    if (options.description !== undefined &&
+        typeof options.description !== 'string') {
+        return false;
+    }
+    if (options.type !== undefined &&
+        options.type !== 'request' &&
+        options.type !== 'response') {
+        return false;
+    }
+    if (options.statusCode !== undefined &&
+        typeof options.statusCode !== 'number') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid AuthMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches AuthMetadata interface
+ */
+function isAuthMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    if (metadata.requireAuth !== undefined &&
+        typeof metadata.requireAuth !== 'boolean') {
+        return false;
+    }
+    if (metadata.requireCryptoAuth !== undefined &&
+        typeof metadata.requireCryptoAuth !== 'boolean') {
+        return false;
+    }
+    if (metadata.isPublic !== undefined &&
+        typeof metadata.isPublic !== 'boolean') {
+        return false;
+    }
+    if (metadata.failureStatusCode !== undefined &&
+        typeof metadata.failureStatusCode !== 'number') {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid ValidationMetadata.
+ * Note: This performs basic structural validation only.
+ * @param obj - Object to validate
+ * @returns True if object matches ValidationMetadata interface
+ */
+function isValidationMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    // Each field can be a ZodSchema, ValidationChain[], or function
+    // We can only do basic type checking here
+    const validateField = (field) => {
+        if (field === undefined) {
+            return true;
+        }
+        // Check if it's a function
+        if (typeof field === 'function') {
+            return true;
+        }
+        // Check if it's an array (ValidationChain[])
+        if (Array.isArray(field)) {
+            return true;
+        }
+        // Check if it's a ZodSchema (has _def property)
+        if (field instanceof zod_1.z.ZodType) {
+            return true;
+        }
+        return false;
+    };
+    if (!validateField(metadata.body)) {
+        return false;
+    }
+    if (!validateField(metadata.params)) {
+        return false;
+    }
+    if (!validateField(metadata.query)) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid MiddlewareMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches MiddlewareMetadata interface
+ */
+function isMiddlewareMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    if (!Array.isArray(metadata.middleware)) {
+        return false;
+    }
+    if (!metadata.middleware.every((m) => typeof m === 'function')) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Type guard to check if an object is a valid TransactionMetadata.
+ * @param obj - Object to validate
+ * @returns True if object matches TransactionMetadata interface
+ */
+function isTransactionMetadata(obj) {
+    if (!obj || typeof obj !== 'object') {
+        return false;
+    }
+    const metadata = obj;
+    if (typeof metadata.useTransaction !== 'boolean') {
+        return false;
+    }
+    if (metadata.timeout !== undefined && typeof metadata.timeout !== 'number') {
+        return false;
+    }
+    return true;
+}
+//# sourceMappingURL=decoratorOptions.js.map