sql-love 1.0.2 → 1.0.4

package/dist/src/extractGrouped/extractGrouped.d.ts

@@ -1,17 +0,0 @@
-/**
- * Group database rows by a column value
- * @param field  The database column to group by
- * @param records  Records from the database
- * @example
- * extractGrouped('org', users); // result:
- * {
- *     "Marketing": [
- *         { id: 1, name: "John", org: "Marketing" },
- *         { id: 2, name: "Jane", org: "Marketing" },
- *     ],
- *     "Finance": [
- *         { id: 3, name: "Jose", org: "Finance" },
- *     ],
- * }
- */
-export default function extractGrouped<DbRecord extends Record<string, any>>(field: keyof DbRecord, records: DbRecord[]): Record<string, DbRecord[]>;

package/dist/src/extractGrouped/extractGrouped.js

@@ -1,31 +0,0 @@
-/**
- * Group database rows by a column value
- * @param field  The database column to group by
- * @param records  Records from the database
- * @example
- * extractGrouped('org', users); // result:
- * {
- *     "Marketing": [
- *         { id: 1, name: "John", org: "Marketing" },
- *         { id: 2, name: "Jane", org: "Marketing" },
- *     ],
- *     "Finance": [
- *         { id: 3, name: "Jose", org: "Finance" },
- *     ],
- * }
- */
-export default function extractGrouped(field, records) {
-    let idx = 0;
-    const grouped = {};
-    for (const record of records) {
-        if (!(field in record)) {
-            throw new Error(`Column "${String(field)}" is not present in record ${idx}`);
-        }
-        if (!grouped[record[field]]) {
-            grouped[record[field]] = [];
-        }
-        grouped[record[field]].push(record);
-        idx++;
-    }
-    return grouped;
-}

package/dist/src/extractIndexed/extractIndexed.d.ts

@@ -1,12 +0,0 @@
-/**
- * Index each database row by a column value
- * @param field  The database column to index by
- * @param records  Records from the database
- * @example
- * extractIndexed('id', users); // result:
- * {
- *   "1": { id: 1, name: "John" },
- *   "2": { id: 2, name: "Jane" },
- * }
- */
-export default function extractIndexed<DbRecord extends Record<string, any>>(field: keyof DbRecord, records: DbRecord[]): Record<string, DbRecord>;

package/dist/src/extractIndexed/extractIndexed.js

@@ -1,23 +0,0 @@
-/**
- * Index each database row by a column value
- * @param field  The database column to index by
- * @param records  Records from the database
- * @example
- * extractIndexed('id', users); // result:
- * {
- *   "1": { id: 1, name: "John" },
- *   "2": { id: 2, name: "Jane" },
- * }
- */
-export default function extractIndexed(field, records) {
-    let idx = 0;
-    const indexed = {};
-    for (const record of records) {
-        if (!(field in record)) {
-            throw new Error(`Column "${String(field)}" is not present in record ${idx}`);
-        }
-        indexed[record[field]] = record;
-        idx++;
-    }
-    return indexed;
-}

package/dist/src/extractLookup/extractLookup.d.ts

@@ -1,9 +0,0 @@
-/**
- * Given an array of records, extract an object with keyField-valueField pairs
- * @param records  An array of records
- * @param keyField  The field to use as the key
- * @param valueField  The field to use as the value
- */
-export default function extractLookup<T extends Array<Record<K | V, any>>, K extends keyof T[number], V extends keyof T[number]>(keyField: K, valueField: V, records: T): {
-    [key in T[number][K]]: T[number][V];
-};

package/dist/src/extractLookup/extractLookup.js

@@ -1,21 +0,0 @@
-/**
- * Given an array of records, extract an object with keyField-valueField pairs
- * @param records  An array of records
- * @param keyField  The field to use as the key
- * @param valueField  The field to use as the value
- */
-export default function extractLookup(keyField, valueField, records) {
-    const lookup = {};
-    let idx = 0;
-    for (const record of records) {
-        if (!(keyField in record)) {
-            throw new Error(`Column "${String(keyField)}" is not present in record ${idx}`);
-        }
-        if (!(valueField in record)) {
-            throw new Error(`Column "${String(valueField)}" is not present in record ${idx}`);
-        }
-        idx++;
-        lookup[String(record[keyField])] = record[valueField];
-    }
-    return lookup;
-}

package/dist/src/getPagination/getPagination.d.ts

@@ -1,16 +0,0 @@
-import type SelectBuilder from '../SelectBuilder/SelectBuilder';
-/**
- * Given a foundRows number of records and a limit, return the foundRows number of pages
- * @param query  The query that was just run
- * @param total  The number of records if there were no limit
- */
-export default function getPagination(query: SelectBuilder, total: BigInt | number): {
-    page: number;
-    prevPage: number;
-    nextPage: number;
-    perPage: number;
-    numPages: number;
-    total: number;
-    isFirst: boolean;
-    isLast: boolean;
-};

package/dist/src/getPagination/getPagination.js

@@ -1,40 +0,0 @@
-/**
- * Given a foundRows number of records and a limit, return the foundRows number of pages
- * @param query  The query that was just run
- * @param total  The number of records if there were no limit
- */
-export default function getPagination(query, total) {
-    total = Number(total) || 0;
-    const perPage = Number(query._limit) || null;
-    let page = null;
-    if (total === 0) {
-        page = null;
-    }
-    else if (query._page) {
-        page = Number(query._page);
-    }
-    else if (query._limit && query._offset) {
-        page = Math.floor(Number(query._offset) / Number(query._limit)) + 1;
-    }
-    else if (query._limit && !query._offset) {
-        page = 1;
-    }
-    else {
-        page = null;
-    }
-    const numPages = total === 0 || perPage === null ? 0 : Math.ceil(total / perPage) || 0;
-    const isFirst = page === 1;
-    const isLast = numPages > 0 && page === numPages;
-    const prevPage = numPages === 0 ? null : page - 1 || null;
-    const nextPage = numPages > 0 && page + 1 <= numPages ? page + 1 : null;
-    return {
-        page,
-        prevPage,
-        nextPage,
-        perPage,
-        numPages,
-        total,
-        isFirst,
-        isLast,
-    };
-}

package/dist/src/runMysql/runMysql.d.ts

@@ -1,58 +0,0 @@
-import type SelectBuilder from '../SelectBuilder/SelectBuilder';
-import type { EngineStyle } from '../SelectBuilder/SelectBuilder';
-interface MysqlClient {
-    query: (sql: string, bindings: any[], callback: (err: Error | null, results: Array<Record<string, any>>, fields: any[]) => void) => void;
-}
-interface MysqlAsyncClient {
-    query: (sql: string, bindings: any[]) => Promise<[Array<Record<string, any>>, any[]]>;
-}
-/**
- * Run the given query with mysql and return the results
- * @param mysqlClient  A client created with mysql.createConnection()  or mysql.createPool()
- * @param query  The SelectBuilder query to run
- */
-export declare function runMysql(mysqlClient: MysqlClient, query: SelectBuilder): Promise<[Array<Record<string, any>>, any[]]>;
-/**
- * Run the given query with mysql and return the results, count, and pagination
- * @param mysqlClient  A client created with mysql.createConnection()  or mysql.createPool()
- * @param query  The SelectBuilder query to run
- * @param options
- * @param options.countExpr  The SQL expression to use for the count (default "*")
- */
-export declare function runMysqlWithCount(mysqlClient: MysqlClient, query: SelectBuilder, { countExpr }?: {
-    countExpr?: string;
-}): Promise<{
-    records: Record<string, any>[];
-    total: any;
-    pagination: {
-        page: number;
-        prevPage: number;
-        nextPage: number;
-        perPage: number;
-        numPages: number;
-        total: number;
-        isFirst: boolean;
-        isLast: boolean;
-    };
-    fields: any[];
-}>;
-export declare function runMysqlAsync(mysqlClient: MysqlAsyncClient, query: SelectBuilder): Promise<[Array<Record<string, any>>, any[]]>;
-export declare function runMysqlAsyncWithCount(mysqlClient: MysqlAsyncClient, query: SelectBuilder, { engine, countExpr, }?: {
-    engine?: EngineStyle;
-    countExpr?: string;
-}): Promise<{
-    records: Record<string, any>[];
-    total: any;
-    pagination: {
-        page: number;
-        prevPage: number;
-        nextPage: number;
-        perPage: number;
-        numPages: number;
-        total: number;
-        isFirst: boolean;
-        isLast: boolean;
-    };
-    fields: any[];
-}>;
-export {};

package/dist/src/runMysql/runMysql.js

@@ -1,61 +0,0 @@
-import getPagination from '../getPagination/getPagination';
-function _queryToPromise(mysqlClient, sql, bindings) {
-    return new Promise((resolve, reject) => {
-        mysqlClient.query(sql, bindings, (err, rows, fields) => {
-            if (err) {
-                reject(err);
-                return;
-            }
-            resolve([rows, fields]);
-        });
-    });
-}
-/**
- * Run the given query with mysql and return the results
- * @param mysqlClient  A client created with mysql.createConnection()  or mysql.createPool()
- * @param query  The SelectBuilder query to run
- */
-export async function runMysql(mysqlClient, query) {
-    const { sql, bindings } = query.compile({ engine: 'mysql' });
-    return _queryToPromise(mysqlClient, sql, bindings);
-}
-/**
- * Run the given query with mysql and return the results, count, and pagination
- * @param mysqlClient  A client created with mysql.createConnection()  or mysql.createPool()
- * @param query  The SelectBuilder query to run
- * @param options
- * @param options.countExpr  The SQL expression to use for the count (default "*")
- */
-export async function runMysqlWithCount(mysqlClient, query, { countExpr = '*' } = {}) {
-    const { sql, bindings } = query.compile({ engine: 'mysql' });
-    const [records, fields] = await _queryToPromise(mysqlClient, sql, bindings);
-    if (records.length > 0) {
-        const { sql, bindings } = query.compileCount({
-            engine: 'mysql',
-            countExpr,
-        });
-        const [rows] = await _queryToPromise(mysqlClient, sql, bindings);
-        const total = rows[0].found_rows;
-        return { records, total, pagination: getPagination(query, total), fields };
-    }
-    else {
-        return { records, total: 0, pagination: getPagination(query, 0), fields };
-    }
-}
-export async function runMysqlAsync(mysqlClient, query) {
-    const { sql, bindings } = query.compile({ engine: 'mysql' });
-    return mysqlClient.query(sql, bindings);
-}
-export async function runMysqlAsyncWithCount(mysqlClient, query, { engine = 'mysql', countExpr = '*', } = {}) {
-    const { sql, bindings } = query.compile({ engine });
-    const [records, fields] = await mysqlClient.query(sql, bindings);
-    if (records.length > 0) {
-        const { sql, bindings } = query.compileCount({ engine, countExpr });
-        const [rows] = await mysqlClient.query(sql, bindings);
-        const total = rows[0].found_rows;
-        return { records, total, pagination: getPagination(query, total), fields };
-    }
-    else {
-        return { records, total: 0, pagination: getPagination(query, 0), fields };
-    }
-}

package/dist/src/runPrisma/runPrisma.d.ts

@@ -1,41 +0,0 @@
-import type SelectBuilder from '../SelectBuilder/SelectBuilder';
-import type { EngineStyle } from '../SelectBuilder/SelectBuilder';
-interface PrismaClient {
-    $queryRawUnsafe: (sql: string, ...bindings: any[]) => Promise<Array<Record<string, any>>>;
-}
-/**
- * Run the given query with prisma and return the results
- * @param prisma  The prisma client instance
- * @param query  The SelectBuilder query to run
- * @param options
- * @param options.engine  The engine style to use ("mssql" | "mysql" | "oracle" | "pg")
- */
-export declare function runPrisma<T extends Array<Record<string, any>> = Array<Record<string, any>>>(prisma: PrismaClient, query: SelectBuilder, { engine }?: {
-    engine?: EngineStyle;
-}): Promise<T>;
-/**
- * Run the given query with prisma and return the results, count, and pagination
- * @param prisma  The prisma client instance
- * @param query  The SelectBuilder query to run
- * @param options
- * @param options.engine  The engine style to use ("mssql" | "mysql" | "oracle" | "pg")
- * @param options.countExpr  The SQL expression to use for the count (default "*")
- */
-export declare function runPrismaWithCount<T extends Array<Record<string, any>> = Array<Record<string, any>>>(prisma: PrismaClient, query: SelectBuilder, { engine, countExpr, }?: {
-    engine?: EngineStyle;
-    countExpr?: string;
-}): Promise<{
-    records: T;
-    total: number;
-    pagination: {
-        page: number;
-        prevPage: number;
-        nextPage: number;
-        perPage: number;
-        numPages: number;
-        total: number;
-        isFirst: boolean;
-        isLast: boolean;
-    };
-}>;
-export {};

package/dist/src/runPrisma/runPrisma.js

@@ -1,34 +0,0 @@
-import getPagination from '../getPagination/getPagination';
-import { toSafeJsonValue } from '../toSafeJson/toSafeJson';
-/**
- * Run the given query with prisma and return the results
- * @param prisma  The prisma client instance
- * @param query  The SelectBuilder query to run
- * @param options
- * @param options.engine  The engine style to use ("mssql" | "mysql" | "oracle" | "pg")
- */
-export async function runPrisma(prisma, query, { engine = undefined } = {}) {
-    const { sql, bindings } = query.compile({ engine });
-    return prisma.$queryRawUnsafe(sql, ...bindings);
-}
-/**
- * Run the given query with prisma and return the results, count, and pagination
- * @param prisma  The prisma client instance
- * @param query  The SelectBuilder query to run
- * @param options
- * @param options.engine  The engine style to use ("mssql" | "mysql" | "oracle" | "pg")
- * @param options.countExpr  The SQL expression to use for the count (default "*")
- */
-export async function runPrismaWithCount(prisma, query, { engine = undefined, countExpr = '*', } = {}) {
-    const { sql, bindings } = query.compile({ engine });
-    const records = (await prisma.$queryRawUnsafe(sql, ...bindings));
-    if (records.length > 0) {
-        const { sql, bindings } = query.compileCount({ engine, countExpr });
-        const result = await prisma.$queryRawUnsafe(sql, ...bindings);
-        const total = toSafeJsonValue(result[0].found_rows);
-        return { records, total, pagination: getPagination(query, total) };
-    }
-    else {
-        return { records, total: 0, pagination: getPagination(query, 0) };
-    }
-}

package/dist/src/substrCount/substrCount.d.ts

@@ -1,6 +0,0 @@
-/**
- * Count the number of times a substring appears in a string
- * @param haystack
- * @param needle
- */
-export default function substrCount(haystack: string, needle: string): number;

package/dist/src/substrCount/substrCount.js

@@ -1,14 +0,0 @@
-/**
- * Count the number of times a substring appears in a string
- * @param haystack
- * @param needle
- */
-export default function substrCount(haystack, needle) {
-    let count = 0;
-    let pos = haystack.indexOf(needle);
-    while (pos !== -1) {
-        count += 1;
-        pos = haystack.indexOf(needle, pos + 1);
-    }
-    return count;
-}

package/dist/src/toSafeJson/toSafeJson.d.ts

@@ -1,25 +0,0 @@
-type SafeValue<T> = T extends BigInt ? number | string : T;
-type SafeRecord<T> = Record<string, SafeValue<T>>;
-type SafeRecords<T> = Array<SafeRecord<T>>;
-/**
- * Convert a value to a value that can be safely serialized to JSON
- * @param value
- */
-export declare function toSafeJsonValue<T>(value: T): SafeValue<T>;
-/**
- * Convert a record to one that can be safely serialized to JSON
- * @param record
- */
-export declare function toSafeJsonRecord<T extends Record<string, any>>(record: T): SafeRecord<T>;
-/**
- * Convert a recordset to one that can be safely serialized to JSON
- * @param records
- */
-export declare function toSafeJsonRecords<T extends Record<string, any>>(records: T[]): SafeRecords<T>;
-/**
- * JSON stringify a value or data structure, ensuring first that all values are
- *   safe to serialize
- * @param records
- */
-export declare function toSafeJsonString(records: Array<Record<string, any>>): string;
-export {};

package/dist/src/toSafeJson/toSafeJson.js

@@ -1,45 +0,0 @@
-/**
- * Convert a value to a value that can be safely serialized to JSON
- * @param value
- */
-export function toSafeJsonValue(value) {
-    if (typeof value === 'bigint') {
-        const asNumber = Number(value);
-        // Use double equals instead of triple equals below to check if the BigInt
-        //   is too big to fit in a JS Number.
-        //   If so, then return it as a string, otherwise return it as a Number
-        // @ts-expect-error
-        return value == asNumber ? asNumber : value.toString();
-    }
-    return value;
-}
-/**
- * Convert a record to one that can be safely serialized to JSON
- * @param record
- */
-export function toSafeJsonRecord(record) {
-    const newRecord = {};
-    for (const key in record) {
-        /* v8 ignore next 3 */
-        if (!Object.prototype.hasOwnProperty.call(record, key)) {
-            continue;
-        }
-        newRecord[key] = toSafeJsonValue(record[key]);
-    }
-    return newRecord;
-}
-/**
- * Convert a recordset to one that can be safely serialized to JSON
- * @param records
- */
-export function toSafeJsonRecords(records) {
-    return records.map(toSafeJsonRecord);
-}
-/**
- * JSON stringify a value or data structure, ensuring first that all values are
- *   safe to serialize
- * @param records
- */
-export function toSafeJsonString(records) {
-    return JSON.stringify(records, (_, value) => toSafeJsonValue(value));
-}

package/index.ts

@@ -1,19 +0,0 @@
-export { default as Parser } from './src/Parser/Parser';
-export { default as SelectBuilder } from './src/SelectBuilder/SelectBuilder';
-export { default as extractGrouped } from './src/extractGrouped/extractGrouped';
-export { default as extractIndexed } from './src/extractIndexed/extractIndexed';
-export { default as extractLookup } from './src/extractLookup/extractLookup';
-export { default as getPagination } from './src/getPagination/getPagination';
-export {
-  runMysql,
-  runMysqlAsync,
-  runMysqlAsyncWithCount,
-  runMysqlWithCount,
-} from './src/runMysql/runMysql';
-export { runPrisma, runPrismaWithCount } from './src/runPrisma/runPrisma';
-export {
-  toSafeJsonRecord,
-  toSafeJsonRecords,
-  toSafeJsonString,
-  toSafeJsonValue,
-} from './src/toSafeJson/toSafeJson';