@mapcreator/sdk 2.0.2 → 3.1.0

package/README.md

@@ -1,20 +1,18 @@
 [Mapcreator](https://mapcreator.io/) JavaScript SDK. Renders Mapcreator projects on a [MapLibre](https://maplibre.org/) interactive map.
 
-## Installation
+## Usage with a bundler
 
 ```
 npm i --save @mapcreator/sdk
 ```
 
-## Usage
-
 ```javascript
-// Import scripts
-import { initMap } from '@mapcreator/sdk';
-
 // Import styles
 import '@mapcreator/sdk/dist/mapcreator-sdk.css';
 
+// Import scripts
+import { initMap } from '@mapcreator/sdk';
+
 // Initialize the map
 const { map } = await initMap({
   container: '<map container element or its id>',
@@ -27,3 +25,25 @@ const { map } = await initMap({
 // map.setZoom(10);
 // map.getZoom();
 ```
+
+## Usage in the browser
+
+```html
+<link rel="stylesheet" href="https://unpkg.com/@mapcreator/sdk@^3.0.0/dist/mapcreator-sdk.css" />
+<div id="map" style="height: 400px"></div>
+
+<script type="module">
+  import { initMap } from 'https://unpkg.com/@mapcreator/sdk@^3.0.0/dist/mapcreator-sdk.mjs';
+
+  const { map } = await initMap({
+    container: 'map',
+    job: '<interactive map id>',
+    accessToken: '<mapcreator access token>',
+  });
+
+  // map is now an instance of MapLibre GL JS:
+  //
+  // map.setZoom(10);
+  // map.getZoom();
+</script>
+```

package/dist/Image.d.ts

@@ -0,0 +1,13 @@
+import { SvgCache } from './utils/svgHelpers';
+import { JobObjectFormat } from './types/jobObject';
+import { MCMap } from './MCMap';
+export declare class Image {
+    private mcMap;
+    private format;
+    private svgCache;
+    private backgroundColor;
+    constructor(mcMap: MCMap, format: JobObjectFormat, svgCache: SvgCache, backgroundColor: string);
+    frame(asBlob: true): Promise<Blob>;
+    frame(asBlob: false): Promise<ImageData>;
+    frame(asBlob: boolean): Promise<Blob | ImageData>;
+}

package/dist/MCMap.d.ts

@@ -1,28 +1,79 @@
 import { Evented, Map as MapLibre, StyleSpecification } from '@mapcreator/maplibre-gl';
+import { JobObject, JobObjectFormat } from './types/jobObject';
 import { ExportType, LayerInfo, Svgs } from './types';
-import { JobObject } from './types/jobObject';
 import { SvgCache } from './utils/svgHelpers';
-type SdkEventType = {
-    playstart: VideoEvent;
-    playend: VideoEvent;
-    play: VideoEvent;
-};
-type VideoEvent = {
-    time: number;
-};
-export declare class MCMap extends Evented {
+import { SdkEventType } from './events';
+export declare class MCMap extends Evented<SdkEventType> {
     map: MapLibre;
+    private format;
+    private mapstyle;
+    private svgCache;
+    private backgroundColor;
+    private vapiUrl;
+    private accessToken;
+    private image;
     private video;
-    constructor(map: MapLibre, exportType: ExportType, jobObject: JobObject, svgs: Svgs, svgCache: SvgCache, mapstyle: StyleSpecification, overlays: Map<number, StyleSpecification>, layerInfo: LayerInfo, backgroundColor: string);
-    on<T extends keyof SdkEventType>(type: T, listener: (e: SdkEventType[T]) => void): import('@mapcreator/maplibre-gl').Subscription;
-    once<T extends keyof SdkEventType>(type: T, listener: (e: SdkEventType[T]) => void): Promise<any> | this;
-    off<T extends keyof SdkEventType>(type: T, listener: (e: SdkEventType[T]) => void): this;
-    fire<T extends keyof SdkEventType>(type: T, payload: SdkEventType[T]): this;
+    constructor(map: MapLibre, format: JobObjectFormat, exportType: ExportType, jobObject: JobObject, svgs: Svgs, svgCache: SvgCache, mapstyle: StyleSpecification, overlays: Map<number, StyleSpecification>, layerInfo: LayerInfo, backgroundColor: string, vapiUrl: string, accessToken: string);
     play(): void;
     pause(): void;
     seekTo(time: number): void;
-    frames(): AsyncGenerator<ImageData, void, void>;
+    frames(asBlob: true): AsyncGenerator<Blob, void, void>;
+    frames(asBlob?: false): AsyncGenerator<ImageData, void, void>;
+    frames(asBlob?: boolean): AsyncGenerator<Blob | ImageData, void, void>;
     preload(): Promise<void>;
+    geoTiffMetadata(size: {
+        width: number;
+        height: number;
+    }): {
+        width: number;
+        height: number;
+        GTRasterTypeGeoKey: number;
+        PhotometricInterpretation: number;
+        ProjectedCSTypeGeoKey: number;
+        ModelTiepoint: number[];
+        ModelPixelScale: never[];
+    };
+    svgExportOptions(api: {
+        href?: string;
+        token: string;
+    }, geoRef?: boolean, signal?: AbortSignal | undefined): {
+        map: MapLibre;
+        api: {
+            href?: string;
+            token: string;
+        };
+        signal: AbortSignal | undefined;
+        options: {
+            svgElements: {
+                name: string | undefined;
+                svg: string;
+                x: number;
+                y: number;
+                w: number;
+                h: number;
+            }[];
+            fillPatterns: {
+                name: string;
+                string: string;
+            }[];
+            backgroundColor: string;
+            detailLevel: number;
+            forPDF: boolean;
+            geoRef: boolean;
+        };
+    };
+    pdfExportOptions(api: {
+        href?: string;
+        token: string;
+    }): {
+        colorCallback: (inValue: [[number, number, number], number] | undefined) => [[number, number, number, number], number] | undefined;
+        fontCallback: (family: string, requestedWeight: number, requestedStyle: string, doc: {
+            registerFont(name: string, data: ArrayBuffer): unknown;
+        }, fontOptions?: {
+            fauxBold: boolean;
+            fauxItalic: boolean;
+        }) => Promise<string>;
+        assumePt: boolean;
+    };
     remove(): void;
 }
-export {};

package/dist/Video.d.ts

@@ -28,7 +28,9 @@ export declare class Video {
     pause(): void;
     seekTo(time: number): void;
     remove(): void;
-    frames(): AsyncGenerator<ImageData, void, void>;
+    frames(asBlob: true): AsyncGenerator<Blob, void, void>;
+    frames(asBlob: false): AsyncGenerator<ImageData, void, void>;
+    frames(asBlob: boolean): AsyncGenerator<Blob | ImageData, void, void>;
     preload(): Promise<void>;
     /**
      * Waits for the next 'render' or a meaningful 'dataabort' event, whichever
@@ -38,7 +40,6 @@ export declare class Video {
      */
     private waitForRenderOrAbort;
     private captureFrame;
-    private drawAdornments;
     private playFrame;
     private setFrame;
     private setCamera;

package/dist/adornments/categoricalLegend.d.ts

@@ -1,2 +1,3 @@
+import { Fonts } from '../utils/fonts';
 import { JobObjectManualLegend } from '../types/jobObject';
-export declare function getCategoricalLegendSvg(legend: JobObjectManualLegend, defaultFont: string, mapScale: number): string;
+export declare function getCategoricalLegendSvg(legend: JobObjectManualLegend, defaultFont: string, mapScale: number, fonts: Fonts): string;

package/dist/adornments/connectedLegend.d.ts

@@ -1,7 +1,8 @@
+import { Fonts } from '../utils/fonts';
 import { Map as MapLibre } from '@mapcreator/maplibre-gl';
-import { JobObject, JobObjectConnectedLegend } from '../types/jobObject';
 import { ExportType } from '../types';
-export declare function useConnectedLegend(legend: JobObjectConnectedLegend, jobObject: JobObject, map: MapLibre, vapiUrl: string, accessToken: string, exportType: ExportType): {
+import { JobObject, JobObjectConnectedLegend } from '../types/jobObject';
+export declare function useConnectedLegend(legend: JobObjectConnectedLegend, jobObject: JobObject, map: MapLibre, fonts: Fonts, exportType: ExportType): {
     element: HTMLElement;
     ready: Promise<void>;
 };

package/dist/adornments/copyright.d.ts

@@ -1,3 +1,7 @@
-import { Map } from '@mapcreator/maplibre-gl';
 import { JobObjectCopyright } from '../types/jobObject';
-export declare function useCopyright(copyright: JobObjectCopyright, map: Map): HTMLElement;
+import { Fonts } from '../utils/fonts';
+import { Map } from '@mapcreator/maplibre-gl';
+export declare function useCopyright(copyright: JobObjectCopyright, map: Map, fonts: Fonts): {
+    element: HTMLElement;
+    ready: Promise<void>;
+};

package/dist/adornments/heading.d.ts

@@ -1,7 +1,8 @@
+import { Fonts } from '../utils/fonts';
 import { JobObjectHeading } from '../types/jobObject';
 import { Map } from '@mapcreator/maplibre-gl';
 import { ExportType } from '../types';
-export declare function useHeading(heading: JobObjectHeading, map: Map, vapiUrl: string, accessToken: string, exportType: ExportType): {
+export declare function useHeading(heading: JobObjectHeading, map: Map, fonts: Fonts, exportType: ExportType): {
     element: HTMLElement;
     ready: Promise<void>;
 };

package/dist/adornments/manualLegend.d.ts

@@ -1,7 +1,8 @@
 import { JobObjectManualLegend } from '../types/jobObject';
 import { Map } from '@mapcreator/maplibre-gl';
+import { Fonts } from '../utils/fonts';
 import { ExportType } from '../types';
-export declare function useManualLegend(legend: JobObjectManualLegend, map: Map, vapiUrl: string, accessToken: string, exportType: ExportType): {
+export declare function useManualLegend(legend: JobObjectManualLegend, map: Map, fonts: Fonts, exportType: ExportType): {
     element: HTMLElement;
     ready: Promise<void>;
 };

package/dist/adornments/scalebar.d.ts

@@ -1,7 +1,8 @@
+import { Fonts } from '../utils/fonts';
 import { JobObjectScalebar } from '../types/jobObject';
 import { Map } from '@mapcreator/maplibre-gl';
 import { ExportType } from '../types';
-export declare function useScalebar(scalebar: JobObjectScalebar, map: Map, vapiUrl: string, accessToken: string, exportType: ExportType): {
+export declare function useScalebar(scalebar: JobObjectScalebar, map: Map, fonts: Fonts, exportType: ExportType): {
     element: HTMLElement;
     ready: Promise<void>;
 };

package/dist/constants/index.d.ts

@@ -1,5 +1,5 @@
 import { PositionOffsets, AdornmentPosition, JobObjectSlotName } from '../types/jobObject';
-import { SkySpecification, StyleLayer } from '@mapcreator/maplibre-gl';
+import { AllPaintProperties, SkySpecification, StyleLayer } from '@mapcreator/maplibre-gl';
 export declare const defaultSky: SkySpecification;
 type PositionConfig = {
     x: 'left' | 'right' | 'center';
@@ -9,9 +9,10 @@ export declare const defaultPositionOffsets: PositionOffsets;
 export declare const positionConfig: {
     [position in AdornmentPosition]: PositionConfig;
 };
+export declare const adornmentSpacing = 5;
 export declare const defaultFov = 36.87;
 type OpacityConfig = {
-    props: string[];
+    props: Array<keyof AllPaintProperties>;
     defaultValue: number;
 };
 export declare const opacityConfigByType: Record<StyleLayer['type'], OpacityConfig>;

package/dist/events.d.ts

@@ -0,0 +1,12 @@
+import { Event } from '@mapcreator/maplibre-gl';
+type VideoEventType = 'playstart' | 'playend' | 'play';
+export declare class VideoEvent<T extends VideoEventType = VideoEventType> extends Event<T> {
+    readonly time: number;
+    constructor(type: T, time: number);
+}
+export type SdkEventType = {
+    playstart: VideoEvent<'playstart'>;
+    playend: VideoEvent<'playend'>;
+    play: VideoEvent<'play'>;
+};
+export {};

package/dist/index.bundler.d.ts

@@ -0,0 +1 @@
+export * from './index';

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import { setRTLTextPlugin } from '@mapcreator/maplibre-gl';
 import { initMap } from './initMap';
 import { MCMap } from './MCMap';
-export { setRTLTextPlugin, initMap, type MCMap };
+export { initMap, type MCMap };