@veltdev/sdk 4.0.0-beta.20 → 4.0.0-beta.22

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;
@@ -36,7 +38,7 @@ export declare class Snippyly {
    * 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.
+   * @deprecated This method is deprecated.
    */
   updateUser: (user: User) => 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. 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. 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
@@ -225,17 +220,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 +260,7 @@ export declare class Snippyly {
 
    /**
     * To get document metadata.
+    * @deprecated This method is deprecated. Use `fetchDocuments` method instead.
     */
    getDocumentMetadata: () => Observable<DocumentMetadata | null>;
 

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;
@@ -63,6 +65,9 @@ export interface CommentRequestQuery {
     documentIds?: string[];
     locationIds?: string[];
     statusIds?: string[];
+    folderId?: string;
+    allDocuments?: boolean;
+    locationId?: string;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;
@@ -161,3 +166,18 @@ export interface ToggleReactionRequest {
     };
     options?: RequestOptions;
 }
+export interface FetchCommentAnnotationsRequest {
+    createdAfter?: number;
+    createdBefore?: number;
+    updatedAfter?: number;
+    updatedBefore?: number;
+    statusIds?: string[];
+    order?: 'asc' | 'desc';
+    pageToken?: string;
+    allDocuments?: boolean;
+    pageSize?: number;
+    organizationId?: string;
+    locationId?: string;
+    documentIds?: string[];
+    folderId?: string;
+}

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

@@ -129,6 +129,9 @@ export interface DeleteCommentAnnotationEvent {
 export interface GetCommentAnnotationsResponse {
     data: Record<string, CommentAnnotation[]> | null;
 }
+export interface FetchCommentAnnotationsResponse extends GetCommentAnnotationsResponse {
+    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/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,23 @@ export interface Document {
 }
 export interface SetDocumentsRequestOptions {
     organizationId?: string;
+    folderId?: string;
+    allDocuments?: boolean;
+    locationId?: string;
+}
+export interface FetchDocumentsRequest {
+    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;
 }

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

@@ -0,0 +1,40 @@
+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/utils/constants.d.ts

@@ -10,6 +10,7 @@ export declare class Constants {
     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;

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/sdk",
-    "version": "4.0.0-beta.20",
+    "version": "4.0.0-beta.22",
     "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": [