@wix/auto_sdk_seo_seo-patterns 1.0.0 → 1.0.1

package/build/internal/cjs/index.typings.d.ts

@@ -4,7 +4,7 @@ import { NonNullablePaths } from '@wix/sdk-types';
  * An SEO pattern is a template of SEO tags defined for one page type, such as every blog
  * post or every store product. A pattern's tags may contain variables, written as
  * `{{variable}}`, that are filled in with each item's own values when its page renders,
- * so a site owner sets the tags for a whole page type once instead of item by item.
+ * so a Wix user sets the tags for a whole page type once instead of item by item.
  *
  * Every page type always has a pattern in effect. When a site has no pattern of its own
  * for a page type, the built-in Wix default applies, and `source` reports which of the
@@ -26,14 +26,6 @@ interface SeoPattern {
     /**
      * Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or
      * `STORES_PRODUCT`.
-     *
-     * Calling with a page type Wix doesn't recognize fails with `UNSUPPORTED_PAGE_TYPE`,
-     * and the error lists the page types that are supported. For a page type provided by a
-     * Wix app, such as `BLOG_POST`, the app must be installed on the site.
-     *
-     * Page types aren't the same set as the item types of the Item SEO Tags API: a page
-     * type can support a pattern without supporting tags set per item, and the other way
-     * round.
      * @maxLength 100
      * @readonly
      */
@@ -42,9 +34,7 @@ interface SeoPattern {
      * ID of a single page built from a Wix Data collection, when the pattern applies to
      * that page alone rather than to the whole page type.
      *
-     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
-     * pattern for the type, and passing a page ID for one of those fails with
-     * `PAGE_ID_NOT_SUPPORTED`.
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type.
      * @maxLength 200
      */
     pageId?: string | null;
@@ -53,16 +43,14 @@ interface SeoPattern {
      * default.
      *
      * Empty when the site has no pattern of its own, in which case `defaultPattern`
-     * applies. Setting this field replaces the pattern in full, so send the complete set of
-     * tag templates you want the page type to have.
+     * applies.
      */
     pattern?: SeoPatternBlob;
     /**
      * The pattern Wix provides for the page type, which applies whenever the site has no
      * pattern of its own.
      *
-     * Always returned, so you can compare a customized pattern with the one it started
-     * from, and see what a reset would restore.
+     * Always returned, so you can see what a reset would restore.
      * @readonly
      */
     defaultPattern?: SeoPatternBlob;
@@ -81,12 +69,13 @@ interface SeoPattern {
      */
     language?: string | null;
     /**
-     * What made the most recent change to the pattern, for example a user or the site
+     * What made the most recent change to the pattern, for example a Wix user or the site
      * migration flow. Derived from the caller, not from the request.
      *
-     * `ORIGIN_UNSPECIFIED` when the caller isn't one Wix identifies as a specific origin.
-     * Origin isn't stored with the pattern either, so Get SEO Pattern and List SEO Patterns
-     * always return `ORIGIN_UNSPECIFIED`.
+     * Reported only on the response to a write, and on the event the write emits. It isn't
+     * stored with the pattern, so Get SEO Pattern and List SEO Patterns always report
+     * `ORIGIN_UNSPECIFIED`, as does a write by a caller Wix doesn't identify as a specific
+     * origin.
      * @readonly
      */
     origin?: OriginWithLiterals;
@@ -102,10 +91,13 @@ interface SeoPatternBlob {
     /**
      * The pattern's SEO tag templates.
      *
-     * A tag may reference only the variables the page type offers. Call List SEO Pattern
-     * Variables for the page type to retrieve them.
+     * A tag may reference only the variables the page type offers. Call [List SEO Pattern
+     * Variables](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/list-seo-pattern-variables)
+     * for the page type to retrieve them.
      *
-     * Max: 100 tags
+     * A tag whose `disabled` or `custom` value is itself a variable is returned with that
+     * value unset, because those fields are booleans. The behavior still applies when the
+     * page renders.
      * @maxSize 100
      */
     tags?: Tag[];
@@ -176,16 +168,15 @@ interface GetSeoPatternRequest {
      * ID of a single page built from a Wix Data collection, to retrieve the pattern of that
      * page alone.
      *
-     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
-     * pattern for the type, and passing a page ID for one of those fails with
-     * `PAGE_ID_NOT_SUPPORTED`.
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type.
      * @maxLength 200
      */
     pageId?: string | null;
     /**
-     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     * Not supported yet.
      *
-     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * To address a single page built from a Wix Data collection, specify its `pageId`.
+     * @internal
      * @maxLength 200
      */
     collectionName?: string | null;
@@ -221,6 +212,9 @@ interface ListSeoPatternVariablesResponse {
     /**
      * Variables a pattern for this page type may use in its tags. For example,
      * `{{product.name}}` in a title template.
+     *
+     * A variable can appear more than once, with different `userVisible` values, when both
+     * the site and the page type offer it. Either entry can be used in a pattern.
      * @maxSize 500
      */
     variables?: SeoPatternVariable[];
@@ -244,17 +238,18 @@ interface SeoPatternVariable {
      */
     key?: string;
     /**
-     * Whether Wix offers this variable to site owners editing the pattern in the dashboard.
+     * Whether the variable appears in the list shown to Wix users editing the pattern in the
+     * dashboard.
      *
-     * `false` doesn't prevent a pattern from using the variable. It marks a variable Wix
-     * keeps out of the dashboard's list, typically because it's only meaningful in specific
+     * `false` doesn't prevent a pattern from using the variable. It marks a variable that's
+     * kept out of the dashboard's list, typically because it's only meaningful in certain
      * cases.
      */
     userVisible?: boolean;
 }
 interface CreateSeoPatternRequest {
     /**
-     * Page type whose pattern to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
+     * Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
      * `STORES_PRODUCT`.
      * @maxLength 100
      */
@@ -293,14 +288,14 @@ interface SetSeoPatternRequest {
     /**
      * Fields to update.
      *
-     * Required, and must name only writable fields. An empty field mask, an unknown field,
-     * or a read-only field fails with `INVALID_FIELD_MASK`.
+     * Supported properties: `pattern`
      */
     fieldMask: string[];
     /**
-     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     * Not supported yet.
      *
-     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * To address a single page built from a Wix Data collection, specify its `pageId`.
+     * @internal
      * @maxLength 200
      */
     collectionName?: string | null;
@@ -308,9 +303,7 @@ interface SetSeoPatternRequest {
      * ID of a single page built from a Wix Data collection, to change the pattern of that
      * page alone.
      *
-     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
-     * pattern for the type, and passing a page ID for one of those fails with
-     * `PAGE_ID_NOT_SUPPORTED`.
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type.
      * @maxLength 200
      */
     pageId?: string | null;
@@ -327,9 +320,10 @@ interface ResetSeoPatternToDefaultRequest {
      */
     pageType: string;
     /**
-     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
+     * Not supported yet.
      *
-     * To address a single page built from a Wix Data collection, pass its `pageId`.
+     * To address a single page built from a Wix Data collection, specify its `pageId`.
+     * @internal
      * @maxLength 200
      */
     collectionName?: string | null;
@@ -337,9 +331,7 @@ interface ResetSeoPatternToDefaultRequest {
      * ID of a single page built from a Wix Data collection, to reset the pattern of that
      * page alone.
      *
-     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
-     * pattern for the type, and passing a page ID for one of those fails with
-     * `PAGE_ID_NOT_SUPPORTED`.
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type.
      * @maxLength 200
      */
     pageId?: string | null;
@@ -509,12 +501,28 @@ type GetSeoPatternApplicationErrors = {
     code?: 'UNSUPPORTED_PAGE_TYPE';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'PAGE_TYPE_NOT_ON_SITE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PAGE_ID_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'COLLECTION_NAME_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
 };
 /** @docsIgnore */
 type ListSeoPatternVariablesApplicationErrors = {
     code?: 'UNSUPPORTED_PAGE_TYPE';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'PAGE_TYPE_NOT_ON_SITE';
+    description?: string;
+    data?: Record<string, any>;
 };
 /** @docsIgnore */
 type CreateSeoPatternApplicationErrors = {
@@ -529,6 +537,14 @@ type CreateSeoPatternApplicationErrors = {
     code?: 'PATTERN_ALREADY_EXISTS';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'PAGE_TYPE_NOT_ON_SITE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PAGE_ID_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
 };
 /** @docsIgnore */
 type SetSeoPatternApplicationErrors = {
@@ -547,6 +563,14 @@ type SetSeoPatternApplicationErrors = {
     code?: 'PATTERN_NOT_FOUND';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'PAGE_ID_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'COLLECTION_NAME_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
 };
 /** @docsIgnore */
 type ResetSeoPatternToDefaultApplicationErrors = {
@@ -557,16 +581,21 @@ type ResetSeoPatternToDefaultApplicationErrors = {
     code?: 'PATTERN_NOT_FOUND';
     description?: string;
     data?: Record<string, any>;
+} | {
+    code?: 'PAGE_ID_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'COLLECTION_NAME_NOT_SUPPORTED';
+    description?: string;
+    data?: Record<string, any>;
 };
 /**
  * Retrieves the SEO pattern in effect for a page type.
  *
- * The response contains both the site's own pattern, which is empty when the site has
- * none, and the Wix default, with `source` reporting which of the two is in effect. A
- * page type with no pattern of its own isn't an error.
- *
- * Fails with `PAGE_TYPE_NOT_ON_SITE` if the page type comes from a Wix app that isn't
- * installed on the site.
+ * The response contains the site's own pattern in `pattern`, and the pattern Wix
+ * provides in `defaultPattern`. `source` reports which of the two is in effect.
+ * `pattern` is empty when the site has no pattern of its own.
  * @param pageType - Page type whose pattern to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
  * `STORES_PRODUCT`.
  * @public
@@ -585,30 +614,17 @@ interface GetSeoPatternOptions {
      * ID of a single page built from a Wix Data collection, to retrieve the pattern of that
      * page alone.
      *
-     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
-     * pattern for the type, and passing a page ID for one of those fails with
-     * `PAGE_ID_NOT_SUPPORTED`.
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type.
      * @maxLength 200
      */
     pageId?: string | null;
-    /**
-     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
-     *
-     * To address a single page built from a Wix Data collection, pass its `pageId`.
-     * @maxLength 200
-     */
-    collectionName?: string | null;
 }
 /**
  * Retrieves the patterns stored for a site, one per page type.
  *
- * Only page types that have had a pattern stored are returned, so this isn't an
- * inventory of a site's page types: a page type still on its Wix default is absent.
- * A page type that was reset to its default remains in the list, with an empty
- * `pattern` and `source` of `PATTERN_SOURCE_DEFAULT`.
- *
- * The response isn't paged. A site has a bounded number of page types, and all of them
- * are returned in one call.
+ * Only returns page types that have had a pattern of the site's own stored, so a page
+ * type that has never had one is absent. A page type that was reset to its default remains in the
+ * list, with an empty `pattern` and `source` of `PATTERN_SOURCE_DEFAULT`.
  * @public
  * @documentationMaturity preview
  * @permissionId wix-seo.read
@@ -620,15 +636,11 @@ declare function listSeoPatterns(): Promise<NonNullablePaths<ListSeoPatternsResp
 /**
  * Retrieves the variables a pattern for a page type may reference.
  *
- * A pattern may reference only the variables its page type offers, so call this method
- * before writing a pattern. A pattern referencing any other variable is rejected with
- * `INVALID_PATTERN`.
+ * Call this method to retrieve the valid variables for a page type before writing a
+ * pattern.
  *
  * Variables for the page's own tags and variables for its structured data are returned
  * in separate fields, and a pattern may use either.
- *
- * Fails with `PAGE_TYPE_NOT_ON_SITE` if the page type comes from a Wix app that isn't
- * installed on the site.
  * @param pageType - Page type whose variables to retrieve. For example, `STATIC_PAGE`, `BLOG_POST`, or
  * `STORES_PRODUCT`.
  * @public
@@ -645,16 +657,12 @@ declare function listSeoPatternVariables(pageType: string): Promise<NonNullableP
 /**
  * Creates a pattern for a page type that's still on its Wix default.
  *
- * The pattern must contain at least one tag. An empty pattern is stored and read back
- * as no pattern at all, so it's rejected rather than saved as a pattern that does
- * nothing. To leave a page type on its Wix default, create nothing for it.
- *
- * To change a pattern that already exists, call Set SEO Pattern. Creating a second
- * pattern for the same page type fails with `PATTERN_ALREADY_EXISTS`.
+ * The pattern must contain at least one tag. To leave a page type on its Wix default,
+ * create nothing for it.
  *
- * Fails with `PAGE_TYPE_NOT_ON_SITE` if the page type comes from a Wix app that isn't
- * installed on the site.
- * @param pageType - Page type whose pattern to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
+ * To change a pattern that already exists, call [Set SEO
+ * Pattern](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/set-seo-pattern).
+ * @param pageType - Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or
  * `STORES_PRODUCT`.
  * @param seoPattern - Pattern to create for the page type.
  *
@@ -681,9 +689,10 @@ declare function createSeoPattern(pageType: string, seoPattern: SeoPattern): Pro
  * pattern first and send back the complete set you want it to have. Sending an empty
  * pattern clears it, which returns the page type to its Wix default.
  *
- * This method changes a pattern that already exists rather than creating one, so a page
- * type still on its Wix default fails with `PATTERN_NOT_FOUND`. Call Create SEO Pattern
- * for it instead.
+ * This method changes a pattern that already exists rather than creating one. For a page
+ * type still on its Wix default, call [Create SEO
+ * Pattern](https://dev.wix.com/docs/api-reference/business-management/seo/seo-pattern-v1/create-seo-pattern)
+ * instead.
  *
  * A pattern has no revision, and the site's SEO settings in the dashboard write to the
  * same pattern. The last write wins, so retrieve the pattern immediately before writing
@@ -711,24 +720,14 @@ interface SetSeoPatternOptions {
     /**
      * Fields to update.
      *
-     * Required, and must name only writable fields. An empty field mask, an unknown field,
-     * or a read-only field fails with `INVALID_FIELD_MASK`.
+     * Supported properties: `pattern`
      */
     fieldMask: string[];
-    /**
-     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
-     *
-     * To address a single page built from a Wix Data collection, pass its `pageId`.
-     * @maxLength 200
-     */
-    collectionName?: string | null;
     /**
      * ID of a single page built from a Wix Data collection, to change the pattern of that
      * page alone.
      *
-     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
-     * pattern for the type, and passing a page ID for one of those fails with
-     * `PAGE_ID_NOT_SUPPORTED`.
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type.
      * @maxLength 200
      */
     pageId?: string | null;
@@ -737,11 +736,7 @@ interface SetSeoPatternOptions {
  * Removes the pattern a site has for a page type, so the Wix default applies again.
  *
  * The response reports the page type after the reset, with an empty `pattern` and
- * `source` of `PATTERN_SOURCE_DEFAULT`. The page type remains in the response of List
- * SEO Patterns, with the same empty pattern.
- *
- * Fails with `PATTERN_NOT_FOUND` if the page type is already on its Wix default, so
- * there's nothing to reset.
+ * `source` of `PATTERN_SOURCE_DEFAULT`.
  * @param pageType - Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or
  * `STORES_PRODUCT`.
  * @public
@@ -755,20 +750,11 @@ declare function resetSeoPatternToDefault(pageType: string, options?: ResetSeoPa
     __applicationErrorsType?: ResetSeoPatternToDefaultApplicationErrors;
 }>;
 interface ResetSeoPatternToDefaultOptions {
-    /**
-     * Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.
-     *
-     * To address a single page built from a Wix Data collection, pass its `pageId`.
-     * @maxLength 200
-     */
-    collectionName?: string | null;
     /**
      * ID of a single page built from a Wix Data collection, to reset the pattern of that
      * page alone.
      *
-     * Supported only for the `WIX_DATA_PAGE_ITEM` page type. Every other page type has one
-     * pattern for the type, and passing a page ID for one of those fails with
-     * `PAGE_ID_NOT_SUPPORTED`.
+     * Supported only for the `WIX_DATA_PAGE_ITEM` page type.
      * @maxLength 200
      */
     pageId?: string | null;

package/build/internal/cjs/index.typings.js

@@ -218,8 +218,7 @@ async function getSeoPattern2(pageType, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     pageType,
-    pageId: options?.pageId,
-    collectionName: options?.collectionName
+    pageId: options?.pageId
   });
   const reqOpts = getSeoPattern(payload);
   sideEffects?.onSiteCall?.();
@@ -232,11 +231,7 @@ async function getSeoPattern2(pageType, options) {
       err,
       {
         spreadPathsToArguments: {},
-        explicitPathsToArguments: {
-          pageType: "$[0]",
-          pageId: "$[1].pageId",
-          collectionName: "$[1].collectionName"
-        },
+        explicitPathsToArguments: { pageType: "$[0]", pageId: "$[1].pageId" },
         singleArgumentUnchanged: false
       },
       ["pageType", "options"]
@@ -323,7 +318,6 @@ async function setSeoPattern2(pageType, seoPattern, options) {
     pageType,
     seoPattern,
     fieldMask: options?.fieldMask,
-    collectionName: options?.collectionName,
     pageId: options?.pageId
   });
   const reqOpts = setSeoPattern(payload);
@@ -341,7 +335,6 @@ async function setSeoPattern2(pageType, seoPattern, options) {
           pageType: "$[0]",
           seoPattern: "$[1]",
           fieldMask: "$[2].fieldMask",
-          collectionName: "$[2].collectionName",
           pageId: "$[2].pageId"
         },
         singleArgumentUnchanged: false
@@ -356,7 +349,6 @@ async function resetSeoPatternToDefault2(pageType, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
     pageType,
-    collectionName: options?.collectionName,
     pageId: options?.pageId
   });
   const reqOpts = resetSeoPatternToDefault(payload);
@@ -370,11 +362,7 @@ async function resetSeoPatternToDefault2(pageType, options) {
       err,
       {
         spreadPathsToArguments: {},
-        explicitPathsToArguments: {
-          pageType: "$[0]",
-          collectionName: "$[1].collectionName",
-          pageId: "$[1].pageId"
-        },
+        explicitPathsToArguments: { pageType: "$[0]", pageId: "$[1].pageId" },
         singleArgumentUnchanged: false
       },
       ["pageType", "options"]