@voiceflow/base-types 2.26.0 → 2.27.0

package/build/common/runtimeLogs/index.d.ts

@@ -1 +1,2 @@
 export * from './logs';
+export * from './runtime';

package/build/common/runtimeLogs/index.js

@@ -11,3 +11,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./logs"), exports);
+__exportStar(require("./runtime"), exports);

package/build/common/runtimeLogs/runtime/index.d.ts

@@ -0,0 +1 @@
+export * from './logBuffer';

package/build/common/runtimeLogs/runtime/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./logBuffer"), exports);

package/build/common/runtimeLogs/runtime/logBuffer.d.ts

@@ -0,0 +1,19 @@
+import { Log } from '../logs';
+/**
+ * It acts as a buffer in between the runtime which produces the logs and the service/datastore which consumes the logs.
+ * In practice, this will almost always be implemented as part of the runtime itself.
+ */
+export interface LogBuffer {
+    /** The number of {@link Log} in this {@link LogBuffer}'s buffer. */
+    readonly bufferSize: number;
+    /** Add {@link Log} to this {@link LogBuffer}'s buffer. */
+    push(...logs: Log[]): void;
+    /** Dispatch all {@link Log} from this {@link LogBuffer}'s buffer and then remove them. */
+    flush(): void;
+    /** Remove all {@link Log} from this {@link LogBuffer}'s buffer. */
+    clear(): void;
+}
+export interface AsyncLogBuffer extends LogBuffer {
+    flush(): void | Promise<void>;
+    clear(): void | Promise<void>;
+}

package/build/common/runtimeLogs/runtime/logBuffer.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/esm/runtimeLogs/index.d.ts

@@ -1 +1,2 @@
 export * from './logs';
+export * from './runtime';

package/build/esm/runtimeLogs/index.js

@@ -1 +1,2 @@
 export * from './logs';
+export * from './runtime';

package/build/esm/runtimeLogs/runtime/index.d.ts

@@ -0,0 +1 @@
+export * from './logBuffer';

package/build/esm/runtimeLogs/runtime/index.js

@@ -0,0 +1 @@
+export * from './logBuffer';

package/build/esm/runtimeLogs/runtime/logBuffer.d.ts

@@ -0,0 +1,19 @@
+import { Log } from '../logs';
+/**
+ * It acts as a buffer in between the runtime which produces the logs and the service/datastore which consumes the logs.
+ * In practice, this will almost always be implemented as part of the runtime itself.
+ */
+export interface LogBuffer {
+    /** The number of {@link Log} in this {@link LogBuffer}'s buffer. */
+    readonly bufferSize: number;
+    /** Add {@link Log} to this {@link LogBuffer}'s buffer. */
+    push(...logs: Log[]): void;
+    /** Dispatch all {@link Log} from this {@link LogBuffer}'s buffer and then remove them. */
+    flush(): void;
+    /** Remove all {@link Log} from this {@link LogBuffer}'s buffer. */
+    clear(): void;
+}
+export interface AsyncLogBuffer extends LogBuffer {
+    flush(): void | Promise<void>;
+    clear(): void | Promise<void>;
+}

package/build/esm/runtimeLogs/runtime/logBuffer.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@voiceflow/base-types",
   "description": "Voiceflow base project types",
-  "version": "2.26.0",
+  "version": "2.27.0",
   "author": "Voiceflow",
   "bugs": {
     "url": "https://github.com/voiceflow/libs/issues"
@@ -43,5 +43,5 @@
     "test:smoke": "exit 0",
     "test:unit": "exit 0"
   },
-  "gitHead": "f079d147cc752ca233177cb1f0a1771a36c88309"
+  "gitHead": "32f0757eae3d1cee6af9220f541feac9d8cd9e75"
 }