acmi-parser 1.0.0 → 1.2.0

package/dist/types/math3d/geospatial/index.d.ts

@@ -0,0 +1,2 @@
+export { Ellipsoid } from './ellipsoid/ellipsoid';
+export { isWGS84 } from './type-utils';

package/dist/types/math3d/geospatial/type-utils.d.ts

@@ -0,0 +1,23 @@
+import { NumericArray } from '../core';
+type LngLatHeightObject = {
+    longitude: number;
+    latitude: number;
+    height: number;
+};
+type XYZObject = {
+    x: number;
+    y: number;
+    z: number;
+};
+type Cartographic = LngLatHeightObject | XYZObject | NumericArray;
+export declare function fromCartographic(cartographic: Readonly<Cartographic>): number[];
+export declare function fromCartographic<NumArrayT>(cartographic: Readonly<Cartographic>, result: NumArrayT, map?: (x: number) => number): NumArrayT;
+export declare function fromCartographicToRadians(cartographic: Readonly<Cartographic>, result?: number[]): number[];
+export declare function fromCartographicToRadians<TArray>(cartographic: Readonly<Cartographic>, result: TArray): TArray;
+export declare function fromCartographicToDegrees(cartographic: Readonly<Cartographic>, result?: number[]): number[];
+export declare function fromCartographicToDegrees<TArray>(cartographic: Readonly<Cartographic>, result: TArray): TArray;
+export declare function toCartographic<T extends Cartographic>(vector: Readonly<NumericArray>, cartographic: T, map?: (x: number) => number): T;
+export declare function toCartographicFromRadians<T extends Cartographic>(vector: Readonly<NumericArray>, cartographic: T): T;
+export declare function toCartographicFromDegrees<T extends Cartographic>(vector: Readonly<NumericArray>, cartographic: T): T;
+export declare function isWGS84(vector: Readonly<NumericArray>): boolean;
+export {};

package/dist/types/math3d/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types';
+export * from './core';
+export * from './geospatial';
+export * from './geoid';

package/dist/types/math3d/types/array-types.d.ts

@@ -0,0 +1,14 @@
+/**
+ * TypeScript type covering all typed arrays
+ */
+export type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array;
+export type TypedArrayConstructor = Int8ArrayConstructor | Uint8ArrayConstructor | Uint8ClampedArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Int32ArrayConstructor | Uint32ArrayConstructor | Float32ArrayConstructor | Float64ArrayConstructor;
+/**
+ * TypeScript type covering all typed arrays and classic arrays consisting of numbers
+ */
+export type NumericArray = TypedArray | number[];
+/**
+ * TypeScript type covering all typed arrays and classic arrays consisting of numbers
+ * @note alias for NumericArray
+ */
+export type NumberArray = NumericArray;

package/dist/types/math3d/types/bigint.d.ts

@@ -0,0 +1,20 @@
+declare function BigIntUnavailable(): void;
+declare namespace BigIntUnavailable {
+    var asIntN: () => never;
+    var asUintN: () => never;
+}
+declare class BigInt64ArrayUnavailable {
+    static get BYTES_PER_ELEMENT(): number;
+    static of(): void;
+    static from(): void;
+    constructor();
+}
+export declare const BigIntAvailable: boolean;
+export declare const BigInt64ArrayAvailable: boolean;
+export declare const BigUint64ArrayAvailable: boolean;
+declare const BigIntCtor: typeof BigIntUnavailable | BigIntConstructor;
+declare const BigInt64ArrayCtor: typeof BigInt64ArrayUnavailable | BigInt64ArrayConstructor;
+declare const BigUint64ArrayCtor: BigUint64ArrayConstructor[] | (typeof BigInt64ArrayUnavailable)[];
+export { BigIntCtor as BigInt };
+export { BigInt64ArrayCtor as BigInt64Array };
+export { BigUint64ArrayCtor as BigUint64Array };

package/dist/types/math3d/types/index.d.ts

@@ -0,0 +1,2 @@
+export type { TypedArray, TypedArrayConstructor, NumericArray, NumberArray } from './array-types';
+export { isTypedArray, isNumericArray } from './is-array';

package/dist/types/math3d/types/is-array.d.ts

@@ -0,0 +1,13 @@
+import { TypedArray, NumericArray } from './array-types';
+/**
+ * Check is an array is a typed array
+ * @param value value to be tested
+ * @returns input as TypedArray, or null
+ */
+export declare function isTypedArray(value: unknown): TypedArray | null;
+/**
+ * Check is an array is a numeric array (typed array or array of numbers)
+ * @param value value to be tested
+ * @returns input as NumericArray, or null
+ */
+export declare function isNumericArray(value: unknown): NumericArray | null;

package/dist/types/parser.d.ts

@@ -0,0 +1,90 @@
+import { default as AcmiData } from './acmi/acmiData';
+/** Options that control entity filtering and cancellation during parsing. */
+export interface AcmiParserOptions {
+    /**
+     * ACMI entity type components to omit from the result.
+     *
+     * @remarks Use `"Untyped"` to omit entities without a `Type` property.
+     */
+    excludedTypes?: readonly string[];
+    /** Signal used to cancel input normalization or ZIP decompression. */
+    signal?: AbortSignal;
+    /** @deprecated Use `excludedTypes` instead. */
+    filter?: string[];
+    /** @deprecated Pass the controller's `signal` instead. */
+    controller?: AbortController;
+}
+/** Binary input accepted by the parser, including typed arrays and Node.js buffers. */
+export type AcmiBinaryInput = ArrayBuffer | ArrayBufferView;
+/** Plain ACMI text, binary ACMI data, or a browser `Blob`/`File`. */
+export type AcmiInput = string | AcmiBinaryInput | Blob;
+/** Stable codes exposed by {@link AcmiParseError}. */
+export type AcmiParseErrorCode = "INVALID_ARCHIVE" | "UNSUPPORTED_INPUT";
+/** Error thrown when input cannot be normalized or a ZIP archive cannot be read. */
+export declare class AcmiParseError extends Error {
+    /** Machine-readable category for the failure. */
+    readonly code: AcmiParseErrorCode;
+    /** Underlying error, when the failure originated in ZIP decompression. */
+    readonly cause?: unknown;
+    /**
+     * Creates a parser error.
+     *
+     * @param message - Human-readable description of the failure.
+     * @param code - Stable machine-readable failure category.
+     * @param cause - Optional lower-level error that caused the failure.
+     */
+    constructor(message: string, code: AcmiParseErrorCode, cause?: unknown);
+}
+/** Stateful parser for Tacview ACMI 2.1 and 2.2 recordings. */
+export default class AcmiParser {
+    private _decoder;
+    private _currentLine;
+    private _currentTimeStamp;
+    private _currentFrame;
+    private _destroyedIds;
+    private _filteredIds;
+    private _data;
+    private _excludedTypes;
+    private readonly _acmiVersions;
+    private readonly _acmiType;
+    private readonly _propertySeparator;
+    private readonly _headerPattern;
+    /**
+     * Creates a reusable parser.
+     *
+     * @param geoidPgm - Optional binary PGM geoid model used to correct altitude.
+     * @remarks Parser instances are reusable sequentially. Do not call `parse()`
+     * concurrently on the same instance.
+     */
+    constructor(geoidPgm?: AcmiBinaryInput);
+    private _toUint8Array;
+    private _normalizeInput;
+    private _throwIfAborted;
+    private _isValidVersion;
+    private _isValidType;
+    private _parseHeader;
+    private _consumeContentLine;
+    private _parseContent;
+    private _parseLine;
+    private _unzip;
+    private _parseBuffer;
+    /**
+     * Parses plain or single-file ZIP-compressed ACMI input.
+     *
+     * @param data - ACMI text, binary data, or a browser `Blob`/`File`.
+     * @param options - Entity filtering and cancellation options.
+     * @returns The parsed recording model.
+     * @throws {@link AcmiParseError} if input normalization or ZIP reading fails.
+     * @throws The abort signal's reason when the operation is cancelled.
+     */
+    parse(data: AcmiInput, options?: AcmiParserOptions): Promise<AcmiData>;
+}
+/**
+ * Parses an ACMI recording with a fresh parser instance.
+ *
+ * @param data - ACMI text, binary data, or a browser `Blob`/`File`.
+ * @param options - Entity filtering and cancellation options.
+ * @returns The parsed recording model.
+ * @throws {@link AcmiParseError} if input normalization or ZIP reading fails.
+ */
+export declare function parseAcmi(data: AcmiInput, options?: AcmiParserOptions): Promise<AcmiData>;

package/dist/types/trajectory/stateVector.d.ts

@@ -0,0 +1,30 @@
+import { Vector3, Quaternion } from '../math3d/index.ts';
+import { default as Transform } from '../acmi//transform';
+/** WGS84 fixed-frame position and optional orientation. */
+export default class StateVector {
+    /** Earth-centred, Earth-fixed Cartesian position in metres. */
+    cartesian: Vector3;
+    /** Fixed-frame orientation quaternion, when available. */
+    quaternion?: Quaternion;
+    /**
+     * Compares position and orientation components with another state vector.
+     *
+     * @param stateVector - State vector to compare.
+     * @returns Whether both state vectors contain equal components.
+     */
+    equals(stateVector: StateVector): boolean | undefined;
+    private static _scratchQuaternionX;
+    private static _scratchQuaternionY;
+    private static _scratchQuaternionZ;
+    private static _scratchHprMatrix;
+    private static _scratchTranslationMatrix;
+    private static _scratchRotation;
+    /**
+     * Converts a geodetic transform into the WGS84 fixed frame.
+     *
+     * @param transform - Geodetic position and optional local orientation.
+     * @param result - Optional object to populate instead of allocating one.
+     * @returns The populated state vector.
+     */
+    static fromTransform(transform: Transform, result?: StateVector): StateVector;
+}

package/dist/types/trajectory/trajectory.d.ts

@@ -0,0 +1,40 @@
+import { default as ITrajectorySample } from './trajectorySample';
+/** Options used when sampling trajectories from frame snapshots. */
+export interface TrajectoryOptions {
+    /**
+     * Sampling interval in seconds.
+     *
+     * @defaultValue `1`
+     */
+    sampleRate?: number;
+    /**
+     * Whether to derive orientations from movement and turning motion.
+     *
+     * @defaultValue `false`
+     */
+    emulateOrientation?: boolean;
+}
+/** @deprecated Use `TrajectoryOptions` instead. */
+export type ITrajectoryOptions = TrajectoryOptions;
+/** Chronologically ordered state-vector samples for one entity. */
+export default class Trajectory {
+    /** Mutable ordered collection of trajectory samples. */
+    samples: ITrajectorySample[];
+    /** @returns Whether the first sample contains an orientation quaternion. */
+    hasOrientations(): boolean;
+    private _lastRoll;
+    private _simpleSmooth;
+    private _computeRoll;
+    private _computeOrientation;
+    /**
+     * Derives and assigns orientations for all samples from their motion.
+     *
+     * @param withRoll - Whether to estimate bank angle from turning motion.
+     * @remarks This method mutates sample state vectors and replaces any source
+     * orientations. For the final two samples, it reuses the last computable
+     * orientation because no forward interval is available.
+     */
+    emulateOrientations(withRoll?: boolean): void;
+}
+/** Entity trajectories keyed by numeric ACMI entity ID. */
+export type Trajectories = Map<number, Trajectory>;

package/dist/types/trajectory/trajectorySample.d.ts

@@ -0,0 +1,11 @@
+import { Dayjs } from 'dayjs';
+import { default as StateVector } from './stateVector';
+/** One absolute-time sample in an entity trajectory. */
+export default interface TrajectorySample {
+    /** Absolute sample time. */
+    time: Dayjs;
+    /** Fixed-frame position and optional orientation. */
+    stateVector: StateVector;
+}
+/** @deprecated Use `TrajectorySample` instead. */
+export type ITrajectorySample = TrajectorySample;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "acmi-parser",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "ACMI file format parser",
   "author": "jfayot",
   "repository": {
@@ -17,6 +17,8 @@
   "bugs": "https://github.com/jfayot/acmi-parser/issues",
   "license": "MIT",
   "publishConfig": {
+    "access": "public",
+    "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
   "files": [
@@ -25,18 +27,12 @@
   "type": "module",
   "main": "./dist/acmi-parser.cjs",
   "module": "./dist/acmi-parser.js",
-  "types": "./dist/types/acmi-parser.d.ts",
+  "types": "./dist/types/index.d.ts",
   "exports": {
-    "types": "./dist/types/acmi-parser.d.ts",
+    "types": "./dist/types/index.d.ts",
     "import": "./dist/acmi-parser.js",
     "require": "./dist/acmi-parser.cjs"
   },
-  "scripts": {
-    "build": "vite build",
-    "clean": "rimraf dist",
-    "clean:all": "pnpm clean && rimraf node_modules",
-    "release": "pnpm build && npm publish"
-  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -52,15 +48,21 @@
     ]
   },
   "dependencies": {
-    "@math.gl/geoid": "^4.0.0",
-    "binary-search-bounds": "^2.0.5",
-    "@cesium/engine": "^6.1.1",
-    "dayjs": "^1.11.10",
-    "unzipit": "^1.4.3"
+    "@zip.js/zip.js": "^2.8.61",
+    "dayjs": "^1.11.23"
   },
   "devDependencies": {
-    "typescript": "^5.3.3",
-    "vite": "^5.0.11",
-    "vite-plugin-dts": "^3.7.0"
+    "@typescript/typescript6": "^6.0.2",
+    "typescript": "^7.0.2",
+    "vite": "^8.2.2",
+    "vite-plugin-dts": "^5.0.3",
+    "vitest": "^4.1.11"
+  },
+  "scripts": {
+    "build": "vite build",
+    "test": "vitest run",
+    "clean": "rimraf dist",
+    "clean:all": "pnpm clean && rimraf node_modules",
+    "release": "pnpm build && npm publish"
   }
-}
+}

package/dist/types/acmi-parser.d.ts

@@ -1,179 +0,0 @@
-import { Cartesian3 } from '@cesium/engine';
-import { Dayjs } from 'dayjs';
-import dayjs from 'dayjs';
-import { Quaternion } from '@cesium/engine';
-
-export declare class AcmiData {
-    isValid: boolean;
-    header: AcmiHeader;
-    globalProperties: GlobalProperties;
-    timeSpan: TimeSpan;
-    entities: Map<number, IEntityProps>;
-    frames: Frames;
-    private readonly _fixedFrame;
-    getFrame(time: Dayjs): Frame | undefined;
-    private _addFrame;
-    createSampledTrajectories(options?: ITrajectoryOptions): Trajectories;
-}
-
-export declare class AcmiHeader {
-    fileType: string;
-    fileVersion: string;
-}
-
-declare class AcmiParser {
-    private _decoder;
-    private _currentLine;
-    private _currentTimeStamp;
-    private _currentFrame;
-    private _destroyedIds;
-    private _filteredIds;
-    private _data;
-    private _filter;
-    private _refLat;
-    private _refLong;
-    private readonly _acmiVersions;
-    private readonly _acmiType;
-    private readonly _propertySeparator;
-    private readonly _headerPattern;
-    constructor(geoidModel: Uint8Array);
-    private _isValidVersion;
-    private _isValidType;
-    private _parseHeader;
-    private _parseContent;
-    private _parseLine;
-    private _isZipped;
-    private _unzip;
-    private _parseBuffer;
-    parse(data: Uint8Array, options?: AcmiParserOptions): Promise<AcmiData>;
-}
-export default AcmiParser;
-
-export declare interface AcmiParserOptions {
-    filter?: string[];
-    controller?: AbortController;
-}
-
-export declare class EntityProps implements IEntityProps {
-    id: number;
-    timeSpan: TimeSpan;
-    name?: string;
-    types?: string[];
-    callsign?: string;
-    pilot?: string;
-    group?: string;
-    country?: string;
-    coalition?: string;
-    color?: string;
-    constructor(id: number);
-}
-
-export declare class Frame {
-    timeStamp: number;
-    scene: Scene;
-    constructor(timeStamp: number, scene?: Scene);
-}
-
-export declare type Frames = Array<Frame>;
-
-export declare class GlobalProperties {
-    referenceTime: dayjs.Dayjs;
-    dataSource?: string;
-    dataRecorder?: string;
-    recordingTime?: Dayjs;
-    author?: string;
-    title?: string;
-    category?: string;
-    briefing?: string;
-    debriefing?: string;
-    comments?: string;
-    referenceLongitude?: number;
-    referenceLatitude?: number;
-    additionalProps?: Map<string, string>;
-}
-
-export declare interface IEntityProps {
-    id: number;
-    timeSpan: {
-        start: Dayjs;
-        end: Dayjs;
-    };
-    name?: string;
-    types?: string[];
-    callsign?: string;
-    pilot?: string;
-    group?: string;
-    country?: string;
-    coalition?: string;
-    color?: string;
-}
-
-export declare interface IStateVector {
-    position: Cartesian3;
-    orientation?: Quaternion;
-}
-
-export declare interface ITrajectoryOptions {
-    sampleRate?: number;
-    fixMslHeight?: boolean;
-    emulateOrientation?: boolean;
-}
-
-export declare interface ITrajectorySample {
-    time: Dayjs;
-    state: IStateVector;
-}
-
-export declare interface ITransform {
-    longitude: number;
-    latitude: number;
-    altitude: number;
-    roll?: number;
-    pitch?: number;
-    yaw?: number;
-}
-
-export declare type Scene = Map<number, ITransform>;
-
-export declare class TimeSpan {
-    start: dayjs.Dayjs;
-    end: dayjs.Dayjs;
-    isValid(): boolean;
-    duration(): number;
-}
-
-export declare type Trajectories = Map<number, Trajectory>;
-
-export declare class Trajectory {
-    samples: ITrajectorySample[];
-    private _mslHeightFixed;
-    private static _geoid?;
-    private readonly _fixedFrame;
-    static loadGeoidModel(model: Uint8Array): void;
-    hasOrientations(): boolean;
-    private _lastRoll;
-    private _simpleSmooth;
-    private _m0;
-    private _m1;
-    private _hpr0;
-    private _hpr1;
-    private _alpha;
-    private _computeRoll;
-    private _p0;
-    private _p1;
-    private _p2;
-    private _v0;
-    private _v1;
-    private _r0;
-    private _r1;
-    private _q0;
-    private _q1;
-    private _rollQuat;
-    private _defaultHpr;
-    private _computeOrientation;
-    emulateOrientations(dt: number, withRoll?: boolean): void;
-    private _cartographicScratch;
-    fixMslHeight(): void;
-}
-
-export { }