@hypequery/serve 0.0.7 → 0.0.9

package/dist/openapi.js

@@ -0,0 +1,205 @@
+import { zodToJsonSchema } from "zod-to-json-schema";
+const ERROR_SCHEMA = {
+    type: "object",
+    properties: {
+        error: {
+            type: "object",
+            properties: {
+                type: { type: "string" },
+                message: { type: "string" },
+                details: { type: "object" },
+            },
+            required: ["type", "message"],
+        },
+    },
+    required: ["error"],
+};
+const dereferenceSchema = (schema) => {
+    if (!schema || typeof schema !== "object") {
+        return schema;
+    }
+    if (schema.$ref && schema.definitions) {
+        const refKey = String(schema.$ref).split("/").pop();
+        if (refKey && schema.definitions[refKey]) {
+            return schema.definitions[refKey];
+        }
+    }
+    return schema;
+};
+const removeDefinitions = (schema) => {
+    if (!schema || typeof schema !== "object") {
+        return schema;
+    }
+    // Handle arrays
+    if (Array.isArray(schema)) {
+        return schema.map(item => removeDefinitions(item));
+    }
+    // If this schema has a $ref and definitions, inline the definition
+    if (schema.$ref && schema.definitions) {
+        const refKey = String(schema.$ref).split("/").pop();
+        if (refKey && schema.definitions[refKey]) {
+            const resolved = schema.definitions[refKey];
+            delete schema.$ref;
+            delete schema.definitions;
+            return removeDefinitions({ ...schema, ...resolved });
+        }
+    }
+    // Remove definitions property if it exists
+    const { definitions: _definitions, $ref: _ref, ...rest } = schema;
+    // Recursively clean nested objects and arrays
+    const result = {};
+    for (const [key, value] of Object.entries(rest)) {
+        if (Array.isArray(value)) {
+            result[key] = value.map(item => typeof item === "object" && item !== null ? removeDefinitions(item) : item);
+        }
+        else if (typeof value === "object" && value !== null) {
+            result[key] = removeDefinitions(value);
+        }
+        else {
+            result[key] = value;
+        }
+    }
+    return result;
+};
+const toJsonSchema = (schema, name) => {
+    if (!schema) {
+        return { type: "object" };
+    }
+    const jsonSchema = zodToJsonSchema(schema, {
+        target: "openApi3",
+        name,
+        $refStrategy: "none",
+    });
+    return removeDefinitions(jsonSchema);
+};
+const toQueryParameters = (schema, name) => {
+    if (!schema) {
+        return [];
+    }
+    const jsonSchema = dereferenceSchema(toJsonSchema(schema, name));
+    if (!jsonSchema || typeof jsonSchema !== "object") {
+        return [];
+    }
+    const schemaType = jsonSchema.type;
+    const isObjectType = schemaType === "object" || (Array.isArray(schemaType) && schemaType.includes("object"));
+    if (!isObjectType || typeof jsonSchema.properties !== "object") {
+        return [];
+    }
+    const properties = jsonSchema.properties;
+    const requiredSet = new Set(Array.isArray(jsonSchema.required) ? jsonSchema.required : []);
+    return Object.entries(properties).map(([key, value]) => ({
+        name: key,
+        in: "query",
+        required: requiredSet.has(key),
+        schema: value,
+    }));
+};
+const toOperation = (endpoint, nameSuffix) => {
+    const operation = {
+        operationId: endpoint.key,
+        summary: endpoint.metadata.summary,
+        description: endpoint.metadata.description,
+        tags: endpoint.metadata.tags.length ? endpoint.metadata.tags : undefined,
+        responses: {
+            200: {
+                description: "Successful response",
+                content: {
+                    "application/json": {
+                        schema: toJsonSchema(endpoint.outputSchema, `${endpoint.key}${nameSuffix}`),
+                    },
+                },
+            },
+            default: {
+                description: "Error response",
+                content: {
+                    "application/json": {
+                        schema: ERROR_SCHEMA,
+                    },
+                },
+            },
+        },
+    };
+    const queryParameters = endpoint.method === "GET"
+        ? toQueryParameters(endpoint.inputSchema, `${endpoint.key}Query`)
+        : [];
+    if (queryParameters.length > 0) {
+        operation.parameters = queryParameters;
+    }
+    else if (endpoint.inputSchema) {
+        operation.requestBody = {
+            required: true,
+            content: {
+                "application/json": {
+                    schema: toJsonSchema(endpoint.inputSchema, `${endpoint.key}Request`),
+                },
+            },
+        };
+    }
+    if (endpoint.metadata.requiresAuth) {
+        operation.security = [{ ApiKeyAuth: [] }];
+        // Add auth guard information to description
+        const authDetails = [];
+        if (endpoint.requiredRoles && endpoint.requiredRoles.length > 0) {
+            authDetails.push(`**Required roles:** ${endpoint.requiredRoles.join(", ")}`);
+        }
+        if (endpoint.requiredScopes && endpoint.requiredScopes.length > 0) {
+            authDetails.push(`**Required scopes:** ${endpoint.requiredScopes.join(", ")}`);
+        }
+        if (authDetails.length > 0) {
+            operation.description = [
+                endpoint.metadata.description || "",
+                ...authDetails,
+            ]
+                .filter(Boolean)
+                .join("\n\n");
+        }
+    }
+    return operation;
+};
+const normalizeInfo = (options) => {
+    const info = options?.info;
+    return {
+        title: info?.title ?? "hypequery API",
+        version: options?.version ?? "1.0.0",
+        description: info?.description,
+        termsOfService: info?.termsOfService,
+        contact: info?.contact,
+        license: info?.license,
+    };
+};
+export const buildOpenApiDocument = (endpoints, options) => {
+    var _a;
+    const document = {
+        openapi: "3.1.0",
+        info: normalizeInfo(options),
+        servers: options?.servers ?? [],
+        paths: {},
+    };
+    let needsSecurityScheme = false;
+    for (const endpoint of endpoints) {
+        if (endpoint.metadata.visibility && endpoint.metadata.visibility !== "public") {
+            continue;
+        }
+        const path = endpoint.metadata.path || "/";
+        const method = endpoint.method.toLowerCase();
+        const pathItem = ((_a = document.paths)[path] ?? (_a[path] = {}));
+        const operation = toOperation(endpoint, "Response");
+        if (endpoint.metadata.requiresAuth) {
+            needsSecurityScheme = true;
+        }
+        pathItem[method] = operation;
+    }
+    if (needsSecurityScheme) {
+        document.components = {
+            ...(document.components ?? {}),
+            securitySchemes: {
+                ApiKeyAuth: {
+                    type: "apiKey",
+                    name: "Authorization",
+                    in: "header",
+                },
+            },
+        };
+    }
+    return document;
+};

package/dist/pipeline.d.ts

@@ -0,0 +1,77 @@
+import { z } from 'zod';
+import type { AuthContext, AuthStrategy, DocsOptions, OpenApiOptions, ServeContextFactory, ServeEndpoint, ServeHandler, ServeLifecycleHooks, ServeMiddleware, ServeRequest, ServeResponse, TenantConfig } from './types.js';
+import { ServeQueryLogger } from './query-logger.js';
+export interface ExecuteEndpointOptions<TContext extends Record<string, unknown>, TAuth extends AuthContext> {
+    endpoint: ServeEndpoint<any, any, TContext, TAuth>;
+    request: ServeRequest;
+    requestId?: string;
+    authStrategies: AuthStrategy<TAuth>[];
+    contextFactory?: ServeContextFactory<TContext, TAuth>;
+    globalMiddlewares: ServeMiddleware<any, any, TContext, TAuth>[];
+    tenantConfig?: TenantConfig<TAuth>;
+    hooks?: ServeLifecycleHooks<TAuth>;
+    queryLogger?: ServeQueryLogger;
+    additionalContext?: Partial<TContext>;
+    verboseAuthErrors?: boolean;
+}
+export declare const executeEndpoint: <TContext extends Record<string, unknown>, TAuth extends AuthContext>(options: ExecuteEndpointOptions<TContext, TAuth>) => Promise<ServeResponse>;
+interface HandlerOptions<TContext extends Record<string, unknown>, TAuth extends AuthContext> {
+    router: import('./router.js').ServeRouter;
+    globalMiddlewares: ServeMiddleware<any, any, TContext, TAuth>[];
+    authStrategies: AuthStrategy<TAuth>[];
+    tenantConfig?: TenantConfig<TAuth>;
+    contextFactory?: ServeContextFactory<TContext, TAuth>;
+    hooks?: ServeLifecycleHooks<TAuth>;
+    queryLogger?: ServeQueryLogger;
+    verboseAuthErrors?: boolean;
+}
+export declare const createServeHandler: <TContext extends Record<string, unknown>, TAuth extends AuthContext>({ router, globalMiddlewares, authStrategies, tenantConfig, contextFactory, hooks, queryLogger, verboseAuthErrors, }: HandlerOptions<TContext, TAuth>) => ServeHandler;
+export declare const createOpenApiEndpoint: (path: string, getEndpoints: () => ServeEndpoint<any, any, any, any>[], options?: OpenApiOptions) => {
+    key: string;
+    method: "GET";
+    inputSchema: undefined;
+    outputSchema: z.ZodAny;
+    handler: () => Promise<unknown>;
+    query: undefined;
+    middlewares: never[];
+    auth: null;
+    metadata: {
+        path: string;
+        method: "GET";
+        name: string;
+        summary: string;
+        description: string;
+        tags: string[];
+        requiresAuth: false;
+        deprecated: false;
+        visibility: "internal";
+    };
+    cacheTtlMs: null;
+};
+export declare const createDocsEndpoint: (path: string, openapiPath: string, options?: DocsOptions) => {
+    key: string;
+    method: "GET";
+    inputSchema: undefined;
+    outputSchema: z.ZodString;
+    handler: () => Promise<string>;
+    query: undefined;
+    middlewares: never[];
+    auth: null;
+    metadata: {
+        path: string;
+        method: "GET";
+        name: string;
+        summary: string;
+        description: string;
+        tags: string[];
+        requiresAuth: false;
+        deprecated: false;
+        visibility: "internal";
+    };
+    cacheTtlMs: null;
+    defaultHeaders: {
+        'content-type': string;
+    };
+};
+export {};
+//# sourceMappingURL=pipeline.d.ts.map

package/dist/pipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.d.ts","sourceRoot":"","sources":["../src/pipeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAmB,MAAM,KAAK,CAAC;AAEzC,OAAO,KAAK,EACV,WAAW,EAEX,YAAY,EACZ,WAAW,EAKX,cAAc,EACd,mBAAmB,EACnB,aAAa,EACb,YAAY,EACZ,mBAAmB,EACnB,eAAe,EACf,YAAY,EACZ,aAAa,EACb,YAAY,EAEb,MAAM,YAAY,CAAC;AAKpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAsKrD,MAAM,WAAW,sBAAsB,CACrC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,KAAK,SAAS,WAAW;IAEzB,QAAQ,EAAE,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACnD,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;IACtC,cAAc,CAAC,EAAE,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtD,iBAAiB,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;IAChE,YAAY,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;IACnC,KAAK,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,iBAAiB,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IACtC,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,eAAO,MAAM,eAAe,GAC1B,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,KAAK,SAAS,WAAW,EAEzB,SAAS,sBAAsB,CAAC,QAAQ,EAAE,KAAK,CAAC,KAC/C,OAAO,CAAC,aAAa,CAqRvB,CAAC;AAEF,UAAU,cAAc,CACtB,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,KAAK,SAAS,WAAW;IAEzB,MAAM,EAAE,OAAO,aAAa,EAAE,WAAW,CAAC;IAC1C,iBAAiB,EAAE,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;IAChE,cAAc,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;IACtC,YAAY,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;IACnC,cAAc,CAAC,EAAE,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC;IACnC,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxC,KAAK,SAAS,WAAW,EACzB,qHASC,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAG,YA2BpC,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAChC,MAAM,MAAM,EACZ,cAAc,MAAM,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,EACvD,UAAU,cAAc;;;;;;;;;;;;;;;;;;;;;CA8BzB,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAC7B,MAAM,MAAM,EACZ,aAAa,MAAM,EACnB,UAAU,WAAW;;;;;;;;;;;;;;;;;;;;;;;;CAyBmD,CAAC"}