skapi-js 2.2.6 → 2.2.8

package/dist/skapi.d.mts

@@ -10,8 +10,18 @@ declare class SkapiError extends Error {
 }
 
 type Condition = 'gt' | 'gte' | 'lt' | 'lte' | 'eq' | '>' | '>=' | '<' | '<=' | '=';
+/**
+ * ICE servers for a WebRTC connection: one url (default "stun:stun.skapi.com:3468"), or a list of
+ * { urls, username?, credential? }. A TURN relay, for users whose network blocks direct
+ * connections, goes in the list with its login; keep a STUN entry beside it.
+ */
+type RTCIceOption = string | Array<{
+    urls: string | string[];
+    username?: string;
+    credential?: string;
+}>;
 type RTCReceiverParams = {
-    ice?: string;
+    ice?: RTCIceOption;
     media?: {
         video: boolean;
         audio: boolean;
@@ -19,7 +29,7 @@ type RTCReceiverParams = {
 };
 type RTCConnectorParams = {
     cid: string;
-    ice?: string;
+    ice?: RTCIceOption;
     media?: {
         video: boolean;
         audio: boolean;
@@ -333,6 +343,8 @@ type NewsletterGroup = {
      */
     endpoint: string;
 };
+/** The public visibility flags: set when an account is created, the user's own afterwards; never changed by an admin's updateUserAttributes(). */
+type UserVisibilityFlag = 'email_public' | 'phone_number_public' | 'address_public' | 'gender_public' | 'birthdate_public';
 type UserAttributes = {
     /** User's name */
     name?: string;
@@ -1300,6 +1312,7 @@ type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
 type Types_RTCConnectorParams = RTCConnectorParams;
 type Types_RTCEvent = RTCEvent;
+type Types_RTCIceOption = RTCIceOption;
 type Types_RTCReceiverParams = RTCReceiverParams;
 type Types_RTCResolved = RTCResolved;
 type Types_RealtimeCallback = RealtimeCallback;
@@ -1325,9 +1338,10 @@ type Types_UploadFilesResult = UploadFilesResult;
 type Types_UserAttributes = UserAttributes;
 type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
+type Types_UserVisibilityFlag = UserVisibilityFlag;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_PostRecordsItem as PostRecordsItem, Types_PostRecordsResult as PostRecordsResult, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_PostRecordsItem as PostRecordsItem, Types_PostRecordsResult as PostRecordsResult, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCIceOption as RTCIceOption, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_UserVisibilityFlag as UserVisibilityFlag, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -2263,10 +2277,10 @@ declare class Skapi {
      * login another account holds without having verified the address blocks
      * nothing; it is removed, and that account keeps the login ID it was created
      * with.
-     * @param params Target user_id and the attributes to update.
+     * @param params Target user_id and the attributes to update. Not the `*_public` visibility flags: they are set when the account is created and are the user's own afterwards; the backend refuses them from an admin.
      * @returns A promise that resolves to Promise<'SUCCESS: User attributes updated.'>.
      */
-    updateUserAttributes(params: UserAttributes & {
+    updateUserAttributes(params: Omit<UserAttributes, UserVisibilityFlag> & {
         user_id: string;
     }): Promise<'SUCCESS: User attributes updated.'>;
     /**

package/dist/skapi.d.ts

@@ -10,8 +10,18 @@ declare class SkapiError extends Error {
 }
 
 type Condition = 'gt' | 'gte' | 'lt' | 'lte' | 'eq' | '>' | '>=' | '<' | '<=' | '=';
+/**
+ * ICE servers for a WebRTC connection: one url (default "stun:stun.skapi.com:3468"), or a list of
+ * { urls, username?, credential? }. A TURN relay, for users whose network blocks direct
+ * connections, goes in the list with its login; keep a STUN entry beside it.
+ */
+type RTCIceOption = string | Array<{
+    urls: string | string[];
+    username?: string;
+    credential?: string;
+}>;
 type RTCReceiverParams = {
-    ice?: string;
+    ice?: RTCIceOption;
     media?: {
         video: boolean;
         audio: boolean;
@@ -19,7 +29,7 @@ type RTCReceiverParams = {
 };
 type RTCConnectorParams = {
     cid: string;
-    ice?: string;
+    ice?: RTCIceOption;
     media?: {
         video: boolean;
         audio: boolean;
@@ -333,6 +343,8 @@ type NewsletterGroup = {
      */
     endpoint: string;
 };
+/** The public visibility flags: set when an account is created, the user's own afterwards; never changed by an admin's updateUserAttributes(). */
+type UserVisibilityFlag = 'email_public' | 'phone_number_public' | 'address_public' | 'gender_public' | 'birthdate_public';
 type UserAttributes = {
     /** User's name */
     name?: string;
@@ -1300,6 +1312,7 @@ type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
 type Types_RTCConnectorParams = RTCConnectorParams;
 type Types_RTCEvent = RTCEvent;
+type Types_RTCIceOption = RTCIceOption;
 type Types_RTCReceiverParams = RTCReceiverParams;
 type Types_RTCResolved = RTCResolved;
 type Types_RealtimeCallback = RealtimeCallback;
@@ -1325,9 +1338,10 @@ type Types_UploadFilesResult = UploadFilesResult;
 type Types_UserAttributes = UserAttributes;
 type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
+type Types_UserVisibilityFlag = UserVisibilityFlag;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_PostRecordsItem as PostRecordsItem, Types_PostRecordsResult as PostRecordsResult, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_PostRecordsItem as PostRecordsItem, Types_PostRecordsResult as PostRecordsResult, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCIceOption as RTCIceOption, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_UserVisibilityFlag as UserVisibilityFlag, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -2263,10 +2277,10 @@ declare class Skapi {
      * login another account holds without having verified the address blocks
      * nothing; it is removed, and that account keeps the login ID it was created
      * with.
-     * @param params Target user_id and the attributes to update.
+     * @param params Target user_id and the attributes to update. Not the `*_public` visibility flags: they are set when the account is created and are the user's own afterwards; the backend refuses them from an admin.
      * @returns A promise that resolves to Promise<'SUCCESS: User attributes updated.'>.
      */
-    updateUserAttributes(params: UserAttributes & {
+    updateUserAttributes(params: Omit<UserAttributes, UserVisibilityFlag> & {
         user_id: string;
     }): Promise<'SUCCESS: User attributes updated.'>;
     /**