Correcting casing of fdc3.timeRange throughout as it appears incorrec…

…tly as fdc3.timerange in a number of places
finos · Jul 4, 2024 · a9a39de · a9a39de
1 parent db2a227
commit a9a39de
Show file tree

Hide file tree

Showing 21 changed files with 26 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,8 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Fixed
 
-* Corrected inconsistent camel-casing of the `fdc3.timeRange` context type which appeared as `fdc3.timerange` in a number of places. ([#1240][https://github.com/finos/FDC3/pull/1240])
-* Corrected an error in the `fdc3.TransactionResult` schema which resulted in the `message` property being omitted from the generated TypeScript types for it. ([#1251][https://github.com/finos/FDC3/pull/1251])
+* Corrected inconsistent camel-casing of the `fdc3.timeRange` context type which appeared as `fdc3.timerange` in a number of places. ([#1240](https://github.com/finos/FDC3/pull/1240))
+* Corrected an error in the `fdc3.TransactionResult` schema which resulted in the `message` property being omitted from the generated TypeScript types for it. ([#1251](https://github.com/finos/FDC3/pull/1251))
 
 ## [FDC3 Standard 2.1](https://github.com/finos/FDC3/compare/v2.0..v2.1) - 2023-09-13
 
@@ -95,7 +95,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added a recommended set of user channel definitions to the API docs and typescript sources ([#727](https://github.com/finos/FDC3/pull/727))
 * Added the optional exposure of originating app metadata to messages received via `addContextListener` and `addIntentListener` via the new `ContextMetadata` type. ([#725](https://github.com/finos/FDC3/pull/725))
 * Added the current app's `AppMetadata` to the `ImplementationMetadata` returned by `fdc3.getInfo()` allowing an app to retrieve its own metadata, according to the Desktop Agent ([#726](https://github.com/finos/FDC3/pull/726))
-* Added a context type representing a range of time (`fdc3.timerange`). ([#706](https://github.com/finos/FDC3/pull/706))
+* Added a context type representing a range of time (`fdc3.timeRange`). ([#706](https://github.com/finos/FDC3/pull/706))
 * Added a context type representing a Currency (`fdc3.currency`). ([#708](https://github.com/finos/FDC3/pull/708))
 * Added a context type representing the price and value of a holding (`fdc3.valuation`). ([#709](https://github.com/finos/FDC3/pull/709))
 * Added a context type representing a Chart (`fdc3.chart`). ([#715](https://github.com/finos/FDC3/pull/715))

diff --git a/docs/context/ref/Chart.md b/docs/context/ref/Chart.md
@@ -29,7 +29,7 @@ In addition to handling requests to plot charts, a charting application may use
 |------------------|-----------------|----------|----------------------|
 | `type`           | string          | Yes      | `'fdc3.chart'`     |
 | `instruments`    | Instrument[]  | Yes      | <pre>[<br/>&emsp;&emsp;{<br/>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br/>&emsp;&emsp;&emsp;&emsp;"id": {<br/>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "AAPL"<br/>&emsp;&emsp;&emsp;&emsp;}<br/>&emsp;&emsp;},<br/>&emsp;&emsp;{<br/>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br/>&emsp;&emsp;&emsp;&emsp;"id": {<br/>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "MSFT"<br/>&emsp;&emsp;&emsp;&emsp;}<br/>&emsp;&emsp;}<br/>]</pre> |
-| `range` | TimeRange  | No       | <pre>{<br/>&emsp;&emsp;"type": "fdc3.timerange",<br/>&emsp;&emsp;"startTime": "2022-03-30T15:44:44+00:00",<br/>&emsp;&emsp;"endTime": "2022-04-30T23:59:59+00:00"<br/>}</pre>            |
+| `range` | TimeRange  | No       | <pre>{<br/>&emsp;&emsp;"type": "fdc3.timeRange",<br/>&emsp;&emsp;"startTime": "2022-03-30T15:44:44+00:00",<br/>&emsp;&emsp;"endTime": "2022-04-30T23:59:59+00:00"<br/>}</pre>            |
 | `style`    | string  | No       | one of: `'line'`, `'bar'`, `'stacked-bar'`, `'mountain'`, `'candle'`, `'pie'`, `'scatter'`, `'histogram'`, `'heatmap'`, `'custom'`      |
 | `otherConfig`* | array  | No |  `[ {/* additional config context objects */} ]`  |
 

diff --git a/docs/context/ref/TimeRange.md b/docs/context/ref/TimeRange.md
@@ -29,7 +29,7 @@ Notes:
 
 ## Type
 
-`fdc3.timerange`
+`fdc3.timeRange`
 
 ## Schema
 

diff --git a/docs/context/spec.md b/docs/context/spec.md
@@ -220,7 +220,7 @@ The following are standard FDC3 context types:
 - [`fdc3.portfolio`](ref/Portfolio) ([schema](/schemas/next/context/portfolio.schema.json))
 - [`fdc3.position`](ref/Position) ([schema](/schemas/next/context/position.schema.json))
 - [`fdc3.nothing`](ref/Nothing) ([schema](/schemas/next/context/nothing.schema.json))
-- [`fdc3.timerange`](ref/TimeRange) ([schema](/schemas/next/context/timerange.schema.json))
+- [`fdc3.timeRange`](ref/TimeRange) ([schema](/schemas/next/context/timerange.schema.json))
 - [`fdc3.transactionResult`](ref/TransactionResult) ([schema](/schemas/next/context/transactionresult.schema.json))
 - [`fdc3.valuation`](ref/Valuation) ([schema](/schemas/next/context/valuation.schema.json))
 

diff --git a/schemas/context/timerange.schema.json b/schemas/context/timerange.schema.json
@@ -8,7 +8,7 @@
     {
       "properties": {
         "type": {
-          "const": "fdc3.timerange"
+          "const": "fdc3.timeRange"
         },
         "startTime": {
           "type": "string",

diff --git a/src/context/ContextType.ts b/src/context/ContextType.ts
@@ -26,7 +26,7 @@ export type StandardContextType =
   | 'fdc3.portfolio'
   | 'fdc3.position'
   | 'fdc3.nothing'
-  | 'fdc3.timerange'
+  | 'fdc3.timeRange'
   | 'fdc3.transactionResult'
   | 'fdc3.valuation';
 
@@ -67,7 +67,7 @@ export enum ContextTypes {
   Portfolio = 'fdc3.portfolio',
   Position = 'fdc3.position',
   ChatSearchCriteria = 'fdc3.chat.searchCriteria',
-  TimeRange = 'fdc3.timerange',
+  TimeRange = 'fdc3.timeRange',
   TransactionResult = 'fdc3.transactionResult',
   Valuation = 'fdc3.valuation',
 }
diff --git a/src/context/ContextTypes.ts b/src/context/ContextTypes.ts
@@ -375,7 +375,7 @@ export interface TimeRangeObject {
      * 8601-1:2019](https://www.iso.org/standard/70907.html) with a timezone indicator.
      */
     startTime?: Date;
-    type:       "fdc3.timerange";
+    type:       "fdc3.timeRange";
     id?:        { [key: string]: any };
     name?:      string;
     [property: string]: any;
@@ -1826,7 +1826,7 @@ export interface TimeRange {
      * 8601-1:2019](https://www.iso.org/standard/70907.html) with a timezone indicator.
      */
     startTime?: Date;
-    type:       "fdc3.timerange";
+    type:       "fdc3.timeRange";
     id?:        { [key: string]: any };
     name?:      string;
     [property: string]: any;
@@ -2793,7 +2793,7 @@ const typeMap: any = {
         "fdc3.instrument",
     ],
     "TimeRangeType": [
-        "fdc3.timerange",
+        "fdc3.timeRange",
     ],
     "ChartStyle": [
         "bar",

diff --git a/src/internal/contextConfiguration.ts b/src/internal/contextConfiguration.ts
@@ -21,7 +21,7 @@ const STANDARD_CONTEXT_TYPES = exhaustiveStringTuple<StandardContextType>()(
   'fdc3.portfolio',
   'fdc3.position',
   'fdc3.nothing',
-  'fdc3.timerange',
+  'fdc3.timeRange',
   'fdc3.transactionResult',
   'fdc3.valuation'
 );

diff --git a/test/Methods.test.ts b/test/Methods.test.ts
@@ -472,7 +472,7 @@ describe('test version comparison functions', () => {
     expect(isStandardContextType('fdc3.portfolio')).toBe(true);
     expect(isStandardContextType('fdc3.position')).toBe(true);
     expect(isStandardContextType('fdc3.nothing')).toBe(true);
-    expect(isStandardContextType('fdc3.timerange')).toBe(true);
+    expect(isStandardContextType('fdc3.timeRange')).toBe(true);
     expect(isStandardContextType('fdc3.transactionResult')).toBe(true);
     expect(isStandardContextType('fdc3.valuation')).toBe(true);
   });

diff --git a/website/static/schemas/2.0/timerange.schema.json b/website/static/schemas/2.0/timerange.schema.json
@@ -16,7 +16,7 @@
     }
   ],
   "properties": {
-    "type": { "const": "fdc3.timerange" },
+    "type": { "const": "fdc3.timeRange" },
     "startTime": { "type": "string", "format": "date-time" },
     "endTime":  {"type": "string", "format": "date-time" }
   },

diff --git a/website/static/schemas/2.1/context/timerange.schema.json b/website/static/schemas/2.1/context/timerange.schema.json
@@ -8,7 +8,7 @@
     {
       "properties": {
         "type": {
-          "const": "fdc3.timerange"
+          "const": "fdc3.timeRange"
         },
         "startTime": {
           "type": "string",

diff --git a/website/static/schemas/next/context/timerange.schema.json b/website/static/schemas/next/context/timerange.schema.json
@@ -8,7 +8,7 @@
     {
       "properties": {
         "type": {
-          "const": "fdc3.timerange"
+          "const": "fdc3.timeRange"
         },
         "startTime": {
           "type": "string",

diff --git a/website/versioned_docs/version-1.0/context/ref/Chart.md b/website/versioned_docs/version-1.0/context/ref/Chart.md
@@ -28,7 +28,7 @@ https://fdc3.finos.org/schemas/next/chart.schema.json
 |------------------|-----------------|----------|----------------------|
 | `type`           | string          | Yes      | `'fdc3.chart'`     |
 | `instruments`    | Instrument[]  | Yes      | <pre>[<br/>&emsp;&emsp;{<br/>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br/>&emsp;&emsp;&emsp;&emsp;"id": {<br/>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "AAPL"<br/>&emsp;&emsp;&emsp;&emsp;}<br/>&emsp;&emsp;},<br/>&emsp;&emsp;{<br/>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br/>&emsp;&emsp;&emsp;&emsp;"id": {<br/>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "MSFT"<br/>&emsp;&emsp;&emsp;&emsp;}<br/>&emsp;&emsp;}<br/>]</pre> |
-| `range` | TimeRange  | No       | <pre>{<br/>&emsp;&emsp;"type": "fdc3.timerange",<br/>&emsp;&emsp;"startTime": "2022-03-30T15:44:44+00:00",<br/>&emsp;&emsp;"endTime": "2022-04-30T23:59:59+00:00"<br/>}</pre>            |
+| `range` | TimeRange  | No       | <pre>{<br/>&emsp;&emsp;"type": "fdc3.timeRange",<br/>&emsp;&emsp;"startTime": "2022-03-30T15:44:44+00:00",<br/>&emsp;&emsp;"endTime": "2022-04-30T23:59:59+00:00"<br/>}</pre>            |
 | `style`    | string  | No       | one of: `'line'`, `'bar'`, `'stacked-bar'`, `'mountain'`, `'candle'`, `'pie'`, `'scatter'`, `'histogram'`, `'heatmap'`, `'custom'`      |
 | `otherConfig`* | object  | No |  `{ /* unstandardized additional config */}`  |
 

diff --git a/website/versioned_docs/version-1.0/context/ref/TimeRange.md b/website/versioned_docs/version-1.0/context/ref/TimeRange.md
@@ -28,7 +28,7 @@ Notes:
 
 ## Type
 
-`fdc3.timerange`
+`fdc3.timeRange`
 
 ## Schema
 

diff --git a/website/versioned_docs/version-1.0/context/spec.md b/website/versioned_docs/version-1.0/context/spec.md
@@ -169,7 +169,7 @@ The following are standard FDC3 context types:
 * [`fdc3.portfolio`](ref/Portfolio) ([schema](/schemas/next/context/portfolio.schema.json))
 * [`fdc3.position`](ref/Position) ([schema](/schemas/next/context/position.schema.json))
 * [`fdc3.nothing`](ref/Nothing) ([schema](/schemas/next/context/nothing.schema.json))
-* [`fdc3.timerange`](ref/TimeRange) ([schema](/schemas/next/context/timerange.schema.json))
+* [`fdc3.timeRange`](ref/TimeRange) ([schema](/schemas/next/context/timerange.schema.json))
 * [`fdc3.valuation`](ref/Valuation) ([schema](/schemas/next/context/valuation.schema.json))
 
 **Note:** The below examples show how the base context data interface can be used to define specific context data objects.

diff --git a/website/versioned_docs/version-2.0/context/ref/Chart.md b/website/versioned_docs/version-2.0/context/ref/Chart.md
@@ -29,7 +29,7 @@ https://fdc3.finos.org/schemas/2.0/chart.schema.json
 |------------------|-----------------|----------|----------------------|
 | `type`           | string          | Yes      | `'fdc3.chart'`     |
 | `instruments`    | Instrument[]  | Yes      | <pre>[<br/>&emsp;&emsp;{<br/>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br/>&emsp;&emsp;&emsp;&emsp;"id": {<br/>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "AAPL"<br/>&emsp;&emsp;&emsp;&emsp;}<br/>&emsp;&emsp;},<br/>&emsp;&emsp;{<br/>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br/>&emsp;&emsp;&emsp;&emsp;"id": {<br/>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "MSFT"<br/>&emsp;&emsp;&emsp;&emsp;}<br/>&emsp;&emsp;}<br/>]</pre> |
-| `range` | TimeRange  | No       | <pre>{<br/>&emsp;&emsp;"type": "fdc3.timerange",<br/>&emsp;&emsp;"startTime": "2022-03-30T15:44:44+00:00",<br/>&emsp;&emsp;"endTime": "2022-04-30T23:59:59+00:00"<br/>}</pre>            |
+| `range` | TimeRange  | No       | <pre>{<br/>&emsp;&emsp;"type": "fdc3.timeRange",<br/>&emsp;&emsp;"startTime": "2022-03-30T15:44:44+00:00",<br/>&emsp;&emsp;"endTime": "2022-04-30T23:59:59+00:00"<br/>}</pre>            |
 | `style`    | string  | No       | one of: `'line'`, `'bar'`, `'stacked-bar'`, `'mountain'`, `'candle'`, `'pie'`, `'scatter'`, `'histogram'`, `'heatmap'`, `'custom'`      |
 | `otherConfig`* | object  | No |  `{ /* unstandardized additional config */}`  |
 

diff --git a/website/versioned_docs/version-2.0/context/ref/TimeRange.md b/website/versioned_docs/version-2.0/context/ref/TimeRange.md
@@ -29,7 +29,7 @@ Notes:
 
 ## Type
 
-`fdc3.timerange`
+`fdc3.timeRange`
 
 ## Schema
 

diff --git a/website/versioned_docs/version-2.0/context/spec.md b/website/versioned_docs/version-2.0/context/spec.md
@@ -172,7 +172,7 @@ The following are standard FDC3 context types:
 * [`fdc3.portfolio`](ref/Portfolio) ([schema](/schemas/2.0/portfolio.schema.json))
 * [`fdc3.position`](ref/Position) ([schema](/schemas/2.0/position.schema.json))
 * [`fdc3.nothing`](ref/Nothing) ([schema](/schemas/2.0/nothing.schema.json))
-* [`fdc3.timerange`](ref/TimeRange) ([schema](/schemas/2.0/timerange.schema.json))
+* [`fdc3.timeRange`](ref/TimeRange) ([schema](/schemas/2.0/timerange.schema.json))
 * [`fdc3.valuation`](ref/Valuation) ([schema](/schemas/2.0/valuation.schema.json))
 
 :::note

diff --git a/website/versioned_docs/version-2.1/context/ref/Chart.md b/website/versioned_docs/version-2.1/context/ref/Chart.md
@@ -29,7 +29,7 @@ In addition to handling requests to plot charts, a charting application may use
 |------------------|-----------------|----------|----------------------|
 | `type`           | string          | Yes      | `'fdc3.chart'`     |
 | `instruments`    | Instrument[]  | Yes      | <pre>[<br/>&emsp;&emsp;{<br/>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br/>&emsp;&emsp;&emsp;&emsp;"id": {<br/>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "AAPL"<br/>&emsp;&emsp;&emsp;&emsp;}<br/>&emsp;&emsp;},<br/>&emsp;&emsp;{<br/>&emsp;&emsp;&emsp;&emsp;"type": "fdc3.instrument",<br/>&emsp;&emsp;&emsp;&emsp;"id": {<br/>&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;"ticker": "MSFT"<br/>&emsp;&emsp;&emsp;&emsp;}<br/>&emsp;&emsp;}<br/>]</pre> |
-| `range` | TimeRange  | No       | <pre>{<br/>&emsp;&emsp;"type": "fdc3.timerange",<br/>&emsp;&emsp;"startTime": "2022-03-30T15:44:44+00:00",<br/>&emsp;&emsp;"endTime": "2022-04-30T23:59:59+00:00"<br/>}</pre>            |
+| `range` | TimeRange  | No       | <pre>{<br/>&emsp;&emsp;"type": "fdc3.timeRange",<br/>&emsp;&emsp;"startTime": "2022-03-30T15:44:44+00:00",<br/>&emsp;&emsp;"endTime": "2022-04-30T23:59:59+00:00"<br/>}</pre>            |
 | `style`    | string  | No       | one of: `'line'`, `'bar'`, `'stacked-bar'`, `'mountain'`, `'candle'`, `'pie'`, `'scatter'`, `'histogram'`, `'heatmap'`, `'custom'`      |
 | `otherConfig`* | array  | No |  `[ {/* additional config context objects */} ]`  |
 

diff --git a/website/versioned_docs/version-2.1/context/ref/TimeRange.md b/website/versioned_docs/version-2.1/context/ref/TimeRange.md
@@ -29,7 +29,7 @@ Notes:
 
 ## Type
 
-`fdc3.timerange`
+`fdc3.timeRange`
 
 ## Schema
 

diff --git a/website/versioned_docs/version-2.1/context/spec.md b/website/versioned_docs/version-2.1/context/spec.md
@@ -218,7 +218,7 @@ The following are standard FDC3 context types:
 - [`fdc3.portfolio`](ref/Portfolio) ([schema](/schemas/2.1/context/portfolio.schema.json))
 - [`fdc3.position`](ref/Position) ([schema](/schemas/2.1/context/position.schema.json))
 - [`fdc3.nothing`](ref/Nothing) ([schema](/schemas/2.1/context/nothing.schema.json))
-- [`fdc3.timerange`](ref/TimeRange) ([schema](/schemas/2.1/context/timerange.schema.json))
+- [`fdc3.timeRange`](ref/TimeRange) ([schema](/schemas/2.1/context/timerange.schema.json))
 - [`fdc3.transactionResult`](ref/TransactionResult) ([schema](/schemas/2.1/context/transactionresult.schema.json))
 - [`fdc3.valuation`](ref/Valuation) ([schema](/schemas/2.1/context/valuation.schema.json))