@naivemap/map-gl-layer-adaptor 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Naive Map
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function o(r){if(Array.isArray(r))return r;const a=r?.defaultProjectionData?.mainMatrix;if(a)return a;throw new Error("Unable to resolve projection matrix from render arguments.")}function d(r){const e=r?.painter;!e||e.terrain||(e.currentStencilSource=void 0,e._tileClippingMaskIDs={})}function i(r,e){let a;return{id:e.id,type:"custom",renderingMode:e.renderingMode??"2d",onAdd(t,n){a=t,r.onAdd(t,n)},onRemove(t,n){r.onRemove(t,n),a=void 0},render(t,n){if(!a)throw new Error("Layer adaptor render invoked before onAdd.");r.render({map:a,gl:t,matrix:(e.resolveMatrix??o)(n),rawArgs:n,prepareStencilMask:e.prepareStencilMask?()=>e.prepareStencilMask(a):void 0})}}}const c=i,p=i;exports.clearTileClippingMask=d;exports.createCustomLayerAdaptor=i;exports.createMapLibreLayerAdaptor=c;exports.createMapboxLayerAdaptor=p;exports.resolveLayerMatrix=o;

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+export type LngLatTuple = [number, number];
+export type Coordinates = [LngLatTuple, LngLatTuple, LngLatTuple, LngLatTuple];
+export type ProjectionMatrix = number[] | Float32Array;
+export interface ProjectedPoint {
+    x: number;
+    y: number;
+}
+export interface GeoPoint {
+    lng: number;
+    lat: number;
+}
+export interface LayerMap {
+    project(lngLat: LngLatTuple): ProjectedPoint;
+    unproject(point: [number, number]): GeoPoint;
+    getCanvas(): HTMLCanvasElement;
+    getCanvasContainer(): HTMLElement;
+    isMoving(): boolean;
+    triggerRepaint(): void;
+}
+export interface LayerRenderFrame<M extends LayerMap = LayerMap> {
+    map: M;
+    gl: WebGLRenderingContext;
+    matrix: ProjectionMatrix;
+    rawArgs: unknown;
+    prepareStencilMask?: () => void;
+}
+export interface LayerController<M extends LayerMap = LayerMap> {
+    onAdd(map: M, gl?: WebGLRenderingContext): void;
+    onRemove(map: M, gl?: WebGLRenderingContext): void;
+    render(frame: LayerRenderFrame<M>): void;
+}
+export interface CustomLayerAdaptorOptions<M extends LayerMap = LayerMap> {
+    id: string;
+    renderingMode?: '2d' | '3d';
+    resolveMatrix?: (args: unknown) => ProjectionMatrix;
+    prepareStencilMask?: (map: M) => void;
+}
+export interface CustomLayerLike<M extends LayerMap = LayerMap> {
+    id: string;
+    type: 'custom';
+    renderingMode?: '2d' | '3d';
+    onAdd(map: M, gl: WebGLRenderingContext): void;
+    onRemove(map: M, gl: WebGLRenderingContext): void;
+    render(gl: WebGLRenderingContext, args: unknown): void;
+}
+export declare function resolveLayerMatrix(args: unknown): ProjectionMatrix;
+export declare function clearTileClippingMask(map: {
+    painter?: any;
+} | undefined): void;
+export declare function createCustomLayerAdaptor<M extends LayerMap>(controller: LayerController<M>, options: CustomLayerAdaptorOptions<M>): CustomLayerLike<M>;
+export declare const createMapLibreLayerAdaptor: typeof createCustomLayerAdaptor;
+export declare const createMapboxLayerAdaptor: typeof createCustomLayerAdaptor;

package/dist/index.js

@@ -0,0 +1,45 @@
+function o(e) {
+  if (Array.isArray(e))
+    return e;
+  const t = e?.defaultProjectionData?.mainMatrix;
+  if (t)
+    return t;
+  throw new Error("Unable to resolve projection matrix from render arguments.");
+}
+function d(e) {
+  const r = e?.painter;
+  !r || r.terrain || (r.currentStencilSource = void 0, r._tileClippingMaskIDs = {});
+}
+function i(e, r) {
+  let t;
+  return {
+    id: r.id,
+    type: "custom",
+    renderingMode: r.renderingMode ?? "2d",
+    onAdd(n, a) {
+      t = n, e.onAdd(n, a);
+    },
+    onRemove(n, a) {
+      e.onRemove(n, a), t = void 0;
+    },
+    render(n, a) {
+      if (!t)
+        throw new Error("Layer adaptor render invoked before onAdd.");
+      e.render({
+        map: t,
+        gl: n,
+        matrix: (r.resolveMatrix ?? o)(a),
+        rawArgs: a,
+        prepareStencilMask: r.prepareStencilMask ? () => r.prepareStencilMask(t) : void 0
+      });
+    }
+  };
+}
+const c = i, p = i;
+export {
+  d as clearTileClippingMask,
+  i as createCustomLayerAdaptor,
+  c as createMapLibreLayerAdaptor,
+  p as createMapboxLayerAdaptor,
+  o as resolveLayerMatrix
+};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@naivemap/map-gl-layer-adaptor",
+  "version": "0.1.0",
+  "description": "Framework-agnostic adaptor primitives for MapLibre GL JS and Mapbox GL JS custom layers.",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "maplibre",
+    "mapbox",
+    "custom",
+    "layer",
+    "adaptor"
+  ],
+  "author": "naivemap",
+  "license": "MIT",
+  "types": "./dist/index.d.ts",
+  "repository": "https://github.com/naivemap/maplibre-gl-layers",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "vite build",
+    "typedocs": "typedoc"
+  }
+}