@effect/platform 0.82.8 → 0.84.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effect/platform",
-  "version": "0.82.8",
+  "version": "0.84.0",
   "description": "Unified interfaces for common platform-specific services",
   "license": "MIT",
   "repository": {
@@ -16,7 +16,7 @@
     "multipasta": "^0.2.5"
   },
   "peerDependencies": {
-    "effect": "^3.15.4"
+    "effect": "^3.16.0"
   },
   "publishConfig": {
     "provenance": true

package/src/Error.ts

@@ -4,32 +4,26 @@
 import type * as Cause from "effect/Cause"
 import * as Data from "effect/Data"
 import * as Predicate from "effect/Predicate"
+import * as Schema from "effect/Schema"
 import type { Simplify } from "effect/Types"
-import * as internal from "./internal/error.js"
 
 /**
  * @since 1.0.0
  * @category type id
  */
-export const PlatformErrorTypeId: unique symbol = internal.PlatformErrorTypeId
+export const TypeId: unique symbol = Symbol.for("@effect/platform/Error")
 
 /**
  * @since 1.0.0
  * @category type id
  */
-export type PlatformErrorTypeId = typeof PlatformErrorTypeId
+export type TypeId = typeof TypeId
 
 /**
  * @since 1.0.0
  * @category refinements
  */
-export const isPlatformError = (u: unknown): u is PlatformError => Predicate.hasProperty(u, PlatformErrorTypeId)
-
-/**
- * @since 1.0.0
- * @category error
- */
-export type PlatformError = BadArgument | SystemError
+export const isPlatformError = (u: unknown): u is PlatformError => Predicate.hasProperty(u, TypeId)
 
 /**
  * @since 1.0.0
@@ -56,70 +50,104 @@ export const TypeIdError = <const TypeId extends symbol, const Tag extends strin
 
 /**
  * @since 1.0.0
+ * @category Models
  */
-export declare namespace PlatformError {
+export const Module = Schema.Literal(
+  "Clipboard",
+  "Command",
+  "FileSystem",
+  "KeyValueStore",
+  "Path",
+  "Stream",
+  "Terminal"
+)
+
+/**
+ * @since 1.0.0
+ * @category Models
+ */
+export class BadArgument extends Schema.TaggedError<BadArgument>("@effect/platform/Error/BadArgument")("BadArgument", {
+  module: Module,
+  method: Schema.String,
+  description: Schema.optional(Schema.String),
+  cause: Schema.optional(Schema.Defect)
+}) {
   /**
    * @since 1.0.0
-   * @category models
    */
-  export interface Base {
-    readonly [PlatformErrorTypeId]: typeof PlatformErrorTypeId
-    readonly _tag: string
-    readonly module: "Clipboard" | "Command" | "FileSystem" | "KeyValueStore" | "Path" | "Stream" | "Terminal"
-    readonly method: string
-    readonly message: string
-  }
+  readonly [TypeId]: typeof TypeId = TypeId
 
   /**
    * @since 1.0.0
    */
-  export type ProvidedFields = PlatformErrorTypeId | "_tag"
+  get message(): string {
+    return `${this.module}.${this.method}${this.description ? `: ${this.description}` : ""}`
+  }
 }
 
 /**
  * @since 1.0.0
- * @category error
+ * @category Model
  */
-export interface BadArgument extends PlatformError.Base {
-  readonly _tag: "BadArgument"
-}
+export const SystemErrorReason = Schema.Literal(
+  "AlreadyExists",
+  "BadResource",
+  "Busy",
+  "InvalidData",
+  "NotFound",
+  "PermissionDenied",
+  "TimedOut",
+  "UnexpectedEof",
+  "Unknown",
+  "WouldBlock",
+  "WriteZero"
+)
 
 /**
  * @since 1.0.0
- * @category error
+ * @category Model
  */
-export const BadArgument: (props: Omit<BadArgument, PlatformError.ProvidedFields>) => BadArgument = internal.badArgument
+export type SystemErrorReason = typeof SystemErrorReason.Type
 
 /**
  * @since 1.0.0
- * @category model
+ * @category models
  */
-export type SystemErrorReason =
-  | "AlreadyExists"
-  | "BadResource"
-  | "Busy"
-  | "InvalidData"
-  | "NotFound"
-  | "PermissionDenied"
-  | "TimedOut"
-  | "UnexpectedEof"
-  | "Unknown"
-  | "WouldBlock"
-  | "WriteZero"
+export class SystemError extends Schema.TaggedError<SystemError>("@effect/platform/Error/SystemError")("SystemError", {
+  reason: SystemErrorReason,
+  module: Module,
+  method: Schema.String,
+  description: Schema.optional(Schema.String),
+  syscall: Schema.optional(Schema.String),
+  pathOrDescriptor: Schema.optional(Schema.Union(Schema.String, Schema.Number)),
+  cause: Schema.optional(Schema.Defect)
+}) {
+  /**
+   * @since 1.0.0
+   */
+  readonly [TypeId]: typeof TypeId = TypeId
+
+  /**
+   * @since 1.0.0
+   */
+  get message(): string {
+    return `${this.reason}: ${this.module}.${this.method}${
+      this.pathOrDescriptor !== undefined ? ` (${this.pathOrDescriptor})` : ""
+    }${this.description ? `: ${this.description}` : ""}`
+  }
+}
 
 /**
  * @since 1.0.0
- * @category models
+ * @category Models
  */
-export interface SystemError extends PlatformError.Base {
-  readonly _tag: "SystemError"
-  readonly reason: SystemErrorReason
-  readonly syscall?: string | undefined
-  readonly pathOrDescriptor: string | number
-}
+export type PlatformError = BadArgument | SystemError
 
 /**
  * @since 1.0.0
- * @category error
+ * @category Models
  */
-export const SystemError: (props: Omit<SystemError, PlatformError.ProvidedFields>) => SystemError = internal.systemError
+export const PlatformError: Schema.Union<[
+  typeof BadArgument,
+  typeof SystemError
+]> = Schema.Union(BadArgument, SystemError)

package/src/PlatformConfigProvider.ts

@@ -48,7 +48,7 @@ export const fromFileTree = (options?: {
       const sourceError = (pathSegments: ReadonlyArray<string>, error: PlatformError) =>
         ConfigError.SourceUnavailable(
           [...pathSegments],
-          error.message,
+          error.description ?? error.message,
           Cause.fail(error)
         )
       const pathNotFoundError = (pathSegments: ReadonlyArray<string>) =>

package/src/internal/fileSystem.ts

@@ -49,11 +49,12 @@ export const make = (
     readFileString: (path, encoding) =>
       Effect.tryMap(impl.readFile(path), {
         try: (_) => new TextDecoder(encoding).decode(_),
-        catch: () =>
-          Error.BadArgument({
+        catch: (cause) =>
+          new Error.BadArgument({
             module: "FileSystem",
             method: "readFileString",
-            message: "invalid encoding"
+            description: "invalid encoding",
+            cause
           })
       }),
     stream: (path, options) =>
@@ -75,11 +76,12 @@ export const make = (
       Effect.flatMap(
         Effect.try({
           try: () => new TextEncoder().encode(data),
-          catch: () =>
-            Error.BadArgument({
+          catch: (cause) =>
+            new Error.BadArgument({
               module: "FileSystem",
               method: "writeFileString",
-              message: "could not encode string"
+              description: "could not encode string",
+              cause
             })
         }),
         (_) => impl.writeFile(path, _, options)
@@ -88,11 +90,11 @@ export const make = (
 }
 
 const notFound = (method: string, path: string) =>
-  Error.SystemError({
+  new Error.SystemError({
     module: "FileSystem",
     method,
     reason: "NotFound",
-    message: "No such file or directory",
+    description: "No such file or directory",
     pathOrDescriptor: path
   })
 

package/src/internal/keyValueStore.ts

@@ -247,8 +247,8 @@ export const layerSchema = <A, I, R>(
 }
 
 /** @internal */
-const storageError = (props: Omit<Parameters<typeof PlatformError.SystemError>[0], "reason" | "module">) =>
-  PlatformError.SystemError({
+const storageError = (props: Omit<ConstructorParameters<typeof PlatformError.SystemError>[0], "reason" | "module">) =>
+  new PlatformError.SystemError({
     reason: "PermissionDenied",
     module: "KeyValueStore",
     ...props
@@ -266,7 +266,7 @@ export const layerStorage = (evaluate: LazyArg<Storage>) =>
             storageError({
               pathOrDescriptor: key,
               method: "get",
-              message: `Unable to get item with key ${key}`
+              description: `Unable to get item with key ${key}`
             })
         }),
 
@@ -277,7 +277,7 @@ export const layerStorage = (evaluate: LazyArg<Storage>) =>
             storageError({
               pathOrDescriptor: key,
               method: "set",
-              message: `Unable to set item with key ${key}`
+              description: `Unable to set item with key ${key}`
             })
         }),
 
@@ -288,7 +288,7 @@ export const layerStorage = (evaluate: LazyArg<Storage>) =>
             storageError({
               pathOrDescriptor: key,
               method: "remove",
-              message: `Unable to remove item with key ${key}`
+              description: `Unable to remove item with key ${key}`
             })
         }),
 
@@ -298,7 +298,7 @@ export const layerStorage = (evaluate: LazyArg<Storage>) =>
           storageError({
             pathOrDescriptor: "clear",
             method: "clear",
-            message: `Unable to clear storage`
+            description: `Unable to clear storage`
           })
       }),
 
@@ -308,7 +308,7 @@ export const layerStorage = (evaluate: LazyArg<Storage>) =>
           storageError({
             pathOrDescriptor: "size",
             method: "size",
-            message: `Unable to get size`
+            description: `Unable to get size`
           })
       })
     })

package/src/internal/path.ts

@@ -105,28 +105,34 @@ function _format(sep: string, pathObject: Partial<Api.Path.Parsed>) {
 
 function fromFileUrl(url: URL): Effect.Effect<string, BadArgument> {
   if (url.protocol !== "file:") {
-    return Effect.fail(BadArgument({
-      module: "Path",
-      method: "fromFileUrl",
-      message: "URL must be of scheme file"
-    }))
+    return Effect.fail(
+      new BadArgument({
+        module: "Path",
+        method: "fromFileUrl",
+        description: "URL must be of scheme file"
+      })
+    )
   } else if (url.hostname !== "") {
-    return Effect.fail(BadArgument({
-      module: "Path",
-      method: "fromFileUrl",
-      message: "Invalid file URL host"
-    }))
+    return Effect.fail(
+      new BadArgument({
+        module: "Path",
+        method: "fromFileUrl",
+        description: "Invalid file URL host"
+      })
+    )
   }
   const pathname = url.pathname
   for (let n = 0; n < pathname.length; n++) {
     if (pathname[n] === "%") {
       const third = pathname.codePointAt(n + 2)! | 0x20
       if (pathname[n + 1] === "2" && third === 102) {
-        return Effect.fail(BadArgument({
-          module: "Path",
-          method: "fromFileUrl",
-          message: "must not include encoded / characters"
-        }))
+        return Effect.fail(
+          new BadArgument({
+            module: "Path",
+            method: "fromFileUrl",
+            description: "must not include encoded / characters"
+          })
+        )
       }
     }
   }

package/dist/cjs/internal/error.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.systemError = exports.badArgument = exports.PlatformErrorTypeId = void 0;
-var Data = _interopRequireWildcard(require("effect/Data"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-/** @internal */
-const PlatformErrorTypeId = exports.PlatformErrorTypeId = /*#__PURE__*/Symbol.for("@effect/platform/Error/PlatformErrorTypeId");
-const make = tag => props => Data.struct({
-  [PlatformErrorTypeId]: PlatformErrorTypeId,
-  _tag: tag,
-  ...props
-});
-/** @internal */
-const badArgument = exports.badArgument = /*#__PURE__*/make("BadArgument");
-/** @internal */
-const systemError = exports.systemError = /*#__PURE__*/make("SystemError");
-//# sourceMappingURL=error.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"error.js","names":["Data","_interopRequireWildcard","require","e","t","WeakMap","r","n","__esModule","o","i","f","__proto__","default","has","get","set","hasOwnProperty","call","Object","defineProperty","getOwnPropertyDescriptor","PlatformErrorTypeId","exports","Symbol","for","make","tag","props","struct","_tag","badArgument","systemError"],"sources":["../../../src/internal/error.ts"],"sourcesContent":[null],"mappings":";;;;;;AAAA,IAAAA,IAAA,GAAAC,uBAAA,CAAAC,OAAA;AAAmC,SAAAD,wBAAAE,CAAA,EAAAC,CAAA,6BAAAC,OAAA,MAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAJ,uBAAA,YAAAA,CAAAE,CAAA,EAAAC,CAAA,SAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA,MAAAM,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAC,OAAA,EAAAV,CAAA,iBAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,SAAAQ,CAAA,MAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAG,CAAA,CAAAK,GAAA,CAAAX,CAAA,UAAAM,CAAA,CAAAM,GAAA,CAAAZ,CAAA,GAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,EAAAQ,CAAA,gBAAAP,CAAA,IAAAD,CAAA,gBAAAC,CAAA,OAAAa,cAAA,CAAAC,IAAA,CAAAf,CAAA,EAAAC,CAAA,OAAAM,CAAA,IAAAD,CAAA,GAAAU,MAAA,CAAAC,cAAA,KAAAD,MAAA,CAAAE,wBAAA,CAAAlB,CAAA,EAAAC,CAAA,OAAAM,CAAA,CAAAK,GAAA,IAAAL,CAAA,CAAAM,GAAA,IAAAP,CAAA,CAAAE,CAAA,EAAAP,CAAA,EAAAM,CAAA,IAAAC,CAAA,CAAAP,CAAA,IAAAD,CAAA,CAAAC,CAAA,WAAAO,CAAA,KAAAR,CAAA,EAAAC,CAAA;AAGnC;AACO,MAAMkB,mBAAmB,GAAAC,OAAA,CAAAD,mBAAA,gBAA8BE,MAAM,CAACC,GAAG,CACtE,4CAA4C,CAChB;AAE9B,MAAMC,IAAI,GACwBC,GAAc,IAAMC,KAAkD,IACpG5B,IAAI,CAAC6B,MAAM,CAAC;EACV,CAACP,mBAAmB,GAAGA,mBAAmB;EAC1CQ,IAAI,EAAEH,GAAG;EACT,GAAGC;CACC,CAAC;AAEX;AACO,MAAMG,WAAW,GAAAR,OAAA,CAAAQ,WAAA,gBAAGL,IAAI,CAAoB,aAAa,CAAC;AAEjE;AACO,MAAMM,WAAW,GAAAT,OAAA,CAAAS,WAAA,gBAAGN,IAAI,CAAoB,aAAa,CAAC","ignoreList":[]}

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

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

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

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

package/dist/esm/internal/error.js

@@ -1,13 +0,0 @@
-import * as Data from "effect/Data";
-/** @internal */
-export const PlatformErrorTypeId = /*#__PURE__*/Symbol.for("@effect/platform/Error/PlatformErrorTypeId");
-const make = tag => props => Data.struct({
-  [PlatformErrorTypeId]: PlatformErrorTypeId,
-  _tag: tag,
-  ...props
-});
-/** @internal */
-export const badArgument = /*#__PURE__*/make("BadArgument");
-/** @internal */
-export const systemError = /*#__PURE__*/make("SystemError");
-//# sourceMappingURL=error.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"error.js","names":["Data","PlatformErrorTypeId","Symbol","for","make","tag","props","struct","_tag","badArgument","systemError"],"sources":["../../../src/internal/error.ts"],"sourcesContent":[null],"mappings":"AAAA,OAAO,KAAKA,IAAI,MAAM,aAAa;AAGnC;AACA,OAAO,MAAMC,mBAAmB,gBAA8BC,MAAM,CAACC,GAAG,CACtE,4CAA4C,CAChB;AAE9B,MAAMC,IAAI,GACwBC,GAAc,IAAMC,KAAkD,IACpGN,IAAI,CAACO,MAAM,CAAC;EACV,CAACN,mBAAmB,GAAGA,mBAAmB;EAC1CO,IAAI,EAAEH,GAAG;EACT,GAAGC;CACC,CAAC;AAEX;AACA,OAAO,MAAMG,WAAW,gBAAGL,IAAI,CAAoB,aAAa,CAAC;AAEjE;AACA,OAAO,MAAMM,WAAW,gBAAGN,IAAI,CAAoB,aAAa,CAAC","ignoreList":[]}

package/src/internal/error.ts

@@ -1,21 +0,0 @@
-import * as Data from "effect/Data"
-import type * as Error from "../Error.js"
-
-/** @internal */
-export const PlatformErrorTypeId: Error.PlatformErrorTypeId = Symbol.for(
-  "@effect/platform/Error/PlatformErrorTypeId"
-) as Error.PlatformErrorTypeId
-
-const make =
-  <A extends Error.PlatformError>(tag: A["_tag"]) => (props: Omit<A, Error.PlatformError.ProvidedFields>): A =>
-    Data.struct({
-      [PlatformErrorTypeId]: PlatformErrorTypeId,
-      _tag: tag,
-      ...props
-    } as A)
-
-/** @internal */
-export const badArgument = make<Error.BadArgument>("BadArgument")
-
-/** @internal */
-export const systemError = make<Error.SystemError>("SystemError")