@wix/bex-utils 1.28.0

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/app-settings.proto

@@ -0,0 +1,327 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/wrappers.proto";
+import "google/api/http.proto";
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/entity.proto";
+
+package com.wix.fed.settings;
+
+// scope of settings when creating/updating;
+enum Scope {
+  APP = 0; // multiple instances of a tpa can share same settings;
+  COMPONENT = 1; // scoped to a single component of an app;
+}
+
+// The state of the settings (Saved or Published)
+enum State {
+  NR = 0; // Not relevant
+  SAVED = 1;
+  PUBLISHED = 2;
+}
+
+// The host in which the settings are displayed
+enum Host {
+  NA = 0;
+  VIEWER = 1;
+  BUSINESS_MANAGER = 2;
+  ONE_APP = 3;
+}
+
+// The language key of the saved multilingual data
+message LanguageKey {
+  string language_code = 1; // e.g. en
+  string region_code = 2; // e.g. us
+  string script_variant = 3; // default: ''
+}
+
+// The translated language that contains the key and its translations
+message TranslatedLanguage {
+  LanguageKey languageKey = 1; // The key of the translations' language
+  map<string, string> translations = 2; // Key-value pair mapping of textual assets
+}
+
+message AppSettings {
+  option (.wix.api.entity) = {
+    fqdn: "wix.app_settings.v1.settings",
+    segment: PUBLIC
+  };
+
+  State state = 1; // The state of the component
+  Host host = 2; // Where this data is relevant
+  google.protobuf.Struct settings = 3; // The app global settings
+  map<string, string> translations = 4; // Translatable textual assets - not using a collection because this type only the get flow (which should return a single value)
+}
+
+message GetComponentSettingsItem {
+  State state = 1; // The state of the component
+  Host host = 2; // Where this data is relevant
+  google.protobuf.StringValue component_id = 3 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 36]; // The component we want data for. Component ids can be from the site or oneApp
+  google.protobuf.Struct settings = 4; // The component settings
+  map<string, string> translations = 5; // Translatable textual assets - not using a collection because this type only the get flow (which should return a single value)
+}
+
+message SetComponentSettingsItem {
+  State state = 1; // The state of the component
+  Host host = 2; // Where this data is relevant
+  google.protobuf.StringValue component_id = 3 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 36]; // The component we want data for. Component ids can be from the site or oneApp
+  google.protobuf.Struct settings = 4; // The component settings
+  repeated TranslatedLanguage translations = 5; // Translatable textual assets (pass empty key as default)
+}
+
+message GetRequest {
+  google.protobuf.StringValue external_app_id = 1 [(.wix.api.format)=GUID]; // id of app-scoped settings
+  google.protobuf.StringValue external_component_id = 2 [(.wix.api.format)=GUID]; // id of component-scoped settings
+  google.protobuf.FieldMask fields = 3; // desired fields to retrieve on either GetResponse.app_settings or GetResponse.component_settings
+}
+
+message GetResponse {
+  google.protobuf.Struct app_settings = 1; // app-scoped settings;
+  google.protobuf.Struct component_settings = 2; //component-scoped settings;
+}
+
+message SetRequest {
+  google.protobuf.StringValue external_id = 1 [(.wix.api.format) = GUID]; // id of settings snapshot
+  Scope scope = 2; // scope of settings to store
+  google.protobuf.Struct data = 3; // settings themselves;
+}
+
+message SetResponse {
+}
+
+message UpdateRequest {
+  google.protobuf.StringValue external_id = 1 [(.wix.api.format) = GUID]; // id of settings snapshot
+  Scope scope = 3; // scope of settings to update
+  google.protobuf.FieldMask fields = 4; // changed fields in provided data
+  google.protobuf.Struct data = 5; //data itself
+}
+
+message UpdateResponse {
+  google.protobuf.StringValue new_external_id = 1; // new if of stored settings snapshot
+}
+
+message SetComponentSettingsRequest {
+  google.protobuf.StringValue component_id = 1 [(.wix.api.maxLength) = 36]; // The component Id
+  google.protobuf.Struct settings = 2; // The data we'd like to store for this component
+  State state = 3; // The state to set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD **
+  Host host = 4; // Where this data is relevant
+  repeated TranslatedLanguage translations = 5; // Translatable textual assets (pass empty key as default)
+  repeated State states = 6; // The states to set in
+}
+
+message SetComponentSettingsForMigrationRequest {
+  google.protobuf.StringValue component_id = 1 [(.wix.api.maxLength) = 36]; // The component Id
+  google.protobuf.Struct settings = 2; // The data we'd like to store for this component
+  State state = 3; // The state to set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD **
+  Host host = 4; // Where this data is relevant
+  repeated TranslatedLanguage translations = 5; // Translatable textual assets (pass empty key as default)
+  repeated State states = 6; // The states to set in
+  string app_def_id = 7 [(.wix.api.format) = GUID]; // The appDefId for migration
+  string instance_id = 8 [(.wix.api.format) = GUID]; // The instanceId for migration (msid)
+}
+
+message SetComponentSettingsResponse {
+  google.protobuf.Struct settings = 1; // Echo of the component settings
+  Host host = 3; // Where this data is relevant
+  repeated TranslatedLanguage translations = 4; // Translatable textual assets (pass empty key as default)
+  repeated State states = 6; // The states this was set in
+}
+
+message SetComponentSettingsForMigrationResponse {
+  google.protobuf.Struct settings = 1; // Echo of the component settings
+  Host host = 2; // Where this data is relevant
+  repeated TranslatedLanguage translations = 3; // Translatable textual assets (pass empty key as default)
+  repeated State states = 4; // The states this was set in
+}
+
+message GetComponentSettingsRequest {
+  google.protobuf.StringValue component_id = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 36]; // The component we want data for. Component ids can be from the site or oneApp
+  State state = 2; // The state of the component
+  Host host = 3; // Where this data is relevant
+  LanguageKey language_key = 5; // The language key of the translation (allow filtering translations explicitly)
+  bool include_global_settings = 6; // Whether it is critical to get Global Settings as well
+}
+
+message GetComponentSettingsResponse {
+  google.protobuf.Struct settings = 1; // Component settings for the requested component id
+  State state = 3; // The data state of the response
+  Host host = 4; // Where this data is relevant
+  map<string, string> translations = 5; // based on x-wix-language or fallback
+  AppSettings global_settings = 6; // Optional. The global app settings
+}
+
+message BulkGetComponentSettingsRequest {
+  repeated string component_ids = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 36, (.wix.api.minSize) = 1 , (.wix.api.maxSize) = 100]; // The component we want data for. Component ids can be from the site or oneApp
+  State state = 2; // The state of the component
+  Host host = 3; // Where this data is relevant
+  LanguageKey language_key = 5; // The language key of the translation (allow filtering translations explicitly)
+}
+
+message BulkGetComponentSettingsResponse {
+  repeated ComponentSettings component_settings = 1;
+    message ComponentSettings {
+      string component_id = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 36];
+      google.protobuf.Struct settings = 2; // Component settings for the requested component id
+      State state = 3; // The data state of the response
+      Host host = 4; // Where this data is relevant
+      map<string, string> translations = 5; // based on x-wix-language or fallback
+    }
+}
+
+message SetGlobalSettingsRequest {
+  google.protobuf.Struct settings = 1; // The global settings for the app
+  repeated SetComponentSettingsItem component_settings = 2; // Any components we would like to set
+  State state = 3; // The state this is set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD **
+  Host host = 4; // Where this data is relevant
+  repeated TranslatedLanguage translations = 5; // Translatable textual assets (pass empty key as default)
+  repeated State states = 6; // The states this was set in
+}
+
+message SetGlobalSettingsResponse {
+  google.protobuf.Struct settings = 1; // The data we have not for the App
+  repeated SetComponentSettingsItem component_settings = 2; // The data we have for the components
+  Host host = 4; // Where this data is relevant
+  repeated TranslatedLanguage translations = 5; // Translatable textual assets (pass empty key as default)
+  repeated State states = 6; // The states this was set in
+}
+
+message SetGlobalSettingsForMigrationRequest {
+  google.protobuf.Struct settings = 1; // The global settings for the app
+  repeated SetComponentSettingsItem component_settings = 2; // Any components we would like to set
+  State state = 3; // The state this is set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD **
+  Host host = 4; // Where this data is relevant
+  repeated TranslatedLanguage translations = 5; // Translatable textual assets (pass empty key as default)
+  repeated State states = 6; // The states this was set in
+  string app_def_id = 7 [(.wix.api.format) = GUID]; // The appDefId for migration
+  string instance_id = 8 [(.wix.api.format) = GUID]; // The instanceId for migration (msid)
+}
+
+message SetGlobalSettingsForMigrationResponse {
+  google.protobuf.Struct settings = 1; // The data we have not for the App
+  repeated SetComponentSettingsItem component_settings = 2; // The data we have for the components
+  Host host = 3; // Where this data is relevant
+  repeated TranslatedLanguage translations = 4; // Translatable textual assets (pass empty key as default)
+  repeated State states = 5; // The states this was set in
+}
+
+message GetGlobalSettingsRequest {
+  State state = 1; // The requested state, default is published
+  Host host = 2; // Allow to filter by host to get only components for that host
+  bool include_component_settings = 3; // If component settings data should also be returned
+  LanguageKey language_key = 4; // The language key of the translation (allow filtering translations explicitly)
+}
+
+message GetGlobalSettingsResponse {
+  State state = 1; // The state of the app
+  Host host = 2; // Where this data is relevant
+  google.protobuf.Struct settings = 3; // The global app settings
+  repeated GetComponentSettingsItem component_settings = 4; // Optional. All components listed. may include components from the site or oneApp
+  map<string, string> translations = 5; // based on x-wix-language or fallback
+}
+
+message GetGlobalSettingsForMigrationRequest {
+  State state = 1; // The requested state, default is published
+  Host host = 2; // Allow to filter by host to get only components for that host
+  bool include_component_settings = 3; // If component settings data should also be returned
+  LanguageKey language_key = 4; // The language key of the translation (allow filtering translations explicitly)
+  string app_def_id = 5 [(.wix.api.format) = GUID]; // The appDefId for migration
+  string instance_id = 6 [(.wix.api.format) = GUID]; // The instanceId for migration (msid)
+}
+
+message GetGlobalSettingsForMigrationResponse {
+  State state = 1; // The state of the app
+  Host host = 2; // Where this data is relevant
+  google.protobuf.Struct settings = 3; // The global app settings
+  repeated GetComponentSettingsItem component_settings = 4; // Optional. All components listed. may include components from the site or oneApp
+  map<string, string> translations = 5; // based on x-wix-language or fallback
+}
+
+service AppSettingsService {
+  option (.wix.api.service_entity).message = "com.wix.fed.settings.AppSettings";
+
+  //Set component settings by componentId
+  rpc SetComponentSettings (SetComponentSettingsRequest) returns (SetComponentSettingsResponse) {
+    option (google.api.http).patch = "/api/v1/settings/components/{component_id}";
+  }
+
+  //Set component settings by componentId
+    rpc SetComponentSettingsForMigration (SetComponentSettingsForMigrationRequest) returns (SetComponentSettingsForMigrationResponse) {
+      option (.wix.api.required) = "SetComponentSettingsForMigrationRequest.app_def_id";
+      option (.wix.api.required) = "SetComponentSettingsForMigrationRequest.instance_id";
+    }
+
+  // Get component settings by componentId
+  rpc GetComponentSettings (GetComponentSettingsRequest) returns (GetComponentSettingsResponse) {
+    // available query params for http exposure:
+    // state (State)
+    // host (Host)
+    // e.g. v1/settings/components/compId?state=SAVED&host=VIEWER
+    option (google.api.http).get = "/api/v1/settings/components/{component_id}";
+    option (.wix.api.cacheable) = {};
+  }
+
+  // Get component settings by componentId
+  rpc BulkGetComponentSettings (BulkGetComponentSettingsRequest) returns (BulkGetComponentSettingsResponse) {
+    // available query params for http exposure:
+    // state (State)
+    // host (Host)
+    // e.g. v1/settings/components/compId?state=SAVED&host=VIEWER
+    option (google.api.http).post = "/api/v1/settings/components/bulk";
+    option (.wix.api.cacheable) = {};
+  }
+
+  // Set global settings by instanceId (extracted from Authorization)
+  rpc SetGlobalSettings (SetGlobalSettingsRequest) returns (SetGlobalSettingsResponse) {
+    option (google.api.http).patch = "/api/v1/settings/instances";
+  }
+
+  // Get global settings by instanceId (extracted from Authorization)
+  rpc GetGlobalSettings (GetGlobalSettingsRequest) returns (GetGlobalSettingsResponse) {
+    option (google.api.http).get = "/api/v1/settings/instances";
+    option (.wix.api.cacheable) = {};
+  }
+
+  // Set global settings for migration
+    rpc SetGlobalSettingsForMigration (SetGlobalSettingsForMigrationRequest) returns (SetGlobalSettingsForMigrationResponse) {
+      option (.wix.api.required) = "SetGlobalSettingsForMigrationRequest.app_def_id";
+      option (.wix.api.required) = "SetGlobalSettingsForMigrationRequest.instance_id";
+    }
+
+  // Get global settings for migration
+    rpc GetGlobalSettingsForMigration (GetGlobalSettingsForMigrationRequest) returns (GetGlobalSettingsForMigrationResponse) {
+      option (.wix.api.required) = "GetGlobalSettingsForMigrationRequest.app_def_id";
+      option (.wix.api.required) = "GetGlobalSettingsForMigrationRequest.instance_id";
+    }
+
+  // retrieve settings for site. app and component-scoped settings ids can be provided.
+  // looks-up settings for one or both ids provided.
+  rpc Get (GetRequest) returns (GetResponse) {
+    option deprecated = true;
+    option (.wix.api.maturity) = GA;
+    option (google.api.http).get = "/api/v2/settings";
+  };
+
+  // store new snapshot of settings on server
+  rpc Set (SetRequest) returns (SetResponse) {
+    option deprecated = true;
+    option (.wix.api.maturity) = GA;
+    option (.wix.api.required) = "SetRequest.external_id";
+    option (.wix.api.required) = "SetRequest.data";
+    option (google.api.http).put = "/api/v2/settings/{scope}/{externalId}";
+  };
+
+  // create new snapshot of settings (patch)
+  rpc Update (UpdateRequest) returns (UpdateResponse) {
+    option deprecated = true;
+    option (.wix.api.maturity) = GA;
+    option (.wix.api.required) = "UpdateRequest.external_id";
+    option (.wix.api.required) = "UpdateRequest.fields";
+    option (.wix.api.required) = "UpdateRequest.data";
+    option (google.api.http).patch = "/api/v2/settings/{scope}/{externalId}";
+  };
+
+}

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/user-preferences.proto

@@ -0,0 +1,132 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/entity.proto";
+
+
+package com.wix.fed.settings;
+
+message Empty {
+}
+
+message UserPreferences {
+  option (.wix.api.entity) = {
+    fqdn: "wix.app_settings.v1.user_preferences",
+    segment: USERS
+  };
+  // We are bound to camel case notation to support migration of existing endpoints
+  google.protobuf.StringValue userId = 1;
+  google.protobuf.StringValue nameSpace = 2;
+  google.protobuf.StringValue siteId = 3;
+  google.protobuf.StringValue key = 4;
+  google.protobuf.Value blob = 5;
+  google.protobuf.Timestamp dateCreated = 6;
+  google.protobuf.Timestamp dateUpdated = 7;
+  google.protobuf.Int32Value TTLInDays = 8;
+}
+
+message DeleteEntryDto {
+  google.protobuf.StringValue nameSpace = 1;
+  google.protobuf.StringValue siteId = 2;
+  google.protobuf.StringValue key = 3;
+}
+
+message BulkSetDto {
+  google.protobuf.StringValue nameSpace = 1;
+  google.protobuf.StringValue siteId = 2;
+  google.protobuf.Int32Value TTLInDays = 3;
+  map<string, google.protobuf.Value> data = 4;
+}
+
+message GetUserPreferencesRequest {
+  google.protobuf.StringValue userId = 1;
+  google.protobuf.StringValue nameSpace = 2;
+  google.protobuf.StringValue key = 3;
+  google.protobuf.StringValue siteId = 4;
+}
+
+message GetUserPreferencesResponse {
+  repeated UserPreferences userPreferences = 1;
+}
+
+message BulkGetByUserSitesRequest {
+  google.protobuf.StringValue nameSpace = 1;
+  google.protobuf.StringValue key = 2;
+  google.protobuf.StringValue userId = 3;
+  repeated google.protobuf.StringValue siteIds = 4;
+}
+
+message BulkGetByUserSitesResponse {
+  repeated UserPreferences userPreferences = 1;
+}
+
+message BulkGetUserPreferencesRequest {
+  repeated google.protobuf.StringValue userIds = 1;
+  google.protobuf.StringValue nameSpace = 2;
+  google.protobuf.StringValue key = 3;
+  google.protobuf.StringValue siteId = 4;
+}
+
+message BulkGetUserPreferencesResponse {
+  repeated UserPreferences userPreferences = 1;
+}
+
+message BulkSetUserPrefencesRequest {
+  BulkSetDto bulkSetDto = 1;
+  google.protobuf.StringValue userId = 2;
+}
+
+message BulkSetUserPrefencesResponse {
+  repeated UserPreferences userPreferences = 1;
+}
+
+message DeleteUserPrefencesRequest {
+  DeleteEntryDto deleteDto = 1;
+  google.protobuf.StringValue userId = 2;
+}
+
+service UserPreferencesService {
+
+  option (.wix.api.service_entity).message = "com.wix.fed.settings.UserPreferences";
+
+
+  rpc Get (GetUserPreferencesRequest) returns (GetUserPreferencesResponse) {
+    option (.wix.api.required) = "GetUserPreferencesRequest.userId";
+    option (.wix.api.required) = "GetUserPreferencesRequest.nameSpace";
+  }
+
+  rpc BulkGetByUserSites (BulkGetByUserSitesRequest) returns (BulkGetByUserSitesResponse) {
+    option (.wix.api.required) = "BulkGetByUserSitesRequest.userId";
+    option (.wix.api.required) = "BulkGetByUserSitesRequest.nameSpace";
+    option (.wix.api.required) = "BulkGetByUserSitesRequest.siteIds";
+  }
+
+  rpc BulkGet (BulkGetUserPreferencesRequest) returns (BulkGetUserPreferencesResponse) {
+    option (.wix.api.required) = "BulkGetUserPreferencesRequest.userIds";
+    option (.wix.api.required) = "BulkGetUserPreferencesRequest.nameSpace";
+  }
+
+  rpc Set (UserPreferences) returns (UserPreferences) {
+    option (.wix.api.required) = "UserPreferences.userId";
+    option (.wix.api.required) = "UserPreferences.nameSpace";
+    option (.wix.api.required) = "UserPreferences.key";
+    option (.wix.api.required) = "UserPreferences.blob";
+  }
+
+  rpc BulkSet (BulkSetUserPrefencesRequest) returns (BulkSetUserPrefencesResponse) {
+    option (.wix.api.required) = "BulkSetUserPrefencesRequest.userId";
+    option (.wix.api.required) = "BulkSetUserPrefencesRequest.bulkSetDto.nameSpace";
+    option (.wix.api.required) = "BulkSetUserPrefencesRequest.bulkSetDto.data";
+  }
+
+  rpc Delete (DeleteUserPrefencesRequest) returns (Empty) {
+    option (.wix.api.required) = "DeleteUserPrefencesRequest.userId";
+    option (.wix.api.required) = "DeleteUserPrefencesRequest.deleteDto.nameSpace";
+    option (.wix.api.required) = "DeleteUserPrefencesRequest.deleteDto.key";
+  }
+}

package/@wix/ambassador-app-settings-v1-settings/src/main/proto/wix/api/action_payload.proto

@@ -0,0 +1,33 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "ActionPayloadProto";
+option java_package = "com.wix.api";
+
+/*
+action_payload option is used to configure custom slugs for the payload type of a DomainEvent Action:
+service BlooperService {
+   option (wix.api.service_entity).message = "com.wixpress.examples.Blooper"; //the "main" entity
+   rpc MissedBlooper (MissedBlooperRequest) returns (MissedBlooperResponse) {
+       option (wix.api.callback) = {
+           event_type: Action
+           payload: "com.wixpress.examples.BlooperWasMissed"
+       };
+   };
+}
+message BlooperWasMissed {
+   option (wix.api.action_payload).custom_slug = "super_custom_slug"; // only define if the default slug value (snake case of the message name) is out of the question
+    int32 how_funny_it_could_have_been = 1;
+}
+*/
+extend google.protobuf.MessageOptions {
+    optional ActionPayload action_payload = 50600;
+}
+
+message ActionPayload {
+    optional string custom_slug = 1;
+}