@veltdev/types 4.7.1 → 4.7.2

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

@@ -1,60 +0,0 @@
-export interface CrdtVersion {
-    versionId: string;
-    versionName?: string;
-    state: Uint8Array | number[];
-    timestamp: number;
-}
-export interface CrdtVersionWithEncryptedState extends Omit<CrdtVersion, 'state'> {
-    encryptedState: string;
-}
-export interface CrdtUpdateDataQuery {
-    id: string;
-    state: Uint8Array | number[];
-    data?: unknown;
-}
-export interface CrdtOnDataChangeQuery {
-    id: string;
-    callback: (data: any) => void;
-}
-export interface CrdtGetDataQuery {
-    id: string;
-}
-export interface CrdtOnStateChangeQuery {
-    id: string;
-    callback: (data: any) => void;
-}
-export interface CrdtUpdateStateQuery {
-    id: string;
-    state: Uint8Array | number[];
-}
-export interface CrdtRegisterSyncUserQuery {
-    id: string;
-}
-export interface CrdtOnRegisteredUserChangeQuery {
-    id: string;
-    callback: (data: any) => void;
-}
-export interface CrdtSetPresenceQuery {
-    id: string;
-}
-export interface CrdtOnPresenceChangeQuery {
-    id: string;
-    callback: (data: any) => void;
-}
-export interface CrdtSaveVersionQuery {
-    id: string;
-    versionId: string;
-    versionName?: string;
-    state: Uint8Array | number[];
-}
-export interface CrdtGetVersionQuery {
-    id: string;
-    versionId: string;
-}
-export interface CrdtGetVersionsQuery {
-    id: string;
-}
-export interface CrdtDeleteVersionQuery {
-    id: string;
-    versionId: string;
-}

package/app/models/data/custom-chip-dropdown.data.model.d.ts

@@ -1,10 +0,0 @@
-export type CustomAnnotationDropdownType = 'multi' | 'single';
-export declare class CustomAnnotationDropdownItem {
-    id: string;
-    label: string;
-}
-export declare class CustomAnnotationDropdownData {
-    type: CustomAnnotationDropdownType;
-    placeholder?: string;
-    data: CustomAnnotationDropdownItem[];
-}

package/app/models/data/custom-css.data.model.d.ts

@@ -1,10 +0,0 @@
-export declare class CustomCss {
-    /**
-     * Type of custom css
-     */
-    type: 'link' | 'styles';
-    /**
-     * Value of custom css
-     */
-    value: string;
-}

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

@@ -1,15 +0,0 @@
-export declare class CustomerMetadata {
-    customBranding?: CustomBranding;
-}
-export declare class CustomBranding {
-    logo?: {
-        logoMark?: {
-            lightUrl?: string;
-            darkUrl?: string;
-        };
-        wordMark?: {
-            lightUrl?: string;
-            darkUrl?: string;
-        };
-    };
-}

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

@@ -1,8 +0,0 @@
-import { DocumentMetadata } from "./document-metadata.model";
-import { FolderMetadata } from "./folder-metadata.model";
-export interface FetchDocumentsResponse {
-    data: Record<string, DocumentMetadata> | null;
-}
-export interface FetchFoldersResponse {
-    data: Record<string, FolderMetadata> | null;
-}

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

@@ -1,63 +0,0 @@
-import { DocumentMetadata } from "./document-metadata.model";
-export interface Document {
-    id: string;
-    metadata?: DocumentMetadata;
-}
-export interface SetDocumentsContext {
-    access: {
-        [key: string]: Array<string | number>;
-    };
-    accessFields?: Array<string>;
-}
-export interface SetDocumentsRequestOptions {
-    organizationId?: string;
-    folderId?: string;
-    allDocuments?: boolean;
-    locationId?: string;
-    rootDocumentId?: string;
-    context?: SetDocumentsContext;
-}
-export interface UpdateDocumentsRequest<T = unknown> {
-    organizationId?: string;
-    folderId?: string;
-    documents?: UpdateDocumentMetadata<T>[];
-}
-export interface UpdateDocumentMetadata<T = unknown> {
-    documentId: string;
-    [key: string]: T | string;
-}
-export interface UpdateLocationsRequest<T = unknown> {
-    organizationId?: string;
-    documentIds?: string[];
-    locations?: UpdateLocationMetadata<T>[];
-}
-export interface UpdateLocationMetadata<T = unknown> {
-    id: string;
-    [key: string]: T | string;
-}
-export interface FetchDocumentsRequest {
-    organizationId?: string;
-    documentIds?: string[];
-    folderId?: string;
-    allDocuments?: boolean;
-}
-export interface FetchLocationsRequest {
-    organizationId?: string;
-    documentIds?: string[];
-    folderId?: string;
-    allDocuments?: boolean;
-}
-export interface FetchFoldersRequest {
-    organizationId?: string;
-    folderId?: string;
-}
-export interface FolderConfig {
-    folderId?: string;
-    allDocuments?: boolean;
-    locationId?: string;
-    veltFolderId?: string;
-}
-export interface OrganizationConfig {
-    organizationId: string;
-    clientOrganizationId: string;
-}

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

@@ -1,12 +0,0 @@
-export interface EncryptConfig<T = any> {
-    data: T;
-    type?: string;
-}
-export interface DecryptConfig<R = any> {
-    data: R;
-    type?: string;
-}
-export interface VeltEncryptionProvider<T = any, R = any> {
-    encrypt: (config: EncryptConfig<T>) => Promise<R>;
-    decrypt: (config: DecryptConfig<R>) => Promise<T>;
-}

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

@@ -1,32 +0,0 @@
-import { DocumentMetadata } from "./document-metadata.model";
-import { SetDocumentsContext } from "./document.data.model";
-import { FolderMetadata } from "./folder-metadata.model";
-import { Location } from "./location.model";
-import { OrganizationMetadata } from "./organization-metadata.model";
-import { User } from "./user.data.model";
-export interface VeltEventMetadata {
-    organization?: OrganizationMetadata | null;
-    documents?: DocumentMetadata[];
-    locations?: Location[];
-    folderId?: string;
-}
-export interface VeltDebugInfo {
-    veltVersion?: string;
-    apiKey?: string;
-    serverMap?: {
-        organization?: OrganizationMetadata;
-        documents?: DocumentMetadata[];
-        locations?: Location[];
-        folder?: FolderMetadata;
-        user?: User;
-        accessFields?: Array<string>;
-    };
-    clientMap?: {
-        organization?: OrganizationMetadata;
-        documents?: DocumentMetadata[];
-        locations?: Location[];
-        folder?: FolderMetadata;
-        user?: User;
-        context?: SetDocumentsContext;
-    };
-}

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

@@ -1,40 +0,0 @@
-export declare class FolderMetadata {
-    folderId?: string;
-    /**
-     * Velt folder id
-     */
-    veltFolderId?: string;
-    /**
-     * Parent folder id
-     */
-    parentFolderId?: string;
-    /**
-     * Velt parent folder id
-     */
-    veltParentFolderId?: string;
-    /**
-     * Created at
-     */
-    createdAt?: number;
-    /**
-     * Last updated
-     */
-    lastUpdated?: number;
-    /**
-     * API key
-     */
-    apiKey?: string;
-    /**
-     * Organization id
-     */
-    organizationId?: string;
-    /**
-     * Client organization id
-     */
-    clientOrganizationId?: string;
-    /**
-     * Folder name
-     */
-    folderName?: string;
-    [key: string]: any;
-}

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

@@ -1,16 +0,0 @@
-import { BaseMetadata } from "./base-metadata.data.model";
-export interface Heartbeat {
-    id: string;
-    createdTimestamp: number;
-    userId: string;
-    veltUserId: string;
-    tabId: string;
-    metadata: BaseMetadata;
-    lastUpdatedTimestamp: number;
-}
-export interface HeartbeatConfig {
-    userId?: string;
-}
-export interface GetHeartbeatResponse {
-    data: Heartbeat[] | null;
-}

package/app/models/data/live-state-events.data.model.d.ts

@@ -1,23 +0,0 @@
-import { LiveStateSyncEventTypes } from "../../utils/enums";
-import { User } from "./user.data.model";
-export interface AccessRequestEvent {
-    viewer?: User;
-    editor?: User;
-    timestamp?: number;
-    status?: string;
-}
-export interface SEMEvent {
-    viewer?: User;
-    editor?: User;
-    timestamp?: number;
-    role?: string;
-}
-export type LiveStateEventTypesMap = {
-    [LiveStateSyncEventTypes.ACCESS_REQUESTED]: AccessRequestEvent;
-    [LiveStateSyncEventTypes.ACCESS_REQUEST_CANCELED]: AccessRequestEvent;
-    [LiveStateSyncEventTypes.ACCESS_ACCEPTED]: AccessRequestEvent;
-    [LiveStateSyncEventTypes.ACCESS_REJECTED]: AccessRequestEvent;
-    [LiveStateSyncEventTypes.EDITOR_ASSIGNED]: SEMEvent;
-    [LiveStateSyncEventTypes.VIEWER_ASSIGNED]: SEMEvent;
-    [LiveStateSyncEventTypes.EDITOR_ON_DIFFERENT_TAB_DETECTED]: SEMEvent;
-};

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

@@ -1,63 +0,0 @@
-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;
-    isTemporary?: boolean;
-    context?: any;
-}
-export declare class MultiThreadMetadata extends BaseMetadata {
-    [key: string]: any;
-}

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

@@ -1,9 +0,0 @@
-import { NotificationSettingsConfig } from "./notification.model";
-import { NotificationEventTypes } from "../../utils/enums";
-export interface SettingsUpdatedEvent {
-    settings: NotificationSettingsConfig;
-    isMutedAll: boolean;
-}
-export type NotificationEventTypesMap = {
-    [NotificationEventTypes.SETTINGS_UPDATED]: SettingsUpdatedEvent;
-};

package/app/models/data/organization-groups.data.model.d.ts

@@ -1,16 +0,0 @@
-import { User } from "./user.data.model";
-export declare class OrganizationUserGroup {
-    metadata: {
-        groupId: string;
-        clientGroupId: string;
-        groupName: string;
-    };
-    users: {
-        [userIdHash: string]: boolean;
-    };
-}
-export interface UserGroup {
-    groupId: string;
-    groupName: string;
-    users: User[];
-}

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

@@ -1,31 +0,0 @@
-import { DocumentMetadata } from "./document-metadata.model";
-import { PageInfo } from "./page-info.model";
-import { User } from "./user.data.model";
-export declare class OrganizationMetadata {
-    /**
-     * Unique organization id generated from client organization id
-     */
-    organizationId?: string;
-    /**
-     * API key
-     */
-    apiKey?: string;
-    /**
-     * Document id provided by client
-     */
-    clientOrganizationId?: string | number;
-    /**
-     * Page metadata
-     */
-    pageInfo?: PageInfo;
-    /**
-     *
-     */
-    documents?: {
-        [documentId: number]: DocumentMetadata;
-    };
-    /**
-     * Organization creator
-     */
-    creator?: User;
-}

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

@@ -1,5 +0,0 @@
-export interface PresenceRequestQuery {
-    documentId?: string;
-    organizationId?: string;
-    statuses?: string[];
-}

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

@@ -1,16 +0,0 @@
-import { PresenceEventTypes } from "../../utils/enums";
-import { PresenceUser } from "./presence-user.data.model";
-export interface PresenceMultipleUsersOnlineEvent {
-    users: PresenceUser[];
-}
-export interface PresenceUserStateChangeEvent {
-    user: PresenceUser;
-    state: string;
-}
-export type PresenceEventTypesMap = {
-    [PresenceEventTypes.MULTIPLE_USERS_ONLINE]: PresenceMultipleUsersOnlineEvent;
-    [PresenceEventTypes.USER_STATE_CHANGE]: PresenceUserStateChangeEvent;
-};
-export interface GetPresenceDataResponse {
-    data: PresenceUser[] | null;
-}

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

@@ -1,10 +0,0 @@
-import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
-import { AttachmentDataProvider } from "./attachment-resolver.data.model";
-import { ReactionAnnotationDataProvider } from "./reaction-resolver.data.model";
-import { UserDataProvider } from "./user-resolver.data.model";
-export interface VeltDataProvider {
-    comment?: CommentAnnotationDataProvider;
-    user?: UserDataProvider;
-    reaction?: ReactionAnnotationDataProvider;
-    attachment?: AttachmentDataProvider;
-}

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

@@ -1,68 +0,0 @@
-import { BaseMetadata } from "./base-metadata.data.model";
-import { CursorPosition } from "./cursor-position.data.model";
-import { Location } from "./location.model";
-import { PageInfo } from "./page-info.model";
-import { Reaction } from "./reaction.data.model";
-import { TargetElement } from "./target-element.data.model";
-import { Context, User } from "./user.data.model";
-export declare class ReactionAnnotation {
-    /**
-     * Unique identifier for the reaction pin annotation.
-     *
-     * Auto generated.
-     */
-    annotationId: string;
-    context?: Context;
-    /**
-     * Connected comment annotation id of reaction annotation
-     */
-    commentAnnotationId?: string;
-    reactions?: Reaction[];
-    /**
-     * Timestamp when the reaction annotation was last updated.
-     *
-     * Auto generated.
-     */
-    lastUpdated?: any;
-    /**
-     * Target element of reaction annotation
-     */
-    targetElement?: TargetElement | null;
-    /**
-     * Target element id provided by user
-     */
-    targetElementId?: string | 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;
-    /**
-     * 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;
-    from?: User;
-    icon?: string;
-    isReactionResolverUsed?: boolean;
-    iconUrl?: string;
-    iconEmoji?: string;
-    metadata?: ReactionMetadata;
-}
-export declare class ReactionMetadata extends BaseMetadata {
-    [key: string]: any;
-}
-export declare class ReactionMap {
-    [reactionId: string]: ReactionItem;
-}
-export declare class ReactionItem {
-    url?: string;
-    svg?: string;
-    emoji?: string;
-}

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

@@ -1,42 +0,0 @@
-import { ResolverActions } from "../../utils/enums";
-import { BaseMetadata } from "./base-metadata.data.model";
-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>>;
-    config?: ResolverConfig;
-}
-export interface GetReactionResolverRequest {
-    organizationId: string;
-    reactionAnnotationIds?: string[];
-    documentIds?: string[];
-    folderId?: string;
-    allDocuments?: boolean;
-}
-export interface DeleteReactionResolverRequest {
-    reactionAnnotationId: string;
-    metadata?: BaseMetadata;
-    event?: ResolverActions;
-}
-export interface SaveReactionResolverRequest {
-    reactionAnnotation: {
-        [key: string]: PartialReactionAnnotation;
-    };
-    metadata?: BaseMetadata;
-    event?: ResolverActions;
-}
-export interface PartialReactionAnnotationResult {
-    strippedData: {
-        [annotationId: string]: PartialReactionAnnotation;
-    } | null;
-    originalData: ReactionAnnotation | null;
-}
-export interface PartialReactionAnnotation {
-    annotationId: string;
-    metadata?: BaseMetadata;
-    icon?: string;
-    from?: PartialUser;
-}

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

@@ -1,18 +0,0 @@
-import { User } from "./user.data.model";
-export declare class Reaction {
-    /**
-     * Emoji variant.
-     */
-    variant?: string;
-    /**
-     * The user who added reaction.
-     *
-     */
-    from: User;
-    /**
-     * Timestamp when this reaction was added.
-     *
-     * Auto generated.
-     */
-    lastUpdated?: Date;
-}

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

@@ -1,45 +0,0 @@
-import { RecorderData } from "../../models/data/recorder-annotation.data.model";
-import { RecorderEventTypes } from "../../utils/enums";
-export interface TranscriptionDoneEvent extends RecorderData {
-}
-export interface RecordingDoneEvent extends RecorderData {
-}
-export interface RecordingDeleteEvent extends RecorderData {
-}
-export interface RecordingEditDoneEvent extends RecorderData {
-}
-export interface RecordingActionsEvent {
-    type: 'audio' | 'video' | 'screen';
-}
-export interface RecordingStartedEvent extends RecordingActionsEvent {
-}
-export interface RecordingPausedEvent extends RecordingActionsEvent {
-}
-export interface RecordingCancelledEvent extends RecordingActionsEvent {
-}
-export interface RecordingStoppedEvent extends RecordingActionsEvent {
-}
-export interface RecordingResumedEvent extends RecordingActionsEvent {
-}
-export interface RecordingErrorEvent {
-    type: string;
-    message: string;
-    recorderId?: string;
-    url?: string;
-}
-export interface RecordingSaveInitiatedEvent {
-    annotationId?: string;
-    message: string;
-    type: 'edit' | 'record';
-}
-export type RecorderEventTypesMap = {
-    [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
-    [RecorderEventTypes.RECORDING_DONE]: RecordingDoneEvent;
-    [RecorderEventTypes.RECORDING_EDIT_DONE]: RecordingEditDoneEvent;
-    [RecorderEventTypes.DELETE_RECORDING]: RecordingDeleteEvent;
-    [RecorderEventTypes.RECORDING_STARTED]: RecordingStartedEvent;
-    [RecorderEventTypes.RECORDING_PAUSED]: RecordingPausedEvent;
-    [RecorderEventTypes.RECORDING_CANCELLED]: RecordingCancelledEvent;
-    [RecorderEventTypes.RECORDING_STOPPED]: RecordingStoppedEvent;
-    [RecorderEventTypes.RECORDING_RESUMED]: RecordingResumedEvent;
-};

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

@@ -1,36 +0,0 @@
-export interface ResolverEndpointConfig {
-    url: string;
-    headers?: Record<string, string>;
-}
-export interface ResolverConfig {
-    resolveTimeout?: number;
-    saveRetryConfig?: RetryConfig;
-    deleteRetryConfig?: RetryConfig;
-    getRetryConfig?: RetryConfig;
-    resolveUsersConfig?: ResolveUsersConfig;
-    fieldsToRemove?: string[];
-    getConfig?: ResolverEndpointConfig;
-    saveConfig?: ResolverEndpointConfig;
-    deleteConfig?: ResolverEndpointConfig;
-}
-export interface ResolveUsersConfig {
-    organization?: boolean;
-    folder?: boolean;
-    document?: boolean;
-}
-export interface ResolverResponse<T> {
-    data?: T;
-    success: boolean;
-    message?: string;
-    timestamp?: number;
-    statusCode: number;
-}
-export interface RetryConfig {
-    retryCount?: number;
-    retryDelay?: number;
-    revertOnFailure?: boolean;
-}
-export interface ResolverResponseConfig {
-    revertOnFailure?: boolean;
-    isSuccess?: boolean;
-}