@mapcreator/sdk 0.0.0-opacity.0

package/dist/utils/helpers.d.ts

@@ -0,0 +1,30 @@
+import { JobObject, JobObjectDataBindings, JobObjectStoredValue } from '../types/jobObject';
+import { LngLat } from '../types/geometry';
+export declare const numberRe: RegExp;
+export declare function degToRad(angle: number): number;
+export declare function radToDeg(angle: number): number;
+export declare function calcDistance(lngLat1: LngLat, lngLat2: LngLat): number;
+export declare function stringToId(str: string): number;
+/**
+ * Resolves a potential binding reference.
+ *
+ * 1. If the string starts with a $, it is considered a binding reference. The value of the binding
+ *    is then returned.
+ * 2. Otherwise, the string is returned as is.
+ */
+export declare function resolveBinding(str: string, bindings: JobObjectDataBindings): string;
+export declare function bindingToString(binding: JobObjectStoredValue | undefined): string;
+export declare function bindingToPrimitive(binding: JobObjectStoredValue | undefined): string | number | boolean | null;
+export declare function getYoutubeVideoId(url: string): string | undefined;
+type Unit = 'millimeter' | 'centimeter' | 'inch' | 'pixel' | 'pica' | 'kilometer' | 'mile' | 'nauticalMile' | 'foot' | 'meter';
+export declare function unitConvert(from: Unit, to: Unit, value: number): number;
+export declare function lerp(value1: number, value2: number, ratio: number): number;
+export declare function unlerp(min: number, max: number, value: number): number;
+export declare function clamp(value: number, min: number, max: number): number;
+/**
+ * Fast hash function for non-cryptographic use
+ */
+export declare function fnv32b(str: string): string;
+export declare function calculateScaleCorrection(jobObject: JobObject, container: HTMLElement): number;
+export declare function almostEqual(a: number, b: number, delta?: number): boolean;
+export {};

package/dist/utils/language.d.ts

@@ -0,0 +1,19 @@
+import { Map } from '@mapcreator/maplibre-gl';
+export declare function setLanguage(language: string, map: Map): void;
+export declare const LanguageNotation: Readonly<{
+    THREE: "ISO 639-2/B";
+    API: "ISO 639-2/B";
+    TWO: "ISO 639-1";
+    MAPLIBRE_COMPAT: "ISO 639-1";
+    ENDONYM: "name";
+    NAME: "name";
+    LOCALE: "locale";
+    i18n: "locale";
+}>;
+export declare const LanguageCodes: readonly {
+    "ISO 639-1": string;
+    "ISO 639-2/B": string;
+    name: string;
+    locale: string;
+}[];
+export declare function transformLanguageCode(input: string, type?: (typeof LanguageNotation)[keyof typeof LanguageNotation]): string;

package/dist/utils/lineSlicer.d.ts

@@ -0,0 +1,9 @@
+import { MercatorCoordinate } from '@mapcreator/maplibre-gl';
+import { Position } from '../types/geometry';
+export declare class LineSlicer {
+    #private;
+    constructor(line: Position[]);
+    sample(position: number): MercatorCoordinate;
+    slice(start: number, end: number): Position[];
+    get length(): number;
+}

package/dist/utils/models.d.ts

@@ -0,0 +1,16 @@
+import { LngLat, Position } from '../types/geometry';
+import { JobObjectPolygon } from '../types/jobObject';
+import { ModelBindings } from '../types';
+import { Map } from '@mapcreator/maplibre-gl';
+export declare function calculateCircle(center: LngLat, radius: number): Array<[number, number]>;
+export declare function calculateRadiusLine(center: LngLat, radius: number, bearing: number): Position[];
+export declare function calculatePolygonGeometry(polygon: JobObjectPolygon): Position[][];
+export declare function getAreaLayerId(groupId: string, area: {
+    vectorUrl: string;
+    sourceLayerId: string;
+}): string;
+export declare function getAreaSourceId(area: {
+    vectorUrl: string;
+}): string;
+export declare function getBoundValues(modelBindings: ModelBindings[], dataColumn: string): Array<number | string>;
+export declare function getLineAngle(line: Position[], map: Map): number;

package/dist/utils/overlays.d.ts

@@ -0,0 +1,4 @@
+import { StyleSpecification, Map, LayerSpecification } from '@mapcreator/maplibre-gl';
+export declare function loadOverlays(overlayIds: number[], overlayNames: string[], map: Map, vapiUrl: string, accessToken: string, styleOverrides?: {
+    [layerId: string]: Partial<LayerSpecification>;
+}): Promise<StyleSpecification[]>;

package/dist/utils/scalebar.d.ts

@@ -0,0 +1,2 @@
+export declare function floatToFraction(x: number, error?: number): number[];
+export declare function getRoundNum(num: number): number;

package/dist/utils/svgHelpers.d.ts

@@ -0,0 +1,91 @@
+import { JobObjectDataBindings } from '../types/jobObject';
+import { Map as MapLibre } from '@mapcreator/maplibre-gl';
+import { ColorGenerator } from './choropleth';
+export declare function escapeXML(str: string): string;
+export declare function loadFonts(fontNames: string[], vapiUrl: string, accessToken: string): Promise<void>;
+export declare function createImage(svgString: string, width: number, height: number): Promise<HTMLImageElement>;
+export interface SvgColor {
+    name: string;
+    color: Color | string | undefined;
+}
+export interface SvgText {
+    name: string;
+    text: string | undefined;
+    isMultiline: boolean;
+}
+export declare class SvgHelper {
+    private _seen;
+    private _svg;
+    private _element;
+    constructor(svg: string);
+    private setElement;
+    getSvgString(): string;
+    getSvgSize(): [number, number];
+    getSvgColors(): SvgColor[];
+    setSvgColors(values: {
+        name: string;
+        color: Color;
+    }[]): SvgHelper;
+    getSvgTexts(): SvgText[];
+    setSvgTexts(values: Pick<SvgText, 'name' | 'text'>[]): SvgHelper;
+    private nodeChanged;
+    private autoResizeId;
+    private sameWidth;
+    private sameHeight;
+    private stack;
+    private rectPosition;
+    private pathPosition;
+    private copyPosition;
+    private resetSize;
+    private resetAnchor;
+    private getBBox;
+    /**
+     * Convert the points in the path shape into an array of points
+     * @param {Object} node of the shape to be used for this object
+     * @return {Object} node Array of coordinates
+     */
+    private nodeToPoints;
+    /**
+     * Convert the points in the given array into a path string
+     * @param {Object} pnts Node of the shape to be used for this object
+     * @return {String} String of the SVG path
+     */
+    private pointsToString;
+    private getCoordinate;
+    private setCoordinate;
+    private moveElement;
+    /**
+     * TODO Needs to be made DRY
+     */
+    private wrapText;
+}
+export declare class SvgCache {
+    private map;
+    private keyCache;
+    constructor(map: MapLibre);
+    getMapLibreImageKey(svg: string, pixelRatio: number): string;
+}
+export declare function measureTextBlock(lines: string[], fontFamily: string, fontSize: number): {
+    width: number;
+    height: number;
+    ascent: number;
+    descent: number;
+};
+export declare function getColorValue(dataBindings: JobObjectDataBindings, modelOrigValue: string | undefined, groupOrigValue: string | undefined, colorGenerator?: ColorGenerator, unmatchedColor?: string): string;
+export declare function getTextValue(dataBindings: JobObjectDataBindings, modelOrigValue: string | undefined, groupOrigValue: string | undefined): string | undefined;
+export declare function getSvgValue(dataBindings: JobObjectDataBindings, modelOrigValue: string | undefined, groupOrigValue: string | undefined): string | undefined;
+type RGB = [number, number, number];
+type RGBA = [number, number, number, number];
+declare class Color {
+    private readonly _error;
+    private readonly _rgba;
+    static fromRGB(rgb: RGB | RGBA): Color;
+    constructor(cstr: string);
+    get badValue(): boolean;
+    get a(): number;
+    get hex(): string;
+    get rgba(): RGBA;
+    sameColor(color: Color): boolean;
+    toString(): string;
+}
+export {};

package/dist/utils/template.d.ts

@@ -0,0 +1,5 @@
+import { Mode } from '../types';
+import { JobObjectDataBindings, PopupMedia } from '../types/jobObject';
+export declare function buildTemplate(template: string | undefined, popupMedia: PopupMedia | undefined, bindings: JobObjectDataBindings, mode: Mode): string;
+export declare const closeButtonHtml: string;
+export declare const cycleButtonsHtml: string;

package/dist/utils/video/animations.d.ts

@@ -0,0 +1,4 @@
+import { JobObjectAnimation, JobObjectAnimationType } from '../../types/jobObject';
+export declare function changesOpacity(animation: JobObjectAnimation): boolean;
+export declare function changesScale(animation: JobObjectAnimation): boolean;
+export declare function getAnimatedValue(animation: JobObjectAnimation, type: JobObjectAnimationType, time: number): number;

package/dist/utils/video/cameraCurve.d.ts

@@ -0,0 +1,39 @@
+import { LngLat } from '../../types/geometry';
+import { Keyframe } from '../../types/video';
+interface CameraParams {
+    center: LngLat;
+    zoom: number;
+    bearing: number;
+    pitch: number;
+    fov: number;
+    elevation: number;
+}
+/**
+ * The CameraCurve class represents a camera path of a single video. It takes a video script (array
+ * of keyframes) in its constructor. It then provides a single public method sample(time) that
+ * returns the camera position for the given time.
+ */
+export declare class CameraCurve {
+    private script;
+    private xCurve;
+    private yCurve;
+    private fovCurve;
+    private zoomCurve;
+    private pitchCurve;
+    private bearingCurve;
+    private altitudeCurve;
+    private elevationCurve;
+    constructor(script: Keyframe[]);
+    /**
+     * Returns the camera position for the given time.
+     */
+    sample(time: number): CameraParams;
+    /**
+     * Creates an instance of MonotonicCurve for the given script and field.
+     */
+    private createMonotonicCurve;
+    sampleAutoHideOpacity(time: number): number;
+    private getKeyframeIndexByTime;
+    private getKeyframeValue;
+}
+export {};

package/dist/utils/video/easings.d.ts

@@ -0,0 +1,31 @@
+export declare function linear(t: number, b: number, c: number, d: number): number;
+export declare function easeInQuad(t: number, b: number, c: number, d: number): number;
+export declare function easeOutQuad(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutQuad(t: number, b: number, c: number, d: number): number;
+export declare function easeInCubic(t: number, b: number, c: number, d: number): number;
+export declare function easeOutCubic(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutCubic(t: number, b: number, c: number, d: number): number;
+export declare function easeInQuart(t: number, b: number, c: number, d: number): number;
+export declare function easeOutQuart(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutQuart(t: number, b: number, c: number, d: number): number;
+export declare function easeInQuint(t: number, b: number, c: number, d: number): number;
+export declare function easeOutQuint(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutQuint(t: number, b: number, c: number, d: number): number;
+export declare function easeInSine(t: number, b: number, c: number, d: number): number;
+export declare function easeOutSine(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutSine(t: number, b: number, c: number, d: number): number;
+export declare function easeInExpo(t: number, b: number, c: number, d: number): number;
+export declare function easeOutExpo(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutExpo(t: number, b: number, c: number, d: number): number;
+export declare function easeInCirc(t: number, b: number, c: number, d: number): number;
+export declare function easeOutCirc(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutCirc(t: number, b: number, c: number, d: number): number;
+export declare function easeInElastic(t: number, b: number, c: number, d: number): number;
+export declare function easeOutElastic(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutElastic(t: number, b: number, c: number, d: number): number;
+export declare function easeInBack(t: number, b: number, c: number, d: number, s?: number): number;
+export declare function easeOutBack(t: number, b: number, c: number, d: number, s?: number): number;
+export declare function easeInOutBack(t: number, b: number, c: number, d: number, s?: number): number;
+export declare function easeInBounce(t: number, b: number, c: number, d: number): number;
+export declare function easeOutBounce(t: number, b: number, c: number, d: number): number;
+export declare function easeInOutBounce(t: number, b: number, c: number, d: number): number;

package/dist/utils/video/index.d.ts

@@ -0,0 +1,11 @@
+import { Keyframe } from '../../types/video';
+/**
+ * This function fixes the given script so that globe and bearing rotations between keyframes always
+ * happen along the shortest path. This fixes the camera unexpectedly turning the opposite direction
+ * when lng or bearing crosses the wrap boundary of –180°/180°. The function does not mutate the
+ * given script, instead generating a brand new one with corrected lng and bearing values.
+ */
+export declare function unwrapGlobeAndCameraRotation(script: Keyframe[]): Keyframe[];
+export declare function zoomToAltitude(zoom: number): number;
+export declare function getTotalDuration(script: Keyframe[]): number;
+export declare function getPreciseFramerate(frameRate: number): number;

package/dist/utils/video/monotonicCurve.d.ts

@@ -0,0 +1,23 @@
+import { Point2D } from '../../types/geometry';
+/**
+ * This class is a wrapper around D3's curveMonotoneX. It takes an array of XY-points in the
+ * constructor and provides two main public methods: sample(X) calculates Y for the given X and
+ * solve(Y) calculates X for the given Y.
+ *
+ * We build curves like this for every camera parameter (x, y, zoom, bearing, pitch, etc.) where X
+ * represents elapsed time in milliseconds and Y represents the value of the parameter.
+ *
+ * @see https://d3js.org/d3-shape/curve#curveMonotoneX
+ */
+export declare class MonotonicCurve {
+    private segments;
+    constructor(points: Point2D[]);
+    /**
+     * Returns the value of Y for the given X.
+     */
+    sample(x: number): number;
+    /**
+     * Returns the value of X for the given Y.
+     */
+    solve(y: number, initialGuess: number): number;
+}

package/dist/utils/youtube.d.ts

@@ -0,0 +1,4 @@
+import { PopupMedia, JobObjectDataBindings } from '../types/jobObject';
+export declare function getEmbedUrlFromYoutubeUrl(popupmedia: Extract<PopupMedia, {
+    type: 'video';
+}>, bindings: JobObjectDataBindings): string;

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@mapcreator/sdk",
+  "version": "0.0.0-opacity.0",
+  "engines": {
+    "node": "^24.0.0",
+    "npm": "^11.0.0"
+  },
+  "description": "Mapcreator JavaScript SDK",
+  "type": "module",
+  "main": "./dist/mapcreator-sdk.umd.cjs",
+  "module": "./dist/mapcreator-sdk.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/mapcreator-sdk.js",
+      "require": "./dist/mapcreator-sdk.umd.cjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./dist/": {
+      "import": "./dist/",
+      "require": "./dist/"
+    }
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "prettier": "prettier --check src/",
+    "prettier:fix": "prettier --write src/",
+    "types": "tsc",
+    "lint": "eslint src --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --ignore-path .gitignore",
+    "lint:fix": "eslint src --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/mapcreator/sdk.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "@vue/eslint-config-prettier": "^10.2.0",
+    "@vue/eslint-config-typescript": "^13.0.0",
+    "eslint": "^8.57.1",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-vue": "^9.33.0",
+    "prettier": "^3.8.1",
+    "rollup-plugin-visualizer": "^7.0.1",
+    "typescript": "^5.9.3",
+    "vite": "^8.0.1",
+    "vite-plugin-dts": "^4.5.4"
+  },
+  "dependencies": {
+    "@mapcreator/maplibre-gl": "5.7.0-mc.5",
+    "@turf/area": "^7.3.4",
+    "@turf/bbox-clip": "^7.3.4",
+    "@turf/intersect": "^7.3.4",
+    "@turf/polygon-smooth": "^7.3.4",
+    "@types/d3-array": "^3.2.2",
+    "@types/d3-format": "^3.0.4",
+    "@types/d3-geo": "^3.1.0",
+    "@types/d3-interpolate": "^3.0.4",
+    "@types/d3-scale": "^4.0.9",
+    "@types/d3-shape": "^3.1.8",
+    "@types/topojson-client": "^3.1.5",
+    "bezier-easing": "^3.0.0",
+    "d3-array": "^3.2.4",
+    "d3-format": "^3.1.2",
+    "d3-geo": "^3.1.1",
+    "d3-interpolate": "^3.0.1",
+    "d3-scale": "^4.0.2",
+    "d3-shape": "^3.2.0",
+    "just-debounce-it": "^3.2.0",
+    "newton-raphson-method": "^1.0.2",
+    "path-data-polyfill": "^1.0.10",
+    "topojson-client": "^3.1.0"
+  }
+}