@maptiler/sdk 3.3.0-rc3 → 3.3.0

package/.husky/pre-commit

@@ -1,3 +1,2 @@
 npx lint-staged;
-npx ts-typecheck;
 npm run test;

package/README.md

@@ -40,30 +40,30 @@ In addition to the details and examples provided in this readme, check out the [
 **Recommended for:** advanced applications
 
 ```ts
-import * as maptilersdk from '@maptiler/sdk';
+import { config, Map } from '@maptiler/sdk';
 
 // Add your MapTiler Cloud API key to the config
 // (Go to https://cloud.maptiler.com/account/keys/ to get one for free!)
-maptilersdk.config.apiKey = 'YOUR_API_KEY';
+config.apiKey = 'YOUR_API_KEY';
 
 // Let's say you have a DIV ready to receive a map
 const mapContainer = document.getElementById('my-container-div');
 
 // Instantiate the map
-const map = new maptilersdk.Map({
+const map = new Map({
   container: mapContainer,
 });
 ```
 
 Alternatively, the `apiKey` can be set as Map option instead of in the `config` object. Yet, this will still internally propagate to the `config` object:
 ```ts
-import * as maptilersdk from '@maptiler/sdk';
+import { Map } from '@maptiler/sdk';
 
 // Let's say you have a DIV ready to receive a map
 const mapContainer = document.getElementById('my-container-div');
 
 // Instantiate the map
-const map = new maptilersdk.Map({
+const map = new Map({
   container: mapContainer,
   apiKey: 'YOUR_API_KEY'
 });
@@ -155,6 +155,7 @@ The SDK hosted on our CDN is bundled as *[Universal Module Definition](https://g
     </script>
   </body>
 </html>
+
 ```
 
 Check out the minimalist code samples in the [demos](demos) directory.
@@ -540,125 +541,7 @@ map.on("terrainAnimationStop", (e) => {
   });
 });
 ```
-# Halo and Space Options
-
-The `halo` and `space` options allow for enhanced visual customization of the map, especially for globe projections.  
-
-## `halo` (Atmospheric Glow)  
-The `halo` option adds a gradient-based atmospheric glow around the globe, simulating the visual effect of Earth's atmosphere when viewed from space.  
-
-### Usage:  
-You can enable a simple halo by setting it to `true`:  
-```ts
-const map = new maptilersdk.Map({
-  container: document.getElementById("map"),
-  style: maptilersdk.MapStyle.OUTDOOR,
-  halo: true,
-});
-```
-For more customization, you can define a radial gradient with scale and stops:
-```ts
 
-const map = new maptilersdk.Map({
-  container: document.getElementById("map"),
-  style: maptilersdk.MapStyle.OUTDOOR,
-  halo: {
-    scale: 1.5, // Controls the halo size
-    stops: [
-      [0.2, "transparent"],
-      [0.2, "red"],
-      [0.4, "red"],
-      [0.4, "transparent"],
-      [0.6, "transparent"],
-      [0.6, "red"],
-      [0.8, "red"],
-      [0.8, "transparent"],
-      [1.0, "transparent"],
-    ],
-  },
-});
-```
-You can also set the halo dynamically after the map loads:
-```ts
-map.on("load", () => {
-  map.setHalo({
-    scale: 2,
-    stops: [
-      [0.0, "rgba(135,206,250,1)"],
-      [0.5, "rgba(0,0,250,0.75)"],
-      [0.75, "rgba(250,0,0,0.0)"],
-    ],
-  });
-});
-```
-## `space` (Background Environment)
-
-The space option allows customizing the background environment of the globe, simulating deep space or skybox effects.
-### Usage
-
-You can enable a simple space background with a solid color:
-```ts
-const map = new maptilersdk.Map({
-  container: document.getElementById("map"),
-  style: maptilersdk.MapStyle.OUTDOOR,
-  space: {
-    color: "#111122", // Dark space-like color
-  },
-});
-```
-Alternatively, you can provide a cubemap for a realistic skybox effect using one of the following methods:
-
-    Predefined Presets:
-```ts
-const map = new maptilersdk.Map({
-  container: document.getElementById("map"),
-  style: maptilersdk.MapStyle.OUTDOOR,
-  space: {
-    preset: "universe-dark",
-  },
-});
-```
-Cubemap Images (Custom Skybox):
-```ts
-const map = new maptilersdk.Map({
-  container: document.getElementById("map"),
-  style: maptilersdk.MapStyle.OUTDOOR,
-  space: {
-    faces: {
-      pX: '/path-to-image/pX.png',
-      nX: '/path-to-image/nX.png',
-      pY: '/path-to-image/pY.png',
-      nY: '/path-to-image/nY.png',
-      pZ: '/path-to-image/pZ.png',
-      nZ: '/path-to-image/nZ.png',
-    },
-  },
-});
-```
-Cubemap Path with image format, fetches all images from a path, this assumes all files are named px, nx, py, ny, pz, nz and suffixed with the appropriate extension specified in `format`.
-```ts
-    const map = new maptilersdk.Map({
-      container: document.getElementById("map"),
-      style: maptilersdk.MapStyle.OUTDOOR,
-      space: {
-        path: {
-          baseUrl: "spacebox/transparent",
-          format: "png", // Defaults to PNG
-        },
-      },
-    });
-```
-You can also set the space background dynamically:
-```ts
-map.on("load", () => {
-  map.setSpace({
-    color: "red",
-    path: {
-      baseUrl: "spacebox/transparent",
-    },
-  });
-});
-```
 
 # Easy language switching
 The language generally depends on the style but we made it possible to easily set and update from a built-in list of languages.

package/dist/eslint.mjs

@@ -0,0 +1,133 @@
+// @ts-nocheck
+
+import tseslint from "typescript-eslint";
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+
+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: {
+      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,
+                              });
+                            }
+                          });
+                        }
+                      });
+                    }
+                  });
+                },
+              };
+            },
+          },
+        },
+      },
+    },
+    rules: {
+      "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": "warn",
+      "@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",
+    },
+  },
+  //
+);