@maptiler/sdk 4.0.0-rc.6 → 4.0.1

package/e2e/tests/helpers/fetchGeojson.ts

@@ -1,21 +0,0 @@
-import { KeyframeableGeoJSONFeature } from "../../../src";
-
-type GeoJSON = {
-  type: "FeatureCollection";
-  features: KeyframeableGeoJSONFeature[];
-};
-
-export default async function fetchGeoJSON(assetUrl: string): Promise<GeoJSON> {
-  try {
-    const response = await fetch(assetUrl);
-
-    if (!response.ok) {
-      throw new Error(`Failed to fetch GeoJSON: ${response.statusText}`);
-    }
-
-    const geojson = await response.json();
-    return geojson as GeoJSON;
-  } catch (e) {
-    throw e;
-  }
-}

package/e2e/tests/helpers/getMapInstanceForFixture.ts

@@ -1,87 +0,0 @@
-import { Page, expect } from "@playwright/test";
-import path from "path";
-import { injectGlobalVariables } from "./injectGlobalVariables";
-
-interface IgetMapInstanceForFixture {
-  fixture: string;
-  page: Page;
-  mockStyle?: boolean;
-  mockTiles?: boolean;
-  debug?: boolean;
-  timeout?: number;
-}
-
-export default async function getMapInstanceForFixture({ fixture, page, mockStyle = true, mockTiles = true, debug = false, timeout = 10000 }: IgetMapInstanceForFixture) {
-  await injectGlobalVariables(page);
-  await page.addInitScript((plt) => {
-    window.__pageLoadTimeout = plt;
-  }, timeout);
-
-  if (mockStyle) {
-    // mock style response
-    await page.route("https://api.maptiler.com/maps/*/*.json*", async (route) => {
-      if (debug) console.info(`ℹ️ Style intercepted at ${route.request().url()}`);
-      await route.fulfill({
-        status: 200,
-        contentType: "application/json",
-        path: path.resolve(import.meta.dirname, "../mocks/maptiler-style.json"),
-      });
-    });
-  }
-
-  if (mockTiles) {
-    // mocks the tile response always returning the mock tile
-    await page.route("https://api.maptiler.com/tiles/*/*/*/*.jpg?key=*&*", (route) => {
-      if (debug) console.info(`ℹ️ Tile intercepted at ${route.request().url()}`);
-      return route.fulfill({
-        status: 200,
-        contentType: "image/png",
-        path: path.resolve(import.meta.dirname, "../mocks/tile.png"),
-      });
-    });
-  }
-
-  page.on("console", (msg) => {
-    console.log("FIXTURE LOG:", msg.text());
-    if (debug) {
-      console.log("DEBUG FIXTURE LOG:", msg.location(), msg.text());
-    }
-  });
-
-  page.addListener("requestfinished", async (request) => {
-    const response = await request.response();
-    if (response && response.status() >= 400) {
-      console.error(`\n\nFailed to load ${request.url()}\n status: ${response.status()}\n\n`);
-      expect(response.status()).toBeLessThan(400);
-    }
-  });
-
-  await page.goto(`http://localhost:5173/${fixture}.html`, {
-    waitUntil: "domcontentloaded",
-  });
-
-  try {
-    const map = await page.evaluateHandle(() => {
-      return Promise.race([
-        new Promise(async (resolve) => {
-          console.log("Window.__map", window.__map);
-          window.__map.on("idle", () => {;
-            resolve(window.__map);
-          });
-        }),
-        new Promise((_, reject) => {
-          setTimeout(() => {
-            reject(new Error("Map did not load in time"));
-          }, window.__pageLoadTimeout);
-        }),
-      ]);
-    });
-
-    return {
-      map,
-    };
-  } catch (e) {
-    console.error(e);
-    return {};
-  }
-}

package/e2e/tests/helpers/injectGlobalVariables.ts

@@ -1,13 +0,0 @@
-import { Page } from "@playwright/test";
-import packagejson from "../../../package.json" assert { type: "json" };
-
-export async function injectGlobalVariables(page: Page) {
-  console.log("injecting global variables");
-  await page.addInitScript(
-    ({ version, nodeEnv }) => {
-      window.__MT_SDK_VERSION__ = version;
-      window.__MT_NODE_ENV__ = nodeEnv;
-    },
-    { version: packagejson.version, nodeEnv: process.env.NODE_ENV },
-  );
-}

package/e2e/tests/helpers/loadFixtureAndGetMapHandle.ts

@@ -1,109 +0,0 @@
-import type { Map } from "../../../src/index";
-import { JSHandle, Page, expect } from "@playwright/test";
-import path from "path";
-import { injectGlobalVariables } from "./injectGlobalVariables";
-
-export interface LoadFixtureAndGetMapHandleOptions {
-  fixture: string;
-  page: Page;
-  mockStyle?: boolean | string;
-  mockTiles?: boolean | string;
-  debug?: boolean;
-  waitUntil?: "load" | "domcontentloaded" | "networkidle";
-  queryParams?: Record<string, string>;
-  lazy?: boolean;
-}
-
-export default async function loadFixtureAndGetMapHandle({
-  fixture,
-  page,
-  mockStyle = true,
-  mockTiles = true,
-  debug = false,
-  waitUntil = "load",
-  queryParams,
-  lazy = false,
-}: LoadFixtureAndGetMapHandleOptions): Promise<{ mapHandle: JSHandle<Map | null> | null }> {
-  await injectGlobalVariables(page);
-  if (mockStyle) {
-    // mock style response
-    await page.route("https://api.maptiler.com/maps/*/*.json*", async (route) => {
-      if (debug) console.info(`ℹ️ Style intercepted at ${route.request().url()}`);
-      const mockFileName = typeof mockStyle === "string" ? mockStyle : "maptiler-style.json";
-      await route.fulfill({
-        status: 200,
-        contentType: "application/json",
-        path: path.resolve(import.meta.dirname, `../mocks/${mockFileName}`),
-      });
-    });
-  }
-
-  if (mockTiles) {
-    // mocks the tile response always returning the mock tile
-    await page.route("https://api.maptiler.com/tiles/*/*/*/*.jpg?key=*&*", (route) => {
-      if (debug) console.info(`ℹ️ Tile intercepted at ${route.request().url()}`);
-      return route.fulfill({
-        status: 200,
-        contentType: "image/png",
-        path: path.resolve(import.meta.dirname, `../mocks/tile.png`),
-      });
-    });
-  }
-
-  page.on("console", (msg) => {
-    if (debug) {
-      console.log("DEBUG FIXTURE LOG:", msg.location(), msg.text());
-    }
-  });
-
-  page.addListener("requestfinished", async (request) => {
-    const response = await request.response();
-    if (response && response.status() >= 400) {
-      console.error(`\n\nFailed to load ${request.url()}\n status: ${response.status()}\n\n`);
-      expect(response.status()).toBeLessThan(400);
-    }
-  });
-
-  await page.goto([`http://localhost:5173/${fixture}.html`, queryParams && new URLSearchParams(queryParams).toString()].filter(Boolean).join("?"), {
-    waitUntil,
-  });
-
-  if (!lazy) {
-    try {
-      const mapHandle = await page.evaluateHandle<Map | null>(() => {
-        return Promise.race<Map | null>([
-          new Promise<Map | null>(async (resolve) => {
-            try {
-              window.__map.on("idle", () => {
-                resolve(window.__map as Map);
-              });
-            } catch (e) {
-              console.error("Error getting map instance", e);
-              resolve(null);
-            }
-          }),
-          new Promise<Map | null>((resolve) => {
-            setTimeout(() => {
-              console.error("Map did not load in time");
-              resolve(null);
-            }, 10000);
-          }),
-        ]);
-      });
-
-      return {
-        mapHandle,
-      };
-    } catch (e) {
-      console.error(e);
-      const nullMap = await page.evaluateHandle(() => null);
-      return {
-        mapHandle: nullMap as JSHandle<Map | null>,
-      };
-    }
-  }
-
-  return {
-    mapHandle: null,
-  };
-}

package/e2e/tests/map-load.test.ts

@@ -1,14 +0,0 @@
-import { expect, test } from "@playwright/test";
-
-import loadFixtureAndGetMapHandle from "./helpers/loadFixtureAndGetMapHandle";
-
-test("Awaits until map ready and takes snapshot", async ({ page }, testInfo) => {
-  await loadFixtureAndGetMapHandle({
-    fixture: "mapLoad",
-    page,
-  });
-
-  expect(await page.title()).toBe("MapTiler E2E Map Load");
-
-  await expect(page).toHaveScreenshot("mapLoad.png");
-});

package/e2e/tests/mocks/maptiler-style-space-halo-invalid.json

@@ -1,38 +0,0 @@
-{
-  "version": 8,
-  "sources": {
-    "raster": {
-      "type": "raster",
-      "tiles": [
-        "https://api.maptiler.com/tiles/satellite/{z}/{x}/{y}.jpg?key=DOESNT_MATTER"
-      ],
-      "tileSize": 256
-    }
-  },
-  "layers": [
-    {
-      "id": "raster",
-      "type": "raster",
-      "source": "raster",
-      "minzoom": 0,
-      "maxzoom": 22
-    }
-  ],
-  "projection": { "type": "globe" },
-  "metadata": {
-    "maptiler": {
-      "version": "1.0.0",
-      "attribution": "© MapTiler © OpenStreetMap contributors",
-      "halo": {
-        "scale": "letter",
-        "stops": {
-          "is": "an object"
-        }
-      },
-      "space": {
-        "color": [1234,1234],
-        "preset": 3
-      }
-    }
-  }
-}

package/e2e/tests/mocks/maptiler-style-space-halo.json

@@ -1,41 +0,0 @@
-{
-  "version": 8,
-  "sources": {
-    "raster": {
-      "type": "raster",
-      "tiles": [
-        "https://api.maptiler.com/tiles/satellite/{z}/{x}/{y}.jpg?key=DOESNT_MATTER"
-      ],
-      "tileSize": 256
-    }
-  },
-  "layers": [
-    {
-      "id": "raster",
-      "type": "raster",
-      "source": "raster",
-      "minzoom": 0,
-      "maxzoom": 22
-    }
-  ],
-  "projection": { "type": "globe" },
-  "metadata": {
-    "maptiler": {
-      "version": "1.0.0",
-      "attribution": "© MapTiler © OpenStreetMap contributors",
-      "halo": {
-        "scale": 1.5,
-        "stops": [
-          [0.2, "transparent"],
-          [0.2, "red"],
-          [0.4, "red"],
-          [0.4, "transparent"]
-        ]
-      },
-      "space": {
-        "color": "green",
-        "preset": "space"
-      }
-    }
-  }
-}

package/e2e/tests/mocks/maptiler-style.json

@@ -1,28 +0,0 @@
-{
-  "version": 8,
-  "sources": {
-    "raster": {
-      "type": "raster",
-      "tiles": [
-        "https://api.maptiler.com/tiles/satellite/{z}/{x}/{y}.jpg?key=DOESNT_MATTER"
-      ],
-      "tileSize": 256
-    }
-  },
-  "projection": { "type": "globe" },
-  "layers": [
-    {
-      "id": "raster",
-      "type": "raster",
-      "source": "raster",
-      "minzoom": 0,
-      "maxzoom": 22
-    }
-  ],
-  "metadata": {
-    "maptiler": {
-      "version": "1.0.0",
-      "attribution": "© MapTiler © OpenStreetMap contributors"
-    }
-  }
-}

package/e2e/tests/rtlTextPlugin.test.ts

@@ -1,22 +0,0 @@
-import { expect, test } from "@playwright/test";
-import loadFixtureAndGetMapHandle from "./helpers/loadFixtureAndGetMapHandle";
-
-test("Renders RTL text correctly when RTL plugin is enabled and incorrectly when disabled", async ({ page }) => {
-  await page.exposeFunction("notifyScreenshotStateReady", async (data: Record<string, TTestTransferData>) => {
-    const screenshotname = data.disabled ? "rtlTextPlugin-disabled.png" : "rtlTextPlugin-enabled.png";
-    await expect(page).toHaveScreenshot(screenshotname);
-  });
-
-  await loadFixtureAndGetMapHandle({
-    fixture: "rtlTextPlugin",
-    page,
-  });
-
-  expect(await page.title()).toBe("MapTiler E2E RTL Text Plugin");
-
-  await loadFixtureAndGetMapHandle({
-    fixture: "rtlTextPlugin",
-    page,
-    queryParams: { "disable-rtl": "true" },
-  });
-});

package/e2e/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "types": ["./global.d.ts", "node"],
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-  },
-  "include": [
-    "./tests/**/*.test.ts",
-    "./tests/helpers/*.ts",
-    "./src/**/*.ts",
-    "../src/**/*.d.ts"
-  ]
-}

package/eslint.config.mjs

@@ -1,141 +0,0 @@
-// @ts-nocheck
-
-import tseslint from "typescript-eslint";
-import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
-import eslintPluginCompat from "eslint-plugin-compat";
-
-export default tseslint.config(
-  // https://typescript-eslint.io/getting-started/typed-linting/
-  tseslint.configs.strictTypeChecked,
-  tseslint.configs.stylisticTypeChecked,
-  tseslint.configs.recommendedTypeChecked,
-  {
-    // forked from https://www.npmjs.com/package/eslint-plugin-restrict-imports
-    plugins: {
-      compat: eslintPluginCompat,
-      import: {
-        rules: {
-          "default-imports-only": {
-            meta: {
-              type: "suggestion",
-              docs: {},
-              schema: [
-                {
-                  bannedImport: {
-                    locations: ["filePaths"],
-                    message: "string",
-                    fixedLocation: "string",
-                  },
-                },
-              ],
-            },
-            create: function (context) {
-              const filePath = context.getFilename();
-              const options = context.options[0] || {
-                "^/(.*)": {
-                  locations: ["(.*)"],
-                },
-              };
-
-              return {
-                ImportDeclaration: (node) => {
-                  Object.entries(options).forEach(([bannedImport, config]) => {
-                    const importLocationRegex = new RegExp(bannedImport);
-
-                    if (config.ignoreTypeImports && node.importKind === "type") return;
-
-                    if (importLocationRegex.test(node.source.value)) {
-                      config.locations.forEach((fp) => {
-                        const bannedLocationRegex = new RegExp(fp);
-
-                        if (bannedLocationRegex.test(filePath)) {
-                          node.specifiers.forEach((specifier) => {
-                            if (specifier.type !== "ImportDefaultSpecifier") {
-                              context.report({
-                                // @ts-expect-error `message` seems to work with this...
-                                message: config.message ?? `Importing from '${bannedImport}' is banned in '${fp}'`,
-                                node,
-                              });
-                            }
-                          });
-                        }
-                      });
-                    }
-                  });
-                },
-              };
-            },
-          },
-        },
-      },
-    },
-    settings: {
-      // eslint-plugin-compat polyfill
-      polyfills: ["requestIdleCallback"],
-    },
-    rules: {
-      "compat/compat": "error",
-      "import/default-imports-only": [
-        "error",
-        {
-          "maplibre-gl$": {
-            locations: ["^(?!.*\.d\.ts$).*\.((ts|js))$"],
-            message: `Maplibre-gl uses CJS modules, only default imports are supported, named imports may fail on some setups.`,
-            ignoreTypeImports: true,
-          },
-        },
-      ],
-    },
-  },
-  {
-    languageOptions: {
-      parserOptions: {
-        projectService: true,
-        tsconfigRootDir: import.meta.dirname,
-      },
-    },
-  },
-  // https://github.com/prettier/eslint-plugin-prettier
-  eslintPluginPrettierRecommended,
-  //
-  {
-    rules: {
-      "@typescript-eslint/array-type": "off",
-      "@typescript-eslint/consistent-indexed-object-style": "warn",
-      "@typescript-eslint/consistent-type-definitions": "off",
-      "@typescript-eslint/no-base-to-string": "warn",
-      "@typescript-eslint/no-confusing-void-expression": "warn",
-      "@typescript-eslint/no-explicit-any": "warn",
-      "@typescript-eslint/no-empty-function": "warn", // this is to satisfy maplibre-gl custom layer interface
-      "@typescript-eslint/no-floating-promises": "warn",
-      "@typescript-eslint/no-inferrable-types": "off",
-      "@typescript-eslint/no-misused-promises": "warn",
-      "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off",
-      "@typescript-eslint/no-unnecessary-condition": "warn",
-      "@typescript-eslint/no-unnecessary-type-arguments": "off",
-      "@typescript-eslint/no-unnecessary-type-assertion": "off",
-      "@typescript-eslint/no-unnecessary-type-parameters": "off",
-      "@typescript-eslint/no-unused-vars": "warn",
-      "@typescript-eslint/no-unsafe-argument": "warn",
-      "@typescript-eslint/no-unsafe-assignment": "warn",
-      "@typescript-eslint/no-unsafe-call": "warn",
-      "@typescript-eslint/no-unsafe-enum-comparison": "off",
-      "@typescript-eslint/no-unsafe-member-access": "warn",
-      "@typescript-eslint/no-unsafe-return": "warn",
-      "@typescript-eslint/no-non-null-assertion": "warn",
-      "@typescript-eslint/non-nullable-type-assertion-style": "warn",
-      "@typescript-eslint/prefer-for-of": "off",
-      "@typescript-eslint/prefer-nullish-coalescing": "warn",
-      "@typescript-eslint/prefer-optional-chain": "off",
-      "@typescript-eslint/prefer-return-this-type": "off",
-      "@typescript-eslint/prefer-string-starts-ends-with": "warn",
-      "@typescript-eslint/restrict-plus-operands": "warn",
-      "@typescript-eslint/restrict-template-expressions": "warn",
-      "@typescript-eslint/related-getter-setter-pairs": "off",
-      "@typescript-eslint/unbound-method": "warn",
-      "@typescript-eslint/use-unknown-in-catch-callback-variable": "warn",
-      "@typescript-eslint/unified-signatures": ["error", { ignoreOverloadsWithDifferentJSDoc: true }],
-    },
-  },
-  //
-);

package/playwright.config.ts

@@ -1,88 +0,0 @@
-import { defineConfig, devices } from '@playwright/test';
-import packagejson from './package.json' assert { type: 'json' };
-/**
- * Read environment variables from file.
- * https://github.com/motdotla/dotenv
- */
-// import dotenv from 'dotenv';
-// import path from 'path';
-// dotenv.config({ path: path.resolve(__dirname, '.env') });
-
-/**
- * See https://playwright.dev/docs/test-configuration.
- */
-export default defineConfig({
-  testDir: 'e2e',
-  // testMatch: '**/*.test.ts',
-  /* Run tests in files in parallel */
-  fullyParallel: true,
-  /* Fail the build on CI if you accidentally left test.only in the source code. */
-  forbidOnly: !!process.env.CI,
-  /* Retry on CI only */
-  retries: process.env.CI ? 2 : 0,
-  /* Opt out of parallel tests on CI. */
-  workers: process.env.CI ? 1 : undefined,
-  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-  reporter: 'html',
-  tsconfig: './e2e/tsconfig.json',
-
-  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
-  use: {
-    /* Base URL to use in actions like `await page.goto('/')`. */
-    // baseURL: 'http://127.0.0.1:3000',
-
-    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
-    trace: 'on-first-retry',
-    launchOptions: {
-      env: {
-        __MT_SDK_VERSION__: packagejson.version,
-        __MT_NODE_ENV__: process.env.NODE_ENV,
-      }
-    }
-  },
-  snapshotDir: './e2e/snapshots',
-  /* Configure projects for major browsers */
-  projects: [
-    {
-      name: 'chromium',
-      use: { ...devices['Desktop Chrome'], },
-      
-    },
-
-    // {
-    //   name: 'firefox',
-    //   use: { ...devices['Desktop Firefox'] },
-    // },
-
-    // {
-    //   name: 'webkit',
-    //   use: { ...devices['Desktop Safari'] },
-    // },
-    /* Test against mobile viewports. */
-    // {
-    //   name: 'Mobile Chrome',
-    //   use: { ...devices['Pixel 5'] },
-    // },
-    // {
-    //   name: 'Mobile Safari',
-    //   use: { ...devices['iPhone 12'] },
-    // },
-
-    /* Test against branded browsers. */
-    // {
-    //   name: 'Microsoft Edge',
-    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
-    // },
-    // {
-    //   name: 'Google Chrome',
-    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
-    // },
-  ],
-
-  /* Run your local dev server before starting the tests */
-  // webServer: {
-    // command: 'npm run e2e:serve',
-    // url: 'http://localhost:5173',
-  //   reuseExistingServer: !process.env.CI,
-  // },
-});

package/tsconfig.json

@@ -1,42 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": "src",
-    "moduleResolution": "Node",
-    "target": "es2021",
-    "useDefineForClassFields": true,
-    "module": "ESNext",
-    "lib": [
-      "es2023",
-      "DOM",
-      "DOM.Iterable"
-    ],
-    "skipLibCheck": true,
-    /* Bundler mode */
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true,
-    "declaration": true,
-    "allowSyntheticDefaultImports": true,
-    "allowJs": true,
-  },
-  "exclude": [
-    "vite.config-*.ts",
-    "vitest-setup-tests.ts",
-    "dist"
-  ],
-  "include": [
-    "vite.config-dev.ts",
-    "vite.config-es.ts",
-    "vite.config-umd.ts",
-    "vite.config-test.ts",
-    "vitest-setup-tests.ts",
-    "src",
-    "demos",
-    "test"
-  ],
-}