cribl-control-plane 0.5.0-rc.1 → 0.5.0-rc.11

package/src/models/functionredis.ts

@@ -3,97 +3,18 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../lib/primitives.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";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
-
-export type Command = {
-  /**
-   * Name of the field in which to store the returned value. Leave blank to discard returned value.
-   */
-  outField?: string | undefined;
-  /**
-   * Redis command to perform. For a complete list visit: https://redis.io/commands
-   */
-  command: string;
-  /**
-   * A JavaScript expression to compute the value of the key to operate on. Can also be a constant such as 'username'.
-   */
-  keyExpr: string;
-  /**
-   * A JavaScript expression to compute arguments to the operation. Can return an array.
-   */
-  argsExpr?: string | undefined;
-};
-
-/**
- * How the Redis server is configured. Defaults to Standalone
- */
-export const DeploymentType = {
-  /**
-   * Standalone
-   */
-  Standalone: "standalone",
-  /**
-   * Cluster
-   */
-  Cluster: "cluster",
-  /**
-   * Sentinel
-   */
-  Sentinel: "sentinel",
-} as const;
-/**
- * How the Redis server is configured. Defaults to Standalone
- */
-export type DeploymentType = OpenEnum<typeof DeploymentType>;
-
-export const FunctionRedisAuthenticationMethod = {
-  /**
-   * None
-   */
-  None: "none",
-  /**
-   * Manual
-   */
-  Manual: "manual",
-  /**
-   * User Secret
-   */
-  CredentialsSecret: "credentialsSecret",
-  /**
-   * Admin Secret
-   */
-  TextSecret: "textSecret",
-} as const;
-export type FunctionRedisAuthenticationMethod = OpenEnum<
-  typeof FunctionRedisAuthenticationMethod
->;
-
-export type FunctionRedisSchema = {
-  commands?: Array<Command> | undefined;
-  /**
-   * How the Redis server is configured. Defaults to Standalone
-   */
-  deploymentType?: DeploymentType | undefined;
-  authType?: FunctionRedisAuthenticationMethod | undefined;
-  /**
-   * Maximum amount of time (seconds) to wait before assuming that Redis is down and passing events through. Use 0 to disable.
-   */
-  maxBlockSecs?: number | undefined;
-  /**
-   * Enable client-side cache. Redundant when using Redis write operations. See more options at Settings > General > Limits > Redis Cache.
-   */
-  enableClientSideCaching?: boolean | undefined;
-};
+import {
+  FunctionConfSchemaRedis,
+  FunctionConfSchemaRedis$inboundSchema,
+} from "./functionconfschemaredis.js";
 
 export type FunctionRedis = {
-  filename: string;
+  __filename: string;
   asyncTimeout?: number | undefined;
-  criblVersion?: string | undefined;
+  cribl_version?: string | undefined;
   disabled?: boolean | undefined;
   group: string;
   handleSignals?: boolean | undefined;
@@ -104,65 +25,9 @@ export type FunctionRedis = {
   sync?: boolean | undefined;
   uischema: { [k: string]: any };
   version: string;
-  schema?: FunctionRedisSchema | undefined;
+  schema?: FunctionConfSchemaRedis | undefined;
 };
 
-/** @internal */
-export const Command$inboundSchema: z.ZodType<Command, z.ZodTypeDef, unknown> =
-  z.object({
-    outField: z.string().optional(),
-    command: z.string(),
-    keyExpr: z.string(),
-    argsExpr: z.string().optional(),
-  });
-
-export function commandFromJSON(
-  jsonString: string,
-): SafeParseResult<Command, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Command$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Command' from JSON`,
-  );
-}
-
-/** @internal */
-export const DeploymentType$inboundSchema: z.ZodType<
-  DeploymentType,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(DeploymentType);
-
-/** @internal */
-export const FunctionRedisAuthenticationMethod$inboundSchema: z.ZodType<
-  FunctionRedisAuthenticationMethod,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(FunctionRedisAuthenticationMethod);
-
-/** @internal */
-export const FunctionRedisSchema$inboundSchema: z.ZodType<
-  FunctionRedisSchema,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  commands: z.array(z.lazy(() => Command$inboundSchema)).optional(),
-  deploymentType: DeploymentType$inboundSchema.default("standalone"),
-  authType: FunctionRedisAuthenticationMethod$inboundSchema.default("none"),
-  maxBlockSecs: z.number().default(60),
-  enableClientSideCaching: z.boolean().optional(),
-});
-
-export function functionRedisSchemaFromJSON(
-  jsonString: string,
-): SafeParseResult<FunctionRedisSchema, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FunctionRedisSchema$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FunctionRedisSchema' from JSON`,
-  );
-}
-
 /** @internal */
 export const FunctionRedis$inboundSchema: z.ZodType<
   FunctionRedis,
@@ -182,12 +47,7 @@ export const FunctionRedis$inboundSchema: z.ZodType<
   sync: z.boolean().optional(),
   uischema: z.record(z.any()),
   version: z.string(),
-  schema: z.lazy(() => FunctionRedisSchema$inboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "__filename": "filename",
-    "cribl_version": "criblVersion",
-  });
+  schema: FunctionConfSchemaRedis$inboundSchema.optional(),
 });
 
 export function functionRedisFromJSON(

package/src/models/functionregexextract.ts

@@ -3,46 +3,18 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
-
-export type FunctionRegexExtractRegexList = {
-  /**
-   * Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)
-   */
-  regex: string;
-};
-
-export type FunctionRegexExtractSchema = {
-  /**
-   * Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)
-   */
-  regex?: string | undefined;
-  regexList?: Array<FunctionRegexExtractRegexList> | undefined;
-  /**
-   * Field on which to perform regex field extraction
-   */
-  source?: string | undefined;
-  /**
-   * The maximum number of times to apply regex to source field when the global flag is set, or when using _NAME_ and _VALUE_ capturing groups
-   */
-  iterations?: number | undefined;
-  /**
-   * JavaScript expression to format field names when _NAME_n and _VALUE_n capturing groups are used. Original field name is in global variable 'name'. Example: To append XX to all field names, use `${name}_XX` (backticks are literal). If empty, names will be sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can access other fields values via __e.<fieldName>.
-   */
-  fieldNameExpression?: string | undefined;
-  /**
-   * Overwrite existing event fields with extracted values. If disabled, existing fields will be converted to an array.
-   */
-  overwrite?: boolean | undefined;
-};
+import {
+  FunctionConfSchemaRegexExtract,
+  FunctionConfSchemaRegexExtract$inboundSchema,
+} from "./functionconfschemaregexextract.js";
 
 export type FunctionRegexExtract = {
-  filename: string;
+  __filename: string;
   asyncTimeout?: number | undefined;
-  criblVersion?: string | undefined;
+  cribl_version?: string | undefined;
   disabled?: boolean | undefined;
   group: string;
   handleSignals?: boolean | undefined;
@@ -53,53 +25,9 @@ export type FunctionRegexExtract = {
   sync?: boolean | undefined;
   uischema: { [k: string]: any };
   version: string;
-  schema?: FunctionRegexExtractSchema | undefined;
+  schema?: FunctionConfSchemaRegexExtract | undefined;
 };
 
-/** @internal */
-export const FunctionRegexExtractRegexList$inboundSchema: z.ZodType<
-  FunctionRegexExtractRegexList,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  regex: z.string(),
-});
-
-export function functionRegexExtractRegexListFromJSON(
-  jsonString: string,
-): SafeParseResult<FunctionRegexExtractRegexList, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FunctionRegexExtractRegexList$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FunctionRegexExtractRegexList' from JSON`,
-  );
-}
-
-/** @internal */
-export const FunctionRegexExtractSchema$inboundSchema: z.ZodType<
-  FunctionRegexExtractSchema,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  regex: z.string().optional(),
-  regexList: z.array(z.lazy(() => FunctionRegexExtractRegexList$inboundSchema))
-    .optional(),
-  source: z.string().default("_raw"),
-  iterations: z.number().default(100),
-  fieldNameExpression: z.string().optional(),
-  overwrite: z.boolean().default(false),
-});
-
-export function functionRegexExtractSchemaFromJSON(
-  jsonString: string,
-): SafeParseResult<FunctionRegexExtractSchema, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FunctionRegexExtractSchema$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FunctionRegexExtractSchema' from JSON`,
-  );
-}
-
 /** @internal */
 export const FunctionRegexExtract$inboundSchema: z.ZodType<
   FunctionRegexExtract,
@@ -119,12 +47,7 @@ export const FunctionRegexExtract$inboundSchema: z.ZodType<
   sync: z.boolean().optional(),
   uischema: z.record(z.any()),
   version: z.string(),
-  schema: z.lazy(() => FunctionRegexExtractSchema$inboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "__filename": "filename",
-    "cribl_version": "criblVersion",
-  });
+  schema: FunctionConfSchemaRegexExtract$inboundSchema.optional(),
 });
 
 export function functionRegexExtractFromJSON(

package/src/models/functionregexfilter.ts

@@ -3,34 +3,18 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
-
-export type FunctionRegexFilterRegexList = {
-  /**
-   * Regex to test against
-   */
-  regex: string;
-};
-
-export type FunctionRegexFilterSchema = {
-  /**
-   * Regex to test against
-   */
-  regex?: string | undefined;
-  regexList?: Array<FunctionRegexFilterRegexList> | undefined;
-  /**
-   * Name of the field to apply the regex on (defaults to _raw)
-   */
-  field?: string | undefined;
-};
+import {
+  FunctionConfSchemaRegexFilter,
+  FunctionConfSchemaRegexFilter$inboundSchema,
+} from "./functionconfschemaregexfilter.js";
 
 export type FunctionRegexFilter = {
-  filename: string;
+  __filename: string;
   asyncTimeout?: number | undefined;
-  criblVersion?: string | undefined;
+  cribl_version?: string | undefined;
   disabled?: boolean | undefined;
   group: string;
   handleSignals?: boolean | undefined;
@@ -41,50 +25,9 @@ export type FunctionRegexFilter = {
   sync?: boolean | undefined;
   uischema: { [k: string]: any };
   version: string;
-  schema?: FunctionRegexFilterSchema | undefined;
+  schema?: FunctionConfSchemaRegexFilter | undefined;
 };
 
-/** @internal */
-export const FunctionRegexFilterRegexList$inboundSchema: z.ZodType<
-  FunctionRegexFilterRegexList,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  regex: z.string(),
-});
-
-export function functionRegexFilterRegexListFromJSON(
-  jsonString: string,
-): SafeParseResult<FunctionRegexFilterRegexList, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FunctionRegexFilterRegexList$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FunctionRegexFilterRegexList' from JSON`,
-  );
-}
-
-/** @internal */
-export const FunctionRegexFilterSchema$inboundSchema: z.ZodType<
-  FunctionRegexFilterSchema,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  regex: z.string().optional(),
-  regexList: z.array(z.lazy(() => FunctionRegexFilterRegexList$inboundSchema))
-    .optional(),
-  field: z.string().default("_raw"),
-});
-
-export function functionRegexFilterSchemaFromJSON(
-  jsonString: string,
-): SafeParseResult<FunctionRegexFilterSchema, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FunctionRegexFilterSchema$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FunctionRegexFilterSchema' from JSON`,
-  );
-}
-
 /** @internal */
 export const FunctionRegexFilter$inboundSchema: z.ZodType<
   FunctionRegexFilter,
@@ -104,12 +47,7 @@ export const FunctionRegexFilter$inboundSchema: z.ZodType<
   sync: z.boolean().optional(),
   uischema: z.record(z.any()),
   version: z.string(),
-  schema: z.lazy(() => FunctionRegexFilterSchema$inboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "__filename": "filename",
-    "cribl_version": "criblVersion",
-  });
+  schema: FunctionConfSchemaRegexFilter$inboundSchema.optional(),
 });
 
 export function functionRegexFilterFromJSON(

package/src/models/functionrename.ts

@@ -3,45 +3,18 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
-
-export type Rename = {
-  /**
-   * Name of the field to rename. Literal identifiers must be quoted.
-   */
-  currentName: string;
-  /**
-   * The name the field will be renamed to. Literal identifiers must be quoted.
-   */
-  newName: string;
-};
-
-export type FunctionRenameSchema = {
-  /**
-   * Fields whose children will inherit the Rename fields and Rename expression operations. Supports wildcards. If empty, only top-level fields will be renamed.
-   */
-  baseFields?: Array<string> | undefined;
-  /**
-   * Set of key-value pairs to rename fields, where key is the current name and value is the new name. Does not support internal fields.
-   */
-  rename?: Array<Rename> | undefined;
-  /**
-   * Optional JavaScript expression whose returned value will be used to rename fields. Use the 'name' and 'value' global variables to access field names/values. Example: `name.startsWith('data') ? name.toUpperCase() : name`. You can access other field values via __e.<fieldName>.
-   */
-  renameExpr?: string | undefined;
-  /**
-   * For wildcards specified in Parent fields, sets the maximum depth within events to match and rename fields. Enter `0` to match only top-level fields. Defaults to `5` levels down.
-   */
-  wildcardDepth?: number | undefined;
-};
+import {
+  FunctionConfSchemaRename,
+  FunctionConfSchemaRename$inboundSchema,
+} from "./functionconfschemarename.js";
 
 export type FunctionRename = {
-  filename: string;
+  __filename: string;
   asyncTimeout?: number | undefined;
-  criblVersion?: string | undefined;
+  cribl_version?: string | undefined;
   disabled?: boolean | undefined;
   group: string;
   handleSignals?: boolean | undefined;
@@ -52,48 +25,9 @@ export type FunctionRename = {
   sync?: boolean | undefined;
   uischema: { [k: string]: any };
   version: string;
-  schema?: FunctionRenameSchema | undefined;
+  schema?: FunctionConfSchemaRename | undefined;
 };
 
-/** @internal */
-export const Rename$inboundSchema: z.ZodType<Rename, z.ZodTypeDef, unknown> = z
-  .object({
-    currentName: z.string(),
-    newName: z.string(),
-  });
-
-export function renameFromJSON(
-  jsonString: string,
-): SafeParseResult<Rename, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Rename$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Rename' from JSON`,
-  );
-}
-
-/** @internal */
-export const FunctionRenameSchema$inboundSchema: z.ZodType<
-  FunctionRenameSchema,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  baseFields: z.array(z.string()).optional(),
-  rename: z.array(z.lazy(() => Rename$inboundSchema)).optional(),
-  renameExpr: z.string().optional(),
-  wildcardDepth: z.number().int().default(5),
-});
-
-export function functionRenameSchemaFromJSON(
-  jsonString: string,
-): SafeParseResult<FunctionRenameSchema, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FunctionRenameSchema$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FunctionRenameSchema' from JSON`,
-  );
-}
-
 /** @internal */
 export const FunctionRename$inboundSchema: z.ZodType<
   FunctionRename,
@@ -113,12 +47,7 @@ export const FunctionRename$inboundSchema: z.ZodType<
   sync: z.boolean().optional(),
   uischema: z.record(z.any()),
   version: z.string(),
-  schema: z.lazy(() => FunctionRenameSchema$inboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "__filename": "filename",
-    "cribl_version": "criblVersion",
-  });
+  schema: FunctionConfSchemaRename$inboundSchema.optional(),
 });
 
 export function functionRenameFromJSON(

package/src/models/functionresponse.ts

@@ -71,9 +71,9 @@ import {
 import { FunctionGeoip, FunctionGeoip$inboundSchema } from "./functiongeoip.js";
 import { FunctionGrok, FunctionGrok$inboundSchema } from "./functiongrok.js";
 import {
-  FunctionHandlebar,
-  FunctionHandlebar$inboundSchema,
-} from "./functionhandlebar.js";
+  FunctionHandlebars,
+  FunctionHandlebars$inboundSchema,
+} from "./functionhandlebars.js";
 import { FunctionJoin, FunctionJoin$inboundSchema } from "./functionjoin.js";
 import {
   FunctionJsonUnroll,
@@ -226,7 +226,7 @@ export type FunctionResponse =
   | FunctionGenStats
   | FunctionGeoip
   | FunctionGrok
-  | FunctionHandlebar
+  | FunctionHandlebars
   | FunctionJoin
   | FunctionJsonUnroll
   | FunctionLakeExport
@@ -297,7 +297,7 @@ export const FunctionResponse$inboundSchema: z.ZodType<
   FunctionGenStats$inboundSchema,
   FunctionGeoip$inboundSchema,
   FunctionGrok$inboundSchema,
-  FunctionHandlebar$inboundSchema,
+  FunctionHandlebars$inboundSchema,
   FunctionJoin$inboundSchema,
   FunctionJsonUnroll$inboundSchema,
   FunctionLakeExport$inboundSchema,

package/src/models/functionrollupmetrics.ts

@@ -3,58 +3,18 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../lib/primitives.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";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
-
-/**
- * The operation to use when rolling up gauge metrics. Defaults to last.
- */
-export const GaugeUpdate = {
-  /**
-   * Last
-   */
-  Last: "last",
-  /**
-   * Maximum
-   */
-  Max: "max",
-  /**
-   * Minimum
-   */
-  Min: "min",
-  /**
-   * Average
-   */
-  Avg: "avg",
-} as const;
-/**
- * The operation to use when rolling up gauge metrics. Defaults to last.
- */
-export type GaugeUpdate = OpenEnum<typeof GaugeUpdate>;
-
-export type FunctionRollupMetricsSchema = {
-  /**
-   * List of dimensions across which to perform rollups. Supports wildcards. Defaults to all original dimensions.
-   */
-  dimensions?: Array<string> | undefined;
-  /**
-   * The time span of the rollup window. Must be a valid time string (such as 10s).
-   */
-  timeWindow?: string | undefined;
-  /**
-   * The operation to use when rolling up gauge metrics. Defaults to last.
-   */
-  gaugeRollup?: GaugeUpdate | undefined;
-};
+import {
+  FunctionConfSchemaRollupMetrics,
+  FunctionConfSchemaRollupMetrics$inboundSchema,
+} from "./functionconfschemarollupmetrics.js";
 
 export type FunctionRollupMetrics = {
-  filename: string;
+  __filename: string;
   asyncTimeout?: number | undefined;
-  criblVersion?: string | undefined;
+  cribl_version?: string | undefined;
   disabled?: boolean | undefined;
   group: string;
   handleSignals?: boolean | undefined;
@@ -65,37 +25,9 @@ export type FunctionRollupMetrics = {
   sync?: boolean | undefined;
   uischema: { [k: string]: any };
   version: string;
-  schema?: FunctionRollupMetricsSchema | undefined;
+  schema?: FunctionConfSchemaRollupMetrics | undefined;
 };
 
-/** @internal */
-export const GaugeUpdate$inboundSchema: z.ZodType<
-  GaugeUpdate,
-  z.ZodTypeDef,
-  unknown
-> = openEnums.inboundSchema(GaugeUpdate);
-
-/** @internal */
-export const FunctionRollupMetricsSchema$inboundSchema: z.ZodType<
-  FunctionRollupMetricsSchema,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  dimensions: z.array(z.string()).optional(),
-  timeWindow: z.string().default("30s"),
-  gaugeRollup: GaugeUpdate$inboundSchema.default("last"),
-});
-
-export function functionRollupMetricsSchemaFromJSON(
-  jsonString: string,
-): SafeParseResult<FunctionRollupMetricsSchema, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FunctionRollupMetricsSchema$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FunctionRollupMetricsSchema' from JSON`,
-  );
-}
-
 /** @internal */
 export const FunctionRollupMetrics$inboundSchema: z.ZodType<
   FunctionRollupMetrics,
@@ -115,12 +47,7 @@ export const FunctionRollupMetrics$inboundSchema: z.ZodType<
   sync: z.boolean().optional(),
   uischema: z.record(z.any()),
   version: z.string(),
-  schema: z.lazy(() => FunctionRollupMetricsSchema$inboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "__filename": "filename",
-    "cribl_version": "criblVersion",
-  });
+  schema: FunctionConfSchemaRollupMetrics$inboundSchema.optional(),
 });
 
 export function functionRollupMetricsFromJSON(