@decaf-ts/core 0.5.0 → 0.5.2

package/lib/query/options.d.ts

@@ -3,101 +3,55 @@ import { Executor } from "../interfaces";
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
 import { Condition } from "./Condition";
 import { Paginatable } from "../interfaces/Paginatable";
-/**
- * @summary Statement Builder interface
- * @description Exposes the final method to build the statement
- *
- * @typedef Q The query object type to build
- * @interface QueryBuilder
- *
- * @category Query
- * @subcategory Options
- *
- */
-export interface QueryBuilder<Q> extends Executor {
-    /**
-     * Method to build and validate the prepared statement before the execution;
-     *
-     * @throws {QueryError}  for invalid statements
-     * @method
-     */
-    build(previous: Q): Q;
-}
 /**
  * @summary GroupBy Option interface
  * @description Exposes the GROUP BY method and remaining options
  *
  * @interface GroupByOption
- * @extends QueryBuilder
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface GroupByOption extends Executor {
-    /**
-     * @summary Groups records by an attribute
-     *
-     * @param {GroupBySelector} selector
-     * @method
-     */
-    groupBy(selector: GroupBySelector): Executor;
+export interface GroupByOption<M extends Model, R> extends Executor<R> {
+    groupBy(selector: GroupBySelector<M>): Executor<R>;
 }
 /**
  * @summary Offset Option interface
  * @description Exposes the OFFSET method and remaining options
  *
  * @interface GroupByOption
- * @extends QueryBuilder
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface OffsetOption extends Executor {
-    /**
-     * @summary Offsets the results by the provided selector
-     *
-     * @param {OffsetSelector} selector
-     * @method
-     */
-    offset(selector: OffsetSelector): Executor;
+export interface OffsetOption<R> extends Executor<R> {
+    offset(selector: OffsetSelector): Executor<R>;
 }
 /**
  * @summary Limit Option interface
  * @description Exposes the LIMIT method and remaining options
  *
  * @interface LimitOption
- * @extends QueryBuilder
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface LimitOption extends Executor, Paginatable {
-    /**
-     * @summary Limits the results to the provided number
-     *
-     * @param {LimitSelector} selector
-     * @method
-     */
-    limit(selector: LimitSelector): OffsetOption;
+export interface LimitOption<M extends Model, R> extends Executor<R>, Paginatable<M, R, any> {
+    limit(selector: LimitSelector): OffsetOption<R>;
 }
 /**
- * @summary OrderpBy Option interface
+ * @summary OrderBy Option interface
  * @description Exposes the ORDER BY method and remaining options
  *
  * @interface OrderByOption
- * @extends QueryBuilder
+ * @memberOf module:core
+ */
+export interface OrderByOption<M extends Model, R> extends Executor<R>, Paginatable<M, R, any> {
+    orderBy(selector: OrderBySelector<M>): LimitOption<M, R> & OffsetOption<R>;
+}
+/**
+ * @summary OrderBy Option interface
+ * @description Exposes the ORDER BY method and remaining options
  *
- * @category Query
- * @subcategory Options
+ * @interface ThenByOption
+ * @memberOf module:core
  */
-export interface OrderByOption extends Executor, Paginatable {
-    /**
-     * @summary Orders the results by the provided attribute and according to the provided direction
-     *
-     * @param {OrderBySelector} selector
-     * @method
-     */
-    orderBy(...selector: OrderBySelector[]): LimitOption & OffsetOption;
+export interface ThenByOption<M extends Model, R> extends LimitOption<M, R>, OffsetOption<R>, Executor<R>, Paginatable<M, R, any> {
+    thenBy(selector: OrderBySelector<M>): ThenByOption<M, R>;
 }
 /**
  * @summary Groups several order and grouping options
@@ -107,11 +61,9 @@ export interface OrderByOption extends Executor, Paginatable {
  * @extends GroupByOption
  * @extends LimitOption
  * @extends OffsetOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface OrderAndGroupOption extends OrderByOption, GroupByOption, LimitOption, OffsetOption {
+export interface OrderAndGroupOption<M extends Model, R> extends OrderByOption<M, R>, Executor<R>, GroupByOption<M, R>, LimitOption<M, R>, OffsetOption<R> {
 }
 /**
  * @summary Where Option interface
@@ -119,36 +71,32 @@ export interface OrderAndGroupOption extends OrderByOption, GroupByOption, Limit
  *
  * @interface WhereOption
  * @extends OrderAndGroupOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface WhereOption extends OrderAndGroupOption {
+export interface WhereOption<M extends Model, R> extends OrderAndGroupOption<M, R> {
     /**
      * @summary filter the records by a condition
      *
      * @param {Condition} condition
      * @method
      */
-    where(condition: Condition): OrderAndGroupOption;
+    where(condition: Condition<M>): OrderAndGroupOption<M, R>;
 }
 /**
  * @summary From Option Interface
  * @description Exposes the FROM method and remaining options
  *
  * @interface FromOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface FromOption<M extends Model> {
+export interface FromOption<M extends Model, R> {
     /**
      * @summary selects records from a table
      *
      * @param {Constructor} tableName
      * @method
      */
-    from(tableName: Constructor<M> | string): WhereOption;
+    from(tableName: Constructor<M> | string): WhereOption<M, R>;
 }
 /**
  * @summary Distinct Option Interface
@@ -156,11 +104,9 @@ export interface FromOption<M extends Model> {
  *
  * @interface DistinctOption
  * @extends FromOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface DistinctOption<M extends Model> extends FromOption<M> {
+export interface DistinctOption<M extends Model, R> extends FromOption<M, R> {
 }
 /**
  * @summary Max Option Interface
@@ -168,11 +114,9 @@ export interface DistinctOption<M extends Model> extends FromOption<M> {
  *
  * @interface MaxOption
  * @extends FromOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface MaxOption<M extends Model> extends FromOption<M> {
+export interface MaxOption<M extends Model, R> extends FromOption<M, R> {
 }
 /**
  * @summary Min Option Interface
@@ -180,11 +124,9 @@ export interface MaxOption<M extends Model> extends FromOption<M> {
  *
  * @interface MinOption
  * @extends FromOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface MinOption<M extends Model> extends FromOption<M> {
+export interface MinOption<M extends Model, R> extends FromOption<M, R> {
 }
 /**
  * @summary Count Option Interface
@@ -192,11 +134,9 @@ export interface MinOption<M extends Model> extends FromOption<M> {
  *
  * @interface CountOption
  * @extends FromOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface CountOption<M extends Model> extends FromOption<M> {
+export interface CountOption<M extends Model, R> extends FromOption<M, R> {
 }
 /**
  * @summary Select Option Interface
@@ -204,169 +144,120 @@ export interface CountOption<M extends Model> extends FromOption<M> {
  *
  * @interface SelectOption
  * @extends FromOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface SelectOption<M extends Model> extends FromOption<M> {
-    /**
-     * @summary selects distinct values
-     *
-     * @param {SelectSelector} selector
-     * @method
-     */
-    distinct(selector: SelectSelector): DistinctOption<M>;
-    /**
-     * @summary the maximum value
-     *
-     * @param {SelectSelector} selector
-     * @method
-     */
-    max(selector: SelectSelector): MaxOption<M>;
-    /**
-     * @summary selects the minimum value
-     *
-     * @param {SelectSelector} selector
-     * @method
-     */
-    min(selector: SelectSelector): MinOption<M>;
-    /**
-     * @summary counts the records
-     *
-     * @param {SelectSelector} selector
-     * @method
-     */
-    count(selector?: SelectSelector): CountOption<M>;
+export interface SelectOption<M extends Model, R> extends FromOption<M, R> {
+    distinct<S extends SelectSelector<M>>(selector: S): DistinctOption<M, M[S][]>;
+    max<S extends SelectSelector<M>>(selector: S): MaxOption<M, M[S]>;
+    min<S extends SelectSelector<M>>(selector: S): MinOption<M, M[S]>;
+    count<S extends SelectSelector<M>>(selector?: S): CountOption<M, number>;
 }
 /**
  * @summary Into Option Interface
  * @description Exposes the remaining options after an INTO
  *
  * @interface IntoOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface IntoOption<M extends Model> {
-    /**
-     * @summary sets the models to insert
-     *
-     * @param {T[]} models
-     * @method
-     */
-    values(...models: M[]): Executor;
-    /**
-     * @summary filter records to insert
-     *
-     * @param {Condition} condition
-     * @method
-     */
-    where(condition: Condition): Executor;
+export interface IntoOption<M extends Model, R> {
+    values(...models: M[]): Executor<R>;
+    where(condition: Condition<M>): Executor<R>;
 }
 /**
  * @summary Valuest Option Interface
  * @description Exposes the remaining options after a VALUES
  *
  * @interface ValuesOption
- * @extends QueryBuilder
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface ValuesOption extends Executor {
+export interface ValuesOption<M extends Model> extends Executor<M> {
 }
 /**
  * @summary Insert Option Interface
  * @description Exposes the remaining options after an INSERT
  *
  * @interface InsertOption
- *
- * @category Query
- * @subcategory Options
+ * @memberOf module:core
  */
-export interface InsertOption<M extends Model> {
+export interface InsertOption<M extends Model, R = void> {
     /**
      * @summary selects the table to insert records into
      *
      * @param {string | Constructor} table
      * @method
      */
-    into(table: Constructor<M>): IntoOption<M>;
+    into(table: Constructor<M>): IntoOption<M, R>;
 }
 /**
  * @summary {@link Operator} Option Interface
  * @description Exposes the available operators for a {@link Condition}
  *
  * @interface AttributeOption
- *
- * @category Query
- * @subcategory Conditions
+ * @memberOf module:core
  */
-export interface AttributeOption {
+export interface AttributeOption<M extends Model> {
     /**
      * @summary Test equality
      *
      * @param {any} val the value to test
      * @method
      */
-    eq(val: any): Condition;
+    eq(val: any): Condition<M>;
     /**
      * @summary Test difference
      *
      * @param {any} val the value to test
      * @method
      */
-    dif(val: any): Condition;
+    dif(val: any): Condition<M>;
     /**
      * @summary Test greater than
      *
      * @param {any} val the value to test
      * @method
      */
-    gt(val: any): Condition;
+    gt(val: any): Condition<M>;
     /**
      * @summary Test lower than
      *
      * @param {any} val the value to test
      * @method
      */
-    lt(val: any): Condition;
+    lt(val: any): Condition<M>;
     /**
      * @summary Test greater or equal to
      *
      * @param {any} val the value to test
      * @method
      */
-    gte(val: any): Condition;
+    gte(val: any): Condition<M>;
     /**
      * @summary Test lower or equal to
      *
      * @param {any} val the value to test
      * @method
      */
-    lte(val: any): Condition;
+    lte(val: any): Condition<M>;
     /**
      * @summary Test value in a range of values
      * @param {any[]} val
      */
-    in(val: any[]): Condition;
+    in(val: any[]): Condition<M>;
     /**
      * @summary Test matches {@link RegExp}
      *
      * @param {any} val the value to test
      * @method
      */
-    regexp(val: string | RegExp): Condition;
+    regexp(val: string | RegExp): Condition<M>;
 }
 /**
- * @summary The starting point for creating Conditions
- * @description Exposes the available operations for a {@link Condition}
- *
+ * @description The starting point for creating query conditions
+ * @summary Exposes the available operations for building database query conditions
+ * @template M - The model type this condition builder operates on
  * @interface ConditionBuilderOption
- *
- * @category Query
- * @subcategory Conditions
+ * @memberOf module:core
  */
-export interface ConditionBuilderOption {
-    attribute(attr: string): AttributeOption;
+export interface ConditionBuilderOption<M extends Model> {
+    attribute(attr: keyof M): AttributeOption<M>;
 }

package/lib/query/selectors.cjs

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VsZWN0b3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3F1ZXJ5L3NlbGVjdG9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgT3JkZXJEaXJlY3Rpb24gfSBmcm9tIFwiLi4vcmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgQ29uc3RydWN0b3IsIE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuXG4vKipcbiAqIEB0eXBlZGVmIEZyb21TZWxlY3RvclxuICpcbiAqIEBjYXRlZ29yeSBDbGF1c2VzXG4gKi9cbmV4cG9ydCB0eXBlIEZyb21TZWxlY3RvcjxNIGV4dGVuZHMgTW9kZWw+ID0gQ29uc3RydWN0b3I8TT4gfCBzdHJpbmc7XG4vKipcbiAqIEB0eXBlZGVmIEdyb3VwQnlTZWxlY3RvclxuICpcbiAqIEBjYXRlZ29yeSBDbGF1c2VzXG4gKi9cbmV4cG9ydCB0eXBlIEdyb3VwQnlTZWxlY3RvciA9IHN0cmluZztcbi8qKlxuICogQHR5cGVkZWYgT3JkZXJCeVNlbGVjdG9yXG4gKlxuICogQGNhdGVnb3J5IENsYXVzZXNcbiAqL1xuZXhwb3J0IHR5cGUgT3JkZXJCeVNlbGVjdG9yID0gW3N0cmluZywgT3JkZXJEaXJlY3Rpb25dO1xuLyoqXG4gKiBAdHlwZWRlZiBMaW1pdFNlbGVjdG9yXG4gKlxuICogQGNhdGVnb3J5IENsYXVzZXNcbiAqL1xuZXhwb3J0IHR5cGUgTGltaXRTZWxlY3RvciA9IG51bWJlcjtcbi8qKlxuICogQHR5cGVkZWYgT2Zmc2V0U2VsZWN0b3JcbiAqXG4gKiBAY2F0ZWdvcnkgQ2xhdXNlc1xuICovXG5leHBvcnQgdHlwZSBPZmZzZXRTZWxlY3RvciA9IG51bWJlcjtcblxuLy8gZXhwb3J0IHR5cGUgU2VsZWN0RnVuY3Rpb248VCA9IGFueT4gPSAob2JqOiBUKSA9PiBUIHwgYW55O1xuLyoqXG4gKiBAdHlwZWRlZiBTZWxlY3RTZWxlY3RvclxuICpcbiAqIEBjYXRlZ29yeSBDbGF1c2VzXG4gKi9cbmV4cG9ydCB0eXBlIFNlbGVjdFNlbGVjdG9yID0gc3RyaW5nIHwgc3RyaW5nW107XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VsZWN0b3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3F1ZXJ5L3NlbGVjdG9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgT3JkZXJEaXJlY3Rpb24gfSBmcm9tIFwiLi4vcmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgQ29uc3RydWN0b3IsIE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIGZvciBzZWxlY3RpbmcgdGhlIGRhdGEgc291cmNlIGluIGEgcXVlcnlcbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIHR5cGUgZm9yIHNwZWNpZnlpbmcgdGhlIHRhYmxlIG9yIG1vZGVsIHRvIHF1ZXJ5IGZyb21cbiAqIEB0ZW1wbGF0ZSBNIC0gVGhlIG1vZGVsIHR5cGUgdGhpcyBzZWxlY3RvciBvcGVyYXRlcyBvblxuICogQHR5cGVkZWYge0NvbnN0cnVjdG9yPE0+IHwgc3RyaW5nfSBGcm9tU2VsZWN0b3JcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgdHlwZSBGcm9tU2VsZWN0b3I8TSBleHRlbmRzIE1vZGVsPiA9IENvbnN0cnVjdG9yPE0+IHwgc3RyaW5nO1xuXG5leHBvcnQgdHlwZSBHcm91cEJ5U2VsZWN0b3I8TSBleHRlbmRzIE1vZGVsPiA9IGtleW9mIE07XG5cbmV4cG9ydCB0eXBlIE9yZGVyQnlTZWxlY3RvcjxNIGV4dGVuZHMgTW9kZWw+ID0gW2tleW9mIE0sIE9yZGVyRGlyZWN0aW9uXTtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gVHlwZSBmb3IgbGltaXRpbmcgcXVlcnkgcmVzdWx0c1xuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgdHlwZSBmb3Igc3BlY2lmeWluZyB0aGUgbWF4aW11bSBudW1iZXIgb2YgcmVzdWx0cyB0byByZXR1cm5cbiAqIEB0eXBlZGVmIHtudW1iZXJ9IExpbWl0U2VsZWN0b3JcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgdHlwZSBMaW1pdFNlbGVjdG9yID0gbnVtYmVyO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIGZvciBvZmZzZXR0aW5nIHF1ZXJ5IHJlc3VsdHNcbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIHR5cGUgZm9yIHNwZWNpZnlpbmcgdGhlIG51bWJlciBvZiByZXN1bHRzIHRvIHNraXBcbiAqIEB0eXBlZGVmIHtudW1iZXJ9IE9mZnNldFNlbGVjdG9yXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IHR5cGUgT2Zmc2V0U2VsZWN0b3IgPSBudW1iZXI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIFR5cGUgZm9yIHNlbGVjdGluZyBmaWVsZHMgaW4gYSBxdWVyeVxuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgdHlwZSBmb3Igc3BlY2lmeWluZyB3aGljaCBmaWVsZHMgdG8gc2VsZWN0IGZyb20gYSBtb2RlbFxuICogQHRlbXBsYXRlIE0gLSBUaGUgbW9kZWwgdHlwZSB0aGlzIHNlbGVjdG9yIG9wZXJhdGVzIG9uXG4gKiBAdHlwZWRlZiBTZWxlY3RTZWxlY3RvclxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCB0eXBlIFNlbGVjdFNlbGVjdG9yPE0gZXh0ZW5kcyBNb2RlbD4gPSBrZXlvZiBNO1xuIl19

package/lib/query/selectors.d.ts

@@ -1,38 +1,34 @@
 import { OrderDirection } from "../repository";
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
 /**
- * @typedef FromSelector
- *
- * @category Clauses
+ * @description Type for selecting the data source in a query
+ * @summary Defines the type for specifying the table or model to query from
+ * @template M - The model type this selector operates on
+ * @typedef {Constructor<M> | string} FromSelector
+ * @memberOf module:core
  */
 export type FromSelector<M extends Model> = Constructor<M> | string;
+export type GroupBySelector<M extends Model> = keyof M;
+export type OrderBySelector<M extends Model> = [keyof M, OrderDirection];
 /**
- * @typedef GroupBySelector
- *
- * @category Clauses
- */
-export type GroupBySelector = string;
-/**
- * @typedef OrderBySelector
- *
- * @category Clauses
- */
-export type OrderBySelector = [string, OrderDirection];
-/**
- * @typedef LimitSelector
- *
- * @category Clauses
+ * @description Type for limiting query results
+ * @summary Defines the type for specifying the maximum number of results to return
+ * @typedef {number} LimitSelector
+ * @memberOf module:core
  */
 export type LimitSelector = number;
 /**
- * @typedef OffsetSelector
- *
- * @category Clauses
+ * @description Type for offsetting query results
+ * @summary Defines the type for specifying the number of results to skip
+ * @typedef {number} OffsetSelector
+ * @memberOf module:core
  */
 export type OffsetSelector = number;
 /**
+ * @description Type for selecting fields in a query
+ * @summary Defines the type for specifying which fields to select from a model
+ * @template M - The model type this selector operates on
  * @typedef SelectSelector
- *
- * @category Clauses
+ * @memberOf module:core
  */
-export type SelectSelector = string | string[];
+export type SelectSelector<M extends Model> = keyof M;