@wix/auto_sdk_data_indexes 1.0.49 → 1.0.51

package/build/cjs/index.d.ts

@@ -2,7 +2,9 @@ import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTF
 import { Index, ListIndexesOptions, ListIndexesResponse, IndexCreatedEnvelope, IndexDeletedEnvelope, IndexUpdatedEnvelope } from './index.typings.js';
 export { AccountInfo, AccountInfoMetadata, ActionEvent, BaseEventMetadata, CreateIndexRequest, CreateIndexResponse, DomainEvent, DomainEventBodyOneOf, DropIndexRequest, DropIndexResponse, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Environment, EnvironmentWithLiterals, EventMetadata, Failure, Field, IdentificationData, IdentificationDataIdOneOf, IndexSource, IndexSourceWithLiterals, ListAvailableIndexesRequest, ListAvailableIndexesResponse, ListIndexesRequest, MessageEnvelope, Order, OrderWithLiterals, Paging, PagingMetadata, RestoreInfo, Status, StatusWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
 
-declare function createIndex$1(httpClient: HttpClient): CreateIndexSignature;
+declare function createIndex$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): CreateIndexSignature;
 interface CreateIndexSignature {
     /**
      * Creates an index for a data collection.
@@ -19,7 +21,9 @@ interface CreateIndexSignature {
      */
     (dataCollectionId: string, index: NonNullablePaths<Index, `fields` | `fields.${number}.path` | `name`, 4>): Promise<NonNullablePaths<Index, `_id` | `name` | `fields` | `fields.${number}.path` | `fields.${number}.order` | `status` | `failure.code` | `failure.description` | `unique` | `caseInsensitive` | `source`, 4>>;
 }
-declare function dropIndex$1(httpClient: HttpClient): DropIndexSignature;
+declare function dropIndex$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): DropIndexSignature;
 interface DropIndexSignature {
     /**
      * Removes an index from a data collection.
@@ -32,7 +36,9 @@ interface DropIndexSignature {
      */
     (dataCollectionId: string, indexName: string): Promise<void>;
 }
-declare function listIndexes$1(httpClient: HttpClient): ListIndexesSignature;
+declare function listIndexes$1(httpClient: HttpClient, __options?: {
+    validateRequestSchema?: boolean;
+}): ListIndexesSignature;
 interface ListIndexesSignature {
     /**
      * Lists all indexes defined for a data collection.

package/build/cjs/index.js

@@ -1,7 +1,9 @@
 "use strict";
+var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -15,6 +17,14 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // index.ts
@@ -491,6 +501,168 @@ function listAvailableIndexes(payload) {
   return __listAvailableIndexes;
 }
 
+// src/data-v2-index-indexes.schemas.ts
+var z = __toESM(require("zod"));
+var CreateIndexRequest = z.object({
+  dataCollectionId: z.string().describe("ID of the data collection for which to generate the index.").max(256),
+  index: z.object({
+    _id: z.string().describe("ID of the index.").regex(
+      /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+      "Must be a valid GUID"
+    ).optional(),
+    name: z.string().describe("Name of the index.").min(1).max(128),
+    fields: z.array(
+      z.object({
+        path: z.string().describe(
+          "Path of the field to index. For example: `title` or `options.price`."
+        ).min(1).max(128),
+        order: z.enum(["ASC", "DESC"]).optional()
+      })
+    ).min(1).max(3),
+    status: z.enum([
+      "UNKNOWN",
+      "BUILDING",
+      "ACTIVE",
+      "DROPPING",
+      "DROPPED",
+      "FAILED",
+      "INVALID"
+    ]).optional(),
+    failure: z.object({
+      code: z.string().describe(
+        "Error code.\n- `WDE0112`: Unknown error while building collection index.\n- `WDE0113`: Duplicate key error while building collection index.\n- `WDE0114`: Document too large while building collection index."
+      ).max(7).optional(),
+      description: z.string().describe("Description of the failure.").max(1024).optional(),
+      itemId: z.string().describe(
+        "ID of the data item that caused the failure.\nFor example, if `unique` is `true`, the ID of an item containing a duplicate value."
+      ).max(16e3).optional().nullable()
+    }).describe(
+      "Contains details about the reasons for failure when `status` is `FAILED`."
+    ).optional(),
+    unique: z.boolean().describe(
+      "Whether the index enforces uniqueness of values in the field for which it's defined.\nIf `true`, the index can have only 1 field.\n\nDefault: `false`"
+    ).optional(),
+    caseInsensitive: z.boolean().describe("Whether the index ignores case.\n\nDefault: `false`").optional(),
+    source: z.enum(["SYSTEM", "USER", "AUTO"]).optional()
+  }).describe("Details of the index to be created.")
+});
+var CreateIndexResponse = z.object({
+  _id: z.string().describe("ID of the index.").regex(
+    /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+    "Must be a valid GUID"
+  ).optional(),
+  name: z.string().describe("Name of the index.").min(1).max(128).optional(),
+  fields: z.array(
+    z.object({
+      path: z.string().describe(
+        "Path of the field to index. For example: `title` or `options.price`."
+      ).min(1).max(128).optional(),
+      order: z.enum(["ASC", "DESC"]).describe(
+        "Sort order for the index. Base on how the data is regularly queried.\n\nDefault: `ASC`"
+      ).optional()
+    })
+  ).min(1).max(3).optional(),
+  status: z.enum([
+    "UNKNOWN",
+    "BUILDING",
+    "ACTIVE",
+    "DROPPING",
+    "DROPPED",
+    "FAILED",
+    "INVALID"
+  ]).describe("Current status of the index.").optional(),
+  failure: z.object({
+    code: z.string().describe(
+      "Error code.\n- `WDE0112`: Unknown error while building collection index.\n- `WDE0113`: Duplicate key error while building collection index.\n- `WDE0114`: Document too large while building collection index."
+    ).max(7).optional(),
+    description: z.string().describe("Description of the failure.").max(1024).optional(),
+    itemId: z.string().describe(
+      "ID of the data item that caused the failure.\nFor example, if `unique` is `true`, the ID of an item containing a duplicate value."
+    ).max(16e3).optional().nullable()
+  }).describe(
+    "Contains details about the reasons for failure when `status` is `FAILED`."
+  ).optional(),
+  unique: z.boolean().describe(
+    "Whether the index enforces uniqueness of values in the field for which it's defined.\nIf `true`, the index can have only 1 field.\n\nDefault: `false`"
+  ).optional(),
+  caseInsensitive: z.boolean().describe("Whether the index ignores case.\n\nDefault: `false`").optional(),
+  source: z.enum(["SYSTEM", "USER", "AUTO"]).describe(
+    "Source of the index. See index sources in [Index Types](https://dev.wix.com/docs/api-reference/business-solutions/cms/indexes/index-types#index-sources).\n\nDefault: `USER`"
+  ).optional()
+});
+var DropIndexRequest = z.object({
+  dataCollectionId: z.string().describe(
+    "ID of the data collection for which the index to be dropped is defined."
+  ).max(1024),
+  indexName: z.string().describe("Name of the index to drop.").min(1).max(128)
+});
+var DropIndexResponse = z.object({});
+var ListIndexesRequest = z.object({
+  dataCollectionId: z.string().describe("ID of the data collection for which to list indexes.").max(1024),
+  options: z.object({
+    paging: z.object({
+      limit: z.number().int().describe("Number of items to load.").min(0).optional().nullable(),
+      offset: z.number().int().describe("Number of items to skip in the current sort order.").min(0).optional().nullable()
+    }).describe("Paging options to limit and skip the number of items.").optional()
+  }).describe("Options for retrieving a list of indexes.").optional()
+});
+var ListIndexesResponse = z.object({
+  indexes: z.array(
+    z.object({
+      _id: z.string().describe("ID of the index.").regex(
+        /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
+        "Must be a valid GUID"
+      ).optional(),
+      name: z.string().describe("Name of the index.").min(1).max(128).optional(),
+      fields: z.array(
+        z.object({
+          path: z.string().describe(
+            "Path of the field to index. For example: `title` or `options.price`."
+          ).min(1).max(128).optional(),
+          order: z.enum(["ASC", "DESC"]).describe(
+            "Sort order for the index. Base on how the data is regularly queried.\n\nDefault: `ASC`"
+          ).optional()
+        })
+      ).min(1).max(3).optional(),
+      status: z.enum([
+        "UNKNOWN",
+        "BUILDING",
+        "ACTIVE",
+        "DROPPING",
+        "DROPPED",
+        "FAILED",
+        "INVALID"
+      ]).describe("Current status of the index.").optional(),
+      failure: z.object({
+        code: z.string().describe(
+          "Error code.\n- `WDE0112`: Unknown error while building collection index.\n- `WDE0113`: Duplicate key error while building collection index.\n- `WDE0114`: Document too large while building collection index."
+        ).max(7).optional(),
+        description: z.string().describe("Description of the failure.").max(1024).optional(),
+        itemId: z.string().describe(
+          "ID of the data item that caused the failure.\nFor example, if `unique` is `true`, the ID of an item containing a duplicate value."
+        ).max(16e3).optional().nullable()
+      }).describe(
+        "Contains details about the reasons for failure when `status` is `FAILED`."
+      ).optional(),
+      unique: z.boolean().describe(
+        "Whether the index enforces uniqueness of values in the field for which it's defined.\nIf `true`, the index can have only 1 field.\n\nDefault: `false`"
+      ).optional(),
+      caseInsensitive: z.boolean().describe("Whether the index ignores case.\n\nDefault: `false`").optional(),
+      source: z.enum(["SYSTEM", "USER", "AUTO"]).describe(
+        "Source of the index. See index sources in [Index Types](https://dev.wix.com/docs/api-reference/business-solutions/cms/indexes/index-types#index-sources).\n\nDefault: `USER`"
+      ).optional()
+    })
+  ).optional(),
+  pagingMetadata: z.object({
+    count: z.number().int().describe("Number of items returned in the response.").optional().nullable(),
+    offset: z.number().int().describe("Offset that was requested.").optional().nullable(),
+    total: z.number().int().describe("Total number of items that match the query.").optional().nullable(),
+    tooManyToCount: z.boolean().describe(
+      "Flag that indicates the server failed to calculate the `total` field."
+    ).optional().nullable()
+  }).describe("Paging metadata.").optional()
+});
+
 // src/data-v2-index-indexes.universal.ts
 var Order = /* @__PURE__ */ ((Order2) => {
   Order2["ASC"] = "ASC";
@@ -528,7 +700,10 @@ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
   return WebhookIdentityType2;
 })(WebhookIdentityType || {});
 async function createIndex2(dataCollectionId, index) {
-  const { httpClient, sideEffects } = arguments[2];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
+  if (validateRequestSchema) {
+    CreateIndexRequest.parse({ dataCollectionId, index });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     dataCollectionId,
     index
@@ -554,7 +729,10 @@ async function createIndex2(dataCollectionId, index) {
   }
 }
 async function dropIndex2(dataCollectionId, indexName) {
-  const { httpClient, sideEffects } = arguments[2];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
+  if (validateRequestSchema) {
+    DropIndexRequest.parse({ dataCollectionId, indexName });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     dataCollectionId,
     indexName
@@ -582,7 +760,10 @@ async function dropIndex2(dataCollectionId, indexName) {
   }
 }
 async function listIndexes2(dataCollectionId, options) {
-  const { httpClient, sideEffects } = arguments[2];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[2];
+  if (validateRequestSchema) {
+    ListIndexesRequest.parse({ dataCollectionId, options });
+  }
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     dataCollectionId,
     paging: options?.paging
@@ -637,35 +818,35 @@ async function listAvailableIndexes2(dataCollectionId) {
 }
 
 // src/data-v2-index-indexes.public.ts
-function createIndex3(httpClient) {
+function createIndex3(httpClient, __options) {
   return (dataCollectionId, index) => createIndex2(
     dataCollectionId,
     index,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function dropIndex3(httpClient) {
+function dropIndex3(httpClient, __options) {
   return (dataCollectionId, indexName) => dropIndex2(
     dataCollectionId,
     indexName,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function listIndexes3(httpClient) {
+function listIndexes3(httpClient, __options) {
   return (dataCollectionId, options) => listIndexes2(
     dataCollectionId,
     options,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
-function listAvailableIndexes3(httpClient) {
+function listAvailableIndexes3(httpClient, __options) {
   return (dataCollectionId) => listAvailableIndexes2(
     dataCollectionId,
     // @ts-ignore
-    { httpClient }
+    { httpClient, validateRequestSchema: __options?.validateRequestSchema }
   );
 }
 var onIndexCreated = (0, import_sdk_types.EventDefinition)(