@gemeenteleiden/icons 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 Gemeente Leiden
+
+   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.

package/README.md

@@ -1,3 +1,118 @@
-# Temporary Holding Version
+# @gemeenteleiden/icons
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+De iconenset van Gemeente Leiden voor de multisiteomgeving. Het package combineert iconen uit meerdere bronnen in één set met één formaat.
+
+| Bron (`source`) | Welke iconen | Licentie |
+| --- | --- | --- |
+| `material-symbols` | [Material Symbols](https://fonts.google.com/icons?icon.style=Sharp) (Sharp, weight 300, zonder fill): alleen de iconen in [icons.json](src/sources/material-symbols/icons.json) | Apache-2.0 |
+| `opengemeenten` | [OpenGemeenten Iconenset](https://github.com/OpenGemeenten/Iconenset): **alle** iconen van de release en variant in [source.json](src/sources/opengemeenten/source.json) | CC0-1.0 |
+| `custom` | Maatwerk: **alle** SVG's in [src/sources/custom/svg/](src/sources/custom/svg/) en [svg-multicolor/](src/sources/custom/svg-multicolor/) | — |
+
+## Installeren
+
+```sh
+npm install @gemeenteleiden/icons
+```
+
+## Gebruik
+
+```js
+import { icons } from '@gemeenteleiden/icons';
+
+// icons: { value, label, source, multicolor, viewBox, nodes }[]
+```
+
+- `value` is de unieke naam van het icoon, in snake_case (bijvoorbeeld `arrow_right_alt` of `afval_gft`).
+- `viewBox` verschilt per bron (Material Symbols `0 -960 960 960`, OpenGemeenten `0 0 48 48`). Neem hem dus altijd over van het icoon zelf.
+- `nodes` is de inhoud van het `<svg>`-element als boom (`{ tag, attrs, children? }`), met SVG-attribuutnamen zoals `fill-rule`. Daarmee bouw je het icoon in elk framework op, zonder `innerHTML`.
+
+Het package bevat:
+
+| Pad | Inhoud |
+| --- | --- |
+| `@gemeenteleiden/icons` | ESM- en CommonJS-module met `icons`, plus TypeScript-types (`IconName`, `IconSource`, `Icon`) |
+| `@gemeenteleiden/icons/icons.json` | Dezelfde gegevens als JSON, bijvoorbeeld om in PHP te lezen |
+| `@gemeenteleiden/icons/svg/<naam>.svg` | Losse SVG-bestanden, bijvoorbeeld voor de WordPress Icon API |
+
+Iconen kleuren mee met `currentColor`, behalve als `multicolor` `true` is (zoals bij het DigiD-logo). Die houden hun eigen kleuren. Attributen die bepalen hoe een icoon getekend wordt (zoals `fill="none"` en `stroke` bij lijn-iconen) staan nooit op het `<svg>`-element zelf, maar op de vormen daarbinnen. Je kunt dus veilig je eigen `fill`, `class` of `style` op `<svg>` zetten.
+
+### Compatibel met de WordPress Icon API
+
+Elk icoon is een platte lijst vormen met alleen de elementen en attributen die de [WordPress Icon API](https://developer.wordpress.org/reference/functions/wp_register_icon/) toelaat:
+
+- **Elementen:** `path`, `rect`, `circle` of `polygon`.
+- **Attributen:** `fill`, `fill-rule`, `clip-rule`, `stroke*`, `transform`, en de geometrie van de vorm.
+
+WordPress haalt al het andere weg met kses, maar laat de inhoud van verwijderde elementen staan. De vorm uit een `<clipPath>` wordt dan zichtbaar en kan het icoon bedekken.
+
+De build zet een icoon daarom automatisch om:
+- `<g>` wordt platgeslagen: de attributen gaan naar de vormen erin.
+- `<line>`, `<polyline>` en `<ellipse>` worden een `<path>`.
+- Een clip-path die niets wegsnijdt, zoals de frame-clip die Figma bij elke export toevoegt, wordt verwijderd.
+
+## Iconen toevoegen
+
+**Material Symbols:** voeg het icoon toe aan [src/sources/material-symbols/icons.json](src/sources/material-symbols/icons.json). De naam vind je op [fonts.google.com/icons](https://fonts.google.com/icons?icon.style=Sharp).
+
+```json
+{ "value": "arrow_forward", "label": "Arrow Forward" }
+```
+
+`label` is optioneel. Met `name` kun je een icoon onder een andere naam opnemen dan in Material Symbols.
+
+**OpenGemeenten:** alle iconen worden automatisch opgenomen. Naar een nieuwe release overstappen:
+
+```sh
+npm run sync:opengemeenten -- 5.2.0
+```
+
+Het script downloadt de release van GitHub en vervangt [src/sources/opengemeenten/svg/](src/sources/opengemeenten/svg/). Het werkt ook `source.json` en `LICENSE.md` bij. Commit die wijzigingen. De iconen staan bewust in deze repository, omdat de Iconenset niet als actueel npm-package beschikbaar is. Zo bouwt het package altijd met precies dezelfde iconen. De variant (`Line`, `Regular`, `Fill` of `Regular diapositive`) stel je in via `variant` in `source.json`, waarna je de sync opnieuw draait. Namen worden van PascalCase naar snake_case omgezet (`AfvalbakPMD` wordt `afvalbak_pmd`). Het label komt uit de `<title>` van de SVG.
+
+**Maatwerk:** zet een SVG, bijvoorbeeld een export uit Figma, in een van deze twee mappen:
+
+| Map | Voor | Kleuren |
+| --- | --- | --- |
+| [src/sources/custom/svg/](src/sources/custom/svg/) | éénkleurige iconen | worden `currentColor` |
+| [src/sources/custom/svg-multicolor/](src/sources/custom/svg-multicolor/) | logo's en andere meerkleurige iconen | blijven behouden |
+
+De bestandsnaam wordt de naam van het icoon, in kleine letters (`DigiD.svg` wordt `digid`). Het label komt uit de `<title>` of anders uit de bestandsnaam (`DigiD`). De SVG wordt opgeschoond met [SVGO] en omgezet naar het formaat hierboven.
+
+Draai daarna `npm run build`. De build stopt met een lijst van **alle** problemen als een icoon:
+- niet bestaat in de bron;
+- een naam heeft die al door een andere bron wordt gebruikt;
+- een ongeldige naam heeft (alleen kleine letters, cijfers en `_` zijn toegestaan);
+- geen `viewBox` heeft;
+- iets anders bevat dan vormen en groepen (`g`, `path`, `circle`, `ellipse`, `line`, `polygon`, `polyline`, `rect`). Verlopen, maskers, afbeeldingen, scripts, stijlen, links en event-attributen worden geweigerd;
+- een clip-path heeft die echt iets wegsnijdt. Maak de clip in het ontwerpprogramma plat, in Figma met *Flatten* of *Outline stroke*;
+- attributen heeft die de WordPress Icon API niet ondersteunt, zoals `opacity` op een groep.
+
+## Een bron toevoegen
+
+1. Maak een map in [src/sources/](src/sources/) met een `index.js`:
+   ```js
+   export default {
+     id: 'mijn-bron',          // wordt `source` op elk icoon
+     optimize: true,           // opschonen met SVGO (false als de bron al schoon is)
+     location: 'beschrijving', // voor foutmeldingen
+     list: () => [{ value: 'naam', label: 'Label', file: '/absoluut/pad.svg' }],
+   };
+   ```
+   `list()` bepaalt welke iconen worden opgenomen: een eigen lijst, zoals bij `material-symbols`, of alles uit een map met `listSvgDirectory()` uit [utils.js](src/sources/utils.js), zoals bij `opengemeenten` en `custom`.
+2. Registreer de bron in [src/sources/index.js](src/sources/index.js).
+3. Vermeld de licentie in de tabel hierboven en in `license` in `package.json`.
+
+## Publiceren
+
+```sh
+npm version <patch|minor|major>
+npm publish
+```
+
+`prepack` bouwt en controleert de set automatisch vóór elke publicatie.
+
+## Licentie
+
+- Material Symbols: © Google, [Apache License 2.0](LICENSE).
+- OpenGemeenten Iconenset: [CC0 1.0](src/sources/opengemeenten/LICENSE.md).
+
+[SVGO]: https://svgo.dev