@mapcreator/sdk 0.0.9 → 0.0.11

package/README.md

@@ -0,0 +1,29 @@
+[Mapcreator](https://mapcreator.io/) JavaScript SDK. Renders Mapcreator projects on a [MapLibre](https://maplibre.org/) interactive map.
+
+## Installation
+
+```
+npm i --save @mapcreator/sdk
+```
+
+## Usage
+
+```javascript
+// Import scripts
+import { initMap } from '@mapcreator/sdk';
+
+// Import styles
+import '@mapcreator/sdk/dist/mapcreator-sdk.css';
+
+// Initialize the map
+const { map } = await initMap({
+  container: '<map container element or its id>',
+  job: '<interactive map id>',
+  accessToken: '<mapcreator access token>',
+});
+
+// map is now an instance of MapLibre GL JS:
+//
+// map.setZoom(10);
+// map.getZoom();
+```

package/dist/{esm/HighlightManager.d.ts → HighlightManager.d.ts}

@@ -1,5 +1,5 @@
-import { type Map } from '@mapcreator/maplibre-gl';
-import type { PopupElement } from '@/Registry';
+import { Map } from '@mapcreator/maplibre-gl';
+import { PopupElement } from './Registry';
 export declare class HighlightManager {
     private map;
     private popupElements;

package/dist/{esm/MCMap.d.ts → MCMap.d.ts}

@@ -1,5 +1,5 @@
 import { Map as MapLibre } from '@mapcreator/maplibre-gl';
-import type { Env, JobObjectAugmented, Mode } from '@/types';
+import { Env, JobObjectAugmented, Mode } from './types';
 export declare class MCMap {
     map: MapLibre;
     constructor(map: MapLibre);

package/dist/{esm/PopupManager.d.ts → PopupManager.d.ts}

@@ -1,7 +1,7 @@
-import { type Map as MapLibre, type MapGeoJSONFeature, type MapLayerMouseEvent, type LngLatLike } from '@mapcreator/maplibre-gl';
-import type { JobObject, PopupPosition } from '@/types/jobObject';
-import { type PopupElement } from '@/Registry';
-import type { Mode } from '@/types';
+import { Map as MapLibre, MapGeoJSONFeature, MapLayerMouseEvent, LngLatLike } from '@mapcreator/maplibre-gl';
+import { JobObject, PopupPosition } from './types/jobObject';
+import { PopupElement } from './Registry';
+import { Mode } from './types';
 export declare class PopupManager {
     private map;
     private popupPosition;

package/dist/{esm/Registry.d.ts → Registry.d.ts}

@@ -1,6 +1,6 @@
-import type { Position } from '@/types/geometry';
-import type { JobObject, JobObjectArea, JobObjectCircle, JobObjectDot, JobObjectLine, JobObjectMarker, JobObjectPolygon, PopupMedia, JobObjectDataBindings } from '@/types/jobObject';
-import type { LngLat, MapGeoJSONFeature } from '@mapcreator/maplibre-gl';
+import { Position } from './types/geometry';
+import { JobObject, JobObjectArea, JobObjectCircle, JobObjectDot, JobObjectLine, JobObjectMarker, JobObjectPolygon, PopupMedia, JobObjectDataBindings } from './types/jobObject';
+import { LngLat, MapGeoJSONFeature } from '@mapcreator/maplibre-gl';
 type Model = JobObjectArea | JobObjectCircle | JobObjectDot | JobObjectLine | JobObjectMarker | JobObjectPolygon;
 export type PopupElement = {
     groupId: string;

package/dist/{esm/adornments → adornments}/categoricalLegend.d.ts

@@ -1,2 +1,2 @@
-import type { JobObjectManualLegend } from '@/types/jobObject';
+import { JobObjectManualLegend } from '../types/jobObject';
 export declare function getCategoricalLegendSvg(legend: JobObjectManualLegend, defaultFont: string): string;

package/dist/{esm/adornments → adornments}/connectedLegend.d.ts

@@ -1,3 +1,3 @@
-import type { Map as MapLibre } from '@mapcreator/maplibre-gl';
-import type { JobObject, JobObjectConnectedLegend } from '@/types/jobObject';
+import { Map as MapLibre } from '@mapcreator/maplibre-gl';
+import { JobObject, JobObjectConnectedLegend } from '../types/jobObject';
 export declare function useConnectedLegend(legend: JobObjectConnectedLegend, jobObject: JobObject, map: MapLibre, vapiUrl: string, accessToken: string): HTMLElement;

package/dist/{esm/adornments → adornments}/customAdornment.d.ts

@@ -1,2 +1,2 @@
-import type { JobObjectCustomAdornment } from '@/types/jobObject';
+import { JobObjectCustomAdornment } from '../types/jobObject';
 export declare function useCustomAdornment(adornment: JobObjectCustomAdornment): HTMLElement;

package/dist/{esm/adornments → adornments}/heading.d.ts

@@ -1,2 +1,2 @@
-import type { JobObjectHeading } from '@/types/jobObject';
+import { JobObjectHeading } from '../types/jobObject';
 export declare function useHeading(heading: JobObjectHeading, vapiUrl: string, accessToken: string): HTMLElement;

package/dist/adornments/insetMap.d.ts

@@ -0,0 +1,3 @@
+import { Map } from '@mapcreator/maplibre-gl';
+import { JobObjectInsetMap } from '../types/jobObject';
+export declare function useInsetMap(insetMap: JobObjectInsetMap, map: Map, cdnUrl: string): HTMLElement;

package/dist/{esm/adornments → adornments}/manualLegend.d.ts

@@ -1,2 +1,2 @@
-import type { JobObjectManualLegend } from '@/types/jobObject';
+import { JobObjectManualLegend } from '../types/jobObject';
 export declare function useManualLegend(legend: JobObjectManualLegend, vapiUrl: string, accessToken: string): HTMLElement;

package/dist/adornments/northArrow.d.ts

@@ -0,0 +1,3 @@
+import { Map } from '@mapcreator/maplibre-gl';
+import { JobObjectNorthArrow } from '../types/jobObject';
+export declare function useNorthArrow(northArrow: JobObjectNorthArrow, map: Map): HTMLElement;

package/dist/adornments/scalebar.d.ts

@@ -0,0 +1,3 @@
+import { Map } from '@mapcreator/maplibre-gl';
+import { JobObjectScalebar } from '../types/jobObject';
+export declare function useScalebar(scalebar: JobObjectScalebar, map: Map): HTMLElement;

package/dist/{esm/constants → constants}/index.d.ts

@@ -1,5 +1,5 @@
-import type { AdornmentPosition } from '@/types/jobObject';
-import type { SkySpecification } from '@mapcreator/maplibre-gl';
+import { AdornmentPosition } from '../types/jobObject';
+import { SkySpecification } from '@mapcreator/maplibre-gl';
 export declare const defaultSky: SkySpecification;
 type PositionConfig = {
     x: 'left' | 'right' | 'center';

package/dist/{esm/controls → controls}/fullscreenControls.d.ts

@@ -1,2 +1,2 @@
-import type { Map } from '@mapcreator/maplibre-gl';
+import { Map } from '@mapcreator/maplibre-gl';
 export declare function useFullScreenButton(map: Map): HTMLElement;

package/dist/{esm/controls → controls}/geocoderControl.d.ts

@@ -1,4 +1,4 @@
-import type { Map } from '@mapcreator/maplibre-gl';
+import { Map } from '@mapcreator/maplibre-gl';
 export declare class GeocoderControl {
     private map;
     private mapContainer;

package/dist/{esm/controls → controls}/geolocationControls.d.ts

@@ -1,2 +1,2 @@
-import type { Map } from '@mapcreator/maplibre-gl';
+import { Map } from '@mapcreator/maplibre-gl';
 export declare function useGeolocationButton(map: Map): HTMLElement;

package/dist/controls/refreshMapControls.d.ts

@@ -0,0 +1,3 @@
+import { InitialPositionInfo } from '../types';
+import { Map } from '@mapcreator/maplibre-gl';
+export declare function useRefreshButton(map: Map, initialPosition: InitialPositionInfo): HTMLElement;

package/dist/controls/webControls.d.ts

@@ -0,0 +1,4 @@
+import { JobObjectWebControls } from '../types/jobObject';
+import { InitialPositionInfo } from '../types';
+import { Map } from '@mapcreator/maplibre-gl';
+export declare function useWebControls(webControls: JobObjectWebControls, map: Map, initialPosition: InitialPositionInfo): HTMLElement;

package/dist/{esm/controls → controls}/zoomControls.d.ts

@@ -1,3 +1,3 @@
-import type { Map } from '@mapcreator/maplibre-gl';
+import { Map } from '@mapcreator/maplibre-gl';
 export declare function useZoomInButton(map: Map): HTMLElement;
 export declare function useZoomOutButton(map: Map): HTMLElement;

package/dist/index.d.ts

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

package/dist/locales/da_DK/strings.json.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+  "search": "Search",
+  "videoAlert": "The video will only work when you publish the map",
+  "mobileHelpText": "Use two fingers to move the map",
+  "windowsHelpText": "Use Ctrl + scroll to zoom the map",
+  "macHelpText": "Use ⌘ + scroll to zoom the map"
+}
+;
+
+export default _default;

package/dist/locales/de_DE/strings.json.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+  "search": "Suche",
+  "videoAlert": "Das Video ist in der veröffentlichten Karte sichtbar.",
+  "mobileHelpText": "Verwenden Sie zwei Finger um die Karte zu bewegen",
+  "windowsHelpText": "Verwenden Sie Strg + Scroll um in der Karte zu zoomen",
+  "macHelpText": "Verwenden Sie ⌘ + Scroll um in der Karte zu zoomen"
+}
+;
+
+export default _default;

package/dist/locales/en_GB/strings.json.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+  "search": "Search",
+  "videoAlert": "The video will only work when you publish the map",
+  "mobileHelpText": "Use two fingers to move the map",
+  "windowsHelpText": "Use Ctrl + scroll to zoom the map",
+  "macHelpText": "Use ⌘ + scroll to zoom the map"
+}
+;
+
+export default _default;

package/dist/locales/es_ES/strings.json.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+  "search": "Buscar",
+  "videoAlert": "The video will only work when you publish the map",
+  "mobileHelpText": "Use dos dedos para mover el mapa",
+  "windowsHelpText": "Use Ctrl + desplazamiento para hacer zoom en el mapa",
+  "macHelpText": "Use ⌘ + desplazamiento para hacer zoom en el mapa"
+}
+;
+
+export default _default;

package/dist/locales/fr_FR/strings.json.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+  "search": "Rechercher",
+  "videoAlert": "Votre vidéo sera diffusée sur la carte publiée",
+  "mobileHelpText": "Utilisez deux doigts pour déplacer la carte",
+  "windowsHelpText": "Utilisez Ctrl + défilement pour zoomer sur la carte",
+  "macHelpText": "Utilisez ⌘ + défilement pour zoomer sur la carte"
+}
+;
+
+export default _default;

package/dist/locales/it_IT/strings.json.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+  "search": "Cercare",
+  "videoAlert": "The video will only work when you publish the map",
+  "mobileHelpText": "Usa due dita per muovere la mappa",
+  "windowsHelpText": "Usa Ctrl + Scroll per ingrandire la mappa",
+  "macHelpText": "Usa ⌘ + Scroll per ingrandire la mappa"
+}
+;
+
+export default _default;

package/dist/locales/nl_NL/strings.json.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+  "search": "Zoeken",
+  "videoAlert": "The video will only work when you publish the map",
+  "mobileHelpText": "Gebruik twee vingers om de kaart te bewegen",
+  "windowsHelpText": "Gebruik Ctrl + Scroll om de kaart te zoomen",
+  "macHelpText": "Gebruik ⌘ + Scroll om de kaart te zoomen"
+}
+;
+
+export default _default;