@agentforge/tools 0.16.71 → 0.16.73

package/dist/index.d.cts

@@ -5609,20 +5609,13 @@ declare function mapSchemaTypes(vendor: DatabaseVendor, columns: Array<{
 declare function getVendorTypeMap(vendor: DatabaseVendor): Readonly<Record<string, string>>;
 
 /**
- * Schema diff and serialisation utilities.
- *
- * Compare two {@link DatabaseSchema} instances and produce a structured
- * diff report.  Also provide JSON export / import for snapshot testing
- * and cross-environment schema comparison.
- *
- * @module schema/schema-diff
+ * Shared public diff-report types for relational schema comparison.
  */
-
 /** Describes a difference for a single column. */
 interface ColumnDiff {
     column: string;
     type: 'added' | 'removed' | 'changed';
-    /** Present when type is `changed` */
+    /** Present when type is `changed`. */
     changes?: Array<{
         property: string;
         before: unknown;
@@ -5633,9 +5626,9 @@ interface ColumnDiff {
 interface TableDiff {
     table: string;
     type: 'added' | 'removed' | 'changed';
-    /** Present when type is `changed` — per-column changes */
+    /** Present when type is `changed` with per-column changes. */
     columns?: ColumnDiff[];
-    /** Present when type is `changed` — primary-key changes */
+    /** Present when type is `changed` with primary-key changes. */
     primaryKeyChanged?: {
         before: string[];
         after: string[];
@@ -5643,11 +5636,11 @@ interface TableDiff {
 }
 /** Full diff report between two schemas. */
 interface SchemaDiffResult {
-    /** Whether the schemas are identical */
+    /** Whether the schemas are identical. */
     identical: boolean;
-    /** Per-table differences */
+    /** Per-table differences. */
     tables: TableDiff[];
-    /** Summary counts */
+    /** Summary counts. */
     summary: {
         tablesAdded: number;
         tablesRemoved: number;
@@ -5657,36 +5650,21 @@ interface SchemaDiffResult {
         columnsChanged: number;
     };
 }
+
 /**
  * Compare two database schemas and return a structured diff report.
  *
  * The comparison is name-based and case-insensitive. Schema-qualified
  * names are supported (e.g. `public.users`).
- *
- * @param before - The baseline schema
- * @param after - The schema to compare against the baseline
- * @returns A structured diff report
  */
 declare function diffSchemas(before: DatabaseSchema, after: DatabaseSchema): SchemaDiffResult;
+
 /**
- * Export a {@link DatabaseSchema} to a JSON string.
- *
- * The output is deterministic (keys sorted, 2-space indent) so that it
- * can be used for snapshot testing.
- *
- * @param schema - The schema to serialise
- * @returns Pretty-printed JSON string
+ * Export a database schema to deterministic JSON for snapshots and fixtures.
  */
 declare function exportSchemaToJson(schema: DatabaseSchema): string;
 /**
- * Import a {@link DatabaseSchema} from a JSON string.
- *
- * Performs basic structural validation to ensure the parsed object has the
- * required shape.
- *
- * @param json - JSON string produced by {@link exportSchemaToJson}
- * @returns Parsed database schema
- * @throws Error when the JSON is not a valid DatabaseSchema
+ * Import a database schema from JSON with basic structural validation.
  */
 declare function importSchemaFromJson(json: string): DatabaseSchema;
 

package/dist/index.d.ts

@@ -5609,20 +5609,13 @@ declare function mapSchemaTypes(vendor: DatabaseVendor, columns: Array<{
 declare function getVendorTypeMap(vendor: DatabaseVendor): Readonly<Record<string, string>>;
 
 /**
- * Schema diff and serialisation utilities.
- *
- * Compare two {@link DatabaseSchema} instances and produce a structured
- * diff report.  Also provide JSON export / import for snapshot testing
- * and cross-environment schema comparison.
- *
- * @module schema/schema-diff
+ * Shared public diff-report types for relational schema comparison.
  */
-
 /** Describes a difference for a single column. */
 interface ColumnDiff {
     column: string;
     type: 'added' | 'removed' | 'changed';
-    /** Present when type is `changed` */
+    /** Present when type is `changed`. */
     changes?: Array<{
         property: string;
         before: unknown;
@@ -5633,9 +5626,9 @@ interface ColumnDiff {
 interface TableDiff {
     table: string;
     type: 'added' | 'removed' | 'changed';
-    /** Present when type is `changed` — per-column changes */
+    /** Present when type is `changed` with per-column changes. */
     columns?: ColumnDiff[];
-    /** Present when type is `changed` — primary-key changes */
+    /** Present when type is `changed` with primary-key changes. */
     primaryKeyChanged?: {
         before: string[];
         after: string[];
@@ -5643,11 +5636,11 @@ interface TableDiff {
 }
 /** Full diff report between two schemas. */
 interface SchemaDiffResult {
-    /** Whether the schemas are identical */
+    /** Whether the schemas are identical. */
     identical: boolean;
-    /** Per-table differences */
+    /** Per-table differences. */
     tables: TableDiff[];
-    /** Summary counts */
+    /** Summary counts. */
     summary: {
         tablesAdded: number;
         tablesRemoved: number;
@@ -5657,36 +5650,21 @@ interface SchemaDiffResult {
         columnsChanged: number;
     };
 }
+
 /**
  * Compare two database schemas and return a structured diff report.
  *
  * The comparison is name-based and case-insensitive. Schema-qualified
  * names are supported (e.g. `public.users`).
- *
- * @param before - The baseline schema
- * @param after - The schema to compare against the baseline
- * @returns A structured diff report
  */
 declare function diffSchemas(before: DatabaseSchema, after: DatabaseSchema): SchemaDiffResult;
+
 /**
- * Export a {@link DatabaseSchema} to a JSON string.
- *
- * The output is deterministic (keys sorted, 2-space indent) so that it
- * can be used for snapshot testing.
- *
- * @param schema - The schema to serialise
- * @returns Pretty-printed JSON string
+ * Export a database schema to deterministic JSON for snapshots and fixtures.
  */
 declare function exportSchemaToJson(schema: DatabaseSchema): string;
 /**
- * Import a {@link DatabaseSchema} from a JSON string.
- *
- * Performs basic structural validation to ensure the parsed object has the
- * required shape.
- *
- * @param json - JSON string produced by {@link exportSchemaToJson}
- * @returns Parsed database schema
- * @throws Error when the JSON is not a valid DatabaseSchema
+ * Import a database schema from JSON with basic structural validation.
  */
 declare function importSchemaFromJson(json: string): DatabaseSchema;