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

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

@@ -26,183 +26,178 @@ 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;
-   identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
-   /**
-    * Tell us who the currently logged in user is.
-    *
-    * Call whenever the user is updated: signs in, signs out, signs up etc.
-    * @deprecated This method is deprecated and will be removed in next release.
-    */
-   updateUser: (user: User) => void;
-   /**
-    * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
-    * @param id unique document ID
-    * @param documentMetadata Document Metadata
-    */
-   setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
-   /**
-    * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
-    * @param id unique document ID
-    */
-   setDocumentId: (id: string) => void;
-   /**
-    * To set multiple documents
-    */
-   setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
-   /**
-    * 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
-    */
-   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
-      */
-   removeLocation: (location?: Location) => void;
-   /**
-    * To exclude data of specific location ids
-    * @param ids Location Ids
-    */
-   excludeLocationIds: (ids: string[]) => void;
-   /**
-    * Tell us the about the scrollable document ids to keep track on its scroll changes
-    * @param ids scrollable elements ids
-    */
-   setScrollableElementsIds: (ids: string[]) => void;
-   /**
-    * To remove document params from a User
-    */
-   removeScrollableElementsIds: () => void;
-   /**
-    * Get the Presence Element Object to access the raw presence data.
-    *
-    * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
-    */
-   getPresenceElement: () => PresenceElement;
-   /**
-    * Get the Cursor Element Object to access the raw cursor data.
-    *
-    * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
-    */
-   getCursorElement: () => CursorElement;
-   /**
-    * Get the Comment Element Object to access the raw comment data.
-    *
-    * This is for Pros who don’t want to use Snippyly Comment web component and want to design their own UI.
-    */
-   getCommentElement: () => CommentElement;
-   /**
-    * Get the Tag Pin Annotation Object to access the raw tag data.
-    *
-    * This is for Pros who don’t want to use Snippyly Tag web component and want to design their own UI.
-    */
-   getTagElement: () => TagElement;
-   /**
-    * Get the Selection Object to enable/disable the feature.
-    */
-   getSelectionElement: () => SelectionElement;
-   /**
-    * Get the Recorder Object.
-    */
-   getRecorderElement: () => RecorderElement;
-   /**
-    * Get the Contact Object.
-    */
-   getContactElement: () => ContactElement;
-   /**
-    * Get the Rewriter Object.
-    */
-   getRewriterElement: () => RewriterElement;
-   /**
-    * Get the Huddle element.
-    */
-   getHuddleElement: () => HuddleElement;
-   /**
-    * Get the LiveStateSync Object.
-    */
-   getLiveStateSyncElement: () => LiveStateSyncElement;
-   /**
-    * Get the Arrow Object.
-    */
-   getArrowElement: () => ArrowElement;
-   /**
-    * Get the Views Object.
-    */
-   getViewsElement: () => ViewsElement;
-   /**
-    * Get the Notification Object.
-    */
-   getNotificationElement: () => NotificationElement;
-   /**
-    * Get the Autocomplete Object.
-    */
-   getAutocompleteElement: () => AutocompleteElement;
-   /**
-    * Get the Area Object.
-    */
-   getAreaElement: () => AreaElement;
-   /**
-    * Get the Area Object.
-    */
-   getReactionElement: () => ReactionElement;
-   /**
-    * Get the metadata of the current resource.
-    */
-   getMetadata: () => Promise<VeltEventMetadata | null>;
-   /**
-    * To signout a user
-    */
-   signOutUser: () => any;
-   /**
-    * Provide a list of features to disable.
-    * Provide an empty array to enable all the features.
-    * @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
-    */
-   setDarkMode: (darkMode: boolean) => void;
+  constructor();
+  initConfig: (apiKey: string, config?: Config) => void;
+  identify: (user: User, userOptions?: UserOptions) => Promise<unknown>;
+  /**
+   * Tell us who the currently logged in user is.
+   *
+   * Call whenever the user is updated: signs in, signs out, signs up etc.
+   * @deprecated This method is deprecated and will be removed in next release.
+   */
+  updateUser: (user: User) => void;
+  /**
+   * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
+   * @param id unique document ID
+   * @param documentMetadata Document Metadata
+   */
+  setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
+  /**
+   * 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;
+  /**
+   * To set multiple documents
+   */
+  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.
+   */
+  setUserDataProvider: (userDataProvider: UserDataProvider) => void;
+  /**
+   * Get Document ID
+   */
+  getDocumentId: () => string;
+  /**
+   * 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 location from a User
+     * @param location Location
+     */
+  removeLocation: (location?: Location) => void;
+  /**
+   * To exclude data of specific location ids
+   * @param ids Location Ids
+   */
+  excludeLocationIds: (ids: string[]) => void;
+  /**
+   * Tell us the about the scrollable document ids to keep track on its scroll changes
+   * @param ids scrollable elements ids
+   */
+  setScrollableElementsIds: (ids: string[]) => void;
+  /**
+   * To remove document params from a User
+   */
+  removeScrollableElementsIds: () => void;
+  /**
+   * Get the Presence Element Object to access the raw presence data.
+   *
+   * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
+   */
+  getPresenceElement: () => PresenceElement;
+  /**
+   * Get the Cursor Element Object to access the raw cursor data.
+   *
+   * This is for Pros who don’t want to use Snippyly Presence web component and want to design their own UI.
+   */
+  getCursorElement: () => CursorElement;
+  /**
+   * Get the Comment Element Object to access the raw comment data.
+   *
+   * This is for Pros who don’t want to use Snippyly Comment web component and want to design their own UI.
+   */
+  getCommentElement: () => CommentElement;
+  /**
+   * Get the Tag Pin Annotation Object to access the raw tag data.
+   *
+   * This is for Pros who don’t want to use Snippyly Tag web component and want to design their own UI.
+   */
+  getTagElement: () => TagElement;
+  /**
+   * Get the Selection Object to enable/disable the feature.
+   */
+  getSelectionElement: () => SelectionElement;
+  /**
+   * Get the Recorder Object.
+   */
+  getRecorderElement: () => RecorderElement;
+  /**
+   * Get the Contact Object.
+   */
+  getContactElement: () => ContactElement;
+  /**
+   * Get the Rewriter Object.
+   */
+  getRewriterElement: () => RewriterElement;
+  /**
+   * Get the Huddle element.
+   */
+  getHuddleElement: () => HuddleElement;
+  /**
+   * Get the LiveStateSync Object.
+   */
+  getLiveStateSyncElement: () => LiveStateSyncElement;
+  /**
+   * Get the Arrow Object.
+   */
+  getArrowElement: () => ArrowElement;
+  /**
+   * Get the Views Object.
+   */
+  getViewsElement: () => ViewsElement;
+  /**
+   * Get the Notification Object.
+   */
+  getNotificationElement: () => NotificationElement;
+  /**
+   * Get the Autocomplete Object.
+   */
+  getAutocompleteElement: () => AutocompleteElement;
+  /**
+   * Get the Area Object.
+   */
+  getAreaElement: () => AreaElement;
+  /**
+   * Get the Area Object.
+   */
+  getReactionElement: () => ReactionElement;
+  /**
+   * Get the metadata of the current resource.
+   */
+  getMetadata: () => Promise<VeltEventMetadata | null>;
+  /**
+   * To signout a user
+   */
+  signOutUser: () => any;
+  /**
+   * Provide a list of features to disable.
+   * Provide an empty array to enable all the features.
+   * @param features List of features
+   */
+  disableFeatures: (features: Array<FeatureType>) => void;
+  /**
+   * To set the dark mode of Velt components.
+   * @param value {boolean} true/false
+   */
+  setDarkMode: (darkMode: boolean) => void;
 
    /**
     * To check if user allowed in provided document or not.
@@ -219,22 +214,11 @@ export declare class Snippyly {
     */
    isPlanExpired$: () => Observable<boolean>;
 
-   /**
-    * To get if the Velt is initialized or not.
-    * @returns Observable<boolean | undefined>
-    */
-   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 get if the Velt is initialized or not.
+   * @returns Observable<boolean | undefined>
+   */
+  getVeltInitState: () => Observable<boolean | undefined>;
 
    /**
     * To remove velt specific content from provided html content.
@@ -276,6 +260,7 @@ export declare class Snippyly {
 
    /**
     * To get document metadata.
+    * @deprecated This method is deprecated and will be removed in next release.
     */
    getDocumentMetadata: () => Observable<DocumentMetadata | null>;
 

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";
@@ -135,14 +133,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;
 }

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/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.117",
     "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": [