@honua/app-platform 0.0.20-alpha.0

package/contract/jobs.d.ts

@@ -0,0 +1,149 @@
+/**
+ * Canonical async-operation surface. `IJobRun` is the protocol-neutral
+ * vocabulary every long-running operation in the SDK speaks. It is the
+ * receipt returned from operations that complete asynchronously on the
+ * server (OGC API Processes execution, future GeoServices async export
+ * tickets, OData function imports, etc.).
+ *
+ * Per the ticket constraint, OGC Processes specifically must surface
+ * through this shared interface — there is no `OgcJobRun` top-level
+ * type. The implementation in `src/core/ogc-processes.ts` returns
+ * `IJobRun<T>` directly.
+ *
+ * @module
+ */
+/**
+ * Coarse-grained job lifecycle. The OGC API Processes 1.0 status values
+ * (`accepted`, `running`, `successful`, `failed`, `dismissed`) are the
+ * canonical vocabulary; adapters for protocols that report a narrower or
+ * wider set must map onto these.
+ */
+export type JobStatus = "accepted" | "running" | "successful" | "failed" | "dismissed";
+/** Human-meaningful job-progress signal. Optional; servers may omit fields. */
+export interface JobProgress {
+    /** 0..100. Omitted when the server does not report a numeric estimate. */
+    percent?: number;
+    /** Human-readable status message for the current step. */
+    message?: string;
+    /** ISO-8601 timestamp of when the server last updated the progress. */
+    updatedAt?: string;
+}
+/**
+ * Snapshot of a job's state. Returned from `IJobRun.poll()` and emitted
+ * to `IJobRun.watch` listeners. The result/error fields are filled only
+ * for terminal states.
+ */
+export interface JobSnapshot<T = unknown> {
+    status: JobStatus;
+    progress?: JobProgress;
+    /** Payload returned for terminal `successful` snapshots only. */
+    result?: JobResult<T>;
+    /** Error envelope returned for terminal `failed` snapshots. */
+    error?: JobError;
+}
+/**
+ * Server-side error envelope for a failed job. Mirrors the OGC API
+ * Processes "exception" shape; adapters for other protocols translate
+ * onto this surface so callers can branch on `code` without protocol
+ * knowledge.
+ */
+export interface JobError {
+    /** Stable machine code (e.g. `"InvalidParameterValue"`). */
+    code: string;
+    /** Human-readable explanation. */
+    message: string;
+    /** Optional details payload as returned by the server. */
+    details?: unknown;
+}
+/**
+ * Job-result document. `outputs` is a map of output-id → value; the SDK
+ * does not parse the value further (it may be a GeoJSON feature
+ * collection, a download URL, a binary asset, etc., depending on the
+ * process). Adapters narrow `T` for typed access.
+ */
+export interface JobResult<T = unknown> {
+    outputs: Record<string, T>;
+}
+/** Listener function invoked on every observed snapshot transition. */
+export type JobSnapshotListener<T = unknown> = (snapshot: JobSnapshot<T>) => void;
+/**
+ * Bounds for {@link IJobRun.results}. Without any bound a hung or never-terminal
+ * status endpoint polls forever with no caller cancellation. Implementations
+ * pass {@link signal} through to the underlying status request, stop polling
+ * when the signal aborts or a deadline / attempt cap is reached, and use capped
+ * exponential backoff between polls.
+ */
+export interface JobResultsOptions {
+    /** Abort the poll loop (and the in-flight status request) when this fires. */
+    readonly signal?: AbortSignal;
+    /** Wall-clock budget in ms for reaching a terminal state. */
+    readonly deadlineMs?: number;
+    /** Maximum number of status polls before giving up. */
+    readonly maxAttempts?: number;
+    /** Base poll interval in ms (defaults to the adapter's cadence). */
+    readonly pollIntervalMs?: number;
+    /** Cap for the exponential backoff interval in ms. */
+    readonly maxPollIntervalMs?: number;
+}
+/**
+ * Canonical async-operation handle. Methods are intentionally narrow so
+ * downstream tickets that submit jobs (operator workflows, manifest
+ * apply, etc.) can speak one vocabulary across protocols.
+ */
+export interface IJobRun<T = unknown> {
+    /** Stable identifier assigned by the server when the job was accepted. */
+    readonly id: string;
+    /** Process / operation identifier, e.g. an OGC processId. */
+    readonly type: string;
+    /**
+     * Last-observed status. Backed by the most recent `poll()` /
+     * `status()` / `watch()` snapshot; reads are synchronous.
+     */
+    readonly status: JobStatus;
+    /** Last-observed progress, if the server reported any. */
+    readonly progress: JobProgress | undefined;
+    /** Force a fresh server poll and return the resulting snapshot. */
+    poll(): Promise<JobSnapshot<T>>;
+    /**
+     * Subscribe to snapshot transitions. The callback fires on every
+     * observed status / progress change, and again on the terminal
+     * snapshot. Returns an unsubscribe handle.
+     */
+    watch(listener: JobSnapshotListener<T>): () => void;
+    /**
+     * Wait for the job to reach a terminal state and resolve with the
+     * outputs. Rejects with `HonuaJobFailedError` for `failed` /
+     * `dismissed` terminal states, or `HonuaJobPollTimeoutError` when the
+     * optional {@link JobResultsOptions} deadline / attempt cap is reached or
+     * the supplied signal aborts. Implementations poll on a configurable
+     * interval (capped exponential backoff); the default cadence is left to
+     * the adapter.
+     */
+    results(options?: JobResultsOptions): Promise<JobResult<T>>;
+    /**
+     * Cancel / dismiss the job. Idempotent. Returns the resulting status
+     * (typically `dismissed`, but the server may have raced to a terminal
+     * state already, in which case the original terminal status is
+     * returned).
+     */
+    cancel(): Promise<JobStatus>;
+}
+/**
+ * `true` when the snapshot status is one of the terminal values
+ * (`successful`, `failed`, `dismissed`). Useful for stop conditions in
+ * watchers and tests.
+ */
+export declare function isJobTerminal(status: JobStatus): boolean;
+/**
+ * Thrown by {@link IJobRun.results} when the poll loop is cancelled or exhausted
+ * before the job reached a terminal state — i.e. the {@link JobResultsOptions}
+ * signal aborted, the deadline elapsed, or the attempt cap was hit. `reason`
+ * distinguishes the three so callers can branch (e.g. retry vs surface).
+ */
+export declare class HonuaJobPollTimeoutError extends Error {
+    readonly reason: "aborted" | "deadline" | "max-attempts";
+    readonly jobId: string;
+    readonly lastStatus: JobStatus;
+    constructor(message: string, reason: "aborted" | "deadline" | "max-attempts", jobId: string, lastStatus: JobStatus);
+}
+//# sourceMappingURL=jobs.d.ts.map

package/contract/jobs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../../src/contract/jobs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,YAAY,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEvF,+EAA+E;AAC/E,MAAM,WAAW,WAAW;IAC1B,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,GAAG,OAAO;IACtC,MAAM,EAAE,SAAS,CAAC;IAClB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,iEAAiE;IACjE,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACtB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,GAAG,OAAO;IACpC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;CAC5B;AAED,uEAAuE;AACvE,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAElF;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,8EAA8E;IAC9E,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,6DAA6D;IAC7D,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,uDAAuD;IACvD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,oEAAoE;IACpE,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,sDAAsD;IACtD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO,CAAC,CAAC,GAAG,OAAO;IAClC,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,0DAA0D;IAC1D,QAAQ,CAAC,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAC;IAC3C,mEAAmE;IACnE,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC;IACpD;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5D;;;;;OAKG;IACH,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;CAC9B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO,CAExD;AAED;;;;;GAKG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;IACjD,SAAgB,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,cAAc,CAAC;IAChE,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,UAAU,EAAE,SAAS,CAAC;gBAGpC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,cAAc,EAC/C,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,SAAS;CAQxB"}

package/contract/jobs.js

@@ -0,0 +1,40 @@
+/**
+ * Canonical async-operation surface. `IJobRun` is the protocol-neutral
+ * vocabulary every long-running operation in the SDK speaks. It is the
+ * receipt returned from operations that complete asynchronously on the
+ * server (OGC API Processes execution, future GeoServices async export
+ * tickets, OData function imports, etc.).
+ *
+ * Per the ticket constraint, OGC Processes specifically must surface
+ * through this shared interface — there is no `OgcJobRun` top-level
+ * type. The implementation in `src/core/ogc-processes.ts` returns
+ * `IJobRun<T>` directly.
+ *
+ * @module
+ */
+/**
+ * `true` when the snapshot status is one of the terminal values
+ * (`successful`, `failed`, `dismissed`). Useful for stop conditions in
+ * watchers and tests.
+ */
+export function isJobTerminal(status) {
+    return status === "successful" || status === "failed" || status === "dismissed";
+}
+/**
+ * Thrown by {@link IJobRun.results} when the poll loop is cancelled or exhausted
+ * before the job reached a terminal state — i.e. the {@link JobResultsOptions}
+ * signal aborted, the deadline elapsed, or the attempt cap was hit. `reason`
+ * distinguishes the three so callers can branch (e.g. retry vs surface).
+ */
+export class HonuaJobPollTimeoutError extends Error {
+    reason;
+    jobId;
+    lastStatus;
+    constructor(message, reason, jobId, lastStatus) {
+        super(message);
+        this.name = "HonuaJobPollTimeoutError";
+        this.reason = reason;
+        this.jobId = jobId;
+        this.lastStatus = lastStatus;
+    }
+}

package/contract/pmtiles.d.ts

@@ -0,0 +1,162 @@
+/**
+ * PMTiles archive inspection for the protocol-neutral contract.
+ *
+ * A PMTiles archive is a single, immutable file (on object storage or any
+ * static host) that stores an entire raster or vector tile pyramid. It
+ * participates in the `Dataset` / `Source` model as a **tiles-only** protocol:
+ * the canonical query family throws {@link HonuaCapabilityNotSupportedError}
+ * (there is no feature-query surface on an archive), while archive metadata —
+ * bounds, min/max zoom, and vector layer names — is inspected through
+ * `Source.protocol("pmtiles").describe()`.
+ *
+ * This module never statically imports the `pmtiles` package. The reader is
+ * pulled in lazily (`await import("pmtiles")`) the first time an archive is
+ * actually described, mirroring the Cesium adapter so consumers that never
+ * touch PMTiles pay zero bundle cost. A minimal `pmtiles` module slice is
+ * modelled here so the wiring stays unit-testable against an injected fake
+ * without a network fetch.
+ *
+ * @module
+ */
+/**
+ * Canonical tile-payload kinds a PMTiles archive can store. `mvt` is a vector
+ * archive (Mapbox Vector Tiles); the rest are raster encodings. `unknown`
+ * covers archives whose header tile-type byte the reader could not classify.
+ */
+export type PmtilesTileKind = "mvt" | "png" | "jpeg" | "webp" | "avif" | "unknown";
+/**
+ * One vector layer advertised in a vector archive's TileJSON-style metadata
+ * (`vector_layers`). Present only for `mvt` archives; raster archives report an
+ * empty {@link PmtilesArchiveDescription.vectorLayers} list.
+ */
+export interface PmtilesVectorLayerInfo {
+    /** Layer id — the MapLibre `source-layer` name to reference in a style. */
+    readonly id: string;
+    /** Optional human description carried in the archive metadata. */
+    readonly description?: string;
+    /** Optional per-layer minimum zoom advertised in the metadata. */
+    readonly minZoom?: number;
+    /** Optional per-layer maximum zoom advertised in the metadata. */
+    readonly maxZoom?: number;
+    /** Optional field-name → type map advertised in the metadata. */
+    readonly fields?: Readonly<Record<string, string>>;
+}
+/**
+ * The archive metadata surfaced by {@link describePmtilesArchive}. Bounds are
+ * `[west, south, east, north]` in degrees; `center` is `[lon, lat, zoom]`. The
+ * raw metadata JSON is preserved on `metadata` for callers that need archive
+ * fields beyond the normalized shape.
+ */
+export interface PmtilesArchiveDescription {
+    /** Archive URL the description was read from. */
+    readonly url: string;
+    /** Tile payload kind stored in the archive. */
+    readonly tileKind: PmtilesTileKind;
+    /** Geographic bounds `[west, south, east, north]` in degrees. */
+    readonly bounds: readonly [number, number, number, number];
+    /** Lowest zoom level present in the archive. */
+    readonly minZoom: number;
+    /** Highest zoom level present in the archive. */
+    readonly maxZoom: number;
+    /** Suggested view center `[lon, lat, zoom]`. */
+    readonly center: readonly [number, number, number];
+    /** Vector layer definitions (empty for raster archives). */
+    readonly vectorLayers: readonly PmtilesVectorLayerInfo[];
+    /** Attribution string advertised in the archive metadata, when present. */
+    readonly attribution?: string;
+    /** The raw, parsed archive metadata JSON. */
+    readonly metadata: Readonly<Record<string, unknown>>;
+}
+/** A byte-range response from a {@link PmtilesSourceLike}. */
+export interface PmtilesRangeResponse {
+    readonly data: ArrayBuffer;
+    readonly etag?: string;
+}
+/**
+ * The `pmtiles` `Source` surface — a byte-range reader over the archive. A
+ * remote archive uses the reader's own `FetchSource`; a local fixture (tests)
+ * supplies a buffer-backed implementation.
+ */
+export interface PmtilesSourceLike {
+    getBytes(offset: number, length: number, signal?: AbortSignal, etag?: string): Promise<PmtilesRangeResponse>;
+    getKey(): string;
+}
+/** The `Header` fields this module reads (a subset of `pmtiles.Header`). */
+export interface PmtilesHeaderLike {
+    readonly minZoom: number;
+    readonly maxZoom: number;
+    readonly minLon: number;
+    readonly minLat: number;
+    readonly maxLon: number;
+    readonly maxLat: number;
+    readonly centerZoom: number;
+    readonly centerLon: number;
+    readonly centerLat: number;
+    readonly tileType: number;
+}
+/** The `PMTiles` reader surface this module drives. */
+export interface PmtilesArchiveLike {
+    getHeader(): Promise<PmtilesHeaderLike>;
+    getMetadata(): Promise<unknown>;
+}
+/** The minimal slice of `typeof import("pmtiles")` the describe path needs. */
+export interface PmtilesModuleLike {
+    new (source: PmtilesSourceLike | string): PmtilesArchiveLike;
+}
+/** Injectable dependencies for {@link describePmtilesArchive} (test seams). */
+export interface DescribePmtilesArchiveDeps {
+    /** Override the lazily-imported `pmtiles.PMTiles` constructor. */
+    readonly PMTiles?: PmtilesModuleLike;
+    /** Read from a local/in-memory source instead of fetching `url`. */
+    readonly source?: PmtilesSourceLike;
+}
+/**
+ * Inspect a PMTiles archive and return its normalized metadata (bounds, min/max
+ * zoom, suggested center, and vector layer names). The `pmtiles` reader is
+ * imported lazily on first use.
+ *
+ * Pass {@link DescribePmtilesArchiveDeps.source} to read a local archive (the
+ * unit-test path) or {@link DescribePmtilesArchiveDeps.PMTiles} to inject a fake
+ * reader; both default to fetching `url` through the real reader.
+ *
+ * @example
+ * ```ts
+ * const info = await describePmtilesArchive("https://example.com/basemap.pmtiles");
+ * console.log(info.bounds, info.minZoom, info.maxZoom);
+ * for (const layer of info.vectorLayers) console.log(layer.id);
+ * ```
+ */
+export declare function describePmtilesArchive(url: string, deps?: DescribePmtilesArchiveDeps): Promise<PmtilesArchiveDescription>;
+/**
+ * Typed adapter handle for a PMTiles archive, reachable through
+ * `Source.protocol("pmtiles")`. Provides the archive-metadata inspection
+ * surface ({@link HonuaPmtilesArchive.describe}) that the tiles-only PMTiles
+ * `Source` uses to participate in the Dataset model honestly. The first
+ * `describe()` call is cached so repeated inspection does not re-open the
+ * archive.
+ */
+export declare class HonuaPmtilesArchive {
+    #private;
+    /** The `pmtiles://`-free archive URL this handle inspects. */
+    readonly url: string;
+    constructor(url: string, deps?: DescribePmtilesArchiveDeps);
+    /**
+     * Inspect the archive and return its normalized metadata. Cached after the
+     * first successful call; a failed inspection is not cached so a transient
+     * fetch error can be retried.
+     */
+    describe(): Promise<PmtilesArchiveDescription>;
+}
+/**
+ * Strip a leading `pmtiles://` scheme from an archive URL, if present. MapLibre
+ * style sources address PMTiles archives as `pmtiles://https://…`; the reader
+ * (and this contract's describe path) want the bare archive URL.
+ */
+export declare function stripPmtilesScheme(url: string): string;
+/**
+ * Add the `pmtiles://` scheme to a bare archive URL if it is not already
+ * present. The inverse of {@link stripPmtilesScheme}; use it when composing a
+ * MapLibre source `url` from a plain archive locator.
+ */
+export declare function toPmtilesSourceUrl(url: string): string;
+//# sourceMappingURL=pmtiles.d.ts.map

package/contract/pmtiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pmtiles.d.ts","sourceRoot":"","sources":["../../../src/contract/pmtiles.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AAEnF;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,kEAAkE;IAClE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,kEAAkE;IAClE,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,iEAAiE;IACjE,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CACpD;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,iDAAiD;IACjD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,iEAAiE;IACjE,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3D,gDAAgD;IAChD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,iDAAiD;IACjD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACnD,4DAA4D;IAC5D,QAAQ,CAAC,YAAY,EAAE,SAAS,sBAAsB,EAAE,CAAC;IACzD,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,6CAA6C;IAC7C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACtD;AAID,8DAA8D;AAC9D,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC7G,MAAM,IAAI,MAAM,CAAC;CAClB;AAED,4EAA4E;AAC5E,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,uDAAuD;AACvD,MAAM,WAAW,kBAAkB;IACjC,SAAS,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACxC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CACjC;AAED,+EAA+E;AAC/E,MAAM,WAAW,iBAAiB;IAChC,KAAK,MAAM,EAAE,iBAAiB,GAAG,MAAM,GAAG,kBAAkB,CAAC;CAC9D;AAED,+EAA+E;AAC/E,MAAM,WAAW,0BAA0B;IACzC,kEAAkE;IAClE,QAAQ,CAAC,OAAO,CAAC,EAAE,iBAAiB,CAAC;IACrC,oEAAoE;IACpE,QAAQ,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC;CACrC;AA4DD;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,sBAAsB,CAC1C,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,0BAA+B,GACpC,OAAO,CAAC,yBAAyB,CAAC,CAkBpC;AAED;;;;;;;GAOG;AACH,qBAAa,mBAAmB;;IAC9B,8DAA8D;IAC9D,SAAgB,GAAG,EAAE,MAAM,CAAC;gBAIT,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,0BAA+B;IAKrE;;;;OAIG;IACI,QAAQ,IAAI,OAAO,CAAC,yBAAyB,CAAC;CAStD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD"}

package/contract/pmtiles.js

@@ -0,0 +1,155 @@
+/**
+ * PMTiles archive inspection for the protocol-neutral contract.
+ *
+ * A PMTiles archive is a single, immutable file (on object storage or any
+ * static host) that stores an entire raster or vector tile pyramid. It
+ * participates in the `Dataset` / `Source` model as a **tiles-only** protocol:
+ * the canonical query family throws {@link HonuaCapabilityNotSupportedError}
+ * (there is no feature-query surface on an archive), while archive metadata —
+ * bounds, min/max zoom, and vector layer names — is inspected through
+ * `Source.protocol("pmtiles").describe()`.
+ *
+ * This module never statically imports the `pmtiles` package. The reader is
+ * pulled in lazily (`await import("pmtiles")`) the first time an archive is
+ * actually described, mirroring the Cesium adapter so consumers that never
+ * touch PMTiles pay zero bundle cost. A minimal `pmtiles` module slice is
+ * modelled here so the wiring stays unit-testable against an injected fake
+ * without a network fetch.
+ *
+ * @module
+ */
+/**
+ * Lazily import the `pmtiles` reader. Kept in its own function so the dynamic
+ * `import("pmtiles")` is the only reference to the package in `src/`, which is
+ * what keeps PMTiles out of every bundle that never inspects an archive.
+ */
+async function loadPmtilesCtor() {
+    const mod = (await import("pmtiles"));
+    return mod.PMTiles;
+}
+/**
+ * The `pmtiles` `TileType` enum values (spec v3). Duplicated here as a plain
+ * map so classification does not force a value import of the package.
+ */
+const TILE_KIND_BY_TYPE = {
+    0: "unknown",
+    1: "mvt",
+    2: "png",
+    3: "jpeg",
+    4: "webp",
+    5: "avif",
+};
+function tileKindFromHeader(tileType) {
+    return TILE_KIND_BY_TYPE[tileType] ?? "unknown";
+}
+function readVectorLayers(metadata) {
+    const raw = metadata.vector_layers;
+    if (!Array.isArray(raw))
+        return [];
+    const layers = [];
+    for (const entry of raw) {
+        if (!entry || typeof entry !== "object")
+            continue;
+        const record = entry;
+        const id = record.id;
+        if (typeof id !== "string" || id === "")
+            continue;
+        const info = { id };
+        if (typeof record.description === "string")
+            info.description = record.description;
+        if (typeof record.minzoom === "number")
+            info.minZoom = record.minzoom;
+        if (typeof record.maxzoom === "number")
+            info.maxZoom = record.maxzoom;
+        if (record.fields && typeof record.fields === "object") {
+            info.fields = record.fields;
+        }
+        layers.push(info);
+    }
+    return layers;
+}
+function asMetadataRecord(metadata) {
+    return metadata && typeof metadata === "object" ? metadata : {};
+}
+/**
+ * Inspect a PMTiles archive and return its normalized metadata (bounds, min/max
+ * zoom, suggested center, and vector layer names). The `pmtiles` reader is
+ * imported lazily on first use.
+ *
+ * Pass {@link DescribePmtilesArchiveDeps.source} to read a local archive (the
+ * unit-test path) or {@link DescribePmtilesArchiveDeps.PMTiles} to inject a fake
+ * reader; both default to fetching `url` through the real reader.
+ *
+ * @example
+ * ```ts
+ * const info = await describePmtilesArchive("https://example.com/basemap.pmtiles");
+ * console.log(info.bounds, info.minZoom, info.maxZoom);
+ * for (const layer of info.vectorLayers) console.log(layer.id);
+ * ```
+ */
+export async function describePmtilesArchive(url, deps = {}) {
+    const PMTiles = deps.PMTiles ?? (await loadPmtilesCtor());
+    const archive = deps.source ? new PMTiles(deps.source) : new PMTiles(url);
+    const [header, rawMetadata] = await Promise.all([archive.getHeader(), archive.getMetadata()]);
+    const metadata = asMetadataRecord(rawMetadata);
+    const attribution = typeof metadata.attribution === "string" ? metadata.attribution : undefined;
+    return {
+        url,
+        tileKind: tileKindFromHeader(header.tileType),
+        bounds: [header.minLon, header.minLat, header.maxLon, header.maxLat],
+        minZoom: header.minZoom,
+        maxZoom: header.maxZoom,
+        center: [header.centerLon, header.centerLat, header.centerZoom],
+        vectorLayers: readVectorLayers(metadata),
+        ...(attribution ? { attribution } : {}),
+        metadata,
+    };
+}
+/**
+ * Typed adapter handle for a PMTiles archive, reachable through
+ * `Source.protocol("pmtiles")`. Provides the archive-metadata inspection
+ * surface ({@link HonuaPmtilesArchive.describe}) that the tiles-only PMTiles
+ * `Source` uses to participate in the Dataset model honestly. The first
+ * `describe()` call is cached so repeated inspection does not re-open the
+ * archive.
+ */
+export class HonuaPmtilesArchive {
+    /** The `pmtiles://`-free archive URL this handle inspects. */
+    url;
+    #deps;
+    #description;
+    constructor(url, deps = {}) {
+        this.url = url;
+        this.#deps = deps;
+    }
+    /**
+     * Inspect the archive and return its normalized metadata. Cached after the
+     * first successful call; a failed inspection is not cached so a transient
+     * fetch error can be retried.
+     */
+    describe() {
+        if (!this.#description) {
+            this.#description = describePmtilesArchive(this.url, this.#deps).catch((error) => {
+                this.#description = undefined;
+                throw error;
+            });
+        }
+        return this.#description;
+    }
+}
+/**
+ * Strip a leading `pmtiles://` scheme from an archive URL, if present. MapLibre
+ * style sources address PMTiles archives as `pmtiles://https://…`; the reader
+ * (and this contract's describe path) want the bare archive URL.
+ */
+export function stripPmtilesScheme(url) {
+    return url.startsWith("pmtiles://") ? url.slice("pmtiles://".length) : url;
+}
+/**
+ * Add the `pmtiles://` scheme to a bare archive URL if it is not already
+ * present. The inverse of {@link stripPmtilesScheme}; use it when composing a
+ * MapLibre source `url` from a plain archive locator.
+ */
+export function toPmtilesSourceUrl(url) {
+    return url.startsWith("pmtiles://") ? url : `pmtiles://${url}`;
+}