@kanorio/sdk 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/customer-oauth.d.ts +21 -21
- package/dist/customer-oauth.js +12 -12
- package/dist/customer.d.ts +22 -22
- package/dist/customer.js +20 -11
- package/dist/delivery.d.ts +9 -9
- package/dist/delivery.js +6 -6
- package/dist/edge.d.ts +25 -21
- package/dist/edge.js +19 -19
- package/dist/forms.d.ts +13 -13
- package/dist/forms.js +13 -13
- package/dist/generated/delivery.d.ts +35 -7
- package/dist/generated/management.d.ts +111 -26
- package/dist/http.d.ts +13 -13
- package/dist/http.js +8 -8
- package/dist/index.js +2 -2
- package/dist/locales.d.ts +22 -22
- package/dist/locales.js +12 -12
- package/dist/management.d.ts +5 -5
- package/dist/management.js +3 -3
- package/dist/paginate.d.ts +3 -3
- package/dist/paginate.js +3 -3
- package/dist/preview.d.ts +13 -13
- package/dist/preview.js +11 -11
- package/dist/protection.d.ts +18 -18
- package/dist/protection.js +11 -11
- package/dist/revalidate.d.ts +22 -22
- package/dist/revalidate.js +14 -14
- package/dist/seo.d.ts +20 -20
- package/dist/seo.js +20 -20
- package/dist/server-key.d.ts +2 -2
- package/dist/server-key.js +2 -2
- package/dist/shared/api/delivery/cache-tags.d.ts +39 -39
- package/dist/shared/api/delivery/cache-tags.js +34 -34
- package/dist/shared/api/server-key.d.ts +32 -28
- package/dist/shared/api/server-key.js +41 -33
- package/dist/shared/business-registry/attribution.d.ts +5 -5
- package/dist/shared/business-registry/attribution.js +4 -4
- package/dist/shared/business-registry/define.d.ts +1 -1
- package/dist/shared/business-registry/define.js +1 -1
- package/dist/shared/business-registry/formats/eu-vat.js +4 -4
- package/dist/shared/business-registry/formats/hk-br.d.ts +2 -2
- package/dist/shared/business-registry/formats/hk-br.js +4 -4
- package/dist/shared/business-registry/formats/jp-trn.d.ts +3 -3
- package/dist/shared/business-registry/formats/jp-trn.js +4 -4
- package/dist/shared/business-registry/formats/kr-brn.d.ts +2 -2
- package/dist/shared/business-registry/formats/kr-brn.js +3 -3
- package/dist/shared/business-registry/formats/my.d.ts +3 -3
- package/dist/shared/business-registry/formats/my.js +4 -4
- package/dist/shared/business-registry/formats/sg-uen.js +4 -4
- package/dist/shared/business-registry/formats/tw-vat.d.ts +5 -5
- package/dist/shared/business-registry/formats/tw-vat.js +6 -6
- package/dist/shared/business-registry/index.js +1 -1
- package/dist/shared/business-registry/lookup-wire.d.ts +9 -9
- package/dist/shared/business-registry/lookup-wire.js +4 -4
- package/dist/shared/business-registry/normalize.d.ts +3 -3
- package/dist/shared/business-registry/normalize.js +4 -4
- package/dist/shared/business-registry/registry.d.ts +9 -9
- package/dist/shared/business-registry/registry.js +13 -13
- package/dist/shared/business-registry/types.d.ts +20 -20
- package/dist/shared/business-registry/types.js +6 -6
- package/dist/shared/localization/locale-path.d.ts +18 -18
- package/dist/shared/localization/locale-path.js +18 -18
- package/dist/shared/localization/request-locale.d.ts +16 -16
- package/dist/shared/localization/request-locale.js +13 -13
- package/dist/shared/seo/alternates.d.ts +26 -26
- package/dist/shared/seo/alternates.js +18 -18
- package/dist/shared/types/forms-logic.d.ts +28 -28
- package/dist/shared/types/forms-logic.js +27 -27
- package/dist/shared/types/number-input.d.ts +2 -2
- package/dist/shared/types/number-input.js +3 -3
- package/dist/shared/utils/redirect-matching.d.ts +33 -24
- package/dist/shared/utils/redirect-matching.js +73 -40
- package/dist/typed.d.ts +5 -5
- package/dist/typed.js +3 -3
- package/package.json +10 -10
|
@@ -463,7 +463,7 @@ export interface paths {
|
|
|
463
463
|
get: operations["domains_list"];
|
|
464
464
|
/**
|
|
465
465
|
* domains.bind
|
|
466
|
-
* @description Set the complete list of custom domains for a website: the first hostname becomes the primary (canonical) domain, the rest become aliases that 301-redirect to it. Hostnames missing from the list are unbound; pass an empty list to remove all custom domains. After binding, the owner must point DNS (CNAME) at Kanorio; call domains.status to see the exact record and verification progress. Requires a paid plan. Errors: FORBIDDEN, PRO_REQUIRED, INVALID_FORMAT, BLOCKED, HIGH_RISK_TLD, LIMIT_REACHED (details.max), TAKEN (used by another site), READD_COOLDOWN (details.retryAfterSeconds).
|
|
466
|
+
* @description Set the complete list of custom domains for a website: the first hostname becomes the primary (canonical) domain, the rest become aliases that 301-redirect to it. Hostnames missing from the list are unbound; pass an empty list to remove all custom domains. After binding, the owner must point DNS (CNAME) at Kanorio; call domains.status to see the exact record and verification progress. Requires a paid plan. On a headless site the list holds the service domain that serves checkout, sign-in, the customer account and the API: exactly one hostname, it must be a subdomain (not the root domain), and it must not be the external frontend's host. Errors: FORBIDDEN, PRO_REQUIRED, INVALID_FORMAT, BLOCKED, HIGH_RISK_TLD, LIMIT_REACHED (details.max), TAKEN (used by another site), READD_COOLDOWN (details.retryAfterSeconds), SERVICE_DOMAIN_SINGLE, SERVICE_DOMAIN_NOT_SUBDOMAIN (details.suggestion), SERVICE_DOMAIN_IS_FRONTEND.
|
|
467
467
|
*/
|
|
468
468
|
put: operations["domains_bind"];
|
|
469
469
|
post?: never;
|
|
@@ -1241,7 +1241,7 @@ export interface paths {
|
|
|
1241
1241
|
put?: never;
|
|
1242
1242
|
/**
|
|
1243
1243
|
* site.create_server_key
|
|
1244
|
-
* @description Issue a server key (
|
|
1244
|
+
* @description Issue a server key (knr_sk_…) for the site's own frontend server: the key that lets server-side code submit forms, exchange customer sign-in codes and report crawler hits on behalf of visitors (send it as X-Kanorio-Server-Key to the site's /api/v1 endpoints). The key cannot call this Management API and can only do what a visitor could already do. It is returned once; store it on the frontend host as an environment variable and never in source code. If a server-key service account with the same name already exists, a new key is added to it (create the new key, switch the host over, then revoke the old one). REST only: not available over MCP, so the key never appears in an AI conversation. Errors: FORBIDDEN, LIMIT_REACHED, VALIDATION.
|
|
1245
1245
|
*/
|
|
1246
1246
|
post: operations["site_create_server_key"];
|
|
1247
1247
|
delete?: never;
|
|
@@ -3332,7 +3332,7 @@ export interface paths {
|
|
|
3332
3332
|
};
|
|
3333
3333
|
/**
|
|
3334
3334
|
* seo.search_console.status
|
|
3335
|
-
* @description Report the Google Search Console connection
|
|
3335
|
+
* @description Report whether a website is registered with Google and the Google Search Console connection behind it. registration.state is the single answer to whether Google knows the site's current address; when it is registered there is nothing to do, including when registration.via is self: do not ask the owner to connect or submit again, connecting a Google account then only adds search data to the dashboard. The remaining fields describe the connection: whether a Google account is connected, which property and sitemap Kanorio uses, whether ownership is verified and how, and when the sitemap was last submitted. Marking a site as registered by the owner is something the owner does under SEO › Settings; no capability does it. Connecting a Google account is a browser OAuth step the owner must do under SEO › Settings; this capability cannot connect. Use it before seo.search_console.verify_and_submit, and to explain the next step to the owner when lastFailureCode is OWNERSHIP_REQUIRED (verify the domain in Search Console), SITEMAP_NOT_REACHABLE (fix the external frontend's /sitemap.xml) or DNS_NOT_PROPAGATED (just wait). Errors: FORBIDDEN (also when the website does not exist).
|
|
3336
3336
|
*/
|
|
3337
3337
|
get: operations["seo_search_console_status"];
|
|
3338
3338
|
put?: never;
|
|
@@ -3354,7 +3354,7 @@ export interface paths {
|
|
|
3354
3354
|
put?: never;
|
|
3355
3355
|
/**
|
|
3356
3356
|
* seo.search_console.verify_and_submit
|
|
3357
|
-
* @description Verify ownership of the website's current property in Google Search Console, add the property, and submit the sitemap. Same flow as the dashboard's Check again button. HOSTED sites verify with a meta tag Kanorio renders. HEADLESS sites with externalStorefrontUrl first check whether the connected Google account already owns a covering property; if not and the domain's DNS is managed by Kanorio, Kanorio writes a TXT record and verifies via DNS; otherwise the owner must verify the domain in Search Console themselves. Requires a connected Google account (owner does this in the dashboard) and a public URL. On failure the site is marked needsReverify and a background job keeps retrying transient causes (META_NOT_LIVE, DNS_NOT_PROPAGATED), but not OWNERSHIP_REQUIRED or SITEMAP_NOT_REACHABLE, which need the owner. Errors: FORBIDDEN, NO_PUBLIC_URL, SEARCH_CONSOLE_NOT_CONNECTED, META_NOT_LIVE (retry in 20-30 s), OWNERSHIP_REQUIRED, SITEMAP_NOT_REACHABLE, DNS_NOT_PROPAGATED (retry later), SEARCH_CONSOLE_AUTH_EXPIRED, SEARCH_CONSOLE_PERMISSION_DENIED, SEARCH_CONSOLE_QUOTA_EXCEEDED, SEARCH_CONSOLE_PROPERTY_NOT_FOUND, SEARCH_CONSOLE_UNAVAILABLE, SEARCH_CONSOLE_ERROR.
|
|
3357
|
+
* @description Verify ownership of the website's current property in Google Search Console, add the property, and submit the sitemap. Same flow as the dashboard's Check again button. Call it only when a Google account is connected and seo.search_console.status reports registration.state in_progress; when the state is registered it is not needed. HOSTED sites verify with a meta tag Kanorio renders. HEADLESS sites with externalStorefrontUrl first check whether the connected Google account already owns a covering property; if not and the domain's DNS is managed by Kanorio, Kanorio writes a TXT record and verifies via DNS; otherwise the owner must verify the domain in Search Console themselves. Requires a connected Google account (owner does this in the dashboard) and a public URL. On failure the site is marked needsReverify and a background job keeps retrying transient causes (META_NOT_LIVE, DNS_NOT_PROPAGATED), but not OWNERSHIP_REQUIRED or SITEMAP_NOT_REACHABLE, which need the owner. Errors: FORBIDDEN, NO_PUBLIC_URL, SEARCH_CONSOLE_NOT_CONNECTED, META_NOT_LIVE (retry in 20-30 s), OWNERSHIP_REQUIRED, SITEMAP_NOT_REACHABLE, DNS_NOT_PROPAGATED (retry later), SEARCH_CONSOLE_AUTH_EXPIRED, SEARCH_CONSOLE_PERMISSION_DENIED, SEARCH_CONSOLE_QUOTA_EXCEEDED, SEARCH_CONSOLE_PROPERTY_NOT_FOUND, SEARCH_CONSOLE_UNAVAILABLE, SEARCH_CONSOLE_ERROR.
|
|
3358
3358
|
*/
|
|
3359
3359
|
post: operations["seo_search_console_verify_and_submit"];
|
|
3360
3360
|
delete?: never;
|
|
@@ -3668,7 +3668,7 @@ export interface paths {
|
|
|
3668
3668
|
};
|
|
3669
3669
|
/**
|
|
3670
3670
|
* auth.whoami
|
|
3671
|
-
* @description Inspect the current
|
|
3671
|
+
* @description Inspect the current credential: who it acts as (principal: a user, or a service account that belongs to one website), its granted scopes, website restrictions, and any capabilities it cannot call (hiddenCapabilities, with the exact reason: missing_scope, feature_disabled, or principal_not_allowed for operations that need a person's token). Call this before telling the user a feature is unsupported. Pass websiteId to also get the role on that website and the effective permissions there (token scopes intersected with the role's or the service account's permissions), plus capabilities the token has the scope for but the role does not allow on that website. A server key (knr_sk_) is not a Management API credential and gets UNAUTHORIZED. Errors: UNAUTHORIZED, FORBIDDEN (websiteId given but the credential has no access to that website).
|
|
3672
3672
|
*/
|
|
3673
3673
|
get: operations["auth_whoami"];
|
|
3674
3674
|
put?: never;
|
|
@@ -3736,7 +3736,7 @@ export interface components {
|
|
|
3736
3736
|
* @description Stable error code. Codes not listed here follow the suffix rules: *_NOT_FOUND → 404, *_REQUIRED / *_FORBIDDEN / *_PLAN_REQUIRED / *_LIMIT → 403, otherwise 422.
|
|
3737
3737
|
* @enum {string}
|
|
3738
3738
|
*/
|
|
3739
|
-
ErrorCode: "EMPTY_SLUG" | "INVALID_BODY" | "INVALID_CURSOR" | "INVALID_EDITED_PATH" | "INVALID_FORMAT" | "INVALID_ORDER" | "INVALID_SUBDOMAIN" | "UNSUPPORTED_EDITED_PATH" | "VALIDATION" | "UNAUTHENTICATED" | "UNAUTHORIZED" | "CUSTOM_DOMAIN_CHANGE_FORBIDDEN" | "CUSTOM_DOMAIN_LIMIT_REACHED" | "CUSTOM_DOMAIN_OWNER_REQUIRED" | "FORBIDDEN" | "LIMIT_REACHED" | "MODERATION_LOCKED" | "OWNER_REQUIRED" | "PLAN_CANNOT_PUBLISH" | "PLATFORM_DOMAIN_OWNER_REQUIRED" | "PRO_REQUIRED" | "REDIRECT_LIMIT" | "SUBDOMAIN_CHANGE_FORBIDDEN" | "TOKEN_WEBSITE_SCOPED" | "HEADER_NOT_FOUND" | "HOME_PAGE_NOT_FOUND" | "NOT_FOUND" | "OWNER_NOT_FOUND" | "PAGE_NOT_FOUND" | "PARENT_NOT_FOUND" | "PRODUCT_NOT_FOUND" | "WEBSITE_NOT_FOUND" | "METHOD_NOT_ALLOWED" | "CONFLICT" | "CUSTOM_DOMAIN_FORWARDING" | "CUSTOM_DOMAIN_TAKEN" | "DOMAIN_FORWARDING" | "HAS_CHILDREN" | "HOSTED_ONLY" | "HOSTNAME_CONFLICT" | "IDEMPOTENCY_CONFLICT" | "IDEMPOTENCY_IN_PROGRESS" | "KEY_TAKEN" | "PRIMARY_HEADER_PROTECTED" | "READD_COOLDOWN" | "REDIRECT_CONFLICT" | "SLUG_TAKEN" | "SUBDOMAIN_TAKEN" | "TAKEN" | "BLOCKED" | "BREADCRUMB_PARENT_INVALID" | "CONTENT_VALIDATION_FAILED" | "CORE_SECTION_VIOLATION" | "CUSTOM_DOMAIN_BLOCKED" | "CUSTOM_DOMAIN_HIGH_RISK_TLD" | "CUSTOM_DOMAIN_NOT_ACTIVE" | "CUSTOM_DOMAIN_TOO_LONG" | "CUSTOM_DOMAIN_WWW_REDUNDANT" | "DEPTH_EXCEEDED" | "DNS_NOT_PROPAGATED" | "DOMAIN_CHANGE_NOT_ALLOWED" | "EMPTY_CONTENT" | "FOREIGN_PAGE" | "HIGH_RISK_TLD" | "HOME_HAS_HIERARCHY" | "HOME_NOT_CREATABLE" | "HOME_NOT_DELETABLE" | "HOME_NOT_SORTABLE" | "HOME_SLUG_IMMUTABLE" | "LINK_IN_BIO_DEDICATED_ENTRY" | "LINK_IN_BIO_NOT_DUPLICABLE" | "META_NOT_LIVE" | "NO_PUBLIC_URL" | "OWNERSHIP_REQUIRED" | "PAGE_LIMIT_REACHED" | "PARENT_NOT_ALLOWED" | "PLATFORM_DOMAIN_NOT_ACTIVE" | "PLATFORM_DOMAIN_WWW_REDUNDANT" | "RESERVED_SEGMENT" | "RESERVED_SLUG" | "RESERVED_SUBDOMAIN" | "SANITIZE_FAILED" | "SEARCH_CONSOLE_AUTH_EXPIRED" | "SEARCH_CONSOLE_NOT_CONNECTED" | "SEARCH_CONSOLE_PERMISSION_DENIED" | "SEARCH_CONSOLE_PROPERTY_NOT_FOUND" | "SEGMENT_TOO_LONG" | "SITEMAP_NOT_REACHABLE" | "SUBDOMAIN_MISSING" | "SYSTEM_PAGE_LOCKED" | "TEMPLATE_PRODUCT_LOCKED" | "ANALYTICS_BUSY" | "DAILY_LIMIT_REACHED" | "RATE_LIMITED" | "SEARCH_BUSY" | "SEARCH_CONSOLE_QUOTA_EXCEEDED" | "STOCK_BUSY" | "INTERNAL" | "SEARCH_CONSOLE_ERROR" | "BUSY" | "SEARCH_CONSOLE_UNAVAILABLE" | "SERVICE_UNAVAILABLE" | "WRITE_FROZEN";
|
|
3739
|
+
ErrorCode: "EMPTY_SLUG" | "INVALID_BODY" | "INVALID_CURSOR" | "INVALID_EDITED_PATH" | "INVALID_FORMAT" | "INVALID_ORDER" | "INVALID_SUBDOMAIN" | "UNSUPPORTED_EDITED_PATH" | "VALIDATION" | "UNAUTHENTICATED" | "UNAUTHORIZED" | "CUSTOM_DOMAIN_CHANGE_FORBIDDEN" | "CUSTOM_DOMAIN_LIMIT_REACHED" | "CUSTOM_DOMAIN_OWNER_REQUIRED" | "FORBIDDEN" | "LIMIT_REACHED" | "MODERATION_LOCKED" | "OWNER_REQUIRED" | "PLAN_CANNOT_PUBLISH" | "PLATFORM_DOMAIN_OWNER_REQUIRED" | "PRO_REQUIRED" | "REDIRECT_LIMIT" | "SUBDOMAIN_CHANGE_FORBIDDEN" | "TOKEN_WEBSITE_SCOPED" | "HEADER_NOT_FOUND" | "HOME_PAGE_NOT_FOUND" | "NOT_FOUND" | "OWNER_NOT_FOUND" | "PAGE_NOT_FOUND" | "PARENT_NOT_FOUND" | "PRODUCT_NOT_FOUND" | "WEBSITE_NOT_FOUND" | "METHOD_NOT_ALLOWED" | "CONFLICT" | "CUSTOM_DOMAIN_FORWARDING" | "CUSTOM_DOMAIN_TAKEN" | "DOMAIN_FORWARDING" | "HAS_CHILDREN" | "HOSTED_ONLY" | "HOSTNAME_CONFLICT" | "IDEMPOTENCY_CONFLICT" | "IDEMPOTENCY_IN_PROGRESS" | "KEY_TAKEN" | "PRIMARY_HEADER_PROTECTED" | "READD_COOLDOWN" | "REDIRECT_CONFLICT" | "SLUG_TAKEN" | "SUBDOMAIN_TAKEN" | "TAKEN" | "BLOCKED" | "BREADCRUMB_PARENT_INVALID" | "CONTENT_VALIDATION_FAILED" | "CORE_SECTION_VIOLATION" | "CUSTOM_DOMAIN_BLOCKED" | "CUSTOM_DOMAIN_HIGH_RISK_TLD" | "CUSTOM_DOMAIN_NOT_ACTIVE" | "CUSTOM_DOMAIN_TOO_LONG" | "CUSTOM_DOMAIN_WWW_REDUNDANT" | "DEPTH_EXCEEDED" | "DNS_NOT_PROPAGATED" | "DOMAIN_CHANGE_NOT_ALLOWED" | "EMPTY_CONTENT" | "FOREIGN_PAGE" | "HIGH_RISK_TLD" | "HOME_HAS_HIERARCHY" | "HOME_NOT_CREATABLE" | "HOME_NOT_DELETABLE" | "HOME_NOT_SORTABLE" | "HOME_SLUG_IMMUTABLE" | "LINK_IN_BIO_DEDICATED_ENTRY" | "LINK_IN_BIO_NOT_DUPLICABLE" | "META_NOT_LIVE" | "NO_PUBLIC_URL" | "OWNERSHIP_REQUIRED" | "PAGE_LIMIT_REACHED" | "PARENT_NOT_ALLOWED" | "PLATFORM_DOMAIN_NOT_ACTIVE" | "PLATFORM_DOMAIN_WWW_REDUNDANT" | "RESERVED_SEGMENT" | "RESERVED_SLUG" | "RESERVED_SUBDOMAIN" | "SANITIZE_FAILED" | "SEARCH_CONSOLE_AUTH_EXPIRED" | "SEARCH_CONSOLE_NOT_CONNECTED" | "SEARCH_CONSOLE_PERMISSION_DENIED" | "SEARCH_CONSOLE_PROPERTY_NOT_FOUND" | "SEGMENT_TOO_LONG" | "SERVICE_DOMAIN_IS_FRONTEND" | "SERVICE_DOMAIN_NOT_SUBDOMAIN" | "SERVICE_DOMAIN_SINGLE" | "SITEMAP_NOT_REACHABLE" | "SUBDOMAIN_MISSING" | "SYSTEM_PAGE_LOCKED" | "TEMPLATE_PRODUCT_LOCKED" | "ANALYTICS_BUSY" | "DAILY_LIMIT_REACHED" | "RATE_LIMITED" | "SEARCH_BUSY" | "SEARCH_CONSOLE_QUOTA_EXCEEDED" | "STOCK_BUSY" | "INTERNAL" | "SEARCH_CONSOLE_ERROR" | "BUSY" | "SEARCH_CONSOLE_UNAVAILABLE" | "SERVICE_UNAVAILABLE" | "WRITE_FROZEN";
|
|
3740
3740
|
};
|
|
3741
3741
|
responses: {
|
|
3742
3742
|
/** @description Input failed validation or is malformed. Codes: EMPTY_SLUG, INVALID_BODY, INVALID_CURSOR, INVALID_EDITED_PATH, INVALID_FORMAT, INVALID_ORDER, INVALID_SUBDOMAIN, UNSUPPORTED_EDITED_PATH, VALIDATION. */
|
|
@@ -3856,7 +3856,7 @@ export interface components {
|
|
|
3856
3856
|
"application/json": components["schemas"]["ErrorEnvelope"];
|
|
3857
3857
|
};
|
|
3858
3858
|
};
|
|
3859
|
-
/** @description Business rule rejected the request. Codes: BLOCKED, BREADCRUMB_PARENT_INVALID, CONTENT_VALIDATION_FAILED, CORE_SECTION_VIOLATION, CUSTOM_DOMAIN_BLOCKED, CUSTOM_DOMAIN_HIGH_RISK_TLD, CUSTOM_DOMAIN_NOT_ACTIVE, CUSTOM_DOMAIN_TOO_LONG, CUSTOM_DOMAIN_WWW_REDUNDANT, DEPTH_EXCEEDED, DNS_NOT_PROPAGATED, DOMAIN_CHANGE_NOT_ALLOWED, EMPTY_CONTENT, FOREIGN_PAGE, HIGH_RISK_TLD, HOME_HAS_HIERARCHY, HOME_NOT_CREATABLE, HOME_NOT_DELETABLE, HOME_NOT_SORTABLE, HOME_SLUG_IMMUTABLE, LINK_IN_BIO_DEDICATED_ENTRY, LINK_IN_BIO_NOT_DUPLICABLE, META_NOT_LIVE, NO_PUBLIC_URL, OWNERSHIP_REQUIRED, PAGE_LIMIT_REACHED, PARENT_NOT_ALLOWED, PLATFORM_DOMAIN_NOT_ACTIVE, PLATFORM_DOMAIN_WWW_REDUNDANT, RESERVED_SEGMENT, RESERVED_SLUG, RESERVED_SUBDOMAIN, SANITIZE_FAILED, SEARCH_CONSOLE_AUTH_EXPIRED, SEARCH_CONSOLE_NOT_CONNECTED, SEARCH_CONSOLE_PERMISSION_DENIED, SEARCH_CONSOLE_PROPERTY_NOT_FOUND, SEGMENT_TOO_LONG, SITEMAP_NOT_REACHABLE, SUBDOMAIN_MISSING, SYSTEM_PAGE_LOCKED, TEMPLATE_PRODUCT_LOCKED. */
|
|
3859
|
+
/** @description Business rule rejected the request. Codes: BLOCKED, BREADCRUMB_PARENT_INVALID, CONTENT_VALIDATION_FAILED, CORE_SECTION_VIOLATION, CUSTOM_DOMAIN_BLOCKED, CUSTOM_DOMAIN_HIGH_RISK_TLD, CUSTOM_DOMAIN_NOT_ACTIVE, CUSTOM_DOMAIN_TOO_LONG, CUSTOM_DOMAIN_WWW_REDUNDANT, DEPTH_EXCEEDED, DNS_NOT_PROPAGATED, DOMAIN_CHANGE_NOT_ALLOWED, EMPTY_CONTENT, FOREIGN_PAGE, HIGH_RISK_TLD, HOME_HAS_HIERARCHY, HOME_NOT_CREATABLE, HOME_NOT_DELETABLE, HOME_NOT_SORTABLE, HOME_SLUG_IMMUTABLE, LINK_IN_BIO_DEDICATED_ENTRY, LINK_IN_BIO_NOT_DUPLICABLE, META_NOT_LIVE, NO_PUBLIC_URL, OWNERSHIP_REQUIRED, PAGE_LIMIT_REACHED, PARENT_NOT_ALLOWED, PLATFORM_DOMAIN_NOT_ACTIVE, PLATFORM_DOMAIN_WWW_REDUNDANT, RESERVED_SEGMENT, RESERVED_SLUG, RESERVED_SUBDOMAIN, SANITIZE_FAILED, SEARCH_CONSOLE_AUTH_EXPIRED, SEARCH_CONSOLE_NOT_CONNECTED, SEARCH_CONSOLE_PERMISSION_DENIED, SEARCH_CONSOLE_PROPERTY_NOT_FOUND, SEGMENT_TOO_LONG, SERVICE_DOMAIN_IS_FRONTEND, SERVICE_DOMAIN_NOT_SUBDOMAIN, SERVICE_DOMAIN_SINGLE, SITEMAP_NOT_REACHABLE, SUBDOMAIN_MISSING, SYSTEM_PAGE_LOCKED, TEMPLATE_PRODUCT_LOCKED. */
|
|
3860
3860
|
Error422: {
|
|
3861
3861
|
headers: {
|
|
3862
3862
|
[name: string]: unknown;
|
|
@@ -5619,7 +5619,6 @@ export interface operations {
|
|
|
5619
5619
|
* @enum {string}
|
|
5620
5620
|
*/
|
|
5621
5621
|
icon?: "briefcase" | "star" | "award" | "crown" | "flame" | "zap" | "target" | "rocket" | "flag" | "gem" | "diamond" | "scroll" | "fingerprint" | "smile" | "laugh" | "clock" | "phone" | "mail" | "bell" | "settings" | "check-circle" | "info" | "help-circle" | "headset" | "megaphone" | "newspaper" | "hourglass" | "stamp" | "milestone" | "utensils" | "utensils-crossed" | "chef-hat" | "coffee" | "pizza" | "soup" | "ice-cream-cone" | "sandwich" | "beef" | "fish" | "salad" | "cookie" | "cake" | "cake-slice" | "dessert" | "cup-soda" | "wine" | "beer" | "martini" | "milk" | "wheat" | "egg" | "croissant" | "popcorn" | "candy" | "apple" | "cherry" | "banana" | "citrus" | "grape" | "carrot" | "drumstick" | "cooking-pot" | "shrimp" | "donut" | "bean" | "vegan" | "store" | "shopping-bag" | "shopping-cart" | "shopping-basket" | "package" | "package-check" | "boxes" | "truck" | "motorbike" | "warehouse" | "tag" | "tags" | "ticket-percent" | "barcode" | "qr-code" | "scan-qr-code" | "credit-card" | "smartphone-nfc" | "wallet" | "banknote" | "coins" | "dollar-sign" | "percent" | "badge-percent" | "receipt" | "shirt" | "heart" | "heart-pulse" | "stethoscope" | "hospital" | "syringe" | "pill" | "pill-bottle" | "bandage" | "cross" | "thermometer" | "briefcase-medical" | "scissors" | "sparkles" | "scan-face" | "hand" | "bath" | "droplet" | "droplets" | "flower" | "flower-2" | "sun" | "moon" | "book-open" | "book-text" | "book-copy" | "book-marked" | "book-check" | "graduation-cap" | "school" | "library" | "monitor-play" | "backpack" | "pencil" | "pen-tool" | "file-text" | "scroll-text" | "notebook-pen" | "languages" | "calculator" | "presentation" | "lightbulb" | "brain" | "puzzle" | "laptop" | "monitor" | "smartphone" | "tablet" | "code" | "code-2" | "terminal" | "server" | "database" | "cloud" | "cpu" | "globe" | "network" | "circuit-board" | "brain-circuit" | "bot" | "blocks" | "palette" | "brush" | "paint-bucket" | "pen-line" | "image" | "image-plus" | "camera" | "video" | "film" | "clapperboard" | "music" | "music-2" | "music-4" | "mic" | "mic-2" | "headphones" | "speaker" | "radio" | "podcast" | "piano" | "plane" | "map-pin" | "map-pinned" | "navigation" | "route" | "compass" | "mountain" | "tree-pine" | "trees" | "tent" | "umbrella" | "anchor" | "ship" | "car" | "bike" | "bus" | "train" | "luggage" | "hotel" | "bed-double" | "concierge-bell" | "wifi" | "parking-square" | "air-vent" | "washing-machine" | "cigarette-off" | "accessibility" | "dumbbell" | "biceps-flexed" | "footprints" | "timer" | "watch" | "medal" | "trophy" | "swords" | "badge-check" | "activity" | "building" | "building-2" | "factory" | "house" | "house-plus" | "map-pin-house" | "door-open" | "door-closed" | "key" | "key-round" | "fence" | "sofa" | "ruler" | "hard-hat" | "hammer" | "wrench" | "paint-roller" | "brush-cleaning" | "cat" | "dog" | "bird" | "rabbit" | "squirrel" | "paw-print" | "bone" | "leaf" | "sprout" | "clover" | "tractor" | "cloud-sun" | "cloud-rain" | "snowflake" | "leafy-green" | "tree-deciduous" | "wind" | "waves" | "recycle" | "landmark" | "vault" | "scale" | "gavel" | "shield" | "shield-check" | "badge-dollar-sign" | "hand-coins" | "trending-up" | "trending-down" | "bar-chart" | "bar-chart-2" | "bar-chart-3" | "pie-chart" | "line-chart" | "chart-no-axes-combined" | "users" | "users-round" | "user-circle" | "user-plus" | "hand-heart" | "hand-helping" | "heart-handshake" | "handshake" | "baby" | "church" | "party-popper" | "sparkle" | "gift" | "ticket" | "calendar" | "calendar-days" | "calendar-check" | "calendar-clock";
|
|
5622
|
-
} & {
|
|
5623
5622
|
dark?: {
|
|
5624
5623
|
/** @enum {string} */
|
|
5625
5624
|
type: "image" | "icon";
|
|
@@ -6335,7 +6334,6 @@ export interface operations {
|
|
|
6335
6334
|
* @enum {string}
|
|
6336
6335
|
*/
|
|
6337
6336
|
icon?: "briefcase" | "star" | "award" | "crown" | "flame" | "zap" | "target" | "rocket" | "flag" | "gem" | "diamond" | "scroll" | "fingerprint" | "smile" | "laugh" | "clock" | "phone" | "mail" | "bell" | "settings" | "check-circle" | "info" | "help-circle" | "headset" | "megaphone" | "newspaper" | "hourglass" | "stamp" | "milestone" | "utensils" | "utensils-crossed" | "chef-hat" | "coffee" | "pizza" | "soup" | "ice-cream-cone" | "sandwich" | "beef" | "fish" | "salad" | "cookie" | "cake" | "cake-slice" | "dessert" | "cup-soda" | "wine" | "beer" | "martini" | "milk" | "wheat" | "egg" | "croissant" | "popcorn" | "candy" | "apple" | "cherry" | "banana" | "citrus" | "grape" | "carrot" | "drumstick" | "cooking-pot" | "shrimp" | "donut" | "bean" | "vegan" | "store" | "shopping-bag" | "shopping-cart" | "shopping-basket" | "package" | "package-check" | "boxes" | "truck" | "motorbike" | "warehouse" | "tag" | "tags" | "ticket-percent" | "barcode" | "qr-code" | "scan-qr-code" | "credit-card" | "smartphone-nfc" | "wallet" | "banknote" | "coins" | "dollar-sign" | "percent" | "badge-percent" | "receipt" | "shirt" | "heart" | "heart-pulse" | "stethoscope" | "hospital" | "syringe" | "pill" | "pill-bottle" | "bandage" | "cross" | "thermometer" | "briefcase-medical" | "scissors" | "sparkles" | "scan-face" | "hand" | "bath" | "droplet" | "droplets" | "flower" | "flower-2" | "sun" | "moon" | "book-open" | "book-text" | "book-copy" | "book-marked" | "book-check" | "graduation-cap" | "school" | "library" | "monitor-play" | "backpack" | "pencil" | "pen-tool" | "file-text" | "scroll-text" | "notebook-pen" | "languages" | "calculator" | "presentation" | "lightbulb" | "brain" | "puzzle" | "laptop" | "monitor" | "smartphone" | "tablet" | "code" | "code-2" | "terminal" | "server" | "database" | "cloud" | "cpu" | "globe" | "network" | "circuit-board" | "brain-circuit" | "bot" | "blocks" | "palette" | "brush" | "paint-bucket" | "pen-line" | "image" | "image-plus" | "camera" | "video" | "film" | "clapperboard" | "music" | "music-2" | "music-4" | "mic" | "mic-2" | "headphones" | "speaker" | "radio" | "podcast" | "piano" | "plane" | "map-pin" | "map-pinned" | "navigation" | "route" | "compass" | "mountain" | "tree-pine" | "trees" | "tent" | "umbrella" | "anchor" | "ship" | "car" | "bike" | "bus" | "train" | "luggage" | "hotel" | "bed-double" | "concierge-bell" | "wifi" | "parking-square" | "air-vent" | "washing-machine" | "cigarette-off" | "accessibility" | "dumbbell" | "biceps-flexed" | "footprints" | "timer" | "watch" | "medal" | "trophy" | "swords" | "badge-check" | "activity" | "building" | "building-2" | "factory" | "house" | "house-plus" | "map-pin-house" | "door-open" | "door-closed" | "key" | "key-round" | "fence" | "sofa" | "ruler" | "hard-hat" | "hammer" | "wrench" | "paint-roller" | "brush-cleaning" | "cat" | "dog" | "bird" | "rabbit" | "squirrel" | "paw-print" | "bone" | "leaf" | "sprout" | "clover" | "tractor" | "cloud-sun" | "cloud-rain" | "snowflake" | "leafy-green" | "tree-deciduous" | "wind" | "waves" | "recycle" | "landmark" | "vault" | "scale" | "gavel" | "shield" | "shield-check" | "badge-dollar-sign" | "hand-coins" | "trending-up" | "trending-down" | "bar-chart" | "bar-chart-2" | "bar-chart-3" | "pie-chart" | "line-chart" | "chart-no-axes-combined" | "users" | "users-round" | "user-circle" | "user-plus" | "hand-heart" | "hand-helping" | "heart-handshake" | "handshake" | "baby" | "church" | "party-popper" | "sparkle" | "gift" | "ticket" | "calendar" | "calendar-days" | "calendar-check" | "calendar-clock";
|
|
6338
|
-
} & {
|
|
6339
6337
|
dark?: {
|
|
6340
6338
|
/** @enum {string} */
|
|
6341
6339
|
type: "image" | "icon";
|
|
@@ -8809,8 +8807,10 @@ export interface operations {
|
|
|
8809
8807
|
/** @description Ids from blog_tags.list. */
|
|
8810
8808
|
tagIds?: string[];
|
|
8811
8809
|
showToc?: boolean;
|
|
8812
|
-
|
|
8813
|
-
|
|
8810
|
+
/** @description SEO title. Null or an empty string clears it; a post's public SEO title then follows the post title again. */
|
|
8811
|
+
seoTitle?: string | null;
|
|
8812
|
+
/** @description SEO description. Null or an empty string clears it; a post's public description then follows the excerpt again. */
|
|
8813
|
+
seoDescription?: string | null;
|
|
8814
8814
|
seoKeywords?: string[];
|
|
8815
8815
|
ogImageAlt?: string;
|
|
8816
8816
|
ogImageFraming?: {
|
|
@@ -9040,7 +9040,9 @@ export interface operations {
|
|
|
9040
9040
|
}[];
|
|
9041
9041
|
showToc: boolean;
|
|
9042
9042
|
seo: {
|
|
9043
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
9043
9044
|
seoTitle: string | null;
|
|
9045
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
9044
9046
|
seoDescription: string | null;
|
|
9045
9047
|
seoKeywords: string[] | null;
|
|
9046
9048
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -10181,7 +10183,9 @@ export interface operations {
|
|
|
10181
10183
|
}[];
|
|
10182
10184
|
showToc: boolean;
|
|
10183
10185
|
seo: {
|
|
10186
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
10184
10187
|
seoTitle: string | null;
|
|
10188
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
10185
10189
|
seoDescription: string | null;
|
|
10186
10190
|
seoKeywords: string[] | null;
|
|
10187
10191
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -10361,8 +10365,10 @@ export interface operations {
|
|
|
10361
10365
|
/** @description Ids from blog_tags.list. */
|
|
10362
10366
|
tagIds?: string[];
|
|
10363
10367
|
showToc?: boolean;
|
|
10364
|
-
|
|
10365
|
-
|
|
10368
|
+
/** @description SEO title. Null or an empty string clears it; a post's public SEO title then follows the post title again. */
|
|
10369
|
+
seoTitle?: string | null;
|
|
10370
|
+
/** @description SEO description. Null or an empty string clears it; a post's public description then follows the excerpt again. */
|
|
10371
|
+
seoDescription?: string | null;
|
|
10366
10372
|
seoKeywords?: string[];
|
|
10367
10373
|
ogImageAlt?: string;
|
|
10368
10374
|
ogImageFraming?: {
|
|
@@ -10588,7 +10594,9 @@ export interface operations {
|
|
|
10588
10594
|
}[];
|
|
10589
10595
|
showToc: boolean;
|
|
10590
10596
|
seo: {
|
|
10597
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
10591
10598
|
seoTitle: string | null;
|
|
10599
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
10592
10600
|
seoDescription: string | null;
|
|
10593
10601
|
seoKeywords: string[] | null;
|
|
10594
10602
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -10925,7 +10933,9 @@ export interface operations {
|
|
|
10925
10933
|
}[];
|
|
10926
10934
|
showToc: boolean;
|
|
10927
10935
|
seo: {
|
|
10936
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
10928
10937
|
seoTitle: string | null;
|
|
10938
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
10929
10939
|
seoDescription: string | null;
|
|
10930
10940
|
seoKeywords: string[] | null;
|
|
10931
10941
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -11253,7 +11263,9 @@ export interface operations {
|
|
|
11253
11263
|
}[];
|
|
11254
11264
|
showToc: boolean;
|
|
11255
11265
|
seo: {
|
|
11266
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
11256
11267
|
seoTitle: string | null;
|
|
11268
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
11257
11269
|
seoDescription: string | null;
|
|
11258
11270
|
seoKeywords: string[] | null;
|
|
11259
11271
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -11577,7 +11589,9 @@ export interface operations {
|
|
|
11577
11589
|
}[];
|
|
11578
11590
|
showToc: boolean;
|
|
11579
11591
|
seo: {
|
|
11592
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
11580
11593
|
seoTitle: string | null;
|
|
11594
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
11581
11595
|
seoDescription: string | null;
|
|
11582
11596
|
seoKeywords: string[] | null;
|
|
11583
11597
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -11912,7 +11926,9 @@ export interface operations {
|
|
|
11912
11926
|
}[];
|
|
11913
11927
|
showToc: boolean;
|
|
11914
11928
|
seo: {
|
|
11929
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
11915
11930
|
seoTitle: string | null;
|
|
11931
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
11916
11932
|
seoDescription: string | null;
|
|
11917
11933
|
seoKeywords: string[] | null;
|
|
11918
11934
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -12236,7 +12252,9 @@ export interface operations {
|
|
|
12236
12252
|
}[];
|
|
12237
12253
|
showToc: boolean;
|
|
12238
12254
|
seo: {
|
|
12255
|
+
/** @description The author's own SEO title. Null means none was written: the public SEO title then follows the post title and is refreshed on every publish. */
|
|
12239
12256
|
seoTitle: string | null;
|
|
12257
|
+
/** @description The author's own SEO description. Null means none was written: the public description then follows the excerpt, or the first paragraph, and is refreshed on every publish. */
|
|
12240
12258
|
seoDescription: string | null;
|
|
12241
12259
|
seoKeywords: string[] | null;
|
|
12242
12260
|
/** @description Share image display URL (changes with versions; do not store it). */
|
|
@@ -17515,8 +17533,8 @@ export interface operations {
|
|
|
17515
17533
|
* "tokenId": "cm9example0001apitoken",
|
|
17516
17534
|
* "name": "Website server",
|
|
17517
17535
|
* "keyName": "Vercel production",
|
|
17518
|
-
* "prefix": "
|
|
17519
|
-
* "key": "
|
|
17536
|
+
* "prefix": "knr_sk_xxxxxxxx",
|
|
17537
|
+
* "key": "knr_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
|
17520
17538
|
* "envName": "KANORIO_SERVER_KEY",
|
|
17521
17539
|
* "createdAt": "2026-10-06T08:00:00.000Z"
|
|
17522
17540
|
* }
|
|
@@ -17527,9 +17545,9 @@ export interface operations {
|
|
|
17527
17545
|
/** @description Service account name. */
|
|
17528
17546
|
name: string;
|
|
17529
17547
|
keyName: string;
|
|
17530
|
-
/** @description Display prefix of the key (
|
|
17548
|
+
/** @description Display prefix of the key (knr_sk_ plus 8 characters). */
|
|
17531
17549
|
prefix: string;
|
|
17532
|
-
/** @description The server key (
|
|
17550
|
+
/** @description The server key (knr_sk_…). Shown only once. */
|
|
17533
17551
|
key: string;
|
|
17534
17552
|
/** @description Environment variable name to store the key under. */
|
|
17535
17553
|
envName: string;
|
|
@@ -17547,9 +17565,9 @@ export interface operations {
|
|
|
17547
17565
|
};
|
|
17548
17566
|
site_check_external_frontend: {
|
|
17549
17567
|
parameters: {
|
|
17550
|
-
query
|
|
17568
|
+
query?: {
|
|
17551
17569
|
/** @description Deprecated and ignored: the former cutover checks (hosted 302 redirect, GSC, customer auth CORS) now run every time. */
|
|
17552
|
-
switching
|
|
17570
|
+
switching?: boolean;
|
|
17553
17571
|
};
|
|
17554
17572
|
header?: never;
|
|
17555
17573
|
path: {
|
|
@@ -17574,13 +17592,15 @@ export interface operations {
|
|
|
17574
17592
|
* "checks": [
|
|
17575
17593
|
* {
|
|
17576
17594
|
* "id": "derivatives",
|
|
17595
|
+
* "code": "ok",
|
|
17577
17596
|
* "title": "SEO & AEO derivative files (sitemap, robots, llms, feed)",
|
|
17578
17597
|
* "status": "pass",
|
|
17579
|
-
* "summary": "sitemap.xml, robots.txt, llms.txt and feed.xml are live
|
|
17598
|
+
* "summary": "sitemap.xml, robots.txt, llms.txt and feed.xml are live.",
|
|
17580
17599
|
* "remediation": "Add seoRewrites({ siteUrl, framework: \"next\" | \"astro\" }) from @kanorio/sdk."
|
|
17581
17600
|
* },
|
|
17582
17601
|
* {
|
|
17583
17602
|
* "id": "jsonld",
|
|
17603
|
+
* "code": "ok",
|
|
17584
17604
|
* "title": "Schema.org JSON-LD structured data",
|
|
17585
17605
|
* "status": "pass",
|
|
17586
17606
|
* "summary": "JSON-LD @graph matched on all 3 sampled page(s).",
|
|
@@ -17588,6 +17608,7 @@ export interface operations {
|
|
|
17588
17608
|
* },
|
|
17589
17609
|
* {
|
|
17590
17610
|
* "id": "content",
|
|
17611
|
+
* "code": "ok",
|
|
17591
17612
|
* "title": "Published page content sync",
|
|
17592
17613
|
* "status": "pass",
|
|
17593
17614
|
* "summary": "All 3 sampled page(s) match published titles and content.",
|
|
@@ -17595,6 +17616,7 @@ export interface operations {
|
|
|
17595
17616
|
* },
|
|
17596
17617
|
* {
|
|
17597
17618
|
* "id": "analytics",
|
|
17619
|
+
* "code": "ok",
|
|
17598
17620
|
* "title": "Visitor pageview reporting (last 24h)",
|
|
17599
17621
|
* "status": "pass",
|
|
17600
17622
|
* "summary": "Received 42 pageview(s) from the external storefront in the last 24 hours.",
|
|
@@ -17602,6 +17624,7 @@ export interface operations {
|
|
|
17602
17624
|
* },
|
|
17603
17625
|
* {
|
|
17604
17626
|
* "id": "revalidate",
|
|
17627
|
+
* "code": "ok",
|
|
17605
17628
|
* "title": "On-demand ISR cache revalidation webhook",
|
|
17606
17629
|
* "status": "pass",
|
|
17607
17630
|
* "summary": "1 active webhook endpoint(s) subscribed for cache invalidation.",
|
|
@@ -17609,6 +17632,7 @@ export interface operations {
|
|
|
17609
17632
|
* },
|
|
17610
17633
|
* {
|
|
17611
17634
|
* "id": "indexnow",
|
|
17635
|
+
* "code": "ok",
|
|
17612
17636
|
* "title": "IndexNow key verification file (/<key>.txt)",
|
|
17613
17637
|
* "status": "pass",
|
|
17614
17638
|
* "summary": "The IndexNow key file is reachable and matches, so search engines can verify new or updated content.",
|
|
@@ -17628,11 +17652,17 @@ export interface operations {
|
|
|
17628
17652
|
* @enum {string}
|
|
17629
17653
|
*/
|
|
17630
17654
|
id: "derivatives" | "jsonld" | "content" | "analytics" | "revalidate" | "indexnow" | "hosted_redirect" | "gsc" | "customer_auth" | "i18n_pages" | "i18n_alternates" | "i18n_files";
|
|
17655
|
+
/** @description Stable result code for this check (for example ok, partial, unreachable, none, paused, not_connected). Branch on id + code; title, summary and remediation are English text that may be reworded. */
|
|
17656
|
+
code: string;
|
|
17631
17657
|
title: string;
|
|
17632
17658
|
/** @enum {string} */
|
|
17633
17659
|
status: "pass" | "warn" | "fail";
|
|
17634
17660
|
summary: string;
|
|
17635
17661
|
remediation: string;
|
|
17662
|
+
/** @description Values behind the result (counts, URLs, lists). */
|
|
17663
|
+
params?: {
|
|
17664
|
+
[key: string]: string | number;
|
|
17665
|
+
};
|
|
17636
17666
|
details?: {
|
|
17637
17667
|
[key: string]: unknown;
|
|
17638
17668
|
};
|
|
@@ -35664,6 +35694,15 @@ export interface operations {
|
|
|
35664
35694
|
content: {
|
|
35665
35695
|
/**
|
|
35666
35696
|
* @example {
|
|
35697
|
+
* "registration": {
|
|
35698
|
+
* "state": "registered",
|
|
35699
|
+
* "via": "kanorio",
|
|
35700
|
+
* "step": null,
|
|
35701
|
+
* "reason": null,
|
|
35702
|
+
* "propertyUrl": "https://www.sunnybakery.example/",
|
|
35703
|
+
* "registeredAt": "2026-10-01T02:30:00.000Z"
|
|
35704
|
+
* },
|
|
35705
|
+
* "dataLink": "connected",
|
|
35667
35706
|
* "connected": true,
|
|
35668
35707
|
* "email": "owner@sunnybakery.example",
|
|
35669
35708
|
* "propertyUrl": "https://www.sunnybakery.example/",
|
|
@@ -35677,6 +35716,29 @@ export interface operations {
|
|
|
35677
35716
|
* }
|
|
35678
35717
|
*/
|
|
35679
35718
|
"application/json": {
|
|
35719
|
+
/** @description Registration with Google for the site's current address. */
|
|
35720
|
+
registration: {
|
|
35721
|
+
/**
|
|
35722
|
+
* @description The single answer to whether Google knows the site's current public address. registered: nothing to do. not_registered: the owner either connects a Google account under SEO › Settings or registers the site in Google Search Console and marks it there. in_progress: a Google account is connected and registration is running or waiting on `step`. blocked: a HEADLESS frontend does not serve /sitemap.xml yet. url_changed: the address changed, Google only knows a previous one, and no Google account is connected to register the new one. unavailable: there is no public address to register (see `reason`).
|
|
35723
|
+
* @enum {string}
|
|
35724
|
+
*/
|
|
35725
|
+
state: "unavailable" | "not_registered" | "in_progress" | "blocked" | "registered" | "url_changed";
|
|
35726
|
+
/** @description Who registered the current address: kanorio (through the connected Google account) or self (the owner registered it in Google Search Console and marked it in the dashboard). null unless state is registered. */
|
|
35727
|
+
via: ("kanorio" | "self") | null;
|
|
35728
|
+
/** @description Where an in-progress registration stands. verifying, dns_pending and retrying resolve on their own. ownership_required: the owner verifies the domain in Google Search Console. sitemap_not_reachable: fix /sitemap.xml on the frontend. reconnect_required: the owner reconnects the Google account. null unless state is in_progress. */
|
|
35729
|
+
step: ("verifying" | "ownership_required" | "sitemap_not_reachable" | "dns_pending" | "reconnect_required" | "retrying") | null;
|
|
35730
|
+
/** @description Why there is nothing to register. null unless state is unavailable. */
|
|
35731
|
+
reason: ("not_published" | "no_frontend_url" | "service_closed" | "indexing_off") | null;
|
|
35732
|
+
/** @description The site's current public address in Search Console URL-prefix form. */
|
|
35733
|
+
propertyUrl: string | null;
|
|
35734
|
+
/** @description ISO time the current address was registered. null unless state is registered. */
|
|
35735
|
+
registeredAt: string | null;
|
|
35736
|
+
};
|
|
35737
|
+
/**
|
|
35738
|
+
* @description Whether a Google account is connected without an authorization problem (not_connected, connected, reconnect_required). Independent of registration.state: a site its owner registered has registration.state registered and dataLink not_connected, and that is complete. connected does not guarantee fresh data: when lastFailureCode is set (for example after switching to a Google account that does not own the domain), search performance and index status stop updating until the owner fixes the step it names.
|
|
35739
|
+
* @enum {string}
|
|
35740
|
+
*/
|
|
35741
|
+
dataLink: "not_connected" | "connected" | "reconnect_required";
|
|
35680
35742
|
/** @description A Google account is connected (refresh token present). */
|
|
35681
35743
|
connected: boolean;
|
|
35682
35744
|
/** @description Connected Google account email. */
|
|
@@ -37977,6 +38039,12 @@ export interface operations {
|
|
|
37977
38039
|
content: {
|
|
37978
38040
|
/**
|
|
37979
38041
|
* @example {
|
|
38042
|
+
* "principal": {
|
|
38043
|
+
* "kind": "USER",
|
|
38044
|
+
* "id": "usr_example01",
|
|
38045
|
+
* "name": null
|
|
38046
|
+
* },
|
|
38047
|
+
* "credentialKind": "PAT",
|
|
37980
38048
|
* "userId": "usr_example01",
|
|
37981
38049
|
* "tokenId": "tok_example01",
|
|
37982
38050
|
* "channel": "mcp",
|
|
@@ -37997,8 +38065,25 @@ export interface operations {
|
|
|
37997
38065
|
* }
|
|
37998
38066
|
*/
|
|
37999
38067
|
"application/json": {
|
|
38000
|
-
/** @description
|
|
38001
|
-
|
|
38068
|
+
/** @description Who this credential acts as. */
|
|
38069
|
+
principal: {
|
|
38070
|
+
/**
|
|
38071
|
+
* @description USER: a personal access token or an OAuth connection acting as a person. SERVICE_ACCOUNT: a service account token acting as the website itself.
|
|
38072
|
+
* @enum {string}
|
|
38073
|
+
*/
|
|
38074
|
+
kind: "USER" | "SERVICE_ACCOUNT";
|
|
38075
|
+
/** @description User id, or service account id. */
|
|
38076
|
+
id: string;
|
|
38077
|
+
/** @description Service account name; null for a user. */
|
|
38078
|
+
name: string | null;
|
|
38079
|
+
};
|
|
38080
|
+
/**
|
|
38081
|
+
* @description Kind of credential: personal access token, OAuth access token, or service account token.
|
|
38082
|
+
* @enum {string}
|
|
38083
|
+
*/
|
|
38084
|
+
credentialKind: "PAT" | "OAUTH" | "SERVICE_TOKEN";
|
|
38085
|
+
/** @description Authenticated user id; null for a service account token (use principal). */
|
|
38086
|
+
userId: string | null;
|
|
38002
38087
|
/** @description Current token id. */
|
|
38003
38088
|
tokenId: string;
|
|
38004
38089
|
/** @description Request channel (mcp or api). */
|
|
@@ -38016,10 +38101,10 @@ export interface operations {
|
|
|
38016
38101
|
/** @description Capability name. */
|
|
38017
38102
|
name: string;
|
|
38018
38103
|
/**
|
|
38019
|
-
* @description Why the capability is
|
|
38104
|
+
* @description Why the capability cannot be called: the token lacks requiredScope, the feature is off on this deployment, or this kind of principal may not call it (a service account calling an operation that needs a person's token).
|
|
38020
38105
|
* @enum {string}
|
|
38021
38106
|
*/
|
|
38022
|
-
reason: "missing_scope" | "feature_disabled";
|
|
38107
|
+
reason: "missing_scope" | "feature_disabled" | "principal_not_allowed";
|
|
38023
38108
|
/** @description Scope needed to unlock this capability. */
|
|
38024
38109
|
requiredScope: string | null;
|
|
38025
38110
|
}[];
|
|
@@ -38027,7 +38112,7 @@ export interface operations {
|
|
|
38027
38112
|
site?: {
|
|
38028
38113
|
websiteId: string;
|
|
38029
38114
|
/**
|
|
38030
|
-
* @description Your team role kind on this website.
|
|
38115
|
+
* @description Your team role kind on this website; custom for a service account (its permissions are the ones it was granted).
|
|
38031
38116
|
* @enum {string}
|
|
38032
38117
|
*/
|
|
38033
38118
|
role: "owner" | "admin" | "custom";
|
|
@@ -38132,7 +38217,7 @@ export interface operations {
|
|
|
38132
38217
|
systemHost: string | null;
|
|
38133
38218
|
externalStorefrontUrl: string | null;
|
|
38134
38219
|
}[];
|
|
38135
|
-
/** @description false when this token is restricted to specific websites; sites.create then fails with TOKEN_WEBSITE_SCOPED
|
|
38220
|
+
/** @description false when this token is restricted to specific websites; sites.create then fails with TOKEN_WEBSITE_SCOPED. The user either creates the site in the backoffice, or switches this connection to all websites under Account settings > API access (no reconnection needed); see guidance. */
|
|
38136
38221
|
tokenCanCreateSites: boolean;
|
|
38137
38222
|
/**
|
|
38138
38223
|
* @description Where the account is on the path to a custom-frontend site.
|
package/dist/http.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
2
|
+
* The fetch core shared by the three clients: builds the URL, sends headers, parses JSON, turns the error envelope into `KanorioApiError`
|
|
3
|
+
* and reads the Deprecation and Sunset headers (RFC 9745, RFC 8594). No business logic.
|
|
4
4
|
*/
|
|
5
5
|
import { type ServerKeyOptions } from "./server-key.js";
|
|
6
|
-
export declare const KANORIO_SDK_VERSION = "1.
|
|
6
|
+
export declare const KANORIO_SDK_VERSION = "1.1.0";
|
|
7
7
|
export declare const SDK_VERSION_HEADER = "x-kanorio-sdk-version";
|
|
8
8
|
export interface ErrorEnvelope {
|
|
9
9
|
error: {
|
|
@@ -17,14 +17,14 @@ export declare class KanorioApiError extends Error {
|
|
|
17
17
|
readonly code: string;
|
|
18
18
|
readonly status: number;
|
|
19
19
|
readonly details?: unknown | undefined;
|
|
20
|
-
/** 429
|
|
20
|
+
/** Suggested wait in seconds on 429 and 503 (the `Retry-After` header or `details.retryAfter`) */
|
|
21
21
|
readonly retryAfter?: number | undefined;
|
|
22
|
-
/**
|
|
22
|
+
/** Release time attached to an access decision (`details.availableAt` of `NOT_RELEASED`) */
|
|
23
23
|
readonly availableAt?: string | undefined;
|
|
24
24
|
constructor(code: string, status: number, message: string, details?: unknown | undefined,
|
|
25
|
-
/** 429
|
|
25
|
+
/** Suggested wait in seconds on 429 and 503 (the `Retry-After` header or `details.retryAfter`) */
|
|
26
26
|
retryAfter?: number | undefined,
|
|
27
|
-
/**
|
|
27
|
+
/** Release time attached to an access decision (`details.availableAt` of `NOT_RELEASED`) */
|
|
28
28
|
availableAt?: string | undefined);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
@@ -48,15 +48,15 @@ export type Query = Record<string, QueryValue | QueryValue[]>;
|
|
|
48
48
|
export declare function buildUrl(baseUrl: string, path: string, query?: Query): string;
|
|
49
49
|
export interface HttpClientOptions extends ServerKeyOptions {
|
|
50
50
|
baseUrl: string;
|
|
51
|
-
/**
|
|
51
|
+
/** Uses the global `fetch` when omitted */
|
|
52
52
|
fetch?: typeof fetch;
|
|
53
|
-
/**
|
|
53
|
+
/** Headers added to every request (may be a function, for dynamic tokens) */
|
|
54
54
|
headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
|
|
55
|
-
/**
|
|
55
|
+
/** Timeout in milliseconds; none when omitted */
|
|
56
56
|
timeoutMs?: number;
|
|
57
|
-
/**
|
|
57
|
+
/** Called when the server announces a deprecation (`console.warn` once by default) */
|
|
58
58
|
onDeprecation?: (notice: DeprecationNotice) => void;
|
|
59
|
-
/**
|
|
59
|
+
/** User agent string (Node); ignored in browsers */
|
|
60
60
|
userAgent?: string;
|
|
61
61
|
}
|
|
62
62
|
export interface RequestOptions {
|
|
@@ -67,7 +67,7 @@ export interface RequestOptions {
|
|
|
67
67
|
}
|
|
68
68
|
export interface HttpClient {
|
|
69
69
|
request<T>(method: string, path: string, options?: RequestOptions): Promise<T>;
|
|
70
|
-
/**
|
|
70
|
+
/** The full response (headers and status), without throwing */
|
|
71
71
|
raw(method: string, path: string, options?: RequestOptions): Promise<Response>;
|
|
72
72
|
}
|
|
73
73
|
export declare function createHttpClient(options: HttpClientOptions): HttpClient;
|
package/dist/http.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
2
|
+
* The fetch core shared by the three clients: builds the URL, sends headers, parses JSON, turns the error envelope into `KanorioApiError`
|
|
3
|
+
* and reads the Deprecation and Sunset headers (RFC 9745, RFC 8594). No business logic.
|
|
4
4
|
*/
|
|
5
5
|
import { EDGE_CHALLENGE_CODE, edgeChallengeMessage, isEdgeChallenge, serverKeyRequest } from "./server-key.js";
|
|
6
|
-
export const KANORIO_SDK_VERSION = "1.
|
|
6
|
+
export const KANORIO_SDK_VERSION = "1.1.0";
|
|
7
7
|
export const SDK_VERSION_HEADER = "x-kanorio-sdk-version";
|
|
8
8
|
export function isErrorEnvelope(value) {
|
|
9
9
|
if (typeof value !== "object" || value === null)
|
|
@@ -21,9 +21,9 @@ export class KanorioApiError extends Error {
|
|
|
21
21
|
retryAfter;
|
|
22
22
|
availableAt;
|
|
23
23
|
constructor(code, status, message, details,
|
|
24
|
-
/** 429
|
|
24
|
+
/** Suggested wait in seconds on 429 and 503 (the `Retry-After` header or `details.retryAfter`) */
|
|
25
25
|
retryAfter,
|
|
26
|
-
/**
|
|
26
|
+
/** Release time attached to an access decision (`details.availableAt` of `NOT_RELEASED`) */
|
|
27
27
|
availableAt) {
|
|
28
28
|
super(message);
|
|
29
29
|
this.code = code;
|
|
@@ -48,7 +48,7 @@ export function toApiError(status, body, headers) {
|
|
|
48
48
|
const retryHeader = headers.get("retry-after");
|
|
49
49
|
const retryAfter = retryHeader ? Number.parseInt(retryHeader, 10) : undefined;
|
|
50
50
|
if (isErrorEnvelope(body)) {
|
|
51
|
-
//
|
|
51
|
+
// The three APIs share one error envelope: extra fields are in details
|
|
52
52
|
const details = body.error.details;
|
|
53
53
|
const detailRetry = typeof details?.retryAfter === "number" ? details.retryAfter : undefined;
|
|
54
54
|
const availableAt = typeof details?.availableAt === "string" ? details.availableAt : undefined;
|
|
@@ -110,7 +110,7 @@ export function createHttpClient(options) {
|
|
|
110
110
|
body = JSON.stringify(req.body);
|
|
111
111
|
}
|
|
112
112
|
const url = buildUrl(options.baseUrl, path, req.query);
|
|
113
|
-
//
|
|
113
|
+
// Server key: server side only, https only, redirects not followed (custom headers are not stripped on cross-origin redirects)
|
|
114
114
|
const viaServerKey = await serverKeyRequest(options, url);
|
|
115
115
|
if (viaServerKey)
|
|
116
116
|
for (const [name, value] of Object.entries(viaServerKey.headers))
|
|
@@ -135,7 +135,7 @@ export function createHttpClient(options) {
|
|
|
135
135
|
}
|
|
136
136
|
async function request(method, path, req = {}) {
|
|
137
137
|
const res = await raw(method, path, req);
|
|
138
|
-
//
|
|
138
|
+
// The edge's challenge page is not an API response: return an error that says what to do next instead of "HTTP 403" and a block of HTML
|
|
139
139
|
if (isEdgeChallenge(res))
|
|
140
140
|
throw new KanorioEdgeChallengeError(edgeChallengeMessage(Boolean(options.serverKey)));
|
|
141
141
|
const notice = parseDeprecation(res.headers, method, path);
|
package/dist/index.js
CHANGED
|
@@ -12,6 +12,6 @@ export { revalidate, createRevalidateHandler, verifyWebhookSignature, computeWeb
|
|
|
12
12
|
export { forms, createFormsHelpers, protectionFromChallenge, uploadProtectionFromChallenge, } from "./forms.js";
|
|
13
13
|
export { edge, createKanorioMiddleware, classifyEdgeUserAgent, isEdgeBotBlocked, EDGE_BOT_LIST, CRAWLER_LIST_VERSION, } from "./edge.js";
|
|
14
14
|
export { preview, previewHeaders, tokenFromCookieHeader, isValidPreviewTokenFormat, sanitizePreviewRedirectPath, createPreviewRouteHandler, PREVIEW_TOKEN_PREFIX, PREVIEW_COOKIE_NAME, } from "./preview.js";
|
|
15
|
-
//
|
|
16
|
-
//
|
|
15
|
+
// Bot protection (shared by forms and customer sign-in): for forms, `protectionFromChallenge(formId, challenge, renderedAt)` is above;
|
|
16
|
+
// for sign-in (`GET /customer/auth/protection`), use `solveProtectionChallenge(challenge, { context, renderedAt })`
|
|
17
17
|
export { protectionFromChallenge as solveProtectionChallenge, solveAltchaChallenge, } from "./protection.js";
|