@stackone/olap 1.26.0 → 1.27.0

package/dist/index.d.cts

@@ -1,9 +1,9 @@
-import { S3Client } from "@aws-sdk/client-s3";
 import * as redis from "redis";
 import { AxiosInstance } from "axios";
 import http from "node:http";
 import https from "node:https";
 import { Readable } from "node:stream";
+import { S3Client } from "@aws-sdk/client-s3";
 import { Producer } from "@platformatic/kafka";
 
 //#region rolldown:runtime
@@ -71,32 +71,6 @@ type LogError = Error & {
   url?: string;
 };
 //#endregion
-//#region src/olap/olapOptions.d.ts
-type OlapOptions = {
-  logs?: LogsOptions;
-  advanced?: AdvancedOptions;
-  defender?: DefenderOptions;
-};
-type LogsOptions = {
-  enabled?: boolean;
-};
-type AdvancedOptions = {
-  enabled?: boolean;
-  ttl?: number;
-  errorsOnly?: boolean;
-  includeBackground?: boolean;
-};
-type DefenderOptions = {
-  enabled?: boolean;
-};
-//#endregion
-//#region src/defender/types.d.ts
-type DefenderLog = {
-  riskLevel: string;
-  tier2Score: number;
-  [key: string]: unknown;
-};
-//#endregion
 //#region ../transport/src/cacheClient/types.d.ts
 interface ICacheClient<ClientType = unknown> {
   isAvailable(): boolean;
@@ -489,7 +463,242 @@ declare class HttpClient<TError extends Error = Error> implements IHttpClient {
   }): Promise<StreamHttpResponse>;
 }
 //#endregion
+//#region src/olap/olapOptions.d.ts
+type OlapOptions = {
+  logs?: LogsOptions;
+  advanced?: AdvancedOptions;
+  defender?: DefenderOptions;
+};
+type LogsOptions = {
+  enabled?: boolean;
+};
+type AdvancedOptions = {
+  enabled?: boolean;
+  ttl?: number;
+  errorsOnly?: boolean;
+  includeBackground?: boolean;
+};
+type DefenderOptions = {
+  enabled?: boolean;
+};
+//#endregion
+//#region src/advanced/types.d.ts
+type ActionAdvancedLog = {
+  data: {
+    [key: string]: unknown;
+  };
+  metadata?: {
+    isBackgroundLog?: boolean;
+    expirationTime?: number;
+  };
+};
+type StepAdvancedLog = {
+  data: {
+    [key: string]: unknown;
+  };
+  metadata?: {
+    expirationTime?: number;
+  };
+};
+type UnifiedAdvancedLog = {
+  data: {
+    [key: string]: unknown;
+  };
+  metadata?: {
+    isBackgroundLog?: boolean;
+    expirationTime?: number;
+  };
+};
+type ProviderAdvancedLog = {
+  data: {
+    [key: string]: unknown;
+  };
+  metadata?: {
+    expirationTime?: number;
+  };
+};
+interface S3ClientConfig {
+  region?: string;
+}
+type S3ClientBuilder = (config?: S3ClientConfig, logger?: ILogger) => S3Client | undefined;
+//#endregion
+//#region src/defender/types.d.ts
+type DefenderLog = {
+  riskLevel: string;
+  tier2Score: number;
+  [key: string]: unknown;
+};
+//#endregion
+//#region src/types.d.ts
+interface IOlapClient {
+  recordAction(actionInput: ActionInput, actionResult: ActionResult, options?: OlapOptions): Promise<void>;
+  recordActions(actions: Array<{
+    input: ActionInput;
+    result: ActionResult;
+  }>, options?: OlapOptions): Promise<void>;
+  recordStep(stepInput: StepInput, stepResult: StepResult, options?: OlapOptions): Promise<void>;
+  recordSteps(steps: Array<{
+    input: StepInput;
+    result: StepResult;
+  }>, options?: OlapOptions): Promise<void>;
+  recordUnified(unifiedInput: UnifiedInput, unifiedResult: UnifiedResult, options?: OlapOptions): Promise<void>;
+  recordProvider(providerInput: ProviderInput, providerResult: ProviderResult, options?: OlapOptions): Promise<void>;
+  getLogs(organizationId: string, projectSecureId: string, query: Query): Promise<QueryResult>;
+  getActionLogs(organizationId: string, projectSecureId: string, query: ActionsQuery): Promise<ActionsQueryResult>;
+  getActionLog(organizationId: string, projectSecureId: string, actionRunId: string): Promise<ActionLog | undefined>;
+  getStepLogs(organizationId: string, projectSecureId: string, query: StepsQuery): Promise<StepsQueryResult>;
+  getStepLog(organizationId: string, projectSecureId: string, actionRunId: string, stepIndex: number): Promise<StepLog | undefined>;
+  getUnifiedLogs(organizationId: string, projectSecureId: string, query: UnifiedQuery): Promise<UnifiedQueryResult>;
+  getUnifiedLog(organizationId: string, projectSecureId: string, requestId: string): Promise<UnifiedLog | undefined>;
+  getProviderLogs(organizationId: string, projectSecureId: string, query: ProviderQuery): Promise<ProviderQueryResult>;
+  getProviderLog(organizationId: string, projectSecureId: string, requestId: string, id: string): Promise<ProviderLog | undefined>;
+  getActionAdvancedLog(organizationId: string, projectSecureId: string, actionRunId: string): Promise<ActionAdvancedLog | undefined>;
+  getStepAdvancedLog(organizationId: string, projectSecureId: string, actionRunId: string, stepIndex: number): Promise<StepAdvancedLog | undefined>;
+  getUnifiedAdvancedLog(organizationId: string, projectSecureId: string, requestId: string): Promise<UnifiedAdvancedLog | undefined>;
+  getProviderAdvancedLog(organizationId: string, projectSecureId: string, requestId: string, id: string): Promise<ProviderAdvancedLog | undefined>;
+  getDefenderLog(organizationId: string, projectSecureId: string, actionRunId: string): Promise<DefenderLog | undefined>;
+  getLogsStatsAggregate(organizationId: string, projectSecureId: string, query: AggregateQuery): Promise<AggregateResult>;
+  getLogsStatsDimensions(organizationId: string, projectSecureId: string, query: DimensionsQuery): Promise<DimensionsResult>;
+}
+type DefenderContext = {
+  riskLevel: string;
+  tier2Score: number;
+  [key: string]: unknown;
+};
+type ActionInput = {
+  actionId?: string;
+  mode?: string;
+  url?: string;
+  pathParams?: unknown;
+  queryParams?: unknown;
+  body?: unknown;
+  headers?: Record<string, string>;
+  sourceId?: string;
+  sourceType?: string;
+  sourceValue?: string;
+  isBackground?: boolean;
+  startTime?: Date;
+};
+type ActionResult = {
+  actionRunId: string;
+  actionId: string;
+  connectorKey: string;
+  connectorVersion: string;
+  actionType: string;
+  category?: string;
+  organizationId: string;
+  projectSecureId: string;
+  accountSecureId: string;
+  originOwnerId?: string;
+  originOwnerName?: string;
+  httpMethod?: string;
+  url?: string;
+  path?: string;
+  resource?: string;
+  subResource?: string;
+  childResource?: string;
+  success?: boolean;
+  statusCode?: number;
+  message?: string;
+  headers?: Record<string, string>;
+  body?: unknown;
+  defenderContext?: DefenderContext;
+  endTime?: Date;
+};
+type StepInput = {
+  actionRunId: string;
+  stepIndex: number;
+  stepId: string;
+  organizationId: string;
+  projectSecureId: string;
+  accountSecureId: string;
+  inputs?: {
+    [key: string]: unknown;
+  };
+};
+type StepResult = {
+  success?: boolean;
+  message?: string;
+  outputs?: unknown;
+  errors?: unknown;
+  skipped?: boolean;
+  startTime?: Date;
+  endTime?: Date;
+};
+type UnifiedInput = {
+  requestId: string;
+  organizationId: string;
+  projectSecureId: string;
+  accountSecureId: string;
+  originOwnerId?: string;
+  originOwnerName?: string;
+  connectorKey: string;
+  action?: string;
+  service?: string;
+  mode?: string;
+  httpMethod?: string;
+  url?: string;
+  path?: string;
+  queryParams?: unknown;
+  body?: unknown;
+  headers?: Record<string, string>;
+  resource?: string;
+  subResource?: string;
+  childResource?: string;
+  sourceId?: string;
+  sourceType?: string;
+  sourceValue?: string;
+  isBackground?: boolean;
+  startTime?: Date;
+};
+type UnifiedResult = {
+  success?: boolean;
+  statusCode?: number;
+  message?: string;
+  headers?: Record<string, string>;
+  body?: unknown;
+  endTime?: Date;
+};
+type ProviderInput = {
+  requestId: string;
+  id: string;
+  organizationId: string;
+  projectSecureId: string;
+  accountSecureId: string;
+  originOwnerId?: string;
+  originOwnerName?: string;
+  connectorKey: string;
+  action: string;
+  service: string;
+  mode: string;
+  httpMethod: string;
+  url: string;
+  path?: string;
+  queryParams?: unknown;
+  headers?: Record<string, string>;
+  body?: unknown;
+  resource?: string;
+  subResource?: string;
+  childResource?: string;
+  startTime?: Date;
+};
+type ProviderResult = {
+  success?: boolean;
+  statusCode?: number;
+  headers?: Record<string, string>;
+  body?: unknown;
+  errors?: unknown;
+  endTime?: Date;
+};
+//#endregion
 //#region src/logs/types.d.ts
+declare const LogType: {
+  readonly Action: "action";
+  readonly Step: "step";
+  readonly Unified: "unified";
+  readonly Provider: "provider";
+};
+type LogType = (typeof LogType)[keyof typeof LogType];
 type Query = {
   organizationId?: string | string[];
   projectSecureId?: string | string[];
@@ -499,7 +708,20 @@ type Query = {
   connectorKey?: string | string[];
   mode?: string | string[];
   category?: string | string[];
-  logType?: ('action' | 'unified') | ('action' | 'unified')[];
+  requestId?: string | string[];
+  provider?: string | string[];
+  service?: string | string[];
+  resource?: string | string[];
+  subResource?: string | string[];
+  childResource?: string | string[];
+  action?: string | string[];
+  statusCode?: string | string[];
+  sourceId?: string | string[];
+  sourceType?: string | string[];
+  sourceValue?: string | string[];
+  originOwnerId?: string | string[];
+  httpMethod?: string | string[];
+  logType?: (typeof LogType.Action | typeof LogType.Unified) | (typeof LogType.Action | typeof LogType.Unified)[];
   success?: boolean;
   startTime?: Date;
   endTime?: Date;
@@ -592,6 +814,45 @@ type ProviderQueryResult = {
   pageNumber: number;
   pageSize: number;
 };
+type IntervalType = 'minute' | 'hour' | 'day' | 'week' | 'month';
+declare const Dimension: {
+  readonly ConnectorKey: "connector_key";
+  readonly Success: "success";
+  readonly ActionType: "action_type";
+  readonly Mode: "mode";
+  readonly Service: "service";
+  readonly Resource: "resource";
+  readonly ActionId: "action_id";
+  readonly HttpMethod: "http_method";
+  readonly AccountSecureId: "account_secure_id";
+  readonly SourceType: "source_type";
+  readonly StatusCode: "status_code";
+  readonly OriginOwnerId: "origin_owner_id";
+  readonly SourceId: "source_id";
+};
+type Dimension = (typeof Dimension)[keyof typeof Dimension];
+type AggregateQuery = Partial<Query> & {
+  dimensions?: Dimension[];
+  intervalType?: IntervalType;
+  intervalPeriod?: number;
+};
+type AggregateResult = {
+  data: Array<{
+    start_time?: string;
+    count: number;
+    [dimension: string]: string | number | boolean | undefined;
+  }>;
+};
+type DimensionsQuery = Partial<Query> & {
+  dimensions: Dimension[];
+  maxValues?: number;
+};
+type DimensionsResult = {
+  [dimension: string]: Array<{
+    value: string;
+    count: number;
+  }>;
+};
 type HttpClientBuilder = (logger?: ILogger) => HttpClient | undefined;
 type SASLMechanism = 'PLAIN' | 'SCRAM-SHA-256' | 'SCRAM-SHA-512';
 interface KafkaClientConfig {
@@ -637,7 +898,7 @@ interface TinybirdQueryOptions<TParams = Record<string, unknown>, TResult = unkn
   };
 }
 interface ILog {
-  logType: 'action' | 'step' | 'unified' | 'provider';
+  logType: LogType;
   eventTime: Date;
   startTime: Date;
   endTime?: Date;
@@ -647,7 +908,7 @@ interface ILog {
   accountSecureId?: string;
 }
 type ActionLog = ILog & {
-  logType: 'action';
+  logType: typeof LogType.Action;
   actionRunId: string;
   actionId: string;
   connectorKey: string;
@@ -672,7 +933,7 @@ type ActionLog = ILog & {
   tier2Score?: number;
 };
 type StepLog = ILog & {
-  logType: 'step';
+  logType: typeof LogType.Step;
   actionRunId: string;
   stepIndex: number;
   stepId: string;
@@ -684,7 +945,7 @@ type StepLog = ILog & {
   message?: string;
 };
 type UnifiedLog = ILog & {
-  logType: 'unified';
+  logType: typeof LogType.Unified;
   requestId: string;
   organizationId: string;
   projectSecureId: string;
@@ -714,7 +975,7 @@ type UnifiedLog = ILog & {
   duration?: number;
 };
 type ProviderLog = ILog & {
-  logType: 'provider';
+  logType: typeof LogType.Provider;
   requestId: string;
   id?: string;
   organizationId: string;
@@ -741,206 +1002,6 @@ type ProviderLog = ILog & {
   duration?: number;
 };
 //#endregion
-//#region src/types.d.ts
-interface IOlapClient {
-  recordAction(actionInput: ActionInput, actionResult: ActionResult, options?: OlapOptions): Promise<void>;
-  recordActions(actions: Array<{
-    input: ActionInput;
-    result: ActionResult;
-  }>, options?: OlapOptions): Promise<void>;
-  recordStep(stepInput: StepInput, stepResult: StepResult, options?: OlapOptions): Promise<void>;
-  recordSteps(steps: Array<{
-    input: StepInput;
-    result: StepResult;
-  }>, options?: OlapOptions): Promise<void>;
-  recordUnified(unifiedInput: UnifiedInput, unifiedResult: UnifiedResult, options?: OlapOptions): Promise<void>;
-  recordProvider(providerInput: ProviderInput, providerResult: ProviderResult, options?: OlapOptions): Promise<void>;
-  getLogs(organizationId: string, projectSecureId: string, query: Query): Promise<QueryResult>;
-  getActionLogs(organizationId: string, projectSecureId: string, query: ActionsQuery): Promise<ActionsQueryResult>;
-  getActionLog(organizationId: string, projectSecureId: string, actionRunId: string): Promise<ActionLog | undefined>;
-  getStepLogs(organizationId: string, projectSecureId: string, query: StepsQuery): Promise<StepsQueryResult>;
-  getStepLog(organizationId: string, projectSecureId: string, actionRunId: string, stepIndex: number): Promise<StepLog | undefined>;
-  getUnifiedLogs(organizationId: string, projectSecureId: string, query: UnifiedQuery): Promise<UnifiedQueryResult>;
-  getUnifiedLog(organizationId: string, projectSecureId: string, requestId: string): Promise<UnifiedLog | undefined>;
-  getProviderLogs(organizationId: string, projectSecureId: string, query: ProviderQuery): Promise<ProviderQueryResult>;
-  getProviderLog(organizationId: string, projectSecureId: string, requestId: string, id: string): Promise<ProviderLog | undefined>;
-  getActionAdvancedLog(organizationId: string, projectSecureId: string, actionRunId: string): Promise<ActionAdvancedLog | undefined>;
-  getStepAdvancedLog(organizationId: string, projectSecureId: string, actionRunId: string, stepIndex: number): Promise<StepAdvancedLog | undefined>;
-  getUnifiedAdvancedLog(organizationId: string, projectSecureId: string, requestId: string): Promise<UnifiedAdvancedLog | undefined>;
-  getProviderAdvancedLog(organizationId: string, projectSecureId: string, requestId: string, id: string): Promise<ProviderAdvancedLog | undefined>;
-  getDefenderLog(organizationId: string, projectSecureId: string, actionRunId: string): Promise<DefenderLog | undefined>;
-}
-type DefenderContext = {
-  riskLevel: string;
-  tier2Score: number;
-  [key: string]: unknown;
-};
-type ActionInput = {
-  actionId?: string;
-  mode?: string;
-  url?: string;
-  pathParams?: unknown;
-  queryParams?: unknown;
-  body?: unknown;
-  headers?: Record<string, string>;
-  sourceId?: string;
-  sourceType?: string;
-  sourceValue?: string;
-  isBackground?: boolean;
-  startTime?: Date;
-};
-type ActionResult = {
-  actionRunId: string;
-  actionId: string;
-  connectorKey: string;
-  connectorVersion: string;
-  actionType: string;
-  category?: string;
-  organizationId: string;
-  projectSecureId: string;
-  accountSecureId: string;
-  originOwnerId?: string;
-  originOwnerName?: string;
-  httpMethod?: string;
-  url?: string;
-  path?: string;
-  resource?: string;
-  subResource?: string;
-  childResource?: string;
-  success?: boolean;
-  statusCode?: number;
-  message?: string;
-  headers?: Record<string, string>;
-  body?: unknown;
-  defenderContext?: DefenderContext;
-  endTime?: Date;
-};
-type StepInput = {
-  actionRunId: string;
-  stepIndex: number;
-  stepId: string;
-  organizationId: string;
-  projectSecureId: string;
-  accountSecureId: string;
-  inputs?: {
-    [key: string]: unknown;
-  };
-};
-type StepResult = {
-  success?: boolean;
-  message?: string;
-  outputs?: unknown;
-  errors?: unknown;
-  skipped?: boolean;
-  startTime?: Date;
-  endTime?: Date;
-};
-type UnifiedInput = {
-  requestId: string;
-  organizationId: string;
-  projectSecureId: string;
-  accountSecureId: string;
-  originOwnerId?: string;
-  originOwnerName?: string;
-  connectorKey: string;
-  action?: string;
-  service?: string;
-  mode?: string;
-  httpMethod?: string;
-  url?: string;
-  path?: string;
-  queryParams?: unknown;
-  body?: unknown;
-  headers?: Record<string, string>;
-  resource?: string;
-  subResource?: string;
-  childResource?: string;
-  sourceId?: string;
-  sourceType?: string;
-  sourceValue?: string;
-  isBackground?: boolean;
-  startTime?: Date;
-};
-type UnifiedResult = {
-  success?: boolean;
-  statusCode?: number;
-  message?: string;
-  headers?: Record<string, string>;
-  body?: unknown;
-  endTime?: Date;
-};
-type ProviderInput = {
-  requestId: string;
-  id: string;
-  organizationId: string;
-  projectSecureId: string;
-  accountSecureId: string;
-  originOwnerId?: string;
-  originOwnerName?: string;
-  connectorKey: string;
-  action: string;
-  service: string;
-  mode: string;
-  httpMethod: string;
-  url: string;
-  path?: string;
-  queryParams?: unknown;
-  headers?: Record<string, string>;
-  body?: unknown;
-  resource?: string;
-  subResource?: string;
-  childResource?: string;
-  startTime?: Date;
-};
-type ProviderResult = {
-  success?: boolean;
-  statusCode?: number;
-  headers?: Record<string, string>;
-  body?: unknown;
-  errors?: unknown;
-  endTime?: Date;
-};
-//#endregion
-//#region src/advanced/types.d.ts
-type ActionAdvancedLog = {
-  data: {
-    [key: string]: unknown;
-  };
-  metadata?: {
-    isBackgroundLog?: boolean;
-    expirationTime?: number;
-  };
-};
-type StepAdvancedLog = {
-  data: {
-    [key: string]: unknown;
-  };
-  metadata?: {
-    expirationTime?: number;
-  };
-};
-type UnifiedAdvancedLog = {
-  data: {
-    [key: string]: unknown;
-  };
-  metadata?: {
-    isBackgroundLog?: boolean;
-    expirationTime?: number;
-  };
-};
-type ProviderAdvancedLog = {
-  data: {
-    [key: string]: unknown;
-  };
-  metadata?: {
-    expirationTime?: number;
-  };
-};
-interface S3ClientConfig {
-  region?: string;
-}
-type S3ClientBuilder = (config?: S3ClientConfig, logger?: ILogger) => S3Client | undefined;
-//#endregion
 //#region src/olap/olapClient.d.ts
 declare class OlapClient implements IOlapClient {
   #private;
@@ -990,6 +1051,8 @@ declare class OlapClient implements IOlapClient {
   getUnifiedAdvancedLog(organizationId: string, projectSecureId: string, requestId: string): Promise<UnifiedAdvancedLog | undefined>;
   getProviderAdvancedLog(organizationId: string, projectSecureId: string, requestId: string, id: string): Promise<ProviderAdvancedLog | undefined>;
   getDefenderLog(organizationId: string, projectSecureId: string, actionRunId: string): Promise<DefenderLog | undefined>;
+  getLogsStatsAggregate(organizationId: string, projectSecureId: string, query: AggregateQuery): Promise<AggregateResult>;
+  getLogsStatsDimensions(organizationId: string, projectSecureId: string, query: DimensionsQuery): Promise<DimensionsResult>;
 }
 //#endregion
 //#region src/olap/olapClientManager.d.ts
@@ -1034,4 +1097,4 @@ declare class OlapClientManager {
   static resetInstance(): void;
 }
 //#endregion
-export { type ActionAdvancedLog, type ActionInput, type ActionLog, type ActionResult, type ActionsQuery, type ActionsQueryResult, type AdvancedOptions, type DefenderContext, type DefenderLog, type DefenderOptions, type ILog, type IOlapClient, type LogsOptions, OlapClient, OlapClientManager, type OlapOptions, type ProviderAdvancedLog, type ProviderInput, type ProviderLog, type ProviderQuery, type ProviderQueryResult, type ProviderResult, type Query, type QueryResult, type StepAdvancedLog, type StepInput, type StepLog, type StepResult, type StepsQuery, type StepsQueryResult, type TinybirdConfig, type TinybirdQueryOptions, type TinybirdResponse, type UnifiedAdvancedLog, type UnifiedInput, type UnifiedLog, type UnifiedQuery, type UnifiedQueryResult, type UnifiedResult };
+export { type ActionAdvancedLog, type ActionInput, type ActionLog, type ActionResult, type ActionsQuery, type ActionsQueryResult, type AdvancedOptions, type AggregateQuery, type AggregateResult, type DefenderContext, type DefenderLog, type DefenderOptions, Dimension, type Dimension as DimensionValues, type DimensionsQuery, type DimensionsResult, type ILog, type IOlapClient, type IntervalType, LogType, type LogType as LogTypeValues, type LogsOptions, OlapClient, OlapClientManager, type OlapOptions, type ProviderAdvancedLog, type ProviderInput, type ProviderLog, type ProviderQuery, type ProviderQueryResult, type ProviderResult, type Query, type QueryResult, type StepAdvancedLog, type StepInput, type StepLog, type StepResult, type StepsQuery, type StepsQueryResult, type TinybirdConfig, type TinybirdQueryOptions, type TinybirdResponse, type UnifiedAdvancedLog, type UnifiedInput, type UnifiedLog, type UnifiedQuery, type UnifiedQueryResult, type UnifiedResult };