@bubblelab/bubble-core 0.1.10 → 0.1.12

package/dist/utils/schema-comparison.d.ts

@@ -0,0 +1,92 @@
+import { z } from 'zod';
+/**
+ * Represents the difference between actual data and a Zod schema
+ */
+export interface SchemaDifference {
+    /** Fields present in data but not defined in schema */
+    extraFields: FieldInfo[];
+    /** Fields defined in schema but missing from data (and are required) */
+    missingRequiredFields: FieldInfo[];
+    /** Fields defined in schema but missing from data (optional fields) */
+    missingOptionalFields: FieldInfo[];
+    /** Fields with type mismatches */
+    typeMismatches: TypeMismatch[];
+    /** Nested object differences */
+    nestedDifferences: Record<string, SchemaDifference>;
+    /** Summary statistics */
+    summary: {
+        totalExtraFields: number;
+        totalMissingRequired: number;
+        totalMissingOptional: number;
+        totalTypeMismatches: number;
+        isCompatible: boolean;
+    };
+}
+export interface FieldInfo {
+    path: string;
+    value?: unknown;
+    type?: string;
+}
+export interface TypeMismatch {
+    path: string;
+    expectedType: string;
+    actualType: string;
+    actualValue: unknown;
+}
+/**
+ * Compare data against a Zod schema and find all differences
+ *
+ * @param schema - The Zod schema to compare against
+ * @param data - The actual data to compare
+ * @param basePath - Base path for nested field names (used internally)
+ * @returns Detailed comparison results showing all differences
+ *
+ * @example
+ * ```typescript
+ * const schema = z.object({
+ *   name: z.string(),
+ *   age: z.number().optional(),
+ * });
+ *
+ * const data = {
+ *   name: 'John',
+ *   extraField: 'unexpected',
+ * };
+ *
+ * const diff = compareWithSchema(schema, data);
+ * // diff.extraFields = [{ path: 'extraField', value: 'unexpected', type: 'string' }]
+ * // diff.missingOptionalFields = [{ path: 'age' }]
+ * ```
+ */
+export declare function compareWithSchema(schema: z.ZodTypeAny, data: unknown, basePath?: string): SchemaDifference;
+/**
+ * Format schema differences as a human-readable string
+ */
+export declare function formatSchemaDifference(diff: SchemaDifference, indent?: number): string;
+export interface FieldWithIndex {
+    fieldName: string;
+    index: number;
+}
+/**
+ * Compare multiple data items against a schema and aggregate differences
+ * Useful for analyzing API responses with multiple items
+ */
+export declare function compareMultipleWithSchema(schema: z.ZodTypeAny, items: unknown[], maxItems?: number): {
+    itemCount: number;
+    status: 'PASS' | 'FAIL';
+    allExtraFields: FieldWithIndex[];
+    allMissingRequired: FieldWithIndex[];
+    allMissingOptional: FieldWithIndex[];
+    allTypeMismatches: Map<string, Set<string>>;
+    sampleDifferences: SchemaDifference[];
+    summary: string;
+};
+/**
+ * Format aggregated differences from multiple items in a git-diff style
+ */
+export declare function formatAggregatedDifferences(result: ReturnType<typeof compareMultipleWithSchema>): string;
+/**
+ * Format aggregated differences with per-item breakdown
+ */
+export declare function formatAggregatedDifferencesDetailed(result: ReturnType<typeof compareMultipleWithSchema>, schema: z.ZodTypeAny): string;
+//# sourceMappingURL=schema-comparison.d.ts.map

package/dist/utils/schema-comparison.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-comparison.d.ts","sourceRoot":"","sources":["../../src/utils/schema-comparison.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uDAAuD;IACvD,WAAW,EAAE,SAAS,EAAE,CAAC;IACzB,wEAAwE;IACxE,qBAAqB,EAAE,SAAS,EAAE,CAAC;IACnC,uEAAuE;IACvE,qBAAqB,EAAE,SAAS,EAAE,CAAC;IACnC,kCAAkC;IAClC,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B,gCAAgC;IAChC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACpD,yBAAyB;IACzB,OAAO,EAAE;QACP,gBAAgB,EAAE,MAAM,CAAC;QACzB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,mBAAmB,EAAE,MAAM,CAAC;QAC5B,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;CACtB;AAqHD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,CAAC,CAAC,UAAU,EACpB,IAAI,EAAE,OAAO,EACb,QAAQ,SAAK,GACZ,gBAAgB,CAyJlB;AAkCD;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,gBAAgB,EACtB,MAAM,SAAI,GACT,MAAM,CAgDR;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,CAAC,CAAC,UAAU,EACpB,KAAK,EAAE,OAAO,EAAE,EAChB,QAAQ,SAAK,GACZ;IACD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC,kBAAkB,EAAE,cAAc,EAAE,CAAC;IACrC,kBAAkB,EAAE,cAAc,EAAE,CAAC;IACrC,iBAAiB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB,CAwEA;AAmUD;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,UAAU,CAAC,OAAO,yBAAyB,CAAC,GACnD,MAAM,CAgDR;AAED;;GAEG;AACH,wBAAgB,mCAAmC,CACjD,MAAM,EAAE,UAAU,CAAC,OAAO,yBAAyB,CAAC,EACpD,MAAM,EAAE,CAAC,CAAC,UAAU,GACnB,MAAM,CA8CR"}