electrodb 1.10.2 → 1.12.1

package/index.d.ts

@@ -1,3 +1,4 @@
+
 export type DocumentClientMethod = (parameters: any) => {promise: () => Promise<any>};
 
 export type DocumentClient = {
@@ -79,6 +80,7 @@ export type CollectionWhereCallback<E extends {[name: string]: Entity<any, any,
 
 export type CollectionWhereClause<E extends {[name: string]: Entity<any, any, any, any>}, A extends string, F extends string, C extends string, S extends Schema<A,F,C>, I extends Partial<AllEntityAttributes<E>>, T> = (where: CollectionWhereCallback<E, I>) => T;
 
+
 export interface WhereRecordsActionOptions<E extends {[name: string]: Entity<any, any, any, any>}, A extends string, F extends string, C extends string, S extends Schema<A,F,C>, I extends Partial<AllEntityAttributes<E>>, Items, IndexCompositeAttributes> {
     go: GoRecord<Items>;
     params: ParamRecord;
@@ -349,6 +351,13 @@ export type CollectionItem<SERVICE extends Service<any>, COLLECTION extends keyo
         : never>
         : never
 
+export interface QueryBranches<A extends string,
+    F extends string, C extends string, S extends Schema<A,F,C>, ResponseItem, IndexCompositeAttributes> {
+    go: GoQueryTerminal<A,F,C,S,ResponseItem>;
+    params: ParamTerminal<A,F,C,S,ResponseItem>;
+    page: PageQueryTerminal<A,F,C,S,ResponseItem,IndexCompositeAttributes>;
+    where: WhereClause<A,F,C,S,Item<A,F,C,S,S["attributes"]>,QueryBranches<A,F,C,S,ResponseItem,IndexCompositeAttributes>>
+}
 
 export interface RecordsActionOptions<A extends string,
     F extends string, C extends string, S extends Schema<A,F,C>, Items, IndexCompositeAttributes> {
@@ -359,11 +368,16 @@ export interface RecordsActionOptions<A extends string,
 }
 
 export interface SingleRecordOperationOptions<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, ResponseType> {
-    go: GoRecord<ResponseType, QueryOptions>;
-    params: ParamRecord<QueryOptions>;
+    go: GoGetTerminal<A,F,C,S, ResponseType>;
+    params: ParamTerminal<A,F,C,S,ResponseType>;
     where: WhereClause<A,F,C,S,Item<A,F,C,S,S["attributes"]>,SingleRecordOperationOptions<A,F,C,S,ResponseType>>;
 }
 
+export interface BatchGetRecordOperationOptions<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, ResponseType> {
+    go: GoBatchGetTerminal<A,F,C,S,ResponseType>
+    params: ParamTerminal<A,F,C,S,ResponseType>;
+}
+
 export interface PutRecordOperationOptions<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, ResponseType> {
     go: GoRecord<ResponseType, PutQueryOptions>;
     params: ParamRecord<PutQueryOptions>;
@@ -406,17 +420,17 @@ export type RemoveRecord<A extends string, F extends string, C extends string, S
 export type DataUpdateMethodRecord<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, SetAttr, IndexCompositeAttributes, TableItem> =
     DataUpdateMethod<A,F,C,S, UpdateData<A,F,C,S>, SetRecordActionOptions<A,F,C,S, SetAttr, IndexCompositeAttributes, TableItem>>
 
-interface QueryOperations<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, CompositeAttributes, TableItem, IndexCompositeAttributes> {
-    between: (skCompositeAttributesStart: CompositeAttributes, skCompositeAttributesEnd: CompositeAttributes) => RecordsActionOptions<A,F,C,S, Array<TableItem>,IndexCompositeAttributes>;
-    gt: (skCompositeAttributes: CompositeAttributes) => RecordsActionOptions<A,F,C,S, Array<TableItem>,IndexCompositeAttributes>;
-    gte: (skCompositeAttributes: CompositeAttributes) => RecordsActionOptions<A,F,C,S, Array<TableItem>,IndexCompositeAttributes>;
-    lt: (skCompositeAttributes: CompositeAttributes) => RecordsActionOptions<A,F,C,S, Array<TableItem>,IndexCompositeAttributes>;
-    lte: (skCompositeAttributes: CompositeAttributes) => RecordsActionOptions<A,F,C,S, Array<TableItem>,IndexCompositeAttributes>;
-    begins: (skCompositeAttributes: CompositeAttributes) => RecordsActionOptions<A,F,C,S, Array<TableItem>,IndexCompositeAttributes>;
-    go: GoRecord<Array<TableItem>>;
-    params: ParamRecord;
-    page: PageRecord<Array<TableItem>,IndexCompositeAttributes>;
-    where: WhereClause<A,F,C,S,Item<A,F,C,S,S["attributes"]>,RecordsActionOptions<A,F,C,S,Array<TableItem>,IndexCompositeAttributes>>
+interface QueryOperations<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, CompositeAttributes, ResponseItem, IndexCompositeAttributes> {
+    between: (skCompositeAttributesStart: CompositeAttributes, skCompositeAttributesEnd: CompositeAttributes) => QueryBranches<A,F,C,S, ResponseItem, IndexCompositeAttributes>;
+    gt: (skCompositeAttributes: CompositeAttributes) => QueryBranches<A,F,C,S, ResponseItem,IndexCompositeAttributes>;
+    gte: (skCompositeAttributes: CompositeAttributes) => QueryBranches<A,F,C,S, ResponseItem,IndexCompositeAttributes>;
+    lt: (skCompositeAttributes: CompositeAttributes) => QueryBranches<A,F,C,S, ResponseItem,IndexCompositeAttributes>;
+    lte: (skCompositeAttributes: CompositeAttributes) => QueryBranches<A,F,C,S, ResponseItem,IndexCompositeAttributes>;
+    begins: (skCompositeAttributes: CompositeAttributes) => QueryBranches<A,F,C,S, ResponseItem,IndexCompositeAttributes>;
+    go: GoQueryTerminal<A,F,C,S,ResponseItem>;
+    params: ParamTerminal<A,F,C,S,ResponseItem>;
+    page: PageQueryTerminal<A,F,C,S,ResponseItem,IndexCompositeAttributes>;
+    where: WhereClause<A,F,C,S,Item<A,F,C,S,S["attributes"]>,QueryBranches<A,F,C,S,ResponseItem,IndexCompositeAttributes>>
 }
 
 export type Queries<A extends string, F extends string, C extends string, S extends Schema<A,F,C>> = {
@@ -424,7 +438,7 @@ export type Queries<A extends string, F extends string, C extends string, S exte
         IndexSKAttributes<A,F,C,S,I> extends infer SK
             // If there is no SK, dont show query operations (when an empty array is provided)
             ? [keyof SK] extends [never]
-            ? RecordsActionOptions<A,F,C,S, ResponseItem<A,F,C,S>[], AllTableIndexCompositeAttributes<A,F,C,S> & Required<CompositeAttributes>>
+            ? QueryBranches<A,F,C,S, ResponseItem<A,F,C,S>, AllTableIndexCompositeAttributes<A,F,C,S> & Required<CompositeAttributes>>
             // If there is no SK, dont show query operations (When no PK is specified)
             : S["indexes"][I] extends IndexWithSortKey
                 ? QueryOperations<
@@ -434,7 +448,7 @@ export type Queries<A extends string, F extends string, C extends string, S exte
                     ResponseItem<A,F,C,S>,
                     AllTableIndexCompositeAttributes<A,F,C,S> & Required<CompositeAttributes> & SK
                     >
-                : RecordsActionOptions<A,F,C,S, ResponseItem<A,F,C,S>[], AllTableIndexCompositeAttributes<A,F,C,S> & Required<CompositeAttributes> & SK>
+                : QueryBranches<A,F,C,S, ResponseItem<A,F,C,S>, AllTableIndexCompositeAttributes<A,F,C,S> & Required<CompositeAttributes> & SK>
             : never
 }
 
@@ -464,7 +478,8 @@ export interface QueryOptions {
 }
 
 // subset of QueryOptions
-export interface ParseOptions {
+export interface ParseOptions<Attributes> {
+    attributes?: ReadonlyArray<Attributes>;
     ignoreOwnership?: boolean;
 }
 
@@ -510,6 +525,162 @@ export type OptionalDefaultEntityIdentifiers = {
     __edb_v__?: string;
 }
 
+interface GoBatchGetTerminalOptions<Attributes> {
+    raw?: boolean;
+    table?: string;
+    limit?: number;
+    params?: object;
+    includeKeys?: boolean;
+    originalErr?: boolean;
+    ignoreOwnership?: boolean;
+    pages?: number;
+    attributes?: ReadonlyArray<Attributes>;
+    unprocessed?: "raw" | "item";
+    concurrency?: number;
+    preserveBatchOrder?: boolean;
+    listeners?: Array<ElectroEventListener>;
+    logger?: ElectroEventListener;
+}
+
+interface GoQueryTerminalOptions<Attributes> {
+    raw?: boolean;
+    table?: string;
+    limit?: number;
+    params?: object;
+    includeKeys?: boolean;
+    originalErr?: boolean;
+    ignoreOwnership?: boolean;
+    pages?: number;
+    attributes?: ReadonlyArray<Attributes>;
+    listeners?: Array<ElectroEventListener>;
+    logger?: ElectroEventListener;
+}
+
+interface PageQueryTerminalOptions<Attributes> extends GoQueryTerminalOptions<Attributes> {
+    pager?: "raw" | "item" | "named";
+    raw?: boolean;
+    table?: string;
+    limit?: number;
+    includeKeys?: boolean;
+    originalErr?: boolean;
+    ignoreOwnership?: boolean;
+    attributes?: ReadonlyArray<Attributes>;
+    listeners?: Array<ElectroEventListener>;
+    logger?: ElectroEventListener;
+}
+
+export interface ParamTerminalOptions<Attributes> {
+    table?: string;
+    limit?: number;
+    params?: object;
+    originalErr?: boolean;
+    attributes?: ReadonlyArray<Attributes>;
+    response?: "default" | "none" | 'all_old' | 'updated_old' | 'all_new' | 'updated_new';
+}
+
+type GoBatchGetTerminal<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, ResponseItem> = <Options extends GoBatchGetTerminalOptions<keyof ResponseItem>>(options?: Options) =>
+    Options extends GoBatchGetTerminalOptions<infer Attr>
+        ? 'preserveBatchOrder' extends keyof Options
+            ? Options['preserveBatchOrder'] extends true
+                ? Promise<[
+                    Array<Resolve<{
+                        [
+                        Name in keyof ResponseItem as Name extends Attr
+                            ? Name
+                            : never
+                        ]: ResponseItem[Name]
+                    } | null>>, Array<Resolve<AllTableIndexCompositeAttributes<A,F,C,S>>>
+                ]>
+                : Promise<[
+                    Array<Resolve<{
+                        [
+                        Name in keyof ResponseItem as Name extends Attr
+                            ? Name
+                            : never
+                        ]: ResponseItem[Name]
+                    }>>, Array<Resolve<AllTableIndexCompositeAttributes<A,F,C,S>>>
+                ]>
+            : Promise<[
+                Array<Resolve<{
+                    [
+                    Name in keyof ResponseItem as Name extends Attr
+                        ? Name
+                        : never
+                    ]: ResponseItem[Name]
+                }>>, Array<Resolve<AllTableIndexCompositeAttributes<A,F,C,S>>>
+            ]>
+        : 'preserveBatchOrder' extends keyof Options
+            ? Options['preserveBatchOrder'] extends true
+                ? [Array<Resolve<ResponseItem | null>>, Array<Resolve<AllTableIndexCompositeAttributes<A,F,C,S>>>]
+                : [Array<Resolve<ResponseItem>>, Array<Resolve<AllTableIndexCompositeAttributes<A,F,C,S>>>]
+            : [Array<Resolve<ResponseItem>>, Array<Resolve<AllTableIndexCompositeAttributes<A,F,C,S>>>]
+
+type GoGetTerminal<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, ResponseItem> = <Options extends GoQueryTerminalOptions<keyof ResponseItem>>(options?: Options) =>
+    Options extends GoQueryTerminalOptions<infer Attr>
+        ? Promise<{
+            [
+            Name in keyof ResponseItem as Name extends Attr
+                ? Name
+                : never
+            ]: ResponseItem[Name]
+        } | null>
+        : Promise<ResponseItem | null>
+
+export type GoQueryTerminal<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, Item> = <Options extends GoQueryTerminalOptions<keyof Item>>(options?: Options) =>
+    Options extends GoQueryTerminalOptions<infer Attr>
+        ? Promise<Array<{
+            [
+            Name in keyof Item as Name extends Attr
+                ? Name
+                : never
+            ]: Item[Name]
+        }>>
+        : Promise<Array<Item>>
+
+export type EntityParseSingleItem<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, ResponseItem> =
+    <Options extends ParseOptions<keyof ResponseItem>>(item: ParseSingleInput, options?: Options) =>
+        Options extends ParseOptions<infer Attr>
+            ? {
+                [
+                Name in keyof ResponseItem as Name extends Attr
+                    ? Name
+                    : never
+                ]: ResponseItem[Name]
+            } | null
+            : ResponseItem | null
+
+export type EntityParseMultipleItems<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, ResponseItem> =
+    <Options extends ParseOptions<keyof ResponseItem>>(item: ParseMultiInput, options?: Options) =>
+        Options extends ParseOptions<infer Attr>
+            ? Array<{
+                [
+                Name in keyof ResponseItem as Name extends Attr
+                    ? Name
+                    : never
+                ]: ResponseItem[Name]
+            }>
+            : Array<ResponseItem>
+
+
+export type PageQueryTerminal<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, Item, CompositeAttributes> = <Options extends PageQueryTerminalOptions<keyof Item>>(page?: (CompositeAttributes & OptionalDefaultEntityIdentifiers) | null, options?: Options) =>
+    Options extends GoQueryTerminalOptions<infer Attr>
+        ? Promise<[
+            (CompositeAttributes & OptionalDefaultEntityIdentifiers) | null,
+            Array<{
+                [
+                Name in keyof Item as Name extends Attr
+                    ? Name
+                    : never
+                ]: Item[Name]
+            }>
+        ]>
+        : Promise<[
+            (CompositeAttributes & OptionalDefaultEntityIdentifiers) | null,
+            Array<ResponseType>
+        ]>;
+
+export type ParamTerminal<A extends string, F extends string, C extends string, S extends Schema<A,F,C>, ResponseItem> = <P extends any = any, Options extends ParamTerminalOptions<keyof ResponseItem> = ParamTerminalOptions<keyof ResponseItem>>(options?: Options) => P;
+
 export type GoRecord<ResponseType, Options = QueryOptions> = <T = ResponseType>(options?: Options) => Promise<T>;
 
 export type BatchGoRecord<ResponseType, AlternateResponseType> = <O extends BulkOptions>(options?: O) =>
@@ -678,7 +849,6 @@ export interface NestedEnumAttribute {
     readonly label?: string;
 }
 
-
 export interface EnumAttribute {
     readonly type: ReadonlyArray<string>;
     readonly required?: boolean;
@@ -862,6 +1032,60 @@ export interface NestedStringSetAttribute {
     readonly field?: string;
 }
 
+export interface NestedEnumNumberSetAttribute {
+    readonly type: "set";
+    readonly items: ReadonlyArray<number>;
+    readonly required?: boolean;
+    readonly hidden?: boolean;
+    readonly readOnly?: boolean;
+    readonly get?: (val: Array<number>, item: any) => Array<number> | undefined | void;
+    readonly set?: (val?: Array<number>, item?: any) => Array<number> | undefined | void;
+    readonly default?: Array<number> | (() => Array<number>);
+    readonly validate?: ((val: Array<number>) => boolean) | ((val: Array<number>) => void) | ((val: Array<number>) => string | void) | RegExp;
+    readonly field?: string;
+}
+
+export interface EnumNumberSetAttribute {
+    readonly type: "set";
+    readonly items: ReadonlyArray<number>;
+    readonly required?: boolean;
+    readonly hidden?: boolean;
+    readonly readOnly?: boolean;
+    readonly get?: (val: Array<number>, item: any) => Array<number> | undefined | void;
+    readonly set?: (val?: Array<number>, item?: any) => Array<number> | undefined | void;
+    readonly default?: Array<number> | (() => Array<number>);
+    readonly validate?: ((val: Array<number>) => boolean) | ((val: Array<number>) => void) | ((val: Array<number>) => string | void) | RegExp;
+    readonly field?: string;
+    readonly watch?: ReadonlyArray<string> | "*";
+}
+
+export interface NestedEnumStringSetAttribute {
+    readonly type: "set";
+    readonly items: ReadonlyArray<string>;
+    readonly required?: boolean;
+    readonly hidden?: boolean;
+    readonly readOnly?: boolean;
+    readonly get?: (val: Array<string>, item: any) => Array<string> | undefined | void;
+    readonly set?: (val?: Array<string>, item?: any) => Array<string> | undefined | void;
+    readonly default?: Array<string> | (() => Array<string>);
+    readonly validate?: ((val: Array<string>) => boolean) | ((val: Array<string>) => void) | ((val: Array<string>) => string | void) | RegExp;
+    readonly field?: string;
+}
+
+export interface EnumStringSetAttribute {
+    readonly type: "set";
+    readonly items: ReadonlyArray<string>;
+    readonly required?: boolean;
+    readonly hidden?: boolean;
+    readonly readOnly?: boolean;
+    readonly get?: (val: Array<string>, item: any) => Array<string> | undefined | void;
+    readonly set?: (val?: Array<string>, item?: any) => Array<string> | undefined | void;
+    readonly default?: Array<string> | (() => Array<string>);
+    readonly validate?: ((val: Array<string>) => boolean) | ((val: Array<string>) => void) | ((val: Array<string>) => string | void) | RegExp;
+    readonly field?: string;
+    readonly watch?: ReadonlyArray<string> | "*";
+}
+
 export interface StringSetAttribute {
     readonly type: "set";
     readonly items: "string";
@@ -903,6 +1127,25 @@ export interface NumberSetAttribute {
     readonly watch?: ReadonlyArray<string> | "*";
 }
 
+type StaticAttribute = {
+    readonly type: "static";
+    readonly hidden?: boolean;
+    value: string | number | boolean;
+    readonly field?: string;
+}
+
+type CustomAttribute<T extends any = any> = {
+    readonly type: "custom";
+    readonly [CustomAttributeSymbol]: T;
+    readonly hidden?: boolean;
+    readonly get?: (val: T, item: any) => T | undefined | void;
+    readonly set?: (val?: T, item?: any) => T | undefined | void;
+    readonly default?: T | (() => T);
+    readonly validate?: ((val: T) => boolean) | ((val: T) => void) | ((val: T) => string | void);
+    readonly field?: string;
+    readonly watch?: ReadonlyArray<string> | "*";
+};
+
 export type Attribute =
     BooleanAttribute
     | NumberAttribute
@@ -914,7 +1157,11 @@ export type Attribute =
     | NumberSetAttribute
     | StringListAttribute
     | NumberListAttribute
-    | MapListAttribute;
+    | MapListAttribute
+    | StaticAttribute
+    | CustomAttribute
+    | EnumNumberSetAttribute
+    | EnumStringSetAttribute;
 
 export type NestedAttributes =
     NestedBooleanAttribute
@@ -927,7 +1174,10 @@ export type NestedAttributes =
     | NestedMapListAttribute
     | NestedStringSetAttribute
     | NestedNumberSetAttribute
-    | NestedEnumAttribute;
+    | NestedEnumAttribute
+    | NestedEnumAttribute
+    | NestedEnumNumberSetAttribute
+    | NestedEnumStringSetAttribute;
 
 export interface IndexWithSortKey {
     readonly sk: {
@@ -1001,7 +1251,9 @@ type PartialDefinedKeys<T> = {
 }
 
 export type ItemAttribute<A extends Attribute> =
-    A["type"] extends infer R
+    A extends CustomAttribute<infer T>
+        ? T
+    : A["type"] extends infer R
         ? R extends "string" ? string
         : R extends "number" ? number
             : R extends "boolean" ? boolean
@@ -1030,28 +1282,20 @@ export type ItemAttribute<A extends Attribute> =
                                     ? A["items"] extends infer I
                                         ? I extends "string" ? string[]
                                             : I extends "number" ? number[]
-                                                : never
+                                                : I extends ReadonlyArray<infer ENUM> ? ENUM[]
+                                                    : never
                                         : never
                                     : never
                                 : R extends "any" ? any
                                     : never
         : never
 
-type FormattedPutMapAttributes<A extends MapAttribute> = {
-    [P in keyof A["properties"]]: A["properties"][P] extends infer M
-        ? M extends HiddenAttribute
-            ? false
-            : M extends DefaultedAttribute
-                ? false
-                : M extends RequiredAttribute
-                    ? true
-                    : false
-        : false
-}
-
 export type ReturnedAttribute<A extends Attribute> =
-    A["type"] extends infer R
-        ? R extends "string" ? string
+    A extends CustomAttribute<infer T>
+    ? T
+    : A["type"] extends infer R
+        ? R extends "static" ? never
+        : R extends "string" ? string
         : R extends "number" ? number
             : R extends "boolean" ? boolean
                 : R extends ReadonlyArray<infer E> ? E
@@ -1079,27 +1323,6 @@ export type ReturnedAttribute<A extends Attribute> =
                                     : never
                                 : never
                         }
-                            // SkipKeys<{
-                            //     [P in keyof A["properties"]]: A["properties"][P] extends infer M
-                            //         ? M extends Attribute
-                            //           ? M extends HiddenAttribute
-                            //             ? SkipValue
-                            //             : M extends RequiredAttribute
-                            //                 ? ReturnedAttribute<M>
-                            //                 : SkipValue
-                            //             : never
-                            //           : never
-                            // }> & SkipKeys<{
-                            //   [P in keyof A["properties"]]?: A["properties"][P] extends infer M
-                            //         ? M extends Attribute
-                            //           ? M extends HiddenAttribute
-                            //             ? SkipValue
-                            //             : M extends RequiredAttribute
-                            //                 ? SkipValue
-                            //                 : ReturnedAttribute<M> | undefined
-                            //             : never
-                            //           : never
-                            // }>
                             : never
                         : R extends "list"
                             ? "items" extends keyof A
@@ -1114,7 +1337,8 @@ export type ReturnedAttribute<A extends Attribute> =
                                     ? A["items"] extends infer I
                                         ? I extends "string" ? string[]
                                             : I extends "number" ? number[]
-                                                : never
+                                                : I extends ReadonlyArray<infer ENUM> ? ENUM[]
+                                                    : never
                                         : never
                                     : never
                                 : R extends "any" ? any
@@ -1122,8 +1346,11 @@ export type ReturnedAttribute<A extends Attribute> =
         : never
 
 export type CreatedAttribute<A extends Attribute> =
-    A["type"] extends infer R
-        ? R extends "string" ? string
+    A extends CustomAttribute<infer T>
+        ? T
+        : A["type"] extends infer R
+        ? R extends "static" ? never
+        : R extends "string" ? string
         : R extends "number" ? number
             : R extends "boolean" ? boolean
                 : R extends ReadonlyArray<infer E> ? E
@@ -1151,27 +1378,6 @@ export type CreatedAttribute<A extends Attribute> =
                                     : never
                                 : never
                         }
-                            // ? SkipKeys<{
-                            //     [P in keyof A["properties"]]: A["properties"][P] extends infer M
-                            //         ? M extends Attribute
-                            //             ? M extends HiddenAttribute
-                            //               ? SkipValue
-                            //               : M extends DefaultedAttribute
-                            //                   ? SkipValue
-                            //                   : M extends RequiredAttribute
-                            //                       ? CreatedAttribute<M>
-                            //                       : SkipValue
-                            //             : never
-                            //     : never
-                            // }> & SkipKeys<{
-                            //   [P in keyof A["properties"]]?: A["properties"][P] extends infer M
-                            //     ? M extends Attribute
-                            //       ? M extends HiddenAttribute
-                            //         ? SkipValue
-                            //         : CreatedAttribute<M> | undefined
-                            //       : never
-                            //     : never
-                            // }>
                             : never
                         : R extends "list"
                             ? "items" extends keyof A
@@ -1186,7 +1392,8 @@ export type CreatedAttribute<A extends Attribute> =
                                     ? A["items"] extends infer I
                                         ? I extends "string" ? string[]
                                             : I extends "number" ? number[]
-                                                : never
+                                                : I extends ReadonlyArray<infer ENUM> ? ENUM[]
+                                                    : never
                                         : never
                                     : never
                                 : R extends "any" ? any
@@ -1202,10 +1409,13 @@ export type CreatedItem<A extends string, F extends string, C extends string, S
 }
 
 export type EditableItemAttribute<A extends Attribute> =
-    A extends ReadOnlyAttribute
+    A extends CustomAttribute<infer T>
+    ? T
+    : A extends ReadOnlyAttribute
         ? never
         : A["type"] extends infer R
-        ? R extends "string" ? string
+            ? R extends "static" ? never
+                : R extends "string" ? string
             : R extends "number" ? number
                 : R extends "boolean" ? boolean
                     : R extends ReadonlyArray<infer E> ? E
@@ -1237,7 +1447,8 @@ export type EditableItemAttribute<A extends Attribute> =
                                         ? A["items"] extends infer I
                                             ? I extends "string" ? string[]
                                                 : I extends "number" ? number[]
-                                                    : never
+                                                    : I extends ReadonlyArray<infer ENUM> ? ENUM[]
+                                                        : never
                                             : never
                                         : never
                                     : R extends "any" ? any
@@ -1245,10 +1456,13 @@ export type EditableItemAttribute<A extends Attribute> =
         : never
 
 export type UpdatableItemAttribute<A extends Attribute> =
-    A extends ReadOnlyAttribute
+    A extends CustomAttribute<infer T>
+        ? T
+        : A extends ReadOnlyAttribute
         ? never
         : A["type"] extends infer R
-        ? R extends "string" ? string
+            ? R extends "static" ? never
+                : R extends "string" ? string
             : R extends "number" ? number
                 : R extends "boolean" ? boolean
                     : R extends ReadonlyArray<infer E> ? E
@@ -1295,7 +1509,8 @@ export type UpdatableItemAttribute<A extends Attribute> =
                                         ? A["items"] extends infer I
                                             ? I extends "string" ? string[]
                                                 : I extends "number" ? number[]
-                                                    : never
+                                                    : I extends ReadonlyArray<infer ENUM> ? ENUM[]
+                                                        : never
                                             : never
                                         : never
                                     : R extends "any" ? any
@@ -1303,10 +1518,13 @@ export type UpdatableItemAttribute<A extends Attribute> =
         : never
 
 export type RemovableItemAttribute<A extends Attribute> =
-    A extends ReadOnlyAttribute | RequiredAttribute
+    A extends CustomAttribute<infer T>
+        ? T
+        : A extends ReadOnlyAttribute | RequiredAttribute
         ? never
         : A["type"] extends infer R
-        ? R extends "string" ? string
+            ? R extends "static" ? never
+                : R extends "string" ? string
             : R extends "number" ? number
                 : R extends "boolean" ? boolean
                     : R extends ReadonlyArray<infer E> ? E
@@ -1338,7 +1556,8 @@ export type RemovableItemAttribute<A extends Attribute> =
                                         ? A["items"] extends infer I
                                             ? I extends "string" ? string[]
                                                 : I extends "number" ? number[]
-                                                    : never
+                                                    : I extends ReadonlyArray<infer ENUM> ? ENUM[]
+                                                        : never
                                             : never
                                         : never
                                     : R extends "any" ? any
@@ -1483,7 +1702,7 @@ export type RemoveItem<A extends string, F extends string, C extends string, S e
 export type AppendItem<A extends string, F extends string, C extends string, S extends Schema<A,F,C>> =
     {
         [
-        P in keyof ItemTypeDescription<A,F,C,S> as ItemTypeDescription<A,F,C,S>[P] extends 'list' | 'any'
+        P in keyof ItemTypeDescription<A,F,C,S> as ItemTypeDescription<A,F,C,S>[P] extends 'list' | 'any' | 'custom'
             ? P
             : never
         ]?: P extends keyof SetItem<A,F,C,S>
@@ -1494,7 +1713,7 @@ export type AppendItem<A extends string, F extends string, C extends string, S e
 export type AddItem<A extends string, F extends string, C extends string, S extends Schema<A,F,C>> =
     {
         [
-        P in keyof ItemTypeDescription<A,F,C,S> as ItemTypeDescription<A,F,C,S>[P] extends "number" | "any" | "set"
+        P in keyof ItemTypeDescription<A,F,C,S> as ItemTypeDescription<A,F,C,S>[P] extends 'number' | 'any' | 'set' | 'custom'
             ? P
             : never
         ]?: P extends keyof SetItem<A,F,C,S>
@@ -1505,7 +1724,7 @@ export type AddItem<A extends string, F extends string, C extends string, S exte
 export type SubtractItem<A extends string, F extends string, C extends string, S extends Schema<A,F,C>> =
     {
         [
-        P in keyof ItemTypeDescription<A,F,C,S> as ItemTypeDescription<A,F,C,S>[P] extends "number" | "any"
+        P in keyof ItemTypeDescription<A,F,C,S> as ItemTypeDescription<A,F,C,S>[P] extends 'number' | 'any' | 'custom'
             ? P
             : never
         ]?: P extends keyof SetItem<A,F,C,S>
@@ -1516,7 +1735,7 @@ export type SubtractItem<A extends string, F extends string, C extends string, S
 export type DeleteItem<A extends string, F extends string, C extends string, S extends Schema<A,F,C>> =
     {
         [
-        P in keyof ItemTypeDescription<A,F,C,S> as ItemTypeDescription<A,F,C,S>[P] extends "any" | "set"
+        P in keyof ItemTypeDescription<A,F,C,S> as ItemTypeDescription<A,F,C,S>[P] extends 'any' | 'set' | 'custom'
             ? P
             : never
         ]?: P extends keyof SetItem<A,F,C,S>
@@ -1526,6 +1745,7 @@ export type DeleteItem<A extends string, F extends string, C extends string, S e
 
 export declare const WhereSymbol: unique symbol;
 export declare const UpdateDataSymbol: unique symbol;
+export declare const CustomAttributeSymbol: unique symbol;
 
 export type WhereAttributeSymbol<T extends any> =
         { [WhereSymbol]: void }
@@ -1632,9 +1852,8 @@ export class Entity<A extends string, F extends string, C extends string, S exte
     private config?: EntityConfiguration;
     constructor(schema: S, config?: EntityConfiguration);
 
-    get(key: AllTableIndexCompositeAttributes<A,F,C,S>): SingleRecordOperationOptions<A,F,C,S, ResponseItem<A,F,C,S> | null>;
-    get(key: AllTableIndexCompositeAttributes<A,F,C,S>[]): BulkRecordOperationOptions<A,F,C,S, [Array<Resolve<ResponseItem<A,F,C,S>>>, Array<Resolve<AllTableIndexCompositeAttributes<A,F,C,S>>>], [Array<Resolve<ResponseItem<A,F,C,S>> | null>, Array<Resolve<AllTableIndexCompositeAttributes<A,F,C,S>>>]>;
-
+    get(key: AllTableIndexCompositeAttributes<A,F,C,S>): SingleRecordOperationOptions<A,F,C,S, ResponseItem<A,F,C,S>>;
+    get(key: AllTableIndexCompositeAttributes<A,F,C,S>[]): BatchGetRecordOperationOptions<A,F,C,S, ResponseItem<A,F,C,S>>;
     delete(key: AllTableIndexCompositeAttributes<A,F,C,S>): DeleteRecordOperationOptions<A,F,C,S, ResponseItem<A,F,C,S>>;
     delete(key: AllTableIndexCompositeAttributes<A,F,C,S>[]): BulkRecordOperationOptions<A,F,C,S, AllTableIndexCompositeAttributes<A,F,C,S>[], AllTableIndexCompositeAttributes<A,F,C,S>[]>;
 
@@ -1671,8 +1890,26 @@ export class Entity<A extends string, F extends string, C extends string, S exte
     scan: RecordsActionOptions<A,F,C,S, ResponseItem<A,F,C,S>[], TableIndexCompositeAttributes<A,F,C,S>>;
     query: Queries<A,F,C,S>;
 
-    parse(item: ParseSingleInput, options?: ParseOptions): ResponseItem<A,F,C,S> | null;
-    parse(item: ParseMultiInput, options?: ParseOptions): ResponseItem<A,F,C,S>[];
+    parse<Options extends ParseOptions<keyof ResponseItem<A,F,C,S>>>(item: ParseSingleInput, options?: Options):
+        Options extends ParseOptions<infer Attr>
+        ? {
+                [
+                Name in keyof ResponseItem<A,F,C,S> as Name extends Attr
+                    ? Name
+                    : never
+            ]: ResponseItem<A,F,C,S>[Name]
+        } | null
+        : ResponseItem<A,F,C,S> | null
+    parse<Options extends ParseOptions<keyof ResponseItem<A,F,C,S>>>(item: ParseMultiInput, options?: Options):
+            Options extends ParseOptions<infer Attr>
+        ? Array<{
+            [
+                Name in keyof ResponseItem<A,F,C,S> as Name extends Attr
+                    ? Name
+                    : never
+            ]: ResponseItem<A,F,C,S>[Name]
+        }>
+        : Array<ResponseItem<A,F,C,S>>
     setIdentifier(type: "entity" | "version", value: string): void;
     client: any;
 }
@@ -1688,4 +1925,18 @@ export class Service<E extends {[name: string]: Entity<any, any, any, any>}> {
     entities: E;
     collections: CollectionQueries<E, CollectionAssociations<E>>
     constructor(entities: E, config?: ServiceConfiguration);
-}
+}
+
+type CustomAttributeDefinition<T> = {
+    readonly required?: boolean;
+    readonly hidden?: boolean;
+    readonly readOnly?: boolean;
+    readonly get?: (val: T, item: any) => T | undefined | void;
+    readonly set?: (val?: T, item?: any) => T | undefined | void;
+    readonly default?: T | (() => T);
+    readonly validate?: ((val: T) => boolean) | ((val: T) => void) | ((val: T) => string | void);
+    readonly field?: string;
+    readonly watch?: ReadonlyArray<string> | "*";
+}
+
+declare function createCustomAttribute<T>(definition?: CustomAttributeDefinition<T>): CustomAttribute<T>;