@temporalio/common 1.10.2 → 1.10.3

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.
package/lib/time.d.ts CHANGED
@@ -11,6 +11,11 @@ export type { StringValue } from 'ms';
11
11
  * If ts is null or undefined returns undefined.
12
12
  */
13
13
  export declare function optionalTsToMs(ts: Timestamp | null | undefined): number | undefined;
14
+ /**
15
+ * Lossy conversion function from Timestamp to number due to possible overflow.
16
+ * If ts is null or undefined, throws a TypeError, with error message including the name of the field.
17
+ */
18
+ export declare function requiredTsToMs(ts: Timestamp | null | undefined, fieldName: string): number;
14
19
  /**
15
20
  * Lossy conversion function from Timestamp to number due to possible overflow
16
21
  */
@@ -21,5 +26,6 @@ export declare function msOptionalToTs(str: Duration | undefined): Timestamp | u
21
26
  export declare function msOptionalToNumber(val: Duration | undefined): number | undefined;
22
27
  export declare function msToNumber(val: Duration): number;
23
28
  export declare function tsToDate(ts: Timestamp): Date;
29
+ export declare function requiredTsToDate(ts: Timestamp | null | undefined, fieldName: string): Date;
24
30
  export declare function optionalTsToDate(ts: Timestamp | null | undefined): Date | undefined;
25
31
  export declare function optionalDateToTs(date: Date | null | undefined): Timestamp | undefined;
package/lib/time.js CHANGED
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.optionalDateToTs = exports.optionalTsToDate = exports.tsToDate = exports.msToNumber = exports.msOptionalToNumber = exports.msOptionalToTs = exports.msToTs = exports.msNumberToTs = exports.tsToMs = exports.optionalTsToMs = void 0;
6
+ exports.optionalDateToTs = exports.optionalTsToDate = exports.requiredTsToDate = exports.tsToDate = exports.msToNumber = exports.msOptionalToNumber = exports.msOptionalToTs = exports.msToTs = exports.msNumberToTs = exports.tsToMs = exports.requiredTsToMs = exports.optionalTsToMs = void 0;
7
7
  const long_1 = __importDefault(require("long")); // eslint-disable-line import/no-named-as-default
8
8
  const ms_1 = __importDefault(require("ms"));
9
9
  const errors_1 = require("./errors");
@@ -18,6 +18,17 @@ function optionalTsToMs(ts) {
18
18
  return tsToMs(ts);
19
19
  }
20
20
  exports.optionalTsToMs = optionalTsToMs;
21
+ /**
22
+ * Lossy conversion function from Timestamp to number due to possible overflow.
23
+ * If ts is null or undefined, throws a TypeError, with error message including the name of the field.
24
+ */
25
+ function requiredTsToMs(ts, fieldName) {
26
+ if (ts === undefined || ts === null) {
27
+ throw new TypeError(`Expected ${fieldName} to be a timestamp, got ${ts}`);
28
+ }
29
+ return tsToMs(ts);
30
+ }
31
+ exports.requiredTsToMs = requiredTsToMs;
21
32
  /**
22
33
  * Lossy conversion function from Timestamp to number due to possible overflow
23
34
  */
@@ -73,6 +84,11 @@ function tsToDate(ts) {
73
84
  return new Date(tsToMs(ts));
74
85
  }
75
86
  exports.tsToDate = tsToDate;
87
+ // ts-prune-ignore-next
88
+ function requiredTsToDate(ts, fieldName) {
89
+ return new Date(requiredTsToMs(ts, fieldName));
90
+ }
91
+ exports.requiredTsToDate = requiredTsToDate;
76
92
  function optionalTsToDate(ts) {
77
93
  if (ts === undefined || ts === null) {
78
94
  return undefined;
package/lib/time.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"time.js","sourceRoot":"","sources":["../src/time.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB,CAAC,iDAAiD;AAC1E,4CAAqC;AAErC,qCAAsC;AAgBtC;;;GAGG;AACH,SAAgB,cAAc,CAAC,EAAgC;IAC7D,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACpC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;AACpB,CAAC;AALD,wCAKC;AAED;;GAEG;AACH,SAAgB,MAAM,CAAC,EAAgC;IACrD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAC9B,OAAO,CAAC,OAAO,IAAI,cAAI,CAAC,KAAK,CAAC;SAC3B,GAAG,CAAC,IAAI,CAAC;SACT,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;SACvC,QAAQ,EAAE,CAAC;AAChB,CAAC;AATD,wBASC;AAED,SAAgB,YAAY,CAAC,MAAc;IACzC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC;IACxC,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,mBAAU,CAAC,kBAAkB,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,cAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC;AACtD,CAAC;AAPD,oCAOC;AAED,SAAgB,MAAM,CAAC,GAAa;IAClC,OAAO,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACvC,CAAC;AAFD,wBAEC;AAED,SAAgB,cAAc,CAAC,GAAyB;IACtD,OAAO,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACvC,CAAC;AAFD,wCAEC;AAED,SAAgB,kBAAkB,CAAC,GAAyB;IAC1D,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAHD,gDAGC;AAED,SAAgB,UAAU,CAAC,GAAa;IACtC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC;AALD,gCAKC;AAED,SAAS,gBAAgB,CAAC,GAAgB;IACxC,MAAM,MAAM,GAAG,IAAA,YAAE,EAAC,GAAG,CAAC,CAAC;IACvB,IAAI,MAAM,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,SAAS,CAAC,6BAA6B,GAAG,GAAG,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,QAAQ,CAAC,EAAa;IACpC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC;AAFD,4BAEC;AAED,SAAgB,gBAAgB,CAAC,EAAgC;IAC/D,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACpC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC;AALD,4CAKC;AAED,0DAA0D;AAC1D,SAAgB,gBAAgB,CAAC,IAA6B;IAC5D,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AAChC,CAAC;AALD,4CAKC"}
1
+ {"version":3,"file":"time.js","sourceRoot":"","sources":["../src/time.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB,CAAC,iDAAiD;AAC1E,4CAAqC;AAErC,qCAAsC;AAgBtC;;;GAGG;AACH,SAAgB,cAAc,CAAC,EAAgC;IAC7D,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACpC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;AACpB,CAAC;AALD,wCAKC;AAED;;;GAGG;AACH,SAAgB,cAAc,CAAC,EAAgC,EAAE,SAAiB;IAChF,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACpC,MAAM,IAAI,SAAS,CAAC,YAAY,SAAS,2BAA2B,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IACD,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;AACpB,CAAC;AALD,wCAKC;AAED;;GAEG;AACH,SAAgB,MAAM,CAAC,EAAgC;IACrD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;IAC9B,OAAO,CAAC,OAAO,IAAI,cAAI,CAAC,KAAK,CAAC;SAC3B,GAAG,CAAC,IAAI,CAAC;SACT,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;SACvC,QAAQ,EAAE,CAAC;AAChB,CAAC;AATD,wBASC;AAED,SAAgB,YAAY,CAAC,MAAc;IACzC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC;IACxC,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,mBAAU,CAAC,kBAAkB,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,cAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC;AACtD,CAAC;AAPD,oCAOC;AAED,SAAgB,MAAM,CAAC,GAAa;IAClC,OAAO,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACvC,CAAC;AAFD,wBAEC;AAED,SAAgB,cAAc,CAAC,GAAyB;IACtD,OAAO,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACvC,CAAC;AAFD,wCAEC;AAED,SAAgB,kBAAkB,CAAC,GAAyB;IAC1D,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAHD,gDAGC;AAED,SAAgB,UAAU,CAAC,GAAa;IACtC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC;AALD,gCAKC;AAED,SAAS,gBAAgB,CAAC,GAAgB;IACxC,MAAM,MAAM,GAAG,IAAA,YAAE,EAAC,GAAG,CAAC,CAAC;IACvB,IAAI,MAAM,IAAI,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,SAAS,CAAC,6BAA6B,GAAG,GAAG,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,QAAQ,CAAC,EAAa;IACpC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC;AAFD,4BAEC;AAED,uBAAuB;AACvB,SAAgB,gBAAgB,CAAC,EAAgC,EAAE,SAAiB;IAClF,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;AACjD,CAAC;AAFD,4CAEC;AAED,SAAgB,gBAAgB,CAAC,EAAgC;IAC/D,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACpC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AAC9B,CAAC;AALD,4CAKC;AAED,0DAA0D;AAC1D,SAAgB,gBAAgB,CAAC,IAA6B;IAC5D,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AAChC,CAAC;AALD,4CAKC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@temporalio/common",
3
- "version": "1.10.2",
3
+ "version": "1.10.3",
4
4
  "description": "Common library for code that's used across the Client, Worker, and/or Workflow",
5
5
  "main": "lib/index.js",
6
6
  "types": "./lib/index.d.ts",
@@ -12,7 +12,7 @@
12
12
  "author": "Temporal Technologies Inc. <sdk@temporal.io>",
13
13
  "license": "MIT",
14
14
  "dependencies": {
15
- "@temporalio/proto": "1.10.2",
15
+ "@temporalio/proto": "1.10.3",
16
16
  "long": "^5.2.3",
17
17
  "ms": "^3.0.0-canary.1",
18
18
  "proto3-json-serializer": "^2.0.0"
@@ -36,5 +36,5 @@
36
36
  "src",
37
37
  "lib"
38
38
  ],
39
- "gitHead": "a44bdfa780c1247fe7ed82b4b73c7b1577ee94af"
39
+ "gitHead": "7832067434443145e1f0ddf07cb37b0b90158bfb"
40
40
  }
package/src/time.ts CHANGED
@@ -28,6 +28,17 @@ export function optionalTsToMs(ts: Timestamp | null | undefined): number | undef
28
28
  return tsToMs(ts);
29
29
  }
30
30
 
31
+ /**
32
+ * Lossy conversion function from Timestamp to number due to possible overflow.
33
+ * If ts is null or undefined, throws a TypeError, with error message including the name of the field.
34
+ */
35
+ export function requiredTsToMs(ts: Timestamp | null | undefined, fieldName: string): number {
36
+ if (ts === undefined || ts === null) {
37
+ throw new TypeError(`Expected ${fieldName} to be a timestamp, got ${ts}`);
38
+ }
39
+ return tsToMs(ts);
40
+ }
41
+
31
42
  /**
32
43
  * Lossy conversion function from Timestamp to number due to possible overflow
33
44
  */
@@ -83,6 +94,11 @@ export function tsToDate(ts: Timestamp): Date {
83
94
  return new Date(tsToMs(ts));
84
95
  }
85
96
 
97
+ // ts-prune-ignore-next
98
+ export function requiredTsToDate(ts: Timestamp | null | undefined, fieldName: string): Date {
99
+ return new Date(requiredTsToMs(ts, fieldName));
100
+ }
101
+
86
102
  export function optionalTsToDate(ts: Timestamp | null | undefined): Date | undefined {
87
103
  if (ts === undefined || ts === null) {
88
104
  return undefined;