@wix/auto_sdk_dynamic-page-router_pages 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,57 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { GetRouterSitemapCountOptions, GetRouterSitemapCountResponse, GetRouterSitemapOptions, GetRouterSitemapResponse, GetRouterPagesOptions, GetRouterPagesResponse, GetRouterPagesCachedOptions, GetDraftPreviewTokenOptions, GetDraftPreviewTokenResponse } from './index.typings.js';
+export { Config, GetDraftPreviewTokenRequest, GetRouterPagesCachedRequest, GetRouterPagesCachedUrlParams, GetRouterPagesRequest, GetRouterSitemapCountRequest, GetRouterSitemapRequest, Page, PageRole, PageRule, Pattern, PatternConfig, RequestInfo, RouterCountItem, RouterPageHead, RouterPagesResult, RouterRouteItem } from './index.typings.js';
+
+declare function getRouterSitemapCount$1(httpClient: HttpClient): GetRouterSitemapCountSignature;
+interface GetRouterSitemapCountSignature {
+    /**
+     * Returns the count of sitemap entries grouped by page name.
+     *
+     * Use this endpoint for analytics dashboards, capacity planning, and understanding
+     * the scale of dynamic content without retrieving actual URLs. Results are capped
+     * at 1,000 items per pattern for performance.
+     */
+    (options?: GetRouterSitemapCountOptions): Promise<NonNullablePaths<GetRouterSitemapCountResponse, `result` | `result.${number}.pageName` | `result.${number}.count`, 4>>;
+}
+declare function getRouterSitemap$1(httpClient: HttpClient): GetRouterSitemapSignature;
+interface GetRouterSitemapSignature {
+    /**
+     * Returns sitemap entries containing URLs, page names, and page titles.
+     *
+     * Use this endpoint to generate XML sitemaps for search engines, build navigation
+     * menus, or provide URL listings to external systems. The `fullUrl` parameter
+     * provides context for scoping sitemap generation to specific domains or URL hierarchies.
+     */
+    (options?: GetRouterSitemapOptions): Promise<NonNullablePaths<GetRouterSitemapResponse, `result` | `result.${number}.url` | `result.${number}.pageName` | `result.${number}.title` | `result.${number}.changeFrequency` | `result.${number}.priority`, 4>>;
+}
+declare function getRouterPages$1(httpClient: HttpClient): GetRouterPagesSignature;
+interface GetRouterPagesSignature {
+    /**
+     * Returns comprehensive page information for a specific route.
+     * Called by the editor via POST with flat body + query params.
+     */
+    (options?: GetRouterPagesOptions): Promise<NonNullablePaths<GetRouterPagesResponse, `result.status` | `result.page` | `result.head.title` | `result.head.description` | `result.head.keywords` | `result.head.noIndex` | `result.message` | `result.redirectUrl`, 4>>;
+}
+declare function getRouterPagesCached$1(httpClient: HttpClient): GetRouterPagesCachedSignature;
+interface GetRouterPagesCachedSignature {
+    /**
+     * Returns comprehensive page information for a specific route (cacheable).
+     * Called by the viewer via GET with .r parameter containing {urlParams, body} envelope.
+     */
+    (options?: GetRouterPagesCachedOptions): Promise<NonNullablePaths<GetRouterPagesResponse, `result.status` | `result.page` | `result.head.title` | `result.head.description` | `result.head.keywords` | `result.head.noIndex` | `result.message` | `result.redirectUrl`, 4>>;
+}
+declare function getDraftPreviewToken$1(httpClient: HttpClient): GetDraftPreviewTokenSignature;
+interface GetDraftPreviewTokenSignature {
+    /**
+     * Returns the preview token used for draft collection previews.
+     */
+    (options?: GetDraftPreviewTokenOptions): Promise<NonNullablePaths<GetDraftPreviewTokenResponse, `token`, 2>>;
+}
+
+declare const getRouterSitemapCount: MaybeContext<BuildRESTFunction<typeof getRouterSitemapCount$1> & typeof getRouterSitemapCount$1>;
+declare const getRouterSitemap: MaybeContext<BuildRESTFunction<typeof getRouterSitemap$1> & typeof getRouterSitemap$1>;
+declare const getRouterPages: MaybeContext<BuildRESTFunction<typeof getRouterPages$1> & typeof getRouterPages$1>;
+declare const getRouterPagesCached: MaybeContext<BuildRESTFunction<typeof getRouterPagesCached$1> & typeof getRouterPagesCached$1>;
+declare const getDraftPreviewToken: MaybeContext<BuildRESTFunction<typeof getDraftPreviewToken$1> & typeof getDraftPreviewToken$1>;
+
+export { GetDraftPreviewTokenOptions, GetDraftPreviewTokenResponse, GetRouterPagesCachedOptions, GetRouterPagesOptions, GetRouterPagesResponse, GetRouterSitemapCountOptions, GetRouterSitemapCountResponse, GetRouterSitemapOptions, GetRouterSitemapResponse, getDraftPreviewToken, getRouterPages, getRouterPagesCached, getRouterSitemap, getRouterSitemapCount };

package/build/cjs/index.js

@@ -0,0 +1,517 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+__export(index_exports, {
+  getDraftPreviewToken: () => getDraftPreviewToken4,
+  getRouterPages: () => getRouterPages4,
+  getRouterPagesCached: () => getRouterPagesCached4,
+  getRouterSitemap: () => getRouterSitemap4,
+  getRouterSitemapCount: () => getRouterSitemapCount4
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/dynamic-page-router-v1-page-pages.universal.ts
+var import_transform_error = require("@wix/sdk-runtime/transform-error");
+var import_rename_all_nested_keys = require("@wix/sdk-runtime/rename-all-nested-keys");
+
+// src/dynamic-page-router-v1-page-pages.http.ts
+var import_rest_modules = require("@wix/sdk-runtime/rest-modules");
+var import_float = require("@wix/sdk-runtime/transformations/float");
+var import_transform_paths = require("@wix/sdk-runtime/transformations/transform-paths");
+var import_rest_modules2 = require("@wix/sdk-runtime/rest-modules");
+function resolveWixDynamicPageRouterV1DynamicPageRouterUrl(opts) {
+  const domainToMappings = {
+    "editor._base_domain_": [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "blocks._base_domain_": [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "create.editorx": [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    _: [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "dev._base_domain_": [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "api._api_base_domain_": [
+      {
+        srcPath: "/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "www._base_domain_": [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "bo._base_domain_": [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "wixbo.ai": [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "wix-bo.com": [
+      {
+        srcPath: "/_api/dynamic-pages-router",
+        destPath: ""
+      },
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "manage._base_domain_": [
+      {
+        srcPath: "/_api/dynamic-page-router",
+        destPath: ""
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/dynamic-page-router/v1/pages",
+        destPath: "/v1/pages"
+      },
+      {
+        srcPath: "/dynamic-page-router/v1/sitemap",
+        destPath: "/v1/sitemap"
+      },
+      {
+        srcPath: "/dynamic-page-router/v1/draft-preview-token",
+        destPath: "/v1/draft-preview-token"
+      }
+    ],
+    "*.dev.wix-code.com": [
+      {
+        srcPath: "/dynamic-page-router/v1/pages",
+        destPath: "/v1/pages"
+      },
+      {
+        srcPath: "/dynamic-page-router/v1/sitemap",
+        destPath: "/v1/sitemap"
+      },
+      {
+        srcPath: "/dynamic-page-router/v1/draft-preview-token",
+        destPath: "/v1/draft-preview-token"
+      }
+    ]
+  };
+  return (0, import_rest_modules2.resolveUrl)(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_dynamic-page-router_pages";
+function getRouterSitemapCount(payload) {
+  function __getRouterSitemapCount({ host }) {
+    const metadata = {
+      entityFqdn: "wix.dynamic_page_router.v1.page",
+      method: "POST",
+      methodFqn: "wix.dynamic_page_router.v1.DynamicPageRouter.GetRouterSitemapCount",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixDynamicPageRouterV1DynamicPageRouterUrl({
+        protoPath: "/v1/sitemapCount",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __getRouterSitemapCount;
+}
+function getRouterSitemap(payload) {
+  function __getRouterSitemap({ host }) {
+    const metadata = {
+      entityFqdn: "wix.dynamic_page_router.v1.page",
+      method: "POST",
+      methodFqn: "wix.dynamic_page_router.v1.DynamicPageRouter.GetRouterSitemap",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixDynamicPageRouterV1DynamicPageRouterUrl({
+        protoPath: "/v1/sitemap",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => (0, import_transform_paths.transformPaths)(payload2, [
+        {
+          transformFn: import_float.transformRESTFloatToSDKFloat,
+          paths: [{ path: "result.priority" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getRouterSitemap;
+}
+function getRouterPages(payload) {
+  function __getRouterPages({ host }) {
+    const metadata = {
+      entityFqdn: "wix.dynamic_page_router.v1.page",
+      method: "POST",
+      methodFqn: "wix.dynamic_page_router.v1.DynamicPageRouter.GetRouterPages",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixDynamicPageRouterV1DynamicPageRouterUrl({
+        protoPath: "/v1/pages",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __getRouterPages;
+}
+function getRouterPagesCached(payload) {
+  function __getRouterPagesCached({ host }) {
+    const metadata = {
+      entityFqdn: "wix.dynamic_page_router.v1.page",
+      method: "GET",
+      methodFqn: "wix.dynamic_page_router.v1.DynamicPageRouter.GetRouterPagesCached",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixDynamicPageRouterV1DynamicPageRouterUrl({
+        protoPath: "/v1/pages",
+        data: payload,
+        host
+      }),
+      params: (0, import_rest_modules.toURLSearchParams)(payload, true)
+    };
+    return metadata;
+  }
+  return __getRouterPagesCached;
+}
+function getDraftPreviewToken(payload) {
+  function __getDraftPreviewToken({ host }) {
+    const metadata = {
+      entityFqdn: "wix.dynamic_page_router.v1.page",
+      method: "POST",
+      methodFqn: "wix.dynamic_page_router.v1.DynamicPageRouter.GetDraftPreviewToken",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixDynamicPageRouterV1DynamicPageRouterUrl({
+        protoPath: "/v1/draft-preview-token",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __getDraftPreviewToken;
+}
+
+// src/dynamic-page-router-v1-page-pages.universal.ts
+async function getRouterSitemapCount2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    routerPrefix: options?.routerPrefix,
+    config: options?.config,
+    pageRoles: options?.pageRoles,
+    pageName: options?.pageName,
+    viewMode: options?.viewMode,
+    gridAppId: options?.gridAppId
+  });
+  const reqOpts = getRouterSitemapCount(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          routerPrefix: "$[0].routerPrefix",
+          config: "$[0].config",
+          pageRoles: "$[0].pageRoles",
+          pageName: "$[0].pageName",
+          viewMode: "$[0].viewMode",
+          gridAppId: "$[0].gridAppId"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function getRouterSitemap2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    fullUrl: options?.fullUrl,
+    routerPrefix: options?.routerPrefix,
+    pageName: options?.pageName,
+    config: options?.config,
+    pageRoles: options?.pageRoles,
+    viewMode: options?.viewMode,
+    gridAppId: options?.gridAppId
+  });
+  const reqOpts = getRouterSitemap(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          fullUrl: "$[0].fullUrl",
+          routerPrefix: "$[0].routerPrefix",
+          pageName: "$[0].pageName",
+          config: "$[0].config",
+          pageRoles: "$[0].pageRoles",
+          viewMode: "$[0].viewMode",
+          gridAppId: "$[0].gridAppId"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function getRouterPages2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    fullUrl: options?.fullUrl,
+    routerPrefix: options?.routerPrefix,
+    routerSuffix: options?.routerSuffix,
+    requestInfo: options?.requestInfo,
+    config: options?.config,
+    pageRoles: options?.pageRoles,
+    viewMode: options?.viewMode,
+    gridAppId: options?.gridAppId
+  });
+  const reqOpts = getRouterPages(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          fullUrl: "$[0].fullUrl",
+          routerPrefix: "$[0].routerPrefix",
+          routerSuffix: "$[0].routerSuffix",
+          requestInfo: "$[0].requestInfo",
+          config: "$[0].config",
+          pageRoles: "$[0].pageRoles",
+          viewMode: "$[0].viewMode",
+          gridAppId: "$[0].gridAppId"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function getRouterPagesCached2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    urlParams: options?.urlParams,
+    body: options?.body
+  });
+  const reqOpts = getRouterPagesCached(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          urlParams: "$[0].urlParams",
+          body: "$[0].body"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function getDraftPreviewToken2(options) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    collectionId: options?.collectionId
+  });
+  const reqOpts = getDraftPreviewToken(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { collectionId: "$[0].collectionId" },
+        singleArgumentUnchanged: false
+      },
+      ["options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+
+// src/dynamic-page-router-v1-page-pages.public.ts
+function getRouterSitemapCount3(httpClient) {
+  return (options) => getRouterSitemapCount2(
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+function getRouterSitemap3(httpClient) {
+  return (options) => getRouterSitemap2(
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+function getRouterPages3(httpClient) {
+  return (options) => getRouterPages2(
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+function getRouterPagesCached3(httpClient) {
+  return (options) => getRouterPagesCached2(
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+function getDraftPreviewToken3(httpClient) {
+  return (options) => getDraftPreviewToken2(
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+
+// src/dynamic-page-router-v1-page-pages.context.ts
+var import_rest_modules3 = require("@wix/sdk-runtime/rest-modules");
+var getRouterSitemapCount4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getRouterSitemapCount3);
+var getRouterSitemap4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getRouterSitemap3);
+var getRouterPages4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getRouterPages3);
+var getRouterPagesCached4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getRouterPagesCached3);
+var getDraftPreviewToken4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getDraftPreviewToken3);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getDraftPreviewToken,
+  getRouterPages,
+  getRouterPagesCached,
+  getRouterSitemap,
+  getRouterSitemapCount
+});
+//# sourceMappingURL=index.js.map