@veltdev/types-dev 4.0.0-beta.10 → 4.0.0-beta.100

package/app/client/snippyly.model.d.ts

@@ -27,6 +27,7 @@ import { ReactionElement } from "../models/element/reaction-element.model";
 import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
 import { CoreEventTypesMap } from "../models/data/core-events.data.model";
 import { Document, SetDocumentsRequestOptions } from "../models/data/document.data.model";
+import { UserDataProvider } from "../models/data/user-resolver.data.model";
 export declare class Snippyly {
   constructor();
   initConfig: (apiKey: string, config?: Config) => void;
@@ -57,6 +58,14 @@ export declare class Snippyly {
    * To unset the document id
    */
   unsetDocumentId: () => void;
+  /**
+   * To unset the documents
+   */
+  unsetDocuments: () => void;
+  /**
+   * To set the user data provider.
+   */
+  setUserDataProvider: (userDataProvider: UserDataProvider) => void;
   /**
    * Get Document ID
    */

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

@@ -0,0 +1,51 @@
+import { AnnotationProperty } from "./annotation-property.data.model";
+import { CursorPosition } from "./cursor-position.data.model";
+import { Location } from "./location.model";
+import { PageInfo } from "./page-info.model";
+import { TargetElement } from "./target-element.data.model";
+import { User } from "./user.data.model";
+export declare class ArrowAnnotation {
+    /**
+     * Unique identifier for the arrow pin annotation.
+     *
+     * Auto generated.
+     */
+    annotationId: string;
+    /**
+     * The user who created this arrow pin annotation.
+     *
+     */
+    from: User;
+    /**
+     * Color used for the arrow pin annotation.
+     *
+     */
+    color?: string;
+    /**
+     * Timestamp when the arrow annotation was last updated.
+     *
+     * Auto generated.
+     */
+    lastUpdated?: any;
+    /**
+     * Target element of attached annotation.
+     */
+    targetElement?: TargetElement | null;
+    position?: CursorPosition | null;
+    /**
+     * Unique location id generated from provided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    type?: string;
+    props: AnnotationProperty;
+    /**
+     * To maintain index of current annotation in available list of annotations
+     * It will start from 1, so no need to add 1 in that.
+     */
+    annotationIndex?: number;
+    pageInfo?: PageInfo;
+}

package/app/models/data/base-metadata.data.model.d.ts

@@ -4,4 +4,6 @@ export declare class BaseMetadata {
     clientDocumentId?: string;
     organizationId?: string;
     clientOrganizationId?: string;
+    folderId?: string;
+    veltFolderId?: string;
 }

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

@@ -9,8 +9,10 @@ import { User } from "./user.data.model";
 export interface RequestOptions {
     organizationId?: string;
     documentId?: string;
+    folderId?: string;
     filters?: any;
     documentIds?: string[];
+    allDocuments?: boolean;
 }
 export interface UpdatePriorityRequest {
     annotationId: string;
@@ -128,6 +130,12 @@ export interface GetRecordingRequest {
     commentId: number;
     options?: RequestOptions;
 }
+export interface GetDocumentsRequest {
+    options?: RequestOptions;
+}
+export interface GetFoldersRequest {
+    options?: RequestOptions;
+}
 export interface DeleteRecordingRequest {
     annotationId: string;
     commentId: number;
@@ -161,3 +169,15 @@ export interface ToggleReactionRequest {
     };
     options?: RequestOptions;
 }
+export interface GetCommentAnnotationsRequest {
+    createdAfter?: number;
+    createdBefore?: number;
+    updatedAfter?: number;
+    updatedBefore?: number;
+    statusIds?: string[];
+    order?: 'asc' | 'desc';
+    pageToken?: string;
+    groupByDocumentId?: boolean;
+    pageSize?: number;
+    options?: RequestOptions;
+}

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

@@ -52,6 +52,7 @@ export declare class Config {
 }
 export interface ExtendedFirebaseOptions extends FirebaseOptions {
     storeDbId: string;
+    region?: string;
 }
 export interface AdvancedQueries {
     advancedQueriesEnabled: boolean;

package/app/models/data/document-metadata.model.d.ts

@@ -6,6 +6,14 @@ export declare class DocumentMetadata {
      * Unique document id generated from client document id
      */
     documentId?: string;
+    /**
+     * Folders
+     */
+    folderId?: string;
+    /**
+     * Velt folder id
+     */
+    veltFolderId?: string;
     /**
      * API key
      */

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

@@ -5,4 +5,7 @@ export interface Document {
 }
 export interface SetDocumentsRequestOptions {
     organizationId?: string;
+    folderId?: string;
+    allDocuments?: boolean;
+    locationId?: string;
 }

package/app/models/data/multi-thread.data.model.d.ts

@@ -0,0 +1,61 @@
+import { BaseMetadata } from "./base-metadata.data.model";
+import { CommentAnnotation, GhostComment, InlineCommentSectionConfig } from "./comment-annotation.data.model";
+import { CursorPosition } from "./cursor-position.data.model";
+import { Location } from "./location.model";
+import { TargetElement } from "./target-element.data.model";
+import { TargetTextRange } from "./target-text-range.data.model";
+import { User } from "./user.data.model";
+export declare class MultiThreadCommentAnnotation {
+    /**
+     * The id of the annotation.
+     */
+    annotationId: string;
+    /**
+     * The id of the area annotation.
+     */
+    areaAnnotationId?: string;
+    /**
+     * The target element of the annotation.
+     */
+    targetElement?: TargetElement | null;
+    /**
+     * The id of the target element.
+     */
+    targetElementId?: string | null;
+    /**
+     * Selected text range of comment annotation
+     */
+    targetTextRange?: TargetTextRange | null;
+    /**
+     * The id of the target inline comment element.
+     */
+    targetInlineCommentElementId?: string;
+    /**
+     * The inline comment section config.
+     */
+    inlineCommentSectionConfig?: InlineCommentSectionConfig;
+    commentAnnotations?: {
+        [commentAnnotationId: string]: boolean;
+    };
+    commentAnnotationsMap?: {
+        [commentAnnotationId: string]: CommentAnnotation;
+    };
+    /**
+     * Unique location id generated from provided location
+     */
+    locationId?: number | null;
+    /**
+     * Set location to identify user on sub document
+     */
+    location?: Location | null;
+    position?: CursorPosition | null;
+    ghostComment?: GhostComment | null;
+    from: User;
+    type: string;
+    isDraft?: boolean;
+    sourceId?: string;
+    metadata?: MultiThreadMetadata;
+}
+export declare class MultiThreadMetadata extends BaseMetadata {
+    [key: string]: any;
+}

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

@@ -88,6 +88,11 @@ export declare class NotificationRawData {
         [key: string]: any;
     };
     displayBodyMessage?: string;
+    displayBodyMessageTemplate?: string;
+    displayBodyMessageTemplateData?: {
+        users?: User[];
+        [key: string]: any;
+    };
     customData?: any;
     notifyUsers?: {
         [email: string]: boolean;
@@ -127,6 +132,17 @@ export declare class Notification {
      * Notification body message
      */
     displayBodyMessage?: string;
+    /**
+       * Display body message template
+       */
+    displayBodyMessageTemplate?: string;
+    /**
+     * Display body message template data
+     */
+    displayBodyMessageTemplateData?: {
+        users?: User[];
+        [key: string]: any;
+    };
     /**
      * Display message template
      */

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

@@ -164,4 +164,10 @@ export declare class RecorderData {
     assets: RecorderDataAsset[];
     transcription: RecorderDataTranscription;
 }
+export interface RecorderRequestQuery {
+    recorderIds: string[];
+}
+export interface GetRecordingDataResponse {
+    data: Record<string, RecorderData> | null;
+}
 export {};

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

@@ -0,0 +1,16 @@
+import { RecorderEventTypes } from "../../utils/enums";
+export interface TranscriptionDoneEvent {
+    transcription: string;
+    id?: string;
+    tag?: string;
+    type?: string;
+    thumbnailUrl?: string;
+    thumbnailWithPlayIconUrl?: string;
+    videoUrl?: string;
+    audioUrl?: string;
+    videoPlayerUrl?: string;
+    getThumbnailTag?: (url?: string) => string;
+}
+export type RecorderEventTypesMap = {
+    [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
+};

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

@@ -0,0 +1,5 @@
+import { User } from "./user.data.model";
+export interface UserDataProvider {
+    getUsers(userIds: string[]): Promise<Record<string, User>>;
+    resolveTimeout?: number;
+}

package/app/models/element/recorder-element.model.d.ts

@@ -1,6 +1,7 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
-import { RecorderData } from "../data/recorder-annotation.data.model";
+import { RecorderData, RecorderRequestQuery, GetRecordingDataResponse } from "../data/recorder-annotation.data.model";
+import { RecorderEventTypesMap } from "../data/recorder-events.data.model";
 
 export declare class RecorderElement {
 
@@ -33,6 +34,16 @@ export declare class RecorderElement {
      */
     disableRecordingTranscription: () => void;
 
+    /**
+     * Subscribe to recorder actions
+     */
+    public on: <T extends keyof RecorderEventTypesMap>(action: T) => Observable<RecorderEventTypesMap[T]>;
+
+    /**
+     * To get recording data by recorder ids
+     */
+    getRecordingData: (query: RecorderRequestQuery) => Promise<GetRecordingDataResponse>;
+
     constructor();
 
     private _initRecording;
@@ -63,4 +74,14 @@ export declare class RecorderElement {
      * To disable recording transcription
      */
     private _disableRecordingTranscription;
+
+    /**
+     * Subscribe to recorder actions
+     */
+    private _on;
+
+    /**
+     * To get recording data by recorder ids
+     */
+    private _getRecordingData;
 }

package/app/utils/constants.d.ts

@@ -8,7 +8,9 @@ export declare class Constants {
     static LOCALSTORAGE_DATA_ID: string;
     static NO_ORGANIZATION_ID: string;
     static DEFAULT_QUERY_HASH: string;
+    static LISTENER_BATCH_SIZE: number;
     static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
+    static FIREBASE_PARTIAL_PATH_FOLDERS: string;
     static FIREBASE_PARTIAL_PATH_DOCS: string;
     static FIREBASE_PARTIAL_PATH_PRESENCE: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATION_USERS: string;
@@ -242,8 +244,8 @@ export declare class Constants {
         VELT_COMMENT_DIALOG_BODY_THREAD_CARD: string;
         VELT_COMMENT_DIALOG_PRIVATE_BANNER: string;
         VELT_COMMENT_COMPOSER: string;
+        VELT_SKELETON_LOADER: string;
         VELT_SHADOW_DOM_INTERNAL: string;
-        VELT_OVERLAY: string;
     };
     static ATTRIBUTES: {
         VELT_TARGET_COMMENT_ELEMENT_ID: string;

package/app/utils/enums.d.ts

@@ -42,10 +42,14 @@ export declare const CommentEventTypes: {
     readonly COMMENT_SIDEBAR_DATA_INIT: "commentSidebarDataInit";
     readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
 };
+export declare const RecorderEventTypes: {
+    readonly TRANSCRIPTION_DONE: "transcriptionDone";
+};
 export declare const CoreEventTypes: {
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
 };
 export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
+export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
 export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
 export declare enum TagStatus {
     ADDED = "added",

package/models.d.ts

@@ -1,6 +1,7 @@
 export * from './app/utils/enums';
 export * from './app/models/data/attachment.model';
 export * from './app/models/data/area-annotation.data.model';
+export * from './app/models/data/arrow-annotation.data.model';
 export * from './app/models/data/base-metadata.data.model';
 export * from './app/models/data/button.data.model';
 export * from './app/models/data/chatgpt.data.model';
@@ -28,12 +29,14 @@ export * from './app/models/data/localstorage.data.model';
 export * from './app/models/data/location-metadata.model';
 export * from './app/models/data/location.model';
 export * from './app/models/data/media-preview-config.data.model';
+export * from './app/models/data/multi-thread.data.model';
 export * from './app/models/data/notification.model';
 export * from './app/models/data/page-info.model';
 export * from './app/models/data/permission.data.model';
 export * from './app/models/data/presence-user.data.model';
 export * from './app/models/data/recorder.model';
 export * from './app/models/data/recorder-annotation.data.model';
+export * from './app/models/data/recorder-events.data.model';
 export * from './app/models/data/rewriter-annotation.data.model';
 export * from './app/models/data/screen-size.data.model';
 export * from './app/models/data/selection.model';
@@ -62,3 +65,4 @@ export * from './app/models/data/organization-groups.data.model';
 export * from './app/models/data/organization-metadata.model';
 export * from './app/models/data/user-organization.data.model';
 export * from './app/models/data/event-metadata.data.model';
+export * from './app/models/data/user-resolver.data.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/types-dev",
-    "version": "4.0.0-beta.10",
+    "version": "4.0.0-beta.100",
     "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": [