@qlik/api 1.23.0 → 1.24.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.
Files changed (84) hide show
  1. package/api-keys.d.ts +6 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +1 -1
  4. package/apps.js +2 -2
  5. package/audits.d.ts +4 -16
  6. package/audits.js +2 -2
  7. package/auth.js +2 -2
  8. package/automations.d.ts +2 -59
  9. package/automations.js +3 -19
  10. package/brands.d.ts +1 -1
  11. package/brands.js +2 -2
  12. package/chunks/{E5TLRYTH.js → 3DYV7KOJ.js} +2 -2
  13. package/chunks/{CUC5USM5.js → 6DEESTGF.js} +2 -2
  14. package/chunks/{3REGOC54.js → 6QRR5VUM.js} +2 -2
  15. package/chunks/7BDAXGID.js +116 -0
  16. package/chunks/{3W4PFUMC.js → BL5PJM4B.js} +1 -1
  17. package/chunks/{3KD5W26Z.js → CZC7KEJN.js} +3 -3
  18. package/chunks/{OCV75U5H.js → I5UOE4ZZ.js} +81 -77
  19. package/chunks/{UJV2QU2J.js → N3ZFICDU.js} +3 -3
  20. package/chunks/{VXEOAWM6.js → OIQ5ELGS.js} +1 -1
  21. package/chunks/{SMQGR3VM.js → UA6BE3VB.js} +2 -2
  22. package/chunks/{EUWNVVK5.js → VX3MQBE7.js} +1 -1
  23. package/collections.d.ts +1 -1
  24. package/collections.js +2 -2
  25. package/csp-origins.d.ts +1 -1
  26. package/csp-origins.js +2 -2
  27. package/data-assets.d.ts +1 -1
  28. package/data-assets.js +2 -2
  29. package/data-connections.d.ts +1 -1
  30. package/data-connections.js +2 -2
  31. package/data-credentials.d.ts +1 -1
  32. package/data-credentials.js +2 -2
  33. package/data-files.d.ts +1 -1
  34. package/data-files.js +2 -2
  35. package/docs/rest.md +47 -0
  36. package/extensions.d.ts +1 -1
  37. package/extensions.js +2 -2
  38. package/glossaries.d.ts +3 -4
  39. package/glossaries.js +2 -2
  40. package/groups.d.ts +1 -1
  41. package/groups.js +2 -2
  42. package/identity-providers.d.ts +1 -1
  43. package/identity-providers.js +2 -2
  44. package/index.d.ts +11 -4
  45. package/index.js +89 -79
  46. package/interceptors.d.ts +51 -0
  47. package/interceptors.js +17 -0
  48. package/{global.types-qsBNouXJ.d.ts → invoke-fetch-types-BLrpeZOL.d.ts} +81 -48
  49. package/items.d.ts +1 -1
  50. package/items.js +2 -2
  51. package/licenses.d.ts +3 -1
  52. package/licenses.js +2 -2
  53. package/package.json +2 -2
  54. package/qix.d.ts +2 -2
  55. package/qix.js +2 -2
  56. package/quotas.d.ts +1 -1
  57. package/quotas.js +2 -2
  58. package/reload-tasks.d.ts +1 -1
  59. package/reload-tasks.js +2 -2
  60. package/reloads.d.ts +1 -1
  61. package/reloads.js +2 -2
  62. package/reports.d.ts +5 -3
  63. package/reports.js +2 -2
  64. package/roles.d.ts +98 -4
  65. package/roles.js +28 -4
  66. package/spaces.d.ts +1 -1
  67. package/spaces.js +2 -2
  68. package/temp-contents.d.ts +5 -5
  69. package/temp-contents.js +2 -2
  70. package/tenants.d.ts +1 -1
  71. package/tenants.js +2 -2
  72. package/themes.d.ts +1 -1
  73. package/themes.js +2 -2
  74. package/transports.d.ts +1 -1
  75. package/transports.js +2 -2
  76. package/users.d.ts +3 -38
  77. package/users.js +2 -9
  78. package/web-integrations.d.ts +1 -1
  79. package/web-integrations.js +2 -2
  80. package/web-notifications.d.ts +1 -1
  81. package/web-notifications.js +2 -2
  82. package/webhooks.d.ts +1 -1
  83. package/webhooks.js +2 -2
  84. package/chunks/7RHSSS4W.js +0 -0
package/index.js CHANGED
@@ -1,15 +1,17 @@
1
1
  import {
2
2
  qix_default
3
- } from "./chunks/VXEOAWM6.js";
3
+ } from "./chunks/OIQ5ELGS.js";
4
4
  import {
5
5
  auth_default
6
- } from "./chunks/3W4PFUMC.js";
7
- import "./chunks/7RHSSS4W.js";
6
+ } from "./chunks/BL5PJM4B.js";
7
+ import {
8
+ interceptors_default
9
+ } from "./chunks/7BDAXGID.js";
8
10
  import {
9
11
  clearApiCache,
10
12
  invokeFetch
11
- } from "./chunks/SMQGR3VM.js";
12
- import "./chunks/3KD5W26Z.js";
13
+ } from "./chunks/UA6BE3VB.js";
14
+ import "./chunks/CZC7KEJN.js";
13
15
  import "./chunks/2ZQ3ZX7F.js";
14
16
 
15
17
  // src/runtime-api-generator/runtime-api-generator-common.ts
@@ -81,7 +83,6 @@ function createLazyApiProxy(api2, initFunc) {
81
83
  }
82
84
  function parseMiniApi(namespace, def) {
83
85
  const api2 = {
84
- interceptors: {},
85
86
  operations: {}
86
87
  };
87
88
  traverse(namespace, "", def, api2.operations);
@@ -133,7 +134,7 @@ function createClassicApiFn({
133
134
  hasBody,
134
135
  contentType,
135
136
  useInstead
136
- }, operationInterceptors, hostConfig, enableConsoleWarnings, invokeFetchFnGetter) {
137
+ }, hostConfig, interceptors2, enableConsoleWarnings, invokeFetchFnGetter) {
137
138
  return (...args) => {
138
139
  const pathVariables = {};
139
140
  argNames.forEach((argName, index) => {
@@ -175,7 +176,7 @@ function createClassicApiFn({
175
176
  ...contentType ? { contentType } : {},
176
177
  options: optionsIncludingDefaultHostConfig
177
178
  },
178
- operationInterceptors
179
+ interceptors2?.getInterceptors()
179
180
  );
180
181
  };
181
182
  }
@@ -185,13 +186,13 @@ var parsedMiniApis = {};
185
186
  function apiDefToApiPublic(namespace, def) {
186
187
  parsedMiniApis[namespace] = parsedMiniApis[namespace] || parseMiniApi(namespace, def);
187
188
  const parsedMiniApi = parsedMiniApis[namespace];
188
- return (hostConfig) => {
189
+ return (hostConfig, interceptors2) => {
189
190
  const lazyApi = {
190
191
  clearCache: () => clearApiCache(namespace)
191
192
  };
192
193
  const initFunc = () => {
193
194
  Object.entries(parsedMiniApi.operations).forEach(([operationName, operation]) => {
194
- lazyApi[operationName] = createClassicApiFn(operation, void 0, hostConfig, true, () => invokeFetch);
195
+ lazyApi[operationName] = createClassicApiFn(operation, hostConfig, interceptors2, true, () => invokeFetch);
195
196
  operation.oldOperationNames.forEach((oldOperationName) => {
196
197
  lazyApi[oldOperationName] = lazyApi[operationName];
197
198
  });
@@ -291,7 +292,6 @@ var automationsMiniModule = apiDefToApiPublic("automations", {
291
292
  v1: {
292
293
  automations: {
293
294
  "": ["getAutomations:GQ:", "createAutomation:PBJ:"],
294
- settings: ["getAutomationsSettings:G:", "updateAutomationsSettings:UBJ:"],
295
295
  usage: ["getAutomationsUsageMetrics:GQ:"],
296
296
  "{id}": {
297
297
  "": ["deleteAutomation:D:", "getAutomationWithQuery:GQ:", "getAutomation:G:", "updateAutomation:UBJ:"],
@@ -560,7 +560,11 @@ var reportsMiniModule = apiDefToApiPublic("reports", {
560
560
  api: { v1: { reports: { "": ["createReport:PBJ:"], "{id}": { status: ["getReportStatus:G:"] } } } }
561
561
  });
562
562
  var rolesMiniModule = apiDefToApiPublic("roles", {
563
- api: { v1: { roles: { "": ["getRoles:GQ:"], "{id}": ["getRole:G:"] } } }
563
+ api: {
564
+ v1: {
565
+ roles: { "": ["getRoles:GQ:", "createRole:PBJ:"], "{id}": ["deleteRole:D:", "getRole:G:", "patchRole:ABJ:"] }
566
+ }
567
+ }
564
568
  });
565
569
  var spacesMiniModule = apiDefToApiPublic("spaces", {
566
570
  api: {
@@ -639,7 +643,6 @@ var usersMiniModule = apiDefToApiPublic("users", {
639
643
  "": ["getUsers:GQ:", "createUser:PBJ:"],
640
644
  actions: { count: ["countUsers:GQ:"], filter: ["filterUsers:PQBJ:"], invite: ["inviteUsers:PBJ:"] },
641
645
  me: ["getMyUser:G:"],
642
- metadata: ["getUsersMetadata:G:"],
643
646
  "{userId}": ["deleteUser:D:", "getUser:GQ:", "patchUser:ABJ:"]
644
647
  }
645
648
  }
@@ -683,74 +686,79 @@ var webhooksMiniModule = apiDefToApiPublic("webhooks", {
683
686
  }
684
687
  }
685
688
  });
686
- var apiKeys = apiKeysMiniModule();
687
- var apps = appsMiniModule();
688
- var audits = auditsMiniModule();
689
+ var apiKeys = apiKeysMiniModule(void 0, interceptors_default);
690
+ var apps = appsMiniModule(void 0, interceptors_default);
691
+ var audits = auditsMiniModule(void 0, interceptors_default);
689
692
  var auth = auth_default;
690
- var automations = automationsMiniModule();
691
- var brands = brandsMiniModule();
692
- var collections = collectionsMiniModule();
693
- var cspOrigins = cspOriginsMiniModule();
694
- var dataAssets = dataAssetsMiniModule();
695
- var dataConnections = dataConnectionsMiniModule();
696
- var dataCredentials = dataCredentialsMiniModule();
697
- var dataFiles = dataFilesMiniModule();
698
- var extensions = extensionsMiniModule();
699
- var glossaries = glossariesMiniModule();
700
- var groups = groupsMiniModule();
701
- var identityProviders = identityProvidersMiniModule();
702
- var items = itemsMiniModule();
703
- var licenses = licensesMiniModule();
693
+ var automations = automationsMiniModule(void 0, interceptors_default);
694
+ var brands = brandsMiniModule(void 0, interceptors_default);
695
+ var collections = collectionsMiniModule(void 0, interceptors_default);
696
+ var cspOrigins = cspOriginsMiniModule(void 0, interceptors_default);
697
+ var dataAssets = dataAssetsMiniModule(void 0, interceptors_default);
698
+ var dataConnections = dataConnectionsMiniModule(void 0, interceptors_default);
699
+ var dataCredentials = dataCredentialsMiniModule(void 0, interceptors_default);
700
+ var dataFiles = dataFilesMiniModule(void 0, interceptors_default);
701
+ var extensions = extensionsMiniModule(void 0, interceptors_default);
702
+ var glossaries = glossariesMiniModule(void 0, interceptors_default);
703
+ var groups = groupsMiniModule(void 0, interceptors_default);
704
+ var identityProviders = identityProvidersMiniModule(void 0, interceptors_default);
705
+ var interceptors = interceptors_default;
706
+ var items = itemsMiniModule(void 0, interceptors_default);
707
+ var licenses = licensesMiniModule(void 0, interceptors_default);
704
708
  var qix = qix_default;
705
- var quotas = quotasMiniModule();
706
- var reloadTasks = reloadTasksMiniModule();
707
- var reloads = reloadsMiniModule();
708
- var reports = reportsMiniModule();
709
- var roles = rolesMiniModule();
710
- var spaces = spacesMiniModule();
711
- var tempContents = tempContentsMiniModule();
712
- var tenants = tenantsMiniModule();
713
- var themes = themesMiniModule();
714
- var transports = transportsMiniModule();
715
- var users = usersMiniModule();
716
- var webIntegrations = webIntegrationsMiniModule();
717
- var webNotifications = webNotificationsMiniModule();
718
- var webhooks = webhooksMiniModule();
719
- var createQlikApi = (props) => ({
720
- apiKeys: apiKeysMiniModule(props?.hostConfig),
721
- apps: appsMiniModule(props?.hostConfig),
722
- audits: auditsMiniModule(props?.hostConfig),
723
- auth: auth_default,
724
- automations: automationsMiniModule(props?.hostConfig),
725
- brands: brandsMiniModule(props?.hostConfig),
726
- collections: collectionsMiniModule(props?.hostConfig),
727
- cspOrigins: cspOriginsMiniModule(props?.hostConfig),
728
- dataAssets: dataAssetsMiniModule(props?.hostConfig),
729
- dataConnections: dataConnectionsMiniModule(props?.hostConfig),
730
- dataCredentials: dataCredentialsMiniModule(props?.hostConfig),
731
- dataFiles: dataFilesMiniModule(props?.hostConfig),
732
- extensions: extensionsMiniModule(props?.hostConfig),
733
- glossaries: glossariesMiniModule(props?.hostConfig),
734
- groups: groupsMiniModule(props?.hostConfig),
735
- identityProviders: identityProvidersMiniModule(props?.hostConfig),
736
- items: itemsMiniModule(props?.hostConfig),
737
- licenses: licensesMiniModule(props?.hostConfig),
738
- qix: qix_default.withHostConfig(props?.hostConfig),
739
- quotas: quotasMiniModule(props?.hostConfig),
740
- reloadTasks: reloadTasksMiniModule(props?.hostConfig),
741
- reloads: reloadsMiniModule(props?.hostConfig),
742
- reports: reportsMiniModule(props?.hostConfig),
743
- roles: rolesMiniModule(props?.hostConfig),
744
- spaces: spacesMiniModule(props?.hostConfig),
745
- tempContents: tempContentsMiniModule(props?.hostConfig),
746
- tenants: tenantsMiniModule(props?.hostConfig),
747
- themes: themesMiniModule(props?.hostConfig),
748
- transports: transportsMiniModule(props?.hostConfig),
749
- users: usersMiniModule(props?.hostConfig),
750
- webIntegrations: webIntegrationsMiniModule(props?.hostConfig),
751
- webNotifications: webNotificationsMiniModule(props?.hostConfig),
752
- webhooks: webhooksMiniModule(props?.hostConfig)
753
- });
709
+ var quotas = quotasMiniModule(void 0, interceptors_default);
710
+ var reloadTasks = reloadTasksMiniModule(void 0, interceptors_default);
711
+ var reloads = reloadsMiniModule(void 0, interceptors_default);
712
+ var reports = reportsMiniModule(void 0, interceptors_default);
713
+ var roles = rolesMiniModule(void 0, interceptors_default);
714
+ var spaces = spacesMiniModule(void 0, interceptors_default);
715
+ var tempContents = tempContentsMiniModule(void 0, interceptors_default);
716
+ var tenants = tenantsMiniModule(void 0, interceptors_default);
717
+ var themes = themesMiniModule(void 0, interceptors_default);
718
+ var transports = transportsMiniModule(void 0, interceptors_default);
719
+ var users = usersMiniModule(void 0, interceptors_default);
720
+ var webIntegrations = webIntegrationsMiniModule(void 0, interceptors_default);
721
+ var webNotifications = webNotificationsMiniModule(void 0, interceptors_default);
722
+ var webhooks = webhooksMiniModule(void 0, interceptors_default);
723
+ var createQlikApi = (props) => {
724
+ const scopedInterceptors = interceptors_default.createInterceptors();
725
+ return {
726
+ apiKeys: apiKeysMiniModule(props?.hostConfig, scopedInterceptors),
727
+ apps: appsMiniModule(props?.hostConfig, scopedInterceptors),
728
+ audits: auditsMiniModule(props?.hostConfig, scopedInterceptors),
729
+ auth: auth_default,
730
+ automations: automationsMiniModule(props?.hostConfig, scopedInterceptors),
731
+ brands: brandsMiniModule(props?.hostConfig, scopedInterceptors),
732
+ collections: collectionsMiniModule(props?.hostConfig, scopedInterceptors),
733
+ cspOrigins: cspOriginsMiniModule(props?.hostConfig, scopedInterceptors),
734
+ dataAssets: dataAssetsMiniModule(props?.hostConfig, scopedInterceptors),
735
+ dataConnections: dataConnectionsMiniModule(props?.hostConfig, scopedInterceptors),
736
+ dataCredentials: dataCredentialsMiniModule(props?.hostConfig, scopedInterceptors),
737
+ dataFiles: dataFilesMiniModule(props?.hostConfig, scopedInterceptors),
738
+ extensions: extensionsMiniModule(props?.hostConfig, scopedInterceptors),
739
+ glossaries: glossariesMiniModule(props?.hostConfig, scopedInterceptors),
740
+ groups: groupsMiniModule(props?.hostConfig, scopedInterceptors),
741
+ identityProviders: identityProvidersMiniModule(props?.hostConfig, scopedInterceptors),
742
+ interceptors: scopedInterceptors,
743
+ items: itemsMiniModule(props?.hostConfig, scopedInterceptors),
744
+ licenses: licensesMiniModule(props?.hostConfig, scopedInterceptors),
745
+ qix: qix_default.withHostConfig(props?.hostConfig),
746
+ quotas: quotasMiniModule(props?.hostConfig, scopedInterceptors),
747
+ reloadTasks: reloadTasksMiniModule(props?.hostConfig, scopedInterceptors),
748
+ reloads: reloadsMiniModule(props?.hostConfig, scopedInterceptors),
749
+ reports: reportsMiniModule(props?.hostConfig, scopedInterceptors),
750
+ roles: rolesMiniModule(props?.hostConfig, scopedInterceptors),
751
+ spaces: spacesMiniModule(props?.hostConfig, scopedInterceptors),
752
+ tempContents: tempContentsMiniModule(props?.hostConfig, scopedInterceptors),
753
+ tenants: tenantsMiniModule(props?.hostConfig, scopedInterceptors),
754
+ themes: themesMiniModule(props?.hostConfig, scopedInterceptors),
755
+ transports: transportsMiniModule(props?.hostConfig, scopedInterceptors),
756
+ users: usersMiniModule(props?.hostConfig, scopedInterceptors),
757
+ webIntegrations: webIntegrationsMiniModule(props?.hostConfig, scopedInterceptors),
758
+ webNotifications: webNotificationsMiniModule(props?.hostConfig, scopedInterceptors),
759
+ webhooks: webhooksMiniModule(props?.hostConfig, scopedInterceptors)
760
+ };
761
+ };
754
762
  var api = {
755
763
  apiKeys,
756
764
  apps,
@@ -768,6 +776,7 @@ var api = {
768
776
  glossaries,
769
777
  groups,
770
778
  identityProviders,
779
+ interceptors,
771
780
  items,
772
781
  licenses,
773
782
  qix,
@@ -807,6 +816,7 @@ export {
807
816
  glossaries,
808
817
  groups,
809
818
  identityProviders,
819
+ interceptors,
810
820
  items,
811
821
  licenses,
812
822
  qix,
@@ -0,0 +1,51 @@
1
+ import { I as InvokeFetchResponse, a as InvokeFetchProperties } from './invoke-fetch-types-BLrpeZOL.js';
2
+ import './auth-types-PkN9CAF_.js';
3
+
4
+ /**
5
+ * The RestInterceptor type is a function that can be used to intercept requests and responses
6
+ */
7
+ type RestInterceptor = <T extends InvokeFetchResponse>(request: InvokeFetchProperties, proceed: (props: InvokeFetchProperties) => Promise<T>, id?: string) => Promise<T>;
8
+ declare function createInterceptors(): InterceptorsAPI;
9
+ declare function addDefaultInterceptors(): void;
10
+ /**
11
+ * Adds an interceptor to the global interceptor stack
12
+ * Returns the newly added interceptor
13
+ * @param interceptor the interceptor to add
14
+ * @returns the newly added interceptor
15
+ */
16
+ declare function addInterceptor(interceptor: RestInterceptor): RestInterceptor;
17
+ /**
18
+ * Removes an interceptor from the global interceptor stack
19
+ * @param interceptor the interceptor remove
20
+ */
21
+ declare function removeInterceptor(interceptor: RestInterceptor): RestInterceptor | null;
22
+ /**
23
+ * Gets all registered interceptors
24
+ */
25
+ declare function getInterceptors(): RestInterceptor[];
26
+ interface InterceptorsAPI {
27
+ /**
28
+ * Adds an interceptor to the global interceptor stack
29
+ * Returns the newly added interceptor
30
+ * @param interceptor the interceptor to add
31
+ * @returns the newly added interceptor
32
+ */
33
+ addInterceptor: typeof addInterceptor;
34
+ /**
35
+ * Removes an interceptor from the global interceptor stack
36
+ * @param interceptor the interceptor remove
37
+ */
38
+ removeInterceptor: typeof removeInterceptor;
39
+ /**
40
+ * Gets all registered interceptors
41
+ */
42
+ getInterceptors: typeof getInterceptors;
43
+ }
44
+ /**
45
+ * The interceptors API
46
+ */
47
+ declare const interceptors: InterceptorsAPI & {
48
+ createInterceptors: typeof createInterceptors;
49
+ };
50
+
51
+ export { type InterceptorsAPI, type RestInterceptor, addDefaultInterceptors, addInterceptor, createInterceptors, interceptors as default, getInterceptors, removeInterceptor };
@@ -0,0 +1,17 @@
1
+ import {
2
+ addDefaultInterceptors,
3
+ addInterceptor,
4
+ createInterceptors,
5
+ getInterceptors,
6
+ interceptors_default,
7
+ removeInterceptor
8
+ } from "./chunks/7BDAXGID.js";
9
+ import "./chunks/2ZQ3ZX7F.js";
10
+ export {
11
+ addDefaultInterceptors,
12
+ addInterceptor,
13
+ createInterceptors,
14
+ interceptors_default as default,
15
+ getInterceptors,
16
+ removeInterceptor
17
+ };
@@ -1,52 +1,5 @@
1
1
  import { H as HostConfig } from './auth-types-PkN9CAF_.js';
2
2
 
3
- /** An entry in the cache for one specific cacheKey */
4
- type CacheEntry = {
5
- lastPulled: number;
6
- /** last time the cache was accessed and prevented an api call */
7
- lastHit: Date | null;
8
- /** number of times the cache has been hit by a client */
9
- hitCount: number;
10
- /** the url path of the cache hit. Useful to determine how many different qmfes are accessing the cache key */
11
- accessedPaths: Set<string>;
12
- value: Promise<unknown>;
13
- };
14
- /** Additional options for an api call done with invoke-fetch */
15
- type ApiCallOptions = {
16
- /** Additional headers to pass on to the request. */
17
- headers?: Record<string, string>;
18
- /** if set to true the call will not use a cached result */
19
- noCache?: boolean;
20
- /**
21
- * Only used cached results whose age in milliseconds are less than that or equal to `maxCacheAge`.
22
- */
23
- maxCacheAge?: number | undefined;
24
- /**
25
- * Only results cached on or after the `ifCachedSince` timestamp are used.
26
- */
27
- useCacheIfAfter?: Date;
28
- /**
29
- * Specify if another host than `globalThis.location` is to be used. Typically used in embedding and mashups
30
- */
31
- hostConfig?: HostConfig;
32
- /**
33
- * Set the amount of time to wait for a response.
34
- * If the timeout is exceeded the request is aborted.
35
- * If both timeoutMs and signal is present, timeoutMs will have no effect, as
36
- * there is already an abort-signal specified.
37
- */
38
- timeoutMs?: number;
39
- /**
40
- * An abort-signal lets you abort an ongoing fetch request. The abort-signal is created
41
- * by taking the .signal property of an AbortController.
42
- */
43
- signal?: AbortSignal;
44
- };
45
- type DownloadableBlob = Blob & {
46
- /** download the blob in a using the specified filename */
47
- download: (filename: string) => Promise<void>;
48
- };
49
-
50
3
  /** ApiKey Auth Configuration for a HostConfig */
51
4
  type ApiKeyAuthConfig = {
52
5
  /** api key created by a developer role on a tenant */
@@ -173,4 +126,84 @@ declare global {
173
126
  } | undefined;
174
127
  }
175
128
 
176
- export type { ApiCallOptions as A, DownloadableBlob as D };
129
+ /** The typical base return type of a fetch call */
130
+ type InvokeFetchResponse = {
131
+ status: number;
132
+ headers: Headers;
133
+ data: unknown;
134
+ prev?: () => Promise<InvokeFetchResponse>;
135
+ next?: () => Promise<InvokeFetchResponse>;
136
+ };
137
+ /** An entry in the cache for one specific cacheKey */
138
+ type CacheEntry = {
139
+ lastPulled: number;
140
+ /** last time the cache was accessed and prevented an api call */
141
+ lastHit: Date | null;
142
+ /** number of times the cache has been hit by a client */
143
+ hitCount: number;
144
+ /** the url path of the cache hit. Useful to determine how many different qmfes are accessing the cache key */
145
+ accessedPaths: Set<string>;
146
+ value: Promise<unknown>;
147
+ };
148
+ /** Additional options for an api call done with invoke-fetch */
149
+ type ApiCallOptions = {
150
+ /** Additional headers to pass on to the request. */
151
+ headers?: Record<string, string>;
152
+ /** if set to true the call will not use a cached result */
153
+ noCache?: boolean;
154
+ /**
155
+ * Only used cached results whose age in milliseconds are less than that or equal to `maxCacheAge`.
156
+ */
157
+ maxCacheAge?: number | undefined;
158
+ /**
159
+ * Only results cached on or after the `ifCachedSince` timestamp are used.
160
+ */
161
+ useCacheIfAfter?: Date;
162
+ /**
163
+ * Specify if another host than `globalThis.location` is to be used. Typically used in embedding and mashups
164
+ */
165
+ hostConfig?: HostConfig;
166
+ /**
167
+ * Set the amount of time to wait for a response.
168
+ * If the timeout is exceeded the request is aborted.
169
+ * If both timeoutMs and signal is present, timeoutMs will have no effect, as
170
+ * there is already an abort-signal specified.
171
+ */
172
+ timeoutMs?: number;
173
+ /**
174
+ * An abort-signal lets you abort an ongoing fetch request. The abort-signal is created
175
+ * by taking the .signal property of an AbortController.
176
+ */
177
+ signal?: AbortSignal;
178
+ /**
179
+ * Ensure that the request is kept alive even if the page that initiated it is unloaded
180
+ * before the request is completed.
181
+ */
182
+ keepalive?: boolean;
183
+ };
184
+ type InvokeFetchProperties = {
185
+ /** http method */
186
+ method: string;
187
+ /** data passed to api call */
188
+ body?: unknown;
189
+ /** additional api call options */
190
+ options?: ApiCallOptions;
191
+ /** override default RequestInit options */
192
+ requestInitOverrides?: RequestInit;
193
+ /** path to api endpoint, can be in a template format e.g. /api/v1/space/{spaceId} */
194
+ pathTemplate: string;
195
+ /** path variables to be used in the path template */
196
+ pathVariables?: Record<string, string>;
197
+ /** additional query to url */
198
+ query?: Record<string, unknown>;
199
+ /** specify what content-type to send, if omitted "application/json" is assumed */
200
+ contentType?: string;
201
+ /** override the default user-agent with this value. This will also override any browser's UA. */
202
+ userAgent?: string;
203
+ };
204
+ type DownloadableBlob = Blob & {
205
+ /** download the blob in a using the specified filename */
206
+ download: (filename: string) => Promise<void>;
207
+ };
208
+
209
+ export type { ApiCallOptions as A, DownloadableBlob as D, InvokeFetchResponse as I, InvokeFetchProperties as a };
package/items.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type CollectionTypes = "private" | "public" | "publicgoverned";
package/items.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/items.ts
package/licenses.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type AssignmentsActionsAddRequest = {
@@ -176,6 +176,8 @@ type LicenseOverview = {
176
176
  /** Parameter values */
177
177
  values?: unknown;
178
178
  }[];
179
+ /** the parent number of the license. can be shared by multiple license numbers */
180
+ parentLicenseNumber?: string;
179
181
  /** The product the license is valid for. */
180
182
  product: string;
181
183
  /** The secondary number of a definition. */
package/licenses.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/licenses.ts
package/package.json CHANGED
@@ -16,7 +16,7 @@
16
16
  "nanoid": "^5.0.7",
17
17
  "ws": "^8.18.0"
18
18
  },
19
- "packageManager": "pnpm@9.12.2",
19
+ "packageManager": "pnpm@9.12.3",
20
20
  "engines": {
21
21
  "node": ">=18"
22
22
  },
@@ -56,5 +56,5 @@
56
56
  "./qix": "./qix.js",
57
57
  "./auth": "./auth.js"
58
58
  },
59
- "version": "1.23.0"
59
+ "version": "1.24.0"
60
60
  }
package/qix.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { H as HostConfig } from './auth-types-PkN9CAF_.js';
2
- import './global.types-qsBNouXJ.js';
2
+ import './invoke-fetch-types-BLrpeZOL.js';
3
3
 
4
- declare const QIX_SCHEMA_VERSION = "12.2224.0";
4
+ declare const QIX_SCHEMA_VERSION = "12.2241.0";
5
5
  type AlfaNumString = {
6
6
  /**
7
7
  * Calculated value.
package/qix.js CHANGED
@@ -2,8 +2,8 @@ import {
2
2
  openAppSession,
3
3
  qix_default,
4
4
  withHostConfig
5
- } from "./chunks/VXEOAWM6.js";
6
- import "./chunks/3KD5W26Z.js";
5
+ } from "./chunks/OIQ5ELGS.js";
6
+ import "./chunks/CZC7KEJN.js";
7
7
  export {
8
8
  qix_default as default,
9
9
  openAppSession,
package/quotas.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
package/quotas.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/quotas.ts
package/reload-tasks.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type Error = {
package/reload-tasks.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/reload-tasks.ts
package/reloads.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type Error = {
package/reloads.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/reloads.ts
package/reports.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -367,13 +367,15 @@ type ReportRequest = {
367
367
  type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0" | "sense-pixel-perfect-template-1.0";
368
368
  };
369
369
  type ReportStatus = {
370
- /** Present when status is failed. */
370
+ /** @deprecated
371
+ * Present when status is failed. Deprecated. Use /reports/{id}/outputs instead. */
371
372
  reasons?: Reason[];
372
373
  /** Errors occured during report generation. */
373
374
  requestErrors?: ExportErrors;
374
375
  /** Count how many times the resolution of this report was attempted. */
375
376
  resolutionAttempts?: number;
376
- /** Present when the status is "done". */
377
+ /** @deprecated
378
+ * Present when the status is "done". Deprecated. Use /reports/{id}/outputs instead. */
377
379
  results?: Result[];
378
380
  /** Status of the requested report. */
379
381
  status: "queued" | "processing" | "done" | "failed" | "aborted" | "visiting" | "aborting";
package/reports.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/SMQGR3VM.js";
5
- import "./chunks/3KD5W26Z.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/reports.ts