@authhero/adapter-interfaces 3.9.0 → 3.11.0

package/dist/sql.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});function e(e){let t=new Date(e);return Number.isNaN(t.getTime())?void 0:t.toISOString()}function t(t){if(t!=null){if(typeof t==`number`)return e(t);if(typeof t==`string`)return t===``?void 0:/^-?\d+(\.\d+)?$/.test(t)?e(parseFloat(t)):t}}function n(e,n=new Date(0).toISOString()){return t(e)??n}function r(e){if(!e||e===``)return null;let t=new Date(e);return isNaN(t.getTime())?null:t.getTime()}function i(){return new Date().toISOString()}function a(e,r,i=[]){let a={};for(let n of i)a[n.replace(/_ts$/,``)]=t(e[n]);for(let t of r)a[t.replace(/_ts$/,``)]=n(e[t]);return a}function o(e){return e===void 0?void 0:JSON.stringify(e)}function s(e,t,n={...e}){for(let r of t)e[r]!==void 0&&(n[r]=JSON.stringify(e[r]));return n}function c(e,t,n=e){for(let r of t)e[r]!==void 0&&(n[r]=+!!e[r])}function l(e){return Object.fromEntries(Object.entries(e).filter(([,e])=>e!=null))}function u(e){if(typeof e!=`object`||!e)return e;if(Array.isArray(e))return e.map(e=>typeof e==`object`&&e?u(e):e);let t=Object.getPrototypeOf(e);return t!==Object.prototype&&t!==null?e:Object.fromEntries(Object.entries(e).filter(([,e])=>e!==null).map(([e,t])=>[e,typeof t==`object`?u(t):t]))}function d(e){let t=Number(e);if(!Number.isSafeInteger(t))throw RangeError(`COUNT result is not a safe integer: ${String(e)}`);return t}exports.booleanToInt=c,exports.convertDatesToAdapter=a,exports.dbDateToIso=t,exports.dbDateToIsoRequired=n,exports.getCountAsInt=d,exports.isoToDbDate=r,exports.nowIso=i,exports.removeNullProperties=u,exports.removeUndefinedAndNull=l,exports.stringifyIfDefined=o,exports.stringifyProperties=s;

package/dist/sql.d.ts

@@ -0,0 +1,114 @@
+/**
+ * Date conversion utilities shared by the SQL adapters (kysely, drizzle).
+ *
+ * Databases may hold timestamps in either of two formats during migration:
+ * - Old format: varchar(35) ISO 8601 strings (e.g., "2024-01-15T10:30:00.000Z")
+ * - New format: bigint Unix timestamps in milliseconds (e.g., 1705315800000),
+ *   stored in `_ts`-suffixed columns
+ *
+ * The adapter interface always uses ISO strings, so adapters convert:
+ * - On READ: detect the stored format and convert to an ISO string
+ * - On WRITE: write as bigint timestamp (new format)
+ *
+ * This allows zero-downtime migration where:
+ * 1. Deploy code that reads both formats, writes new format
+ * 2. Run migration to convert existing data
+ * 3. (Optional) Remove old format support after migration completes
+ */
+/**
+ * Type for a date field that could be either format from the database
+ */
+type DbDateField = string | number | null | undefined;
+/**
+ * Convert a database date field (either format) to an ISO string for the
+ * adapter interface. Returns undefined if the value is null/undefined/empty.
+ */
+declare function dbDateToIso(value: DbDateField): string | undefined;
+/**
+ * Convert a database date field to ISO string, with a required fallback.
+ * Use this for non-nullable date fields like created_at.
+ */
+declare function dbDateToIsoRequired(value: DbDateField, fallback?: string): string;
+/**
+ * Convert an ISO string from the adapter interface to a bigint timestamp
+ * for writing to the database.
+ */
+declare function isoToDbDate(isoString: string | null | undefined): number | null;
+/**
+ * Get current timestamp as ISO string (for adapter interface)
+ */
+declare function nowIso(): string;
+/**
+ * Convert date fields from DB format to adapter format (ISO strings).
+ * Strips the _ts suffix from column names (e.g., created_at_ts -> created_at).
+ * @param row - The database row object
+ * @param requiredColumns - Columns that must have a value (will use fallback if null)
+ * @param optionalColumns - Columns that can be undefined
+ * @returns Object with converted date fields (with _ts suffix stripped)
+ */
+declare function convertDatesToAdapter<T extends Record<string, DbDateField>, R extends Extract<keyof T, string>, O extends Extract<keyof T, string> = never>(row: T, requiredColumns: R[], optionalColumns?: O[]): Record<string, string | undefined>;
+
+/**
+ * Row/entity transformation helpers shared by the SQL adapters (kysely,
+ * drizzle). They convert between the adapter interface's rich entity shapes
+ * (nested objects, booleans, optional fields) and the flat SQL row shapes
+ * (JSON strings, 0/1 integers, no undefined values).
+ */
+/**
+ * Stringify a value to JSON if it's defined, otherwise return undefined.
+ * This is useful for converting objects to JSON strings for database storage.
+ */
+declare function stringifyIfDefined<T>(value: T | undefined): string | undefined;
+/**
+ * Stringify multiple properties of an object to JSON strings.
+ * Only properties that are defined will be stringified.
+ *
+ * @param obj - The source object containing properties to stringify
+ * @param properties - Array of property names to stringify
+ * @param target - The target object to write stringified values to (defaults to a new object based on obj)
+ * @returns The target object with stringified properties
+ *
+ * @example
+ * const source = { flags: { enabled: true }, sessions: { timeout: 300 }, name: "Test" };
+ * const result = stringifyProperties(source, ['flags', 'sessions']);
+ * // result = { flags: '{"enabled":true}', sessions: '{"timeout":300}', name: "Test" }
+ */
+type StringifiedProperties<T, K extends keyof T> = {
+    [P in keyof T]: P extends K ? undefined extends T[P] ? string | undefined : string : T[P];
+};
+declare function stringifyProperties<T extends Record<string, unknown>, K extends keyof T & string>(obj: T, properties: K[]): StringifiedProperties<T, K>;
+declare function stringifyProperties<T extends Record<string, unknown>, U extends Record<string, unknown>>(obj: T, properties: (keyof T & string)[], target: U): U;
+/**
+ * Convert boolean properties to integers (1 for true, 0 for false).
+ * Only properties that are defined will be converted.
+ *
+ * @param source - The source object containing boolean properties to convert
+ * @param properties - Array of property names to convert
+ * @param target - The target object to write integer values to (defaults to source)
+ *
+ * @example
+ * const source = { enabled: true, active: false, name: "Test" };
+ * const result = {};
+ * booleanToInt(source, ['enabled', 'active'], result);
+ * // result = { enabled: 1, active: 0 }
+ */
+declare function booleanToInt<T extends Record<string, unknown>>(source: Partial<T>, properties: (keyof T & string)[], target?: Record<string, unknown>): void;
+/**
+ * Remove undefined and null properties from an object.
+ * This keeps the SQL payload clean by only including defined values.
+ */
+declare function removeUndefinedAndNull<T extends Record<string, unknown>>(obj: T): Partial<T>;
+/**
+ * Remove null properties from an object recursively. Used when mapping SQL
+ * rows (where missing values are NULL) back to adapter entities (where they
+ * are absent).
+ */
+declare function removeNullProperties<T>(obj: unknown): T;
+/**
+ * Get a COUNT(*) result as an integer regardless of how the DB driver
+ * returns it (string, number, or bigint).
+ */
+declare function getCountAsInt(count: string | number | bigint): number;
+
+export { booleanToInt, convertDatesToAdapter, dbDateToIso, dbDateToIsoRequired, getCountAsInt, isoToDbDate, nowIso, removeNullProperties, removeUndefinedAndNull, stringifyIfDefined, stringifyProperties };
+export type { DbDateField };

package/dist/sql.mjs

@@ -0,0 +1,56 @@
+//#region src/sql/dates.ts
+function e(e) {
+	let t = new Date(e);
+	return Number.isNaN(t.getTime()) ? void 0 : t.toISOString();
+}
+function t(t) {
+	if (t != null) {
+		if (typeof t == "number") return e(t);
+		if (typeof t == "string") return t === "" ? void 0 : /^-?\d+(\.\d+)?$/.test(t) ? e(parseFloat(t)) : t;
+	}
+}
+function n(e, n = (/* @__PURE__ */ new Date(0)).toISOString()) {
+	return t(e) ?? n;
+}
+function r(e) {
+	if (!e || e === "") return null;
+	let t = new Date(e);
+	return isNaN(t.getTime()) ? null : t.getTime();
+}
+function i() {
+	return (/* @__PURE__ */ new Date()).toISOString();
+}
+function a(e, r, i = []) {
+	let a = {};
+	for (let n of i) a[n.replace(/_ts$/, "")] = t(e[n]);
+	for (let t of r) a[t.replace(/_ts$/, "")] = n(e[t]);
+	return a;
+}
+//#endregion
+//#region src/sql/transform.ts
+function o(e) {
+	return e === void 0 ? void 0 : JSON.stringify(e);
+}
+function s(e, t, n = { ...e }) {
+	for (let r of t) e[r] !== void 0 && (n[r] = JSON.stringify(e[r]));
+	return n;
+}
+function c(e, t, n = e) {
+	for (let r of t) e[r] !== void 0 && (n[r] = +!!e[r]);
+}
+function l(e) {
+	return Object.fromEntries(Object.entries(e).filter(([, e]) => e != null));
+}
+function u(e) {
+	if (typeof e != "object" || !e) return e;
+	if (Array.isArray(e)) return e.map((e) => typeof e == "object" && e ? u(e) : e);
+	let t = Object.getPrototypeOf(e);
+	return t !== Object.prototype && t !== null ? e : Object.fromEntries(Object.entries(e).filter(([, e]) => e !== null).map(([e, t]) => [e, typeof t == "object" ? u(t) : t]));
+}
+function d(e) {
+	let t = Number(e);
+	if (!Number.isSafeInteger(t)) throw RangeError(`COUNT result is not a safe integer: ${String(e)}`);
+	return t;
+}
+//#endregion
+export { c as booleanToInt, a as convertDatesToAdapter, t as dbDateToIso, n as dbDateToIsoRequired, d as getCountAsInt, r as isoToDbDate, i as nowIso, u as removeNullProperties, l as removeUndefinedAndNull, o as stringifyIfDefined, s as stringifyProperties };