@sakuzu/maplibre-gl-draw-ui 1.0.0

package/README.md

@@ -0,0 +1,267 @@
+# @sakuzu/maplibre-gl-draw-ui
+
+The standard user interface of
+[`@sakuzu/maplibre-gl-draw`](https://github.com/sakuzu/maplibre-gl-draw):
+a toolbar of the drawing tools at the bottom of the map, with keyboard
+shortcuts. It is built with the components of
+[kata](https://github.com/sakuzu/kata) and used through a plain
+JavaScript API, from any framework or none.
+
+The interface keeps nothing of the drawing. The current tool is
+`draw.getMode()`, the selection is `draw.selection.get()`, and every
+button calls the public API of the draw instance, so the interface can be
+mixed with controls of your own.
+
+The documentation of core, its guides and its API reference, is at
+<https://sakuzu.github.io/maplibre-gl-draw/>.
+
+## Install
+
+```sh
+npm install @sakuzu/maplibre-gl-draw @sakuzu/maplibre-gl-draw-ui maplibre-gl
+```
+
+`@sakuzu/maplibre-gl-draw` (2.x) and `maplibre-gl` are peer
+dependencies: the application installs them, and the interface uses the
+same copies as the application. Svelte is a dependency, and kata is
+compiled into the package.
+
+The package loads in two ways.
+
+- With a bundler, as ES modules: `dist/index.js` imports `svelte`, core
+  and `maplibre-gl`, which the bundler resolves, and
+  `@sakuzu/maplibre-gl-draw-ui/style.css` is the style sheet.
+- Without a bundler: `dist/maplibre-gl-draw-ui.js` is one module with
+  Svelte and kata in it. It loads with `<script type="module">` and an
+  import map that names `@sakuzu/maplibre-gl-draw` and `maplibre-gl`,
+  together with `dist/style.css`.
+
+```html
+<link rel="stylesheet" href="/vendor/maplibre-gl.css" />
+<link rel="stylesheet" href="/vendor/maplibre-gl-draw-ui/style.css" />
+<script type="importmap">
+  {
+    "imports": {
+      "maplibre-gl": "/vendor/maplibre-gl.mjs",
+      "@sakuzu/maplibre-gl-draw": "/vendor/maplibre-gl-draw.js"
+    }
+  }
+</script>
+<script type="module">
+  import { Map } from 'maplibre-gl';
+  import { createDraw } from '@sakuzu/maplibre-gl-draw';
+  import { createDrawUI } from '/vendor/maplibre-gl-draw-ui/maplibre-gl-draw-ui.js';
+
+  const map = new Map({ container: 'map', style: '/style.json' });
+  createDrawUI(createDraw(map));
+</script>
+```
+
+The paths stand for where the page serves the files: maplibre-gl's
+`dist/maplibre-gl.mjs`, the `dist/` of this package, and a module of core
+with its own dependencies in it that imports `maplibre-gl` by that name.
+
+## Use
+
+```ts
+import { createDraw } from '@sakuzu/maplibre-gl-draw';
+import { createDrawUI } from '@sakuzu/maplibre-gl-draw-ui';
+import '@sakuzu/maplibre-gl-draw-ui/style.css';
+
+const draw = createDraw(map);
+const ui = createDrawUI(draw, {
+  toolbar: { tools: ['select', 'point', 'line', 'polygon', 'circle'] },
+  locale: 'ja', // 'en' (the default), 'ja', or words laid over English
+  shortcuts: true, // V P L A C F I, Delete, and ? for the list
+});
+
+ui.setLocale('en');
+ui.destroy();
+```
+
+The options of `createDrawUI`, all optional:
+
+| Option | What it sets | Default |
+| --- | --- | --- |
+| `container` | The positioned element it lies over | the map's container |
+| `toolbar` | `false`, or the `tools`, `delete` and `snapping` | `true` |
+| `inspector` | `false`, or the `tabs` and `operations` | `true` |
+| `layers` | `false`, or the `features`, `add` and `reorder` | `true` |
+| `legend` | The legend beside the layer panel | `true` |
+| `locale` | `en`, `ja`, or words laid over English | `en` |
+| `theme` | `light`, `dark` or `auto` (follows the system) | `auto` |
+| `units` | The measurements in `metric` or `imperial` | `metric` |
+| `shortcuts` | The keyboard shortcuts | `true` |
+| `padding` | Whether the map's padding follows the interface | `true` |
+| `side` | The side panels `floating` over the map or `beside` it | `floating` |
+| `themeToggle` | The button that switches the look | `true` |
+| `mapControls` | maplibre-gl's globe, compass, zoom and scale | `true` |
+
+Each part also goes alone into an element of the page, with its own
+options and `target`, `locale` and `theme`: `createToolbar`,
+`createLayerPanel`, `createLegend` and `createInspector`.
+
+The interface is laid over the map's container. The toolbar alone goes
+into any positioned element with `createToolbar(draw, { target })`.
+The side panels float over the map, gap-md from its edges and as tall
+as their content; `side: 'beside'` docks them beside the map on a wide
+one instead. The map's padding follows the interface, the width of a
+panel that stands beside the map and the toolbar's height at the bottom,
+so that `fitBounds` and `easeTo` keep clear of them; `padding: false`
+leaves the map's padding alone.
+
+On the left, the layer panel and the legend share a panel, in two tabs.
+The layer panel is the tree of the layers, their groups and their
+features, from the front, with the eye, the lock, renaming in place (F2
+or a double click), reordering by dragging and an add menu (a new layer,
+a new group from the selected features). A feature is named by its
+`properties.name`, or by its type when it has none. The legend shows
+the rows of the style rule (`styleRule`) of each layer that has one.
+Shift+L opens and closes the panel, and while it is closed a button at
+the top left of the map opens it again.
+
+```ts
+const ui = createDrawUI(draw, {
+  layers: { features: true, add: true, reorder: true }, // or false for none
+  legend: true,
+});
+```
+
+Each goes alone into an element with
+`createLayerPanel(draw, { target })` and `createLegend(draw, { target })`.
+
+A tool for a mode of your own (added with `draw.extensions.modes.add`):
+
+```ts
+ui.tools.add({
+  id: 'ring',
+  mode: 'draw_ring',
+  label: 'Ring',
+  icon: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor">…</svg>',
+  shortcut: 'R',
+});
+```
+
+## Inspector
+
+The inspector is the panel on the right of `createDrawUI`. It opens
+while something is selected and closes, clearing the selection, with its
+close button. For one feature it shows its name (`properties.name`,
+changed where it stands); under it, its measurements and its description
+(`properties.description`, changed where it stands); then a Style tab
+with the fields its type reads and an Attributes tab with its other
+attributes. Several features
+show the fields they share, a field whose values differ being mixed, and
+the operations that apply to them (union, intersection, difference,
+split and buffer). A layer and a group show their name, whether they are
+visible and whether they are locked.
+
+```ts
+const ui = createDrawUI(draw, {
+  inspector: { tabs: ['style', 'attributes'], operations: true },
+  units: 'imperial', // ft, mi, ac; metric by default
+});
+```
+
+A value typed into an attribute is kept as the string typed. The
+inspector alone goes into any element with
+`createInspector(draw, { target })`, and an application adds a section
+of its own for the features it applies to:
+
+```ts
+ui.inspector?.sections.add({
+  id: 'survey',
+  title: 'Survey',
+  appliesTo: (features) => features.every((f) => f.type === 'Point'),
+  fields: ([first]) => [
+    {
+      key: 'checked',
+      kind: 'toggle',
+      label: 'Checked',
+      value: first.properties.checked === true,
+    },
+  ],
+  onchange: (key, value, features) => {
+    const patch = { properties: { [key]: value } };
+    draw.features.updateMany(features.map((f) => ({ id: f.id, patch })));
+  },
+});
+```
+
+## Customize
+
+Everything the interface draws is inside its root element, which has the
+class `mgd-ui`, and its style sheet reaches nothing outside it. kata's
+tokens (the CSS custom properties `--kata-*`) are set on that element;
+set them on `.mgd-ui` to change the look. The `theme` option of
+`createDrawUI` and of each part put alone is `light`, `dark` or `auto`
+(the default, which follows the system's `prefers-color-scheme` as it
+changes), and `ui.setTheme` changes it. kata's theme is dark;
+`data-color-mode="light"` on the root element, which `light` sets, or on
+any element around it, turns it light.
+
+A button at the top right of the map switches the look: a sun while it
+is dark, a moon while it is light. It sets the theme to the look that is
+not shown, so from `auto` it keeps the one the system does not prefer;
+`ui.setTheme('auto')` follows the system again. While the inspector is
+open over the map or beside it, the button stands to the left of it.
+`themeToggle: false` leaves it out.
+
+Beyond the look, the options above choose the parts and what each shows,
+`ui.tools.add` adds a tool for a mode of the application (see
+[Use](#use)), and `ui.inspector.sections.add` adds a section to the
+inspector (see [Inspector](#inspector)).
+
+## Map controls
+
+`createDrawUI` adds maplibre-gl's own controls to the map, as
+maplibre-gl draws them: at the bottom right, from the top, the globe
+(`GlobeControl`), the compass (`NavigationControl` without zoom, which
+also resets the pitch) and the zoom; at the bottom left, the scale
+(`ScaleControl`). `destroy()` removes them. Their look comes from
+maplibre-gl's style sheet, which the page imports itself
+(`import 'maplibre-gl/dist/maplibre-gl.css'`).
+
+```ts
+const ui = createDrawUI(draw, {
+  mapControls: { globe: false, scale: true }, // or false for none
+});
+```
+
+A page that adds controls of its own passes `mapControls: false`. Where
+the toolbar reaches a bottom corner of the map across, as on a narrow
+map, that corner (its controls and the attribution) is lifted above the
+toolbar. This is the one rule of the style sheet outside the root
+element: it applies to the map's container while the interface is on
+it.
+
+## Development
+
+The interface takes core from the root of this repository as an
+application takes it from npm, through core's build. Build core first,
+then work on the interface:
+
+```sh
+npm run build          # core, at the root
+npm run ui:typecheck   # tsc and svelte-check
+npm run ui:test
+npm run ui:test:e2e    # on a real map in headless Chromium
+npm run ui:build       # dist/index.js, dist/maplibre-gl-draw-ui.js, dist/style.css
+npm run ui:dev         # the development page on http://localhost:3100
+```
+
+## License
+
+Copyright (C) 2026 SAKAIDA Atsushi.
+
+Licensed under the GNU Affero General Public License version 3
+(`AGPL-3.0-only`), the same terms as `@sakuzu/maplibre-gl-draw`. See
+`LICENSE` in the package, the same text as the
+[LICENSE](https://github.com/sakuzu/maplibre-gl-draw/blob/main/LICENSE)
+of the repository.
+
+If the AGPL does not fit your product, a commercial license is available
+from Kasika, Inc. (可視化技研株式会社): <https://www.kasika.xyz/>.
+
+The notices of the software included in the build (Svelte, kata and its
+icons) are in `THIRD_PARTY_NOTICES.md`.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,350 @@
+# Third-party notices
+
+`@sakuzu/maplibre-gl-draw-ui` is distributed under the GNU Affero General
+Public License version 3 (AGPL-3.0-only) (see `LICENSE`). Its build
+includes the third-party software listed here, under licenses compatible
+with AGPL-3.0. This file reproduces their notices and license texts.
+
+| Software | License | In `dist/index.js` | In `dist/maplibre-gl-draw-ui.js` |
+| --- | --- | --- | --- |
+| kata (`@sakuzu/kata`) | Apache-2.0 | Yes | Yes |
+| Lucide (`@lucide/svelte`) | ISC (MIT for the Feather icons) | Yes | Yes |
+| Svelte (`svelte`) | MIT | No (a dependency) | Yes |
+
+`dist/style.css` includes kata's tokens and the styles of its
+components. `@sakuzu/maplibre-gl-draw` and `maplibre-gl` are peer
+dependencies and are not included.
+
+The font tokens of kata name typefaces (IBM Plex Sans, IBM Plex Sans JP,
+IBM Plex Mono, Noto Sans SC and Noto Sans TC). The package does not
+bundle or load these fonts; without them, the browser falls back to the
+system fonts named at the end of each list.
+
+---
+
+## 1. kata (Apache License 2.0)
+
+The components, the icons of the drawing shapes, the tokens and the
+styles of kata are compiled into the build.
+
+Upstream: <https://github.com/sakuzu/kata>
+
+The NOTICE file of kata:
+
+```text
+kata
+Copyright 2026 Kasika, Inc.
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+The numeric scale follows ideas from LiftKit (Chainlift); no code or text
+from it is included.
+```
+
+The license of kata:
+
+```text
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```
+
+## 2. Lucide (ISC License, and MIT License for the icons from Feather)
+
+The icons that the interface uses (`circle`, `magnet` and
+`mouse-pointer-2`) and those that kata uses are compiled into the build.
+Some of them are derived from the Feather project, whose license follows
+the ISC License below for the icons it lists.
+
+Upstream: <https://github.com/lucide-icons/lucide>
+
+```text
+ISC License
+
+Copyright (c) 2026 Lucide Icons and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+---
+
+The following Lucide icons are derived from the Feather project:
+
+airplay, alert-circle, alert-octagon, alert-triangle, aperture,
+arrow-down-circle, arrow-down-left, arrow-down-right, arrow-down,
+arrow-left-circle, arrow-left, arrow-right-circle, arrow-right, arrow-up-circle,
+arrow-up-left, arrow-up-right, arrow-up, at-sign, calendar, cast, check,
+chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down,
+chevrons-left, chevrons-right, chevrons-up, circle, clipboard, clock, code,
+columns, command, compass, corner-down-left, corner-down-right,
+corner-left-down, corner-left-up, corner-right-down, corner-right-up,
+corner-up-left, corner-up-right, crosshair, database, divide-circle,
+divide-square, dollar-sign, download, external-link, feather, frown, hash,
+headphones, help-circle, info, italic, key, layout, life-buoy, link-2, link,
+loader, lock, log-in, log-out, maximize, meh, minimize, minimize-2,
+minus-circle, minus-square, minus, monitor, moon, more-horizontal,
+more-vertical, move, music, navigation-2, navigation, octagon, pause-circle,
+percent, plus-circle, plus-square, plus, power, radio, rss, search, server,
+share, shopping-bag, sidebar, smartphone, smile, square, table-2, tablet,
+target, terminal, trash-2, trash, triangle, tv, type, upload, x-circle,
+x-octagon, x-square, x, zoom-in, zoom-out
+
+The MIT License (MIT) (for the icons listed above)
+
+Copyright (c) 2013-present Cole Bemis
+
+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.
+```
+
+## 3. Svelte (MIT License)
+
+The run-time of Svelte is included in `dist/maplibre-gl-draw-ui.js`.
+`dist/index.js` imports it from the `svelte` package, a dependency.
+
+Upstream: <https://github.com/sveltejs/svelte>
+
+```text
+Copyright (c) 2016-2025 [Svelte
+Contributors](https://github.com/sveltejs/svelte/graphs/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/dist/controls.d.ts

@@ -0,0 +1,36 @@
+import { type ControlPosition, type IControl } from 'maplibre-gl';
+import type { MapControlsOptions } from './types.js';
+/** The members of the map the controls use */
+export interface ControlsMap {
+    addControl(control: IControl, position?: ControlPosition): unknown;
+    removeControl(control: IControl): unknown;
+}
+/** The controls added to a map, to remove */
+export interface MapControls {
+    /** Removes the controls from the map. A second call does nothing */
+    destroy(): void;
+}
+/**
+ * Adds maplibre-gl's controls to a map: all four with `true` or `undefined`, none with `false`,
+ * those not set to false with an object.
+ *
+ * maplibre-gl puts a control added to a bottom corner above those already there, so the controls
+ * of the bottom right are added from the bottom: the zoom, the compass, then the globe.
+ */
+export declare function mapControls(map: ControlsMap, option: boolean | MapControlsOptions | undefined): MapControls;
+/** The attribute on the map's container while the interface lifts its bottom corners */
+export declare const LIFT_ATTRIBUTE = "data-mgd-ui-lift";
+/** The bottom corners of the map, lifted above the toolbar while it reaches them */
+export interface CornerLift {
+    /** Measures again after the toolbar came, went or changed */
+    update(): void;
+    /** Stops following and puts the corners back */
+    destroy(): void;
+}
+/**
+ * Lifts the bottom corners of maplibre-gl's controls in `container` (the map's container) above
+ * the toolbar of the interface in `root`, each while the toolbar reaches it across: by the
+ * distance from the top of the toolbar to the bottom of the map. root.css moves the corners by
+ * the custom properties this sets on the container (--mgd-ui-lift-left and --mgd-ui-lift-right).
+ */
+export declare function cornerLift(container: HTMLElement, root: HTMLElement): CornerLift;