Start lock down stratum work

Author: nf-s

.gitignore

@@ -19,6 +19,7 @@ package-lock.json
 dist
 .history/
 ts-out/
+project.inlang/
 
 # Catalog index generation files
 catalog-index*.json

lib/Core/createDiscreteTimes.ts

@@ -1,9 +1,7 @@
 import moment from "moment";
-import StratumFromTraits from "../Models/Definition/StratumFromTraits";
-import DiscreteTimeTraits from "../Traits/TraitsClasses/DiscreteTimeTraits";
 
 export default function createDiscreteTimesFromIsoSegments(
-  result: StratumFromTraits<DiscreteTimeTraits>[],
+  result: { times: string[]; tags: string[] },
   startDate: string,
   stopDate: string,
   isoDuration: string | undefined,
@@ -80,10 +78,9 @@ export default function createDiscreteTimesFromIsoSegments(
     current.isSameOrBefore(stop) &&
     count < maxRefreshIntervals
   ) {
-    result.push({
-      time: formatMomentForWms(current, duration),
-      tag: undefined
-    });
+    result.times.push(formatMomentForWms(current, duration));
+    result.tags.push("");
+
     current.add(duration);
     ++count;
   }
@@ -96,10 +93,8 @@ export default function createDiscreteTimesFromIsoSegments(
     );
   } else if (!current.isSame(stop)) {
     // Add stop date if it has not been added yet.
-    result.push({
-      time: formatMomentForWms(stop, duration),
-      tag: undefined
-    });
+    result.times.push(formatMomentForWms(stop, duration));
+    result.tags.push("");
   }
 }
 

lib/ModelMixins/CatalogFunctionJobMixin.ts

@@ -11,7 +11,9 @@ import isDefined from "../Core/isDefined";
 import TerriaError from "../Core/TerriaError";
 import CommonStrata from "../Models/Definition/CommonStrata";
 import createStratumInstance from "../Models/Definition/createStratumInstance";
-import LoadableStratum from "../Models/Definition/LoadableStratum";
+import LoadableStratum, {
+  LockedDownStratum
+} from "../Models/Definition/LoadableStratum";
 import Model, { BaseModel } from "../Models/Definition/Model";
 import StratumOrder from "../Models/Definition/StratumOrder";
 import CatalogFunctionJobTraits from "../Traits/TraitsClasses/CatalogFunctionJobTraits";
@@ -21,8 +23,13 @@ import CatalogMemberMixin from "./CatalogMemberMixin";
 import GroupMixin from "./GroupMixin";
 import MappableMixin, { MapItem } from "./MappableMixin";
 
-class FunctionJobStratum extends LoadableStratum(CatalogFunctionJobTraits) {
-  constructor(readonly catalogFunctionJob: CatalogFunctionJobMixin.Instance) {
+class FunctionJobStratum
+  extends LoadableStratum(CatalogFunctionJobTraits)
+  implements LockedDownStratum<CatalogFunctionJobTraits, FunctionJobStratum>
+{
+  constructor(
+    private readonly catalogFunctionJob: CatalogFunctionJobMixin.Instance
+  ) {
     super();
     makeObservable(this);
   }

lib/ModelMixins/Cesium3dTilesStyleMixin.ts

@@ -1,15 +1,20 @@
+import { computed, makeObservable, override, runInAction, toJS } from "mobx";
+import clone from "terriajs-cesium/Source/Core/clone";
+import Color from "terriajs-cesium/Source/Core/Color";
 import Cesium3DTileStyle from "terriajs-cesium/Source/Scene/Cesium3DTileStyle";
 import AbstractConstructor from "../Core/AbstractConstructor";
 import isDefined from "../Core/isDefined";
+import LoadableStratum, {
+  LockedDownStratum
+} from "../Models/Definition/LoadableStratum";
 import Model, { BaseModel } from "../Models/Definition/Model";
-import Cesium3dTilesTraits from "../Traits/TraitsClasses/Cesium3dTilesTraits";
-import clone from "terriajs-cesium/Source/Core/clone";
-import { computed, makeObservable, override, runInAction, toJS } from "mobx";
-import Color from "terriajs-cesium/Source/Core/Color";
-import LoadableStratum from "../Models/Definition/LoadableStratum";
 import StratumOrder from "../Models/Definition/StratumOrder";
+import Cesium3dTilesTraits from "../Traits/TraitsClasses/Cesium3dTilesTraits";
 
-class Cesium3dTilesStyleStratum extends LoadableStratum(Cesium3dTilesTraits) {
+class Cesium3dTilesStyleStratum
+  extends LoadableStratum(Cesium3dTilesTraits)
+  implements LockedDownStratum<Cesium3dTilesTraits, Cesium3dTilesStyleStratum>
+{
   constructor(...args: any[]) {
     super(...args);
     makeObservable(this);

lib/ModelMixins/DiffableMixin.ts

@@ -1,7 +1,9 @@
 import { computed, makeObservable, override } from "mobx";
 import JulianDate from "terriajs-cesium/Source/Core/JulianDate";
 import AbstractConstructor from "../Core/AbstractConstructor";
-import LoadableStratum from "../Models/Definition/LoadableStratum";
+import LoadableStratum, {
+  LockedDownStratum
+} from "../Models/Definition/LoadableStratum";
 import Model, { BaseModel } from "../Models/Definition/Model";
 import createStratumInstance from "../Models/Definition/createStratumInstance";
 import { SelectableDimensionEnum } from "../Models/SelectableDimensions/SelectableDimensions";
@@ -10,9 +12,12 @@ import LegendTraits from "../Traits/TraitsClasses/LegendTraits";
 import MappableMixin from "./MappableMixin";
 import TimeFilterMixin from "./TimeFilterMixin";
 
-export class DiffStratum extends LoadableStratum(DiffableTraits) {
+export class DiffStratum
+  extends LoadableStratum(DiffableTraits)
+  implements LockedDownStratum<DiffableTraits, DiffStratum>
+{
   static stratumName = "diffStratum";
-  constructor(readonly catalogItem: DiffableMixin.Instance) {
+  constructor(private readonly catalogItem: DiffableMixin.Instance) {
     super();
     makeObservable(this);
   }
@@ -37,7 +42,7 @@ export class DiffStratum extends LoadableStratum(DiffableTraits) {
   }
 
   @computed
-  get diffLegendUrl() {
+  private get diffLegendUrl() {
     const diffStyleId = this.catalogItem.diffStyleId;
     const firstDate = this.catalogItem.firstDiffDate;
     const secondDate = this.catalogItem.secondDiffDate;

lib/ModelMixins/DiscretelyTimeVaryingMixin.ts

@@ -21,11 +21,6 @@ export interface AsJulian {
   tag: string;
 }
 
-export interface DiscreteTimeAsJS {
-  time: string;
-  tag: string | undefined;
-}
-
 function DiscretelyTimeVaryingMixin<
   T extends AbstractConstructor<Model<DiscretelyTimeVaryingTraits>>
 >(Base: T) {
@@ -41,7 +36,6 @@ function DiscretelyTimeVaryingMixin<
     get hasDiscreteTimes() {
       return true;
     }
-    abstract get discreteTimes(): DiscreteTimeAsJS[] | undefined;
 
     @override
     get currentTime(): string | undefined {
@@ -100,19 +94,20 @@ function DiscretelyTimeVaryingMixin<
     @computed
     get discreteTimesAsSortedJulianDates(): AsJulian[] | undefined {
       const discreteTimes = this.discreteTimes;
-      if (discreteTimes === undefined) {
+      if (discreteTimes === undefined || discreteTimes.times === undefined) {
         return undefined;
       }
 
       const asJulian: AsJulian[] = [];
-      for (let i = 0; i < discreteTimes.length; i++) {
-        const dt = discreteTimes[i];
+      for (let i = 0; i < discreteTimes.times.length; i++) {
+        const timeString = this.discreteTimes.times[i];
+        const tag = this.discreteTimes.tags?.[i];
         try {
-          if (dt.time !== undefined) {
-            const time = JulianDate.fromIso8601(dt.time);
+          if (timeString !== undefined) {
+            const time = JulianDate.fromIso8601(timeString);
             asJulian.push({
               time,
-              tag: dt.tag !== undefined ? dt.tag : dt.time
+              tag: tag ?? timeString
             });
           }
         } catch {}

lib/ModelMixins/ExportWebCoverageServiceMixin.ts

@@ -15,7 +15,9 @@ import proxyCatalogItemUrl from "../Models/Catalog/proxyCatalogItemUrl";
 import ResultPendingCatalogItem from "../Models/Catalog/ResultPendingCatalogItem";
 import CommonStrata from "../Models/Definition/CommonStrata";
 import createStratumInstance from "../Models/Definition/createStratumInstance";
-import LoadableStratum from "../Models/Definition/LoadableStratum";
+import LoadableStratum, {
+  LockedDownStratum
+} from "../Models/Definition/LoadableStratum";
 import Model, { BaseModel } from "../Models/Definition/Model";
 import StratumOrder from "../Models/Definition/StratumOrder";
 import UserDrawing from "../Models/UserDrawing";
@@ -46,9 +48,14 @@ type Coverage = {
  *
  * Note: not currently used
  */
-class WebCoverageServiceCapabilitiesStratum extends LoadableStratum(
-  ExportWebCoverageServiceTraits
-) {
+class WebCoverageServiceCapabilitiesStratum
+  extends LoadableStratum(ExportWebCoverageServiceTraits)
+  implements
+    LockedDownStratum<
+      ExportWebCoverageServiceTraits,
+      WebCoverageServiceCapabilitiesStratum
+    >
+{
   static stratumName = "wcsCapabilitiesStratum";
 
   static async load(catalogItem: ExportWebCoverageServiceMixin.Instance) {
@@ -87,8 +94,8 @@ class WebCoverageServiceCapabilitiesStratum extends LoadableStratum(
   }
 
   constructor(
-    readonly catalogItem: ExportWebCoverageServiceMixin.Instance,
-    readonly capabilities: {
+    private readonly catalogItem: ExportWebCoverageServiceMixin.Instance,
+    private readonly capabilities: {
       coverages: Coverage[];
       formats: string[];
       crs: string[];

lib/ModelMixins/GeojsonMixin.ts

@@ -75,7 +75,9 @@ import CatalogMemberMixin from "../ModelMixins/CatalogMemberMixin";
 import UrlMixin from "../ModelMixins/UrlMixin";
 import proxyCatalogItemUrl from "../Models/Catalog/proxyCatalogItemUrl";
 import createStratumInstance from "../Models/Definition/createStratumInstance";
-import LoadableStratum from "../Models/Definition/LoadableStratum";
+import LoadableStratum, {
+  LockedDownStratum
+} from "../Models/Definition/LoadableStratum";
 import Model, { BaseModel } from "../Models/Definition/Model";
 import StratumOrder from "../Models/Definition/StratumOrder";
 import TerriaFeature from "../Models/Feature/Feature";
@@ -85,10 +87,10 @@ import TableStylingWorkflow from "../Models/Workflows/TableStylingWorkflow";
 import createLongitudeLatitudeFeaturePerRow from "../Table/createLongitudeLatitudeFeaturePerRow";
 import TableAutomaticStylesStratum from "../Table/TableAutomaticStylesStratum";
 import TableStyle, { createRowGroupId } from "../Table/TableStyle";
+import { DiscreteTimesTraits } from "../Traits/TraitsClasses/DiscretelyTimeVaryingTraits";
 import { GeoJsonTraits } from "../Traits/TraitsClasses/GeoJsonTraits";
 import { RectangleTraits } from "../Traits/TraitsClasses/MappableTraits";
 import StyleTraits from "../Traits/TraitsClasses/StyleTraits";
-import { DiscreteTimeAsJS } from "./DiscretelyTimeVaryingMixin";
 import { ExportData } from "./ExportableMixin";
 import FeatureInfoUrlTemplateMixin from "./FeatureInfoUrlTemplateMixin";
 import { isDataSource } from "./MappableMixin";
@@ -112,7 +114,10 @@ const SIMPLE_STYLE_KEYS = [
   "fill-opacity"
 ];
 
-class GeoJsonStratum extends LoadableStratum(GeoJsonTraits) {
+class GeoJsonStratum
+  extends LoadableStratum(GeoJsonTraits)
+  implements LockedDownStratum<GeoJsonTraits, GeoJsonStratum>
+{
   static stratumName = "geojson";
   constructor(private readonly _item: GeoJsonMixin.Instance) {
     super();
@@ -176,6 +181,39 @@ class GeoJsonStratum extends LoadableStratum(GeoJsonTraits) {
       return true;
     }
   }
+
+  @computed get discreteTimes() {
+    if (this._item.readyData === undefined) {
+      return undefined;
+    }
+
+    // If we are using mvt (mapbox vector tiles / protomaps imagery provider) we use TableMixin.discreteTimes instead
+    if (this._item.useTableStylingAndProtomaps) return undefined;
+
+    // If using timeProperty - get discrete times from that
+    if (this._item.timeProperty) {
+      const times: string[] = [];
+      const tags: string[] = [];
+
+      for (let i = 0; i < this._item.readyData.features.length; i++) {
+        const feature = this._item.readyData.features[i];
+        if (
+          feature.properties !== null &&
+          feature.properties !== undefined &&
+          feature.properties[this._item.timeProperty!] !== undefined
+        ) {
+          times.push(
+            new Date(
+              `${feature.properties[this._item.timeProperty!]}`
+            ).toISOString()
+          );
+          tags.push(feature.properties[this._item.timeProperty!]);
+        }
+      }
+
+      return createStratumInstance(DiscreteTimesTraits, { tags, times });
+    }
+  }
 }
 
 StratumOrder.addLoadStratum(GeoJsonStratum.stratumName);
@@ -1142,40 +1180,6 @@ function GeoJsonMixin<T extends AbstractConstructor<BaseType>>(Base: T) {
       return dataSource;
     }
 
-    @override
-    get discreteTimes(): DiscreteTimeAsJS[] | undefined {
-      if (this.readyData === undefined) {
-        return undefined;
-      }
-
-      // If we are using mvt (mapbox vector tiles / protomaps imagery provider) return TableMixin.discreteTimes
-      if (this.useTableStylingAndProtomaps) return super.discreteTimes;
-
-      // If using timeProperty - get discrete times from that
-      if (this.timeProperty) {
-        const discreteTimesMap: Map<string, DiscreteTimeAsJS> = new Map();
-
-        for (let i = 0; i < this.readyData.features.length; i++) {
-          const feature = this.readyData.features[i];
-          if (
-            feature.properties !== null &&
-            feature.properties !== undefined &&
-            feature.properties[this.timeProperty!] !== undefined
-          ) {
-            const dt = {
-              time: new Date(
-                `${feature.properties[this.timeProperty!]}`
-              ).toISOString(),
-              tag: feature.properties[this.timeProperty!]
-            };
-            discreteTimesMap.set(dt.tag, dt);
-          }
-        }
-
-        return Array.from(discreteTimesMap.values());
-      }
-    }
-
     /**
      * Transform feature properties into column-major format.
      * This enables all TableMixin functionality - which is used for styling vector tiles.

lib/ModelMixins/TableMixin.ts

@@ -445,7 +445,7 @@ function TableMixin<T extends AbstractConstructor<BaseType>>(Base: T) {
 
       return filterOutUndefined([
         // If time-series region mapping - show time points chart
-        this.activeTableStyle.isRegions() && this.discreteTimes?.length
+        this.activeTableStyle.isRegions() && this.discreteTimes?.times?.length
           ? this.momentChart
           : undefined,
         ...this.tableChartItems
@@ -693,33 +693,6 @@ function TableMixin<T extends AbstractConstructor<BaseType>>(Base: T) {
       return this.activeTableStyle.isSampled;
     }
 
-    @computed
-    get discreteTimes():
-      | { time: string; tag: string | undefined }[]
-      | undefined {
-      if (!this.activeTableStyle.moreThanOneTimeInterval) return;
-      const dates = this.activeTableStyle.timeColumn?.valuesAsDates.values;
-      if (dates === undefined) {
-        return;
-      }
-
-      // is it correct for discrete times to remove duplicates?
-      // see discussion on https://github.com/TerriaJS/terriajs/pull/4577
-      // duplicates will mess up the indexing problem as our `<DateTimePicker />`
-      // will eliminate duplicates on the UI front, so given the datepicker
-      // expects uniques, return uniques here
-      const times = new Set<string>();
-
-      for (let i = 0; i < dates.length; i++) {
-        const d = dates[i];
-        if (d) {
-          times.add(d.toISOString());
-        }
-      }
-
-      return Array.from(times).map((time) => ({ time, tag: undefined }));
-    }
-
     /** This is a temporary button which shows in the Legend in the Workbench, if custom styling has been applied. */
     @computed get legendButton() {
       return this.activeTableStyle.isCustom