@restorecommerce/protos 0.4.5

package/io/restorecommerce/policy_set.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+package io.restorecommerce.policy_set;
+ 
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/policy.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/rule.proto";
+import "io/restorecommerce/status.proto";
+
+message PolicySet {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  io.restorecommerce.rule.Target target = 5;
+  string combining_algorithm = 6;
+  repeated string policies = 7; // policy IDs
+}
+
+message PolicySetList {
+  repeated PolicySet items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message PolicySetListResponse {
+  repeated PolicySetResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message PolicySetResponse {
+  PolicySet payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message PolicySetRQ {
+  string id = 1;
+  io.restorecommerce.rule.Target target = 2;
+  string combining_algorithm = 3;
+  repeated io.restorecommerce.policy.PolicyRQ policies = 4;
+  io.restorecommerce.rule.Effect effect = 5;
+}
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PolicySetListResponse);
+  rpc Create (PolicySetList) returns (PolicySetListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (PolicySetList) returns (PolicySetListResponse);
+  rpc Upsert (PolicySetList) returns (PolicySetListResponse);
+}

package/io/restorecommerce/price_group.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+
+package io.restorecommerce.price_group;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+// PriceGroup resource
+message PriceGroup {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3; 
+  string description = 4;
+}
+
+message PriceGroupList {
+  repeated PriceGroup items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message PriceGroupListResponse {
+  repeated PriceGroupResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message PriceGroupResponse {
+  PriceGroup payload = 1;
+  io.restorecommerce.status.Status status = 3;
+}
+
+message Deleted {
+  string id = 1;
+}
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (PriceGroupListResponse);
+  rpc Create (PriceGroupList) returns (PriceGroupListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (PriceGroupList) returns (PriceGroupListResponse);
+  rpc Upsert (PriceGroupList) returns (PriceGroupListResponse);
+}

package/io/restorecommerce/product.proto

@@ -0,0 +1,101 @@
+syntax = "proto3";
+
+package io.restorecommerce.product;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/image.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductListResponse);
+  rpc Create (ProductList) returns (ProductListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (ProductList) returns (ProductListResponse);
+  rpc Upsert (ProductList) returns (ProductListResponse);
+}
+
+// Product resource
+message MainProduct {
+  string id = 1;
+  oneof product_type {
+    Product product = 2;
+    Bundle bundle = 3;
+  }
+  bool active = 4;
+  io.restorecommerce.meta.Meta meta = 5;
+}
+
+message Product {
+  string id = 1;
+  string name = 2;
+  string description = 3;
+  string manufacturer_id = 4;
+  string taric_code = 5;
+  oneof classification {
+    Identifier prototype = 6;
+    Identifier category = 7;
+  }
+  repeated string tax_type_id = 8;
+  repeated Variant variants = 9;
+  string gtin = 10;
+}
+
+message Identifier {
+  string id = 1;
+}
+
+message ProductList {
+  repeated MainProduct items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ProductListResponse {
+  repeated ProductResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message ProductResponse {
+  MainProduct payload = 1;
+  io.restorecommerce.status.Status status = 3;
+}
+
+message Variant {
+  string id = 1;
+  string name = 2;
+  string description = 3;
+  int32 stock_level = 4;
+  double price = 5;
+  bool sale = 6;
+  double sale_price = 7;
+  repeated io.restorecommerce.image.Image image = 8;
+  string stock_keeping_unit = 9;
+  repeated VariantAttribute attributes = 10;
+}
+
+message VariantAttribute {
+  string key = 1;
+  repeated string values = 2;
+}
+
+message Bundle {
+  string id = 1;
+  string name = 3;
+  string description = 4;
+  repeated io.restorecommerce.image.Image image = 5;
+  repeated BundleProduct product = 6;
+  double price = 7;
+}
+
+message BundleProduct {
+  string product_id = 1;
+  uint32 quantity = 2;
+}
+
+
+message Deleted {
+  string id = 1;
+}

package/io/restorecommerce/product_category.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+package io.restorecommerce.product_category;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/image.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+// ProductCategory resource
+message ProductCategory {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  string price_group_id = 5;
+  io.restorecommerce.image.Image image = 6;
+  Parent parent = 7;
+}
+
+message ProductCategoryList {
+  repeated ProductCategory items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ProductCategoryListResponse {
+  repeated ProductCategoryResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message ProductCategoryResponse {
+  ProductCategory payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message Parent {
+  string parent_id = 1;
+}
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductCategoryListResponse);
+  rpc Create (ProductCategoryList) returns (ProductCategoryListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (ProductCategoryList) returns (ProductCategoryListResponse);
+  rpc Upsert (ProductCategoryList) returns (ProductCategoryListResponse);
+}

package/io/restorecommerce/product_prototype.proto

@@ -0,0 +1,47 @@
+syntax = "proto3";
+
+package io.restorecommerce.product_prototype;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+// ProductPrototype resource
+message ProductPrototype {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3; 
+  string version = 4;
+  string description = 5;
+  string category_id = 6;
+}
+
+message ProductPrototypeList {
+  repeated ProductPrototype items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message ProductPrototypeListResponse {
+  repeated ProductPrototypeResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message ProductPrototypeResponse {
+  ProductPrototype payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Deleted {
+  string id = 1;
+}
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (ProductPrototypeListResponse);
+  rpc Create (ProductPrototypeList) returns (ProductPrototypeListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (ProductPrototypeList) returns (ProductPrototypeListResponse);
+  rpc Upsert (ProductPrototypeList) returns (ProductPrototypeListResponse);
+}

package/io/restorecommerce/rendering.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+package io.restorecommerce.rendering;
+
+import "google/protobuf/any.proto";
+
+message Payload {
+  // json with <key, template> pairs
+  // e.g. { 'subject': ..., 'message':....}
+  google.protobuf.Any templates = 1;
+  google.protobuf.Any data = 2;  // data to fill template with
+  string style_url = 3; // stylesheet URL
+
+  enum Strategy { // style-applying 'strategy'
+    INLINE = 0;
+    COPY = 1;
+  }
+  Strategy strategy = 4;  // inlining, copying CSS into <style>, etc...
+  // rendering options JSON object
+  google.protobuf.Any options = 5;
+  // content type for rendering such as 'application/html' or 'application/text'
+  string content_type = 6;
+}
+
+message RenderRequest {
+  string id = 1; // identifies the render request payload
+  // List of templates with associated data and rendering options
+  repeated Payload payload = 2;
+}
+
+message RenderResponse {
+  string id = 1;
+  repeated google.protobuf.Any response = 2;  // error or HTML contents
+}

package/io/restorecommerce/resource_base.proto

@@ -0,0 +1,137 @@
+syntax = "proto3";
+package io.restorecommerce.resourcebase;
+
+import "google/protobuf/any.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+import "io/restorecommerce/filter.proto";
+
+// Service provides the CRUD operations
+service Service {
+  rpc Read (ReadRequest) returns (ResourceListResponse);
+  rpc Create (ResourceList) returns (ResourceListResponse);
+  rpc Delete (DeleteRequest) returns (DeleteResponse);
+  rpc Update (ResourceList) returns (ResourceListResponse);
+  rpc Upsert (ResourceList) returns (ResourceListResponse);
+}
+
+message FieldFilter {
+  string name = 1;
+  bool include = 2;
+}
+
+message Sort {
+  enum SortOrder {
+    UNSORTED = 0;
+    ASCENDING = 1;
+    DESCENDING = 2;
+  }
+  string field = 1;
+  SortOrder order = 2;
+}
+
+message Filter {
+  string field = 1;
+  enum Operation {
+    eq = 0;
+    lt = 1;
+    lte = 2;
+    gt = 3;
+    gte = 4;
+    isEmpty = 5;
+    iLike = 6;
+    in = 7;
+    neq = 8;
+  }
+  Operation operation = 2;
+  string value = 3;
+  enum ValueType {
+    STRING = 0; // default value type if not specified
+    NUMBER = 1;
+    BOOLEAN = 2;
+    DATE = 3;
+    ARRAY = 4;
+  }
+  ValueType type = 4;
+  repeated io.restorecommerce.filter.FilterOp filters = 5; // for nested filtering and to make optional its in separate filter.proto file
+}
+
+message FilterOp {
+  repeated Filter filter = 1;
+  enum Operator {
+    and = 0;
+    or = 1;
+  }
+  Operator operator = 2;
+}
+
+message ReadRequest {
+  uint32 offset = 1;
+  uint32 limit = 2;
+  repeated Sort sort = 3;
+
+  /// Filter based on fieldName|operation, value|list
+  repeated FilterOp filters = 4; // repeated filters
+
+  /// Fields selector
+  repeated FieldFilter field = 5;
+  repeated string search = 6;
+
+  /** Check the query parameters of HTTP request.
+    * If query parameter `locales` is given,
+    * return all corresponding localized values.
+    * Otherwise, return always the localized value
+    * with highest priority.
+    * Can be empty, single locale or multiple locales.
+    */
+  repeated string locales_limiter = 7;
+
+  repeated string custom_queries = 8;
+  google.protobuf.Any custom_arguments = 9;
+  io.restorecommerce.auth.Subject subject = 10;
+}
+
+message DeleteRequest {
+  /// Request to purge the whole collection
+  bool collection = 1;
+  /// Delete specified documents
+  repeated string ids = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message DeleteResponse {
+  repeated io.restorecommerce.status.Status status = 1;
+  io.restorecommerce.status.OperationStatus operation_status = 2;
+}
+
+/// List of resources
+message ResourceList {
+  repeated Resource items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+// ResourceList response
+message ResourceListResponse {
+  repeated ResourceResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+// resource read response
+message ResourceResponse {
+  Resource payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+/// Example resource
+message Resource {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  int32 value = 3;
+  string text = 4;
+  bool active = 5;
+  double created = 6;
+  string status = 7;
+}

package/io/restorecommerce/role.proto

@@ -0,0 +1,45 @@
+syntax = "proto3";
+
+package io.restorecommerce.role;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RoleListResponse);
+  rpc Create (RoleList) returns (RoleListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (RoleList) returns (RoleListResponse);
+  rpc Upsert (RoleList) returns (RoleListResponse);
+}
+
+message Role {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3; // specifies the role of the user
+  string description = 4;
+  repeated string assignable_by_roles = 5; // role id who can assign this role
+}
+
+message RoleList {
+  repeated Role items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message RoleListResponse {
+  repeated RoleResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message RoleResponse {
+  Role payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Deleted {
+  string id = 1;
+}

package/io/restorecommerce/rule.proto

@@ -0,0 +1,86 @@
+syntax = "proto3";
+
+package io.restorecommerce.rule;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/attribute.proto";
+import "io/restorecommerce/status.proto";
+
+
+/**
+* Target specified by a Rule or a Request.
+*/
+message Target {
+  repeated io.restorecommerce.attribute.Attribute subject = 1;
+  repeated io.restorecommerce.attribute.Attribute resources = 2;
+  repeated io.restorecommerce.attribute.Attribute action = 3;
+}
+
+/**
+* Resulting effect from a Policy or Rule.
+*/
+enum Effect {
+  PERMIT = 0;
+  DENY = 1;
+}
+
+message Rule {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string name = 3;
+  string description = 4;
+  Target target = 5;
+  ContextQuery context_query = 6;
+  string condition = 7; // JS code
+  Effect effect = 8;
+  bool evaluation_cacheable = 9;
+}
+
+message RuleRQ { // used for `whatIsAllowed` / reverse queries
+  string id = 1;
+  Target target = 2;
+  Effect effect = 3;
+  string condition = 4;
+  ContextQuery context_query = 5; 
+  bool evaluation_cacheable = 6;
+}
+
+message RuleList {
+  repeated Rule items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message RuleListResponse {
+  repeated RuleResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message RuleResponse {
+  Rule payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+// Query to pull resources from an external service
+//  and append them to the request's context.
+// The retrieved data can then be passed onto the request's context
+message ContextQuery {
+  message Filter {
+    string field = 1;
+    string operation = 2;
+    string value = 3;
+  }
+  repeated Filter filters = 1;
+  string query = 2;
+}
+
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (RuleListResponse);
+  rpc Create (RuleList) returns (RuleListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (RuleList) returns (RuleListResponse);
+  rpc Upsert (RuleList) returns (RuleListResponse);
+}

package/io/restorecommerce/search.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+package io.restorecommerce.search;
+
+import "google/protobuf/any.proto";
+import "io/restorecommerce/auth.proto";
+
+// Service provides the CRUD operations
+service Service {
+  rpc Search (SearchRequest) returns (SearchResponse);
+}
+
+message SearchRequest {
+  string collection = 1;
+  string text = 2;
+  repeated string acl = 3;
+  io.restorecommerce.auth.Subject subject = 4;
+}
+
+message SearchResponse {
+  repeated google.protobuf.Any data = 1;
+}

package/io/restorecommerce/status.proto

@@ -0,0 +1,26 @@
+syntax = "proto3";
+
+package io.restorecommerce.status;
+
+message Status {
+  string id = 1;
+  uint32 code = 2;
+  string message = 3;
+}
+
+message StatusArray {
+repeated Status status = 1;
+}
+
+message StatusObj {
+  Status status = 1;
+}
+
+message OperationStatusObj {
+  OperationStatus operation_status = 1;
+}
+
+message OperationStatus {
+  uint32 code = 1;
+  string message = 2;
+}

package/io/restorecommerce/tax.proto

@@ -0,0 +1,49 @@
+syntax = "proto3";
+
+package io.restorecommerce.tax;
+
+import "io/restorecommerce/resource_base.proto";
+import "io/restorecommerce/meta.proto";
+import "io/restorecommerce/auth.proto";
+import "io/restorecommerce/status.proto";
+
+/*
+* Microservice definition.
+*/
+service Service {
+  rpc Read (io.restorecommerce.resourcebase.ReadRequest) returns (TaxListResponse);
+  rpc Create (TaxList) returns (TaxListResponse);
+  rpc Delete (io.restorecommerce.resourcebase.DeleteRequest) returns (io.restorecommerce.resourcebase.DeleteResponse);
+  rpc Update (TaxList) returns (TaxListResponse);
+  rpc Upsert (TaxList) returns (TaxListResponse);
+}
+
+message Deleted {
+  string id = 1;
+}
+
+message TaxList {
+  repeated Tax items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.auth.Subject subject = 3;
+}
+
+message TaxListResponse {
+  repeated TaxResponse items = 1;
+  uint32 total_count = 2;
+  io.restorecommerce.status.OperationStatus operation_status = 3;
+}
+
+message TaxResponse {
+  Tax payload = 1;
+  io.restorecommerce.status.Status status = 2;
+}
+
+message Tax {
+  string id = 1;
+  io.restorecommerce.meta.Meta meta = 2;
+  string country_id = 3;
+  double rate = 4;
+  string variant = 5;
+  string type_id = 6;
+}