@zlink-systems/framework 0.10.0

package/dist/runtime/messaging/submission-result.d.ts

@@ -0,0 +1,15 @@
+import { ZLinkFrameworkInternalErrorKind } from '../framework-errors-internal';
+export declare enum ZLinkSubmitStatus {
+    Submitted = "submitted",
+    Backpressured = "backpressured",
+    TimedOut = "timedOut",
+    TargetNotFound = "targetNotFound",
+    RouteNotConnected = "routeNotConnected",
+    Shutdown = "shutdown"
+}
+export interface ZLinkSubmitResult {
+    readonly status: ZLinkSubmitStatus;
+}
+export declare function requireOneWayCompletion(result: ZLinkSubmitResult, operation: string, notFoundKind?: ZLinkFrameworkInternalErrorKind): void;
+export declare function requirePublishCompletion(result: ZLinkSubmitResult, operation: string): void;
+export declare function throwAlreadySubmitted(operation: string): never;

package/dist/runtime/messaging/submission-result.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZLinkSubmitStatus = void 0;
+exports.requireOneWayCompletion = requireOneWayCompletion;
+exports.requirePublishCompletion = requirePublishCompletion;
+exports.throwAlreadySubmitted = throwAlreadySubmitted;
+const framework_errors_internal_1 = require("../framework-errors-internal");
+var ZLinkSubmitStatus;
+(function (ZLinkSubmitStatus) {
+    ZLinkSubmitStatus["Submitted"] = "submitted";
+    ZLinkSubmitStatus["Backpressured"] = "backpressured";
+    ZLinkSubmitStatus["TimedOut"] = "timedOut";
+    ZLinkSubmitStatus["TargetNotFound"] = "targetNotFound";
+    ZLinkSubmitStatus["RouteNotConnected"] = "routeNotConnected";
+    ZLinkSubmitStatus["Shutdown"] = "shutdown";
+})(ZLinkSubmitStatus || (exports.ZLinkSubmitStatus = ZLinkSubmitStatus = {}));
+function requireOneWayCompletion(result, operation, notFoundKind = framework_errors_internal_1.ZLinkFrameworkInternalErrorKind.RequestTargetNotFound) {
+    switch (result.status) {
+        case ZLinkSubmitStatus.Submitted:
+            return;
+        case ZLinkSubmitStatus.TimedOut:
+        case ZLinkSubmitStatus.Backpressured:
+            throw (0, framework_errors_internal_1.createInternalFrameworkException)(framework_errors_internal_1.ZLinkFrameworkInternalErrorKind.DeadlineExceeded, `${operation} did not obtain admission before its deadline.`, true);
+        case ZLinkSubmitStatus.TargetNotFound:
+            throw (0, framework_errors_internal_1.createInternalFrameworkException)(notFoundKind, `${operation} target was not found.`);
+        case ZLinkSubmitStatus.RouteNotConnected:
+            throw (0, framework_errors_internal_1.createInternalFrameworkException)(framework_errors_internal_1.ZLinkFrameworkInternalErrorKind.RouteNotConnected, `${operation} route is not connected.`, true);
+        case ZLinkSubmitStatus.Shutdown:
+            throw (0, framework_errors_internal_1.createInternalFrameworkException)(framework_errors_internal_1.ZLinkFrameworkInternalErrorKind.RuntimeShutdown, `${operation} was rejected because the runtime is shutting down.`);
+    }
+}
+function requirePublishCompletion(result, operation) {
+    requireOneWayCompletion(result, operation);
+}
+function throwAlreadySubmitted(operation) {
+    throw (0, framework_errors_internal_1.createInternalFrameworkException)(framework_errors_internal_1.ZLinkFrameworkInternalErrorKind.AlreadySubmitted, `${operation} has already been submitted.`);
+}

package/dist/runtime/protocol/service_wire_pilot_codec.generated.d.ts

@@ -0,0 +1,395 @@
+export interface ServiceWireRouteFence {
+    readonly id: string;
+    readonly generation: bigint;
+    readonly targetNodeRid: Uint8Array;
+    readonly targetNodeGeneration: bigint;
+    readonly expectedAuthorityOwnerGeneration: bigint;
+    readonly expectedOwnerLeaseGeneration: bigint;
+}
+export interface ApplicationPayloadEnvelopeV1 {
+    readonly packetName: string;
+    readonly contentType: string;
+    readonly payload: Uint8Array;
+}
+export interface ActorJoin28 {
+    readonly correlation: bigint;
+    readonly actor: ServiceWireRouteFence;
+    readonly entry: boolean;
+    readonly targetSpot: ServiceWireRouteFence;
+    readonly payload?: ApplicationPayloadEnvelopeV1;
+}
+export declare function encodeActorJoin28(value: ActorJoin28): readonly Uint8Array[];
+export declare function decodeActorJoin28(frames: readonly Uint8Array[]): ActorJoin28;
+export type RelocationObjectIdentity = {
+    readonly objectKind: "actor";
+    readonly actorId: string;
+    readonly objectGeneration: bigint;
+    readonly expectedAuthorityOwnerGeneration: bigint;
+} | {
+    readonly objectKind: "userSpot";
+    readonly spotId: string;
+    readonly objectGeneration: bigint;
+    readonly expectedAuthorityOwnerGeneration: bigint;
+} | {
+    readonly objectKind: "instanceSpot";
+    readonly instanceType: string;
+    readonly spotId: string;
+    readonly objectGeneration: bigint;
+};
+export interface RelocationEnvelopeV1 {
+    readonly relocationHigh: bigint;
+    readonly relocationLow: bigint;
+    readonly object: RelocationObjectIdentity;
+    readonly applicationVersion: bigint;
+    readonly applicationStates: readonly {
+        readonly participantId: bigint;
+        readonly hasState: boolean;
+        readonly payload: Uint8Array;
+    }[];
+    readonly savedWork: readonly {
+        readonly participantId: bigint;
+        readonly order: bigint;
+        readonly frozenRecord: Uint8Array;
+    }[];
+    readonly timerRegistrations: readonly {
+        readonly participantId: bigint;
+        readonly name: string;
+        readonly handlerType: string;
+        readonly periodMilliseconds: bigint;
+        readonly overrunPolicy: 1 | 2 | 3;
+        readonly maxCatchUpTicks: bigint;
+        readonly stopOnUnhandledException: boolean;
+        readonly lastCompletedDeliveryIndex: bigint;
+        readonly lastCompletedScheduledIndex: bigint;
+        readonly nextScheduledAtUnixMilliseconds: bigint;
+    }[];
+    readonly pendingTimerTicks: readonly {
+        readonly participantId: bigint;
+        readonly order: bigint;
+        readonly timerName: string;
+        readonly deliveryIndex: bigint;
+        readonly scheduledIndex: bigint;
+        readonly scheduledAtUnixMilliseconds: bigint;
+        readonly skippedTicks: bigint;
+    }[];
+}
+export interface RelocationDataChunkV1 {
+    readonly order: number;
+    readonly data: Uint8Array;
+}
+export interface RelocationChunkEntryV1 {
+    readonly order: number;
+    readonly reference: string;
+    readonly length: bigint;
+    readonly checksumCrc32c: number;
+}
+export interface RelocationManifestV1 {
+    readonly logicalFormatVersion: 1;
+    readonly totalLength: bigint;
+    readonly totalChecksumCrc32c: number;
+    readonly inventoryDigestSha256: Uint8Array;
+    readonly chunks: readonly RelocationChunkEntryV1[];
+}
+export declare function encodeRelocationEnvelopeV1(value: RelocationEnvelopeV1): Uint8Array;
+export declare function decodeRelocationEnvelopeV1(chunks: readonly Uint8Array[]): RelocationEnvelopeV1;
+export declare function encodeRelocationDataChunkV1(value: RelocationDataChunkV1): Uint8Array;
+export declare function decodeRelocationDataChunkV1(bytes: Uint8Array): RelocationDataChunkV1;
+export declare function encodeRelocationManifestV1(value: RelocationManifestV1): Uint8Array;
+export declare function decodeRelocationManifestV1(bytes: Uint8Array): RelocationManifestV1;
+export interface LivenessProbe5 {
+    readonly probeId: bigint;
+}
+export declare function encodeLivenessProbe5(value: LivenessProbe5): Uint8Array;
+export declare function decodeLivenessProbe5(bytes: Uint8Array): LivenessProbe5;
+export interface LivenessAck6 {
+    readonly probeId: bigint;
+}
+export declare function encodeLivenessAck6(value: LivenessAck6): Uint8Array;
+export declare function decodeLivenessAck6(bytes: Uint8Array): LivenessAck6;
+export declare function encodeNodeSend16(): Uint8Array;
+export declare function decodeNodeSend16(bytes: Uint8Array): void;
+export interface NodeRequest17 {
+    readonly correlation: bigint;
+}
+export declare function encodeNodeRequest17(value: NodeRequest17): Uint8Array;
+export declare function decodeNodeRequest17(bytes: Uint8Array): NodeRequest17;
+export interface ChannelSend18 {
+    readonly channelName: string;
+}
+export declare function encodeChannelSend18(value: ChannelSend18): Uint8Array;
+export declare function decodeChannelSend18(bytes: Uint8Array): ChannelSend18;
+export interface ChannelRequest19 {
+    readonly correlation: bigint;
+    readonly channelName: string;
+}
+export declare function encodeChannelRequest19(value: ChannelRequest19): Uint8Array;
+export declare function decodeChannelRequest19(bytes: Uint8Array): ChannelRequest19;
+export interface LogicalMulticast23 {
+    readonly channelName: string;
+    readonly topic: string;
+    readonly sourceSpotId: string;
+}
+export declare function encodeLogicalMulticast23(value: LogicalMulticast23): Uint8Array;
+export declare function decodeLogicalMulticast23(bytes: Uint8Array): LogicalMulticast23;
+export interface ActorLookup26 {
+    readonly correlation: bigint;
+    readonly actorId: string;
+}
+export declare function encodeActorLookup26(value: ActorLookup26): Uint8Array;
+export declare function decodeActorLookup26(bytes: Uint8Array): ActorLookup26;
+export interface ActorDestroy27 {
+    readonly correlation: bigint;
+    readonly actor: ServiceWireRouteFence;
+}
+export declare function encodeActorDestroy27(value: ActorDestroy27): Uint8Array;
+export declare function decodeActorDestroy27(bytes: Uint8Array): ActorDestroy27;
+export interface ServiceWireOperationId {
+    readonly high: bigint;
+    readonly low: bigint;
+}
+export interface ServiceWireRelocationId {
+    readonly high: bigint;
+    readonly low: bigint;
+}
+export interface ServiceWireCoordinatorFence {
+    readonly coordinatorOwnerId: string;
+    readonly coordinatorLeaseGeneration: bigint;
+    readonly coordinatorNodeRid: Uint8Array;
+    readonly coordinatorNodeGeneration: bigint;
+    readonly expectedAuthorityStoreVersion: string;
+}
+export interface ServiceWireTargetFence {
+    readonly targetNodeRid: Uint8Array;
+    readonly targetNodeGeneration: bigint;
+    readonly targetOwnerId: string;
+    readonly targetOwnerLeaseGeneration: bigint;
+}
+export interface ServiceWireActorRef {
+    readonly actorId: string;
+    readonly objectGeneration: bigint;
+}
+export interface ServiceWireRequestSourceFence {
+    readonly sourceOwnerId: string;
+    readonly sourceOwnerLeaseGeneration: bigint;
+    readonly sourceNodeRid: Uint8Array;
+    readonly sourceNodeGeneration: bigint;
+}
+export interface ServiceWireAuthorityFence {
+    readonly objectGeneration: bigint;
+    readonly ownerId: string;
+    readonly authorityOwnerGeneration: bigint;
+    readonly leaseGeneration: bigint;
+    readonly storeVersion: string;
+}
+export type ServiceWireRelocationRole = "source" | "target" | "coordinator";
+export type ServiceWireReplyRelayContext = {
+    readonly contextKind: "coldActivation";
+    readonly completionKind: "readyBarrier" | "activationFailure";
+    readonly authority: ServiceWireAuthorityFence;
+} | {
+    readonly contextKind: "maintenanceRelocation";
+    readonly relocation: ServiceWireRelocationId;
+    readonly targetAttemptGeneration: bigint;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly participantId: bigint;
+    readonly sequence: bigint;
+};
+export type ServiceWireSessionRouteUpdate = {
+    readonly action: "commit";
+    readonly previousAuthorityOwnerGeneration: bigint;
+    readonly targetAuthorityOwnerGeneration: bigint;
+    readonly targetNodeRid: Uint8Array;
+    readonly targetNodeGeneration: bigint;
+} | {
+    readonly action: "abort";
+    readonly currentAuthorityOwnerGeneration: bigint;
+};
+export interface ReplyRelay33 {
+    readonly operation: ServiceWireOperationId;
+    readonly replyRouteId: bigint;
+    readonly context: ServiceWireReplyRelayContext;
+    readonly terminalResult: number;
+    readonly failureCode: number;
+    readonly payload?: ApplicationPayloadEnvelopeV1;
+}
+export interface ReplyRelayAck46 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly operation: ServiceWireOperationId;
+    readonly replyRouteId: bigint;
+    readonly requestSource: ServiceWireRequestSourceFence;
+    readonly status: "terminalReceived" | "alreadyTerminal";
+}
+export interface RelocationReady30 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly targetAttemptGeneration: bigint;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly target: ServiceWireTargetFence;
+    readonly object: RelocationObjectIdentity;
+    readonly senderRole: ServiceWireRelocationRole;
+}
+export interface RelocationData31 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly targetAttemptGeneration: bigint;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly senderRole: ServiceWireRelocationRole;
+    readonly object: RelocationObjectIdentity;
+    readonly record: Uint8Array;
+}
+export interface RelocationCutover34 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly targetAttemptGeneration: bigint;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly senderRole: ServiceWireRelocationRole;
+    readonly object: RelocationObjectIdentity;
+    readonly boundaryRecordCount: bigint;
+    readonly boundaryChecksumCrc32c: number;
+}
+export interface RelocationPrepare40 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly targetAttemptGeneration: bigint;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly target: ServiceWireTargetFence;
+    readonly initiatorRole: ServiceWireRelocationRole;
+    readonly object: RelocationObjectIdentity;
+    readonly sourceNodeRid: Uint8Array;
+    readonly sourceNodeGeneration: bigint;
+    readonly payloadTotalLength: bigint;
+    readonly payloadChunkCount: number;
+    readonly payloadChecksumCrc32c: number;
+    readonly applicationVersion: bigint;
+}
+export interface SessionRelocationSeal42 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly senderRole: ServiceWireRelocationRole;
+    readonly actor: ServiceWireRouteFence;
+    readonly sessionOwnerNodeRid: Uint8Array;
+    readonly sessionOwnerNodeGeneration: bigint;
+    readonly sessionOwnerId: string;
+    readonly sessionOwnerLeaseGeneration: bigint;
+    readonly sessionRid: Uint8Array;
+    readonly bindingGeneration: bigint;
+}
+export type SessionRelocationSealed43 = Omit<SessionRelocationSeal42, "senderRole">;
+export interface SessionRelocationRoute44 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly senderRole: ServiceWireRelocationRole;
+    readonly actor: ServiceWireActorRef;
+    readonly sessionOwnerNodeRid: Uint8Array;
+    readonly sessionOwnerNodeGeneration: bigint;
+    readonly sessionOwnerId: string;
+    readonly sessionOwnerLeaseGeneration: bigint;
+    readonly sessionRid: Uint8Array;
+    readonly bindingGeneration: bigint;
+    readonly route: ServiceWireSessionRouteUpdate;
+}
+export interface RelocationState52 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly targetAttemptGeneration: bigint;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly senderRole: ServiceWireRelocationRole;
+    readonly object: RelocationObjectIdentity;
+    readonly chunkOrdinal: number;
+    readonly chunkData: Uint8Array;
+}
+export interface RelocationFailed53 {
+    readonly relocation: ServiceWireRelocationId;
+    readonly targetAttemptGeneration: bigint;
+    readonly coordinator: ServiceWireCoordinatorFence;
+    readonly target: ServiceWireTargetFence;
+    readonly object: RelocationObjectIdentity;
+    readonly senderRole: ServiceWireRelocationRole;
+    readonly failureCode: number;
+}
+export declare function encodeReplyRelay33(v: ReplyRelay33): readonly Uint8Array[];
+export declare function decodeReplyRelay33(frames: readonly Uint8Array[]): ReplyRelay33;
+export declare function encodeReplyRelayAck46(v: ReplyRelayAck46): Uint8Array;
+export declare function decodeReplyRelayAck46(bytes: Uint8Array): ReplyRelayAck46;
+export declare function encodeRelocationReady30(v: RelocationReady30): Uint8Array;
+export declare function decodeRelocationReady30(bytes: Uint8Array): RelocationReady30;
+export declare function encodeRelocationFailed53(v: RelocationFailed53): Uint8Array;
+export declare function decodeRelocationFailed53(bytes: Uint8Array): RelocationFailed53;
+export declare function encodeRelocationData31(v: RelocationData31): Uint8Array;
+export declare function decodeRelocationData31(bytes: Uint8Array): RelocationData31;
+export declare function encodeRelocationCutover34(v: RelocationCutover34): Uint8Array;
+export declare function decodeRelocationCutover34(bytes: Uint8Array): RelocationCutover34;
+export declare function encodeRelocationState52(v: RelocationState52): Uint8Array;
+export declare function decodeRelocationState52(bytes: Uint8Array): RelocationState52;
+export declare function encodeRelocationPrepare40(v: RelocationPrepare40): Uint8Array;
+export declare function decodeRelocationPrepare40(bytes: Uint8Array): RelocationPrepare40;
+export declare function encodeSessionRelocationSeal42(v: SessionRelocationSeal42): Uint8Array;
+export declare function decodeSessionRelocationSeal42(bytes: Uint8Array): SessionRelocationSeal42;
+export declare function encodeSessionRelocationSealed43(v: SessionRelocationSealed43): Uint8Array;
+export declare function decodeSessionRelocationSealed43(bytes: Uint8Array): SessionRelocationSealed43;
+export declare function encodeSessionRelocationRoute44(v: SessionRelocationRoute44): Uint8Array;
+export declare function decodeSessionRelocationRoute44(bytes: Uint8Array): SessionRelocationRoute44;
+export interface ServiceWireObjectReservationFence {
+    readonly reservationId: string;
+    readonly expectedStoreVersion: string;
+    readonly objectGeneration: bigint;
+    readonly authorityOwnerGeneration: bigint;
+    readonly targetNodeRid: Uint8Array;
+    readonly targetNodeGeneration: bigint;
+    readonly targetOwnerId: string;
+    readonly targetOwnerLeaseGeneration: bigint;
+    readonly pendingCapacityDelta: number;
+}
+export interface ServiceWireUserSpotCloseFenceV1 {
+    readonly spotId: string;
+    readonly objectGeneration: bigint;
+    readonly targetNodeRid: Uint8Array;
+    readonly targetNodeGeneration: bigint;
+    readonly expectedAuthorityOwnerGeneration: bigint;
+    readonly expectedStoreVersion: string;
+}
+export interface UserSpotCreate47 {
+    readonly correlation: bigint;
+    readonly operation: ServiceWireOperationId;
+    readonly sourceNodeRid: Uint8Array;
+    readonly sourceNodeGeneration: bigint;
+    readonly spotId: string;
+    readonly stableType: string;
+    readonly reservation: ServiceWireObjectReservationFence;
+    readonly deadlineUnixMs: bigint;
+}
+export interface UserSpotClose48 {
+    readonly correlation: bigint;
+    readonly operation: ServiceWireOperationId;
+    readonly sourceNodeRid: Uint8Array;
+    readonly sourceNodeGeneration: bigint;
+    readonly target: ServiceWireUserSpotCloseFenceV1;
+    readonly deadlineUnixMs: bigint;
+}
+export interface ActorCreate49 {
+    readonly correlation: bigint;
+    readonly operation: ServiceWireOperationId;
+    readonly sourceNodeRid: Uint8Array;
+    readonly sourceNodeGeneration: bigint;
+    readonly actorId: string;
+    readonly stableType: string;
+    readonly reservation: ServiceWireObjectReservationFence;
+    readonly deadlineUnixMs: bigint;
+}
+export interface ZljrNodeSourceV1 {
+    readonly nodeRid: Uint8Array;
+    readonly nodeGeneration: bigint;
+    readonly ownerId: string;
+    readonly ownerLeaseGeneration: bigint;
+}
+export interface ZljrRecordV1 {
+    readonly source: ZljrNodeSourceV1;
+    readonly operation: ServiceWireOperationId;
+    readonly metadata: Uint8Array;
+    readonly request: Uint8Array;
+    readonly reply: Uint8Array;
+}
+export declare function encodeUserSpotCreate47(v: UserSpotCreate47): Uint8Array;
+export declare function decodeUserSpotCreate47(bytes: Uint8Array): UserSpotCreate47;
+export declare function encodeUserSpotClose48(v: UserSpotClose48): Uint8Array;
+export declare function decodeUserSpotClose48(bytes: Uint8Array): UserSpotClose48;
+export declare function encodeActorCreate49(v: ActorCreate49): Uint8Array;
+export declare function decodeActorCreate49(bytes: Uint8Array): ActorCreate49;
+export declare function encodeZljrRecordV1(v: ZljrRecordV1): Uint8Array;
+export declare function decodeZljrRecordV1(bytes: Uint8Array): ZljrRecordV1;