@rybosome/tspice 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export type { BackendKind, KernelSource, SpiceBackend, SpiceBackendWasm, } from "#backend-contract";
+export type { CreateBackendOptions } from "./backend.js";
+export { createBackend } from "./backend.js";
+export type { AberrationCorrection, FrameName, GetStateArgs, Mat3, SpiceTime, StateVector, Vec3, Vec6, } from "./types.js";
+export { SpiceError } from "./errors.js";
+export type { Spice, SpiceKit } from "./spice-types.js";
+export type { CreateSpiceOptions } from "./spice.js";
+export { createSpice } from "./spice.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,4 @@
+export { createBackend } from "./backend.js";
+export { SpiceError } from "./errors.js";
+export { createSpice } from "./spice.js";
+//# sourceMappingURL=index.js.map

package/dist/spice-types.d.ts

@@ -0,0 +1,36 @@
+import type { KernelSource, SpiceBackend } from "#backend-contract";
+import type { FrameName, GetStateArgs, Mat3, SpiceTime, StateVector } from "./types.js";
+/**
+* Low-level CSPICE-like primitive surface.
+*
+* This is the raw backend contract (node addon, wasm backend, etc.).
+*/
+/**
+* Higher-level helpers and convenience APIs built on top of the raw backend.
+*/
+export type SpiceKit = {
+    /** Load a SPICE kernel. */
+    loadKernel(kernel: KernelSource): void;
+    /** Unload a previously-loaded SPICE kernel. */
+    unloadKernel(path: string): void;
+    /** Convenience wrapper around `tkvrsn(\"TOOLKIT\")`. */
+    toolkitVersion(): string;
+    /** Convert UTC time string to ET seconds past J2000. */
+    utcToEt(utc: string): SpiceTime;
+    /** Convert ET seconds past J2000 to a formatted UTC string. */
+    etToUtc(et: SpiceTime, format?: string, prec?: number): string;
+    /** Compute a 3x3 frame transformation matrix (row-major). */
+    frameTransform(from: FrameName, to: FrameName, et: SpiceTime): Mat3;
+    /** Convenience wrapper around `spkezr` that returns a structured state vector. */
+    getState(args: GetStateArgs): StateVector;
+};
+/**
+* Top-level `createSpice()` return type.
+*/
+export type Spice = {
+    /** Raw backend primitives (verbatim). */
+    cspice: SpiceBackend;
+    /** Higher-level helpers and typed conveniences. */
+    kit: SpiceKit;
+};
+//# sourceMappingURL=spice-types.d.ts.map

package/dist/spice-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=spice-types.js.map

package/dist/spice.d.ts

@@ -0,0 +1,13 @@
+import type { SpiceBackend } from "#backend-contract";
+import type { CreateBackendOptions } from "./backend.js";
+import type { Spice } from "./spice-types.js";
+export type CreateSpiceOptions = CreateBackendOptions & {
+    /**
+     * If provided, `createSpice()` will wrap this backend instead of creating a new one.
+     *
+     * Useful for testing or advanced callers.
+     */
+    backendInstance?: SpiceBackend;
+};
+export declare function createSpice(options: CreateSpiceOptions): Promise<Spice>;
+//# sourceMappingURL=spice.d.ts.map

package/dist/spice.js

@@ -0,0 +1,84 @@
+import { createBackend } from "./backend.js";
+import { wrapSpiceError } from "./errors.js";
+const DEFAULT_FRAME = "J2000";
+const DEFAULT_ABERRATION = "NONE";
+function splitState(state) {
+    const position = [state[0], state[1], state[2]];
+    const velocity = [state[3], state[4], state[5]];
+    return { position, velocity };
+}
+export async function createSpice(options) {
+    const backend = options.backendInstance ?? (await createBackend(options));
+    const cspice = backend;
+    const kit = {
+        loadKernel: (kernel) => {
+            try {
+                cspice.furnsh(kernel);
+            }
+            catch (error) {
+                throw wrapSpiceError("loadKernel", error);
+            }
+        },
+        unloadKernel: (path) => {
+            try {
+                cspice.unload(path);
+            }
+            catch (error) {
+                throw wrapSpiceError("unloadKernel", error);
+            }
+        },
+        toolkitVersion: () => {
+            try {
+                return cspice.tkvrsn("TOOLKIT");
+            }
+            catch (error) {
+                throw wrapSpiceError("toolkitVersion", error);
+            }
+        },
+        utcToEt: (utc) => {
+            try {
+                return cspice.str2et(utc);
+            }
+            catch (error) {
+                throw wrapSpiceError("utcToEt", error);
+            }
+        },
+        etToUtc: (et, format = "C", prec = 3) => {
+            try {
+                return cspice.et2utc(et, format, prec);
+            }
+            catch (error) {
+                throw wrapSpiceError("etToUtc", error);
+            }
+        },
+        frameTransform: (from, to, et) => {
+            try {
+                return cspice.pxform(from, to, et);
+            }
+            catch (error) {
+                throw wrapSpiceError("frameTransform", error);
+            }
+        },
+        getState: ({ target, observer, at, frame = DEFAULT_FRAME, aberration = DEFAULT_ABERRATION }) => {
+            try {
+                const { state, lt } = cspice.spkezr(target, at, frame, aberration, observer);
+                const { position, velocity } = splitState(state);
+                return {
+                    et: at,
+                    frame,
+                    target,
+                    observer,
+                    aberration,
+                    position,
+                    velocity,
+                    lightTime: lt,
+                };
+            }
+            catch (error) {
+                throw wrapSpiceError("getState", error);
+            }
+        },
+    };
+    return { cspice, kit };
+}
+//# sourceMappingURL=spice.js.map

package/dist/types.d.ts

@@ -0,0 +1,54 @@
+/** 3-vector, typically kilometers or km/s depending on context. */
+export type Vec3 = readonly [number, number, number];
+/** 6-vector, typically (x,y,z,vx,vy,vz). */
+export type Vec6 = readonly [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+/** 3x3 matrix, row-major. */
+export type Mat3 = readonly [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+/** SPICE frame name (e.g. "J2000", "IAU_EARTH"). */
+export type FrameName = string;
+/** Aberration correction string accepted by `spkezr`. */
+export type AberrationCorrection = "NONE" | "LT" | "LT+S" | "CN" | "CN+S" | "XLT" | "XLT+S" | "XCN" | "XCN+S";
+export type SpiceTime = number & {
+    readonly __tspiceBrand: "SpiceTime";
+};
+export type StateVector = {
+    /** Seconds past J2000 (ET). */
+    et: SpiceTime;
+    /** Reference frame used for `position`/`velocity`. */
+    frame: FrameName;
+    /** Target body/ID string used for the query. */
+    target: string;
+    /** Observer body/ID string used for the query. */
+    observer: string;
+    /** Aberration correction used for the query. */
+    aberration: AberrationCorrection;
+    position: Vec3;
+    velocity: Vec3;
+    /** One-way light time (seconds). */
+    lightTime: number;
+};
+export type GetStateArgs = {
+    target: string;
+    observer: string;
+    at: SpiceTime;
+    frame?: FrameName;
+    aberration?: AberrationCorrection;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@rybosome/tspice",
+  "version": "0.0.1",
+  "license": "MIT",
+  "type": "module",
+  "imports": {
+    "#core": "./core/dist/index.js",
+    "#backend-contract": "./backend-contract/dist/index.js",
+    "#backend-fake": "./backend-fake/dist/index.js",
+    "#backend-wasm": "./backend-wasm/dist/index.js",
+    "#backend-node": "./backend-node/dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "optionalDependencies": {
+    "@rybosome/tspice-native-darwin-arm64": "0.0.1",
+    "@rybosome/tspice-native-darwin-x64": "0.0.1",
+    "@rybosome/tspice-native-linux-x64-gnu": "0.0.1"
+  },
+  "files": [
+    "dist",
+    "backend-contract",
+    "core",
+    "backend-fake",
+    "backend-wasm",
+    "backend-node",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}