@smplkit/sdk 3.0.51 → 3.0.52

package/dist/index.d.cts

@@ -106,27 +106,54 @@ interface HttpHeader {
  * {@link FORWARDER_TYPES} for callers that need to iterate.
  */
 type ForwarderType = "HTTP" | "DATADOG" | "SPLUNK_HEC" | "SUMO_LOGIC" | "NEW_RELIC" | "HONEYCOMB" | "ELASTIC";
-interface ForwarderHttp {
+/**
+ * Transport-specific delivery configuration. Today every destination
+ * type uses HTTP; future transports (FTP, SQS, ...) will join this as
+ * members of a discriminated union under {@link Forwarder.configuration}.
+ */
+interface HttpConfiguration {
+    /** HTTP method: GET, POST, PUT, PATCH, or DELETE. */
     method: string;
+    /** Destination URL. */
     url: string;
+    /** HTTP headers attached to each delivery request. */
     headers: HttpHeader[];
-    body: string | null;
     /**
-     * 3-character string: an exact HTTP code (e.g. `"200"`, `"204"`) or a
-     * class (`"2xx"`, `"3xx"`, `"4xx"`, `"5xx"`).
+     * Either an exact HTTP code (e.g. `"200"`, `"204"`) or a status class
+     * (`"1xx"`, `"2xx"`, `"3xx"`, `"4xx"`, `"5xx"`).
      */
     successStatus: string;
 }
+/**
+ * Engine used to evaluate {@link Forwarder.transform}. Must be set
+ * whenever `transform` is set. Today only `JSONATA` is supported.
+ */
+type TransformType = "JSONATA";
 interface Forwarder {
+    /** UUID assigned by the server at creation time. */
     id: string;
     name: string;
-    slug: string;
+    /** Free-text description for the forwarder. */
+    description: string | null;
     forwarderType: ForwarderType;
     enabled: boolean;
     filter: Record<string, unknown> | null;
-    transform: string | null;
-    /** Header values are returned redacted on reads. */
-    http: ForwarderHttp;
+    /**
+     * Engine used to evaluate {@link transform}. Paired 1:1 with
+     * `transform` — both set, or both `null`.
+     */
+    transformType: TransformType | null;
+    /**
+     * Template applied to each event before delivery. Shape depends on
+     * {@link transformType}; for `JSONATA`, a string containing a JSONata
+     * expression. `null` when no transform is configured.
+     */
+    transform: unknown | null;
+    /**
+     * Transport-specific delivery configuration. Header values are
+     * returned redacted on reads.
+     */
+    configuration: HttpConfiguration;
     createdAt: string | null;
     updatedAt: string | null;
     deletedAt: string | null;
@@ -135,10 +162,13 @@ interface Forwarder {
 interface CreateForwarderInput {
     name: string;
     forwarderType: ForwarderType;
-    http: ForwarderHttp;
+    configuration: HttpConfiguration;
     enabled?: boolean;
+    description?: string;
     filter?: Record<string, unknown>;
-    transform?: string;
+    /** Required when {@link transform} is set; today must be `"JSONATA"`. */
+    transformType?: TransformType;
+    transform?: unknown;
 }
 interface UpdateForwarderInput extends CreateForwarderInput {
 }

package/dist/index.d.ts

@@ -106,27 +106,54 @@ interface HttpHeader {
  * {@link FORWARDER_TYPES} for callers that need to iterate.
  */
 type ForwarderType = "HTTP" | "DATADOG" | "SPLUNK_HEC" | "SUMO_LOGIC" | "NEW_RELIC" | "HONEYCOMB" | "ELASTIC";
-interface ForwarderHttp {
+/**
+ * Transport-specific delivery configuration. Today every destination
+ * type uses HTTP; future transports (FTP, SQS, ...) will join this as
+ * members of a discriminated union under {@link Forwarder.configuration}.
+ */
+interface HttpConfiguration {
+    /** HTTP method: GET, POST, PUT, PATCH, or DELETE. */
     method: string;
+    /** Destination URL. */
     url: string;
+    /** HTTP headers attached to each delivery request. */
     headers: HttpHeader[];
-    body: string | null;
     /**
-     * 3-character string: an exact HTTP code (e.g. `"200"`, `"204"`) or a
-     * class (`"2xx"`, `"3xx"`, `"4xx"`, `"5xx"`).
+     * Either an exact HTTP code (e.g. `"200"`, `"204"`) or a status class
+     * (`"1xx"`, `"2xx"`, `"3xx"`, `"4xx"`, `"5xx"`).
      */
     successStatus: string;
 }
+/**
+ * Engine used to evaluate {@link Forwarder.transform}. Must be set
+ * whenever `transform` is set. Today only `JSONATA` is supported.
+ */
+type TransformType = "JSONATA";
 interface Forwarder {
+    /** UUID assigned by the server at creation time. */
     id: string;
     name: string;
-    slug: string;
+    /** Free-text description for the forwarder. */
+    description: string | null;
     forwarderType: ForwarderType;
     enabled: boolean;
     filter: Record<string, unknown> | null;
-    transform: string | null;
-    /** Header values are returned redacted on reads. */
-    http: ForwarderHttp;
+    /**
+     * Engine used to evaluate {@link transform}. Paired 1:1 with
+     * `transform` — both set, or both `null`.
+     */
+    transformType: TransformType | null;
+    /**
+     * Template applied to each event before delivery. Shape depends on
+     * {@link transformType}; for `JSONATA`, a string containing a JSONata
+     * expression. `null` when no transform is configured.
+     */
+    transform: unknown | null;
+    /**
+     * Transport-specific delivery configuration. Header values are
+     * returned redacted on reads.
+     */
+    configuration: HttpConfiguration;
     createdAt: string | null;
     updatedAt: string | null;
     deletedAt: string | null;
@@ -135,10 +162,13 @@ interface Forwarder {
 interface CreateForwarderInput {
     name: string;
     forwarderType: ForwarderType;
-    http: ForwarderHttp;
+    configuration: HttpConfiguration;
     enabled?: boolean;
+    description?: string;
     filter?: Record<string, unknown>;
-    transform?: string;
+    /** Required when {@link transform} is set; today must be `"JSONATA"`. */
+    transformType?: TransformType;
+    transform?: unknown;
 }
 interface UpdateForwarderInput extends CreateForwarderInput {
 }

package/dist/index.js

@@ -19866,16 +19866,15 @@ function _paginationFromBody2(body) {
   }
   return out;
 }
-function _httpToWire(http) {
+function _configurationToWire(config) {
   return {
-    method: http.method,
-    url: http.url,
-    headers: http.headers.map((h) => ({ name: h.name, value: h.value })),
-    body: http.body,
-    success_status: http.successStatus
+    method: config.method,
+    url: config.url,
+    headers: config.headers.map((h) => ({ name: h.name, value: h.value })),
+    success_status: config.successStatus
   };
 }
-function _httpFromWire(raw) {
+function _configurationFromWire(raw) {
   const r = raw ?? {};
   const headers = (r.headers ?? []).map((h) => ({
     name: String(h.name ?? ""),
@@ -19885,7 +19884,6 @@ function _httpFromWire(raw) {
     method: String(r.method ?? "POST"),
     url: String(r.url ?? ""),
     headers,
-    body: r.body ?? null,
     successStatus: String(r.success_status ?? "2xx")
   };
 }
@@ -19894,11 +19892,13 @@ function _forwarderAttributes(input) {
     name: input.name,
     forwarder_type: input.forwarderType,
     enabled: input.enabled ?? true,
-    http: _httpToWire(input.http)
+    configuration: _configurationToWire(input.configuration)
   };
+  if (input.description !== void 0) attrs.description = input.description;
   if (input.filter !== void 0) {
     attrs.filter = input.filter;
   }
+  if (input.transformType !== void 0) attrs.transform_type = input.transformType;
   if (input.transform !== void 0) attrs.transform = input.transform;
   return attrs;
 }
@@ -19907,12 +19907,13 @@ function _forwarderFromResource(resource) {
   return {
     id: resource.id,
     name: String(a.name ?? ""),
-    slug: String(a.slug ?? ""),
+    description: a.description ?? null,
     forwarderType: a.forwarder_type,
     enabled: Boolean(a.enabled ?? true),
     filter: a.filter ?? null,
+    transformType: a.transform_type ?? null,
     transform: a.transform ?? null,
-    http: _httpFromWire(a.http),
+    configuration: _configurationFromWire(a.configuration),
     createdAt: a.created_at ?? null,
     updatedAt: a.updated_at ?? null,
     deletedAt: a.deleted_at ?? null,