terrier-engine 4.14.0 → 4.14.1

package/package.json

@@ -4,7 +4,7 @@
   "files": [
     "*"
   ],
-  "version": "4.14.0",
+  "version": "4.14.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/Terrier-Tech/terrier-engine"

package/terrier/api-subscriber.ts

@@ -11,8 +11,14 @@ export type SubscriptionOptions = {
     keepAlive?: boolean
 }
 
+/** Options specific to Subscribers that use GET HTTP requests */
+export type GetSubscriberOptions = {
+    /** If true, keys in the params object will be snakified before being sent to the server */
+    snakifyKeys?: boolean
+}
+
 /** Parameters to send with the subscription request */
-export type SubscriptionParams = Record<string, string>
+export type SubscriptionParams = Record<string, unknown>
 
 export type SubscriptionEventHandlers<TResult> = {
     onResult: resultListener<TResult>[]
@@ -206,7 +212,7 @@ export class PollingSubscriber<TResult, TParams extends SubscriptionParams> exte
         public url: string,
         public params: TParams,
         public interval: number | duration.Duration,
-        public options: SubscriptionOptions | undefined = undefined
+        public options: (SubscriptionOptions & GetSubscriberOptions) | undefined = undefined
     ) {
         super()
     }
@@ -247,7 +253,8 @@ export class PollingSubscriber<TResult, TParams extends SubscriptionParams> exte
     }
 
     protected request(): Promise<((ApiResponse & SubscriptionEvent<TResult>) | { events: SubscriptionEvent<TResult>[] })> {
-        return Api.get<((ApiResponse & SubscriptionEvent<TResult>) | { events: SubscriptionEvent<TResult>[] })>(this.url, this.params)
+        const params = Api.objectToQueryParams(this.params, this.options?.snakifyKeys)
+        return Api.get<((ApiResponse & SubscriptionEvent<TResult>) | { events: SubscriptionEvent<TResult>[] })>(this.url, params)
     }
 
     protected handleEvent(event: SubscriptionEvent<TResult>): boolean {
@@ -341,7 +348,7 @@ export class StreamingSubscriber<TResult, TParams extends SubscriptionParams> ex
     constructor(
         public url: string,
         public params: TParams,
-        public options: SubscriptionOptions | undefined = undefined,
+        public options: (SubscriptionOptions & GetSubscriberOptions) | undefined = undefined,
     ) {
         super()
     }
@@ -367,8 +374,9 @@ export class StreamingSubscriber<TResult, TParams extends SubscriptionParams> ex
     }
 
     protected subscribeImpl(): void {
-        const paramsString = new URLSearchParams(this.params).toString()
-        const streamer = new Streamer(`${this.url}?${paramsString}`, this.options ?? {})
+        const params = Api.objectToQueryParams(this.params, this.options?.snakifyKeys)
+        const fullUrl = new URLSearchParams(params).toString()
+        const streamer = new Streamer(fullUrl, this.options ?? {})
 
         this.eventHandlers.onResult.forEach(handler => streamer.on<ResultEvent<TResult>>('_result', this.wrapHandler(handler)))
         this.eventHandlers.onError.forEach(handler => streamer.on<ErrorEvent>('_error', this.wrapHandler(handler)))

package/terrier/api.ts

@@ -2,6 +2,8 @@ import {Logger} from "tuff-core/logging"
 import {QueryParams} from "tuff-core/urls"
 import {LogEntry} from "./logging"
 import {ErrorEvent} from "./api-subscriber"
+import Strings from "tuff-core/strings";
+import dayjs from "dayjs";
 
 const log = new Logger('Api')
 
@@ -147,6 +149,28 @@ async function post<ResponseType>(url: string, body: Record<string, unknown> | F
     return await request<ResponseType & ApiResponse>(url, config)
 }
 
+////////////////////////////////////////////////////////////////////////////////
+// Query Params
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Transforms the given object to a QueryParams compatible object.
+ */
+function objectToQueryParams(object: Record<string, unknown>, snakifyKeys: boolean = false): Record<string, string> {
+    const raw: Record<string, string> = {}
+    for (const [key, value] of Object.entries(object)) {
+        const paramKey = snakifyKeys ? Strings.splitWords(key).map(w => w.toLowerCase()).join("_") : key
+
+        if (dayjs.isDayjs(value)) {
+            raw[paramKey] = value.format()
+        } else if (value == undefined) {
+            raw[paramKey] = ""
+        } else {
+            raw[paramKey] = value?.toString()
+        }
+    }
+    return raw
+}
 
 ////////////////////////////////////////////////////////////////////////////////
 // Event Streams
@@ -248,5 +272,6 @@ const Api = {
     post,
     stream,
     addRequestDecorator,
+    objectToQueryParams,
 }
 export default Api