@siemens/maps-ng 47.11.0

package/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@siemens/maps-ng" />
+export * from './public-api';

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@siemens/maps-ng",
+  "description": "Element maps library based on OpenLayers.",
+  "version": "47.11.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/siemens/element.git"
+  },
+  "author": {
+    "name": "Siemens AG",
+    "email": "info@siemens.com"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/siemens/element",
+  "bugs": "https://github.com/siemens/element/issues/new",
+  "type": "module",
+  "peerDependencies": {
+    "@angular/common": "19 - 20",
+    "@angular/core": "19 - 20",
+    "ol": "~10.2.1",
+    "ol-ext": "^4.0.24",
+    "ol-mapbox-style": "^12.4.0",
+    "@siemens/element-translate-ng": "47.11.0"
+  },
+  "exports": {
+    "./docs.json": {
+      "default": "./docs.json"
+    },
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./fesm2022/siemens-maps-ng.mjs"
+    },
+    "./translate": {
+      "types": "./translate/index.d.ts",
+      "default": "./fesm2022/siemens-maps-ng-translate.mjs"
+    }
+  },
+  "module": "fesm2022/siemens-maps-ng.mjs",
+  "typings": "index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "tslib": "^2.3.0"
+  }
+}

package/projects/maps-ng/README.md

@@ -0,0 +1,119 @@
+# Element Maps
+
+Element maps library based on OpenLayers.
+
+## Usage
+
+To use this library in other projects, add it to your dependencies using:
+
+```sh
+npm install --save @siemens/maps-ng
+
+# Also install the needed peer dependencies
+npm install --save ol@~10.2.0 ol-ext ol-mapbox-style
+```
+
+Add library assets and CommonJs dependencies in your _angular.json_ under the build options
+
+```json
+{
+  "architect": {
+    "build": {
+      "options": {
+        "assets": [
+          // ... other assets
+          {
+            "glob": "**/*",
+            "input": "./node_modules/@siemens/maps-ng/assets",
+            "output": "/assets/"
+          }
+        ],
+        // ... other options
+        "allowedCommonJsDependencies": [
+          "xml-utils/find-tags-by-name.js",
+          "xml-utils/get-attribute.js",
+          "web-worker",
+          "pbf",
+          "earcut",
+          "rbush"
+        ]
+      }
+    }
+  }
+}
+```
+
+Import openlayers styles into your main global stylesheet
+
+```scss
+@use 'ol/ol.css';
+```
+
+Add the library to the list of _imports_ in your Angular _AppModule_ like this:
+
+```ts
+// [...]
+
+// Import this library and required dependencies
+import { SiMapModule } from '@siemens/maps-ng';
+
+@NgModule({
+  declarations: [AppComponent],
+  imports: [
+    BrowserModule,
+
+    // Import this library
+    SiMapModule
+  ],
+  bootstrap: [AppComponent]
+})
+export class AppModule {}
+```
+
+Or simply _import_ the `SiMapComponent` in your standalone component.
+
+```ts
+@Component({
+  selector: 'app-map',
+  standalone: true,
+  imports: [SiMapComponent],
+  templateUrl: './sample.component.html',
+  host: { class: 'h-100' }
+})
+export class SampleComponent {}
+```
+
+And lastly, add the map to your template and add a MapTiler key.
+Note, the map has not height per default and comes with a `block`
+display. Set the height or put it in a related container.
+
+The demo key works on localhost. It will be renewed regularly
+to avoid missuses of the key. Contact the SiMPL team to receive
+a key for your SI BP product.
+
+```html
+<si-map [maptilerKey]="'REPLACE_WITH_YOUR_MAPTILER_KEY'" style="height: 500px;"></si-map>
+```
+
+### Testing
+
+Do **not** load map data (tiles) from maptiler in automated tests, to reduce the number of
+payed requests to a minimum. E.g. during testing, you want to test your functions and not the
+tile data provided by maptiler.
+
+- **Unit tests:** Do simply **not** provide an API key during
+- **Playwright tests:** Stub the `tiles.json` request (and some others) using [page.route(...)](playwright/e2e/simpl-element/maps/static.spec.ts).
+
+### Running Unit Tests
+
+Run `yarn maps:test` to perform the unit tests via [Karma](https://karma-runner.github.io).
+You can set a seed for running the tests in a specific using an environment variable: `SEED=71384 yarn maps:test`
+
+## License
+
+The following applies for code and documentation of the git repository,
+unless explicitly mentioned.
+
+Copyright (c) Siemens 2016 - 2025
+
+MIT, see [LICENSE.md](LICENSE.md).

package/public-api.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Siemens 2016 - 2025
+ * SPDX-License-Identifier: MIT
+ */
+export * from './components/si-map/index';
+export * from '@siemens/maps-ng/translate';
+export * from './public-api.module';

package/public-api.module.d.ts

@@ -0,0 +1,8 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./components/si-map/si-map.module";
+export declare class SiMapsNgModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SiMapsNgModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SiMapsNgModule, never, never, [typeof i1.SiMapModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<SiMapsNgModule>;
+}
+export { SiMapsNgModule as SimplMapsNgModule };

package/translate/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) Siemens 2016 - 2025
+ * SPDX-License-Identifier: MIT
+ */
+export * from './si-translatable-keys.interface';
+export * from './si-translatable-overrides.provider';

package/translate/package.json

@@ -0,0 +1,3 @@
+{
+  "module": "../fesm2022/siemens-maps-ng-translate.mjs"
+}

package/translate/si-translatable-keys.interface.d.ts

@@ -0,0 +1,7 @@
+export interface SiTranslatableKeys {
+    'SI_MAPS.ATTRIBUTIONS_BUTTON'?: string;
+    'SI_MAPS.TOOLTIP_MORE_TEXT'?: string;
+    'SI_MAPS.ZOOM_IN_BUTTON'?: string;
+    'SI_MAPS.ZOOM_OUT_BUTTON'?: string;
+    'SI_MAPS.ZOOM_TO_DEFAULT_BUTTON'?: string;
+}

package/translate/si-translatable-overrides.provider.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) Siemens 2016 - 2025
+ * SPDX-License-Identifier: MIT
+ */
+import { Provider } from '@angular/core';
+import { SiTranslatableKeys } from './si-translatable-keys.interface';
+export declare const provideSiMapsTranslatableOverrides: (values: SiTranslatableKeys) => Provider;