Get ride of the src/types

maplibre · May 22, 2024 · df31dcf · df31dcf
1 parent 263365b
commit df31dcf
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 46 deletions.
diff --git a/src/source/load_tilejson.ts b/src/source/load_tilejson.ts
@@ -1,10 +1,9 @@
-import {pick, extend} from '../util/util';
+import {pick, extend, TileJSON} from '../util/util';
 import {getJSON} from '../util/ajax';
 import {ResourceType} from '../util/request_manager';
 import {browser} from '../util/browser';
 
 import type {RequestManager} from '../util/request_manager';
-import type {TileJSON} from '../types/tilejson';
 import type {RasterDEMSourceSpecification, RasterSourceSpecification, VectorSourceSpecification} from '@maplibre/maplibre-gl-style-spec';
 
 export type LoadTileJsonResponse = {

diff --git a/src/types/tilejson.ts b/src/types/tilejson.ts
diff --git a/src/types/util.ts b/src/types/util.ts
diff --git a/src/ui/map.ts b/src/ui/map.ts
@@ -1,4 +1,4 @@
-import {extend, warnOnce, uniqueId, isImageBitmap} from '../util/util';
+import {extend, warnOnce, uniqueId, isImageBitmap, Complete} from '../util/util';
 import {browser} from '../util/browser';
 import {DOM} from '../util/dom';
 import packageJSON from '../../package.json' with {type: 'json'};
@@ -58,7 +58,6 @@ import type {
 import type {MapGeoJSONFeature} from '../util/vectortile_to_geojson';
 import type {ControlPosition, IControl} from './control/control';
 import type {QueryRenderedFeaturesOptions, QuerySourceFeatureOptions} from '../source/query_features';
-import {Complete} from '../types/util';
 
 const version = packageJSON.version;
 

diff --git a/src/util/util.ts b/src/util/util.ts
@@ -668,3 +668,45 @@ export function subscribe(target: Subscriber, message: keyof WindowEventMap, lis
 export function degreesToRadians(degrees: number): number {
     return degrees * Math.PI / 180;
 }
+
+/**
+ * Makes optional keys required and add the the undefined type.
+ *
+ * ```
+ * interface Test {
+ *  foo: number;
+ *  bar?: number;
+ *  baz: number | undefined;
+ * }
+ *
+ * Complete<Test> {
+ *  foo: number;
+ *  bar: number | undefined;
+ *  baz: number | undefined;
+ * }
+ *
+ * ```
+ *
+ * See https://medium.com/terria/typescript-transforming-optional-properties-to-required-properties-that-may-be-undefined-7482cb4e1585
+ */
+
+export type Complete<T> = {
+    [P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>> ? T[P] : (T[P] | undefined);
+}
+
+export type TileJSON = {
+    tilejson: '2.2.0' | '2.1.0' | '2.0.1' | '2.0.0' | '1.0.0';
+    name?: string;
+    description?: string;
+    version?: string;
+    attribution?: string;
+    template?: string;
+    tiles: Array<string>;
+    grids?: Array<string>;
+    data?: Array<string>;
+    minzoom?: number;
+    maxzoom?: number;
+    bounds?: [number, number, number, number];
+    center?: [number, number, number];
+    vector_layers: [{id: string}]; // this is partial but enough for what we need
+};
diff --git a/test/bench/lib/tile_parser.ts b/test/bench/lib/tile_parser.ts
@@ -12,7 +12,7 @@ import {StyleLayerIndex} from '../../../src/style/style_layer_index';
 import type {StyleSpecification} from '@maplibre/maplibre-gl-style-spec';
 import type {WorkerTileResult} from '../../../src/source/worker_source';
 import type {OverscaledTileID} from '../../../src/source/tile_id';
-import type {TileJSON} from '../../../src/types/tilejson';
+import type {TileJSON} from '../../../src/util/util';
 import type {Map} from '../../../src/ui/map';
 import type {IActor} from '../../../src/util/actor';
 import {MessageType} from '../../../src/util/actor_messages';