postgresdk 0.6.11 → 0.6.14

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

@@ -0,0 +1,83 @@
+import type { Model } from "./introspect";
+import type { Config, AuthConfig } from "./types";
+export interface UnifiedContract {
+    version: string;
+    generatedAt: string;
+    description: string;
+    sdk: {
+        initialization: SDKInitExample[];
+        authentication: SDKAuthExample[];
+    };
+    resources: ResourceWithSDK[];
+    relationships: RelationshipContract[];
+}
+export interface SDKInitExample {
+    description: string;
+    code: string;
+}
+export interface SDKAuthExample {
+    strategy: string;
+    description: string;
+    code: string;
+}
+export interface ResourceWithSDK {
+    name: string;
+    tableName: string;
+    description: string;
+    sdk: {
+        client: string;
+        methods: SDKMethod[];
+    };
+    api: {
+        endpoints: EndpointContract[];
+    };
+    fields: FieldContract[];
+}
+export interface SDKMethod {
+    name: string;
+    signature: string;
+    description: string;
+    example: string;
+    correspondsTo?: string;
+}
+export interface EndpointContract {
+    method: string;
+    path: string;
+    description: string;
+    requestBody?: string;
+    responseBody?: string;
+    queryParameters?: Record<string, string>;
+}
+export interface FieldContract {
+    name: string;
+    type: string;
+    tsType: 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 unified contract showing both API and SDK usage
+ */
+export declare function generateUnifiedContract(model: Model, config: Config & {
+    auth?: AuthConfig;
+}): UnifiedContract;
+/**
+ * Generate markdown documentation for the unified contract
+ */
+export declare function generateUnifiedContractMarkdown(contract: UnifiedContract): string;
+/**
+ * Emit the unified contract as TypeScript code
+ */
+export declare function emitUnifiedContract(model: Model, config: Config & {
+    auth?: AuthConfig;
+}): string;