@qlik/api 0.0.15 → 0.1.0

package/extensions.d.mts

@@ -1,293 +0,0 @@
-import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
-import './auth-types-nnUcWhuU.mjs';
-
-/**
- * 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 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 extensions.
- *
- * @throws GetExtensionsHttpError
- */
-declare const getExtensions: (options?: ApiCallOptions) => Promise<GetExtensionsHttpResponse>;
-type GetExtensionsHttpResponse = {
-    data: Extensions;
-    headers: Headers;
-    status: number;
-};
-type GetExtensionsHttpError = {
-    data: unknown;
-    headers: Headers;
-    status: number;
-};
-/**
- * Creates a new extension. If a file is provided, the data field is not required.
- *
- * @param body an object with the body content
- * @throws UploadExtensionHttpError
- */
-declare const uploadExtension: (body: {
-    /** The extension model. */
-    data?: Extension;
-    /** Extension archive. */
-    file?: BodyInit;
-}, options?: ApiCallOptions) => Promise<UploadExtensionHttpResponse>;
-type UploadExtensionHttpResponse = {
-    data: Extension;
-    headers: Headers;
-    status: number;
-};
-type UploadExtensionHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Deletes a specific extension.
- *
- * @param id Extension identifier or its qextFilename.
- * @throws DeleteExtensionHttpError
- */
-declare const deleteExtension: (id: string, options?: ApiCallOptions) => Promise<DeleteExtensionHttpResponse>;
-type DeleteExtensionHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-type DeleteExtensionHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Returns a specific extension.
- *
- * @param id Extension identifier or its qextFilename.
- * @throws GetExtensionHttpError
- */
-declare const getExtension: (id: string, options?: ApiCallOptions) => Promise<GetExtensionHttpResponse>;
-type GetExtensionHttpResponse = {
-    data: Extension;
-    headers: Headers;
-    status: number;
-};
-type GetExtensionHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Updates a specific extension with provided data. If a file is provided, the data field is not required.
- *
- * @param id Extension identifier or its qextFilename.
- * @param body an object with the body content
- * @throws PatchExtensionHttpError
- */
-declare const patchExtension: (id: string, body: {
-    /** The extension model. */
-    data?: Extension;
-    /** Extension archive. */
-    file?: BodyInit;
-}, options?: ApiCallOptions) => Promise<PatchExtensionHttpResponse>;
-type PatchExtensionHttpResponse = {
-    data: Extension;
-    headers: Headers;
-    status: number;
-};
-type PatchExtensionHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Downloads the extension as an archive.
- *
- * @param id Extension identifier or its qextFilename.
- * @throws DownloadExtensionHttpError
- */
-declare const downloadExtension: (id: string, options?: ApiCallOptions) => Promise<DownloadExtensionHttpResponse>;
-type DownloadExtensionHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-type DownloadExtensionHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Downloads a file from the extension archive.
- *
- * @param id Extension identifier or its qextFilename.
- * @param filepath Path to the file archive for the specified extension archive. Folders separated with forward slashes.
- * @throws DownloadFileFromExtensionHttpError
- */
-declare const downloadFileFromExtension: (id: string, filepath: string, options?: ApiCallOptions) => Promise<DownloadFileFromExtensionHttpResponse>;
-type DownloadFileFromExtensionHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-type DownloadFileFromExtensionHttpError = {
-    data: Error;
-    headers: Headers;
-    status: number;
-};
-/**
- * Clears the cache for extensions api requests.
- */
-declare function clearCache(): void;
-interface ExtensionsAPI {
-    /**
-     * Lists all extensions.
-     *
-     * @throws GetExtensionsHttpError
-     */
-    getExtensions: typeof getExtensions;
-    /**
-     * Creates a new extension. If a file is provided, the data field is not required.
-     *
-     * @param body an object with the body content
-     * @throws UploadExtensionHttpError
-     */
-    uploadExtension: typeof uploadExtension;
-    /**
-     * Deletes a specific extension.
-     *
-     * @param id Extension identifier or its qextFilename.
-     * @throws DeleteExtensionHttpError
-     */
-    deleteExtension: typeof deleteExtension;
-    /**
-     * Returns a specific extension.
-     *
-     * @param id Extension identifier or its qextFilename.
-     * @throws GetExtensionHttpError
-     */
-    getExtension: typeof getExtension;
-    /**
-     * Updates a specific extension with provided data. If a file is provided, the data field is not required.
-     *
-     * @param id Extension identifier or its qextFilename.
-     * @param body an object with the body content
-     * @throws PatchExtensionHttpError
-     */
-    patchExtension: typeof patchExtension;
-    /**
-     * Downloads the extension as an archive.
-     *
-     * @param id Extension identifier or its qextFilename.
-     * @throws DownloadExtensionHttpError
-     */
-    downloadExtension: typeof downloadExtension;
-    /**
-     * Downloads a file from the extension archive.
-     *
-     * @param id Extension identifier or its qextFilename.
-     * @param filepath Path to the file archive for 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;
-
-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.mjs

@@ -1,77 +0,0 @@
-import {
-  clearApiCache,
-  invokeFetch
-} from "./chunks/3YV6X7S6.mjs";
-import "./chunks/EHAANYDL.mjs";
-import "./chunks/VSY5YIQY.mjs";
-
-// src/public/rest/extensions.ts
-var getExtensions = async (options) => invokeFetch("extensions", {
-  method: "get",
-  pathTemplate: "/api/v1/extensions",
-  options
-});
-var uploadExtension = async (body, options) => invokeFetch("extensions", {
-  method: "post",
-  pathTemplate: "/api/v1/extensions",
-  body,
-  contentType: "multipart/form-data",
-  options
-});
-var deleteExtension = async (id, options) => invokeFetch("extensions", {
-  method: "delete",
-  pathTemplate: "/api/v1/extensions/{id}",
-  pathVariables: { id },
-  options
-});
-var getExtension = async (id, options) => invokeFetch("extensions", {
-  method: "get",
-  pathTemplate: "/api/v1/extensions/{id}",
-  pathVariables: { id },
-  options
-});
-var patchExtension = async (id, body, options) => invokeFetch("extensions", {
-  method: "patch",
-  pathTemplate: "/api/v1/extensions/{id}",
-  pathVariables: { id },
-  body,
-  contentType: "multipart/form-data",
-  options
-});
-var downloadExtension = async (id, options) => invokeFetch("extensions", {
-  method: "get",
-  pathTemplate: "/api/v1/extensions/{id}/file",
-  pathVariables: { id },
-  options
-});
-var downloadFileFromExtension = async (id, filepath, options) => invokeFetch("extensions", {
-  method: "get",
-  pathTemplate: "/api/v1/extensions/{id}/file/{filepath}",
-  pathVariables: { id, filepath },
-  options
-});
-function clearCache() {
-  return clearApiCache("extensions");
-}
-var extensionsExport = {
-  getExtensions,
-  uploadExtension,
-  deleteExtension,
-  getExtension,
-  patchExtension,
-  downloadExtension,
-  downloadFileFromExtension,
-  clearCache
-};
-var extensions_default = extensionsExport;
-export {
-  clearCache,
-  extensions_default as default,
-  deleteExtension,
-  downloadExtension,
-  downloadFileFromExtension,
-  getExtension,
-  getExtensions,
-  patchExtension,
-  uploadExtension
-};

package/global.types-5iFvFJvX.d.mts

@@ -1,115 +0,0 @@
-import { H as HostConfig } from './auth-types-nnUcWhuU.mjs';
-
-/** An entry in the cache for one specific cacheKey */
-type CacheEntry = {
-    lastPulled: number;
-    /** last time the cache was accessed and prevented an api call */
-    lastHit: Date | null;
-    /** number of times the cache has been hit by a client */
-    hitCount: number;
-    /** the url path of the cache hit. Useful to determine how many different qmfes are accessing the cache key */
-    accessedPaths: Set<string>;
-    value: Promise<unknown>;
-};
-/** Additional options for an api call done with invoke-fetch */
-type ApiCallOptions = {
-    /** Additional headers to pass on to the request. */
-    headers?: Record<string, string>;
-    /** if set to true the call will not use a cached result */
-    noCache?: boolean;
-    /**
-     * Only used cached results whose age in milliseconds are less than that or equal to `maxCacheAge`.
-     */
-    maxCacheAge?: number | undefined;
-    /**
-     * Only results cached on or after the `ifCachedSince` timestamp are used.
-     */
-    useCacheIfAfter?: Date;
-    /**
-     * Specify if another host than `globalThis.location` is to be used. Typically used in embedding and mashups
-     */
-    hostConfig?: HostConfig;
-    /**
-     * Set the amount of time to wait for a response.
-     * If the timeout is exceeded the request is aborted.
-     */
-    timeoutMs?: number;
-};
-type DownloadableBlob = Blob & {
-    /** download the blob in a using the specified filename */
-    download: (filename: string) => Promise<void>;
-};
-
-/** ApiKey Auth Configuration for a HostConfig */
-type ApiKeyAuthConfig = {
-    /** api key created by a developer role on a tenant */
-    apiKey: string;
-};
-/** Cookie Auth Configuration for a HostConfig */
-type CookieAuthConfig = {
-    /** Web Integration Id created by tenant admin */
-    webIntegrationId?: string;
-    /** If set to false the `credentials` property will be set to same-origin  */
-    crossSiteCookies?: boolean;
-};
-/** WindowsCookie Auth Configuration for a HostConfig */
-type WindowsCookieAuthConfig = {
-    /** location of the login page, auth module will redirect to this page when an unauthenticated api call is made */
-    loginUri?: string;
-    /** If set to false the `credentials` property will be set to same-origin  */
-    crossSiteCookies?: boolean;
-};
-/** OAuth2 Auth Configuration for a HostConfig */
-type Oauth2AuthConfig = {
-    /** client id of oauth client created by tenant admin */
-    clientId: string;
-    /** client id of oauth client created by tenant admin */
-    clientSecret?: string;
-    /** location of where the client should be redirected after getting hold of the access token */
-    redirectUri?: string;
-    /** If set, store the access token in either local or session storage, otherwise not stored */
-    accessTokenStorage?: "session" | "local";
-    /** A string with comma separated values of oauth2 scopes https://oauth.net/2/scope defaults to "user_default" */
-    scope?: string;
-};
-declare global {
-    /**
-     * QlikAuthModules is a global interface that can be extended to add custom auth modules.
-     */
-    interface QlikAuthModules {
-        apikey: {
-            config: ApiKeyAuthConfig;
-        };
-        oauth2: {
-            config: Oauth2AuthConfig;
-        };
-        cookie: {
-            config: CookieAuthConfig;
-        };
-        windowscookie: {
-            config: WindowsCookieAuthConfig;
-        };
-        none: {
-            config: object;
-        };
-    }
-    /**
-     * Property set on the window when the user is logging out.
-     * This prevents unnecessary redirect calls when pending requests
-     * resolved.
-     */
-    var loggingOut: boolean;
-    /**
-     * Attaching cache to the window so it can be viewed from the devtool.
-     * Do not use this for anything!
-     */
-    var __API_CACHE__DO_NOT_USE_OR_YOU_WILL_BE_FIRED: Record<string, Record<string, CacheEntry>>;
-    /**
-     * QlikMain object defined in https://github.com/qlik-trial/main-web-container/blob/main/src/main.ts
-     */
-    var QlikMain: {
-        resourceNeedsCredentials: (resourcesUrl: string) => boolean;
-    } | undefined;
-}
-
-export type { ApiCallOptions as A, DownloadableBlob as D };