@zukall/zap 0.0.0-stage → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/LICENSE +21 -0
  2. package/PROTOCOL-V1.md +117 -0
  3. package/PROTOCOL.md +176 -0
  4. package/README.md +554 -2
  5. package/THIRD-PARTY-NOTICES.md +19 -0
  6. package/asset/zukall-diagnol-example.webp +0 -0
  7. package/asset/zukall-north-south-example.webp +0 -0
  8. package/asset/zukall-west-east.webp +0 -0
  9. package/dist/cjs/address.d.ts +3 -0
  10. package/dist/cjs/address.js +38 -0
  11. package/dist/cjs/address_bounty.d.ts +26 -0
  12. package/dist/cjs/address_bounty.js +2334 -0
  13. package/dist/cjs/address_province_bounty.d.ts +56 -0
  14. package/dist/cjs/address_province_bounty.js +5563 -0
  15. package/dist/cjs/country.d.ts +6 -0
  16. package/dist/cjs/country.js +27 -0
  17. package/dist/cjs/data.d.ts +3 -0
  18. package/dist/cjs/data.js +33 -0
  19. package/dist/cjs/directions.d.ts +5 -0
  20. package/dist/cjs/directions.js +13 -0
  21. package/dist/cjs/encoding.d.ts +3 -0
  22. package/dist/cjs/encoding.js +20 -0
  23. package/dist/cjs/grid.d.ts +23 -0
  24. package/dist/cjs/grid.js +152 -0
  25. package/dist/cjs/index.d.ts +27 -0
  26. package/dist/cjs/index.js +26 -0
  27. package/dist/cjs/internal.d.ts +3 -0
  28. package/dist/cjs/internal.js +19 -0
  29. package/dist/cjs/legacy-address.d.ts +3 -0
  30. package/dist/cjs/legacy-address.js +44 -0
  31. package/dist/cjs/package.json +1 -0
  32. package/dist/cjs/protocol.d.ts +22 -0
  33. package/dist/cjs/protocol.js +25 -0
  34. package/dist/cjs/types.d.ts +114 -0
  35. package/dist/cjs/types.js +2 -0
  36. package/dist/esm/address.d.ts +3 -0
  37. package/dist/esm/address.js +35 -0
  38. package/dist/esm/address_bounty.d.ts +26 -0
  39. package/dist/esm/address_bounty.js +2331 -0
  40. package/dist/esm/address_province_bounty.d.ts +56 -0
  41. package/dist/esm/address_province_bounty.js +5560 -0
  42. package/dist/esm/country.d.ts +6 -0
  43. package/dist/esm/country.js +22 -0
  44. package/dist/esm/data.d.ts +3 -0
  45. package/dist/esm/data.js +2 -0
  46. package/dist/esm/directions.d.ts +5 -0
  47. package/dist/esm/directions.js +10 -0
  48. package/dist/esm/encoding.d.ts +3 -0
  49. package/dist/esm/encoding.js +17 -0
  50. package/dist/esm/grid.d.ts +23 -0
  51. package/dist/esm/grid.js +148 -0
  52. package/dist/esm/index.d.ts +27 -0
  53. package/dist/esm/index.js +16 -0
  54. package/dist/esm/internal.d.ts +3 -0
  55. package/dist/esm/internal.js +15 -0
  56. package/dist/esm/legacy-address.d.ts +3 -0
  57. package/dist/esm/legacy-address.js +41 -0
  58. package/dist/esm/package.json +1 -0
  59. package/dist/esm/protocol.d.ts +22 -0
  60. package/dist/esm/protocol.js +22 -0
  61. package/dist/esm/types.d.ts +114 -0
  62. package/dist/esm/types.js +1 -0
  63. package/package.json +68 -4
@@ -0,0 +1,56 @@
1
+ /**
2
+ * Frozen address-grid snapshot; historical coverage notes are exported below.
3
+ * Scope: 22 countries and 530 province grids.
4
+ * Source: Natural Earth Admin-1 States/Provinces, 1:10 million, public domain.
5
+ * https://www.naturalearthdata.com/downloads/10m-cultural-vectors/10m-admin-1-states-provinces/
6
+ * https://raw.githubusercontent.com/nvkelso/natural-earth-vector/master/geojson/ne_10m_admin_1_states_provinces.geojson
7
+ * Retrieved: 2026-10-10. Retrieval date is NOT the date of administrative validity.
8
+ * SHA256: 22d0e3ad85eb3e27f17cabf8ba2d50e554fbc27a87796ff891d958185da62fb5
9
+ *
10
+ * Every country constant has exactly name, version, province.
11
+ * Province entries have name, version, corners.
12
+ * Four corners: topLeft, topRight, bottomRight, bottomLeft.
13
+ * Six decimal places, rounded OUTWARD to contain source geometry.
14
+ * Precision of representation does not imply centimeter boundary accuracy.
15
+ * For date-line rectangles, left/west longitude can exceed right/east longitude.
16
+ * ZAP supports these date-line rectangles.
17
+ *
18
+ * Keys prefer the source ISO-3166-2 suffix, e.g. AK, TX, ON, XJ, 01.
19
+ * Source codes are not verified current ISO codes. Duplicated, synthetic, or
20
+ * nonmatching codes get a stable NE_ source-ID key; none are silently overwritten.
21
+ * Review provinceDataNotes before presenting these as administrative choices.
22
+ * These snapshots can define fixed grid origins, but must not be advertised as
23
+ * current/all provinces. Replacing bounds later changes generated addresses.
24
+ * Source territorial groupings reflect map conventions, not sovereignty claims.
25
+ *
26
+ * Integration: the source constants use singular `province`.
27
+ * `provinceGrids` below adapts them to plural `provinces` for generateAddress.
28
+ */
29
+ import type { Country, ProvinceCountry } from "./types.js";
30
+ export declare const DZ: ProvinceCountry;
31
+ export declare const CD: ProvinceCountry;
32
+ export declare const SD: ProvinceCountry;
33
+ export declare const LY: ProvinceCountry;
34
+ export declare const TD: ProvinceCountry;
35
+ export declare const NE: ProvinceCountry;
36
+ export declare const AO: ProvinceCountry;
37
+ export declare const ML: ProvinceCountry;
38
+ export declare const ZA: ProvinceCountry;
39
+ export declare const ET: ProvinceCountry;
40
+ export declare const MR: ProvinceCountry;
41
+ export declare const RU: ProvinceCountry;
42
+ export declare const CA: ProvinceCountry;
43
+ export declare const US: ProvinceCountry;
44
+ export declare const CN: ProvinceCountry;
45
+ export declare const BR: ProvinceCountry;
46
+ export declare const AU: ProvinceCountry;
47
+ export declare const IN: ProvinceCountry;
48
+ export declare const AR: ProvinceCountry;
49
+ export declare const KZ: ProvinceCountry;
50
+ export declare const SA: ProvinceCountry;
51
+ export declare const ID: ProvinceCountry;
52
+ export declare const provinceCountries: Readonly<Record<string, ProvinceCountry>>;
53
+ /** Use this adapter to replace country-wide entries in address_bounty.ts. */
54
+ export declare const provinceGrids: Readonly<Record<string, Country>>;
55
+ export declare const provinceDataNotes: Readonly<Record<string, readonly string[]>>;
56
+ export declare const provinceCounts: Readonly<Record<string, number>>;