1 | import { Model } from "./Model";
|
2 | import { Schema } from "./Schema";
|
3 | import { DynamoDB, AWSError } from "aws-sdk";
|
4 | import { CallbackType, ObjectType } from "./General";
|
5 | import { SerializerOptions } from "./Serializer";
|
6 | import { PopulateSettings } from "./Populate";
|
7 | import { Condition } from "./Condition";
|
8 | export interface DocumentSaveSettings {
|
9 | overwrite?: boolean;
|
10 | return?: "request" | "document";
|
11 | condition?: Condition;
|
12 | }
|
13 | export interface DocumentSettings {
|
14 | type?: "fromDynamo" | "toDynamo";
|
15 | }
|
16 | export declare class Document {
|
17 | constructor(model: Model<Document>, object?: DynamoDB.AttributeMap | ObjectType, settings?: DocumentSettings);
|
18 | model?: Model<Document>;
|
19 | static objectToDynamo(object: ObjectType): DynamoDB.AttributeMap;
|
20 | static objectToDynamo(object: any, settings: {
|
21 | type: "value";
|
22 | }): DynamoDB.AttributeValue;
|
23 | static objectToDynamo(object: ObjectType, settings: {
|
24 | type: "object";
|
25 | }): DynamoDB.AttributeMap;
|
26 | static fromDynamo(object: DynamoDB.AttributeMap): ObjectType;
|
27 | static isDynamoObject(object: ObjectType, recurrsive?: boolean): boolean | null;
|
28 | static attributesWithSchema: (document: Document, model: Model<Document>) => Promise<string[]>;
|
29 | static objectFromSchema: (object: any, model: Model<Document>, settings?: DocumentObjectFromSchemaSettings) => Promise<any>;
|
30 | static prepareForObjectFromSchema: (object: any, model: Model<Document>, settings: DocumentObjectFromSchemaSettings) => any;
|
31 | conformToSchema: (this: Document, settings?: DocumentObjectFromSchemaSettings) => Promise<Document>;
|
32 | toDynamo: (this: Document, settings?: Partial<DocumentObjectFromSchemaSettings>) => Promise<any>;
|
33 | prepareForResponse(): Promise<Document>;
|
34 | original(): ObjectType | null;
|
35 | toJSON(): ObjectType;
|
36 | serialize(nameOrOptions?: SerializerOptions | string): ObjectType;
|
37 | delete(this: Document): Promise<void>;
|
38 | delete(this: Document, callback: CallbackType<void, AWSError>): void;
|
39 | save(this: Document): Promise<Document>;
|
40 | save(this: Document, callback: CallbackType<Document, AWSError>): void;
|
41 | save(this: Document, settings: DocumentSaveSettings & {
|
42 | return: "request";
|
43 | }): Promise<DynamoDB.PutItemInput>;
|
44 | save(this: Document, settings: DocumentSaveSettings & {
|
45 | return: "request";
|
46 | }, callback: CallbackType<DynamoDB.PutItemInput, AWSError>): void;
|
47 | save(this: Document, settings: DocumentSaveSettings & {
|
48 | return: "document";
|
49 | }): Promise<Document>;
|
50 | save(this: Document, settings: DocumentSaveSettings & {
|
51 | return: "document";
|
52 | }, callback: CallbackType<Document, AWSError>): void;
|
53 | populate(): Promise<Document>;
|
54 | populate(callback: CallbackType<Document, AWSError>): void;
|
55 | populate(settings: PopulateSettings): Promise<Document>;
|
56 | populate(settings: PopulateSettings, callback: CallbackType<Document, AWSError>): void;
|
57 | }
|
58 | export declare class AnyDocument extends Document {
|
59 | [key: string]: any;
|
60 | }
|
61 | export interface DocumentObjectFromSchemaSettings {
|
62 | type: "toDynamo" | "fromDynamo";
|
63 | schema?: Schema;
|
64 | checkExpiredItem?: boolean;
|
65 | saveUnknown?: boolean;
|
66 | defaults?: boolean;
|
67 | forceDefault?: boolean;
|
68 | customTypesDynamo?: boolean;
|
69 | validate?: boolean;
|
70 | required?: boolean | "nested";
|
71 | enum?: boolean;
|
72 | populate?: boolean;
|
73 | combine?: boolean;
|
74 | modifiers?: ("set" | "get")[];
|
75 | updateTimestamps?: boolean | {
|
76 | updatedAt?: boolean;
|
77 | createdAt?: boolean;
|
78 | };
|
79 | }
|