@caronashow/api 0.14.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -172,9 +172,9 @@ export type MapRideSuggestion = Message<"caronashow.service.v1.MapRideSuggestion
172
172
  driverEndpointLocation?: LatLng | undefined;
173
173
  /**
174
174
  * Safe route path and cache identity used by the map renderer. For the first
175
- * outbound release, the path runs from the coarse driver area toward the
176
- * organization area. It must not expose the passenger's exact origin or a
177
- * raw Pooler stop sequence.
175
+ * organization-origin release, the path starts at the organization area and
176
+ * ends at coarse participant home areas. It must not expose any participant's
177
+ * exact home address or a raw Pooler stop sequence.
178
178
  *
179
179
  * @generated from field: caronashow.service.v1.RouteGeometry route_geometry = 4;
180
180
  */
@@ -355,9 +355,11 @@ export type RankedRideSuggestion = Message<"caronashow.service.v1.RankedRideSugg
355
355
  */
356
356
  seats?: SeatAvailability | undefined;
357
357
  /**
358
- * Optional exact organization time when a trusted Backend calculation exists
359
- * for a custom schedule. Clients must prefer organization_arrival_window and
360
- * hide the schedule when both are absent.
358
+ * Optional exact organization-local time when a trusted Backend calculation
359
+ * exists for a custom schedule. For COMMUTE_DIRECTION_FROM_ORGANIZATION,
360
+ * this is departure from the organization; for TO_ORGANIZATION, it is
361
+ * arrival at the organization. Clients must prefer
362
+ * organization_arrival_window and hide the schedule when both are absent.
361
363
  *
362
364
  * @generated from field: caronashow.types.v1.TimeOfDay organization_time = 7;
363
365
  */
@@ -370,11 +372,14 @@ export type RankedRideSuggestion = Message<"caronashow.service.v1.RankedRideSugg
370
372
  */
371
373
  restrictedToVulnerableGroup: boolean;
372
374
  /**
373
- * Arrival window associated with the driver's named organization shift. It
374
- * is interpreted using organization_time_zone and is the preferred schedule
375
- * display for the first outbound release. It is absent for a custom schedule
376
- * unless the Backend can derive a meaningful window; clients may use the
377
- * exact-time field as a fallback.
375
+ * Direction-specific organization window associated with the driver's named
376
+ * organization shift. For COMMUTE_DIRECTION_FROM_ORGANIZATION, this carries
377
+ * the shift's departure window; for TO_ORGANIZATION, it carries the arrival
378
+ * window. It is interpreted using organization_time_zone and is the preferred
379
+ * schedule display for the first organization-origin release. The historical
380
+ * field name is retained for wire and source compatibility. It is absent for
381
+ * a custom schedule unless the Backend can derive a meaningful window;
382
+ * clients may use the exact-time field as a fallback.
378
383
  *
379
384
  * @generated from field: caronashow.service.v1.TimeWindow organization_arrival_window = 10;
380
385
  */
@@ -397,9 +402,11 @@ export type RankedRideSuggestion = Message<"caronashow.service.v1.RankedRideSugg
397
402
  routeDurationSeconds?: number | undefined;
398
403
  /**
399
404
  * Optional finite, nonnegative additional duration incurred by the driver
400
- * for this passenger, relative to the driver's direct baseline route to the
401
- * organization. The Backend derives it from the same published snapshot; the
402
- * browser must not calculate it.
405
+ * for this passenger, relative to the driver's direct baseline route for the
406
+ * requested commute direction. For the first supported direction, that route
407
+ * starts at the organization and ends at the driver's home. The Backend
408
+ * derives it from the same published snapshot; the browser must not calculate
409
+ * it.
403
410
  *
404
411
  * @generated from field: optional double driver_detour_duration_seconds = 13;
405
412
  */
@@ -510,15 +517,15 @@ export declare enum CommuteDirection {
510
517
  */
511
518
  UNSPECIFIED = 0,
512
519
  /**
513
- * Driver and passenger travel toward the organization. Supported by the
514
- * first Backend recommendation release.
520
+ * Driver and passenger travel toward the organization. Kept in the enum for
521
+ * forward compatibility; not supported by the first Backend release.
515
522
  *
516
523
  * @generated from enum value: COMMUTE_DIRECTION_TO_ORGANIZATION = 1;
517
524
  */
518
525
  TO_ORGANIZATION = 1,
519
526
  /**
520
- * Driver and passenger leave the organization for their return trip. Kept
521
- * for the shared Home model; not supported by the first Backend release.
527
+ * Driver and passenger leave the organization toward participant home
528
+ * addresses. Supported by the first Backend recommendation release.
522
529
  *
523
530
  * @generated from enum value: COMMUTE_DIRECTION_FROM_ORGANIZATION = 2;
524
531
  */
@@ -584,9 +591,11 @@ export declare const MatchingService: GenService<{
584
591
  * saved Search setup are inferred from the session token.
585
592
  *
586
593
  * The first Backend recommendation release supports only
587
- * COMMUTE_DIRECTION_TO_ORGANIZATION. FROM_ORGANIZATION remains in the enum
588
- * for forward compatibility and returns UNIMPLEMENTED until the Backend
589
- * dataset and projection support the return direction.
594
+ * COMMUTE_DIRECTION_FROM_ORGANIZATION. Pooler's production routes start at
595
+ * the organization and end at participant home addresses. TO_ORGANIZATION
596
+ * remains in the enum for forward compatibility and returns UNIMPLEMENTED
597
+ * until the Backend dataset and projection support the toward-organization
598
+ * direction.
590
599
  *
591
600
  * Returns UNAUTHENTICATED without a valid session, FAILED_PRECONDITION when
592
601
  * the caller has no eligible Search setup, and INVALID_ARGUMENT for an
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "module": "src/index.ts",
4
4
  "main": "dist/index.cjs",
5
5
  "types": "dist/index.d.ts",
6
- "version": "0.14.0",
6
+ "version": "0.15.0",
7
7
  "description": "CaronaShow API definitions",
8
8
  "author": "Lucas Santos <zerowhy.server@protonmail.com>",
9
9
  "license": "MIT",