@palmares/databases
Version:
Add support for working with databases with palmares framework
343 lines • 16.3 kB
TypeScript
import { Field } from './field';
import type { CustomImportsForFieldType, FieldWithOperationTypeForSearch } from './types';
import type { CompareCallback, NewInstanceArgumentsCallback, OptionsCallback, ToStringCallback } from './utils';
import type { AdapterAutoFieldParser, DatabaseAdapter } from '../..';
/**
* Functional approach for the creation of an AutoField instance. An AutoField is a field that
* is used as the primary key of the database.
*
* We recommend just using one AutoField per model (or BigAutoField) because you might face some
* issues with certain ORM's. For ALL use cases, this
* field should be an integer.
*
* @example
* ```ts
* const autoField = auto();
* ```
*
* @example
* ```
* const autoField = auto();
* ```
*/
export declare function auto(): AutoField<{
create: number | undefined;
read: number;
update: number | undefined;
}, {
unique: true;
allowNull: true;
dbIndex: true;
underscored: true;
isPrimaryKey: true;
hasDefaultValue: false;
auto: true;
defaultValue: undefined;
typeName: string;
databaseName: undefined;
engineInstance: DatabaseAdapter;
customAttributes: any;
}, Pick<FieldWithOperationTypeForSearch<number>, 'lessThan' | 'greaterThan' | 'and' | 'in' | 'or' | 'eq' | 'is' | 'between'>>;
/**
* We recommend just using one AutoField per model (or BigAutoField) because you might face some
* issues with certain ORM's. For ALL use cases, this field should be an integer.
*
* @example
* ```ts
* const autoField = AutoField.new();
* ```
*
* @example
* ```
* const autoField = AutoField.new({ databaseName: 'user_id' });
* ```
*/
export declare class AutoField<out TType extends {
create: any;
read: any;
update: any;
} = {
create: number | undefined | null;
read: number;
update: number | undefined | null;
}, out TDefinitions extends {
hasDefaultValue: boolean;
unique: boolean;
auto: boolean;
allowNull: boolean;
dbIndex: boolean;
isPrimaryKey: boolean;
defaultValue: undefined;
underscored: boolean;
typeName: string;
databaseName: string | undefined;
engineInstance: DatabaseAdapter;
customAttributes: any;
} & Record<string, any> = {
hasDefaultValue: false;
unique: true;
allowNull: true;
dbIndex: true;
underscored: true;
isPrimaryKey: true;
auto: true;
defaultValue: undefined;
typeName: string;
databaseName: undefined;
engineInstance: DatabaseAdapter;
customAttributes: any;
}, out TFieldOperationTypes = Pick<FieldWithOperationTypeForSearch<number>, 'lessThan' | 'greaterThan' | 'and' | 'in' | 'or' | 'eq' | 'is' | 'between'>> extends Field<TType, TDefinitions, TFieldOperationTypes> {
protected $$type: string;
protected __typeName: string;
protected __isAuto: boolean;
protected __hasDefaultValue: boolean;
protected __primaryKey: boolean;
protected __defaultValue: undefined;
protected __allowNull: boolean;
protected __unique: boolean;
protected __dbIndex: boolean;
protected __allowedQueryOperations: Set<any>;
protected __inputParsers: Map<string, ((args: import("../..").AdapterFieldParserInputAndOutputArgs<"field" | "auto" | "big-auto" | "big-integer" | "boolean" | "char" | "date" | "decimal" | "enum" | "foreign-key" | "integer" | "text" | "uuid">) => Promise<any>) | null>;
protected __outputParsers: Map<string, ((args: import("../..").AdapterFieldParserInputAndOutputArgs<"field" | "auto" | "big-auto" | "big-integer" | "boolean" | "char" | "date" | "decimal" | "enum" | "foreign-key" | "integer" | "text" | "uuid">) => Promise<any>) | null>;
unique: never;
auto: never;
allowNull: never;
primaryKey: never;
dbIndex: never;
default: never;
constructor(...args: any[]);
/**
* Supposed to be used by library maintainers.
*
* When you custom create a field, you might want to take advantage of the builder pattern we already support.
* This let's you create functions that can be chained together to create a new field. It should be used
* alongside the `_setPartialAttributes` method like
*
* @example
* ```ts
* const customBigInt = TextField.overrideType<
* { create: bigint; read: bigint; update: bigint },
* {
* customAttributes: { name: string };
* unique: boolean;
* auto: boolean;
* allowNull: true;
* dbIndex: boolean;
* isPrimaryKey: boolean;
* defaultValue: any;
* typeName: string;
* engineInstance: DatabaseAdapter;
* }
* >({
* typeName: 'CustomBigInt'
* });
*
* const customBuilder = () => {
* const field = textField.new();
* class Builder {
* test<TTest extends { age: number }>(param: TTest) {
* return field
* ._setPartialAttributes<{ create: TTest }, { create: 'union' }>()(param)
* ._setNewBuilderMethods<Builder>();
* }
* value<const TValue extends string>(value: TValue) {
* return field
* ._setPartialAttributes<{ create: TValue }, { create: 'replace' }>()(value)
* ._setNewBuilderMethods<Builder>();
* }
* }
*
* const builder = new Builder();
* return field._setNewBuilderMethods(builder);
* };
*
* // Then your user can use it like:
*
* const field = customBuilder({ name: 'test' }).test({ age: 2 });
* ```
*
* **Important**: `customBuilder` will be used by the end user and you are responsible for documenting it.
*/
_setNewBuilderMethods<const TFunctions extends InstanceType<any>>(functions?: TFunctions): AutoField<TType, {
[TKey in Exclude<keyof TDefinitions, 'underscored' | 'allowNull' | 'dbIndex' | 'unique' | 'isPrimaryKey' | 'auto' | 'defaultValue' | 'databaseName' | 'typeName' | 'engineInstance' | 'customAttributes'>]: TDefinitions[TKey];
} & {
hasDefaultValue: TDefinitions['hasDefaultValue'];
unique: TDefinitions['unique'];
allowNull: TDefinitions['allowNull'];
dbIndex: TDefinitions['dbIndex'];
underscored: TDefinitions['underscored'];
isPrimaryKey: TDefinitions['isPrimaryKey'];
auto: TDefinitions['auto'];
defaultValue: TDefinitions['defaultValue'];
databaseName: TDefinitions['databaseName'];
typeName: TDefinitions['typeName'];
engineInstance: TDefinitions['engineInstance'];
customAttributes: TDefinitions['customAttributes'];
}, TFieldOperationTypes> & TFunctions;
/**
* FOR LIBRARY MAINTAINERS ONLY
*
* Focused for library maintainers that want to support a custom field type not supported by palmares.
* This let's them partially update the custom attributes of the field. By default setCustomAttributes
* will override the custom attributes entirely.
*/
_setPartialAttributes<TNewType extends {
create?: any;
read?: any;
update?: any;
}, TActions extends {
create?: 'merge' | 'union' | 'replace';
read?: 'merge' | 'union' | 'replace';
update?: 'merge' | 'union' | 'replace';
}, TNewAllowedQueryOperations extends FieldWithOperationTypeForSearch<TActions['read'] extends 'merge' ? TType['read'] & TNewType['read'] : TActions['read'] extends 'union' ? TType['read'] | TNewType['read'] : TActions['read'] extends 'replace' ? TNewType['read'] : TType['read']> = Pick<FieldWithOperationTypeForSearch<TActions['read'] extends 'merge' ? TType['read'] & TNewType['read'] : TActions['read'] extends 'union' ? TType['read'] | TNewType['read'] : TActions['read'] extends 'replace' ? TNewType['read'] : TType['read']>, 'lessThan' | 'greaterThan' | 'and' | 'in' | 'or' | 'eq' | 'is' | 'between'>>(): <const TCustomPartialAttributes>(partialCustomAttributes: TCustomPartialAttributes) => AutoField<{
create: TActions['create'] extends 'merge' ? TType['create'] & TNewType['create'] : TActions['create'] extends 'union' ? TType['create'] | TNewType['create'] : TActions['create'] extends 'replace' ? TNewType['create'] : TType['create'];
read: TActions['read'] extends 'merge' ? TType['read'] & TNewType['read'] : TActions['read'] extends 'union' ? TType['read'] | TNewType['read'] : TActions['read'] extends 'replace' ? TNewType['read'] : TType['read'];
update: TActions['update'] extends 'merge' ? TType['update'] & TNewType['update'] : TActions['update'] extends 'union' ? TType['update'] | TNewType['update'] : TActions['update'] extends 'replace' ? TNewType['update'] : TType['update'];
}, {
[TKey in Exclude<keyof TDefinitions, 'underscored' | 'allowNull' | 'dbIndex' | 'unique' | 'isPrimaryKey' | 'auto' | 'defaultValue' | 'databaseName' | 'typeName' | 'engineInstance' | 'customAttributes'>]: TDefinitions[TKey];
} & {
hasDefaultValue: TDefinitions['hasDefaultValue'];
unique: TDefinitions['unique'];
allowNull: TDefinitions['allowNull'];
dbIndex: TDefinitions['dbIndex'];
underscored: TDefinitions['underscored'];
isPrimaryKey: TDefinitions['isPrimaryKey'];
auto: TDefinitions['auto'];
defaultValue: TDefinitions['defaultValue'];
databaseName: TDefinitions['databaseName'];
typeName: TDefinitions['typeName'];
engineInstance: TDefinitions['engineInstance'];
customAttributes: TDefinitions['customAttributes'] & TCustomPartialAttributes;
}, TNewAllowedQueryOperations>;
setCustomAttributes<const TCustomAttributes extends TDefinitions['engineInstance']['fields']['autoFieldParser'] extends AdapterAutoFieldParser ? Parameters<TDefinitions['engineInstance']['fields']['autoFieldParser']['translate']>[0]['customAttributes'] : Parameters<TDefinitions['engineInstance']['fields']['integerFieldParser']['translate']>[0]['customAttributes']>(customAttributes: TCustomAttributes): AutoField<TType, {
[TKey in Exclude<keyof TDefinitions, 'underscored' | 'allowNull' | 'dbIndex' | 'unique' | 'isPrimaryKey' | 'auto' | 'defaultValue' | 'databaseName' | 'typeName' | 'engineInstance' | 'customAttributes'>]: TDefinitions[TKey];
} & {
hasDefaultValue: TDefinitions['hasDefaultValue'];
unique: TDefinitions['unique'];
allowNull: TDefinitions['allowNull'];
dbIndex: TDefinitions['dbIndex'];
underscored: TDefinitions['underscored'];
isPrimaryKey: TDefinitions['isPrimaryKey'];
auto: TDefinitions['auto'];
defaultValue: TDefinitions['defaultValue'];
databaseName: TDefinitions['databaseName'];
typeName: TDefinitions['typeName'];
engineInstance: TDefinitions['engineInstance'];
customAttributes: TCustomAttributes;
}, TFieldOperationTypes>;
underscored<TUnderscored extends boolean = true>(isUnderscored?: TUnderscored): AutoField<TType, {
[TKey in Exclude<keyof TDefinitions, 'underscored' | 'allowNull' | 'dbIndex' | 'unique' | 'isPrimaryKey' | 'auto' | 'defaultValue' | 'databaseName' | 'typeName' | 'engineInstance' | 'customAttributes'>]: TDefinitions[TKey];
} & {
hasDefaultValue: TDefinitions['hasDefaultValue'];
unique: TDefinitions['unique'];
allowNull: TDefinitions['allowNull'];
dbIndex: TDefinitions['dbIndex'];
underscored: TUnderscored extends false ? false : true;
isPrimaryKey: TDefinitions['isPrimaryKey'];
auto: TDefinitions['auto'];
defaultValue: TDefinitions['defaultValue'];
databaseName: TDefinitions['databaseName'];
typeName: TDefinitions['typeName'];
engineInstance: TDefinitions['engineInstance'];
customAttributes: TDefinitions['customAttributes'];
}, TFieldOperationTypes>;
databaseName<TDatabaseName extends string>(databaseName: TDatabaseName): AutoField<TType, {
[TKey in Exclude<keyof TDefinitions, 'underscored' | 'allowNull' | 'dbIndex' | 'unique' | 'isPrimaryKey' | 'auto' | 'defaultValue' | 'databaseName' | 'typeName' | 'engineInstance' | 'customAttributes'>]: TDefinitions[TKey];
} & {
hasDefaultValue: TDefinitions['hasDefaultValue'];
unique: TDefinitions['unique'];
allowNull: TDefinitions['allowNull'];
dbIndex: TDefinitions['dbIndex'];
underscored: TDefinitions['underscored'];
isPrimaryKey: TDefinitions['isPrimaryKey'];
auto: TDefinitions['auto'];
defaultValue: TDefinitions['defaultValue'];
databaseName: TDatabaseName;
typeName: TDefinitions['typeName'];
engineInstance: TDefinitions['engineInstance'];
customAttributes: TDefinitions['customAttributes'];
}, TFieldOperationTypes>;
/**
* This method can be used to override the type of a field. This is useful for library
* maintainers that want to support the field type but the default type provided by palmares
* is not the one that the user want to use.
*
* ### Note
*
* Your library should provide documentation of the fields that are supported.
*/
static _overrideType<TNewType extends {
create: any;
update: any;
read: any;
}, TDefinitions extends {
customAttributes: any;
unique: boolean;
auto: boolean;
allowNull: boolean;
dbIndex: boolean;
isPrimaryKey: boolean;
defaultValue: any;
typeName: string;
hasDefaultValue: boolean;
engineInstance: DatabaseAdapter;
}, const TFieldOperationTypes extends FieldWithOperationTypeForSearch<any> | Pick<FieldWithOperationTypeForSearch<any>, any>>(args: {
typeName: string;
toStringCallback?: ToStringCallback;
compareCallback?: CompareCallback;
optionsCallback?: OptionsCallback;
newInstanceCallback?: NewInstanceArgumentsCallback;
allowedQueryOperations?: (keyof TFieldOperationTypes)[];
customImports?: CustomImportsForFieldType[];
definitions?: Omit<TDefinitions, 'typeName' | 'engineInstance' | 'customAttributes'>;
}): TDefinitions['customAttributes'] extends undefined ? {
new: () => AutoField<TNewType, {
hasDefaultValue: TDefinitions['hasDefaultValue'];
unique: TDefinitions['unique'];
auto: TDefinitions['auto'];
allowNull: TDefinitions['allowNull'];
dbIndex: TDefinitions['dbIndex'];
isPrimaryKey: TDefinitions['isPrimaryKey'];
defaultValue: TDefinitions['defaultValue'];
underscored: boolean;
databaseName: string | undefined;
engineInstance: TDefinitions['engineInstance'];
customAttributes: TDefinitions['customAttributes'];
typeName: TDefinitions['typeName'];
}, TFieldOperationTypes>;
} : {
new: (params: TDefinitions['customAttributes']) => AutoField<TNewType, {
unique: TDefinitions['unique'];
auto: TDefinitions['auto'];
allowNull: TDefinitions['allowNull'];
dbIndex: TDefinitions['dbIndex'];
isPrimaryKey: TDefinitions['isPrimaryKey'];
defaultValue: TDefinitions['defaultValue'];
underscored: boolean;
databaseName: string | undefined;
hasDefaultValue: TDefinitions['hasDefaultValue'];
engineInstance: TDefinitions['engineInstance'];
customAttributes: TDefinitions['customAttributes'];
typeName: TDefinitions['typeName'];
}, TFieldOperationTypes>;
};
static new(..._args: any[]): AutoField<{
create: number | undefined;
read: number;
update: number | undefined;
}, {
unique: true;
allowNull: true;
dbIndex: true;
underscored: true;
isPrimaryKey: true;
auto: true;
hasDefaultValue: false;
defaultValue: undefined;
typeName: string;
databaseName: undefined;
engineInstance: DatabaseAdapter;
customAttributes: any;
}, Pick<FieldWithOperationTypeForSearch<number>, 'lessThan' | 'greaterThan' | 'and' | 'in' | 'or' | 'eq' | 'is' | 'between'>>;
}
//# sourceMappingURL=auto.d.ts.map