@microsoft/rayfin-data 1.20.0

package/dist/utils/serialization.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Serialization utilities for DAB compatibility
+ *
+ * DAB often returns boolean values as strings ("true"/"false") from database queries.
+ * These utilities ensure proper type conversion for TypeScript clients.
+ */
+/**
+ * Converts a DAB boolean value (which may be a string) to a proper TypeScript boolean
+ * @param value - The boolean value from DAB, which could be boolean, string, or undefined
+ * @returns A proper TypeScript boolean
+ */
+export declare function deserializeBoolean(value: boolean | string | undefined | null): boolean;
+/**
+ * Converts a DAB date value (which may be a string) to a proper Date object
+ * @param value - The date value from DAB, which could be Date, string, or undefined
+ * @returns A proper Date object or undefined
+ */
+export declare function deserializeDate(value: Date | string | undefined | null): Date | undefined;
+/**
+ * Type guard to check if a value is a DAB string boolean
+ */
+export declare function isDabStringBoolean(value: unknown): value is 'true' | 'false';
+/**
+ * Deep transform an object to convert DAB serialized values to proper TypeScript types
+ * This recursively processes objects and arrays to convert string booleans and dates
+ */
+export declare function deserializeDabResponse<T = any>(data: any): T;
+/**
+ * Transform data for sending to DAB (opposite of deserialize)
+ * Converts boolean values to strings if needed for specific DAB configurations
+ */
+export declare function serializeForDab<T = any>(data: T): any;
+//# sourceMappingURL=serialization.d.ts.map

package/dist/utils/serialization.js

@@ -0,0 +1,132 @@
+/**
+ * Serialization utilities for DAB compatibility
+ *
+ * DAB often returns boolean values as strings ("true"/"false") from database queries.
+ * These utilities ensure proper type conversion for TypeScript clients.
+ */
+/**
+ * Converts a DAB boolean value (which may be a string) to a proper TypeScript boolean
+ * @param value - The boolean value from DAB, which could be boolean, string, or undefined
+ * @returns A proper TypeScript boolean
+ */
+export function deserializeBoolean(value) {
+    if (typeof value === 'boolean') {
+        return value;
+    }
+    if (typeof value === 'string') {
+        return value.toLowerCase() === 'true';
+    }
+    return false; // Default for undefined, null, or other types
+}
+/**
+ * Converts a DAB date value (which may be a string) to a proper Date object
+ * @param value - The date value from DAB, which could be Date, string, or undefined
+ * @returns A proper Date object or undefined
+ */
+export function deserializeDate(value) {
+    if (!value)
+        return undefined;
+    if (value instanceof Date)
+        return value;
+    if (typeof value === 'string') {
+        const date = new Date(value);
+        return isNaN(date.getTime()) ? undefined : date;
+    }
+    return undefined;
+}
+/**
+ * Type guard to check if a value is a DAB string boolean
+ */
+export function isDabStringBoolean(value) {
+    return typeof value === 'string' && (value === 'true' || value === 'false');
+}
+/**
+ * Deep transform an object to convert DAB serialized values to proper TypeScript types
+ * This recursively processes objects and arrays to convert string booleans and dates
+ */
+export function deserializeDabResponse(data) {
+    if (data === null || data === undefined) {
+        return data;
+    }
+    if (Array.isArray(data)) {
+        return data.map((item) => deserializeDabResponse(item));
+    }
+    if (typeof data === 'object') {
+        const result = {};
+        for (const [key, value] of Object.entries(data)) {
+            if (isDabStringBoolean(value)) {
+                // Convert string booleans to actual booleans
+                result[key] = deserializeBoolean(value);
+            }
+            else if (typeof value === 'string' && isISODateString(value)) {
+                // Convert ISO date strings to Date objects
+                result[key] = deserializeDate(value);
+            }
+            else if (value instanceof Date) {
+                // Keep Date objects as-is (don't recursively process them)
+                result[key] = value;
+            }
+            else if (typeof value === 'object') {
+                // Recursively process nested objects
+                result[key] = deserializeDabResponse(value);
+            }
+            else {
+                // Keep primitive values as-is
+                result[key] = value;
+            }
+        }
+        return result;
+    }
+    // For primitive values, return as-is
+    return data;
+}
+/**
+ * Check if a string looks like an ISO date string
+ */
+function isISODateString(value) {
+    // Check for ISO 8601 formats:
+    // - Full datetime: "2023-12-25T10:30:00.000Z" or "2023-12-25T10:30:00"
+    // - Date only: "2023-12-25" (DAB commonly returns date-only strings)
+    const isoDatetimeRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$/;
+    const isoDateOnlyRegex = /^\d{4}-\d{2}-\d{2}$/;
+    return ((isoDatetimeRegex.test(value) || isoDateOnlyRegex.test(value)) &&
+        !isNaN(Date.parse(value)));
+}
+/**
+ * Transform data for sending to DAB (opposite of deserialize)
+ * Converts boolean values to strings if needed for specific DAB configurations
+ */
+export function serializeForDab(data) {
+    if (data === null || data === undefined) {
+        return data;
+    }
+    if (Array.isArray(data)) {
+        return data.map((item) => serializeForDab(item));
+    }
+    if (typeof data === 'object') {
+        const result = {};
+        for (const [key, value] of Object.entries(data)) {
+            if (typeof value === 'boolean') {
+                // Keep booleans as booleans for most DAB scenarios
+                // Only convert to strings if specifically needed
+                result[key] = value;
+            }
+            else if (value instanceof Date) {
+                // Convert Date objects to ISO strings
+                result[key] = value.toISOString();
+            }
+            else if (typeof value === 'object') {
+                // Recursively process nested objects
+                result[key] = serializeForDab(value);
+            }
+            else {
+                // Keep other values as-is
+                result[key] = value;
+            }
+        }
+        return result;
+    }
+    // For primitive values, return as-is
+    return data;
+}
+//# sourceMappingURL=serialization.js.map

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@microsoft/rayfin-data",
+  "version": "1.20.0",
+  "description": "Type-safe client library for Data API Builder endpoints",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "!dist/**/__tests__/**",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@microsoft/rayfin-lib": "1.20.0",
+    "@microsoft/rayfin-core": "1.20.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "eslint": "^9.28.0",
+    "prettier": "^3.5.3",
+    "rimraf": "~6.0.1",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.3",
+    "@vitest/coverage-v8": "~3.2.4"
+  },
+  "keywords": [
+    "dab",
+    "data-api-builder",
+    "typescript",
+    "client",
+    "rest",
+    "graphql"
+  ],
+  "author": "Microsoft",
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com",
+    "access": "restricted"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/project-rayfin.git",
+    "directory": "packages/typescript-sdk/data"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rimraf dist && rimraf .tsbuildinfo",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:integration": "vitest run src/__tests__/integration/",
+    "test:integration:watch": "vitest src/__tests__/integration/"
+  }
+}