@road-signs/se 0.0.0-stage → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# @road-signs/se
+
+## 0.1.1
+
+### Patch Changes
+
+- f798cfd: Add a README to every package, so the npm page for each one documents what it
+  contains and how to use it instead of rendering blank.
+
+  Country READMEs are generated from the same metadata that drives the docs site
+  plus live counts read from each registry, so they cannot drift from the code.
+
+- Updated dependencies [f798cfd]
+  - @road-signs/core@0.1.1

package/README.md

@@ -1,3 +1,64 @@
-# Temporary Holding Version
+# @road-signs/se
 
-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.
+Road signs for Sweden — a TypeScript registry with most signs' artwork inlined as SVG, plus typed lookup helpers.
+
+## Install
+
+```sh
+npm install @road-signs/se
+```
+
+## At a glance
+
+|                     |                                                                  |
+| ------------------- | ---------------------------------------------------------------- |
+| Signs               | 267                                                              |
+| With vector artwork | 260                                                              |
+| Categories          | `information`, `mandatory`, `priority`, `prohibitory`, `warning` |
+| Standard            | Vägmärkesförordning (VMF) — Vienna Convention                    |
+| Regulator           | Trafikverket (VMF)                                               |
+| Drive side          | right-hand                                                       |
+| Language(s)         | Swedish                                                          |
+
+## Usage
+
+```ts
+import { signs, getSign, getSignByCode, getSignsByCategory } from '@road-signs/se';
+
+signs; // the whole registry
+getSign('dangerous-curve-to-left-dangerous-curve-to-left'); // by slug id
+getSignByCode('dangerous-curve-to-left'); // by official code
+getSignsByCategory('information'); // by category
+```
+
+Each sign carries its own artwork, so nothing else has to be copied or served:
+
+```ts
+const sign = getSign('dangerous-curve-to-left-dangerous-curve-to-left')!;
+
+sign.svg; // inline, SVGO-optimised SVG markup
+```
+
+> **7 of these signs carry inline artwork.**
+> They have no usable vector source — either none was published upstream,
+> or the only artwork is a monochrome trace that renders as a black shape.
+> Vector sources for Sweden are welcome:
+> see [the coverage notes](https://karlnorling.github.io/road-signs/countries/se/).
+
+> `sign.assets` holds paths into this repo's build-time `assets/` tree.
+> That directory is ~16GB across all countries and is **not published** —
+> render from `sign.svg` instead.
+
+## Sources
+
+- [Wikimedia Commons — Road signs in Sweden](https://commons.wikimedia.org/wiki/Category:SVG_road_signs_in_Sweden)
+- [Wikimedia Commons — Road signs in Sweden (general)](https://commons.wikimedia.org/wiki/Category:Road_signs_in_Sweden)
+
+## Links
+
+- [Documentation](https://karlnorling.github.io/road-signs)
+- [Source](https://github.com/karlnorling/road-signs/tree/main/packages/@road-signs/se)
+
+## License
+
+MIT © Karl Norling

package/dist/cjs/index.d.ts

@@ -0,0 +1,9 @@
+import type { SECategory, SESign } from './types';
+import { signs } from './signs.generated';
+export type { SECategory, SESign } from './types';
+export { signs };
+export declare const getAllSigns: () => SESign[];
+export declare const getSign: (id: string) => SESign | undefined;
+export declare const getSignByCode: (code: string) => SESign | undefined;
+export declare const getSignsByCategory: (category: SECategory) => SESign[];
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE1C,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,CAAC;AAEjB,eAAO,MAAM,WAAW,QAAO,MAAM,EAAgB,CAAC;AAEtD,eAAO,MAAM,OAAO,OAAQ,MAAM,KAAG,MAAM,GAAG,SACd,CAAC;AAEjC,eAAO,MAAM,aAAa,SAAU,MAAM,KAAG,MAAM,GAAG,SAClB,CAAC;AAErC,eAAO,MAAM,kBAAkB,aAAc,UAAU,KAAG,MAAM,EAClB,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSignsByCategory = exports.getSignByCode = exports.getSign = exports.getAllSigns = exports.signs = void 0;
+const signs_generated_1 = require("./signs.generated");
+Object.defineProperty(exports, "signs", { enumerable: true, get: function () { return signs_generated_1.signs; } });
+const getAllSigns = () => [...signs_generated_1.signs];
+exports.getAllSigns = getAllSigns;
+const getSign = (id) => signs_generated_1.signs.find((s) => s.id === id);
+exports.getSign = getSign;
+const getSignByCode = (code) => signs_generated_1.signs.find((s) => s.code === code);
+exports.getSignByCode = getSignByCode;
+const getSignsByCategory = (category) => signs_generated_1.signs.filter((s) => s.category === category);
+exports.getSignsByCategory = getSignsByCategory;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AACA,uDAA0C;sFAAjC,uBAAK;AAKP,MAAM,WAAW,GAAG,GAAa,EAAE,CAAC,CAAC,GAAG,uBAAK,CAAC,CAAC;AAAzC,QAAA,WAAW,GAAX,WAAW,CAA8B;AAE/C,MAAM,OAAO,GAAG,CAAC,EAAU,EAAsB,EAAE,CACxD,uBAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AADpB,QAAA,OAAO,GAAP,OAAO,CACa;AAE1B,MAAM,aAAa,GAAG,CAAC,IAAY,EAAsB,EAAE,CAChE,uBAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AADxB,QAAA,aAAa,GAAb,aAAa,CACW;AAE9B,MAAM,kBAAkB,GAAG,CAAC,QAAoB,EAAY,EAAE,CACnE,uBAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;AADlC,QAAA,kBAAkB,GAAlB,kBAAkB,CACgB"}

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist/cjs/signs.generated.d.ts

@@ -0,0 +1,3 @@
+import type { SESign } from './types';
+export declare const signs: SESign[];
+//# sourceMappingURL=signs.generated.d.ts.map

package/dist/cjs/signs.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signs.generated.d.ts","sourceRoot":"","sources":["../../src/signs.generated.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC,eAAO,MAAM,KAAK,EAAE,MAAM,EA2pHzB,CAAC"}