@stream-io/video-react-native-sdk 0.0.1-alpha.217 → 0.0.1-alpha.219

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.
Files changed (8) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/src/utils/StreamVideoRN/index.d.ts +7 -3
  3. package/dist/src/utils/StreamVideoRN/index.js +7 -3
  4. package/dist/src/utils/StreamVideoRN/index.js.map +1 -1
  5. package/dist/src/utils/StreamVideoRN/types.d.ts +1 -1
  6. package/package.json +1 -1
  7. package/src/utils/StreamVideoRN/index.ts +7 -3
  8. package/src/utils/StreamVideoRN/types.ts +1 -1
package/CHANGELOG.md CHANGED
@@ -2,6 +2,19 @@
2
2
 
3
3
  This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
4
4
 
5
+ ## [0.0.1-alpha.219](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-native-sdk-0.0.1-alpha.218...@stream-io/video-react-native-sdk-0.0.1-alpha.219) (2023-06-27)
6
+
7
+
8
+ ### Features
9
+
10
+ * **react-native:** add push notification documentation according to the new SDK changes ([#712](https://github.com/GetStream/stream-video-js/issues/712)) ([7a721ac](https://github.com/GetStream/stream-video-js/commit/7a721ac30f035f5a24901c44cf56afbfb868da10))
11
+
12
+
13
+
14
+ ## [0.0.1-alpha.218](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-native-sdk-0.0.1-alpha.217...@stream-io/video-react-native-sdk-0.0.1-alpha.218) (2023-06-27)
15
+
16
+
17
+
5
18
  ## [0.0.1-alpha.217](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-react-native-sdk-0.0.1-alpha.216...@stream-io/video-react-native-sdk-0.0.1-alpha.217) (2023-06-27)
6
19
 
7
20
 
package/dist/src/utils/StreamVideoRN/index.d.ts CHANGED
@@ -10,13 +10,17 @@ export declare class StreamVideoRN {
10
10
  static updateConfig(updateConfig: Partial<Omit<StreamVideoConfig, 'push'>>): void;
11
11
  /**
12
12
  * Set the push config for StreamVideoRN.
13
- * Note: This function can only be called once.
14
- * It is necessary to call this function before AppRegistry.registerComponent since the app can be opened from a dead state through a push notification
13
+ * This method must be called **outside** of your application lifecycle, e.g. alongside your
14
+ * `AppRegistry.registerComponent()` method call at the entry point of your application code.
15
+ * Since the app can be opened from a dead state through a push notification
16
+ * Note: This function must be called only once. Further calls will be ignored.
15
17
  * @example // in index.js
16
18
  * import { AppRegistry } from 'react-native';
19
+ * import { StreamVideoRN } from '@stream-io/video-react-native-sdk';
17
20
  * import App from './App';
18
21
  * // Set push config
19
- * StreamVideoRN.setPushConfig(pushConfig); // set push config
22
+ * const pushConfig = {}; // construct your config
23
+ * StreamVideoRN.setPushConfig(pushConfig);
20
24
  * AppRegistry.registerComponent('app', () => App);
21
25
  */
22
26
  static setPushConfig(pushConfig: NonNullable<StreamVideoConfig['push']>): void;
package/dist/src/utils/StreamVideoRN/index.js CHANGED
@@ -39,13 +39,17 @@ class StreamVideoRN {
39
39
  }
40
40
  /**
41
41
  * Set the push config for StreamVideoRN.
42
- * Note: This function can only be called once.
43
- * It is necessary to call this function before AppRegistry.registerComponent since the app can be opened from a dead state through a push notification
42
+ * This method must be called **outside** of your application lifecycle, e.g. alongside your
43
+ * `AppRegistry.registerComponent()` method call at the entry point of your application code.
44
+ * Since the app can be opened from a dead state through a push notification
45
+ * Note: This function must be called only once. Further calls will be ignored.
44
46
  * @example // in index.js
45
47
  * import { AppRegistry } from 'react-native';
48
+ * import { StreamVideoRN } from '@stream-io/video-react-native-sdk';
46
49
  * import App from './App';
47
50
  * // Set push config
48
- * StreamVideoRN.setPushConfig(pushConfig); // set push config
51
+ * const pushConfig = {}; // construct your config
52
+ * StreamVideoRN.setPushConfig(pushConfig);
49
53
  * AppRegistry.registerComponent('app', () => App);
50
54
  */
51
55
  static setPushConfig(pushConfig) {
package/dist/src/utils/StreamVideoRN/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/utils/StreamVideoRN/index.ts"],"names":[],"mappings":";;;AAAA,wDAA0D;AAC1D,+CAAwD;AACxD,6CAA8D;AAE9D,+CAGuB;AAEvB,MAAM,2BAA2B,GAAsB;IACrD,kBAAkB,EAAE,iCAAqB;IACzC,iBAAiB,EAAE;QACjB,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,EAAE,EAAE,gCAAgC;gBACpC,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,KAAK;gBAChB,UAAU,EAAE,gCAAiB,CAAC,OAAO;aACtC;YACD,iBAAiB,EAAE;gBACjB,KAAK,EAAE,kBAAkB;gBACzB,IAAI,EAAE,2BAA2B;aAClC;SACF;KACF;CACF,CAAC;AAEF,MAAa,aAAa;IAChB,MAAM,CAAC,MAAM,GAAG,2BAA2B,CAAC;IACpD;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,YAAsD;QACxE,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,YAAY;SAChB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,aAAa,CAAC,UAAkD;QACrE,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YACpB,OAAO,CAAC,GAAG,CACT,oEAAoE,CACrE,CAAC;YACF,OAAO;SACR;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC;QAC9B,6HAA6H;QAC7H,IAAA,qCAA2B,EAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,EACpB,yBAAyB,EACzB,sBAAsB,GAIvB;QACC,wCAA0B,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC3D,qCAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;;AAzDH,sCA0DC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/utils/StreamVideoRN/index.ts"],"names":[],"mappings":";;;AAAA,wDAA0D;AAC1D,+CAAwD;AACxD,6CAA8D;AAE9D,+CAGuB;AAEvB,MAAM,2BAA2B,GAAsB;IACrD,kBAAkB,EAAE,iCAAqB;IACzC,iBAAiB,EAAE;QACjB,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,EAAE,EAAE,gCAAgC;gBACpC,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,KAAK;gBAChB,UAAU,EAAE,gCAAiB,CAAC,OAAO;aACtC;YACD,iBAAiB,EAAE;gBACjB,KAAK,EAAE,kBAAkB;gBACzB,IAAI,EAAE,2BAA2B;aAClC;SACF;KACF;CACF,CAAC;AAEF,MAAa,aAAa;IAChB,MAAM,CAAC,MAAM,GAAG,2BAA2B,CAAC;IACpD;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,YAAsD;QACxE,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,YAAY;SAChB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,aAAa,CAAC,UAAkD;QACrE,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YACpB,OAAO,CAAC,GAAG,CACT,oEAAoE,CACrE,CAAC;YACF,OAAO;SACR;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC;QAC9B,6HAA6H;QAC7H,IAAA,qCAA2B,EAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,EACpB,yBAAyB,EACzB,sBAAsB,GAIvB;QACC,wCAA0B,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC3D,qCAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;;AA7DH,sCA8DC"}
package/dist/src/utils/StreamVideoRN/types.d.ts CHANGED
@@ -57,7 +57,7 @@ export type StreamVideoConfig = {
57
57
  * This is used create a video client for incoming calls in the background and inform call events to the server.
58
58
  * If you are unable to create a video client, for example if you dont know the logged in user yet, return undefined.
59
59
  * @example
60
- * createStreamVideoClient: () => {
60
+ * createStreamVideoClient: async () => {
61
61
  * const userId = await AsyncStorage.getItem('@userId');
62
62
  * const userName = await AsyncStorage.getItem('@userName');
63
63
  * const token = await AsyncStorage.getItem('@userToken');
package/package.json CHANGED
@@ -85,5 +85,5 @@
85
85
  "typedoc-plugin-markdown": "^3.15.3",
86
86
  "typescript": "^4.9.5"
87
87
  },
88
- "version": "0.0.1-alpha.217"
88
+ "version": "0.0.1-alpha.219"
89
89
  }
package/src/utils/StreamVideoRN/index.ts CHANGED
@@ -43,13 +43,17 @@ export class StreamVideoRN {
43
43
 
44
44
  /**
45
45
  * Set the push config for StreamVideoRN.
46
- * Note: This function can only be called once.
47
- * It is necessary to call this function before AppRegistry.registerComponent since the app can be opened from a dead state through a push notification
46
+ * This method must be called **outside** of your application lifecycle, e.g. alongside your
47
+ * `AppRegistry.registerComponent()` method call at the entry point of your application code.
48
+ * Since the app can be opened from a dead state through a push notification
49
+ * Note: This function must be called only once. Further calls will be ignored.
48
50
  * @example // in index.js
49
51
  * import { AppRegistry } from 'react-native';
52
+ * import { StreamVideoRN } from '@stream-io/video-react-native-sdk';
50
53
  * import App from './App';
51
54
  * // Set push config
52
- * StreamVideoRN.setPushConfig(pushConfig); // set push config
55
+ * const pushConfig = {}; // construct your config
56
+ * StreamVideoRN.setPushConfig(pushConfig);
53
57
  * AppRegistry.registerComponent('app', () => App);
54
58
  */
55
59
  static setPushConfig(pushConfig: NonNullable<StreamVideoConfig['push']>) {
package/src/utils/StreamVideoRN/types.ts CHANGED
@@ -59,7 +59,7 @@ export type StreamVideoConfig = {
59
59
  * This is used create a video client for incoming calls in the background and inform call events to the server.
60
60
  * If you are unable to create a video client, for example if you dont know the logged in user yet, return undefined.
61
61
  * @example
62
- * createStreamVideoClient: () => {
62
+ * createStreamVideoClient: async () => {
63
63
  * const userId = await AsyncStorage.getItem('@userId');
64
64
  * const userName = await AsyncStorage.getItem('@userName');
65
65
  * const token = await AsyncStorage.getItem('@userToken');