Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: type definitions for columns constraint #355

Merged
merged 4 commits into from
Oct 9, 2022
Merged

fix: type definitions for columns constraint #355

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8646a58
fix: type definitions for columns constraint
Sep 29, 2022
1ded56d
fix: change raw to ts and complete unit test
Oct 8, 2022
f901b73
chore: columnAttributes definitions
Oct 8, 2022
bac10a2
chore: { toDate: () => Date } (#356)
cyjake Oct 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 37 additions & 17 deletions src/adapters/sequelize.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {
Attributes, Literal, OperatorCondition,
BoneOptions, ResultSet, Raw,
SetOptions, BeforeHooksType, AfterHooksType,
QueryOptions, OrderOptions, QueryResult, Values as CommonValues,
QueryOptions, OrderOptions, QueryResult, Values as CommonValues, BoneColumns, InstanceColumns,
} from '../types/common';
import { AbstractBone } from '../types/abstract_bone';
import { Spell } from '../spell';
Expand All @@ -21,21 +21,21 @@ interface BaseSequelizeConditions<T extends typeof SequelizeBone> extends QueryO
where?: WhereConditions<T>;
order?: OrderOptions<T>;
limit?: number;
attributes?: string | Raw | Array<[keyof Extract<CommonValues<InstanceType<T>>, Literal>] | string | Raw> | [keyof Extract<CommonValues<InstanceType<T>>, Literal>];
attributes?: BoneColumns<T> | Array<BoneColumns<T> | string | Raw> | string | Raw;
offset?: number;
}

type SequelizeUpdateOptions<T extends typeof SequelizeBone> = BaseSequelizeConditions<T> & {
fields?: Array<[keyof Extract<CommonValues<InstanceType<T>>, Literal>] | string | Raw> | [keyof Extract<CommonValues<InstanceType<T>>, Literal>];
fields?: BoneColumns<T> | Array<BoneColumns<T> | string | Raw> | string;
}

interface SequelizeInstanceUpdateOptions<T extends SequelizeBone> extends QueryOptions {
attributes?: string | Raw | Array<[keyof Extract<CommonValues<T>, Literal>] | string | Raw> | [keyof Extract<CommonValues<T>, Literal>];
attributes?: [keyof Extract<CommonValues<T>, Literal>] | string | Raw | Array<[keyof Extract<CommonValues<T>, Literal>] | string | Raw>;
fields?: Array<[keyof Extract<CommonValues<T>, Literal>] | string | Raw> | [keyof Extract<CommonValues<T>, Literal>];
}

interface SequelizeConditions<T extends typeof SequelizeBone> extends BaseSequelizeConditions<T> {
group?: string | string[] | Raw;
group?: BoneColumns<T> | BoneColumns<T>[] | Raw | string;
having?: WhereConditions<T> | string | { [key:string]: Literal | Literal[] } | Raw;
include?: string | Raw;
}
Expand Down Expand Up @@ -82,7 +82,7 @@ export class SequelizeBone extends AbstractBone {

static getTableName(): boolean;

static removeAttribute(name: string): void;
static removeAttribute<T extends typeof SequelizeBone>(this: T, name?: BoneColumns<T>): void;

/**
*
Expand Down Expand Up @@ -122,7 +122,8 @@ export class SequelizeBone extends AbstractBone {
*/
static setScope<T extends typeof SequelizeBone>(this: T, name: (string | ((...args: any[]) => SequelizeConditions<T>) | SequelizeConditions<T> | Array<SequelizeConditions<T>>), ...args: any[]): void;

static aggregate<T extends typeof SequelizeBone>(this: T, name: string, func: aggregators, options?: SequelizeConditions<T>): Spell<T, number>;
static aggregate<T extends typeof SequelizeBone>(this: T, name: BoneColumns<T>, func: aggregators, options?: SequelizeConditions<T>): Spell<T, number>;
static aggregate<T extends typeof SequelizeBone>(this: T, name: string | Raw, func: aggregators, options?: SequelizeConditions<T>): Spell<T, number>;

static build<T extends typeof SequelizeBone>(this: T, values: Values<T>, options?: BoneOptions): InstanceType<T>;

Expand All @@ -133,24 +134,29 @@ export class SequelizeBone extends AbstractBone {
*/
static bulkBuild<T extends typeof SequelizeBone>(this:T, valueSets: Array<Values<T>>, options?: BoneOptions): Array<InstanceType<T>>;

static count<T extends typeof SequelizeBone>(this: T, name?: string): Spell<T, ResultSet<T> | number>;
static count<T extends typeof SequelizeBone>(this: T, name?: BoneColumns<T>): Spell<T, ResultSet<T> | number>;
static count<T extends typeof SequelizeBone>(this: T, conditions?: SequelizeConditions<T>): Spell<T, ResultSet<T> | number>;

static decrement<T extends typeof SequelizeBone>(
this: T,
fields: string | Array<string> | { [Property in keyof Extract<InstanceType<T>, Literal>]?: number },
fields: { [Property in keyof Extract<InstanceType<T>, Literal>]?: number } | string | Array<BoneColumns<T> | string> ,
options?: SequelizeConditions<T>
): Spell<T, QueryResult>;

static increment<T extends typeof SequelizeBone>(
this: T,
fields: string | Array<string> | { [Property in keyof Extract<InstanceType<T>, Literal>]?: number },
fields: { [Property in keyof Extract<InstanceType<T>, Literal>]?: number } | string | Array<BoneColumns<T> | string> ,
options?: SequelizeConditions<T>
): Spell<T, QueryResult>;

static max<T extends typeof SequelizeBone>(this: T, filed: string, options?: SequelizeConditions<T>): Promise<Literal>;
static min<T extends typeof SequelizeBone>(this: T, filed: string, options?: SequelizeConditions<T>): Promise<Literal>;
static sum<T extends typeof SequelizeBone>(this: T, filed: string, options?: SequelizeConditions<T>): Promise<Literal>;
static max<T extends typeof SequelizeBone>(this: T, field: BoneColumns<T>, options?: SequelizeConditions<T>): Promise<Literal>;
static max<T extends typeof SequelizeBone>(this: T, field: Raw | string, options?: SequelizeConditions<T>): Promise<Literal>;

static min<T extends typeof SequelizeBone>(this: T, field: BoneColumns<T>, options?: SequelizeConditions<T>): Promise<Literal>;
static min<T extends typeof SequelizeBone>(this: T, field: Raw | string, options?: SequelizeConditions<T>): Promise<Literal>;

static sum<T extends typeof SequelizeBone>(this: T, field: BoneColumns<T>, options?: SequelizeConditions<T>): Promise<Literal>;
static sum<T extends typeof SequelizeBone>(this: T, field: Raw | string, options?: SequelizeConditions<T>): Promise<Literal>;

static destroy<T extends typeof SequelizeBone>(this: T, options?: DestroyOptions<T>): Promise<Array<number> | number>;
static bulkDestroy<T extends typeof SequelizeBone>(this: T, options?: DestroyOptions<T>): Spell<T, number>;
Expand Down Expand Up @@ -184,18 +190,32 @@ export class SequelizeBone extends AbstractBone {
get dataValues(): { [key: string]: Literal };

where(): { [key: string]: number | bigint | string };
set<T, Key extends keyof CommonValues<T>>(this: T, key: Key, value: T[Key]): void;
set<T, Key extends keyof T>(this: T, key: Key, value: T[Key]): void;

get<T, Key extends keyof CommonValues<T>>(this: T, key?: Key): T[Key];
get<T, Key extends keyof T>(this: T, key?: Key): T[Key];

setDataValue<T, Key extends keyof CommonValues<T>>(this: T, key: Key, value: T[Key]): void;
setDataValue<T, Key extends keyof T>(this: T, key: Key, value: T[Key]): void;

getDataValue<T>(this: T): T;
getDataValue<T, Key extends keyof CommonValues<T>>(this: T, key: Key): T[Key];
getDataValue<T, Key extends keyof T>(this: T, key: Key): T[Key];
previous(key?: string): Literal | Literal[] | { [key: string]: Literal | Literal[] };

previous<T, Key extends keyof CommonValues<T>>(this: T, key?: Key): Literal | Literal[] | { [Property in keyof Extract<this, Literal>]?: Literal | Literal[] };
previous<T, Key extends keyof T>(this: T, key?: Key): Literal | Literal[] | { [Property in keyof Extract<this, Literal>]?: Literal | Literal[] };

isSoftDeleted(): boolean;

increment(field: string | string[] | { [Property in keyof Extract<this, Literal>]?: number }, options?: QueryOptions): Spell<typeof SequelizeBone, QueryResult>;
decrement(field: string | string[] | { [Property in keyof Extract<this, Literal>]?: number }, options?: QueryOptions): Spell<typeof SequelizeBone, QueryResult>;
increment(field: InstanceColumns<this> | Array<InstanceColumns<this>> | { [Property in keyof Extract<this, Literal>]?: number }, options?: QueryOptions): Spell<typeof SequelizeBone, QueryResult>;
increment(field: string | Raw | Array<string | Raw>, options?: QueryOptions): Spell<typeof SequelizeBone, QueryResult>;
decrement(field: InstanceColumns<this> | Array<InstanceColumns<this>> | { [Property in keyof Extract<this, Literal>]?: number }, options?: QueryOptions): Spell<typeof SequelizeBone, QueryResult>;
decrement(field: string | Raw | Array<string | Raw> , options?: QueryOptions): Spell<typeof SequelizeBone, QueryResult>;
destroy(options?: SequelizeDestroyOptions): Promise<this| number>;
update<T = this>(this: T, changes?: { [key: string]: Literal } | { [Property in keyof Extract<this, Literal>]?: Literal }, opts?: SequelizeInstanceUpdateOptions<this>): Promise<number>;
update<T = this>(this: T, changes?: { [Property in keyof Extract<this, Literal>]?: Literal }, opts?: SequelizeInstanceUpdateOptions<this>): Promise<number>;
update<T = this>(this: T, changes?: { [key: string]: Literal }, opts?: SequelizeInstanceUpdateOptions<this>): Promise<number>;

}

export const sequelize: (Bone: AbstractBone) => typeof SequelizeBone;
7 changes: 4 additions & 3 deletions src/bone.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Spell } from './spell';
import { AbstractBone } from './types/abstract_bone';
import { Collection, Literal, QueryOptions, ResultSet, WhereConditions } from './types/common';
import { BoneColumns, Collection, Literal, QueryOptions, ResultSet, Values, WhereConditions } from './types/common';

export default class Bone extends AbstractBone {

Expand All @@ -26,6 +26,7 @@ export default class Bone extends AbstractBone {
static findOne<T extends typeof Bone>(this: T, primaryKey: number | number[] | bigint): Spell<T, InstanceType<T> | null>;
static findOne<T extends typeof Bone>(this: T, ): Spell<T, InstanceType<T> | null>;

static sum<T extends typeof Bone>(this: T, name?: BoneColumns<T>): Spell<T, ResultSet<T> | number>;
static sum<T extends typeof Bone>(this: T, name?: string): Spell<T, ResultSet<T> | number>;

/**
Expand All @@ -36,12 +37,12 @@ export default class Bone extends AbstractBone {
* @param conditions query conditions
* @param opts query options
*/
static restore<T extends typeof Bone>(this: T, conditions: Object, opts?: QueryOptions): Spell<T, number>;
static restore<T extends typeof Bone>(this: T, conditions: WhereConditions<T>, opts?: QueryOptions): Spell<T, number>;

/**
* UPDATE rows.
*/
static update<T extends typeof Bone>(this: T, whereConditions: WhereConditions<T>, values?: Object, opts?: QueryOptions): Spell<T, number>;
static update<T extends typeof Bone>(this: T, whereConditions: WhereConditions<T>, values?: Values<InstanceType<T>> & Partial<Record<BoneColumns<T>, Literal>>, opts?: QueryOptions): Spell<T, number>;

/**
* Discard all the applied scopes.
Expand Down
14 changes: 13 additions & 1 deletion src/spell.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {
Literal, command, Raw, Connection,
ResultSet, QueryResult,
QueryOptions, SetOptions, WithOptions,
Collection, WhereConditions, OrderOptions,
Collection, WhereConditions, OrderOptions, BoneColumns,
} from './types/common';
import { AbstractBone } from './types/abstract_bone';
import { Hint, IndexHint, CommonHintsArgs, HintInterface } from './hint';
Expand Down Expand Up @@ -134,15 +134,27 @@ export class Spell<T extends typeof AbstractBone, U = InstanceType<T> | Collecti
$limit(rowCount: number): Spell<T, U>;
limit(rowCount: number): Spell<T, U>;

count(name?: BoneColumns<T>): Spell<T, Extract<U, ResultSet<T> | number>>;
count(name?: string): Spell<T, Extract<U, ResultSet<T> | number>>;

average(name?: BoneColumns<T>): Spell<T, Extract<U, ResultSet<T> | number>>;
average(name?: string): Spell<T, Extract<U, ResultSet<T> | number>>;

minimum(name?: BoneColumns<T>): Spell<T, Extract<U, ResultSet<T> | number>>;
minimum(name?: string): Spell<T, Extract<U, ResultSet<T> | number>>;

maximum(name?: BoneColumns<T>): Spell<T, Extract<U, ResultSet<T> | number>>;
maximum(name?: string): Spell<T, Extract<U, ResultSet<T> | number>>;

sum(name?: BoneColumns<T>): Spell<T, Extract<U, ResultSet<T> | number>>;
sum(name?: string): Spell<T, Extract<U, ResultSet<T> | number>>;

batch(size?: number): AsyncIterable<T>;

increment(name: BoneColumns<T>, by?: number, options?: QueryOptions): Spell<T, QueryResult>;
increment(name: string, by?: number, options?: QueryOptions): Spell<T, QueryResult>;

decrement(name: BoneColumns<T>, by?: number, options?: QueryOptions): Spell<T, QueryResult>;
decrement(name: string, by?: number, options?: QueryOptions): Spell<T, QueryResult>;

toSqlString(): string;
Expand Down
Loading