@qlik/api 1.17.0 → 1.18.0

package/api-keys.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type ApiKey = {
     /** When the API key was created. */

package/api-keys.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/2NXPFUPZ.js";
+import "./chunks/ZLPAS7FC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/api-keys.ts

package/apps.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions, D as DownloadableBlob } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions, D as DownloadableBlob } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type Analysis = "breakdown" | "changePoint" | "comparison" | "contribution" | "correlation" | "fact" | "mutualInfo" | "rank" | "spike" | "trend" | "values";
 type AnalysisComposition = {
@@ -696,7 +696,7 @@ type NxAttributes = {
     /** The Origin App ID for published apps. */
     originAppId?: string;
     /** @deprecated
-     * Deprecated. Use user api to fetch user metadata. */
+     * Deprecated. Use the Users API to fetch user metadata. */
     owner?: string;
     /** Identifier of the app owner. */
     ownerId?: string;
@@ -985,7 +985,7 @@ type UpdateOwner = {
 type UpdateSpace = {
     spaceId?: string;
 };
-type UsageEnum = "ANALYTICS" | "DATA_PREPARATION" | "DATAFLOW_PREP";
+type UsageEnum = "ANALYTICS" | "DATA_PREPARATION" | "DATAFLOW_PREP" | "SINGLE_TABLE_PREP";
 type UserPrivileges = "can_create_app" | "can_import_app" | "can_create_session_app";
 type Classification = {
     absoluteDiff?: number;

package/apps.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/2NXPFUPZ.js";
+import "./chunks/ZLPAS7FC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/apps.ts

package/audits.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type ErrorResponse = {
     errors?: {

package/audits.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/2NXPFUPZ.js";
+import "./chunks/ZLPAS7FC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/audits.ts

package/{auth-types-BU5EGt_9.d.ts → auth-types-PkN9CAF_.d.ts}

@@ -98,6 +98,9 @@ type HostConfigCommon = {
      * Optional parameter that can be used to point to a Qlik Cloud tenant domain from which the embed runtime should be loaded. If omitted the host parameter will be used.
      */
     embedRuntimeUrl?: string;
+    onAuthFailed?: (props: {
+        message: string;
+    }) => unknown;
 };
 
 export type { AuthType as A, Credentials as C, GetRestCallAuthParamsProps as G, HostConfig as H, RestCallAuthParams as R, WebSocketAuthParams as W, AuthModule as a, GetWebSocketAuthParamsProps as b, GetWebResourceAuthParamsProps as c, WebResourceAuthParams as d, GetRemoteAuthDataProps as e, HandleAuthenticationErrorProps as f, AuthenticationErrorAction as g };

package/auth.d.ts

@@ -1,5 +1,5 @@
-import { A as AuthType, a as AuthModule, H as HostConfig } from './auth-types-BU5EGt_9.js';
-export { g as AuthenticationErrorAction, C as Credentials, e as GetRemoteAuthDataProps, G as GetRestCallAuthParamsProps, c as GetWebResourceAuthParamsProps, b as GetWebSocketAuthParamsProps, f as HandleAuthenticationErrorProps, R as RestCallAuthParams, d as WebResourceAuthParams, W as WebSocketAuthParams } from './auth-types-BU5EGt_9.js';
+import { A as AuthType, a as AuthModule, H as HostConfig } from './auth-types-PkN9CAF_.js';
+export { g as AuthenticationErrorAction, C as Credentials, e as GetRemoteAuthDataProps, G as GetRestCallAuthParamsProps, c as GetWebResourceAuthParamsProps, b as GetWebSocketAuthParamsProps, f as HandleAuthenticationErrorProps, R as RestCallAuthParams, d as WebResourceAuthParams, W as WebSocketAuthParams } from './auth-types-PkN9CAF_.js';
 
 /**
  * Registers an auth module that can handle authentication. An auth module is used by specifying its name as authType in the HostConfig passed in to api calls.

package/auth.js

@@ -4,8 +4,8 @@ import {
   logout,
   registerAuthModule,
   setDefaultHostConfig
-} from "./chunks/AVML2WPM.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/H7WWFWBM.js";
+import "./chunks/ZLPAS7FC.js";
 export {
   auth_default as default,
   getAccessToken,

package/automations.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type AutomationDetailRequestObject = {
     description?: string;

package/automations.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/2NXPFUPZ.js";
+import "./chunks/ZLPAS7FC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/automations.ts

package/brands.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions, D as DownloadableBlob } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions, D as DownloadableBlob } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 /**
  * A brand is a collection of assets for applying custom branding. Only a single brand can be active in a tenant.

package/brands.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/2NXPFUPZ.js";
+import "./chunks/ZLPAS7FC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/brands.ts

package/chunks/{RWQS4ASJ.js → 2B3EPESP.js}

@@ -18,7 +18,7 @@ import {
   toValidEnigmaLocationUrl,
   toValidLocationUrl,
   toValidWebsocketLocationUrl
-} from "./HFUVFYT4.js";
+} from "./YEHZGXQV.js";
 import "./2ZQ3ZX7F.js";
 export {
   AuthorizationError,

package/chunks/{5W53XSXH.js → 2NXPFUPZ.js}

@@ -1,12 +1,12 @@
 import {
   getInvokeFetchRuntimeModule
-} from "./NJRTJEAQ.js";
+} from "./ZLPAS7FC.js";
 import {
   isBrowser
 } from "./2ZQ3ZX7F.js";
 
 // src/public/invoke-fetch.ts
-var defaultUserAgent = "qlik-api/1.17.0";
+var defaultUserAgent = "qlik-api/1.18.0";
 async function invokeFetch(api, props) {
   const hostConfig = props.options?.hostConfig;
   let userAgent;

package/chunks/{6MPNTVLD.js → 4FZ45I6G.js}

@@ -4,7 +4,7 @@ import {
   getRestCallAuthParams,
   getWebSocketAuthParams,
   toValidWebsocketLocationUrl
-} from "./HFUVFYT4.js";
+} from "./YEHZGXQV.js";
 import {
   isBrowser,
   isNode

package/chunks/{JBH4H34J.js → GKEPTI44.js}

@@ -1,6 +1,6 @@
 import {
   getQixRuntimeModule
-} from "./NJRTJEAQ.js";
+} from "./ZLPAS7FC.js";
 
 // src/public/qix.ts
 function openAppSession(appSessionProps) {

package/chunks/{AVML2WPM.js → H7WWFWBM.js}

@@ -1,6 +1,6 @@
 import {
   getAuthRuntimeModule
-} from "./NJRTJEAQ.js";
+} from "./ZLPAS7FC.js";
 
 // src/public/auth.ts
 function registerAuthModule(name, authModule) {

package/chunks/{S5OMX5JT.js → QLFOH4GP.js}

@@ -4,11 +4,55 @@ import {
   invokeFetch,
   isWindows,
   toValidWebsocketLocationUrl
-} from "./HFUVFYT4.js";
+} from "./YEHZGXQV.js";
 import {
   isBrowser
 } from "./2ZQ3ZX7F.js";
 
+// src/qix/session/websocket-errors.ts
+var closeCodeEngineTerminating = 4003;
+var closeCodeEngineAbnormalClosure = 1006;
+var closeCodeEngineProxyGeneric = 4200;
+var closeCodeClientTimeout = 4201;
+var closeCodeBadRequest = 4202;
+var closeCodePermissions = 4203;
+var closeCodeNotFound = 4204;
+var closeCodeTooManyRequests = 4205;
+var closeCodeNetwork = 4206;
+var closeCodeDependencyGeneric = 4210;
+var closeCodeDependencyUnavailable = 4211;
+var closeCodeEngineGeneric = 4220;
+var closeCodeEntitlement = 4230;
+var closeCodeNoEnginesAvailable = 4240;
+var CloseCodeSessionReservationMissing = 4222;
+var closeCodeMessages = {
+  [closeCodeEngineTerminating]: "The engine is in terminating state",
+  [closeCodeEngineAbnormalClosure]: "The engine is abnormally closed",
+  [closeCodeEngineProxyGeneric]: "A problem occurred in engine-proxy",
+  [closeCodeClientTimeout]: "The client has closed the connection",
+  [closeCodeBadRequest]: "The provided request is invalid and/or malformed",
+  [closeCodePermissions]: "No permission to open the app",
+  [closeCodeNotFound]: "App not found",
+  [closeCodeTooManyRequests]: "Too many requests have been sent in a given amount of time",
+  [closeCodeNetwork]: "Networking issues",
+  [closeCodeDependencyGeneric]: "A problem occurred in a dependency of engine-proxy",
+  [closeCodeDependencyUnavailable]: "A dependency is unavailable and not serving any requests",
+  [closeCodeEngineGeneric]: "A problem occurred in an engine",
+  [closeCodeEntitlement]: "You are not entitled to perform that operation",
+  [closeCodeNoEnginesAvailable]: "There are currently no engines available",
+  [CloseCodeSessionReservationMissing]: "The reserved session is missing"
+};
+var uknownCloseErrorMessage = "websocket closed for unknown reason";
+function getHumanReadableSocketClosedErrorMessage(err, { appId, hostConfig }) {
+  const closeCode = err?.original?.code;
+  const closeMessage = closeCode ? closeCodeMessages[closeCode] || uknownCloseErrorMessage : err.message;
+  if (hostConfig?.host) {
+    return `Failed to open app ${appId} on ${hostConfig?.host}: ${closeMessage}`;
+  } else {
+    return `Failed to open app ${appId}: ${closeMessage}`;
+  }
+}
+
 // src/qix/session/shared-sessions.ts
 var globalEventListeners = /* @__PURE__ */ new Set();
 function globalOnWebSocketEvent(listener) {
@@ -101,7 +145,7 @@ function listenForWindowsAuthenticationInformation(session) {
   return authSuggestedInWebsocket;
 }
 async function createAndSetupEnigmaSession(props, canRetry) {
-  const { createEnigmaSession } = await import("./6MPNTVLD.js");
+  const { createEnigmaSession } = await import("./4FZ45I6G.js");
   const session = await createEnigmaSession(props);
   setupSessionListeners(session, props);
   let global;
@@ -327,7 +371,8 @@ function createSharedSession(props) {
   const clients = [];
   function closeEnigmaSession() {
     delete sharedSessions[key];
-    return sharedSession.sessionPromise.then((session) => session.close());
+    return sharedSession.sessionPromise.then((session) => session.close()).catch(() => {
+    });
   }
   const sharedSession = {
     sessionPromise,
@@ -380,7 +425,11 @@ function createSharedSession(props) {
   });
   sharedSession.docPromise = sharedSession.docPromise.catch((err) => {
     closeEnigmaSession();
-    return Promise.reject(err);
+    const errorWithReadableMessage = new Error(getHumanReadableSocketClosedErrorMessage(err, props));
+    Object.entries(err).forEach(([key2, value]) => {
+      errorWithReadableMessage[key2] = value;
+    });
+    return Promise.reject(errorWithReadableMessage);
   });
   return sharedSession;
 }

package/chunks/{NJFCE5EM.js → URFSYYRS.js}

@@ -5,7 +5,7 @@ import {
   invokeFetch,
   invoke_fetch_default,
   parseFetchResponse
-} from "./HFUVFYT4.js";
+} from "./YEHZGXQV.js";
 import "./2ZQ3ZX7F.js";
 export {
   EncodingError,

package/chunks/{HFUVFYT4.js → YEHZGXQV.js}

@@ -188,23 +188,33 @@ var InvalidAuthTypeError = class extends Error {
     this.name = "InvalidAuthTypeError";
   }
 };
+function errorToString({ title, detail, code, status }) {
+  if (detail) {
+    return `${title} - ${detail} (Status: ${status}, Code: ${code})`;
+  }
+  return `${title} (Status: ${status}, Code: ${code})`;
+}
 var AuthorizationError = class extends Error {
+  errors;
   constructor(errors) {
+    if (typeof errors !== "object") {
+      super("Unknown error");
+      return;
+    }
     const errorArray = Array.isArray(errors) ? errors : [errors];
-    super(
-      errorArray.map(
-        (error) => `
-Code: ${error.code}
-Status: ${error.status}
-${error.title}:
-${error.detail}
-`
-      ).join(",\n")
-    );
+    super(errorArray.map(errorToString).join(", "));
+    this.errors = errorArray;
   }
 };
 
 // src/auth/auth-functions.ts
+var lastErrorMessage = "";
+function logToConsole({ message }) {
+  if (message !== lastErrorMessage) {
+    lastErrorMessage = message;
+    console.error(message);
+  }
+}
 function isHostCrossOrigin(hostConfig) {
   if (!globalThis.location?.origin) {
     return true;
@@ -265,31 +275,57 @@ function toValidWebsocketLocationUrl(hostConfig) {
 }
 async function getWebSocketAuthParams(props) {
   const hostConfigToUse = withDefaultHostConfig(props.hostConfig);
-  return (await getAuthModule(hostConfigToUse)).getWebSocketAuthParams({
-    ...props,
-    hostConfig: hostConfigToUse
-  });
+  try {
+    const authModule = await getAuthModule(hostConfigToUse);
+    return await authModule.getWebSocketAuthParams({
+      ...props,
+      hostConfig: hostConfigToUse
+    });
+  } catch (err) {
+    (hostConfigToUse.onAuthFailed || logToConsole)(normalizeAuthModuleError(err));
+    throw err;
+  }
 }
 async function getWebResourceAuthParams(props) {
   const hostConfigToUse = withDefaultHostConfig(props.hostConfig);
-  return (await getAuthModule(hostConfigToUse)).getWebResourceAuthParams?.({
-    ...props,
-    hostConfig: hostConfigToUse
-  }) || { queryParams: {} };
+  try {
+    const authModule = await getAuthModule(hostConfigToUse);
+    return await authModule.getWebResourceAuthParams?.({
+      ...props,
+      hostConfig: hostConfigToUse
+    }) || { queryParams: {} };
+  } catch (err) {
+    (hostConfigToUse.onAuthFailed || logToConsole)(normalizeAuthModuleError(err));
+    throw err;
+  }
 }
 async function handleAuthenticationError(props) {
   const hostConfigToUse = withDefaultHostConfig(props.hostConfig);
-  return (await getAuthModule(hostConfigToUse)).handleAuthenticationError({
+  const authModule = await getAuthModule(hostConfigToUse);
+  const result2 = await authModule.handleAuthenticationError({
     ...props,
     hostConfig: hostConfigToUse
   });
+  const willRetry = props.canRetry && result2.retry;
+  const willHangUntilANewPageIsLoaded = result2.preventDefault;
+  if (!willRetry && !willHangUntilANewPageIsLoaded) {
+    const { status, errorBody } = props;
+    (hostConfigToUse.onAuthFailed || logToConsole)(normalizeInbandAuthError({ status, errorBody }));
+  }
+  return result2;
 }
 async function getRestCallAuthParams(props) {
   const hostConfigToUse = withDefaultHostConfig(props.hostConfig);
-  return (await getAuthModule(hostConfigToUse)).getRestCallAuthParams({
-    ...props,
-    hostConfig: hostConfigToUse
-  });
+  try {
+    const authModule = await getAuthModule(hostConfigToUse);
+    return await authModule.getRestCallAuthParams({
+      ...props,
+      hostConfig: hostConfigToUse
+    });
+  } catch (err) {
+    (hostConfigToUse.onAuthFailed || logToConsole)(normalizeAuthModuleError(err));
+    throw err;
+  }
 }
 async function getAccessToken(props) {
   const res = await getRestCallAuthParams({ method: "GET", ...props });
@@ -321,6 +357,17 @@ var logout = () => {
   globalThis.location.href = "/logout";
 };
 var leadingHttp = /^http/;
+function normalizeInbandAuthError({ errorBody, status }) {
+  const authError = errorBody;
+  if (typeof authError?.errors === "object") {
+    const err = new AuthorizationError(authError?.errors);
+    return { message: err.message };
+  }
+  return { message: `HTTP ${status}` };
+}
+function normalizeAuthModuleError(err) {
+  return { message: err.message || "Unknown error" };
+}
 
 // src/random/random.ts
 import { customAlphabet, nanoid } from "nanoid";
@@ -359,6 +406,7 @@ function internalValidateHostConfig(hostConfig, options) {
     "authRedirectUserConfirmation",
     "embedRuntimeUrl",
     "host",
+    "onAuthFailed",
     ...options.requiredProps,
     ...options.optionalProps
   ];
@@ -652,7 +700,7 @@ async function getOauthTokensWithRefreshToken(baseUrl, refreshToken, clientSecre
   };
 }
 async function getAnonymousOauthAccessToken(baseUrl, accessCode, clientId, trackingCode) {
-  const result2 = await fetch(`${baseUrl}/oauth/token`, {
+  const result2 = await fetch(`${baseUrl}/oauth/token/anonymous-embed`, {
     method: "POST",
     mode: "cors",
     headers: { "content-type": "application/json" },

package/chunks/{NJRTJEAQ.js → ZLPAS7FC.js}

@@ -1,21 +1,21 @@
 // src/public/public-runtime-modules.ts
 function getAuthRuntimeModule(hostConfig) {
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./RWQS4ASJ.js") : import("./GLS4DAZ4.js").then(
+  return isNode ? import("./2B3EPESP.js") : import("./GLS4DAZ4.js").then(
     (mod) => mod.importRuntimeModule("auth@v1", hostConfig)
   );
 }
 async function getQixRuntimeModule(hostConfig) {
   await getAuthRuntimeModule(hostConfig);
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./S5OMX5JT.js") : import("./GLS4DAZ4.js").then(
+  return isNode ? import("./QLFOH4GP.js") : import("./GLS4DAZ4.js").then(
     (mod) => mod.importRuntimeModule("qix@v1", hostConfig)
   );
 }
 async function getInvokeFetchRuntimeModule(hostConfig) {
   await getAuthRuntimeModule(hostConfig);
   const isNode = !!globalThis.process?.argv;
-  return isNode ? import("./NJFCE5EM.js") : import("./GLS4DAZ4.js").then(
+  return isNode ? import("./URFSYYRS.js") : import("./GLS4DAZ4.js").then(
     (mod) => mod.importRuntimeModule("invoke-fetch@v1", hostConfig)
   );
 }

package/collections.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type CollectionByIdPatch = {
     /** The operation to be performed. */
@@ -19,6 +19,7 @@ type CollectionsAddCollectionItemRequestBody = {
 };
 type CollectionsCreateCollectionRequestBody = {
     description?: string;
+    /** For `public` collections (tags), if name already exists in the tenant as a `public` collection, this call will fail with a `409` response. */
     name: string;
     type: CollectionTypes;
 };
@@ -233,7 +234,7 @@ type Meta = {
     timeout?: boolean;
 };
 /**
- * Finds and returns the collections that the user can access. This endpoint does not return the user's favorites collection.
+ * Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with `/v1/collections/favorites`.
  *
  * @param query an object with query parameters
  * @throws GetCollectionsHttpError
@@ -261,7 +262,7 @@ declare const getCollections: (query: {
      * must be prefixed by + or - to indicate ascending or descending sort order
      * respectively. */
     sort?: "+createdAt" | "-createdAt" | "+name" | "-name" | "+updatedAt" | "-updatedAt";
-    /** The case-sensitive string used to filter for a collection by type. */
+    /** The case-sensitive string used to filter for a collection by type. Retrieve private collections with `private`, public collections with `publicgoverned`, and tags with `public`. */
     type?: CollectionTypes;
     /** A commaseparated case-sensitive string used to filter by multiple types. */
     types?: CollectionTypes[];
@@ -279,7 +280,7 @@ type GetCollectionsHttpError = {
     status: number;
 };
 /**
- * Creates and returns a new collection. Collections can have the same name.
+ * Creates and returns a new collection. Collections of type `public` (shown as tags in the user interface) must have unique names. Other collection types can reuse names.
  *
  * @param body an object with the body content
  * @throws CreateCollectionHttpError
@@ -296,7 +297,7 @@ type CreateCollectionHttpError = {
     status: number;
 };
 /**
- * Finds and returns the user's favorites collection.
+ * Lists the user's favorites collection.
  *
  * @throws GetFavoritesCollectionHttpError
  */
@@ -346,7 +347,7 @@ type GetCollectionHttpError = {
     status: number;
 };
 /**
- * Updates the collection fields provided in the patch body.
+ * Updates the name, description, or type fields provided in the patch body. Can be used to publish a `private` collection as a `publicgoverned` collection by patching `/type` with `publicgoverned` once the collection contains at least 1 item. Can also be used to return a `publicgoverned` collection to `private`. Cannot be used to change between `public` (tag) and `private / publicgoverned` (collection).
  *
  * @param collectionId The collection's unique identifier.
  * @param body an object with the body content
@@ -364,7 +365,7 @@ type PatchCollectionHttpError = {
     status: number;
 };
 /**
- * Updates a collection and returns the new collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
+ * Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
  *
  * @param collectionId The collection's unique identifier.
  * @param body an object with the body content
@@ -382,7 +383,7 @@ type UpdateCollectionHttpError = {
     status: number;
 };
 /**
- * Finds and returns items from a collection that the user has access to.
+ * Retrieves items from a collection that the user has access to.
  *
  * @param collectionId The collection's unique identifier. (This query also supports 'favorites' as the collectionID).
 
@@ -463,7 +464,7 @@ type DeleteCollectionItemHttpError = {
     status: number;
 };
 /**
- * Finds and returns an item. See GET /items/{id}
+ * Finds and returns an item in a specific collection. See GET `/items/{id}`.
  *
  * @param collectionId The collection's unique identifier.
  * @param itemId The item's unique identifier.
@@ -486,21 +487,21 @@ type GetCollectionItemHttpError = {
 declare function clearCache(): void;
 interface CollectionsAPI {
     /**
-     * Finds and returns the collections that the user can access. This endpoint does not return the user's favorites collection.
+     * Retrieves the collections that the user has access to. This endpoint does not return the user's favorites collection, which can be retrieved with `/v1/collections/favorites`.
      *
      * @param query an object with query parameters
      * @throws GetCollectionsHttpError
      */
     getCollections: typeof getCollections;
     /**
-     * Creates and returns a new collection. Collections can have the same name.
+     * Creates and returns a new collection. Collections of type `public` (shown as tags in the user interface) must have unique names. Other collection types can reuse names.
      *
      * @param body an object with the body content
      * @throws CreateCollectionHttpError
      */
     createCollection: typeof createCollection;
     /**
-     * Finds and returns the user's favorites collection.
+     * Lists the user's favorites collection.
      *
      * @throws GetFavoritesCollectionHttpError
      */
@@ -520,7 +521,7 @@ interface CollectionsAPI {
      */
     getCollection: typeof getCollection;
     /**
-     * Updates the collection fields provided in the patch body.
+     * Updates the name, description, or type fields provided in the patch body. Can be used to publish a `private` collection as a `publicgoverned` collection by patching `/type` with `publicgoverned` once the collection contains at least 1 item. Can also be used to return a `publicgoverned` collection to `private`. Cannot be used to change between `public` (tag) and `private / publicgoverned` (collection).
      *
      * @param collectionId The collection's unique identifier.
      * @param body an object with the body content
@@ -528,7 +529,7 @@ interface CollectionsAPI {
      */
     patchCollection: typeof patchCollection;
     /**
-     * Updates a collection and returns the new collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
+     * Updates a collection's name and description and returns the updated collection. Omitted and unsupported fields are ignored. To unset a field, provide the field's zero value.
      *
      * @param collectionId The collection's unique identifier.
      * @param body an object with the body content
@@ -536,7 +537,7 @@ interface CollectionsAPI {
      */
     updateCollection: typeof updateCollection;
     /**
-     * Finds and returns items from a collection that the user has access to.
+     * Retrieves items from a collection that the user has access to.
      *
      * @param collectionId The collection's unique identifier. (This query also supports 'favorites' as the collectionID).
   
@@ -561,7 +562,7 @@ interface CollectionsAPI {
      */
     deleteCollectionItem: typeof deleteCollectionItem;
     /**
-     * Finds and returns an item. See GET /items/{id}
+     * Finds and returns an item in a specific collection. See GET `/items/{id}`.
      *
      * @param collectionId The collection's unique identifier.
      * @param itemId The item's unique identifier.

package/collections.js

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/5W53XSXH.js";
-import "./chunks/NJRTJEAQ.js";
+} from "./chunks/2NXPFUPZ.js";
+import "./chunks/ZLPAS7FC.js";
 import "./chunks/2ZQ3ZX7F.js";
 
 // src/public/rest/collections.ts

package/csp-origins.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiCallOptions } from './global.types-BU2Yugjm.js';
-import './auth-types-BU5EGt_9.js';
+import { A as ApiCallOptions } from './global.types--37uwGji.js';
+import './auth-types-PkN9CAF_.js';
 
 type CSPEntry = {
     /** The CSP entry's unique identifier. */