@jsm-mit/map-routes-package 0.0.0-stage → 0.2.0

package/declarations/map-routes-worker/map-routes-worker.did

@@ -0,0 +1,172 @@
+type BeginUploadArgs = record {
+  // sha256 (hex) of the graph file.
+  sha256 : text;
+  // Bytes of the graph file (`map-routes-build build` output, format TMC3).
+  size : nat64;
+  osmDate : text;
+};
+type BufferInfo = record {
+  sha256 : text;
+  size : nat64;
+  startedAtNs : nat64;
+  state : BufferState;
+  buffer : nat8;
+  osmDate : text;
+};
+type BufferState = variant { Uploading; Active; Ready };
+type CopyFromArgs = record {
+  // A worker that lists this canister in its peers.
+  source : principal;
+};
+type CopyStatus = record {
+  sha256 : text;
+  source : principal;
+  size : nat64;
+  // Bytes written so far.
+  copied : nat64;
+};
+// The fastest route by car between two points.
+type Distance = record {
+  meters : nat64;
+  snapToMeters : nat32;
+  seconds : nat64;
+  // Instructions this query took (measurement of the PoC).
+  instructions : nat64;
+  // sha256 (hex) of the graph, as printed by `map-routes-build build`.
+  graphSha256 : text;
+  // Date of the OpenStreetMap extract the graph was built from.
+  osmDate : text;
+  // How far each point lies from the junction the route starts or ends at.
+  snapFromMeters : nat32;
+};
+type DistanceArgs = record {
+  to : Point;
+  from : Point;
+  // The pass from the coordinator (`map-routes-pass`); required once `passRequired`.
+  pass : opt blob;
+};
+type Error = variant {
+  // No road within `MAX_SNAP_M` of the point named ("from" / "to" / "points[i]").
+  OutsideArea : text;
+  // A point lies outside the bbox of the pass ("from" / "to" / "points[i]").
+  OutsideBbox : text;
+  // No graph is active yet, or the active one is of an older format.
+  NotReady;
+  NotFound;
+  NotAuthorized : text;
+  // The pass is past its time: ask the coordinator for a new one.
+  PassExpired;
+  NoRoute;
+  InvalidData : text;
+  // `passRequired` and the query carries no pass.
+  PassMissing;
+  // The pass does not hold: format, key, signature, copy, caller or area (named).
+  PassInvalid : text;
+};
+// The fastest route from one point of a `route` query to the next.
+type Leg = record {
+  meters : nat64;
+  // Encoded polyline of precision 5 (as ORS sends it), from the junction the leg starts
+  // at to the one it ends at; "" when the line was not asked for.
+  line : text;
+  seconds : nat64;
+};
+// One pass key of this copy, from the coordinator.
+type PassKeyArgs = record {
+  id : nat32;
+  // 32 bytes.
+  key : blob;
+  // An old key after a rotation stays valid until then; `null` = no end.
+  validUntilNs : opt nat64;
+};
+// The pass check as `getStatus` shows it: never the keys.
+type PassStatus = record {
+  keyIds : vec nat32;
+  area : opt text;
+  required : bool;
+};
+type Point = record { lat : float64; lon : float64 };
+type ReadChunkArgs = record {
+  // The graph to read: the buffer holding a committed graph with this sha256.
+  sha256 : text;
+  offset : nat64;
+  // 1..=`MAX_CHUNK_BYTES`.
+  length : nat32;
+};
+type Result = variant { Ok : BufferInfo; Err : Error };
+type Result_1 = variant { Ok : Distance; Err : Error };
+type Result_2 = variant { Ok : Status; Err : Error };
+type Result_3 = variant { Ok : blob; Err : Error };
+type Result_4 = variant { Ok : RouteAnswer; Err : Error };
+type Result_5 = variant { Ok : PassStatus; Err : Error };
+type Result_6 = variant { Ok; Err : Error };
+type RouteAnswer = record {
+  // How far each point lies from the junction its legs start or end at.
+  snapMeters : vec nat32;
+  // One leg for each pair of consecutive points.
+  legs : vec Leg;
+  instructions : nat64;
+  graphSha256 : text;
+  osmDate : text;
+};
+type RouteArgs = record {
+  // Whether each leg carries its line.
+  line : bool;
+  // The pass from the coordinator (`map-routes-pass`); required once `passRequired`.
+  pass : opt blob;
+  // 2..=`MAX_ROUTE_POINTS` points, driven in this order.
+  points : vec Point;
+};
+type SetPassConfigArgs = record {
+  // The area of this worker; a pass for another area is refused.
+  area : text;
+  // 0..=`MAX_PASS_KEYS` keys; replaces the ones held.
+  keys : vec PassKeyArgs;
+  // Without a pass `distance` and `route` answer `PassMissing`.
+  required : bool;
+};
+type Status = record {
+  stableBytes : nat64;
+  heapBytes : nat64;
+  // A copy from another worker that has not ended (`copyFrom`).
+  copy : opt CopyStatus;
+  // The pass check; `opt` so that a newer package reads an older canister.
+  pass : opt PassStatus;
+  // Who may upload and commit a graph besides the controllers (`setUploaders`).
+  uploaders : opt vec principal;
+  // Nodes of the graph that answers `distance`; 0 when none is active.
+  nodes : nat64;
+  buffers : vec BufferInfo;
+  // Workers that may read this graph (`setPeers`).
+  peers : opt vec principal;
+};
+type UploadChunkArgs = record { offset : nat64; bytes : blob };
+service : () -> {
+  // Switches `distance` to the inactive buffer — a new graph, or back to the previous one.
+  activate : () -> (Result);
+  // Starts an upload into the inactive buffer; whatever was there is dropped.
+  beginUpload : (BeginUploadArgs) -> (Result);
+  // Checks the hash and the header of the uploaded graph; the buffer becomes Ready.
+  commitUpload : () -> (Result);
+  // Pulls the active graph of `source` into the inactive buffer, chunk by chunk, and commits
+  // it (hash and header checked). It does not activate it. Called again after a stop, it goes
+  // on where it stopped; the source must list this canister in its peers.
+  copyFrom : (CopyFromArgs) -> (Result);
+  // The fastest route by car from one point to another. Public.
+  distance : (DistanceArgs) -> (Result_1) query;
+  getStatus : () -> (Result_2) query;
+  // The active graph, for a copy: sha256, size, date. Controllers and peers.
+  graphInfo : () -> (Result) query;
+  // Bytes of a committed graph (by its sha256), for a copy. Controllers and peers.
+  readChunk : (ReadChunkArgs) -> (Result_3) query;
+  // The fastest route by car through 2..=5 points, leg by leg, with each leg's line when
+  // asked. Public.
+  route : (RouteArgs) -> (Result_4) query;
+  // Sets the pass check: required or not, the area, the keys (from the coordinator).
+  setPassConfig : (SetPassConfigArgs) -> (Result_5);
+  // Sets the workers that may read the graph to copy it (the coordinator lists the copies).
+  setPeers : (vec principal) -> (Result_6);
+  // Sets who may upload and commit a graph besides the controllers (not activate it).
+  setUploaders : (vec principal) -> (Result_6);
+  uploadChunk : (UploadChunkArgs) -> (Result_6);
+}

package/declarations/map-routes-worker/map-routes-worker.did.d.ts

@@ -0,0 +1,296 @@
+import type { Principal } from '@icp-sdk/core/principal';
+import type { ActorMethod } from '@icp-sdk/core/agent';
+import type { IDL } from '@icp-sdk/core/candid';
+
+export interface BeginUploadArgs {
+  /**
+   * sha256 (hex) of the graph file.
+   */
+  'sha256' : string,
+  /**
+   * Bytes of the graph file (`map-routes-build build` output, format TMC3).
+   */
+  'size' : bigint,
+  'osmDate' : string,
+}
+export interface BufferInfo {
+  'sha256' : string,
+  'size' : bigint,
+  'startedAtNs' : bigint,
+  'state' : BufferState,
+  'buffer' : number,
+  'osmDate' : string,
+}
+export type BufferState = { 'Uploading' : null } |
+  { 'Active' : null } |
+  { 'Ready' : null };
+export interface CopyFromArgs {
+  /**
+   * A worker that lists this canister in its peers.
+   */
+  'source' : Principal,
+}
+export interface CopyStatus {
+  'sha256' : string,
+  'source' : Principal,
+  'size' : bigint,
+  /**
+   * Bytes written so far.
+   */
+  'copied' : bigint,
+}
+/**
+ * The fastest route by car between two points.
+ */
+export interface Distance {
+  'meters' : bigint,
+  'snapToMeters' : number,
+  'seconds' : bigint,
+  /**
+   * Instructions this query took (measurement of the PoC).
+   */
+  'instructions' : bigint,
+  /**
+   * sha256 (hex) of the graph, as printed by `map-routes-build build`.
+   */
+  'graphSha256' : string,
+  /**
+   * Date of the OpenStreetMap extract the graph was built from.
+   */
+  'osmDate' : string,
+  /**
+   * How far each point lies from the junction the route starts or ends at.
+   */
+  'snapFromMeters' : number,
+}
+export interface DistanceArgs {
+  'to' : Point,
+  'from' : Point,
+  /**
+   * The pass from the coordinator (`map-routes-pass`); required once `passRequired`.
+   */
+  'pass' : [] | [Uint8Array | number[]],
+}
+export type Error = {
+    /**
+     * No road within `MAX_SNAP_M` of the point named ("from" / "to" / "points[i]").
+     */
+    'OutsideArea' : string
+  } |
+  {
+    /**
+     * A point lies outside the bbox of the pass ("from" / "to" / "points[i]").
+     */
+    'OutsideBbox' : string
+  } |
+  {
+    /**
+     * No graph is active yet, or the active one is of an older format.
+     */
+    'NotReady' : null
+  } |
+  { 'NotFound' : null } |
+  { 'NotAuthorized' : string } |
+  {
+    /**
+     * The pass is past its time: ask the coordinator for a new one.
+     */
+    'PassExpired' : null
+  } |
+  { 'NoRoute' : null } |
+  { 'InvalidData' : string } |
+  {
+    /**
+     * `passRequired` and the query carries no pass.
+     */
+    'PassMissing' : null
+  } |
+  {
+    /**
+     * The pass does not hold: format, key, signature, copy, caller or area (named).
+     */
+    'PassInvalid' : string
+  };
+/**
+ * The fastest route from one point of a `route` query to the next.
+ */
+export interface Leg {
+  'meters' : bigint,
+  /**
+   * Encoded polyline of precision 5 (as ORS sends it), from the junction the leg starts
+   * at to the one it ends at; "" when the line was not asked for.
+   */
+  'line' : string,
+  'seconds' : bigint,
+}
+/**
+ * One pass key of this copy, from the coordinator.
+ */
+export interface PassKeyArgs {
+  'id' : number,
+  /**
+   * 32 bytes.
+   */
+  'key' : Uint8Array | number[],
+  /**
+   * An old key after a rotation stays valid until then; `null` = no end.
+   */
+  'validUntilNs' : [] | [bigint],
+}
+/**
+ * The pass check as `getStatus` shows it: never the keys.
+ */
+export interface PassStatus {
+  'keyIds' : Uint32Array | number[],
+  'area' : [] | [string],
+  'required' : boolean,
+}
+export interface Point { 'lat' : number, 'lon' : number }
+export interface ReadChunkArgs {
+  /**
+   * The graph to read: the buffer holding a committed graph with this sha256.
+   */
+  'sha256' : string,
+  'offset' : bigint,
+  /**
+   * 1..=`MAX_CHUNK_BYTES`.
+   */
+  'length' : number,
+}
+export type Result = { 'Ok' : BufferInfo } |
+  { 'Err' : Error };
+export type Result_1 = { 'Ok' : Distance } |
+  { 'Err' : Error };
+export type Result_2 = { 'Ok' : Status } |
+  { 'Err' : Error };
+export type Result_3 = { 'Ok' : Uint8Array | number[] } |
+  { 'Err' : Error };
+export type Result_4 = { 'Ok' : RouteAnswer } |
+  { 'Err' : Error };
+export type Result_5 = { 'Ok' : PassStatus } |
+  { 'Err' : Error };
+export type Result_6 = { 'Ok' : null } |
+  { 'Err' : Error };
+export interface RouteAnswer {
+  /**
+   * How far each point lies from the junction its legs start or end at.
+   */
+  'snapMeters' : Uint32Array | number[],
+  /**
+   * One leg for each pair of consecutive points.
+   */
+  'legs' : Array<Leg>,
+  'instructions' : bigint,
+  'graphSha256' : string,
+  'osmDate' : string,
+}
+export interface RouteArgs {
+  /**
+   * Whether each leg carries its line.
+   */
+  'line' : boolean,
+  /**
+   * The pass from the coordinator (`map-routes-pass`); required once `passRequired`.
+   */
+  'pass' : [] | [Uint8Array | number[]],
+  /**
+   * 2..=`MAX_ROUTE_POINTS` points, driven in this order.
+   */
+  'points' : Array<Point>,
+}
+export interface SetPassConfigArgs {
+  /**
+   * The area of this worker; a pass for another area is refused.
+   */
+  'area' : string,
+  /**
+   * 0..=`MAX_PASS_KEYS` keys; replaces the ones held.
+   */
+  'keys' : Array<PassKeyArgs>,
+  /**
+   * Without a pass `distance` and `route` answer `PassMissing`.
+   */
+  'required' : boolean,
+}
+export interface Status {
+  'stableBytes' : bigint,
+  'heapBytes' : bigint,
+  /**
+   * A copy from another worker that has not ended (`copyFrom`).
+   */
+  'copy' : [] | [CopyStatus],
+  /**
+   * The pass check; `opt` so that a newer package reads an older canister.
+   */
+  'pass' : [] | [PassStatus],
+  /**
+   * Who may upload and commit a graph besides the controllers (`setUploaders`).
+   */
+  'uploaders' : [] | [Array<Principal>],
+  /**
+   * Nodes of the graph that answers `distance`; 0 when none is active.
+   */
+  'nodes' : bigint,
+  'buffers' : Array<BufferInfo>,
+  /**
+   * Workers that may read this graph (`setPeers`).
+   */
+  'peers' : [] | [Array<Principal>],
+}
+export interface UploadChunkArgs {
+  'offset' : bigint,
+  'bytes' : Uint8Array | number[],
+}
+export interface _SERVICE {
+  /**
+   * Switches `distance` to the inactive buffer — a new graph, or back to the previous one.
+   */
+  'activate' : ActorMethod<[], Result>,
+  /**
+   * Starts an upload into the inactive buffer; whatever was there is dropped.
+   */
+  'beginUpload' : ActorMethod<[BeginUploadArgs], Result>,
+  /**
+   * Checks the hash and the header of the uploaded graph; the buffer becomes Ready.
+   */
+  'commitUpload' : ActorMethod<[], Result>,
+  /**
+   * Pulls the active graph of `source` into the inactive buffer, chunk by chunk, and commits
+   * it (hash and header checked). It does not activate it. Called again after a stop, it goes
+   * on where it stopped; the source must list this canister in its peers.
+   */
+  'copyFrom' : ActorMethod<[CopyFromArgs], Result>,
+  /**
+   * The fastest route by car from one point to another. Public.
+   */
+  'distance' : ActorMethod<[DistanceArgs], Result_1>,
+  'getStatus' : ActorMethod<[], Result_2>,
+  /**
+   * The active graph, for a copy: sha256, size, date. Controllers and peers.
+   */
+  'graphInfo' : ActorMethod<[], Result>,
+  /**
+   * Bytes of a committed graph (by its sha256), for a copy. Controllers and peers.
+   */
+  'readChunk' : ActorMethod<[ReadChunkArgs], Result_3>,
+  /**
+   * The fastest route by car through 2..=5 points, leg by leg, with each leg's line when
+   * asked. Public.
+   */
+  'route' : ActorMethod<[RouteArgs], Result_4>,
+  /**
+   * Sets the pass check: required or not, the area, the keys (from the coordinator).
+   */
+  'setPassConfig' : ActorMethod<[SetPassConfigArgs], Result_5>,
+  /**
+   * Sets the workers that may read the graph to copy it (the coordinator lists the copies).
+   */
+  'setPeers' : ActorMethod<[Array<Principal>], Result_6>,
+  /**
+   * Sets who may upload and commit a graph besides the controllers (not activate it).
+   */
+  'setUploaders' : ActorMethod<[Array<Principal>], Result_6>,
+  'uploadChunk' : ActorMethod<[UploadChunkArgs], Result_6>,
+}
+export declare const idlFactory: IDL.InterfaceFactory;
+export declare const init: (args: { IDL: typeof IDL }) => IDL.Type[];

package/declarations/map-routes-worker/map-routes-worker.did.js

@@ -0,0 +1,128 @@
+export const idlFactory = ({ IDL }) => {
+  const BufferState = IDL.Variant({
+    'Uploading' : IDL.Null,
+    'Active' : IDL.Null,
+    'Ready' : IDL.Null,
+  });
+  const BufferInfo = IDL.Record({
+    'sha256' : IDL.Text,
+    'size' : IDL.Nat64,
+    'startedAtNs' : IDL.Nat64,
+    'state' : BufferState,
+    'buffer' : IDL.Nat8,
+    'osmDate' : IDL.Text,
+  });
+  const Error = IDL.Variant({
+    'OutsideArea' : IDL.Text,
+    'OutsideBbox' : IDL.Text,
+    'NotReady' : IDL.Null,
+    'NotFound' : IDL.Null,
+    'NotAuthorized' : IDL.Text,
+    'PassExpired' : IDL.Null,
+    'NoRoute' : IDL.Null,
+    'InvalidData' : IDL.Text,
+    'PassMissing' : IDL.Null,
+    'PassInvalid' : IDL.Text,
+  });
+  const Result = IDL.Variant({ 'Ok' : BufferInfo, 'Err' : Error });
+  const BeginUploadArgs = IDL.Record({
+    'sha256' : IDL.Text,
+    'size' : IDL.Nat64,
+    'osmDate' : IDL.Text,
+  });
+  const CopyFromArgs = IDL.Record({ 'source' : IDL.Principal });
+  const Point = IDL.Record({ 'lat' : IDL.Float64, 'lon' : IDL.Float64 });
+  const DistanceArgs = IDL.Record({
+    'to' : Point,
+    'from' : Point,
+    'pass' : IDL.Opt(IDL.Vec(IDL.Nat8)),
+  });
+  const Distance = IDL.Record({
+    'meters' : IDL.Nat64,
+    'snapToMeters' : IDL.Nat32,
+    'seconds' : IDL.Nat64,
+    'instructions' : IDL.Nat64,
+    'graphSha256' : IDL.Text,
+    'osmDate' : IDL.Text,
+    'snapFromMeters' : IDL.Nat32,
+  });
+  const Result_1 = IDL.Variant({ 'Ok' : Distance, 'Err' : Error });
+  const CopyStatus = IDL.Record({
+    'sha256' : IDL.Text,
+    'source' : IDL.Principal,
+    'size' : IDL.Nat64,
+    'copied' : IDL.Nat64,
+  });
+  const PassStatus = IDL.Record({
+    'keyIds' : IDL.Vec(IDL.Nat32),
+    'area' : IDL.Opt(IDL.Text),
+    'required' : IDL.Bool,
+  });
+  const Status = IDL.Record({
+    'stableBytes' : IDL.Nat64,
+    'heapBytes' : IDL.Nat64,
+    'copy' : IDL.Opt(CopyStatus),
+    'pass' : IDL.Opt(PassStatus),
+    'uploaders' : IDL.Opt(IDL.Vec(IDL.Principal)),
+    'nodes' : IDL.Nat64,
+    'buffers' : IDL.Vec(BufferInfo),
+    'peers' : IDL.Opt(IDL.Vec(IDL.Principal)),
+  });
+  const Result_2 = IDL.Variant({ 'Ok' : Status, 'Err' : Error });
+  const ReadChunkArgs = IDL.Record({
+    'sha256' : IDL.Text,
+    'offset' : IDL.Nat64,
+    'length' : IDL.Nat32,
+  });
+  const Result_3 = IDL.Variant({ 'Ok' : IDL.Vec(IDL.Nat8), 'Err' : Error });
+  const RouteArgs = IDL.Record({
+    'line' : IDL.Bool,
+    'pass' : IDL.Opt(IDL.Vec(IDL.Nat8)),
+    'points' : IDL.Vec(Point),
+  });
+  const Leg = IDL.Record({
+    'meters' : IDL.Nat64,
+    'line' : IDL.Text,
+    'seconds' : IDL.Nat64,
+  });
+  const RouteAnswer = IDL.Record({
+    'snapMeters' : IDL.Vec(IDL.Nat32),
+    'legs' : IDL.Vec(Leg),
+    'instructions' : IDL.Nat64,
+    'graphSha256' : IDL.Text,
+    'osmDate' : IDL.Text,
+  });
+  const Result_4 = IDL.Variant({ 'Ok' : RouteAnswer, 'Err' : Error });
+  const PassKeyArgs = IDL.Record({
+    'id' : IDL.Nat32,
+    'key' : IDL.Vec(IDL.Nat8),
+    'validUntilNs' : IDL.Opt(IDL.Nat64),
+  });
+  const SetPassConfigArgs = IDL.Record({
+    'area' : IDL.Text,
+    'keys' : IDL.Vec(PassKeyArgs),
+    'required' : IDL.Bool,
+  });
+  const Result_5 = IDL.Variant({ 'Ok' : PassStatus, 'Err' : Error });
+  const Result_6 = IDL.Variant({ 'Ok' : IDL.Null, 'Err' : Error });
+  const UploadChunkArgs = IDL.Record({
+    'offset' : IDL.Nat64,
+    'bytes' : IDL.Vec(IDL.Nat8),
+  });
+  return IDL.Service({
+    'activate' : IDL.Func([], [Result], []),
+    'beginUpload' : IDL.Func([BeginUploadArgs], [Result], []),
+    'commitUpload' : IDL.Func([], [Result], []),
+    'copyFrom' : IDL.Func([CopyFromArgs], [Result], []),
+    'distance' : IDL.Func([DistanceArgs], [Result_1], ['query']),
+    'getStatus' : IDL.Func([], [Result_2], ['query']),
+    'graphInfo' : IDL.Func([], [Result], ['query']),
+    'readChunk' : IDL.Func([ReadChunkArgs], [Result_3], ['query']),
+    'route' : IDL.Func([RouteArgs], [Result_4], ['query']),
+    'setPassConfig' : IDL.Func([SetPassConfigArgs], [Result_5], []),
+    'setPeers' : IDL.Func([IDL.Vec(IDL.Principal)], [Result_6], []),
+    'setUploaders' : IDL.Func([IDL.Vec(IDL.Principal)], [Result_6], []),
+    'uploadChunk' : IDL.Func([UploadChunkArgs], [Result_6], []),
+  });
+};
+export const init = ({ IDL }) => { return []; };

package/dist/canister-actor.d.ts

@@ -0,0 +1,59 @@
+import { type ActorSubclass, type Identity } from "@icp-sdk/core/agent";
+import type { IDL } from "@icp-sdk/core/candid";
+export interface MapRoutesOptions {
+    /**
+     * The gateway or replica to talk to. Default: mainnet (`https://icp0.io`). Pass a local
+     * replica (`http://127.0.0.1:4943`) for runs that must not touch mainnet. For a local
+     * host — and only then — the agent fetches the replica's root key.
+     */
+    host?: string;
+}
+export declare const MAINNET_HOST = "https://icp0.io";
+/** True for a replica on this machine: localhost, *.localhost, 127.0.0.1 or [::1]. */
+export declare function isLocalHost(host: string): boolean;
+export declare function rawActorAsync<S>(idlFactory: IDL.InterfaceFactory, canisterId: string, options: MapRoutesOptions): Promise<ActorSubclass<S>>;
+export declare function signedActorAsync<S>(idlFactory: IDL.InterfaceFactory, canisterId: string, host: string, identity: Identity | undefined): Promise<ActorSubclass<S>>;
+/**
+ * A canister that is stopped or stopping — an upgrade of it runs — refuses every call with
+ * IC0508 / IC0509. The call did NOT run, so it is tried again: doubling pauses from
+ * `STOPPED_RETRY_FIRST_DELAY_MS`, at most `STOPPED_RETRY_MAX_FACTOR` times it, each 0.5–1.5
+ * of its length at random, `STOPPED_RETRY_ATTEMPTS` tries in all: about a minute — unless
+ * the time limit of the call ends first.
+ */
+export declare const STOPPED_RETRY_FIRST_DELAY_MS = 1000;
+export declare const STOPPED_RETRY_MAX_FACTOR = 8;
+export declare const STOPPED_RETRY_ATTEMPTS = 10;
+/** True for the refusal of a stopped or stopping canister. */
+export declare function isCanisterStoppedError(error: unknown): boolean;
+/** The wait before try `attempt + 1`: doubling, capped, 0.5–1.5 of it at random. */
+export declare function stoppedRetryDelayMs(attempt: number, firstDelayMs?: number): number;
+/** Tests shorten the waits. */
+export declare const retrySettings: {
+    stoppedFirstDelayMs: number;
+    stoppedAttempts: number;
+};
+export declare function waitOutStoppedAsync<T>(fnAsync: () => Promise<T>): Promise<T>;
+/** The error of a call that did not answer within its time limit. */
+export declare function timeoutError(timeoutMs: number): Error;
+export declare function isTimeoutError(error: unknown): boolean;
+/**
+ * The call, or `Timeout` after `timeoutMs` (none when undefined). The call itself goes on
+ * (a query cannot be called back); its late answer is dropped.
+ */
+export declare function withTimeoutAsync<T>(fnAsync: () => Promise<T>, timeoutMs: number | undefined): Promise<T>;
+export type RustResult<T> = {
+    Ok: T;
+} | {
+    Err: Record<string, unknown>;
+};
+/**
+ * `{ Ok: T }` resolves with `T`; `{ Err }` is thrown as `Error("CanisterError", { cause:
+ * { errorKey, errorMessage } })` with the variant's name as the errorKey (`OutsideArea`,
+ * `NoRoute`, `NotReady`, `InvalidData`); any transport failure as
+ * `Error("CriticalCanisterError", { cause: { rawError } })`. A stopped canister is waited
+ * out first.
+ */
+export declare function executeRustAsyncUnsafe<T>(fnAsync: () => Promise<RustResult<T>>): Promise<T>;
+/** The errorKey of a `CanisterError`, or undefined for any other error. */
+export declare function errorKeyOf(error: unknown): string | undefined;
+//# sourceMappingURL=canister-actor.d.ts.map

package/dist/canister-actor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"canister-actor.d.ts","sourceRoot":"","sources":["../src/canister-actor.ts"],"names":[],"mappings":"AAIA,OAAO,EAAS,KAAK,aAAa,EAAa,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC1F,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,sBAAsB,CAAC;AAEhD,MAAM,WAAW,gBAAgB;IAC7B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,eAAO,MAAM,YAAY,oBAAoB,CAAC;AAE9C,sFAAsF;AACtF,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAUjD;AAiBD,wBAAsB,aAAa,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,gBAAgB,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAKjJ;AAKD,wBAAsB,gBAAgB,CAAC,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,gBAAgB,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAgBvK;AAID;;;;;;GAMG;AACH,eAAO,MAAM,4BAA4B,OAAO,CAAC;AACjD,eAAO,MAAM,wBAAwB,IAAI,CAAC;AAC1C,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAKzC,8DAA8D;AAC9D,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAW9D;AAED,oFAAoF;AACpF,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,GAAE,MAAqC,GAAG,MAAM,CAGhH;AAED,+BAA+B;AAC/B,eAAO,MAAM,aAAa;;;CAGzB,CAAC;AAEF,wBAAsB,mBAAmB,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAUlF;AAID,qEAAqE;AACrE,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAErD;AAED,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEtD;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAa9G;AAID,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IAAE,EAAE,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAAC;AAEzE;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAYjG;AAED,2EAA2E;AAC3E,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAG7D"}