cribl-control-plane 0.5.0-beta.9 → 0.5.0-rc.10

package/src/lib/config.ts

@@ -61,9 +61,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "4.16.0-alpha.1767654263427-c6413233",
-  sdkVersion: "0.5.0-beta.9",
-  genVersion: "2.778.0",
+  openapiDocVersion: "4.16.0-alpha.1767808351351-326f0624",
+  sdkVersion: "0.5.0-rc.10",
+  genVersion: "2.791.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.5.0-beta.9 2.778.0 4.16.0-alpha.1767654263427-c6413233 cribl-control-plane",
+    "speakeasy-sdk/typescript 0.5.0-rc.10 2.791.1 4.16.0-alpha.1767808351351-326f0624 cribl-control-plane",
 } as const;

package/src/lib/jsonl.ts

@@ -0,0 +1,127 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+const LF = 0x0a;
+const CR = 0x0d;
+const RIGHT_BRACE = 0x7d;
+const MESSAGE_BOUNDARIES = [
+  new Uint8Array([RIGHT_BRACE, CR, LF]),
+  new Uint8Array([RIGHT_BRACE, LF]),
+];
+
+export class JsonLStream<Event> {
+  private readonly stream: ReadableStream<Uint8Array>;
+  private readonly decoder: (rawEvent: string) => Event;
+
+  constructor(init: {
+    stream: ReadableStream<Uint8Array>;
+    decoder: (rawEvent: string) => Event;
+  }) {
+    this.stream = init.stream;
+    this.decoder = init.decoder;
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<Event, void, unknown> {
+    const reader = this.stream.getReader();
+    let buffer = new Uint8Array([]);
+    let position = 0;
+
+    try {
+      while (true) {
+        const { done, value } = await reader.read();
+        if (done) {
+          break;
+        }
+
+        const newBuffer = new Uint8Array(buffer.length + value.length);
+        newBuffer.set(buffer);
+        newBuffer.set(value, buffer.length);
+        buffer = newBuffer;
+
+        for (let i = position; i < buffer.length; i++) {
+          const boundary = findBoundary(buffer, i);
+          if (boundary == null) {
+            continue;
+          }
+
+          const chunk = buffer.slice(position, i + 1);
+          position = i + boundary.length;
+          const event = parseEvent(chunk, this.decoder);
+          if (event != null) {
+            yield event;
+          }
+        }
+
+        if (position > 0) {
+          buffer = buffer.slice(position);
+          position = 0;
+        }
+      }
+
+      if (buffer.length > 0) {
+        const event = parseEvent(buffer, this.decoder);
+        if (event != null) {
+          yield event;
+        }
+      }
+    } catch (e: unknown) {
+      if (e instanceof Error && e.name === "AbortError") {
+        return;
+      }
+
+      throw e;
+    } finally {
+      reader.releaseLock();
+    }
+  }
+}
+
+function findBoundary(buffer: Uint8Array, start: number): Uint8Array | null {
+  for (const s of MESSAGE_BOUNDARIES) {
+    const seq = peekSequence(start, buffer, s);
+    if (seq != null) {
+      return seq;
+    }
+  }
+
+  return null;
+}
+
+function peekSequence(
+  position: number,
+  buffer: Uint8Array,
+  sequence: Uint8Array,
+): Uint8Array | null {
+  if (sequence.length > buffer.length - position) {
+    return null;
+  }
+
+  for (let i = 0; i < sequence.length; i++) {
+    if (buffer[position + i] !== sequence[i]) {
+      return null;
+    }
+  }
+
+  return sequence;
+}
+
+function parseEvent<Event>(
+  chunk: Uint8Array,
+  decoder: (rawEvent: string) => Event,
+) {
+  if (!chunk.length) {
+    return null;
+  }
+
+  const td = new TextDecoder();
+  const raw = td.decode(chunk);
+
+  try {
+    const parsed = JSON.parse(raw);
+    return decoder(parsed);
+  } catch (e) {
+    console.error("Error parsing JSON:", e);
+    return null;
+  }
+}

package/src/models/capturelevel.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+export const CaptureLevel = {
+  Zero: 0,
+  One: 1,
+  Two: 2,
+  Three: 3,
+} as const;
+export type CaptureLevel = OpenEnum<typeof CaptureLevel>;
+
+/** @internal */
+export const CaptureLevel$outboundSchema: z.ZodType<
+  number,
+  z.ZodTypeDef,
+  CaptureLevel
+> = openEnums.outboundSchemaInt(CaptureLevel);

package/src/models/captureparams.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { CaptureLevel, CaptureLevel$outboundSchema } from "./capturelevel.js";
+
+export type CaptureParams = {
+  duration: number;
+  filter: string;
+  level: CaptureLevel;
+  maxEvents: number;
+  stepDuration?: number | undefined;
+  workerId?: string | undefined;
+  workerThreshold?: number | undefined;
+};
+
+/** @internal */
+export type CaptureParams$Outbound = {
+  duration: number;
+  filter: string;
+  level: number;
+  maxEvents: number;
+  stepDuration?: number | undefined;
+  workerId?: string | undefined;
+  workerThreshold?: number | undefined;
+};
+
+/** @internal */
+export const CaptureParams$outboundSchema: z.ZodType<
+  CaptureParams$Outbound,
+  z.ZodTypeDef,
+  CaptureParams
+> = z.object({
+  duration: z.number(),
+  filter: z.string(),
+  level: CaptureLevel$outboundSchema,
+  maxEvents: z.number(),
+  stepDuration: z.number().optional(),
+  workerId: z.string().optional(),
+  workerThreshold: z.number().optional(),
+});
+
+export function captureParamsToJSON(captureParams: CaptureParams): string {
+  return JSON.stringify(CaptureParams$outboundSchema.parse(captureParams));
+}

package/src/models/criblevent.ts

@@ -7,7 +7,7 @@ import { remap as remap$ } from "../lib/primitives.js";
 
 export type CriblEvent = {
   raw: string;
-  additionalProperties?: { [k: string]: any } | undefined;
+  [additionalProperties: string]: unknown;
 };
 
 /** @internal */
@@ -23,13 +23,10 @@ export const CriblEvent$outboundSchema: z.ZodType<
   CriblEvent
 > = z.object({
   raw: z.string(),
-  additionalProperties: z.record(z.any()).optional(),
-}).transform((v) => {
+}).catchall(z.any()).transform((v) => {
   return {
-    ...v.additionalProperties,
     ...remap$(v, {
       raw: "_raw",
-      additionalProperties: null,
     }),
   };
 });

package/src/models/functionconfschemaaggregatemetrics.ts

@@ -32,7 +32,7 @@ export type FunctionConfSchemaAggregateMetricsAggregation = {
   /**
    * The output metric type
    */
-  metricType?: FunctionConfSchemaAggregateMetricsMetricType | undefined;
+  metricType: FunctionConfSchemaAggregateMetricsMetricType;
   /**
    * Aggregate function to perform on events. Example: sum(bytes).where(action=='REJECT').as(TotalBytes)
    */
@@ -51,15 +51,15 @@ export type FunctionConfSchemaAggregateMetrics = {
   /**
    * Pass through the original events along with the aggregation events
    */
-  passthrough?: boolean | undefined;
+  passthrough: boolean;
   /**
    * Preserve the structure of the original aggregation event's groupby fields
    */
-  preserveGroupBys?: boolean | undefined;
+  preserveGroupBys: boolean;
   /**
    * Output only statistics that are sufficient for the supplied aggregations
    */
-  sufficientStatsOnly?: boolean | undefined;
+  sufficientStatsOnly: boolean;
   /**
    * A prefix that is prepended to all of the fields output by this Aggregations Function
    */
@@ -67,7 +67,7 @@ export type FunctionConfSchemaAggregateMetrics = {
   /**
    * The time span of the tumbling window for aggregating events. Must be a valid time string (such as 10s).
    */
-  timeWindow?: string | undefined;
+  timeWindow: string;
   /**
    * Combination of Aggregation function and output metric type
    */
@@ -89,11 +89,11 @@ export type FunctionConfSchemaAggregateMetrics = {
   /**
    * Enable to retain aggregations for cumulative aggregations when flushing out an aggregation table event. When disabled (the default), aggregations are reset to 0 on flush.
    */
-  cumulative?: boolean | undefined;
+  cumulative: boolean;
   /**
    * Treat dots in dimension names as literals. This is useful for top-level dimensions that contain dots, such as 'service.name'.
    */
-  shouldTreatDotsAsLiterals?: boolean | undefined;
+  shouldTreatDotsAsLiterals: boolean;
   /**
    * Set of key-value pairs to evaluate and add/set
    */
@@ -101,7 +101,7 @@ export type FunctionConfSchemaAggregateMetrics = {
   /**
    * Flush aggregations when an input stream is closed. If disabled, Time Window Settings control flush behavior.
    */
-  flushOnInputClose?: boolean | undefined;
+  flushOnInputClose: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemaaggregation.ts

@@ -19,19 +19,19 @@ export type FunctionConfSchemaAggregation = {
   /**
    * Pass through the original events along with the aggregation events
    */
-  passthrough?: boolean | undefined;
+  passthrough: boolean;
   /**
    * Preserve the structure of the original aggregation event's groupby fields
    */
-  preserveGroupBys?: boolean | undefined;
+  preserveGroupBys: boolean;
   /**
    * Output only statistics that are sufficient for the supplied aggregations
    */
-  sufficientStatsOnly?: boolean | undefined;
+  sufficientStatsOnly: boolean;
   /**
    * Enable to output the aggregates as metrics. When disabled, aggregates are output as events.
    */
-  metricsMode?: boolean | undefined;
+  metricsMode: boolean;
   /**
    * A prefix that is prepended to all of the fields output by this Aggregations Function
    */
@@ -39,7 +39,7 @@ export type FunctionConfSchemaAggregation = {
   /**
    * The time span of the tumbling window for aggregating events. Must be a valid time string (such as 10s).
    */
-  timeWindow?: string | undefined;
+  timeWindow: string;
   /**
    * Aggregate function to perform on events. Example: sum(bytes).where(action=='REJECT').as(TotalBytes)
    */
@@ -59,7 +59,7 @@ export type FunctionConfSchemaAggregation = {
   /**
    * Enable to retain aggregations for cumulative aggregations when flushing out an aggregation table event. When disabled (the default), aggregations are reset to 0 on flush.
    */
-  cumulative?: boolean | undefined;
+  cumulative: boolean;
   /**
    * Allows Cribl Search-specific aggregation configuration
    */
@@ -71,11 +71,11 @@ export type FunctionConfSchemaAggregation = {
   /**
    * Treat dots in dimension names as literals. This is useful for top-level dimensions that contain dots, such as 'service.name'.
    */
-  shouldTreatDotsAsLiterals?: boolean | undefined;
+  shouldTreatDotsAsLiterals: boolean;
   /**
    * Flush aggregations when an input stream is closed. If disabled, Time Window Settings control flush behavior.
    */
-  flushOnInputClose?: boolean | undefined;
+  flushOnInputClose: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemacef.ts

@@ -27,7 +27,7 @@ export type FunctionConfSchemaCef = {
   /**
    * The field to which the CEF formatted event will be output
    */
-  outputField?: string | undefined;
+  outputField: string;
   /**
    * Set of header key/value pairs
    */

package/src/models/functionconfschemadistinct.ts

@@ -15,15 +15,15 @@ export type FunctionConfSchemaDistinct = {
   /**
    * maximum number of tracked combinations
    */
-  maxCombinations?: number | undefined;
+  maxCombinations: number;
   /**
    * maximum number of groupBy properties
    */
-  maxDepth?: number | undefined;
+  maxDepth: number;
   /**
    * indicator that the operator runs on a federated executor
    */
-  isFederated?: boolean | undefined;
+  isFederated: boolean;
   /**
    * Toggle this on to suppress generating previews of intermediate results
    */

package/src/models/functionconfschemadnslookup.ts

@@ -3,11 +3,7 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../lib/primitives.js";
-import {
-  collectExtraKeys as collectExtraKeys$,
-  safeParse,
-} from "../lib/schemas.js";
+import { safeParse } from "../lib/schemas.js";
 import * as openEnums from "../types/enums.js";
 import { OpenEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
@@ -150,7 +146,7 @@ export type FunctionConfSchemaDnsLookup = {
    */
   domainOverrides?: Array<string> | undefined;
   lookupFailLogLevel?: LogLevelForFailedLookups | undefined;
-  additionalProperties?: { [k: string]: any } | undefined;
+  [additionalProperties: string]: unknown;
 };
 
 /** @internal */
@@ -267,23 +263,19 @@ export const FunctionConfSchemaDnsLookup$inboundSchema: z.ZodType<
   FunctionConfSchemaDnsLookup,
   z.ZodTypeDef,
   unknown
-> = collectExtraKeys$(
-  z.object({
-    dnsLookupFields: z.array(z.lazy(() => DnsLookupField$inboundSchema))
-      .optional(),
-    reverseLookupFields: z.array(z.lazy(() => ReverseLookupField$inboundSchema))
-      .optional(),
-    dnsServers: z.array(z.string()).optional(),
-    cacheTTL: z.number().default(30),
-    maxCacheSize: z.number().default(5000),
-    useResolvConf: z.boolean().default(false),
-    lookupFallback: z.boolean().default(false),
-    domainOverrides: z.array(z.string()).optional(),
-    lookupFailLogLevel: LogLevelForFailedLookups$inboundSchema.default("error"),
-  }).catchall(z.any()),
-  "additionalProperties",
-  true,
-);
+> = z.object({
+  dnsLookupFields: z.array(z.lazy(() => DnsLookupField$inboundSchema))
+    .optional(),
+  reverseLookupFields: z.array(z.lazy(() => ReverseLookupField$inboundSchema))
+    .optional(),
+  dnsServers: z.array(z.string()).optional(),
+  cacheTTL: z.number().default(30),
+  maxCacheSize: z.number().default(5000),
+  useResolvConf: z.boolean().default(false),
+  lookupFallback: z.boolean().default(false),
+  domainOverrides: z.array(z.string()).optional(),
+  lookupFailLogLevel: LogLevelForFailedLookups$inboundSchema.default("error"),
+}).catchall(z.any());
 /** @internal */
 export type FunctionConfSchemaDnsLookup$Outbound = {
   dnsLookupFields?: Array<DnsLookupField$Outbound> | undefined;
@@ -315,15 +307,7 @@ export const FunctionConfSchemaDnsLookup$outboundSchema: z.ZodType<
   lookupFallback: z.boolean().default(false),
   domainOverrides: z.array(z.string()).optional(),
   lookupFailLogLevel: LogLevelForFailedLookups$outboundSchema.default("error"),
-  additionalProperties: z.record(z.any()).optional(),
-}).transform((v) => {
-  return {
-    ...v.additionalProperties,
-    ...remap$(v, {
-      additionalProperties: null,
-    }),
-  };
-});
+}).catchall(z.any());
 
 export function functionConfSchemaDnsLookupToJSON(
   functionConfSchemaDnsLookup: FunctionConfSchemaDnsLookup,

package/src/models/functionconfschemadropdimensions.ts

@@ -11,7 +11,7 @@ export type FunctionConfSchemaDropDimensions = {
   /**
    * The time span of the tumbling window for aggregating events. Must be a valid time string (such as 10s).
    */
-  timeWindow?: string | undefined;
+  timeWindow: string;
   /**
    * One or more dimensions to be dropped. Supports wildcard expressions. Warning: Using wildcard '*' causes all dimensions in the event to be dropped.
    */
@@ -19,7 +19,7 @@ export type FunctionConfSchemaDropDimensions = {
   /**
    * Flush aggregations when an input stream is closed. If disabled, aggregations are flushed based on Time Window Settings instead.
    */
-  flushOnInputClose?: boolean | undefined;
+  flushOnInputClose: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemadynamicsampling.ts

@@ -33,23 +33,23 @@ export type FunctionConfSchemaDynamicSampling = {
   /**
    * Defines how sample rate will be derived: log(previousPeriodCount) or sqrt(previousPeriodCount)
    */
-  mode?: FunctionConfSchemaDynamicSamplingSampleMode | undefined;
+  mode: FunctionConfSchemaDynamicSamplingSampleMode;
   /**
    * Expression used to derive sample group key. Example:`${domain}:${status}`. Each sample group will have its own derived sampling rate based on volume. Defaults to `${host}`.
    */
-  keyExpr?: string | undefined;
+  keyExpr: string;
   /**
    * How often (in seconds) sample rates will be adjusted
    */
-  samplePeriod?: number | undefined;
+  samplePeriod: number;
   /**
    * Minimum number of events that must be received in previous sample period for sampling mode to be applied to current period. If the number of events received for a sample group is less than this minimum, a sample rate of 1:1 is used.
    */
-  minEvents?: number | undefined;
+  minEvents: number;
   /**
    * Maximum sampling rate. If computed sampling rate is above this value, it will be limited to this value.
    */
-  maxSampleRate?: number | undefined;
+  maxSampleRate: number;
 };
 
 /** @internal */

package/src/models/functionconfschemaeventbreaker.ts

@@ -24,11 +24,11 @@ export type FunctionConfSchemaEventBreakerExistingOrNew = OpenEnum<
 >;
 
 export type FunctionConfSchemaEventBreaker = {
-  existingOrNew?: FunctionConfSchemaEventBreakerExistingOrNew | undefined;
+  existingOrNew: FunctionConfSchemaEventBreakerExistingOrNew;
   /**
    * Add this Function name to the cribl_breaker field
    */
-  shouldMarkCriblBreaker?: boolean | undefined;
+  shouldMarkCriblBreaker: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemaeventstats.ts

@@ -19,11 +19,11 @@ export type FunctionConfSchemaEventstats = {
   /**
    * Specifies how many events are at max kept in memory to be enriched with aggregations
    */
-  maxEvents?: number | undefined;
+  maxEvents: number;
   /**
    * Determines if aggregations should flush when an input stream is closed. If disabled, time window settings will control flush behavior.
    */
-  flushOnInputClose?: boolean | undefined;
+  flushOnInputClose: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemageoip.ts

@@ -31,11 +31,11 @@ export type FunctionConfSchemaGeoip = {
   /**
    * Field name in which to find an IP to look up. Can be nested.
    */
-  inField?: string | undefined;
+  inField: string;
   /**
    * Field name in which to store the GeoIP lookup results
    */
-  outField?: string | undefined;
+  outField: string;
   additionalFields?: Array<FunctionConfSchemaGeoipAdditionalField> | undefined;
   /**
    * Search-specific mappings for granular control over event enrichment

package/src/models/functionconfschemagrok.ts

@@ -23,7 +23,7 @@ export type FunctionConfSchemaGrok = {
   /**
    * Field on which to perform Grok extractions
    */
-  source?: string | undefined;
+  source: string;
 };
 
 /** @internal */

package/src/models/functionconfschemahandlebars.ts

@@ -23,7 +23,7 @@ export type FunctionConfSchemaHandlebarsTemplateDefinition = {
   /**
    * Type categorization for the template (e.g., Universal, Email, Slack)
    */
-  type?: string | undefined;
+  type: string;
 };
 
 export type FunctionConfSchemaHandlebars = {
@@ -34,15 +34,15 @@ export type FunctionConfSchemaHandlebars = {
   /**
    * Field name to store the rendered template result. Defaults to _raw.
    */
-  targetField?: string | undefined;
+  targetField: string;
   /**
    * Parse the rendered template as JSON and store as an object instead of a string. Useful for building structured data like Slack blocks.
    */
-  parseJson?: boolean | undefined;
+  parseJson: boolean;
   /**
    * Remove the target field if the rendered result is empty or null.
    */
-  removeOnNull?: boolean | undefined;
+  removeOnNull: boolean;
 };
 
 /** @internal */

package/src/models/functionconfschemalakeexport.ts

@@ -19,15 +19,15 @@ export type FunctionConfSchemaLakeExport = {
   /**
    * Name of the lake
    */
-  lake?: string | undefined;
+  lake: string;
   /**
    * Tee results to search. When set to true results will be shipped instead of stats
    */
-  tee?: string | undefined;
+  tee: string;
   /**
    * How often are stats flushed in ms
    */
-  flushMs?: number | undefined;
+  flushMs: number;
   /**
    * Disables generation of intermediate stats. When true stats will be emitted only on end
    */

package/src/models/functionconfschemalookup.ts

@@ -41,7 +41,7 @@ export type FunctionConfSchemaLookup = {
   /**
    * Enable to use a disk-based lookup. This option displays only the settings relevant to disk-based mode and hides those for in-memory lookups.
    */
-  dbLookup?: boolean | undefined;
+  dbLookup: boolean;
   matchMode?: any | undefined;
   matchType?: any | undefined;
   reloadPeriodSec?: any | undefined;
@@ -56,7 +56,7 @@ export type FunctionConfSchemaLookup = {
   /**
    * Add the looked-up values to _raw, as key=value pairs
    */
-  addToEvent?: boolean | undefined;
+  addToEvent: boolean;
   ignoreCase?: any | undefined;
 };
 

package/src/models/functionconfschemamask.ts

@@ -15,11 +15,11 @@ export type FunctionConfSchemaMaskRule = {
   /**
    * A JavaScript expression or literal to replace the matching content. Capturing groups can be referenced as g1, g2, and so on, and event fields as event.<fieldName>.
    */
-  replaceExpr?: string | undefined;
+  replaceExpr: string;
   /**
    * Set to No to disable the evaluation of an individual rule
    */
-  disabled?: boolean | undefined;
+  disabled: boolean;
 };
 
 export type FunctionConfSchemaMaskFlag = {
@@ -39,7 +39,7 @@ export type FunctionConfSchemaMask = {
   /**
    * Depth to which the Mask Function will search for fields to mask
    */
-  depth?: number | undefined;
+  depth: number;
   /**
    * Fields to evaluate if one or more masking rules are matched
    */

package/src/models/functionconfschemamvexpand.ts

@@ -41,7 +41,7 @@ export type FunctionConfSchemaMvExpand = {
   /**
    * max. number of rows generated out of every source events
    */
-  rowLimit?: number | undefined;
+  rowLimit: number;
   /**
    * name of an optional index property generated into the output
    */
@@ -49,7 +49,7 @@ export type FunctionConfSchemaMvExpand = {
   /**
    * decides if bag-values are expanded to bags or arrays
    */
-  bagExpansionMode?: FunctionConfSchemaMvExpandBagExpansionMode | undefined;
+  bagExpansionMode: FunctionConfSchemaMvExpandBagExpansionMode;
 };
 
 /** @internal */