@rwillians/qx 0.1.2 → 0.1.4

package/dist/types/pretty-logger.d.ts

@@ -0,0 +1,7 @@
+import { type ILogger } from './index';
+/**
+ * @public  Creates a basic console logger that logs all queries.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const createPrettyLogger: () => ILogger;

package/dist/types/standard-schema.d.ts

@@ -0,0 +1,157 @@
+import * as std from '@standard-schema/spec';
+/**
+ * @public  The Standard Schema interface.
+ * @since   0.1.0
+ * @version 1
+ */
+export { type StandardSchemaV1 as Schema } from '@standard-schema/spec';
+/**
+ * @public  Infers the input type of a Standard Schema.
+ * @since   0.1.0
+ * @version 1
+ */
+export type input<T extends std.StandardSchemaV1> = std.StandardSchemaV1.InferInput<T>;
+/**
+ * @public  Infers the Input type of a Standard Schema.
+ * @since   0.1.0
+ * @version 1
+ */
+export type output<T extends std.StandardSchemaV1> = std.StandardSchemaV1.InferOutput<T>;
+/**
+ * @public  Use any standard schema to parse a value.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const parse: <T extends std.StandardSchemaV1>(schema: T, value: unknown) => std.StandardSchemaV1.Result<output<T>>;
+/**
+ * @public  Defines an array of a given standard schema.
+ * @since   0.1.0
+ * @version 1
+ */
+export type QxArray<T extends std.StandardSchemaV1> = std.StandardSchemaV1<input<T>[], output<T>[]>;
+/**
+ * @public  Defines an array of a given standard schema.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const array: <T extends std.StandardSchemaV1>(schema: T) => QxArray<T>;
+/**
+ * @public  Defines a standard schema for boolean values.
+ * @since   0.1.0
+ * @version 1
+ */
+export type QxBoolean = std.StandardSchemaV1<boolean, boolean>;
+/**
+ * @public  Defines a standard schema for boolean values.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const boolean: () => QxBoolean;
+/**
+ * @public  Defines a standard schema for Date values that can be
+ *          coerced from ISO 8601 strings or epoch timestamps in
+ *          milliseconds.
+ * @since   0.1.0
+ * @version 1
+ */
+export type QxCoercibleDate = std.StandardSchemaV1<Date | string | number, Date>;
+/**
+ * @public  Defines a standard schema for Date values that can be
+ *          coerced from ISO 8601 strings or epoch timestamps in
+ *          milliseconds.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const date: () => QxCoercibleDate;
+/**
+ * @public  Defines a standard schema that validates instances of a
+ *          given class.
+ * @since   0.1.0
+ * @version 1
+ */
+export type QxInstanceOf<T> = std.StandardSchemaV1<T, T>;
+/**
+ * @public  Defines a standard schema that validates instances of a
+ *          given class.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const instanceOf: <T>(ctor: new (...args: any[]) => T) => QxInstanceOf<T>;
+/**
+ * @public  Defines a standard schema for integers with optional min
+ *          and max constraints.
+ * @since   0.1.0
+ * @version 1
+ */
+export type QxInteger = std.StandardSchemaV1<number, number>;
+/**
+ * @public  Defines a standard schema for integers with optional min and max constraints.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const integer: ({ min, max }?: {
+    min?: number;
+    max?: number;
+}) => QxInteger;
+/**
+ * @public  Makes any standard schema nullable.
+ * @since   0.1.0
+ * @version 1
+ */
+export type QxNullable<T extends std.StandardSchemaV1 = std.StandardSchemaV1> = std.StandardSchemaV1<input<T> | null, output<T> | null>;
+/**
+ * @public  Makes any standard schema accepts `null` as a valid value.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const nullable: <T extends std.StandardSchemaV1>(schema: T) => QxNullable<T>;
+/**
+ * @public  Defines a standard schema for numbers with optional min
+ *          and max constraints.
+ * @since   0.1.0
+ * @version 1
+ */
+export type QxNumber = std.StandardSchemaV1<number, number>;
+/**
+ * @public  Defines a standard schema for numbers with optional min
+ *          and max constraints.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const number: ({ min, max }?: {
+    min?: number;
+    max?: number;
+}) => QxNumber;
+/**
+ * @public  Defines an object schema that does not allow extra fields.
+ * @since   0.1.0
+ * @version 1
+ */
+type QxStrictObject<T extends Record<string, std.StandardSchemaV1>> = std.StandardSchemaV1<{
+    [K in keyof T]: input<T[K]>;
+}, {
+    [K in keyof T]: output<T[K]>;
+}>;
+/**
+ * @public  Defines an object schema that does not allow extra fields.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const strictObject: <T extends Record<string, std.StandardSchemaV1>>(shape: T) => QxStrictObject<T>;
+/**
+ * @public  Defines a standard schema for strings with optional min
+ *          and max length constraints.
+ * @since   0.1.0
+ * @version 1
+ */
+export type QxString = std.StandardSchemaV1<string, string>;
+/**
+ * @public  Defines a standard schema for strings with optional min
+ *          and max length constraints.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const string: ({ min, max }?: {
+    min?: number;
+    max?: number;
+}) => QxString;

package/dist/types/utils.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @private Converts a snake_case string to camelCase.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const camelCase: (str: string) => string;
+/**
+   * @private Simplified check for plain objects.
+   * @since   0.1.0
+   * @version 1
+   */
+export declare const isPlainObject: (value: unknown) => value is Record<string, any>;
+/**
+   * @private Throws an error if the given number is greater than the
+   *          specified maximum.
+   * @since   0.1.0
+   * @version 1
+   */
+export declare const lte: (n: number, max: number) => number;
+/**
+ * @public  Maps over the keys of an object.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const mapKeys: <T extends Record<string, any>, U extends string>(obj: T, fn: (key: keyof T) => U) => { [K in U]: T[keyof T]; };
+/**
+ * @private Maps over the values of an object.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const mapValues: <T extends Record<string, any>, U>(obj: T, fn: (value: T[keyof T], key: keyof T) => U) => { [K in keyof T]: U; };
+/**
+   * @private Resolves the given value or function to a value.
+   * @since   0.1.0
+   * @version 1
+   */
+export declare const resolve: <T>(value: T | (() => T)) => T;
+/**
+ * @private Converts a camelCase string to snake_case.
+ * @since   0.1.0
+ * @version 1
+ */
+export declare const snakeCase: (str: string) => string;
+/**
+   * @public  Wraps the given value in an array, unless it's already an
+   *          array.
+   * @since   0.1.0
+   * @version 1
+   */
+export declare const wrap: <T>(value: T | T[]) => T[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rwillians/qx",
   "description": "A teeny tiny ORM for SQLite.",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "author": "Rafael Willians <me@rwillians.com>",
   "license": "MIT",
   "repository": {
@@ -25,16 +25,19 @@
   "files": ["dist/", "LICENSE"],
   "exports": {
     ".": {
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/esm/index.js",
       "require": "./dist/cjs/index.js",
       "default": "./dist/cjs/index.js"
     },
     "./bun-sqlite": {
+      "types": "./dist/types/bun-sqlite.d.ts",
       "import": "./dist/esm/bun-sqlite.js",
       "require": "./dist/cjs/bun-sqlite.js",
       "default": "./dist/cjs/bun-sqlite.js"
     },
     "./pretty-logger": {
+      "types": "./dist/types/pretty-logger.d.ts",
       "import": "./dist/esm/pretty-logger.js",
       "require": "./dist/cjs/pretty-logger.js",
       "default": "./dist/cjs/pretty-logger.js"