@qlik/api 2.2.0 → 2.3.0

package/extensions.d.ts

@@ -1,4 +1,296 @@
-import "./chunks/auth-types-E99tzdN0.js";
-import "./chunks/invoke-fetch-CbU2Dgqr.js";
-import { C as downloadExtension, D as getExtensions, E as getExtension, O as patchExtension, S as deleteExtension, T as extensionsExport, _ as PatchExtensionHttpError, a as DownloadExtensionHttpResponse, b as UploadExtensionHttpResponse, c as Error, d as ExtensionsAPI, f as GetExtensionHttpError, g as Meta, h as GetExtensionsHttpResponse, i as DownloadExtensionHttpError, k as uploadExtension, l as Extension, m as GetExtensionsHttpError, n as DeleteExtensionHttpError, o as DownloadFileFromExtensionHttpError, p as GetExtensionHttpResponse, r as DeleteExtensionHttpResponse, s as DownloadFileFromExtensionHttpResponse, t as BundleMeta, u as Extensions, v as PatchExtensionHttpResponse, w as downloadFileFromExtension, x as clearCache, y as UploadExtensionHttpError } from "./chunks/extensions-OO0WtInj.js";
+import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
+import "./chunks/invoke-fetch-C1Z0RJYU.js";
+
+//#region src/public/rest/extensions.d.ts
+/**
+ * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
+ */
+type BundleMeta = {
+  /** Description of the bundle. */
+  description?: string;
+  /** Unique identifier of the bundle. */
+  id?: string;
+  /** Name of the bundle. */
+  name?: string;
+};
+/**
+ * An error object.
+ */
+type Error = {
+  /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
+  meta?: Meta;
+  /** Optional JSON patch object pointing to an invalid property. */
+  source?: unknown;
+  /** The HTTP status code. */
+  status?: number;
+  /** Title of the HTTP status code. */
+  title: string;
+  /** The active traceId. */
+  traceId?: string;
+};
+/**
+ * The extension model.
+ */
+type Extension = {
+  /** Author of the extension. */
+  author?: string;
+  /** Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined. */
+  bundle?: BundleMeta;
+  /** If the extension is part of an extension bundle. */
+  bundled?: boolean;
+  /** Checksum of the extension contents. */
+  checksum?: string;
+  readonly createdAt?: string;
+  /** Map of dependencies describing version of the component it requires. */
+  dependencies?: unknown;
+  /** A date noting when the extension was deprecated. */
+  deprecated?: string;
+  /** Description of the extension. */
+  description?: string;
+  /** The file that was uploaded with the extension. */
+  file?: unknown;
+  /** Home page of the extension. */
+  homepage?: string;
+  /** Icon to show in the client. */
+  icon?: string;
+  readonly id?: string;
+  /** Keywords for the extension. */
+  keywords?: string;
+  /** Under which license this extension is published. */
+  license?: string;
+  /** Relative path to the extension's entry file, defaults to `filename` from the qext file. */
+  loadpath?: string;
+  /** The display name of this extension. */
+  name?: string;
+  /** Path to an image that enables users to preview the extension. */
+  preview?: string;
+  /** The name of the qext file that was uploaded with this extension. */
+  qextFilename?: string;
+  /** The version from the qext file that was uploaded with this extension. */
+  qextVersion?: string;
+  /** Link to the extension source code. */
+  repository?: string;
+  /** If the extension is a supernova extension or not. */
+  supernova?: boolean;
+  /** Supplier of the extension. */
+  supplier?: string;
+  /** List of tags. */
+  tags?: string[];
+  readonly tenantId?: string;
+  /** The type of this extension (visualization, etc.). */
+  type?: string;
+  readonly updateAt?: string;
+  readonly userId?: string;
+  /** Version of the extension. */
+  version?: string;
+};
+type Extensions = {
+  data: Extension[];
+};
+/**
+ * Object containing meta data regarding an error. It does not necessarily contain all the properties.
+ */
+type Meta = {
+  /** A more detailed message explaining the error. */
+  message?: string;
+  /** Name of the resource related to the error. If there is a conflict, it is the name of the model attempting to be created. */
+  resourceName?: string;
+  /** Full stack trace of the error that was raised. */
+  stack?: string;
+};
+/**
+ * Lists all imported extensions in the tenant.
+ *
+ * @throws GetExtensionsHttpError
+ */
+declare function getExtensions(options?: ApiCallOptions): Promise<GetExtensionsHttpResponse>;
+type GetExtensionsHttpResponse = {
+  data: Extensions;
+  headers: Headers;
+  status: 200;
+};
+type GetExtensionsHttpError = {
+  data: unknown;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.
+ *
+ * @param body an object with the body content
+ * @throws UploadExtensionHttpError
+ */
+declare function uploadExtension(body: {
+  /** The extension model. */
+  data?: Extension;
+  /** Extension archive. */
+  file?: BodyInit;
+}, options?: ApiCallOptions): Promise<UploadExtensionHttpResponse>;
+type UploadExtensionHttpResponse = {
+  data: Extension;
+  headers: Headers;
+  status: 201;
+};
+type UploadExtensionHttpError = {
+  data: Error;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Deletes a specific extension matching either extension ID or extension name.
+ *
+ * @param id Extension identifier or its qextFilename.
+ * @throws DeleteExtensionHttpError
+ */
+declare function deleteExtension(id: string, options?: ApiCallOptions): Promise<DeleteExtensionHttpResponse>;
+type DeleteExtensionHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type DeleteExtensionHttpError = {
+  data: Error;
+  headers: Headers;
+  status: 403 | 404 | 410;
+};
+/**
+ * Returns a specific extension matching either extension ID or extension name.
+ *
+ * @param id Extension identifier or its qextFilename.
+ * @throws GetExtensionHttpError
+ */
+declare function getExtension(id: string, options?: ApiCallOptions): Promise<GetExtensionHttpResponse>;
+type GetExtensionHttpResponse = {
+  data: Extension;
+  headers: Headers;
+  status: 200;
+};
+type GetExtensionHttpError = {
+  data: Error;
+  headers: Headers;
+  status: 403 | 404 | 410;
+};
+/**
+ * Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
+ *
+ * @param id Extension identifier or its qextFilename.
+ * @param body an object with the body content
+ * @throws PatchExtensionHttpError
+ */
+declare function patchExtension(id: string, body: {
+  /** The extension model. */
+  data?: Extension;
+  /** Extension archive. */
+  file?: BodyInit;
+}, options?: ApiCallOptions): Promise<PatchExtensionHttpResponse>;
+type PatchExtensionHttpResponse = {
+  data: Extension;
+  headers: Headers;
+  status: 200;
+};
+type PatchExtensionHttpError = {
+  data: Error;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Downloads all files in the extension matching either extension ID or extension name as a `.zip` archive.
+ *
+ * @param id Extension identifier or its qextFilename.
+ * @throws DownloadExtensionHttpError
+ */
+declare function downloadExtension(id: string, options?: ApiCallOptions): Promise<DownloadExtensionHttpResponse>;
+type DownloadExtensionHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 200;
+};
+type DownloadExtensionHttpError = {
+  data: Error;
+  headers: Headers;
+  status: 403 | 404 | 410;
+};
+/**
+ * Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
+ *
+ * @param id Extension identifier or its qextFilename.
+ * @param filepath Path to the file location within the specified extension archive. Folders separated with forward slashes.
+ * @throws DownloadFileFromExtensionHttpError
+ */
+declare function downloadFileFromExtension(id: string, filepath: string, options?: ApiCallOptions): Promise<DownloadFileFromExtensionHttpResponse>;
+type DownloadFileFromExtensionHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 200;
+};
+type DownloadFileFromExtensionHttpError = {
+  data: Error;
+  headers: Headers;
+  status: 403 | 404 | 410;
+};
+/**
+ * Clears the cache for extensions api requests.
+ */
+declare function clearCache(): void;
+type ExtensionsAPI = {
+  /**
+   * Lists all imported extensions in the tenant.
+   *
+   * @throws GetExtensionsHttpError
+   */
+  getExtensions: typeof getExtensions;
+  /**
+   * Creates a new extension. Accepts either provided file or data object. The name of the new extension must be different to any existing extensions.
+   *
+   * @param body an object with the body content
+   * @throws UploadExtensionHttpError
+   */
+  uploadExtension: typeof uploadExtension;
+  /**
+   * Deletes a specific extension matching either extension ID or extension name.
+   *
+   * @param id Extension identifier or its qextFilename.
+   * @throws DeleteExtensionHttpError
+   */
+  deleteExtension: typeof deleteExtension;
+  /**
+   * Returns a specific extension matching either extension ID or extension name.
+   *
+   * @param id Extension identifier or its qextFilename.
+   * @throws GetExtensionHttpError
+   */
+  getExtension: typeof getExtension;
+  /**
+   * Updates a specific extension matching either extension ID or extension name. Accepts either provided file or data object.
+   *
+   * @param id Extension identifier or its qextFilename.
+   * @param body an object with the body content
+   * @throws PatchExtensionHttpError
+   */
+  patchExtension: typeof patchExtension;
+  /**
+   * Downloads all files in the extension matching either extension ID or extension name as a `.zip` archive.
+   *
+   * @param id Extension identifier or its qextFilename.
+   * @throws DownloadExtensionHttpError
+   */
+  downloadExtension: typeof downloadExtension;
+  /**
+   * Downloads a specific file from the extension matching either extension ID or extension name, identified by the file path within the imported extension.
+   *
+   * @param id Extension identifier or its qextFilename.
+   * @param filepath Path to the file location within the specified extension archive. Folders separated with forward slashes.
+   * @throws DownloadFileFromExtensionHttpError
+   */
+  downloadFileFromExtension: typeof downloadFileFromExtension;
+  /**
+   * Clears the cache for extensions api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the extensions api
+ */
+declare const extensionsExport: ExtensionsAPI;
+//#endregion
 export { BundleMeta, DeleteExtensionHttpError, DeleteExtensionHttpResponse, DownloadExtensionHttpError, DownloadExtensionHttpResponse, DownloadFileFromExtensionHttpError, DownloadFileFromExtensionHttpResponse, Error, Extension, Extensions, ExtensionsAPI, GetExtensionHttpError, GetExtensionHttpResponse, GetExtensionsHttpError, GetExtensionsHttpResponse, Meta, PatchExtensionHttpError, PatchExtensionHttpResponse, UploadExtensionHttpError, UploadExtensionHttpResponse, clearCache, extensionsExport as default, deleteExtension, downloadExtension, downloadFileFromExtension, getExtension, getExtensions, patchExtension, uploadExtension };

package/extensions.js

@@ -1,6 +1,5 @@
-import "./chunks/utils-BnC4lrlq.js";
-import "./chunks/public-runtime-modules-Dwjzb3l8.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
+import "./chunks/public-runtime-modules-QhLPeQr5.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
 
 //#region src/public/rest/extensions.ts
 /**

package/global-types.d.ts

@@ -1,2 +1,2 @@
-import { v as PerformInteractiveLoginFn } from "./chunks/auth-types-E99tzdN0.js";
+import { v as PerformInteractiveLoginFn } from "./chunks/auth-types-YrlH_R9f.js";
 export { PerformInteractiveLoginFn };

package/global-types.js

@@ -1,3 +1 @@
-import "./chunks/global-types-CrOvI33z.js";
-
 export {  };