@streamlayer/sdk-web-core 0.19.0 → 0.20.1

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.
@@ -13,7 +13,7 @@ export declare class BypassAuth extends AbstractAuthenticationProvider {
13
13
  private readonly transport;
14
14
  private readonly bypassLogin;
15
15
  constructor(store: CoreStore, transport: Transport, deepLink: DeepLinkContext);
16
- me: () => Promise<(import("@streamlayer/sl-eslib/users/users_common_pb").User & import("@streamlayer/sl-eslib/users/users_common_pb").User) | undefined>;
16
+ me: () => Promise<import("@streamlayer/sl-eslib/users/users_common_pb").User | undefined>;
17
17
  /**
18
18
  * Login user by token and schema.
19
19
  * On success, save the user and update the token to the Transport, UserStore and cache.
@@ -21,7 +21,7 @@ export declare class BypassAuth extends AbstractAuthenticationProvider {
21
21
  * @param userKey - user token received from the host app.
22
22
  */
23
23
  login: (schema: string, userKey: string) => Promise<string>;
24
- isAuthenticated: () => Promise<(import("@streamlayer/sl-eslib/users/users_common_pb").User & import("@streamlayer/sl-eslib/users/users_common_pb").User) | undefined>;
24
+ isAuthenticated: () => Promise<import("@streamlayer/sl-eslib/users/users_common_pb").User | undefined>;
25
25
  /**
26
26
  * Logout user. Clears the all user data from the store.
27
27
  */
@@ -1,6 +1,9 @@
1
1
  import { AbstractAuthenticationProvider } from '@streamlayer/sdk-web-interfaces';
2
2
  import { queries } from '@streamlayer/sdk-web-api';
3
+ import { createLogger } from '@streamlayer/sdk-web-logger';
4
+ import { DEEP_LINK_USER_ID } from '../../deepLink';
3
5
  import { UserStorage } from '../../storage';
6
+ const logger = createLogger('bypass');
4
7
  /**
5
8
  * An authorization service manages user access by providing login, logout,
6
9
  * authentication checks, and the ability to revoke access.
@@ -32,8 +35,9 @@ export class BypassAuth extends AbstractAuthenticationProvider {
32
35
  */
33
36
  login = async (schema, userKey) => {
34
37
  this.$coreStore.getValues().userKey.setValue(userKey);
35
- const inviterKey = this.deepLink.getDeepLinkData()?.friendId;
36
- console.log('inviterKey', inviterKey);
38
+ const { used, data } = this.deepLink.getDeepLinkData();
39
+ const inviterKey = !used ? data?.[DEEP_LINK_USER_ID] : '';
40
+ logger.debug('inviterKey', inviterKey);
37
41
  const user = await this.bypassLogin({
38
42
  schema,
39
43
  userKey,
@@ -45,7 +49,7 @@ export class BypassAuth extends AbstractAuthenticationProvider {
45
49
  if (!token || !userId) {
46
50
  throw new Error('internal: token missing');
47
51
  }
48
- console.log('user', user);
52
+ logger.debug('user', user);
49
53
  if (user.meta?.inviterKey) {
50
54
  this.deepLink.deepLinkUsed(user.meta.inviterKey);
51
55
  }
@@ -1,19 +1,17 @@
1
1
  import { StreamLayerContext } from '@streamlayer/sdk-web-interfaces';
2
2
  import { MapStore } from '@streamlayer/sdk-web-interfaces';
3
3
  type DeepLinkContextData = {
4
- processed: boolean;
5
- hash?: string;
6
- search?: string;
7
- sessionId?: string;
8
- data?: {
9
- friendId?: string;
10
- };
4
+ handled?: boolean;
5
+ parsed?: boolean;
6
+ used?: boolean;
7
+ data?: DeepLinkUrlParams;
11
8
  };
9
+ export type DeepLinkCallback = (deepLinkData: DeepLinkContextData['data']) => void;
12
10
  export interface DeepLinkContext {
13
11
  $store: DeepLinkContextStore;
14
- getDeepLinkData: () => DeepLinkContextData['data'];
12
+ getDeepLinkData: () => Pick<DeepLinkContextData, 'data' | 'used'>;
15
13
  deepLinkUsed: (inviterId: string) => void;
16
- onDeepLinkHandlers: Set<() => void>;
14
+ onDeepLinkHandlers: Set<DeepLinkCallback>;
17
15
  }
18
16
  export type DeepLinkContextStore = MapStore<DeepLinkContextData>;
19
17
  declare module '@streamlayer/sdk-web-interfaces' {
@@ -21,14 +19,18 @@ declare module '@streamlayer/sdk-web-interfaces' {
21
19
  deepLink: DeepLinkContext;
22
20
  }
23
21
  interface StreamLayerSDK {
24
- onDeepLinkHandled: (cb: () => void) => void;
25
- deepLinkHandled: () => void;
26
- getInviterId: () => string | undefined;
22
+ onDeepLinkHandled: (cb: DeepLinkCallback) => void;
27
23
  }
28
24
  }
29
25
  export declare const DEEP_LINK_PREFIX = "sldl";
30
26
  export declare const DEEP_LINK_USER_ID = "sldl_uid";
31
27
  export declare const DEEP_LINK_EVENT_ID = "sldl_eid";
28
+ export declare const DEEP_LINK_EXTERNAL_EVENT_ID = "sldl_e_eid";
29
+ export type DeepLinkUrlParams = {
30
+ [DEEP_LINK_USER_ID]?: string;
31
+ [DEEP_LINK_EVENT_ID]?: string;
32
+ [DEEP_LINK_EXTERNAL_EVENT_ID]?: string;
33
+ };
32
34
  /**
33
35
  * Bypass authorization, used for login with external token.
34
36
  * Automatically login user if SDK initialized and READY.
@@ -1,5 +1,6 @@
1
1
  import { createMapStore, MapStore } from '@streamlayer/sdk-web-interfaces';
2
2
  import { Storage } from '@streamlayer/sdk-web-storage';
3
+ import { createLogger } from '@streamlayer/sdk-web-logger';
3
4
  class DeepLinkContextStorage extends Storage {
4
5
  get = this.read;
5
6
  set = this.write;
@@ -11,33 +12,70 @@ class DeepLinkContextStorage extends Storage {
11
12
  export const DEEP_LINK_PREFIX = 'sldl';
12
13
  export const DEEP_LINK_USER_ID = 'sldl_uid';
13
14
  export const DEEP_LINK_EVENT_ID = 'sldl_eid';
15
+ export const DEEP_LINK_EXTERNAL_EVENT_ID = 'sldl_e_eid';
16
+ const ALLOWED_PARAMS = new Set([DEEP_LINK_USER_ID, DEEP_LINK_EVENT_ID, DEEP_LINK_EXTERNAL_EVENT_ID]);
17
+ const pickOnlyAllowedParams = (params) => {
18
+ const result = {};
19
+ const remain = {};
20
+ for (const [key, value] of params) {
21
+ if (ALLOWED_PARAMS.has(key)) {
22
+ result[key] = value;
23
+ }
24
+ else {
25
+ remain[key] = value;
26
+ }
27
+ }
28
+ return { result, remain };
29
+ };
14
30
  const parseDeepLinkData = ({ hash, search }) => {
15
31
  if (hash && hash.includes(DEEP_LINK_PREFIX)) {
16
32
  const params = new URLSearchParams(hash.substr(1));
17
- for (const [key, value] of params) {
18
- if (key === DEEP_LINK_USER_ID) {
19
- return { friendId: value };
20
- }
21
- }
22
- return null;
33
+ return { hash: pickOnlyAllowedParams(params) };
23
34
  }
24
35
  if (search && search.includes(DEEP_LINK_PREFIX)) {
25
36
  const params = new URLSearchParams(search);
26
- return { friendId: params?.[DEEP_LINK_USER_ID] };
37
+ return { search: pickOnlyAllowedParams(params) };
27
38
  }
28
39
  return null;
29
40
  };
30
- const pickDeepLinkData = ($deepLinkContext) => {
31
- const { hash, search, processed } = $deepLinkContext.getValues();
32
- console.log('get deep link data from', { hash, search, processed });
33
- if (!processed) {
34
- const result = parseDeepLinkData({ hash, search });
35
- console.log('parse deep link result', result);
36
- if (result) {
37
- $deepLinkContext.setValue('data', result);
41
+ const logger = createLogger('deep_link');
42
+ const pickDeepLinkData = ($deepLinkContext, deepLinkHandled) => {
43
+ const { hash, search } = window.location;
44
+ logger.debug({ hash, search }, 'get deep link data from');
45
+ if (hash || search) {
46
+ const parsedData = parseDeepLinkData({ hash, search });
47
+ logger.debug(parsedData, 'parse deep link result');
48
+ if (parsedData) {
49
+ const { hash, search } = parsedData;
50
+ const { result, remain } = hash || search;
51
+ if (Object.keys(result).length !== 0) {
52
+ $deepLinkContext.setValue('data', result);
53
+ const remainExist = Object.keys(remain).length !== 0;
54
+ if (hash) {
55
+ if (remainExist) {
56
+ const updatedHash = `#${new URLSearchParams(remain).toString()}`;
57
+ logger.debug({ updatedHash }, 'update hash');
58
+ window.location.hash = updatedHash;
59
+ }
60
+ else {
61
+ window.location.hash = '';
62
+ }
63
+ }
64
+ if (search) {
65
+ if (remainExist) {
66
+ const updatedSearch = `?${new URLSearchParams(remain).toString()}`;
67
+ logger.debug({ updatedSearch }, 'update search');
68
+ window.location.search = updatedSearch;
69
+ }
70
+ else {
71
+ window.location.search = '';
72
+ }
73
+ }
74
+ deepLinkHandled(result);
75
+ }
38
76
  }
39
- return;
40
77
  }
78
+ $deepLinkContext.setValue('parsed', true);
41
79
  return;
42
80
  };
43
81
  /**
@@ -47,64 +85,45 @@ const pickDeepLinkData = ($deepLinkContext) => {
47
85
  export const deepLink = (instance, opts, done) => {
48
86
  const storage = new DeepLinkContextStorage();
49
87
  const initStoreStr = storage.get('sl-deep-link-store');
50
- let initStore = { processed: false };
88
+ let initStore = {};
51
89
  if (initStoreStr) {
52
90
  try {
53
91
  initStore = JSON.parse(initStoreStr);
54
92
  }
55
93
  catch (e) {
56
- console.log(e);
94
+ logger.debug(e);
57
95
  }
58
96
  }
59
97
  instance.deepLink = {
60
98
  $store: new MapStore(createMapStore(initStore), 'deep-link-context'),
61
99
  getDeepLinkData: () => {
62
- const { data, processed } = instance.deepLink.$store.getValues();
63
- return !processed ? data : undefined;
100
+ const { data, used } = instance.deepLink.$store.getValues();
101
+ return { data, used };
64
102
  },
65
103
  // we are logged in with inviter id
66
104
  deepLinkUsed: (inviterId) => {
67
- instance.deepLink.$store.setValue('processed', true);
68
- storage.set('sl-inviter-id', inviterId);
69
- storage.del('sl-location');
105
+ logger.debug(`logged in with inviterId: ${inviterId}`);
106
+ instance.deepLink.$store.setValue('used', true);
70
107
  },
71
108
  onDeepLinkHandlers: new Set(),
72
109
  };
73
110
  instance.deepLink.$store.subscribe((value) => storage.set('sl-deep-link-store', JSON.stringify(value)));
74
- instance.sdk.getInviterId = () => {
75
- return storage.get('sl-inviter-id');
76
- };
77
111
  instance.sdk.onDeepLinkHandled = (cb) => {
78
112
  instance.deepLink.onDeepLinkHandlers.add(cb);
79
113
  };
80
- // sdk initialized after login by invite
81
- instance.sdk.deepLinkHandled = () => {
82
- storage.del('sl-inviter-id');
83
- instance.deepLink.$store.setValue('processed', true);
114
+ // called after sdk parsed deep link data from location
115
+ const deepLinkHandled = (data) => {
116
+ instance.deepLink.$store.setValue('handled', true);
84
117
  for (const handler of instance.deepLink.onDeepLinkHandlers) {
85
118
  try {
86
- handler();
119
+ logger.debug('called handler');
120
+ handler(data);
87
121
  }
88
122
  catch (err) {
89
123
  console.error(err);
90
124
  }
91
125
  }
92
126
  };
93
- let sessionId = storage.get('sl-session-id');
94
- if (!sessionId) {
95
- const { hash, search } = window.location;
96
- sessionId = Date.now().toString();
97
- storage.set('sl-session-id', sessionId);
98
- storage.set('sl-location', JSON.stringify({ hash, search }));
99
- instance.deepLink.$store.getStore().set({ sessionId, hash, search, processed: false });
100
- }
101
- else {
102
- const initialLocation = storage.get('sl-location');
103
- if (initialLocation) {
104
- const parsed = JSON.parse(initialLocation);
105
- instance.deepLink.$store.getStore().set({ sessionId, hash: parsed.hash, search: parsed.search, processed: false });
106
- }
107
- }
108
- pickDeepLinkData(instance.deepLink.$store);
127
+ pickDeepLinkData(instance.deepLink.$store, deepLinkHandled);
109
128
  done();
110
129
  };
package/lib/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { StreamLayerContext } from '@streamlayer/sdk-web-interfaces';
2
2
  export { bypass, storage } from './auth';
3
3
  export { store } from './store';
4
- export { deepLink, DEEP_LINK_PREFIX, DEEP_LINK_USER_ID, DEEP_LINK_EVENT_ID } from './deepLink';
4
+ export { deepLink, type DeepLinkUrlParams, type DeepLinkCallback, DEEP_LINK_PREFIX, DEEP_LINK_USER_ID, DEEP_LINK_EVENT_ID, DEEP_LINK_EXTERNAL_EVENT_ID, } from './deepLink';
5
5
  import './store';
6
6
  import './auth';
7
7
  declare module '@streamlayer/sdk-web-interfaces' {
package/lib/index.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import { CoreStatus } from './store/store';
2
2
  export { bypass, storage } from './auth';
3
3
  export { store } from './store';
4
- export { deepLink, DEEP_LINK_PREFIX, DEEP_LINK_USER_ID, DEEP_LINK_EVENT_ID } from './deepLink';
4
+ export { deepLink, DEEP_LINK_PREFIX, DEEP_LINK_USER_ID, DEEP_LINK_EVENT_ID, DEEP_LINK_EXTERNAL_EVENT_ID, } from './deepLink';
5
5
  import './store';
6
6
  import './auth';
7
7
  /**
package/package.json CHANGED
@@ -5,12 +5,13 @@
5
5
  },
6
6
  "peerDependencies": {
7
7
  "@nanostores/query": "^0.2.8",
8
- "@streamlayer/sl-eslib": "^5.66.0",
8
+ "@streamlayer/sl-eslib": "^5.67.0",
9
9
  "nanostores": "^0.9.5",
10
- "@streamlayer/sdk-web-api": "^0.21.0",
11
- "@streamlayer/sdk-web-interfaces": "^0.20.2",
12
- "@streamlayer/sdk-web-storage": "^0.4.0",
13
- "@streamlayer/sdk-web-types": "^0.22.0"
10
+ "@streamlayer/sdk-web-api": "^0.21.2",
11
+ "@streamlayer/sdk-web-interfaces": "^0.20.4",
12
+ "@streamlayer/sdk-web-storage": "^0.4.2",
13
+ "@streamlayer/sdk-web-types": "^0.22.2",
14
+ "@streamlayer/sdk-web-logger": "^0.5.15"
14
15
  },
15
16
  "exports": {
16
17
  ".": {
@@ -39,7 +40,7 @@
39
40
  "default": "./lib/auth/index.js"
40
41
  }
41
42
  },
42
- "version": "0.19.0",
43
+ "version": "0.20.1",
43
44
  "type": "module",
44
45
  "main": "./lib/index.js",
45
46
  "module": "./lib/index.js",