@sqlrooms/utils 0.0.1-alpha.0 → 0.0.2

package/dist/filepaths.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Splits a file path into its directory, name, and extension components.
+ * @param filePath - The full file path to split
+ * @returns An object containing the directory path, file name (without extension), and extension
+ * @example
+ * splitFilePath("path/to/file.txt") // returns { dir: "path/to", name: "file", ext: "txt" }
+ */
+export declare function splitFilePath(filePath: string): {
+    dir: string;
+    name: string;
+    ext: string;
+};
+/**
+ * Converts a filename into a valid and unique column or table name for database use.
+ * - Removes file extension
+ * - Replaces invalid characters with underscores
+ * - Ensures the name starts with a letter or underscore
+ * - Truncates to max length of 63 characters
+ * - Ensures uniqueness among existing names
+ *
+ * @param filename - The original filename to convert
+ * @param existingTables - Optional array of existing table names to ensure uniqueness
+ * @returns A valid and unique table/column name
+ * @example
+ * convertToUniqueColumnOrTableName("my-file.csv") // returns "my_file"
+ * convertToUniqueColumnOrTableName("123data.csv") // returns "_123data"
+ */
+export declare function convertToUniqueColumnOrTableName(filename: string, existingTables?: string[]): string;
+/**
+ * Generates a unique name by appending a numeric suffix if the name already exists.
+ * @param name - The base name to make unique
+ * @param usedNames - Optional array of existing names to check against
+ * @returns A unique name, potentially with a numeric suffix
+ * @example
+ * generateUniqueName("table", ["table"]) // returns "table_1"
+ * generateUniqueName("table_1", ["table_1"]) // returns "table_2"
+ */
+export declare function generateUniqueName(name: string, usedNames?: string[]): string;
+/**
+ * Generates a unique file path by appending a numeric suffix if the path already exists.
+ * @param filePath - The original file path
+ * @param existingPaths - Array of existing file paths to check against
+ * @returns A unique file path
+ * @example
+ * generateUniquePath("file.txt", ["file.txt"]) // returns "file_1.txt"
+ */
+export declare function generateUniquePath(filePath: string, existingPaths: string[]): string;
+/**
+ * Converts a string into a valid and unique S3 object name.
+ * - Replaces special characters with underscores
+ * - Ensures name is within S3's length limits
+ * - Ensures uniqueness among existing objects
+ *
+ * @param str - The string to convert into an S3 object name
+ * @param existingObjects - Optional array of existing S3 object names to ensure uniqueness
+ * @returns A valid and unique S3 object name
+ * @example
+ * convertToUniqueS3ObjectName("my file.txt") // returns "my_file.txt"
+ */
+export declare function convertToUniqueS3ObjectName(str: string, existingObjects?: string[]): string;
+/**
+ * Converts a string into a valid and unique S3 folder path.
+ * - Ensures the path ends with a forward slash
+ * - Replaces special characters with underscores
+ * - Ensures uniqueness among existing paths
+ *
+ * @param str - The string to convert into an S3 folder path
+ * @param existingObjects - Optional array of existing S3 paths to ensure uniqueness
+ * @returns A valid and unique S3 folder path ending with a forward slash
+ * @example
+ * convertToUniqueS3FolderPath("my folder") // returns "my_folder/"
+ */
+export declare function convertToUniqueS3FolderPath(str: string, existingObjects?: string[]): string;
+//# sourceMappingURL=filepaths.d.ts.map

package/dist/filepaths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filepaths.d.ts","sourceRoot":"","sources":["../src/filepaths.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG;IAC/C,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb,CAYA;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gCAAgC,CAC9C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,EAAE,GACxB,MAAM,CAoBR;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,UAsBpE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EAAE,GACtB,MAAM,CAqBR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,EAAE,MAAM,EACX,eAAe,CAAC,EAAE,MAAM,EAAE,GACzB,MAAM,CAeR;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,2BAA2B,CACzC,GAAG,EAAE,MAAM,EACX,eAAe,CAAC,EAAE,MAAM,EAAE,GACzB,MAAM,CAaR"}

package/dist/filepaths.js

@@ -0,0 +1,156 @@
+/**
+ * Splits a file path into its directory, name, and extension components.
+ * @param filePath - The full file path to split
+ * @returns An object containing the directory path, file name (without extension), and extension
+ * @example
+ * splitFilePath("path/to/file.txt") // returns { dir: "path/to", name: "file", ext: "txt" }
+ */
+export function splitFilePath(filePath) {
+    const pathParts = filePath.split('/');
+    const file = pathParts.pop() || '';
+    const dotIndex = file.lastIndexOf('.');
+    if (dotIndex === -1 || dotIndex === 0)
+        return { dir: pathParts.join('/'), name: file, ext: '' };
+    const name = file.substring(0, dotIndex);
+    const ext = file.substring(dotIndex + 1);
+    return { dir: pathParts.join('/'), name, ext };
+}
+/**
+ * Converts a filename into a valid and unique column or table name for database use.
+ * - Removes file extension
+ * - Replaces invalid characters with underscores
+ * - Ensures the name starts with a letter or underscore
+ * - Truncates to max length of 63 characters
+ * - Ensures uniqueness among existing names
+ *
+ * @param filename - The original filename to convert
+ * @param existingTables - Optional array of existing table names to ensure uniqueness
+ * @returns A valid and unique table/column name
+ * @example
+ * convertToUniqueColumnOrTableName("my-file.csv") // returns "my_file"
+ * convertToUniqueColumnOrTableName("123data.csv") // returns "_123data"
+ */
+export function convertToUniqueColumnOrTableName(filename, existingTables) {
+    // Remove file extension
+    const base = filename.replace(/\.[^/.]+$/, '');
+    // Replace any invalid character with underscore, and convert to lowercase
+    let tableName = base.replace(/[^a-z0-9_]/gi, '_');
+    // If the first character is a number, prepend an underscore
+    if (/^\d/.test(tableName)) {
+        tableName = '_' + tableName;
+    }
+    // Truncate to the max length 63
+    if (tableName.length > 63) {
+        tableName = tableName.substring(0, 63);
+    }
+    tableName = generateUniqueName(tableName, existingTables);
+    return tableName;
+}
+/**
+ * Generates a unique name by appending a numeric suffix if the name already exists.
+ * @param name - The base name to make unique
+ * @param usedNames - Optional array of existing names to check against
+ * @returns A unique name, potentially with a numeric suffix
+ * @example
+ * generateUniqueName("table", ["table"]) // returns "table_1"
+ * generateUniqueName("table_1", ["table_1"]) // returns "table_2"
+ */
+export function generateUniqueName(name, usedNames) {
+    const usedNamesLower = usedNames?.map((n) => n.toLowerCase());
+    // If tableName exists in the list
+    if (usedNamesLower?.includes(name.toLowerCase())) {
+        let baseName = name;
+        let i = 0;
+        // If tableName ends with `_${i}` pattern, update the baseTableName and i
+        const matched = name.match(/^(.+)_(\d+)$/);
+        if (matched) {
+            baseName = matched[1];
+            i = Number(matched[2]);
+        }
+        do {
+            i++;
+            name = `${baseName}_${i}`;
+        } while (usedNamesLower.includes(name.toLowerCase()));
+    }
+    return name;
+}
+/**
+ * Generates a unique file path by appending a numeric suffix if the path already exists.
+ * @param filePath - The original file path
+ * @param existingPaths - Array of existing file paths to check against
+ * @returns A unique file path
+ * @example
+ * generateUniquePath("file.txt", ["file.txt"]) // returns "file_1.txt"
+ */
+export function generateUniquePath(filePath, existingPaths) {
+    let nextPath = filePath;
+    if (existingPaths?.includes(filePath)) {
+        const { dir, name, ext } = splitFilePath(filePath);
+        let i = 0;
+        let baseName = name;
+        const matched = name.match(/^(.+)_(\d+)$/);
+        if (matched) {
+            baseName = matched[1];
+            i = Number(matched[2]);
+        }
+        do {
+            i++;
+            const fname = `${baseName}_${i}${ext ? `.${ext}` : ''}`;
+            nextPath = `${dir}${dir ? '/' : ''}${fname}`;
+        } while (existingPaths.includes(nextPath));
+    }
+    return nextPath;
+}
+/**
+ * Converts a string into a valid and unique S3 object name.
+ * - Replaces special characters with underscores
+ * - Ensures name is within S3's length limits
+ * - Ensures uniqueness among existing objects
+ *
+ * @param str - The string to convert into an S3 object name
+ * @param existingObjects - Optional array of existing S3 object names to ensure uniqueness
+ * @returns A valid and unique S3 object name
+ * @example
+ * convertToUniqueS3ObjectName("my file.txt") // returns "my_file.txt"
+ */
+export function convertToUniqueS3ObjectName(str, existingObjects) {
+    let rv = str
+        .trim() // Remove leading and trailing white spaces
+        .replace(/[^\w\s-\.]/g, '_') // Replace special characters with underscores
+        .replace(/\s+/g, '_') // Replace consecutive spaces with a single underscore
+        // .replace(/_+/g, '_') // Remove consecutive underscores
+        // .replace(/^_/, '') // Remove leading underscores
+        // .replace(/_$/, '') // Remove trailing underscores
+        .slice(0, 255); // Truncate the string if it exceeds 255 characters
+    if (existingObjects?.length) {
+        rv = generateUniquePath(rv, existingObjects);
+    }
+    return rv;
+}
+/**
+ * Converts a string into a valid and unique S3 folder path.
+ * - Ensures the path ends with a forward slash
+ * - Replaces special characters with underscores
+ * - Ensures uniqueness among existing paths
+ *
+ * @param str - The string to convert into an S3 folder path
+ * @param existingObjects - Optional array of existing S3 paths to ensure uniqueness
+ * @returns A valid and unique S3 folder path ending with a forward slash
+ * @example
+ * convertToUniqueS3FolderPath("my folder") // returns "my_folder/"
+ */
+export function convertToUniqueS3FolderPath(str, existingObjects) {
+    let next = convertToUniqueS3ObjectName(str, existingObjects);
+    if (!next.endsWith('/'))
+        next += '/'; // Add trailing slash if not present
+    return next;
+    // return (
+    //   str
+    //     .trim() // Remove leading and trailing white spaces
+    //     .replace(/\/+/g, '/') // Replace consecutive slashes with a single slash
+    //     .replace(/[^\w\s-\/]/g, '_') // Replace special characters with underscores
+    //     .replace(/\s+/g, '_') // Replace consecutive spaces with a single underscore
+    //     .replace(/^\//, '') + // Remove leading slash
+    //   (str.endsWith('/') ? '' : '/')
+    // );
+}

package/dist/filepaths.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=filepaths.test.d.ts.map

package/dist/filepaths.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filepaths.test.d.ts","sourceRoot":"","sources":["../src/filepaths.test.ts"],"names":[],"mappings":""}

package/dist/filepaths.test.js

@@ -0,0 +1,42 @@
+import { generateUniqueName, generateUniquePath, convertToUniqueS3ObjectName, } from './filepaths';
+test('generateUniqueName generates unique table names', () => {
+    expect(generateUniqueName('foo', [])).toBe('foo');
+    expect(generateUniqueName('foo', ['345'])).toBe('foo');
+    expect(generateUniqueName('foo', ['foo_1'])).toBe('foo');
+    expect(generateUniqueName('foo', ['foo', 'foo_1'])).toBe('foo_2');
+    expect(generateUniqueName('foo_1', ['foo_1'])).toBe('foo_2');
+    expect(generateUniqueName('foo_2', ['foo_2'])).toBe('foo_3');
+    expect(generateUniqueName('foo', ['foo', 'foo_1', 'foo_2'])).toBe('foo_3');
+    expect(generateUniqueName('')).toBe('');
+    expect(generateUniqueName('', [''])).toBe('_1');
+    expect(generateUniqueName('_', ['_'])).toBe('__1');
+});
+test('generateUniquePath generates unique paths', () => {
+    expect(generateUniquePath('/foo/bar.csv', [])).toBe('/foo/bar.csv');
+    expect(generateUniquePath('/foo/bar.csv', ['345'])).toBe('/foo/bar.csv');
+    expect(generateUniquePath('/foo/bar.csv', ['/foo/bar.csv'])).toBe('/foo/bar_1.csv');
+    expect(generateUniquePath('/foo/bar.csv', ['/foo/bar_1.csv'])).toBe('/foo/bar.csv');
+    expect(generateUniquePath('/foo/bar.csv', ['/foo/bar.csv', '/foo/bar_1.csv'])).toBe('/foo/bar_2.csv');
+    expect(generateUniquePath('/foo/bar.csv', [
+        '/foo/bar.csv',
+        '/foo/bar_1.csv',
+        '/foo/bar_2.csv',
+    ])).toBe('/foo/bar_3.csv');
+    expect(generateUniquePath('/foo/bar_1.csv', ['/foo/bar_1.csv'])).toBe('/foo/bar_2.csv');
+    expect(generateUniquePath('/foo/bar_2.csv', ['/foo/bar_2.csv'])).toBe('/foo/bar_3.csv');
+    expect(generateUniquePath('/foo', [])).toBe('/foo');
+    expect(generateUniquePath('/foo/bar', [])).toBe('/foo/bar');
+    expect(generateUniquePath('/foo/bar', ['/foo/bar'])).toBe('/foo/bar_1');
+    expect(generateUniquePath('/', [])).toBe('/');
+    expect(generateUniquePath('', [])).toBe('');
+    expect(generateUniquePath('', [''])).toBe('_1');
+    expect(generateUniquePath('_', ['_'])).toBe('__1');
+});
+test('convertToUniqueS3ObjectName works correctly', () => {
+    expect(convertToUniqueS3ObjectName('/flows.csv', [])).toBe('_flows.csv');
+    expect(convertToUniqueS3ObjectName('&flows.csv', [])).toBe('_flows.csv');
+    expect(convertToUniqueS3ObjectName('@flows.csv', [])).toBe('_flows.csv');
+    expect(convertToUniqueS3ObjectName('/flows.csv', [])).toBe('_flows.csv');
+    expect(convertToUniqueS3ObjectName('flows.csv', ['flows.csv'])).toBe('flows_1.csv');
+    expect(convertToUniqueS3ObjectName('flows.csv', ['flows.csv', 'flows_1.csv'])).toBe('flows_2.csv');
+});

package/dist/format.d.ts

@@ -1,11 +1,32 @@
+/**
+ * Formats a number as a string with thousands separators and no decimal places.
+ * Example: 1234567 -> "1,234,567"
+ */
 export declare const formatCount: (n: number | {
     valueOf(): number;
 }) => string;
+/**
+ * Formats a number as a string with 4 significant digits and SI prefix.
+ * Example: 1234567 -> "1.235M"
+ */
 export declare const formatCount4: (n: number | {
     valueOf(): number;
 }) => string;
+/**
+ * Formats a number as a string with thousands separators and SI prefix.
+ * Example: 1234567 -> "1M"
+ */
 export declare const formatCountShort: (n: number | {
     valueOf(): number;
 }) => string;
+/**
+ * Shortens a string to a specified maximum length by truncating and adding an ellipsis.
+ * @param str - The string to shorten
+ * @param maxLength - Maximum length of the resulting string (including ellipsis). Defaults to 10.
+ * @returns The shortened string with ellipsis if truncated, or the original string if shorter than maxLength
+ * @example
+ * shorten("Hello World", 8) // Returns "Hello..."
+ * shorten("Hi", 8) // Returns "Hi"
+ */
 export declare function shorten(str: string, maxLength?: number): string;
 //# sourceMappingURL=format.d.ts.map

package/dist/format.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,WAAW;;YAA0B,CAAC;AACnD,eAAO,MAAM,YAAY;;YAA0B,CAAC;AACpD,eAAO,MAAM,gBAAgB;;YAA0B,CAAC;AAExD,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,SAAK,GAAG,MAAM,CAK3D"}
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,WAAW;;YAA0B,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,YAAY;;YAA0B,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;YAA0B,CAAC;AAExD;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,SAAK,GAAG,MAAM,CAK3D"}

package/dist/format.js

@@ -1,7 +1,28 @@
 import * as d3Format from 'd3-format';
+/**
+ * Formats a number as a string with thousands separators and no decimal places.
+ * Example: 1234567 -> "1,234,567"
+ */
 export const formatCount = d3Format.format(',.0f');
+/**
+ * Formats a number as a string with 4 significant digits and SI prefix.
+ * Example: 1234567 -> "1.235M"
+ */
 export const formatCount4 = d3Format.format('.4~s');
+/**
+ * Formats a number as a string with thousands separators and SI prefix.
+ * Example: 1234567 -> "1M"
+ */
 export const formatCountShort = d3Format.format(',.0s');
+/**
+ * Shortens a string to a specified maximum length by truncating and adding an ellipsis.
+ * @param str - The string to shorten
+ * @param maxLength - Maximum length of the resulting string (including ellipsis). Defaults to 10.
+ * @returns The shortened string with ellipsis if truncated, or the original string if shorter than maxLength
+ * @example
+ * shorten("Hello World", 8) // Returns "Hello..."
+ * shorten("Hi", 8) // Returns "Hi"
+ */
 export function shorten(str, maxLength = 10) {
     if (str.length <= maxLength) {
         return str;

package/dist/helpers.d.ts

@@ -1,11 +1,66 @@
 import { ConfigType } from 'dayjs';
-export declare const toDateTime: (secs: number) => Date;
-export declare function genRandomStr(length: number, seed?: string): string;
+/**
+ * Number formatter instance configured for US locale with no minimum fraction digits
+ */
 export declare const NUMBER_FORMAT: Intl.NumberFormat;
+/**
+ * Formats a number using US locale formatting
+ * @param n - Number to format
+ * @returns Formatted number string
+ * @example
+ * ```ts
+ * formatNumber(1234567.89); // "1,234,568"
+ * ```
+ */
 export declare const formatNumber: (n: number) => string;
+/**
+ * Formats a date into a human-readable datetime string
+ * @param d - Date to format (can be Date object, timestamp number, or bigint)
+ * @returns Formatted string in "Day YYYY-MM-DD HH:MM AM/PM" format
+ * @example
+ * ```ts
+ * formatDateTime(new Date()); // e.g., "Wed 2024-03-13 02:30 PM"
+ * ```
+ */
 export declare const formatDateTime: (d: Date | number | bigint) => string;
+/**
+ * Formats a date into YYYY-MM-DD format
+ * @param d - Date to format (can be Date object, timestamp number, or bigint)
+ * @returns Formatted date string
+ * @example
+ * ```ts
+ * formatDate(new Date()); // e.g., "2024-03-13"
+ * ```
+ */
 export declare const formatDate: (d: Date | number | bigint) => string;
+/**
+ * Formats a date into time of day (HH:MM AM/PM)
+ * @param d - Date to format (can be Date object, timestamp number, or bigint)
+ * @returns Formatted time string
+ * @example
+ * ```ts
+ * formatTimeOfDay(new Date()); // e.g., "02:30 PM"
+ * ```
+ */
 export declare const formatTimeOfDay: (d: Date | number | bigint) => string;
+/**
+ * Formats a date relative to the current time (e.g., "2 hours ago", "in 3 days")
+ * @param d - Date to format (accepts any dayjs ConfigType)
+ * @returns Human-readable relative time string
+ * @example
+ * ```ts
+ * formatTimeRelative(new Date(Date.now() - 3600000)); // "1 hour ago"
+ * ```
+ */
 export declare const formatTimeRelative: (d: ConfigType) => string;
-export declare const getErrorMessageForDisplay: (e: any) => string;
+/**
+ * Extracts and formats an error message for display, removing common prefixes and truncating at first newline
+ * @param e - Error object or any other value that can be converted to string
+ * @returns Cleaned up error message string
+ * @example
+ * ```ts
+ * getErrorMessageForDisplay(new Error("Query failed: Error: Invalid syntax\nMore details...")); // "Invalid syntax"
+ * ```
+ */
+export declare const getErrorMessageForDisplay: (e: unknown) => string;
 //# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAGA,OAAc,EAAC,UAAU,EAAC,MAAM,OAAO,CAAC;AAKxC,eAAO,MAAM,UAAU,SAAU,MAAM,SAItC,CAAC;AAEF,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,UAgBzD;AAED,eAAO,MAAM,aAAa,mBAExB,CAAC;AAEH,eAAO,MAAM,YAAY,MAAO,MAAM,WAA4B,CAAC;AAMnE,eAAO,MAAM,cAAc,MAAO,IAAI,GAAG,MAAM,GAAG,MAAM,WAIvD,CAAC;AAEF,eAAO,MAAM,UAAU,MAAO,IAAI,GAAG,MAAM,GAAG,MAAM,WAGnD,CAAC;AAEF,eAAO,MAAM,eAAe,MAAO,IAAI,GAAG,MAAM,GAAG,MAAM,WAGxD,CAAC;AAEF,eAAO,MAAM,kBAAkB,MAAO,UAAU,WAE/C,CAAC;AAEF,eAAO,MAAM,yBAAyB,MAAO,GAAG,WAK/C,CAAC"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAEA,OAAc,EAAC,UAAU,EAAC,MAAM,OAAO,CAAC;AAKxC;;GAEG;AACH,eAAO,MAAM,aAAa,mBAExB,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,MAAO,MAAM,WAA4B,CAAC;AAMnE;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,MAAO,IAAI,GAAG,MAAM,GAAG,MAAM,WAGvD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,MAAO,IAAI,GAAG,MAAM,GAAG,MAAM,WAGnD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,MAAO,IAAI,GAAG,MAAM,GAAG,MAAM,WAGxD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,kBAAkB,MAAO,UAAU,WAE/C,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,MAAO,OAAO,WAKnD,CAAC"}

package/dist/helpers.js

@@ -1,53 +1,86 @@
 import { timeFormat } from 'd3-time-format';
-import { alea } from 'seedrandom';
 import dayjs from 'dayjs';
 import relativeTime from 'dayjs/plugin/relativeTime';
 dayjs.extend(relativeTime);
-export const toDateTime = (secs) => {
-    const t = new Date('1970-01-01T00:30:00Z'); // Unix epoch start.
-    t.setSeconds(secs);
-    return t;
-};
-export function genRandomStr(length, seed) {
-    const rnd = seed ? alea(seed) : Math.random;
-    return Array.from((function* () {
-        for (let i = 0; i < length; i++) {
-            const v = Math.floor(rnd() * (26 * 2 + 10));
-            if (v < 26) {
-                yield String.fromCharCode(v + 65); // 'A' - 'Z'
-            }
-            else if (v < 52) {
-                yield String.fromCharCode(v + 71); // 'a' - 'z'
-            }
-            else {
-                yield String.fromCharCode(v + 48); // '0' - '9'
-            }
-        }
-    })()).join('');
-}
+/**
+ * Number formatter instance configured for US locale with no minimum fraction digits
+ */
 export const NUMBER_FORMAT = new Intl.NumberFormat('en-US', {
     minimumFractionDigits: 0,
 });
+/**
+ * Formats a number using US locale formatting
+ * @param n - Number to format
+ * @returns Formatted number string
+ * @example
+ * ```ts
+ * formatNumber(1234567.89); // "1,234,568"
+ * ```
+ */
 export const formatNumber = (n) => NUMBER_FORMAT.format(n);
 const TIME_OF_DAY_FORMAT = timeFormat('%I:%M %p');
 const DATE_TIME_FORMAT = timeFormat('%a %Y-%m-%d %I:%M %p');
 const DATE_FORMAT = timeFormat('%Y-%m-%d');
+/**
+ * Formats a date into a human-readable datetime string
+ * @param d - Date to format (can be Date object, timestamp number, or bigint)
+ * @returns Formatted string in "Day YYYY-MM-DD HH:MM AM/PM" format
+ * @example
+ * ```ts
+ * formatDateTime(new Date()); // e.g., "Wed 2024-03-13 02:30 PM"
+ * ```
+ */
 export const formatDateTime = (d) => {
     const date = d instanceof Date ? d : new Date(Number(d));
-    // return date.toISOString();
     return DATE_TIME_FORMAT(date);
 };
+/**
+ * Formats a date into YYYY-MM-DD format
+ * @param d - Date to format (can be Date object, timestamp number, or bigint)
+ * @returns Formatted date string
+ * @example
+ * ```ts
+ * formatDate(new Date()); // e.g., "2024-03-13"
+ * ```
+ */
 export const formatDate = (d) => {
     const date = d instanceof Date ? d : new Date(Number(d));
     return DATE_FORMAT(date);
 };
+/**
+ * Formats a date into time of day (HH:MM AM/PM)
+ * @param d - Date to format (can be Date object, timestamp number, or bigint)
+ * @returns Formatted time string
+ * @example
+ * ```ts
+ * formatTimeOfDay(new Date()); // e.g., "02:30 PM"
+ * ```
+ */
 export const formatTimeOfDay = (d) => {
     const date = d instanceof Date ? d : new Date(Number(d));
     return TIME_OF_DAY_FORMAT(date);
 };
+/**
+ * Formats a date relative to the current time (e.g., "2 hours ago", "in 3 days")
+ * @param d - Date to format (accepts any dayjs ConfigType)
+ * @returns Human-readable relative time string
+ * @example
+ * ```ts
+ * formatTimeRelative(new Date(Date.now() - 3600000)); // "1 hour ago"
+ * ```
+ */
 export const formatTimeRelative = (d) => {
     return dayjs().to(d);
 };
+/**
+ * Extracts and formats an error message for display, removing common prefixes and truncating at first newline
+ * @param e - Error object or any other value that can be converted to string
+ * @returns Cleaned up error message string
+ * @example
+ * ```ts
+ * getErrorMessageForDisplay(new Error("Query failed: Error: Invalid syntax\nMore details...")); // "Invalid syntax"
+ * ```
+ */
 export const getErrorMessageForDisplay = (e) => {
     let msg = e instanceof Error ? e.message : String(e);
     msg = msg.replace(/Query failed: Error: /, '');

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export * from './color';
 export * from './format';
 export * from './helpers';
-export * from './storage';
+export * from './random';
 export * from './str';
 export * from './xhr';
+export * from './filepaths';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC"}

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from './color';
 export * from './format';
 export * from './helpers';
-export * from './storage';
+export * from './random';
 export * from './str';
 export * from './xhr';
+export * from './filepaths';

package/dist/random.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generates a random string of specified length with optional seed
+ * @param length - The length of the random string to generate
+ * @param seed - Optional seed string for reproducible random generation
+ * @returns Random string containing uppercase letters, lowercase letters, and numbers
+ * @example
+ * ```ts
+ * const random = genRandomStr(10); // e.g., "aB3kF9mN2x"
+ * const seeded = genRandomStr(10, "myseed"); // Will always generate the same string for "myseed"
+ * ```
+ */
+export declare function genRandomStr(length: number, seed?: string): string;
+//# sourceMappingURL=random.d.ts.map

package/dist/random.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"random.d.ts","sourceRoot":"","sources":["../src/random.ts"],"names":[],"mappings":"AACA;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,UAgBzD"}

package/dist/random.js

@@ -0,0 +1,29 @@
+import { alea } from 'seedrandom';
+/**
+ * Generates a random string of specified length with optional seed
+ * @param length - The length of the random string to generate
+ * @param seed - Optional seed string for reproducible random generation
+ * @returns Random string containing uppercase letters, lowercase letters, and numbers
+ * @example
+ * ```ts
+ * const random = genRandomStr(10); // e.g., "aB3kF9mN2x"
+ * const seeded = genRandomStr(10, "myseed"); // Will always generate the same string for "myseed"
+ * ```
+ */
+export function genRandomStr(length, seed) {
+    const rnd = seed ? alea(seed) : Math.random;
+    return Array.from((function* () {
+        for (let i = 0; i < length; i++) {
+            const v = Math.floor(rnd() * (26 * 2 + 10));
+            if (v < 26) {
+                yield String.fromCharCode(v + 65); // 'A' - 'Z'
+            }
+            else if (v < 52) {
+                yield String.fromCharCode(v + 71); // 'a' - 'z'
+            }
+            else {
+                yield String.fromCharCode(v + 48); // '0' - '9'
+            }
+        }
+    })()).join('');
+}

package/dist/str.d.ts

@@ -1,13 +1,19 @@
+/**
+ * Formats a number of bytes into a human-readable string with appropriate size units.
+ * @param bytes - The number of bytes to format
+ * @returns A string representation of the bytes with appropriate unit (Bytes, KB, MB, etc.)
+ * @example
+ * formatBytes(1024) // returns "1 KB"
+ * formatBytes(1234567) // returns "1.18 MB"
+ */
 export declare function formatBytes(bytes: number): string;
-export declare function splitFilePath(filePath: string): {
-    dir: string;
-    name: string;
-    ext: string;
-};
-export declare function convertToUniqueColumnOrTableName(filename: string, existingTables?: string[]): string;
-export declare function generateUniqueName(name: string, usedNames?: string[]): string;
-export declare function generateUniquePath(filePath: string, existingPaths: string[]): string;
-export declare function convertToUniqueS3ObjectName(str: string, existingObjects?: string[]): string;
-export declare function convertToUniqueS3FolderPath(str: string, existingObjects?: string[]): string;
+/**
+ * Converts a camelCase string into a Title Case string.
+ * @param camelCase - The camelCase string to convert
+ * @returns A Title Case string with spaces between words
+ * @example
+ * camelCaseToTitle("myVariableName") // returns "My Variable Name"
+ * camelCaseToTitle("URL") // returns "URL"
+ */
 export declare function camelCaseToTitle(camelCase: string): string;
 //# sourceMappingURL=str.d.ts.map

package/dist/str.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"str.d.ts","sourceRoot":"","sources":["../src/str.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAgBjD;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG;IAC/C,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb,CAYA;AAED,wBAAgB,gCAAgC,CAC9C,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,EAAE,GACxB,MAAM,CAoBR;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,UAsBpE;AAED,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EAAE,GACtB,MAAM,CAqBR;AAED,wBAAgB,2BAA2B,CACzC,GAAG,EAAE,MAAM,EACX,eAAe,CAAC,EAAE,MAAM,EAAE,GACzB,MAAM,CAeR;AAED,wBAAgB,2BAA2B,CACzC,GAAG,EAAE,MAAM,EACX,eAAe,CAAC,EAAE,MAAM,EAAE,GACzB,MAAM,CAaR;AAED,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAgB1D"}
+{"version":3,"file":"str.d.ts","sourceRoot":"","sources":["../src/str.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAgBjD;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAgB1D"}

package/dist/str.js

@@ -1,3 +1,11 @@
+/**
+ * Formats a number of bytes into a human-readable string with appropriate size units.
+ * @param bytes - The number of bytes to format
+ * @returns A string representation of the bytes with appropriate unit (Bytes, KB, MB, etc.)
+ * @example
+ * formatBytes(1024) // returns "1 KB"
+ * formatBytes(1234567) // returns "1.18 MB"
+ */
 export function formatBytes(bytes) {
     if (bytes === 0)
         return '0 Bytes';
@@ -12,99 +20,14 @@ export function formatBytes(bytes) {
             : Math.floor(sizeValue);
     return sizeValue + ' ' + sizes[i];
 }
-export function splitFilePath(filePath) {
-    const pathParts = filePath.split('/');
-    const file = pathParts.pop() || '';
-    const dotIndex = file.lastIndexOf('.');
-    if (dotIndex === -1 || dotIndex === 0)
-        return { dir: pathParts.join('/'), name: file, ext: '' };
-    const name = file.substring(0, dotIndex);
-    const ext = file.substring(dotIndex + 1);
-    return { dir: pathParts.join('/'), name, ext };
-}
-export function convertToUniqueColumnOrTableName(filename, existingTables) {
-    // Remove file extension
-    const base = filename.replace(/\.[^/.]+$/, '');
-    // Replace any invalid character with underscore, and convert to lowercase
-    let tableName = base.replace(/[^a-z0-9_]/gi, '_');
-    // If the first character is a number, prepend an underscore
-    if (/^\d/.test(tableName)) {
-        tableName = '_' + tableName;
-    }
-    // Truncate to the max length 63
-    if (tableName.length > 63) {
-        tableName = tableName.substring(0, 63);
-    }
-    tableName = generateUniqueName(tableName, existingTables);
-    return tableName;
-}
-export function generateUniqueName(name, usedNames) {
-    const usedNamesLower = usedNames?.map((n) => n.toLowerCase());
-    // If tableName exists in the list
-    if (usedNamesLower?.includes(name.toLowerCase())) {
-        let baseName = name;
-        let i = 0;
-        // If tableName ends with `_${i}` pattern, update the baseTableName and i
-        const matched = name.match(/^(.+)_(\d+)$/);
-        if (matched) {
-            baseName = matched[1];
-            i = Number(matched[2]);
-        }
-        do {
-            i++;
-            name = `${baseName}_${i}`;
-        } while (usedNamesLower.includes(name.toLowerCase()));
-    }
-    return name;
-}
-export function generateUniquePath(filePath, existingPaths) {
-    let nextPath = filePath;
-    if (existingPaths?.includes(filePath)) {
-        const { dir, name, ext } = splitFilePath(filePath);
-        let i = 0;
-        let baseName = name;
-        const matched = name.match(/^(.+)_(\d+)$/);
-        if (matched) {
-            baseName = matched[1];
-            i = Number(matched[2]);
-        }
-        do {
-            i++;
-            const fname = `${baseName}_${i}${ext ? `.${ext}` : ''}`;
-            nextPath = `${dir}${dir ? '/' : ''}${fname}`;
-        } while (existingPaths.includes(nextPath));
-    }
-    return nextPath;
-}
-export function convertToUniqueS3ObjectName(str, existingObjects) {
-    let rv = str
-        .trim() // Remove leading and trailing white spaces
-        .replace(/[^\w\s-\.]/g, '_') // Replace special characters with underscores
-        .replace(/\s+/g, '_') // Replace consecutive spaces with a single underscore
-        // .replace(/_+/g, '_') // Remove consecutive underscores
-        // .replace(/^_/, '') // Remove leading underscores
-        // .replace(/_$/, '') // Remove trailing underscores
-        .slice(0, 255); // Truncate the string if it exceeds 255 characters
-    if (existingObjects?.length) {
-        rv = generateUniquePath(rv, existingObjects);
-    }
-    return rv;
-}
-export function convertToUniqueS3FolderPath(str, existingObjects) {
-    let next = convertToUniqueS3ObjectName(str, existingObjects);
-    if (!next.endsWith('/'))
-        next += '/'; // Add trailing slash if not present
-    return next;
-    // return (
-    //   str
-    //     .trim() // Remove leading and trailing white spaces
-    //     .replace(/\/+/g, '/') // Replace consecutive slashes with a single slash
-    //     .replace(/[^\w\s-\/]/g, '_') // Replace special characters with underscores
-    //     .replace(/\s+/g, '_') // Replace consecutive spaces with a single underscore
-    //     .replace(/^\//, '') + // Remove leading slash
-    //   (str.endsWith('/') ? '' : '/')
-    // );
-}
+/**
+ * Converts a camelCase string into a Title Case string.
+ * @param camelCase - The camelCase string to convert
+ * @returns A Title Case string with spaces between words
+ * @example
+ * camelCaseToTitle("myVariableName") // returns "My Variable Name"
+ * camelCaseToTitle("URL") // returns "URL"
+ */
 export function camelCaseToTitle(camelCase) {
     // Split the string into words on the camelCase boundaries
     const words = camelCase.match(/^[a-z]+|[A-Z][a-z]*/g);

package/dist/xhr.d.ts

@@ -1,17 +1,49 @@
+/**
+ * Posts data to a specified URL endpoint using fetch API
+ * @param {Object} params - The parameters for the POST request
+ * @param {string} params.url - The URL to send the POST request to
+ * @param {Record<string, unknown>} [params.data] - Optional data to be sent in the request body
+ * @returns {Promise<any>} The parsed JSON response from the server
+ * @throws {Error} If the response is not ok, throws an error with the status message or error details
+ */
 export declare const postData: ({ url, data, }: {
     url: string;
-    data?: Record<string, any>;
+    data?: Record<string, unknown>;
 }) => Promise<any>;
+/**
+ * Represents progress information for file operations
+ */
 export type ProgressInfo = {
     loaded: number;
     total: number;
     ratio: number;
 };
+/**
+ * Downloads a file from a specified URL using XMLHttpRequest
+ * @param {string} url - The URL to download the file from
+ * @param {Object} [opts] - Optional configuration for the download
+ * @param {string} [opts.method='GET'] - The HTTP method to use
+ * @param {Record<string, string>} [opts.headers] - Additional headers to include in the request
+ * @param {(info: ProgressInfo) => void} [opts.onProgress] - Callback function to track download progress
+ * @returns {Promise<Uint8Array>} The downloaded file as a Uint8Array
+ * @throws {Object} Throws an object containing status and error message if download fails
+ */
 export declare function downloadFile(url: string, opts?: {
     method?: string;
     headers?: Record<string, string>;
     onProgress?: (info: ProgressInfo) => void;
 }): Promise<Uint8Array>;
+/**
+ * Uploads a file to a specified URL using XMLHttpRequest
+ * @param {string} url - The URL to upload the file to
+ * @param {File | Blob | FormData} content - The content to upload
+ * @param {Object} [opts] - Optional configuration for the upload
+ * @param {string} [opts.method='POST'] - The HTTP method to use
+ * @param {Record<string, string>} [opts.headers] - Additional headers to include in the request
+ * @param {(info: ProgressInfo) => void} [opts.onProgress] - Callback function to track upload progress
+ * @returns {Promise<Response>} The server response
+ * @throws {Object} Throws an object containing status and error message if upload fails
+ */
 export declare function uploadFile(url: string, content: File | Blob | FormData, opts?: {
     method?: string;
     headers?: Record<string, string>;

package/dist/xhr.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xhr.d.ts","sourceRoot":"","sources":["../src/xhr.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,mBAGlB;IACD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,iBAoBA,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,CAAC;AAK1E,wBAAsB,YAAY,CAChC,GAAG,EAAE,MAAM,EACX,IAAI,GAAE;IACJ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;CACtC,GACL,OAAO,CAAC,UAAU,CAAC,CAsCrB;AAID,wBAAsB,UAAU,CAC9B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,IAAI,GAAG,IAAI,GAAG,QAAQ,EAC/B,IAAI,GAAE;IACJ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;CACtC,GACL,OAAO,CAAC,QAAQ,CAAC,CAiCnB"}
+{"version":3,"file":"xhr.d.ts","sourceRoot":"","sources":["../src/xhr.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,mBAGlB;IACD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,iBAoBA,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,CAAC;AAK1E;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAChC,GAAG,EAAE,MAAM,EACX,IAAI,GAAE;IACJ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;CACtC,GACL,OAAO,CAAC,UAAU,CAAC,CAsCrB;AAID;;;;;;;;;;GAUG;AACH,wBAAsB,UAAU,CAC9B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,IAAI,GAAG,IAAI,GAAG,QAAQ,EAC/B,IAAI,GAAE;IACJ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;CACtC,GACL,OAAO,CAAC,QAAQ,CAAC,CAiCnB"}

package/dist/xhr.js

@@ -1,3 +1,11 @@
+/**
+ * Posts data to a specified URL endpoint using fetch API
+ * @param {Object} params - The parameters for the POST request
+ * @param {string} params.url - The URL to send the POST request to
+ * @param {Record<string, unknown>} [params.data] - Optional data to be sent in the request body
+ * @returns {Promise<any>} The parsed JSON response from the server
+ * @throws {Error} If the response is not ok, throws an error with the status message or error details
+ */
 export const postData = async ({ url, data, }) => {
     const res = await fetch(url, {
         method: 'POST',
@@ -21,6 +29,16 @@ export const postData = async ({ url, data, }) => {
 };
 // TODO: use range requests to download in chunks
 // https://github.com/duckdb/duckdb-wasm/blob/d9ea9c919b6301e7c6dc8a9b3fd527e86f69a38e/packages/duckdb-wasm/src/bindings/runtime_browser.ts#L307
+/**
+ * Downloads a file from a specified URL using XMLHttpRequest
+ * @param {string} url - The URL to download the file from
+ * @param {Object} [opts] - Optional configuration for the download
+ * @param {string} [opts.method='GET'] - The HTTP method to use
+ * @param {Record<string, string>} [opts.headers] - Additional headers to include in the request
+ * @param {(info: ProgressInfo) => void} [opts.onProgress] - Callback function to track download progress
+ * @returns {Promise<Uint8Array>} The downloaded file as a Uint8Array
+ * @throws {Object} Throws an object containing status and error message if download fails
+ */
 export async function downloadFile(url, opts = {}) {
     const { method = 'GET', headers = {}, onProgress } = opts;
     return await new Promise((resolve, reject) => {
@@ -57,6 +75,17 @@ export async function downloadFile(url, opts = {}) {
     });
 }
 // TODO: upload in chunks https://www.html5rocks.com/en/tutorials/file/xhr2/
+/**
+ * Uploads a file to a specified URL using XMLHttpRequest
+ * @param {string} url - The URL to upload the file to
+ * @param {File | Blob | FormData} content - The content to upload
+ * @param {Object} [opts] - Optional configuration for the upload
+ * @param {string} [opts.method='POST'] - The HTTP method to use
+ * @param {Record<string, string>} [opts.headers] - Additional headers to include in the request
+ * @param {(info: ProgressInfo) => void} [opts.onProgress] - Callback function to track upload progress
+ * @returns {Promise<Response>} The server response
+ * @throws {Object} Throws an object containing status and error message if upload fails
+ */
 export async function uploadFile(url, content, opts = {}) {
     const { method = 'POST', headers = {}, onProgress } = opts;
     return await new Promise((resolve, reject) => {

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@sqlrooms/utils",
-  "version": "0.0.1-alpha.0",
+  "version": "0.0.2",
   "main": "dist/index.js",
-  "types": "src/index.ts",
+  "types": "dist/index.d.ts",
   "module": "dist/index.js",
   "type": "module",
   "private": false,
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -14,23 +17,21 @@
     "build": "tsc",
     "_test": "jest",
     "_test:watch": "jest --watch",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "typedoc": "typedoc"
   },
   "dependencies": {
     "d3-color": "^3.1.0",
     "d3-format": "^3.1.0",
     "d3-time-format": "^4.1.0",
+    "dayjs": "^1.11.13",
     "seedrandom": "^3.0.5"
   },
-  "peerDependencies": {
-    "dayjs": "*",
-    "zod": "*"
-  },
   "devDependencies": {
     "@types/d3-color": "^3.1.3",
     "@types/d3-format": "^3.0.4",
     "@types/d3-time-format": "^4.0.3",
     "@types/seedrandom": "^3.0.8"
   },
-  "gitHead": "8e3c0b884db7755c8b892a590af49c0081336d8d"
+  "gitHead": "32da0b35fe906bdcef42274624d069cc49425a74"
 }

package/CHANGELOG.md

@@ -1,10 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## 0.0.1-alpha.0 (2025-01-30)
-
-**Note:** Version bump only for package @sqlrooms/utils
-
-**Note:** Version bump only for package @sqlrooms/utils

package/jest.config.ms

@@ -1,8 +0,0 @@
-// See https://github.com/bakeruk/modern-typescript-monorepo-example/blob/main/package.json
-/** @type {import('jest').Config} */
-module.exports = {
-  transform: {
-    '^.+\\.(t|j)sx?$': '@swc/jest',
-  },
-  testPathIgnorePatterns: ['/dist/'],
-};