minor sdk tweaks (#2828)

sdk/base/lib/util/GetSystemSmtp.ts

@@ -1,10 +1,11 @@
 import { Effects } from "../Effects"
+import * as T from "../types"
 
 export class GetSystemSmtp {
   constructor(readonly effects: Effects) {}
 
   /**
-   * Returns the system SMTP credentials. Restarts the service if the credentials change
+   * Returns the system SMTP credentials. Reruns the context from which it has been called if the underlying value changes
    */
   const() {
     return this.effects.getSystemSmtp({
@@ -17,8 +18,9 @@ export class GetSystemSmtp {
   once() {
     return this.effects.getSystemSmtp({})
   }
+
   /**
-   * Watches the system SMTP credentials. Takes a custom callback function to run whenever the credentials change
+   * Watches the system SMTP credentials. Returns an async iterator that yields whenever the value changes
    */
   async *watch() {
     while (true) {
@@ -32,4 +34,34 @@ export class GetSystemSmtp {
       await waitForNext
     }
   }
+
+  /**
+   * Watches the system SMTP credentials. Takes a custom callback function to run whenever the credentials change
+   */
+  onChange(
+    callback: (
+      value: T.SmtpValue | null,
+      error?: Error,
+    ) => void | Promise<void>,
+  ) {
+    ;(async () => {
+      for await (const value of this.watch()) {
+        try {
+          await callback(value)
+        } catch (e) {
+          console.error(
+            "callback function threw an error @ GetSystemSmtp.onChange",
+            e,
+          )
+        }
+      }
+    })()
+      .catch((e) => callback(null, e))
+      .catch((e) =>
+        console.error(
+          "callback function threw an error @ GetSystemSmtp.onChange",
+          e,
+        ),
+      )
+  }
 }

sdk/base/lib/util/getServiceInterface.ts

@@ -205,7 +205,7 @@ export class GetServiceInterface {
   ) {}
 
   /**
-   * Returns the value of Store at the provided path. Restart the service if the value changes
+   * Returns the requested service interface. Reruns the context from which it has been called if the underlying value changes
    */
   async const() {
     const { id, packageId } = this.opts
@@ -220,7 +220,7 @@ export class GetServiceInterface {
     return interfaceFilled
   }
   /**
-   * Returns the value of ServiceInterfacesFilled at the provided path. Does nothing if the value changes
+   * Returns the requested service interface. Does nothing if the value changes
    */
   async once() {
     const { id, packageId } = this.opts
@@ -234,7 +234,7 @@ export class GetServiceInterface {
   }
 
   /**
-   * Watches the value of ServiceInterfacesFilled at the provided path. Takes a custom callback function to run whenever the value changes
+   * Watches the requested service interface. Returns an async iterator that yields whenever the value changes
    */
   async *watch() {
     const { id, packageId } = this.opts
@@ -252,6 +252,36 @@ export class GetServiceInterface {
       await waitForNext
     }
   }
+
+  /**
+   * Watches the requested service interface. Takes a custom callback function to run whenever the value changes
+   */
+  onChange(
+    callback: (
+      value: ServiceInterfaceFilled | null,
+      error?: Error,
+    ) => void | Promise<void>,
+  ) {
+    ;(async () => {
+      for await (const value of this.watch()) {
+        try {
+          await callback(value)
+        } catch (e) {
+          console.error(
+            "callback function threw an error @ GetServiceInterface.onChange",
+            e,
+          )
+        }
+      }
+    })()
+      .catch((e) => callback(null, e))
+      .catch((e) =>
+        console.error(
+          "callback function threw an error @ GetServiceInterface.onChange",
+          e,
+        ),
+      )
+  }
 }
 export function getServiceInterface(
   effects: Effects,

sdk/base/lib/util/getServiceInterfaces.ts

@@ -47,7 +47,7 @@ export class GetServiceInterfaces {
   ) {}
 
   /**
-   * Returns the value of Store at the provided path. Restart the service if the value changes
+   * Returns the service interfaces for the package. Reruns the context from which it has been called if the underlying value changes
    */
   async const() {
     const { packageId } = this.opts
@@ -62,7 +62,7 @@ export class GetServiceInterfaces {
     return interfaceFilled
   }
   /**
-   * Returns the value of ServiceInterfacesFilled at the provided path. Does nothing if the value changes
+   * Returns the service interfaces for the package. Does nothing if the value changes
    */
   async once() {
     const { packageId } = this.opts
@@ -76,7 +76,7 @@ export class GetServiceInterfaces {
   }
 
   /**
-   * Watches the value of ServiceInterfacesFilled at the provided path. Takes a custom callback function to run whenever the value changes
+   * Watches the service interfaces for the package. Returns an async iterator that yields whenever the value changes
    */
   async *watch() {
     const { packageId } = this.opts
@@ -93,6 +93,36 @@ export class GetServiceInterfaces {
       await waitForNext
     }
   }
+
+  /**
+   * Watches the service interfaces for the package. Takes a custom callback function to run whenever the value changes
+   */
+  onChange(
+    callback: (
+      value: ServiceInterfaceFilled[] | null,
+      error?: Error,
+    ) => void | Promise<void>,
+  ) {
+    ;(async () => {
+      for await (const value of this.watch()) {
+        try {
+          await callback(value)
+        } catch (e) {
+          console.error(
+            "callback function threw an error @ GetServiceInterfaces.onChange",
+            e,
+          )
+        }
+      }
+    })()
+      .catch((e) => callback(null, e))
+      .catch((e) =>
+        console.error(
+          "callback function threw an error @ GetServiceInterfaces.onChange",
+          e,
+        ),
+      )
+  }
 }
 export function getServiceInterfaces(
   effects: Effects,