@agoric/time 0.3.3-dev-2dc53d7.0 → 0.3.3-dev-0f94e34.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/time",
-  "version": "0.3.3-dev-2dc53d7.0+2dc53d7",
+  "version": "0.3.3-dev-0f94e34.0+0f94e34",
   "description": "Timestamps, time math, timer service API definition",
   "type": "module",
   "main": "index.js",
@@ -31,7 +31,7 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-2dc53d7.0+2dc53d7",
+    "@agoric/assert": "0.6.1-dev-0f94e34.0+0f94e34",
     "@endo/nat": "^5.0.7",
     "@endo/patterns": "^1.4.0"
   },
@@ -58,7 +58,7 @@
     "access": "public"
   },
   "typeCoverage": {
-    "atLeast": 87.11
+    "atLeast": 87.29
   },
-  "gitHead": "2dc53d7552650c5d46319d0cd5341eeec275663a"
+  "gitHead": "0f94e34eb539b8f91c82d0877df836738e58cc69"
 }

package/src/timeMath.js

@@ -2,14 +2,16 @@ import { Nat } from '@endo/nat';
 import { mustMatch } from '@endo/patterns';
 import { RelativeTimeRecordShape, TimestampRecordShape } from './typeGuards.js';
 
+/** @import {RelativeTime, RelativeTimeValue, TimerBrand, TimeMathType, Timestamp, TimestampRecord, TimestampValue} from './types.js' */
+
 const { Fail, quote: q } = assert;
 
 /**
  * `agreedTimerBrand` is internal to this module.
  *
- * @param {import('./types').TimerBrand | undefined} leftBrand
- * @param {import('./types').TimerBrand | undefined} rightBrand
- * @returns {import('./types').TimerBrand | undefined}
+ * @param {TimerBrand | undefined} leftBrand
+ * @param {TimerBrand | undefined} rightBrand
+ * @returns {TimerBrand | undefined}
  */
 const agreedTimerBrand = (leftBrand, rightBrand) => {
   if (leftBrand === undefined) {
@@ -34,9 +36,9 @@ const agreedTimerBrand = (leftBrand, rightBrand) => {
  * this logic. It does the error checking between the operands, and returns
  * the brand, if any, that should label the resulting time value.
  *
- * @param {import('./types').Timestamp | import('./types').RelativeTime} left
- * @param {import('./types').Timestamp | import('./types').RelativeTime} right
- * @returns {import('./types').TimerBrand | undefined}
+ * @param {Timestamp | RelativeTime} left
+ * @param {Timestamp | RelativeTime} right
+ * @returns {TimerBrand | undefined}
  */
 const sharedTimerBrand = (left, right) => {
   const leftBrand = typeof left === 'bigint' ? undefined : left.timerBrand;
@@ -49,10 +51,10 @@ const sharedTimerBrand = (left, right) => {
  * operators in the case where the returned time should be a `Timestamp`
  * rather than a `RelativeTime`.
  *
- * @param {import('./types').Timestamp | import('./types').RelativeTime} left
- * @param {import('./types').Timestamp | import('./types').RelativeTime} right
- * @param {import('./types').TimestampValue} absValue
- * @returns {import('./types').Timestamp}
+ * @param {Timestamp | RelativeTime} left
+ * @param {Timestamp | RelativeTime} right
+ * @param {TimestampValue} absValue
+ * @returns {Timestamp}
  */
 const absLike = (left, right, absValue) => {
   Nat(absValue);
@@ -72,10 +74,10 @@ const absLike = (left, right, absValue) => {
  * operators in the case where the returned time should be a `RelativeTime`
  * rather than a `Timestamp`.
  *
- * @param {import('./types').Timestamp | import('./types').RelativeTime} left
- * @param {import('./types').Timestamp | import('./types').RelativeTime} right
- * @param {import('./types').RelativeTimeValue} relValue
- * @returns {import('./types').RelativeTime}
+ * @param {Timestamp | RelativeTime} left
+ * @param {Timestamp | RelativeTime} right
+ * @param {RelativeTimeValue} relValue
+ * @returns {RelativeTime}
  */
 const relLike = (left, right, relValue) => {
   Nat(relValue);
@@ -187,8 +189,8 @@ const modRelRel = (rel, step) =>
  * `compareValues` is internal to this module, and used to implement
  * the time comparison operators.
  *
- * @param {import('./types').Timestamp | import('./types').RelativeTime} left
- * @param {import('./types').Timestamp | import('./types').RelativeTime} right
+ * @param {Timestamp | RelativeTime} left
+ * @param {Timestamp | RelativeTime} right
  * @param {bigint} v1
  * @param {bigint} v2
  * @returns {import('@endo/marshal').RankComparison}
@@ -237,14 +239,16 @@ const compareValues = (left, right, v1, v2) => {
  * operand, and return a labeled time object with the brand of the labeled
  * operand.
  *
- * @type {import('./types').TimeMathType}
+ * @type {TimeMathType}
  */
 export const TimeMath = harden({
   absValue,
   relValue,
   coerceTimestampRecord,
   coerceRelativeTimeRecord,
+  // @ts-expect-error xxx dynamic typing
   addAbsRel,
+  // @ts-expect-error xxx dynamic typing
   addRelRel,
   subtractAbsAbs,
   clampedSubtractAbsAbs,

package/src/types.d.ts

@@ -2,7 +2,7 @@ import type { ERef, RemotableBrand } from '@endo/eventual-send';
 
 import type { RankComparison, RemotableObject } from '@endo/marshal';
 
-/// <reference types="@agoric/notifier/src/types.js"/>
+/// <reference types="@agoric/notifier/src/types.js" />
 
 // These aren't in the global runtime environment. They are just types that are
 // meant to be globally accessible as a side-effect of importing this module.
@@ -167,7 +167,7 @@ export interface TimerServiceI {
     delay: RelativeTime,
     interval: RelativeTime,
     cancelToken?: CancelToken,
-  ) => Notifier<TimestampRecord>;
+  ) => import('@agoric/notifier').Notifier<TimestampRecord>;
   /**
    * Cancel a previously-established wakeup or repeater.
    */
@@ -290,17 +290,19 @@ export type TimeMathType = {
   ) => RelativeTimeRecord;
   /**
    * An absolute time + a relative time gives a new absolute time.
-   *
-   * @template {Timestamp} T
    */
-  addAbsRel: (abs: T, rel: RelativeTime) => T;
+  addAbsRel: <T extends Timestamp>(
+    abs: T,
+    rel: RelativeTime,
+  ) => T extends TimestampRecord ? TimestampRecord : TimestampValue;
   /**
    * A relative time (i.e., a duration) + another relative time
    * gives a new relative time.
-   *
-   * @template {RelativeTime} T
    */
-  addRelRel: (rel1: T, rel2: T) => T;
+  addRelRel: <T extends RelativeTime>(
+    rel1: T,
+    rel2: T,
+  ) => T extends RelativeTimeRecord ? RelativeTimeRecord : RelativeTimeValue;
   /**
    * The difference between two absolute times is a relative time. If abs1 > abs2
    * the difference would be negative, so this method throws instead.