@veltdev/sdk 4.6.1 → 4.6.3

package/app/models/data/core-events.data.model.d.ts

@@ -3,6 +3,10 @@ import { VeltButtonClickEvent } from "./button.data.model";
 import { PermissionSource, User } from "./user.data.model";
 export type CoreEventTypesMap = {
     [CoreEventTypes.PERMISSION_PROVIDER]: PermissionProviderEvent;
+    [CoreEventTypes.USER_RESOLVER]: UserResolverEvent;
+    [CoreEventTypes.COMMENT_RESOLVER]: CommentResolverEvent;
+    [CoreEventTypes.ATTACHMENT_RESOLVER]: AttachmentResolverEvent;
+    [CoreEventTypes.REACTION_RESOLVER]: ReactionResolverEvent;
     [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
     [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
     [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
@@ -11,14 +15,50 @@ export type CoreEventTypesMap = {
 };
 export type UserUpdateEvent = User | null;
 export type DocumentInitEvent = boolean | undefined;
-export type PermissionProviderEvent = {
-    event: PermissionProviderEventType;
-    methodName?: PermissionSource;
+export declare enum UserResolverSource {
+    RESOLVE_USERS = "resolveUsers",
+    FORMAT_RESPONSE = "formatResponse",
+    MERGE_USER_WITH_PROVIDED_USER_DATA = "mergeUserWithProvidedUserData",
+    GET_TEMPORARY_USERS = "getTemporaryUsers",
+    SET_SINGLE_EDITOR_MODE_LIVE_STATE_DATA_FOR_DIFFERENT_USER_PRESENT_ON_TAB = "setSingleEditorModeLiveStateDataForDifferentUserPresentOnTab",
+    RESOLVE_AND_MERGE_SINGLE_EDITOR_LIVE_STATE_DATA_WITH_USER = "resolveAndMergeSingleEditorLiveStateDataWithUser",
+    GET_SINGLE_EDITOR_MODE_DATA = "getSingleEditorModeData",
+    RESOLVE_USERS_FROM_HUDDLE_MESSAGES = "resolveUsersFromHuddleMessages"
+}
+export declare enum CommentResolverSource {
+    RESOLVE_COMMENT_ANNOTATIONS = "resolveCommentAnnotations",
+    SAVE_COMMENT_ANNOTATION = "saveCommentAnnotation",
+    DELETE_COMMENT_ANNOTATION = "deleteCommentAnnotation",
+    FORMAT_RESPONSE = "formatResponse",
+    INIT_DOCUMENTS = "initDocuments",
+    SET_DATA = "setData",
+    UPDATE_DATA = "updateData",
+    DELETE_DATA = "deleteData"
+}
+export declare enum AttachmentResolverSource {
+    SAVE_ATTACHMENT = "saveAttachment",
+    DELETE_ATTACHMENT = "deleteAttachment",
+    UPLOAD_TO_RESOLVER = "uploadToResolver"
+}
+export declare enum ReactionResolverSource {
+    RESOLVE_REACTION_ANNOTATIONS = "resolveReactionAnnotations",
+    SAVE_REACTION_ANNOTATION = "saveReactionAnnotation",
+    DELETE_REACTION_ANNOTATION = "deleteReactionAnnotation",
+    FORMAT_RESPONSE = "formatResponse",
+    INIT_DOCUMENTS = "initDocuments",
+    SET_DATA = "setData",
+    UPDATE_DATA = "updateData",
+    DELETE_DATA = "deleteData"
+}
+export type BaseResolverEvent<TEventType, TMethodName> = {
+    event: TEventType;
+    methodName?: TMethodName;
     source?: 'internal' | 'external';
     timestamp?: number;
     uniqueId?: string;
     payload?: any;
 };
+export type PermissionProviderEvent = BaseResolverEvent<PermissionProviderEventType, PermissionSource>;
 export type PermissionProviderEventType = {
     RESOURCE_ACCESS_REQUEST_FORMED: 'resourceAccessRequestFormed';
     RESOURCE_ACCESS_REQUEST_TRIGGERED: 'resourceAccessRequestTriggered';
@@ -26,6 +66,57 @@ export type PermissionProviderEventType = {
     RESOURCE_ACCESS_ERROR: 'resourceAccessError';
     RESOURCE_ACCESS_RESULT_FROM_CACHE: 'resourceAccessResultFromCache';
 };
+export type UserResolverEvent = BaseResolverEvent<UserResolverEventType, UserResolverSource>;
+export type UserResolverEventType = {
+    USER_RESOLUTION_REQUEST_FORMED: 'userResolutionRequestFormed';
+    USER_RESOLUTION_REQUEST_TRIGGERED: 'userResolutionRequestTriggered';
+    USER_RESOLUTION_RESULT: 'userResolutionResult';
+    USER_RESOLUTION_ERROR: 'userResolutionError';
+    USER_RESOLUTION_RESULT_FROM_CACHE: 'userResolutionResultFromCache';
+};
+export type CommentResolverEvent = BaseResolverEvent<CommentResolverEventType, CommentResolverSource>;
+export type CommentResolverEventType = {
+    COMMENT_RESOLUTION_REQUEST_FORMED: 'commentResolutionRequestFormed';
+    COMMENT_RESOLUTION_REQUEST_TRIGGERED: 'commentResolutionRequestTriggered';
+    COMMENT_RESOLUTION_RESULT: 'commentResolutionResult';
+    COMMENT_RESOLUTION_ERROR: 'commentResolutionError';
+    COMMENT_RESOLUTION_RESULT_FROM_CACHE: 'commentResolutionResultFromCache';
+    COMMENT_SAVE_REQUEST_FORMED: 'commentSaveRequestFormed';
+    COMMENT_SAVE_REQUEST_TRIGGERED: 'commentSaveRequestTriggered';
+    COMMENT_SAVE_RESULT: 'commentSaveResult';
+    COMMENT_SAVE_ERROR: 'commentSaveError';
+    COMMENT_DELETE_REQUEST_FORMED: 'commentDeleteRequestFormed';
+    COMMENT_DELETE_REQUEST_TRIGGERED: 'commentDeleteRequestTriggered';
+    COMMENT_DELETE_RESULT: 'commentDeleteResult';
+    COMMENT_DELETE_ERROR: 'commentDeleteError';
+};
+export type AttachmentResolverEvent = BaseResolverEvent<AttachmentResolverEventType, AttachmentResolverSource>;
+export type AttachmentResolverEventType = {
+    ATTACHMENT_SAVE_REQUEST_FORMED: 'attachmentSaveRequestFormed';
+    ATTACHMENT_SAVE_REQUEST_TRIGGERED: 'attachmentSaveRequestTriggered';
+    ATTACHMENT_SAVE_RESULT: 'attachmentSaveResult';
+    ATTACHMENT_SAVE_ERROR: 'attachmentSaveError';
+    ATTACHMENT_DELETE_REQUEST_FORMED: 'attachmentDeleteRequestFormed';
+    ATTACHMENT_DELETE_REQUEST_TRIGGERED: 'attachmentDeleteRequestTriggered';
+    ATTACHMENT_DELETE_RESULT: 'attachmentDeleteResult';
+    ATTACHMENT_DELETE_ERROR: 'attachmentDeleteError';
+};
+export type ReactionResolverEvent = BaseResolverEvent<ReactionResolverEventType, ReactionResolverSource>;
+export type ReactionResolverEventType = {
+    REACTION_RESOLUTION_REQUEST_FORMED: 'reactionResolutionRequestFormed';
+    REACTION_RESOLUTION_REQUEST_TRIGGERED: 'reactionResolutionRequestTriggered';
+    REACTION_RESOLUTION_RESULT: 'reactionResolutionResult';
+    REACTION_RESOLUTION_ERROR: 'reactionResolutionError';
+    REACTION_RESOLUTION_RESULT_FROM_CACHE: 'reactionResolutionResultFromCache';
+    REACTION_SAVE_REQUEST_FORMED: 'reactionSaveRequestFormed';
+    REACTION_SAVE_REQUEST_TRIGGERED: 'reactionSaveRequestTriggered';
+    REACTION_SAVE_RESULT: 'reactionSaveResult';
+    REACTION_SAVE_ERROR: 'reactionSaveError';
+    REACTION_DELETE_REQUEST_FORMED: 'reactionDeleteRequestFormed';
+    REACTION_DELETE_REQUEST_TRIGGERED: 'reactionDeleteRequestTriggered';
+    REACTION_DELETE_RESULT: 'reactionDeleteResult';
+    REACTION_DELETE_ERROR: 'reactionDeleteError';
+};
 export type ErrorEvent = {
     event?: string;
     sourceMethod?: string;

package/app/models/data/user.data.model.d.ts

@@ -99,6 +99,10 @@ export declare class Options {
      * If you want to force re-login the user.
      */
     forceReset?: boolean;
+    /**
+     * If you want to throw an error if the user is not authenticated.
+     */
+    throwError?: boolean;
 }
 export interface AuthRetryConfig {
     retryCount?: number;
@@ -115,6 +119,7 @@ export interface VeltAuthProvider {
     options?: Options;
     retryConfig?: AuthRetryConfig;
     generateToken?: () => Promise<string>;
+    onError?: (err: unknown) => void;
 }
 export declare enum RevokeAccessOnType {
     DOCUMENT_UNSET = "document_unset",

package/app/utils/enums.d.ts

@@ -72,6 +72,10 @@ export declare const RecorderEventTypes: {
 };
 export declare const CoreEventTypes: {
     readonly PERMISSION_PROVIDER: "permissionProvider";
+    readonly USER_RESOLVER: "userResolver";
+    readonly COMMENT_RESOLVER: "commentResolver";
+    readonly ATTACHMENT_RESOLVER: "attachmentResolver";
+    readonly REACTION_RESOLVER: "reactionResolver";
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
     readonly USER_UPDATE: "userUpdate";
     readonly INIT_UPDATE: "initUpdate";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "4.6.1",
+    "version": "4.6.3",
     "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
     "homepage": "https://velt.dev",
     "keywords": [