@rushdb/javascript-sdk 0.17.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +75 -59
- package/dist/api/api.d.ts +260 -19
- package/dist/api/index.d.ts +0 -1
- package/dist/api/rest-api-proxy.d.ts +1 -1
- package/dist/api/types.d.ts +0 -60
- package/dist/api/utils.d.ts +3 -33
- package/dist/common/constants.d.ts +2 -0
- package/dist/common/utils.d.ts +4 -2
- package/dist/index.cjs +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.node.d.ts +492 -69
- package/dist/index.worker.d.ts +492 -69
- package/dist/network/HttpClient.d.ts +1 -1
- package/dist/network/types.d.ts +3 -2
- package/dist/sdk/errors.d.ts +2 -1
- package/dist/sdk/model.d.ts +160 -20
- package/dist/sdk/record.d.ts +23 -67
- package/dist/sdk/sdk.d.ts +465 -42
- package/dist/sdk/utils.d.ts +2 -2
- package/dist/types/expressions.d.ts +11 -2
- package/dist/types/query.d.ts +8 -3
- package/dist/types/schema.d.ts +6 -4
- package/dist/types/utils.d.ts +2 -0
- package/dist/types/value.d.ts +18 -11
- package/package.json +1 -1
- package/dist/api/create-api.d.ts +0 -66
package/dist/sdk/sdk.d.ts
CHANGED
|
@@ -15,34 +15,175 @@ export declare const initSDK: (httpClient: HttpClient) => {
|
|
|
15
15
|
readonly __label: string;
|
|
16
16
|
readonly __proptypes?: import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysRead<S>]: S[Key]["type"]; } & { [Key_1 in import("../types/schema.js").OptionalKeysRead<S>]?: S[Key_1]["type"] | undefined; }> | undefined;
|
|
17
17
|
} & import("../types/utils.js").FlattenTypes<import("./record.js").RecordProps<S>>>): DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>;
|
|
18
|
-
api: ReturnType<typeof import("../api/create-api.js").createApi>;
|
|
19
18
|
fetcher: ReturnType<typeof import("../network/index.js").createFetcher>;
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
19
|
+
options: SDKConfig["options"];
|
|
20
|
+
logger: SDKConfig["logger"];
|
|
21
|
+
_extractTargetIds(target: import("./record.js").RelationTarget, operation: string): Array<string>;
|
|
22
|
+
records: {
|
|
23
|
+
attach: ({ source, target, options }: {
|
|
24
|
+
source: import("./record.js").DBRecordTarget;
|
|
25
|
+
target: import("./record.js").RelationTarget;
|
|
26
|
+
options?: import("./record.js").RelationOptions;
|
|
27
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
28
|
+
message: string;
|
|
29
|
+
}>>;
|
|
30
|
+
detach: ({ source, target, options }: {
|
|
31
|
+
source: import("./record.js").DBRecordTarget;
|
|
32
|
+
target: import("./record.js").RelationTarget;
|
|
33
|
+
options?: import("./record.js").RelationDetachOptions;
|
|
34
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
35
|
+
message: string;
|
|
36
|
+
}>>;
|
|
37
|
+
create: <S extends Schema = any>({ label, data, options }: {
|
|
38
|
+
label: string;
|
|
39
|
+
data: import("../types/value.js").PropertyDraft[] | import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
40
|
+
boolean: boolean;
|
|
41
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
42
|
+
null: null;
|
|
43
|
+
number: number;
|
|
44
|
+
string: string;
|
|
45
|
+
vector: Array<number>;
|
|
46
|
+
}[S[Key]["type"]][] : {
|
|
47
|
+
boolean: boolean;
|
|
48
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
49
|
+
null: null;
|
|
50
|
+
number: number;
|
|
51
|
+
string: string;
|
|
52
|
+
vector: Array<number>;
|
|
53
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
54
|
+
boolean: boolean;
|
|
55
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
56
|
+
null: null;
|
|
57
|
+
number: number;
|
|
58
|
+
string: string;
|
|
59
|
+
vector: Array<number>;
|
|
60
|
+
}[S[Key_1]["type"]][] : {
|
|
61
|
+
boolean: boolean;
|
|
62
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
63
|
+
null: null;
|
|
64
|
+
number: number;
|
|
65
|
+
string: string;
|
|
66
|
+
vector: Array<number>;
|
|
67
|
+
}[S[Key_1]["type"]]) | undefined; }>;
|
|
68
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
69
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
70
|
+
createMany: <S extends Schema = any>(data: {
|
|
71
|
+
label: string;
|
|
72
|
+
data: import("../types/utils.js").MaybeArray<import("../types/utils.js").AnyObject>;
|
|
73
|
+
options?: import("./record.js").DBRecordCreationOptions;
|
|
74
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("./record.js").DBRecordsArrayInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
75
|
+
delete: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
76
|
+
message: string;
|
|
77
|
+
}>>;
|
|
78
|
+
deleteById: (idOrIds: import("../types/utils.js").MaybeArray<string>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
79
|
+
message: string;
|
|
80
|
+
}>>;
|
|
81
|
+
export: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
82
|
+
dateTime: string;
|
|
83
|
+
fileContent: string;
|
|
84
|
+
}>>;
|
|
85
|
+
find: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQueryWithEntryPoint: Q & {
|
|
86
|
+
id?: string;
|
|
87
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("./record.js").DBRecordsArrayInstance<S, Q>>;
|
|
88
|
+
findById: <S extends Schema = Schema, Arg extends import("../types/utils.js").MaybeArray<string> = import("../types/utils.js").MaybeArray<string>, Result = Arg extends string[] ? import("./record.js").DBRecordsArrayInstance<S, import("../types/query.js").SearchQuery<S>> : DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>(idOrIds: Arg, transaction?: import("./transaction.js").Transaction | string) => Promise<Result>;
|
|
89
|
+
findOne: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQuery: Q, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
90
|
+
findUniq: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQuery: Q, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, Q>>;
|
|
91
|
+
set: <S extends Schema = any>({ target, label, data, options }: {
|
|
92
|
+
target: import("./record.js").DBRecordTarget;
|
|
93
|
+
label: string;
|
|
94
|
+
data: import("../types/value.js").PropertyDraft[] | import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
95
|
+
boolean: boolean;
|
|
96
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
97
|
+
null: null;
|
|
98
|
+
number: number;
|
|
99
|
+
string: string;
|
|
100
|
+
vector: Array<number>;
|
|
101
|
+
}[S[Key]["type"]][] : {
|
|
102
|
+
boolean: boolean;
|
|
103
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
104
|
+
null: null;
|
|
105
|
+
number: number;
|
|
106
|
+
string: string;
|
|
107
|
+
vector: Array<number>;
|
|
108
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
109
|
+
boolean: boolean;
|
|
110
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
111
|
+
null: null;
|
|
112
|
+
number: number;
|
|
113
|
+
string: string;
|
|
114
|
+
vector: Array<number>;
|
|
115
|
+
}[S[Key_1]["type"]][] : {
|
|
116
|
+
boolean: boolean;
|
|
117
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
118
|
+
null: null;
|
|
119
|
+
number: number;
|
|
120
|
+
string: string;
|
|
121
|
+
vector: Array<number>;
|
|
122
|
+
}[S[Key_1]["type"]]) | undefined; }>;
|
|
123
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
124
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
125
|
+
update: <S extends Schema = any>({ target, label, data, options }: {
|
|
126
|
+
target: import("./record.js").DBRecordTarget;
|
|
127
|
+
label: string;
|
|
128
|
+
data: import("../types/value.js").PropertyDraft[] | Partial<import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
129
|
+
boolean: boolean;
|
|
130
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
131
|
+
null: null;
|
|
132
|
+
number: number;
|
|
133
|
+
string: string;
|
|
134
|
+
vector: Array<number>;
|
|
135
|
+
}[S[Key]["type"]][] : {
|
|
136
|
+
boolean: boolean;
|
|
137
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
138
|
+
null: null;
|
|
139
|
+
number: number;
|
|
140
|
+
string: string;
|
|
141
|
+
vector: Array<number>;
|
|
142
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
143
|
+
boolean: boolean;
|
|
144
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
145
|
+
null: null;
|
|
146
|
+
number: number;
|
|
147
|
+
string: string;
|
|
148
|
+
vector: Array<number>;
|
|
149
|
+
}[S[Key_1]["type"]][] : {
|
|
150
|
+
boolean: boolean;
|
|
151
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
152
|
+
null: null;
|
|
153
|
+
number: number;
|
|
154
|
+
string: string;
|
|
155
|
+
vector: Array<number>;
|
|
156
|
+
}[S[Key_1]["type"]]) | undefined; }>>;
|
|
157
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
158
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
159
|
+
};
|
|
160
|
+
relationships: {
|
|
161
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("./record.js").Relation[]>>;
|
|
27
162
|
};
|
|
28
163
|
properties: {
|
|
29
164
|
delete: (id: string, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property>>;
|
|
30
|
-
find: <S extends Schema = any>(
|
|
165
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property[]>>;
|
|
31
166
|
findById: (id: string, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property>>;
|
|
32
|
-
values: (id: string, options?: import("../types/value.js").PropertyValuesOptions, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<
|
|
167
|
+
values: (id: string, options?: import("../types/value.js").PropertyValuesOptions, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
168
|
+
metadata?: string;
|
|
169
|
+
name: string;
|
|
170
|
+
type: import("../types/value.js").PropertyType;
|
|
171
|
+
} & {
|
|
172
|
+
id: string;
|
|
173
|
+
} & import("../types/value.js").PropertyValuesData>>;
|
|
33
174
|
};
|
|
34
175
|
labels: {
|
|
35
|
-
find: <S extends Schema = any>(
|
|
176
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<Record<string, number>>>;
|
|
36
177
|
};
|
|
37
178
|
tx: {
|
|
38
179
|
begin: (config?: Partial<{
|
|
39
180
|
ttl: number;
|
|
40
181
|
}>) => Promise<import("./transaction.js").Transaction>;
|
|
41
|
-
commit: (
|
|
182
|
+
commit: (tx: string | import("./transaction.js").Transaction) => Promise<import("../index.node.js").ApiResponse<{
|
|
42
183
|
message: string;
|
|
43
184
|
}>>;
|
|
44
|
-
get: (
|
|
45
|
-
rollback: (
|
|
185
|
+
get: (tx: string | import("./transaction.js").Transaction) => Promise<import("./transaction.js").Transaction>;
|
|
186
|
+
rollback: (tx: string | import("./transaction.js").Transaction) => Promise<import("../index.node.js").ApiResponse<{
|
|
46
187
|
message: string;
|
|
47
188
|
}>>;
|
|
48
189
|
};
|
|
@@ -58,34 +199,175 @@ export declare const initSDK: (httpClient: HttpClient) => {
|
|
|
58
199
|
readonly __label: string;
|
|
59
200
|
readonly __proptypes?: import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysRead<S>]: S[Key]["type"]; } & { [Key_1 in import("../types/schema.js").OptionalKeysRead<S>]?: S[Key_1]["type"] | undefined; }> | undefined;
|
|
60
201
|
} & import("../types/utils.js").FlattenTypes<import("./record.js").RecordProps<S>>>): DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>;
|
|
61
|
-
api: ReturnType<typeof import("../api/create-api.js").createApi>;
|
|
62
202
|
fetcher: ReturnType<typeof import("../network/index.js").createFetcher>;
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
203
|
+
options: SDKConfig["options"];
|
|
204
|
+
logger: SDKConfig["logger"];
|
|
205
|
+
_extractTargetIds(target: import("./record.js").RelationTarget, operation: string): Array<string>;
|
|
206
|
+
records: {
|
|
207
|
+
attach: ({ source, target, options }: {
|
|
208
|
+
source: import("./record.js").DBRecordTarget;
|
|
209
|
+
target: import("./record.js").RelationTarget;
|
|
210
|
+
options?: import("./record.js").RelationOptions;
|
|
211
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
212
|
+
message: string;
|
|
213
|
+
}>>;
|
|
214
|
+
detach: ({ source, target, options }: {
|
|
215
|
+
source: import("./record.js").DBRecordTarget;
|
|
216
|
+
target: import("./record.js").RelationTarget;
|
|
217
|
+
options?: import("./record.js").RelationDetachOptions;
|
|
218
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
219
|
+
message: string;
|
|
220
|
+
}>>;
|
|
221
|
+
create: <S extends Schema = any>({ label, data, options }: {
|
|
222
|
+
label: string;
|
|
223
|
+
data: import("../types/value.js").PropertyDraft[] | import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
224
|
+
boolean: boolean;
|
|
225
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
226
|
+
null: null;
|
|
227
|
+
number: number;
|
|
228
|
+
string: string;
|
|
229
|
+
vector: Array<number>;
|
|
230
|
+
}[S[Key]["type"]][] : {
|
|
231
|
+
boolean: boolean;
|
|
232
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
233
|
+
null: null;
|
|
234
|
+
number: number;
|
|
235
|
+
string: string;
|
|
236
|
+
vector: Array<number>;
|
|
237
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
238
|
+
boolean: boolean;
|
|
239
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
240
|
+
null: null;
|
|
241
|
+
number: number;
|
|
242
|
+
string: string;
|
|
243
|
+
vector: Array<number>;
|
|
244
|
+
}[S[Key_1]["type"]][] : {
|
|
245
|
+
boolean: boolean;
|
|
246
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
247
|
+
null: null;
|
|
248
|
+
number: number;
|
|
249
|
+
string: string;
|
|
250
|
+
vector: Array<number>;
|
|
251
|
+
}[S[Key_1]["type"]]) | undefined; }>;
|
|
252
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
253
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
254
|
+
createMany: <S extends Schema = any>(data: {
|
|
255
|
+
label: string;
|
|
256
|
+
data: import("../types/utils.js").MaybeArray<import("../types/utils.js").AnyObject>;
|
|
257
|
+
options?: import("./record.js").DBRecordCreationOptions;
|
|
258
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("./record.js").DBRecordsArrayInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
259
|
+
delete: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
260
|
+
message: string;
|
|
261
|
+
}>>;
|
|
262
|
+
deleteById: (idOrIds: import("../types/utils.js").MaybeArray<string>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
263
|
+
message: string;
|
|
264
|
+
}>>;
|
|
265
|
+
export: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
266
|
+
dateTime: string;
|
|
267
|
+
fileContent: string;
|
|
268
|
+
}>>;
|
|
269
|
+
find: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQueryWithEntryPoint: Q & {
|
|
270
|
+
id?: string;
|
|
271
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("./record.js").DBRecordsArrayInstance<S, Q>>;
|
|
272
|
+
findById: <S extends Schema = Schema, Arg extends import("../types/utils.js").MaybeArray<string> = import("../types/utils.js").MaybeArray<string>, Result = Arg extends string[] ? import("./record.js").DBRecordsArrayInstance<S, import("../types/query.js").SearchQuery<S>> : DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>(idOrIds: Arg, transaction?: import("./transaction.js").Transaction | string) => Promise<Result>;
|
|
273
|
+
findOne: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQuery: Q, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
274
|
+
findUniq: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQuery: Q, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, Q>>;
|
|
275
|
+
set: <S extends Schema = any>({ target, label, data, options }: {
|
|
276
|
+
target: import("./record.js").DBRecordTarget;
|
|
277
|
+
label: string;
|
|
278
|
+
data: import("../types/value.js").PropertyDraft[] | import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
279
|
+
boolean: boolean;
|
|
280
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
281
|
+
null: null;
|
|
282
|
+
number: number;
|
|
283
|
+
string: string;
|
|
284
|
+
vector: Array<number>;
|
|
285
|
+
}[S[Key]["type"]][] : {
|
|
286
|
+
boolean: boolean;
|
|
287
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
288
|
+
null: null;
|
|
289
|
+
number: number;
|
|
290
|
+
string: string;
|
|
291
|
+
vector: Array<number>;
|
|
292
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
293
|
+
boolean: boolean;
|
|
294
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
295
|
+
null: null;
|
|
296
|
+
number: number;
|
|
297
|
+
string: string;
|
|
298
|
+
vector: Array<number>;
|
|
299
|
+
}[S[Key_1]["type"]][] : {
|
|
300
|
+
boolean: boolean;
|
|
301
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
302
|
+
null: null;
|
|
303
|
+
number: number;
|
|
304
|
+
string: string;
|
|
305
|
+
vector: Array<number>;
|
|
306
|
+
}[S[Key_1]["type"]]) | undefined; }>;
|
|
307
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
308
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
309
|
+
update: <S extends Schema = any>({ target, label, data, options }: {
|
|
310
|
+
target: import("./record.js").DBRecordTarget;
|
|
311
|
+
label: string;
|
|
312
|
+
data: import("../types/value.js").PropertyDraft[] | Partial<import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
313
|
+
boolean: boolean;
|
|
314
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
315
|
+
null: null;
|
|
316
|
+
number: number;
|
|
317
|
+
string: string;
|
|
318
|
+
vector: Array<number>;
|
|
319
|
+
}[S[Key]["type"]][] : {
|
|
320
|
+
boolean: boolean;
|
|
321
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
322
|
+
null: null;
|
|
323
|
+
number: number;
|
|
324
|
+
string: string;
|
|
325
|
+
vector: Array<number>;
|
|
326
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
327
|
+
boolean: boolean;
|
|
328
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
329
|
+
null: null;
|
|
330
|
+
number: number;
|
|
331
|
+
string: string;
|
|
332
|
+
vector: Array<number>;
|
|
333
|
+
}[S[Key_1]["type"]][] : {
|
|
334
|
+
boolean: boolean;
|
|
335
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
336
|
+
null: null;
|
|
337
|
+
number: number;
|
|
338
|
+
string: string;
|
|
339
|
+
vector: Array<number>;
|
|
340
|
+
}[S[Key_1]["type"]]) | undefined; }>>;
|
|
341
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
342
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
343
|
+
};
|
|
344
|
+
relationships: {
|
|
345
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("./record.js").Relation[]>>;
|
|
70
346
|
};
|
|
71
347
|
properties: {
|
|
72
348
|
delete: (id: string, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property>>;
|
|
73
|
-
find: <S extends Schema = any>(
|
|
349
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property[]>>;
|
|
74
350
|
findById: (id: string, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property>>;
|
|
75
|
-
values: (id: string, options?: import("../types/value.js").PropertyValuesOptions, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<
|
|
351
|
+
values: (id: string, options?: import("../types/value.js").PropertyValuesOptions, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
352
|
+
metadata?: string;
|
|
353
|
+
name: string;
|
|
354
|
+
type: import("../types/value.js").PropertyType;
|
|
355
|
+
} & {
|
|
356
|
+
id: string;
|
|
357
|
+
} & import("../types/value.js").PropertyValuesData>>;
|
|
76
358
|
};
|
|
77
359
|
labels: {
|
|
78
|
-
find: <S extends Schema = any>(
|
|
360
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<Record<string, number>>>;
|
|
79
361
|
};
|
|
80
362
|
tx: {
|
|
81
363
|
begin: (config?: Partial<{
|
|
82
364
|
ttl: number;
|
|
83
365
|
}>) => Promise<import("./transaction.js").Transaction>;
|
|
84
|
-
commit: (
|
|
366
|
+
commit: (tx: string | import("./transaction.js").Transaction) => Promise<import("../index.node.js").ApiResponse<{
|
|
85
367
|
message: string;
|
|
86
368
|
}>>;
|
|
87
|
-
get: (
|
|
88
|
-
rollback: (
|
|
369
|
+
get: (tx: string | import("./transaction.js").Transaction) => Promise<import("./transaction.js").Transaction>;
|
|
370
|
+
rollback: (tx: string | import("./transaction.js").Transaction) => Promise<import("../index.node.js").ApiResponse<{
|
|
89
371
|
message: string;
|
|
90
372
|
}>>;
|
|
91
373
|
};
|
|
@@ -101,34 +383,175 @@ export declare const initSDK: (httpClient: HttpClient) => {
|
|
|
101
383
|
readonly __label: string;
|
|
102
384
|
readonly __proptypes?: import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysRead<S>]: S[Key]["type"]; } & { [Key_1 in import("../types/schema.js").OptionalKeysRead<S>]?: S[Key_1]["type"] | undefined; }> | undefined;
|
|
103
385
|
} & import("../types/utils.js").FlattenTypes<import("./record.js").RecordProps<S>>>): DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>;
|
|
104
|
-
api: ReturnType<typeof import("../api/create-api.js").createApi>;
|
|
105
386
|
fetcher: ReturnType<typeof import("../network/index.js").createFetcher>;
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
387
|
+
options: SDKConfig["options"];
|
|
388
|
+
logger: SDKConfig["logger"];
|
|
389
|
+
_extractTargetIds(target: import("./record.js").RelationTarget, operation: string): Array<string>;
|
|
390
|
+
records: {
|
|
391
|
+
attach: ({ source, target, options }: {
|
|
392
|
+
source: import("./record.js").DBRecordTarget;
|
|
393
|
+
target: import("./record.js").RelationTarget;
|
|
394
|
+
options?: import("./record.js").RelationOptions;
|
|
395
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
396
|
+
message: string;
|
|
397
|
+
}>>;
|
|
398
|
+
detach: ({ source, target, options }: {
|
|
399
|
+
source: import("./record.js").DBRecordTarget;
|
|
400
|
+
target: import("./record.js").RelationTarget;
|
|
401
|
+
options?: import("./record.js").RelationDetachOptions;
|
|
402
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
403
|
+
message: string;
|
|
404
|
+
}>>;
|
|
405
|
+
create: <S extends Schema = any>({ label, data, options }: {
|
|
406
|
+
label: string;
|
|
407
|
+
data: import("../types/value.js").PropertyDraft[] | import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
408
|
+
boolean: boolean;
|
|
409
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
410
|
+
null: null;
|
|
411
|
+
number: number;
|
|
412
|
+
string: string;
|
|
413
|
+
vector: Array<number>;
|
|
414
|
+
}[S[Key]["type"]][] : {
|
|
415
|
+
boolean: boolean;
|
|
416
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
417
|
+
null: null;
|
|
418
|
+
number: number;
|
|
419
|
+
string: string;
|
|
420
|
+
vector: Array<number>;
|
|
421
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
422
|
+
boolean: boolean;
|
|
423
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
424
|
+
null: null;
|
|
425
|
+
number: number;
|
|
426
|
+
string: string;
|
|
427
|
+
vector: Array<number>;
|
|
428
|
+
}[S[Key_1]["type"]][] : {
|
|
429
|
+
boolean: boolean;
|
|
430
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
431
|
+
null: null;
|
|
432
|
+
number: number;
|
|
433
|
+
string: string;
|
|
434
|
+
vector: Array<number>;
|
|
435
|
+
}[S[Key_1]["type"]]) | undefined; }>;
|
|
436
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
437
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
438
|
+
createMany: <S extends Schema = any>(data: {
|
|
439
|
+
label: string;
|
|
440
|
+
data: import("../types/utils.js").MaybeArray<import("../types/utils.js").AnyObject>;
|
|
441
|
+
options?: import("./record.js").DBRecordCreationOptions;
|
|
442
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("./record.js").DBRecordsArrayInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
443
|
+
delete: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
444
|
+
message: string;
|
|
445
|
+
}>>;
|
|
446
|
+
deleteById: (idOrIds: import("../types/utils.js").MaybeArray<string>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
447
|
+
message: string;
|
|
448
|
+
}>>;
|
|
449
|
+
export: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
450
|
+
dateTime: string;
|
|
451
|
+
fileContent: string;
|
|
452
|
+
}>>;
|
|
453
|
+
find: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQueryWithEntryPoint: Q & {
|
|
454
|
+
id?: string;
|
|
455
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<import("./record.js").DBRecordsArrayInstance<S, Q>>;
|
|
456
|
+
findById: <S extends Schema = Schema, Arg extends import("../types/utils.js").MaybeArray<string> = import("../types/utils.js").MaybeArray<string>, Result = Arg extends string[] ? import("./record.js").DBRecordsArrayInstance<S, import("../types/query.js").SearchQuery<S>> : DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>(idOrIds: Arg, transaction?: import("./transaction.js").Transaction | string) => Promise<Result>;
|
|
457
|
+
findOne: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQuery: Q, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
458
|
+
findUniq: <S extends Schema = any, Q extends import("../types/query.js").SearchQuery<S> = import("../types/query.js").SearchQuery<S>>(searchQuery: Q, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, Q>>;
|
|
459
|
+
set: <S extends Schema = any>({ target, label, data, options }: {
|
|
460
|
+
target: import("./record.js").DBRecordTarget;
|
|
461
|
+
label: string;
|
|
462
|
+
data: import("../types/value.js").PropertyDraft[] | import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
463
|
+
boolean: boolean;
|
|
464
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
465
|
+
null: null;
|
|
466
|
+
number: number;
|
|
467
|
+
string: string;
|
|
468
|
+
vector: Array<number>;
|
|
469
|
+
}[S[Key]["type"]][] : {
|
|
470
|
+
boolean: boolean;
|
|
471
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
472
|
+
null: null;
|
|
473
|
+
number: number;
|
|
474
|
+
string: string;
|
|
475
|
+
vector: Array<number>;
|
|
476
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
477
|
+
boolean: boolean;
|
|
478
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
479
|
+
null: null;
|
|
480
|
+
number: number;
|
|
481
|
+
string: string;
|
|
482
|
+
vector: Array<number>;
|
|
483
|
+
}[S[Key_1]["type"]][] : {
|
|
484
|
+
boolean: boolean;
|
|
485
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
486
|
+
null: null;
|
|
487
|
+
number: number;
|
|
488
|
+
string: string;
|
|
489
|
+
vector: Array<number>;
|
|
490
|
+
}[S[Key_1]["type"]]) | undefined; }>;
|
|
491
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
492
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
493
|
+
update: <S extends Schema = any>({ target, label, data, options }: {
|
|
494
|
+
target: import("./record.js").DBRecordTarget;
|
|
495
|
+
label: string;
|
|
496
|
+
data: import("../types/value.js").PropertyDraft[] | Partial<import("../types/utils.js").FlattenTypes<{ [Key in import("../types/schema.js").RequiredKeysWrite<S>]: S[Key]["multiple"] extends true ? {
|
|
497
|
+
boolean: boolean;
|
|
498
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
499
|
+
null: null;
|
|
500
|
+
number: number;
|
|
501
|
+
string: string;
|
|
502
|
+
vector: Array<number>;
|
|
503
|
+
}[S[Key]["type"]][] : {
|
|
504
|
+
boolean: boolean;
|
|
505
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
506
|
+
null: null;
|
|
507
|
+
number: number;
|
|
508
|
+
string: string;
|
|
509
|
+
vector: Array<number>;
|
|
510
|
+
}[S[Key]["type"]]; } & { [Key_1 in import("../types/schema.js").OptionalKeysWrite<S>]?: (S[Key_1]["multiple"] extends true ? {
|
|
511
|
+
boolean: boolean;
|
|
512
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
513
|
+
null: null;
|
|
514
|
+
number: number;
|
|
515
|
+
string: string;
|
|
516
|
+
vector: Array<number>;
|
|
517
|
+
}[S[Key_1]["type"]][] : {
|
|
518
|
+
boolean: boolean;
|
|
519
|
+
datetime: import("../types/value.js").DatetimeObject | string;
|
|
520
|
+
null: null;
|
|
521
|
+
number: number;
|
|
522
|
+
string: string;
|
|
523
|
+
vector: Array<number>;
|
|
524
|
+
}[S[Key_1]["type"]]) | undefined; }>>;
|
|
525
|
+
options?: Omit<import("./record.js").DBRecordCreationOptions, "returnResult" | "capitalizeLabels" | "relationshipType">;
|
|
526
|
+
}, transaction?: import("./transaction.js").Transaction | string) => Promise<DBRecordInstance<S, import("../types/query.js").SearchQuery<S>>>;
|
|
527
|
+
};
|
|
528
|
+
relationships: {
|
|
529
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("./record.js").Relation[]>>;
|
|
113
530
|
};
|
|
114
531
|
properties: {
|
|
115
532
|
delete: (id: string, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property>>;
|
|
116
|
-
find: <S extends Schema = any>(
|
|
533
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property[]>>;
|
|
117
534
|
findById: (id: string, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<import("../types/value.js").Property>>;
|
|
118
|
-
values: (id: string, options?: import("../types/value.js").PropertyValuesOptions, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<
|
|
535
|
+
values: (id: string, options?: import("../types/value.js").PropertyValuesOptions, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<{
|
|
536
|
+
metadata?: string;
|
|
537
|
+
name: string;
|
|
538
|
+
type: import("../types/value.js").PropertyType;
|
|
539
|
+
} & {
|
|
540
|
+
id: string;
|
|
541
|
+
} & import("../types/value.js").PropertyValuesData>>;
|
|
119
542
|
};
|
|
120
543
|
labels: {
|
|
121
|
-
find: <S extends Schema = any>(
|
|
544
|
+
find: <S extends Schema = any>(searchQuery: import("../types/query.js").SearchQuery<S>, transaction?: import("./transaction.js").Transaction | string) => Promise<import("../index.node.js").ApiResponse<Record<string, number>>>;
|
|
122
545
|
};
|
|
123
546
|
tx: {
|
|
124
547
|
begin: (config?: Partial<{
|
|
125
548
|
ttl: number;
|
|
126
549
|
}>) => Promise<import("./transaction.js").Transaction>;
|
|
127
|
-
commit: (
|
|
550
|
+
commit: (tx: string | import("./transaction.js").Transaction) => Promise<import("../index.node.js").ApiResponse<{
|
|
128
551
|
message: string;
|
|
129
552
|
}>>;
|
|
130
|
-
get: (
|
|
131
|
-
rollback: (
|
|
553
|
+
get: (tx: string | import("./transaction.js").Transaction) => Promise<import("./transaction.js").Transaction>;
|
|
554
|
+
rollback: (tx: string | import("./transaction.js").Transaction) => Promise<import("../index.node.js").ApiResponse<{
|
|
132
555
|
message: string;
|
|
133
556
|
}>>;
|
|
134
557
|
};
|
package/dist/sdk/utils.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { PropertyValue, Schema, InferSchemaTypesWrite } from '../types/index.js';
|
|
2
2
|
import type { SDKConfig } from './types.js';
|
|
3
|
-
export declare const mergeDefaultsWithPayload: <S extends Schema = Schema>(schema: S,
|
|
3
|
+
export declare const mergeDefaultsWithPayload: <S extends Schema = Schema>(schema: S, data: Partial<InferSchemaTypesWrite<S>>) => Promise<InferSchemaTypesWrite<S>>;
|
|
4
4
|
export declare const pickUniqFieldsFromRecord: <S extends Schema = Schema>(schema: S, data: Partial<InferSchemaTypesWrite<S>>) => Record<string, PropertyValue>;
|
|
5
|
-
export declare const pickUniqFieldsFromRecords: <S extends Schema = Schema>(data: Partial<InferSchemaTypesWrite<S
|
|
5
|
+
export declare const pickUniqFieldsFromRecords: <S extends Schema = Schema>(data: Array<Partial<InferSchemaTypesWrite<S>>>, schema: S, label: string) => Record<string, PropertyValue[]>;
|
|
6
6
|
export declare const parseConfig: (config?: Record<string, unknown>) => SDKConfig;
|
|
7
7
|
export declare function validateInteger(name: string, n: unknown, defaultVal?: number): number;
|
|
8
8
|
export declare function idToTimestamp(id: string): number;
|