@based/client 2.7.4 → 2.7.5
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/dist/types.d.ts +253 -0
- package/dist/types.js +58 -0
- package/dist/types.js.map +1 -0
- package/package.json +3 -3
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import type { GetOptions } from './selvaTypes/get';
|
|
3
|
+
import type { SetOptions } from './selvaTypes/set';
|
|
4
|
+
import type { Schema } from './selvaTypes/schema';
|
|
5
|
+
import { Readable } from 'stream';
|
|
6
|
+
export { GetOptions, SetOptions, Schema };
|
|
7
|
+
export declare type DigestOptions = string;
|
|
8
|
+
export declare enum RequestTypes {
|
|
9
|
+
Subscription = 1,
|
|
10
|
+
SubscriptionDiff = 2,
|
|
11
|
+
SendSubscriptionData = 3,
|
|
12
|
+
Unsubscribe = 4,
|
|
13
|
+
Set = 5,
|
|
14
|
+
Get = 6,
|
|
15
|
+
Configuration = 7,
|
|
16
|
+
GetConfiguration = 8,
|
|
17
|
+
Call = 9,
|
|
18
|
+
GetSubscription = 10,
|
|
19
|
+
Delete = 11,
|
|
20
|
+
Copy = 12,
|
|
21
|
+
Digest = 13,
|
|
22
|
+
Token = 14,
|
|
23
|
+
Track = 15,
|
|
24
|
+
Auth = 16
|
|
25
|
+
}
|
|
26
|
+
export declare enum AuthRequestTypes {
|
|
27
|
+
Login = 1,
|
|
28
|
+
Logout = 2,
|
|
29
|
+
RenewToken = 3
|
|
30
|
+
}
|
|
31
|
+
export declare type Configuration = {
|
|
32
|
+
schema: {
|
|
33
|
+
[db: string]: Schema;
|
|
34
|
+
};
|
|
35
|
+
dbs: string[];
|
|
36
|
+
};
|
|
37
|
+
export declare type Query = GetOptions;
|
|
38
|
+
export declare type GenericObject = {
|
|
39
|
+
[key: string]: any;
|
|
40
|
+
};
|
|
41
|
+
export declare type Copy = {
|
|
42
|
+
$id: string;
|
|
43
|
+
db?: string;
|
|
44
|
+
deep?: boolean;
|
|
45
|
+
parents?: string[];
|
|
46
|
+
excludeFields?: string[];
|
|
47
|
+
};
|
|
48
|
+
export declare type ErrorObject = {
|
|
49
|
+
type: string;
|
|
50
|
+
message: string;
|
|
51
|
+
name?: string;
|
|
52
|
+
query?: GenericObject;
|
|
53
|
+
payload?: any;
|
|
54
|
+
auth?: boolean;
|
|
55
|
+
code?: string;
|
|
56
|
+
};
|
|
57
|
+
export declare type FunctionCallMessage = [RequestTypes.Call, string, number, any?];
|
|
58
|
+
export declare type TrackMessage = [RequestTypes.Track, TrackPayload];
|
|
59
|
+
export declare type RequestMessage<T = GenericObject> = [
|
|
60
|
+
(RequestTypes.Set | RequestTypes.Get | RequestTypes.Configuration | RequestTypes.GetConfiguration | RequestTypes.Delete | RequestTypes.Copy | RequestTypes.Digest),
|
|
61
|
+
number,
|
|
62
|
+
T
|
|
63
|
+
];
|
|
64
|
+
export declare type TokenMessage = [RequestTypes.Token, string?, boolean?];
|
|
65
|
+
export declare type AuthMessage = [
|
|
66
|
+
RequestTypes.Auth,
|
|
67
|
+
AuthRequestTypes,
|
|
68
|
+
number,
|
|
69
|
+
GenericObject?
|
|
70
|
+
];
|
|
71
|
+
export declare type SubscribeMessage = [
|
|
72
|
+
RequestTypes.Subscription,
|
|
73
|
+
number,
|
|
74
|
+
GenericObject?,
|
|
75
|
+
number?,
|
|
76
|
+
(2 | 1 | 0)?,
|
|
77
|
+
string?
|
|
78
|
+
];
|
|
79
|
+
export declare type SendSubscriptionDataMessage = [
|
|
80
|
+
RequestTypes.SendSubscriptionData,
|
|
81
|
+
number,
|
|
82
|
+
number?
|
|
83
|
+
];
|
|
84
|
+
export declare type SendSubscriptionGetDataMessage = [
|
|
85
|
+
RequestTypes.GetSubscription,
|
|
86
|
+
number,
|
|
87
|
+
GenericObject?,
|
|
88
|
+
number?,
|
|
89
|
+
string?
|
|
90
|
+
];
|
|
91
|
+
export declare type UnsubscribeMessage = [
|
|
92
|
+
RequestTypes.Unsubscribe,
|
|
93
|
+
number
|
|
94
|
+
];
|
|
95
|
+
export declare type SubscriptionMessage = SubscribeMessage | SendSubscriptionDataMessage | UnsubscribeMessage | SendSubscriptionGetDataMessage;
|
|
96
|
+
export declare type Message = RequestMessage | SubscriptionMessage | FunctionCallMessage | AuthMessage;
|
|
97
|
+
export declare type SubscriptionDiffData = [
|
|
98
|
+
RequestTypes.SubscriptionDiff,
|
|
99
|
+
number,
|
|
100
|
+
GenericObject,
|
|
101
|
+
[
|
|
102
|
+
number,
|
|
103
|
+
number
|
|
104
|
+
]
|
|
105
|
+
];
|
|
106
|
+
export declare type SubscriptionData = [
|
|
107
|
+
RequestTypes.Subscription,
|
|
108
|
+
number,
|
|
109
|
+
GenericObject,
|
|
110
|
+
number?,
|
|
111
|
+
ErrorObject?
|
|
112
|
+
];
|
|
113
|
+
export declare type RequestData = [
|
|
114
|
+
(RequestTypes.Set | RequestTypes.Get | RequestTypes.Configuration | RequestTypes.GetConfiguration | RequestTypes.Call | RequestTypes.Delete | RequestTypes.Copy | RequestTypes.Digest),
|
|
115
|
+
number,
|
|
116
|
+
any,
|
|
117
|
+
ErrorObject?
|
|
118
|
+
];
|
|
119
|
+
export declare type AuthorizedData = [RequestTypes.Token, number[], boolean?];
|
|
120
|
+
export declare type AuthData = [
|
|
121
|
+
RequestTypes.Auth,
|
|
122
|
+
number,
|
|
123
|
+
GenericObject,
|
|
124
|
+
ErrorObject?
|
|
125
|
+
];
|
|
126
|
+
export declare type ResponseData = SubscriptionDiffData | SubscriptionData | RequestData | AuthorizedData | AuthData;
|
|
127
|
+
export declare type TrackPayload = {
|
|
128
|
+
t: string;
|
|
129
|
+
u?: 1;
|
|
130
|
+
s?: 1;
|
|
131
|
+
e?: 1;
|
|
132
|
+
r?: 1;
|
|
133
|
+
o?: TrackOpts;
|
|
134
|
+
};
|
|
135
|
+
export declare type TrackOpts = {
|
|
136
|
+
amount?: number;
|
|
137
|
+
};
|
|
138
|
+
export declare type SendTokenOptions = {
|
|
139
|
+
isBasedUser?: boolean;
|
|
140
|
+
isApiKey?: boolean;
|
|
141
|
+
refreshToken?: string;
|
|
142
|
+
};
|
|
143
|
+
export declare type AnalyticsResult = {
|
|
144
|
+
all: {
|
|
145
|
+
total: number;
|
|
146
|
+
geo?: {
|
|
147
|
+
[isoCode: string]: number;
|
|
148
|
+
};
|
|
149
|
+
};
|
|
150
|
+
unique: {
|
|
151
|
+
total: number;
|
|
152
|
+
geo?: {
|
|
153
|
+
[isoCode: string]: number;
|
|
154
|
+
};
|
|
155
|
+
};
|
|
156
|
+
active: {
|
|
157
|
+
total: number;
|
|
158
|
+
max: number;
|
|
159
|
+
geo?: {
|
|
160
|
+
[isoCode: string]: number;
|
|
161
|
+
};
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
export declare type AnalyticsHistoryResult = {
|
|
165
|
+
all: {
|
|
166
|
+
total: [number, number][];
|
|
167
|
+
geo?: {
|
|
168
|
+
[isoCode: string]: [number, number][];
|
|
169
|
+
};
|
|
170
|
+
};
|
|
171
|
+
unique: {
|
|
172
|
+
total: [number, number][];
|
|
173
|
+
geo?: {
|
|
174
|
+
[isoCode: string]: [number, number][];
|
|
175
|
+
};
|
|
176
|
+
};
|
|
177
|
+
active: {
|
|
178
|
+
total: [number, number][];
|
|
179
|
+
geo?: {
|
|
180
|
+
[isoCode: string]: [number, number][];
|
|
181
|
+
};
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
export declare type AnalyticsTypes = string[];
|
|
185
|
+
export declare type AnalyticsTypesOpts = {
|
|
186
|
+
type?: string;
|
|
187
|
+
$types: true;
|
|
188
|
+
};
|
|
189
|
+
export declare function isAnalyticsTypesOpts(opts: AnalyticsOpts | AnalyticsTypesOpts): opts is AnalyticsTypesOpts;
|
|
190
|
+
export declare function isAnalyticsHistoryOpts(opts: AnalyticsOpts | AnalyticsTypesOpts): opts is AnalyticsHistoryOpts;
|
|
191
|
+
export declare type AnalyticsOpts = {
|
|
192
|
+
type: string;
|
|
193
|
+
params?: {
|
|
194
|
+
[key: string]: number | string | boolean;
|
|
195
|
+
};
|
|
196
|
+
$geo?: string[] | boolean;
|
|
197
|
+
};
|
|
198
|
+
export declare type AnalyticsHistoryOpts = {
|
|
199
|
+
type: string;
|
|
200
|
+
params?: {
|
|
201
|
+
[key: string]: number | string | boolean;
|
|
202
|
+
};
|
|
203
|
+
$geo?: string[] | boolean;
|
|
204
|
+
$history: boolean | number;
|
|
205
|
+
};
|
|
206
|
+
export declare type LoginOpts = {
|
|
207
|
+
email: string;
|
|
208
|
+
password: string;
|
|
209
|
+
};
|
|
210
|
+
export declare type RenewTokenOpts = {
|
|
211
|
+
refreshToken: string;
|
|
212
|
+
};
|
|
213
|
+
export declare type FileUploadOptions = {
|
|
214
|
+
contents: Buffer | ArrayBuffer | string | File | Blob;
|
|
215
|
+
mimeType?: string;
|
|
216
|
+
name?: string;
|
|
217
|
+
url?: string | (() => Promise<string>);
|
|
218
|
+
id?: string;
|
|
219
|
+
raw?: boolean;
|
|
220
|
+
parents?: string[];
|
|
221
|
+
functionName?: string;
|
|
222
|
+
};
|
|
223
|
+
export declare type FileUploadStream = {
|
|
224
|
+
contents: Readable;
|
|
225
|
+
mimeType?: string;
|
|
226
|
+
extension?: string;
|
|
227
|
+
size: number;
|
|
228
|
+
name?: string;
|
|
229
|
+
url?: string | (() => Promise<string>);
|
|
230
|
+
id?: string;
|
|
231
|
+
raw?: boolean;
|
|
232
|
+
parents?: string[];
|
|
233
|
+
functionName?: string;
|
|
234
|
+
};
|
|
235
|
+
export declare type FileUploadPath = {
|
|
236
|
+
path: string;
|
|
237
|
+
mimeType?: string;
|
|
238
|
+
extension?: string;
|
|
239
|
+
name?: string;
|
|
240
|
+
url?: string | (() => Promise<string>);
|
|
241
|
+
id?: string;
|
|
242
|
+
raw?: boolean;
|
|
243
|
+
parents?: string[];
|
|
244
|
+
functionName?: string;
|
|
245
|
+
};
|
|
246
|
+
export declare type FileUploadSrc = {
|
|
247
|
+
src: string;
|
|
248
|
+
mimeType?: string;
|
|
249
|
+
name?: string;
|
|
250
|
+
id?: string;
|
|
251
|
+
parents?: string[];
|
|
252
|
+
size?: number;
|
|
253
|
+
};
|
package/dist/types.js
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.isAnalyticsHistoryOpts = exports.isAnalyticsTypesOpts = exports.AuthRequestTypes = exports.RequestTypes = void 0;
|
|
4
|
+
// eslint-disable-next-line
|
|
5
|
+
var RequestTypes;
|
|
6
|
+
(function (RequestTypes) {
|
|
7
|
+
// eslint-disable-next-line
|
|
8
|
+
RequestTypes[RequestTypes["Subscription"] = 1] = "Subscription";
|
|
9
|
+
// eslint-disable-next-line
|
|
10
|
+
RequestTypes[RequestTypes["SubscriptionDiff"] = 2] = "SubscriptionDiff";
|
|
11
|
+
// eslint-disable-next-line
|
|
12
|
+
RequestTypes[RequestTypes["SendSubscriptionData"] = 3] = "SendSubscriptionData";
|
|
13
|
+
// eslint-disable-next-line
|
|
14
|
+
RequestTypes[RequestTypes["Unsubscribe"] = 4] = "Unsubscribe";
|
|
15
|
+
// eslint-disable-next-line
|
|
16
|
+
RequestTypes[RequestTypes["Set"] = 5] = "Set";
|
|
17
|
+
// eslint-disable-next-line
|
|
18
|
+
RequestTypes[RequestTypes["Get"] = 6] = "Get";
|
|
19
|
+
// eslint-disable-next-line
|
|
20
|
+
RequestTypes[RequestTypes["Configuration"] = 7] = "Configuration";
|
|
21
|
+
// eslint-disable-next-line
|
|
22
|
+
RequestTypes[RequestTypes["GetConfiguration"] = 8] = "GetConfiguration";
|
|
23
|
+
// eslint-disable-next-line
|
|
24
|
+
RequestTypes[RequestTypes["Call"] = 9] = "Call";
|
|
25
|
+
// eslint-disable-next-line
|
|
26
|
+
RequestTypes[RequestTypes["GetSubscription"] = 10] = "GetSubscription";
|
|
27
|
+
// eslint-disable-next-line
|
|
28
|
+
RequestTypes[RequestTypes["Delete"] = 11] = "Delete";
|
|
29
|
+
// eslint-disable-next-line
|
|
30
|
+
RequestTypes[RequestTypes["Copy"] = 12] = "Copy";
|
|
31
|
+
// eslint-disable-next-line
|
|
32
|
+
RequestTypes[RequestTypes["Digest"] = 13] = "Digest";
|
|
33
|
+
// eslint-disable-next-line
|
|
34
|
+
RequestTypes[RequestTypes["Token"] = 14] = "Token";
|
|
35
|
+
// eslint-disable-next-line
|
|
36
|
+
RequestTypes[RequestTypes["Track"] = 15] = "Track";
|
|
37
|
+
// eslint-disable-next-line
|
|
38
|
+
RequestTypes[RequestTypes["Auth"] = 16] = "Auth";
|
|
39
|
+
})(RequestTypes = exports.RequestTypes || (exports.RequestTypes = {}));
|
|
40
|
+
var AuthRequestTypes;
|
|
41
|
+
(function (AuthRequestTypes) {
|
|
42
|
+
// eslint-disable-next-line
|
|
43
|
+
AuthRequestTypes[AuthRequestTypes["Login"] = 1] = "Login";
|
|
44
|
+
// eslint-disable-next-line
|
|
45
|
+
AuthRequestTypes[AuthRequestTypes["Logout"] = 2] = "Logout";
|
|
46
|
+
// eslint-disable-next-line
|
|
47
|
+
AuthRequestTypes[AuthRequestTypes["RenewToken"] = 3] = "RenewToken";
|
|
48
|
+
})(AuthRequestTypes = exports.AuthRequestTypes || (exports.AuthRequestTypes = {}));
|
|
49
|
+
function isAnalyticsTypesOpts(opts) {
|
|
50
|
+
return opts.$types === true;
|
|
51
|
+
}
|
|
52
|
+
exports.isAnalyticsTypesOpts = isAnalyticsTypesOpts;
|
|
53
|
+
function isAnalyticsHistoryOpts(opts) {
|
|
54
|
+
const hasHistory = opts.$history;
|
|
55
|
+
return !!hasHistory;
|
|
56
|
+
}
|
|
57
|
+
exports.isAnalyticsHistoryOpts = isAnalyticsHistoryOpts;
|
|
58
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AASA,2BAA2B;AAC3B,IAAY,YAiCX;AAjCD,WAAY,YAAY;IACtB,2BAA2B;IAC3B,+DAAgB,CAAA;IAChB,2BAA2B;IAC3B,uEAAoB,CAAA;IACpB,2BAA2B;IAC3B,+EAAwB,CAAA;IACxB,2BAA2B;IAC3B,6DAAe,CAAA;IACf,2BAA2B;IAC3B,6CAAO,CAAA;IACP,2BAA2B;IAC3B,6CAAO,CAAA;IACP,2BAA2B;IAC3B,iEAAiB,CAAA;IACjB,2BAA2B;IAC3B,uEAAoB,CAAA;IACpB,2BAA2B;IAC3B,+CAAQ,CAAA;IACR,2BAA2B;IAC3B,sEAAoB,CAAA;IACpB,2BAA2B;IAC3B,oDAAW,CAAA;IACX,2BAA2B;IAC3B,gDAAS,CAAA;IACT,2BAA2B;IAC3B,oDAAW,CAAA;IACX,2BAA2B;IAC3B,kDAAU,CAAA;IACV,2BAA2B;IAC3B,kDAAU,CAAA;IACV,2BAA2B;IAC3B,gDAAS,CAAA;AACX,CAAC,EAjCW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAiCvB;AAED,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,2BAA2B;IAC3B,yDAAS,CAAA;IACT,2BAA2B;IAC3B,2DAAU,CAAA;IACV,2BAA2B;IAC3B,mEAAc,CAAA;AAChB,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AA2OD,SAAgB,oBAAoB,CAClC,IAAwC;IAExC,OAAQ,IAA2B,CAAC,MAAM,KAAK,IAAI,CAAA;AACrD,CAAC;AAJD,oDAIC;AAED,SAAgB,sBAAsB,CACpC,IAAwC;IAExC,MAAM,UAAU,GAAI,IAA6B,CAAC,QAAQ,CAAA;IAC1D,OAAO,CAAC,CAAC,UAAU,CAAA;AACrB,CAAC;AALD,wDAKC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@based/client",
|
|
3
|
-
"version": "2.7.
|
|
3
|
+
"version": "2.7.5",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"browser": {
|
|
@@ -28,9 +28,9 @@
|
|
|
28
28
|
]
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@based/get-service": "2.4.
|
|
31
|
+
"@based/get-service": "2.4.3",
|
|
32
32
|
"@based/graphql": "2.4.2",
|
|
33
|
-
"@based/types": "^2.
|
|
33
|
+
"@based/types": "^2.6.0",
|
|
34
34
|
"@saulx/diff": "^1.1.3",
|
|
35
35
|
"@saulx/hash": "^1.1.0",
|
|
36
36
|
"@saulx/utils": "^2.2.1",
|