@zaes/sidc 0.0.0-stage → 0.2.0
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.
- package/CHANGELOG.md +58 -0
- package/LICENSE +21 -0
- package/README.md +24 -3
- package/THIRD-PARTY-NOTICES +217 -0
- package/dist/cjs/2525c/data2525c.js +1965 -0
- package/dist/cjs/2525c/index.js +178 -0
- package/dist/cjs/catalog/data2525e.js +2704 -0
- package/dist/cjs/catalog/dataApp6e.js +85 -0
- package/dist/cjs/catalog/index.js +137 -0
- package/dist/cjs/catalog/types.js +2 -0
- package/dist/cjs/genc.js +298 -0
- package/dist/cjs/index.js +49 -0
- package/dist/cjs/letter.js +116 -0
- package/dist/cjs/numeric.js +127 -0
- package/dist/cjs/tables.js +151 -0
- package/dist/esm/2525c/data2525c.js +1962 -0
- package/dist/esm/2525c/index.js +174 -0
- package/dist/esm/catalog/data2525e.js +2701 -0
- package/dist/esm/catalog/dataApp6e.js +82 -0
- package/dist/esm/catalog/index.js +130 -0
- package/dist/esm/catalog/types.js +1 -0
- package/dist/esm/genc.js +294 -0
- package/dist/esm/index.js +20 -0
- package/dist/esm/letter.js +112 -0
- package/dist/esm/numeric.js +123 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/tables.js +147 -0
- package/dist/types/2525c/data2525c.d.ts +10 -0
- package/dist/types/2525c/index.d.ts +22 -0
- package/dist/types/catalog/data2525e.d.ts +12 -0
- package/dist/types/catalog/dataApp6e.d.ts +15 -0
- package/dist/types/catalog/index.d.ts +31 -0
- package/dist/types/catalog/types.d.ts +46 -0
- package/dist/types/genc.d.ts +12 -0
- package/dist/types/index.d.ts +15 -0
- package/dist/types/letter.d.ts +51 -0
- package/dist/types/numeric.d.ts +66 -0
- package/dist/types/tables.d.ts +56 -0
- package/package.json +66 -6
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to `@zaes/sidc`.
|
|
4
|
+
|
|
5
|
+
The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
|
|
6
|
+
project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Dates are
|
|
7
|
+
the npm publish dates — when a version actually became installable.
|
|
8
|
+
|
|
9
|
+
> **Version 0.1.0 was reconstructed from the commit history after the fact.** This file was
|
|
10
|
+
> added afterwards, so its entry summarizes what the release contained.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## [Unreleased]
|
|
15
|
+
|
|
16
|
+
## [0.2.0] — 2026-11-16
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- **APP-6(E)'s own entities in the catalog.** The 59 entities APP-6(E) Version 2 defines and MIL-STD-2525E
|
|
21
|
+
Change 1 does not (cyberspace non-unit set 64, civilian dismounted individuals, NATO supply classes II and
|
|
22
|
+
V, Military Armoury and Base, and others) are read for an APP-6(E) code: `getEntity(symbolSet, code,
|
|
23
|
+
standard)` takes the code's standard (`'APP-6E'` for versions 14 and 16), and `describeSidc` passes it.
|
|
24
|
+
Such an entity carries `standard: 'APP-6E'`. For a 2525D or APP-6(D) code (`'2525D'`, `'APP-6D'`) the 13 of
|
|
25
|
+
them MIL-STD-2525D also defines are found too, under 2525D's own names and paths (`APP6E_IN_2525D`): 60 120100
|
|
26
|
+
is Infection › Advanced Persistent Threat (APT), not APP-6(E)'s Criminal, and 2525D spells Armored and Armory. Without the standard, or for any other, the
|
|
27
|
+
catalog is 2525E's as before.
|
|
28
|
+
|
|
29
|
+
### Fixed
|
|
30
|
+
|
|
31
|
+
- **APP-6(E) symbol sets.** An APP-6(E) code (versions 14 and 16) may name the signals intelligence sets
|
|
32
|
+
51-54 and the cyberspace non-unit set 64 of APP-6(E) Table A-4; they were reported as undefined.
|
|
33
|
+
`SYMBOL_SETS_APP6E_ONLY` lists 64.
|
|
34
|
+
|
|
35
|
+
### Changed
|
|
36
|
+
|
|
37
|
+
- **`formatNumericSidc` refuses a field longer than its positions**, with a `RangeError` naming the
|
|
38
|
+
field. It kept the last digits (`entityCode: '1211000'` wrote `211000`), which is another symbol's code.
|
|
39
|
+
|
|
40
|
+
## [0.1.0] — 2026-11-10
|
|
41
|
+
|
|
42
|
+
The first release: read, validate, write and convert MIL-STD-2525 and APP-6 symbol codes.
|
|
43
|
+
|
|
44
|
+
### Added
|
|
45
|
+
|
|
46
|
+
- **`parseSidc`**: reads a 2525C/2525B letter code (15 characters, trailing dashes optional) or a
|
|
47
|
+
2525D/2525E numeric code (20 or 30 digits), and reports rather than refuses: a well-formed code
|
|
48
|
+
with a value the tables do not define parses, with the value in `problems`. Versions 15
|
|
49
|
+
(2525E Change 1) and 16 (APP-6(E)(2)) are read as Table A-I gives them.
|
|
50
|
+
- **`formatNumericSidc`**: writes a numeric code from its fields.
|
|
51
|
+
- **The code tables**: standard identities, contexts, symbol sets, statuses, headquarters, task
|
|
52
|
+
force and dummy, amplifying descriptors, letter-code identities and statuses, each naming the
|
|
53
|
+
standard table it transcribes; `gencCountry` and the GENC country table for positions 28-30.
|
|
54
|
+
- **`@zaes/sidc/catalog`**: every 2525E Change 1 entity and sector modifier, with names,
|
|
55
|
+
hierarchy, kind (icon, frame, point, multipoint), Appendix A geometry, draw rule and icon type
|
|
56
|
+
(`getEntity`, `listEntities`, `listSectorModifiers`).
|
|
57
|
+
- **`@zaes/sidc/2525c`**: `convert2525C`, letter codes to 2525D codes through the crosswalk, with
|
|
58
|
+
what the conversion could not keep.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ZAES
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,24 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
# @zaes/sidc
|
|
2
|
+
|
|
3
|
+
Read, validate and write MIL-STD-2525 symbol identification codes: the 15-character letter code of
|
|
4
|
+
2525C and the 20- and 30-position numeric codes of 2525D and 2525E (and APP-6 D/E). No
|
|
5
|
+
dependencies.
|
|
6
|
+
|
|
7
|
+
**[Documentation](https://www.zaes.com/docs/military-symbols/)** · drawn by
|
|
8
|
+
[`@zaes/military-symbols`](https://www.npmjs.com/package/@zaes/military-symbols)
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install @zaes/sidc
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
```ts
|
|
15
|
+
import {parseSidc} from '@zaes/sidc';
|
|
16
|
+
|
|
17
|
+
const result = parseSidc('130310000011000000000000000000');
|
|
18
|
+
if (result.ok) console.log(result.sidc.standard, result.sidc.symbolSet, result.problems);
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
`@zaes/sidc/catalog` lists every 2525E entity and modifier; `@zaes/sidc/2525c` converts 2525C
|
|
22
|
+
letter codes to 2525D codes (`convert2525C`).
|
|
23
|
+
|
|
24
|
+
MIT licensed; the 2525C crosswalk derives from Apache-2.0 work (see THIRD-PARTY-NOTICES).
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
THIRD-PARTY NOTICES
|
|
2
|
+
|
|
3
|
+
@zaes/sidc includes data derived from third-party work.
|
|
4
|
+
|
|
5
|
+
-------------------------------------------------------------------------------
|
|
6
|
+
MIL-STD-2525C to MIL-STD-2525D crosswalk, as published in mil-sym-ts
|
|
7
|
+
https://github.com/missioncommand/mil-sym-ts (commit a6c2a354, 2026-11-05)
|
|
8
|
+
Licensed under the Apache License, Version 2.0 (reproduced below).
|
|
9
|
+
|
|
10
|
+
What is used: the code pairs and notes of src/main/ts/armyc2/c5isr/data/c2d.json,
|
|
11
|
+
in the optional 2525c entry.
|
|
12
|
+
|
|
13
|
+
Changes made: rows re-keyed by the positions that name a symbol; empty fields
|
|
14
|
+
filled with zeros.
|
|
15
|
+
-------------------------------------------------------------------------------
|
|
16
|
+
|
|
17
|
+
Apache License
|
|
18
|
+
Version 2.0, January 2004
|
|
19
|
+
http://www.apache.org/licenses/
|
|
20
|
+
|
|
21
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
22
|
+
|
|
23
|
+
1. Definitions.
|
|
24
|
+
|
|
25
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
26
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
27
|
+
|
|
28
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
29
|
+
the copyright owner that is granting the License.
|
|
30
|
+
|
|
31
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
32
|
+
other entities that control, are controlled by, or are under common
|
|
33
|
+
control with that entity. For the purposes of this definition,
|
|
34
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
35
|
+
direction or management of such entity, whether by contract or
|
|
36
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
37
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
38
|
+
|
|
39
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
40
|
+
exercising permissions granted by this License.
|
|
41
|
+
|
|
42
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
43
|
+
including but not limited to software source code, documentation
|
|
44
|
+
source, and configuration files.
|
|
45
|
+
|
|
46
|
+
"Object" form shall mean any form resulting from mechanical
|
|
47
|
+
transformation or translation of a Source form, including but
|
|
48
|
+
not limited to compiled object code, generated documentation,
|
|
49
|
+
and conversions to other media types.
|
|
50
|
+
|
|
51
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
52
|
+
Object form, made available under the License, as indicated by a
|
|
53
|
+
copyright notice that is included in or attached to the work
|
|
54
|
+
(an example is provided in the Appendix below).
|
|
55
|
+
|
|
56
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
57
|
+
form, that is based on (or derived from) the Work and for which the
|
|
58
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
59
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
60
|
+
of this License, Derivative Works shall not include works that remain
|
|
61
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
62
|
+
the Work and Derivative Works thereof.
|
|
63
|
+
|
|
64
|
+
"Contribution" shall mean any work of authorship, including
|
|
65
|
+
the original version of the Work and any modifications or additions
|
|
66
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
67
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
68
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
69
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
70
|
+
means any form of electronic, verbal, or written communication sent
|
|
71
|
+
to the Licensor or its representatives, including but not limited to
|
|
72
|
+
communication on electronic mailing lists, source code control systems,
|
|
73
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
74
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
75
|
+
excluding communication that is conspicuously marked or otherwise
|
|
76
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
77
|
+
|
|
78
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
79
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
80
|
+
subsequently incorporated within the Work.
|
|
81
|
+
|
|
82
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
83
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
84
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
85
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
86
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
87
|
+
Work and such Derivative Works in Source or Object form.
|
|
88
|
+
|
|
89
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
90
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
91
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
92
|
+
(except as stated in this section) patent license to make, have made,
|
|
93
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
94
|
+
where such license applies only to those patent claims licensable
|
|
95
|
+
by such Contributor that are necessarily infringed by their
|
|
96
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
97
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
98
|
+
institute patent litigation against any entity (including a
|
|
99
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
100
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
101
|
+
or contributory patent infringement, then any patent licenses
|
|
102
|
+
granted to You under this License for that Work shall terminate
|
|
103
|
+
as of the date such litigation is filed.
|
|
104
|
+
|
|
105
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
106
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
107
|
+
modifications, and in Source or Object form, provided that You
|
|
108
|
+
meet the following conditions:
|
|
109
|
+
|
|
110
|
+
(a) You must give any other recipients of the Work or
|
|
111
|
+
Derivative Works a copy of this License; and
|
|
112
|
+
|
|
113
|
+
(b) You must cause any modified files to carry prominent notices
|
|
114
|
+
stating that You changed the files; and
|
|
115
|
+
|
|
116
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
117
|
+
that You distribute, all copyright, patent, trademark, and
|
|
118
|
+
attribution notices from the Source form of the Work,
|
|
119
|
+
excluding those notices that do not pertain to any part of
|
|
120
|
+
the Derivative Works; and
|
|
121
|
+
|
|
122
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
123
|
+
distribution, then any Derivative Works that You distribute must
|
|
124
|
+
include a readable copy of the attribution notices contained
|
|
125
|
+
within such NOTICE file, excluding those notices that do not
|
|
126
|
+
pertain to any part of the Derivative Works, in at least one
|
|
127
|
+
of the following places: within a NOTICE text file distributed
|
|
128
|
+
as part of the Derivative Works; within the Source form or
|
|
129
|
+
documentation, if provided along with the Derivative Works; or,
|
|
130
|
+
within a display generated by the Derivative Works, if and
|
|
131
|
+
wherever such third-party notices normally appear. The contents
|
|
132
|
+
of the NOTICE file are for informational purposes only and
|
|
133
|
+
do not modify the License. You may add Your own attribution
|
|
134
|
+
notices within Derivative Works that You distribute, alongside
|
|
135
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
136
|
+
that such additional attribution notices cannot be construed
|
|
137
|
+
as modifying the License.
|
|
138
|
+
|
|
139
|
+
You may add Your own copyright statement to Your modifications and
|
|
140
|
+
may provide additional or different license terms and conditions
|
|
141
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
142
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
143
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
144
|
+
the conditions stated in this License.
|
|
145
|
+
|
|
146
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
147
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
148
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
149
|
+
this License, without any additional terms or conditions.
|
|
150
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
151
|
+
the terms of any separate license agreement you may have executed
|
|
152
|
+
with Licensor regarding such Contributions.
|
|
153
|
+
|
|
154
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
155
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
156
|
+
except as required for reasonable and customary use in describing the
|
|
157
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
158
|
+
|
|
159
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
160
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
161
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
162
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
163
|
+
implied, including, without limitation, any warranties or conditions
|
|
164
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
165
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
166
|
+
appropriateness of using or redistributing the Work and assume any
|
|
167
|
+
risks associated with Your exercise of permissions under this License.
|
|
168
|
+
|
|
169
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
170
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
171
|
+
unless required by applicable law (such as deliberate and grossly
|
|
172
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
173
|
+
liable to You for damages, including any direct, indirect, special,
|
|
174
|
+
incidental, or consequential damages of any character arising as a
|
|
175
|
+
result of this License or out of the use or inability to use the
|
|
176
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
177
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
178
|
+
other commercial damages or losses), even if such Contributor
|
|
179
|
+
has been advised of the possibility of such damages.
|
|
180
|
+
|
|
181
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
182
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
183
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
184
|
+
or other liability obligations and/or rights consistent with this
|
|
185
|
+
License. However, in accepting such obligations, You may act only
|
|
186
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
187
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
188
|
+
defend, and hold each Contributor harmless for any liability
|
|
189
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
190
|
+
of your accepting any such warranty or additional liability.
|
|
191
|
+
|
|
192
|
+
END OF TERMS AND CONDITIONS
|
|
193
|
+
|
|
194
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
195
|
+
|
|
196
|
+
To apply the Apache License to your work, attach the following
|
|
197
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
198
|
+
replaced with your own identifying information. (Don't include
|
|
199
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
200
|
+
comment syntax for the file format. We also recommend that a
|
|
201
|
+
file or class name and description of purpose be included on the
|
|
202
|
+
same "printed page" as the copyright notice for easier
|
|
203
|
+
identification within third-party archives.
|
|
204
|
+
|
|
205
|
+
Copyright [yyyy] [name of copyright owner]
|
|
206
|
+
|
|
207
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
208
|
+
you may not use this file except in compliance with the License.
|
|
209
|
+
You may obtain a copy of the License at
|
|
210
|
+
|
|
211
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
212
|
+
|
|
213
|
+
Unless required by applicable law or agreed to in writing, software
|
|
214
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
215
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
216
|
+
See the License for the specific language governing permissions and
|
|
217
|
+
limitations under the License.
|