effect 2.0.0-next.42 → 2.0.0-next.44

package/Brand/dist/effect-Brand.cjs.prod.js

@@ -2,33 +2,228 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-require('../../dist/Either-3fab3796.cjs.prod.js');
-require('../../dist/Function-2e6b0cda.cjs.prod.js');
-require('../../dist/Option-02025c86.cjs.prod.js');
-require('../../dist/ReadonlyArray-8157f697.cjs.prod.js');
-var Brand_dist_effectBrand = require('../../dist/Brand-93578f43.cjs.prod.js');
-require('../../dist/Equivalence-0bc84518.cjs.prod.js');
-require('../../dist/Either-d03d5f05.cjs.prod.js');
-require('../../dist/Equal-ce9977a8.cjs.prod.js');
-require('../../dist/Hash-1bd73210.cjs.prod.js');
-require('../../dist/GlobalValue-cb645c99.cjs.prod.js');
-require('../../dist/Utils-864e1d48.cjs.prod.js');
-require('../../dist/Predicate-daa86e61.cjs.prod.js');
-require('../../dist/Inspectable-3c4a0f5d.cjs.prod.js');
-require('../../dist/Effectable-f867d1cb.cjs.prod.js');
-require('../../dist/Data-07dc27f1.cjs.prod.js');
-require('../../dist/Pipeable-d3ec6711.cjs.prod.js');
-require('../../dist/Number-cb2ba2e8.cjs.prod.js');
-require('../../dist/Order-8a112bfb.cjs.prod.js');
+var Either_dist_effectEither = require('../../Either/dist/effect-Either.cjs.prod.js');
+var Function_dist_effectFunction = require('../../Function/dist/effect-Function.cjs.prod.js');
+var Option_dist_effectOption = require('../../Option/dist/effect-Option.cjs.prod.js');
+var ReadonlyArray_dist_effectReadonlyArray = require('../../ReadonlyArray/dist/effect-ReadonlyArray.cjs.prod.js');
+require('../../Equivalence/dist/effect-Equivalence.cjs.prod.js');
+require('../../dist/Either-7a881c7a.cjs.prod.js');
+require('../../Equal/dist/effect-Equal.cjs.prod.js');
+require('../../Hash/dist/effect-Hash.cjs.prod.js');
+require('../../GlobalValue/dist/effect-GlobalValue.cjs.prod.js');
+require('../../Utils/dist/effect-Utils.cjs.prod.js');
+require('../../Predicate/dist/effect-Predicate.cjs.prod.js');
+require('../../Inspectable/dist/effect-Inspectable.cjs.prod.js');
+require('../../dist/Effectable-cd8f3a96.cjs.prod.js');
+require('../../Data/dist/effect-Data.cjs.prod.js');
+require('../../Pipeable/dist/effect-Pipeable.cjs.prod.js');
+require('../../Number/dist/effect-Number.cjs.prod.js');
+require('../../Order/dist/effect-Order.cjs.prod.js');
 require('../../dist/ReadonlyArray-f9ed7a05.cjs.prod.js');
-require('../../dist/ReadonlyRecord-8db8bada.cjs.prod.js');
+require('../../ReadonlyRecord/dist/effect-ReadonlyRecord.cjs.prod.js');
 
+/**
+ * This module provides types and utility functions to create and work with branded types,
+ * which are TypeScript types with an added type tag to prevent accidental usage of a value in the wrong context.
+ *
+ * The `refined` and `nominal` functions are both used to create branded types in TypeScript.
+ * The main difference between them is that `refined` allows for validation of the data, while `nominal` does not.
+ *
+ * The `nominal` function is used to create a new branded type that has the same underlying type as the input, but with a different name.
+ * This is useful when you want to distinguish between two values of the same type that have different meanings.
+ * The `nominal` function does not perform any validation of the input data.
+ *
+ * On the other hand, the `refined` function is used to create a new branded type that has the same underlying type as the input,
+ * but with a different name, and it also allows for validation of the input data.
+ * The `refined` function takes a predicate that is used to validate the input data.
+ * If the input data fails the validation, a `BrandErrors` is returned, which provides information about the specific validation failure.
+ *
+ * @since 2.0.0
+ */
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+const BrandTypeId = /*#__PURE__*/Symbol.for("effect/Brand");
 
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
 
-exports.BrandTypeId = Brand_dist_effectBrand.BrandTypeId;
-exports.RefinedConstructorsTypeId = Brand_dist_effectBrand.RefinedConstructorsTypeId;
-exports.all = Brand_dist_effectBrand.all;
-exports.error = Brand_dist_effectBrand.error;
-exports.errors = Brand_dist_effectBrand.errors;
-exports.nominal = Brand_dist_effectBrand.nominal;
-exports.refined = Brand_dist_effectBrand.refined;
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+const RefinedConstructorsTypeId = /*#__PURE__*/Symbol.for("effect/Brand/Refined");
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+
+/**
+ * A generic interface that defines a branded type.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ */
+
+/**
+ * @category alias
+ * @since 2.0.0
+ */
+
+/**
+ * Returns a `BrandErrors` that contains a single `RefinementError`.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const error = (message, meta) => [{
+  message,
+  meta
+}];
+
+/**
+ * Takes a variable number of `BrandErrors` and returns a single `BrandErrors` that contains all refinement errors.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const errors = (...errors) => ReadonlyArray_dist_effectReadonlyArray.flatten(errors);
+
+/**
+ * Returns a `Brand.Constructor` that can construct a branded type from an unbranded value using the provided `refinement`
+ * predicate as validation of the input data.
+ *
+ * If you don't want to perform any validation but only distinguish between two values of the same type but with different meanings,
+ * see {@link nominal}.
+ *
+ * @param refinement - The refinement predicate to apply to the unbranded value.
+ * @param onFailure - Takes the unbranded value that did not pass the `refinement` predicate and returns a `BrandErrors`.
+ *
+ * @example
+ * import * as Brand from "effect/Brand"
+ *
+ * type Int = number & Brand.Brand<"Int">
+ *
+ * const Int = Brand.refined<Int>(
+ *   (n) => Number.isInteger(n),
+ *   (n) => Brand.error(`Expected ${n} to be an integer`)
+ * )
+ *
+ * assert.strictEqual(Int(1), 1)
+ * assert.throws(() => Int(1.1))
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const refined = (refinement, onFailure) => {
+  const either = args => refinement(args) ? Either_dist_effectEither.right(args) : Either_dist_effectEither.left(onFailure(args));
+  // @ts-expect-error
+  return Object.assign(args => Either_dist_effectEither.match(either(args), {
+    onLeft: e => {
+      throw e;
+    },
+    onRight: Function_dist_effectFunction.identity
+  }), {
+    [RefinedConstructorsTypeId]: RefinedConstructorsTypeId,
+    option: args => Option_dist_effectOption.getRight(either(args)),
+    either,
+    is: args => Either_dist_effectEither.isRight(either(args))
+  });
+};
+
+/**
+ * This function returns a `Brand.Constructor` that **does not apply any runtime checks**, it just returns the provided value.
+ * It can be used to create nominal types that allow distinguishing between two values of the same type but with different meanings.
+ *
+ * If you also want to perform some validation, see {@link refined}.
+ *
+ * @example
+ * import * as Brand from "effect/Brand"
+ *
+ * type UserId = number & Brand.Brand<"UserId">
+ *
+ * const UserId = Brand.nominal<UserId>()
+ *
+ * assert.strictEqual(UserId(1), 1)
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const nominal = () => {
+  // @ts-expect-error
+  return Object.assign(args => args, {
+    [RefinedConstructorsTypeId]: RefinedConstructorsTypeId,
+    option: args => Option_dist_effectOption.some(args),
+    either: args => Either_dist_effectEither.right(args),
+    is: _args => true
+  });
+};
+
+/**
+ * Combines two or more brands together to form a single branded type.
+ * This API is useful when you want to validate that the input data passes multiple brand validators.
+ *
+ * @example
+ * import * as Brand from "effect/Brand"
+ *
+ * type Int = number & Brand.Brand<"Int">
+ * const Int = Brand.refined<Int>(
+ *   (n) => Number.isInteger(n),
+ *   (n) => Brand.error(`Expected ${n} to be an integer`)
+ * )
+ * type Positive = number & Brand.Brand<"Positive">
+ * const Positive = Brand.refined<Positive>(
+ *   (n) => n > 0,
+ *   (n) => Brand.error(`Expected ${n} to be positive`)
+ * )
+ *
+ * const PositiveInt = Brand.all(Int, Positive)
+ *
+ * assert.strictEqual(PositiveInt(1), 1)
+ * assert.throws(() => PositiveInt(1.1))
+ *
+ * @since 2.0.0
+ * @category combining
+ */
+const all = (...brands) => {
+  const either = args => {
+    let result = Either_dist_effectEither.right(args);
+    for (const brand of brands) {
+      const nextResult = brand.either(args);
+      if (Either_dist_effectEither.isLeft(result) && Either_dist_effectEither.isLeft(nextResult)) {
+        result = Either_dist_effectEither.left([...result.left, ...nextResult.left]);
+      } else {
+        result = Either_dist_effectEither.isLeft(result) ? result : nextResult;
+      }
+    }
+    return result;
+  };
+  // @ts-expect-error
+  return Object.assign(args => Either_dist_effectEither.match(either(args), {
+    onLeft: e => {
+      throw e;
+    },
+    onRight: Function_dist_effectFunction.identity
+  }), {
+    [RefinedConstructorsTypeId]: RefinedConstructorsTypeId,
+    option: args => Option_dist_effectOption.getRight(either(args)),
+    either,
+    is: args => Either_dist_effectEither.isRight(either(args))
+  });
+};
+
+exports.BrandTypeId = BrandTypeId;
+exports.RefinedConstructorsTypeId = RefinedConstructorsTypeId;
+exports.all = all;
+exports.error = error;
+exports.errors = errors;
+exports.nominal = nominal;
+exports.refined = refined;

package/Cache/dist/effect-Cache.cjs.dev.js

@@ -2,85 +2,190 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-require('../../dist/cache-6a9fa3c2.cjs.dev.js');
-var Cache_dist_effectCache = require('../../dist/Cache-b1fd7d93.cjs.dev.js');
-require('../../dist/Context-3c9e986b.cjs.dev.js');
-require('../../dist/Context-96739709.cjs.dev.js');
-require('../../dist/Equal-281b6ca8.cjs.dev.js');
-require('../../dist/Hash-bd154268.cjs.dev.js');
-require('../../dist/Function-41ce433d.cjs.dev.js');
-require('../../dist/GlobalValue-81ab6908.cjs.dev.js');
-require('../../dist/Utils-b0c14d1b.cjs.dev.js');
-require('../../dist/Predicate-9e859c9c.cjs.dev.js');
-require('../../dist/Inspectable-ac929af4.cjs.dev.js');
-require('../../dist/Option-03997d77.cjs.dev.js');
-require('../../dist/Equivalence-de7a0d51.cjs.dev.js');
-require('../../dist/Either-9c349424.cjs.dev.js');
-require('../../dist/Effectable-a6403e5f.cjs.dev.js');
-require('../../dist/Data-85559fb3.cjs.dev.js');
-require('../../dist/Pipeable-4698db72.cjs.dev.js');
-require('../../dist/Number-588f6483.cjs.dev.js');
-require('../../dist/Order-28bdebd2.cjs.dev.js');
-require('../../dist/Deferred-e92635ac.cjs.dev.js');
-require('../../dist/core-3ddc73fc.cjs.dev.js');
-require('../../dist/Chunk-bd290b8e.cjs.dev.js');
-require('../../dist/ReadonlyArray-48949ee7.cjs.dev.js');
-require('../../dist/Either-a806809d.cjs.dev.js');
+var cache = require('../../dist/cache-e1ea3923.cjs.dev.js');
+require('../../Context/dist/effect-Context.cjs.dev.js');
+require('../../dist/Context-593661f6.cjs.dev.js');
+require('../../Equal/dist/effect-Equal.cjs.dev.js');
+require('../../Hash/dist/effect-Hash.cjs.dev.js');
+require('../../Function/dist/effect-Function.cjs.dev.js');
+require('../../GlobalValue/dist/effect-GlobalValue.cjs.dev.js');
+require('../../Utils/dist/effect-Utils.cjs.dev.js');
+require('../../Predicate/dist/effect-Predicate.cjs.dev.js');
+require('../../Inspectable/dist/effect-Inspectable.cjs.dev.js');
+require('../../Option/dist/effect-Option.cjs.dev.js');
+require('../../Equivalence/dist/effect-Equivalence.cjs.dev.js');
+require('../../dist/Either-12bbe00c.cjs.dev.js');
+require('../../dist/Effectable-2f022879.cjs.dev.js');
+require('../../Data/dist/effect-Data.cjs.dev.js');
+require('../../Pipeable/dist/effect-Pipeable.cjs.dev.js');
+require('../../Number/dist/effect-Number.cjs.dev.js');
+require('../../Order/dist/effect-Order.cjs.dev.js');
+require('../../Deferred/dist/effect-Deferred.cjs.dev.js');
+require('../../dist/core-b4d7b4f5.cjs.dev.js');
+require('../../Chunk/dist/effect-Chunk.cjs.dev.js');
+require('../../ReadonlyArray/dist/effect-ReadonlyArray.cjs.dev.js');
+require('../../Either/dist/effect-Either.cjs.dev.js');
 require('../../dist/ReadonlyArray-9a1474f6.cjs.dev.js');
-require('../../dist/ReadonlyRecord-605a625b.cjs.dev.js');
-require('../../dist/Differ-0122f60e.cjs.dev.js');
-require('../../dist/HashMap-68e290b6.cjs.dev.js');
-require('../../dist/HashSet-ece2cfe8.cjs.dev.js');
+require('../../ReadonlyRecord/dist/effect-ReadonlyRecord.cjs.dev.js');
+require('../../Differ/dist/effect-Differ.cjs.dev.js');
+require('../../HashMap/dist/effect-HashMap.cjs.dev.js');
+require('../../dist/HashSet-0b4ff1e4.cjs.dev.js');
 require('../../dist/Stack-ada2d201.cjs.dev.js');
-require('../../dist/HashSet-6978c08e.cjs.dev.js');
-require('../../dist/FiberId-929dcce4.cjs.dev.js');
-require('../../dist/MutableRef-724c4082.cjs.dev.js');
-require('../../dist/List-c6ea7efe.cjs.dev.js');
-require('../../dist/RuntimeFlagsPatch-130e990c.cjs.dev.js');
-require('../../dist/Duration-604874d1.cjs.dev.js');
-require('../../dist/Exit-b702e23f.cjs.dev.js');
-require('../../dist/MutableHashMap-74e83e84.cjs.dev.js');
-require('../../dist/MutableQueue-0e9f2466.cjs.dev.js');
-require('../../dist/MutableList-58124ef2.cjs.dev.js');
-require('../../dist/core-effect-0b09eb55.cjs.dev.js');
-require('../../dist/Clock-dd715d18.cjs.dev.js');
-require('../../dist/defaultServices-101983cd.cjs.dev.js');
+require('../../HashSet/dist/effect-HashSet.cjs.dev.js');
+require('../../dist/FiberId-557db880.cjs.dev.js');
+require('../../MutableRef/dist/effect-MutableRef.cjs.dev.js');
+require('../../List/dist/effect-List.cjs.dev.js');
+require('../../dist/RuntimeFlagsPatch-ea268c50.cjs.dev.js');
+require('../../Duration/dist/effect-Duration.cjs.dev.js');
+require('../../Exit/dist/effect-Exit.cjs.dev.js');
+require('../../MutableHashMap/dist/effect-MutableHashMap.cjs.dev.js');
+require('../../MutableQueue/dist/effect-MutableQueue.cjs.dev.js');
+require('../../MutableList/dist/effect-MutableList.cjs.dev.js');
+require('../../dist/core-effect-892f3686.cjs.dev.js');
+require('../../Clock/dist/effect-Clock.cjs.dev.js');
+require('../../dist/defaultServices-5530ff0e.cjs.dev.js');
 require('../../dist/timeout-d380d3f8.cjs.dev.js');
-require('../../dist/configProvider-e8277224.cjs.dev.js');
-require('../../dist/config-a57559a0.cjs.dev.js');
-require('../../dist/ConfigError-c1f762d2.cjs.dev.js');
-require('../../dist/configError-1686533e.cjs.dev.js');
-require('../../dist/configSecret-5812fa69.cjs.dev.js');
-require('../../dist/pathPatch-e46d4168.cjs.dev.js');
-require('../../dist/FiberRefs-ec1734cb.cjs.dev.js');
-require('../../dist/fiberRefs-1a0bda7d.cjs.dev.js');
-require('../../dist/patch-d5f75194.cjs.dev.js');
-require('../../dist/label-246fb11d.cjs.dev.js');
-require('../../dist/LogLevel-91738879.cjs.dev.js');
-require('../../dist/LogSpan-e345ba58.cjs.dev.js');
-require('../../dist/Ref-f41d9514.cjs.dev.js');
-require('../../dist/Tracer-81751f09.cjs.dev.js');
-require('../../dist/fiberRuntime-9699a6b8.cjs.dev.js');
-require('../../dist/Boolean-f0bc3abf.cjs.dev.js');
-require('../../dist/ExecutionStrategy-89fbe735.cjs.dev.js');
-require('../../dist/FiberRefsPatch-efbeff91.cjs.dev.js');
-require('../../dist/FiberStatus-bac7d58d.cjs.dev.js');
-require('../../dist/fiber-e68a3beb.cjs.dev.js');
-require('../../dist/boundaries-03c7494a.cjs.dev.js');
-require('../../dist/key-a474fc0d.cjs.dev.js');
-require('../../dist/keyType-1e916ae2.cjs.dev.js');
-require('../../dist/registry-c883cf52.cjs.dev.js');
-require('../../dist/hook-822704ea.cjs.dev.js');
-require('../../dist/state-8a8a647c.cjs.dev.js');
-require('../../dist/pair-08a8685e.cjs.dev.js');
-require('../../dist/SortedSet-f90b14a2.cjs.dev.js');
-require('../../dist/RedBlackTree-e6bd147c.cjs.dev.js');
-require('../../dist/Scheduler-23a6506c.cjs.dev.js');
+require('../../dist/configProvider-ce43fdbf.cjs.dev.js');
+require('../../dist/config-80900693.cjs.dev.js');
+require('../../ConfigError/dist/effect-ConfigError.cjs.dev.js');
+require('../../dist/configError-240e9b61.cjs.dev.js');
+require('../../dist/configSecret-e34c1b14.cjs.dev.js');
+require('../../dist/pathPatch-d9d41297.cjs.dev.js');
+require('../../FiberRefs/dist/effect-FiberRefs.cjs.dev.js');
+require('../../dist/fiberRefs-be4fae6a.cjs.dev.js');
+require('../../dist/patch-a1b2802f.cjs.dev.js');
+require('../../dist/label-011edbe7.cjs.dev.js');
+require('../../LogLevel/dist/effect-LogLevel.cjs.dev.js');
+require('../../LogSpan/dist/effect-LogSpan.cjs.dev.js');
+require('../../dist/Ref-74b592a4.cjs.dev.js');
+require('../../Tracer/dist/effect-Tracer.cjs.dev.js');
+require('../../dist/fiberRuntime-c7280769.cjs.dev.js');
+require('../../Boolean/dist/effect-Boolean.cjs.dev.js');
+require('../../dist/ExecutionStrategy-70f1a920.cjs.dev.js');
+require('../../FiberRefsPatch/dist/effect-FiberRefsPatch.cjs.dev.js');
+require('../../FiberStatus/dist/effect-FiberStatus.cjs.dev.js');
+require('../../dist/fiber-1bfb4c1d.cjs.dev.js');
+require('../../dist/boundaries-3810d885.cjs.dev.js');
+require('../../dist/key-f0a1408a.cjs.dev.js');
+require('../../dist/keyType-55f27f07.cjs.dev.js');
+require('../../dist/registry-1099de3f.cjs.dev.js');
+require('../../dist/hook-e72b20fd.cjs.dev.js');
+require('../../dist/state-8fbec044.cjs.dev.js');
+require('../../dist/pair-291b78d7.cjs.dev.js');
+require('../../SortedSet/dist/effect-SortedSet.cjs.dev.js');
+require('../../RedBlackTree/dist/effect-RedBlackTree.cjs.dev.js');
+require('../../Scheduler/dist/effect-Scheduler.cjs.dev.js');
 
+/**
+ * @since 2.0.0
+ */
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+const CacheTypeId = cache.CacheTypeId;
 
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
 
-exports.CacheTypeId = Cache_dist_effectCache.CacheTypeId;
-exports.make = Cache_dist_effectCache.make;
-exports.makeCacheStats = Cache_dist_effectCache.makeCacheStats;
-exports.makeEntryStats = Cache_dist_effectCache.makeEntryStats;
-exports.makeWith = Cache_dist_effectCache.makeWith;
+/**
+ * A `Cache` is defined in terms of a lookup function that, given a key of
+ * type `Key`, can either fail with an error of type `Error` or succeed with a
+ * value of type `Value`. Getting a value from the cache will either return
+ * the previous result of the lookup function if it is available or else
+ * compute a new result with the lookup function, put it in the cache, and
+ * return it.
+ *
+ * A cache also has a specified capacity and time to live. When the cache is
+ * at capacity the least recently accessed values in the cache will be
+ * removed to make room for new values. Getting a value with a life older than
+ * the specified time to live will result in a new value being computed with
+ * the lookup function and returned when available.
+ *
+ * The cache is safe for concurrent access. If multiple fibers attempt to get
+ * the same key the lookup function will only be computed once and the result
+ * will be returned to all fibers.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * A ConsumerCache models a portion of a cache which is safe to share without allowing to create new values or access existing ones.
+ *
+ * It can be used safely to give over control for request management without leaking writer side details.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * @since 2.0.0
+ */
+
+/**
+ * Constructs a new cache with the specified capacity, time to live, and
+ * lookup function.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const make = cache.make;
+
+/**
+ * Constructs a new cache with the specified capacity, time to live, and
+ * lookup function, where the time to live can depend on the `Exit` value
+ * returned by the lookup function.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const makeWith = cache.makeWith;
+
+/**
+ * `CacheStats` represents a snapshot of statistics for the cache as of a
+ * point in time.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * Constructs a new `CacheStats` from the specified values.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const makeCacheStats = cache.makeCacheStats;
+
+/**
+ * Represents a snapshot of statistics for an entry in the cache.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+
+/**
+ * Constructs a new `EntryStats` from the specified values.
+ *
+ * @since 2.0.0
+ * @category constructors
+ */
+const makeEntryStats = cache.makeEntryStats;
+
+/**
+ * A `Lookup` represents a lookup function that, given a key of type `Key`, can
+ * return an effect that will either produce a value of type `Value` or fail
+ * with an error of type `Error` using an environment of type `Environment`.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+
+exports.CacheTypeId = CacheTypeId;
+exports.make = make;
+exports.makeCacheStats = makeCacheStats;
+exports.makeEntryStats = makeEntryStats;
+exports.makeWith = makeWith;