@veltdev/sdk-staging 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,22 +2,50 @@
2
2
  export declare class AreaElement {
3
3
  /**
4
4
  * To enable area feature
5
+ *
6
+ * @deprecated Use enableAreaComment instead.
5
7
  */
6
8
  enableArea: () => void;
7
9
 
8
10
  /**
9
11
  * To disable area feature
12
+ *
13
+ * @deprecated Use disableAreaComment instead.
10
14
  */
11
15
  disableArea: () => void;
16
+
17
+ /**
18
+ * To enable area feature
19
+ */
20
+ enableAreaComment: () => void;
21
+
22
+ /**
23
+ * To disable area feature
24
+ */
25
+ disableAreaComment: () => void;
12
26
  constructor();
13
27
 
14
28
  /**
15
29
  * To enable area feature
30
+ *
31
+ * @deprecated Use enableAreaComment instead.
16
32
  */
17
33
  private _enableArea;
18
34
 
19
35
  /**
20
36
  * To disable area feature
37
+ *
38
+ * @deprecated Use disableAreaComment instead.
21
39
  */
22
40
  private _disableArea;
41
+
42
+ /**
43
+ * To enable area feature
44
+ */
45
+ private _enableAreaComment;
46
+
47
+ /**
48
+ * To disable area feature
49
+ */
50
+ private _disableAreaComment;
23
51
  }
@@ -6,9 +6,18 @@ export declare class CursorElement {
6
6
  * Subscribe to cursors of all online users who are either active or inactive on the current document.
7
7
  *
8
8
  * Returns Observable<CursorUser[] | null>.
9
+ *
10
+ * @deprecated Use getOnlineUsersOnCurrentDocument instead.
9
11
  */
10
12
  getLiveCursorsOnCurrentDocument: () => Observable<CursorUser[] | null>;
11
13
 
14
+ /**
15
+ * Subscribe to cursors of all online users who are either active or inactive on the current document.
16
+ *
17
+ * Returns Observable<CursorUser[] | null>.
18
+ */
19
+ getOnlineUsersOnCurrentDocument: () => Observable<CursorUser[] | null>;
20
+
12
21
  /**
13
22
  * To set inactivity time (Default value is 2 minutes)
14
23
  * @param time inactivity time in milliseconds
@@ -25,9 +34,18 @@ export declare class CursorElement {
25
34
  * Subscribe to cursors of all online users who are either active or inactive on the current document.
26
35
  *
27
36
  * Returns Observable<CursorUser[] | null>.
37
+ *
38
+ * @deprecated Use getOnlineUsersOnCurrentDocument instead.
28
39
  */
29
40
  private _getLiveCursorsOnCurrentDocument;
30
41
 
42
+ /**
43
+ * Subscribe to cursors of all online users who are either active or inactive on the current document.
44
+ *
45
+ * Returns Observable<CursorUser[] | null>.
46
+ */
47
+ private _getOnlineUsersOnCurrentDocument;
48
+
31
49
  /**
32
50
  * To set inactivity time (Default value is 2 minutes)
33
51
  * @param time inactivity time in milliseconds
@@ -1,15 +1,23 @@
1
1
  // @ts-nocheck
2
2
  export declare class SelectionElement {
3
3
  /**
4
- * To enable/disable selections
5
- * @param enable pass `true` to enable it, `false` to disable it.
4
+ * To enable selections
6
5
  */
7
- enableLiveSelection: (enable: boolean) => void;
6
+ enableLiveSelection: () => void;
7
+
8
+ /**
9
+ * To disable selections
10
+ */
11
+ disableLiveSelection: () => void;
8
12
  constructor();
9
13
 
10
14
  /**
11
- * To enable/disable selections
12
- * @param enable pass `true` to enable it, `false` to disable it.
15
+ * To enable selections
13
16
  */
14
17
  private _enableLiveSelection;
18
+
19
+ /**
20
+ * To disable selections
21
+ */
22
+ private _disableLiveSelection;
15
23
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk-staging",
3
- "version": "1.0.4",
3
+ "version": "1.0.6",
4
4
  "description": "",
5
5
  "main": "velt.js",
6
6
  "scripts": {
package/types.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export * from './app/client/snippyly.model';
2
+ export * from './app/client/velt.model';
2
3
  export * from './app/models/element/cursor-element.model';
3
4
  export * from './app/models/element/presence-element.model';
4
5
  export * from './models';
package/velt.d.ts CHANGED
@@ -1,21 +1,20 @@
1
1
  // @ts-nocheck
2
- import * as snippyly from './types';
2
+ import * as velt from './types';
3
3
  export * from './types';
4
- export type Snippyly = { init: (api: string, config: snippyly.Config) => Snippyly, loaded: boolean, loadSnippyly: Function } & snippyly.Snippyly;
5
- export const Snippyly: {
6
- init: (api: string, config?: snippyly.Config) => Promise<Snippyly>,
7
- loadSnippyly: () => Snippyly,
4
+ export type Velt = { init: (api: string, config: velt.Config) => Velt, loaded: boolean, loadVelt: Function, loadSnippyly: Function } & velt.Velt;
5
+ export const Velt: {
6
+ init: (api: string, config?: velt.Config) => Promise<Velt>,
7
+ loadSnippyly: () => Velt,
8
+ loadVelt: () => Velt,
8
9
  loaded: boolean
9
- } & snippyly.Snippyly;
10
-
11
- export const Velt = Snippyly;
10
+ } & velt.Velt;
12
11
 
13
12
  ////////////////////
14
13
  // Global object
15
14
  ////////////////////
16
15
  declare global {
17
16
  interface Window {
18
- Snippyly: typeof snippyly.Snippyly;
19
- Velt: typeof snippyly.Snippyly;
17
+ Snippyly: typeof velt.Velt;
18
+ Velt: typeof velt.Velt;
20
19
  }
21
20
  }