@mapcreator/sdk 3.0.0 → 3.1.1

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,16 +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';
 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);
+    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;
 }

package/dist/Video.d.ts

@@ -28,17 +28,11 @@ 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
-     * comes first. 'dataabort' events for tiles that aren't in the 'loading'
-     * state (e.g. errored tiles being evicted) are ignored — they don't indicate
-     * lost in-flight work.
-     */
-    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

@@ -9,6 +9,7 @@ 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: Array<keyof AllPaintProperties>;