comply to notify resp rules

src/commands/common/notify.ts

@@ -10,8 +10,8 @@ const decode: DecodeFn = (msg) => {
   const parent = util.searchParent(msg, "subscriptionId");
   if (parent) {
     const id = parent.subscriptionId;
-    const relField = Object.keys(parent).find((k) =>
-      k !== "subscriptionId" && k !== "sendResp"
+    const relField = Object.keys(parent).find(
+      (k) => k !== "subscriptionId" && k !== "sendResp"
     );
     return id && relField
       ? [parseInfo(relField, msg), id, null]
@@ -20,7 +20,7 @@ const decode: DecodeFn = (msg) => {
   return [null];
 };
 
-const encode: EncodeFn = ({ paths }) => ({
+const encode: EncodeFn = ({ sendResp, subscriptionId, ...rest }) => ({
   lookup: "Msg",
   header: {
     msgId: util.uniq("NOTIFY@"),
@@ -31,8 +31,10 @@ const encode: EncodeFn = ({ paths }) => ({
     lookup: "Body",
     request: {
       lookup: "Request",
-      get: {
-        paramPaths: Array.isArray(paths) ? paths : [paths],
+      notify: {
+        subscriptionId,
+        sendResp,
+        ...rest,
       },
     },
   },

src/commands/recipes/subscribe.ts

-import { MakeFn, SubscribeRecipe } from "../../types";
+import { CallbackOptions, MakeFn, SubscribeRecipe } from "../../types";
 import { uniq } from "../util";
 
 const subscriptionPath = "Device.LocalAgent.Subscription.";
@@ -23,12 +23,12 @@ const make: MakeFn =
       },
     });
 
-    const respond = opts?.forceNoResponse
-      ? () => {}
-      : () => call("NOTIFY_RESP", { subscriptionId: id });
-    const clear = on(id, (...args) => {
-      respond();
-      callback(...args);
+    // from https://usp.technology/specification/07-index-messages.html#sec:responses-and-retry
+
+    const respond = () => call("NOTIFY_RESP", { subscriptionId: id });
+    const clear = on(id, (msg, fullMsg, opts) => {
+      opts?.sendResp && respond();
+      callback(msg, fullMsg);
     });
     return () => {
       clear();

src/configurations/build.ts

@@ -15,7 +15,7 @@ import {
   BuildConnectionFn,
   USPVersion,
 } from "../types";
-import { knownUSPVersions, makeCallbackRouter, makeRouter } from "../util";
+import { knownUSPVersions, makeCallbackRouter, makeRouter, parseCallbackOptions } from "../util";
 
 const defaultPublishEndpoint = "/usp/endpoint";
 const defaultSubscribeEndpoint = "/usp/controller";
@@ -187,9 +187,10 @@ const buildConnect: BuildConnectionFn =
         }
 
         const cbs = callbackRouter.get(id);
+        const callbackOptions = parseCallbackOptions(parsedMsg)
         cbs.forEach((cb) => {
-          if (message) cb(message, parsedMsg);
-          else if (err) cb(err, parsedMsg);
+          if (callbackOptions) cb(message || err || "", parsedMsg, callbackOptions)
+          else cb(message || err || "", parsedMsg)
         });
       }
     });

src/types.ts

@@ -240,6 +240,7 @@ export type PbRequestCommand =
   | PbRequestCommandSupport
   | PbRequestCommandInstance
   | PbRequestCommandSupportProto
+  | PbRequestCommandNotify
   | PbRequestCommandNotifyResp;
 
 export interface SuportedCommandOpts {
@@ -266,6 +267,14 @@ export type PbRequestCommandNotifyResp = {
   };
 };
 
+export type PbRequestCommandNotify = {
+  notify: {
+    subscriptionId: string;
+    sendResp: boolean;
+    [key: string]: unknown;
+  };
+};
+
 export type PbRequestCommandSupportProto = {
   getSupportedProtocol: {
     controllerSupportedProtocolVersions: string;
@@ -615,7 +624,6 @@ export interface SubscriptionOptions {
   id?: string;
   notif: NotifType;
   retry?: boolean;
-  forceNoResponse?: boolean;
   reference: string | string[];
 }
 
@@ -726,10 +734,20 @@ export type EncodeArgs = {
 
 export type OnIdent = string | RegExp;
 
+export type CallbackOptions = {
+  sendResp: boolean
+}
+
+export type OnCallback = (
+  msg: Response,
+  fullMsg?: Record<string, any>,
+  opts?: CallbackOptions
+) => void;
+
 export type EncodeFn = (args: Record<string, any>) => PbRequestMessage;
 export type CallArgs = Record<string, any>;
 export type ClearFn = () => void;
-export type OnFn = (ident: OnIdent, callback: SubscriptionCallback) => ClearFn;
+export type OnFn = (ident: OnIdent, callback: OnCallback) => ClearFn;
 export type MakeFn = (call: CallFn, on: OnFn) => Command;
 export type MakeRecipeFn = (call: CallFn) => Recipe;
 export type CommandTrigger = {

src/util.ts

-import { CommandType, OnIdent, SubscriptionCallback } from "./types";
+import { search } from "./commands/util";
+import { CallbackOptions, CommandType, OnCallback, OnIdent, SubscriptionCallback } from "./types";
 
 /**
  * Makes a router for storing resolve/reject for a message
@@ -24,19 +25,25 @@ const satisfies = (id: OnIdent, matches: string): boolean =>
 export const makeCallbackRouter = () => {
   const routes = new Map<
     string,
-    { callback: SubscriptionCallback; ident: OnIdent }
+    { callback: OnCallback; ident: OnIdent }
   >();
   return {
-    get: (id: string): SubscriptionCallback[] => {
+    get: (id: string): OnCallback[] => {
       return Array.from(routes.values())
         .filter(({ ident }) => satisfies(ident, id))
         .map((v) => v.callback);
     },
-    add: (ident: OnIdent, callback: SubscriptionCallback) => {
+    add: (ident: OnIdent, callback: OnCallback) => {
       routes.set(toId(ident), { callback, ident });
     },
     del: (id: OnIdent) => routes.delete(toId(id)),
   };
 };
 
+export const parseCallbackOptions = (msg: Record<string, any>): CallbackOptions | null => {
+  const sendResp = search(msg, "sendResp")
+  if (typeof sendResp === "boolean") return { sendResp }
+  return null
+}
+
 export const knownUSPVersions = ["1.0", "1.1", "1.2"] as const;