@wix/himalaya-cli 0.1535.0 → 0.1537.0

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

@@ -7,18 +7,30 @@ function wixCall(method, path, body) {
   }
   return globalThis.himalaya.wixApi.call(method, path, body);
 }
-function queryDataItems(dataCollectionId, limit = 50, filter, returnTotalCount = false, offset = 0, sort) {
+function queryDataItems(dataCollectionId, limit = 50, filter, returnTotalCount = false, offset = 0, sort, options) {
   if (!dataCollectionId) throw new Error("queryDataItems: dataCollectionId is required");
+  const cursor = options?.cursorPaging;
+  if (cursor && offset) {
+    throw new Error("queryDataItems: offset and options.cursorPaging are mutually exclusive \u2014 page one way");
+  }
+  const followUp = !!cursor?.cursor;
   const body = {
     dataCollectionId,
     query: {
       // `offset` is omitted when 0 so a caller that does not page sends the byte-identical
       // body it sent before this parameter existed.
-      paging: { limit, ...offset ? { offset } : {} },
-      ...filter ? { filter } : {},
-      ...sort?.length ? { sort: sort.map((k) => ({ fieldName: k.fieldName, order: k.order ?? "ASC" })) } : {}
+      ...cursor ? { cursorPaging: { limit: cursor.limit ?? limit, ...cursor.cursor ? { cursor: cursor.cursor } : {} } } : { paging: { limit, ...offset ? { offset } : {} } },
+      ...filter && !followUp ? { filter } : {},
+      ...sort?.length && !followUp ? { sort: sort.map((k) => ({ fieldName: k.fieldName, order: k.order ?? "ASC" })) } : {},
+      ...options?.fields?.length ? { fields: options.fields } : {}
     },
-    ...returnTotalCount ? { returnTotalCount: true } : {}
+    ...returnTotalCount && !followUp ? { returnTotalCount: true } : {},
+    // Each of these is appended only when set: an absent option leaves the body exactly as it
+    // was before the option existed, so recorded net-mocks and fixtures keep matching.
+    ...options?.consistentRead ? { consistentRead: true } : {},
+    ...options?.includeReferences?.length ? { includeReferences: options.includeReferences } : {},
+    ...options?.language ? { language: options.language } : {},
+    ...options?.includeDraftItems ? { publishPluginOptions: { includeDraftItems: true } } : {}
   };
   return wixCall("POST", "/wix-data/v2/items/query", body);
 }
@@ -30,13 +42,30 @@ function getDataItem(dataCollectionId, dataItemId) {
     `/wix-data/v2/items/${encodeURIComponent(dataItemId)}?dataCollectionId=${encodeURIComponent(dataCollectionId)}`
   );
 }
-function insertDataItem(dataCollectionId, data) {
+function insertDataItem(dataCollectionId, data, options) {
   if (!dataCollectionId) throw new Error("insertDataItem: dataCollectionId is required");
   return wixCall("POST", "/wix-data/v2/items", {
     dataCollectionId,
-    dataItem: { data }
+    dataItem: itemEnvelope("insertDataItem", data, options?.id)
   });
 }
+var MAX_ITEM_ID = 128;
+function itemEnvelope(fn, data, id, at) {
+  const idName = at ? `${at}.id` : "options.id";
+  const dataId = at ? `${at}.data._id` : "data._id";
+  if (id === void 0) {
+    if (data._id === void 0) return { data };
+    if (typeof data._id !== "string" || !data._id) throw new Error(`${fn}: ${dataId} must be a non-empty string`);
+    if (data._id.length > MAX_ITEM_ID) throw new Error(`${fn}: ${dataId} is at most ${MAX_ITEM_ID} characters (got ${data._id.length})`);
+    return { id: data._id, data };
+  }
+  if (!id) throw new Error(`${fn}: ${idName} must not be empty`);
+  if (id.length > MAX_ITEM_ID) throw new Error(`${fn}: ${idName} is at most ${MAX_ITEM_ID} characters (got ${id.length})`);
+  if (data._id !== void 0 && data._id !== id) {
+    throw new Error(`${fn}: ${dataId} must match ${idName} (or be left out)`);
+  }
+  return { id, data };
+}
 function updateDataItem(dataCollectionId, id, data) {
   if (!dataCollectionId || !id) throw new Error("updateDataItem: dataCollectionId and id are required");
   return wixCall("PUT", `/wix-data/v2/items/${encodeURIComponent(id)}`, {
@@ -49,11 +78,290 @@ function removeDataItem(dataCollectionId, id) {
   const q = `dataCollectionId=${encodeURIComponent(dataCollectionId)}`;
   return wixCall("DELETE", `/wix-data/v2/items/${encodeURIComponent(id)}?${q}`);
 }
+var MAX_FIELD_MODIFICATIONS = 100;
+function assertModifications(fn, mods) {
+  if (!Array.isArray(mods) || mods.length === 0) throw new Error(`${fn}: at least one field modification is required`);
+  if (mods.length > MAX_FIELD_MODIFICATIONS) {
+    throw new Error(`${fn}: at most ${MAX_FIELD_MODIFICATIONS} field modifications per patch (got ${mods.length})`);
+  }
+  for (const m of mods) {
+    if (!m?.fieldPath) throw new Error(`${fn}: every field modification needs a fieldPath`);
+  }
+}
+function setField(fieldPath, value) {
+  return { fieldPath, action: "SET_FIELD", setFieldOptions: { value } };
+}
+function removeField(fieldPath) {
+  return { fieldPath, action: "REMOVE_FIELD" };
+}
+function incrementField(fieldPath, by = 1) {
+  return { fieldPath, action: "INCREMENT_FIELD", incrementFieldOptions: { value: by } };
+}
+function appendToArray(fieldPath, value) {
+  return { fieldPath, action: "APPEND_TO_ARRAY", appendToArrayOptions: { value } };
+}
+function removeFromArray(fieldPath, value) {
+  return { fieldPath, action: "REMOVE_FROM_ARRAY", removeFromArrayOptions: { value } };
+}
+function patchDataItem(dataCollectionId, dataItemId, fieldModifications) {
+  if (!dataCollectionId || !dataItemId) throw new Error("patchDataItem: dataCollectionId and dataItemId are required");
+  assertModifications("patchDataItem", fieldModifications);
+  return wixCall("PATCH", `/wix-data/v2/items/${encodeURIComponent(dataItemId)}`, {
+    dataCollectionId,
+    patch: { dataItemId, fieldModifications }
+  });
+}
+function saveDataItem(dataCollectionId, data, options) {
+  if (!dataCollectionId) throw new Error("saveDataItem: dataCollectionId is required");
+  return wixCall("POST", "/wix-data/v2/items/save", {
+    dataCollectionId,
+    dataItem: itemEnvelope("saveDataItem", data, options?.id)
+  });
+}
+function countDataItems(dataCollectionId, filter, options) {
+  if (!dataCollectionId) throw new Error("countDataItems: dataCollectionId is required");
+  return wixCall("POST", "/wix-data/v2/items/count", {
+    dataCollectionId,
+    ...filter ? { filter } : {},
+    ...options?.consistentRead ? { consistentRead: true } : {},
+    ...options?.language ? { language: options.language } : {},
+    ...options?.includeDraftItems ? { publishPluginOptions: { includeDraftItems: true } } : {}
+  });
+}
+var MAX_BULK_ITEMS = 1e3;
+var MAX_BULK_PATCHES = 100;
+function assertBatch(fn, what, list, max) {
+  if (!Array.isArray(list) || list.length === 0) throw new Error(`${fn}: at least one ${what} is required`);
+  const plural = what.endsWith("ch") ? `${what}es` : `${what}s`;
+  if (list.length > max) throw new Error(`${fn}: at most ${max} ${plural} per call (got ${list.length})`);
+}
+function bulkFailures(res) {
+  return (res?.results ?? []).filter((r) => {
+    const meta = r.itemMetadata ?? r.referenceMetadata;
+    return meta?.success === false || meta?.success !== true && meta?.error != null;
+  });
+}
+function bulkInsertDataItems(dataCollectionId, dataItems, options) {
+  if (!dataCollectionId) throw new Error("bulkInsertDataItems: dataCollectionId is required");
+  assertBatch("bulkInsertDataItems", "item", dataItems, MAX_BULK_ITEMS);
+  return wixCall("POST", "/wix-data/v2/bulk/items/insert", {
+    dataCollectionId,
+    dataItems: dataItems.map((i, n) => itemEnvelope("bulkInsertDataItems", i.data, i.id, `dataItems[${n}]`)),
+    ...options?.returnEntity !== void 0 ? { returnEntity: options.returnEntity } : {}
+  });
+}
+function bulkSaveDataItems(dataCollectionId, dataItems, options) {
+  if (!dataCollectionId) throw new Error("bulkSaveDataItems: dataCollectionId is required");
+  assertBatch("bulkSaveDataItems", "item", dataItems, MAX_BULK_ITEMS);
+  return wixCall("POST", "/wix-data/v2/bulk/items/save", {
+    dataCollectionId,
+    dataItems: dataItems.map((i, n) => itemEnvelope("bulkSaveDataItems", i.data, i.id, `dataItems[${n}]`)),
+    ...options?.returnEntity !== void 0 ? { returnEntity: options.returnEntity } : {}
+  });
+}
+function bulkUpdateDataItems(dataCollectionId, dataItems, options) {
+  if (!dataCollectionId) throw new Error("bulkUpdateDataItems: dataCollectionId is required");
+  assertBatch("bulkUpdateDataItems", "item", dataItems, MAX_BULK_ITEMS);
+  dataItems.forEach((i, n) => {
+    if (!i?.id) throw new Error(`bulkUpdateDataItems: every item needs an id (dataItems[${n}].id)`);
+  });
+  return wixCall("POST", "/wix-data/v2/bulk/items/update", {
+    dataCollectionId,
+    dataItems: dataItems.map((i, n) => itemEnvelope("bulkUpdateDataItems", i.data, i.id, `dataItems[${n}]`)),
+    ...options?.returnEntity !== void 0 ? { returnEntity: options.returnEntity } : {},
+    ...options?.condition ? { condition: options.condition } : {}
+  });
+}
+function bulkPatchDataItems(dataCollectionId, patches, options) {
+  if (!dataCollectionId) throw new Error("bulkPatchDataItems: dataCollectionId is required");
+  assertBatch("bulkPatchDataItems", "patch", patches, MAX_BULK_PATCHES);
+  for (const p of patches) {
+    if (!p?.dataItemId) throw new Error("bulkPatchDataItems: every patch needs a dataItemId");
+    assertModifications("bulkPatchDataItems", p.fieldModifications);
+  }
+  return wixCall("POST", "/wix-data/v2/bulk/items/patch", {
+    dataCollectionId,
+    patches: patches.map((p) => ({ dataItemId: p.dataItemId, fieldModifications: p.fieldModifications })),
+    ...options?.returnEntity !== void 0 ? { returnEntity: options.returnEntity } : {},
+    ...options?.condition ? { condition: options.condition } : {}
+  });
+}
+function bulkRemoveDataItems(dataCollectionId, dataItemIds, options) {
+  if (!dataCollectionId) throw new Error("bulkRemoveDataItems: dataCollectionId is required");
+  assertBatch("bulkRemoveDataItems", "id", dataItemIds, MAX_BULK_ITEMS);
+  if (dataItemIds.some((id) => !id)) throw new Error("bulkRemoveDataItems: ids must not be empty");
+  return wixCall("POST", "/wix-data/v2/bulk/items/remove", {
+    dataCollectionId,
+    dataItemIds,
+    ...options?.condition ? { condition: options.condition } : {}
+  });
+}
+function aggregateDataItemsPipeline(dataCollectionId, pipeline, options) {
+  if (!dataCollectionId) throw new Error("aggregateDataItemsPipeline: dataCollectionId is required");
+  const followUp = !!pipeline?.cursorPaging?.cursor;
+  const stages = pipeline?.stages;
+  if (!followUp && (!Array.isArray(stages) || stages.length === 0)) {
+    throw new Error("aggregateDataItemsPipeline: pipeline.stages needs at least one stage");
+  }
+  if ((stages?.length ?? 0) > 100) {
+    throw new Error(`aggregateDataItemsPipeline: at most 100 stages per pipeline (got ${stages?.length})`);
+  }
+  if (pipeline.paging && pipeline.cursorPaging) {
+    throw new Error("aggregateDataItemsPipeline: paging and cursorPaging are mutually exclusive");
+  }
+  return wixCall("POST", "/wix-data/v2/items/aggregate-pipeline", {
+    dataCollectionId,
+    pipeline: followUp ? { cursorPaging: pipeline.cursorPaging } : pipeline,
+    ...options?.returnTotalCount && !followUp ? { returnTotalCount: true } : {},
+    ...options?.consistentRead ? { consistentRead: true } : {},
+    ...options?.language ? { language: options.language } : {},
+    ...options?.includeDraftItems ? { publishPluginOptions: { includeDraftItems: true } } : {}
+  });
+}
+function queryDistinctValues(dataCollectionId, fieldName, options) {
+  if (!dataCollectionId) throw new Error("queryDistinctValues: dataCollectionId is required");
+  if (!fieldName) throw new Error("queryDistinctValues: fieldName is required");
+  if (options?.paging && options?.cursorPaging) {
+    throw new Error("queryDistinctValues: paging and cursorPaging are mutually exclusive");
+  }
+  const followUp = !!options?.cursorPaging?.cursor;
+  return wixCall("POST", "/wix-data/v2/items/query-distinct-values", {
+    dataCollectionId,
+    ...followUp ? {} : { fieldName },
+    ...options?.filter && !followUp ? { filter: options.filter } : {},
+    ...options?.order && !followUp ? { order: options.order } : {},
+    ...options?.paging ? { paging: options.paging } : {},
+    ...options?.cursorPaging ? { cursorPaging: options.cursorPaging } : {},
+    ...options?.returnTotalCount && !followUp ? { returnTotalCount: true } : {},
+    ...options?.consistentRead ? { consistentRead: true } : {},
+    ...options?.language ? { language: options.language } : {},
+    ...options?.includeDraftItems ? { publishPluginOptions: { includeDraftItems: true } } : {}
+  });
+}
+function searchDataItems(dataCollectionId, expression, options) {
+  if (!dataCollectionId) throw new Error("searchDataItems: dataCollectionId is required");
+  if (!expression) throw new Error("searchDataItems: expression is required");
+  if (expression.length > 100) throw new Error(`searchDataItems: expression is at most 100 characters (got ${expression.length})`);
+  if (options?.cursorPaging) {
+    throw new Error("searchDataItems: Wix does not support cursor paging for search \u2014 page with `paging` (offset)");
+  }
+  return wixCall("POST", "/wix-data/v2/items/search", {
+    dataCollectionId,
+    search: {
+      search: {
+        expression,
+        ...options?.mode ? { mode: options.mode } : {},
+        ...options?.fuzzy ? { fuzzy: true } : {}
+      },
+      ...options?.paging ? { paging: options.paging } : {},
+      ...options?.filter ? { filter: options.filter } : {},
+      ...options?.sort?.length ? { sort: options.sort.map((k) => ({ fieldName: k.fieldName, order: k.order ?? "ASC" })) } : {},
+      ...options?.fields?.length ? { fields: options.fields } : {}
+    },
+    ...options?.includeReferences?.length ? { includeReferences: options.includeReferences } : {},
+    ...options?.includeDraftItems ? { publishPluginOptions: { includeDraftItems: true } } : {}
+  });
+}
+function queryReferencedDataItems(dataCollectionId, referringItemId, referringItemFieldName, options) {
+  if (!dataCollectionId || !referringItemId || !referringItemFieldName) {
+    throw new Error("queryReferencedDataItems: dataCollectionId, referringItemId and referringItemFieldName are required");
+  }
+  if (options?.paging && options?.cursorPaging) {
+    throw new Error("queryReferencedDataItems: paging and cursorPaging are mutually exclusive");
+  }
+  const followUp = !!options?.cursorPaging?.cursor;
+  return wixCall("POST", "/wix-data/v2/items/query-referenced", {
+    dataCollectionId,
+    ...followUp ? {} : { referringItemFieldName, referringItemId },
+    ...options?.order && !followUp ? { order: options.order } : {},
+    ...options?.paging ? { paging: options.paging } : {},
+    ...options?.cursorPaging ? { cursorPaging: options.cursorPaging } : {},
+    ...options?.fields?.length && !followUp ? { fields: options.fields } : {},
+    ...options?.returnTotalCount && !followUp ? { returnTotalCount: true } : {},
+    ...options?.consistentRead ? { consistentRead: true } : {},
+    ...options?.language ? { language: options.language } : {},
+    ...options?.includeDraftItems ? { publishPluginOptions: { includeDraftItems: true } } : {}
+  });
+}
+function isReferencedDataItem(dataCollectionId, referringItemId, referringItemFieldName, referencedItemId, options) {
+  if (!dataCollectionId || !referringItemId || !referringItemFieldName || !referencedItemId) {
+    throw new Error("isReferencedDataItem: dataCollectionId, referringItemId, referringItemFieldName and referencedItemId are required");
+  }
+  return wixCall("POST", "/wix-data/v2/items/is-referenced", {
+    dataCollectionId,
+    referringItemFieldName,
+    referringItemId,
+    referencedItemId,
+    ...options?.consistentRead ? { consistentRead: true } : {}
+  });
+}
+function assertReferences(fn, refs) {
+  assertBatch(fn, "reference", refs, MAX_BULK_ITEMS);
+  for (const r of refs) {
+    if (!r?.referringItemId || !r.referringItemFieldName || !r.referencedItemId) {
+      throw new Error(`${fn}: every reference needs referringItemId, referringItemFieldName and referencedItemId`);
+    }
+  }
+}
+function insertDataItemReferences(dataCollectionId, references, options) {
+  if (!dataCollectionId) throw new Error("insertDataItemReferences: dataCollectionId is required");
+  assertReferences("insertDataItemReferences", references);
+  return wixCall("POST", "/wix-data/v2/bulk/items/insert-references", {
+    dataCollectionId,
+    dataItemReferences: references,
+    ...options?.returnEntity !== void 0 ? { returnEntity: options.returnEntity } : {}
+  });
+}
+function removeDataItemReferences(dataCollectionId, references) {
+  if (!dataCollectionId) throw new Error("removeDataItemReferences: dataCollectionId is required");
+  assertReferences("removeDataItemReferences", references);
+  return wixCall("POST", "/wix-data/v2/bulk/items/remove-references", {
+    dataCollectionId,
+    dataItemReferences: references
+  });
+}
+function replaceDataItemReferences(dataCollectionId, referringItemId, referringItemFieldName, newReferencedItemIds) {
+  if (!dataCollectionId || !referringItemId || !referringItemFieldName) {
+    throw new Error("replaceDataItemReferences: dataCollectionId, referringItemId and referringItemFieldName are required");
+  }
+  if (!Array.isArray(newReferencedItemIds)) throw new Error("replaceDataItemReferences: newReferencedItemIds must be an array (empty removes all links)");
+  if (newReferencedItemIds.length > MAX_BULK_ITEMS) {
+    throw new Error(`replaceDataItemReferences: at most ${MAX_BULK_ITEMS} ids per call (got ${newReferencedItemIds.length})`);
+  }
+  return wixCall("POST", "/wix-data/v2/items/replace-references", {
+    dataCollectionId,
+    referringItemFieldName,
+    referringItemId,
+    newReferencedItemIds
+  });
+}
 export {
+  aggregateDataItemsPipeline,
+  appendToArray,
+  bulkFailures,
+  bulkInsertDataItems,
+  bulkPatchDataItems,
+  bulkRemoveDataItems,
+  bulkSaveDataItems,
+  bulkUpdateDataItems,
+  countDataItems,
   getDataItem,
+  incrementField,
   insertDataItem,
+  insertDataItemReferences,
+  isReferencedDataItem,
+  patchDataItem,
   queryDataItems,
+  queryDistinctValues,
+  queryReferencedDataItems,
   removeDataItem,
+  removeDataItemReferences,
+  removeField,
+  removeFromArray,
+  replaceDataItemReferences,
+  saveDataItem,
+  searchDataItems,
+  setField,
   updateDataItem,
   wixCall
 };