@wix/auto_sdk_app-components_components-catalog 1.0.109 → 1.0.111

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.
@@ -22627,18 +22627,21 @@ interface DispatchOrigin {
22627
22627
  declare enum VerificationSource {
22628
22628
  /**
22629
22629
  * One set of material covers every delivery of this connector: a single stored secret for the
22630
- * HMAC and callback-token methods, or the published key set at public_key_url for PUBLIC_KEY
22631
- * and OIDC_BEARER, where nothing is stored at all. The only legal scope for either.
22630
+ * HMAC and callback-token methods, or the published key set at the arm's public_key_url for
22631
+ * PUBLIC_KEY and OIDC_BEARER, where nothing is stored at all. The only legal scope for either.
22632
22632
  */
22633
22633
  CONNECTOR_WIDE = "CONNECTOR_WIDE",
22634
22634
  /**
22635
22635
  * Material is issued per registration and lives on the registration the delivery was sent to.
22636
- * Requires registration_required.
22636
+ * Requires registration_required. A registration is the provider-side one for a single
22637
+ * account, which is that account's subscription; there is no separate registration entity.
22637
22638
  */
22638
22639
  PER_REGISTRATION = "PER_REGISTRATION",
22639
22640
  /**
22640
22641
  * There is no material, because nothing is verified. The only legal scope for
22641
- * NO_VERIFICATION, and legal for nothing else.
22642
+ * NO_VERIFICATION, and legal for nothing else. Redundant with NO_VERIFICATION on purpose:
22643
+ * every enum in a valid config is explicitly set, so "nothing was declared" and "the
22644
+ * declaration is that nothing is verified" stay distinguishable.
22642
22645
  */
22643
22646
  UNSIGNED = "UNSIGNED"
22644
22647
  }
@@ -22683,7 +22686,7 @@ type SignedPayloadWithLiterals = SignedPayload | 'RAW_BODY' | 'TIMESTAMP_DOT_RAW
22683
22686
  /**
22684
22687
  * Per-method payload for the `verification` oneof above. Shared by HMAC_SHA256,
22685
22688
  * HMAC_SHA1, and (wrapped) PUBLIC_KEY - the three methods signatureMethods already groups
22686
- * together in the validator. timestamp_header / timestamp_tolerance_seconds stay flat on
22689
+ * together in the validator. timestamp_header / timestamp_tolerance_seconds stay on
22687
22690
  * WebhookConfig rather than moving in here, since BODY_HASH_WITHIN_TIMESTAMP_WINDOW borrows
22688
22691
  * them independently of which verification_method is selected.
22689
22692
  */
@@ -22697,13 +22700,20 @@ interface HmacConfig {
22697
22700
  signatureHeader?: string;
22698
22701
  /**
22699
22702
  * Literal prefix the provider places in front of the encoded signature, for example
22700
- * "sha256=" or "v0=". Empty when the header holds the bare signature.
22703
+ * "sha256=" or "v0=". Empty when the header holds the bare signature. A constant, never a
22704
+ * template: compared verbatim against the start of the header, and a delivery whose header
22705
+ * does not start with it is rejected.
22701
22706
  * @maxLength 20
22702
22707
  */
22703
22708
  signatureValuePrefix?: string;
22704
22709
  /** How the signature bytes are encoded in signature_header. */
22705
22710
  signatureEncoding?: SignatureEncodingWithLiterals;
22706
- /** Which canonical string the signature is computed over. */
22711
+ /**
22712
+ * Which canonical string the signature is computed over, from a closed set of recipes. There
22713
+ * is deliberately no free-form signing template, which would make the inbound path an
22714
+ * interpreter of app-owner input; a provider whose canonical string is not listed needs a new
22715
+ * enum value.
22716
+ */
22707
22717
  signedPayload?: SignedPayloadWithLiterals;
22708
22718
  }
22709
22719
  declare enum EventsLocation {
@@ -22723,7 +22733,7 @@ declare enum VerificationMethod {
22723
22733
  HMAC_SHA1 = "HMAC_SHA1",
22724
22734
  /**
22725
22735
  * Asymmetric signature over the canonical string, verified with a key fetched from
22726
- * public_key_url.
22736
+ * PublicKeyConfig.public_key_url.
22727
22737
  */
22728
22738
  PUBLIC_KEY = "PUBLIC_KEY",
22729
22739
  /**
@@ -22736,9 +22746,10 @@ declare enum VerificationMethod {
22736
22746
  NO_VERIFICATION = "NO_VERIFICATION",
22737
22747
  /**
22738
22748
  * OIDC bearer JWT in the Authorization header, verified against the key set at
22739
- * public_key_url with the expected audience, issuer and subject, for example Cloud Pub/Sub
22740
- * push authentication. Carries no payload binding, the same limitation CALLBACK_TOKEN
22741
- * documents for itself: it proves the sender's identity, not that the body is intact.
22749
+ * OidcBearerConfig.public_key_url with the expected audience, issuer and subject, for
22750
+ * example Cloud Pub/Sub push authentication. Carries no payload binding, the same
22751
+ * limitation CALLBACK_TOKEN documents for itself: it proves the sender's identity, not that
22752
+ * the body is intact.
22742
22753
  */
22743
22754
  OIDC_BEARER = "OIDC_BEARER"
22744
22755
  }
@@ -22747,8 +22758,8 @@ type VerificationMethodWithLiterals = VerificationMethod | 'HMAC_SHA256' | 'HMAC
22747
22758
  /** How a repeated delivery is recognized, so the same event is not processed twice. */
22748
22759
  declare enum ReplayProtection {
22749
22760
  /**
22750
- * The provider sends a per-delivery id, named by delivery_id_header, and a delivery already
22751
- * seen under that id is discarded.
22761
+ * The provider sends a per-delivery id, named by DeliveryIdHeaderConfig.delivery_id_header,
22762
+ * and a delivery already seen under that id is discarded.
22752
22763
  */
22753
22764
  DELIVERY_ID_HEADER = "DELIVERY_ID_HEADER",
22754
22765
  /**
@@ -23078,8 +23089,9 @@ interface DispatchConfig {
23078
23089
  *
23079
23090
  * No credential material is declared here. This config lives in the app component catalog and is
23080
23091
  * readable by app owners; signing secrets and callback tokens are stored separately and are
23081
- * located through verification_source. public_key_url is the only credential-adjacent field, and
23082
- * it points at material the provider publishes.
23092
+ * located through the selected verification arm's verification_source. The public_key_url on
23093
+ * PublicKeyConfig and OidcBearerConfig is the only credential-adjacent field, and it points at
23094
+ * material the provider publishes.
23083
23095
  *
23084
23096
  * Fields naming something the provider owns carry a provider_ prefix, so the identifiers a
23085
23097
  * delivery arrives with are never confused with the ones Wix mints.
@@ -23110,90 +23122,19 @@ interface WebhookConfig extends WebhookConfigVerificationOneOf, WebhookConfigRep
23110
23122
  * must select a concrete method — an unset method is rejected rather than treated as a default.
23111
23123
  */
23112
23124
  verificationMethod?: VerificationMethodWithLiterals;
23113
- /**
23114
- * Scope of the material used by verification_method: shared by the whole connector, or issued
23115
- * per registration. Names the scope rather than the kind of material, so it stays accurate for
23116
- * PUBLIC_KEY, where the connector-wide material is a published key URL and nothing is stored.
23117
- *
23118
- * "Per registration" is the provider-side registration for one account, which is that account's
23119
- * subscription - there is no separate registration entity to look for.
23120
- *
23121
- * The UNSIGNED arm is redundant with verification_method = NO_VERIFICATION, and deliberately so:
23122
- * every enum in a valid config is explicitly set, which keeps "nothing was declared" and "the
23123
- * declaration is that nothing is verified" distinguishable states rather than the same unset
23124
- * field. The alternative - dropping the arm and making this field conditionally required - moves
23125
- * the same fact into a validation rule instead of removing it.
23126
- *
23127
- * Deprecated: superseded by each `verification` arm's own verification_source field. Kept live
23128
- * and enforced for the flat-shape configs this migration has not yet moved off of.
23129
- * @deprecated
23130
- * @replacedBy verification (each arm's own verification_source field)
23131
- * @targetRemovalDate 2027-06-30
23132
- */
23133
- verificationSource?: VerificationSourceWithLiterals;
23134
- /**
23135
- * Header carrying the signature to verify. Required for HMAC_SHA256, HMAC_SHA1 and PUBLIC_KEY,
23136
- * and must be empty for every other method. For example: "X-Hub-Signature-256".
23137
- *
23138
- * Deprecated: superseded by HmacConfig.signature_header (via the `verification` oneof's
23139
- * hmac_sha256_config, hmac_sha1_config and public_key_config arms).
23140
- * @maxLength 120
23141
- * @deprecated
23142
- * @replacedBy HmacConfig.signature_header (via the verification oneof)
23143
- * @targetRemovalDate 2027-06-30
23144
- */
23145
- signatureHeader?: string;
23146
- /**
23147
- * Literal prefix the provider places in front of the encoded signature, for example "sha256="
23148
- * or "v0=". Empty when the header holds the bare signature.
23149
- *
23150
- * The value is a constant, never a template: it is compared verbatim against the start of the
23151
- * header and stripped before decoding, and a delivery whose header does not start with it is
23152
- * rejected. Nothing in it is interpreted or substituted.
23153
- *
23154
- * Deprecated: superseded by HmacConfig.signature_value_prefix.
23155
- * @maxLength 20
23156
- * @deprecated
23157
- * @replacedBy HmacConfig.signature_value_prefix (via the verification oneof)
23158
- * @targetRemovalDate 2027-06-30
23159
- */
23160
- signatureValuePrefix?: string;
23161
- /**
23162
- * How the signature bytes are encoded in signature_header. Required whenever signature_header
23163
- * is required.
23164
- *
23165
- * Deprecated: superseded by HmacConfig.signature_encoding.
23166
- * @deprecated
23167
- * @replacedBy HmacConfig.signature_encoding (via the verification oneof)
23168
- * @targetRemovalDate 2027-06-30
23169
- */
23170
- signatureEncoding?: SignatureEncodingWithLiterals;
23171
- /**
23172
- * Which canonical string the signature is computed over, selected from a closed set of recipes
23173
- * the server implements. Required whenever signature_header is required.
23174
- *
23175
- * There is deliberately no free-form signing template: a configurable template would make the
23176
- * inbound path an interpreter of app-owner input and an injection surface. A provider whose
23177
- * canonical string is not listed here needs a new enum value, not a new template.
23178
- *
23179
- * Deprecated: superseded by HmacConfig.signed_payload.
23180
- * @deprecated
23181
- * @replacedBy HmacConfig.signed_payload (via the verification oneof)
23182
- * @targetRemovalDate 2027-06-30
23183
- */
23184
- signedPayload?: SignedPayloadWithLiterals;
23185
23125
  /**
23186
23126
  * Header carrying the delivery timestamp, used to reject stale and replayed deliveries. For
23187
- * example: "X-Slack-Request-Timestamp". Required by the signed_payload recipes that include a
23188
- * timestamp, and must be set together with timestamp_tolerance_seconds. The header value is read
23189
- * as epoch seconds, except under METHOD_URI_BODY_TIMESTAMP, which reads it as epoch milliseconds.
23127
+ * example: "X-Slack-Request-Timestamp". Required by the HmacConfig.signed_payload recipes that
23128
+ * include a timestamp, and must be set together with timestamp_tolerance_seconds. The header
23129
+ * value is read as epoch seconds, except under METHOD_URI_BODY_TIMESTAMP, which reads it as
23130
+ * epoch milliseconds.
23190
23131
  * @maxLength 120
23191
23132
  */
23192
23133
  timestampHeader?: string;
23193
23134
  /**
23194
23135
  * How far the delivery timestamp may be from server time before the delivery is rejected. Must
23195
23136
  * be greater than zero when timestamp_header is set, and zero when it is not. Always in seconds,
23196
- * whatever unit the signed_payload recipe reads timestamp_header in.
23137
+ * whatever unit the HmacConfig.signed_payload recipe reads timestamp_header in.
23197
23138
  *
23198
23139
  * The tolerance is a floor on replay-protection retention, not only a freshness bound: whatever
23199
23140
  * remembers seen deliveries has to outlive this window, or a delivery still inside its accepted
@@ -23206,52 +23147,6 @@ interface WebhookConfig extends WebhookConfigVerificationOneOf, WebhookConfigRep
23206
23147
  * @max 3600
23207
23148
  */
23208
23149
  timestampToleranceSeconds?: number;
23209
- /**
23210
- * Header carrying the shared token the provider echoes on every delivery. Required for
23211
- * CALLBACK_TOKEN and must be empty for every other method. For example:
23212
- * "X-Goog-Channel-Token". The token itself is never declared here — it is located through
23213
- * verification_source.
23214
- *
23215
- * Deprecated: superseded by CallbackTokenConfig.callback_token_header.
23216
- * @maxLength 120
23217
- * @deprecated
23218
- * @replacedBy verification.callback_token_config.callback_token_header
23219
- * @targetRemovalDate 2027-06-30
23220
- */
23221
- callbackTokenHeader?: string;
23222
- /**
23223
- * Endpoint publishing the provider's public keys. Required for PUBLIC_KEY and OIDC_BEARER, and
23224
- * must be empty for every other method.
23225
- *
23226
- * Deliberately has no (wix.api.format), following revoke_url above: WEB_URL rejects the empty
23227
- * value this field carries for every other method. HTTPS and a parseable endpoint are enforced
23228
- * when the keys are fetched instead.
23229
- *
23230
- * Deprecated: superseded by PublicKeyConfig.public_key_url for PUBLIC_KEY, and by
23231
- * OidcBearerConfig.public_key_url for OIDC_BEARER.
23232
- * @maxLength 2000
23233
- * @deprecated
23234
- * @replacedBy verification.public_key_config.public_key_url (PUBLIC_KEY) or verification.oidc_bearer_config.public_key_url (OIDC_BEARER)
23235
- * @targetRemovalDate 2027-06-30
23236
- */
23237
- publicKeyUrl?: string;
23238
- /**
23239
- * Header carrying the provider's unique id for this delivery, for example "X-GitHub-Delivery".
23240
- * Required by, and legal only with, replay_protection = DELIVERY_ID_HEADER.
23241
- *
23242
- * The id is only as unique as the provider makes it. Google Calendar's X-Goog-Message-Number,
23243
- * for instance, counts per notification channel rather than globally, so a delivery is
23244
- * identified by the registration it arrived on together with this value, never by the value
23245
- * alone.
23246
- *
23247
- * Deprecated: superseded by DeliveryIdHeaderConfig.delivery_id_header (via the
23248
- * `replay_protection_config` oneof's delivery_id_header_config arm).
23249
- * @maxLength 120
23250
- * @deprecated
23251
- * @replacedBy replay_protection_config.delivery_id_header_config.delivery_id_header
23252
- * @targetRemovalDate 2027-06-30
23253
- */
23254
- deliveryIdHeader?: string;
23255
23150
  /**
23256
23151
  * Header carrying the event type of the delivery, for example "X-GitHub-Event". Optional: at
23257
23152
  * most one of event_type_header and event_type_json_pointer may be set, and a provider with no
@@ -23369,47 +23264,6 @@ interface WebhookConfig extends WebhookConfigVerificationOneOf, WebhookConfigRep
23369
23264
  * @immutable
23370
23265
  */
23371
23266
  deliveryTopic?: string;
23372
- /**
23373
- * Expected `aud` claim of an OIDC_BEARER token. An OIDC issuer's audience is chosen by whoever
23374
- * requested the token, not by the issuer, so pinning the value expected here is what stops a
23375
- * bearer token minted for a different audience — a different Pub/Sub push subscription, for
23376
- * instance — from authenticating against this one. Required for OIDC_BEARER and must be empty
23377
- * for every other method.
23378
- *
23379
- * Deprecated: superseded by OidcBearerConfig.oidc_expected_audience.
23380
- * @maxLength 2000
23381
- * @deprecated
23382
- * @replacedBy verification.oidc_bearer_config.oidc_expected_audience
23383
- * @targetRemovalDate 2027-06-30
23384
- */
23385
- oidcExpectedAudience?: string;
23386
- /**
23387
- * Expected `iss` claim of an OIDC_BEARER token, for example "https://accounts.google.com".
23388
- * Required for OIDC_BEARER and must be empty for every other method.
23389
- *
23390
- * Deprecated: superseded by OidcBearerConfig.oidc_expected_issuer.
23391
- * @maxLength 2000
23392
- * @deprecated
23393
- * @replacedBy verification.oidc_bearer_config.oidc_expected_issuer
23394
- * @targetRemovalDate 2027-06-30
23395
- */
23396
- oidcExpectedIssuer?: string;
23397
- /**
23398
- * Expected `sub` claim of an OIDC_BEARER token — the stable identifier of the specific caller
23399
- * trusted to send this connector's deliveries, for example a Pub/Sub push subscription's
23400
- * service account. iss and aud alone do not identify the sender: aud is a value the token
23401
- * *requester* chooses, not the issuer, so any principal able to mint a same-issuer,
23402
- * same-audience token — a different Google service account with permission to request an ID
23403
- * token for this audience, for instance — would otherwise pass. Required for OIDC_BEARER and
23404
- * must be empty for every other method.
23405
- *
23406
- * Deprecated: superseded by OidcBearerConfig.oidc_expected_subject.
23407
- * @maxLength 2000
23408
- * @deprecated
23409
- * @replacedBy verification.oidc_bearer_config.oidc_expected_subject
23410
- * @targetRemovalDate 2027-06-30
23411
- */
23412
- oidcExpectedSubject?: string;
23413
23267
  /**
23414
23268
  * Set when one delivery body is a batch of events, each possibly for a different provider tenant.
23415
23269
  * The whole request is verified once, then split into one delivery per element.