@wix/auto_sdk_viewer_site-structure-service 1.0.14 → 1.0.15

package/build/cjs/schemas.d.ts

@@ -0,0 +1,102 @@
+import * as z from 'zod';
+
+declare const GetSiteStructureRequest: z.ZodObject<{
+    options: z.ZodOptional<z.ZodObject<{
+        pageVersion: z.ZodOptional<z.ZodEnum<{
+            PUBLISHED: "PUBLISHED";
+            SAVED: "SAVED";
+        }>>;
+        paging: z.ZodOptional<z.ZodObject<{
+            limit: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+            cursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>;
+        filter: z.ZodOptional<z.ZodObject<{
+            itemTypeIdentifier: z.ZodOptional<z.ZodString>;
+            sourceId: z.ZodOptional<z.ZodString>;
+            configId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        sorting: z.ZodOptional<z.ZodObject<{
+            fieldName: z.ZodOptional<z.ZodString>;
+            order: z.ZodOptional<z.ZodEnum<{
+                ASC: "ASC";
+                DESC: "DESC";
+            }>>;
+        }, z.core.$strip>>;
+        fieldSet: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        languageMetadata: z.ZodOptional<z.ZodObject<{
+            code: z.ZodOptional<z.ZodString>;
+            tag: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>;
+        branchId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const GetSiteStructureResponse: z.ZodObject<{
+    totalResults: z.ZodOptional<z.ZodNumber>;
+    pageData: z.ZodOptional<z.ZodObject<{
+        count: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        cursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>;
+    results: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        itemId: z.ZodOptional<z.ZodString>;
+        itemTypeIdentifier: z.ZodOptional<z.ZodString>;
+        sourceId: z.ZodOptional<z.ZodString>;
+        configId: z.ZodOptional<z.ZodString>;
+        name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        media: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
+            image: z.ZodOptional<z.ZodNever>;
+            video: z.ZodOptional<z.ZodNever>;
+            document: z.ZodOptional<z.ZodNever>;
+        }, z.core.$strip>, z.ZodObject<{
+            video: z.ZodOptional<z.ZodNever>;
+            document: z.ZodOptional<z.ZodNever>;
+            image: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            image: z.ZodOptional<z.ZodNever>;
+            document: z.ZodOptional<z.ZodNever>;
+            video: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            image: z.ZodOptional<z.ZodNever>;
+            video: z.ZodOptional<z.ZodNever>;
+            document: z.ZodString;
+        }, z.core.$strip>]>>>>;
+        path: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
+        inactive: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        metadata: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+        image: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        video: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        protected: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        translationId: z.ZodOptional<z.ZodString>;
+        isCustomErrorPage: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    }, z.core.$strip>>>;
+    errors: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{
+        errorMessage: z.ZodOptional<z.ZodString>;
+        appId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
+        itemTypeId: z.ZodOptional<z.ZodNever>;
+        routerPrefix: z.ZodOptional<z.ZodNever>;
+    }, z.core.$strip>, z.ZodObject<{
+        routerPrefix: z.ZodOptional<z.ZodNever>;
+        itemTypeId: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        itemTypeId: z.ZodOptional<z.ZodNever>;
+        routerPrefix: z.ZodString;
+    }, z.core.$strip>]>>>>;
+}, z.core.$strip>;
+declare const GetSiteStructureMetadataRequest: z.ZodObject<{
+    options: z.ZodOptional<z.ZodObject<{
+        pageVersion: z.ZodOptional<z.ZodEnum<{
+            PUBLISHED: "PUBLISHED";
+            SAVED: "SAVED";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const GetSiteStructureMetadataResponse: z.ZodObject<{
+    pageTypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        itemTypeIdentifier: z.ZodOptional<z.ZodString>;
+        sourceId: z.ZodOptional<z.ZodString>;
+        configId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+
+export { GetSiteStructureMetadataRequest, GetSiteStructureMetadataResponse, GetSiteStructureRequest, GetSiteStructureResponse };

package/build/cjs/schemas.js

@@ -0,0 +1,216 @@
+"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)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  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);
+
+// schemas.ts
+var schemas_exports = {};
+__export(schemas_exports, {
+  GetSiteStructureMetadataRequest: () => GetSiteStructureMetadataRequest,
+  GetSiteStructureMetadataResponse: () => GetSiteStructureMetadataResponse,
+  GetSiteStructureRequest: () => GetSiteStructureRequest,
+  GetSiteStructureResponse: () => GetSiteStructureResponse
+});
+module.exports = __toCommonJS(schemas_exports);
+
+// src/viewer-structure-v1-site-structure-item-site-structure-service.schemas.ts
+var z = __toESM(require("zod"));
+var GetSiteStructureRequest = z.object({
+  options: z.object({
+    pageVersion: z.enum(["PUBLISHED", "SAVED"]).optional(),
+    paging: z.object({
+      limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(100).optional().nullable(),
+      cursor: z.string().describe(
+        "Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
+      ).max(16e3).optional().nullable()
+    }).describe(
+      "Pagination request metadata, currently applicable for:\\\n- Queries filtered for items from a TPA that is part of the new-integration (TpaSiteStructureService)\n- Queries filtered for dynamic router items from the new dynamic-pages-router integration (DynamicSiteStructureService)"
+    ).optional(),
+    filter: z.object({
+      itemTypeIdentifier: z.string().describe("In accordance to SiteStructureItem.item_type_identifier").optional(),
+      sourceId: z.string().describe("In accordance to SiteStructureItem.source_id").optional(),
+      configId: z.string().describe("In accordance to SiteStructureItem.config_id").optional()
+    }).describe(
+      "Filtering metadata. Only items allowed by the filter will be returned."
+    ).optional(),
+    sorting: z.object({
+      fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
+      order: z.enum(["ASC", "DESC"]).optional()
+    }).describe("General sorting metadata. Currently not supported.").optional(),
+    fieldSet: z.array(z.string()).optional(),
+    languageMetadata: z.object({
+      code: z.string().describe("2 chars language code (e.g. 'en')").optional(),
+      tag: z.string().describe("4 chars language tag (e.g. 'en-us')").optional().nullable()
+    }).describe(
+      "Language metadata. Contains 2 chars language code and/or 4 chars language tag."
+    ).optional(),
+    branchId: z.string().describe(
+      "Used to identify the branch of the site for which the structure is requested."
+    ).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().nullable()
+  }).optional()
+});
+var GetSiteStructureResponse = z.object({
+  totalResults: z.number().int().describe(
+    "The total number of items to be returned, combining all paginated responses."
+  ).optional(),
+  pageData: z.object({
+    count: z.number().int().describe("The item count in the current page").optional().nullable(),
+    cursor: z.string().describe("The cursor which will be used to query the next page").optional().nullable()
+  }).describe(
+    "A cursor based paging response metadata, including the item count in the current page and a cursor string to be used for querying of the next page."
+  ).optional(),
+  results: z.array(
+    z.object({
+      itemId: z.string().describe(
+        "The end goal: this field should contain a unique identifier for this site-structure item.\\\nCurrently it contains:\n- For site-structure integrated TPAs - the unique identifier provided by the TPA.\n- For all other item types - empty string."
+      ).optional(),
+      itemTypeIdentifier: z.string().describe(
+        `An identifier for the type of the item. One of:
+- For the site's static pages - "static_page".
+- For legacy integration TPAs - the TPA's app-def-id.
+- For TPAs with new site-structure integration - the item type identifier provided by the TPA. Commonly one of that TPA's supported sub-pages.
+- For items that are the result of a dynamic router - "dynamic-page".`
+      ).optional(),
+      sourceId: z.string().describe(
+        `An identifier for the source of the item. One of:
+- For the site's static pages - "editor".
+- For legacy integration TPAs - the TPA's app-def-id.
+- For TPAs with new site-structure integration - the TPA's app-def-id.
+- For items that are the result of a dataBinding router - Wix-Data's app-def-id: 'e593b0bd-b783-45b8-97c2-873d42aacaf4'.
+- For items that are the result of a dynamic router - Wix-Code's app-def-id: '675bbcef-18d8-41f5-800e-131ec9e08762'.`
+      ).optional(),
+      configId: z.string().describe(
+        `An identifier for the configuration of the item. Used currently as some sort of a placeholder for further filtering.
+- For items of type "dynamic-page" - The 'prefix' field that is part of the router-config object of the router that is related to this item (see WixCodeDynamicRouterResolver).
+- For all other items types - empty string.`
+      ).optional(),
+      name: z.string().describe(
+        "A human readable name string associated with the item.\\\nCurrently exists only for new TPA site-structure integration items, and contains the 'name' field provided by the TPA for that item.\\\nThis field is not guaranteed to be unique across the item list."
+      ).optional().nullable(),
+      media: z.array(
+        z.intersection(
+          z.object({}),
+          z.xor([
+            z.object({
+              image: z.never().optional(),
+              video: z.never().optional(),
+              document: z.never().optional()
+            }),
+            z.object({
+              video: z.never().optional(),
+              document: z.never().optional(),
+              image: z.string().describe("WixMedia image")
+            }),
+            z.object({
+              image: z.never().optional(),
+              document: z.never().optional(),
+              video: z.string().describe("WixMedia video")
+            }),
+            z.object({
+              image: z.never().optional(),
+              video: z.never().optional(),
+              document: z.string().describe("WixMedia document")
+            })
+          ])
+        )
+      ).optional(),
+      path: z.string().describe(
+        "A relative url path that can be used, with the site's base-url, to reach the page represented by this item."
+      ).optional().nullable(),
+      _updatedDate: z.date().describe(
+        "A timestamp representing the moment that this item was last changed.\n- For static pages - the site's last publish time.\n- For all kinds of TPAs - the last-modified field in the respective response item from the TPA.\n- For items that are the result of a dynamic router - the content of the 'lastModified' optional field in the response item from Wix-Code's RPC endpoint, or, if missing, the site's last publish time. (see WixCodeDynamicRouterResolver)."
+      ).optional().nullable(),
+      inactive: z.boolean().describe(
+        "A value indicating whether the item is inactive or not. E.g. hidden product/finished event etc.\\\nCurrently exists only for new TPA site-structure integration items, and contains the 'inactive' field provided by the TPA for that item."
+      ).optional().nullable(),
+      metadata: z.record(z.string(), z.any()).describe(
+        'A general free schema field to include further metadata related to this item.\\\nCurrently exists only for:\\\nStatic pages - a JSON that is the merge of:\n1. The advancedSeoData JSON string that exists for the page in the master-page.\n2. A JSON of the form:\n```javascript\n{\n"seo_legacy": {\n"hidden_from_seo": true / false\n},\n"password_protected": true / false\n}\n```\nNew TPA site-structure integration items - the \'metadata\' field provided by the TPA for that item.'
+      ).optional().nullable(),
+      image: z.array(z.string()).optional(),
+      video: z.array(z.string()).optional(),
+      protected: z.boolean().describe(
+        "A value indicating whether the item is protected or not, by password or login."
+      ).optional().nullable(),
+      translationId: z.string().describe(
+        "ID of the translations of the item. As same item can have multiple instances, one for each language, we can match them by this ID.\\\nFor example:\nBlog has one post, translated to 2 languages (EN, FR):\n- EN item path is `/amazing-post`\n- FR item path is `/poste-incroyable\nBoth of them might have different `item_id`, but will share the same `translation_id`, to be easily match together\nCurrently only relevant for Blog"
+      ).optional(),
+      isCustomErrorPage: z.boolean().describe(
+        "A value indicating whether the item is a custom error page or not."
+      ).optional().nullable()
+    })
+  ).optional(),
+  errors: z.array(
+    z.intersection(
+      z.object({
+        errorMessage: z.string().describe("Error message").min(1).max(1e3).optional(),
+        appId: z.string().describe(
+          "if the fetch happened while fetching links from a TPA, this will hold the TPA appDefId"
+        ).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().nullable()
+      }),
+      z.xor([
+        z.object({
+          itemTypeId: z.never().optional(),
+          routerPrefix: z.never().optional()
+        }),
+        z.object({
+          routerPrefix: z.never().optional(),
+          itemTypeId: z.string().describe("item type id of the failed fetch").min(1).max(200)
+        }),
+        z.object({
+          itemTypeId: z.never().optional(),
+          routerPrefix: z.string().describe("for dynamic pages: router prefix of the failed fetch").min(1).max(200)
+        })
+      ])
+    )
+  ).optional()
+});
+var GetSiteStructureMetadataRequest = z.object({
+  options: z.object({ pageVersion: z.enum(["PUBLISHED", "SAVED"]).optional() }).optional()
+});
+var GetSiteStructureMetadataResponse = z.object({
+  pageTypes: z.array(
+    z.object({
+      itemTypeIdentifier: z.string().describe("Type identifier").optional(),
+      sourceId: z.string().describe("Site's page-type sourceId").optional(),
+      configId: z.string().describe("Site's page-type configId").optional()
+    })
+  ).optional()
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  GetSiteStructureMetadataRequest,
+  GetSiteStructureMetadataResponse,
+  GetSiteStructureRequest,
+  GetSiteStructureResponse
+});
+//# sourceMappingURL=schemas.js.map

package/build/cjs/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../schemas.ts","../../src/viewer-structure-v1-site-structure-item-site-structure-service.schemas.ts"],"sourcesContent":["export * from './src/viewer-structure-v1-site-structure-item-site-structure-service.schemas.js';\n","import * as z from 'zod';\n\nexport const GetSiteStructureRequest = z.object({\n  options: z\n    .object({\n      pageVersion: z.enum(['PUBLISHED', 'SAVED']).optional(),\n      paging: z\n        .object({\n          limit: z\n            .number()\n            .int()\n            .describe('Maximum number of items to return in the results.')\n            .min(0)\n            .max(100)\n            .optional()\n            .nullable(),\n          cursor: z\n            .string()\n            .describe(\n              \"Pointer to the next or previous page in the list of results.\\n\\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\\nNot relevant for the first request.\"\n            )\n            .max(16000)\n            .optional()\n            .nullable(),\n        })\n        .describe(\n          'Pagination request metadata, currently applicable for:\\\\\\n- Queries filtered for items from a TPA that is part of the new-integration (TpaSiteStructureService)\\n- Queries filtered for dynamic router items from the new dynamic-pages-router integration (DynamicSiteStructureService)'\n        )\n        .optional(),\n      filter: z\n        .object({\n          itemTypeIdentifier: z\n            .string()\n            .describe('In accordance to SiteStructureItem.item_type_identifier')\n            .optional(),\n          sourceId: z\n            .string()\n            .describe('In accordance to SiteStructureItem.source_id')\n            .optional(),\n          configId: z\n            .string()\n            .describe('In accordance to SiteStructureItem.config_id')\n            .optional(),\n        })\n        .describe(\n          'Filtering metadata. Only items allowed by the filter will be returned.'\n        )\n        .optional(),\n      sorting: z\n        .object({\n          fieldName: z\n            .string()\n            .describe('Name of the field to sort by.')\n            .max(512)\n            .optional(),\n          order: z.enum(['ASC', 'DESC']).optional(),\n        })\n        .describe('General sorting metadata. Currently not supported.')\n        .optional(),\n      fieldSet: z.array(z.string()).optional(),\n      languageMetadata: z\n        .object({\n          code: z\n            .string()\n            .describe(\"2 chars language code (e.g. 'en')\")\n            .optional(),\n          tag: z\n            .string()\n            .describe(\"4 chars language tag (e.g. 'en-us')\")\n            .optional()\n            .nullable(),\n        })\n        .describe(\n          'Language metadata. Contains 2 chars language code and/or 4 chars language tag.'\n        )\n        .optional(),\n      branchId: z\n        .string()\n        .describe(\n          'Used to identify the branch of the site for which the structure is requested.'\n        )\n        .regex(\n          /^[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}$/,\n          'Must be a valid GUID'\n        )\n        .optional()\n        .nullable(),\n    })\n    .optional(),\n});\nexport const GetSiteStructureResponse = z.object({\n  totalResults: z\n    .number()\n    .int()\n    .describe(\n      'The total number of items to be returned, combining all paginated responses.'\n    )\n    .optional(),\n  pageData: z\n    .object({\n      count: z\n        .number()\n        .int()\n        .describe('The item count in the current page')\n        .optional()\n        .nullable(),\n      cursor: z\n        .string()\n        .describe('The cursor which will be used to query the next page')\n        .optional()\n        .nullable(),\n    })\n    .describe(\n      'A cursor based paging response metadata, including the item count in the current page and a cursor string to be used for querying of the next page.'\n    )\n    .optional(),\n  results: z\n    .array(\n      z.object({\n        itemId: z\n          .string()\n          .describe(\n            'The end goal: this field should contain a unique identifier for this site-structure item.\\\\\\nCurrently it contains:\\n- For site-structure integrated TPAs - the unique identifier provided by the TPA.\\n- For all other item types - empty string.'\n          )\n          .optional(),\n        itemTypeIdentifier: z\n          .string()\n          .describe(\n            'An identifier for the type of the item. One of:\\n- For the site\\'s static pages - \"static_page\".\\n- For legacy integration TPAs - the TPA\\'s app-def-id.\\n- For TPAs with new site-structure integration - the item type identifier provided by the TPA. Commonly one of that TPA\\'s supported sub-pages.\\n- For items that are the result of a dynamic router - \"dynamic-page\".'\n          )\n          .optional(),\n        sourceId: z\n          .string()\n          .describe(\n            \"An identifier for the source of the item. One of:\\n- For the site's static pages - \\\"editor\\\".\\n- For legacy integration TPAs - the TPA's app-def-id.\\n- For TPAs with new site-structure integration - the TPA's app-def-id.\\n- For items that are the result of a dataBinding router - Wix-Data's app-def-id: 'e593b0bd-b783-45b8-97c2-873d42aacaf4'.\\n- For items that are the result of a dynamic router - Wix-Code's app-def-id: '675bbcef-18d8-41f5-800e-131ec9e08762'.\"\n          )\n          .optional(),\n        configId: z\n          .string()\n          .describe(\n            'An identifier for the configuration of the item. Used currently as some sort of a placeholder for further filtering.\\n- For items of type \"dynamic-page\" - The \\'prefix\\' field that is part of the router-config object of the router that is related to this item (see WixCodeDynamicRouterResolver).\\n- For all other items types - empty string.'\n          )\n          .optional(),\n        name: z\n          .string()\n          .describe(\n            \"A human readable name string associated with the item.\\\\\\nCurrently exists only for new TPA site-structure integration items, and contains the 'name' field provided by the TPA for that item.\\\\\\nThis field is not guaranteed to be unique across the item list.\"\n          )\n          .optional()\n          .nullable(),\n        media: z\n          .array(\n            z.intersection(\n              z.object({}),\n              z.xor([\n                z.object({\n                  image: z.never().optional(),\n                  video: z.never().optional(),\n                  document: z.never().optional(),\n                }),\n                z.object({\n                  video: z.never().optional(),\n                  document: z.never().optional(),\n                  image: z.string().describe('WixMedia image'),\n                }),\n                z.object({\n                  image: z.never().optional(),\n                  document: z.never().optional(),\n                  video: z.string().describe('WixMedia video'),\n                }),\n                z.object({\n                  image: z.never().optional(),\n                  video: z.never().optional(),\n                  document: z.string().describe('WixMedia document'),\n                }),\n              ])\n            )\n          )\n          .optional(),\n        path: z\n          .string()\n          .describe(\n            \"A relative url path that can be used, with the site's base-url, to reach the page represented by this item.\"\n          )\n          .optional()\n          .nullable(),\n        _updatedDate: z\n          .date()\n          .describe(\n            \"A timestamp representing the moment that this item was last changed.\\n- For static pages - the site's last publish time.\\n- For all kinds of TPAs - the last-modified field in the respective response item from the TPA.\\n- For items that are the result of a dynamic router - the content of the 'lastModified' optional field in the response item from Wix-Code's RPC endpoint, or, if missing, the site's last publish time. (see WixCodeDynamicRouterResolver).\"\n          )\n          .optional()\n          .nullable(),\n        inactive: z\n          .boolean()\n          .describe(\n            \"A value indicating whether the item is inactive or not. E.g. hidden product/finished event etc.\\\\\\nCurrently exists only for new TPA site-structure integration items, and contains the 'inactive' field provided by the TPA for that item.\"\n          )\n          .optional()\n          .nullable(),\n        metadata: z\n          .record(z.string(), z.any())\n          .describe(\n            'A general free schema field to include further metadata related to this item.\\\\\\nCurrently exists only for:\\\\\\nStatic pages - a JSON that is the merge of:\\n1. The advancedSeoData JSON string that exists for the page in the master-page.\\n2. A JSON of the form:\\n```javascript\\n{\\n\"seo_legacy\": {\\n\"hidden_from_seo\": true / false\\n},\\n\"password_protected\": true / false\\n}\\n```\\nNew TPA site-structure integration items - the \\'metadata\\' field provided by the TPA for that item.'\n          )\n          .optional()\n          .nullable(),\n        image: z.array(z.string()).optional(),\n        video: z.array(z.string()).optional(),\n        protected: z\n          .boolean()\n          .describe(\n            'A value indicating whether the item is protected or not, by password or login.'\n          )\n          .optional()\n          .nullable(),\n        translationId: z\n          .string()\n          .describe(\n            'ID of the translations of the item. As same item can have multiple instances, one for each language, we can match them by this ID.\\\\\\nFor example:\\nBlog has one post, translated to 2 languages (EN, FR):\\n- EN item path is `/amazing-post`\\n- FR item path is `/poste-incroyable\\nBoth of them might have different `item_id`, but will share the same `translation_id`, to be easily match together\\nCurrently only relevant for Blog'\n          )\n          .optional(),\n        isCustomErrorPage: z\n          .boolean()\n          .describe(\n            'A value indicating whether the item is a custom error page or not.'\n          )\n          .optional()\n          .nullable(),\n      })\n    )\n    .optional(),\n  errors: z\n    .array(\n      z.intersection(\n        z.object({\n          errorMessage: z\n            .string()\n            .describe('Error message')\n            .min(1)\n            .max(1000)\n            .optional(),\n          appId: z\n            .string()\n            .describe(\n              'if the fetch happened while fetching links from a TPA, this will hold the TPA appDefId'\n            )\n            .regex(\n              /^[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}$/,\n              'Must be a valid GUID'\n            )\n            .optional()\n            .nullable(),\n        }),\n        z.xor([\n          z.object({\n            itemTypeId: z.never().optional(),\n            routerPrefix: z.never().optional(),\n          }),\n          z.object({\n            routerPrefix: z.never().optional(),\n            itemTypeId: z\n              .string()\n              .describe('item type id of the failed fetch')\n              .min(1)\n              .max(200),\n          }),\n          z.object({\n            itemTypeId: z.never().optional(),\n            routerPrefix: z\n              .string()\n              .describe('for dynamic pages: router prefix of the failed fetch')\n              .min(1)\n              .max(200),\n          }),\n        ])\n      )\n    )\n    .optional(),\n});\nexport const GetSiteStructureMetadataRequest = z.object({\n  options: z\n    .object({ pageVersion: z.enum(['PUBLISHED', 'SAVED']).optional() })\n    .optional(),\n});\nexport const GetSiteStructureMetadataResponse = z.object({\n  pageTypes: z\n    .array(\n      z.object({\n        itemTypeIdentifier: z.string().describe('Type identifier').optional(),\n        sourceId: z.string().describe(\"Site's page-type sourceId\").optional(),\n        configId: z.string().describe(\"Site's page-type configId\").optional(),\n      })\n    )\n    .optional(),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,QAAmB;AAEZ,IAAM,0BAA4B,SAAO;AAAA,EAC9C,SACG,SAAO;AAAA,IACN,aAAe,OAAK,CAAC,aAAa,OAAO,CAAC,EAAE,SAAS;AAAA,IACrD,QACG,SAAO;AAAA,MACN,OACG,SAAO,EACP,IAAI,EACJ,SAAS,mDAAmD,EAC5D,IAAI,CAAC,EACL,IAAI,GAAG,EACP,SAAS,EACT,SAAS;AAAA,MACZ,QACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,IAAI,IAAK,EACT,SAAS,EACT,SAAS;AAAA,IACd,CAAC,EACA;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,IACZ,QACG,SAAO;AAAA,MACN,oBACG,SAAO,EACP,SAAS,yDAAyD,EAClE,SAAS;AAAA,MACZ,UACG,SAAO,EACP,SAAS,8CAA8C,EACvD,SAAS;AAAA,MACZ,UACG,SAAO,EACP,SAAS,8CAA8C,EACvD,SAAS;AAAA,IACd,CAAC,EACA;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,IACZ,SACG,SAAO;AAAA,MACN,WACG,SAAO,EACP,SAAS,+BAA+B,EACxC,IAAI,GAAG,EACP,SAAS;AAAA,MACZ,OAAS,OAAK,CAAC,OAAO,MAAM,CAAC,EAAE,SAAS;AAAA,IAC1C,CAAC,EACA,SAAS,oDAAoD,EAC7D,SAAS;AAAA,IACZ,UAAY,QAAQ,SAAO,CAAC,EAAE,SAAS;AAAA,IACvC,kBACG,SAAO;AAAA,MACN,MACG,SAAO,EACP,SAAS,mCAAmC,EAC5C,SAAS;AAAA,MACZ,KACG,SAAO,EACP,SAAS,qCAAqC,EAC9C,SAAS,EACT,SAAS;AAAA,IACd,CAAC,EACA;AAAA,MACC;AAAA,IACF,EACC,SAAS;AAAA,IACZ,UACG,SAAO,EACP;AAAA,MACC;AAAA,IACF,EACC;AAAA,MACC;AAAA,MACA;AAAA,IACF,EACC,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;AACM,IAAM,2BAA6B,SAAO;AAAA,EAC/C,cACG,SAAO,EACP,IAAI,EACJ;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,UACG,SAAO;AAAA,IACN,OACG,SAAO,EACP,IAAI,EACJ,SAAS,oCAAoC,EAC7C,SAAS,EACT,SAAS;AAAA,IACZ,QACG,SAAO,EACP,SAAS,sDAAsD,EAC/D,SAAS,EACT,SAAS;AAAA,EACd,CAAC,EACA;AAAA,IACC;AAAA,EACF,EACC,SAAS;AAAA,EACZ,SACG;AAAA,IACG,SAAO;AAAA,MACP,QACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,oBACG,SAAO,EACP;AAAA,QACC;AAAA;AAAA;AAAA;AAAA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,UACG,SAAO,EACP;AAAA,QACC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,UACG,SAAO,EACP;AAAA,QACC;AAAA;AAAA;AAAA,MACF,EACC,SAAS;AAAA,MACZ,MACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,OACG;AAAA,QACG;AAAA,UACE,SAAO,CAAC,CAAC;AAAA,UACT,MAAI;AAAA,YACF,SAAO;AAAA,cACP,OAAS,QAAM,EAAE,SAAS;AAAA,cAC1B,OAAS,QAAM,EAAE,SAAS;AAAA,cAC1B,UAAY,QAAM,EAAE,SAAS;AAAA,YAC/B,CAAC;AAAA,YACC,SAAO;AAAA,cACP,OAAS,QAAM,EAAE,SAAS;AAAA,cAC1B,UAAY,QAAM,EAAE,SAAS;AAAA,cAC7B,OAAS,SAAO,EAAE,SAAS,gBAAgB;AAAA,YAC7C,CAAC;AAAA,YACC,SAAO;AAAA,cACP,OAAS,QAAM,EAAE,SAAS;AAAA,cAC1B,UAAY,QAAM,EAAE,SAAS;AAAA,cAC7B,OAAS,SAAO,EAAE,SAAS,gBAAgB;AAAA,YAC7C,CAAC;AAAA,YACC,SAAO;AAAA,cACP,OAAS,QAAM,EAAE,SAAS;AAAA,cAC1B,OAAS,QAAM,EAAE,SAAS;AAAA,cAC1B,UAAY,SAAO,EAAE,SAAS,mBAAmB;AAAA,YACnD,CAAC;AAAA,UACH,CAAC;AAAA,QACH;AAAA,MACF,EACC,SAAS;AAAA,MACZ,MACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,cACG,OAAK,EACL;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,UACG,UAAQ,EACR;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,UACG,SAAS,SAAO,GAAK,MAAI,CAAC,EAC1B;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,OAAS,QAAQ,SAAO,CAAC,EAAE,SAAS;AAAA,MACpC,OAAS,QAAQ,SAAO,CAAC,EAAE,SAAS;AAAA,MACpC,WACG,UAAQ,EACR;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,MACZ,eACG,SAAO,EACP;AAAA,QACC;AAAA,MACF,EACC,SAAS;AAAA,MACZ,mBACG,UAAQ,EACR;AAAA,QACC;AAAA,MACF,EACC,SAAS,EACT,SAAS;AAAA,IACd,CAAC;AAAA,EACH,EACC,SAAS;AAAA,EACZ,QACG;AAAA,IACG;AAAA,MACE,SAAO;AAAA,QACP,cACG,SAAO,EACP,SAAS,eAAe,EACxB,IAAI,CAAC,EACL,IAAI,GAAI,EACR,SAAS;AAAA,QACZ,OACG,SAAO,EACP;AAAA,UACC;AAAA,QACF,EACC;AAAA,UACC;AAAA,UACA;AAAA,QACF,EACC,SAAS,EACT,SAAS;AAAA,MACd,CAAC;AAAA,MACC,MAAI;AAAA,QACF,SAAO;AAAA,UACP,YAAc,QAAM,EAAE,SAAS;AAAA,UAC/B,cAAgB,QAAM,EAAE,SAAS;AAAA,QACnC,CAAC;AAAA,QACC,SAAO;AAAA,UACP,cAAgB,QAAM,EAAE,SAAS;AAAA,UACjC,YACG,SAAO,EACP,SAAS,kCAAkC,EAC3C,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,QACZ,CAAC;AAAA,QACC,SAAO;AAAA,UACP,YAAc,QAAM,EAAE,SAAS;AAAA,UAC/B,cACG,SAAO,EACP,SAAS,sDAAsD,EAC/D,IAAI,CAAC,EACL,IAAI,GAAG;AAAA,QACZ,CAAC;AAAA,MACH,CAAC;AAAA,IACH;AAAA,EACF,EACC,SAAS;AACd,CAAC;AACM,IAAM,kCAAoC,SAAO;AAAA,EACtD,SACG,SAAO,EAAE,aAAe,OAAK,CAAC,aAAa,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC,EACjE,SAAS;AACd,CAAC;AACM,IAAM,mCAAqC,SAAO;AAAA,EACvD,WACG;AAAA,IACG,SAAO;AAAA,MACP,oBAAsB,SAAO,EAAE,SAAS,iBAAiB,EAAE,SAAS;AAAA,MACpE,UAAY,SAAO,EAAE,SAAS,2BAA2B,EAAE,SAAS;AAAA,MACpE,UAAY,SAAO,EAAE,SAAS,2BAA2B,EAAE,SAAS;AAAA,IACtE,CAAC;AAAA,EACH,EACC,SAAS;AACd,CAAC;","names":[]}

package/build/es/schemas.d.mts

@@ -0,0 +1,102 @@
+import * as z from 'zod';
+
+declare const GetSiteStructureRequest: z.ZodObject<{
+    options: z.ZodOptional<z.ZodObject<{
+        pageVersion: z.ZodOptional<z.ZodEnum<{
+            PUBLISHED: "PUBLISHED";
+            SAVED: "SAVED";
+        }>>;
+        paging: z.ZodOptional<z.ZodObject<{
+            limit: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+            cursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>;
+        filter: z.ZodOptional<z.ZodObject<{
+            itemTypeIdentifier: z.ZodOptional<z.ZodString>;
+            sourceId: z.ZodOptional<z.ZodString>;
+            configId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        sorting: z.ZodOptional<z.ZodObject<{
+            fieldName: z.ZodOptional<z.ZodString>;
+            order: z.ZodOptional<z.ZodEnum<{
+                ASC: "ASC";
+                DESC: "DESC";
+            }>>;
+        }, z.core.$strip>>;
+        fieldSet: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        languageMetadata: z.ZodOptional<z.ZodObject<{
+            code: z.ZodOptional<z.ZodString>;
+            tag: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>;
+        branchId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const GetSiteStructureResponse: z.ZodObject<{
+    totalResults: z.ZodOptional<z.ZodNumber>;
+    pageData: z.ZodOptional<z.ZodObject<{
+        count: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        cursor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>;
+    results: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        itemId: z.ZodOptional<z.ZodString>;
+        itemTypeIdentifier: z.ZodOptional<z.ZodString>;
+        sourceId: z.ZodOptional<z.ZodString>;
+        configId: z.ZodOptional<z.ZodString>;
+        name: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        media: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{}, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
+            image: z.ZodOptional<z.ZodNever>;
+            video: z.ZodOptional<z.ZodNever>;
+            document: z.ZodOptional<z.ZodNever>;
+        }, z.core.$strip>, z.ZodObject<{
+            video: z.ZodOptional<z.ZodNever>;
+            document: z.ZodOptional<z.ZodNever>;
+            image: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            image: z.ZodOptional<z.ZodNever>;
+            document: z.ZodOptional<z.ZodNever>;
+            video: z.ZodString;
+        }, z.core.$strip>, z.ZodObject<{
+            image: z.ZodOptional<z.ZodNever>;
+            video: z.ZodOptional<z.ZodNever>;
+            document: z.ZodString;
+        }, z.core.$strip>]>>>>;
+        path: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
+        inactive: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        metadata: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+        image: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        video: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        protected: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        translationId: z.ZodOptional<z.ZodString>;
+        isCustomErrorPage: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    }, z.core.$strip>>>;
+    errors: z.ZodOptional<z.ZodArray<z.ZodIntersection<z.ZodObject<{
+        errorMessage: z.ZodOptional<z.ZodString>;
+        appId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>, z.ZodXor<readonly [z.ZodObject<{
+        itemTypeId: z.ZodOptional<z.ZodNever>;
+        routerPrefix: z.ZodOptional<z.ZodNever>;
+    }, z.core.$strip>, z.ZodObject<{
+        routerPrefix: z.ZodOptional<z.ZodNever>;
+        itemTypeId: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        itemTypeId: z.ZodOptional<z.ZodNever>;
+        routerPrefix: z.ZodString;
+    }, z.core.$strip>]>>>>;
+}, z.core.$strip>;
+declare const GetSiteStructureMetadataRequest: z.ZodObject<{
+    options: z.ZodOptional<z.ZodObject<{
+        pageVersion: z.ZodOptional<z.ZodEnum<{
+            PUBLISHED: "PUBLISHED";
+            SAVED: "SAVED";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const GetSiteStructureMetadataResponse: z.ZodObject<{
+    pageTypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        itemTypeIdentifier: z.ZodOptional<z.ZodString>;
+        sourceId: z.ZodOptional<z.ZodString>;
+        configId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+
+export { GetSiteStructureMetadataRequest, GetSiteStructureMetadataResponse, GetSiteStructureRequest, GetSiteStructureResponse };

package/build/es/schemas.mjs

@@ -0,0 +1,176 @@
+// src/viewer-structure-v1-site-structure-item-site-structure-service.schemas.ts
+import * as z from "zod";
+var GetSiteStructureRequest = z.object({
+  options: z.object({
+    pageVersion: z.enum(["PUBLISHED", "SAVED"]).optional(),
+    paging: z.object({
+      limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(100).optional().nullable(),
+      cursor: z.string().describe(
+        "Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
+      ).max(16e3).optional().nullable()
+    }).describe(
+      "Pagination request metadata, currently applicable for:\\\n- Queries filtered for items from a TPA that is part of the new-integration (TpaSiteStructureService)\n- Queries filtered for dynamic router items from the new dynamic-pages-router integration (DynamicSiteStructureService)"
+    ).optional(),
+    filter: z.object({
+      itemTypeIdentifier: z.string().describe("In accordance to SiteStructureItem.item_type_identifier").optional(),
+      sourceId: z.string().describe("In accordance to SiteStructureItem.source_id").optional(),
+      configId: z.string().describe("In accordance to SiteStructureItem.config_id").optional()
+    }).describe(
+      "Filtering metadata. Only items allowed by the filter will be returned."
+    ).optional(),
+    sorting: z.object({
+      fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
+      order: z.enum(["ASC", "DESC"]).optional()
+    }).describe("General sorting metadata. Currently not supported.").optional(),
+    fieldSet: z.array(z.string()).optional(),
+    languageMetadata: z.object({
+      code: z.string().describe("2 chars language code (e.g. 'en')").optional(),
+      tag: z.string().describe("4 chars language tag (e.g. 'en-us')").optional().nullable()
+    }).describe(
+      "Language metadata. Contains 2 chars language code and/or 4 chars language tag."
+    ).optional(),
+    branchId: z.string().describe(
+      "Used to identify the branch of the site for which the structure is requested."
+    ).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().nullable()
+  }).optional()
+});
+var GetSiteStructureResponse = z.object({
+  totalResults: z.number().int().describe(
+    "The total number of items to be returned, combining all paginated responses."
+  ).optional(),
+  pageData: z.object({
+    count: z.number().int().describe("The item count in the current page").optional().nullable(),
+    cursor: z.string().describe("The cursor which will be used to query the next page").optional().nullable()
+  }).describe(
+    "A cursor based paging response metadata, including the item count in the current page and a cursor string to be used for querying of the next page."
+  ).optional(),
+  results: z.array(
+    z.object({
+      itemId: z.string().describe(
+        "The end goal: this field should contain a unique identifier for this site-structure item.\\\nCurrently it contains:\n- For site-structure integrated TPAs - the unique identifier provided by the TPA.\n- For all other item types - empty string."
+      ).optional(),
+      itemTypeIdentifier: z.string().describe(
+        `An identifier for the type of the item. One of:
+- For the site's static pages - "static_page".
+- For legacy integration TPAs - the TPA's app-def-id.
+- For TPAs with new site-structure integration - the item type identifier provided by the TPA. Commonly one of that TPA's supported sub-pages.
+- For items that are the result of a dynamic router - "dynamic-page".`
+      ).optional(),
+      sourceId: z.string().describe(
+        `An identifier for the source of the item. One of:
+- For the site's static pages - "editor".
+- For legacy integration TPAs - the TPA's app-def-id.
+- For TPAs with new site-structure integration - the TPA's app-def-id.
+- For items that are the result of a dataBinding router - Wix-Data's app-def-id: 'e593b0bd-b783-45b8-97c2-873d42aacaf4'.
+- For items that are the result of a dynamic router - Wix-Code's app-def-id: '675bbcef-18d8-41f5-800e-131ec9e08762'.`
+      ).optional(),
+      configId: z.string().describe(
+        `An identifier for the configuration of the item. Used currently as some sort of a placeholder for further filtering.
+- For items of type "dynamic-page" - The 'prefix' field that is part of the router-config object of the router that is related to this item (see WixCodeDynamicRouterResolver).
+- For all other items types - empty string.`
+      ).optional(),
+      name: z.string().describe(
+        "A human readable name string associated with the item.\\\nCurrently exists only for new TPA site-structure integration items, and contains the 'name' field provided by the TPA for that item.\\\nThis field is not guaranteed to be unique across the item list."
+      ).optional().nullable(),
+      media: z.array(
+        z.intersection(
+          z.object({}),
+          z.xor([
+            z.object({
+              image: z.never().optional(),
+              video: z.never().optional(),
+              document: z.never().optional()
+            }),
+            z.object({
+              video: z.never().optional(),
+              document: z.never().optional(),
+              image: z.string().describe("WixMedia image")
+            }),
+            z.object({
+              image: z.never().optional(),
+              document: z.never().optional(),
+              video: z.string().describe("WixMedia video")
+            }),
+            z.object({
+              image: z.never().optional(),
+              video: z.never().optional(),
+              document: z.string().describe("WixMedia document")
+            })
+          ])
+        )
+      ).optional(),
+      path: z.string().describe(
+        "A relative url path that can be used, with the site's base-url, to reach the page represented by this item."
+      ).optional().nullable(),
+      _updatedDate: z.date().describe(
+        "A timestamp representing the moment that this item was last changed.\n- For static pages - the site's last publish time.\n- For all kinds of TPAs - the last-modified field in the respective response item from the TPA.\n- For items that are the result of a dynamic router - the content of the 'lastModified' optional field in the response item from Wix-Code's RPC endpoint, or, if missing, the site's last publish time. (see WixCodeDynamicRouterResolver)."
+      ).optional().nullable(),
+      inactive: z.boolean().describe(
+        "A value indicating whether the item is inactive or not. E.g. hidden product/finished event etc.\\\nCurrently exists only for new TPA site-structure integration items, and contains the 'inactive' field provided by the TPA for that item."
+      ).optional().nullable(),
+      metadata: z.record(z.string(), z.any()).describe(
+        'A general free schema field to include further metadata related to this item.\\\nCurrently exists only for:\\\nStatic pages - a JSON that is the merge of:\n1. The advancedSeoData JSON string that exists for the page in the master-page.\n2. A JSON of the form:\n```javascript\n{\n"seo_legacy": {\n"hidden_from_seo": true / false\n},\n"password_protected": true / false\n}\n```\nNew TPA site-structure integration items - the \'metadata\' field provided by the TPA for that item.'
+      ).optional().nullable(),
+      image: z.array(z.string()).optional(),
+      video: z.array(z.string()).optional(),
+      protected: z.boolean().describe(
+        "A value indicating whether the item is protected or not, by password or login."
+      ).optional().nullable(),
+      translationId: z.string().describe(
+        "ID of the translations of the item. As same item can have multiple instances, one for each language, we can match them by this ID.\\\nFor example:\nBlog has one post, translated to 2 languages (EN, FR):\n- EN item path is `/amazing-post`\n- FR item path is `/poste-incroyable\nBoth of them might have different `item_id`, but will share the same `translation_id`, to be easily match together\nCurrently only relevant for Blog"
+      ).optional(),
+      isCustomErrorPage: z.boolean().describe(
+        "A value indicating whether the item is a custom error page or not."
+      ).optional().nullable()
+    })
+  ).optional(),
+  errors: z.array(
+    z.intersection(
+      z.object({
+        errorMessage: z.string().describe("Error message").min(1).max(1e3).optional(),
+        appId: z.string().describe(
+          "if the fetch happened while fetching links from a TPA, this will hold the TPA appDefId"
+        ).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().nullable()
+      }),
+      z.xor([
+        z.object({
+          itemTypeId: z.never().optional(),
+          routerPrefix: z.never().optional()
+        }),
+        z.object({
+          routerPrefix: z.never().optional(),
+          itemTypeId: z.string().describe("item type id of the failed fetch").min(1).max(200)
+        }),
+        z.object({
+          itemTypeId: z.never().optional(),
+          routerPrefix: z.string().describe("for dynamic pages: router prefix of the failed fetch").min(1).max(200)
+        })
+      ])
+    )
+  ).optional()
+});
+var GetSiteStructureMetadataRequest = z.object({
+  options: z.object({ pageVersion: z.enum(["PUBLISHED", "SAVED"]).optional() }).optional()
+});
+var GetSiteStructureMetadataResponse = z.object({
+  pageTypes: z.array(
+    z.object({
+      itemTypeIdentifier: z.string().describe("Type identifier").optional(),
+      sourceId: z.string().describe("Site's page-type sourceId").optional(),
+      configId: z.string().describe("Site's page-type configId").optional()
+    })
+  ).optional()
+});
+export {
+  GetSiteStructureMetadataRequest,
+  GetSiteStructureMetadataResponse,
+  GetSiteStructureRequest,
+  GetSiteStructureResponse
+};
+//# sourceMappingURL=schemas.mjs.map