@solvice/routing 0.19.2-beta.0 → 0.19.3-beta.0

package/dist/runs.d.ts

@@ -646,10 +646,10 @@ export interface components {
              */
             preferences?: components["schemas"]["VehiclePreference"][] | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Importance of a must-serve task when not all of them fit: the solver
-             *     maximises the summed `priority` of served tasks before any cost. `>= 1`,
-             *     default `1` (maximise the count). A rank, not money — it never makes a
+             *     maximises the summed `priority` of served tasks before any cost. `1` to
+             *     `4294967295`, default `1` (maximise the count). A rank, not money — it never makes a
              *     task droppable; use `drop_cost` for that. Both set is a 400.
              * @example 3
              */
@@ -840,7 +840,7 @@ export interface components {
              */
             max_route_duration_s?: number | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Hard cap on served stops across the period's shifts; a job counts as
              *     one stop. Start, end, break and reload stops in `routes[].stops` do not
              *     count; a shipment counts as two stops.
@@ -886,7 +886,7 @@ export interface components {
          */
         PlanRoute: {
             /**
-             * Format: int32
+             * Format: uint32
              * @description On solve, the first `locked_count` stops stay where they are (already
              *     dispatched). Counts every listed stop. Cannot be combined with a
              *     `reload` stop, and must not exceed the route's stop count — both are
@@ -1129,7 +1129,7 @@ export interface components {
              */
             id: string;
             /**
-             * Format: int32
+             * Format: uint32
              * @description The cap on counted stops; a job counts as one stop.
              *     Start, end, break and reload stops in `routes[].stops` do not count; a
              *     shipment counts as two stops.
@@ -1173,8 +1173,10 @@ export interface components {
          *     its pickup. A shipment's own id in `stops`, or a shipment carrying the
          *     `tag` of a `same_vehicle` or `same_day` relation, is rejected with HTTP 400
          *     `not_supported`: relations never silently skip a member. `same_route`,
-         *     `time_lag`, `compatible_vehicles`, `all_or_none` and `tag_order` reject a
-         *     shipment with HTTP 400 as well.
+         *     `time_lag`, `compatible_vehicles` and `tag_order` reject a shipment with
+         *     HTTP 400 as well. `all_or_none` alone takes a shipment's own id, naming both
+         *     legs, in a group that is exactly one `consecutive` chain; such a chain may
+         *     also be jobs only.
          * @example {
          *       "stops": [
          *         "job-1",
@@ -1187,20 +1189,25 @@ export interface components {
         /**
          * All or none
          * @description All or none: either every member in `stops` is served, or none is.
-         *     Sets no timing; combine with `synchronized` or `time_lag` for when.
-         *     Hard. Overlapping `all_or_none` relations chain: one on A and B plus
+         *     Sets no timing; a coupled group takes its timing from the
+         *     `synchronized` or `time_lag` relation that names its members. Hard.
+         *     Overlapping `all_or_none` relations chain: one on A and B plus
          *     one on B and C serve all three together or none of them. A group with
          *     a task in a vehicle's locked prefix (`plan.routes[].locked_count`) is
          *     exempt. A member that could be served but is held back because
          *     another cannot reports `all_or_none` in `unassigned[].reasons`.
          *
-         *     Every task must also be named by a `synchronized` or `time_lag`
-         *     relation; a task named by neither is rejected with HTTP 400.
+         *     A member may be a shipment id (both legs). Members are coupled by
+         *     `synchronized`/`time_lag`, or the group's stops (a shipment as its two
+         *     legs) are exactly one `consecutive` chain with no member coupled by
+         *     `synchronized` or `time_lag`, directly or through a `sequence` or
+         *     `consecutive` relation. A task named by neither is rejected with HTTP 400, as is a
+         *     shipment-leg id: name the shipment.
          */
         RelationAllOrNone: {
             /**
-             * @description Job ids, at least two. A shipment's own id or a shipment-leg stop id
-             *     is rejected with HTTP 400.
+             * @description Job ids or shipment ids, at least two. A shipment-leg stop id is
+             *     rejected with HTTP 400.
              * @example [
              *       "job-1",
              *       "job-2"
@@ -1248,6 +1255,7 @@ export interface components {
          *     route. A member that is unassigned is skipped, so only listed
          *     neighbours that are both served are adjacent. Members on different
          *     routes are unconstrained; add `same_route` to keep them together.
+         *     Put a chain in an `all_or_none` to serve it whole or not at all.
          */
         RelationConsecutive: {
             /**
@@ -1504,14 +1512,14 @@ export interface components {
         /** @description One problem in a request. */
         RequestIssue: {
             /**
-             * Format: int64
+             * Format: uint64
              * @description `limit_exceeded` only: the count this request has.
              */
             actual?: number | null;
             /** @description What is wrong. */
             code: components["schemas"]["ErrorItemCode"];
             /**
-             * Format: int64
+             * Format: uint64
              * @description `limit_exceeded` only: the published cap.
              */
             limit?: number | null;
@@ -1998,7 +2006,7 @@ export interface components {
              */
             polyline?: null | components["schemas"]["PolylineDetail"];
             /**
-             * Format: int64
+             * Format: uint64
              * @description Random seed for the search. Default `42`: omitting it is the same as
              *     sending `42`, so send different values to explore different plans.
              *     Repeated runs on one machine usually return an identical plan; a
@@ -2260,7 +2268,7 @@ export interface components {
              */
             unassigned_priority: number;
             /**
-             * Format: int32
+             * Format: uint32
              * @description How many hard-constraint violations the plan has (the `violations`
              *     arrays on routes and stops list them). Always `0` on a solve result.
              * @example 0
@@ -2400,7 +2408,7 @@ export interface components {
         /** @description How the search behind a plan ended. */
         SearchInfo: {
             /**
-             * Format: int64
+             * Format: uint64
              * @description Search iterations performed. `0` when nothing was searched.
              * @example 48210
              */
@@ -2426,7 +2434,7 @@ export interface components {
              */
             cost: number;
             /**
-             * Format: int64
+             * Format: uint64
              * @description Milliseconds since the search started (the clock of
              *     `summary.timings.search_ms`).
              */
@@ -2728,7 +2736,7 @@ export interface components {
              */
             max_route_duration_s?: number | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Maximum stops served in this shift; a job counts as one stop.
              *     Start, end, break and reload stops in `routes[].stops` do not count; a
              *     shipment counts as two stops.
@@ -2857,10 +2865,10 @@ export interface components {
              */
             preferences?: components["schemas"]["VehiclePreference"][] | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Importance of a must-serve task when not all of them fit: the solver
-             *     maximises the summed `priority` of served tasks before any cost. `>= 1`,
-             *     default `1` (maximise the count). A rank, not money — it never makes a
+             *     maximises the summed `priority` of served tasks before any cost. `1` to
+             *     `4294967295`, default `1` (maximise the count). A rank, not money — it never makes a
              *     task droppable; use `drop_cost` for that. Both set is a 400.
              * @example 3
              */
@@ -3264,7 +3272,7 @@ export interface components {
             /** @description How the search ended. */
             search: components["schemas"]["SearchInfo"];
             /**
-             * Format: int32
+             * Format: uint32
              * @description Routes with at least one task stop: one per used shift.
              * @example 1
              */
@@ -3288,7 +3296,7 @@ export interface components {
              */
             travel_estimated?: boolean;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Distinct vehicles with at least one route.
              * @example 1
              */
@@ -3367,17 +3375,17 @@ export interface components {
          */
         TaskCounts: {
             /**
-             * Format: int32
+             * Format: uint32
              * @description Tasks on a route.
              */
             served: number;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Tasks on no route: the length of `unassigned`.
              */
             unassigned: number;
             /**
-             * Format: int32
+             * Format: uint32
              * @description The unassigned tasks that carry no `drop_cost`: tasks the plan was
              *     required to serve and did not.
              */
@@ -3536,13 +3544,13 @@ export interface components {
          */
         Timings: {
             /**
-             * Format: int64
+             * Format: uint64
              * @description Time spent in the search. Absent on `/evaluate`, which runs none, and
              *     on `/suggest`, which has no separate search figure.
              */
             search_ms?: number | null;
             /**
-             * Format: int64
+             * Format: uint64
              * @description From the request's arrival to the end of the search (of the scoring,
              *     on `/evaluate`; of the suggestion search, on `/suggest`): fetching
              *     travel times and waiting for capacity included, building the response
@@ -3889,7 +3897,7 @@ export interface components {
              */
             max_route_duration_s?: number | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Maximum stops served per shift; a job counts as one stop.
              *     Start, end, break and reload stops in `routes[].stops` do not count; a
              *     shipment counts as two stops.

package/dist/v3.d.ts

@@ -833,10 +833,10 @@ export interface components {
              */
             preferences?: components["schemas"]["VehiclePreference"][] | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Importance of a must-serve task when not all of them fit: the solver
-             *     maximises the summed `priority` of served tasks before any cost. `>= 1`,
-             *     default `1` (maximise the count). A rank, not money — it never makes a
+             *     maximises the summed `priority` of served tasks before any cost. `1` to
+             *     `4294967295`, default `1` (maximise the count). A rank, not money — it never makes a
              *     task droppable; use `drop_cost` for that. Both set is a 400.
              * @example 3
              */
@@ -1027,7 +1027,7 @@ export interface components {
              */
             max_route_duration_s?: number | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Hard cap on served stops across the period's shifts; a job counts as
              *     one stop. Start, end, break and reload stops in `routes[].stops` do not
              *     count; a shipment counts as two stops.
@@ -1128,7 +1128,7 @@ export interface components {
          */
         PlanRoute: {
             /**
-             * Format: int32
+             * Format: uint32
              * @description On solve, the first `locked_count` stops stay where they are (already
              *     dispatched). Counts every listed stop. Cannot be combined with a
              *     `reload` stop, and must not exceed the route's stop count — both are
@@ -1377,7 +1377,7 @@ export interface components {
              */
             id: string;
             /**
-             * Format: int32
+             * Format: uint32
              * @description The cap on counted stops; a job counts as one stop.
              *     Start, end, break and reload stops in `routes[].stops` do not count; a
              *     shipment counts as two stops.
@@ -1421,8 +1421,10 @@ export interface components {
          *     its pickup. A shipment's own id in `stops`, or a shipment carrying the
          *     `tag` of a `same_vehicle` or `same_day` relation, is rejected with HTTP 400
          *     `not_supported`: relations never silently skip a member. `same_route`,
-         *     `time_lag`, `compatible_vehicles`, `all_or_none` and `tag_order` reject a
-         *     shipment with HTTP 400 as well.
+         *     `time_lag`, `compatible_vehicles` and `tag_order` reject a shipment with
+         *     HTTP 400 as well. `all_or_none` alone takes a shipment's own id, naming both
+         *     legs, in a group that is exactly one `consecutive` chain; such a chain may
+         *     also be jobs only.
          * @example {
          *       "stops": [
          *         "job-1",
@@ -1435,20 +1437,25 @@ export interface components {
         /**
          * All or none
          * @description All or none: either every member in `stops` is served, or none is.
-         *     Sets no timing; combine with `synchronized` or `time_lag` for when.
-         *     Hard. Overlapping `all_or_none` relations chain: one on A and B plus
+         *     Sets no timing; a coupled group takes its timing from the
+         *     `synchronized` or `time_lag` relation that names its members. Hard.
+         *     Overlapping `all_or_none` relations chain: one on A and B plus
          *     one on B and C serve all three together or none of them. A group with
          *     a task in a vehicle's locked prefix (`plan.routes[].locked_count`) is
          *     exempt. A member that could be served but is held back because
          *     another cannot reports `all_or_none` in `unassigned[].reasons`.
          *
-         *     Every task must also be named by a `synchronized` or `time_lag`
-         *     relation; a task named by neither is rejected with HTTP 400.
+         *     A member may be a shipment id (both legs). Members are coupled by
+         *     `synchronized`/`time_lag`, or the group's stops (a shipment as its two
+         *     legs) are exactly one `consecutive` chain with no member coupled by
+         *     `synchronized` or `time_lag`, directly or through a `sequence` or
+         *     `consecutive` relation. A task named by neither is rejected with HTTP 400, as is a
+         *     shipment-leg id: name the shipment.
          */
         RelationAllOrNone: {
             /**
-             * @description Job ids, at least two. A shipment's own id or a shipment-leg stop id
-             *     is rejected with HTTP 400.
+             * @description Job ids or shipment ids, at least two. A shipment-leg stop id is
+             *     rejected with HTTP 400.
              * @example [
              *       "job-1",
              *       "job-2"
@@ -1496,6 +1503,7 @@ export interface components {
          *     route. A member that is unassigned is skipped, so only listed
          *     neighbours that are both served are adjacent. Members on different
          *     routes are unconstrained; add `same_route` to keep them together.
+         *     Put a chain in an `all_or_none` to serve it whole or not at all.
          */
         RelationConsecutive: {
             /**
@@ -1752,14 +1760,14 @@ export interface components {
         /** @description One problem in a request. */
         RequestIssue: {
             /**
-             * Format: int64
+             * Format: uint64
              * @description `limit_exceeded` only: the count this request has.
              */
             actual?: number | null;
             /** @description What is wrong. */
             code: components["schemas"]["ErrorItemCode"];
             /**
-             * Format: int64
+             * Format: uint64
              * @description `limit_exceeded` only: the published cap.
              */
             limit?: number | null;
@@ -2176,7 +2184,7 @@ export interface components {
              */
             unassigned_priority: number;
             /**
-             * Format: int32
+             * Format: uint32
              * @description How many hard-constraint violations the plan has (the `violations`
              *     arrays on routes and stops list them). Always `0` on a solve result.
              * @example 0
@@ -2316,7 +2324,7 @@ export interface components {
         /** @description How the search behind a plan ended. */
         SearchInfo: {
             /**
-             * Format: int64
+             * Format: uint64
              * @description Search iterations performed. `0` when nothing was searched.
              * @example 48210
              */
@@ -2342,7 +2350,7 @@ export interface components {
              */
             cost: number;
             /**
-             * Format: int64
+             * Format: uint64
              * @description Milliseconds since the search started (the clock of
              *     `summary.timings.search_ms`).
              */
@@ -2644,7 +2652,7 @@ export interface components {
              */
             max_route_duration_s?: number | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Maximum stops served in this shift; a job counts as one stop.
              *     Start, end, break and reload stops in `routes[].stops` do not count; a
              *     shipment counts as two stops.
@@ -2786,10 +2794,10 @@ export interface components {
              */
             preferences?: components["schemas"]["VehiclePreference"][] | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Importance of a must-serve task when not all of them fit: the solver
-             *     maximises the summed `priority` of served tasks before any cost. `>= 1`,
-             *     default `1` (maximise the count). A rank, not money — it never makes a
+             *     maximises the summed `priority` of served tasks before any cost. `1` to
+             *     `4294967295`, default `1` (maximise the count). A rank, not money — it never makes a
              *     task droppable; use `drop_cost` for that. Both set is a 400.
              * @example 3
              */
@@ -2931,7 +2939,7 @@ export interface components {
              */
             polyline?: null | components["schemas"]["PolylineDetail"];
             /**
-             * Format: int64
+             * Format: uint64
              * @description Random seed for the search. Default `42`: omitting it is the same as
              *     sending `42`, so send different values to explore different plans.
              *     Repeated runs on one machine usually return an identical plan; a
@@ -3285,7 +3293,7 @@ export interface components {
          */
         SuggestOptions: {
             /**
-             * Format: int32
+             * Format: uint32
              * @description Max ranked `insertions` in each `suggestions[]` entry, `1` to `10`;
              *     default 5. It caps the insertions per entry, not the number of
              *     entries: every task outside `plan` still gets its entry. Values outside
@@ -3293,7 +3301,7 @@ export interface components {
              *     several stops is searched (such a unit is never searched exhaustively):
              *     each stop after the unit's first keeps at most
              *     `max(8, 4 × max_insertions)` partial placements. A `synchronized` or
-             *     `time_lag` group is the exception: every start slot of one member is
+             *     `time_lag` group is the exception: every start slot of each member is
              *     tried, each other member at its cheapest slot, whatever this value. A
              *     single-stop task has every feasible position considered unless
              *     `time_limit_s` runs out first.
@@ -3501,11 +3509,12 @@ export interface components {
              */
             timings: components["schemas"]["Timings"];
             /**
-             * @description `true` when `options.time_limit_s` cut the search short, or a
+             * @description `true` when `options.time_limit_s` cut the search short, a
              *     multi-member unit came back empty after the search had discarded
              *     candidates (an inconclusive "not found"; its `reason.code` is
-             *     `candidates_exhausted`). Lists may then be incomplete or missing the
-             *     best insertion. A single visit's only level is never pruned, so its
+             *     `candidates_exhausted`), or a crew lists fewer than `max_insertions`
+             *     after a member's cheapest slot was refused and its other slots went
+             *     untried. Lists may then be incomplete or missing the best insertion. A single visit's only level is never pruned, so its
              *     empty list is proof of infeasibility unless the budget cut it, and its
              *     `reason.code` is then `time_limit`.
              */
@@ -3587,7 +3596,7 @@ export interface components {
             /** @description How the search ended. */
             search: components["schemas"]["SearchInfo"];
             /**
-             * Format: int32
+             * Format: uint32
              * @description Routes with at least one task stop: one per used shift.
              * @example 1
              */
@@ -3611,7 +3620,7 @@ export interface components {
              */
             travel_estimated?: boolean;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Distinct vehicles with at least one route.
              * @example 1
              */
@@ -3690,17 +3699,17 @@ export interface components {
          */
         TaskCounts: {
             /**
-             * Format: int32
+             * Format: uint32
              * @description Tasks on a route.
              */
             served: number;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Tasks on no route: the length of `unassigned`.
              */
             unassigned: number;
             /**
-             * Format: int32
+             * Format: uint32
              * @description The unassigned tasks that carry no `drop_cost`: tasks the plan was
              *     required to serve and did not.
              */
@@ -3918,13 +3927,13 @@ export interface components {
          */
         Timings: {
             /**
-             * Format: int64
+             * Format: uint64
              * @description Time spent in the search. Absent on `/evaluate`, which runs none, and
              *     on `/suggest`, which has no separate search figure.
              */
             search_ms?: number | null;
             /**
-             * Format: int64
+             * Format: uint64
              * @description From the request's arrival to the end of the search (of the scoring,
              *     on `/evaluate`; of the suggestion search, on `/suggest`): fetching
              *     travel times and waiting for capacity included, building the response
@@ -4285,7 +4294,7 @@ export interface components {
              */
             max_route_duration_s?: number | null;
             /**
-             * Format: int32
+             * Format: uint32
              * @description Maximum stops served per shift; a job counts as one stop.
              *     Start, end, break and reload stops in `routes[].stops` do not count; a
              *     shipment counts as two stops.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solvice/routing",
-  "version": "0.19.2-beta.0",
+  "version": "0.19.3-beta.0",
   "description": "TypeScript client for the Solvice V3 routing API, generated from its OpenAPI spec.",
   "license": "Apache-2.0",
   "homepage": "https://docs.solvice.io/guides/platform/sdks/typescript",