@osmix/core 0.0.2 → 0.0.6

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 (165) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/README.md +118 -107
  3. package/dist/core/src/entities.d.ts +114 -0
  4. package/dist/core/src/entities.d.ts.map +1 -0
  5. package/dist/core/src/entities.js +152 -0
  6. package/dist/core/src/entities.js.map +1 -0
  7. package/dist/core/src/ids.d.ts +113 -0
  8. package/dist/core/src/ids.d.ts.map +1 -0
  9. package/dist/{src → core/src}/ids.js +96 -31
  10. package/dist/core/src/ids.js.map +1 -0
  11. package/dist/core/src/index.d.ts +32 -0
  12. package/dist/core/src/index.d.ts.map +1 -0
  13. package/dist/core/src/index.js +35 -0
  14. package/dist/core/src/index.js.map +1 -0
  15. package/dist/core/src/nodes.d.ts +101 -0
  16. package/dist/core/src/nodes.d.ts.map +1 -0
  17. package/dist/core/src/nodes.js +309 -0
  18. package/dist/core/src/nodes.js.map +1 -0
  19. package/dist/core/src/osm.d.ts +74 -0
  20. package/dist/core/src/osm.d.ts.map +1 -0
  21. package/dist/core/src/osm.js +120 -0
  22. package/dist/core/src/osm.js.map +1 -0
  23. package/dist/core/src/relations.d.ts +118 -0
  24. package/dist/core/src/relations.d.ts.map +1 -0
  25. package/dist/core/src/relations.js +412 -0
  26. package/dist/core/src/relations.js.map +1 -0
  27. package/dist/core/src/stringtable.d.ts +95 -0
  28. package/dist/core/src/stringtable.d.ts.map +1 -0
  29. package/dist/core/src/stringtable.js +170 -0
  30. package/dist/core/src/stringtable.js.map +1 -0
  31. package/dist/core/src/tags.d.ts +126 -0
  32. package/dist/core/src/tags.d.ts.map +1 -0
  33. package/dist/core/src/tags.js +228 -0
  34. package/dist/core/src/tags.js.map +1 -0
  35. package/dist/core/src/typed-arrays.d.ts +124 -0
  36. package/dist/core/src/typed-arrays.d.ts.map +1 -0
  37. package/dist/{src → core/src}/typed-arrays.js +88 -9
  38. package/dist/core/src/typed-arrays.js.map +1 -0
  39. package/dist/core/src/utils.d.ts +11 -0
  40. package/dist/core/src/utils.d.ts.map +1 -0
  41. package/dist/{src → core/src}/utils.js +8 -10
  42. package/dist/core/src/utils.js.map +1 -0
  43. package/dist/core/src/ways.d.ts +101 -0
  44. package/dist/core/src/ways.d.ts.map +1 -0
  45. package/dist/core/src/ways.js +336 -0
  46. package/dist/core/src/ways.js.map +1 -0
  47. package/dist/core/test/memory.test.d.ts +7 -0
  48. package/dist/core/test/memory.test.d.ts.map +1 -0
  49. package/dist/core/test/memory.test.js +29 -0
  50. package/dist/core/test/memory.test.js.map +1 -0
  51. package/dist/{test → core/test}/mock-osm.d.ts +3 -3
  52. package/dist/core/test/mock-osm.d.ts.map +1 -0
  53. package/dist/{test → core/test}/mock-osm.js +3 -3
  54. package/dist/core/test/mock-osm.js.map +1 -0
  55. package/dist/core/test/tags-search.test.d.ts +2 -0
  56. package/dist/core/test/tags-search.test.d.ts.map +1 -0
  57. package/dist/core/test/tags-search.test.js +56 -0
  58. package/dist/core/test/tags-search.test.js.map +1 -0
  59. package/dist/core/test/typed-arrays.test.d.ts.map +1 -0
  60. package/dist/{test → core/test}/typed-arrays.test.js +19 -17
  61. package/dist/core/test/typed-arrays.test.js.map +1 -0
  62. package/dist/osmix/src/extract.d.ts +43 -0
  63. package/dist/osmix/src/extract.d.ts.map +1 -0
  64. package/dist/osmix/src/extract.js +156 -0
  65. package/dist/osmix/src/extract.js.map +1 -0
  66. package/dist/osmix/src/pbf.d.ts +55 -0
  67. package/dist/osmix/src/pbf.d.ts.map +1 -0
  68. package/dist/osmix/src/pbf.js +187 -0
  69. package/dist/osmix/src/pbf.js.map +1 -0
  70. package/dist/osmix/src/utils.d.ts +36 -0
  71. package/dist/osmix/src/utils.d.ts.map +1 -0
  72. package/dist/osmix/src/utils.js +108 -0
  73. package/dist/osmix/src/utils.js.map +1 -0
  74. package/dist/osmix/test/extract.bench.d.ts.map +1 -0
  75. package/dist/{test → osmix/test}/extract.bench.js +8 -5
  76. package/dist/osmix/test/extract.bench.js.map +1 -0
  77. package/dist/osmix/test/extract.test.d.ts.map +1 -0
  78. package/dist/osmix/test/extract.test.js +392 -0
  79. package/dist/osmix/test/extract.test.js.map +1 -0
  80. package/package.json +10 -12
  81. package/src/entities.ts +138 -22
  82. package/src/ids.ts +117 -45
  83. package/src/index.ts +34 -5
  84. package/src/nodes.ts +237 -58
  85. package/src/osm.ts +174 -0
  86. package/src/relations.ts +383 -54
  87. package/src/stringtable.ts +111 -36
  88. package/src/tags.ts +207 -46
  89. package/src/typed-arrays.ts +97 -10
  90. package/src/types/geoflatbush.d.ts +37 -0
  91. package/src/types/geokdbush.d.ts +37 -0
  92. package/src/types/kdbush.d.ts +24 -6
  93. package/src/utils.ts +9 -14
  94. package/src/ways.ts +248 -84
  95. package/test/memory.test.ts +38 -0
  96. package/test/mock-osm.ts +8 -8
  97. package/test/tags-search.test.ts +60 -0
  98. package/test/typed-arrays.test.ts +5 -6
  99. package/tsconfig.json +7 -1
  100. package/dist/src/entities.d.ts +0 -26
  101. package/dist/src/entities.d.ts.map +0 -1
  102. package/dist/src/entities.js +0 -69
  103. package/dist/src/entities.js.map +0 -1
  104. package/dist/src/ids.d.ts +0 -50
  105. package/dist/src/ids.d.ts.map +0 -1
  106. package/dist/src/ids.js.map +0 -1
  107. package/dist/src/index.d.ts +0 -6
  108. package/dist/src/index.d.ts.map +0 -1
  109. package/dist/src/index.js +0 -7
  110. package/dist/src/index.js.map +0 -1
  111. package/dist/src/nodes.d.ts +0 -36
  112. package/dist/src/nodes.d.ts.map +0 -1
  113. package/dist/src/nodes.js +0 -171
  114. package/dist/src/nodes.js.map +0 -1
  115. package/dist/src/osmix.d.ts +0 -88
  116. package/dist/src/osmix.d.ts.map +0 -1
  117. package/dist/src/osmix.js +0 -438
  118. package/dist/src/osmix.js.map +0 -1
  119. package/dist/src/relations.d.ts +0 -31
  120. package/dist/src/relations.d.ts.map +0 -1
  121. package/dist/src/relations.js +0 -161
  122. package/dist/src/relations.js.map +0 -1
  123. package/dist/src/stringtable.d.ts +0 -37
  124. package/dist/src/stringtable.d.ts.map +0 -1
  125. package/dist/src/stringtable.js +0 -101
  126. package/dist/src/stringtable.js.map +0 -1
  127. package/dist/src/tags.d.ts +0 -33
  128. package/dist/src/tags.d.ts.map +0 -1
  129. package/dist/src/tags.js +0 -92
  130. package/dist/src/tags.js.map +0 -1
  131. package/dist/src/typed-arrays.d.ts +0 -50
  132. package/dist/src/typed-arrays.d.ts.map +0 -1
  133. package/dist/src/typed-arrays.js.map +0 -1
  134. package/dist/src/utils.d.ts +0 -4
  135. package/dist/src/utils.d.ts.map +0 -1
  136. package/dist/src/utils.js.map +0 -1
  137. package/dist/src/ways.d.ts +0 -42
  138. package/dist/src/ways.d.ts.map +0 -1
  139. package/dist/src/ways.js +0 -186
  140. package/dist/src/ways.js.map +0 -1
  141. package/dist/test/extract.bench.d.ts.map +0 -1
  142. package/dist/test/extract.bench.js.map +0 -1
  143. package/dist/test/extract.test.d.ts.map +0 -1
  144. package/dist/test/extract.test.js +0 -127
  145. package/dist/test/extract.test.js.map +0 -1
  146. package/dist/test/mock-osm.d.ts.map +0 -1
  147. package/dist/test/mock-osm.js.map +0 -1
  148. package/dist/test/read.test.d.ts +0 -2
  149. package/dist/test/read.test.d.ts.map +0 -1
  150. package/dist/test/read.test.js +0 -17
  151. package/dist/test/read.test.js.map +0 -1
  152. package/dist/test/typed-arrays.test.d.ts.map +0 -1
  153. package/dist/test/typed-arrays.test.js.map +0 -1
  154. package/dist/test/write.test.d.ts +0 -2
  155. package/dist/test/write.test.d.ts.map +0 -1
  156. package/dist/test/write.test.js +0 -55
  157. package/dist/test/write.test.js.map +0 -1
  158. package/src/osmix.ts +0 -556
  159. package/test/extract.bench.ts +0 -29
  160. package/test/extract.test.ts +0 -161
  161. package/test/read.test.ts +0 -22
  162. package/test/write.test.ts +0 -69
  163. /package/dist/{test → core/test}/typed-arrays.test.d.ts +0 -0
  164. /package/dist/{test → osmix/test}/extract.bench.d.ts +0 -0
  165. /package/dist/{test → osmix/test}/extract.test.d.ts +0 -0
@@ -1,161 +0,0 @@
1
- import { getFixtureFileReadStream } from "@osmix/shared/test/fixtures"
2
- import type { GeoBbox2D } from "@osmix/shared/types"
3
- import { assert, test } from "vitest"
4
- import { Osmix } from "../src/osmix"
5
-
6
- const TEST_BBOX: GeoBbox2D = [-0.1, -0.1, 1, 1]
7
- const SEATTLE_BBOX: GeoBbox2D = [-122.463226, 47.469878, -122.180328, 47.82883]
8
-
9
- function buildSourceOsm() {
10
- const osm = new Osmix({ id: "source" })
11
- osm.nodes.addNode({
12
- id: 1,
13
- lat: 0,
14
- lon: 0,
15
- tags: {
16
- name: "inside-a",
17
- },
18
- })
19
- osm.nodes.addNode({
20
- id: 2,
21
- lat: 0,
22
- lon: 2,
23
- tags: {
24
- name: "outside-a",
25
- },
26
- })
27
- osm.nodes.addNode({
28
- id: 3,
29
- lat: 0.5,
30
- lon: 0.5,
31
- })
32
- osm.nodes.addNode({
33
- id: 4,
34
- lat: 0.5,
35
- lon: 1.5,
36
- })
37
-
38
- osm.ways.addWay({
39
- id: 10,
40
- refs: [1, 2],
41
- tags: {
42
- highway: "residential",
43
- },
44
- })
45
- osm.ways.addWay({
46
- id: 11,
47
- refs: [3, 4],
48
- tags: {
49
- highway: "service",
50
- },
51
- })
52
-
53
- osm.relations.addRelation({
54
- id: 20,
55
- members: [
56
- {
57
- type: "way",
58
- ref: 10,
59
- role: "outer",
60
- },
61
- ],
62
- tags: {
63
- type: "multipolygon",
64
- },
65
- })
66
-
67
- osm.buildIndexes()
68
- return osm
69
- }
70
-
71
- test("extract a BBOX while reading a PBF", async () => {
72
- const source = buildSourceOsm()
73
- const transform = new TransformStream<
74
- Uint8Array<ArrayBufferLike>,
75
- Uint8Array<ArrayBufferLike>
76
- >()
77
- const extract = new Osmix()
78
- const extractPromise = extract.readPbf(transform.readable, {
79
- extractBbox: TEST_BBOX,
80
- })
81
- await source.toPbfStream().pipeTo(transform.writable)
82
- await extractPromise
83
-
84
- assert.equal(extract.nodes.size, 2)
85
- assert.isTrue(extract.nodes.ids.has(1))
86
- assert.isTrue(extract.nodes.ids.has(3))
87
- assert.isNotTrue(extract.nodes.ids.has(2))
88
- assert.isNotTrue(extract.nodes.ids.has(4))
89
-
90
- const truncatedWay = extract.ways.getById(10)
91
- assert.exists(truncatedWay)
92
- assert.deepEqual(truncatedWay?.refs, [1])
93
-
94
- assert.isTrue(extract.ways.ids.has(11))
95
- assert.isTrue(extract.relations.ids.has(20))
96
- })
97
-
98
- test("extract a BBOX after reading a PBF", async () => {
99
- const source = buildSourceOsm()
100
- const buffer = await source.toPbfBuffer()
101
-
102
- const streaming = new Osmix()
103
- await streaming.readPbf(new Uint8Array(buffer.slice(0)), {
104
- extractBbox: TEST_BBOX,
105
- })
106
-
107
- const twoStepOsmix = new Osmix()
108
- await twoStepOsmix.readPbf(new Uint8Array(buffer.slice(0)))
109
- const twoStep = twoStepOsmix.extract(TEST_BBOX)
110
-
111
- assert.equal(streaming.nodes.size, twoStep.nodes.size)
112
- assert.equal(streaming.ways.size, twoStep.ways.size)
113
- assert.equal(streaming.relations.size, twoStep.relations.size)
114
-
115
- assert.deepEqual(
116
- Array.from(streaming.nodes.ids.sorted),
117
- Array.from(twoStep.nodes.ids.sorted),
118
- )
119
- assert.deepEqual(
120
- Array.from(streaming.ways.ids.sorted),
121
- Array.from(twoStep.ways.ids.sorted),
122
- )
123
- assert.deepEqual(
124
- Array.from(streaming.relations.ids.sorted),
125
- Array.from(twoStep.relations.ids.sorted),
126
- )
127
-
128
- for (const nodeId of streaming.nodes.ids.sorted) {
129
- const streamingNode = streaming.nodes.getById(nodeId)
130
- const twoStepNode = twoStep.nodes.getById(nodeId)
131
- assert.deepEqual(streamingNode, twoStepNode)
132
- }
133
-
134
- for (const wayId of streaming.ways.ids.sorted) {
135
- const streamingWay = streaming.ways.getById(wayId)
136
- const twoStepWay = twoStep.ways.getById(wayId)
137
- assert.deepEqual(streamingWay, twoStepWay)
138
- }
139
-
140
- for (const relationId of streaming.relations.ids.sorted) {
141
- const streamingRelation = streaming.relations.getById(relationId)
142
- const twoStepRelation = twoStep.relations.getById(relationId)
143
- assert.deepEqual(streamingRelation, twoStepRelation)
144
- }
145
- })
146
-
147
- test.skip("extract from a large PBF", { timeout: 500_000 }, async () => {
148
- const seattle = new Osmix({ logger: console.error })
149
- await seattle.readPbf(getFixtureFileReadStream("usa.pbf"), {
150
- extractBbox: SEATTLE_BBOX,
151
- })
152
-
153
- assert.deepEqual(
154
- {
155
- nodes: seattle.nodes.size,
156
- ways: seattle.ways.size,
157
- relations: seattle.relations.size,
158
- },
159
- { nodes: 802_541, ways: 241_248, relations: 3_622 },
160
- )
161
- })
package/test/read.test.ts DELETED
@@ -1,22 +0,0 @@
1
- import {
2
- getFixtureFile,
3
- getFixtureFileReadStream,
4
- PBFs,
5
- } from "@osmix/shared/test/fixtures"
6
- import { assert, beforeAll, describe, it } from "vitest"
7
- import { Osmix } from "../src/osmix"
8
-
9
- describe("read", () => {
10
- describe.each(Object.entries(PBFs))("%s", async (name, pbf) => {
11
- beforeAll(() => getFixtureFile(pbf.url))
12
-
13
- it("into OSM class", async () => {
14
- const fileStream = getFixtureFileReadStream(pbf.url)
15
- const osm = await Osmix.fromPbf(fileStream, { id: name })
16
- assert.equal(osm.nodes.size, pbf.nodes)
17
- assert.equal(osm.stringTable.length, pbf.uniqueStrings)
18
- assert.deepEqual(osm.nodes.getByIndex(0), pbf.node0)
19
- assert.equal(osm.ways.size, pbf.ways)
20
- })
21
- })
22
- })
@@ -1,69 +0,0 @@
1
- import {
2
- getFixtureFile,
3
- getFixtureFileReadStream,
4
- PBFs,
5
- } from "@osmix/shared/test/fixtures"
6
- import { assert, beforeAll, describe, it } from "vitest"
7
- import { Osmix } from "../src/osmix"
8
-
9
- describe("write", () => {
10
- describe.each(Object.entries(PBFs))("%s", async (name, pbf) => {
11
- beforeAll(() => getFixtureFile(pbf.url))
12
-
13
- it("write osm primitive blocks", async () => {
14
- // Parse the original PBF
15
- const fileStream = getFixtureFileReadStream(pbf.url)
16
- const osm = await Osmix.fromPbf(fileStream, { id: name })
17
-
18
- // Get the first node, way, and relation
19
- const node1 = osm.nodes.getByIndex(0)
20
- const way1 = osm.ways.getByIndex(0)
21
- const relation1 = osm.relations.getByIndex(0)
22
- assert.exists(node1)
23
- assert.exists(way1)
24
- assert.exists(relation1)
25
-
26
- const transformStream = new TransformStream<
27
- Uint8Array<ArrayBufferLike>,
28
- Uint8Array<ArrayBufferLike>
29
- >()
30
- const testOsmPromise = Osmix.fromPbf(transformStream.readable, {
31
- id: `${name}-reparsed`,
32
- })
33
-
34
- // Write the PBF to an array buffer
35
- // let data = new Uint8Array(0)
36
- await osm.toPbfStream().pipeTo(transformStream.writable)
37
-
38
- // Re-parse the new PBF
39
- // assert.exists(data.buffer)
40
- const testOsm = await testOsmPromise
41
-
42
- // Compare the original parsed PBF and newly parsed/written/re-parsed PBF
43
- assert.equal(osm.nodes.size, testOsm.nodes.size)
44
- assert.equal(osm.ways.size, testOsm.ways.size)
45
- assert.equal(osm.relations.size, testOsm.relations.size)
46
-
47
- if (node1) {
48
- const testNode1 = testOsm.nodes.getById(node1.id)
49
- assert.deepEqual(testNode1, node1)
50
- assert.equal(testNode1?.id, node1.id)
51
- assert.equal(testNode1?.lon, node1.lon)
52
- assert.equal(testNode1?.lat, node1.lat)
53
- assert.deepEqual(testNode1?.tags, node1.tags)
54
- }
55
- if (way1) {
56
- const testWay1 = testOsm.ways.getById(way1.id)
57
- assert.equal(testWay1?.id, way1.id)
58
- assert.deepEqual(testWay1?.refs, way1.refs)
59
- assert.deepEqual(testWay1?.tags, way1.tags)
60
- }
61
- if (relation1) {
62
- const testRelation1 = testOsm.relations.getById(relation1.id)
63
- assert.equal(testRelation1?.id, relation1.id)
64
- assert.deepEqual(testRelation1?.members, relation1.members)
65
- assert.deepEqual(testRelation1?.tags, relation1.tags)
66
- }
67
- })
68
- })
69
- })
File without changes
File without changes
File without changes