@nextera.one/axis-server-sdk 1.1.0 → 1.2.1

package/dist/index.d.ts

@@ -1,5 +1,7 @@
+import { ModuleRef } from '@nestjs/core';
 import { AxisFrame as AxisFrame$1 } from './core/index.js';
-export { AXIS_MAGIC, AXIS_VERSION, AxisBinaryFrame, AxisFrameZ, TLV as AxisTlvType, BodyProfile, ERR_BAD_SIGNATURE, ERR_CONTRACT_VIOLATION, ERR_INVALID_PACKET, ERR_REPLAY_DETECTED, FLAG_BODY_TLV, FLAG_CHAIN_REQ, FLAG_HAS_WITNESS, MAX_BODY_LEN, MAX_FRAME_LEN, MAX_HDR_LEN, MAX_SIG_LEN, NCERT_ALG, NCERT_EXP, NCERT_ISSUER_KID, NCERT_KID, NCERT_NBF, NCERT_NODE_ID, NCERT_PAYLOAD, NCERT_PUB, NCERT_SCOPE, NCERT_SIG, PROOF_CAPSULE, PROOF_JWT, PROOF_LOOM, PROOF_MTLS, PROOF_NONE, PROOF_WITNESS, ProofType, TLV, TLV_ACTOR_ID, TLV_AUD, TLV_BODY_ARR, TLV_BODY_OBJ, TLV_CAPSULE, TLV_EFFECT, TLV_ERROR_CODE, TLV_ERROR_MSG, TLV_INDEX, TLV_INTENT, TLV_KID, TLV_LOOM_PRESENCE_ID, TLV_LOOM_THREAD_HASH, TLV_LOOM_WRIT, TLV_NODE, TLV_NODE_CERT_HASH, TLV_NODE_KID, TLV_NONCE, TLV_OFFSET, TLV_OK, TLV_PID, TLV_PREV_HASH, TLV_PROOF_REF, TLV_PROOF_TYPE, TLV_REALM, TLV_RECEIPT_HASH, TLV_RID, TLV_SHA256_CHUNK, TLV_TRACE_ID, TLV_TS, TLV_UPLOAD_ID, computeReceiptHash, computeSignaturePayload, decodeArray, decodeFrame, decodeObject, decodeTLVs, decodeTLVsList, decodeVarint, encodeFrame, encodeTLVs, encodeVarint, generateEd25519KeyPair, getSignTarget, sha256, signFrame, varintLength, verifyFrameSignature } from './core/index.js';
+export { AxisBinaryFrame, AxisFrameZ, computeReceiptHash, computeSignaturePayload, decodeFrame, encodeFrame, generateEd25519KeyPair, getSignTarget, sha256, signFrame, verifyFrameSignature } from './core/index.js';
+export { AXIS_MAGIC, AXIS_VERSION, TLV as AxisTlvType, BodyProfile, ERR_BAD_SIGNATURE, ERR_CONTRACT_VIOLATION, ERR_INVALID_PACKET, ERR_REPLAY_DETECTED, FLAG_BODY_TLV, FLAG_CHAIN_REQ, FLAG_HAS_WITNESS, MAX_BODY_LEN, MAX_FRAME_LEN, MAX_HDR_LEN, MAX_SIG_LEN, NCERT_ALG, NCERT_EXP, NCERT_ISSUER_KID, NCERT_KID, NCERT_NBF, NCERT_NODE_ID, NCERT_PAYLOAD, NCERT_PUB, NCERT_SCOPE, NCERT_SIG, PROOF_CAPSULE, PROOF_JWT, PROOF_LOOM, PROOF_MTLS, PROOF_NONE, PROOF_WITNESS, ProofType, TLV, TLV_ACTOR_ID, TLV_AUD, TLV_BODY_ARR, TLV_BODY_OBJ, TLV_CAPSULE, TLV_EFFECT, TLV_ERROR_CODE, TLV_ERROR_MSG, TLV_INDEX, TLV_INTENT, TLV_KID, TLV_LOOM_PRESENCE_ID, TLV_LOOM_THREAD_HASH, TLV_LOOM_WRIT, TLV_NODE, TLV_NODE_CERT_HASH, TLV_NODE_KID, TLV_NONCE, TLV_OFFSET, TLV_OK, TLV_PID, TLV_PREV_HASH, TLV_PROOF_REF, TLV_PROOF_TYPE, TLV_REALM, TLV_RECEIPT_HASH, TLV_RID, TLV_SHA256_CHUNK, TLV_TRACE_ID, TLV_TS, TLV_UPLOAD_ID, decodeArray, decodeObject, decodeTLVs, decodeTLVsList, decodeVarint, encodeTLVs, encodeVarint, varintLength } from '@nextera.one/axis-protocol';
 import 'zod';
 
 declare const HANDLER_METADATA_KEY = "axis:handler";
@@ -37,6 +39,12 @@ interface IntentOptions {
 }
 declare function Intent(action: string, options?: IntentOptions): MethodDecorator;
 
+declare const INTENT_BODY_KEY = "axis:intent:body";
+declare function IntentBody(decoder: (buf: Buffer) => any): MethodDecorator;
+
+declare const INTENT_SENSORS_KEY = "axis:intent:sensors";
+declare function IntentSensors(sensors: Function[]): MethodDecorator;
+
 declare const TLV_FIELDS_KEY = "axis:tlv:fields";
 declare const TLV_VALIDATORS_KEY = "axis:tlv:validators";
 type TlvFieldKind = 'utf8' | 'u64' | 'bytes' | 'bytes16' | 'bool' | 'obj' | 'arr';
@@ -94,6 +102,20 @@ declare abstract class AxisResponseDto extends AxisTlvDto {
     updated_by?: string;
 }
 
+interface IntentSchema {
+    intent: string;
+    version: number;
+    bodyProfile: 'TLV_MAP' | 'RAW' | 'TLV_OBJ' | 'TLV_ARR';
+    fields: Array<{
+        name: string;
+        tlv: number;
+        kind: IntentTlvField['kind'];
+        required?: boolean;
+        maxLen?: number;
+        max?: string;
+        scope?: 'header' | 'body';
+    }>;
+}
 interface AxisEffect {
     ok: boolean;
     effect: string;
@@ -102,11 +124,34 @@ interface AxisEffect {
     metadata?: any;
 }
 declare class IntentRouter {
+    private readonly moduleRef?;
+    private readonly logger;
+    private static readonly BUILTIN_INTENTS;
     private handlers;
+    private intentSensors;
+    private intentDecoders;
+    private intentSchemas;
+    private intentValidators;
+    private intentKinds;
+    constructor(moduleRef?: ModuleRef | undefined);
+    getSchema(intent: string): IntentSchema | undefined;
+    getValidators(intent: string): Map<number, TlvValidatorFn[]> | undefined;
+    has(intent: string): boolean;
+    getRegisteredIntents(): string[];
+    getIntentEntry(intent: string): {
+        schema?: IntentSchema;
+        validators?: Map<number, TlvValidatorFn[]>;
+        hasSensors: boolean;
+        builtin: boolean;
+        kind?: IntentKind;
+    } | null;
     register(intent: string, handler: any): void;
     registerHandler(instance: any): void;
     route(frame: AxisFrame$1): Promise<AxisEffect>;
-    private recordLatency;
+    private logIntent;
+    registerIntentMeta(intent: string, proto: object, methodName: string): void;
+    private runIntentSensors;
+    private storeSchema;
 }
 
 declare const ATS1_HDR: {
@@ -437,6 +482,10 @@ interface AxisCapsulePayload {
     constraints?: AxisCapsuleConstraints;
     meta?: Record<string, unknown>;
 }
+interface AxisCapsule {
+    payload: AxisCapsulePayload;
+    sig: AxisSig$1;
+}
 interface AxisResponse$1<T = any> {
     ok: boolean;
     pid: string;
@@ -757,4 +806,85 @@ interface IntentDefinition {
 declare function validateFrameShape(frame: any): boolean;
 declare function isTimestampValid(ts: number, skewSeconds?: number): boolean;
 
-export { ATS1_HDR, ATS1_SCHEMA, AXIS_OPCODES, ats1 as Ats1Codec, type Axis1DecodedFrame, type Axis1FrameToEncode, type AxisAlg$1 as AxisAlg, type AxisPacket as AxisBinaryPacket, type AxisCapsuleConstraints, type AxisCapsulePayload, type AxisCrudHandler, type AxisEffect, type AxisHandler, type AxisHandlerInit, AxisIdDto, type AxisAlg as AxisJsonAlg, type AxisFrame as AxisJsonFrame, type AxisResponse as AxisJsonResponse, type AxisSig as AxisJsonSig, type AxisObservedContext, type AxisPacket$1 as AxisPacket, T as AxisPacketTags, AxisPartialType, type AxisPostSensor, type AxisPreSensor, type AxisRequestContext, AxisResponseDto, type AxisSensor, type AxisSensorInit, type AxisSig$1 as AxisSig, AxisTlvDto, CAPABILITIES, type Capability, type CapsuleMode, ContractViolationError, DEFAULT_CONTRACTS, DEFAULT_TIMEOUT, Decision, type DtoSchema, type ExecutionContract, ExecutionMeter, type ExecutionMetrics, FALLBACK_CONTRACT, HANDLER_METADATA_KEY, Handler, INTENT_METADATA_KEY, INTENT_REQUIREMENTS, INTENT_ROUTES_KEY, INTENT_SENSITIVITY_MAP, INTENT_TIMEOUTS, Intent, type IntentDefinition, type IntentKind, type IntentOptions, type IntentRoute, IntentRouter, IntentSensitivity, type IntentTlvField, type KeyStatus, PROOF_CAPABILITIES, RESPONSE_TAG_CREATED_AT, RESPONSE_TAG_CREATED_BY, RESPONSE_TAG_ID, RESPONSE_TAG_UPDATED_AT, RESPONSE_TAG_UPDATED_BY, type ReceiptEffect, RiskDecision, type RiskEvaluation, type RiskSignal, Schema2002_PasskeyLoginOptionsRes, Schema2011_PasskeyLoginVerifyReq, Schema2012_PasskeyLoginVerifyRes, Schema2021_PasskeyRegisterOptionsReq, type SensorDecision, SensorDecisions, type SensorInput, type SensorMinifiedDecision, type SensorPhaseMetadata, TLV_FIELDS_KEY, TLV_VALIDATORS_KEY, TlvEnum, TlvField, type TlvFieldKind, type TlvFieldMeta, type TlvFieldOptions, TlvMinLen, TlvRange, TlvUtf8Pattern, TlvValidate, type TlvValidatorFn, type TlvValidatorMeta, axis1SigningBytes, b64urlDecode, b64urlDecodeString, b64urlEncode, b64urlEncodeString, buildAts1Hdr, buildDtoDecoder, buildPacket, buildReceiptHash, buildTLVs, bytes, canAccessResource, canonicalJson, canonicalJsonExcluding, classifyIntent, decodeAxis1Frame, encVarint, encodeAxis1Frame, extractDtoSchema, hasScope, isAdminOpcode, isKnownOpcode, isTimestampValid, nonce16, normalizeSensorDecision, packPasskeyLoginOptionsReq, packPasskeyLoginOptionsRes, packPasskeyLoginVerifyReq, packPasskeyLoginVerifyRes, packPasskeyRegisterOptionsReq, parseScope, resolveTimeout, sensitivityName, tlv, u64be, unpackPasskeyLoginOptionsReq, unpackPasskeyLoginVerifyReq, unpackPasskeyRegisterOptionsReq, utf8, validateFrameShape, varintU };
+type UploadSessionStatus = 'ACTIVE' | 'FINALIZING' | 'COMPLETE' | 'ABORTED';
+interface UploadSessionRecord {
+    id?: string;
+    fileId: string;
+    filename?: string;
+    status: UploadSessionStatus | string;
+    totalSize?: number;
+    chunkSize?: number;
+    totalChunks?: number;
+    receivedBitmap?: Uint8Array | Buffer | null;
+    hashState?: Uint8Array | Buffer | null;
+    mimeType?: string | null;
+    version?: number;
+}
+interface UploadSessionStore {
+    findByFileId(fileId: string): Promise<UploadSessionRecord | null>;
+    updateStatus(fileId: string, status: UploadSessionStatus, hashState?: Uint8Array | Buffer | null): Promise<void>;
+}
+interface UploadReceiptSigner {
+    signActive(message: Uint8Array): {
+        kid: string;
+        sig: Uint8Array;
+    };
+}
+interface UploadFileStat {
+    path: string;
+    size: number;
+}
+interface UploadFileStore {
+    getFinalPath(fileId: string, filename?: string): string;
+    getTempPath(fileId: string): string;
+    statFinal(fileId: string, filename?: string): Promise<UploadFileStat>;
+    readFinalRange(fileId: string, filename: string | undefined, start: number, length: number): Promise<Buffer>;
+    hasTemp(fileId: string): Promise<boolean>;
+    moveTempToFinal(fileId: string, filename?: string): Promise<string>;
+    createTempReadStream(fileId: string): NodeJS.ReadableStream;
+}
+
+declare class AxisFilesDownloadHandler implements AxisHandler {
+    private readonly sessions;
+    private readonly files;
+    private readonly logger;
+    readonly name = "axis.files.download";
+    readonly open = true;
+    readonly description = "File download handler";
+    constructor(sessions: UploadSessionStore, files: UploadFileStore);
+    execute(body: Uint8Array, headers?: Map<number, Uint8Array>): Promise<any>;
+}
+declare class AxisFilesFinalizeHandler implements AxisHandler {
+    private readonly sessions;
+    private readonly files;
+    private readonly keyring?;
+    private readonly logger;
+    readonly name = "axis.files.finalize";
+    readonly open = false;
+    readonly description = "File upload finalization handler";
+    constructor(sessions: UploadSessionStore, files: UploadFileStore, keyring?: UploadReceiptSigner | undefined);
+    execute(body: Uint8Array, headers?: Map<number, Uint8Array>): Promise<any>;
+}
+
+declare const AXIS_UPLOAD_SESSION_STORE = "AXIS_UPLOAD_SESSION_STORE";
+declare const AXIS_UPLOAD_FILE_STORE = "AXIS_UPLOAD_FILE_STORE";
+declare const AXIS_UPLOAD_RECEIPT_SIGNER = "AXIS_UPLOAD_RECEIPT_SIGNER";
+
+interface DiskUploadFileStoreOptions {
+    uploadDir: string;
+    chunkDir: string;
+}
+declare class DiskUploadFileStore implements UploadFileStore {
+    private readonly uploadDir;
+    private readonly chunkDir;
+    constructor(options: DiskUploadFileStoreOptions);
+    getFinalPath(fileId: string, filename?: string): string;
+    getTempPath(fileId: string): string;
+    statFinal(fileId: string, filename?: string): Promise<UploadFileStat>;
+    readFinalRange(fileId: string, filename: string | undefined, start: number, length: number): Promise<Buffer>;
+    hasTemp(fileId: string): Promise<boolean>;
+    moveTempToFinal(fileId: string, filename?: string): Promise<string>;
+    createTempReadStream(fileId: string): NodeJS.ReadableStream;
+}
+
+export { ATS1_HDR, ATS1_SCHEMA, AXIS_OPCODES, AXIS_UPLOAD_FILE_STORE, AXIS_UPLOAD_RECEIPT_SIGNER, AXIS_UPLOAD_SESSION_STORE, ats1 as Ats1Codec, type Axis1DecodedFrame, type Axis1FrameToEncode, type AxisAlg$1 as AxisAlg, type AxisPacket as AxisBinaryPacket, type AxisCapsule, type AxisCapsuleConstraints, type AxisCapsulePayload, type AxisCrudHandler, type AxisEffect, AxisFilesDownloadHandler, AxisFilesFinalizeHandler, AxisFrame$1 as AxisFrame, type AxisHandler, type AxisHandlerInit, AxisIdDto, type AxisAlg as AxisJsonAlg, type AxisFrame as AxisJsonFrame, type AxisResponse as AxisJsonResponse, type AxisSig as AxisJsonSig, type AxisObservedContext, type AxisPacket$1 as AxisPacket, T as AxisPacketTags, AxisPartialType, type AxisPostSensor, type AxisPreSensor, type AxisRequestContext, AxisResponseDto, type AxisSensor, type AxisSensorInit, type AxisSig$1 as AxisSig, AxisTlvDto, CAPABILITIES, type Capability, type CapsuleMode, ContractViolationError, DEFAULT_CONTRACTS, DEFAULT_TIMEOUT, Decision, DiskUploadFileStore, type DtoSchema, type ExecutionContract, ExecutionMeter, type ExecutionMetrics, FALLBACK_CONTRACT, HANDLER_METADATA_KEY, Handler, INTENT_BODY_KEY, INTENT_METADATA_KEY, INTENT_REQUIREMENTS, INTENT_ROUTES_KEY, INTENT_SENSITIVITY_MAP, INTENT_SENSORS_KEY, INTENT_TIMEOUTS, Intent, IntentBody, type IntentDefinition, type IntentKind, type IntentOptions, type IntentRoute, IntentRouter, IntentSensitivity, IntentSensors, type IntentTlvField, type KeyStatus, PROOF_CAPABILITIES, RESPONSE_TAG_CREATED_AT, RESPONSE_TAG_CREATED_BY, RESPONSE_TAG_ID, RESPONSE_TAG_UPDATED_AT, RESPONSE_TAG_UPDATED_BY, type ReceiptEffect, RiskDecision, type RiskEvaluation, type RiskSignal, Schema2002_PasskeyLoginOptionsRes, Schema2011_PasskeyLoginVerifyReq, Schema2012_PasskeyLoginVerifyRes, Schema2021_PasskeyRegisterOptionsReq, type SensorDecision, SensorDecisions, type SensorInput, type SensorMinifiedDecision, type SensorPhaseMetadata, TLV_FIELDS_KEY, TLV_VALIDATORS_KEY, TlvEnum, TlvField, type TlvFieldKind, type TlvFieldMeta, type TlvFieldOptions, TlvMinLen, TlvRange, TlvUtf8Pattern, TlvValidate, type TlvValidatorFn, type TlvValidatorMeta, type UploadFileStat, type UploadFileStore, type UploadReceiptSigner, type UploadSessionRecord, type UploadSessionStatus, type UploadSessionStore, axis1SigningBytes, b64urlDecode, b64urlDecodeString, b64urlEncode, b64urlEncodeString, buildAts1Hdr, buildDtoDecoder, buildPacket, buildReceiptHash, buildTLVs, bytes, canAccessResource, canonicalJson, canonicalJsonExcluding, classifyIntent, decodeAxis1Frame, encVarint, encodeAxis1Frame, extractDtoSchema, hasScope, isAdminOpcode, isKnownOpcode, isTimestampValid, nonce16, normalizeSensorDecision, packPasskeyLoginOptionsReq, packPasskeyLoginOptionsRes, packPasskeyLoginVerifyReq, packPasskeyLoginVerifyRes, packPasskeyRegisterOptionsReq, parseScope, resolveTimeout, sensitivityName, tlv, u64be, unpackPasskeyLoginOptionsReq, unpackPasskeyLoginVerifyReq, unpackPasskeyRegisterOptionsReq, utf8, validateFrameShape, varintU };