diff --git a/website/src/lib/components/map/layer-control/extension-api.test.ts b/website/src/lib/components/map/layer-control/extension-api.test.ts index 8fab8157a..d861cada4 100644 --- a/website/src/lib/components/map/layer-control/extension-api.test.ts +++ b/website/src/lib/components/map/layer-control/extension-api.test.ts @@ -7,29 +7,14 @@ import { engine } from '$lib/engine'; import { settings } from '$lib/state/settings'; import { map } from '$lib/components/map/map'; import type { StyleSpecification } from 'maplibre-gl'; -import { ExtensionAPI, type CustomOverlay, type ExtensionOverlay } from './extension-api'; +import { ExtensionAPI, type ExtensionOverlay } from './extension-api'; import { isSelected, prefixStyle } from './utils'; const original = { set: engine.setSetting, delete: engine.deleteSetting }; -/** The raster source that an overlay added by an extension uses. */ -function rasterSource(id: string) { - const style = overlays[id]; - assert.ok(typeof style === 'object'); - const source = style.sources[id]; - assert.ok(source?.type === 'raster'); - return source; -} const overlayTreeBefore = JSON.stringify(overlayTree); const overlayIdsBefore = Object.keys(overlays).sort(); -const overlay = (id: string, extensionName = 'My extension'): CustomOverlay => ({ - extensionName, - id, - name: `Overlay ${id}`, - tileUrls: [`https://tiles.example.com/${id}/{z}/{x}/{y}.png`], -}); - let api: ExtensionAPI; beforeEach(() => { @@ -42,120 +27,14 @@ beforeEach(() => { afterEach(() => { // the layers are shared by the whole app: leave them as they were - api.filterOverlays([]); api.setOverlays('Heatmaps', []); api.setOverlays('Other', []); - for (const extension of ['My extension', 'Other extension']) { - delete (overlayTree.overlays as LayerTreeType)[extension]; - } engine.setSetting = original.set; engine.deleteSetting = original.delete; assert.equal(JSON.stringify(overlayTree), overlayTreeBefore); assert.deepEqual(Object.keys(overlays).sort(), overlayIdsBefore); }); -describe('ExtensionAPI', () => { - it('adds an overlay as a layer, in the tree of its extension', () => { - api.addOrUpdateOverlay(overlay('one')); - - const source = rasterSource('extension-one'); - assert.deepEqual(source.tiles, ['https://tiles.example.com/one/{z}/{x}/{y}.png']); - assert.equal(source.tileSize, 256); - assert.equal(source.maxzoom, 22); - - assert.ok((overlayTree.overlays as LayerTreeType)['My extension']); - assert.equal(isSelected(overlayTree, 'extension-one'), true); - assert.equal(isSelected(get(settings.selectedOverlayTree), 'extension-one'), true); - // not shown until the user chooses to - assert.equal(isSelected(get(settings.currentOverlays)!, 'extension-one'), false); - assert.ok(get(api.isLayerFromExtension)('extension-one')); - assert.equal(get(api.getLayerName)('extension-one'), 'Overlay one'); - assert.equal(get(api.getLayerName)('other'), ''); - }); - - it('uses big tiles when the urls say so, and the max zoom it is given', () => { - api.addOrUpdateOverlay({ - ...overlay('big'), - tileUrls: ['https://tiles.example.com/512/{z}/{x}/{y}.png'], - maxZoom: 15, - }); - const source = rasterSource('extension-big'); - assert.equal(source.tileSize, 512); - assert.equal(source.maxzoom, 15); - }); - - it('refuses an overlay that is not complete', () => { - for (const bad of [ - { ...overlay('a'), extensionName: '' }, - { ...overlay('a'), id: '' }, - { ...overlay('a'), name: '' }, - { ...overlay('a'), tileUrls: [] }, - { ...overlay('a'), tileUrls: undefined as unknown as string[] }, - ]) { - assert.throws(() => api.addOrUpdateOverlay(bad), /must have/); - } - assert.ok(!('extension-a' in overlays)); - }); - - it('updates an overlay that is added again, keeping it shown', () => { - api.addOrUpdateOverlay(overlay('one')); - settings.currentOverlays.update((current) => { - (current.overlays as LayerTreeType)['My extension'] = { 'extension-one': true }; - return current; - }); - - api.addOrUpdateOverlay({ - ...overlay('one'), - name: 'Renamed', - tileUrls: ['https://other/{z}'], - }); - assert.equal(get(api.getLayerName)('extension-one'), 'Renamed'); - assert.deepEqual(rasterSource('extension-one').tiles, ['https://other/{z}']); - assert.equal(isSelected(get(settings.currentOverlays)!, 'extension-one'), true); - }); - - it('removes the overlays that are not in the list anymore, everywhere', () => { - api.addOrUpdateOverlay(overlay('one')); - api.addOrUpdateOverlay(overlay('two', 'Other extension')); - - api.filterOverlays(['two']); - assert.ok(!('extension-one' in overlays)); - assert.ok('extension-two' in overlays); - assert.equal(get(api.isLayerFromExtension)('extension-one'), false); - assert.equal(get(api.isLayerFromExtension)('extension-two'), true); - for (const tree of [ - overlayTree, - get(settings.selectedOverlayTree), - get(settings.currentOverlays)!, - ]) { - assert.equal(isSelected(tree, 'extension-one'), false); - } - assert.equal(isSelected(overlayTree, 'extension-two'), true); - - api.filterOverlays([]); - assert.ok(!('extension-two' in overlays)); - }); - - it('puts the overlays in the order it is given', () => { - api.addOrUpdateOverlay(overlay('one')); - api.addOrUpdateOverlay(overlay('two')); - api.addOrUpdateOverlay(overlay('three')); - - api.updateOverlaysOrder(['three', 'one', 'two']); - const extension = (get(settings.selectedOverlayTree).overlays as LayerTreeType)[ - 'My extension' - ]; - assert.deepEqual(Object.keys(extension as LayerTreeType), [ - 'extension-three', - 'extension-one', - 'extension-two', - ]); - // ids it does not know are ignored - api.updateOverlaysOrder(['unknown', 'two']); - assert.equal(Object.keys(extension as LayerTreeType).at(-1), 'extension-two'); - }); -}); - const rasterStyle = (url = 'https://tiles.example.com/{z}/{x}/{y}.png'): StyleSpecification => ({ version: 8, sources: { tiles: { type: 'raster', tiles: [url], tileSize: 256 } }, @@ -225,7 +104,7 @@ describe('prefixStyle', () => { }); }); -describe('ExtensionAPI v2', () => { +describe('ExtensionAPI', () => { it('adds the overlays of an extension, in the order of the list, hidden by default', () => { api.setOverlays('Heatmaps', [v2('b'), v2('a', { name: 'A' }), v2('c', { visible: true })]); @@ -250,7 +129,7 @@ describe('ExtensionAPI v2', () => { assert.equal((style.layers[0] as { source: string }).source, `${id('a')}/tiles`); }); - it('names its overlays after the extension, the way the v1 API does without it', () => { + it('names its overlays after the extension', () => { api.setOverlays('My heatmap', [v2('all')]); assert.ok(isSelected(overlayTree, 'extension-My%20heatmap/all')); api.setOverlays('My heatmap', []); @@ -273,11 +152,9 @@ describe('ExtensionAPI v2', () => { api.setOverlays('Heatmaps/a', []); }); - it('knows the groups of the extensions, of either version', () => { + it('knows the groups of the extensions', () => { api.setOverlays('Heatmaps', [v2('a')]); - api.addOrUpdateOverlay(overlay('one')); assert.equal(get(api.isExtensionGroup)('Heatmaps'), true); - assert.equal(get(api.isExtensionGroup)('My extension'), true); assert.equal(get(api.isExtensionGroup)('france'), false); api.setOverlays('Heatmaps', []); assert.equal(get(api.isExtensionGroup)('Heatmaps'), false); @@ -410,7 +287,6 @@ describe('ExtensionAPI v2', () => { settings.connect(saved()); api.setOverlays('Heatmaps', [v2('a', { visible: true }), v2('b')]); - api.addOrUpdateOverlay(overlay('one')); settings.selectedOverlayTree.update((tree) => { group(tree)![id('b')] = false; return tree; @@ -482,19 +358,4 @@ describe('ExtensionAPI v2', () => { store.set(null); } }); - - it('is not affected by the v1 API, and can live next to it', () => { - api.setOverlays('Heatmaps', [v2('a')]); - api.addOrUpdateOverlay(overlay('one', 'Heatmaps')); - api.filterOverlays([]); - assert.ok(id('a') in overlays); - assert.ok(get(api.isLayerFromExtension)(id('a'))); - assert.ok(isSelected(overlayTree, id('a'))); - - api.addOrUpdateOverlay(overlay('one', 'Heatmaps')); - api.setOverlays('Heatmaps', [v2('a'), v2('b')]); - assert.ok(isSelected(overlayTree, 'extension-one')); - api.setOverlays('Heatmaps', []); - assert.ok(isSelected(overlayTree, 'extension-one')); - }); }); diff --git a/website/src/lib/components/map/layer-control/extension-api.ts b/website/src/lib/components/map/layer-control/extension-api.ts index 9ff8421a0..42e1434ba 100644 --- a/website/src/lib/components/map/layer-control/extension-api.ts +++ b/website/src/lib/components/map/layer-control/extension-api.ts @@ -8,16 +8,7 @@ import { map } from '$lib/components/map/map'; const { currentOverlays, previousOverlays, selectedOverlayTree } = settings; -/** An overlay of the v1 API. */ -export type CustomOverlay = { - extensionName: string; - id: string; - name: string; - tileUrls: string[]; - maxZoom?: number; -}; - -/** An overlay of the v2 API. */ +/** An overlay given by an extension. */ export type ExtensionOverlay = { /** Unique within the extension. Keep it stable: the opacity and menu choices are tied to it. */ id: string; @@ -37,8 +28,8 @@ export type ExtensionOverlay = { type RegisteredOverlay = { extensionName: string; name: string; - /** The style given by the extension, to tell when it changes; only for the v2 API. */ - signature?: string; + /** The style given by the extension, to tell when it changes. */ + signature: string; }; type VisibilityCallback = (visible: Record) => void; @@ -46,36 +37,19 @@ type VisibilityCallback = (visible: Record) => void; /** The groups of the overlay tree that an extension cannot put its overlays in. */ const reservedGroups = new Set(['__proto__', ...Object.keys(layerGroup(overlayTree.overlays))]); -/** The id of an overlay of the v1 API, whose methods do not all get the name of the extension. */ -function getOverlayId(id: string): string { - return `extension-${id}`; -} - -/** The id of an overlay of the v2 API. It is encoded so that two extensions cannot clash. */ +/** The id of an overlay. It is encoded so that two extensions cannot clash. */ function getExtensionOverlayId(extensionName: string, id: string): string { - return getOverlayId(`${encodeURIComponent(extensionName)}/${encodeURIComponent(id)}`); + return `extension-${encodeURIComponent(extensionName)}/${encodeURIComponent(id)}`; } /** - * Sets the overlays of an extension in a tree, in order. Its other entries are dropped, except for - * those of `keep`: its overlays of the v1 API, which can be in the same group. An extension that - * has nothing left has no group anymore. + * Sets the overlays of an extension in a tree, in order, dropping its other entries. An extension + * that has nothing left has no group anymore. */ -function setGroup( - tree: LayerTreeType, - extensionName: string, - entries: Record, - keep: (id: string) => boolean -) { +function setGroup(tree: LayerTreeType, extensionName: string, entries: Record) { const groups = layerGroup(tree.overlays); - const group = groups[extensionName]; - const kept = - typeof group === 'object' - ? Object.entries(group).filter(([id]) => keep(id) && !Object.hasOwn(entries, id)) - : []; - const updated = { ...entries, ...Object.fromEntries(kept) }; - if (Object.keys(updated).length > 0) { - groups[extensionName] = updated; + if (Object.keys(entries).length > 0) { + groups[extensionName] = { ...entries }; } else { delete groups[extensionName]; } @@ -83,7 +57,7 @@ function setGroup( } export class ExtensionAPI { - /** The version of the API; the methods of v1 are still there, until extensions have moved. */ + /** The version of the API. */ readonly version = 2; /** * Resolved once overlays can be set. `gpxstudio:extension-api-ready` is sent on `window` at that @@ -99,7 +73,7 @@ export class ExtensionAPI { init() { if (browser && !Object.hasOwn(window, 'gpxstudio')) { - this.ready = this.ensureLoaded(); + this.ready = this.whenLoaded(); this.ready.then(() => window.dispatchEvent(new Event('gpxstudio:extension-api-ready'))); Object.defineProperty(window, 'gpxstudio', { value: this, @@ -107,8 +81,7 @@ export class ExtensionAPI { } } - /** @deprecated v1: use `ready`. */ - ensureLoaded(): Promise { + private whenLoaded(): Promise { let unsubscribe: () => void; const promise = new Promise((resolve) => { map.onLoad(() => { @@ -206,16 +179,12 @@ export class ExtensionAPI { visibility[overlay.id] = shown[id]; }); - const keep = (id: string) => { - const overlay = get(this._overlays).get(id); - return overlay !== undefined && overlay.signature === undefined; - }; - setGroup(overlayTree, extensionName, available, keep); - selectedOverlayTree.update((tree) => setGroup(tree, extensionName, selected, keep)); + setGroup(overlayTree, extensionName, available); + selectedOverlayTree.update((tree) => setGroup(tree, extensionName, selected)); previousOverlays.update((tree) => removeAll(tree, removedIds)); // this is not an action of the user: there must be nothing to tell the extension about this._visibility.set(extensionName, visibility); - currentOverlays.update((tree) => setGroup(tree, extensionName, shown, keep)); + currentOverlays.update((tree) => setGroup(tree, extensionName, shown)); } /** @@ -263,8 +232,7 @@ export class ExtensionAPI { private getOverlaysOf(extensionName: string): Map { return new Map( Array.from(get(this._overlays)).filter( - ([, overlay]) => - overlay.extensionName === extensionName && overlay.signature !== undefined + ([, overlay]) => overlay.extensionName === extensionName ) ); } @@ -286,139 +254,6 @@ export class ExtensionAPI { } } - /** @deprecated v1: use `setOverlays`. */ - addOrUpdateOverlay(overlay: CustomOverlay) { - if ( - !overlay.extensionName || - !overlay.id || - !overlay.name || - !overlay.tileUrls || - overlay.tileUrls.length === 0 - ) { - throw new Error( - 'Overlay must have an extensionName, id, name, and at least one tile URL.' - ); - } - overlay.id = getOverlayId(overlay.id); - - this._overlays.update(($overlays) => { - $overlays.set(overlay.id, overlay); - return $overlays; - }); - - overlays[overlay.id] = { - version: 8, - sources: { - [overlay.id]: { - type: 'raster', - tiles: overlay.tileUrls, - tileSize: overlay.tileUrls.some((url) => url.includes('512')) ? 512 : 256, - maxzoom: overlay.maxZoom ?? 22, - }, - }, - layers: [ - { - id: overlay.id, - type: 'raster', - source: overlay.id, - }, - ], - }; - - const extensions = layerGroup(overlayTree.overlays); - if (!Object.hasOwn(extensions, overlay.extensionName)) { - extensions[overlay.extensionName] = {}; - } - - layerGroup(extensions[overlay.extensionName])[overlay.id] = true; - - selectedOverlayTree.update((selected) => { - if (!Object.hasOwn(selected.overlays, overlay.extensionName)) { - selected.overlays[overlay.extensionName] = {}; - } - selected.overlays[overlay.extensionName][overlay.id] = true; - return selected; - }); - - const current = get(currentOverlays); - let show = false; - if (current && isSelected(current, overlay.id)) { - show = true; - try { - get(map)?.removeLayer(overlay.id); - } catch { - // No reliable way to check if the map is ready to remove sources and layers - } - } - - currentOverlays.update((current) => { - if (!Object.hasOwn(current.overlays, overlay.extensionName)) { - current.overlays[overlay.extensionName] = {}; - } - current.overlays[overlay.extensionName][overlay.id] = show; - return current; - }); - } - - /** @deprecated v1: use `setOverlays`. Leaves the overlays of the v2 API alone. */ - filterOverlays(ids: string[]) { - ids = ids.map((id) => getOverlayId(id)); - const idsToRemove = Array.from(get(this._overlays)) - .filter(([id, overlay]) => overlay.signature === undefined && !ids.includes(id)) - .map(([id]) => id); - - currentOverlays.update((current) => { - removeAll(current, idsToRemove); - return current; - }); - previousOverlays.update((previous) => { - removeAll(previous, idsToRemove); - return previous; - }); - selectedOverlayTree.update((selected) => { - removeAll(selected, idsToRemove); - return selected; - }); - Object.keys(overlays).forEach((id) => { - if (idsToRemove.includes(id)) { - delete overlays[id]; - } - }); - removeAll(overlayTree, idsToRemove); - this._overlays.update(($overlays) => { - $overlays.forEach((_, id) => { - if (idsToRemove.includes(id)) { - $overlays.delete(id); - } - }); - return $overlays; - }); - } - - /** @deprecated v1: use `setOverlays`. */ - updateOverlaysOrder(ids: string[]) { - ids = ids.map((id) => getOverlayId(id)); - selectedOverlayTree.update((selected) => { - const isSelected: Record = {}; - ids.forEach((id) => { - const overlay = get(this._overlays).get(id); - if ( - overlay && - Object.hasOwn(selected.overlays, overlay.extensionName) && - Object.hasOwn(selected.overlays[overlay.extensionName] as LayerTreeType, id) - ) { - isSelected[id] = selected.overlays[overlay.extensionName][id]; - delete selected.overlays[overlay.extensionName][id]; - } - }); - Object.entries(isSelected).forEach(([id, value]) => { - const overlay = get(this._overlays).get(id)!; - selected.overlays[overlay.extensionName][id] = value; - }); - return selected; - }); - } - isLayerFromExtension = derived(this._overlays, ($overlays) => { return (id: string) => $overlays.has(id); });