@road-signs/core 0.0.0-stage → 0.1.0

package/dist/cjs/index.d.ts

@@ -0,0 +1,7 @@
+import type { Sign } from './types';
+export type { Sign, SignAssets, ViennaCategory, ViennaSign } from './types';
+export declare const getAllSigns: <T extends Sign>(registry: readonly T[]) => T[];
+export declare const getSign: <T extends Sign>(registry: readonly T[], id: string) => T | undefined;
+export declare const getSignByCode: <T extends Sign>(registry: readonly T[], code: string) => T | undefined;
+export declare const getSignsByCategory: <T extends Sign>(registry: readonly T[], category: T['category']) => T[];
+//# 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,IAAI,EAAE,MAAM,SAAS,CAAC;AAEpC,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE5E,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,IAAI,YAAY,SAAS,CAAC,EAAE,KAAG,CAAC,EAAmB,CAAC;AAE1F,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,IAAI,YAAY,SAAS,CAAC,EAAE,MAAM,MAAM,KAAG,CAAC,GAAG,SAC9C,CAAC;AAEpC,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,IAAI,YAAY,SAAS,CAAC,EAAE,QAAQ,MAAM,KAAG,CAAC,GAAG,SAClD,CAAC;AAExC,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,IAAI,YACrC,SAAS,CAAC,EAAE,YACZ,CAAC,CAAC,UAAU,CAAC,KACtB,CAAC,EAAqD,CAAC"}

package/dist/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSignsByCategory = exports.getSignByCode = exports.getSign = exports.getAllSigns = void 0;
+const getAllSigns = (registry) => [...registry];
+exports.getAllSigns = getAllSigns;
+const getSign = (registry, id) => registry.find((s) => s.id === id);
+exports.getSign = getSign;
+const getSignByCode = (registry, code) => registry.find((s) => s.code === code);
+exports.getSignByCode = getSignByCode;
+const getSignsByCategory = (registry, category) => registry.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":";;;AAIO,MAAM,WAAW,GAAG,CAAiB,QAAsB,EAAO,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;AAA7E,QAAA,WAAW,GAAX,WAAW,CAAkE;AAEnF,MAAM,OAAO,GAAG,CAAiB,QAAsB,EAAE,EAAU,EAAiB,EAAE,CAC3F,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AADvB,QAAA,OAAO,GAAP,OAAO,CACgB;AAE7B,MAAM,aAAa,GAAG,CAAiB,QAAsB,EAAE,IAAY,EAAiB,EAAE,CACnG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAD3B,QAAA,aAAa,GAAb,aAAa,CACc;AAEjC,MAAM,kBAAkB,GAAG,CAChC,QAAsB,EACtB,QAAuB,EAClB,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;AAH7C,QAAA,kBAAkB,GAAlB,kBAAkB,CAG2B"}

package/dist/cjs/package.json

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

package/dist/cjs/types.d.ts

@@ -0,0 +1,31 @@
+export interface SignAssets {
+    jpg: Record<number, string>;
+    png: Record<number, string>;
+    /** Relative path to the SVG source file. Absent for PDF-extracted (PNG-only) signs. */
+    svg?: string;
+    webp: Record<number, string>;
+}
+/**
+ * A single road sign. TCategory is narrowed per country package
+ * (e.g. USCategory = 'warning' | 'regulatory' | ...).
+ */
+export interface Sign<TCategory extends string = string> {
+    assets: SignAssets;
+    category: TCategory;
+    /** Official sign code, e.g. "W1-1" (US), "670" (UK). */
+    code: string;
+    description: string;
+    /** Slug ID, e.g. "w1-1-turn". */
+    id: string;
+    name: string;
+    /** Inline SVG string, SVGO-optimised. Absent for PDF-extracted (PNG-only) signs. */
+    svg?: string;
+}
+/**
+ * Standard five-category taxonomy shared by Vienna Convention countries.
+ * Used by: AT, BE, CH, CZ, DE, DK, ES, FI, FR, GR, HR, HU, IE, IS, IT,
+ *           LI, LT, LV, ME, MT, NL, NO, PL, PT, RO, RS, SE, SI, SK, TR…
+ */
+export type ViennaCategory = 'information' | 'mandatory' | 'priority' | 'prohibitory' | 'warning';
+export type ViennaSign = Sign<ViennaCategory>;
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,uFAAuF;IACvF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM;IACrD,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,SAAS,CAAC;IACpB,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,aAAa,GACb,WAAW,GACX,UAAU,GACV,aAAa,GACb,SAAS,CAAC;AAEd,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC"}

package/dist/cjs/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+import type { Sign } from './types';
+export type { Sign, SignAssets, ViennaCategory, ViennaSign } from './types';
+export declare const getAllSigns: <T extends Sign>(registry: readonly T[]) => T[];
+export declare const getSign: <T extends Sign>(registry: readonly T[], id: string) => T | undefined;
+export declare const getSignByCode: <T extends Sign>(registry: readonly T[], code: string) => T | undefined;
+export declare const getSignsByCategory: <T extends Sign>(registry: readonly T[], category: T['category']) => T[];
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAEpC,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAE5E,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,IAAI,YAAY,SAAS,CAAC,EAAE,KAAG,CAAC,EAAmB,CAAC;AAE1F,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,IAAI,YAAY,SAAS,CAAC,EAAE,MAAM,MAAM,KAAG,CAAC,GAAG,SAC9C,CAAC;AAEpC,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,IAAI,YAAY,SAAS,CAAC,EAAE,QAAQ,MAAM,KAAG,CAAC,GAAG,SAClD,CAAC;AAExC,eAAO,MAAM,kBAAkB,GAAI,CAAC,SAAS,IAAI,YACrC,SAAS,CAAC,EAAE,YACZ,CAAC,CAAC,UAAU,CAAC,KACtB,CAAC,EAAqD,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+export const getAllSigns = (registry) => [...registry];
+export const getSign = (registry, id) => registry.find((s) => s.id === id);
+export const getSignByCode = (registry, code) => registry.find((s) => s.code === code);
+export const getSignsByCategory = (registry, category) => registry.filter((s) => s.category === category);
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,WAAW,GAAG,CAAiB,QAAsB,EAAO,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC;AAE1F,MAAM,CAAC,MAAM,OAAO,GAAG,CAAiB,QAAsB,EAAE,EAAU,EAAiB,EAAE,CAC3F,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AAEpC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAiB,QAAsB,EAAE,IAAY,EAAiB,EAAE,CACnG,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAExC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,QAAsB,EACtB,QAAuB,EAClB,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC"}

package/dist/esm/package.json

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

package/dist/esm/types.d.ts

@@ -0,0 +1,31 @@
+export interface SignAssets {
+    jpg: Record<number, string>;
+    png: Record<number, string>;
+    /** Relative path to the SVG source file. Absent for PDF-extracted (PNG-only) signs. */
+    svg?: string;
+    webp: Record<number, string>;
+}
+/**
+ * A single road sign. TCategory is narrowed per country package
+ * (e.g. USCategory = 'warning' | 'regulatory' | ...).
+ */
+export interface Sign<TCategory extends string = string> {
+    assets: SignAssets;
+    category: TCategory;
+    /** Official sign code, e.g. "W1-1" (US), "670" (UK). */
+    code: string;
+    description: string;
+    /** Slug ID, e.g. "w1-1-turn". */
+    id: string;
+    name: string;
+    /** Inline SVG string, SVGO-optimised. Absent for PDF-extracted (PNG-only) signs. */
+    svg?: string;
+}
+/**
+ * Standard five-category taxonomy shared by Vienna Convention countries.
+ * Used by: AT, BE, CH, CZ, DE, DK, ES, FI, FR, GR, HR, HU, IE, IS, IT,
+ *           LI, LT, LV, ME, MT, NL, NO, PL, PT, RO, RS, SE, SI, SK, TR…
+ */
+export type ViennaCategory = 'information' | 'mandatory' | 'priority' | 'prohibitory' | 'warning';
+export type ViennaSign = Sign<ViennaCategory>;
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,uFAAuF;IACvF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM;IACrD,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,SAAS,CAAC;IACpB,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,aAAa,GACb,WAAW,GACX,UAAU,GACV,aAAa,GACb,SAAS,CAAC;AAEd,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC"}

package/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@road-signs/core",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Shared TypeScript types and generic lookup helpers for road sign packages",
+  "keywords": [
+    "road-signs",
+    "svg",
+    "typescript"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/karlnorling/road-signs",
+    "directory": "packages/@road-signs/core"
+  },
+  "files": [
+    "dist/",
+    "package.json",
+    "README.md"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/esm/index.d.ts"
+    }
+  },
+  "scripts": {
+    "compile": "tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && node -e \"require('fs').writeFileSync('dist/cjs/package.json', JSON.stringify({type:'commonjs'})); require('fs').writeFileSync('dist/esm/package.json', JSON.stringify({type:'module'}))\"",
+    "test": "jest --passWithNoTests",
+    "type-check": "tsc --noEmit -p tsconfig.cjs.json"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
+    "jest": "^30.5.2",
+    "ts-jest": "^29.4.15",
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
+  },
+  "author": {
+    "name": "Karl Norling",
+    "url": "https://github.com/karlnorling"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-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.