@amityco/ts-sdk 0.0.1-beta.14 → 0.0.1-beta.15

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.
package/README.md CHANGED
@@ -26,12 +26,12 @@ import {
26
26
  } from '@amityco/ts-sdk'
27
27
 
28
28
  (async () => {
29
- const client = createClient(API_KEY, API_ENDPOINT)
29
+ const client = createClient(API_KEY, API_REGION)
30
30
  let isConnected = await connectClient({ userId: USER_ID })
31
31
  })()
32
32
  ```
33
33
 
34
- The `API_KEY` and `API_ENDPOINT` are given at the time you create an application in the [Amity Portal](http://portal.amity.co/).
34
+ The `API_KEY` and `API_REGION` are given at the time you create an application in the [Amity Portal](http://portal.amity.co/).
35
35
 
36
36
  You can listen to disconnection by using the `onClientDisconnected` function:
37
37
 
@@ -61,7 +61,7 @@ import {
61
61
  } from '@amityco/ts-sdk'
62
62
 
63
63
  (async () => {
64
- const client = createClient(API_KEY, API_ENDPOINT)
64
+ const client = createClient(API_KEY, API_REGION)
65
65
  enableCache()
66
66
 
67
67
  let isConnected = await connectClient({ userId: USER_ID })
@@ -4,11 +4,11 @@ export {};
4
4
  declare global {
5
5
  namespace Amity {
6
6
  type Listener<T = any> = (params: T) => void;
7
- type ObjectListener<T, K extends string[]> = {
7
+ type ObjectListener<T, K extends string[]> = Listener<T> | ({
8
8
  onEvent?: (event: K[number], params: T) => void;
9
9
  } & {
10
10
  [P in K[number]]?: Listener<T>;
11
- };
11
+ });
12
12
  type Unsubscriber = () => void;
13
13
  type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber;
14
14
  type WsEvents = {
@@ -1 +1 @@
1
- {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/@types/core/events.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAElF,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,QAAQ,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAA;QAE5C,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAAE,IAAI;YAC3C,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,CAAA;SAChD,GAAG;aACD,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;SAC/B,CAAA;QAED,KAAK,YAAY,GAAG,MAAM,IAAI,CAAA;QAE9B,KAAK,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,YAAY,CAAA;QAElE,KAAK,QAAQ,GAAG;YACd,YAAY,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAA;YAC7C,KAAK,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YACvC,aAAa,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/C,eAAe,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YACjD,gBAAgB,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAElD,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,oBAAoB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC1C,qBAAqB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC3C,wBAAwB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC9C,2BAA2B,EAAE,KAAK,CAAC,cAAc,CAAA;YACjD,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAA;YACzC,qBAAqB,EAAE,KAAK,CAAC,cAAc,CAAA;YAE3C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAE5C,2BAA2B,EAAE,KAAK,CAAC,aAAa,CAAA;YAChD,0BAA0B,EAAE,KAAK,CAAC,aAAa,CAAA;YAC/C,yBAAyB,EAAE,KAAK,CAAC,aAAa,CAAA;SAC/C,CAAA;QAED,KAAK,UAAU,GAAG;YAChB,OAAO,EAAE,cAAc,CAAC;YACxB,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,CAAA;YACjE,UAAU,EAAE,iBAAiB,CAAC;YAC9B,KAAK,EAAE,KAAK,CAAC;YACb,KAAK,EAAE,KAAK,CAAC;YACb,GAAG,EAAE,SAAS,CAAC;YACf,SAAS,EAAE,SAAS,CAAC;SACtB,CAAA;QAED,KAAK,8BAA8B,GAAG;YACpC,kBAAkB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YACpD,gBAAgB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YAClD,qBAAqB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YACvD,uBAAuB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YACzD,sBAAsB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YACxD,wBAAwB,EAAE,KAAK,CAAC,0BAA0B,CAAA;SAC3D,CAAA;QAED,KAAK,0BAA0B,GAAG;YAChC,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAC;YAC5C,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAC3C,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAA;SAC5C,GAAG,8BAA8B,CAAA;QAElC,KAAK,qBAAqB,GAAG;YAC3B,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,eAAe,EAAE,KAAK,CAAC,WAAW,CAAA;YAClC,eAAe,EAAE,KAAK,CAAC,WAAW,CAAA;YAClC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,gBAAgB,EAAE,KAAK,CAAC,WAAW,CAAA;YACnC,kBAAkB,EAAE,KAAK,CAAC,WAAW,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAA;YACnE,qBAAqB,EAAE,KAAK,CAAC,WAAW,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAA;SACvE,CAAA;QAED,KAAK,wBAAwB,GAAG;YAC9B,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAA;YACvC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAA;YACvC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAA;YACvC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAA;YACvC,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAA;YACzC,qBAAqB,EAAE,KAAK,CAAC,cAAc,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAA;YACzE,wBAAwB,EAAE,KAAK,CAAC,cAAc,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAA;SAC7E,CAAA;QAED,KAAK,qBAAqB,GAAG;YAC3B,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,gBAAgB,EAAE,KAAK,CAAC,WAAW,CAAA;YACnC,kBAAkB,EAAE,KAAK,CAAC,WAAW,CAAA;SACtC,CAAA;QAED,KAAK,iBAAiB,GAAG,0BAA0B,GAC/C,qBAAqB,GACrB,wBAAwB,GACxB,qBAAqB,CAAA;QAEzB,KAAK,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,iBAAiB,CAAA;KACxD;CACF"}
1
+ {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../src/@types/core/events.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAElF,OAAO,EAAE,CAAA;AAET,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK,CAAC;QACd,KAAK,QAAQ,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAA;QAE5C,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,EAAE,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAG;YACzD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,CAAA;SAChD,GAAG;aACD,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;SAC/B,CAAA,CAAA;QAED,KAAK,YAAY,GAAG,MAAM,IAAI,CAAA;QAE9B,KAAK,UAAU,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,YAAY,CAAA;QAElE,KAAK,QAAQ,GAAG;YACd,YAAY,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAA;YAC7C,KAAK,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YACvC,aAAa,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAC/C,eAAe,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YACjD,gBAAgB,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;YAElD,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,oBAAoB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC1C,qBAAqB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC3C,wBAAwB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC9C,2BAA2B,EAAE,KAAK,CAAC,cAAc,CAAA;YACjD,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAA;YACzC,qBAAqB,EAAE,KAAK,CAAC,cAAc,CAAA;YAE3C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAC5C,sBAAsB,EAAE,KAAK,CAAC,cAAc,CAAA;YAE5C,2BAA2B,EAAE,KAAK,CAAC,aAAa,CAAA;YAChD,0BAA0B,EAAE,KAAK,CAAC,aAAa,CAAA;YAC/C,yBAAyB,EAAE,KAAK,CAAC,aAAa,CAAA;SAC/C,CAAA;QAED,KAAK,UAAU,GAAG;YAChB,OAAO,EAAE,cAAc,CAAC;YACxB,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,CAAA;YACjE,UAAU,EAAE,iBAAiB,CAAC;YAC9B,KAAK,EAAE,KAAK,CAAC;YACb,KAAK,EAAE,KAAK,CAAC;YACb,GAAG,EAAE,SAAS,CAAC;YACf,SAAS,EAAE,SAAS,CAAC;SACtB,CAAA;QAED,KAAK,8BAA8B,GAAG;YACpC,kBAAkB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YACpD,gBAAgB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YAClD,qBAAqB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YACvD,uBAAuB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YACzD,sBAAsB,EAAE,KAAK,CAAC,0BAA0B,CAAA;YACxD,wBAAwB,EAAE,KAAK,CAAC,0BAA0B,CAAA;SAC3D,CAAA;QAED,KAAK,0BAA0B,GAAG;YAChC,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAC;YAC5C,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAA;YAC3C,mBAAmB,EAAE,KAAK,CAAC,gBAAgB,CAAA;SAC5C,GAAG,8BAA8B,CAAA;QAElC,KAAK,qBAAqB,GAAG;YAC3B,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,eAAe,EAAE,KAAK,CAAC,WAAW,CAAA;YAClC,eAAe,EAAE,KAAK,CAAC,WAAW,CAAA;YAClC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,gBAAgB,EAAE,KAAK,CAAC,WAAW,CAAA;YACnC,kBAAkB,EAAE,KAAK,CAAC,WAAW,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAA;YACnE,qBAAqB,EAAE,KAAK,CAAC,WAAW,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAA;SACvE,CAAA;QAED,KAAK,wBAAwB,GAAG;YAC9B,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAA;YACvC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAA;YACvC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAA;YACvC,iBAAiB,EAAE,KAAK,CAAC,cAAc,CAAA;YACvC,mBAAmB,EAAE,KAAK,CAAC,cAAc,CAAA;YACzC,qBAAqB,EAAE,KAAK,CAAC,cAAc,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAA;YACzE,wBAAwB,EAAE,KAAK,CAAC,cAAc,GAAG;gBAAE,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAA;aAAE,CAAA;SAC7E,CAAA;QAED,KAAK,qBAAqB,GAAG;YAC3B,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,cAAc,EAAE,KAAK,CAAC,WAAW,CAAA;YACjC,gBAAgB,EAAE,KAAK,CAAC,WAAW,CAAA;YACnC,kBAAkB,EAAE,KAAK,CAAC,WAAW,CAAA;SACtC,CAAA;QAED,KAAK,iBAAiB,GAAG,0BAA0B,GAC/C,qBAAqB,GACrB,wBAAwB,GACxB,qBAAqB,CAAA;QAEzB,KAAK,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,iBAAiB,CAAA;KACxD;CACF"}
@@ -1,4 +1,4 @@
1
- import { API_ENDPOINT } from '~/core/network';
1
+ import { API_REGIONS } from '~/client/utils/endpoints';
2
2
  /**
3
3
  * ```js
4
4
  * import { createClient } from '@amityco/ts-sdk'
@@ -8,11 +8,11 @@ import { API_ENDPOINT } from '~/core/network';
8
8
  * Creates a new {@link Amity.Client} instance
9
9
  *
10
10
  * @param apiKey for the {@link Amity.Client} instance
11
- * @param apiEndpoint endpoint to connect to
11
+ * @param apiRegion endpoint to connect to
12
12
  * @param debugSession session's identifier for the client's logger instance
13
13
  * @returns A {@link Amity.Client} instance
14
14
  *
15
15
  * @category Client API
16
16
  **/
17
- export declare const createClient: (apiKey: string, apiEndpoint?: typeof API_ENDPOINT[keyof typeof API_ENDPOINT] | string, debugSession?: string) => Amity.Client;
17
+ export declare const createClient: (apiKey: string, apiRegion?: typeof API_REGIONS[keyof typeof API_REGIONS], debugSession?: string) => Amity.Client;
18
18
  //# sourceMappingURL=createClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"createClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/createClient.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAmC,MAAM,gBAAgB,CAAA;AAO9E;;;;;;;;;;;;;;IAcI;AACJ,eAAO,MAAM,YAAY,WACf,MAAM,gBACD,mBAAmB,CAAC,MAAM,mBAAmB,CAAC,GAAC,MAAM,iBACpD,MAAM,KACnB,MAAM,MAiCR,CAAA"}
1
+ {"version":3,"file":"createClient.d.ts","sourceRoot":"","sources":["../../../src/client/api/createClient.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,WAAW,EAAc,MAAM,0BAA0B,CAAA;AAOlE;;;;;;;;;;;;;;IAcI;AACJ,eAAO,MAAM,YAAY,WACf,MAAM,cACH,kBAAkB,CAAC,MAAM,kBAAkB,CAAC,iBACzC,MAAM,KACnB,MAAM,MAiCR,CAAA"}
@@ -0,0 +1,12 @@
1
+ export declare const API_REGIONS: {
2
+ readonly EU: "eu";
3
+ readonly SG: "sg";
4
+ readonly US: "us";
5
+ };
6
+ declare const URLS: {
7
+ readonly http: "https://api.{region}.amity.co";
8
+ readonly mqtt: "wss://sse.{region}.amity.co:443/mqtt";
9
+ };
10
+ export declare function computeUrl(type: keyof typeof URLS, region: string): string;
11
+ export {};
12
+ //# sourceMappingURL=endpoints.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../src/client/utils/endpoints.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW;;;;CAId,CAAA;AAEV,QAAA,MAAM,IAAI;;;CAGA,CAAA;AAEV,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,OAAO,IAAI,EAAE,MAAM,EAAE,MAAM,UAEjE"}
package/dist/index.cjs.js CHANGED
@@ -496,19 +496,18 @@ const createLogger = (session) => {
496
496
  return print;
497
497
  };
498
498
 
499
- const API_ENDPOINT = {
499
+ const API_REGIONS = {
500
500
  EU: 'eu',
501
501
  SG: 'sg',
502
502
  US: 'us',
503
503
  };
504
- var UrlTemplate;
505
- (function (UrlTemplate) {
506
- UrlTemplate["HTTP"] = "https://api.{region}.amity.co";
507
- UrlTemplate["MQTT"] = "wss://sse.{region}.amity.co:443/mqtt";
508
- })(UrlTemplate || (UrlTemplate = {}));
509
- const getUrlFromTemplate = (template, region) => {
510
- return template.replace('{region}', region);
511
- };
504
+ const URLS = {
505
+ http: 'https://api.{region}.amity.co',
506
+ mqtt: 'wss://sse.{region}.amity.co:443/mqtt',
507
+ };
508
+ function computeUrl(type, region) {
509
+ return URLS[type].replace('{region}', region);
510
+ }
512
511
 
513
512
  /**
514
513
  * Unwraps v3 server payload (for error handling and type extraction)
@@ -14832,21 +14831,21 @@ const fireEvent = (event, payload) => {
14832
14831
  * Creates a new {@link Amity.Client} instance
14833
14832
  *
14834
14833
  * @param apiKey for the {@link Amity.Client} instance
14835
- * @param apiEndpoint endpoint to connect to
14834
+ * @param apiRegion endpoint to connect to
14836
14835
  * @param debugSession session's identifier for the client's logger instance
14837
14836
  * @returns A {@link Amity.Client} instance
14838
14837
  *
14839
14838
  * @category Client API
14840
14839
  **/
14841
- const createClient = (apiKey, apiEndpoint = API_ENDPOINT.SG, debugSession = 'amity') => {
14840
+ const createClient = (apiKey, apiRegion = API_REGIONS.SG, debugSession = 'amity') => {
14842
14841
  const log = createLogger(debugSession);
14843
14842
  log('client/api/createClient', {
14844
14843
  apiKey: apiKey.replace(/.{5}$/g, 'xxxxx'),
14845
- apiEndpoint,
14844
+ apiRegion,
14846
14845
  });
14847
- const http = createHttpTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint));
14848
- const ws = createWebsocketTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint));
14849
- const mqtt = createMqttTransport(getUrlFromTemplate(UrlTemplate.MQTT, apiEndpoint));
14846
+ const http = createHttpTransport(computeUrl('http', apiRegion));
14847
+ const ws = createWebsocketTransport(computeUrl('http', apiRegion));
14848
+ const mqtt = createMqttTransport(computeUrl('mqtt', apiRegion));
14850
14849
  const emitter = createEventEmitter();
14851
14850
  const client = {
14852
14851
  version: `${VERSION$1}`,
@@ -20007,6 +20006,7 @@ const onStreamRecorded = (callback) => {
20007
20006
  return createEventSubscriber(client, 'stream/onStreamRecorded', 'video-streaming.didRecord', filter);
20008
20007
  };
20009
20008
 
20009
+ exports.API_REGIONS = API_REGIONS;
20010
20010
  exports.VERSION = VERSION$1;
20011
20011
  exports.addChannelMembers = addChannelMembers;
20012
20012
  exports.addChannelMembersRole = addChannelMembersRole;
package/dist/index.d.ts CHANGED
@@ -5,6 +5,7 @@ export * from './core/subscription';
5
5
  export * from './cache/api';
6
6
  export * from './client/api';
7
7
  export * from './client/events';
8
+ export { API_REGIONS } from './client/utils/endpoints';
8
9
  export * from './user/api';
9
10
  export * from './user/events';
10
11
  export * from './user/observers';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,CAAA;AAEjB,cAAc,WAAW,CAAA;AAGzB,cAAc,cAAc,CAAA;AAC5B,cAAc,qBAAqB,CAAA;AACnC,cAAc,aAAa,CAAA;AAE3B,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAG/B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAEhC,cAAc,YAAY,CAAA;AAC1B,cAAc,kBAAkB,CAAA;AAEhC,cAAc,YAAY,CAAA;AAG1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AAEjC,cAAc,cAAc,CAAA;AAG5B,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AAEnC,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AAGnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AAErC,cAAc,YAAY,CAAA;AAE1B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAEhC,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AAEnC,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,CAAA;AAEjB,cAAc,WAAW,CAAA;AAGzB,cAAc,cAAc,CAAA;AAC5B,cAAc,qBAAqB,CAAA;AACnC,cAAc,aAAa,CAAA;AAE3B,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAGtD,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAEhC,cAAc,YAAY,CAAA;AAC1B,cAAc,kBAAkB,CAAA;AAEhC,cAAc,YAAY,CAAA;AAG1B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,mBAAmB,CAAA;AAEjC,cAAc,cAAc,CAAA;AAG5B,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AAEnC,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AAGnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AAErC,cAAc,YAAY,CAAA;AAE1B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAEhC,cAAc,eAAe,CAAA;AAC7B,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AAEnC,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA"}
package/dist/index.esm.js CHANGED
@@ -483,19 +483,18 @@ const createLogger = (session) => {
483
483
  return print;
484
484
  };
485
485
 
486
- const API_ENDPOINT = {
486
+ const API_REGIONS = {
487
487
  EU: 'eu',
488
488
  SG: 'sg',
489
489
  US: 'us',
490
490
  };
491
- var UrlTemplate;
492
- (function (UrlTemplate) {
493
- UrlTemplate["HTTP"] = "https://api.{region}.amity.co";
494
- UrlTemplate["MQTT"] = "wss://sse.{region}.amity.co:443/mqtt";
495
- })(UrlTemplate || (UrlTemplate = {}));
496
- const getUrlFromTemplate = (template, region) => {
497
- return template.replace('{region}', region);
498
- };
491
+ const URLS = {
492
+ http: 'https://api.{region}.amity.co',
493
+ mqtt: 'wss://sse.{region}.amity.co:443/mqtt',
494
+ };
495
+ function computeUrl(type, region) {
496
+ return URLS[type].replace('{region}', region);
497
+ }
499
498
 
500
499
  /**
501
500
  * Unwraps v3 server payload (for error handling and type extraction)
@@ -14819,21 +14818,21 @@ const fireEvent = (event, payload) => {
14819
14818
  * Creates a new {@link Amity.Client} instance
14820
14819
  *
14821
14820
  * @param apiKey for the {@link Amity.Client} instance
14822
- * @param apiEndpoint endpoint to connect to
14821
+ * @param apiRegion endpoint to connect to
14823
14822
  * @param debugSession session's identifier for the client's logger instance
14824
14823
  * @returns A {@link Amity.Client} instance
14825
14824
  *
14826
14825
  * @category Client API
14827
14826
  **/
14828
- const createClient = (apiKey, apiEndpoint = API_ENDPOINT.SG, debugSession = 'amity') => {
14827
+ const createClient = (apiKey, apiRegion = API_REGIONS.SG, debugSession = 'amity') => {
14829
14828
  const log = createLogger(debugSession);
14830
14829
  log('client/api/createClient', {
14831
14830
  apiKey: apiKey.replace(/.{5}$/g, 'xxxxx'),
14832
- apiEndpoint,
14831
+ apiRegion,
14833
14832
  });
14834
- const http = createHttpTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint));
14835
- const ws = createWebsocketTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint));
14836
- const mqtt = createMqttTransport(getUrlFromTemplate(UrlTemplate.MQTT, apiEndpoint));
14833
+ const http = createHttpTransport(computeUrl('http', apiRegion));
14834
+ const ws = createWebsocketTransport(computeUrl('http', apiRegion));
14835
+ const mqtt = createMqttTransport(computeUrl('mqtt', apiRegion));
14837
14836
  const emitter = createEventEmitter();
14838
14837
  const client = {
14839
14838
  version: `${VERSION$1}`,
@@ -19994,4 +19993,4 @@ const onStreamRecorded = (callback) => {
19994
19993
  return createEventSubscriber(client, 'stream/onStreamRecorded', 'video-streaming.didRecord', filter);
19995
19994
  };
19996
19995
 
19997
- export { SubscriptionLevels, VERSION$1 as VERSION, addChannelMembers, addChannelMembersRole, addCommunityMembers, addCommunityMembersRole, addReaction, backupCache, connectClient, createChannel, createClient, createComment, createCommunity, createFile, createMessage, createPost, createQuery, createReport, createStream, deleteChannel, deleteComment, deleteCommunity, deleteFile, deleteMessage, deletePost, deleteReport, deleteStream, disableCache, disconnectClient, disposeStream, dropFromCache, enableCache, fileUrlWithSize, filterByPropEquality, getActiveClient, getChannel, getChannels, getComment, getCommentTopic, getComments, getCommunities, getCommunity, getCommunityTopic, getFile, getMessage, getMessages, getPost, getPostTopic, getPosts, getRole, getStream, getUser, getUserTopic, getUsers, isAfterBefore, isAfterBeforeRaw, isCachable, isConnected, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkipLimit, joinChannel, joinCommunity, leaveChannel, leaveCommunity, mergeInCache, observeChannel, observeComment, observeComments, observeCommunity, observeFile, observeMessage, observeMessages, observePost, observePosts, observeUser, onChannelDeleted, onChannelJoined, onChannelLeft, onChannelUpdated, onClientBanned, onClientDisconnected, onCommentCreated, onCommentDeleted, onCommentFlagged, onCommentReactionAdded, onCommentReactionRemoved, onCommentUnflagged, onCommentUpdated, onCommunityCreated, onCommunityDeleted, onCommunityJoined, onCommunityLeft, onCommunityUpdated, onCommunityUserAdded, onCommunityUserBanned, onCommunityUserRemoved, onCommunityUserUnbanned, onConnectionError, onMemberAdded, onMemberRemoved, onMessageCreated, onMessageDeleted, onMessageUpdated, onPostApproved, onPostCreated, onPostDeclined, onPostDeleted, onPostFlagged, onPostReactionAdded, onPostReactionRemoved, onPostUnflagged, onPostUpdated, onReactionRemoved, onStreamRecorded, onStreamStarted, onStreamStopped, onUserFlagCleared, onUserFlagged, onUserUnflagged, onUserUpdated, pullFromCache, pushToCache, queryCache, queryChannelMembers, queryChannels, queryComments, queryCommunities, queryCommunityMembers, queryGlobalFeed, queryMessages, queryOptions, queryPosts, queryRoles, queryStreams, queryUsers, removeChannelMembers, removeChannelMembersRole, removeCommunityMembers, removeCommunityMembersRole, removeReaction, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByLastActivity, sortByLastCreated, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, updateChannel, updateComment, updateCommunity, updateMessage, updatePost, updateStream, updateUser, upsertInCache, wipeCache };
19996
+ export { API_REGIONS, SubscriptionLevels, VERSION$1 as VERSION, addChannelMembers, addChannelMembersRole, addCommunityMembers, addCommunityMembersRole, addReaction, backupCache, connectClient, createChannel, createClient, createComment, createCommunity, createFile, createMessage, createPost, createQuery, createReport, createStream, deleteChannel, deleteComment, deleteCommunity, deleteFile, deleteMessage, deletePost, deleteReport, deleteStream, disableCache, disconnectClient, disposeStream, dropFromCache, enableCache, fileUrlWithSize, filterByPropEquality, getActiveClient, getChannel, getChannels, getComment, getCommentTopic, getComments, getCommunities, getCommunity, getCommunityTopic, getFile, getMessage, getMessages, getPost, getPostTopic, getPosts, getRole, getStream, getUser, getUserTopic, getUsers, isAfterBefore, isAfterBeforeRaw, isCachable, isConnected, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkipLimit, joinChannel, joinCommunity, leaveChannel, leaveCommunity, mergeInCache, observeChannel, observeComment, observeComments, observeCommunity, observeFile, observeMessage, observeMessages, observePost, observePosts, observeUser, onChannelDeleted, onChannelJoined, onChannelLeft, onChannelUpdated, onClientBanned, onClientDisconnected, onCommentCreated, onCommentDeleted, onCommentFlagged, onCommentReactionAdded, onCommentReactionRemoved, onCommentUnflagged, onCommentUpdated, onCommunityCreated, onCommunityDeleted, onCommunityJoined, onCommunityLeft, onCommunityUpdated, onCommunityUserAdded, onCommunityUserBanned, onCommunityUserRemoved, onCommunityUserUnbanned, onConnectionError, onMemberAdded, onMemberRemoved, onMessageCreated, onMessageDeleted, onMessageUpdated, onPostApproved, onPostCreated, onPostDeclined, onPostDeleted, onPostFlagged, onPostReactionAdded, onPostReactionRemoved, onPostUnflagged, onPostUpdated, onReactionRemoved, onStreamRecorded, onStreamStarted, onStreamStopped, onUserFlagCleared, onUserFlagged, onUserUnflagged, onUserUpdated, pullFromCache, pushToCache, queryCache, queryChannelMembers, queryChannels, queryComments, queryCommunities, queryCommunityMembers, queryGlobalFeed, queryMessages, queryOptions, queryPosts, queryRoles, queryStreams, queryUsers, removeChannelMembers, removeChannelMembersRole, removeCommunityMembers, removeCommunityMembersRole, removeReaction, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByLastActivity, sortByLastCreated, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, updateChannel, updateComment, updateCommunity, updateMessage, updatePost, updateStream, updateUser, upsertInCache, wipeCache };