@wix/himalaya-cli 0.1036.0 → 0.1037.0

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/_types/stdlib/wix-sdk/portfolio/src/index.d.ts

@@ -5,12 +5,36 @@ declare global {
         };
     };
 }
+/** A Wix Portfolio media image — a project / collection cover or a project item's image. */
+export interface WixMediaImage {
+    type?: string;
+    imageInfo?: {
+        id?: string;
+        url?: string;
+        width?: number;
+        height?: number;
+    };
+}
+/**
+ * The Wix media reference of a Portfolio cover or item image — its `imageInfo.url`, else
+ * its `imageInfo.id` — for `wixMediaUrl` to resolve and size. `""` when there is none.
+ * A bare string is still accepted, so a cover stored as a url string keeps rendering.
+ *
+ * @example
+ * const image = wixMediaUrl(portfolioCoverRef(project.coverImage));
+ */
+export declare function portfolioCoverRef(cover: WixMediaImage | string | null | undefined): string;
 export interface WixPortfolioProject {
     id: string;
     title?: string;
     description?: string;
-    /** Project cover. coverImage is a Wix media url/id. */
-    coverImage?: string;
+    /**
+     * Project cover. The live wire shape is a media OBJECT
+     * (`{type:"WIX_MEDIA", imageInfo:{id,url,width,height}}`), not a url string —
+     * read it with {@link portfolioCoverRef}; `wixMediaUrl` returns `""` for the object.
+     * A url string is still accepted, for projects constructed by hand.
+     */
+    coverImage?: WixMediaImage | string;
     slug?: string;
     hidden?: boolean;
     createdDate?: string;
@@ -28,12 +52,6 @@ export interface WixListProjectsResponse {
 }
 /** GET /portfolio/v1/projects — list projects (paged). */
 export declare function listProjects(limit?: number, cursor?: string): Promise<WixListProjectsResponse>;
-export interface WixMediaImage {
-    imageInfo?: {
-        id?: string;
-        url?: string;
-    };
-}
 export interface WixPortfolioCollection {
     id: string;
     title?: string;
@@ -72,6 +90,10 @@ export interface WixPortfolioProjectItem {
 }
 export interface WixListProjectItemsResponse {
     items?: WixPortfolioProjectItem[];
+    /**
+     * Paging, under the name this function always documented. A Wix query reports it as
+     * `metadata`; {@link listProjectItems} copies that here when `pagingMetadata` is absent.
+     */
     pagingMetadata?: {
         count?: number;
         cursors?: {
@@ -79,6 +101,21 @@ export interface WixListProjectItemsResponse {
         };
         hasNext?: boolean;
     };
+    /** The query endpoint's own name for the paging block. */
+    metadata?: {
+        count?: number;
+        cursors?: {
+            next?: string;
+        };
+        hasNext?: boolean;
+    };
 }
-/** GET /portfolio/v1/projects/{projectId}/items — list a project's items. */
+/**
+ * POST /portfolio/v1/items/query — list a project's items.
+ *
+ * A first page filters on `projectId` with `paging.limit`. Passing a `cursor` (a previous
+ * page's `pagingMetadata.cursors.next`) switches to `cursorPaging` and drops the filter,
+ * because a Wix query cursor already carries it. Items come back in the order Wix returns
+ * them — sort on `sortOrder` for the author's order.
+ */
 export declare function listProjectItems(projectId: string, limit?: number, cursor?: string): Promise<WixListProjectItemsResponse>;

package/dist/authoring-runtime/node_modules/@wix/himalaya/dist/wix-portfolio.mjs

@@ -10,6 +10,14 @@ function wixCall(method, path, body) {
   }
   return globalThis.himalaya.wixApi.call(method, path, body);
 }
+function portfolioCoverRef(cover) {
+  if (typeof cover === "string") return cover.trim();
+  if (!cover || typeof cover !== "object") return "";
+  const info = cover.imageInfo;
+  const url = typeof info?.url === "string" ? info.url.trim() : "";
+  if (url) return url;
+  return typeof info?.id === "string" ? info.id.trim() : "";
+}
 function listProjects(limit = 100, cursor) {
   return wixCall("GET", `/portfolio/v1/projects?${pagingQuery(limit, cursor)}`);
 }
@@ -17,11 +25,15 @@ function listCollections(limit = 100, cursor) {
   return wixCall("GET", `/portfolio/v1/collections?${pagingQuery(limit, cursor)}`);
 }
 function listProjectItems(projectId, limit = 100, cursor) {
-  return wixCall("GET", `/portfolio/v1/projects/${encodeURIComponent(projectId)}/items?${pagingQuery(limit, cursor)}`);
+  const query = cursor ? { cursorPaging: { limit, cursor } } : { filter: { projectId }, paging: { limit } };
+  return wixCall("POST", "/portfolio/v1/items/query", { query }).then(
+    (response) => response && !response.pagingMetadata && response.metadata ? { ...response, pagingMetadata: response.metadata } : response
+  );
 }
 export {
   listCollections,
   listProjectItems,
-  listProjects
+  listProjects,
+  portfolioCoverRef
 };
 //# sourceMappingURL=wix-portfolio.mjs.map