postgresdk 0.6.5 → 0.6.7

package/dist/emit-api-contract.d.ts

@@ -0,0 +1,60 @@
+import type { Model } from "./introspect";
+import type { Config, AuthConfig } from "./types";
+export interface ApiContract {
+    version: string;
+    generatedAt: string;
+    description: string;
+    authentication?: {
+        type: string;
+        description: string;
+    };
+    resources: ResourceContract[];
+    relationships: RelationshipContract[];
+}
+export interface ResourceContract {
+    name: string;
+    tableName: string;
+    description: string;
+    endpoints: EndpointContract[];
+    fields: FieldContract[];
+}
+export interface EndpointContract {
+    method: string;
+    path: string;
+    description: string;
+    requestBody?: any;
+    responseBody?: any;
+    queryParameters?: any;
+}
+export interface FieldContract {
+    name: string;
+    type: string;
+    required: boolean;
+    description: string;
+    foreignKey?: {
+        table: string;
+        field: string;
+    };
+}
+export interface RelationshipContract {
+    from: string;
+    to: string;
+    type: "one-to-many" | "many-to-one" | "many-to-many";
+    description: string;
+}
+/**
+ * Generate a comprehensive API contract in JSON format
+ */
+export declare function generateApiContract(model: Model, config: Config & {
+    auth?: AuthConfig;
+}): ApiContract;
+/**
+ * Generate a human-readable markdown version of the contract
+ */
+export declare function generateApiContractMarkdown(contract: ApiContract): string;
+/**
+ * Emit the API contract as TypeScript code that can be served as an endpoint
+ */
+export declare function emitApiContract(model: Model, config: Config & {
+    auth?: AuthConfig;
+}): string;