oneentry 1.0.174 → 1.0.175
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/changelog.md +12 -0
- package/dist/auth-provider/authProviderApi.d.ts +1 -1
- package/dist/auth-provider/authProviderApi.js +1 -1
- package/dist/auth-provider/authProviderSchemas.d.ts +1 -1
- package/dist/auth-provider/authProvidersInterfaces.d.ts +3 -2
- package/dist/base/validation.d.ts +1 -1
- package/dist/base/validation.js +1 -1
- package/dist/users/usersApi.d.ts +2 -2
- package/dist/users/usersApi.js +2 -2
- package/dist/users/usersInterfaces.d.ts +8 -7
- package/dist/users/usersSchemas.d.ts +1 -1
- package/esm/auth-provider/authProviderApi.d.ts +1 -1
- package/esm/auth-provider/authProviderApi.js +1 -1
- package/esm/auth-provider/authProviderSchemas.d.ts +1 -1
- package/esm/auth-provider/authProvidersInterfaces.d.ts +3 -2
- package/esm/base/validation.d.ts +1 -1
- package/esm/base/validation.js +1 -1
- package/esm/users/usersApi.d.ts +2 -2
- package/esm/users/usersApi.js +2 -2
- package/esm/users/usersInterfaces.d.ts +8 -7
- package/esm/users/usersSchemas.d.ts +1 -1
- package/package.json +2 -2
package/changelog.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# SDK Change Log
|
|
2
2
|
|
|
3
|
+
## v.1.0.175
|
|
4
|
+
|
|
5
|
+
### What's Changed
|
|
6
|
+
|
|
7
|
+
- **`AuthProvider.signUp` and `Users.updateUser` take form field values by field type.** `formData` was typed with `IAuthFormData`, whose `value` is a `string`, so a date, a text object, a list or a file descriptor did not compile — while the platform takes a value shaped by the attribute type (`FormDataType.value`, an object). `ISignUpData.formData` and `IUserBody.formData` are `FormDataType | FormDataType[]` now, the same union the FormData module uses. String values compile as before. A file goes in as the descriptor `FileUploading.upload` returns: these two methods do not upload a `File`/`Blob` themselves. `IAuthFormData` is unchanged and still describes `ISignUpEntity.formData` (CMS-1089).
|
|
8
|
+
|
|
9
|
+
- **`IUserEntity.total` is optional and deprecated.** It is a service counter of the platform's user list query that leaks into the response of a single user: always `"1"`, it says nothing about the user, and the API reference does not describe it. Once the platform stops sending it, a required `total` would no longer hold; the Zod schema no longer requires it either (CMS-1088).
|
|
10
|
+
|
|
11
|
+
### Tests
|
|
12
|
+
|
|
13
|
+
- **`callercontracts.spec.ts`**: a date and a text value in `signUp` / `updateUser` must compile; a user without `total` must compile. `users.spec.ts` no longer expects `total`.
|
|
14
|
+
|
|
3
15
|
## v.1.0.174
|
|
4
16
|
|
|
5
17
|
### What's Changed
|
|
@@ -61,7 +61,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
|
|
|
61
61
|
"value": "12345"
|
|
62
62
|
}
|
|
63
63
|
]
|
|
64
|
-
* @param {
|
|
64
|
+
* @param {FormDataType | FormDataType[]} body.formData - Registration form fields: one object or an array. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
65
65
|
* @example
|
|
66
66
|
{
|
|
67
67
|
"marker": "last_name",
|
|
@@ -100,7 +100,7 @@ class AuthProviderApi extends asyncModules_1.default {
|
|
|
100
100
|
"value": "12345"
|
|
101
101
|
}
|
|
102
102
|
]
|
|
103
|
-
* @param {
|
|
103
|
+
* @param {FormDataType | FormDataType[]} body.formData - Registration form fields: one object or an array. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
104
104
|
* @example
|
|
105
105
|
{
|
|
106
106
|
"marker": "last_name",
|
|
@@ -49,7 +49,7 @@ export declare const UserResponseSchema: z.ZodObject<{
|
|
|
49
49
|
authProviderIdentifier: z.ZodString;
|
|
50
50
|
formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
|
|
51
51
|
formIdentifier: z.ZodString;
|
|
52
|
-
total: z.ZodString
|
|
52
|
+
total: z.ZodOptional<z.ZodString>;
|
|
53
53
|
groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
54
54
|
state: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
55
55
|
moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { IError, ILocalizeInfo, IRating } from '../base/utils';
|
|
2
|
+
import type { FormDataType } from '../forms-data/formsDataInterfaces';
|
|
2
3
|
/**
|
|
3
4
|
* @interface IAuthProvider
|
|
4
5
|
* @description This interface defines methods for user authentication and registration through various auth providers.
|
|
@@ -198,7 +199,7 @@ interface IAuthFormData {
|
|
|
198
199
|
* @property {string} formIdentifier - Marker of the registration form. Example: "reg".
|
|
199
200
|
* @property {string} [langCode] - Language code. Default: "en_US".
|
|
200
201
|
* @property {Array} authData - Authentication fields, each with a `marker` and a `value`.
|
|
201
|
-
* @property {
|
|
202
|
+
* @property {FormDataType | FormDataType[]} formData - Registration form fields. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
202
203
|
* @property {INotificationData} notificationData - Notification contacts: `email`, `phonePush` and `phoneSMS`.
|
|
203
204
|
* @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
|
|
204
205
|
*/
|
|
@@ -206,7 +207,7 @@ interface ISignUpData {
|
|
|
206
207
|
formIdentifier: string;
|
|
207
208
|
langCode?: string;
|
|
208
209
|
authData: IAuthData[];
|
|
209
|
-
formData:
|
|
210
|
+
formData: FormDataType | FormDataType[];
|
|
210
211
|
notificationData: INotificationData;
|
|
211
212
|
}
|
|
212
213
|
/**
|
|
@@ -74,7 +74,7 @@ export declare const UserEntitySchema: z.ZodObject<{
|
|
|
74
74
|
authProviderIdentifier: z.ZodString;
|
|
75
75
|
formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
|
|
76
76
|
formIdentifier: z.ZodString;
|
|
77
|
-
total: z.ZodString
|
|
77
|
+
total: z.ZodOptional<z.ZodString>;
|
|
78
78
|
groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
79
79
|
state: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
80
80
|
moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
|
package/dist/base/validation.js
CHANGED
|
@@ -143,7 +143,7 @@ exports.UserEntitySchema = zod_1.z.object({
|
|
|
143
143
|
authProviderIdentifier: zod_1.z.string(),
|
|
144
144
|
formData: zod_1.z.union([zod_1.z.array(zod_1.z.any()), zod_1.z.record(zod_1.z.string(), zod_1.z.any())]),
|
|
145
145
|
formIdentifier: zod_1.z.string(),
|
|
146
|
-
total: zod_1.z.string(),
|
|
146
|
+
total: zod_1.z.string().optional(),
|
|
147
147
|
groups: zod_1.z.array(zod_1.z.union([zod_1.z.string(), zod_1.z.number()])),
|
|
148
148
|
state: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
|
|
149
149
|
moduleFormConfigs: zod_1.z.array(zod_1.z.any()).optional(),
|
package/dist/users/usersApi.d.ts
CHANGED
|
@@ -73,7 +73,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
|
|
|
73
73
|
]
|
|
74
74
|
* @param {string} body.authData[].marker - Identifies the field being used. Example: "email_reg".
|
|
75
75
|
* @param {string} body.authData[].value - Contains the value of the field. Example: "example@oneentry.cloud".
|
|
76
|
-
* @param {
|
|
76
|
+
* @param {FormDataType | FormDataType[]} body.formData - Form fields of the user. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
77
77
|
* @example
|
|
78
78
|
[
|
|
79
79
|
{
|
|
@@ -84,7 +84,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
|
|
|
84
84
|
]
|
|
85
85
|
* @param {string} body.formData[].marker - The marker of the field. Example: "last_name".
|
|
86
86
|
* @param {string} body.formData[].type - The type of the field. Example: "string".
|
|
87
|
-
* @param {
|
|
87
|
+
* @param {unknown} body.formData[].value - The value of the field, shaped by its type. Example: "Username".
|
|
88
88
|
* @param {string} body.notificationData - The notification data.
|
|
89
89
|
* @example
|
|
90
90
|
{
|
package/dist/users/usersApi.js
CHANGED
|
@@ -116,7 +116,7 @@ class UsersApi extends asyncModules_1.default {
|
|
|
116
116
|
]
|
|
117
117
|
* @param {string} body.authData[].marker - Identifies the field being used. Example: "email_reg".
|
|
118
118
|
* @param {string} body.authData[].value - Contains the value of the field. Example: "example@oneentry.cloud".
|
|
119
|
-
* @param {
|
|
119
|
+
* @param {FormDataType | FormDataType[]} body.formData - Form fields of the user. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
120
120
|
* @example
|
|
121
121
|
[
|
|
122
122
|
{
|
|
@@ -127,7 +127,7 @@ class UsersApi extends asyncModules_1.default {
|
|
|
127
127
|
]
|
|
128
128
|
* @param {string} body.formData[].marker - The marker of the field. Example: "last_name".
|
|
129
129
|
* @param {string} body.formData[].type - The type of the field. Example: "string".
|
|
130
|
-
* @param {
|
|
130
|
+
* @param {unknown} body.formData[].value - The value of the field, shaped by its type. Example: "Username".
|
|
131
131
|
* @param {string} body.notificationData - The notification data.
|
|
132
132
|
* @example
|
|
133
133
|
{
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { IAuthData,
|
|
1
|
+
import type { IAuthData, INotificationData } from '../auth-provider/authProvidersInterfaces';
|
|
2
2
|
import type { IError, IRating, IVectorSearchResponse } from '../base/utils';
|
|
3
3
|
import type { IFormConfig } from '../forms/formsInterfaces';
|
|
4
4
|
import type { FormDataType } from '../forms-data/formsDataInterfaces';
|
|
@@ -64,7 +64,7 @@ interface IUsersApi {
|
|
|
64
64
|
]
|
|
65
65
|
* @param {string} body.authData[index].marker - Identifies the field being used. Example: "email_reg".
|
|
66
66
|
* @param {string} body.authData[index].value - Contains the value of the field. Example: "example@oneentry.cloud".
|
|
67
|
-
* @param {
|
|
67
|
+
* @param {FormDataType | FormDataType[]} body.formData - Form fields of the user. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
68
68
|
* @example
|
|
69
69
|
[
|
|
70
70
|
{
|
|
@@ -75,7 +75,7 @@ interface IUsersApi {
|
|
|
75
75
|
]
|
|
76
76
|
* @param {string} body.formData[index].marker - The marker of the field. Example: "last_name".
|
|
77
77
|
* @param {string} body.formData[index].type - The type of the field. Example: "string".
|
|
78
|
-
* @param {
|
|
78
|
+
* @param {unknown} body.formData[index].value - The value of the field, shaped by its type. Example: "Username".
|
|
79
79
|
* @param {string} body.notificationData - The notification data.
|
|
80
80
|
* @example
|
|
81
81
|
{
|
|
@@ -264,7 +264,7 @@ interface IUsersResponse {
|
|
|
264
264
|
}
|
|
265
265
|
]
|
|
266
266
|
* @property {string} formIdentifier - Marker of the form. Example: "form_12345".
|
|
267
|
-
* @property {string} total -
|
|
267
|
+
* @property {string} [total] - Deprecated, do not rely on it. A service counter that leaks into the response of a single user: always `"1"`, it carries no data about the user. The API reference does not describe it, and the field may disappear from the response. Example: "1".
|
|
268
268
|
* @property {Array<string | number>} groups - User groups.
|
|
269
269
|
* @example
|
|
270
270
|
[
|
|
@@ -287,7 +287,8 @@ interface IUserEntity {
|
|
|
287
287
|
authProviderIdentifier: string;
|
|
288
288
|
formData: FormDataType[];
|
|
289
289
|
formIdentifier: string;
|
|
290
|
-
|
|
290
|
+
/** @deprecated Service counter leaking into the response, always `"1"`; the field may disappear. */
|
|
291
|
+
total?: string;
|
|
291
292
|
groups: Array<string | number>;
|
|
292
293
|
state: Record<string, unknown>;
|
|
293
294
|
moduleFormConfigs?: Array<IFormConfig>;
|
|
@@ -306,7 +307,7 @@ interface IUserEntity {
|
|
|
306
307
|
"value": "12345"
|
|
307
308
|
}
|
|
308
309
|
]
|
|
309
|
-
* @property {
|
|
310
|
+
* @property {FormDataType | FormDataType[]} [formData] - One form field object or an array of them. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
310
311
|
* @example
|
|
311
312
|
[
|
|
312
313
|
{
|
|
@@ -338,7 +339,7 @@ interface IUserBody {
|
|
|
338
339
|
formIdentifier: string;
|
|
339
340
|
langCode?: string;
|
|
340
341
|
authData?: IAuthData[];
|
|
341
|
-
formData?:
|
|
342
|
+
formData?: FormDataType | FormDataType[];
|
|
342
343
|
notificationData?: INotificationData;
|
|
343
344
|
state?: Record<string, unknown>;
|
|
344
345
|
}
|
|
@@ -13,7 +13,7 @@ export declare const UserResponseSchema: z.ZodObject<{
|
|
|
13
13
|
authProviderIdentifier: z.ZodString;
|
|
14
14
|
formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
|
|
15
15
|
formIdentifier: z.ZodString;
|
|
16
|
-
total: z.ZodString
|
|
16
|
+
total: z.ZodOptional<z.ZodString>;
|
|
17
17
|
groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
18
18
|
state: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
19
19
|
moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
|
|
@@ -61,7 +61,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
|
|
|
61
61
|
"value": "12345"
|
|
62
62
|
}
|
|
63
63
|
]
|
|
64
|
-
* @param {
|
|
64
|
+
* @param {FormDataType | FormDataType[]} body.formData - Registration form fields: one object or an array. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
65
65
|
* @example
|
|
66
66
|
{
|
|
67
67
|
"marker": "last_name",
|
|
@@ -62,7 +62,7 @@ export default class AuthProviderApi extends AsyncModules {
|
|
|
62
62
|
"value": "12345"
|
|
63
63
|
}
|
|
64
64
|
]
|
|
65
|
-
* @param {
|
|
65
|
+
* @param {FormDataType | FormDataType[]} body.formData - Registration form fields: one object or an array. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
66
66
|
* @example
|
|
67
67
|
{
|
|
68
68
|
"marker": "last_name",
|
|
@@ -49,7 +49,7 @@ export declare const UserResponseSchema: z.ZodObject<{
|
|
|
49
49
|
authProviderIdentifier: z.ZodString;
|
|
50
50
|
formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
|
|
51
51
|
formIdentifier: z.ZodString;
|
|
52
|
-
total: z.ZodString
|
|
52
|
+
total: z.ZodOptional<z.ZodString>;
|
|
53
53
|
groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
54
54
|
state: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
55
55
|
moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { IError, ILocalizeInfo, IRating } from '../base/utils.js';
|
|
2
|
+
import type { FormDataType } from '../forms-data/formsDataInterfaces.js';
|
|
2
3
|
/**
|
|
3
4
|
* @interface IAuthProvider
|
|
4
5
|
* @description This interface defines methods for user authentication and registration through various auth providers.
|
|
@@ -198,7 +199,7 @@ interface IAuthFormData {
|
|
|
198
199
|
* @property {string} formIdentifier - Marker of the registration form. Example: "reg".
|
|
199
200
|
* @property {string} [langCode] - Language code. Default: "en_US".
|
|
200
201
|
* @property {Array} authData - Authentication fields, each with a `marker` and a `value`.
|
|
201
|
-
* @property {
|
|
202
|
+
* @property {FormDataType | FormDataType[]} formData - Registration form fields. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
202
203
|
* @property {INotificationData} notificationData - Notification contacts: `email`, `phonePush` and `phoneSMS`.
|
|
203
204
|
* @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
|
|
204
205
|
*/
|
|
@@ -206,7 +207,7 @@ interface ISignUpData {
|
|
|
206
207
|
formIdentifier: string;
|
|
207
208
|
langCode?: string;
|
|
208
209
|
authData: IAuthData[];
|
|
209
|
-
formData:
|
|
210
|
+
formData: FormDataType | FormDataType[];
|
|
210
211
|
notificationData: INotificationData;
|
|
211
212
|
}
|
|
212
213
|
/**
|
package/esm/base/validation.d.ts
CHANGED
|
@@ -74,7 +74,7 @@ export declare const UserEntitySchema: z.ZodObject<{
|
|
|
74
74
|
authProviderIdentifier: z.ZodString;
|
|
75
75
|
formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
|
|
76
76
|
formIdentifier: z.ZodString;
|
|
77
|
-
total: z.ZodString
|
|
77
|
+
total: z.ZodOptional<z.ZodString>;
|
|
78
78
|
groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
79
79
|
state: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
80
80
|
moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
|
package/esm/base/validation.js
CHANGED
|
@@ -137,7 +137,7 @@ export const UserEntitySchema = z.object({
|
|
|
137
137
|
authProviderIdentifier: z.string(),
|
|
138
138
|
formData: z.union([z.array(z.any()), z.record(z.string(), z.any())]),
|
|
139
139
|
formIdentifier: z.string(),
|
|
140
|
-
total: z.string(),
|
|
140
|
+
total: z.string().optional(),
|
|
141
141
|
groups: z.array(z.union([z.string(), z.number()])),
|
|
142
142
|
state: z.record(z.string(), z.any()),
|
|
143
143
|
moduleFormConfigs: z.array(z.any()).optional(),
|
package/esm/users/usersApi.d.ts
CHANGED
|
@@ -73,7 +73,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
|
|
|
73
73
|
]
|
|
74
74
|
* @param {string} body.authData[].marker - Identifies the field being used. Example: "email_reg".
|
|
75
75
|
* @param {string} body.authData[].value - Contains the value of the field. Example: "example@oneentry.cloud".
|
|
76
|
-
* @param {
|
|
76
|
+
* @param {FormDataType | FormDataType[]} body.formData - Form fields of the user. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
77
77
|
* @example
|
|
78
78
|
[
|
|
79
79
|
{
|
|
@@ -84,7 +84,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
|
|
|
84
84
|
]
|
|
85
85
|
* @param {string} body.formData[].marker - The marker of the field. Example: "last_name".
|
|
86
86
|
* @param {string} body.formData[].type - The type of the field. Example: "string".
|
|
87
|
-
* @param {
|
|
87
|
+
* @param {unknown} body.formData[].value - The value of the field, shaped by its type. Example: "Username".
|
|
88
88
|
* @param {string} body.notificationData - The notification data.
|
|
89
89
|
* @example
|
|
90
90
|
{
|
package/esm/users/usersApi.js
CHANGED
|
@@ -78,7 +78,7 @@ export default class UsersApi extends AsyncModules {
|
|
|
78
78
|
]
|
|
79
79
|
* @param {string} body.authData[].marker - Identifies the field being used. Example: "email_reg".
|
|
80
80
|
* @param {string} body.authData[].value - Contains the value of the field. Example: "example@oneentry.cloud".
|
|
81
|
-
* @param {
|
|
81
|
+
* @param {FormDataType | FormDataType[]} body.formData - Form fields of the user. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
82
82
|
* @example
|
|
83
83
|
[
|
|
84
84
|
{
|
|
@@ -89,7 +89,7 @@ export default class UsersApi extends AsyncModules {
|
|
|
89
89
|
]
|
|
90
90
|
* @param {string} body.formData[].marker - The marker of the field. Example: "last_name".
|
|
91
91
|
* @param {string} body.formData[].type - The type of the field. Example: "string".
|
|
92
|
-
* @param {
|
|
92
|
+
* @param {unknown} body.formData[].value - The value of the field, shaped by its type. Example: "Username".
|
|
93
93
|
* @param {string} body.notificationData - The notification data.
|
|
94
94
|
* @example
|
|
95
95
|
{
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { IAuthData,
|
|
1
|
+
import type { IAuthData, INotificationData } from '../auth-provider/authProvidersInterfaces.js';
|
|
2
2
|
import type { IError, IRating, IVectorSearchResponse } from '../base/utils.js';
|
|
3
3
|
import type { IFormConfig } from '../forms/formsInterfaces.js';
|
|
4
4
|
import type { FormDataType } from '../forms-data/formsDataInterfaces.js';
|
|
@@ -64,7 +64,7 @@ interface IUsersApi {
|
|
|
64
64
|
]
|
|
65
65
|
* @param {string} body.authData[index].marker - Identifies the field being used. Example: "email_reg".
|
|
66
66
|
* @param {string} body.authData[index].value - Contains the value of the field. Example: "example@oneentry.cloud".
|
|
67
|
-
* @param {
|
|
67
|
+
* @param {FormDataType | FormDataType[]} body.formData - Form fields of the user. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
68
68
|
* @example
|
|
69
69
|
[
|
|
70
70
|
{
|
|
@@ -75,7 +75,7 @@ interface IUsersApi {
|
|
|
75
75
|
]
|
|
76
76
|
* @param {string} body.formData[index].marker - The marker of the field. Example: "last_name".
|
|
77
77
|
* @param {string} body.formData[index].type - The type of the field. Example: "string".
|
|
78
|
-
* @param {
|
|
78
|
+
* @param {unknown} body.formData[index].value - The value of the field, shaped by its type. Example: "Username".
|
|
79
79
|
* @param {string} body.notificationData - The notification data.
|
|
80
80
|
* @example
|
|
81
81
|
{
|
|
@@ -264,7 +264,7 @@ interface IUsersResponse {
|
|
|
264
264
|
}
|
|
265
265
|
]
|
|
266
266
|
* @property {string} formIdentifier - Marker of the form. Example: "form_12345".
|
|
267
|
-
* @property {string} total -
|
|
267
|
+
* @property {string} [total] - Deprecated, do not rely on it. A service counter that leaks into the response of a single user: always `"1"`, it carries no data about the user. The API reference does not describe it, and the field may disappear from the response. Example: "1".
|
|
268
268
|
* @property {Array<string | number>} groups - User groups.
|
|
269
269
|
* @example
|
|
270
270
|
[
|
|
@@ -287,7 +287,8 @@ interface IUserEntity {
|
|
|
287
287
|
authProviderIdentifier: string;
|
|
288
288
|
formData: FormDataType[];
|
|
289
289
|
formIdentifier: string;
|
|
290
|
-
|
|
290
|
+
/** @deprecated Service counter leaking into the response, always `"1"`; the field may disappear. */
|
|
291
|
+
total?: string;
|
|
291
292
|
groups: Array<string | number>;
|
|
292
293
|
state: Record<string, unknown>;
|
|
293
294
|
moduleFormConfigs?: Array<IFormConfig>;
|
|
@@ -306,7 +307,7 @@ interface IUserEntity {
|
|
|
306
307
|
"value": "12345"
|
|
307
308
|
}
|
|
308
309
|
]
|
|
309
|
-
* @property {
|
|
310
|
+
* @property {FormDataType | FormDataType[]} [formData] - One form field object or an array of them. Field values: {@link FormDataType} — a value shaped by the field type (a string, a date object, a text object, a list, a file descriptor), not only a string. A file goes in as the descriptor `FileUploading.upload` returns: these methods do not upload a `File`/`Blob` themselves.
|
|
310
311
|
* @example
|
|
311
312
|
[
|
|
312
313
|
{
|
|
@@ -338,7 +339,7 @@ interface IUserBody {
|
|
|
338
339
|
formIdentifier: string;
|
|
339
340
|
langCode?: string;
|
|
340
341
|
authData?: IAuthData[];
|
|
341
|
-
formData?:
|
|
342
|
+
formData?: FormDataType | FormDataType[];
|
|
342
343
|
notificationData?: INotificationData;
|
|
343
344
|
state?: Record<string, unknown>;
|
|
344
345
|
}
|
|
@@ -13,7 +13,7 @@ export declare const UserResponseSchema: z.ZodObject<{
|
|
|
13
13
|
authProviderIdentifier: z.ZodString;
|
|
14
14
|
formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
|
|
15
15
|
formIdentifier: z.ZodString;
|
|
16
|
-
total: z.ZodString
|
|
16
|
+
total: z.ZodOptional<z.ZodString>;
|
|
17
17
|
groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
|
|
18
18
|
state: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
19
19
|
moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oneentry",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.175",
|
|
4
4
|
"description": "OneEntry NPM package",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "esm/index.js",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
},
|
|
49
49
|
"scripts": {
|
|
50
50
|
"prepublishOnly": "node ../scripts/smoke-pack.js --files-only",
|
|
51
|
-
"postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.
|
|
51
|
+
"postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.175"
|
|
52
52
|
},
|
|
53
53
|
"sideEffects": false,
|
|
54
54
|
"files": [
|