@decaf-ts/core 0.5.1 → 0.5.3

package/lib/query/options.d.ts

@@ -8,6 +8,7 @@ import { Paginatable } from "../interfaces/Paginatable";
  * @description Exposes the GROUP BY method and remaining options
  *
  * @interface GroupByOption
+ * @memberOf module:core
  */
 export interface GroupByOption<M extends Model, R> extends Executor<R> {
     groupBy(selector: GroupBySelector<M>): Executor<R>;
@@ -17,6 +18,7 @@ export interface GroupByOption<M extends Model, R> extends Executor<R> {
  * @description Exposes the OFFSET method and remaining options
  *
  * @interface GroupByOption
+ * @memberOf module:core
  */
 export interface OffsetOption<R> extends Executor<R> {
     offset(selector: OffsetSelector): Executor<R>;
@@ -26,6 +28,7 @@ export interface OffsetOption<R> extends Executor<R> {
  * @description Exposes the LIMIT method and remaining options
  *
  * @interface LimitOption
+ * @memberOf module:core
  */
 export interface LimitOption<M extends Model, R> extends Executor<R>, Paginatable<M, R, any> {
     limit(selector: LimitSelector): OffsetOption<R>;
@@ -35,6 +38,7 @@ export interface LimitOption<M extends Model, R> extends Executor<R>, Paginatabl
  * @description Exposes the ORDER BY method and remaining options
  *
  * @interface OrderByOption
+ * @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>;
@@ -44,6 +48,7 @@ export interface OrderByOption<M extends Model, R> extends Executor<R>, Paginata
  * @description Exposes the ORDER BY method and remaining options
  *
  * @interface ThenByOption
+ * @memberOf module:core
  */
 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>;
@@ -56,6 +61,7 @@ export interface ThenByOption<M extends Model, R> extends LimitOption<M, R>, Off
  * @extends GroupByOption
  * @extends LimitOption
  * @extends OffsetOption
+ * @memberOf module:core
  */
 export interface OrderAndGroupOption<M extends Model, R> extends OrderByOption<M, R>, Executor<R>, GroupByOption<M, R>, LimitOption<M, R>, OffsetOption<R> {
 }
@@ -65,6 +71,7 @@ export interface OrderAndGroupOption<M extends Model, R> extends OrderByOption<M
  *
  * @interface WhereOption
  * @extends OrderAndGroupOption
+ * @memberOf module:core
  */
 export interface WhereOption<M extends Model, R> extends OrderAndGroupOption<M, R> {
     /**
@@ -80,6 +87,7 @@ export interface WhereOption<M extends Model, R> extends OrderAndGroupOption<M,
  * @description Exposes the FROM method and remaining options
  *
  * @interface FromOption
+ * @memberOf module:core
  */
 export interface FromOption<M extends Model, R> {
     /**
@@ -96,6 +104,7 @@ export interface FromOption<M extends Model, R> {
  *
  * @interface DistinctOption
  * @extends FromOption
+ * @memberOf module:core
  */
 export interface DistinctOption<M extends Model, R> extends FromOption<M, R> {
 }
@@ -105,6 +114,7 @@ export interface DistinctOption<M extends Model, R> extends FromOption<M, R> {
  *
  * @interface MaxOption
  * @extends FromOption
+ * @memberOf module:core
  */
 export interface MaxOption<M extends Model, R> extends FromOption<M, R> {
 }
@@ -114,6 +124,7 @@ export interface MaxOption<M extends Model, R> extends FromOption<M, R> {
  *
  * @interface MinOption
  * @extends FromOption
+ * @memberOf module:core
  */
 export interface MinOption<M extends Model, R> extends FromOption<M, R> {
 }
@@ -123,6 +134,7 @@ export interface MinOption<M extends Model, R> extends FromOption<M, R> {
  *
  * @interface CountOption
  * @extends FromOption
+ * @memberOf module:core
  */
 export interface CountOption<M extends Model, R> extends FromOption<M, R> {
 }
@@ -132,6 +144,7 @@ export interface CountOption<M extends Model, R> extends FromOption<M, R> {
  *
  * @interface SelectOption
  * @extends FromOption
+ * @memberOf module:core
  */
 export interface SelectOption<M extends Model, R> extends FromOption<M, R> {
     distinct<S extends SelectSelector<M>>(selector: S): DistinctOption<M, M[S][]>;
@@ -144,6 +157,7 @@ export interface SelectOption<M extends Model, R> extends FromOption<M, R> {
  * @description Exposes the remaining options after an INTO
  *
  * @interface IntoOption
+ * @memberOf module:core
  */
 export interface IntoOption<M extends Model, R> {
     values(...models: M[]): Executor<R>;
@@ -154,6 +168,7 @@ export interface IntoOption<M extends Model, R> {
  * @description Exposes the remaining options after a VALUES
  *
  * @interface ValuesOption
+ * @memberOf module:core
  */
 export interface ValuesOption<M extends Model> extends Executor<M> {
 }
@@ -162,6 +177,7 @@ export interface ValuesOption<M extends Model> extends Executor<M> {
  * @description Exposes the remaining options after an INSERT
  *
  * @interface InsertOption
+ * @memberOf module:core
  */
 export interface InsertOption<M extends Model, R = void> {
     /**
@@ -177,6 +193,7 @@ export interface InsertOption<M extends Model, R = void> {
  * @description Exposes the available operators for a {@link Condition}
  *
  * @interface AttributeOption
+ * @memberOf module:core
  */
 export interface AttributeOption<M extends Model> {
     /**
@@ -235,10 +252,11 @@ export interface AttributeOption<M extends Model> {
     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
+ * @memberOf module:core
  */
 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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VsZWN0b3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3F1ZXJ5L3NlbGVjdG9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgT3JkZXJEaXJlY3Rpb24gfSBmcm9tIFwiLi4vcmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgQ29uc3RydWN0b3IsIE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuXG5leHBvcnQgdHlwZSBGcm9tU2VsZWN0b3I8TSBleHRlbmRzIE1vZGVsPiA9IENvbnN0cnVjdG9yPE0+IHwgc3RyaW5nO1xuXG5leHBvcnQgdHlwZSBHcm91cEJ5U2VsZWN0b3I8TSBleHRlbmRzIE1vZGVsPiA9IGtleW9mIE07XG5cbmV4cG9ydCB0eXBlIE9yZGVyQnlTZWxlY3RvcjxNIGV4dGVuZHMgTW9kZWw+ID0gW2tleW9mIE0sIE9yZGVyRGlyZWN0aW9uXTtcblxuZXhwb3J0IHR5cGUgTGltaXRTZWxlY3RvciA9IG51bWJlcjtcblxuZXhwb3J0IHR5cGUgT2Zmc2V0U2VsZWN0b3IgPSBudW1iZXI7XG5cbmV4cG9ydCB0eXBlIFNlbGVjdFNlbGVjdG9yPE0gZXh0ZW5kcyBNb2RlbD4gPSBrZXlvZiBNO1xuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VsZWN0b3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3F1ZXJ5L3NlbGVjdG9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgT3JkZXJEaXJlY3Rpb24gfSBmcm9tIFwiLi4vcmVwb3NpdG9yeVwiO1xuaW1wb3J0IHsgQ29uc3RydWN0b3IsIE1vZGVsIH0gZnJvbSBcIkBkZWNhZi10cy9kZWNvcmF0b3ItdmFsaWRhdGlvblwiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIGZvciBzZWxlY3RpbmcgdGhlIGRhdGEgc291cmNlIGluIGEgcXVlcnlcbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIHR5cGUgZm9yIHNwZWNpZnlpbmcgdGhlIHRhYmxlIG9yIG1vZGVsIHRvIHF1ZXJ5IGZyb21cbiAqIEB0ZW1wbGF0ZSBNIC0gVGhlIG1vZGVsIHR5cGUgdGhpcyBzZWxlY3RvciBvcGVyYXRlcyBvblxuICogQHR5cGVkZWYge0NvbnN0cnVjdG9yPE0+IHwgc3RyaW5nfSBGcm9tU2VsZWN0b3JcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgdHlwZSBGcm9tU2VsZWN0b3I8TSBleHRlbmRzIE1vZGVsPiA9IENvbnN0cnVjdG9yPE0+IHwgc3RyaW5nO1xuXG5leHBvcnQgdHlwZSBHcm91cEJ5U2VsZWN0b3I8TSBleHRlbmRzIE1vZGVsPiA9IGtleW9mIE07XG5cbmV4cG9ydCB0eXBlIE9yZGVyQnlTZWxlY3RvcjxNIGV4dGVuZHMgTW9kZWw+ID0gW2tleW9mIE0sIE9yZGVyRGlyZWN0aW9uXTtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gVHlwZSBmb3IgbGltaXRpbmcgcXVlcnkgcmVzdWx0c1xuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgdHlwZSBmb3Igc3BlY2lmeWluZyB0aGUgbWF4aW11bSBudW1iZXIgb2YgcmVzdWx0cyB0byByZXR1cm5cbiAqIEB0eXBlZGVmIHtudW1iZXJ9IExpbWl0U2VsZWN0b3JcbiAqIEBtZW1iZXJPZiBtb2R1bGU6Y29yZVxuICovXG5leHBvcnQgdHlwZSBMaW1pdFNlbGVjdG9yID0gbnVtYmVyO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBUeXBlIGZvciBvZmZzZXR0aW5nIHF1ZXJ5IHJlc3VsdHNcbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIHR5cGUgZm9yIHNwZWNpZnlpbmcgdGhlIG51bWJlciBvZiByZXN1bHRzIHRvIHNraXBcbiAqIEB0eXBlZGVmIHtudW1iZXJ9IE9mZnNldFNlbGVjdG9yXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmNvcmVcbiAqL1xuZXhwb3J0IHR5cGUgT2Zmc2V0U2VsZWN0b3IgPSBudW1iZXI7XG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIFR5cGUgZm9yIHNlbGVjdGluZyBmaWVsZHMgaW4gYSBxdWVyeVxuICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgdHlwZSBmb3Igc3BlY2lmeWluZyB3aGljaCBmaWVsZHMgdG8gc2VsZWN0IGZyb20gYSBtb2RlbFxuICogQHRlbXBsYXRlIE0gLSBUaGUgbW9kZWwgdHlwZSB0aGlzIHNlbGVjdG9yIG9wZXJhdGVzIG9uXG4gKiBAdHlwZWRlZiBTZWxlY3RTZWxlY3RvclxuICogQG1lbWJlck9mIG1vZHVsZTpjb3JlXG4gKi9cbmV4cG9ydCB0eXBlIFNlbGVjdFNlbGVjdG9yPE0gZXh0ZW5kcyBNb2RlbD4gPSBrZXlvZiBNO1xuIl19

package/lib/query/selectors.d.ts

@@ -1,8 +1,34 @@
 import { OrderDirection } from "../repository";
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
+/**
+ * @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];
+/**
+ * @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;
+/**
+ * @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
+ * @memberOf module:core
+ */
 export type SelectSelector<M extends Model> = keyof M;