@veltdev/types-dev 4.5.8-beta.2 → 4.5.8-beta.20

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

@@ -25,7 +25,7 @@ import { UserContact } from "../models/data/user-contact.data.model";
 import { DocumentMetadata } from "../models/data/document-metadata.model";
 import { ReactionElement } from "../models/element/reaction-element.model";
 import { CrdtElement } from "../models/element/crdt-element.model";
-import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
+import { VeltEventMetadata, VeltDebugInfo } from "../models/data/event-metadata.data.model";
 import { CoreEventTypesMap } from "../models/data/core-events.data.model";
 import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest, UpdateLocationsRequest } from "../models/data/document.data.model";
 import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
@@ -243,6 +243,15 @@ export declare class Snippyly {
     * Get the metadata of the current resource.
     */
    getMetadata: () => Promise<VeltEventMetadata | null>;
+   /**
+    * To fetch debug info.
+    */
+   fetchDebugInfo: () => Promise<VeltDebugInfo | null>;
+   /**
+    * To subscribe to debug info.
+    */
+   getDebugInfo: () => Observable<VeltDebugInfo | null>;
+
    /**
     * To signout a user
     */

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

@@ -1,16 +1,21 @@
 import { DocumentMetadata } from "./document-metadata.model";
-import { Context } from "./user.data.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?: Context;
+    context?: SetDocumentsContext;
 }
 export interface UpdateDocumentsRequest<T = unknown> {
     organizationId?: string;

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

@@ -1,9 +1,29 @@
 import { DocumentMetadata } from "./document-metadata.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;
+    };
+    clientMap?: {
+        organization?: OrganizationMetadata;
+        documents?: DocumentMetadata[];
+        locations?: Location[];
+        folder?: FolderMetadata;
+        user?: User;
+    };
+}

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

@@ -0,0 +1,10 @@
+import { AreaAnnotation } from "./area-annotation.data.model";
+import { CommentAnnotation } from "./comment-annotation.data.model";
+export interface ScreenshotData {
+    source?: string;
+    sourceData?: {
+        commentAnnotation?: CommentAnnotation;
+        areaAnnotation?: AreaAnnotation;
+    };
+    eventType: string;
+}

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

@@ -11,6 +11,7 @@ export declare class UserIAM {
      * The user's contact details
      */
     user: UserContact;
+    accessFields?: string[];
     documentIds?: string[];
     viewerDocumentIds?: string[];
     folderIds?: string[];

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

@@ -106,14 +106,13 @@ export interface AuthRetryConfig {
 }
 export interface Context {
     access: {
-        [key: string]: Array<string | number> | null;
+        [key: string]: string | number;
     };
     accessFields?: Array<string>;
 }
 export interface VeltAuthProvider {
     user: User;
     options?: Options;
-    context?: Context;
     retryConfig?: AuthRetryConfig;
     generateToken?: () => Promise<string>;
 }
@@ -133,24 +132,31 @@ export interface RevokeAccessOn {
 }
 export interface VeltPermissionProvider {
     retryConfig?: AuthRetryConfig;
-    isProviderEnabled?: boolean;
+    isContextEnabled?: boolean;
     revokeAccessOn?: RevokeAccessOn[];
     forceRefresh?: boolean;
 }
+export declare enum PermissionResourceType {
+    FOLDER = "folder",
+    DOCUMENT = "document",
+    ORGANIZATION = "organization",
+    CONTEXT = "context"
+}
 export interface PermissionQuery {
     userId: string;
     resource: {
         id: string;
-        type: 'folder' | 'document' | 'organization';
+        type: PermissionResourceType;
         source: PermissionSource;
         organizationId: string;
+        context?: Context;
     };
 }
 export interface PermissionResult {
     userId: string;
     resourceId: string;
     organizationId: string;
-    type: 'folder' | 'document' | 'organization';
+    type: PermissionResourceType;
     accessRole?: UserPermissionAccessRole;
     expiresAt?: number;
     hasAccess: boolean;

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

@@ -562,7 +562,7 @@ export declare class CommentElement {
    * To select comment by annotation id
    * @param annotationId Comment annotation id
    */
-  public selectCommentByAnnotationId: (annotationId: string) => void;
+  public selectCommentByAnnotationId: (annotationId?: string) => void;
 
   /**
    * To enable showing recording summary in comments
@@ -1259,6 +1259,16 @@ export declare class CommentElement {
    */
   public markAsUnread: (annotationId: string) => Promise<void>;
 
+  /**
+   * To enable screenshot
+   */
+  public enableScreenshot: () => void;
+
+  /**
+   * To disable screenshot
+   */
+  public disableScreenshot: () => void;
+
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -2496,4 +2506,14 @@ export declare class CommentElement {
    * To mark comment annotation as unread
    */
   private _markAsUnread;
+
+  /**
+   * To enable screenshot
+   */
+  private _enableScreenshot;
+
+  /**
+   * To disable screenshot
+   */
+  private _disableScreenshot;
 }

package/app/utils/constants.d.ts

@@ -9,6 +9,8 @@ export declare class Constants {
     static NO_ORGANIZATION_ID: string;
     static DEFAULT_QUERY_HASH: string;
     static LISTENER_BATCH_SIZE: number;
+    static LISTENER_CONTEXT_BATCH_SIZE: number;
+    static DEFAULT_VELT_CONTEXT: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
     static FIREBASE_PARTIAL_PATH_FOLDERS: string;
     static FIREBASE_PARTIAL_PATH_DOCS: string;

package/models.d.ts

@@ -48,6 +48,7 @@ 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/screenshot.data.model';
 export * from './app/models/data/selection.model';
 export * from './app/models/data/sync-video-player.data.model';
 export * from './app/models/data/tag-annotation.data.model';

package/package.json

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