@wix/bex-utils 2.71.0 → 2.73.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/@wix/ambassador-dealer-v1-serving-offer/build/cjs/builders.impl.d.ts +115 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/builders.impl.js +1340 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/builders.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/http.impl.d.ts +29 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/http.impl.js +524 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/http.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/meta.impl.d.ts +20 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/meta.impl.js +119 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/meta.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/proto/client/proto-generated.d.ts +18874 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/proto/client/proto-generated.js +2 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/proto/proto-generated.d.ts +9468 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/proto/proto-generated.js +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/proto/server/proto-generated.d.ts +18788 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/proto/server/proto-generated.js +2 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/rpc.impl.d.ts +39 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/rpc.impl.js +113 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/rpc.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/types.impl.d.ts +1248 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/types.impl.js +371 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/cjs/types.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/builders.impl.d.ts +115 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/builders.impl.js +1209 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/builders.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/http.impl.d.ts +29 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/http.impl.js +516 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/http.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/meta.impl.d.ts +20 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/meta.impl.js +92 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/meta.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/rpc.impl.d.ts +39 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/rpc.impl.js +86 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/rpc.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/types.impl.d.ts +1248 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/types.impl.js +368 -0
- package/@wix/ambassador-dealer-v1-serving-offer/build/es/types.impl.js.map +1 -0
- package/@wix/ambassador-dealer-v1-serving-offer/builders/package.json +7 -0
- package/@wix/ambassador-dealer-v1-serving-offer/http/package.json +7 -0
- package/@wix/ambassador-dealer-v1-serving-offer/meta/package.json +7 -0
- package/@wix/ambassador-dealer-v1-serving-offer/package.json +52 -0
- package/@wix/ambassador-dealer-v1-serving-offer/rpc/package.json +6 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/abtest/v2/experiment_properties.proto +46 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/abtest/v2/experiment_results.proto +39 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/abtest/v2/experiment_support_kpis.proto +29 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/abtest/v2/experiments_properties_thin.proto +31 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/abtest/v2/wixab_service.proto +81 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/action_payload.proto +33 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/annotations.proto +451 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/api_errors.proto +142 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/callback.proto +163 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/context.proto +19 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/entity.proto +127 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/errors.proto +127 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/idempotency.proto +25 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/permissions.proto +46 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/sla.proto +24 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/subscription.proto +32 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/api/validations.proto +142 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/address.proto +148 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/bulk.proto +53 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/data/dataextensions/extended-fields.proto +20 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/data/dataextensions/update-extended-fields-messages.proto +15 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/data/errors.proto +435 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/identification.proto +40 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/image.proto +8 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/media.proto +280 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/money.proto +32 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/pageurl.proto +32 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/paging.proto +121 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/query.proto +812 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/sorting.proto +36 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/spi.proto +85 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/tags.proto +55 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/wixlink.proto +203 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/audiences.proto +226 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/campaigns.proto +270 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/frequency-caps.proto +74 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/localization-managers.proto +11 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/managers.proto +11 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/offer-test.proto +338 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/offer.proto +298 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/offers-service.proto +696 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/placements.proto +423 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/schemas-service.proto +142 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/targeting.proto +378 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/upstream/wix/common/paging.proto +126 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/upstream/wix/common/query.proto +840 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/upstream/wix/common/sorting.proto +37 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerOffersServing/api/v1/dealer-offers-debug.proto +188 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerOffersServing/api/v1/dealer-offers-serving.proto +177 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerOffersServing/api/v1/offer.proto +87 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerPriority/api/v1/priority-service.proto +57 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerPriority/api/v1/priority.proto +132 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/graphql/definitions.proto +13 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/http/field_mask.proto +46 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/optimization_test/v1/optimization_tester_service.proto +284 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/optimization_test/v1/test.proto +170 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/optimization_test/v1/upstream/wix/common/bulk.proto +56 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/optimization_test/v1/upstream/wix/common/paging.proto +121 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/optimization_test/v1/upstream/wix/common/query.proto +741 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/optimization_test/v1/upstream/wix/common/sorting.proto +26 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/targeting/v1/targeting.proto +406 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/targeting/v1/targeting_service.proto +247 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/variants_generator/v1/variant.proto +92 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/personalize/variants_generator/v1/variants_generator_service.proto +73 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/sdk/definitions.proto +191 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/spi/definitions.proto +187 -0
- package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/spi/http_error_status.proto +24 -0
- package/@wix/ambassador-dealer-v1-serving-offer/types/package.json +7 -0
- package/@wix/bex-bundled-mini-essentials/CHANGELOG.md +4 -0
- package/@wix/bex-bundled-mini-essentials/package.json +1 -1
- package/package.json +6 -5
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
syntax = "proto3";
|
|
2
|
+
|
|
3
|
+
package wix.personalize.variants_generator.v1;
|
|
4
|
+
option java_package = "com.wixpress.personalize.variants.generator.v1";
|
|
5
|
+
|
|
6
|
+
import "wix/api/validations.proto";
|
|
7
|
+
import "wix/api/entity.proto";
|
|
8
|
+
import "google/protobuf/wrappers.proto";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
A Variant is a variation of a content with a persona voice.
|
|
12
|
+
*/
|
|
13
|
+
message Variant {
|
|
14
|
+
// flynt-disable missing-extensible
|
|
15
|
+
// flynt-disable missing-taggable-annotation
|
|
16
|
+
option (wix.api.entity) = {
|
|
17
|
+
fqdn: "wix.personalize.generate_variants.v1.variant"
|
|
18
|
+
segment: PUBLIC
|
|
19
|
+
app_def_id: "f4b79adb-9998-48b2-b637-e45ab5358ca9"
|
|
20
|
+
appendix_files: {
|
|
21
|
+
type: DOCS_CONF,
|
|
22
|
+
path: "appendices/docs"
|
|
23
|
+
}
|
|
24
|
+
};
|
|
25
|
+
|
|
26
|
+
// Variant ID.
|
|
27
|
+
google.protobuf.StringValue id = 1 [(wix.api.maxLength) = 5, (wix.api.readOnly) = true];
|
|
28
|
+
|
|
29
|
+
// The variant string value.
|
|
30
|
+
string text = 2 [(.wix.api.maxLength) = 10000];
|
|
31
|
+
|
|
32
|
+
// The persona voice describes the variant.
|
|
33
|
+
Persona persona = 3;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
message Persona {
|
|
37
|
+
// The name describes the persona.
|
|
38
|
+
Name name = 1;
|
|
39
|
+
|
|
40
|
+
// The tone of voice describes the persona.
|
|
41
|
+
ToneOfVoice tone_of_voice = 2;
|
|
42
|
+
|
|
43
|
+
// The emotion describes the persona.
|
|
44
|
+
Emotion emotion = 3;
|
|
45
|
+
|
|
46
|
+
// The name persuasion technique the persona.
|
|
47
|
+
PersuasionTechnique persuasion_technique = 4;
|
|
48
|
+
|
|
49
|
+
// The formality level describes the persona.
|
|
50
|
+
FormalityLevel formality_level = 5;
|
|
51
|
+
|
|
52
|
+
enum Name {
|
|
53
|
+
UNKNOWN_NAME = 0;
|
|
54
|
+
FRIENDLY_GUIDE = 1;
|
|
55
|
+
PROFESSIONAL_EXPERT = 2;
|
|
56
|
+
EMPATHETIC_HELPER = 3;
|
|
57
|
+
ENTHUSIASTIC_INNOVATOR = 4;
|
|
58
|
+
AUTHORITATIVE_LEADER = 5;
|
|
59
|
+
INSPIRATIONAL_MENTOR = 6;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
enum ToneOfVoice {
|
|
63
|
+
UNKNOWN_TONE_OF_VOICE = 0;
|
|
64
|
+
FRIENDLY = 1;
|
|
65
|
+
PROFESSIONAL = 2;
|
|
66
|
+
EMPATHETIC = 3;
|
|
67
|
+
ENTHUSIASTIC = 4;
|
|
68
|
+
AUTHORITATIVE = 5;
|
|
69
|
+
INSPIRATIONAL = 6;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
enum Emotion {
|
|
73
|
+
UNKNOWN_EMOTION = 0;
|
|
74
|
+
JOY = 1;
|
|
75
|
+
TRUST = 2;
|
|
76
|
+
ANTICIPATION = 3;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
enum PersuasionTechnique {
|
|
80
|
+
UNKNOWN_PERSUASION_TECHNIQUE = 0;
|
|
81
|
+
LIKING = 1;
|
|
82
|
+
AUTHORITY = 2;
|
|
83
|
+
SOCIAL_PROOF = 3;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
enum FormalityLevel {
|
|
87
|
+
UNKNOWN_FORMALITY_LEVEL = 0;
|
|
88
|
+
CASUAL = 1;
|
|
89
|
+
FORMAL = 2;
|
|
90
|
+
NEUTRAL = 3;
|
|
91
|
+
}
|
|
92
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
syntax = "proto3";
|
|
2
|
+
|
|
3
|
+
package wix.personalize.variants_generator.v1;
|
|
4
|
+
option java_package = "com.wixpress.personalize.variants.generator.v1";
|
|
5
|
+
|
|
6
|
+
import "google/api/annotations.proto";
|
|
7
|
+
import "wix/api/annotations.proto";
|
|
8
|
+
import "wix/api/entity.proto";
|
|
9
|
+
import "wix/api/permissions.proto";
|
|
10
|
+
import "wix/api/validations.proto";
|
|
11
|
+
import "wix/personalize/variants_generator/v1/variant.proto";
|
|
12
|
+
import "google/protobuf/wrappers.proto";
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
Manages Variants Generation
|
|
16
|
+
*/
|
|
17
|
+
service VariantsGeneratorService {
|
|
18
|
+
option (wix.api.service_maturity) = ALPHA;
|
|
19
|
+
option (wix.api.service_exposure) = PUBLIC;
|
|
20
|
+
option (wix.api.service_entity).message = "wix.personalize.variants_generator.v1.Variant";
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
Generate Text Variants.
|
|
24
|
+
Get a text and generate content-equivalent text variants.
|
|
25
|
+
*/
|
|
26
|
+
rpc GenerateTextVariants (GenerateTextVariantsRequest) returns (GenerateTextVariantsResponse) {
|
|
27
|
+
option (google.api.http).post = "/v1/variants/text";
|
|
28
|
+
option (wix.api.permission).name = "PERSONALIZE.GENERATE_VARIANTS";
|
|
29
|
+
option (wix.api.required) = "GenerateTextVariantsRequest.text";
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
List The Personas.
|
|
34
|
+
Return the personas with their characteristics.
|
|
35
|
+
*/
|
|
36
|
+
rpc ListPersonas (ListPersonasRequest) returns (ListPersonasResponse) {
|
|
37
|
+
option (google.api.http).get = "/v1/personas";
|
|
38
|
+
option (wix.api.permission).name = "PERSONALIZE.GENERATE_VARIANTS";
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
message GenerateTextVariantsRequest {
|
|
43
|
+
// The original text to generate analogous variants.
|
|
44
|
+
string text = 1 [(wix.api.maxLength) = 10000];
|
|
45
|
+
|
|
46
|
+
// The requested personas of variants.
|
|
47
|
+
repeated Persona.Name personas = 2 [(wix.api.maxSize) = 6];
|
|
48
|
+
|
|
49
|
+
// The minimum number of characters for text variant.
|
|
50
|
+
google.protobuf.Int32Value min_char_num = 3;
|
|
51
|
+
|
|
52
|
+
// The maximum number of characters for text variant.
|
|
53
|
+
google.protobuf.Int32Value max_char_num = 4;
|
|
54
|
+
|
|
55
|
+
// The keywords mush be included in each variant.
|
|
56
|
+
repeated google.protobuf.StringValue included_keywords = 5 [(wix.api.maxLength) = 200, (wix.api.maxSize) = 100];
|
|
57
|
+
|
|
58
|
+
// The keywords mush not be included in each variant.
|
|
59
|
+
repeated google.protobuf.StringValue excluded_keywords = 6 [(wix.api.maxLength) = 200, (wix.api.maxSize) = 100];
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
message GenerateTextVariantsResponse {
|
|
63
|
+
// The generated variants.
|
|
64
|
+
repeated Variant variants = 1;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
message ListPersonasRequest {
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
message ListPersonasResponse {
|
|
71
|
+
// The personas with their characteristics.
|
|
72
|
+
repeated Persona personas = 1;
|
|
73
|
+
}
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
syntax = "proto2";
|
|
2
|
+
|
|
3
|
+
package wix.sdk;
|
|
4
|
+
|
|
5
|
+
import "google/protobuf/descriptor.proto";
|
|
6
|
+
|
|
7
|
+
option java_multiple_files = true;
|
|
8
|
+
option java_outer_classname = "DefinitionsProto";
|
|
9
|
+
option java_package = "com.wix.sdk";
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
logic of signature generation:
|
|
14
|
+
==============================
|
|
15
|
+
|
|
16
|
+
1) `id` (path-param) should be the first argument.
|
|
17
|
+
2) if there are more identifiers (path-params), a parent object called `identifiers` containing those will be the first argument.
|
|
18
|
+
3) first payload member will be the second argument unless overridden via proto option. in case of override, args will be taken from override option value in-order.
|
|
19
|
+
4) rest of arguments (if exist) will follow under the `options` parent.
|
|
20
|
+
|
|
21
|
+
internal logic for `identifiers` field:
|
|
22
|
+
take all path-params, merge with all `unique` fields, distinct.
|
|
23
|
+
if you have total args > 1 -> put all in `identifiers` parent.
|
|
24
|
+
otherwise - use single (usually id) arg as is and make it the first param.
|
|
25
|
+
|
|
26
|
+
`sdk.signature.params` cannot control neither `options` (last param) nor `id`/`identifiers` (first param) as those are needed by convention in Velo.
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
Examples:
|
|
30
|
+
=========
|
|
31
|
+
|
|
32
|
+
// Example-1: Default behavior, single identifier:
|
|
33
|
+
message GetProductRequest {
|
|
34
|
+
option (.wix.api.unique) = {field: "id"}; //not needed, automatically assumed
|
|
35
|
+
string id = 1;
|
|
36
|
+
string product_family = 2;
|
|
37
|
+
bool include_pii = 3;
|
|
38
|
+
}
|
|
39
|
+
rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
|
|
40
|
+
option (google.api.http) = {
|
|
41
|
+
get = "/v1/products/{id}"
|
|
42
|
+
};
|
|
43
|
+
// ...
|
|
44
|
+
}
|
|
45
|
+
// Resulted signature: getProduct(id: string, productFamily: string, options: {includePii: boolean}) Product {...}
|
|
46
|
+
{
|
|
47
|
+
sdkSignatures: [
|
|
48
|
+
{
|
|
49
|
+
args: [
|
|
50
|
+
{
|
|
51
|
+
field: {
|
|
52
|
+
path: "id" <-- field name in proto request message
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
field: {
|
|
57
|
+
path: "productFamily" <-- field name in proto request message
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
parent: {
|
|
61
|
+
name: "options"
|
|
62
|
+
fields: [
|
|
63
|
+
{
|
|
64
|
+
path: "includePii" <-- field name in proto request message
|
|
65
|
+
}
|
|
66
|
+
]
|
|
67
|
+
}
|
|
68
|
+
]
|
|
69
|
+
}
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// Example-2: Default behavior, multiple identifiers:
|
|
74
|
+
message GetProductRequest {
|
|
75
|
+
option (.wix.api.unique) = {
|
|
76
|
+
field: "catalogId"
|
|
77
|
+
field: "productId"
|
|
78
|
+
};
|
|
79
|
+
string catalogId = 1;
|
|
80
|
+
string productId = 2;
|
|
81
|
+
string product_family = 3;
|
|
82
|
+
bool include_pii = 4;
|
|
83
|
+
}
|
|
84
|
+
rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
|
|
85
|
+
option (google.api.http) = {
|
|
86
|
+
get = "/v1/catalog/{catalogId}/products/{productId}"
|
|
87
|
+
};
|
|
88
|
+
// ...
|
|
89
|
+
}
|
|
90
|
+
// Resulted signature: getProduct(identifiers: {catalogId: string, productId: string}, productFamily: string, options: {includePii: boolean}) Product {...}
|
|
91
|
+
// schema response:
|
|
92
|
+
{
|
|
93
|
+
sdkSignatures: [
|
|
94
|
+
{
|
|
95
|
+
args: [
|
|
96
|
+
{
|
|
97
|
+
parent: {
|
|
98
|
+
name: "identifiers"
|
|
99
|
+
fields: [
|
|
100
|
+
{
|
|
101
|
+
path: "catalogId" <-- field name in proto request message
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
path: "productId" <-- field name in proto request message
|
|
105
|
+
},
|
|
106
|
+
]
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
field: {
|
|
111
|
+
path: "productFamily" <-- field name in proto request message
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
parent: {
|
|
115
|
+
name: "options"
|
|
116
|
+
fields: [
|
|
117
|
+
{
|
|
118
|
+
path: "includePii" <-- field name in proto request message
|
|
119
|
+
}
|
|
120
|
+
]
|
|
121
|
+
}
|
|
122
|
+
]
|
|
123
|
+
}
|
|
124
|
+
]
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// Example-3: Using override option, multiple identifiers:
|
|
128
|
+
message GetProductRequest {
|
|
129
|
+
option (.wix.api.unique) = {
|
|
130
|
+
field: "catalogId"
|
|
131
|
+
field: "productId"
|
|
132
|
+
};
|
|
133
|
+
string catalogId = 1;
|
|
134
|
+
string productId = 2;
|
|
135
|
+
string product_family = 3;
|
|
136
|
+
bool include_pii = 4;
|
|
137
|
+
}
|
|
138
|
+
rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
|
|
139
|
+
option (google.api.http) = {
|
|
140
|
+
get = "/v1/catalog/{catalogId}/products/{productId}"
|
|
141
|
+
};
|
|
142
|
+
option (.wix.sdk.signature) = {
|
|
143
|
+
params = "include_pii" // the rest will be auto wired to options arg
|
|
144
|
+
};
|
|
145
|
+
// ...
|
|
146
|
+
}
|
|
147
|
+
// Resulted signature: getProduct(identifiers: {catalogId: string, productId: string}, includePii: boolean, options: {productFamily: string}) Product {...}
|
|
148
|
+
// schema response:
|
|
149
|
+
{
|
|
150
|
+
sdkSignatures: [
|
|
151
|
+
{
|
|
152
|
+
args: [
|
|
153
|
+
{
|
|
154
|
+
parent: {
|
|
155
|
+
name: "identifiers"
|
|
156
|
+
fields: [
|
|
157
|
+
{
|
|
158
|
+
path: "catalogId" <-- field name in proto request message
|
|
159
|
+
},
|
|
160
|
+
{
|
|
161
|
+
path: "productId" <-- field name in proto request message
|
|
162
|
+
}
|
|
163
|
+
]
|
|
164
|
+
}
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
field: {
|
|
168
|
+
path: "includePii" <-- field name in proto request message
|
|
169
|
+
}
|
|
170
|
+
},
|
|
171
|
+
parent: {
|
|
172
|
+
name: "options"
|
|
173
|
+
fields: [
|
|
174
|
+
{
|
|
175
|
+
path: "productFamily" <-- field name in proto request message
|
|
176
|
+
}
|
|
177
|
+
]
|
|
178
|
+
}
|
|
179
|
+
]
|
|
180
|
+
}
|
|
181
|
+
]
|
|
182
|
+
}
|
|
183
|
+
**/
|
|
184
|
+
|
|
185
|
+
extend google.protobuf.MethodOptions {
|
|
186
|
+
repeated Signature signature = 60100;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
message Signature {
|
|
190
|
+
repeated string params = 1;
|
|
191
|
+
}
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
syntax = "proto2";
|
|
2
|
+
|
|
3
|
+
package wix.spi;
|
|
4
|
+
|
|
5
|
+
import "google/protobuf/descriptor.proto";
|
|
6
|
+
import "wix/spi/http_error_status.proto";
|
|
7
|
+
|
|
8
|
+
option java_multiple_files = true;
|
|
9
|
+
option java_outer_classname = "DefinitionsProto";
|
|
10
|
+
option java_package = "com.wix.spi";
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
Example SPI proto files:
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package com.wixpress.ecom.couponsSpi;
|
|
18
|
+
|
|
19
|
+
// this service is bla bla bla...
|
|
20
|
+
//
|
|
21
|
+
// changelog:
|
|
22
|
+
// revision 2: added couponGenerated event
|
|
23
|
+
service CouponsProvider {
|
|
24
|
+
// since this is an SPI interface definition, the FQDN of the service_entity must start with `wix.interfaces.*`
|
|
25
|
+
option (.wix.spi.service) = {
|
|
26
|
+
fqdn: "wix.interfaces.ecom.v1.coupons_provider" // must be `wix.interfaces.*` for entities that define SPI
|
|
27
|
+
spi_identifier: "com.wixpress.appservice.api.ComponentType.AUTOMATION_TRIGGER"
|
|
28
|
+
config_message: "com.wixpresss.ecom.CouponsProviderConfig"
|
|
29
|
+
host_service: "com.wixpress.ecom.couponsSpi.CouponsSpiHost"
|
|
30
|
+
business_manager_url: "/ecom/coupons" // used to provide deep-link to biz-mgr to finish configuration after code publish in Velo
|
|
31
|
+
};
|
|
32
|
+
|
|
33
|
+
// The provider has to send this event when a coupon is generated on the provider system.
|
|
34
|
+
// When the coupon code will be used by a user during checkout,
|
|
35
|
+
// wix-ecom will call the provider in order to calculate the effect of the coupon on the cart
|
|
36
|
+
option (.wix.spi.event) = {
|
|
37
|
+
method_name: "CouponGenerated" // Name of the method on the SPI-Host service that needs to be called. Together with `host_service` annotation above, you can get the full FQN
|
|
38
|
+
};
|
|
39
|
+
|
|
40
|
+
// called when the system has to calculate how a coupon affects a given cart
|
|
41
|
+
rpc CalculateCart (CalculateCartRequest) returns (CalculateCartResponse) {
|
|
42
|
+
option (google.api.http) = {
|
|
43
|
+
post: "/calculate-cart"
|
|
44
|
+
};
|
|
45
|
+
option (.wix.spi.error) = {
|
|
46
|
+
name: "CouponNotSupportedError"
|
|
47
|
+
http_code: INVALID_ARGUMENT
|
|
48
|
+
application_code: "COUPON_TYPE_NOT_SUPPORTED"
|
|
49
|
+
data: "com.wixpress.ecom.couponsSpi.TypeNotSupportedError"
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// called when a coupon is applied during checkout and has to be reserved until the checkout is completed
|
|
54
|
+
// redeem will later be called using the reservation_code returned by this method
|
|
55
|
+
rpc Reserve (ReserveCouponRequest) returns (ReserveCouponResponse) {
|
|
56
|
+
option (google.api.http) = {
|
|
57
|
+
post: "/reserve"
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
// called after a successful transaction that used a coupon was made, in order to notify the coupons provider
|
|
62
|
+
// that the coupon was redeemed.
|
|
63
|
+
// sends the reservation_code that the was returned by reserve method
|
|
64
|
+
rpc Redeem (RedeemCouponRequest) returns (RedeemCouponResponse) {
|
|
65
|
+
option (google.api.http) = {
|
|
66
|
+
post: "/redeem"
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
// called in order to extend coupon expiration date
|
|
71
|
+
// this method was added later than other methods and therefore needs to be toggled in config_message
|
|
72
|
+
rpc ExtendCoupon (ExtendCouponRequest) returns (ExtendCouponResponse) {
|
|
73
|
+
option (google.api.http) ={
|
|
74
|
+
post: "/extend-coupon"
|
|
75
|
+
};
|
|
76
|
+
option (.wix.spi.feature_toggle) = "toggle_extend_coupon_enabled";
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
message CouponsProviderConfig {
|
|
81
|
+
string base_uri = 1 [(.wix.spi.base_uri) = true]; // the base URI where all the methods are deployed. E.g. "https://golden-coupons.com/wix-provider"
|
|
82
|
+
repeated string supported_coupon_types = 2; // specific field related to this SPI
|
|
83
|
+
bool toggle_extend_coupon_enabled = 3; // feature toggle initialized with default value = false. should be true if implemented by spi provider
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
message TypeNotSupportedError {
|
|
87
|
+
string type = 1; The received type that is not supported by the service
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// =========== another file, standard proto, no SPI annotation ================
|
|
91
|
+
|
|
92
|
+
service CouponsSpiHost {
|
|
93
|
+
// we cannot use the same service_entity as the SPI definition, because it is only interface definition. Here we need concrete FQDN
|
|
94
|
+
option (.wix.api.service_entity).message = "com.wixpress.ecom.couponsProviderGateway";
|
|
95
|
+
|
|
96
|
+
// The provider has to send this event when a coupon is generated on the provider system.
|
|
97
|
+
// When the coupon code will be used by a user during checkout,
|
|
98
|
+
// wix-ecom will call the provider in order to calculate the effect of the coupon on the cart
|
|
99
|
+
rpc CouponGenerated (CouponGeneratedRequest) returns (CouponGeneratedResponse) {
|
|
100
|
+
option (google.api.http) = {
|
|
101
|
+
post: "/v1/coupon-generated"
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
// The following 3 methods are an implementation of the SPI interface
|
|
106
|
+
|
|
107
|
+
rpc CalculateCart (CalculateCartRequest) returns (CalculateCartResponse) {
|
|
108
|
+
option (google.api.http) = {
|
|
109
|
+
post: "/calculate-cart"
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
rpc Reserve (ReserveCouponRequest) returns (ReserveCouponResponse) {
|
|
114
|
+
option (google.api.http) = {
|
|
115
|
+
post: "/reserve"
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
rpc Redeem (RedeemCouponRequest) returns (RedeemCouponResponse) {
|
|
120
|
+
option (google.api.http) ={
|
|
121
|
+
post: "/redeem"
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
rpc ExtendCoupon (ExtendCouponRequest) returns (RedeemCouponResponse) {
|
|
126
|
+
option (google.api.http) ={
|
|
127
|
+
post: "/extend-coupon"
|
|
128
|
+
};
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
message CouponsProviderGateway {
|
|
134
|
+
option (.wix.api.entity) = {
|
|
135
|
+
fqdn: "wix.gateways.ecom.v1.coupons_provider_gateway"
|
|
136
|
+
implements: "wix.intefaces.ecom.v1.coupons_provider"
|
|
137
|
+
};
|
|
138
|
+
}
|
|
139
|
+
**/
|
|
140
|
+
|
|
141
|
+
extend google.protobuf.ServiceOptions {
|
|
142
|
+
optional Service service = 65000;
|
|
143
|
+
repeated Event event = 65001; // spi event is essentially an endpoint that will get requests from spi implementor
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
extend google.protobuf.FieldOptions {
|
|
147
|
+
optional bool base_uri = 65020; // holds the base URI of the implementing service for this spi. (can be https://... | grpc://... | velo:///...)
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
extend google.protobuf.MethodOptions {
|
|
151
|
+
repeated Error error = 65040; // errors that can be thrown by the method
|
|
152
|
+
optional string feature_toggle = 65041; // name of the controlling feature toggle boolean field as it appears in the config message
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
message Service {
|
|
156
|
+
required string spi_identifier = 1; // string representation of dev-center's catalog [ComponentType](https://github.com/wix-private/devcenter/blob/master/app-service/app-service-api/src/main/proto/components_catalog/components_catalog_type.proto)
|
|
157
|
+
required string config_message = 2; // FQN ref to message with config details
|
|
158
|
+
optional string host_service = 3; // FQN ref to proto service of SPI host that implements endpoints that the provider needs to call
|
|
159
|
+
optional string business_manager_url = 4; // relative deeplink to business-manager page where the user needs to continue configuration of current spi
|
|
160
|
+
optional string fqdn = 5; // may be used to define an FQDN directly on SPI service without having a main entity. must start with `wix.interfaces.*`
|
|
161
|
+
optional string app_id = 6; // SPI Host's App Id
|
|
162
|
+
repeated ServiceAppendix appendix_files = 7; // declare external configuration info
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
message ServiceAppendix {
|
|
166
|
+
enum Type {
|
|
167
|
+
UNKNOWN_APPENDIX_TYPE = 0;
|
|
168
|
+
AUTO_VELO = 1 [deprecated = true]; // auto velo configuration
|
|
169
|
+
DOCS_CONF = 2; // wix docs configuration: `documentation.yaml`
|
|
170
|
+
MULTILINGUAL = 3; // wix multilingual configuration
|
|
171
|
+
SEARCH = 4; // nile search configuration
|
|
172
|
+
AUTO_SDK = 5; // auto sdk configuration
|
|
173
|
+
}
|
|
174
|
+
required Type type = 1; // appendix type
|
|
175
|
+
required string path = 2; // absolute from module root
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
message Error {
|
|
179
|
+
required string name = 1; // name that can be used by SDKs to generate error class
|
|
180
|
+
required HttpStatusCode http_code = 2; // HTTP status code that will be returned with this type of error
|
|
181
|
+
required string application_code = 3; // a constant string in the format of ALL_CAPS that describes the specific error type
|
|
182
|
+
optional string data = 4; // FQN of a message that describes structured data that should be provided in the error body
|
|
183
|
+
}
|
|
184
|
+
|
|
185
|
+
message Event {
|
|
186
|
+
required string method_name = 1; // name of the implemented method in SPI host service. Together with `host_service` annotation above, you can get the full FQN
|
|
187
|
+
}
|
package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/spi/http_error_status.proto
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
syntax = "proto3";
|
|
2
|
+
|
|
3
|
+
package wix.spi;
|
|
4
|
+
|
|
5
|
+
import "google/protobuf/descriptor.proto";
|
|
6
|
+
|
|
7
|
+
option java_package = "com.wix.spi";
|
|
8
|
+
|
|
9
|
+
enum HttpStatusCode {
|
|
10
|
+
UNKNOWN_ERROR = 0; // Should not be used
|
|
11
|
+
UNAUTHENTICATED = 1; // 401 - thrown when the request signature could be validated
|
|
12
|
+
INVALID_ARGUMENT = 3; // 400 - thrown when one of the properties has unexpected value or type
|
|
13
|
+
// 500 - thrown when something happened that is the result of server bug, network issue, DB issue,
|
|
14
|
+
// or anything that is not affected by the request itself, and is not the fault of the client in any way.
|
|
15
|
+
INTERNAL = 5;
|
|
16
|
+
RESOURCE_EXHAUSTED = 7; // 429 - The client has sent too many requests in a given amount of time (rate limit)
|
|
17
|
+
CANCELED = 8; // 499 - Request cancelled by the client
|
|
18
|
+
|
|
19
|
+
NOT_FOUND = 4; // 404 - thrown when the resource requested could not be found
|
|
20
|
+
ALREADY_EXISTS = 9; //409 - Can't recreate same resource or concurrency conflict
|
|
21
|
+
// 428 - request cannot be executed in current system state
|
|
22
|
+
// such as deleting a non-empty folder or paying with no funds
|
|
23
|
+
FAILED_PRECONDITION = 10;
|
|
24
|
+
}
|
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [2.34.0](https://github.com/wix-private/cairo/compare/@wix/bex-bundled-mini-essentials@2.33.0...@wix/bex-bundled-mini-essentials@2.34.0) (2025-11-23)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @wix/bex-bundled-mini-essentials
|
|
9
|
+
|
|
6
10
|
# [2.33.0](https://github.com/wix-private/cairo/compare/@wix/bex-bundled-mini-essentials@2.32.0...@wix/bex-bundled-mini-essentials@2.33.0) (2025-11-16)
|
|
7
11
|
|
|
8
12
|
**Note:** Version bump only for package @wix/bex-bundled-mini-essentials
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/bex-bundled-mini-essentials",
|
|
3
3
|
"private": true,
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.34.0",
|
|
5
5
|
"main": "dist/cjs/bex-bundled-mini-essentials.js",
|
|
6
6
|
"module": "dist/esm/bex-bundled-mini-essentials.mjs",
|
|
7
7
|
"types": "dist/cjs/bex-bundled-mini-essentials.d.ts",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/bex-utils",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.73.0",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Kobi",
|
|
@@ -36,8 +36,8 @@
|
|
|
36
36
|
"@formatjs/intl-relativetimeformat": "^4.5.16",
|
|
37
37
|
"@sentry/browser": "5.30.0",
|
|
38
38
|
"@sentry/types": "5.30.0",
|
|
39
|
-
"@wix/metro-common-builders": "^1.0.
|
|
40
|
-
"@wix/metro-runtime": "^1.
|
|
39
|
+
"@wix/metro-common-builders": "^1.0.1737",
|
|
40
|
+
"@wix/metro-runtime": "^1.2055.0",
|
|
41
41
|
"callsite": "^1.0.0",
|
|
42
42
|
"i18next": "^19.9.2",
|
|
43
43
|
"intl-messageformat": "^7.8.4",
|
|
@@ -52,13 +52,14 @@
|
|
|
52
52
|
"@types/react-native": "^0.73.0",
|
|
53
53
|
"@wix/ambassador-app-settings-v1-settings": "^1.0.0",
|
|
54
54
|
"@wix/ambassador-data-extensions-v1-data-extension-schema": "^1.0.93",
|
|
55
|
+
"@wix/ambassador-dealer-v1-serving-offer": "^1.0.132",
|
|
55
56
|
"@wix/ambassador-devcenter-app-market-listing-v1-market-listing": "^1.0.70",
|
|
56
57
|
"@wix/ambassador-fedinfra-exportservice-v1-export-async-job": "^1.0.174",
|
|
57
58
|
"@wix/ambassador-infra-asyncjobs-v1-async-job": "^1.0.87",
|
|
58
59
|
"@wix/ambassador-items-selection-spi-host-v1-provider": "^1.0.91",
|
|
59
60
|
"@wix/ambassador-media-site-media-v1-file-descriptor": "^1.0.127",
|
|
60
61
|
"@wix/ambassador-os-tags-v1-tag": "^1.0.24",
|
|
61
|
-
"@wix/bex-bundled-mini-essentials": "2.
|
|
62
|
+
"@wix/bex-bundled-mini-essentials": "2.34.0",
|
|
62
63
|
"@wix/bi-logger-os-data": "^1.310.0",
|
|
63
64
|
"@wix/eslint-config-yoshi": "^6.74.0",
|
|
64
65
|
"@wix/jest-yoshi-preset-base": "^6.74.0",
|
|
@@ -152,5 +153,5 @@
|
|
|
152
153
|
"wallaby": {
|
|
153
154
|
"autoDetect": true
|
|
154
155
|
},
|
|
155
|
-
"falconPackageHash": "
|
|
156
|
+
"falconPackageHash": "8f3b3527067975d1c33675408a999240c2a841b0b60b3b124b70cec0"
|
|
156
157
|
}
|