@vectora/contracts 1.0.0

package/gen/ts/shipments-freight-v1.ts

@@ -0,0 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.2
+//   protoc               v3.21.12
+// source: shipments-freight-v1.proto
+
+/* eslint-disable */
+
+export const protobufPackage = "freight.v1";

package/gen/ts/shipments-loads-v1.ts

@@ -0,0 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.2
+//   protoc               v3.21.12
+// source: shipments-loads-v1.proto
+
+/* eslint-disable */
+
+export const protobufPackage = "loads.v1";

package/gen/ts/shipments-rate-v1.ts

@@ -0,0 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.2
+//   protoc               v3.21.12
+// source: shipments-rate-v1.proto
+
+/* eslint-disable */
+
+export const protobufPackage = "rate.v1";

package/gen/ts/shipments-stop-v1.ts

@@ -0,0 +1,9 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.11.2
+//   protoc               v3.21.12
+// source: shipments-stop-v1.proto
+
+/* eslint-disable */
+
+export const protobufPackage = "stop.v1";

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@vectora/contracts",
+  "version": "1.0.0",
+  "description": "Shared TypeSafe contracts, Protobuf definitions, and DTOs for Vectora OS cross-service communication.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "format": "prettier --write \"gen/**/*.ts\" \"proto/**/*.proto\"",
+    "generate:dir": "node -e \"const fs = require('fs'); fs.mkdirSync('gen/ts', { recursive: true }); fs.mkdirSync('gen/go', { recursive: true });\"",
+    "generate:ts": "protoc --plugin=protoc-gen-ts_proto=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=./gen/ts --ts_proto_opt=esModuleInterop=true,outputJsonMethods=false --proto_path=./proto proto/*.proto",
+    "generate:go": "protoc --go_out=./gen/go --go_opt=paths=source_relative --proto_path=./proto proto/mapbox-*.proto",
+    "generate": "yarn generate:dir && yarn generate:ts && (yarn generate:go || true)"
+  },
+  "files": [
+    "proto",
+    "gen",
+    "dist",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "SEE LICENSE IN LICENSE.md",
+  "author": "Vectora Inc.",
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
+    "@types/node": "^25.2.3",
+    "@vectora/core": "^1.0.0",
+    "prettier": "latest",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@nestjs/microservices": "^11.1.13",
+    "rxjs": "^7.8.2",
+    "ts-proto": "^2.11.2"
+  }
+}

package/proto/common-geocode-v1.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+package common_geocode.v1;
+
+option go_package = "github.com/vectora-os/contracts/gen/go/common;common_geocode_v1";
+
+message Point { repeated double values = 1; }
+message Coordinates { double longitude = 1; double latitude = 2; }
+message Geometry { string type = 1; repeated double coordinates = 2; }
+message LineString { string type = 1; repeated Point coordinates = 2; }
+message ContextItem { string id = 1; string text = 2; optional string short_code = 3; }

package/proto/common-pagination-v1.proto

@@ -0,0 +1,39 @@
+syntax = "proto3";
+
+package common_pagination.v1;
+message PaginateQuery {
+  optional int32 page = 1;
+  optional int32 limit = 2;
+  optional string search = 3;
+  optional string path = 4;
+  repeated string sort_by = 5;
+  map<string, string> filter = 6;
+  repeated string select = 7;
+}
+
+message PaginateMeta {
+  int32 items_per_page = 1;
+  int32 total_items = 2;
+  int32 current_page = 3;
+  int32 total_pages = 4;
+
+  repeated string sort_by = 5;
+  map<string, string> filter = 6;
+
+  message Links {
+    string first = 1;
+    string previous = 2;
+    string current = 3;
+    string next = 4;
+    string last = 5;
+  }
+  Links links = 7;
+}
+
+message FilterQuery {
+  optional string search = 1;
+  optional string path = 2;
+  repeated string sort_by = 3;
+  map<string, string> filter = 4;
+  repeated string select = 5;
+}

package/proto/fleet-truck-v1.proto

@@ -0,0 +1,145 @@
+syntax = "proto3";
+
+package truck.v1;
+
+import "common-pagination-v1.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/field_mask.proto";
+
+// --- Enums ---
+
+enum TruckDock {
+  TRUCK_DOCK_UNSPECIFIED = 0;
+  TRUCK_DOCK_NO = 1;
+  TRUCK_DOCK_RA = 2;
+  TRUCK_DOCK_LG = 3;
+  TRUCK_DOCK_TR = 4;
+}
+
+enum TruckType {
+  TRUCK_TYPE_UNSPECIFIED = 0;
+  TRUCK_TYPE_CV = 1;
+  TRUCK_TYPE_SV = 2;
+  TRUCK_TYPE_SV_REF = 3;
+  TRUCK_TYPE_SS = 4;
+  TRUCK_TYPE_SS_REF = 5;
+  TRUCK_TYPE_LS = 6;
+  TRUCK_TYPE_LS_REF = 7;
+}
+
+enum TruckEquipment {
+  TRUCK_EQUIPMENT_UNSPECIFIED = 0;
+  TRUCK_EQUIPMENT_LG = 1; // Liftgate
+  TRUCK_EQUIPMENT_PJ = 2; // Pallet Jack
+  TRUCK_EQUIPMENT_AR = 3; // Air Ride
+  TRUCK_EQUIPMENT_DL = 4; // Dolly
+  TRUCK_EQUIPMENT_ST = 5; // Straps
+  TRUCK_EQUIPMENT_BL = 6; // Blankets
+  TRUCK_EQUIPMENT_LB = 7; // Load Bars
+  TRUCK_EQUIPMENT_TP = 8; // Tarps
+  TRUCK_EQUIPMENT_ETW = 9; // Walls E-Track
+  TRUCK_EQUIPMENT_FTW = 10; // Floor E-Track
+}
+
+// --- Service ---
+service TrucksService {
+  // Creating one truck
+  rpc Create(CreateTruckRequest) returns (TruckResponse);
+
+  // Updating one truck by "id"
+  rpc Update(UpdateTruckRequest) returns (TruckResponse);
+
+  // Getting one truck by "id"
+  rpc GetOne(GetOneTruckRequest) returns (TruckResponse);
+
+  // Getting paginated response
+  rpc GetAllPaginated (common_pagination.v1.PaginateQuery) returns (TruckPaginatedResponse);
+
+  // Getting not paginated response
+  rpc GetAllNotPaginated (common_pagination.v1.FilterQuery) returns (TruckNotPaginatedResponse);
+
+  // Delete one truck by "id"
+  rpc Delete(DeleteTruckRequest) returns (DeleteTruckResponse);
+}
+
+// --- Messages ---
+
+message CreateTruckRequest {
+  string make = 1;
+  string model = 2;
+  google.protobuf.Int32Value year = 3;
+  string vin = 4;
+  google.protobuf.StringValue plate = 5;
+  google.protobuf.StringValue plate_state = 6;
+
+  int32 length = 7;
+  int32 width = 8;
+  int32 height = 9;
+  int32 door_width = 10;
+  int32 door_height = 11;
+
+  int32 capacity = 12;
+
+  TruckDock dock_high = 13;
+  TruckType type = 14;
+
+  // Wrapper for equipment to distinguish null (not received) from [] (clear)
+  message EquipmentInput {
+    repeated TruckEquipment items = 1;
+  }
+  optional EquipmentInput equipment = 15;
+
+  string company = 16;
+}
+
+message UpdateTruckRequest {
+  // Inside the truck, the id must be filled in.
+  TruckResponse truck = 1;
+  // The mask determines which fields from truck we save in the database.
+  google.protobuf.FieldMask update_mask = 2;
+}
+
+message TruckResponse {
+  string id = 1;
+  string make = 2;
+  string model = 3;
+  google.protobuf.Int32Value year = 4;
+  string vin = 5;
+  google.protobuf.StringValue plate = 6;
+  google.protobuf.StringValue plate_state = 7;
+
+  int32 length = 8;
+  int32 width = 9;
+  int32 height = 10;
+  int32 door_width = 11;
+  int32 door_height = 12;
+
+  int32 capacity = 13;
+
+  TruckDock dock_high = 14;
+  TruckType type = 15;
+
+  repeated TruckEquipment equipment = 16;
+  string company = 17;
+}
+
+message GetOneTruckRequest {
+  string id = 1;
+}
+
+message TruckPaginatedResponse {
+  repeated TruckResponse data = 1;
+  common_pagination.v1.PaginateMeta meta = 2;
+}
+
+message TruckNotPaginatedResponse {
+  repeated TruckResponse data = 1;
+}
+
+message DeleteTruckRequest {
+  string id = 1;
+}
+
+message DeleteTruckResponse {
+  bool success = 1;
+}

package/proto/fleet-unit-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package unit.v1;

package/proto/identify-account-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package account.v1;

package/proto/identify-auth-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package auth.v1;

package/proto/identify-company-v1.proto

@@ -0,0 +1,114 @@
+syntax = "proto3";
+
+package company.v1;
+
+import "common-pagination-v1.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/field_mask.proto";
+
+// --- Enums ---
+enum CompanyType {
+  COMPANY_TYPE_UNSPECIFIED = 0;
+  COMPANY_TYPE_CUSTOMER = 1;
+  COMPANY_TYPE_CONTRACTOR = 2;
+}
+
+enum CompanyStatus {
+  COMPANY_STATUS_UNSPECIFIED = 0;
+  COMPANY_STATUS_ONBOARDING = 1;
+  COMPANY_STATUS_PENDING = 2;
+  COMPANY_STATUS_ACTIVE = 3;
+  COMPANY_STATUS_SUSPECTED = 4;
+  COMPANY_STATUS_REJECTED = 5;
+  COMPANY_STATUS_BLOCKED = 6;
+}
+
+// --- Service ---
+service CompaniesService {
+  // Creating one company
+  rpc Create(CreateCompanyRequest) returns (CompanyResponse);
+  // Updating one company by "id"
+  rpc Update(UpdateCompanyRequest) returns (CompanyResponse);
+  // Updating one company's status by "id"
+  rpc UpdateStatus(UpdateCompanyRequest) returns (CompanyResponse);
+  // Getting one company by "id"
+  rpc GetOne(GetOneCompanyRequest) returns (CompanyResponse);
+  // Getting paginated response
+  rpc GetAllPaginated (common_pagination.v1.PaginateQuery) returns (CompanyPaginatedResponse);
+  // Getting not paginated response
+  rpc GetAllNotPaginated (common_pagination.v1.FilterQuery) returns (CompanyNotPaginatedResponse);
+  // Delete one company by "id"
+  rpc Delete(DeleteCompanyRequest) returns (DeleteCompanyResponse);
+}
+
+// --- Messages ---
+
+message CreateCompanyRequest {
+  string legal_name = 1;
+  google.protobuf.StringValue dba_name = 2;
+  google.protobuf.StringValue mc_number = 3;
+  google.protobuf.StringValue dot_number = 4;
+  CompanyType type = 5;
+  CompanyStatus status = 6;
+  string address = 7;
+  string city = 8;
+  string state = 9;
+  string zip = 10;
+}
+
+message UpdateCompanyRequest {
+  string id = 1;
+  // Поля, которые разрешено обновлять
+  optional string legal_name = 2;
+  google.protobuf.StringValue dba_name = 3;
+  google.protobuf.StringValue mc_number = 4;
+  google.protobuf.StringValue dot_number = 5;
+  optional CompanyType type = 6;
+  optional string address = 7;
+  optional string city = 8;
+  optional string state = 9;
+  optional string zip = 10;
+
+  // Маска для частичного обновления
+  google.protobuf.FieldMask update_mask = 11;
+}
+
+message UpdateCompanyStatusRequest {
+  string id = 1;
+  CompanyStatus status = 2;
+}
+
+message CompanyResponse {
+  string id = 1;
+  string legal_name = 2;
+  google.protobuf.StringValue dba_name = 3;
+  google.protobuf.StringValue mc_number = 4;
+  google.protobuf.StringValue dot_number = 5;
+  CompanyType type = 6;
+  CompanyStatus status = 7;
+  string address = 8;
+  string city = 9;
+  string state = 10;
+  string zip = 11;
+}
+
+message GetOneCompanyRequest {
+  string id = 1;
+}
+
+message CompanyPaginatedResponse {
+  repeated CompanyResponse data = 1;
+  common_pagination.v1.PaginateMeta meta = 2;
+}
+
+message CompanyNotPaginatedResponse {
+  repeated CompanyResponse data = 1;
+}
+
+message DeleteCompanyRequest {
+  string id = 1;
+}
+
+message DeleteCompanyResponse {
+  bool success = 1;
+}

package/proto/identify-role-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package user.v1;

package/proto/identify-user-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package user.v1;

package/proto/mapbox-direction-v1.proto

@@ -0,0 +1,61 @@
+syntax = "proto3";
+
+package directions.v1;
+
+import "common-geocode-v1.proto";
+
+option go_package = "github.com/vectora-os/contracts/gen/go/directions;directions_v1";
+
+service DirectionsService {
+  rpc GetRoute (DirectionsRequest) returns (DirectionsResponse);
+}
+
+message DirectionsRequest {
+  repeated common_geocode.v1.Point coordinates = 1;
+  string profile = 2;
+  bool steps = 3;
+  string geometries = 4;
+}
+
+message DirectionsResponse {
+  repeated Route routes = 1;
+  repeated Waypoint waypoints = 2;
+  string code = 3;
+  string uuid = 4;
+}
+
+message Route {
+  repeated RouteLeg legs = 1;
+  double distance = 2;
+  double duration = 3;
+  common_geocode.v1.LineString geometry = 4;
+  string weight_name = 5;
+}
+
+message RouteLeg {
+  repeated RouteStep steps = 1;
+  double distance = 2;
+  double duration = 3;
+  string summary = 4;
+}
+
+message RouteStep {
+  Maneuver maneuver = 1;
+  string name = 2;
+  double distance = 3;
+  double duration = 4;
+  string mode = 5;
+  string driving_side = 6;
+}
+
+message Maneuver {
+  string type = 1;
+  string instruction = 2;
+  repeated double location = 3;
+  optional string modifier = 4;
+}
+
+message Waypoint {
+  string name = 1;
+  repeated double location = 2;
+}

package/proto/mapbox-geocode-v1.proto

@@ -0,0 +1,47 @@
+syntax = "proto3";
+
+package geocode.v1;
+
+import "common-geocode-v1.proto";
+
+option go_package = "github.com/vectora-os/contracts/gen/go/geocode;geocode_v1";
+
+service GeocodingService {
+  rpc ForwardGeocoding (ForwardGeocodingRequest) returns (GeocodingResponse);
+  rpc ReverseGeocoding (ReverseGeocodingRequest) returns (GeocodingResponse);
+}
+
+message ForwardGeocodingRequest {
+  string query = 1;
+  repeated string types = 2;
+  optional int32 limit = 3;
+}
+
+message ReverseGeocodingRequest {
+  double longitude = 1;
+  double latitude = 2;
+  repeated string types = 3;
+  optional int32 limit = 4;
+}
+
+message GeocodingResponse {
+  string type = 1;
+  repeated string query = 2;
+  repeated GeocodingFeature features = 3;
+  string attribution = 4;
+}
+
+message GeocodingFeature {
+  string id = 1;
+  string type = 2;
+  string place_name = 3;
+  GeocodingProperties properties = 4;
+  common_geocode.v1.Geometry geometry = 5;
+  repeated common_geocode.v1.ContextItem context = 6;
+}
+
+message GeocodingProperties {
+  optional string mapbox_id = 1;
+  optional string wikidata = 2;
+  optional string address = 3;
+}

package/proto/mapbox-matrix-v1.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+package matrix.v1;
+
+import "common-geocode-v1.proto";
+
+option go_package = "github.com/vectora-os/contracts/gen/go/matrix;matrix_v1";
+
+service MatrixService {
+  rpc GetMatrix (MatrixRequest) returns (MatrixResponse);
+}
+
+message MatrixRequest {
+  repeated common_geocode.v1.Point coordinates = 1;
+  string profile = 2;
+  repeated string annotations = 3;
+}
+
+message MatrixResponse {
+  string code = 1;
+  repeated MatrixRow durations = 2;
+  repeated MatrixRow distances = 3;
+  repeated MatrixWaypoint destinations = 4;
+  repeated MatrixWaypoint sources = 5;
+}
+
+message MatrixRow {
+  repeated double values = 1;
+}
+
+message MatrixWaypoint {
+  string name = 1;
+  repeated double location = 2;
+}

package/proto/mapbox-optimization-v1.proto

@@ -0,0 +1,43 @@
+syntax = "proto3";
+
+package optimization.v1;
+
+import "common-geocode-v1.proto";
+import "mapbox-direction-v1.proto";
+
+option go_package = "github.com/vectora-os/contracts/gen/go/optimization;optimization_v1";
+
+service OptimizationService {
+  rpc GetOptimizedRoute (OptimizationRequest) returns (OptimizationResponse);
+}
+
+message OptimizationRequest {
+  repeated common_geocode.v1.Point coordinates = 1;
+  string profile = 2;
+  optional bool roundtrip = 3;
+  optional string source = 4;
+  optional string destination = 5;
+  optional string geometries = 6;
+  optional bool steps = 7;
+}
+
+message OptimizationResponse {
+  string code = 1;
+  repeated OptimizationWaypoint waypoints = 2;
+  repeated OptimizationTrip trips = 3;
+}
+
+message OptimizationTrip {
+  common_geocode.v1.LineString geometry = 1;
+  repeated directions.v1.RouteLeg legs = 2;
+  double distance = 3;
+  double duration = 4;
+  double weight = 5;
+}
+
+message OptimizationWaypoint {
+  string name = 1;
+  repeated double location = 2;
+  int32 waypoint_index = 3;
+  int32 trips_index = 4;
+}

package/proto/mapbox-search-v1.proto

@@ -0,0 +1,68 @@
+syntax = "proto3";
+
+package search.v1;
+
+import "common-geocode-v1.proto";
+
+option go_package = "github.com/vectora-os/contracts/gen/go/search;search_v1";
+
+service SearchService {
+  rpc Suggest (SearchSuggestRequest) returns (SearchSuggestResponse);
+  rpc Retrieve (SearchRetrieveRequest) returns (SearchRetrieveResponse);
+}
+
+message SearchSuggestRequest {
+  string q = 1;
+  optional string session_token = 2;
+  optional int32 limit = 3;
+}
+
+message SearchSuggestResponse {
+  repeated SearchSuggestion suggestions = 1;
+  string attribution = 2;
+}
+
+message SearchSuggestion {
+  string name = 1;
+  string mapbox_id = 2;
+  string feature_type = 3;
+  string place_name = 4;
+  SearchContext context = 5;
+  string language = 6;
+  optional string maki = 7;
+}
+
+message SearchRetrieveResponse {
+  string type = 1;
+  repeated SearchFeature features = 2;
+  string attribution = 3;
+}
+
+message SearchFeature {
+  string id = 1;
+  string type = 2;
+  common_geocode.v1.Geometry geometry = 3;
+  FeatureProperties properties = 4;
+}
+
+message FeatureProperties {
+  string name = 1;
+  string mapbox_id = 2;
+  string full_address = 3;
+  SearchContext context = 4;
+  common_geocode.v1.Coordinates coordinates = 5;
+}
+
+message SearchContext {
+  common_geocode.v1.ContextItem country = 1;
+  common_geocode.v1.ContextItem region = 2;
+  common_geocode.v1.ContextItem postcode = 3;
+  common_geocode.v1.ContextItem place = 4;
+  common_geocode.v1.ContextItem neighborhood = 5;
+  common_geocode.v1.ContextItem street = 6;
+}
+
+message SearchRetrieveRequest {
+  string mapbox_id = 1;
+  string session_token = 2;
+}

package/proto/shipments-freight-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package freight.v1;

package/proto/shipments-loads-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package loads.v1;

package/proto/shipments-rate-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package rate.v1;

package/proto/shipments-stop-v1.proto

@@ -0,0 +1,3 @@
+syntax = "proto3";
+
+package stop.v1;