olamaps-web-sdk 1.1.1

package/LICENSE.txt

@@ -0,0 +1,141 @@
+Copyright (c) 2024, OlaMaps
+All rights reserved.
+
+-------------------------------------------------------------------------------
+
+Copyright (c) 2023, MapLibre contributors
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of MapLibre GL JS nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------------
+
+Contains code from mapbox-gl-js v1.13 and earlier
+
+Version v1.13 of mapbox-gl-js and earlier are licensed under a BSD-3-Clause license
+
+Copyright (c) 2020, Mapbox
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+* Neither the name of Mapbox GL JS nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------------
+
+Contains code from glfx.js
+
+Copyright (C) 2011 by Evan Wallace
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+--------------------------------------------------------------------------------
+
+Contains a portion of d3-color https://github.com/d3/d3-color
+
+Copyright 2010-2016 Mike Bostock
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author nor the names of contributors may be used to
+  endorse or promote products derived from this software without specific prior
+  written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------------------------------------------------------------------------------
+
+Copyright Vis.gl contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,98 @@
+# OlaMaps Web SDK
+
+[![npm version](https://img.shields.io/npm/v/1.1.0)](https://www.npmjs.com/package/olamaps-web-sdk)
+[![License](https://img.shields.io/badge/Licence-OlaMaps-red)](LICENSE.txt)
+
+The official OlaMaps Web SDK provides a powerful and easy-to-use interface for integrating maps into your web applications. This repository contains the distribution files and serves as the public interface for issues, feature requests, and discussions.
+
+## Installation
+
+#### CDN Usage
+
+Add the following script tag to your HTML file's `<head>` section:
+
+```html
+<script src="https://www.unpkg.com/olamaps-web-sdk@latest/dist/olamaps-web-sdk.umd.js"></script>
+```
+
+#### Package Manager
+
+Install via npm:
+
+```bash
+npm i olamaps-web-sdk
+```
+
+Then use in your project by imports like:
+
+```javascript
+import { OlaMaps } from "olamaps-web-sdk";
+```
+
+### Usage
+
+#### Initialization
+
+First, initialize `OlaMaps` with your `API key`:
+
+```javascript
+const olaMaps = new OlaMaps({
+  apiKey: [YOUR_API_KEY],
+});
+```
+
+#### Rendering map
+
+1. Add a container element to your HTML
+
+```html
+<div id="[MAP CONTAINER ID]"></div>
+```
+
+2. Initialize the map with your desired configuration
+
+```javascript
+const map = olaMaps.init({
+  style: [ADD THE LINK OF TILES STYLE JSON HERE],
+  container: [MAP CONTAINER ID],
+  center: [INITIAL LAT LAN POSITION],
+  zoom: [SET ZOOM NUMBER]
+})
+```
+
+## Documentation & Resources
+
+For complete documentation and integration guides, visit our [Web SDK Documentation](https://maps.olakrutrim.com/docs/sdks/web-sdk/setup).
+Check out our [examples directory](/examples) for various implementation scenarios.
+
+### Community Support & Issue Tracking
+
+All bug reports, feature requests, and general issues should be raised through GitHub.
+
+- [Create a bug report](https://github.com/ola-maps/olamaps-web-sdk/blob/main/.github/ISSUE_TEMPLATE/bug_report.md)
+- [Request a feature](https://github.com/ola-maps/olamaps-web-sdk/blob/main/.github/ISSUE_TEMPLATE/feature_request.md)
+- [Browse existing issues](https://github.com/ola-maps/olamaps-web-sdk/issues)
+
+For general questions and discussions, visit our [discussions](https://github.com/ola-maps/olamaps-web-sdk/discussions) page
+For commercial support, contact us at [support@olakrutrim.com](mailto:support@olakrutrim.com)
+
+## Distribution Files
+
+The SDK includes the following distribution files:
+
+- `dist/olamaps-web-sdk.umd.js` - UMD build (minified)
+- `dist/index.js` - ES Module
+- `dist/index.d.ts` - TypeScript definitions
+
+## Versioning
+
+We use SemVer for versioning. For available versions, see the releases page.
+
+## Contributing
+
+While this repository doesn't contain the source code, we welcome:
+
+- Bug reports
+- Feature requests
+- Documentation improvements
+- Usage examples

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import { GeolocateControlOptions } from 'maplibre-gl';
+import { Map as Map_2 } from 'maplibre-gl';
+import { MapOptions } from 'maplibre-gl';
+import { MarkerOptions } from 'maplibre-gl';
+import { NavigationControlOptions } from 'maplibre-gl';
+import * as OlaMapsGl from 'maplibre-gl';
+import { PopupOptions } from 'maplibre-gl';
+
+declare interface olaMapProps {
+    apiKey: string;
+    mode?: string;
+    threedTileset?: string;
+    accessToken?: string;
+}
+
+export declare class OlaMaps {
+    private olaMaps;
+    private apiKey;
+    private accessToken;
+    mode: string;
+    private threedTileset;
+    constructor({ apiKey, accessToken, mode, threedTileset }: olaMapProps);
+    private addOlaLogo;
+    private addAttribution;
+    private fetchStaticMap;
+    private add3dLayer;
+    init(options?: MapOptions): Map_2 & typeof OlaMapsGl;
+    addNavigationControls(options?: NavigationControlOptions): OlaMapsGl.NavigationControl;
+    addGeolocateControls(options: GeolocateControlOptions): OlaMapsGl.GeolocateControl;
+    getMercatorCoordinate(): typeof OlaMapsGl.MercatorCoordinate;
+    addMarker(options?: MarkerOptions): OlaMapsGl.Marker;
+    addPopup(options?: PopupOptions): OlaMapsGl.Popup;
+    getStaticMap(url: string, elementID: string): void;
+}
+
+export { }