@qlik/api 0.0.1 → 0.0.3

package/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# These owners will be the default owners for everything in the repo.
+* @qlik-oss/frontend-core

package/.github/workflows/release.yaml

@@ -0,0 +1,35 @@
+name: Publish NPM Package
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Set NPM Token
+        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_CI_TOKEN }}" > .npmrc
+
+      - name: Set version and publish
+        run: |
+          VERSION=$(git describe --tags --abbrev=7 --match "v*")
+          VERSION=${VERSION#v}
+          echo "version is $VERSION"
+          jq --arg version "$VERSION" '.version = $version' package.json >temp.json && mv temp.json package.json
+          cat package.json
+          npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_CI_TOKEN }}

package/README.md

@@ -3,6 +3,4 @@
 > **Warning**
 > This package is experimental and will likely change and break until the version number 1.0.0 is released.
 
-Javascript library for consuming Qlik API's
-
-Connect to Qlik's rest and qix API from your Javascript/Typescript application with fully typed API's.
+Library used for connecting to Qlik API's. Supports both rest and qix api.

package/api-keys.d.mts

@@ -122,6 +122,7 @@ type ApiKeyPage = {
 };
 /**
  * Lists API keys for a given tenant ID.
+ *
  * @param query an object with query parameters
  * @throws GetApiKeysHttpError
  */
@@ -155,6 +156,7 @@ type GetApiKeysHttpError = {
 };
 /**
  * Creates an API key resource.
+ *
  * @param body an object with the body content
  * @throws CreateApiKeyHttpError
  */
@@ -171,39 +173,42 @@ type CreateApiKeyHttpError = {
 };
 /**
  * Gets the API keys configuration for a given tenant ID.
+ *
  * @param tenantId The tenant ID of the API keys configuration to be retrieved.
- * @throws GetApiKeyConfigHttpError
+ * @throws GetApiKeysConfigHttpError
  */
-declare const getApiKeyConfig: (tenantId: string, options?: ApiCallOptions) => Promise<GetApiKeyConfigHttpResponse>;
-type GetApiKeyConfigHttpResponse = {
+declare const getApiKeysConfig: (tenantId: string, options?: ApiCallOptions) => Promise<GetApiKeysConfigHttpResponse>;
+type GetApiKeysConfigHttpResponse = {
     data: ApiKeysConfig;
     headers: Headers;
     status: number;
 };
-type GetApiKeyConfigHttpError = {
+type GetApiKeysConfigHttpError = {
     data: Errors;
     headers: Headers;
     status: number;
 };
 /**
  * Updates the API keys configuration for a given tenant ID.
+ *
  * @param tenantId The tenant ID of the API keys configuration to be retrieved.
  * @param body an object with the body content
- * @throws PatchApiKeyConfigHttpError
+ * @throws PatchApiKeysConfigHttpError
  */
-declare const patchApiKeyConfig: (tenantId: string, body: ApiKeysConfigPatchSchema, options?: ApiCallOptions) => Promise<PatchApiKeyConfigHttpResponse>;
-type PatchApiKeyConfigHttpResponse = {
+declare const patchApiKeysConfig: (tenantId: string, body: ApiKeysConfigPatchSchema, options?: ApiCallOptions) => Promise<PatchApiKeysConfigHttpResponse>;
+type PatchApiKeysConfigHttpResponse = {
     data: void;
     headers: Headers;
     status: number;
 };
-type PatchApiKeyConfigHttpError = {
+type PatchApiKeysConfigHttpError = {
     data: Errors;
     headers: Headers;
     status: number;
 };
 /**
  * When the owner of the API key sends the request, the key will be removed. When a TenantAdmin sends the request, the key will be revoked.
+ *
  * @param id The ID of the API key resource to be retrieved.
  * @throws DeleteApiKeyHttpError
  */
@@ -220,6 +225,7 @@ type DeleteApiKeyHttpError = {
 };
 /**
  * Gets the API key for a given ID.
+ *
  * @param id The ID of the API key resource to be retrieved.
  * @throws GetApiKeyHttpError
  */
@@ -236,6 +242,7 @@ type GetApiKeyHttpError = {
 };
 /**
  * Updates an API key for a given ID.
+ *
  * @param id The ID of the API key resource to be updated.
  * @param body an object with the body content
  * @throws PatchApiKeyHttpError
@@ -258,43 +265,50 @@ declare function clearCache(): void;
 interface ApiKeysAPI {
     /**
      * Lists API keys for a given tenant ID.
+     *
      * @param query an object with query parameters
      * @throws GetApiKeysHttpError
      */
     getApiKeys: typeof getApiKeys;
     /**
      * Creates an API key resource.
+     *
      * @param body an object with the body content
      * @throws CreateApiKeyHttpError
      */
     createApiKey: typeof createApiKey;
     /**
      * Gets the API keys configuration for a given tenant ID.
+     *
      * @param tenantId The tenant ID of the API keys configuration to be retrieved.
-     * @throws GetApiKeyConfigHttpError
+     * @throws GetApiKeysConfigHttpError
      */
-    getApiKeyConfig: typeof getApiKeyConfig;
+    getApiKeysConfig: typeof getApiKeysConfig;
     /**
      * Updates the API keys configuration for a given tenant ID.
+     *
      * @param tenantId The tenant ID of the API keys configuration to be retrieved.
      * @param body an object with the body content
-     * @throws PatchApiKeyConfigHttpError
+     * @throws PatchApiKeysConfigHttpError
      */
-    patchApiKeyConfig: typeof patchApiKeyConfig;
+    patchApiKeysConfig: typeof patchApiKeysConfig;
     /**
      * When the owner of the API key sends the request, the key will be removed. When a TenantAdmin sends the request, the key will be revoked.
+     *
      * @param id The ID of the API key resource to be retrieved.
      * @throws DeleteApiKeyHttpError
      */
     deleteApiKey: typeof deleteApiKey;
     /**
      * Gets the API key for a given ID.
+     *
      * @param id The ID of the API key resource to be retrieved.
      * @throws GetApiKeyHttpError
      */
     getApiKey: typeof getApiKey;
     /**
      * Updates an API key for a given ID.
+     *
      * @param id The ID of the API key resource to be updated.
      * @param body an object with the body content
      * @throws PatchApiKeyHttpError
@@ -310,4 +324,4 @@ interface ApiKeysAPI {
  */
 declare const apiKeysExport: ApiKeysAPI;
 
-export { type ApiKey, type ApiKeyBody, type ApiKeyConfigPatch, type ApiKeyPage, type ApiKeyPatch, type ApiKeyWithToken, type ApiKeysAPI, type ApiKeysConfig, type ApiKeysConfigPatchSchema, type ApiKeysPatchSchema, type CreateApiKeyHttpError, type CreateApiKeyHttpResponse, type DeleteApiKeyHttpError, type DeleteApiKeyHttpResponse, type Error, type Errors, type GetApiKeyConfigHttpError, type GetApiKeyConfigHttpResponse, type GetApiKeyHttpError, type GetApiKeyHttpResponse, type GetApiKeysHttpError, type GetApiKeysHttpResponse, type Link, type PatchApiKeyConfigHttpError, type PatchApiKeyConfigHttpResponse, type PatchApiKeyHttpError, type PatchApiKeyHttpResponse, clearCache, createApiKey, apiKeysExport as default, deleteApiKey, getApiKey, getApiKeyConfig, getApiKeys, patchApiKey, patchApiKeyConfig };
+export { type ApiKey, type ApiKeyBody, type ApiKeyConfigPatch, type ApiKeyPage, type ApiKeyPatch, type ApiKeyWithToken, type ApiKeysAPI, type ApiKeysConfig, type ApiKeysConfigPatchSchema, type ApiKeysPatchSchema, type CreateApiKeyHttpError, type CreateApiKeyHttpResponse, type DeleteApiKeyHttpError, type DeleteApiKeyHttpResponse, type Error, type Errors, type GetApiKeyHttpError, type GetApiKeyHttpResponse, type GetApiKeysConfigHttpError, type GetApiKeysConfigHttpResponse, type GetApiKeysHttpError, type GetApiKeysHttpResponse, type Link, type PatchApiKeyHttpError, type PatchApiKeyHttpResponse, type PatchApiKeysConfigHttpError, type PatchApiKeysConfigHttpResponse, clearCache, createApiKey, apiKeysExport as default, deleteApiKey, getApiKey, getApiKeys, getApiKeysConfig, patchApiKey, patchApiKeysConfig };

package/api-keys.d.ts

@@ -122,6 +122,7 @@ type ApiKeyPage = {
 };
 /**
  * Lists API keys for a given tenant ID.
+ *
  * @param query an object with query parameters
  * @throws GetApiKeysHttpError
  */
@@ -155,6 +156,7 @@ type GetApiKeysHttpError = {
 };
 /**
  * Creates an API key resource.
+ *
  * @param body an object with the body content
  * @throws CreateApiKeyHttpError
  */
@@ -171,39 +173,42 @@ type CreateApiKeyHttpError = {
 };
 /**
  * Gets the API keys configuration for a given tenant ID.
+ *
  * @param tenantId The tenant ID of the API keys configuration to be retrieved.
- * @throws GetApiKeyConfigHttpError
+ * @throws GetApiKeysConfigHttpError
  */
-declare const getApiKeyConfig: (tenantId: string, options?: ApiCallOptions) => Promise<GetApiKeyConfigHttpResponse>;
-type GetApiKeyConfigHttpResponse = {
+declare const getApiKeysConfig: (tenantId: string, options?: ApiCallOptions) => Promise<GetApiKeysConfigHttpResponse>;
+type GetApiKeysConfigHttpResponse = {
     data: ApiKeysConfig;
     headers: Headers;
     status: number;
 };
-type GetApiKeyConfigHttpError = {
+type GetApiKeysConfigHttpError = {
     data: Errors;
     headers: Headers;
     status: number;
 };
 /**
  * Updates the API keys configuration for a given tenant ID.
+ *
  * @param tenantId The tenant ID of the API keys configuration to be retrieved.
  * @param body an object with the body content
- * @throws PatchApiKeyConfigHttpError
+ * @throws PatchApiKeysConfigHttpError
  */
-declare const patchApiKeyConfig: (tenantId: string, body: ApiKeysConfigPatchSchema, options?: ApiCallOptions) => Promise<PatchApiKeyConfigHttpResponse>;
-type PatchApiKeyConfigHttpResponse = {
+declare const patchApiKeysConfig: (tenantId: string, body: ApiKeysConfigPatchSchema, options?: ApiCallOptions) => Promise<PatchApiKeysConfigHttpResponse>;
+type PatchApiKeysConfigHttpResponse = {
     data: void;
     headers: Headers;
     status: number;
 };
-type PatchApiKeyConfigHttpError = {
+type PatchApiKeysConfigHttpError = {
     data: Errors;
     headers: Headers;
     status: number;
 };
 /**
  * When the owner of the API key sends the request, the key will be removed. When a TenantAdmin sends the request, the key will be revoked.
+ *
  * @param id The ID of the API key resource to be retrieved.
  * @throws DeleteApiKeyHttpError
  */
@@ -220,6 +225,7 @@ type DeleteApiKeyHttpError = {
 };
 /**
  * Gets the API key for a given ID.
+ *
  * @param id The ID of the API key resource to be retrieved.
  * @throws GetApiKeyHttpError
  */
@@ -236,6 +242,7 @@ type GetApiKeyHttpError = {
 };
 /**
  * Updates an API key for a given ID.
+ *
  * @param id The ID of the API key resource to be updated.
  * @param body an object with the body content
  * @throws PatchApiKeyHttpError
@@ -258,43 +265,50 @@ declare function clearCache(): void;
 interface ApiKeysAPI {
     /**
      * Lists API keys for a given tenant ID.
+     *
      * @param query an object with query parameters
      * @throws GetApiKeysHttpError
      */
     getApiKeys: typeof getApiKeys;
     /**
      * Creates an API key resource.
+     *
      * @param body an object with the body content
      * @throws CreateApiKeyHttpError
      */
     createApiKey: typeof createApiKey;
     /**
      * Gets the API keys configuration for a given tenant ID.
+     *
      * @param tenantId The tenant ID of the API keys configuration to be retrieved.
-     * @throws GetApiKeyConfigHttpError
+     * @throws GetApiKeysConfigHttpError
      */
-    getApiKeyConfig: typeof getApiKeyConfig;
+    getApiKeysConfig: typeof getApiKeysConfig;
     /**
      * Updates the API keys configuration for a given tenant ID.
+     *
      * @param tenantId The tenant ID of the API keys configuration to be retrieved.
      * @param body an object with the body content
-     * @throws PatchApiKeyConfigHttpError
+     * @throws PatchApiKeysConfigHttpError
      */
-    patchApiKeyConfig: typeof patchApiKeyConfig;
+    patchApiKeysConfig: typeof patchApiKeysConfig;
     /**
      * When the owner of the API key sends the request, the key will be removed. When a TenantAdmin sends the request, the key will be revoked.
+     *
      * @param id The ID of the API key resource to be retrieved.
      * @throws DeleteApiKeyHttpError
      */
     deleteApiKey: typeof deleteApiKey;
     /**
      * Gets the API key for a given ID.
+     *
      * @param id The ID of the API key resource to be retrieved.
      * @throws GetApiKeyHttpError
      */
     getApiKey: typeof getApiKey;
     /**
      * Updates an API key for a given ID.
+     *
      * @param id The ID of the API key resource to be updated.
      * @param body an object with the body content
      * @throws PatchApiKeyHttpError
@@ -310,4 +324,4 @@ interface ApiKeysAPI {
  */
 declare const apiKeysExport: ApiKeysAPI;
 
-export { type ApiKey, type ApiKeyBody, type ApiKeyConfigPatch, type ApiKeyPage, type ApiKeyPatch, type ApiKeyWithToken, type ApiKeysAPI, type ApiKeysConfig, type ApiKeysConfigPatchSchema, type ApiKeysPatchSchema, type CreateApiKeyHttpError, type CreateApiKeyHttpResponse, type DeleteApiKeyHttpError, type DeleteApiKeyHttpResponse, type Error, type Errors, type GetApiKeyConfigHttpError, type GetApiKeyConfigHttpResponse, type GetApiKeyHttpError, type GetApiKeyHttpResponse, type GetApiKeysHttpError, type GetApiKeysHttpResponse, type Link, type PatchApiKeyConfigHttpError, type PatchApiKeyConfigHttpResponse, type PatchApiKeyHttpError, type PatchApiKeyHttpResponse, clearCache, createApiKey, apiKeysExport as default, deleteApiKey, getApiKey, getApiKeyConfig, getApiKeys, patchApiKey, patchApiKeyConfig };
+export { type ApiKey, type ApiKeyBody, type ApiKeyConfigPatch, type ApiKeyPage, type ApiKeyPatch, type ApiKeyWithToken, type ApiKeysAPI, type ApiKeysConfig, type ApiKeysConfigPatchSchema, type ApiKeysPatchSchema, type CreateApiKeyHttpError, type CreateApiKeyHttpResponse, type DeleteApiKeyHttpError, type DeleteApiKeyHttpResponse, type Error, type Errors, type GetApiKeyHttpError, type GetApiKeyHttpResponse, type GetApiKeysConfigHttpError, type GetApiKeysConfigHttpResponse, type GetApiKeysHttpError, type GetApiKeysHttpResponse, type Link, type PatchApiKeyHttpError, type PatchApiKeyHttpResponse, type PatchApiKeysConfigHttpError, type PatchApiKeysConfigHttpResponse, clearCache, createApiKey, apiKeysExport as default, deleteApiKey, getApiKey, getApiKeys, getApiKeysConfig, patchApiKey, patchApiKeysConfig };

package/api-keys.js

@@ -1,62 +1,66 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _chunkOULT3V2Ujs = require('./chunk-OULT3V2U.js');
-require('./chunk-ZT4C7KCQ.js');
+var _chunkJNGURO23js = require('./chunk-JNGURO23.js');
+require('./chunk-2STFUQKQ.js');
+require('./chunk-P57PW2II.js');
 
 // src/public/rest/api-keys.ts
-var getApiKeys = async (query, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "api-keys", {
+var getApiKeys = async (query, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "api-keys", {
   method: "get",
   pathTemplate: "/api/v1/api-keys",
   query,
   options
 });
-var createApiKey = async (body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "api-keys", {
+var createApiKey = async (body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "api-keys", {
   method: "post",
   pathTemplate: "/api/v1/api-keys",
   body,
+  contentType: "application/json",
   options
 });
-var getApiKeyConfig = async (tenantId, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "api-keys", {
+var getApiKeysConfig = async (tenantId, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "api-keys", {
   method: "get",
   pathTemplate: "/api/v1/api-keys/configs/{tenantId}",
   pathVariables: { tenantId },
   options
 });
-var patchApiKeyConfig = async (tenantId, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "api-keys", {
+var patchApiKeysConfig = async (tenantId, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "api-keys", {
   method: "patch",
   pathTemplate: "/api/v1/api-keys/configs/{tenantId}",
   pathVariables: { tenantId },
   body,
+  contentType: "application/json",
   options
 });
-var deleteApiKey = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "api-keys", {
+var deleteApiKey = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "api-keys", {
   method: "delete",
   pathTemplate: "/api/v1/api-keys/{id}",
   pathVariables: { id },
   options
 });
-var getApiKey = async (id, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "api-keys", {
+var getApiKey = async (id, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "api-keys", {
   method: "get",
   pathTemplate: "/api/v1/api-keys/{id}",
   pathVariables: { id },
   options
 });
-var patchApiKey = async (id, body, options) => _chunkOULT3V2Ujs.invokeFetch.call(void 0, "api-keys", {
+var patchApiKey = async (id, body, options) => _chunkJNGURO23js.invokeFetch.call(void 0, "api-keys", {
   method: "patch",
   pathTemplate: "/api/v1/api-keys/{id}",
   pathVariables: { id },
   body,
+  contentType: "application/json",
   options
 });
 function clearCache() {
-  return _chunkOULT3V2Ujs.clearApiCache.call(void 0, "api-keys");
+  return _chunkJNGURO23js.clearApiCache.call(void 0, "api-keys");
 }
 var apiKeysExport = {
   getApiKeys,
   createApiKey,
-  getApiKeyConfig,
-  patchApiKeyConfig,
+  getApiKeysConfig,
+  patchApiKeysConfig,
   deleteApiKey,
   getApiKey,
   patchApiKey,
@@ -73,4 +77,4 @@ var api_keys_default = apiKeysExport;
 
 
 
-exports.clearCache = clearCache; exports.createApiKey = createApiKey; exports.default = api_keys_default; exports.deleteApiKey = deleteApiKey; exports.getApiKey = getApiKey; exports.getApiKeyConfig = getApiKeyConfig; exports.getApiKeys = getApiKeys; exports.patchApiKey = patchApiKey; exports.patchApiKeyConfig = patchApiKeyConfig;
+exports.clearCache = clearCache; exports.createApiKey = createApiKey; exports.default = api_keys_default; exports.deleteApiKey = deleteApiKey; exports.getApiKey = getApiKey; exports.getApiKeys = getApiKeys; exports.getApiKeysConfig = getApiKeysConfig; exports.patchApiKey = patchApiKey; exports.patchApiKeysConfig = patchApiKeysConfig;

package/api-keys.mjs

@@ -1,8 +1,9 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunk-3YE7EI7I.mjs";
-import "./chunk-WM7FQU2U.mjs";
+} from "./chunk-TE7XMBT5.mjs";
+import "./chunk-3SVRHJII.mjs";
+import "./chunk-ZFXKCRJC.mjs";
 
 // src/public/rest/api-keys.ts
 var getApiKeys = async (query, options) => invokeFetch("api-keys", {
@@ -15,19 +16,21 @@ var createApiKey = async (body, options) => invokeFetch("api-keys", {
   method: "post",
   pathTemplate: "/api/v1/api-keys",
   body,
+  contentType: "application/json",
   options
 });
-var getApiKeyConfig = async (tenantId, options) => invokeFetch("api-keys", {
+var getApiKeysConfig = async (tenantId, options) => invokeFetch("api-keys", {
   method: "get",
   pathTemplate: "/api/v1/api-keys/configs/{tenantId}",
   pathVariables: { tenantId },
   options
 });
-var patchApiKeyConfig = async (tenantId, body, options) => invokeFetch("api-keys", {
+var patchApiKeysConfig = async (tenantId, body, options) => invokeFetch("api-keys", {
   method: "patch",
   pathTemplate: "/api/v1/api-keys/configs/{tenantId}",
   pathVariables: { tenantId },
   body,
+  contentType: "application/json",
   options
 });
 var deleteApiKey = async (id, options) => invokeFetch("api-keys", {
@@ -47,6 +50,7 @@ var patchApiKey = async (id, body, options) => invokeFetch("api-keys", {
   pathTemplate: "/api/v1/api-keys/{id}",
   pathVariables: { id },
   body,
+  contentType: "application/json",
   options
 });
 function clearCache() {
@@ -55,8 +59,8 @@ function clearCache() {
 var apiKeysExport = {
   getApiKeys,
   createApiKey,
-  getApiKeyConfig,
-  patchApiKeyConfig,
+  getApiKeysConfig,
+  patchApiKeysConfig,
   deleteApiKey,
   getApiKey,
   patchApiKey,
@@ -69,8 +73,8 @@ export {
   api_keys_default as default,
   deleteApiKey,
   getApiKey,
-  getApiKeyConfig,
   getApiKeys,
+  getApiKeysConfig,
   patchApiKey,
-  patchApiKeyConfig
+  patchApiKeysConfig
 };