@zenstackhq/server 3.5.0-beta.2 → 3.5.0-beta.4

package/dist/api.d.cts

@@ -1,6 +1,37 @@
+import { QueryOptions } from '@zenstackhq/orm';
 import { SchemaDef } from '@zenstackhq/orm/schema';
+import * as openapi_types from 'openapi-types';
+import { OpenAPIV3_1 } from 'openapi-types';
 import { A as ApiHandler, L as LogConfig, R as RequestContext, a as Response } from './types-CU_PWKr9.cjs';
-import '@zenstackhq/orm';
+
+type CommonHandlerOptions<Schema extends SchemaDef> = {
+    /** Query options that affect the behavior of the OpenAPI provider. */
+    queryOptions?: QueryOptions<Schema>;
+};
+type OpenApiSpecOptions = {
+    /** Spec title. Defaults to 'ZenStack Generated API' */
+    title?: string;
+    /** Spec version. Defaults to '1.0.0' */
+    version?: string;
+    /** Spec description. */
+    description?: string;
+    /** Spec summary. */
+    summary?: string;
+    /**
+     * When true, assumes that the schema includes access policies, and adds
+     * 403 responses to operations that can potentially be rejected.
+     */
+    respectAccessPolicies?: boolean;
+};
+/**
+ * Interface for generating OpenAPI specifications.
+ */
+interface OpenApiSpecGenerator {
+    /**
+     * Generates an OpenAPI v3.1 specification document.
+     */
+    generateSpec(options?: OpenApiSpecOptions): Promise<OpenAPIV3_1.Document>;
+}
 
 /**
  * Options for {@link RestApiHandler}
@@ -45,11 +76,11 @@ type RestApiHandlerOptions<Schema extends SchemaDef = SchemaDef> = {
      * Mapping from model names to unique field name to be used as resource's ID.
      */
     externalIdMapping?: Record<string, string>;
-};
+} & CommonHandlerOptions<Schema>;
 /**
  * RESTful-style API request handler (compliant with JSON:API)
  */
-declare class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements ApiHandler<Schema> {
+declare class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements ApiHandler<Schema>, OpenApiSpecGenerator {
     private readonly options;
     private serializers;
     private readonly errors;
@@ -122,6 +153,7 @@ declare class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Ap
     private makeError;
     private makeUnsupportedModelError;
     private makeUnsupportedRelationshipError;
+    generateSpec(options?: OpenApiSpecOptions): Promise<openapi_types.OpenAPIV3_1.Document<{}>>;
 }
 
 /**
@@ -136,7 +168,7 @@ type RPCApiHandlerOptions<Schema extends SchemaDef = SchemaDef> = {
      * Logging configuration
      */
     log?: LogConfig;
-};
+} & CommonHandlerOptions<Schema>;
 /**
  * RPC style API request handler that mirrors the ZenStackClient API
  */
@@ -156,4 +188,4 @@ declare class RPCApiHandler<Schema extends SchemaDef = SchemaDef> implements Api
     private processRequestPayload;
 }
 
-export { RPCApiHandler, type RPCApiHandlerOptions, RestApiHandler, type RestApiHandlerOptions };
+export { type OpenApiSpecGenerator, type OpenApiSpecOptions, RPCApiHandler, type RPCApiHandlerOptions, RestApiHandler, type RestApiHandlerOptions };

package/dist/api.d.ts

@@ -1,6 +1,37 @@
+import { QueryOptions } from '@zenstackhq/orm';
 import { SchemaDef } from '@zenstackhq/orm/schema';
+import * as openapi_types from 'openapi-types';
+import { OpenAPIV3_1 } from 'openapi-types';
 import { A as ApiHandler, L as LogConfig, R as RequestContext, a as Response } from './types-CU_PWKr9.js';
-import '@zenstackhq/orm';
+
+type CommonHandlerOptions<Schema extends SchemaDef> = {
+    /** Query options that affect the behavior of the OpenAPI provider. */
+    queryOptions?: QueryOptions<Schema>;
+};
+type OpenApiSpecOptions = {
+    /** Spec title. Defaults to 'ZenStack Generated API' */
+    title?: string;
+    /** Spec version. Defaults to '1.0.0' */
+    version?: string;
+    /** Spec description. */
+    description?: string;
+    /** Spec summary. */
+    summary?: string;
+    /**
+     * When true, assumes that the schema includes access policies, and adds
+     * 403 responses to operations that can potentially be rejected.
+     */
+    respectAccessPolicies?: boolean;
+};
+/**
+ * Interface for generating OpenAPI specifications.
+ */
+interface OpenApiSpecGenerator {
+    /**
+     * Generates an OpenAPI v3.1 specification document.
+     */
+    generateSpec(options?: OpenApiSpecOptions): Promise<OpenAPIV3_1.Document>;
+}
 
 /**
  * Options for {@link RestApiHandler}
@@ -45,11 +76,11 @@ type RestApiHandlerOptions<Schema extends SchemaDef = SchemaDef> = {
      * Mapping from model names to unique field name to be used as resource's ID.
      */
     externalIdMapping?: Record<string, string>;
-};
+} & CommonHandlerOptions<Schema>;
 /**
  * RESTful-style API request handler (compliant with JSON:API)
  */
-declare class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements ApiHandler<Schema> {
+declare class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements ApiHandler<Schema>, OpenApiSpecGenerator {
     private readonly options;
     private serializers;
     private readonly errors;
@@ -122,6 +153,7 @@ declare class RestApiHandler<Schema extends SchemaDef = SchemaDef> implements Ap
     private makeError;
     private makeUnsupportedModelError;
     private makeUnsupportedRelationshipError;
+    generateSpec(options?: OpenApiSpecOptions): Promise<openapi_types.OpenAPIV3_1.Document<{}>>;
 }
 
 /**
@@ -136,7 +168,7 @@ type RPCApiHandlerOptions<Schema extends SchemaDef = SchemaDef> = {
      * Logging configuration
      */
     log?: LogConfig;
-};
+} & CommonHandlerOptions<Schema>;
 /**
  * RPC style API request handler that mirrors the ZenStackClient API
  */
@@ -156,4 +188,4 @@ declare class RPCApiHandler<Schema extends SchemaDef = SchemaDef> implements Api
     private processRequestPayload;
 }
 
-export { RPCApiHandler, type RPCApiHandlerOptions, RestApiHandler, type RestApiHandlerOptions };
+export { type OpenApiSpecGenerator, type OpenApiSpecOptions, RPCApiHandler, type RPCApiHandlerOptions, RestApiHandler, type RestApiHandlerOptions };