@wix/auto_sdk_dynamic-page-router_pages 1.0.0

package/build/internal/es/meta.d.mts

@@ -0,0 +1,345 @@
+import { GetRouterSitemapCountRequest as GetRouterSitemapCountRequest$1, GetRouterSitemapCountResponse as GetRouterSitemapCountResponse$1, GetRouterSitemapRequest as GetRouterSitemapRequest$1, GetRouterSitemapResponse as GetRouterSitemapResponse$1, GetRouterPagesRequest as GetRouterPagesRequest$1, GetRouterPagesResponse as GetRouterPagesResponse$1, GetRouterPagesCachedRequest as GetRouterPagesCachedRequest$1, GetDraftPreviewTokenRequest as GetDraftPreviewTokenRequest$1, GetDraftPreviewTokenResponse as GetDraftPreviewTokenResponse$1 } from './index.typings.mjs';
+import '@wix/sdk-types';
+
+/** Stub entity, not used at the moment. */
+interface Page {
+    /**
+     * Page ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+}
+interface GetRouterSitemapCountRequest {
+    /**
+     * Router prefix that identifies the page type or origin. For TPA (Third-Party Application) pages, this contains the TPA page ID.
+     * @maxLength 2048
+     */
+    routerPrefix?: string;
+    /** Config containing request patterns, e.g. '/{title}' */
+    config?: Config;
+    /** Map of page roles containing page ID and title of each role */
+    pageRoles?: Record<string, PageRole>;
+    /**
+     * Optional page name to filter patterns by matching page role title
+     * @maxLength 200
+     */
+    pageName?: string;
+    /**
+     * Query param mapped to body, editor/site
+     * @maxLength 200
+     */
+    viewMode?: string;
+    /**
+     * Query param mapped to body, unique for Wix code app
+     * @format GUID
+     */
+    gridAppId?: string | null;
+}
+interface Config {
+    /** Map of URL patterns to their configurations. The key is the URL pattern (e.g., `/{title}`) and the value contains the pattern configuration. */
+    patterns?: Record<string, Pattern>;
+    /** Maps rule ID → PageRule (filter + variant page role). */
+    rules?: Record<string, PageRule>;
+    /** Maps original page role ID → ordered rule IDs. First matching rule wins. */
+    roleVariations?: Record<string, any[]>;
+}
+interface Pattern {
+    /**
+     * Page role identifier that links this pattern to a specific page template.
+     * @maxLength 200
+     */
+    pageRole?: string;
+    /**
+     * Title pattern with field interpolation (e.g., "{title}, {author} - {category}").
+     * Increased to 50000 to support complex title templates with many interpolated fields and long text content.
+     * @maxLength 50000
+     */
+    title?: string;
+    /** Configuration specifying which collection to query and any filters to apply. */
+    config?: PatternConfig;
+    /** SEO meta tags to be included in the page head. Keys are meta tag names, values are the content. */
+    seoMetaTags?: Record<string, string>;
+}
+interface PatternConfig {
+    /**
+     * Name of the Wix Data collection to query for dynamic content.
+     * @maxLength 200
+     */
+    collection?: string;
+    /** Filter criteria to apply when querying the collection. Uses MongoDB-style query syntax to limit which items generate routes. */
+    filter?: Record<string, any> | null;
+    /** Indicates if URLs in sitemap should be turned to lowercase. Defaults to true if not set. */
+    lowercase?: boolean | null;
+    /**
+     * The field id that gets added to DataCollection and DataItems.
+     * Indicates that page links is a slug based and items should be retrieved by slug fields present in the pattern.
+     * @maxLength 1000
+     */
+    pageLinkId?: string | null;
+    /**
+     * Sort specification for query results. Each struct contains field name and direction (asc/desc).
+     * @maxSize 32
+     */
+    sort?: Record<string, any>[] | null;
+    /** Page size for pagination. */
+    pageSize?: number | null;
+    /** SEO v2 flag. */
+    seoV2?: boolean | null;
+    /** Cursor-based pagination flag. */
+    cursor?: boolean | null;
+    /**
+     * Dataset includes array for passthrough config.
+     * @maxSize 100
+     * @maxLength 1000
+     */
+    includes?: string[];
+}
+/** A variant rule: if filter matches the fetched data item, use page_role instead of the original. */
+interface PageRule {
+    /**
+     * Variant page role ID to return when this rule matches.
+     * @maxLength 200
+     */
+    pageRole?: string;
+    /** Wix Data filter evaluated against the fetched item. */
+    filter?: Record<string, any> | null;
+    /**
+     * Human-readable rule name (for debugging/logging).
+     * @maxLength 200
+     */
+    name?: string | null;
+}
+interface PageRole {
+    /**
+     * Page role ID that uniquely identifies the page template.
+     * @maxLength 200
+     */
+    id?: string;
+    /**
+     * Human-readable title for the page role.
+     * @maxLength 200
+     */
+    title?: string;
+}
+interface GetRouterSitemapCountResponse {
+    /** List of count results grouped by page name. */
+    result?: RouterCountItem[];
+}
+interface RouterCountItem {
+    /**
+     * Name of the dynamic page template.
+     * @maxLength 200
+     */
+    pageName?: string;
+    /** Number of inner routes for the given page. Capped at 1,000 for performance. */
+    count?: number;
+}
+interface GetRouterSitemapRequest {
+    /**
+     * Full URL to the inner route
+     * @maxLength 2048
+     */
+    fullUrl?: string;
+    /**
+     * Router prefix (TPA page ID for TPA pages)
+     * @maxLength 2048
+     */
+    routerPrefix?: string;
+    /**
+     * Optional page name to filter patterns by matching page role title
+     * @maxLength 2048
+     */
+    pageName?: string;
+    /** Config containing request patterns, e.g. '/{title}' */
+    config?: Config;
+    /** Map of page roles containing page ID and title of each role */
+    pageRoles?: Record<string, PageRole>;
+    /**
+     * Query param mapped to body, editor/site
+     * @maxLength 200
+     */
+    viewMode?: string;
+    /**
+     * Query param mapped to body, unique for Wix code app
+     * @format GUID
+     */
+    gridAppId?: string | null;
+}
+interface GetRouterSitemapResponse {
+    /** List of sitemap entries containing URLs and metadata for dynamic pages. */
+    result?: RouterRouteItem[];
+}
+interface RouterRouteItem {
+    /**
+     * URL to inner route relative to current domain
+     * @maxLength 500
+     */
+    url?: string;
+    /**
+     * Dynamic page name
+     * @maxLength 200
+     */
+    pageName?: string;
+    /**
+     * Title of the specific route, typically derived from collection data.
+     * @maxLength 200
+     */
+    title?: string;
+    /**
+     * Change frequency for sitemap SEO purposes (e.g., `daily`, `weekly`, `monthly`).
+     * @maxLength 100
+     */
+    changeFrequency?: string;
+    /**
+     * Last modified timestamp in ISO 8601 format.
+     * @maxLength 100
+     */
+    lastModified?: string | null;
+    /** Priority for sitemap SEO purposes (0.0 to 1.0). */
+    priority?: number;
+}
+interface GetRouterPagesRequest {
+    /**
+     * Complete URL to the inner route. Used for context-aware processing and as a base for relative URL resolution.
+     * Increased to 8192 to accommodate URLs with extensive query parameters (tracking, analytics, UTM params, etc.)
+     * @maxLength 8192
+     */
+    fullUrl?: string;
+    /**
+     * Router prefix (TPA page ID for TPA pages)
+     * @maxLength 2048
+     */
+    routerPrefix?: string;
+    /**
+     * Inner route suffix containing the dynamic part of the URL pattern. For example, `/{title}` or `/category/{category}/post/{slug}`.
+     * Increased to 8192 to match full_url capacity for complex dynamic routes
+     * @maxLength 8192
+     */
+    routerSuffix?: string;
+    /** Additional request information including form factor (desktop/mobile) for device-appropriate routing. */
+    requestInfo?: RequestInfo;
+    /** Config containing request patterns, e.g. '/{title}' */
+    config?: Config;
+    /** Map of page roles containing page ID and title of each role */
+    pageRoles?: Record<string, PageRole>;
+    /**
+     * Query param mapped to body, editor/site
+     * @maxLength 200
+     */
+    viewMode?: string;
+    /**
+     * Query param mapped to body, unique for Wix code app
+     * @format GUID
+     */
+    gridAppId?: string | null;
+}
+interface RequestInfo {
+    /**
+     * Device form factor, typically `desktop` or `mobile`. Used to serve device-appropriate page layouts.
+     * @maxLength 200
+     */
+    formFactor?: string;
+}
+interface GetRouterPagesResponse {
+    /** Page resolution result containing status, data, and metadata. */
+    result?: RouterPagesResult;
+}
+interface RouterPagesResult {
+    /** HTTP status code of the page (200, 302, 404) */
+    status?: number;
+    /**
+     * Name of the dynamic page template that should be used for rendering.
+     * @maxLength 200
+     */
+    page?: string;
+    /** Application router data available only to internal Wix apps. Contains system-level and administrative information. */
+    data?: Record<string, any> | null;
+    /** SEO and metadata information for the page head section. */
+    head?: RouterPageHead;
+    /**
+     * Error message when status indicates an error condition.
+     * @maxLength 500
+     */
+    message?: string;
+    /**
+     * Target URL for redirects when status is 302.
+     * @maxLength 2048
+     */
+    redirectUrl?: string;
+}
+interface RouterPageHead {
+    /**
+     * Page title for SEO and browser display.
+     * @maxLength 200
+     */
+    title?: string;
+    /** Meta tags for SEO optimization. Keys are meta tag names, values are the content. */
+    metaTags?: Record<string, string>;
+    /**
+     * Page description for SEO. Extracted from seoMetaTags if present.
+     * @maxLength 5000
+     */
+    description?: string;
+    /**
+     * Keywords for SEO. Extracted from seoMetaTags if present.
+     * @maxLength 5000
+     */
+    keywords?: string;
+    /**
+     * NoIndex directive for search engines. Extracted from seoMetaTags if present.
+     * @maxLength 500
+     */
+    noIndex?: string;
+}
+/** Viewer GET request: .r parameter containing {urlParams, body} envelope. */
+interface GetRouterPagesCachedRequest {
+    /** URL parameters from the viewer's query string. */
+    urlParams?: GetRouterPagesCachedUrlParams;
+    /** Request body from the viewer's envelope. */
+    body?: GetRouterPagesRequest;
+}
+interface GetRouterPagesCachedUrlParams {
+    /**
+     * Unique for Wix code app
+     * @format GUID
+     */
+    gridAppId?: string | null;
+    /**
+     * Editor/site
+     * @maxLength 200
+     */
+    viewMode?: string;
+}
+interface GetDraftPreviewTokenRequest {
+    /**
+     * Wix Data collection ID to get a draft preview key for.
+     * @maxLength 256
+     */
+    collectionId?: string;
+}
+interface GetDraftPreviewTokenResponse {
+    /**
+     * Draft preview token.
+     * @maxLength 10000
+     */
+    token?: string;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getRouterSitemapCount(): __PublicMethodMetaInfo<'POST', {}, GetRouterSitemapCountRequest$1, GetRouterSitemapCountRequest, GetRouterSitemapCountResponse$1, GetRouterSitemapCountResponse>;
+declare function getRouterSitemap(): __PublicMethodMetaInfo<'POST', {}, GetRouterSitemapRequest$1, GetRouterSitemapRequest, GetRouterSitemapResponse$1, GetRouterSitemapResponse>;
+declare function getRouterPages(): __PublicMethodMetaInfo<'POST', {}, GetRouterPagesRequest$1, GetRouterPagesRequest, GetRouterPagesResponse$1, GetRouterPagesResponse>;
+declare function getRouterPagesCached(): __PublicMethodMetaInfo<'GET', {}, GetRouterPagesCachedRequest$1, GetRouterPagesCachedRequest, GetRouterPagesResponse$1, GetRouterPagesResponse>;
+declare function getDraftPreviewToken(): __PublicMethodMetaInfo<'POST', {}, GetDraftPreviewTokenRequest$1, GetDraftPreviewTokenRequest, GetDraftPreviewTokenResponse$1, GetDraftPreviewTokenResponse>;
+
+export { type Config as ConfigOriginal, type GetDraftPreviewTokenRequest as GetDraftPreviewTokenRequestOriginal, type GetDraftPreviewTokenResponse as GetDraftPreviewTokenResponseOriginal, type GetRouterPagesCachedRequest as GetRouterPagesCachedRequestOriginal, type GetRouterPagesCachedUrlParams as GetRouterPagesCachedUrlParamsOriginal, type GetRouterPagesRequest as GetRouterPagesRequestOriginal, type GetRouterPagesResponse as GetRouterPagesResponseOriginal, type GetRouterSitemapCountRequest as GetRouterSitemapCountRequestOriginal, type GetRouterSitemapCountResponse as GetRouterSitemapCountResponseOriginal, type GetRouterSitemapRequest as GetRouterSitemapRequestOriginal, type GetRouterSitemapResponse as GetRouterSitemapResponseOriginal, type Page as PageOriginal, type PageRole as PageRoleOriginal, type PageRule as PageRuleOriginal, type PatternConfig as PatternConfigOriginal, type Pattern as PatternOriginal, type RequestInfo as RequestInfoOriginal, type RouterCountItem as RouterCountItemOriginal, type RouterPageHead as RouterPageHeadOriginal, type RouterPagesResult as RouterPagesResultOriginal, type RouterRouteItem as RouterRouteItemOriginal, type __PublicMethodMetaInfo, getDraftPreviewToken, getRouterPages, getRouterPagesCached, getRouterSitemap, getRouterSitemapCount };

package/build/internal/es/meta.mjs

@@ -0,0 +1,356 @@
+// src/dynamic-page-router-v1-page-pages.http.ts
+import { toURLSearchParams } from "@wix/sdk-runtime/rest-modules";
+import { transformRESTFloatToSDKFloat } from "@wix/sdk-runtime/transformations/float";
+import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
+import { resolveUrl } from "@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 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) => transformPaths(payload2, [
+        {
+          transformFn: 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: 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.meta.ts
+function getRouterSitemapCount2() {
+  const payload = {};
+  const getRequestOptions = getRouterSitemapCount(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/sitemapCount",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function getRouterSitemap2() {
+  const payload = {};
+  const getRequestOptions = getRouterSitemap(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/sitemap",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function getRouterPages2() {
+  const payload = {};
+  const getRequestOptions = getRouterPages(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/pages",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function getRouterPagesCached2() {
+  const payload = {};
+  const getRequestOptions = getRouterPagesCached(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "GET",
+    path: "/v1/pages",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function getDraftPreviewToken2() {
+  const payload = {};
+  const getRequestOptions = getDraftPreviewToken(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/draft-preview-token",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+export {
+  getDraftPreviewToken2 as getDraftPreviewToken,
+  getRouterPages2 as getRouterPages,
+  getRouterPagesCached2 as getRouterPagesCached,
+  getRouterSitemap2 as getRouterSitemap,
+  getRouterSitemapCount2 as getRouterSitemapCount
+};
+//# sourceMappingURL=meta.mjs.map