@nextera.one/axis-server-sdk 2.1.8 → 2.2.0

package/dist/index.d.mts

@@ -681,7 +681,7 @@ declare function Handler(intent?: string): ClassDecorator;
 
 declare const INTENT_METADATA_KEY = "axis:intent";
 declare const INTENT_ROUTES_KEY = "axis:intent_routes";
-type IntentKind = 'create' | 'read' | 'update' | 'delete' | 'action';
+type IntentKind = "create" | "read" | "update" | "delete" | "action";
 type AxisIntentSensorRef = string | Function;
 interface AxisIntentSensorOptions {
     is?: AxisIntentSensorRef[];
@@ -689,11 +689,11 @@ interface AxisIntentSensorOptions {
 interface IntentTlvField {
     name: string;
     tag: number;
-    kind: 'utf8' | 'u64' | 'bytes' | 'bytes16' | 'bool' | 'obj' | 'arr';
+    kind: "utf8" | "u64" | "bytes" | "bytes16" | "bool" | "obj" | "arr";
     required?: boolean;
     maxLen?: number;
     max?: string;
-    scope?: 'header' | 'body';
+    scope?: "header" | "body";
 }
 interface IntentRoute extends AxisIntentSensorOptions {
     action: string;
@@ -703,7 +703,7 @@ interface IntentRoute extends AxisIntentSensorOptions {
     kind?: IntentKind;
     sensitivity?: SensitivityLevel;
     chain?: boolean | ChainOptions;
-    bodyProfile?: 'TLV_MAP' | 'RAW' | 'TLV_OBJ' | 'TLV_ARR';
+    bodyProfile?: "TLV_MAP" | "RAW" | "TLV_OBJ" | "TLV_ARR";
     tlv?: IntentTlvField[];
     dto?: Function;
 }
@@ -713,9 +713,10 @@ interface IntentOptions extends AxisIntentSensorOptions {
     absolute?: boolean;
     frame?: boolean;
     chain?: boolean | ChainOptions;
-    bodyProfile?: 'TLV_MAP' | 'RAW' | 'TLV_OBJ' | 'TLV_ARR';
+    bodyProfile?: "TLV_MAP" | "RAW" | "TLV_OBJ" | "TLV_ARR";
     tlv?: IntentTlvField[];
     dto?: Function;
+    decoder?: (buf: Buffer) => any;
 }
 declare function Intent(action: string, options?: IntentOptions): MethodDecorator;
 
@@ -793,6 +794,7 @@ declare function extractDtoSchema(dto: Function): DtoSchema;
 declare function buildDtoDecoder(dto: Function): (bodyBytes: Buffer) => Record<string, any>;
 
 declare abstract class AxisTlvDto {
+    static afterDecode(_dto: Record<string, any>): void;
 }
 
 declare class AxisIdDto extends AxisTlvDto {

package/dist/index.d.ts

@@ -681,7 +681,7 @@ declare function Handler(intent?: string): ClassDecorator;
 
 declare const INTENT_METADATA_KEY = "axis:intent";
 declare const INTENT_ROUTES_KEY = "axis:intent_routes";
-type IntentKind = 'create' | 'read' | 'update' | 'delete' | 'action';
+type IntentKind = "create" | "read" | "update" | "delete" | "action";
 type AxisIntentSensorRef = string | Function;
 interface AxisIntentSensorOptions {
     is?: AxisIntentSensorRef[];
@@ -689,11 +689,11 @@ interface AxisIntentSensorOptions {
 interface IntentTlvField {
     name: string;
     tag: number;
-    kind: 'utf8' | 'u64' | 'bytes' | 'bytes16' | 'bool' | 'obj' | 'arr';
+    kind: "utf8" | "u64" | "bytes" | "bytes16" | "bool" | "obj" | "arr";
     required?: boolean;
     maxLen?: number;
     max?: string;
-    scope?: 'header' | 'body';
+    scope?: "header" | "body";
 }
 interface IntentRoute extends AxisIntentSensorOptions {
     action: string;
@@ -703,7 +703,7 @@ interface IntentRoute extends AxisIntentSensorOptions {
     kind?: IntentKind;
     sensitivity?: SensitivityLevel;
     chain?: boolean | ChainOptions;
-    bodyProfile?: 'TLV_MAP' | 'RAW' | 'TLV_OBJ' | 'TLV_ARR';
+    bodyProfile?: "TLV_MAP" | "RAW" | "TLV_OBJ" | "TLV_ARR";
     tlv?: IntentTlvField[];
     dto?: Function;
 }
@@ -713,9 +713,10 @@ interface IntentOptions extends AxisIntentSensorOptions {
     absolute?: boolean;
     frame?: boolean;
     chain?: boolean | ChainOptions;
-    bodyProfile?: 'TLV_MAP' | 'RAW' | 'TLV_OBJ' | 'TLV_ARR';
+    bodyProfile?: "TLV_MAP" | "RAW" | "TLV_OBJ" | "TLV_ARR";
     tlv?: IntentTlvField[];
     dto?: Function;
+    decoder?: (buf: Buffer) => any;
 }
 declare function Intent(action: string, options?: IntentOptions): MethodDecorator;
 
@@ -793,6 +794,7 @@ declare function extractDtoSchema(dto: Function): DtoSchema;
 declare function buildDtoDecoder(dto: Function): (bodyBytes: Buffer) => Record<string, any>;
 
 declare abstract class AxisTlvDto {
+    static afterDecode(_dto: Record<string, any>): void;
 }
 
 declare class AxisIdDto extends AxisTlvDto {

package/dist/index.js

@@ -318,6 +318,25 @@ var init_handler_decorator = __esm({
   }
 });
 
+// src/decorators/intent-body.decorator.ts
+var intent_body_decorator_exports = {};
+__export(intent_body_decorator_exports, {
+  INTENT_BODY_KEY: () => INTENT_BODY_KEY,
+  IntentBody: () => IntentBody
+});
+function IntentBody(decoder) {
+  return (target, propertyKey) => {
+    Reflect.defineMetadata(INTENT_BODY_KEY, decoder, target, propertyKey);
+  };
+}
+var import_reflect_metadata4, INTENT_BODY_KEY;
+var init_intent_body_decorator = __esm({
+  "src/decorators/intent-body.decorator.ts"() {
+    import_reflect_metadata4 = require("reflect-metadata");
+    INTENT_BODY_KEY = "axis:intent:body";
+  }
+});
+
 // src/decorators/intent.decorator.ts
 var intent_decorator_exports = {};
 __export(intent_decorator_exports, {
@@ -329,6 +348,14 @@ function Intent(action, options) {
   return (target, propertyKey) => {
     const metadata = { intent: action, ...options };
     Reflect.defineMetadata(INTENT_METADATA_KEY, metadata, target, propertyKey);
+    if (options?.decoder) {
+      Reflect.defineMetadata(
+        INTENT_BODY_KEY,
+        options.decoder,
+        target,
+        propertyKey
+      );
+    }
     if (options?.sensitivity) {
       Reflect.defineMetadata(
         SENSITIVITY_METADATA_KEY,
@@ -354,35 +381,17 @@ function Intent(action, options) {
     Reflect.defineMetadata(INTENT_ROUTES_KEY, routes, target.constructor);
   };
 }
-var import_reflect_metadata4, INTENT_METADATA_KEY, INTENT_ROUTES_KEY;
+var import_reflect_metadata5, INTENT_METADATA_KEY, INTENT_ROUTES_KEY;
 var init_intent_decorator = __esm({
   "src/decorators/intent.decorator.ts"() {
-    import_reflect_metadata4 = require("reflect-metadata");
+    import_reflect_metadata5 = require("reflect-metadata");
+    init_intent_body_decorator();
     init_intent_policy_decorator();
     INTENT_METADATA_KEY = "axis:intent";
     INTENT_ROUTES_KEY = "axis:intent_routes";
   }
 });
 
-// src/decorators/intent-body.decorator.ts
-var intent_body_decorator_exports = {};
-__export(intent_body_decorator_exports, {
-  INTENT_BODY_KEY: () => INTENT_BODY_KEY,
-  IntentBody: () => IntentBody
-});
-function IntentBody(decoder) {
-  return (target, propertyKey) => {
-    Reflect.defineMetadata(INTENT_BODY_KEY, decoder, target, propertyKey);
-  };
-}
-var import_reflect_metadata5, INTENT_BODY_KEY;
-var init_intent_body_decorator = __esm({
-  "src/decorators/intent-body.decorator.ts"() {
-    import_reflect_metadata5 = require("reflect-metadata");
-    INTENT_BODY_KEY = "axis:intent:body";
-  }
-});
-
 // src/decorators/intent-sensors.decorator.ts
 var intent_sensors_decorator_exports = {};
 __export(intent_sensors_decorator_exports, {
@@ -621,9 +630,12 @@ var require_dto_schema_util = __commonJS({
     var tlv_field_decorator_1 = require_tlv_field_decorator();
     var tlv_1 = (init_tlv(), __toCommonJS(tlv_exports));
     function extractDtoSchema2(dto) {
+      if (typeof dto !== "function") {
+        throw new Error(`extractDtoSchema expected a class constructor but received ${typeof dto} (${String(dto)}) \u2014 did you pass a plain object or instance to @Intent({ dto }) instead of a class?`);
+      }
       const fieldMetas = Reflect.getMetadata(tlv_field_decorator_1.TLV_FIELDS_KEY, dto) || [];
       if (fieldMetas.length === 0) {
-        throw new Error(`DTO class ${dto.name} has no @TlvField decorators \u2014 nothing to validate`);
+        throw new Error(`DTO class ${dto.name || "<anonymous>"} has no @TlvField decorators \u2014 nothing to validate. Make sure the class extends AxisTlvDto and its fields are annotated with @TlvField(tag, { kind }).`);
       }
       const tagByProp = /* @__PURE__ */ new Map();
       const fields = fieldMetas.map((m) => {
@@ -651,14 +663,19 @@ var require_dto_schema_util = __commonJS({
       return { fields, validators };
     }
     function buildDtoDecoder2(dto) {
+      if (typeof dto !== "function") {
+        throw new Error(`buildDtoDecoder expected a class constructor but received ${typeof dto} (${String(dto)}) \u2014 did you pass a plain object or instance to @Intent({ dto }) instead of a class?`);
+      }
       const fieldMetas = Reflect.getMetadata(tlv_field_decorator_1.TLV_FIELDS_KEY, dto) || [];
       if (fieldMetas.length === 0) {
-        throw new Error(`DTO class ${dto.name} has no @TlvField decorators \u2014 cannot build decoder`);
+        throw new Error(`DTO class ${dto.name || "<anonymous>"} has no @TlvField decorators \u2014 cannot build decoder. Make sure the class extends AxisTlvDto and its fields are annotated with @TlvField(tag, { kind }).`);
       }
       const tagMap = /* @__PURE__ */ new Map();
       for (const m of fieldMetas) {
         tagMap.set(m.tag, { property: m.property, kind: m.options.kind });
       }
+      const dtoClass = dto;
+      const afterDecode = typeof dtoClass.afterDecode === "function" ? dtoClass.afterDecode.bind(dtoClass) : void 0;
       return (bodyBytes) => {
         const tlvMap2 = (0, tlv_1.decodeTLVs)(new Uint8Array(bodyBytes));
         const result = {};
@@ -693,6 +710,7 @@ var require_dto_schema_util = __commonJS({
               result[meta.property] = raw;
           }
         }
+        afterDecode?.(result);
         return result;
       };
     }
@@ -708,6 +726,8 @@ var AxisTlvDto;
 var init_axis_tlv_dto = __esm({
   "src/base/axis-tlv.dto.ts"() {
     AxisTlvDto = class {
+      static afterDecode(_dto) {
+      }
     };
   }
 });