@qlik/api 0.0.1

package/extensions.js

@@ -0,0 +1,74 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkOULT3V2Ujs = require('./chunk-OULT3V2U.js');
+require('./chunk-ZT4C7KCQ.js');
+
+// src/public/rest/extensions.ts
+var getExtensions = async (options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "extensions", {
+  method: "get",
+  pathTemplate: "/api/v1/extensions",
+  options
+});
+var uploadExtension = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "extensions", {
+  method: "post",
+  pathTemplate: "/api/v1/extensions",
+  body,
+  options
+});
+var deleteExtension = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "extensions", {
+  method: "delete",
+  pathTemplate: "/api/v1/extensions/{id}",
+  pathVariables: { id },
+  options
+});
+var getExtension = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "extensions", {
+  method: "get",
+  pathTemplate: "/api/v1/extensions/{id}",
+  pathVariables: { id },
+  options
+});
+var patchExtension = async (id, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "extensions", {
+  method: "patch",
+  pathTemplate: "/api/v1/extensions/{id}",
+  pathVariables: { id },
+  body,
+  options
+});
+var downloadExtension = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "extensions", {
+  method: "get",
+  pathTemplate: "/api/v1/extensions/{id}/file",
+  pathVariables: { id },
+  options
+});
+var downloadFileFromExtension = async (id, filepath, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "extensions", {
+  method: "get",
+  pathTemplate: "/api/v1/extensions/{id}/file/{filepath}",
+  pathVariables: { id, filepath },
+  options
+});
+function clearCache() {
+  return _chunkOULT3V2Ujs.clearApiCache.call(void 0, "extensions");
+}
+var extensionsExport = {
+  getExtensions,
+  uploadExtension,
+  deleteExtension,
+  getExtension,
+  patchExtension,
+  downloadExtension,
+  downloadFileFromExtension,
+  clearCache
+};
+var extensions_default = extensionsExport;
+
+
+
+
+
+
+
+
+
+
+exports.clearCache = clearCache; exports.default = extensions_default; exports.deleteExtension = deleteExtension; exports.downloadExtension = downloadExtension; exports.downloadFileFromExtension = downloadFileFromExtension; exports.getExtension = getExtension; exports.getExtensions = getExtensions; exports.patchExtension = patchExtension; exports.uploadExtension = uploadExtension;

package/extensions.mjs

@@ -0,0 +1,74 @@
+import {
+  clearApiCache,
+  invokeFetch
+} from "./chunk-3YE7EI7I.mjs";
+import "./chunk-WM7FQU2U.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,
+  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,
+  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-Eto4uYwy.d.mts

@@ -0,0 +1,102 @@
+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;
+};
+
+/** ApiKey Auth Configuration for a HostConfig */
+type ApiKeyAuthConfig = {
+    apiKey: string;
+};
+/** Cookie Auth Configuration for a HostConfig */
+type CookieAuthConfig = {
+    webIntegrationId?: string;
+    crossSiteCookies?: boolean;
+};
+/** WindowsCookie Auth Configuration for a HostConfig */
+type WindowsCookieAuthConfig = {
+    loginUri?: string;
+    crossSiteCookies?: boolean;
+};
+/** OAuth2 Auth Configuration for a HostConfig */
+type Oauth2AuthConfig = {
+    clientId: string;
+    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 };

package/global.types-hIvp-WdX.d.ts

@@ -0,0 +1,102 @@
+import { H as HostConfig } from './auth-types-nnUcWhuU.js';
+
+/** 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;
+};
+
+/** ApiKey Auth Configuration for a HostConfig */
+type ApiKeyAuthConfig = {
+    apiKey: string;
+};
+/** Cookie Auth Configuration for a HostConfig */
+type CookieAuthConfig = {
+    webIntegrationId?: string;
+    crossSiteCookies?: boolean;
+};
+/** WindowsCookie Auth Configuration for a HostConfig */
+type WindowsCookieAuthConfig = {
+    loginUri?: string;
+    crossSiteCookies?: boolean;
+};
+/** OAuth2 Auth Configuration for a HostConfig */
+type Oauth2AuthConfig = {
+    clientId: string;
+    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 };