@mapcreator/sdk 2.0.1 → 3.0.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/MCMap.d.ts

@@ -2,22 +2,11 @@ import { Evented, Map as MapLibre, StyleSpecification } from '@mapcreator/maplib
 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 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;
     play(): void;
     pause(): void;
     seekTo(time: number): void;
@@ -25,4 +14,3 @@ export declare class MCMap extends Evented {
     preload(): Promise<void>;
     remove(): void;
 }
-export {};

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';
@@ -11,7 +11,7 @@ export declare const positionConfig: {
 };
 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 };