@expofp/offline 0.0.0-experimental.cf063fc

package/dist/lib/offline-map-style.js

@@ -0,0 +1,284 @@
+import { layers } from '@protomaps/basemaps';
+/**
+ * The offline basemap style, built to look like the online one.
+ *
+ * Online the SDK serves OpenFreeMap's Positron/Dark pair recolored to the
+ * CARTO palettes (`basemap-palette.ts` in the floorplan): Positron for the
+ * light theme, Dark Matter for the dark one. Both are OpenMapTiles-schema
+ * styles; offline tiles come from a Protomaps basemap build, a different
+ * schema, so the *style* cannot be shared — only the palette. This module
+ * therefore renders the upstream Protomaps layer set (`@protomaps/basemaps`,
+ * kept current with the tile schema) through flavors whose colors are lifted
+ * from the two CARTO styles.
+ *
+ * Parity is visual, not pixel-exact: the two schemas classify roads, landuse
+ * and labels differently, so features are colored to the nearest CARTO
+ * equivalent rather than reproduced stop for stop.
+ */
+/**
+ * Backgrounds the two CARTO styles paint their land on. Fills that CARTO makes
+ * translucent are pre-blended over these, because the Protomaps layers paint
+ * them opaque.
+ */
+const POSITRON_BACKGROUND = '#fafaf8';
+const DARK_MATTER_BACKGROUND = '#0e0e0e';
+/**
+ * Protomaps draws buildings at 50% opacity; these are the fills that land on
+ * the CARTO building color once blended over the background.
+ *
+ * The target is CARTO's `building-top` (`#ededed` light, `#393939` dark), not
+ * its `building`: the latter is the extruded wall — `transparent` in Dark
+ * Matter — visible only as a sliver along the offset edge, so matching it
+ * would paint every roof wrong.
+ */
+const POSITRON_BUILDING_FILL = '#e0e0e2';
+const DARK_MATTER_BUILDING_FILL = '#646464';
+/**
+ * A single font stack for every label.
+ *
+ * The Protomaps layers ask for Regular, Medium and Italic; pinning all three to
+ * Regular keeps the offline archive at one downloaded glyph set instead of
+ * three, at the cost of unemphasized city and shield labels. The CARTO styles'
+ * own label weights are light throughout, so the flattening is barely visible.
+ */
+const GLYPH_FONTSTACK = 'Noto Sans Regular';
+/** The one font stack every label in {@link createOfflineMapStyle} asks for. */
+export const OFFLINE_GLYPH_FONTSTACK = GLYPH_FONTSTACK;
+/** CARTO Positron's road casing (`#ddd`) and its paler low-zoom variant. */
+const LIGHT_ROAD_CASING = '#dddddd';
+const LIGHT_ROAD_CASING_LOW_ZOOM = '#e6e6e6';
+/** Positron road fills: `#fdfdfd` for minor roads, pure white for the rest. */
+const LIGHT_ROAD_MINOR_FILL = '#fdfdfd';
+const LIGHT_ROAD_MAJOR_FILL = '#ffffff';
+/** Positron's translucent green landuse and grey residential, pre-blended. */
+const LIGHT_GREEN_FILL = '#f2f6f1';
+const LIGHT_GREY_FILL = '#f6f6f5';
+/**
+ * The Protomaps flavor recolored to CARTO Positron.
+ *
+ * `pois` is deliberately absent: it is optional, and leaving it out drops the
+ * colored POI icon layers entirely — the CARTO styles show no POI icons, so
+ * emitting them would be the loudest departure from the online look.
+ */
+export const POSITRON_FLAVOR = {
+    background: POSITRON_BACKGROUND,
+    earth: POSITRON_BACKGROUND,
+    park_a: LIGHT_GREEN_FILL,
+    park_b: LIGHT_GREEN_FILL,
+    hospital: LIGHT_GREY_FILL,
+    industrial: LIGHT_GREY_FILL,
+    school: LIGHT_GREY_FILL,
+    wood_a: LIGHT_GREEN_FILL,
+    wood_b: LIGHT_GREEN_FILL,
+    pedestrian: '#f4f4f2',
+    scrub_a: LIGHT_GREEN_FILL,
+    scrub_b: LIGHT_GREEN_FILL,
+    glacier: '#f7f7f7',
+    sand: '#f7f6f2',
+    beach: '#f7f6f2',
+    aerodrome: '#f4f4f4',
+    runway: '#e8e8e8',
+    water: '#d4dadc',
+    zoo: LIGHT_GREEN_FILL,
+    military: LIGHT_GREEN_FILL,
+    tunnel_other_casing: LIGHT_ROAD_CASING,
+    tunnel_minor_casing: LIGHT_ROAD_CASING,
+    tunnel_link_casing: LIGHT_ROAD_CASING,
+    tunnel_major_casing: LIGHT_ROAD_CASING,
+    tunnel_highway_casing: LIGHT_ROAD_CASING,
+    tunnel_other: '#eeeeee',
+    tunnel_minor: '#eeeeee',
+    tunnel_link: '#eeeeee',
+    tunnel_major: '#eeeeee',
+    tunnel_highway: '#eeeeee',
+    pier: '#f0f0ee',
+    buildings: POSITRON_BUILDING_FILL,
+    minor_service_casing: LIGHT_ROAD_CASING,
+    minor_casing: LIGHT_ROAD_CASING,
+    link_casing: LIGHT_ROAD_CASING,
+    major_casing_late: LIGHT_ROAD_CASING,
+    highway_casing_late: LIGHT_ROAD_CASING,
+    other: LIGHT_ROAD_MINOR_FILL,
+    minor_service: LIGHT_ROAD_MINOR_FILL,
+    // Minor roads fade from casing grey to their fill as they widen, the way
+    // Positron's thin low-zoom casings read before the white fill takes over.
+    minor_a: LIGHT_ROAD_CASING_LOW_ZOOM,
+    minor_b: LIGHT_ROAD_MINOR_FILL,
+    link: LIGHT_ROAD_MAJOR_FILL,
+    major_casing_early: LIGHT_ROAD_CASING,
+    major: LIGHT_ROAD_MAJOR_FILL,
+    highway_casing_early: LIGHT_ROAD_CASING,
+    highway: LIGHT_ROAD_MAJOR_FILL,
+    railway: '#dddddd',
+    boundaries: '#e1c5c7',
+    bridges_other_casing: LIGHT_ROAD_CASING,
+    bridges_minor_casing: LIGHT_ROAD_CASING,
+    bridges_link_casing: LIGHT_ROAD_CASING,
+    bridges_major_casing: LIGHT_ROAD_CASING,
+    bridges_highway_casing: LIGHT_ROAD_CASING,
+    bridges_other: LIGHT_ROAD_MINOR_FILL,
+    bridges_minor: LIGHT_ROAD_MINOR_FILL,
+    bridges_link: LIGHT_ROAD_MAJOR_FILL,
+    bridges_major: LIGHT_ROAD_MAJOR_FILL,
+    bridges_highway: LIGHT_ROAD_MAJOR_FILL,
+    roads_label_minor: '#838383',
+    roads_label_minor_halo: '#ffffff',
+    roads_label_major: '#838383',
+    roads_label_major_halo: '#ffffff',
+    ocean_label: '#abb6be',
+    subplace_label: '#697b89',
+    subplace_label_halo: '#ffffff',
+    city_label: '#697b89',
+    city_label_halo: '#ffffff',
+    state_label: '#97a4ae',
+    state_label_halo: POSITRON_BACKGROUND,
+    country_label: '#8a99a4',
+    address_label: '#a3a3a3',
+    address_label_halo: '#ffffff',
+    regular: GLYPH_FONTSTACK,
+    bold: GLYPH_FONTSTACK,
+    italic: GLYPH_FONTSTACK,
+    landcover: {
+        grassland: LIGHT_GREEN_FILL,
+        barren: '#f7f6f2',
+        urban_area: LIGHT_GREY_FILL,
+        farmland: LIGHT_GREEN_FILL,
+        glacier: '#f7f7f7',
+        scrub: LIGHT_GREEN_FILL,
+        forest: LIGHT_GREEN_FILL,
+    },
+};
+/** Dark Matter's road bands: minor and secondary flat, primary and motorway lifted. */
+const DARK_ROAD_MINOR_FILL = '#414758';
+const DARK_ROAD_MAJOR_FILL = '#535666';
+const DARK_ROAD_HIGHWAY_FILL = '#494949';
+const DARK_ROAD_SERVICE_FILL = '#0b0b0b';
+/** Dark Matter outlines its bigger roads; minor roads get no visible casing. */
+const DARK_ROAD_CASING = '#232323';
+const DARK_TUNNEL_CASING = '#1a1a1a';
+/**
+ * The Protomaps flavor recolored to CARTO Dark Matter.
+ *
+ * Dark Matter tints no landuse at all — its parks, landcover and residential
+ * blocks are all painted the background color — so every land field here
+ * collapses onto {@link DARK_MATTER_BACKGROUND}. That is the intended look, not
+ * an omission.
+ */
+export const DARK_MATTER_FLAVOR = {
+    background: DARK_MATTER_BACKGROUND,
+    earth: DARK_MATTER_BACKGROUND,
+    park_a: DARK_MATTER_BACKGROUND,
+    park_b: DARK_MATTER_BACKGROUND,
+    hospital: DARK_MATTER_BACKGROUND,
+    industrial: DARK_MATTER_BACKGROUND,
+    school: DARK_MATTER_BACKGROUND,
+    wood_a: DARK_MATTER_BACKGROUND,
+    wood_b: DARK_MATTER_BACKGROUND,
+    pedestrian: DARK_MATTER_BACKGROUND,
+    scrub_a: DARK_MATTER_BACKGROUND,
+    scrub_b: DARK_MATTER_BACKGROUND,
+    glacier: DARK_MATTER_BACKGROUND,
+    sand: DARK_MATTER_BACKGROUND,
+    beach: DARK_MATTER_BACKGROUND,
+    aerodrome: DARK_MATTER_BACKGROUND,
+    runway: '#111111',
+    water: '#2c353c',
+    zoo: DARK_MATTER_BACKGROUND,
+    military: DARK_MATTER_BACKGROUND,
+    tunnel_other_casing: DARK_TUNNEL_CASING,
+    tunnel_minor_casing: DARK_TUNNEL_CASING,
+    tunnel_link_casing: DARK_TUNNEL_CASING,
+    tunnel_major_casing: DARK_ROAD_CASING,
+    tunnel_highway_casing: DARK_ROAD_CASING,
+    tunnel_other: '#161616',
+    tunnel_minor: '#161616',
+    tunnel_link: '#161616',
+    tunnel_major: DARK_ROAD_MINOR_FILL,
+    tunnel_highway: DARK_ROAD_MINOR_FILL,
+    pier: DARK_TUNNEL_CASING,
+    buildings: DARK_MATTER_BUILDING_FILL,
+    minor_service_casing: '#1c1c1c',
+    // Dark Matter paints the minor casing the same color as the fill, so minor
+    // roads read as one flat band rather than a lined one.
+    minor_casing: DARK_ROAD_MINOR_FILL,
+    link_casing: DARK_ROAD_CASING,
+    major_casing_late: DARK_ROAD_CASING,
+    highway_casing_late: DARK_ROAD_CASING,
+    other: DARK_ROAD_SERVICE_FILL,
+    minor_service: DARK_ROAD_SERVICE_FILL,
+    minor_a: DARK_ROAD_MINOR_FILL,
+    minor_b: DARK_ROAD_MINOR_FILL,
+    link: DARK_ROAD_MINOR_FILL,
+    major_casing_early: DARK_ROAD_CASING,
+    major: DARK_ROAD_MAJOR_FILL,
+    highway_casing_early: DARK_ROAD_CASING,
+    highway: DARK_ROAD_HIGHWAY_FILL,
+    railway: '#1a1a1a',
+    boundaries: '#5c5e5e',
+    // Deliberate deviation: Dark Matter fills most bridge decks near-black
+    // (`#0b0b0b`) and lets the casing carry them, which on the Protomaps layer
+    // set reads as a bridge that vanishes. Mirroring the road colors keeps
+    // bridges legible at the cost of an exact match on a feature that is rare
+    // inside a venue's bbox.
+    bridges_other_casing: DARK_ROAD_CASING,
+    bridges_minor_casing: DARK_ROAD_CASING,
+    bridges_link_casing: DARK_ROAD_CASING,
+    bridges_major_casing: DARK_ROAD_CASING,
+    bridges_highway_casing: DARK_ROAD_CASING,
+    bridges_other: DARK_ROAD_SERVICE_FILL,
+    bridges_minor: DARK_ROAD_MINOR_FILL,
+    bridges_link: DARK_ROAD_MINOR_FILL,
+    bridges_major: DARK_ROAD_MAJOR_FILL,
+    bridges_highway: DARK_ROAD_HIGHWAY_FILL,
+    roads_label_minor: '#b5b4b4',
+    roads_label_minor_halo: '#111111',
+    roads_label_major: '#b5b4b4',
+    roads_label_major_halo: '#111111',
+    ocean_label: '#6d7b81',
+    subplace_label: '#ccd0e4',
+    subplace_label_halo: '#222222',
+    city_label: '#ccd0e4',
+    city_label_halo: '#222222',
+    state_label: '#cbe6e6',
+    state_label_halo: '#222222',
+    country_label: '#9d9d9d',
+    address_label: '#515151',
+    address_label_halo: '#111111',
+    regular: GLYPH_FONTSTACK,
+    bold: GLYPH_FONTSTACK,
+    italic: GLYPH_FONTSTACK,
+    landcover: {
+        grassland: DARK_MATTER_BACKGROUND,
+        barren: DARK_MATTER_BACKGROUND,
+        urban_area: DARK_MATTER_BACKGROUND,
+        farmland: DARK_MATTER_BACKGROUND,
+        glacier: DARK_MATTER_BACKGROUND,
+        scrub: DARK_MATTER_BACKGROUND,
+        forest: DARK_MATTER_BACKGROUND,
+    },
+};
+const FLAVORS = {
+    light: POSITRON_FLAVOR,
+    dark: DARK_MATTER_FLAVOR,
+};
+/**
+ * Build the offline style document.
+ *
+ * URLs stay relative to the style so the archive is relocatable; the SDK
+ * absolutizes them at load time (see `MapLibreConfigSchema`).
+ */
+export function createOfflineMapStyle(options) {
+    return {
+        version: 8,
+        sources: {
+            protomaps: {
+                type: 'vector',
+                attribution: '<a href="https://github.com/protomaps/basemaps">Protomaps</a> © <a href="https://openstreetmap.org">OpenStreetMap</a>',
+                url: `pmtiles://${options.tiles}`,
+            },
+        },
+        sprite: options.sprite,
+        glyphs: options.glyphs,
+        layers: layers('protomaps', FLAVORS[options.theme], { lang: 'en' }),
+    };
+}

package/dist/lib/resolve-floorplan-dir.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Locates the `@expofp/floorplan` browser build directory on disk and
+ * returns a `file://` URL string (with trailing slash) pointing at it.
+ *
+ * Throws if the package or its `bundle.json` cannot be found.
+ */
+export declare function resolveFloorplanDir(): Promise<string>;
+//# sourceMappingURL=resolve-floorplan-dir.d.ts.map

package/dist/lib/resolve-floorplan-dir.js

@@ -0,0 +1,34 @@
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import { importFsPromises } from '@expofp/utils';
+/**
+ * Locates the `@expofp/floorplan` browser build directory on disk and
+ * returns a `file://` URL string (with trailing slash) pointing at it.
+ *
+ * Throws if the package or its `bundle.json` cannot be found.
+ */
+export async function resolveFloorplanDir() {
+    const require = createRequire(import.meta.url);
+    let pkgJsonPath;
+    try {
+        pkgJsonPath = require.resolve('@expofp/floorplan/package.json');
+    }
+    catch {
+        throw new Error('Could not find @expofp/floorplan. ' +
+            'Ensure it is installed (it should be a dependency of @expofp/offline).');
+    }
+    const pkgDir = path.dirname(pkgJsonPath);
+    const browserDir = path.join(pkgDir, 'dist', 'browser');
+    const bundleJsonPath = path.join(browserDir, 'bundle.json');
+    const fs = await importFsPromises();
+    try {
+        await fs.access(bundleJsonPath);
+    }
+    catch {
+        throw new Error(`Found @expofp/floorplan at ${pkgDir} but dist/browser/bundle.json is missing. ` +
+            'Ensure the package has been built (pnpm nx build-browser @expofp/floorplan).');
+    }
+    // Return file:// URL with trailing slash so new URL(file, base) works
+    return pathToFileURL(browserDir).href + '/';
+}

package/dist/lib/save-offline-zip.d.ts

@@ -0,0 +1,5 @@
+import { type Manifest } from '@expofp/config';
+import { type Ref } from '@expofp/resolve';
+import { type OfflineOptions } from './types.js';
+export declare function saveOfflineZip(manifest: Manifest | Ref<Manifest>, path: string, options: OfflineOptions): Promise<void>;
+//# sourceMappingURL=save-offline-zip.d.ts.map

package/dist/lib/save-offline-zip.js

@@ -0,0 +1,21 @@
+import { importFsPromises } from '@expofp/utils';
+import debug from 'debug';
+import { buildOfflineZip } from './generate-offline-data.js';
+const log = debug('efp:offline:save-offline-zip');
+export async function saveOfflineZip(manifest, path, options) {
+    if (typeof process === 'undefined' || !process.versions?.node) {
+        throw new Error('saveOfflineZip can only be used in a Node.js environment');
+    }
+    if (!path) {
+        throw new Error('Path is required to save the ZIP file');
+    }
+    if (!path.endsWith('.zip')) {
+        throw new Error('The specified path must end with .zip');
+    }
+    log('Saving offline ZIP bundle to', path);
+    const blob = await buildOfflineZip(manifest, options);
+    const arrayBuffer = await blob.arrayBuffer();
+    const fs = await importFsPromises();
+    await fs.writeFile(path, Buffer.from(arrayBuffer));
+    log('Saved offline ZIP bundle to', path);
+}

package/dist/lib/types.d.ts

@@ -0,0 +1,21 @@
+export type LocalData = LocalDataFetch | LocalDataText;
+export interface LocalDataFetch {
+    url: URL;
+    targetFilePath: string;
+    /** An expected-missing resource (fabricated variant URLs): skip, don't fail, when the download fails. */
+    optional?: boolean;
+}
+export interface LocalDataText {
+    text: string;
+    targetFilePath: string;
+}
+export interface OfflineOptions {
+    signal?: AbortSignal;
+    runtimeBaseUrl: string;
+    offlineMap?: OfflineMapOptions;
+    inferOfflineMap?: boolean;
+}
+export interface OfflineMapOptions {
+    mapSource?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@expofp/offline",
+  "version": "0.0.0-experimental.cf063fc",
+  "type": "module",
+  "description": "CLI tool for creating offline copies of ExpoFP floor plans",
+  "homepage": "https://developer.expofp.com/",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@expofp/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "expofp-offline": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo",
+    "!**/*.map"
+  ],
+  "dependencies": {
+    "@protomaps/basemaps": "^5.7.2",
+    "color": "^3.1.2",
+    "debug": "^4.4.3",
+    "tslib": "^2.3.0",
+    "@expofp/config": "0.0.0-experimental.cf063fc",
+    "@expofp/floorplan": "0.0.0-experimental.cf063fc",
+    "@expofp/geometry": "0.0.0-experimental.cf063fc",
+    "@expofp/resolve": "0.0.0-experimental.cf063fc",
+    "@expofp/schema": "0.0.0-experimental.cf063fc",
+    "@expofp/utils": "0.0.0-experimental.cf063fc"
+  },
+  "devDependencies": {
+    "@types/color": "^3.0.7"
+  }
+}