@veltdev/types-dev 4.0.0-beta.116 → 4.0.0-beta.118

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

@@ -26,8 +26,10 @@ import { DocumentMetadata } from "../models/data/document-metadata.model";
 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 { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest } from "../models/data/document.data.model";
+import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/document-events.data.model";
 import { UserDataProvider } from "../models/data/user-resolver.data.model";
+
 export declare class Snippyly {
    constructor();
    initConfig: (apiKey: string, config?: Config) => void;
@@ -48,6 +50,7 @@ export declare class Snippyly {
    /**
     * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
     * @param id unique document ID
+    * @deprecated This method is deprecated and will be removed in next release. Use `setDocuments` method instead.
     */
    setDocumentId: (id: string) => void;
    /**
@@ -56,12 +59,21 @@ export declare class Snippyly {
    setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
    /**
     * To unset the document id
+    * @deprecated This method is deprecated and will be removed in next release. Use `unsetDocuments` method instead.
     */
    unsetDocumentId: () => void;
    /**
     * To unset the documents
     */
    unsetDocuments: () => void;
+   /**
+    * To fetch documents
+    */
+   fetchDocuments: (options?: FetchDocumentsRequest) => Promise<FetchDocumentsResponse>;
+   /**
+    * To fetch folders
+    */
+   fetchFolders: (options?: FetchFoldersRequest) => Promise<FetchFoldersResponse>;
    /**
     * To set the user data provider.
     */
@@ -70,23 +82,12 @@ export declare class Snippyly {
     * Get Document ID
     */
    getDocumentId: () => string;
-   /**
-    * Tell us the custom params of the current document/resource to identify sub document inside a document.
-    * @param params Document Params
-    * @deprecated This method is depercated and will be removed in next release. Use `setLocation` method instead.
-    */
-   setDocumentParams: (params: Location) => void;
    /**
     * Tell us the custom params of the current document/resource to identify sub document inside a document.
     * @param params Location
     * @param appendLocation Append location to existing location
     */
    setLocation: (params: Location, appendLocation?: boolean) => void;
-   /**
-    * To remove document params from a User
-    * @deprecated This method is depercated and will be removed in next release. Use `removeLocation` method instead.
-    */
-   removeDocumentParams: () => void;
    /**
       * To remove location from a User
       * @param location Location
@@ -192,12 +193,6 @@ export declare class Snippyly {
     * @param features List of features
     */
    disableFeatures: (features: Array<FeatureType>) => void;
-   /**
-    * Add location to show comments, tags, recorders etc. for provided location also.
-    * @param location Location object
-    * @deprecated This method is deprecated and will be removed in next release. Use `setLocation` method with `appendLocation: true` instead.
-    */
-   addLocation: (location: any) => any;
    /**
     * To set the dark mode of Velt components.
     * @param value {boolean} true/false
@@ -209,6 +204,11 @@ export declare class Snippyly {
     */
    isUserAllowed$: () => Observable<boolean>;
 
+   /**
+    * To get user.
+    */
+   getUser: () => User | null;
+
    /**
     * To get user role in provided document.
     */
@@ -225,17 +225,6 @@ export declare class Snippyly {
     */
    getVeltInitState: () => Observable<boolean | undefined>;
 
-   /**
-    * To invite list of users to the document.
-    * @param documentUsers List of document users
-    */
-   inviteUsers: (documentUsers: Array<DocumentUser>) => void;
-
-   /**
-    * To remove snippyly specific content from provided html content.
-    */
-   removeSnippylyContent: (htmlContent: string) => string;
-
    /**
     * To remove velt specific content from provided html content.
     */
@@ -276,6 +265,7 @@ export declare class Snippyly {
 
    /**
     * To get document metadata.
+    * @deprecated This method is deprecated. Use `fetchDocuments` method instead.
     */
    getDocumentMetadata: () => Observable<DocumentMetadata | null>;
 
@@ -285,12 +275,12 @@ export declare class Snippyly {
    on: <T extends keyof CoreEventTypesMap>(action: T) => Observable<CoreEventTypesMap[T]>;
 
    /**
-    * To set the ui state.
-    */
+   * To set the ui state.
+   */
    setUiState: (uiState: { [key: string]: any }) => void;
 
    /**
     * To get the ui state.
     */
    getUiState: () => Observable<{ [key: string]: any }>;
-}
+}

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

@@ -5,9 +5,7 @@ import { AddAttachmentResponse } from "./comment-actions.data.model";
 import { CommentAnnotation, UpdateContextConfig } from "./comment-annotation.data.model";
 import { Comment } from "./comment.data.model";
 import { CustomPriority, CustomStatus } from "./custom-filter.data.model";
-import { DocumentMetadata } from "./document-metadata.model";
 import { VeltEventMetadata } from "./event-metadata.data.model";
-import { FolderMetadata } from "./folder-metadata.model";
 import { Location } from "./location.model";
 import { ReactionAnnotation } from "./reaction-annotation.data.model";
 import { RecordedData } from "./recorder.model";
@@ -80,6 +78,7 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_INIT]: CommentSidebarDataInitEvent;
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
     [CommentEventTypes.AUTOCOMPLETE_SEARCH]: AutocompleteSearchEvent;
+    [CommentEventTypes.COMPOSER_CLICKED]: ComposerClickedEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -135,14 +134,6 @@ export interface GetCommentAnnotationsResponse {
 export interface FetchCommentAnnotationsResponse extends GetCommentAnnotationsResponse {
     nextPageToken: string;
 }
-export interface FetchDocumentsResponse {
-    data: Record<string, DocumentMetadata[]> | null;
-    nextPageToken: string;
-}
-export interface FetchFoldersResponse {
-    data: Record<string, FolderMetadata[]> | null;
-    nextPageToken: string;
-}
 export interface GetCommentAnnotationsCountResponse {
     data: Record<string, CommentAnnotationsCount> | null;
 }
@@ -255,3 +246,7 @@ export interface AutocompleteSearchEvent {
     type?: 'contact' | 'custom' | 'group';
     metadata?: VeltEventMetadata;
 }
+export interface ComposerClickedEvent {
+    commentAnnotation?: CommentAnnotation;
+    metadata?: VeltEventMetadata;
+}

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

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

package/app/utils/enums.d.ts

@@ -42,6 +42,7 @@ export declare const CommentEventTypes: {
     readonly COMMENT_SIDEBAR_DATA_INIT: "commentSidebarDataInit";
     readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
     readonly AUTOCOMPLETE_SEARCH: "autocompleteSearch";
+    readonly COMPOSER_CLICKED: "composerClicked";
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";

package/models.d.ts

@@ -18,6 +18,7 @@ export * from './app/models/data/custom-css.data.model';
 export * from './app/models/data/custom-chip-dropdown.data.model';
 export * from './app/models/data/device-info.model';
 export * from './app/models/data/document.data.model';
+export * from './app/models/data/document-events.data.model';
 export * from './app/models/data/document-iam.data.model';
 export * from './app/models/data/document-metadata.model';
 export * from './app/models/data/document-paths.data.model';

package/package.json

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