@or-sdk/discovery 1.11.2-beta.4096.0 → 1.11.2-beta.4097.0

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.
@@ -3,18 +3,92 @@ import { DiscoveryConfig, ListServicesPayload, ListServicesByCategoryPayload, Se
3
3
  export declare class Discovery extends Base {
4
4
  private readonly route;
5
5
  constructor({ token, discoveryUrl }: DiscoveryConfig);
6
+ /**
7
+ * Get services list
8
+ * ```typescript
9
+ * const result = await discovery.listServices({ type: 'type', feature: 'feature' });
10
+ * ```
11
+ */
6
12
  listServices({ type, feature, invalidate }?: ListServicesPayload): Promise<List<ServiceResponse>>;
13
+ /**
14
+ * Get services list by category
15
+ * ```typescript
16
+ * const result = await discovery.listServices({ type: 'type', feature: 'feature' });
17
+ * ```
18
+ */
7
19
  listServicesByCategory({ category, feature }: ListServicesByCategoryPayload): Promise<List<ServiceResponse>>;
20
+ /**
21
+ * Get service url
22
+ * ```typescript
23
+ * const result = await discovery.getServiceUrl('serviceName');
24
+ * ```
25
+ */
8
26
  getServiceUrl(serviceKey: string): Promise<string>;
27
+ /**
28
+ * Delete service
29
+ * ```typescript
30
+ * await discovery.deleteService('serviceKey');
31
+ * ```
32
+ */
9
33
  deleteService(serviceKey: string): Promise<void>;
34
+ /**
35
+ * Creates or updates service
36
+ * ```typescript
37
+ * await discovery.createOrUpdateService({
38
+ * serviceKey: "some-service",
39
+ * version: "1.0.0",
40
+ * type: "ui",
41
+ * url: "https://api.example.com/users",
42
+ * translations: {
43
+ * en: { label: "Some Service" },
44
+ * },
45
+ * });
46
+ * ```
47
+ */
10
48
  createOrUpdateService(service: ServiceCreateOrUpdatePayload): Promise<void>;
49
+ /**
50
+ * Hide service
51
+ * ```typescript
52
+ * await discovery.hideService('serviceKey');
53
+ * ```
54
+ */
11
55
  hideService(serviceKey: string): Promise<void>;
56
+ /**
57
+ * Unhide service
58
+ * ```typescript
59
+ * await discovery.unhideService('serviceKey');
60
+ * ```
61
+ */
12
62
  revealService(serviceKey: string): Promise<void>;
63
+ /**
64
+ * Get multiple service urls
65
+ * ```typescript
66
+ * const result = await discovery.getServiceUrls(['serviceName']);
67
+ * ```
68
+ */
13
69
  getServiceUrls(serviceKeys: string[], feature?: string): Promise<(ServiceResponse | null)[]>;
70
+ /**
71
+ * Get environment
72
+ * ```typescript
73
+ * const result = await discovery.getEnv();
74
+ * ```
75
+ */
14
76
  getEnv(): Promise<{
15
77
  env: string;
16
78
  }>;
79
+ /**
80
+ * Get providersAccountId
81
+ * ```typescript
82
+ * const providersAccountId = await discovery.getProvidersAccountId();
83
+ * ```
84
+ */
17
85
  getProvidersAccountId(): Promise<string>;
86
+ /**
87
+ * Get currentAccountId
88
+ * ```typescript
89
+ * const currentAccountId = await discovery.getCurrentAccountId();
90
+ * ```
91
+ */
18
92
  getCurrentAccountId(): Promise<string>;
19
93
  }
20
94
  //# sourceMappingURL=Discovery.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Discovery.d.ts","sourceRoot":"","sources":["../../src/Discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAA+C,MAAM,cAAc,CAAC;AAEvF,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,6BAA6B,EAC7B,eAAe,EACf,4BAA4B,EAC7B,MAAM,SAAS,CAAC;AAEjB,qBAAa,SAAU,SAAQ,IAAI;IACjC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAoB;gBAE9B,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,eAAe;IAcvC,YAAY,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,GAAE,mBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAyBrG,sBAAsB,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAmB5G,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBlD,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBhD,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB3E,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB9C,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBhD,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,eAAe,GAAG,IAAI,CAAC,EAAE,CAAC;IAqB5F,MAAM,IAAI,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;KAAE,CAAC;IAanC,qBAAqB,IAAI,OAAO,CAAC,MAAM,CAAC;IAexC,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC;CAQpD"}
1
+ {"version":3,"file":"Discovery.d.ts","sourceRoot":"","sources":["../../src/Discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAA+C,MAAM,cAAc,CAAC;AAEvF,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,6BAA6B,EAC7B,eAAe,EACf,4BAA4B,EAC7B,MAAM,SAAS,CAAC;AAEjB,qBAAa,SAAU,SAAQ,IAAI;IACjC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAoB;gBAE9B,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,eAAe;IAQpD;;;;;OAKG;IACU,YAAY,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,GAAE,mBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAmBlH;;;;;OAKG;IACU,sBAAsB,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,6BAA6B,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAazH;;;;;OAKG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAY/D;;;;;OAKG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU7D;;;;;;;;;;;;;MAaE;IACW,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAUxF;;;;;OAKG;IACU,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU3D;;;;;OAKG;IACU,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU7D;;;;;OAKG;IACU,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,eAAe,GAAG,IAAI,CAAC,EAAE,CAAC;IAezG;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;KAAE,CAAC;IAOhD;;;;;OAKG;IACU,qBAAqB,IAAI,OAAO,CAAC,MAAM,CAAC;IASrD;;;;;OAKG;IACU,mBAAmB,IAAI,OAAO,CAAC,MAAM,CAAC;CAQpD"}
@@ -1,6 +1,12 @@
1
1
  import { Token } from '@or-sdk/base';
2
2
  export type DiscoveryConfig = {
3
+ /**
4
+ * token
5
+ */
3
6
  token?: Token;
7
+ /**
8
+ * Url of OneReach service discovery api
9
+ */
4
10
  discoveryUrl?: string;
5
11
  };
6
12
  export type ServiceTranslation = {
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,eAAe,GAAG;IAI5B,KAAK,CAAC,EAAE,KAAK,CAAC;IAKd,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,CAAA;KAAE,CAAC;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,OAAO,GAAG;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAGF,MAAM,MAAM,oBAAoB,GAAG;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE;QAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,CAAA;KAAE,CAAC;IAC1D,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,OAAO,GAAG;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAGF,MAAM,MAAM,oBAAoB,GAAG;IACjC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAC"}
@@ -1,2 +1,5 @@
1
+ /**
2
+ * @internal
3
+ */
1
4
  export { default as convertUrlsResult } from './convertUrlsResult';
2
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@or-sdk/discovery",
3
- "version": "1.11.2-beta.4096.0",
3
+ "version": "1.11.2-beta.4097.0",
4
4
  "license": "Apache-2.0",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -18,7 +18,7 @@
18
18
  "dev": "pnpm build:watch:esm"
19
19
  },
20
20
  "dependencies": {
21
- "@or-sdk/base": "^0.44.1-beta.4096.0"
21
+ "@or-sdk/base": "^0.44.1-beta.4097.0"
22
22
  },
23
23
  "devDependencies": {
24
24
  "concurrently": "9.0.1",