@qlik/api 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +17 -0
- package/README.md +8 -0
- package/api-keys.d.mts +313 -0
- package/api-keys.d.ts +313 -0
- package/api-keys.js +76 -0
- package/api-keys.mjs +76 -0
- package/apps.d.mts +1921 -0
- package/apps.d.ts +1921 -0
- package/apps.js +331 -0
- package/apps.mjs +331 -0
- package/audits.d.mts +262 -0
- package/audits.d.ts +262 -0
- package/audits.js +63 -0
- package/audits.mjs +63 -0
- package/auth-CSVTXOZX.js +36 -0
- package/auth-TE272Q34.mjs +36 -0
- package/auth-types-nnUcWhuU.d.mts +98 -0
- package/auth-types-nnUcWhuU.d.ts +98 -0
- package/auth.d.mts +26 -0
- package/auth.d.ts +26 -0
- package/auth.js +13 -0
- package/auth.mjs +13 -0
- package/automations.d.mts +638 -0
- package/automations.d.ts +638 -0
- package/automations.js +166 -0
- package/automations.mjs +166 -0
- package/brands.d.mts +614 -0
- package/brands.d.ts +614 -0
- package/brands.js +118 -0
- package/brands.mjs +118 -0
- package/chunk-3YE7EI7I.mjs +17 -0
- package/chunk-4ES65KO3.js +57 -0
- package/chunk-4FLMND6T.js +25 -0
- package/chunk-4OMEH5SW.mjs +1337 -0
- package/chunk-CKPJE4IA.mjs +57 -0
- package/chunk-GUQBHY3H.mjs +25 -0
- package/chunk-OULT3V2U.js +17 -0
- package/chunk-WM7FQU2U.mjs +21 -0
- package/chunk-XASXL2NC.js +1337 -0
- package/chunk-ZT4C7KCQ.js +21 -0
- package/collections.d.mts +535 -0
- package/collections.d.ts +535 -0
- package/collections.js +100 -0
- package/collections.mjs +100 -0
- package/csp-origins.d.mts +258 -0
- package/csp-origins.d.ts +258 -0
- package/csp-origins.js +66 -0
- package/csp-origins.mjs +66 -0
- package/data-assets.d.mts +195 -0
- package/data-assets.d.ts +195 -0
- package/data-assets.js +61 -0
- package/data-assets.mjs +61 -0
- package/data-connections.d.mts +527 -0
- package/data-connections.d.ts +527 -0
- package/data-connections.js +96 -0
- package/data-connections.mjs +96 -0
- package/data-credentials.d.mts +188 -0
- package/data-credentials.d.ts +188 -0
- package/data-credentials.js +56 -0
- package/data-credentials.mjs +56 -0
- package/data-files.d.mts +471 -0
- package/data-files.d.ts +471 -0
- package/data-files.js +116 -0
- package/data-files.mjs +116 -0
- package/docs/examples.md +4 -0
- package/enigma-session-4L373ALV.mjs +10196 -0
- package/enigma-session-TEB53FAF.js +10196 -0
- package/esm-4X3DKK5D.js +63 -0
- package/esm-SOWVJKOQ.mjs +63 -0
- package/extensions.d.mts +257 -0
- package/extensions.d.ts +257 -0
- package/extensions.js +74 -0
- package/extensions.mjs +74 -0
- package/global.types-Eto4uYwy.d.mts +102 -0
- package/global.types-hIvp-WdX.d.ts +102 -0
- package/glossaries.d.mts +1041 -0
- package/glossaries.d.ts +1041 -0
- package/glossaries.js +225 -0
- package/glossaries.mjs +225 -0
- package/groups.d.mts +379 -0
- package/groups.d.ts +379 -0
- package/groups.js +83 -0
- package/groups.mjs +83 -0
- package/identity-providers.d.mts +492 -0
- package/identity-providers.d.ts +492 -0
- package/identity-providers.js +80 -0
- package/identity-providers.mjs +80 -0
- package/index.d.mts +142 -0
- package/index.d.ts +142 -0
- package/index.js +678 -0
- package/index.mjs +678 -0
- package/invoke-fetch-MSSJAZ7K.mjs +14 -0
- package/invoke-fetch-PEI54KZO.js +14 -0
- package/items.d.mts +501 -0
- package/items.d.ts +501 -0
- package/items.js +84 -0
- package/items.mjs +84 -0
- package/licenses.d.mts +436 -0
- package/licenses.d.ts +436 -0
- package/licenses.js +87 -0
- package/licenses.mjs +87 -0
- package/package.json +264 -0
- package/qix-EU7PXRZ6.mjs +573 -0
- package/qix-RLTISYTB.js +573 -0
- package/qix.d.mts +11543 -0
- package/qix.d.ts +11543 -0
- package/qix.js +9 -0
- package/qix.mjs +9 -0
- package/quotas.d.mts +105 -0
- package/quotas.d.ts +105 -0
- package/quotas.js +31 -0
- package/quotas.mjs +31 -0
- package/reload-tasks.d.mts +222 -0
- package/reload-tasks.d.ts +222 -0
- package/reload-tasks.js +59 -0
- package/reload-tasks.mjs +59 -0
- package/reloads.d.mts +189 -0
- package/reloads.d.ts +189 -0
- package/reloads.js +44 -0
- package/reloads.mjs +44 -0
- package/roles.d.mts +150 -0
- package/roles.d.ts +150 -0
- package/roles.js +30 -0
- package/roles.mjs +30 -0
- package/spaces.d.mts +524 -0
- package/spaces.d.ts +524 -0
- package/spaces.js +118 -0
- package/spaces.mjs +118 -0
- package/temp-contents.d.mts +222 -0
- package/temp-contents.d.ts +222 -0
- package/temp-contents.js +60 -0
- package/temp-contents.mjs +60 -0
- package/tenants.d.mts +276 -0
- package/tenants.d.ts +276 -0
- package/tenants.js +68 -0
- package/tenants.mjs +68 -0
- package/themes.d.mts +235 -0
- package/themes.d.ts +235 -0
- package/themes.js +74 -0
- package/themes.mjs +74 -0
- package/transports.d.mts +298 -0
- package/transports.d.ts +298 -0
- package/transports.js +62 -0
- package/transports.mjs +62 -0
- package/users.d.mts +544 -0
- package/users.d.ts +544 -0
- package/users.js +99 -0
- package/users.mjs +99 -0
- package/web-integrations.d.mts +246 -0
- package/web-integrations.d.ts +246 -0
- package/web-integrations.js +59 -0
- package/web-integrations.mjs +59 -0
- package/web-notifications.d.mts +220 -0
- package/web-notifications.d.ts +220 -0
- package/web-notifications.js +66 -0
- package/web-notifications.mjs +66 -0
- package/webhooks.d.mts +422 -0
- package/webhooks.d.ts +422 -0
- package/webhooks.js +100 -0
- package/webhooks.mjs +100 -0
package/esm-4X3DKK5D.js
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
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; }// node_modules/.pnpm/@qlik+runtime-module-loader@0.1.15/node_modules/@qlik/runtime-module-loader/dist/esm/index.js
|
|
2
|
+
var resolveMainJsUrl;
|
|
3
|
+
var mainUrlPromise = new Promise((resolve) => {
|
|
4
|
+
resolveMainJsUrl = (value) => resolve(value);
|
|
5
|
+
});
|
|
6
|
+
window.qlikMainPromise = window.qlikMainPromise || (async () => {
|
|
7
|
+
if (window.QlikMain) {
|
|
8
|
+
return window.QlikMain;
|
|
9
|
+
}
|
|
10
|
+
const url = await mainUrlPromise;
|
|
11
|
+
return new Promise((resolve, reject) => {
|
|
12
|
+
if (window.QlikMain) {
|
|
13
|
+
resolve(window.QlikMain);
|
|
14
|
+
}
|
|
15
|
+
const script = window.document.createElement("script");
|
|
16
|
+
script.src = url;
|
|
17
|
+
script.addEventListener("error", (err) => {
|
|
18
|
+
reject(err);
|
|
19
|
+
});
|
|
20
|
+
script.addEventListener("load", () => {
|
|
21
|
+
resolve(window.QlikMain);
|
|
22
|
+
});
|
|
23
|
+
window.document.head.appendChild(script);
|
|
24
|
+
});
|
|
25
|
+
})();
|
|
26
|
+
function provideHostConfigForMainJsUrl(hostConfig) {
|
|
27
|
+
const trailingSlashes = /\/+$/;
|
|
28
|
+
function toMainJsUrl(hc) {
|
|
29
|
+
const url = _optionalChain([hc, 'optionalAccess', _ => _.embedRuntimeUrl]) || _optionalChain([hc, 'optionalAccess', _2 => _2.url]) || _optionalChain([hc, 'optionalAccess', _3 => _3.host]);
|
|
30
|
+
if (!url) {
|
|
31
|
+
return void 0;
|
|
32
|
+
}
|
|
33
|
+
let locationUrl;
|
|
34
|
+
if (url.toLowerCase().startsWith("https://") || url.toLowerCase().startsWith("http://")) {
|
|
35
|
+
locationUrl = url;
|
|
36
|
+
} else {
|
|
37
|
+
locationUrl = `https://${url}`;
|
|
38
|
+
}
|
|
39
|
+
locationUrl = locationUrl.replace(trailingSlashes, "");
|
|
40
|
+
return `${locationUrl}/main.js`;
|
|
41
|
+
}
|
|
42
|
+
const potentialMainJsUrl = toMainJsUrl(hostConfig);
|
|
43
|
+
if (potentialMainJsUrl) {
|
|
44
|
+
resolveMainJsUrl(potentialMainJsUrl);
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
async function importRuntimeModule(name, hostConfig) {
|
|
48
|
+
if (_optionalChain([hostConfig, 'optionalAccess', _4 => _4.runtimeModuleMocks, 'optionalAccess', _5 => _5[name]])) {
|
|
49
|
+
return _optionalChain([hostConfig, 'optionalAccess', _6 => _6.runtimeModuleMocks, 'optionalAccess', _7 => _7[name]]);
|
|
50
|
+
}
|
|
51
|
+
provideHostConfigForMainJsUrl(hostConfig);
|
|
52
|
+
return importFromCdn(name);
|
|
53
|
+
}
|
|
54
|
+
async function importUnsupportedAndUnstableRuntimeModule(name) {
|
|
55
|
+
return importFromCdn(name);
|
|
56
|
+
}
|
|
57
|
+
async function importFromCdn(name) {
|
|
58
|
+
return (await window.qlikMainPromise).import(name);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
exports.importRuntimeModule = importRuntimeModule; exports.importUnsupportedAndUnstableRuntimeModule = importUnsupportedAndUnstableRuntimeModule;
|
package/esm-SOWVJKOQ.mjs
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
// node_modules/.pnpm/@qlik+runtime-module-loader@0.1.15/node_modules/@qlik/runtime-module-loader/dist/esm/index.js
|
|
2
|
+
var resolveMainJsUrl;
|
|
3
|
+
var mainUrlPromise = new Promise((resolve) => {
|
|
4
|
+
resolveMainJsUrl = (value) => resolve(value);
|
|
5
|
+
});
|
|
6
|
+
window.qlikMainPromise = window.qlikMainPromise || (async () => {
|
|
7
|
+
if (window.QlikMain) {
|
|
8
|
+
return window.QlikMain;
|
|
9
|
+
}
|
|
10
|
+
const url = await mainUrlPromise;
|
|
11
|
+
return new Promise((resolve, reject) => {
|
|
12
|
+
if (window.QlikMain) {
|
|
13
|
+
resolve(window.QlikMain);
|
|
14
|
+
}
|
|
15
|
+
const script = window.document.createElement("script");
|
|
16
|
+
script.src = url;
|
|
17
|
+
script.addEventListener("error", (err) => {
|
|
18
|
+
reject(err);
|
|
19
|
+
});
|
|
20
|
+
script.addEventListener("load", () => {
|
|
21
|
+
resolve(window.QlikMain);
|
|
22
|
+
});
|
|
23
|
+
window.document.head.appendChild(script);
|
|
24
|
+
});
|
|
25
|
+
})();
|
|
26
|
+
function provideHostConfigForMainJsUrl(hostConfig) {
|
|
27
|
+
const trailingSlashes = /\/+$/;
|
|
28
|
+
function toMainJsUrl(hc) {
|
|
29
|
+
const url = hc?.embedRuntimeUrl || hc?.url || hc?.host;
|
|
30
|
+
if (!url) {
|
|
31
|
+
return void 0;
|
|
32
|
+
}
|
|
33
|
+
let locationUrl;
|
|
34
|
+
if (url.toLowerCase().startsWith("https://") || url.toLowerCase().startsWith("http://")) {
|
|
35
|
+
locationUrl = url;
|
|
36
|
+
} else {
|
|
37
|
+
locationUrl = `https://${url}`;
|
|
38
|
+
}
|
|
39
|
+
locationUrl = locationUrl.replace(trailingSlashes, "");
|
|
40
|
+
return `${locationUrl}/main.js`;
|
|
41
|
+
}
|
|
42
|
+
const potentialMainJsUrl = toMainJsUrl(hostConfig);
|
|
43
|
+
if (potentialMainJsUrl) {
|
|
44
|
+
resolveMainJsUrl(potentialMainJsUrl);
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
async function importRuntimeModule(name, hostConfig) {
|
|
48
|
+
if (hostConfig?.runtimeModuleMocks?.[name]) {
|
|
49
|
+
return hostConfig?.runtimeModuleMocks?.[name];
|
|
50
|
+
}
|
|
51
|
+
provideHostConfigForMainJsUrl(hostConfig);
|
|
52
|
+
return importFromCdn(name);
|
|
53
|
+
}
|
|
54
|
+
async function importUnsupportedAndUnstableRuntimeModule(name) {
|
|
55
|
+
return importFromCdn(name);
|
|
56
|
+
}
|
|
57
|
+
async function importFromCdn(name) {
|
|
58
|
+
return (await window.qlikMainPromise).import(name);
|
|
59
|
+
}
|
|
60
|
+
export {
|
|
61
|
+
importRuntimeModule,
|
|
62
|
+
importUnsupportedAndUnstableRuntimeModule
|
|
63
|
+
};
|
package/extensions.d.mts
ADDED
|
@@ -0,0 +1,257 @@
|
|
|
1
|
+
import { A as ApiCallOptions } from './global.types-Eto4uYwy.mjs';
|
|
2
|
+
import './auth-types-nnUcWhuU.mjs';
|
|
3
|
+
|
|
4
|
+
type BundleMeta = {
|
|
5
|
+
/** Description of the bundle. */
|
|
6
|
+
description?: string;
|
|
7
|
+
/** Unique identifier of the bundle. */
|
|
8
|
+
id?: string;
|
|
9
|
+
/** Name of the bundle. */
|
|
10
|
+
name?: string;
|
|
11
|
+
};
|
|
12
|
+
type Error = {
|
|
13
|
+
/** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
|
|
14
|
+
meta?: Meta;
|
|
15
|
+
/** Optional JSON patch object pointing to an invalid property. */
|
|
16
|
+
source?: unknown;
|
|
17
|
+
/** The HTTP status code. */
|
|
18
|
+
status?: number;
|
|
19
|
+
/** Title of the HTTP status code. */
|
|
20
|
+
title: string;
|
|
21
|
+
};
|
|
22
|
+
type Extension = {
|
|
23
|
+
/** Author of the extension. */
|
|
24
|
+
author?: string;
|
|
25
|
+
/** Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined. */
|
|
26
|
+
bundle?: BundleMeta;
|
|
27
|
+
/** If the extension is part of an extension bundle. */
|
|
28
|
+
bundled?: boolean;
|
|
29
|
+
/** Checksum of the extension contents. */
|
|
30
|
+
checksum?: string;
|
|
31
|
+
readonly createdAt?: string;
|
|
32
|
+
/** Map of dependencies describing version of the component it requires. */
|
|
33
|
+
dependencies?: unknown;
|
|
34
|
+
/** A date noting when the extension was deprecated. */
|
|
35
|
+
deprecated?: string;
|
|
36
|
+
/** Description of the extension. */
|
|
37
|
+
description?: string;
|
|
38
|
+
/** The file that was uploaded with the extension. */
|
|
39
|
+
file?: unknown;
|
|
40
|
+
/** Home page of the extension. */
|
|
41
|
+
homepage?: string;
|
|
42
|
+
/** Icon to show in the client. */
|
|
43
|
+
icon?: string;
|
|
44
|
+
readonly id?: string;
|
|
45
|
+
/** Keywords for the extension. */
|
|
46
|
+
keywords?: string;
|
|
47
|
+
/** Under which license this extension is published. */
|
|
48
|
+
license?: string;
|
|
49
|
+
/** Relative path to the extension's entry file, defaults to `filename` from the qext file. */
|
|
50
|
+
loadpath?: string;
|
|
51
|
+
/** The display name of this extension. */
|
|
52
|
+
name?: string;
|
|
53
|
+
/** Path to an image that enables users to preview the extension. */
|
|
54
|
+
preview?: string;
|
|
55
|
+
/** The name of the qext file that was uploaded with this extension. */
|
|
56
|
+
qextFilename?: string;
|
|
57
|
+
/** The version from the qext file that was uploaded with this extension. */
|
|
58
|
+
qextVersion?: string;
|
|
59
|
+
/** Link to the extension source code. */
|
|
60
|
+
repository?: string;
|
|
61
|
+
/** If the extension is a supernova extension or not. */
|
|
62
|
+
supernova?: boolean;
|
|
63
|
+
/** Supplier of the extension. */
|
|
64
|
+
supplier?: string;
|
|
65
|
+
/** List of tags. */
|
|
66
|
+
tags?: string[];
|
|
67
|
+
readonly tenantId?: string;
|
|
68
|
+
/** The type of this extension (visualization, etc.). */
|
|
69
|
+
type?: string;
|
|
70
|
+
readonly updateAt?: string;
|
|
71
|
+
readonly userId?: string;
|
|
72
|
+
/** Version of the extension. */
|
|
73
|
+
version?: string;
|
|
74
|
+
};
|
|
75
|
+
type Extensions = {
|
|
76
|
+
data: Extension[];
|
|
77
|
+
};
|
|
78
|
+
type Meta = {
|
|
79
|
+
/** A more detailed message explaining the error. */
|
|
80
|
+
message?: string;
|
|
81
|
+
/** Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created. */
|
|
82
|
+
resourceName?: string;
|
|
83
|
+
/** Full stack trace of the error that was raised. */
|
|
84
|
+
stack?: string;
|
|
85
|
+
};
|
|
86
|
+
/**
|
|
87
|
+
* Lists all extensions.
|
|
88
|
+
* @throws GetExtensionsHttpError
|
|
89
|
+
*/
|
|
90
|
+
declare const getExtensions: (options?: ApiCallOptions) => Promise<GetExtensionsHttpResponse>;
|
|
91
|
+
type GetExtensionsHttpResponse = {
|
|
92
|
+
data: Extensions;
|
|
93
|
+
headers: Headers;
|
|
94
|
+
status: number;
|
|
95
|
+
};
|
|
96
|
+
type GetExtensionsHttpError = {
|
|
97
|
+
data: unknown;
|
|
98
|
+
headers: Headers;
|
|
99
|
+
status: number;
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* Creates a new extension. If a file is provided, the data field is not required.
|
|
103
|
+
* @param body an object with the body content
|
|
104
|
+
* @throws UploadExtensionHttpError
|
|
105
|
+
*/
|
|
106
|
+
declare const uploadExtension: (body: unknown, options?: ApiCallOptions) => Promise<UploadExtensionHttpResponse>;
|
|
107
|
+
type UploadExtensionHttpResponse = {
|
|
108
|
+
data: Extension;
|
|
109
|
+
headers: Headers;
|
|
110
|
+
status: number;
|
|
111
|
+
};
|
|
112
|
+
type UploadExtensionHttpError = {
|
|
113
|
+
data: Error;
|
|
114
|
+
headers: Headers;
|
|
115
|
+
status: number;
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* Deletes a specific extension.
|
|
119
|
+
* @param id Extension identifier or its qextFilename.
|
|
120
|
+
* @throws DeleteExtensionHttpError
|
|
121
|
+
*/
|
|
122
|
+
declare const deleteExtension: (id: string, options?: ApiCallOptions) => Promise<DeleteExtensionHttpResponse>;
|
|
123
|
+
type DeleteExtensionHttpResponse = {
|
|
124
|
+
data: void;
|
|
125
|
+
headers: Headers;
|
|
126
|
+
status: number;
|
|
127
|
+
};
|
|
128
|
+
type DeleteExtensionHttpError = {
|
|
129
|
+
data: Error;
|
|
130
|
+
headers: Headers;
|
|
131
|
+
status: number;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* Returns a specific extension.
|
|
135
|
+
* @param id Extension identifier or its qextFilename.
|
|
136
|
+
* @throws GetExtensionHttpError
|
|
137
|
+
*/
|
|
138
|
+
declare const getExtension: (id: string, options?: ApiCallOptions) => Promise<GetExtensionHttpResponse>;
|
|
139
|
+
type GetExtensionHttpResponse = {
|
|
140
|
+
data: Extension;
|
|
141
|
+
headers: Headers;
|
|
142
|
+
status: number;
|
|
143
|
+
};
|
|
144
|
+
type GetExtensionHttpError = {
|
|
145
|
+
data: Error;
|
|
146
|
+
headers: Headers;
|
|
147
|
+
status: number;
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* Updates a specific extension with provided data. If a file is provided, the data field is not required.
|
|
151
|
+
* @param id Extension identifier or its qextFilename.
|
|
152
|
+
* @param body an object with the body content
|
|
153
|
+
* @throws PatchExtensionHttpError
|
|
154
|
+
*/
|
|
155
|
+
declare const patchExtension: (id: string, body: unknown, options?: ApiCallOptions) => Promise<PatchExtensionHttpResponse>;
|
|
156
|
+
type PatchExtensionHttpResponse = {
|
|
157
|
+
data: Extension;
|
|
158
|
+
headers: Headers;
|
|
159
|
+
status: number;
|
|
160
|
+
};
|
|
161
|
+
type PatchExtensionHttpError = {
|
|
162
|
+
data: Error;
|
|
163
|
+
headers: Headers;
|
|
164
|
+
status: number;
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Downloads the extension as an archive.
|
|
168
|
+
* @param id Extension identifier or its qextFilename.
|
|
169
|
+
* @throws DownloadExtensionHttpError
|
|
170
|
+
*/
|
|
171
|
+
declare const downloadExtension: (id: string, options?: ApiCallOptions) => Promise<DownloadExtensionHttpResponse>;
|
|
172
|
+
type DownloadExtensionHttpResponse = {
|
|
173
|
+
data: void;
|
|
174
|
+
headers: Headers;
|
|
175
|
+
status: number;
|
|
176
|
+
};
|
|
177
|
+
type DownloadExtensionHttpError = {
|
|
178
|
+
data: Error;
|
|
179
|
+
headers: Headers;
|
|
180
|
+
status: number;
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* Downloads a file from the extension archive.
|
|
184
|
+
* @param id Extension identifier or its qextFilename.
|
|
185
|
+
* @param filepath Path to the file archive for the specified extension archive. Folders separated with forward slashes.
|
|
186
|
+
* @throws DownloadFileFromExtensionHttpError
|
|
187
|
+
*/
|
|
188
|
+
declare const downloadFileFromExtension: (id: string, filepath: string, options?: ApiCallOptions) => Promise<DownloadFileFromExtensionHttpResponse>;
|
|
189
|
+
type DownloadFileFromExtensionHttpResponse = {
|
|
190
|
+
data: void;
|
|
191
|
+
headers: Headers;
|
|
192
|
+
status: number;
|
|
193
|
+
};
|
|
194
|
+
type DownloadFileFromExtensionHttpError = {
|
|
195
|
+
data: Error;
|
|
196
|
+
headers: Headers;
|
|
197
|
+
status: number;
|
|
198
|
+
};
|
|
199
|
+
/**
|
|
200
|
+
* Clears the cache for extensions api requests.
|
|
201
|
+
*/
|
|
202
|
+
declare function clearCache(): void;
|
|
203
|
+
interface ExtensionsAPI {
|
|
204
|
+
/**
|
|
205
|
+
* Lists all extensions.
|
|
206
|
+
* @throws GetExtensionsHttpError
|
|
207
|
+
*/
|
|
208
|
+
getExtensions: typeof getExtensions;
|
|
209
|
+
/**
|
|
210
|
+
* Creates a new extension. If a file is provided, the data field is not required.
|
|
211
|
+
* @param body an object with the body content
|
|
212
|
+
* @throws UploadExtensionHttpError
|
|
213
|
+
*/
|
|
214
|
+
uploadExtension: typeof uploadExtension;
|
|
215
|
+
/**
|
|
216
|
+
* Deletes a specific extension.
|
|
217
|
+
* @param id Extension identifier or its qextFilename.
|
|
218
|
+
* @throws DeleteExtensionHttpError
|
|
219
|
+
*/
|
|
220
|
+
deleteExtension: typeof deleteExtension;
|
|
221
|
+
/**
|
|
222
|
+
* Returns a specific extension.
|
|
223
|
+
* @param id Extension identifier or its qextFilename.
|
|
224
|
+
* @throws GetExtensionHttpError
|
|
225
|
+
*/
|
|
226
|
+
getExtension: typeof getExtension;
|
|
227
|
+
/**
|
|
228
|
+
* Updates a specific extension with provided data. If a file is provided, the data field is not required.
|
|
229
|
+
* @param id Extension identifier or its qextFilename.
|
|
230
|
+
* @param body an object with the body content
|
|
231
|
+
* @throws PatchExtensionHttpError
|
|
232
|
+
*/
|
|
233
|
+
patchExtension: typeof patchExtension;
|
|
234
|
+
/**
|
|
235
|
+
* Downloads the extension as an archive.
|
|
236
|
+
* @param id Extension identifier or its qextFilename.
|
|
237
|
+
* @throws DownloadExtensionHttpError
|
|
238
|
+
*/
|
|
239
|
+
downloadExtension: typeof downloadExtension;
|
|
240
|
+
/**
|
|
241
|
+
* Downloads a file from the extension archive.
|
|
242
|
+
* @param id Extension identifier or its qextFilename.
|
|
243
|
+
* @param filepath Path to the file archive for the specified extension archive. Folders separated with forward slashes.
|
|
244
|
+
* @throws DownloadFileFromExtensionHttpError
|
|
245
|
+
*/
|
|
246
|
+
downloadFileFromExtension: typeof downloadFileFromExtension;
|
|
247
|
+
/**
|
|
248
|
+
* Clears the cache for extensions api requests.
|
|
249
|
+
*/
|
|
250
|
+
clearCache: typeof clearCache;
|
|
251
|
+
}
|
|
252
|
+
/**
|
|
253
|
+
* Functions for the extensions api
|
|
254
|
+
*/
|
|
255
|
+
declare const extensionsExport: ExtensionsAPI;
|
|
256
|
+
|
|
257
|
+
export { type BundleMeta, type DeleteExtensionHttpError, type DeleteExtensionHttpResponse, type DownloadExtensionHttpError, type DownloadExtensionHttpResponse, type DownloadFileFromExtensionHttpError, type DownloadFileFromExtensionHttpResponse, type Error, type Extension, type Extensions, type ExtensionsAPI, type GetExtensionHttpError, type GetExtensionHttpResponse, type GetExtensionsHttpError, type GetExtensionsHttpResponse, type Meta, type PatchExtensionHttpError, type PatchExtensionHttpResponse, type UploadExtensionHttpError, type UploadExtensionHttpResponse, clearCache, extensionsExport as default, deleteExtension, downloadExtension, downloadFileFromExtension, getExtension, getExtensions, patchExtension, uploadExtension };
|
package/extensions.d.ts
ADDED
|
@@ -0,0 +1,257 @@
|
|
|
1
|
+
import { A as ApiCallOptions } from './global.types-hIvp-WdX.js';
|
|
2
|
+
import './auth-types-nnUcWhuU.js';
|
|
3
|
+
|
|
4
|
+
type BundleMeta = {
|
|
5
|
+
/** Description of the bundle. */
|
|
6
|
+
description?: string;
|
|
7
|
+
/** Unique identifier of the bundle. */
|
|
8
|
+
id?: string;
|
|
9
|
+
/** Name of the bundle. */
|
|
10
|
+
name?: string;
|
|
11
|
+
};
|
|
12
|
+
type Error = {
|
|
13
|
+
/** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
|
|
14
|
+
meta?: Meta;
|
|
15
|
+
/** Optional JSON patch object pointing to an invalid property. */
|
|
16
|
+
source?: unknown;
|
|
17
|
+
/** The HTTP status code. */
|
|
18
|
+
status?: number;
|
|
19
|
+
/** Title of the HTTP status code. */
|
|
20
|
+
title: string;
|
|
21
|
+
};
|
|
22
|
+
type Extension = {
|
|
23
|
+
/** Author of the extension. */
|
|
24
|
+
author?: string;
|
|
25
|
+
/** Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined. */
|
|
26
|
+
bundle?: BundleMeta;
|
|
27
|
+
/** If the extension is part of an extension bundle. */
|
|
28
|
+
bundled?: boolean;
|
|
29
|
+
/** Checksum of the extension contents. */
|
|
30
|
+
checksum?: string;
|
|
31
|
+
readonly createdAt?: string;
|
|
32
|
+
/** Map of dependencies describing version of the component it requires. */
|
|
33
|
+
dependencies?: unknown;
|
|
34
|
+
/** A date noting when the extension was deprecated. */
|
|
35
|
+
deprecated?: string;
|
|
36
|
+
/** Description of the extension. */
|
|
37
|
+
description?: string;
|
|
38
|
+
/** The file that was uploaded with the extension. */
|
|
39
|
+
file?: unknown;
|
|
40
|
+
/** Home page of the extension. */
|
|
41
|
+
homepage?: string;
|
|
42
|
+
/** Icon to show in the client. */
|
|
43
|
+
icon?: string;
|
|
44
|
+
readonly id?: string;
|
|
45
|
+
/** Keywords for the extension. */
|
|
46
|
+
keywords?: string;
|
|
47
|
+
/** Under which license this extension is published. */
|
|
48
|
+
license?: string;
|
|
49
|
+
/** Relative path to the extension's entry file, defaults to `filename` from the qext file. */
|
|
50
|
+
loadpath?: string;
|
|
51
|
+
/** The display name of this extension. */
|
|
52
|
+
name?: string;
|
|
53
|
+
/** Path to an image that enables users to preview the extension. */
|
|
54
|
+
preview?: string;
|
|
55
|
+
/** The name of the qext file that was uploaded with this extension. */
|
|
56
|
+
qextFilename?: string;
|
|
57
|
+
/** The version from the qext file that was uploaded with this extension. */
|
|
58
|
+
qextVersion?: string;
|
|
59
|
+
/** Link to the extension source code. */
|
|
60
|
+
repository?: string;
|
|
61
|
+
/** If the extension is a supernova extension or not. */
|
|
62
|
+
supernova?: boolean;
|
|
63
|
+
/** Supplier of the extension. */
|
|
64
|
+
supplier?: string;
|
|
65
|
+
/** List of tags. */
|
|
66
|
+
tags?: string[];
|
|
67
|
+
readonly tenantId?: string;
|
|
68
|
+
/** The type of this extension (visualization, etc.). */
|
|
69
|
+
type?: string;
|
|
70
|
+
readonly updateAt?: string;
|
|
71
|
+
readonly userId?: string;
|
|
72
|
+
/** Version of the extension. */
|
|
73
|
+
version?: string;
|
|
74
|
+
};
|
|
75
|
+
type Extensions = {
|
|
76
|
+
data: Extension[];
|
|
77
|
+
};
|
|
78
|
+
type Meta = {
|
|
79
|
+
/** A more detailed message explaining the error. */
|
|
80
|
+
message?: string;
|
|
81
|
+
/** Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created. */
|
|
82
|
+
resourceName?: string;
|
|
83
|
+
/** Full stack trace of the error that was raised. */
|
|
84
|
+
stack?: string;
|
|
85
|
+
};
|
|
86
|
+
/**
|
|
87
|
+
* Lists all extensions.
|
|
88
|
+
* @throws GetExtensionsHttpError
|
|
89
|
+
*/
|
|
90
|
+
declare const getExtensions: (options?: ApiCallOptions) => Promise<GetExtensionsHttpResponse>;
|
|
91
|
+
type GetExtensionsHttpResponse = {
|
|
92
|
+
data: Extensions;
|
|
93
|
+
headers: Headers;
|
|
94
|
+
status: number;
|
|
95
|
+
};
|
|
96
|
+
type GetExtensionsHttpError = {
|
|
97
|
+
data: unknown;
|
|
98
|
+
headers: Headers;
|
|
99
|
+
status: number;
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* Creates a new extension. If a file is provided, the data field is not required.
|
|
103
|
+
* @param body an object with the body content
|
|
104
|
+
* @throws UploadExtensionHttpError
|
|
105
|
+
*/
|
|
106
|
+
declare const uploadExtension: (body: unknown, options?: ApiCallOptions) => Promise<UploadExtensionHttpResponse>;
|
|
107
|
+
type UploadExtensionHttpResponse = {
|
|
108
|
+
data: Extension;
|
|
109
|
+
headers: Headers;
|
|
110
|
+
status: number;
|
|
111
|
+
};
|
|
112
|
+
type UploadExtensionHttpError = {
|
|
113
|
+
data: Error;
|
|
114
|
+
headers: Headers;
|
|
115
|
+
status: number;
|
|
116
|
+
};
|
|
117
|
+
/**
|
|
118
|
+
* Deletes a specific extension.
|
|
119
|
+
* @param id Extension identifier or its qextFilename.
|
|
120
|
+
* @throws DeleteExtensionHttpError
|
|
121
|
+
*/
|
|
122
|
+
declare const deleteExtension: (id: string, options?: ApiCallOptions) => Promise<DeleteExtensionHttpResponse>;
|
|
123
|
+
type DeleteExtensionHttpResponse = {
|
|
124
|
+
data: void;
|
|
125
|
+
headers: Headers;
|
|
126
|
+
status: number;
|
|
127
|
+
};
|
|
128
|
+
type DeleteExtensionHttpError = {
|
|
129
|
+
data: Error;
|
|
130
|
+
headers: Headers;
|
|
131
|
+
status: number;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* Returns a specific extension.
|
|
135
|
+
* @param id Extension identifier or its qextFilename.
|
|
136
|
+
* @throws GetExtensionHttpError
|
|
137
|
+
*/
|
|
138
|
+
declare const getExtension: (id: string, options?: ApiCallOptions) => Promise<GetExtensionHttpResponse>;
|
|
139
|
+
type GetExtensionHttpResponse = {
|
|
140
|
+
data: Extension;
|
|
141
|
+
headers: Headers;
|
|
142
|
+
status: number;
|
|
143
|
+
};
|
|
144
|
+
type GetExtensionHttpError = {
|
|
145
|
+
data: Error;
|
|
146
|
+
headers: Headers;
|
|
147
|
+
status: number;
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* Updates a specific extension with provided data. If a file is provided, the data field is not required.
|
|
151
|
+
* @param id Extension identifier or its qextFilename.
|
|
152
|
+
* @param body an object with the body content
|
|
153
|
+
* @throws PatchExtensionHttpError
|
|
154
|
+
*/
|
|
155
|
+
declare const patchExtension: (id: string, body: unknown, options?: ApiCallOptions) => Promise<PatchExtensionHttpResponse>;
|
|
156
|
+
type PatchExtensionHttpResponse = {
|
|
157
|
+
data: Extension;
|
|
158
|
+
headers: Headers;
|
|
159
|
+
status: number;
|
|
160
|
+
};
|
|
161
|
+
type PatchExtensionHttpError = {
|
|
162
|
+
data: Error;
|
|
163
|
+
headers: Headers;
|
|
164
|
+
status: number;
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Downloads the extension as an archive.
|
|
168
|
+
* @param id Extension identifier or its qextFilename.
|
|
169
|
+
* @throws DownloadExtensionHttpError
|
|
170
|
+
*/
|
|
171
|
+
declare const downloadExtension: (id: string, options?: ApiCallOptions) => Promise<DownloadExtensionHttpResponse>;
|
|
172
|
+
type DownloadExtensionHttpResponse = {
|
|
173
|
+
data: void;
|
|
174
|
+
headers: Headers;
|
|
175
|
+
status: number;
|
|
176
|
+
};
|
|
177
|
+
type DownloadExtensionHttpError = {
|
|
178
|
+
data: Error;
|
|
179
|
+
headers: Headers;
|
|
180
|
+
status: number;
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* Downloads a file from the extension archive.
|
|
184
|
+
* @param id Extension identifier or its qextFilename.
|
|
185
|
+
* @param filepath Path to the file archive for the specified extension archive. Folders separated with forward slashes.
|
|
186
|
+
* @throws DownloadFileFromExtensionHttpError
|
|
187
|
+
*/
|
|
188
|
+
declare const downloadFileFromExtension: (id: string, filepath: string, options?: ApiCallOptions) => Promise<DownloadFileFromExtensionHttpResponse>;
|
|
189
|
+
type DownloadFileFromExtensionHttpResponse = {
|
|
190
|
+
data: void;
|
|
191
|
+
headers: Headers;
|
|
192
|
+
status: number;
|
|
193
|
+
};
|
|
194
|
+
type DownloadFileFromExtensionHttpError = {
|
|
195
|
+
data: Error;
|
|
196
|
+
headers: Headers;
|
|
197
|
+
status: number;
|
|
198
|
+
};
|
|
199
|
+
/**
|
|
200
|
+
* Clears the cache for extensions api requests.
|
|
201
|
+
*/
|
|
202
|
+
declare function clearCache(): void;
|
|
203
|
+
interface ExtensionsAPI {
|
|
204
|
+
/**
|
|
205
|
+
* Lists all extensions.
|
|
206
|
+
* @throws GetExtensionsHttpError
|
|
207
|
+
*/
|
|
208
|
+
getExtensions: typeof getExtensions;
|
|
209
|
+
/**
|
|
210
|
+
* Creates a new extension. If a file is provided, the data field is not required.
|
|
211
|
+
* @param body an object with the body content
|
|
212
|
+
* @throws UploadExtensionHttpError
|
|
213
|
+
*/
|
|
214
|
+
uploadExtension: typeof uploadExtension;
|
|
215
|
+
/**
|
|
216
|
+
* Deletes a specific extension.
|
|
217
|
+
* @param id Extension identifier or its qextFilename.
|
|
218
|
+
* @throws DeleteExtensionHttpError
|
|
219
|
+
*/
|
|
220
|
+
deleteExtension: typeof deleteExtension;
|
|
221
|
+
/**
|
|
222
|
+
* Returns a specific extension.
|
|
223
|
+
* @param id Extension identifier or its qextFilename.
|
|
224
|
+
* @throws GetExtensionHttpError
|
|
225
|
+
*/
|
|
226
|
+
getExtension: typeof getExtension;
|
|
227
|
+
/**
|
|
228
|
+
* Updates a specific extension with provided data. If a file is provided, the data field is not required.
|
|
229
|
+
* @param id Extension identifier or its qextFilename.
|
|
230
|
+
* @param body an object with the body content
|
|
231
|
+
* @throws PatchExtensionHttpError
|
|
232
|
+
*/
|
|
233
|
+
patchExtension: typeof patchExtension;
|
|
234
|
+
/**
|
|
235
|
+
* Downloads the extension as an archive.
|
|
236
|
+
* @param id Extension identifier or its qextFilename.
|
|
237
|
+
* @throws DownloadExtensionHttpError
|
|
238
|
+
*/
|
|
239
|
+
downloadExtension: typeof downloadExtension;
|
|
240
|
+
/**
|
|
241
|
+
* Downloads a file from the extension archive.
|
|
242
|
+
* @param id Extension identifier or its qextFilename.
|
|
243
|
+
* @param filepath Path to the file archive for the specified extension archive. Folders separated with forward slashes.
|
|
244
|
+
* @throws DownloadFileFromExtensionHttpError
|
|
245
|
+
*/
|
|
246
|
+
downloadFileFromExtension: typeof downloadFileFromExtension;
|
|
247
|
+
/**
|
|
248
|
+
* Clears the cache for extensions api requests.
|
|
249
|
+
*/
|
|
250
|
+
clearCache: typeof clearCache;
|
|
251
|
+
}
|
|
252
|
+
/**
|
|
253
|
+
* Functions for the extensions api
|
|
254
|
+
*/
|
|
255
|
+
declare const extensionsExport: ExtensionsAPI;
|
|
256
|
+
|
|
257
|
+
export { type BundleMeta, type DeleteExtensionHttpError, type DeleteExtensionHttpResponse, type DownloadExtensionHttpError, type DownloadExtensionHttpResponse, type DownloadFileFromExtensionHttpError, type DownloadFileFromExtensionHttpResponse, type Error, type Extension, type Extensions, type ExtensionsAPI, type GetExtensionHttpError, type GetExtensionHttpResponse, type GetExtensionsHttpError, type GetExtensionsHttpResponse, type Meta, type PatchExtensionHttpError, type PatchExtensionHttpResponse, type UploadExtensionHttpError, type UploadExtensionHttpResponse, clearCache, extensionsExport as default, deleteExtension, downloadExtension, downloadFileFromExtension, getExtension, getExtensions, patchExtension, uploadExtension };
|