@qlik/api 0.0.4 → 0.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.
Files changed (165) hide show
  1. package/README.md +83 -2
  2. package/api-keys.d.mts +1 -1
  3. package/api-keys.d.ts +1 -1
  4. package/api-keys.js +10 -10
  5. package/api-keys.mjs +2 -2
  6. package/apps.d.mts +21 -62
  7. package/apps.d.ts +21 -62
  8. package/apps.js +46 -46
  9. package/apps.mjs +2 -2
  10. package/audits.d.mts +1 -1
  11. package/audits.d.ts +1 -1
  12. package/audits.js +9 -9
  13. package/audits.mjs +2 -2
  14. package/auth-6VOJ5YIL.js +41 -0
  15. package/{auth-CPBNNC7S.mjs → auth-7HMK2Q6F.mjs} +1 -1
  16. package/auth.js +3 -3
  17. package/auth.mjs +2 -2
  18. package/automations.d.mts +1 -1
  19. package/automations.d.ts +1 -1
  20. package/automations.js +21 -21
  21. package/automations.mjs +2 -2
  22. package/brands.d.mts +1 -1
  23. package/brands.d.ts +1 -1
  24. package/brands.js +15 -15
  25. package/brands.mjs +2 -2
  26. package/{chunk-D52VW5UN.js → chunk-2II4JNZO.js} +17 -13
  27. package/{chunk-GV5SRHY2.js → chunk-2NSUC46G.js} +4 -4
  28. package/{chunk-7RY3NO6N.js → chunk-7PAVHCQG.js} +2 -2
  29. package/{chunk-GNWU6SP2.mjs → chunk-EDRFS7GY.mjs} +1 -1
  30. package/{chunk-3SVRHJII.mjs → chunk-GLWHVX4M.mjs} +3 -3
  31. package/{chunk-2STFUQKQ.js → chunk-JZAPZIPR.js} +3 -3
  32. package/{chunk-TE7XMBT5.mjs → chunk-PUBPF4EZ.mjs} +1 -1
  33. package/{chunk-CYRLVHU3.mjs → chunk-QLS6D4AX.mjs} +17 -13
  34. package/{chunk-67GJTTPV.mjs → chunk-UXRTUKY5.mjs} +1 -1
  35. package/{chunk-JNGURO23.js → chunk-XJKF347C.js} +3 -3
  36. package/collections.d.mts +1 -1
  37. package/collections.d.ts +1 -1
  38. package/collections.js +14 -14
  39. package/collections.mjs +2 -2
  40. package/csp-origins.d.mts +1 -1
  41. package/csp-origins.d.ts +1 -1
  42. package/csp-origins.js +9 -9
  43. package/csp-origins.mjs +2 -2
  44. package/data-assets.d.mts +1 -1
  45. package/data-assets.d.ts +1 -1
  46. package/data-assets.js +8 -8
  47. package/data-assets.mjs +2 -2
  48. package/data-connections.d.mts +1 -1
  49. package/data-connections.d.ts +1 -1
  50. package/data-connections.js +12 -12
  51. package/data-connections.mjs +2 -2
  52. package/data-credentials.d.mts +1 -1
  53. package/data-credentials.d.ts +1 -1
  54. package/data-credentials.js +7 -7
  55. package/data-credentials.mjs +2 -2
  56. package/data-files.d.mts +1 -1
  57. package/data-files.d.ts +1 -1
  58. package/data-files.js +15 -15
  59. package/data-files.mjs +2 -2
  60. package/docs/authentication.md +220 -0
  61. package/docs/examples/create-app.md +51 -0
  62. package/docs/examples/create-session-app.md +88 -0
  63. package/docs/examples/fetch-spaces.md +104 -0
  64. package/docs/examples/show-sheet-list.md +81 -0
  65. package/docs/examples.md +10 -2
  66. package/docs/features.md +129 -0
  67. package/docs/qix.md +85 -0
  68. package/docs/rest.md +64 -0
  69. package/{enigma-session-XPXDQAIV.js → enigma-session-2OXUKTWL.js} +4 -4
  70. package/{enigma-session-ZH6MYA54.mjs → enigma-session-L4P4IJWW.mjs} +1 -1
  71. package/{esm-OY4XVIJB.mjs → esm-HMY2LVVZ.mjs} +1 -1
  72. package/{esm-3VXX2GKL.js → esm-PXQUPJYJ.js} +1 -1
  73. package/extensions.d.mts +1 -1
  74. package/extensions.d.ts +1 -1
  75. package/extensions.js +10 -10
  76. package/extensions.mjs +2 -2
  77. package/{global.types-hIvp-WdX.d.ts → global.types-1rNhDH7j.d.ts} +9 -0
  78. package/{global.types-Eto4uYwy.d.mts → global.types-4jzAvW7R.d.mts} +9 -0
  79. package/glossaries.d.mts +1 -1
  80. package/glossaries.d.ts +1 -1
  81. package/glossaries.js +27 -27
  82. package/glossaries.mjs +2 -2
  83. package/groups.d.mts +1 -1
  84. package/groups.d.ts +1 -1
  85. package/groups.js +11 -11
  86. package/groups.mjs +2 -2
  87. package/identity-providers.d.mts +1 -1
  88. package/identity-providers.d.ts +1 -1
  89. package/identity-providers.js +11 -11
  90. package/identity-providers.mjs +2 -2
  91. package/index.d.mts +1 -1
  92. package/index.d.ts +1 -1
  93. package/index.js +8 -8
  94. package/index.mjs +4 -4
  95. package/{invoke-fetch-3WZWAAZH.mjs → invoke-fetch-CK5Y37H3.mjs} +1 -1
  96. package/invoke-fetch-D52L5Y7B.js +17 -0
  97. package/items.d.mts +1 -1
  98. package/items.d.ts +1 -1
  99. package/items.js +11 -11
  100. package/items.mjs +2 -2
  101. package/licenses.d.mts +1 -1
  102. package/licenses.d.ts +1 -1
  103. package/licenses.js +12 -12
  104. package/licenses.mjs +2 -2
  105. package/package.json +4 -4
  106. package/{qix-UNWXPGMA.js → qix-FLNSZRQX.js} +8 -8
  107. package/{qix-ZSJ4PIK3.mjs → qix-MP65NOTD.mjs} +2 -2
  108. package/qix.d.mts +2 -2
  109. package/qix.d.ts +2 -2
  110. package/qix.js +3 -3
  111. package/qix.mjs +2 -2
  112. package/quotas.d.mts +1 -1
  113. package/quotas.d.ts +1 -1
  114. package/quotas.js +5 -5
  115. package/quotas.mjs +2 -2
  116. package/reload-tasks.d.mts +1 -1
  117. package/reload-tasks.d.ts +1 -1
  118. package/reload-tasks.js +8 -8
  119. package/reload-tasks.mjs +2 -2
  120. package/reloads.d.mts +1 -1
  121. package/reloads.d.ts +1 -1
  122. package/reloads.js +7 -7
  123. package/reloads.mjs +2 -2
  124. package/roles.d.mts +1 -1
  125. package/roles.d.ts +1 -1
  126. package/roles.js +5 -5
  127. package/roles.mjs +2 -2
  128. package/spaces.d.mts +1 -1
  129. package/spaces.d.ts +1 -1
  130. package/spaces.js +15 -15
  131. package/spaces.mjs +2 -2
  132. package/temp-contents.d.mts +1 -1
  133. package/temp-contents.d.ts +1 -1
  134. package/temp-contents.js +6 -6
  135. package/temp-contents.mjs +2 -2
  136. package/tenants.d.mts +1 -1
  137. package/tenants.d.ts +1 -1
  138. package/tenants.js +9 -9
  139. package/tenants.mjs +2 -2
  140. package/themes.d.mts +1 -1
  141. package/themes.d.ts +1 -1
  142. package/themes.js +10 -10
  143. package/themes.mjs +2 -2
  144. package/transports.d.mts +1 -1
  145. package/transports.d.ts +1 -1
  146. package/transports.js +9 -9
  147. package/transports.mjs +2 -2
  148. package/users.d.mts +1 -1
  149. package/users.d.ts +1 -1
  150. package/users.js +13 -13
  151. package/users.mjs +2 -2
  152. package/web-integrations.d.mts +1 -1
  153. package/web-integrations.d.ts +1 -1
  154. package/web-integrations.js +8 -8
  155. package/web-integrations.mjs +2 -2
  156. package/web-notifications.d.mts +1 -1
  157. package/web-notifications.d.ts +1 -1
  158. package/web-notifications.js +9 -9
  159. package/web-notifications.mjs +2 -2
  160. package/webhooks.d.mts +1 -1
  161. package/webhooks.d.ts +1 -1
  162. package/webhooks.js +13 -13
  163. package/webhooks.mjs +2 -2
  164. package/auth-AWZV4DPP.js +0 -41
  165. package/invoke-fetch-UNTAUR7O.js +0 -17
package/docs/qix.md ADDED
@@ -0,0 +1,85 @@
1
+ # QIX
2
+
3
+ ◁ [Back to overview](../README.md)
4
+
5
+ The `@qlik/api/qix` module gives you a fully typed API to the QIX engine and to Qlik Sense Applications. This is built for ease of use and also comes with the same "Sense Mixins" that Qlik's in-house developers use for building the Qlik Sense Client application. This means that it is easier to get the different list objects from Qlik Sense Applications. Simply setup a host config and connect to an app.
6
+
7
+ ## Can this be used instead of `enigma.js`?
8
+
9
+ [enigma.js](https://github.com/qlik-oss/enigma.js) is a library that can be used to set up a websocket connection to a Qlik Sense Engine and get programmatic interfaces to Qlik Sense App's object models. The library provide events to data updates and has some handy features such as suspending and resuming sessions.
10
+
11
+ `@qlik/api` provides the same features, but with a lot simpler interface. It also comes with types for the QIX api including GenericObjects, HyperCubes etc etc. So in most cases `@qlik/api` can be used instead of `enigma.js`. Only when you have very specific configuration needs and don't want to use the "sense mixins" `enigma.js` can be used.
12
+
13
+ ## Features
14
+
15
+ ### Re-using sessions
16
+
17
+ `@qlik/api/qix` will re-use existing websocket sessions if they are found. It also integrates seamlessly with `@qlik/embed` libraries and will hook into any websocket session already opened by any `@qlik/embed` library.
18
+
19
+ ### Auto suspend/resume and re-connect
20
+
21
+ When a session gets a suspend event `@qlik/api` will automatically handle the suspend/resume logic and attempt to re-connect to the same engine session. Hopefully a user will never even notice that the websocket was closed for a little while.
22
+
23
+ ## Usage example
24
+
25
+ ```ts
26
+ import { openAppSession } from "@qlik/api/qix";
27
+ import { setDefaultHostConfig } from "@qlik/api/auth";
28
+
29
+ setDefaultHostConfig({ ... });
30
+
31
+ // sets up a websocket to engine
32
+ appSession = openAppSession({ appId: "<app-id>" });
33
+
34
+ // get the "qix document (qlik app)"
35
+ const app = await appSession.getDoc();
36
+
37
+ // app is now fully typed including sense-client mixins
38
+ const sheetlist = await app.getSheetList();
39
+
40
+ // sheetlist is now of the type SheetListItem[], that type is included in the package.
41
+ ```
42
+
43
+ React example of getting the sheet list from a Qlik Sense app.
44
+
45
+ ```tsx
46
+ import React from "react";
47
+ import usePromise from "react-use-promise";
48
+ import { useAppHook } from "@qlik/api/qix";
49
+ import { setDefaultHostConfig } from "@qlik/api/auth";
50
+
51
+ setDefaultHostConfig({ ... });
52
+
53
+ // send in the react instance (avoid unnecessary dependencies to react in @qlik/api)
54
+ const useApp = useAppHook(React);
55
+
56
+ type SheetListProps = {
57
+ appId: string;
58
+ };
59
+
60
+ const SheetList = ({ appId }: SheetListProps): JSX.Element | null => {
61
+ const app = useApp(appId);
62
+
63
+ // this could be nicely wrapped in your own local getSheetList hook
64
+ const [sheetList] = usePromise(async () => app && app.getSheetList(), [app]);
65
+ // getSheetList above is coming from mixins, fully typed
66
+
67
+ if (!sheetList) {
68
+ return <div>Loading</div>;
69
+ }
70
+ return (
71
+ <div>
72
+ <div>Sheets:</div>
73
+ {sheetList.map((item) => (
74
+ <div key={item.qInfo?.qId}>{item.qData.title}</div>
75
+ ))}
76
+ </div>
77
+ );
78
+ };
79
+
80
+ export default SheetList;
81
+ ```
82
+
83
+ More examples can be found in the [examples](examples.md) section.
84
+
85
+ ◁ [Back to overview](../README.md)
package/docs/rest.md ADDED
@@ -0,0 +1,64 @@
1
+ # REST
2
+
3
+ ◁ [Back to overview](../README.md)
4
+
5
+ Each rest entity is exposed as it's own javascript module. It contains all api calls and types exposed by the entity service. They can be imported from `@qlik/api` as a sub module of the package like `/spaces` in the example below. These modules both has named exports and a default export. Types are always named exports.
6
+
7
+ ```ts
8
+ import spaces, { type Spaces } from "@qlik/api/spaces";
9
+ await { data: mySpaces } = await spaces.getSpaces();
10
+
11
+ // mySpaces now has the type Spaces
12
+ ```
13
+
14
+ Each module can also be imported directly from `@qlik/api`.
15
+
16
+ ```ts
17
+ import { spaces, users } from "@qlik/api";
18
+ ```
19
+
20
+ These modules are the default exports from each respective sub module. The types from the sub modules are not exposed here since they would introduce name conflicts. The types need to be imported from the respective sub modules.
21
+
22
+ Info about these entities and their api's can be found [here](https://qlik.dev/apis/#rest).
23
+
24
+ ## HTTP Calls
25
+
26
+ The http calls uses the native fetch api. Each http call with a response status in the 200 range will resolve to an object with structure `{ status, headers, data }`. If status is in the >=300 range an error will be thrown.
27
+
28
+ ```ts
29
+ import { getSpaces } from "@qlik/api/spaces";
30
+
31
+ try {
32
+ const { status, headers, data: spaces } = await getSpaces();
33
+ // status < 300
34
+ if (spaces.data) {
35
+ // the spaces list is returned as "data"
36
+ // There are spaces
37
+ }
38
+ } catch (e) {
39
+ // status >= 300
40
+ // something went wrong
41
+ }
42
+ ```
43
+
44
+ ## Error handling
45
+
46
+ Every http response that has a status over 300 is considered to be an error and the promise is rejected. To handle this in typescript you can do the following:
47
+
48
+ ```ts
49
+ import { deleteExtension, type DeleteExtensionHttpError } from "@qlik/qmfe/extensions";
50
+
51
+ try {
52
+ const { status } = await deleteExtension("<extension-id>");
53
+ ...
54
+ } catch (e as DeleteExtensionHttpError) {
55
+ if (e.status === 404) {
56
+ // DeleteEndpoint404HttpError
57
+ e.data // < -- body of error
58
+ }
59
+ }
60
+ ```
61
+
62
+ ## Caching
63
+
64
+ Every GET request is cached so that subsequent calls to the same api will resolve immediately from the cache. Read more about caching [here](features.md#caching).
@@ -2,7 +2,7 @@
2
2
 
3
3
 
4
4
 
5
- var _chunkD52VW5UNjs = require('./chunk-D52VW5UN.js');
5
+ var _chunk2II4JNZOjs = require('./chunk-2II4JNZO.js');
6
6
  require('./chunk-P57PW2II.js');
7
7
 
8
8
  // src/qix/session/enigma-session.ts
@@ -10160,14 +10160,14 @@ async function createEnigmaSession({
10160
10160
  identity,
10161
10161
  hostConfig
10162
10162
  }) {
10163
- const locationUrl = _chunkD52VW5UNjs.toValidWebsocketLocationUrl.call(void 0, hostConfig);
10163
+ const locationUrl = _chunk2II4JNZOjs.toValidWebsocketLocationUrl.call(void 0, hostConfig);
10164
10164
  const reloadUri = encodeURIComponent(`${locationUrl}/sense/app/${appId}`);
10165
10165
  const identityPart = identity ? `/identity/${identity}` : "";
10166
10166
  let url = `${locationUrl}/app/${appId}${identityPart}?reloadUri=${reloadUri}`.replace(/^http/, "ws");
10167
10167
  const isNodeEnvironment = typeof window === "undefined";
10168
10168
  let createSocketMethod;
10169
10169
  if (isNodeEnvironment) {
10170
- const { headers, queryParams } = await _chunkD52VW5UNjs.getRestCallAuthParams.call(void 0, { hostConfig, method: "POST" });
10170
+ const { headers, queryParams } = await _chunk2II4JNZOjs.getRestCallAuthParams.call(void 0, { hostConfig, method: "POST" });
10171
10171
  const WS = (await Promise.resolve().then(() => _interopRequireWildcard(require("ws")))).default;
10172
10172
  Object.entries(queryParams).forEach(([key, value]) => {
10173
10173
  url = `${url}&${key}=${value}`;
@@ -10176,7 +10176,7 @@ async function createEnigmaSession({
10176
10176
  headers
10177
10177
  });
10178
10178
  } else {
10179
- const { queryParams } = await _chunkD52VW5UNjs.getWebSocketAuthParams.call(void 0, { hostConfig });
10179
+ const { queryParams } = await _chunk2II4JNZOjs.getWebSocketAuthParams.call(void 0, { hostConfig });
10180
10180
  Object.entries(queryParams).forEach(([key, value]) => {
10181
10181
  url = `${url}&${key}=${value}`;
10182
10182
  });
@@ -2,7 +2,7 @@ import {
2
2
  getRestCallAuthParams,
3
3
  getWebSocketAuthParams,
4
4
  toValidWebsocketLocationUrl
5
- } from "./chunk-CYRLVHU3.mjs";
5
+ } from "./chunk-QLS6D4AX.mjs";
6
6
  import "./chunk-ZFXKCRJC.mjs";
7
7
 
8
8
  // src/qix/session/enigma-session.ts
@@ -1,6 +1,6 @@
1
1
  import "./chunk-ZFXKCRJC.mjs";
2
2
 
3
- // node_modules/.pnpm/@qlik+runtime-module-loader@0.2.3/node_modules/@qlik/runtime-module-loader/dist/esm/index.js
3
+ // node_modules/.pnpm/@qlik+runtime-module-loader@0.2.4/node_modules/@qlik/runtime-module-loader/dist/esm/index.js
4
4
  window.__qlikMainPrivateResolvers = window.__qlikMainPrivateResolvers || {};
5
5
  window.__qlikMainPrivateResolvers.mainUrlPromise = window.__qlikMainPrivateResolvers.mainUrlPromise || new Promise((resolve) => {
6
6
  window.__qlikMainPrivateResolvers.resolveMainJsUrl = (value) => resolve(value);
@@ -1,6 +1,6 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }require('./chunk-P57PW2II.js');
2
2
 
3
- // node_modules/.pnpm/@qlik+runtime-module-loader@0.2.3/node_modules/@qlik/runtime-module-loader/dist/esm/index.js
3
+ // node_modules/.pnpm/@qlik+runtime-module-loader@0.2.4/node_modules/@qlik/runtime-module-loader/dist/esm/index.js
4
4
  window.__qlikMainPrivateResolvers = window.__qlikMainPrivateResolvers || {};
5
5
  window.__qlikMainPrivateResolvers.mainUrlPromise = window.__qlikMainPrivateResolvers.mainUrlPromise || new Promise((resolve) => {
6
6
  window.__qlikMainPrivateResolvers.resolveMainJsUrl = (value) => resolve(value);
package/extensions.d.mts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
1
+ import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
2
2
  import './auth-types-nnUcWhuU.mjs';
3
3
 
4
4
  type BundleMeta = {
package/extensions.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
1
+ import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
2
2
  import './auth-types-nnUcWhuU.js';
3
3
 
4
4
  type BundleMeta = {
package/extensions.js CHANGED
@@ -1,36 +1,36 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunkJNGURO23js = require('./chunk-JNGURO23.js');
5
- require('./chunk-2STFUQKQ.js');
4
+ var _chunkXJKF347Cjs = require('./chunk-XJKF347C.js');
5
+ require('./chunk-JZAPZIPR.js');
6
6
  require('./chunk-P57PW2II.js');
7
7
 
8
8
  // src/public/rest/extensions.ts
9
- var getExtensions = async (options) => _chunkJNGURO23js.invokeFetch.call(void 0, "extensions", {
9
+ var getExtensions = async (options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "extensions", {
10
10
  method: "get",
11
11
  pathTemplate: "/api/v1/extensions",
12
12
  options
13
13
  });
14
- var uploadExtension = async (body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "extensions", {
14
+ var uploadExtension = async (body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "extensions", {
15
15
  method: "post",
16
16
  pathTemplate: "/api/v1/extensions",
17
17
  body,
18
18
  contentType: "multipart/form-data",
19
19
  options
20
20
  });
21
- var deleteExtension = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "extensions", {
21
+ var deleteExtension = async (id, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "extensions", {
22
22
  method: "delete",
23
23
  pathTemplate: "/api/v1/extensions/{id}",
24
24
  pathVariables: { id },
25
25
  options
26
26
  });
27
- var getExtension = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "extensions", {
27
+ var getExtension = async (id, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "extensions", {
28
28
  method: "get",
29
29
  pathTemplate: "/api/v1/extensions/{id}",
30
30
  pathVariables: { id },
31
31
  options
32
32
  });
33
- var patchExtension = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "extensions", {
33
+ var patchExtension = async (id, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "extensions", {
34
34
  method: "patch",
35
35
  pathTemplate: "/api/v1/extensions/{id}",
36
36
  pathVariables: { id },
@@ -38,20 +38,20 @@ var patchExtension = async (id, body, options) => _chunkJNGURO23js.invokeFetch.c
38
38
  contentType: "multipart/form-data",
39
39
  options
40
40
  });
41
- var downloadExtension = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "extensions", {
41
+ var downloadExtension = async (id, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "extensions", {
42
42
  method: "get",
43
43
  pathTemplate: "/api/v1/extensions/{id}/file",
44
44
  pathVariables: { id },
45
45
  options
46
46
  });
47
- var downloadFileFromExtension = async (id, filepath, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "extensions", {
47
+ var downloadFileFromExtension = async (id, filepath, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "extensions", {
48
48
  method: "get",
49
49
  pathTemplate: "/api/v1/extensions/{id}/file/{filepath}",
50
50
  pathVariables: { id, filepath },
51
51
  options
52
52
  });
53
53
  function clearCache() {
54
- return _chunkJNGURO23js.clearApiCache.call(void 0, "extensions");
54
+ return _chunkXJKF347Cjs.clearApiCache.call(void 0, "extensions");
55
55
  }
56
56
  var extensionsExport = {
57
57
  getExtensions,
package/extensions.mjs CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-TE7XMBT5.mjs";
5
- import "./chunk-3SVRHJII.mjs";
4
+ } from "./chunk-PUBPF4EZ.mjs";
5
+ import "./chunk-GLWHVX4M.mjs";
6
6
  import "./chunk-ZFXKCRJC.mjs";
7
7
 
8
8
  // src/public/rest/extensions.ts
@@ -38,21 +38,30 @@ type ApiCallOptions = {
38
38
 
39
39
  /** ApiKey Auth Configuration for a HostConfig */
40
40
  type ApiKeyAuthConfig = {
41
+ /** api key created by a developer role on a tenant */
41
42
  apiKey: string;
42
43
  };
43
44
  /** Cookie Auth Configuration for a HostConfig */
44
45
  type CookieAuthConfig = {
46
+ /** Web Integration Id created by tenant admin */
45
47
  webIntegrationId?: string;
48
+ /** If set to false the `credentials` property will be set to same-origin */
46
49
  crossSiteCookies?: boolean;
47
50
  };
48
51
  /** WindowsCookie Auth Configuration for a HostConfig */
49
52
  type WindowsCookieAuthConfig = {
53
+ /** location of the login page, auth module will redirect to this page when an unauthenticated api call is made */
50
54
  loginUri?: string;
55
+ /** If set to false the `credentials` property will be set to same-origin */
51
56
  crossSiteCookies?: boolean;
52
57
  };
53
58
  /** OAuth2 Auth Configuration for a HostConfig */
54
59
  type Oauth2AuthConfig = {
60
+ /** client id of oauth client created by tenant admin */
55
61
  clientId: string;
62
+ /** client id of oauth client created by tenant admin */
63
+ clientSecret?: string;
64
+ /** location of where the client should be redirected after getting hold of the access token */
56
65
  redirectUri?: string;
57
66
  /** If set, store the access token in either local or session storage, otherwise not stored */
58
67
  accessTokenStorage?: "session" | "local";
@@ -38,21 +38,30 @@ type ApiCallOptions = {
38
38
 
39
39
  /** ApiKey Auth Configuration for a HostConfig */
40
40
  type ApiKeyAuthConfig = {
41
+ /** api key created by a developer role on a tenant */
41
42
  apiKey: string;
42
43
  };
43
44
  /** Cookie Auth Configuration for a HostConfig */
44
45
  type CookieAuthConfig = {
46
+ /** Web Integration Id created by tenant admin */
45
47
  webIntegrationId?: string;
48
+ /** If set to false the `credentials` property will be set to same-origin */
46
49
  crossSiteCookies?: boolean;
47
50
  };
48
51
  /** WindowsCookie Auth Configuration for a HostConfig */
49
52
  type WindowsCookieAuthConfig = {
53
+ /** location of the login page, auth module will redirect to this page when an unauthenticated api call is made */
50
54
  loginUri?: string;
55
+ /** If set to false the `credentials` property will be set to same-origin */
51
56
  crossSiteCookies?: boolean;
52
57
  };
53
58
  /** OAuth2 Auth Configuration for a HostConfig */
54
59
  type Oauth2AuthConfig = {
60
+ /** client id of oauth client created by tenant admin */
55
61
  clientId: string;
62
+ /** client id of oauth client created by tenant admin */
63
+ clientSecret?: string;
64
+ /** location of where the client should be redirected after getting hold of the access token */
56
65
  redirectUri?: string;
57
66
  /** If set, store the access token in either local or session storage, otherwise not stored */
58
67
  accessTokenStorage?: "session" | "local";
package/glossaries.d.mts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
1
+ import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
2
2
  import './auth-types-nnUcWhuU.mjs';
3
3
 
4
4
  type JSONPatch = {
package/glossaries.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
1
+ import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
2
2
  import './auth-types-nnUcWhuU.js';
3
3
 
4
4
  type JSONPatch = {
package/glossaries.js CHANGED
@@ -1,25 +1,25 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true});
2
2
 
3
3
 
4
- var _chunkJNGURO23js = require('./chunk-JNGURO23.js');
5
- require('./chunk-2STFUQKQ.js');
4
+ var _chunkXJKF347Cjs = require('./chunk-XJKF347C.js');
5
+ require('./chunk-JZAPZIPR.js');
6
6
  require('./chunk-P57PW2II.js');
7
7
 
8
8
  // src/public/rest/glossaries.ts
9
- var getGlossaries = async (query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
9
+ var getGlossaries = async (query, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
10
10
  method: "get",
11
11
  pathTemplate: "/api/v1/glossaries",
12
12
  query,
13
13
  options
14
14
  });
15
- var createGlossary = async (body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
15
+ var createGlossary = async (body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
16
16
  method: "post",
17
17
  pathTemplate: "/api/v1/glossaries",
18
18
  body,
19
19
  contentType: "application/json",
20
20
  options
21
21
  });
22
- var importGlossary = async (query, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
22
+ var importGlossary = async (query, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
23
23
  method: "post",
24
24
  pathTemplate: "/api/v1/glossaries/actions/import",
25
25
  query,
@@ -27,19 +27,19 @@ var importGlossary = async (query, body, options) => _chunkJNGURO23js.invokeFetc
27
27
  contentType: "application/json",
28
28
  options
29
29
  });
30
- var deleteGlossary = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
30
+ var deleteGlossary = async (id, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
31
31
  method: "delete",
32
32
  pathTemplate: "/api/v1/glossaries/{id}",
33
33
  pathVariables: { id },
34
34
  options
35
35
  });
36
- var getGlossary = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
36
+ var getGlossary = async (id, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
37
37
  method: "get",
38
38
  pathTemplate: "/api/v1/glossaries/{id}",
39
39
  pathVariables: { id },
40
40
  options
41
41
  });
42
- var patchGlossary = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
42
+ var patchGlossary = async (id, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
43
43
  method: "patch",
44
44
  pathTemplate: "/api/v1/glossaries/{id}",
45
45
  pathVariables: { id },
@@ -47,7 +47,7 @@ var patchGlossary = async (id, body, options) => _chunkJNGURO23js.invokeFetch.ca
47
47
  contentType: "application/json",
48
48
  options
49
49
  });
50
- var updateGlossary = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
50
+ var updateGlossary = async (id, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
51
51
  method: "put",
52
52
  pathTemplate: "/api/v1/glossaries/{id}",
53
53
  pathVariables: { id },
@@ -55,20 +55,20 @@ var updateGlossary = async (id, body, options) => _chunkJNGURO23js.invokeFetch.c
55
55
  contentType: "application/json",
56
56
  options
57
57
  });
58
- var exportGlossary = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
58
+ var exportGlossary = async (id, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
59
59
  method: "get",
60
60
  pathTemplate: "/api/v1/glossaries/{id}/actions/export",
61
61
  pathVariables: { id },
62
62
  options
63
63
  });
64
- var getGlossaryCategories = async (id, query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
64
+ var getGlossaryCategories = async (id, query, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
65
65
  method: "get",
66
66
  pathTemplate: "/api/v1/glossaries/{id}/categories",
67
67
  pathVariables: { id },
68
68
  query,
69
69
  options
70
70
  });
71
- var createGlossaryCategory = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
71
+ var createGlossaryCategory = async (id, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
72
72
  method: "post",
73
73
  pathTemplate: "/api/v1/glossaries/{id}/categories",
74
74
  pathVariables: { id },
@@ -76,19 +76,19 @@ var createGlossaryCategory = async (id, body, options) => _chunkJNGURO23js.invok
76
76
  contentType: "application/json",
77
77
  options
78
78
  });
79
- var deleteGlossaryCategory = async (id, categoryId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
79
+ var deleteGlossaryCategory = async (id, categoryId, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
80
80
  method: "delete",
81
81
  pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
82
82
  pathVariables: { id, categoryId },
83
83
  options
84
84
  });
85
- var getGlossaryCategory = async (id, categoryId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
85
+ var getGlossaryCategory = async (id, categoryId, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
86
86
  method: "get",
87
87
  pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
88
88
  pathVariables: { id, categoryId },
89
89
  options
90
90
  });
91
- var patchGlossaryCategory = async (id, categoryId, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
91
+ var patchGlossaryCategory = async (id, categoryId, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
92
92
  method: "patch",
93
93
  pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
94
94
  pathVariables: { id, categoryId },
@@ -96,7 +96,7 @@ var patchGlossaryCategory = async (id, categoryId, body, options) => _chunkJNGUR
96
96
  contentType: "application/json",
97
97
  options
98
98
  });
99
- var updateGlossaryCategory = async (id, categoryId, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
99
+ var updateGlossaryCategory = async (id, categoryId, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
100
100
  method: "put",
101
101
  pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
102
102
  pathVariables: { id, categoryId },
@@ -104,14 +104,14 @@ var updateGlossaryCategory = async (id, categoryId, body, options) => _chunkJNGU
104
104
  contentType: "application/json",
105
105
  options
106
106
  });
107
- var getGlossaryTerms = async (id, query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
107
+ var getGlossaryTerms = async (id, query, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
108
108
  method: "get",
109
109
  pathTemplate: "/api/v1/glossaries/{id}/terms",
110
110
  pathVariables: { id },
111
111
  query,
112
112
  options
113
113
  });
114
- var createGlossaryTerm = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
114
+ var createGlossaryTerm = async (id, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
115
115
  method: "post",
116
116
  pathTemplate: "/api/v1/glossaries/{id}/terms",
117
117
  pathVariables: { id },
@@ -119,19 +119,19 @@ var createGlossaryTerm = async (id, body, options) => _chunkJNGURO23js.invokeFet
119
119
  contentType: "application/json",
120
120
  options
121
121
  });
122
- var deleteGlossaryTerm = async (id, termId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
122
+ var deleteGlossaryTerm = async (id, termId, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
123
123
  method: "delete",
124
124
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
125
125
  pathVariables: { id, termId },
126
126
  options
127
127
  });
128
- var getGlossaryTerm = async (id, termId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
128
+ var getGlossaryTerm = async (id, termId, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
129
129
  method: "get",
130
130
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
131
131
  pathVariables: { id, termId },
132
132
  options
133
133
  });
134
- var patchGlossaryTerm = async (id, termId, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
134
+ var patchGlossaryTerm = async (id, termId, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
135
135
  method: "patch",
136
136
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
137
137
  pathVariables: { id, termId },
@@ -139,7 +139,7 @@ var patchGlossaryTerm = async (id, termId, body, options) => _chunkJNGURO23js.in
139
139
  contentType: "application/json",
140
140
  options
141
141
  });
142
- var updateGlossaryTerm = async (id, termId, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
142
+ var updateGlossaryTerm = async (id, termId, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
143
143
  method: "put",
144
144
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
145
145
  pathVariables: { id, termId },
@@ -147,21 +147,21 @@ var updateGlossaryTerm = async (id, termId, body, options) => _chunkJNGURO23js.i
147
147
  contentType: "application/json",
148
148
  options
149
149
  });
150
- var changeGlossaryTermStatus = async (id, termId, query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
150
+ var changeGlossaryTermStatus = async (id, termId, query, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
151
151
  method: "post",
152
152
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/actions/change-status",
153
153
  pathVariables: { id, termId },
154
154
  query,
155
155
  options
156
156
  });
157
- var getGlossaryTermLinks = async (id, termId, query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
157
+ var getGlossaryTermLinks = async (id, termId, query, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
158
158
  method: "get",
159
159
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/links",
160
160
  pathVariables: { id, termId },
161
161
  query,
162
162
  options
163
163
  });
164
- var createGlossaryTermLink = async (id, termId, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
164
+ var createGlossaryTermLink = async (id, termId, body, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
165
165
  method: "post",
166
166
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/links",
167
167
  pathVariables: { id, termId },
@@ -169,7 +169,7 @@ var createGlossaryTermLink = async (id, termId, body, options) => _chunkJNGURO23
169
169
  contentType: "application/json",
170
170
  options
171
171
  });
172
- var getGlossaryTermRevisions = async (id, termId, query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "glossaries", {
172
+ var getGlossaryTermRevisions = async (id, termId, query, options) => _chunkXJKF347Cjs.invokeFetch.call(void 0, "glossaries", {
173
173
  method: "get",
174
174
  pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/revisions",
175
175
  pathVariables: { id, termId },
@@ -177,7 +177,7 @@ var getGlossaryTermRevisions = async (id, termId, query, options) => _chunkJNGUR
177
177
  options
178
178
  });
179
179
  function clearCache() {
180
- return _chunkJNGURO23js.clearApiCache.call(void 0, "glossaries");
180
+ return _chunkXJKF347Cjs.clearApiCache.call(void 0, "glossaries");
181
181
  }
182
182
  var glossariesExport = {
183
183
  getGlossaries,
package/glossaries.mjs CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunk-TE7XMBT5.mjs";
5
- import "./chunk-3SVRHJII.mjs";
4
+ } from "./chunk-PUBPF4EZ.mjs";
5
+ import "./chunk-GLWHVX4M.mjs";
6
6
  import "./chunk-ZFXKCRJC.mjs";
7
7
 
8
8
  // src/public/rest/glossaries.ts
package/groups.d.mts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
1
+ import { A as ApiCallOptions } from './global.types-4jzAvW7R.mjs';
2
2
  import './auth-types-nnUcWhuU.mjs';
3
3
 
4
4
  type AssignedRoles = {
package/groups.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
1
+ import { A as ApiCallOptions } from './global.types-1rNhDH7j.js';
2
2
  import './auth-types-nnUcWhuU.js';
3
3
 
4
4
  type AssignedRoles = {