@caronashow/api 0.7.0 → 0.7.1

package/README.md

@@ -21,7 +21,7 @@ bun install @caronashow/api
 ```typescript
 import { createClient } from "@connectrpc/connect";
 import { createGrpcWebTransport } from "@connectrpc/connect-web";
-import { PoolerService } from "@caronashow/api";
+import { OnboardingService } from "@caronashow/api";
 
 // Create a transport
 const transport = createGrpcWebTransport({
@@ -30,10 +30,10 @@ const transport = createGrpcWebTransport({
 });
 
 // Create the client
-const client = createClient(PoolerService, transport);
+const client = createClient(OnboardingService, transport);
 
-// Example: Using the positions service
-const position = await client.getPosition({ deviceId: "device-123" });
+// Check if the current user has completed onboarding
+const status = await client.getOnboardingStatus({});
 ```
 
 ### API Documentation
@@ -42,20 +42,21 @@ const position = await client.getPosition({ deviceId: "device-123" });
 
 The package includes the following type definitions:
 
-- `Position` - Represents a device's location with latitude, longitude, altitude, speed, and heading
-- `DevicePosition` - Combines a device ID with its position
-- `Device` - Device information including ID and name
-- `User` - User information including ID, name, and associated devices
-- `Group` - Group information including ID, name, description, and associated users
+- `User` - User information including ID, name, email, participation mode, tier, avatar, and org
+- `TimeOfDay` - A time without a date component (hours, minutes)
+- `DayOfWeek` - Enum for days of the week
+- `ChatPreference` - Passenger's conversation preference (open, quiet, indifferent)
+- `ParticipationMode` - User's role in the system (offer, search, explore)
+- `DriverOfferSetup` - Driver's vehicle and route preferences
+- `PassengerSearchSetup` - Passenger's pickup and schedule preferences
 
 #### Services
 
 This is not a full list of services. These are just some examples.
 
-- `PositionsService` - Service for managing device positions
-  - `sendPositions(positions: DevicePosition[]): Promise<SendPositionsResponse>` - Send multiple device position updates
-  - `getGroup(groupId: string): Promise<GetGroupResponse>` - Get a group by ID, including user data and their devices
-  - `getGroupPositions(groupId: string): Promise<GetGroupPositionsResponse>` - Get positions for all devices in a group
+- `OnboardingService` - One-shot onboarding flow
+  - `getOnboardingStatus({}): Promise<GetOnboardingStatusResponse>` - Check if the current user has completed onboarding
+  - `completeOnboarding(request: CompleteOnboardingRequest): Promise<CompleteOnboardingResponse>` - Submit all onboarding data
 
 ## Development
 

package/dist/index.cjs

@@ -41,6 +41,8 @@ var exports_src = {};
 __export(exports_src, {
   file_google_type_latlng: () => file_google_type_latlng,
   file_caronashow_types_v1_user: () => file_caronashow_types_v1_user,
+  file_caronashow_types_v1_common: () => file_caronashow_types_v1_common,
+  file_caronashow_service_v1_onboarding: () => file_caronashow_service_v1_onboarding,
   file_caronashow_service_v1_map: () => file_caronashow_service_v1_map,
   file_caronashow_pooler_v1_pooler: () => file_caronashow_pooler_v1_pooler,
   file_caronashow_poc_v1_routes: () => file_caronashow_poc_v1_routes,
@@ -49,6 +51,7 @@ __export(exports_src, {
   file_caronashow_poc_v1_groups: () => file_caronashow_poc_v1_groups,
   VehicleSchema: () => VehicleSchema,
   UserSchema: () => UserSchema,
+  TimeOfDaySchema: () => TimeOfDaySchema,
   RouteTargetTypeSchema: () => RouteTargetTypeSchema,
   RouteTargetType: () => RouteTargetType,
   PoolerService: () => PoolerService,
@@ -58,6 +61,7 @@ __export(exports_src, {
   PersonRank: () => PersonRank,
   PersonIconSchema: () => PersonIconSchema,
   PersonIcon: () => PersonIcon,
+  PassengerSearchSetupSchema: () => PassengerSearchSetupSchema,
   PassengerPointSchema: () => PassengerPointSchema,
   ParticipationModeSchema: () => ParticipationModeSchema,
   ParticipationMode: () => ParticipationMode,
@@ -66,6 +70,7 @@ __export(exports_src, {
   OperationStateSchema: () => OperationStateSchema,
   OperationState: () => OperationState,
   OperationSchema: () => OperationSchema,
+  OnboardingService: () => OnboardingService,
   MatchingAlgorithmSchema: () => MatchingAlgorithmSchema,
   MatchingAlgorithm: () => MatchingAlgorithm,
   MatchGroupSchema: () => MatchGroupSchema,
@@ -77,6 +82,8 @@ __export(exports_src, {
   GetStateOfOperationRequestSchema: () => GetStateOfOperationRequestSchema,
   GetOptimizedRoutesResponseSchema: () => GetOptimizedRoutesResponseSchema,
   GetOptimizedRoutesRequestSchema: () => GetOptimizedRoutesRequestSchema,
+  GetOnboardingStatusResponseSchema: () => GetOnboardingStatusResponseSchema,
+  GetOnboardingStatusRequestSchema: () => GetOnboardingStatusRequestSchema,
   GetMapPointsResponseSchema: () => GetMapPointsResponseSchema,
   GetMapPointsRequestSchema: () => GetMapPointsRequestSchema,
   GetMapPointGroupsResponseSchema: () => GetMapPointGroupsResponseSchema,
@@ -86,9 +93,16 @@ __export(exports_src, {
   ExecuteMatchingAlgorithmOnDatasetResponseSchema: () => ExecuteMatchingAlgorithmOnDatasetResponseSchema,
   ExecuteMatchingAlgorithmOnDatasetRequestSchema: () => ExecuteMatchingAlgorithmOnDatasetRequestSchema,
   DriverPointSchema: () => DriverPointSchema,
+  DriverOfferSetupSchema: () => DriverOfferSetupSchema,
   DirectRouteSchema: () => DirectRouteSchema,
+  DayOfWeekSchema: () => DayOfWeekSchema,
+  DayOfWeek: () => DayOfWeek,
   DatasetSchema: () => DatasetSchema,
   Dataset: () => Dataset,
+  CompleteOnboardingResponseSchema: () => CompleteOnboardingResponseSchema,
+  CompleteOnboardingRequestSchema: () => CompleteOnboardingRequestSchema,
+  ChatPreferenceSchema: () => ChatPreferenceSchema,
+  ChatPreference: () => ChatPreference,
   AddressSchema: () => AddressSchema
 });
 module.exports = __toCommonJS(exports_src);
@@ -3101,6 +3115,30 @@ var PoolerService = /* @__PURE__ */ serviceDesc(file_caronashow_pooler_v1_pooler
 // src/gen/caronashow/service/v1/map_pb.ts
 var file_caronashow_service_v1_map = /* @__PURE__ */ fileDesc("Ch9jYXJvbmFzaG93L3NlcnZpY2UvdjEvbWFwLnByb3RvEhVjYXJvbmFzaG93LnNlcnZpY2UudjEyDAoKTWFwU2VydmljZULdAQoZY29tLmNhcm9uYXNob3cuc2VydmljZS52MUIITWFwUHJvdG9QAVpAZ2l0bGFiLmNvbS9jYXJvbmFzaG93L2FwaS9nby9nZW4vY2Fyb25hc2hvdy9zZXJ2aWNlL3YxO3NlcnZpY2V2MaICA0NTWKoCFUNhcm9uYXNob3cuU2VydmljZS5WMcoCFUNhcm9uYXNob3dcU2VydmljZVxWMeICIUNhcm9uYXNob3dcU2VydmljZVxWMVxHUEJNZXRhZGF0YeoCF0Nhcm9uYXNob3c6OlNlcnZpY2U6OlYxYgZwcm90bzM");
 var MapService = /* @__PURE__ */ serviceDesc(file_caronashow_service_v1_map, 0);
+// src/gen/caronashow/types/v1/common_pb.ts
+var file_caronashow_types_v1_common = /* @__PURE__ */ fileDesc("CiBjYXJvbmFzaG93L3R5cGVzL3YxL2NvbW1vbi5wcm90bxITY2Fyb25hc2hvdy50eXBlcy52MSIrCglUaW1lT2ZEYXkSDQoFaG91cnMYASABKAUSDwoHbWludXRlcxgCIAEoBSrYAQoJRGF5T2ZXZWVrEhsKF0RBWV9PRl9XRUVLX1VOU1BFQ0lGSUVEEAASFgoSREFZX09GX1dFRUtfTU9OREFZEAESFwoTREFZX09GX1dFRUtfVFVFU0RBWRACEhkKFURBWV9PRl9XRUVLX1dFRE5FU0RBWRADEhgKFERBWV9PRl9XRUVLX1RIVVJTREFZEAQSFgoSREFZX09GX1dFRUtfRlJJREFZEAUSGAoUREFZX09GX1dFRUtfU0FUVVJEQVkQBhIWChJEQVlfT0ZfV0VFS19TVU5EQVkQByqHAQoOQ2hhdFByZWZlcmVuY2USHwobQ0hBVF9QUkVGRVJFTkNFX1VOU1BFQ0lGSUVEEAASGAoUQ0hBVF9QUkVGRVJFTkNFX09QRU4QARIZChVDSEFUX1BSRUZFUkVOQ0VfUVVJRVQQAhIfChtDSEFUX1BSRUZFUkVOQ0VfSU5ESUZGRVJFTlQQA0LSAQoXY29tLmNhcm9uYXNob3cudHlwZXMudjFCC0NvbW1vblByb3RvUAFaPGdpdGxhYi5jb20vY2Fyb25hc2hvdy9hcGkvZ28vZ2VuL2Nhcm9uYXNob3cvdHlwZXMvdjE7dHlwZXN2MaICA0NUWKoCE0Nhcm9uYXNob3cuVHlwZXMuVjHKAhNDYXJvbmFzaG93XFR5cGVzXFYx4gIfQ2Fyb25hc2hvd1xUeXBlc1xWMVxHUEJNZXRhZGF0YeoCFUNhcm9uYXNob3c6OlR5cGVzOjpWMWIGcHJvdG8z");
+var TimeOfDaySchema = /* @__PURE__ */ messageDesc(file_caronashow_types_v1_common, 0);
+var DayOfWeek;
+((DayOfWeek2) => {
+  DayOfWeek2[DayOfWeek2["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+  DayOfWeek2[DayOfWeek2["MONDAY"] = 1] = "MONDAY";
+  DayOfWeek2[DayOfWeek2["TUESDAY"] = 2] = "TUESDAY";
+  DayOfWeek2[DayOfWeek2["WEDNESDAY"] = 3] = "WEDNESDAY";
+  DayOfWeek2[DayOfWeek2["THURSDAY"] = 4] = "THURSDAY";
+  DayOfWeek2[DayOfWeek2["FRIDAY"] = 5] = "FRIDAY";
+  DayOfWeek2[DayOfWeek2["SATURDAY"] = 6] = "SATURDAY";
+  DayOfWeek2[DayOfWeek2["SUNDAY"] = 7] = "SUNDAY";
+})(DayOfWeek ||= {});
+var DayOfWeekSchema = /* @__PURE__ */ enumDesc(file_caronashow_types_v1_common, 0);
+var ChatPreference;
+((ChatPreference2) => {
+  ChatPreference2[ChatPreference2["UNSPECIFIED"] = 0] = "UNSPECIFIED";
+  ChatPreference2[ChatPreference2["OPEN"] = 1] = "OPEN";
+  ChatPreference2[ChatPreference2["QUIET"] = 2] = "QUIET";
+  ChatPreference2[ChatPreference2["INDIFFERENT"] = 3] = "INDIFFERENT";
+})(ChatPreference ||= {});
+var ChatPreferenceSchema = /* @__PURE__ */ enumDesc(file_caronashow_types_v1_common, 1);
+
 // src/gen/caronashow/types/v1/user_pb.ts
 var file_caronashow_types_v1_user = /* @__PURE__ */ fileDesc("Ch5jYXJvbmFzaG93L3R5cGVzL3YxL3VzZXIucHJvdG8SE2Nhcm9uYXNob3cudHlwZXMudjEijgIKBFVzZXISCgoCaWQYASABKAkSEgoKZmlyc3RfbmFtZRgCIAEoCRIRCglsYXN0X25hbWUYAyABKAkSDQoFZW1haWwYBCABKAkSKAogZW5yb2xsZWRfaW5fdnVsbmVyYWJpbGl0eV9maWx0ZXIYBSABKAgSSgoaY3VycmVudF9wYXJ0aWNpcGF0aW9uX21vZGUYBiABKA4yJi5jYXJvbmFzaG93LnR5cGVzLnYxLlBhcnRpY2lwYXRpb25Nb2RlEgwKBHRpZXIYByABKAkSEgoKYXZhdGFyX3VybBgIIAEoCRIOCgZvcmdfaWQYCSABKAkSHAoUb25ib2FyZGluZ19jb21wbGV0ZWQYCiABKAgqlAEKEVBhcnRpY2lwYXRpb25Nb2RlEiIKHlBBUlRJQ0lQQVRJT05fTU9ERV9VTlNQRUNJRklFRBAAEhwKGFBBUlRJQ0lQQVRJT05fTU9ERV9PRkZFUhABEh0KGVBBUlRJQ0lQQVRJT05fTU9ERV9TRUFSQ0gQAhIeChpQQVJUSUNJUEFUSU9OX01PREVfRVhQTE9SRRADQtABChdjb20uY2Fyb25hc2hvdy50eXBlcy52MUIJVXNlclByb3RvUAFaPGdpdGxhYi5jb20vY2Fyb25hc2hvdy9hcGkvZ28vZ2VuL2Nhcm9uYXNob3cvdHlwZXMvdjE7dHlwZXN2MaICA0NUWKoCE0Nhcm9uYXNob3cuVHlwZXMuVjHKAhNDYXJvbmFzaG93XFR5cGVzXFYx4gIfQ2Fyb25hc2hvd1xUeXBlc1xWMVxHUEJNZXRhZGF0YeoCFUNhcm9uYXNob3c6OlR5cGVzOjpWMWIGcHJvdG8z");
 var UserSchema = /* @__PURE__ */ messageDesc(file_caronashow_types_v1_user, 0);
@@ -3112,3 +3150,13 @@ var ParticipationMode;
   ParticipationMode2[ParticipationMode2["EXPLORE"] = 3] = "EXPLORE";
 })(ParticipationMode ||= {});
 var ParticipationModeSchema = /* @__PURE__ */ enumDesc(file_caronashow_types_v1_user, 0);
+
+// src/gen/caronashow/service/v1/onboarding_pb.ts
+var file_caronashow_service_v1_onboarding = /* @__PURE__ */ fileDesc("CiZjYXJvbmFzaG93L3NlcnZpY2UvdjEvb25ib2FyZGluZy5wcm90bxIVY2Fyb25hc2hvdy5zZXJ2aWNlLnYxIhwKGkdldE9uYm9hcmRpbmdTdGF0dXNSZXF1ZXN0IjsKG0dldE9uYm9hcmRpbmdTdGF0dXNSZXNwb25zZRIcChRvbmJvYXJkaW5nX2NvbXBsZXRlZBgBIAEoCCKjAgoZQ29tcGxldGVPbmJvYXJkaW5nUmVxdWVzdBIoCiBlbnJvbGxlZF9pbl92dWxuZXJhYmlsaXR5X2ZpbHRlchgBIAEoCBIWCg50ZXJtc19hY2NlcHRlZBgCIAEoCBJCChJwYXJ0aWNpcGF0aW9uX21vZGUYAyABKA4yJi5jYXJvbmFzaG93LnR5cGVzLnYxLlBhcnRpY2lwYXRpb25Nb2RlEjgKBW9mZmVyGAQgASgLMicuY2Fyb25hc2hvdy5zZXJ2aWNlLnYxLkRyaXZlck9mZmVyU2V0dXBIABI9CgZzZWFyY2gYBSABKAsyKy5jYXJvbmFzaG93LnNlcnZpY2UudjEuUGFzc2VuZ2VyU2VhcmNoU2V0dXBIAEIHCgVzZXR1cCK3AgoQRHJpdmVyT2ZmZXJTZXR1cBIVCg12ZWhpY2xlX21vZGVsGAEgASgJEhUKDXZlaGljbGVfY29sb3IYAiABKAkSFQoNdmVoaWNsZV9wbGF0ZRgDIAEoCRIVCg1vZmZlcmVkX3NlYXRzGAQgASgFEhYKDm9yaWdpbl9hZGRyZXNzGAUgASgJEjYKDmRlcGFydHVyZV90aW1lGAYgASgLMh4uY2Fyb25hc2hvdy50eXBlcy52MS5UaW1lT2ZEYXkSMwoLcmV0dXJuX3RpbWUYByABKAsyHi5jYXJvbmFzaG93LnR5cGVzLnYxLlRpbWVPZkRheRIaChJhY2NlcHRpbmdfcmVxdWVzdHMYCCABKAgSJgoecmVzdHJpY3RlZF90b192dWxuZXJhYmxlX2dyb3VwGAkgASgIItkBChRQYXNzZW5nZXJTZWFyY2hTZXR1cBIWCg5vcmlnaW5fYWRkcmVzcxgBIAEoCRI2Cg5kZXBhcnR1cmVfdGltZRgCIAEoCzIeLmNhcm9uYXNob3cudHlwZXMudjEuVGltZU9mRGF5EjMKC3JldHVybl90aW1lGAMgASgLMh4uY2Fyb25hc2hvdy50eXBlcy52MS5UaW1lT2ZEYXkSPAoPY2hhdF9wcmVmZXJlbmNlGAQgASgOMiMuY2Fyb25hc2hvdy50eXBlcy52MS5DaGF0UHJlZmVyZW5jZSIcChpDb21wbGV0ZU9uYm9hcmRpbmdSZXNwb25zZTKMAgoRT25ib2FyZGluZ1NlcnZpY2USfAoTR2V0T25ib2FyZGluZ1N0YXR1cxIxLmNhcm9uYXNob3cuc2VydmljZS52MS5HZXRPbmJvYXJkaW5nU3RhdHVzUmVxdWVzdBoyLmNhcm9uYXNob3cuc2VydmljZS52MS5HZXRPbmJvYXJkaW5nU3RhdHVzUmVzcG9uc2USeQoSQ29tcGxldGVPbmJvYXJkaW5nEjAuY2Fyb25hc2hvdy5zZXJ2aWNlLnYxLkNvbXBsZXRlT25ib2FyZGluZ1JlcXVlc3QaMS5jYXJvbmFzaG93LnNlcnZpY2UudjEuQ29tcGxldGVPbmJvYXJkaW5nUmVzcG9uc2VC5AEKGWNvbS5jYXJvbmFzaG93LnNlcnZpY2UudjFCD09uYm9hcmRpbmdQcm90b1ABWkBnaXRsYWIuY29tL2Nhcm9uYXNob3cvYXBpL2dvL2dlbi9jYXJvbmFzaG93L3NlcnZpY2UvdjE7c2VydmljZXYxogIDQ1NYqgIVQ2Fyb25hc2hvdy5TZXJ2aWNlLlYxygIVQ2Fyb25hc2hvd1xTZXJ2aWNlXFYx4gIhQ2Fyb25hc2hvd1xTZXJ2aWNlXFYxXEdQQk1ldGFkYXRh6gIXQ2Fyb25hc2hvdzo6U2VydmljZTo6VjFiBnByb3RvMw", [file_caronashow_types_v1_common, file_caronashow_types_v1_user]);
+var GetOnboardingStatusRequestSchema = /* @__PURE__ */ messageDesc(file_caronashow_service_v1_onboarding, 0);
+var GetOnboardingStatusResponseSchema = /* @__PURE__ */ messageDesc(file_caronashow_service_v1_onboarding, 1);
+var CompleteOnboardingRequestSchema = /* @__PURE__ */ messageDesc(file_caronashow_service_v1_onboarding, 2);
+var DriverOfferSetupSchema = /* @__PURE__ */ messageDesc(file_caronashow_service_v1_onboarding, 3);
+var PassengerSearchSetupSchema = /* @__PURE__ */ messageDesc(file_caronashow_service_v1_onboarding, 4);
+var CompleteOnboardingResponseSchema = /* @__PURE__ */ messageDesc(file_caronashow_service_v1_onboarding, 5);
+var OnboardingService = /* @__PURE__ */ serviceDesc(file_caronashow_service_v1_onboarding, 0);

package/dist/index.d.ts

@@ -4,5 +4,7 @@ export * from "./gen/caronashow/poc/v1/points_pb";
 export * from "./gen/caronashow/poc/v1/routes_pb";
 export * from "./gen/caronashow/pooler/v1/pooler_pb";
 export * from "./gen/caronashow/service/v1/map_pb";
+export * from "./gen/caronashow/service/v1/onboarding_pb";
+export * from "./gen/caronashow/types/v1/common_pb";
 export * from "./gen/caronashow/types/v1/user_pb";
 export * from "./gen/google/type/latlng_pb";

package/package.json

@@ -3,7 +3,7 @@
   "module": "src/index.ts",
   "main": "dist/index.cjs",
   "types": "dist/index.d.ts",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "CaronaShow API definitions",
   "author": "Lucas Santos <zerowhy.server@protonmail.com>",
   "license": "MIT",