@mailwoman/cartographer 1.0.0

package/tiger/index.ts

@@ -0,0 +1,71 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { HillsLayerID } from "../base/layers.js"
+import type { LayerSpecificationListInput } from "../styles/layers.js"
+import { TileSetSourceID } from "../styles/sources.js"
+
+export const TIGERTractsTileSetID = TileSetSourceID("tiger-tracts")
+export const TIGERBlocksTileSetID = TileSetSourceID("tiger-blocks")
+
+export const TIGERLayers: LayerSpecificationListInput[] = [
+	{
+		afterID: HillsLayerID,
+		metadata: {
+			queryable: false,
+		},
+
+		id: "boundary-tracts",
+		"source-layer": "tracts",
+		source: TIGERTractsTileSetID,
+		type: "line",
+		filter: [">=", ["get", "ALAND"], 0],
+		maxzoom: 9,
+		paint: {
+			"line-color": "white",
+			"line-width": 1,
+
+			"line-opacity": [
+				// We fade out the outline at higher zoom levels
+				"interpolate",
+				["linear"],
+				["zoom"],
+				5,
+				0.01,
+				10,
+				0.25,
+			],
+		},
+	},
+
+	{
+		beforeID: "water",
+		metadata: {
+			queryable: false,
+		},
+		id: "boundary-blocks",
+		"source-layer": "blocks",
+		source: TIGERBlocksTileSetID,
+		type: "line",
+		filter: [">=", ["get", "ALAND"], 0],
+		minzoom: 9,
+		paint: {
+			"line-color": "orange",
+			"line-width": 1,
+
+			"line-opacity": [
+				// We fade out the outline at higher zoom levels
+				"interpolate",
+				["linear"],
+				["zoom"],
+				9,
+				0.01,
+				16,
+				0.5,
+			],
+		},
+	},
+]

package/tiles/api.ts

@@ -0,0 +1,53 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+import { APIClient, pluckResponseData } from "@mailwoman/core/api"
+import type { VectorSourceSpecification } from "maplibre-gl"
+import type { TileSetSourceID, TileSetSourceRecord } from "../styles/sources.js"
+import type { TileJSON } from "./schema.js"
+
+/**
+ * API Client for fetching Protomap tile data.
+ */
+export const TileAPI = new APIClient({
+	displayName: "TileAPI",
+	axios: {
+		baseURL: "https://tiles.sister.software",
+	},
+})
+
+export function fetchTileSetSourceSpec(
+	tileSetID: TileSetSourceID
+): Promise<[TileSetSourceID, VectorSourceSpecification]> {
+	return TileAPI.fetch<TileJSON>({ url: `/${tileSetID}.json` })
+		.then(pluckResponseData)
+		.then((metadata) => {
+			const sourceSpec: VectorSourceSpecification = {
+				type: "vector",
+				scheme: metadata.scheme,
+				tiles: metadata.tiles,
+				minzoom: metadata.minzoom,
+				maxzoom: metadata.maxzoom,
+				attribution: metadata.attribution || "Sister Software. et al.",
+				bounds: metadata.bounds,
+			}
+
+			return [tileSetID, sourceSpec] as const
+		})
+}
+
+export async function fetchTileSetSources(tileSetIDs: TileSetSourceID[]): Promise<TileSetSourceRecord> {
+	const tileSetPromises = tileSetIDs.map(fetchTileSetSourceSpec)
+
+	const tileSetPairs = await Promise.all(tileSetPromises)
+	const tileSetSources: TileSetSourceRecord = {}
+
+	for (const [tileSetID, sourceSpec] of tileSetPairs) {
+		tileSetSources[tileSetID] = sourceSpec
+	}
+
+	return tileSetSources
+}

package/tiles/coords.ts

@@ -0,0 +1,46 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+/**
+ * Literal type for a tile coord array.
+ */
+export type TileCoords = [zoom: number, xCoord: number, yCoord: number]
+
+export function parseTileCoordParams({ z, x, y }: Record<string, string | undefined>): TileCoords | null {
+	const coords = [z, x, y].map((n) => parseInt(n!, 10)).filter((n) => !isNaN(n))
+
+	if (coords.length !== 3) return null
+
+	return coords as TileCoords
+}
+
+/*
+ * Get the precise fractional tile location for a point at a zoom level
+ *
+ */
+export function pointToTileFraction(zoom: number, longitude: number, latitude: number): TileCoords {
+	const sin = Math.sin((latitude * Math.PI) / 180)
+	const z2 = Math.pow(2, zoom)
+	let x = z2 * (longitude / 360 + 0.5)
+
+	const y = z2 * (0.5 - (0.25 * Math.log((1 + sin) / (1 - sin))) / Math.PI)
+
+	// Wrap Tile X
+	x = x % z2
+
+	if (x < 0) x = x + z2
+
+	return [zoom, x, y]
+}
+
+/**
+ * Get the tile for a point at a specified zoom level
+ */
+export function pointToTile(zoom: number, longitude: number, latitude: number): TileCoords {
+	const [, x, y] = pointToTileFraction(zoom, longitude, latitude)
+
+	return [zoom, Math.floor(x), Math.floor(y)]
+}

package/tiles/index.ts

@@ -0,0 +1,9 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+export * from "./api.js"
+export * from "./coords.js"
+export * from "./schema.js"

package/tiles/schema.ts

@@ -0,0 +1,42 @@
+/**
+ * @copyright Sister Software.
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+
+/**
+ * TileJSON is an open standard for representing map metadata.
+ *
+ * @see {@link https://github.com/mapbox/tilejson-spec TileJSON Specification}
+ */
+export interface TileJSON {
+	/**
+	 * The version of the TileJSON spec that is implemented by this JSON object.
+	 *
+	 * @default "3.0.0"
+	 */
+	tilejson: string
+	scheme: "xyz"
+	tiles: string[]
+	vector_layers: TileJSONVectorLayer[]
+	attribution?: string
+	description?: string
+	name: string
+	version: string
+	bounds: [minLon: number, minLat: number, maxLon: number, maxLat: number]
+	center: [centerLon: number, centerLat: number, centerZoom: number]
+	minzoom: number
+	maxzoom: number
+}
+
+/**
+ * A vector layer definition for a TileJSON object.
+ */
+export interface TileJSONVectorLayer {
+	description?: string
+	id: string
+	fields: Record<string, string>
+	source: string
+	minzoom?: number
+	maxzoom?: number
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+	"extends": "@sister.software/tsconfig",
+	"compilerOptions": {
+		"emitDeclarationOnly": false,
+		"allowImportingTsExtensions": false,
+		"allowSyntheticDefaultImports": true,
+		"emitDecoratorMetadata": true,
+		"experimentalDecorators": true,
+		"paths": {
+			"@mailwoman/mailwoman/sdk": ["./sdk/index"],
+			"@mailwoman/mailwoman/sdk/*": ["./sdk/*"]
+		}
+	},
+	"exclude": ["./out/**/*"],
+	"references": [
+		// ---
+		{ "path": "../core" },
+		{ "path": "../spatial" },
+		{ "path": "../tiger" },
+		{ "path": "../mailwoman" }
+	]
+}

package/typedoc.json

@@ -0,0 +1,4 @@
+{
+	"extends": ["../typedoc.base.jsonc"],
+	"entryPoints": ["index.ts"]
+}