@hla4ts/spacefom 0.1.0 → 0.1.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.
package/README.md CHANGED
@@ -1,73 +1,73 @@
1
- # @hla4ts/spacefom
2
-
3
- Thin SpaceFOM asset/helper layer beneath `@hla4ts/spacekit`.
4
-
5
- This package is no longer the main application entry point for SEE users.
6
- Start with `@hla4ts/spacekit` unless you specifically need one of the raw
7
- SpaceFOM building blocks below:
8
-
9
- - bundled base SpaceFOM XML modules
10
- - `loadSpaceFomModules()` for inline/path module loading
11
- - SpaceFOM constants such as execution modes and sync point labels
12
- - low-level encode/decode helpers and coders
13
- - optional dashboard launcher via `serveDashboard()`
14
-
15
- ## Install
16
-
17
- ```bash
18
- bun add @hla4ts/spacefom
19
- ```
20
-
21
- ## Load Base Modules
22
-
23
- ```ts
24
- import { loadSpaceFomModules } from "@hla4ts/spacefom";
25
-
26
- const baseModules = await loadSpaceFomModules({ format: "inline" });
27
- ```
28
-
29
- ## Encode/Decode SpaceFOM Values
30
-
31
- ```ts
32
- import {
33
- decodeHLAunicodeString,
34
- encodeHLAunicodeString,
35
- encodeSpaceTimeCoordinateState,
36
- } from "@hla4ts/spacefom";
37
- ```
38
-
39
- ## Execution and Sync Constants
40
-
41
- ```ts
42
- import {
43
- SpaceFomExecutionMode,
44
- SpaceFomMtrMode,
45
- SpaceFomSyncPointLabels,
46
- } from "@hla4ts/spacefom";
47
- ```
48
-
49
- ## Dashboard Loader
50
-
51
- `serveDashboard()` remains here because it is an optional SpaceFOM-oriented
52
- tooling hook:
53
-
54
- ```ts
55
- import { serveDashboard } from "@hla4ts/spacefom";
56
-
57
- const server = await serveDashboard();
58
- await server.close();
59
- ```
60
-
61
- This requires `@hla4ts/spacefomapp-dashboard` to be installed separately.
62
-
63
- ## When To Use `@hla4ts/spacekit` Instead
64
-
65
- Use `@hla4ts/spacekit` if you need any of the following:
66
-
67
- - `SpacekitApp`
68
- - `PhysicalEntity`, `DynamicalEntity`, `ReferenceFrame`, `ExecutionConfiguration`
69
- - `ModeTransitionRequest`
70
- - `SpaceFomLateJoinerBootstrap`
71
- - `createSpaceFomConfig()` or `declareSpaceFom()`
72
- - runtime adapter generation from decorated classes
73
- - SEE run loop and reference-frame-aware registration
1
+ # @hla4ts/spacefom
2
+
3
+ Thin SpaceFOM asset/helper layer beneath `@hla4ts/spacekit`.
4
+
5
+ This package is no longer the main application entry point for SEE users.
6
+ Start with `@hla4ts/spacekit` unless you specifically need one of the raw
7
+ SpaceFOM building blocks below:
8
+
9
+ - bundled base SpaceFOM XML modules
10
+ - `loadSpaceFomModules()` for inline/path module loading
11
+ - SpaceFOM constants such as execution modes and sync point labels
12
+ - low-level encode/decode helpers and coders
13
+ - optional dashboard launcher via `serveDashboard()`
14
+
15
+ ## Install
16
+
17
+ ```bash
18
+ bun add @hla4ts/spacefom
19
+ ```
20
+
21
+ ## Load Base Modules
22
+
23
+ ```ts
24
+ import { loadSpaceFomModules } from "@hla4ts/spacefom";
25
+
26
+ const baseModules = await loadSpaceFomModules({ format: "inline" });
27
+ ```
28
+
29
+ ## Encode/Decode SpaceFOM Values
30
+
31
+ ```ts
32
+ import {
33
+ decodeHLAunicodeString,
34
+ encodeHLAunicodeString,
35
+ encodeSpaceTimeCoordinateState,
36
+ } from "@hla4ts/spacefom";
37
+ ```
38
+
39
+ ## Execution and Sync Constants
40
+
41
+ ```ts
42
+ import {
43
+ SpaceFomExecutionMode,
44
+ SpaceFomMtrMode,
45
+ SpaceFomSyncPointLabels,
46
+ } from "@hla4ts/spacefom";
47
+ ```
48
+
49
+ ## Dashboard Loader
50
+
51
+ `serveDashboard()` remains here because it is an optional SpaceFOM-oriented
52
+ tooling hook:
53
+
54
+ ```ts
55
+ import { serveDashboard } from "@hla4ts/spacefom";
56
+
57
+ const server = await serveDashboard();
58
+ await server.close();
59
+ ```
60
+
61
+ This requires `@hla4ts/spacefomapp-dashboard` to be installed separately.
62
+
63
+ ## When To Use `@hla4ts/spacekit` Instead
64
+
65
+ Use `@hla4ts/spacekit` if you need any of the following:
66
+
67
+ - `SpacekitApp`
68
+ - `PhysicalEntity`, `DynamicalEntity`, `ReferenceFrame`, `ExecutionConfiguration`
69
+ - `ModeTransitionRequest`
70
+ - `SpaceFomLateJoinerBootstrap`
71
+ - `createSpaceFomConfig()` or `declareSpaceFom()`
72
+ - runtime adapter generation from decorated classes
73
+ - SEE run loop and reference-frame-aware registration
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hla4ts/spacefom",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Thin SpaceFOM helper layer with bundled XML modules, coders, and constants",
5
5
  "type": "module",
6
6
  "main": "src/index.ts",
@@ -17,7 +17,7 @@
17
17
  "access": "public"
18
18
  },
19
19
  "dependencies": {
20
- "@hla4ts/hla-api": "^0.1.0"
20
+ "@hla4ts/hla-api": "^0.1.1"
21
21
  },
22
22
  "scripts": {
23
23
  "typecheck": "tsc --noEmit",