@smplkit/sdk 3.0.54 → 3.0.56

package/dist/index.d.cts

@@ -22,20 +22,21 @@ interface AuditEvent {
     /** ISO-8601-with-offset timestamp of when the audit service ingested the event. */
     createdAt: string;
     /**
-     * Type of the actor that performed the action (`"user"`, `"api_key"`,
-     * `"system"`, …). Empty string when unknown.
+     * Kind of actor that caused the event — e.g. `"USER"`, `"API_KEY"`,
+     * `"SYSTEM"`, or any label the caller chose. `null` when the caller
+     * did not supply one; the audit service never backfills.
      */
-    actorType: string;
+    actorType: string | null;
     /**
-     * UUID of the actor, when the actor is a tracked entity
-     * (user, api_key). `null` for system actors or anonymous events.
+     * Identifier of the actor that caused the event. Free-form — any
+     * identifier scheme is accepted. `null` when not supplied.
      */
     actorId: string | null;
     /**
-     * Display label for the actor — typically a name or email. Empty
-     * string when unknown.
+     * Human-readable label for the actor (e.g. an email address or API
+     * key name). `null` when not supplied.
      */
-    actorLabel: string;
+    actorLabel: string | null;
     /**
      * Free-form per-event payload defined by the customer. Surfaced on
      * the audit-event resource as a structured JSONB column.
@@ -61,6 +62,17 @@ interface CreateEventInput {
     resourceId: string;
     /** Defaults to server-side `now()` if omitted. */
     occurredAt?: Date | string;
+    /**
+     * Free-form label for the kind of actor that caused the event (e.g.
+     * `"USER"`, `"API_KEY"`, `"SYSTEM"`, or any custom value). The audit
+     * service never backfills this from the request credential — supply
+     * it explicitly when you want the event attributed.
+     */
+    actorType?: string;
+    /** Free-form identifier of the actor. Any string scheme is accepted. */
+    actorId?: string;
+    /** Human-readable label for the actor (e.g. email or API key name). */
+    actorLabel?: string;
     /**
      * Free-form contextual JSON. To record a resource snapshot, nest it
      * inside `data` — smplkit's internal convention is `data.snapshot`,
@@ -293,14 +305,19 @@ declare class Forwarder {
     filter: Record<string, unknown> | null;
     /**
      * Optional template applied to each event before delivery. Shape
-     * depends on {@link transformType}; for `"JSONATA"`, a JSONata
-     * expression string. `null` delivers the event JSON as-is.
+     * depends on {@link transformType}; for {@link TransformType.JSONATA}
+     * the value is a JSONata expression string, but the wire schema
+     * widens to arbitrary JSON to leave room for future transform engines
+     * carrying structured templates. `null` delivers the event JSON as-is.
+     *
+     * Whenever {@link transform} is set, {@link transformType} must also
+     * be set; the SDK enforces this at save time.
      */
-    transform: string | null;
+    transform: unknown;
     /**
-     * Engine used to evaluate {@link transform}. Currently only
-     * `"JSONATA"` is supported. Auto-filled by the SDK whenever
-     * {@link transform} is set on save.
+     * Engine used to evaluate {@link transform}. Required whenever
+     * {@link transform} is set. Today only {@link TransformType.JSONATA}
+     * is supported.
      */
     transformType: TransformType | null;
     /**
@@ -324,7 +341,7 @@ declare class Forwarder {
         enabled?: boolean;
         description?: string | null;
         filter?: Record<string, unknown> | null;
-        transform?: string | null;
+        transform?: unknown;
         transformType?: TransformType | null;
         createdAt?: string | null;
         updatedAt?: string | null;
@@ -2849,18 +2866,19 @@ declare class ManagementFlagsClient {
 /**
  * Log severity levels used by the Smpl Logging service.
  *
- * Members are declared in alphabetical order. Severity ordering is not
- * derived from declaration order — it lives in the framework adapter
- * code that maps these to each framework's native numeric level.
+ * Members are declared in increasing order of severity per the
+ * convention of every major JS/TS logging library (winston, bunyan,
+ * pino, npm). `SILENT` is the all-suppressing sentinel and sits at
+ * the end.
  */
 declare enum LogLevel {
+    TRACE = "TRACE",
     DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARN = "WARN",
     ERROR = "ERROR",
     FATAL = "FATAL",
-    INFO = "INFO",
-    SILENT = "SILENT",
-    TRACE = "TRACE",
-    WARN = "WARN"
+    SILENT = "SILENT"
 }
 /**
  * Describes a logger effective-level change. Frozen — fields cannot be
@@ -3180,20 +3198,27 @@ declare class ForwardersClient implements ForwarderModelClient {
      * Construct an unsaved {@link Forwarder}. Call {@link Forwarder.save}
      * to persist.
      *
-     * @param fields.name           Display name. Free-form.
-     * @param fields.forwarderType  Destination type — see {@link ForwarderType}.
-     * @param fields.configuration  Destination HTTP request configuration.
-     *                              Headers carry credentials and are
-     *                              encrypted at rest server-side; reads
-     *                              return them redacted.
-     * @param fields.enabled        Whether the forwarder is active. Defaults true.
-     * @param fields.description    Optional free-text description.
-     * @param fields.filter         Optional JSON Logic filter; events that
-     *                              don't match are recorded as
-     *                              `filtered_out` deliveries.
-     * @param fields.transform      Optional JSONata template applied to
-     *                              the event payload before POST. `null`
-     *                              delivers the event as-is.
+     * @param fields.name            Display name. Free-form.
+     * @param fields.forwarderType   Destination type — see {@link ForwarderType}.
+     * @param fields.configuration   Destination HTTP request configuration.
+     *                               Headers carry credentials and are
+     *                               encrypted at rest server-side; reads
+     *                               return them redacted.
+     * @param fields.enabled         Whether the forwarder is active. Defaults true.
+     * @param fields.description     Optional free-text description.
+     * @param fields.filter          Optional JSON Logic filter; events that
+     *                               don't match are recorded as
+     *                               `filtered_out` deliveries.
+     * @param fields.transformType   Engine used to evaluate `transform`.
+     *                               Required whenever `transform` is set;
+     *                               today only {@link TransformType.JSONATA}
+     *                               is supported.
+     * @param fields.transform       Optional template applied to each
+     *                               event before delivery. The value is
+     *                               arbitrary JSON — for JSONATA, supply
+     *                               an expression string; future engines
+     *                               may accept other shapes. Omit (or pass
+     *                               `null`) to deliver events unchanged.
      */
     new(fields: {
         name: string;
@@ -3202,7 +3227,8 @@ declare class ForwardersClient implements ForwarderModelClient {
         enabled?: boolean;
         description?: string | null;
         filter?: Record<string, unknown> | null;
-        transform?: string | null;
+        transformType?: TransformType | null;
+        transform?: unknown;
     }): Forwarder;
     /**
      * List forwarders for the authenticated account.

package/dist/index.d.ts

@@ -22,20 +22,21 @@ interface AuditEvent {
     /** ISO-8601-with-offset timestamp of when the audit service ingested the event. */
     createdAt: string;
     /**
-     * Type of the actor that performed the action (`"user"`, `"api_key"`,
-     * `"system"`, …). Empty string when unknown.
+     * Kind of actor that caused the event — e.g. `"USER"`, `"API_KEY"`,
+     * `"SYSTEM"`, or any label the caller chose. `null` when the caller
+     * did not supply one; the audit service never backfills.
      */
-    actorType: string;
+    actorType: string | null;
     /**
-     * UUID of the actor, when the actor is a tracked entity
-     * (user, api_key). `null` for system actors or anonymous events.
+     * Identifier of the actor that caused the event. Free-form — any
+     * identifier scheme is accepted. `null` when not supplied.
      */
     actorId: string | null;
     /**
-     * Display label for the actor — typically a name or email. Empty
-     * string when unknown.
+     * Human-readable label for the actor (e.g. an email address or API
+     * key name). `null` when not supplied.
      */
-    actorLabel: string;
+    actorLabel: string | null;
     /**
      * Free-form per-event payload defined by the customer. Surfaced on
      * the audit-event resource as a structured JSONB column.
@@ -61,6 +62,17 @@ interface CreateEventInput {
     resourceId: string;
     /** Defaults to server-side `now()` if omitted. */
     occurredAt?: Date | string;
+    /**
+     * Free-form label for the kind of actor that caused the event (e.g.
+     * `"USER"`, `"API_KEY"`, `"SYSTEM"`, or any custom value). The audit
+     * service never backfills this from the request credential — supply
+     * it explicitly when you want the event attributed.
+     */
+    actorType?: string;
+    /** Free-form identifier of the actor. Any string scheme is accepted. */
+    actorId?: string;
+    /** Human-readable label for the actor (e.g. email or API key name). */
+    actorLabel?: string;
     /**
      * Free-form contextual JSON. To record a resource snapshot, nest it
      * inside `data` — smplkit's internal convention is `data.snapshot`,
@@ -293,14 +305,19 @@ declare class Forwarder {
     filter: Record<string, unknown> | null;
     /**
      * Optional template applied to each event before delivery. Shape
-     * depends on {@link transformType}; for `"JSONATA"`, a JSONata
-     * expression string. `null` delivers the event JSON as-is.
+     * depends on {@link transformType}; for {@link TransformType.JSONATA}
+     * the value is a JSONata expression string, but the wire schema
+     * widens to arbitrary JSON to leave room for future transform engines
+     * carrying structured templates. `null` delivers the event JSON as-is.
+     *
+     * Whenever {@link transform} is set, {@link transformType} must also
+     * be set; the SDK enforces this at save time.
      */
-    transform: string | null;
+    transform: unknown;
     /**
-     * Engine used to evaluate {@link transform}. Currently only
-     * `"JSONATA"` is supported. Auto-filled by the SDK whenever
-     * {@link transform} is set on save.
+     * Engine used to evaluate {@link transform}. Required whenever
+     * {@link transform} is set. Today only {@link TransformType.JSONATA}
+     * is supported.
      */
     transformType: TransformType | null;
     /**
@@ -324,7 +341,7 @@ declare class Forwarder {
         enabled?: boolean;
         description?: string | null;
         filter?: Record<string, unknown> | null;
-        transform?: string | null;
+        transform?: unknown;
         transformType?: TransformType | null;
         createdAt?: string | null;
         updatedAt?: string | null;
@@ -2849,18 +2866,19 @@ declare class ManagementFlagsClient {
 /**
  * Log severity levels used by the Smpl Logging service.
  *
- * Members are declared in alphabetical order. Severity ordering is not
- * derived from declaration order — it lives in the framework adapter
- * code that maps these to each framework's native numeric level.
+ * Members are declared in increasing order of severity per the
+ * convention of every major JS/TS logging library (winston, bunyan,
+ * pino, npm). `SILENT` is the all-suppressing sentinel and sits at
+ * the end.
  */
 declare enum LogLevel {
+    TRACE = "TRACE",
     DEBUG = "DEBUG",
+    INFO = "INFO",
+    WARN = "WARN",
     ERROR = "ERROR",
     FATAL = "FATAL",
-    INFO = "INFO",
-    SILENT = "SILENT",
-    TRACE = "TRACE",
-    WARN = "WARN"
+    SILENT = "SILENT"
 }
 /**
  * Describes a logger effective-level change. Frozen — fields cannot be
@@ -3180,20 +3198,27 @@ declare class ForwardersClient implements ForwarderModelClient {
      * Construct an unsaved {@link Forwarder}. Call {@link Forwarder.save}
      * to persist.
      *
-     * @param fields.name           Display name. Free-form.
-     * @param fields.forwarderType  Destination type — see {@link ForwarderType}.
-     * @param fields.configuration  Destination HTTP request configuration.
-     *                              Headers carry credentials and are
-     *                              encrypted at rest server-side; reads
-     *                              return them redacted.
-     * @param fields.enabled        Whether the forwarder is active. Defaults true.
-     * @param fields.description    Optional free-text description.
-     * @param fields.filter         Optional JSON Logic filter; events that
-     *                              don't match are recorded as
-     *                              `filtered_out` deliveries.
-     * @param fields.transform      Optional JSONata template applied to
-     *                              the event payload before POST. `null`
-     *                              delivers the event as-is.
+     * @param fields.name            Display name. Free-form.
+     * @param fields.forwarderType   Destination type — see {@link ForwarderType}.
+     * @param fields.configuration   Destination HTTP request configuration.
+     *                               Headers carry credentials and are
+     *                               encrypted at rest server-side; reads
+     *                               return them redacted.
+     * @param fields.enabled         Whether the forwarder is active. Defaults true.
+     * @param fields.description     Optional free-text description.
+     * @param fields.filter          Optional JSON Logic filter; events that
+     *                               don't match are recorded as
+     *                               `filtered_out` deliveries.
+     * @param fields.transformType   Engine used to evaluate `transform`.
+     *                               Required whenever `transform` is set;
+     *                               today only {@link TransformType.JSONATA}
+     *                               is supported.
+     * @param fields.transform       Optional template applied to each
+     *                               event before delivery. The value is
+     *                               arbitrary JSON — for JSONATA, supply
+     *                               an expression string; future engines
+     *                               may accept other shapes. Omit (or pass
+     *                               `null`) to deliver events unchanged.
      */
     new(fields: {
         name: string;
@@ -3202,7 +3227,8 @@ declare class ForwardersClient implements ForwarderModelClient {
         enabled?: boolean;
         description?: string | null;
         filter?: Record<string, unknown> | null;
-        transform?: string | null;
+        transformType?: TransformType | null;
+        transform?: unknown;
     }): Forwarder;
     /**
      * List forwarders for the authenticated account.

package/dist/index.js

@@ -16856,6 +16856,9 @@ function _eventBodyFromInput(input) {
   if (input.occurredAt !== void 0) {
     attrs.occurred_at = input.occurredAt instanceof Date ? input.occurredAt.toISOString() : input.occurredAt;
   }
+  if (input.actorType !== void 0) attrs.actor_type = input.actorType;
+  if (input.actorId !== void 0) attrs.actor_id = input.actorId;
+  if (input.actorLabel !== void 0) attrs.actor_label = input.actorLabel;
   if (input.data !== void 0) {
     attrs.data = input.data;
   }
@@ -16870,9 +16873,9 @@ function _eventFromResource(resource) {
     resourceId: String(attrs.resource_id ?? ""),
     occurredAt: String(attrs.occurred_at ?? ""),
     createdAt: String(attrs.created_at ?? ""),
-    actorType: String(attrs.actor_type ?? ""),
+    actorType: attrs.actor_type ?? null,
     actorId: attrs.actor_id ?? null,
-    actorLabel: String(attrs.actor_label ?? ""),
+    actorLabel: attrs.actor_label ?? null,
     data: attrs.data ?? {},
     idempotencyKey: String(attrs.idempotency_key ?? ""),
     doNotForward: Boolean(attrs.do_not_forward ?? false)
@@ -19208,13 +19211,13 @@ function _coerceValues(values) {
 
 // src/logging/types.ts
 var LogLevel = /* @__PURE__ */ ((LogLevel5) => {
+  LogLevel5["TRACE"] = "TRACE";
   LogLevel5["DEBUG"] = "DEBUG";
+  LogLevel5["INFO"] = "INFO";
+  LogLevel5["WARN"] = "WARN";
   LogLevel5["ERROR"] = "ERROR";
   LogLevel5["FATAL"] = "FATAL";
-  LogLevel5["INFO"] = "INFO";
   LogLevel5["SILENT"] = "SILENT";
-  LogLevel5["TRACE"] = "TRACE";
-  LogLevel5["WARN"] = "WARN";
   return LogLevel5;
 })(LogLevel || {});
 var LoggerChangeEvent = class {
@@ -19891,14 +19894,19 @@ var Forwarder = class {
   filter;
   /**
    * Optional template applied to each event before delivery. Shape
-   * depends on {@link transformType}; for `"JSONATA"`, a JSONata
-   * expression string. `null` delivers the event JSON as-is.
+   * depends on {@link transformType}; for {@link TransformType.JSONATA}
+   * the value is a JSONata expression string, but the wire schema
+   * widens to arbitrary JSON to leave room for future transform engines
+   * carrying structured templates. `null` delivers the event JSON as-is.
+   *
+   * Whenever {@link transform} is set, {@link transformType} must also
+   * be set; the SDK enforces this at save time.
    */
   transform;
   /**
-   * Engine used to evaluate {@link transform}. Currently only
-   * `"JSONATA"` is supported. Auto-filled by the SDK whenever
-   * {@link transform} is set on save.
+   * Engine used to evaluate {@link transform}. Required whenever
+   * {@link transform} is set. Today only {@link TransformType.JSONATA}
+   * is supported.
    */
   transformType;
   /**
@@ -20029,8 +20037,12 @@ function _forwarderAttrs(forwarder) {
   if (forwarder.filter !== null) {
     attrs.filter = forwarder.filter;
   }
-  if (forwarder.transform !== null) {
-    attrs.transform_type = "JSONATA" /* JSONATA */;
+  const hasTransform = forwarder.transform !== null && forwarder.transform !== void 0;
+  if (hasTransform && forwarder.transformType === null) {
+    throw new Error("Forwarder.transform requires Forwarder.transformType to be set");
+  }
+  if (hasTransform) {
+    attrs.transform_type = forwarder.transformType;
     attrs.transform = forwarder.transform;
   }
   return attrs;
@@ -20062,20 +20074,27 @@ var ForwardersClient = class {
    * Construct an unsaved {@link Forwarder}. Call {@link Forwarder.save}
    * to persist.
    *
-   * @param fields.name           Display name. Free-form.
-   * @param fields.forwarderType  Destination type — see {@link ForwarderType}.
-   * @param fields.configuration  Destination HTTP request configuration.
-   *                              Headers carry credentials and are
-   *                              encrypted at rest server-side; reads
-   *                              return them redacted.
-   * @param fields.enabled        Whether the forwarder is active. Defaults true.
-   * @param fields.description    Optional free-text description.
-   * @param fields.filter         Optional JSON Logic filter; events that
-   *                              don't match are recorded as
-   *                              `filtered_out` deliveries.
-   * @param fields.transform      Optional JSONata template applied to
-   *                              the event payload before POST. `null`
-   *                              delivers the event as-is.
+   * @param fields.name            Display name. Free-form.
+   * @param fields.forwarderType   Destination type — see {@link ForwarderType}.
+   * @param fields.configuration   Destination HTTP request configuration.
+   *                               Headers carry credentials and are
+   *                               encrypted at rest server-side; reads
+   *                               return them redacted.
+   * @param fields.enabled         Whether the forwarder is active. Defaults true.
+   * @param fields.description     Optional free-text description.
+   * @param fields.filter          Optional JSON Logic filter; events that
+   *                               don't match are recorded as
+   *                               `filtered_out` deliveries.
+   * @param fields.transformType   Engine used to evaluate `transform`.
+   *                               Required whenever `transform` is set;
+   *                               today only {@link TransformType.JSONATA}
+   *                               is supported.
+   * @param fields.transform       Optional template applied to each
+   *                               event before delivery. The value is
+   *                               arbitrary JSON — for JSONATA, supply
+   *                               an expression string; future engines
+   *                               may accept other shapes. Omit (or pass
+   *                               `null`) to deliver events unchanged.
    */
   new(fields) {
     return new Forwarder(this, {
@@ -20085,6 +20104,7 @@ var ForwardersClient = class {
       enabled: fields.enabled,
       description: fields.description,
       filter: fields.filter,
+      transformType: fields.transformType,
       transform: fields.transform
     });
   }