@effect/platform 0.28.1 → 0.28.3

package/dist/cjs/Terminal.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Terminal = exports.QuitException = void 0;
+var _Data = /*#__PURE__*/require("effect/Data");
+var InternalTerminal = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./internal/terminal.js"));
+function _getRequireWildcardCache(e) {
+  if ("function" != typeof WeakMap) return null;
+  var r = new WeakMap(),
+    t = new WeakMap();
+  return (_getRequireWildcardCache = function (e) {
+    return e ? t : r;
+  })(e);
+}
+function _interopRequireWildcard(e, r) {
+  if (!r && e && e.__esModule) return e;
+  if (null === e || "object" != typeof e && "function" != typeof e) return {
+    default: e
+  };
+  var t = _getRequireWildcardCache(r);
+  if (t && t.has(e)) return t.get(e);
+  var n = {
+      __proto__: null
+    },
+    a = Object.defineProperty && Object.getOwnPropertyDescriptor;
+  for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) {
+    var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
+    i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u];
+  }
+  return n.default = e, t && t.set(e, n), n;
+}
+/**
+ * A `QuitException` represents an exception that occurs when a user attempts to
+ * quit out of a `Terminal` prompt for input (usually by entering `ctrl`+`c`).
+ *
+ * @since 1.0.0
+ * @category model
+ */
+class QuitException extends (0, _Data.TaggedError)("QuitException") {}
+/**
+ * @since 1.0.0
+ * @category tag
+ */
+exports.QuitException = QuitException;
+const Terminal = exports.Terminal = InternalTerminal.tag;
+//# sourceMappingURL=Terminal.js.map

package/dist/cjs/Terminal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Terminal.js","names":["_Data","require","InternalTerminal","_interopRequireWildcard","_getRequireWildcardCache","e","WeakMap","r","t","__esModule","default","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","prototype","hasOwnProperty","call","i","set","QuitException","TaggedError","exports","Terminal","tag"],"sources":["../../src/Terminal.ts"],"sourcesContent":[null],"mappings":";;;;;;AAIA,IAAAA,KAAA,gBAAAC,OAAA;AAIA,IAAAC,gBAAA,gBAAAC,uBAAA,eAAAF,OAAA;AAA0D,SAAAG,yBAAAC,CAAA;EAAA,yBAAAC,OAAA;EAAA,IAAAC,CAAA,OAAAD,OAAA;IAAAE,CAAA,OAAAF,OAAA;EAAA,QAAAF,wBAAA,YAAAA,CAAAC,CAAA;IAAA,OAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA;EAAA,GAAAF,CAAA;AAAA;AAAA,SAAAF,wBAAAE,CAAA,EAAAE,CAAA;EAAA,KAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA;EAAA,aAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA;IAAAK,OAAA,EAAAL;EAAA;EAAA,IAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA;EAAA,IAAAC,CAAA,IAAAA,CAAA,CAAAG,GAAA,CAAAN,CAAA,UAAAG,CAAA,CAAAI,GAAA,CAAAP,CAAA;EAAA,IAAAQ,CAAA;MAAAC,SAAA;IAAA;IAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA;EAAA,SAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,IAAAH,MAAA,CAAAI,SAAA,CAAAC,cAAA,CAAAC,IAAA,CAAAjB,CAAA,EAAAc,CAAA;IAAA,IAAAI,CAAA,GAAAR,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAb,CAAA,EAAAc,CAAA;IAAAI,CAAA,KAAAA,CAAA,CAAAX,GAAA,IAAAW,CAAA,CAAAC,GAAA,IAAAR,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAI,CAAA,IAAAV,CAAA,CAAAM,CAAA,IAAAd,CAAA,CAAAc,CAAA;EAAA;EAAA,OAAAN,CAAA,CAAAH,OAAA,GAAAL,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAgB,GAAA,CAAAnB,CAAA,EAAAQ,CAAA,GAAAA,CAAA;AAAA;AA0D1D;;;;;;;AAOM,MAAOY,aAAc,SAAQ,IAAAzB,KAAA,CAAA0B,WAAW,EAAC,eAAe,CAAK;AAEnE;;;;AAAAC,OAAA,CAAAF,aAAA,GAAAA,aAAA;AAIO,MAAMG,QAAQ,GAAAD,OAAA,CAAAC,QAAA,GAA4B1B,gBAAgB,CAAC2B,GAAG"}

package/dist/cjs/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.WorkerRunner = exports.WorkerError = exports.Worker = exports.Runtime = exports.Path = exports.KeyValueStore = exports.HttpServer = exports.HttpClient = exports.FileSystem = exports.Error = exports.Effectify = exports.CommandExecutor = exports.Command = void 0;
+exports.WorkerRunner = exports.WorkerError = exports.Worker = exports.Terminal = exports.Runtime = exports.Path = exports.KeyValueStore = exports.HttpServer = exports.HttpClient = exports.FileSystem = exports.Error = exports.Effectify = exports.CommandExecutor = exports.Command = void 0;
 var _Command = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Command.js"));
 exports.Command = _Command;
 var _CommandExecutor = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./CommandExecutor.js"));
@@ -24,6 +24,8 @@ var _Path = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Path.j
 exports.Path = _Path;
 var _Runtime = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Runtime.js"));
 exports.Runtime = _Runtime;
+var _Terminal = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Terminal.js"));
+exports.Terminal = _Terminal;
 var _Worker = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Worker.js"));
 exports.Worker = _Worker;
 var _WorkerError = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./WorkerError.js"));

package/dist/cjs/internal/terminal.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.tag = void 0;
+var _Context = /*#__PURE__*/require("effect/Context");
+/** @internal */
+const tag = exports.tag = /*#__PURE__*/(0, _Context.Tag)("@effect/platform/Terminal");
+//# sourceMappingURL=terminal.js.map

package/dist/cjs/internal/terminal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminal.js","names":["_Context","require","tag","exports","Tag"],"sources":["../../../src/internal/terminal.ts"],"sourcesContent":[null],"mappings":";;;;;;AAAA,IAAAA,QAAA,gBAAAC,OAAA;AAGA;AACO,MAAMC,GAAG,GAAAC,OAAA,CAAAD,GAAA,gBAAG,IAAAF,QAAA,CAAAI,GAAG,EAAoB,2BAA2B,CAAC"}

package/dist/dts/Error.d.ts

@@ -28,7 +28,7 @@ export declare namespace PlatformError {
     interface Base extends Data.Case {
         readonly [PlatformErrorTypeId]: typeof PlatformErrorTypeId;
         readonly _tag: string;
-        readonly module: "Command" | "FileSystem" | "Path" | "KeyValueStore" | "Clipboard" | "Stream";
+        readonly module: "Clipboard" | "Command" | "FileSystem" | "KeyValueStore" | "Path" | "Stream" | "Terminal";
         readonly method: string;
         readonly message: string;
     }

package/dist/dts/Error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,IAAI,MAAM,aAAa,CAAA;AAGxC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAAqC,CAAA;AAE9E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAA;AAE5D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,WAAW,CAAA;AAErD;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC;;;OAGG;IACH,UAAiB,IAAK,SAAQ,IAAI,CAAC,IAAI;QACrC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE,OAAO,mBAAmB,CAAA;QAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,MAAM,GAAG,eAAe,GAAG,WAAW,GAAG,QAAQ,CAAA;QAC7F,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;QACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KACzB;IAED;;OAEG;IACH,KAAY,cAAc,GAAG,mBAAmB,GAAG,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;CAC5E;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa,CAAC,IAAI;IACrD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,cAAc,CAAC,KAAK,WAAkC,CAAA;AAExH;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB,eAAe,GACf,aAAa,GACb,MAAM,GACN,aAAa,GACb,UAAU,GACV,kBAAkB,GAClB,UAAU,GACV,eAAe,GACf,SAAS,GACT,YAAY,GACZ,WAAW,CAAA;AAEf;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa,CAAC,IAAI;IACrD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAA;CAC3C;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,cAAc,CAAC,KAAK,WAAkC,CAAA"}
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,IAAI,MAAM,aAAa,CAAA;AAGxC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,OAAO,MAAqC,CAAA;AAE9E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,mBAAmB,CAAA;AAE5D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,WAAW,CAAA;AAErD;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC;;;OAGG;IACH,UAAiB,IAAK,SAAQ,IAAI,CAAC,IAAI;QACrC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,EAAE,OAAO,mBAAmB,CAAA;QAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,YAAY,GAAG,eAAe,GAAG,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAA;QAC1G,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;QACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KACzB;IAED;;OAEG;IACH,KAAY,cAAc,GAAG,mBAAmB,GAAG,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAA;CAC5E;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa,CAAC,IAAI;IACrD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;CAC7B;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,cAAc,CAAC,KAAK,WAAkC,CAAA;AAExH;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB,eAAe,GACf,aAAa,GACb,MAAM,GACN,aAAa,GACb,UAAU,GACV,kBAAkB,GAClB,UAAU,GACV,eAAe,GACf,SAAS,GACT,YAAY,GACZ,WAAW,CAAA;AAEf;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa,CAAC,IAAI;IACrD,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAA;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAA;CAC3C;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,cAAc,CAAC,KAAK,WAAkC,CAAA"}

package/dist/dts/Terminal.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @since 1.0.0
+ */
+import type { Tag } from "effect/Context";
+import type { Effect } from "effect/Effect";
+import type { Option } from "effect/Option";
+import type { PlatformError } from "./Error.js";
+/**
+ * A `Terminal` represents a command-line interface which can read input from a
+ * user and display messages to a user.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export interface Terminal {
+    /**
+     * Reads a single input event from the default standard input.
+     */
+    readonly readInput: Effect<never, QuitException, UserInput>;
+    /**
+     * Displays text to the the default standard output.
+     */
+    readonly display: (text: string) => Effect<never, PlatformError, void>;
+}
+/**
+ * @since 1.0.0
+ * @category model
+ */
+export interface Key {
+    /**
+     * The name of the key being pressed.
+     */
+    readonly name: string;
+    /**
+     * If set to `true`, then the user is also holding down the `Ctrl` key.
+     */
+    readonly ctrl: boolean;
+    /**
+     * If set to `true`, then the user is also holding down the `Meta` key.
+     */
+    readonly meta: boolean;
+    /**
+     * If set to `true`, then the user is also holding down the `Shift` key.
+     */
+    readonly shift: boolean;
+}
+/**
+ * @since 1.0.0
+ * @category model
+ */
+export interface UserInput {
+    /**
+     * The character read from the user (if any).
+     */
+    readonly input: Option<string>;
+    /**
+     * The key that the user pressed.
+     */
+    readonly key: Key;
+}
+declare const QuitException_base: new <A extends Record<string, any>>(args: import("effect/Types").Equals<Omit<A, keyof import("effect/Equal").Equal>, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" | keyof import("effect/Equal").Equal ? never : P]: A[P]; }) => import("effect/Data").YieldableError & {
+    readonly _tag: "QuitException";
+} & Readonly<A>;
+/**
+ * A `QuitException` represents an exception that occurs when a user attempts to
+ * quit out of a `Terminal` prompt for input (usually by entering `ctrl`+`c`).
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export declare class QuitException extends QuitException_base<{}> {
+}
+/**
+ * @since 1.0.0
+ * @category tag
+ */
+export declare const Terminal: Tag<Terminal, Terminal>;
+export {};
+//# sourceMappingURL=Terminal.d.ts.map

package/dist/dts/Terminal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Terminal.d.ts","sourceRoot":"","sources":["../../src/Terminal.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAG/C;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,CAAC,CAAA;IAC3D;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,CAAC,CAAA;CACvE;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAA;IAC9B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;CAClB;;;;AAED;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,mBAA6B,EAAE,CAAC;CAAG;AAEtE;;;GAGG;AACH,eAAO,MAAM,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAwB,CAAA"}

package/dist/dts/index.d.ts

@@ -38,6 +38,10 @@ export * as Path from "./Path.js";
  * @since 1.0.0
  */
 export * as Runtime from "./Runtime.js";
+/**
+ * @since 1.0.0
+ */
+export * as Terminal from "./Terminal.js";
 /**
  * @since 1.0.0
  */

package/dist/dts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA"}

package/dist/dts/internal/terminal.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=terminal.d.ts.map

package/dist/dts/internal/terminal.d.ts.map

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

package/dist/esm/Terminal.js

@@ -0,0 +1,16 @@
+import { TaggedError } from "effect/Data";
+import * as InternalTerminal from "./internal/terminal.js";
+/**
+ * A `QuitException` represents an exception that occurs when a user attempts to
+ * quit out of a `Terminal` prompt for input (usually by entering `ctrl`+`c`).
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export class QuitException extends TaggedError("QuitException") {}
+/**
+ * @since 1.0.0
+ * @category tag
+ */
+export const Terminal = InternalTerminal.tag;
+//# sourceMappingURL=Terminal.js.map

package/dist/esm/Terminal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Terminal.js","names":["TaggedError","InternalTerminal","QuitException","Terminal","tag"],"sources":["../../src/Terminal.ts"],"sourcesContent":[null],"mappings":"AAIA,SAASA,WAAW,QAAQ,aAAa;AAIzC,OAAO,KAAKC,gBAAgB,MAAM,wBAAwB;AA0D1D;;;;;;;AAOA,OAAM,MAAOC,aAAc,SAAQF,WAAW,CAAC,eAAe,CAAK;AAEnE;;;;AAIA,OAAO,MAAMG,QAAQ,GAA4BF,gBAAgB,CAACG,GAAG"}

package/dist/esm/index.js

@@ -38,6 +38,10 @@ export * as Path from "./Path.js";
  * @since 1.0.0
  */
 export * as Runtime from "./Runtime.js";
+/**
+ * @since 1.0.0
+ */
+export * as Terminal from "./Terminal.js";
 /**
  * @since 1.0.0
  */

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["Command","CommandExecutor","Effectify","Error","FileSystem","HttpClient","HttpServer","KeyValueStore","Path","Runtime","Worker","WorkerError","WorkerRunner"],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,IAAI,MAAM,WAAW;AAEjC;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB"}
+{"version":3,"file":"index.js","names":["Command","CommandExecutor","Effectify","Error","FileSystem","HttpClient","HttpServer","KeyValueStore","Path","Runtime","Terminal","Worker","WorkerError","WorkerRunner"],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,IAAI,MAAM,WAAW;AAEjC;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB"}

package/dist/esm/internal/terminal.js

@@ -0,0 +1,4 @@
+import { Tag } from "effect/Context";
+/** @internal */
+export const tag = /*#__PURE__*/Tag("@effect/platform/Terminal");
+//# sourceMappingURL=terminal.js.map

package/dist/esm/internal/terminal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminal.js","names":["Tag","tag"],"sources":["../../../src/internal/terminal.ts"],"sourcesContent":[null],"mappings":"AAAA,SAASA,GAAG,QAAQ,gBAAgB;AAGpC;AACA,OAAO,MAAMC,GAAG,gBAAGD,GAAG,CAAoB,2BAA2B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/platform",
-  "version": "0.28.1",
+  "version": "0.28.3",
   "description": "Unified interfaces for common platform-specific services",
   "license": "MIT",
   "repository": {
@@ -172,6 +172,11 @@
       "import": "./dist/esm/Runtime.js",
       "default": "./dist/cjs/Runtime.js"
     },
+    "./Terminal": {
+      "types": "./dist/dts/Terminal.d.ts",
+      "import": "./dist/esm/Terminal.js",
+      "default": "./dist/cjs/Terminal.js"
+    },
     "./Worker": {
       "types": "./dist/dts/Worker.d.ts",
       "import": "./dist/esm/Worker.js",
@@ -277,6 +282,9 @@
       "Runtime": [
         "./dist/dts/Runtime.d.ts"
       ],
+      "Terminal": [
+        "./dist/dts/Terminal.d.ts"
+      ],
       "Worker": [
         "./dist/dts/Worker.d.ts"
       ],

package/src/Error.ts

@@ -33,7 +33,7 @@ export declare namespace PlatformError {
   export interface Base extends Data.Case {
     readonly [PlatformErrorTypeId]: typeof PlatformErrorTypeId
     readonly _tag: string
-    readonly module: "Command" | "FileSystem" | "Path" | "KeyValueStore" | "Clipboard" | "Stream"
+    readonly module: "Clipboard" | "Command" | "FileSystem" | "KeyValueStore" | "Path" | "Stream" | "Terminal"
     readonly method: string
     readonly message: string
   }

package/src/Terminal.ts

@@ -0,0 +1,80 @@
+/**
+ * @since 1.0.0
+ */
+import type { Tag } from "effect/Context"
+import { TaggedError } from "effect/Data"
+import type { Effect } from "effect/Effect"
+import type { Option } from "effect/Option"
+import type { PlatformError } from "./Error.js"
+import * as InternalTerminal from "./internal/terminal.js"
+
+/**
+ * A `Terminal` represents a command-line interface which can read input from a
+ * user and display messages to a user.
+ *
+ * @since 1.0.0
+ * @category models
+ */
+export interface Terminal {
+  /**
+   * Reads a single input event from the default standard input.
+   */
+  readonly readInput: Effect<never, QuitException, UserInput>
+  /**
+   * Displays text to the the default standard output.
+   */
+  readonly display: (text: string) => Effect<never, PlatformError, void>
+}
+
+/**
+ * @since 1.0.0
+ * @category model
+ */
+export interface Key {
+  /**
+   * The name of the key being pressed.
+   */
+  readonly name: string
+  /**
+   * If set to `true`, then the user is also holding down the `Ctrl` key.
+   */
+  readonly ctrl: boolean
+  /**
+   * If set to `true`, then the user is also holding down the `Meta` key.
+   */
+  readonly meta: boolean
+  /**
+   * If set to `true`, then the user is also holding down the `Shift` key.
+   */
+  readonly shift: boolean
+}
+
+/**
+ * @since 1.0.0
+ * @category model
+ */
+export interface UserInput {
+  /**
+   * The character read from the user (if any).
+   */
+  readonly input: Option<string>
+  /**
+   * The key that the user pressed.
+   */
+  readonly key: Key
+}
+
+/**
+ * A `QuitException` represents an exception that occurs when a user attempts to
+ * quit out of a `Terminal` prompt for input (usually by entering `ctrl`+`c`).
+ *
+ * @since 1.0.0
+ * @category model
+ */
+export class QuitException extends TaggedError("QuitException")<{}> {}
+
+/**
+ * @since 1.0.0
+ * @category tag
+ */
+export const Terminal: Tag<Terminal, Terminal> = InternalTerminal.tag

package/src/index.ts

@@ -48,6 +48,11 @@ export * as Path from "./Path.js"
  */
 export * as Runtime from "./Runtime.js"
 
+/**
+ * @since 1.0.0
+ */
+export * as Terminal from "./Terminal.js"
+
 /**
  * @since 1.0.0
  */

package/src/internal/terminal.ts

@@ -0,0 +1,5 @@
+import { Tag } from "effect/Context"
+import type * as Terminal from "../Terminal.js"
+
+/** @internal */
+export const tag = Tag<Terminal.Terminal>("@effect/platform/Terminal")