ES Modules *and* a much smaller bundle

[chriskrycho]

💥 Changed

• The top-level namespace-style export has been removed. If you were relying on the static members to be present when doing import Maybe from 'true-myth/maybe' or import Result from 'true-myth/result';, you can replace them with import * as Maybe from 'true-myth/maybe'; or import * as Result from 'true-myth/result';. This should make for much better tree-shaking with bundlers like Rollup, which can see “through” a namespace import in a way they cannot with a manually-created namespace object. Where you want to maintain the type and namespace imports, you can do this:

  import * as Maybe from 'true-myth/maybe';
  type Maybe<T> = Maybe.Maybe<T>; // convenience alias

  In general, though, you should prefer to simply import the named functions instead:

  import Maybe, { transposeArray } from 'true-myth/maybe';

• There are no longer separate classes for Just, Nothing, Ok, and Err. This substantially reduces the size of the library, and should hopefully improve browsers' ability to optimize code using these, since there is now only one class in each case: Maybe and Result. The public API for the classes is unchanged, but if you relied on instanceof checks against those classes anywhere, those checks will no longer work.

• The exported Variant types are now frozen, constant objects, not TypeScript enums. This should not break anyone, since the only difference in observable behavior between an enum and a const is the ability to do a “reverse lookup” on an enum—but since the field names and their values are identical, this just means shipping less, and faster, code.

• The isJust, isNothing, isOk, and isErr methods have been converted to getters. This makes them muchmore immediately useful in contexts where invoking a function is annoying, for any reason—for example, in Ember templates.

• We no longer publish CommonJS modules, only ES Modules.

• Dropped support for Node versions earlier than Node 12 LTS.

• Support for versions of TypeScript before 4.0 have been removed, to enable the type-safe re-implementation of Maybe.all.

• The MaybeShape and ResultShape interfaces are no longer exported. These were never intended for public reimplementation, and there is accordingly no value in their continuing to be public.

• A number of aliases (originally designed to make migration from e.g. Folktale easier) have been removed:

  • cata: use match
  • chain and flatMap: use andThen
  • maybeify and transmogrify: use wrapReturn
  • unsafelyGet, unsafeGet, and unsafelyUnwrap: use .isJust/.isOk then .value
  • unsafelyGetErr and unsafelyUnwrapErr: use .isErr then .error
  • getOr: use unwrapOr
  • getOrElse: use unwrapOrElse
  • fromNullable and maybe:
    • import Maybe and use its static constructor Maybe.of
    • import the module as namespace and use Maybe.of
    • import of and alias it as you like

⭐ Added

• We introduced a new Maybe.transposeArray, which is a type-safe, renamed, merged version of Maybe.tuple and Maybe.all which can correctly handle both array and tuple types. To support this change, it now accepts arrays or tuples directly, and the variadic/spread arguments to all have been replaced with taking an array or tuple directly. While tuple and all are unchanged, they are also deprecated (see below).

  Before:

  import Maybe, { all, just, nothing, tuple } from 'true-myth/maybe';
  
  // arrays
  type ArrayResult = Maybe<Array<string | number>>;
  
  let mixedArray = [just("hello"), nothing<number>()];
  let mixedArrayResult: ArrayResult = all(...arrayOfMaybes);
  
  let allJustArray = [just("hello"), just(12)];
  let allJustArrayResult: ArrayResult = all(...allJustArray);
  
  type Tuple = [Maybe<number>, Maybe<string>];
  type TupleResult = Maybe<[number, string]>;
  
  let mixedTuple: Tuple = [just(12), just("hi")];
  let mixedTupleResult: TupleResult = tuple(mixedTuple);

  After:

  import Maybe, { arrayTranspose, just, nothing } from 'true-myth/maybe';
  
  // arrays
  type ArrayResult = Maybe<Array<string | number>>;
  
  let mixedArray = [just("hello"), nothing<number>()];
  let mixedArrayResult: ArrayResult = arrayTranspose(arrayOfMaybes);
  
  let allJustArray = [just("hello"), just(12)];
  let allJustArrayResult: ArrayResult = arrayTranspose(allJustArray);
  
  // Tuples now work with `arrayTranspose` as well.
  type Tuple = [Maybe<number>, Maybe<string>];
  type TupleResult = Maybe<[number, string]>;
  
  let mixedTuple: Tuple = [just(12), just("hi")];
  let mixedTupleResult: TupleResult = arrayTranspose(mixedTuple);

• Maybe.transpose and Result.transpose: for when you have a Maybe<Result<T, E>> or a Result<Maybe<T>, E> and need to invert them.

  import Maybe, { just, nothing } from 'true-myth/maybe';
  import Result, { ok, err } from 'true-myth/result';
  
  let anOkJust: Result<Maybe<number>, string> = ok(just(12));
  let maybe: Maybe<number>, string> = Maybe.transposeResult(anOkJust);
  console.log(maybe); // Just(Ok(12))
  
  let aJustOk: Maybe<Result<number, string>> = just(ok(12));
  let result: Maybe<Result<number, string>> = Result.transposeMaybe(aJustOk);
  console.log(result); // Ok(Just(12))

  See the docs for further details!

  Note: these are standalone functions, not methods, because TypeScript
  does not support conditionally supplying a method only for one specific type
  parameterization.

🟥 Deprecated

• Maybe.tuple and Maybe.all are deprecated in favor of Maybe.arrayTranspose now correctly handles both arrays and tuples. They will be removed not earlier than 6.0.0 (timeline not decided, but not sooner than when Node 12 LTS reaches end of life on April 30, 2022).

Full change list

• Bump ini from 1.3.5 to 1.3.7 by @dependabot in Bump ini from 1.3.5 to 1.3.7 #71
• Add Greetings workflow by @chriskrycho in Add Greetings workflow #78
• Create GH Actions CI Workflow by @chriskrycho in Create GH Actions CI Workflow #79
• Update supported Node versions by @chriskrycho in Update supported Node versions #77
• Switch to expect-type for type assertions by @chriskrycho in Switch to expect-type for type assertions #72
• Upgrade lint configuration and include it in CI by @chriskrycho in Upgrade lint configuration and include it in CI #81
• Upgrade jest to latest by @chriskrycho in Upgrade jest to latest #82
• Bump and run Prettier by @chriskrycho in Bump and run Prettier #83
• Fix Volta GH Action config by @chriskrycho in Fix Volta GH Action config #84
• Bump dev Node, yarn, and npm versions by @chriskrycho in Bump dev Node, yarn, and npm versions #85
• Add Ember Try config by @chriskrycho in Add Ember Try config #86
• [breaking] type-safe Maybe.all implementation by @chriskrycho in [breaking] type-safe Maybe.all implementation #88
• Upgrade TypeDoc to latest stable by @chriskrycho in Upgrade TypeDoc to latest stable #91
• [breaking] remove *Shape interface exports by @chriskrycho in [breaking] remove *Shape interface exports #93
• Remove all uses of any from the codebase by @chriskrycho in Remove all uses of any from the codebase #94
• Implement transpose by @chriskrycho in Implement transpose #95
• x2 the period by @netaisllc in x2 the period #100
• Perhaps the missing period.... by @netaisllc in Perhaps the missing period.... #99
• Reenable macOS in CI by @jrr in Reenable macOS in CI #103
• Update (and fix!) ember-try config by @chriskrycho in Update (and fix!) ember-try config #104
• Create Dependabot config file by @dependabot-preview in Create Dependabot config file #105
• Bump ts-jest from 26.4.4 to 26.5.5 by @dependabot in Bump ts-jest from 26.4.4 to 26.5.5 #112
• Bump ember-cli from 3.23.0 to 3.26.0 by @dependabot in Bump ember-cli from 3.23.0 to 3.26.0 #110
• Bump @types/jest from 26.0.19 to 26.0.22 by @dependabot in Bump @types/jest from 26.0.19 to 26.0.22 #111
• Bump rimraf from 2.6.3 to 3.0.2 by @dependabot in Bump rimraf from 2.6.3 to 3.0.2 #106
• Update badge for TS supported versions: 4.2 by @chriskrycho in Update badge for TS supported versions: 4.2 #115
• Bump typedoc from 0.20.20 to 0.20.35 by @dependabot in Bump typedoc from 0.20.20 to 0.20.35 #108
• Bump typescript from 4.1.3 to 4.2.4 by @dependabot in Bump typescript from 4.1.3 to 4.2.4 #114
• Bump eslint from 7.15.0 to 7.24.0 by @dependabot in Bump eslint from 7.15.0 to 7.24.0 #107
• Bump @typescript-eslint/parser from 4.14.1 to 4.22.0 by @dependabot in Bump @typescript-eslint/parser from 4.14.1 to 4.22.0 #109
• Bump ember-cli from 3.26.0 to 3.26.1 by @dependabot in Bump ember-cli from 3.26.0 to 3.26.1 #116
• Bump typedoc from 0.20.35 to 0.20.36 by @dependabot in Bump typedoc from 0.20.35 to 0.20.36 #117
• Update README with correct build size info by @chriskrycho in Update README with correct build size info #118
• [breaking] remove extras by @chriskrycho in [breaking] remove extras #119
• [breaking] rework Maybe and Result as single classes by @chriskrycho in [breaking] rework Maybe and Result as single classes #120
• Bump @types/jest from 26.0.22 to 26.0.23 by @dependabot in Bump @types/jest from 26.0.22 to 26.0.23 #123
• Bump eslint from 7.24.0 to 7.25.0 by @dependabot in Bump eslint from 7.24.0 to 7.25.0 #122
• Bump @typescript-eslint/parser from 4.22.0 to 4.22.1 by @dependabot in Bump @typescript-eslint/parser from 4.22.0 to 4.22.1 #124
• Bump ts-jest from 26.5.5 to 26.5.6 by @dependabot in Bump ts-jest from 26.5.5 to 26.5.6 #125
• Bump eslint from 7.25.0 to 7.26.0 by @dependabot in Bump eslint from 7.25.0 to 7.26.0 #128
• Bump prettier from 2.2.1 to 2.3.0 by @dependabot in Bump prettier from 2.2.1 to 2.3.0 #127
• Bump @typescript-eslint/parser from 4.22.1 to 4.23.0 by @dependabot in Bump @typescript-eslint/parser from 4.22.1 to 4.23.0 #129
• Bump eslint from 7.26.0 to 7.27.0 by @dependabot in Bump eslint from 7.26.0 to 7.27.0 #132
• Bump @typescript-eslint/parser from 4.23.0 to 4.24.0 by @dependabot in Bump @typescript-eslint/parser from 4.23.0 to 4.24.0 #131
• Bump @typescript-eslint/parser from 4.24.0 to 4.25.0 by @dependabot in Bump @typescript-eslint/parser from 4.24.0 to 4.25.0 #133
• Bump browserslist from 4.16.4 to 4.16.6 by @dependabot in Bump browserslist from 4.16.4 to 4.16.6 #134
• Bump @typescript-eslint/parser from 4.25.0 to 4.26.0 by @dependabot in Bump @typescript-eslint/parser from 4.25.0 to 4.26.0 #135
• Bump @typescript-eslint/parser from 4.26.0 to 4.26.1 by @dependabot in Bump @typescript-eslint/parser from 4.26.0 to 4.26.1 #138
• Bump typedoc from 0.20.36 to 0.20.37 by @dependabot in Bump typedoc from 0.20.36 to 0.20.37 #140
• Bump @typescript-eslint/parser from 4.26.1 to 4.28.0 by @dependabot in Bump @typescript-eslint/parser from 4.26.1 to 4.28.0 #143
• Bump prettier from 2.3.0 to 2.3.1 by @dependabot in Bump prettier from 2.3.0 to 2.3.1 #137
• Bump eslint from 7.27.0 to 7.29.0 by @dependabot in Bump eslint from 7.27.0 to 7.29.0 #142
• Bump ember-cli from 3.26.1 to 3.27.0 by @dependabot in Bump ember-cli from 3.26.1 to 3.27.0 #147
• Bump @typescript-eslint/parser from 4.28.0 to 4.28.1 by @dependabot in Bump @typescript-eslint/parser from 4.28.0 to 4.28.1 #148
• Bump prettier from 2.3.1 to 2.3.2 by @dependabot in Bump prettier from 2.3.1 to 2.3.2 #145
• Bump expect-type from 0.11.0 to 0.12.0 by @dependabot in Bump expect-type from 0.11.0 to 0.12.0 #150
• Bump eslint from 7.29.0 to 7.30.0 by @dependabot in Bump eslint from 7.29.0 to 7.30.0 #149
• Bump @typescript-eslint/parser from 4.28.1 to 4.30.0 by @dependabot in Bump @typescript-eslint/parser from 4.28.1 to 4.30.0 #170
• Bump prettier-eslint from 12.0.0 to 13.0.0 by @dependabot in Bump prettier-eslint from 12.0.0 to 13.0.0 #159
• Bump @types/jest from 26.0.23 to 27.0.1 by @dependabot in Bump @types/jest from 26.0.23 to 27.0.1 #165
• Bump eslint from 7.30.0 to 7.32.0 by @dependabot in Bump eslint from 7.30.0 to 7.32.0 #160
• Bump prettier from 2.3.2 to 2.4.0 by @dependabot in Bump prettier from 2.3.2 to 2.4.0 #173
• Bump @typescript-eslint/parser from 4.30.0 to 4.31.1 by @dependabot in Bump @typescript-eslint/parser from 4.30.0 to 4.31.1 #175
• Bump prettier from 2.4.0 to 2.5.0 by @dependabot in Bump prettier from 2.4.0 to 2.5.0 #202
• Bump @types/jest from 27.0.1 to 27.0.3 by @dependabot in Bump @types/jest from 27.0.1 to 27.0.3 #199
• Support node exports by adding export map to package.json by @MarcusCemes in Support node exports by adding export map to package.json #126
• Fix source maps by @chriskrycho in Fix source maps #205
• Require Node 12 || 14+ in engines, fix authors/contributors by @chriskrycho in Require Node 12 || 14+ in engines, fix authors/contributors #121
• Add release automation with release-it by @chriskrycho in Add release automation with release-it #209
• Update TS support range by @chriskrycho in Update TS support range #210
• Update README with TS compat, bundle info by @chriskrycho in Update README with TS compat, bundle info #211
• Bump typedoc from 0.20.37 to 0.22.10 by @dependabot in Bump typedoc from 0.20.37 to 0.22.10 #200
• Bump ember-cli from 3.27.0 to 3.28.4 by @dependabot in Bump ember-cli from 3.27.0 to 3.28.4 #196
• Switch to ES Modules and drop CJS emit by @chriskrycho in Switch to ES Modules and drop CJS emit #212
• Update expect-test by @chriskrycho in Update expect-test #213
• Update to latest ESLint by @chriskrycho in Update to latest ESLint #214
• Correct the ap docs about currying by @chriskrycho in Correct the ap docs about currying #216
• Use latest TS in development by @chriskrycho in Use latest TS in development #217
• Revert array utilities removal by @chriskrycho in Revert array utilities removal #218
• Improve transpose handling by @chriskrycho in Improve transpose handling #219
• Changelog updates by @chriskrycho in Changelog updates #220
• Update docs by @chriskrycho in Update docs #221
• Remove a few more needless aliases by @chriskrycho in Remove a few more needless aliases #222
• Update to current size info by @chriskrycho in Update to current size info #223

New Contributors

• @netaisllc made their first contribution in x2 the period #100
• @jrr made their first contribution in Reenable macOS in CI #103
• @dependabot-preview made their first contribution in Create Dependabot config file #105
• @MarcusCemes made their first contribution in Support node exports by adding export map to package.json #126

Full Changelog: v4.1.1...v5.0.0

---

This discussion was created from the release ES Modules *and* a much smaller bundle.