@solvice/routing 0.16.1-beta.0 → 0.17.1-beta.0

package/README.md

@@ -98,9 +98,12 @@ npm test           # builds, typechecks tests/types.ts and examples/, runs the u
 npm run smoke      # live calls; needs SOLVICE_API_KEY
 ```
 
-To release, bump `version` to the next `0.x.y-beta.n`, merge it to `main`, then run
-the "Publish TypeScript SDK" workflow on `main` (Actions → Run workflow). It runs
-`npm run publish:beta` through npm trusted publishing; never publish
+Releases are automatic: when release-plz publishes the GitHub release `vX.Y.Z`, the
+"Publish TypeScript SDK" workflow publishes `X.Y.Z-beta.0`. `version` in `package.json`
+is a placeholder (`0.0.0-development`); the workflow sets the real one from the tag, so
+never bump it. To publish a release that triggered nothing, or re-run a failed one, use
+Actions → Run workflow on `main`: it publishes the latest tag, or the one typed into `tag`.
+It runs `npm run publish:beta` through npm trusted publishing; never publish
 from a branch. The explicit `--tag beta` matters: npm 11 ignores
 `publishConfig.tag` and would move `latest` to the prerelease. Until a stable version
 exists, `latest` still points at the first prerelease (npm gives a package's first

package/dist/v3.d.ts

@@ -1898,10 +1898,10 @@ export interface components {
             id?: string | null;
             /**
              * Format: int32
-             * @description Seconds late beyond the latest allowed arrival (`0` when on time), on
-             *     task stops, measured from the arrival plus any `windowed` break taken
-             *     on arrival at this stop (idle until that break's window opens
-             *     included). Measures the hard time window only; a soft target is
+             * @description Seconds the start of service is past the time window's `to` (`0` when
+             *     on time), on task stops, measured from the arrival plus any `windowed`
+             *     break taken on arrival at this stop (idle until that break's window
+             *     opens included). Measures the time window only; a soft target is
              *     reported in `target_lateness_s`.
              * @example 0
              */
@@ -2181,6 +2181,35 @@ export interface components {
             /** @description How the search ended. */
             termination: components["schemas"]["SearchTermination"];
         };
+        /**
+         * @description One point of `search_progress`: the best plan's score `elapsed_ms` into
+         *     the search. `unassigned_priority` and `cost` mean what they mean in
+         *     `summary.score`; the best plan has the lowest `unassigned_priority`, then the
+         *     lowest `cost`, so `cost` can rise when more tasks get served.
+         * @example {
+         *       "cost": 58.8436,
+         *       "elapsed_ms": 180,
+         *       "unassigned_priority": 0
+         *     }
+         */
+        SearchProgressPoint: {
+            /**
+             * Format: double
+             * @description Total cost, in the objective's currency.
+             */
+            cost: number;
+            /**
+             * Format: int64
+             * @description Milliseconds since the search started (the clock of
+             *     `summary.timings.search_ms`).
+             */
+            elapsed_ms: number;
+            /**
+             * Format: int64
+             * @description Summed `priority` of the required tasks left unassigned.
+             */
+            unassigned_priority: number;
+        };
         /**
          * @description How the search ended. New values may be added; clients must accept
          *     unknown values.
@@ -2983,6 +3012,15 @@ export interface components {
             plan: components["schemas"]["Plan"];
             /** @description One entry per non-empty route. */
             routes: components["schemas"]["Route"][];
+            /**
+             * @description How the best plan improved during the search, oldest first: the
+             *     starting plan, every improvement (thinned to at most 500 entries), and
+             *     the final plan, which equals `summary.score` (it can equal, or after
+             *     the final repair be slightly worse than, the entry before it). Present on
+             *     every solve; absent on evaluate, which does not search. A large solve
+             *     the solver splits into clusters has the final entry alone.
+             */
+            search_progress?: components["schemas"]["SearchProgressPoint"][] | null;
             /** @description Aggregate statistics for the solve run. */
             summary: components["schemas"]["Summary"];
             /** @description Tasks that could not be feasibly assigned. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solvice/routing",
-  "version": "0.16.1-beta.0",
+  "version": "0.17.1-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",