@cratis/fundamentals 7.22.4 → 7.22.5

package/for_DateOnly/when_parsing_february_in_leap_and_common_years.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { DateOnly } from '../DateOnly';
+
+describe('when parsing february in leap and common years', () => {
+    it('should accept the 29th in a leap year', () => DateOnly.parse('2024-02-29').day.should.equal(29));
+    it('should accept the 29th in a year divisible by 400', () => DateOnly.parse('2000-02-29').day.should.equal(29));
+    it('should reject the 29th in a common year', () => (() => DateOnly.parse('2023-02-29')).should.throw('day 29 is out of range'));
+    it('should reject the 29th in a century year not divisible by 400', () => (() => DateOnly.parse('1900-02-29')).should.throw('day 29 is out of range'));
+});

package/for_JsonSerializer/when_deserializing_a_value_map_with_out_of_range_temporal_keys.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { DateOnly } from '../DateOnly';
+import { TimeOnly } from '../TimeOnly';
+import { TimeSpan } from '../TimeSpan';
+import { JsonSerializer } from '../JsonSerializer';
+import { ValueMap } from '../ValueMap';
+import { field } from '../fieldDecorator';
+
+class Dates { @field(ValueMap, { genericArguments: [DateOnly, Number] }) byKey!: ValueMap<DateOnly, number>; }
+class Times { @field(ValueMap, { genericArguments: [TimeOnly, Number] }) byKey!: ValueMap<TimeOnly, number>; }
+class Spans { @field(ValueMap, { genericArguments: [TimeSpan, Number] }) byKey!: ValueMap<TimeSpan, number>; }
+
+describe('when deserializing a value map with out of range temporal keys', () => {
+    it('should reject a DateOnly key', () => (() => JsonSerializer.deserialize(Dates, '{"byKey":{"2024-13-45":1}}')).should.throw('not a valid DateOnly'));
+    it('should reject a TimeOnly key', () => (() => JsonSerializer.deserialize(Times, '{"byKey":{"25:99:00":1}}')).should.throw('not a valid TimeOnly'));
+    it('should reject a TimeSpan key', () => (() => JsonSerializer.deserialize(Spans, '{"byKey":{"00:60:00":1}}')).should.throw('not a valid TimeSpan'));
+});

package/for_JsonSerializer/when_deserializing_out_of_range_temporal_values.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { DateOnly } from '../DateOnly';
+import { TimeOnly } from '../TimeOnly';
+import { TimeSpan } from '../TimeSpan';
+import { JsonSerializer } from '../JsonSerializer';
+import { field } from '../fieldDecorator';
+
+class Holder {
+    @field(DateOnly) date!: DateOnly;
+    @field(TimeOnly) time!: TimeOnly;
+    @field(TimeSpan) span!: TimeSpan;
+}
+
+describe('when deserializing out of range temporal values', () => {
+    it('should reject a DateOnly value', () => (() => JsonSerializer.deserialize(Holder, '{"date":"2024-13-45"}')).should.throw('Invalid DateOnly'));
+    it('should reject a TimeOnly value', () => (() => JsonSerializer.deserialize(Holder, '{"time":"25:99:00"}')).should.throw('Invalid TimeOnly'));
+    it('should reject a TimeSpan value', () => (() => JsonSerializer.deserialize(Holder, '{"span":"00:60:00"}')).should.throw('Invalid TimeSpan'));
+});

package/for_JsonSerializer/when_round_tripping_a_value_map_with_time_only_keys_differing_below_a_millisecond.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeOnly } from '../TimeOnly';
+import { JsonSerializer } from '../JsonSerializer';
+import { ValueMap } from '../ValueMap';
+import { field } from '../fieldDecorator';
+
+class Totals {
+    @field(ValueMap, { genericArguments: [TimeOnly, Number] })
+    byKey!: ValueMap<TimeOnly, number>;
+}
+
+describe('when round tripping a value map with time only keys differing below a millisecond', () => {
+    const result = JsonSerializer.deserialize(Totals, '{"byKey":{"10:11:12.1234567":1,"10:11:12.1239999":2}}');
+
+    it('should keep both entries', () => [...result.byKey.entries()].length.should.equal(2));
+    it('should find the first value', () => result.byKey.get(TimeOnly.parse('10:11:12.1234567'))!.should.equal(1));
+    it('should find the second value', () => result.byKey.get(TimeOnly.parse('10:11:12.1239999'))!.should.equal(2));
+});

package/for_TimeOnly/when_creating_with_out_of_range_sub_millisecond_ticks.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeOnly } from '../TimeOnly';
+
+describe('when creating with out of range sub millisecond ticks', () => {
+    it('should reject ticks above 9999', () => (() => TimeOnly.from(1, 2, 3, 4, 10000)).should.throw('subMillisecondTicks 10000 is out of range'));
+    it('should reject negative ticks', () => (() => TimeOnly.from(1, 2, 3, 4, -1)).should.throw('subMillisecondTicks -1 is out of range'));
+    it('should reject fractional ticks', () => (() => TimeOnly.from(1, 2, 3, 4, 1.5)).should.throw('out of range'));
+    it('should accept the largest value', () => TimeOnly.from(1, 2, 3, 4, 9999).subMillisecondTicks.should.equal(9999));
+});

package/for_TimeOnly/when_parsing_an_out_of_range_time_of_day.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeOnly } from '../TimeOnly';
+
+describe('when parsing an out of range time of day', () => {
+    it('should reject an hour above 23', () => (() => TimeOnly.parse('24:00:00')).should.throw('hour 24 is out of range'));
+    it('should reject a minute above 59', () => (() => TimeOnly.parse('10:60:00')).should.throw('minute 60 is out of range'));
+    it('should reject a second above 59', () => (() => TimeOnly.parse('10:00:60')).should.throw('second 60 is out of range'));
+    it('should reject every component out of range', () => (() => TimeOnly.parse('25:99:00')).should.throw('Invalid TimeOnly'));
+});

package/for_TimeOnly/when_parsing_the_last_moment_of_the_day.ts

@@ -0,0 +1,10 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeOnly } from '../TimeOnly';
+
+describe('when parsing the last moment of the day', () => {
+    const parsed = TimeOnly.parse('23:59:59.9999999');
+
+    it('should keep the full fraction', () => parsed.toString().should.equal('23:59:59.9999999'));
+});

package/for_TimeOnly/when_parsing_the_shapes_the_server_sends.ts

@@ -4,9 +4,9 @@
 import { TimeOnly } from '../TimeOnly';
 
 /**
- * The server omits the seconds and the fraction when they are zero, and writes up to seven fractional digits where
- * JavaScript holds three. Every one of those shapes has to parse, and a value has to survive a parse followed by a
- * render without moving.
+ * The server omits the seconds and the fraction when they are zero, and writes up to seven fractional digits.
+ * Every one of those shapes has to parse, and a value has to survive a parse followed by a render without
+ * moving.
  */
 describe('when parsing the shapes the server sends', () => {
     const withoutSeconds = TimeOnly.parse('14:30');
@@ -16,9 +16,9 @@ describe('when parsing the shapes the server sends', () => {
     it('should default the seconds when they are omitted', () => withoutSeconds.second.should.equal(0));
     it('should render omitted seconds explicitly', () => withoutSeconds.toString().should.equal('14:30:00'));
 
-    // Truncated rather than rounded, so a parse followed by a render never moves the value forward.
-    it('should truncate the fraction to milliseconds', () => withFraction.millisecond.should.equal(123));
-    it('should render the fraction it kept', () => withFraction.toString().should.equal('14:30:45.123'));
+    it('should keep the milliseconds of the fraction', () => withFraction.millisecond.should.equal(123));
+    it('should keep the ticks below the millisecond', () => withFraction.subMillisecondTicks.should.equal(4567));
+    it('should render the full fraction', () => withFraction.toString().should.equal('14:30:45.1234567'));
 
     it('should parse midnight', () => midnight.toString().should.equal('00:00:00'));
 });

package/for_TimeOnly/when_parsing_times_that_differ_below_a_millisecond.ts

@@ -0,0 +1,14 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeOnly } from '../TimeOnly';
+
+describe('when parsing times that differ below a millisecond', () => {
+    const first = TimeOnly.parse('10:11:12.1234567');
+    const second = TimeOnly.parse('10:11:12.1239999');
+
+    it('should not be equal', () => first.equals(second).should.be.false);
+    it('should render the full seven digit fraction', () => first.toString().should.equal('10:11:12.1234567'));
+    it('should render differently', () => first.toJSON().should.not.equal(second.toJSON()));
+    it('should be equal to the same time written with trailing zeros', () => TimeOnly.parse('10:11:12.1230000').equals(TimeOnly.parse('10:11:12.123')).should.be.true);
+});

package/for_TimeOnly/when_rendering_a_fraction.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeOnly } from '../TimeOnly';
+
+describe('when rendering a fraction', () => {
+    it('should keep the three digit form when there is no part below the millisecond', () => TimeOnly.parse('10:11:12.1').toString().should.equal('10:11:12.100'));
+    it('should pad to seven digits when there is a part below the millisecond', () => TimeOnly.parse('10:11:12.1230100').toString().should.equal('10:11:12.1230100'));
+    it('should pad a short part below the millisecond', () => TimeOnly.parse('10:11:12.0000001').toString().should.equal('10:11:12.0000001'));
+    it('should render the time alone when there is no fraction', () => TimeOnly.parse('10:11:12').toString().should.equal('10:11:12'));
+});

package/for_TimeSpan/when_parsing_out_of_range_time.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeSpan } from '../TimeSpan';
+
+describe('when parsing out of range time', () => {
+    it('should reject minutes above 59', () => (() => TimeSpan.parse('00:60:00')).should.throw('minutes 60 is out of range'));
+    it('should reject seconds above 59', () => (() => TimeSpan.parse('00:00:60')).should.throw('seconds 60 is out of range'));
+    it('should reject hours above 23', () => (() => TimeSpan.parse('1.24:00:00')).should.throw('hours 24 is out of range'));
+    it('should reject hours above 23 without days', () => (() => TimeSpan.parse('25:00:00')).should.throw('hours 25 is out of range'));
+});

package/for_TimeSpan/when_parsing_the_largest_in_range_time_span.ts

@@ -0,0 +1,10 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeSpan } from '../TimeSpan';
+
+describe('when parsing the largest in range time span', () => {
+    const parsed = TimeSpan.parse('1.23:59:59');
+
+    it('should render back to what it was parsed from', () => parsed.toString().should.equal('1.23:59:59'));
+});

package/for_TimeSpan/when_parsing_time_beyond_what_a_time_span_can_hold.ts

@@ -0,0 +1,11 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+import { TimeSpan } from '../TimeSpan';
+
+describe('when parsing time beyond what a time span can hold', () => {
+    it('should reject more days than the maximum', () => (() => TimeSpan.parse('10675200.00:00:00')).should.throw('days 10675200 is out of range'));
+    it('should reject the maximum days with a remainder above the maximum', () => (() => TimeSpan.parse('10675199.02:48:05.4775808')).should.throw('outside the range'));
+    it('should accept the maximum value', () => TimeSpan.parse('10675199.02:48:05.4775807').days.should.equal(10675199));
+    it('should accept the minimum value', () => TimeSpan.parse('-10675199.02:48:05.4775808').days.should.equal(-10675199));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cratis/fundamentals",
-    "version": "7.22.4",
+    "version": "7.22.5",
     "description": "The shared building blocks beneath the Cratis stack — GUIDs, concepts, derived-type serialization, property-path proxies, and decorators for TypeScript",
     "keywords": [
         "cratis",