@veltdev/sdk-staging 5.0.2-beta.21 → 5.0.2-beta.22

package/app/models/data/attachment-resolver.data.model.d.ts

@@ -1,8 +1,8 @@
 import { ResolverActions } from "../../utils/enums";
 import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface AttachmentDataProvider {
-    save: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
-    delete: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    save?: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
+    delete?: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
     config?: ResolverConfig;
 }
 export interface DeleteAttachmentResolverRequest {

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

@@ -53,6 +53,7 @@ export interface UploadFileOptions {
     file: File;
     useAttachmentResolver?: boolean;
     metadata?: any;
+    attachmentScope?: string;
 }
 export interface UploadFileData {
     files: File[];

package/app/models/data/comment-resolver.data.model.d.ts

@@ -4,9 +4,9 @@ import { BaseMetadata } from "./base-metadata.data.model";
 import { CommentAnnotation } from "./comment-annotation.data.model";
 import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface CommentAnnotationDataProvider {
-    get: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
-    save: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
-    delete: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    get?: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
+    save?: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    delete?: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
     config?: ResolverConfig;
 }
 export interface GetCommentResolverRequest {

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

@@ -7,6 +7,7 @@ export type CoreEventTypesMap = {
     [CoreEventTypes.COMMENT_RESOLVER]: CommentResolverEvent;
     [CoreEventTypes.ATTACHMENT_RESOLVER]: AttachmentResolverEvent;
     [CoreEventTypes.REACTION_RESOLVER]: ReactionResolverEvent;
+    [CoreEventTypes.RECORDER_RESOLVER]: RecorderResolverEvent;
     [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
     [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
     [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
@@ -147,6 +148,35 @@ export type ReactionResolverEventType = {
     REACTION_DELETE_RESULT: 'reactionDeleteResult';
     REACTION_DELETE_ERROR: 'reactionDeleteError';
 };
+export declare enum RecorderResolverSource {
+    RESOLVE_RECORDER_ANNOTATIONS = "resolveRecorderAnnotations",
+    SAVE_RECORDER_ANNOTATION = "saveRecorderAnnotation",
+    DELETE_RECORDER_ANNOTATION = "deleteRecorderAnnotation",
+    FORMAT_RESPONSE = "formatResponse",
+    INIT_DOCUMENTS = "initDocuments",
+    SET_DATA = "setData",
+    UPDATE_DATA = "updateData",
+    DELETE_DATA = "deleteData"
+}
+export declare enum RecorderResolverModuleName {
+    GET_RECORDER_ANNOTATIONS = "getRecorderAnnotations"
+}
+export type RecorderResolverEvent = BaseResolverEvent<RecorderResolverEventType, RecorderResolverSource, RecorderResolverModuleName>;
+export type RecorderResolverEventType = {
+    RECORDER_RESOLUTION_REQUEST_FORMED: 'recorderResolutionRequestFormed';
+    RECORDER_RESOLUTION_REQUEST_TRIGGERED: 'recorderResolutionRequestTriggered';
+    RECORDER_RESOLUTION_RESULT: 'recorderResolutionResult';
+    RECORDER_RESOLUTION_ERROR: 'recorderResolutionError';
+    RECORDER_RESOLUTION_RESULT_FROM_CACHE: 'recorderResolutionResultFromCache';
+    RECORDER_SAVE_REQUEST_FORMED: 'recorderSaveRequestFormed';
+    RECORDER_SAVE_REQUEST_TRIGGERED: 'recorderSaveRequestTriggered';
+    RECORDER_SAVE_RESULT: 'recorderSaveResult';
+    RECORDER_SAVE_ERROR: 'recorderSaveError';
+    RECORDER_DELETE_REQUEST_FORMED: 'recorderDeleteRequestFormed';
+    RECORDER_DELETE_REQUEST_TRIGGERED: 'recorderDeleteRequestTriggered';
+    RECORDER_DELETE_RESULT: 'recorderDeleteResult';
+    RECORDER_DELETE_ERROR: 'recorderDeleteError';
+};
 export type ErrorEvent = {
     event?: string;
     sourceMethod?: string;

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

@@ -1,6 +1,7 @@
 import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
 import { AttachmentDataProvider } from "./attachment-resolver.data.model";
 import { ReactionAnnotationDataProvider } from "./reaction-resolver.data.model";
+import { RecorderAnnotationDataProvider } from "./recorder-resolver.data.model";
 import { AnonymousUserDataProvider, UserDataProvider } from "./user-resolver.data.model";
 export interface VeltDataProvider {
     comment?: CommentAnnotationDataProvider;
@@ -8,4 +9,5 @@ export interface VeltDataProvider {
     reaction?: ReactionAnnotationDataProvider;
     attachment?: AttachmentDataProvider;
     anonymousUser?: AnonymousUserDataProvider;
+    recorder?: RecorderAnnotationDataProvider;
 }

package/app/models/data/reaction-resolver.data.model.d.ts

@@ -4,9 +4,9 @@ import { PartialUser } from "./comment-resolver.data.model";
 import { ReactionAnnotation } from "./reaction-annotation.data.model";
 import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface ReactionAnnotationDataProvider {
-    get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
-    save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
-    delete: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
+    get?: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
+    save?: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
+    delete?: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
     config?: ResolverConfig;
 }
 export interface GetReactionResolverRequest {

package/app/models/data/recorder-annotation.data.model.d.ts

@@ -150,6 +150,17 @@ export declare class RecorderAnnotation {
     chunkUrls?: {
         [key: number]: string;
     };
+    /**
+     * Whether the recorder resolver is used for this annotation.
+     * Used by UI components to show loading states while resolver data is being fetched.
+     */
+    isRecorderResolverUsed?: boolean;
+    /**
+     * Whether the real recording URL is available.
+     * Set to false when the annotation is first saved (URL is still a local blob),
+     * and true once the actual URL from storage is available after the async upload completes.
+     */
+    isUrlAvailable?: boolean;
 }
 export interface RecorderAnnotationEditVersion {
     from?: User;

package/app/models/data/recorder-resolver.data.model.d.ts

@@ -0,0 +1,58 @@
+import { ResolverActions } from "../../utils/enums";
+import { AttachmentDataProvider } from "./attachment-resolver.data.model";
+import { BaseMetadata } from "./base-metadata.data.model";
+import { RecorderAnnotation } from "./recorder-annotation.data.model";
+import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
+import { Attachment } from "./attachment.model";
+import { Transcription } from "./transcription.data.model";
+import { User } from "./user.data.model";
+export interface RecorderAnnotationDataProvider {
+    get?: (request: GetRecorderResolverRequest) => Promise<ResolverResponse<Record<string, PartialRecorderAnnotation>>>;
+    save?: (request: SaveRecorderResolverRequest) => Promise<ResolverResponse<SaveRecorderResolverData | undefined>>;
+    delete?: (request: DeleteRecorderResolverRequest) => Promise<ResolverResponse<undefined>>;
+    config?: ResolverConfig;
+    uploadChunks?: boolean;
+    storage?: AttachmentDataProvider;
+}
+export interface GetRecorderResolverRequest {
+    organizationId: string;
+    recorderAnnotationIds?: string[];
+    documentIds?: string[];
+}
+export interface SaveRecorderResolverRequest {
+    recorderAnnotation: Record<string, PartialRecorderAnnotation>;
+    event?: ResolverActions;
+    metadata?: BaseMetadata;
+}
+export interface SaveRecorderResolverData {
+    transcription?: Transcription;
+    attachment?: Attachment | null;
+    attachments?: Attachment[];
+}
+export interface DeleteRecorderResolverRequest {
+    recorderAnnotationId: string;
+    metadata?: BaseMetadata;
+    event?: ResolverActions;
+}
+export interface PartialRecorderAnnotation {
+    annotationId: string;
+    metadata?: BaseMetadata;
+    from?: User;
+    transcription?: Transcription;
+    attachment?: Attachment | null;
+    attachments?: Attachment[];
+    chunkUrls?: Record<number, string>;
+    recordingEditVersions?: Record<number, PartialRecorderAnnotationEditVersion>;
+    [key: string]: any;
+}
+export interface PartialRecorderAnnotationEditVersion {
+    from?: User;
+    attachment?: Attachment | null;
+    attachments?: Attachment[];
+    transcription?: Transcription;
+}
+export interface PartialRecorderAnnotationResult {
+    strippedData: Record<string, PartialRecorderAnnotation> | null;
+    originalData: RecorderAnnotation | null;
+    eventType?: ResolverActions;
+}

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

@@ -9,6 +9,7 @@ export interface ResolverConfig {
     getRetryConfig?: RetryConfig;
     resolveUsersConfig?: ResolveUsersConfig;
     fieldsToRemove?: string[];
+    additionalFields?: string[];
     getConfig?: ResolverEndpointConfig;
     saveConfig?: ResolverEndpointConfig;
     deleteConfig?: ResolverEndpointConfig;

package/app/utils/enums.d.ts

@@ -25,7 +25,10 @@ export declare enum ResolverActions {
     REACTION_ADD = "reaction.add",
     REACTION_DELETE = "reaction.delete",
     ATTACHMENT_ADD = "attachment.add",
-    ATTACHMENT_DELETE = "attachment.delete"
+    ATTACHMENT_DELETE = "attachment.delete",
+    RECORDER_ANNOTATION_ADD = "recorder_annotation.add",
+    RECORDER_ANNOTATION_UPDATE = "recorder_annotation.update",
+    RECORDER_ANNOTATION_DELETE = "recorder_annotation.delete"
 }
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
@@ -87,6 +90,7 @@ export declare const CoreEventTypes: {
     readonly COMMENT_RESOLVER: "commentResolver";
     readonly ATTACHMENT_RESOLVER: "attachmentResolver";
     readonly REACTION_RESOLVER: "reactionResolver";
+    readonly RECORDER_RESOLVER: "recorderResolver";
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
     readonly USER_UPDATE: "userUpdate";
     readonly INIT_UPDATE: "initUpdate";

package/models.d.ts

@@ -72,6 +72,7 @@ export * from './app/models/data/views.data.model';
 export * from './app/models/data/autocomplete.data.model';
 export * from './app/models/data/reaction-annotation.data.model';
 export * from './app/models/data/reaction-resolver.data.model';
+export * from './app/models/data/recorder-resolver.data.model';
 export * from './app/models/data/attachment-resolver.data.model';
 export * from './app/models/data/reaction.data.model';
 export * from './app/models/data/organization-groups.data.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk-staging",
-    "version": "5.0.2-beta.21",
+    "version": "5.0.2-beta.22",
     "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": [