@unchainedshop/cockpit-api 2.2.1 → 2.2.2

package/dist/client.d.ts

@@ -39,14 +39,14 @@ export interface CockpitAPIClient {
     /**
      * Get a transformed image asset URL.
      *
-     * **Important:** The `w` (width) or `h` (height) parameter is required by the API.
-     * Without it, the API returns a 400 error.
+     * **Important:** At least one of `w` (width) or `h` (height) must be provided.
+     * The Cockpit CMS API requires this and returns a 400 error without it.
      *
      * @param assetId - The asset ID
      * @param queryParams - Image transformation parameters (w or h required)
      * @returns URL string to the generated image, or null if not found
      */
-    imageAssetById(assetId: string, queryParams?: ImageAssetQueryParams): Promise<string | null>;
+    imageAssetById(assetId: string, queryParams: ImageAssetQueryParams): Promise<string | null>;
     getFullRouteForSlug(slug: string): Promise<string | undefined>;
     /**
      * Clear cache entries matching pattern

package/dist/methods/assets.d.ts

@@ -38,28 +38,38 @@ export declare enum MimeType {
     WEBP = "webp",
     BMP = "bmp"
 }
-export interface ImageAssetQueryParams {
+/**
+ * Image transformation parameters for imageAssetById.
+ *
+ * At least one of `w` (width) or `h` (height) must be provided.
+ * The Cockpit CMS API requires this and returns a 400 error without it.
+ */
+export type ImageAssetQueryParams = {
     m?: ImageSizeMode;
-    w?: number;
-    h?: number;
     q?: number;
     mime?: MimeType;
     re?: number;
     t?: string;
     o?: number;
-}
+} & ({
+    w: number;
+    h?: number;
+} | {
+    w?: number;
+    h: number;
+});
 export interface AssetMethods {
     assetById<T = CockpitAsset>(assetId: string): Promise<T | null>;
     /**
      * Get a transformed image asset URL.
      *
-     * **Important:** The `w` (width) or `h` (height) parameter is required by the API.
-     * Without it, the API returns a 400 error.
+     * **Important:** At least one of `w` (width) or `h` (height) must be provided.
+     * The Cockpit CMS API requires this and returns a 400 error without it.
      *
      * @param assetId - The asset ID
      * @param queryParams - Image transformation parameters (w or h required)
      * @returns URL string to the generated image, or null if not found
      */
-    imageAssetById(assetId: string, queryParams?: ImageAssetQueryParams): Promise<string | null>;
+    imageAssetById(assetId: string, queryParams: ImageAssetQueryParams): Promise<string | null>;
 }
 export declare function createAssetMethods(ctx: MethodContext): AssetMethods;

package/dist/methods/pages.js

@@ -12,6 +12,9 @@ export function createPagesMethods(ctx) {
             });
             const result = await ctx.http.fetch(url);
             // Normalize response to always return { data, meta? }
+            // Note: The Cockpit /api/pages/pages endpoint returns a raw array even when skip
+            // is provided, unlike /api/content/items/{model} which returns { data, meta }.
+            // This means meta.total will not be available for pages() method.
             if (result === null) {
                 return null;
             }

package/dist/methods/routes.d.ts

@@ -28,7 +28,7 @@ export interface CockpitSettings {
         logo?: CockpitAsset | null;
         small?: CockpitAsset | null;
         favicon?: CockpitAsset | null;
-        [key: string]: CockpitAsset | null | undefined;
+        [key: string]: CockpitAsset | null;
     };
     scripts?: {
         header?: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unchainedshop/cockpit-api",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "A package to interact with the Cockpit CMS API, including functionalities to handle GraphQL requests and various CMS content manipulations.",
   "main": "dist/index.js",
   "homepage": "https://unchained.shop",