@wix/bex-utils 2.38.0 → 2.40.0

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/infra/asyncjobs/v1/AsyncJobService.proto

@@ -0,0 +1,339 @@
+//flynt-disable disallow-direct-common-imports
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/entity.proto";
+
+package wix.infra.asyncjobs.v1;
+option java_package = "com.wixpress.infra.asyncinfra.asyncjobservice.v1";
+
+import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/struct.proto";
+
+import "wix/http/field_mask.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/callback.proto";
+import "wix/api/permissions.proto";
+import "wix/common/paging.proto";
+import "wix/infra/asyncjobs/v1/upstream/wix/common/paging.proto";
+
+import "wix/infra/asyncjobs/v1/AsyncJobItem.proto";
+import "wix/infra/asyncjobs/v1/AsyncJob.proto";
+
+service AsyncJobService {
+  option (wix.api.service_entity).message = "wix.infra.asyncjobs.v1.AsyncJob";
+
+  option (wix.api.event) = {
+    event_type: ACTION,
+    payload: "wix.infra.asyncjobs.v1.AsyncJobFinishedEvent"
+  };
+
+  option (wix.api.event) = {
+    event_type: ACTION,
+    payload: "wix.infra.asyncjobs.v1.AsyncJobFailedEvent"
+  };
+
+  option (wix.api.event) = {
+    event_type: ACTION,
+    payload: "wix.infra.asyncjobs.v1.AsyncJobItemFailedEvent"
+  };
+
+  // Creates an async job.
+  rpc CreateAsyncJob (CreateAsyncJobRequest) returns (CreateAsyncJobResponse) {
+
+    option (.wix.api.crud) = {
+      method: CREATE
+      create_options: {
+        item_field: "job"
+      }
+    };
+
+    option (google.api.http) = {
+      post: "/v1/async-jobs"
+    };
+
+    option (wix.api.permission) = {
+      name: "INFRA.ASYNC_JOB_MANAGE",
+      type: MANUAL
+    };
+
+    option (wix.api.callback) = {
+      event_type: CREATED
+    };
+
+    option (wix.api.maturity) = BETA;
+    option (wix.api.exposure) = INTERNAL;
+
+    option (wix.api.required) = "CreateAsyncJobRequest.job";
+  }
+
+  // Retrieves a job.
+  rpc GetAsyncJob (GetAsyncJobRequest) returns (GetAsyncJobResponse) {
+
+    option (.wix.api.crud) = {
+      method: GET_ITEM
+      get_options: {
+        id_field: "job_id"
+        item_field: "job"
+      }
+    };
+
+    option (google.api.http) = {
+      get: "/v1/async-jobs/{job_id}"
+    };
+
+    option (wix.api.permission) = {
+      name: "INFRA.ASYNC_JOB_READ",
+      type: MANUAL
+    };
+
+    option (wix.api.maturity) = GA;
+    option (wix.api.exposure) = PUBLIC;
+    option (wix.api.required) = "GetAsyncJobRequest.job_id";
+  }
+
+  // Updates a job.
+  rpc UpdateAsyncJob (UpdateAsyncJobRequest) returns (UpdateAsyncJobResponse) {
+
+    option (.wix.api.crud) = {
+      method: UPDATE
+      update_options: {
+        item_field: "job"
+        fieldmask_field: "mask"
+      }
+    };
+
+    option (google.api.http) = {
+      patch: "/v1/async-jobs/{job.id}"
+    };
+
+    option (wix.api.permission) = {
+      name: "INFRA.ASYNC_JOB_MANAGE",
+      type: MANUAL
+    };
+
+    option (wix.api.callback) = {
+      event_type: UPDATED
+    };
+
+    option (wix.api.maturity) = GA;
+    option (wix.api.exposure) = INTERNAL;
+    option (wix.api.required) = "UpdateAsyncJobRequest.job.id";
+    option (wix.http.infer_fieldmask) = {
+      from: "job"
+      fieldmask: "mask"
+    };
+  }
+
+  // Deletes a job.
+  rpc DeleteAsyncJob (DeleteAsyncJobRequest) returns (DeleteAsyncJobResponse) {
+
+    option (.wix.api.crud) = {
+      method: DELETE
+      delete_options: {
+        id_field: "job_id"
+      }
+    };
+
+    option (google.api.http) = {
+      delete: "/v1/async-jobs/{job_id}"
+    };
+    option (wix.api.permission) = {
+      name: "INFRA.ASYNC_JOB_MANAGE",
+      type: MANUAL
+    };
+
+    option (wix.api.callback) = {
+      event_type: DELETED
+    };
+
+    option (wix.api.maturity) = GA;
+    option (wix.api.exposure) = INTERNAL;
+    option (wix.api.required) = "DeleteAsyncJobRequest.job_id";
+  }
+
+  // Completes a job.
+  rpc CompleteAsyncJob (CompleteAsyncJobRequest) returns (CompleteAsyncJobResponse) {
+    option (google.api.http) = {
+      put: "/v1/async-jobs/{job_id}/complete"
+    };
+
+    option (wix.api.permission) = {
+      name: "INFRA.ASYNC_JOB_MANAGE",
+      type: MANUAL
+    };
+
+    option (wix.api.maturity) = GA;
+    option (wix.api.exposure) = INTERNAL;
+    option (wix.api.required) = "CompleteAsyncJobRequest.job_id";
+  }
+
+  // Reports job progress.
+  rpc ReportAsyncJobProgress (ReportAsyncJobProgressRequest) returns (ReportAsyncJobProgressResponse) {
+    option (google.api.http) = {
+      post: "/v1/async-jobs/{job_id}/items/report"
+    };
+
+    option (wix.api.permission) = {
+      name: "INFRA.ASYNC_JOB_MANAGE",
+      type: MANUAL
+    };
+
+    option (wix.api.callback) = {
+      event_type: ACTION
+      payload: "wix.infra.asyncjobs.v1.AsyncJobItemAddedEvent"
+    };
+    option (wix.api.callback) = {
+      event_type: UPDATED
+    };
+
+    option (wix.api.required) = "ReportAsyncJobProgressRequest.job_id";
+  }
+
+  // Retrieves a list of job items.
+  rpc ListAsyncJobItems (ListAsyncJobItemsRequest) returns (ListAsyncJobItemsResponse) {
+    option (google.api.http) = {
+      get: "/v1/async-jobs/{job_id}/items"
+    };
+    option (wix.api.permission).name = "INFRA.ASYNC_JOB_READ";
+    option (wix.api.required) = "ListAsyncJobItemsRequest.job_id";
+
+
+    option (wix.api.maturity) = GA;
+    option (wix.api.exposure) = PUBLIC;
+  }
+
+}
+message CreateAsyncJobRequest {
+  // Job to create.
+  AsyncJob job = 1;
+}
+
+message CreateAsyncJobResponse {
+  // Created job.
+  AsyncJob job = 1;
+}
+
+message GetAsyncJobRequest {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+}
+
+message GetAsyncJobResponse {
+  // Returned job.
+  AsyncJob job = 1;
+}
+
+
+message UpdateAsyncJobRequest {
+  // Job to update.
+  AsyncJob job = 1;
+  // Field mask.
+  google.protobuf.FieldMask mask = 2;
+}
+
+message UpdateAsyncJobResponse {
+  // Updated job.
+  AsyncJob job = 1;
+}
+
+message DeleteAsyncJobRequest {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+}
+
+message DeleteAsyncJobResponse {
+}
+
+
+message ReportAsyncJobProgressRequest {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+
+  // Job items being reported.
+  repeated AsyncJobItem items = 2 [(wix.api.maxSize) = 1000];
+}
+
+message ReportAsyncJobProgressResponse {}
+
+message ListAsyncJobItemsRequest {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+  // Pagination options.
+  wix.common.CursorPaging paging = 2;
+  /*
+    Whether to return only failed items. 
+    when false, only successful items will be returned.
+    when not set, all both failed and successful will be returned.
+   */
+  google.protobuf.BoolValue has_error = 3 [(wix.api.field_exposure) = INTERNAL,
+    deprecated = true, (wix.api.field_deprecated) = {
+      replaced_by: "wix.infra.asyncjobs.v1.ListAsyncJobItemsRequest.status_filter"
+      target_removal_date: "2024-12-12",
+    }];
+  // async job item status filter.
+  StatusFilter status_filter = 4;
+
+  enum StatusFilter {
+    // Return all items.
+    ALL = 0;
+    // Return only failed items.
+    FAILED_ONLY = 1;
+    // Return only successful items.
+    SUCCESSFUL_ONLY = 2;
+  }
+}
+
+message ListAsyncJobItemsResponse {
+  // Job items.
+  repeated AsyncJobItem results = 1;
+  // Paging metadata.
+  wix.infra.asyncjobs.v1.upstream.wix.common.PagingMetadataV2 paging_metadata = 2;
+}
+
+
+message CompleteAsyncJobRequest {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+  // Job status.
+  CompleteStatus status = 2;
+
+  enum CompleteStatus {
+    // Job is finished.
+    FINISHED = 0;
+    // Job has failed.
+    FAILED = 1;
+  }
+}
+
+message CompleteAsyncJobResponse {}
+
+// Events
+message AsyncJobFinishedEvent {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+}
+
+message AsyncJobFailedEvent {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+}
+
+message AsyncJobItemAddedEvent {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+  // Job items.
+  AsyncJobItem job_item = 2;
+}
+
+message AsyncJobItemFailedEvent {
+  // Job ID.
+  string job_id = 1 [(wix.api.format) = GUID];
+  // Job items.
+  AsyncJobItem job_item = 2;
+}
+
+

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/infra/asyncjobs/v1/upstream/wix/common/paging.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package wix.infra.asyncjobs.v1.upstream.wix.common;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/errors.proto";
+import "wix/api/entity.proto";
+
+option java_multiple_files = true;
+option java_package = "com.wixpress.infra.asyncinfra.asyncjobservice.v1.upstream.wix.common";
+
+
+message PagingMetadataV2 {
+  option (.wix.api.decomposite_of) = "wix.common.PagingMetadataV2";
+  // Number of items returned in the response.
+  google.protobuf.Int32Value count = 1;
+  // Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.
+  Cursors cursors = 5;
+  // Indicates if there are more results after the current page.
+  // If `true`, another page of results can be retrieved.
+  // If `false`, this is the last page.
+  google.protobuf.BoolValue has_next = 6 [(.wix.api.field_exposure) = PRIVATE];
+}
+
+message Cursors {
+  option (.wix.api.decomposite_of) = "wix.common.Cursors";
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "next"
+  };
+  // Cursor pointing to next page in the list of results.
+  google.protobuf.StringValue next = 1 [(.wix.api.maxLength) = 16000];
+  // Cursor pointing to previous page in the list of results.
+  google.protobuf.StringValue prev = 2 [(.wix.api.maxLength) = 16000];
+}

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/sdk/definitions.proto

@@ -0,0 +1,191 @@
+syntax = "proto2";
+
+package wix.sdk;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "DefinitionsProto";
+option java_package = "com.wix.sdk";
+
+
+/**
+logic of signature generation:
+==============================
+
+1) `id` (path-param) should be the first argument.
+2) if there are more identifiers (path-params), a parent object called `identifiers` containing those will be the first argument.
+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.
+4) rest of arguments (if exist) will follow under the `options` parent.
+
+internal logic for `identifiers` field:
+take all path-params, merge with all `unique` fields, distinct.
+if you have total args > 1 -> put all in `identifiers` parent.
+otherwise - use single (usually id) arg as is and make it the first param.
+
+`sdk.signature.params` cannot control neither `options` (last param) nor `id`/`identifiers` (first param) as those are needed by convention in Velo.
+
+
+Examples:
+=========
+
+  // Example-1: Default behavior, single identifier:
+  message GetProductRequest {
+    option (.wix.api.unique) = {field: "id"}; //not needed, automatically assumed
+    string id = 1;
+    string product_family = 2;
+    bool include_pii = 3;
+  }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/products/{id}"
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(id: string, productFamily: string, options: {includePii: boolean}) Product {...}
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            field: {
+              path: "id"  <-- field name in proto request message
+            }
+          },
+          {
+            field: {
+              path: "productFamily"  <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "includePii" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+
+  // Example-2: Default behavior, multiple identifiers:
+    message GetProductRequest {
+      option (.wix.api.unique) = {
+        field: "catalogId"
+        field: "productId"
+      };
+      string catalogId = 1;
+      string productId = 2;
+      string product_family = 3;
+      bool include_pii = 4;
+    }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/catalog/{catalogId}/products/{productId}"
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(identifiers: {catalogId: string, productId: string}, productFamily: string, options: {includePii: boolean}) Product {...}
+  // schema response:
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            parent: {
+              name: "identifiers"
+              fields: [
+                {
+                  path: "catalogId"  <-- field name in proto request message
+                },
+                {
+                  path: "productId" <-- field name in proto request message
+                },
+              ]
+            }
+          },
+          {
+            field: {
+              path: "productFamily" <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "includePii" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+
+  // Example-3: Using override option, multiple identifiers:
+    message GetProductRequest {
+      option (.wix.api.unique) = {
+        field: "catalogId"
+        field: "productId"
+      };
+      string catalogId = 1;
+      string productId = 2;
+      string product_family = 3;
+      bool include_pii = 4;
+    }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/catalog/{catalogId}/products/{productId}"
+    };
+    option (.wix.sdk.signature) = {
+      params = "include_pii" // the rest will be auto wired to options arg
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(identifiers: {catalogId: string, productId: string}, includePii: boolean, options: {productFamily: string}) Product {...}
+  // schema response:
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            parent: {
+              name: "identifiers"
+              fields: [
+                {
+                  path: "catalogId"  <-- field name in proto request message
+                },
+                {
+                  path: "productId" <-- field name in proto request message
+                }
+              ]
+            }
+          },
+          {
+            field: {
+              path: "includePii" <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "productFamily" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+**/
+
+extend google.protobuf.MethodOptions {
+  repeated Signature signature = 60100;
+}
+
+message Signature {
+  repeated string params = 1;
+}