@aephia/atlas-kit 0.0.0

package/dist/fleets/actions/index.d.ts

@@ -0,0 +1,200 @@
+import { type Address } from '@solana/kit';
+import type { SageContext } from '../../client/contracts.js';
+import { type PlanAuthorization } from '../../internal/planning/authorization-adapter.js';
+import { type Plan } from '../../planning/index.js';
+import type { FleetSnapshot } from '../index.js';
+export type { PlanAuthorization };
+/** Inputs for planning one docked-to-idle Fleet transition.
+ *
+ * @example
+ * ```ts
+ * declare const authorization: PlanAuthorization;
+ * const options: PlanFleetUndockOptions = { authorization };
+ * ```
+ */
+export interface PlanFleetUndockOptions {
+    readonly authorization: PlanAuthorization;
+}
+/** Inputs for planning one idle-to-docked Fleet transition.
+ *
+ * @example
+ * ```ts
+ * declare const authorization: PlanAuthorization;
+ * const options: PlanFleetDockOptions = { authorization };
+ * ```
+ */
+export interface PlanFleetDockOptions {
+    readonly authorization: PlanAuthorization;
+}
+/** Inputs for planning one explicit coordinate-destination Fleet movement.
+ *
+ * @example
+ * ```ts
+ * declare const authorization: PlanAuthorization;
+ * const options: PlanFleetCoordinateMovementOptions = {
+ *   authorization,
+ *   destination: { x: 12, y: -7 },
+ * };
+ * ```
+ */
+export interface PlanFleetCoordinateMovementOptions {
+    readonly authorization: PlanAuthorization;
+    readonly destination: FleetSnapshot['location'];
+}
+/** Inputs for planning one explicit connected-system Fleet warp.
+ *
+ * @example
+ * ```ts
+ * declare const authorization: PlanAuthorization;
+ * declare const destinationSystem: Address;
+ * const options: PlanFleetWarpLaneOptions = {
+ *   authorization,
+ *   destinationSystem,
+ * };
+ * ```
+ */
+export interface PlanFleetWarpLaneOptions {
+    readonly authorization: PlanAuthorization;
+    readonly destinationSystem: Address;
+}
+/** Address-only input for settling one Fleet movement arrival.
+ *
+ * The funder is the sole required signer. Reusing the later assembly fee payer
+ * is convenient, but the planner does not require the two addresses to match.
+ *
+ * @example
+ * ```ts
+ * declare const funder: Address;
+ * const options: PlanFleetSettleArrivalOptions = { funder };
+ * ```
+ */
+export interface PlanFleetSettleArrivalOptions {
+    readonly funder: Address;
+}
+/** Inputs for stopping one Fleet subwarp early.
+ *
+ * @example
+ * ```ts
+ * declare const authorization: PlanAuthorization;
+ * const options: PlanFleetStopSubwarpOptions = { authorization };
+ * ```
+ */
+export interface PlanFleetStopSubwarpOptions {
+    readonly authorization: PlanAuthorization;
+}
+/** Plans one explicit connected-system Fleet warp without local economics estimates.
+ *
+ * The planner resolves the source Star System from the idle Fleet coordinate,
+ * proves connectivity from that System's decoded connections, and resolves all
+ * generated instruction accounts internally.
+ *
+ * @example
+ * ```ts
+ * declare const ctx: SageContext;
+ * declare const fleet: FleetSnapshot;
+ * declare const destinationSystem: Address;
+ * declare const authorization: PlanAuthorization;
+ * const plan = await planFleetWarpLane(ctx, fleet, {
+ *   authorization,
+ *   destinationSystem,
+ * });
+ * ```
+ */
+export declare function planFleetWarpLane(ctx: SageContext, fleet: FleetSnapshot, options: PlanFleetWarpLaneOptions): Promise<Plan>;
+/** Plans one explicit Fleet subwarp to a coordinate without movement estimates.
+ *
+ * @example
+ * ```ts
+ * declare const ctx: SageContext;
+ * declare const fleet: FleetSnapshot;
+ * declare const authorization: PlanAuthorization;
+ * const plan = await planFleetSubwarp(ctx, fleet, {
+ *   authorization,
+ *   destination: { x: 12, y: -7 },
+ * });
+ * ```
+ */
+export declare function planFleetSubwarp(ctx: SageContext, fleet: FleetSnapshot, options: PlanFleetCoordinateMovementOptions): Promise<Plan>;
+/** Plans one explicit Fleet coordinate warp without movement estimates.
+ *
+ * @example
+ * ```ts
+ * declare const ctx: SageContext;
+ * declare const fleet: FleetSnapshot;
+ * declare const authorization: PlanAuthorization;
+ * const plan = await planFleetWarpToCoordinate(ctx, fleet, {
+ *   authorization,
+ *   destination: { x: 12, y: -7 },
+ * });
+ * ```
+ */
+export declare function planFleetWarpToCoordinate(ctx: SageContext, fleet: FleetSnapshot, options: PlanFleetCoordinateMovementOptions): Promise<Plan>;
+/** Plans settlement of one Fleet warp or subwarp arrival.
+ *
+ * Settlement is distinct from stopping subwarp early: the program completes an
+ * elapsed movement, while an in-transit call is a measured safe no-op. Subwarp
+ * settlement charges the fuel recorded when movement started; warp fuel was
+ * already charged up front. Settlement does not clear the independent warp
+ * cooldown, so an arrived Fleet can be idle but still unable to warp again.
+ *
+ * @example
+ * ```ts
+ * declare const ctx: SageContext;
+ * declare const fleet: FleetSnapshot;
+ * declare const funder: Address;
+ * const plan = await planFleetSettleArrival(ctx, fleet, { funder });
+ * console.log(plan.describe());
+ * ```
+ */
+export declare function planFleetSettleArrival(ctx: SageContext, fleet: FleetSnapshot, input: PlanFleetSettleArrivalOptions): Promise<Plan>;
+/** Plans an early Fleet subwarp stop without signing, simulation, or write RPC.
+ *
+ * This operation stops an in-progress subwarp before arrival. Use
+ * {@link planFleetSettleArrival} for a trip already known to have completed;
+ * callers should not deliberately stop a completed trip. An idle Fleet is
+ * still accepted so the program's benign no-op handles the normal race where
+ * subwarp completes between planning and execution.
+ *
+ * @example
+ * ```ts
+ * declare const ctx: SageContext;
+ * declare const fleet: FleetSnapshot;
+ * declare const authorization: PlanAuthorization;
+ * const plan = await planFleetStopSubwarp(ctx, fleet, { authorization });
+ * console.log(plan.describe());
+ * ```
+ */
+export declare function planFleetStopSubwarp(ctx: SageContext, fleet: FleetSnapshot, options: PlanFleetStopSubwarpOptions): Promise<Plan>;
+/** Plans one explicit Fleet undock without signing, simulation, or write RPC.
+ *
+ * The planner accepts a loaded Fleet snapshot, resolves its canonical Character,
+ * docked Star System, and Starbase Player internally, and returns one inspectable
+ * docked-to-idle Plan.
+ *
+ * @example
+ * ```ts
+ * declare const ctx: SageContext;
+ * declare const fleet: FleetSnapshot;
+ * declare const authorization: PlanAuthorization;
+ * const plan = await planFleetUndock(ctx, fleet, { authorization });
+ * console.log(plan.describe());
+ * ```
+ */
+export declare function planFleetUndock(ctx: SageContext, fleet: FleetSnapshot, options: PlanFleetUndockOptions): Promise<Plan>;
+/** Plans one explicit Fleet dock without signing, simulation, or write RPC.
+ *
+ * The planner accepts a loaded idle Fleet snapshot, resolves the only canonical
+ * Character, Star System at its current coordinate, and Starbase Player
+ * internally, and returns one inspectable idle-to-docked Plan.
+ *
+ * @example
+ * ```ts
+ * declare const ctx: SageContext;
+ * declare const fleet: FleetSnapshot;
+ * declare const authorization: PlanAuthorization;
+ * const plan = await planFleetDock(ctx, fleet, { authorization });
+ * console.log(plan.describe());
+ * ```
+ */
+export declare function planFleetDock(ctx: SageContext, fleet: FleetSnapshot, options: PlanFleetDockOptions): Promise<Plan>;
+//# sourceMappingURL=index.d.ts.map

package/dist/fleets/actions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/fleets/actions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,OAAO,EACb,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,EAAc,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAqCzE,OAAO,EASL,KAAK,iBAAiB,EACvB,MAAM,kDAAkD,CAAC;AAC1D,OAAO,EAEL,KAAK,IAAI,EAGV,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEjD,YAAY,EAAE,iBAAiB,EAAE,CAAC;AAqBlC;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,aAAa,EAAE,iBAAiB,CAAC;CAC3C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,aAAa,EAAE,iBAAiB,CAAC;CAC3C;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,aAAa,EAAE,iBAAiB,CAAC;IAC1C,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;CACjD;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,aAAa,EAAE,iBAAiB,CAAC;IAC1C,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;CACrC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,aAAa,EAAE,iBAAiB,CAAC;CAC3C;AAu8BD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,IAAI,CAAC,CA2Df;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,IAAI,CAAC,CAEf;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,sBAAsB,CAC1C,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,aAAa,EACpB,KAAK,EAAE,6BAA6B,GACnC,OAAO,CAAC,IAAI,CAAC,CA0Bf;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,oBAAoB,CACxC,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,IAAI,CAAC,CAuCf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,eAAe,CACnC,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,IAAI,CAAC,CA0Gf;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAuJf"}