@or-sdk/deployer 1.5.6 → 1.6.0

package/src/types/flow-logs.ts

@@ -0,0 +1,132 @@
+/* eslint-disable max-len */
+
+export type FetchFlowLogsParams = {
+  /** Flow id to pull log events for */
+  flowId: string;
+
+  /** The maximum number of events to return. Default 50. */
+  limit?: number;
+
+  /**
+   * Filter for searching log events
+   * @see [Using filter patterns to match terms in space-delimited log events](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html#matching-terms-json-log-events) */
+  filter?: string;
+
+  /**
+   * The start of the time range. Log events with a timestamp before this time are not returned.
+   *
+   * - `number` - start expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`.
+   * - `Date` - start expressed as instance of Data class.
+   * - `'now'` - use current time for a start (With additional gap for convenience, about a minute ago).
+   *
+   * Default `'now'`.
+   */
+  start?: Date | number | 'now';
+
+  /**
+   * The end of the time range. Log events with a timestamp later than this time are not returned.
+   *
+   * - `number` - end expressed as the number of milliseconds after `Jan 1, 1970 00:00:00 UTC`.
+   * - `Date` - end expressed as instance of Data class.
+   * - `'now'` - use current time for a end.
+   *
+   * Default `'now'`
+   */
+  end?: Date | number | 'now';
+
+  /** If `false` will include original unparsed message as unstructured string. Default true. */
+  skipOriginal?: boolean;
+};
+
+export type FetchFlowLogsChunkParams = FetchFlowLogsParams & {
+  /** The token for the next set of events to return. (You received this token from a previous call.) */
+  next?: string;
+}
+
+export type FlowLogEventMessageString = {
+  parsed: string;
+  type: 'string';
+}
+
+export type ParsedReportingEventMessage = {
+  event: {
+    EventId: string;
+    Event: string;
+    EventCategory: string;
+    EventValue: Record<string, unknown>;
+    AccountId: string;
+    FlowId: string;
+    Timestamp: string;
+    Tags?: Array<unknown>;
+    SessionId?: string;
+    BeginningSessionId?: string;
+    Version?: number;
+
+    [key: string]: unknown;
+  }
+}
+
+export type RuntimeEventMessage = {
+  type: 'START' | 'END' | 'REPORT';
+  message: string;
+}
+
+export type SystemEventMessage = {
+  type: string;
+  sys: string;
+  thread: string;
+  data?: Record<string, unknown>;
+  step?: {
+    stepId: string;
+    [key: string]: unknown;
+  };
+  session?: {
+    id: string;
+    [key: string]: unknown;
+  };
+}
+
+export type LogEventMessage = {
+  type: string;
+  msg: string;
+  thread: string;
+  data?: Record<string, unknown>;
+  step?: {
+    stepId: string;
+    [key: string]: unknown;
+  };
+  session?: {
+    id: string;
+    [key: string]: unknown;
+  };
+}
+
+export type FlowLogEventMessageJson = {
+  parsed:
+  | LogEventMessage
+  | SystemEventMessage
+  | ParsedReportingEventMessage
+  | RuntimeEventMessage;
+  type: 'json';
+}
+
+export type FlowLogEventMessage = FlowLogEventMessageString | FlowLogEventMessageJson;
+
+export type FlowLogEvent = {
+  requestId: string;
+  message: FlowLogEventMessage;
+  timestamp: number;
+}
+
+export type FlowLogsResponse = {
+  /** List of flow log events */
+  events: FlowLogEvent[];
+
+  /** Start of time range as UNIX timestamp in milliseconds */
+  startTime: number;
+};
+
+export type FlowLogsChunkResponse = FlowLogsResponse & {
+  /** The token for the next set of events to return */
+  nextToken?: string;
+};

package/src/types/index.ts

@@ -0,0 +1,3 @@
+export type * from './base';
+export type * from './flow-activation';
+export type * from './flow-logs';

package/tsconfig.types.json

@@ -5,6 +5,7 @@
     "rootDir": "./src",
     "declaration": true,
     "declarationMap": true,
-    "emitDeclarationOnly": true
+    "emitDeclarationOnly": true,
+    "removeComments": false
   }
 }

package/dist/cjs/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/esm/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,MAAM,cAAc,GAAG;IAI3B,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE;QACL,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,aAAa,CAAC,EAAE;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,QAAQ,EAAE;QACR,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF,KAAK,EAAE,IAAI,EAAE,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC;AAEjE,MAAM,MAAM,UAAU,GAAG;IACvB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,cAAc,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,OAAO,CAAC;QAClB,IAAI,EAAE,OAAO,CAAC;QACd,MAAM,EAAE;YACN,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,IAAI,EAAE,MAAM,CAAC;SACd,CAAC;QACF,WAAW,EAAE,MAAM,CAAC;QACpB,aAAa,EAAE,eAAe,EAAE,CAAC;QACjC,KAAK,EAAE;YACL,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;SACrB,CAAC;QACF,QAAQ,EAAE,OAAO,CAAC;QAClB,IAAI,EAAE;YACJ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,CAAC;QACF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAC5B,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;KAClC,CAAC;IACF,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE;YACP,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,IAAI,CAAC,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,SAAS,EAAE;QACT,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAIjC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE;QAIL,OAAO,CAAC,EAAE,MAAM,CAAC;QAIjB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,OAAO,EAAE,CAAC;AAErD,MAAM,MAAM,qCAAqC,GAAG;IAClD,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,oBAAoB,EAAE,MAAM,CAAC;QAC7B,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,OAAO,EAAE,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,qCAAqC,EAAE,CAAC;AAErF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE;QACV,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,aAAa,GACvB,oBAAoB,GAClB,4BAA4B,GAC5B,8BAA8B,GAC9B,kBAAkB,CAAC;AAEvB,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}