fortepiano 1.0.2 → 1.0.3

package/CHANGELOG.md

@@ -0,0 +1,230 @@
+# Changelog
+
+## 1.0.3
+
+### Patch Changes
+
+- [#107](https://github.com/facile-it/fortepiano/pull/107) [`8268baf`](https://github.com/facile-it/fortepiano/commit/8268bafa66db140d4ee91917ef86ba712ce338e5) Thanks [@pierroberto](https://github.com/pierroberto)! - Add Changesets to automate versioning, changelog generation, and npm releases.
+
+## [1.0.2](https://github.com/facile-it/fortepiano/compare/v1.0.1...v1.0.2) - 2026-08-10
+
+### Changed
+
+- Upgrade CI workflows to supported Node.js versions.
+- Upgrade Yarn from 3.2.3 to 4.18.1.
+
+## [1.0.1](https://github.com/facile-it/fortepiano/compare/v1.0.0...v1.0.1) - 2026-08-10
+
+### Fixed
+
+- Fix `prerelease` and `release` script.
+
+## [1.0.0](https://github.com/facile-it/fortepiano/compare/v0.1.9...v1.0.0) - 2025-27-02
+
+### Removed
+
+- Remove `Http` module.
+- Remove `Cache` module.
+- Remove `Memcached` module.
+- Remove `Buffer` module.
+- Remove `Stream` module.
+- Remove `Memory` module.
+- Remove `Redis` module.
+- Remove `Storage` module.
+- Remove `Axios` module.
+- Remove `Fetch` module.
+- Remove `Got` module.
+- Remove `Flydrive` module.
+- Remove `Fs` module.
+- Remove `Random` module.
+- Remove `Log` module.
+- Remove `Void` module.
+- Remove `GeneratorL` module.
+- Remove `number` module.
+- Remove `Console` module.
+- Remove `Crypto` module.
+- Remove `Binary` module.
+- Remove `Date` module.
+- Remove `AsyncYield` module.
+- Remove `Magma` module.
+- Remove `Matrix` module.
+- Remove `Option` module.
+- Remove `Reader` module.
+- Remove `ReaderEither` module.
+- Remove `ReaderTask` module.
+- Remove `ReaderTaskEither` module.
+- Remove `ReadonlyTuple` module.
+- Remove `TaskEither` module.
+- Remove `Validation` module.
+- Remove `Has` module.
+- Remove `Aggregate` module.
+- Remove `Eq` module.
+- Remove `string` module.
+- Remove `Error` module.
+- Remove `ReadonlyRecord` module.
+- Remove `ReadonlyArray` module.
+- Remove `Yield` module.
+- Remove unused functions `ReadonlyArray`, `Type`, `function` and `struct` modules.
+
+## [0.1.9](https://github.com/facile-it/fortepiano/compare/v0.1.8...v0.1.9) - 2024-05-14
+
+### Security
+
+- Fix CVE-2022-25883.
+
+## [0.1.8](https://github.com/facile-it/fortepiano/compare/v0.1.7...v0.1.8) - 2023-07-10
+
+### Added
+
+- Complete the list of `Http` errors.
+
+### Security
+
+- Fix CVE-2022-46175.
+- Fix CVE-2022-25881.
+- Fix CVE-2023-26136.
+
+## [0.1.7](https://github.com/facile-it/fortepiano/compare/v0.1.6...v0.1.7) - 2023-01-02
+
+### Added
+
+- Add `infix` to `string` module.
+
+## [0.1.6](https://github.com/facile-it/fortepiano/compare/v0.1.5...v0.1.6) - 2022-09-30
+
+### Added
+
+- Add `collectWithIndex` function to `ReadonlyRecord` module.
+
+## [0.1.5](https://github.com/facile-it/fortepiano/compare/v0.1.4...v0.1.5) - 2022-09-22
+
+### Added
+
+- Add `prefix` to `string` module.
+- Add `suffix` to `string` module.
+
+### Changed
+
+- Changed overloads of `$mock.union` function.
+
+### Fixed
+
+- Update `yarn.lock` in order to fix "typescript (18.x)" and "jest (18.x)" jobs in CI.
+
+## [0.1.4](https://github.com/facile-it/fortepiano/compare/v0.1.3...v0.1.4) - 2022-06-24
+
+### Security
+
+- Fix CVE-2022-33987.
+
+## [0.1.3](https://github.com/facile-it/fortepiano/compare/v0.1.2...v0.1.3) - 2022-05-31
+
+### Added
+
+- Add `AggregateError` inspired from TC39.
+- Add `decode` method to `Type` module to help wrapping `io-ts` `Errors` into an `Error` subclass.
+- Add unit tests for the `set` function of the `Redis` module.
+- Add `Has` module and enhance `ReaderTaskEither` for smart dependencies management (inspired by [Effect-TS](https://www.matechs.com/open-source)):
+
+  ```typescript
+  // Foo.ts
+  import { TaskEither } from 'fp-ts/TaskEither'
+  import { $has, $readerTaskEither } from 'fortepiano'
+
+  export interface Foo {
+    bar(a: number): TaskEither<Error, string>
+  }
+
+  export const TagFoo = $has.tag<Foo>()
+
+  export const $foo = {
+    bar: $readerTaskEither.derivesTaskEither(TagFoo, 'bar'),
+  }
+  ```
+
+  ```typescript
+  // Bar.ts
+  import { IOEither } from 'fp-ts/IOEither'
+  import { $has, $readerTaskEither } from 'fortepiano'
+
+  export interface Bar {
+    (a: string): IOEither<Error, boolean>
+  }
+
+  export const TagBar = $has.tag<Bar>()
+
+  export const bar = $readerTaskEither.deriveIOEither(TagBar)
+  ```
+
+  ```typescript
+  // index.ts
+  import { $has } from 'fortepiano'
+  import { ioEither, readerTaskEither, taskEither } from 'fp-ts'
+  import { pipe } from 'fp-ts/function'
+  import { TagBar, bar } from './Bar'
+  import { $foo, TagFoo } from './Foo'
+
+  // const a: ReaderTaskEither<Has<Foo> & Has<Bar>, Error, boolean>
+  const a = pipe($foo.bar(42), readerTaskEither.chainW(bar))
+
+  // const b: TaskEither<Error, boolean>
+  const b = a(
+    // Let's mock our dependencies.
+    pipe(
+      $has.singleton(TagFoo, { bar: () => taskEither.of('foobar') }),
+      $has.upsertAt(TagBar, () => ioEither.of(true)),
+    ),
+  )
+  ```
+
+### Changed
+
+- Replace `struct` type with `Struct`.
+- Rename `GeneratorL` module to `Yield`.
+- Use `cause` property to record wrapped errors (inspired by TC39).
+
+### Deprecated
+
+- Deprecate `struct` (use `Struct` instead).
+- Deprecate `GeneratorL` module (use `Yield` instead).
+
+### Fixed
+
+- Decode from Json and then from the given codec in the `get` function of the `Redis` module.
+
+## [0.1.2](https://github.com/facile-it/fortepiano/compare/v0.1.1...v0.1.2) - 2022-04-29
+
+### Added
+
+- Add `LICENSE.md`.
+- Add `CONTRIBUTING.md`.
+- Add `CHANGELOG.md`.
+
+### Changed
+
+- Relicense as MIT.
+- Update `README.md`.
+
+### Deprecated
+
+- Deprecate `$got` (use `$axios` instead).
+
+## [0.1.1](https://github.com/facile-it/fortepiano/compare/v0.1.0...v0.1.1) - 2022-04-26
+
+### Added
+
+- Support [tree shaking](https://webpack.js.org/guides/tree-shaking/) via top-level imports:
+  ```typescript
+  import { curry } from 'fortepiano/function'
+  // ...instead of `import { curry } from 'fortepiano/lib/function'`
+  ```
+
+### Deprecated
+
+- Discourage imports from `fortepiano/lib/*` as they break tree shaking.
+
+## [0.1.0](https://github.com/facile-it/fortepiano/releases/tag/v0.1.0) - 2022-04-20
+
+### Added
+
+- First public release of `fortepiano`.

package/README.md

@@ -1,10 +1,10 @@
 <p align="center">
-<img src="./logo.png" width=150px" height="auto"/>
+<img src="./logo.png" width="150px" height="auto"/>
 </p>
 
 # fortepiano [ˌfɔrteˈpjaːno]
 
-_Playing actual music over `fp-ts` notes_ 🎶
+_Playing actual music over functional notes_ 🎶
 
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/facile-it/fortepiano/main)](https://github.com/facile-it/fortepiano/actions)
 [![Codecov](https://img.shields.io/codecov/c/gh/facile-it/fortepiano)](https://app.codecov.io/gh/facile-it/fortepiano)
@@ -25,7 +25,7 @@ To install the stable version:
 npm install fortepiano
 ```
 
-or using yarn:
+or using Yarn:
 
 ```bash
 yarn add fortepiano
@@ -35,10 +35,26 @@ yarn add fortepiano
 
 Fortepiano uses a functional API to create and configure mocks, encouraging pure function usage and immutable mock objects.
 
-Here's an example:
+Import Fortepiano as a namespace:
 
 ```typescript
-import { $mock } from 'fortepiano'
+import * as $mock from 'fortepiano'
+```
+
+A mock is a function that produces an `IO`, so call it twice to generate a value:
+
+```typescript
+const value = $mock.string()()
+
+console.log(value) // A randomly generated string
+```
+
+#### Creating structured mocks
+
+Use `$mock.struct` to combine mocks:
+
+```typescript
+import * as $mock from 'fortepiano'
 
 interface User {
   firstName: string
@@ -51,7 +67,87 @@ export const UserMock = (): $mock.Mock<User> =>
     lastName: $mock.string,
   })
 
-console.log(UserMock()()()) // Output: { firstName: 'randomString', lastName: 'randomString' }
+const user = UserMock()()()
+
+console.log(user)
+// { firstName: "<random string>", lastName: "<random string>" }
+```
+
+`UserMock()` creates the mock, the second call creates its `IO`, and the third call executes that `IO`.
+
+You can also define the mock directly:
+
+```typescript
+const userMock: $mock.Mock<User> = $mock.struct({
+  firstName: $mock.string,
+  lastName: $mock.string,
+})
+
+const user = userMock()()
+```
+
+#### Using fixed values
+
+Use `$mock.of` when a mock should always produce a specific value:
+
+```typescript
+const testString = $mock.of('test')
+
+console.log(testString()()) // "test"
+```
+
+Fixed and generated values can be combined in a structured mock:
+
+```typescript
+const userMock: $mock.Mock<User> = $mock.struct({
+  firstName: $mock.of('test'),
+  lastName: $mock.string,
+})
+
+console.log(userMock()())
+// { firstName: "test", lastName: "<random string>" }
+```
+
+#### Overriding generated values
+
+A value can be supplied when invoking a mock:
+
+```typescript
+console.log($mock.string('test')()) // "test"
+```
+
+Structured mocks accept partial overrides:
+
+```typescript
+const userMock: $mock.Mock<User> = $mock.struct({
+  firstName: $mock.string,
+  lastName: $mock.string,
+})
+
+console.log(userMock({ firstName: 'John' })())
+// { firstName: "John", lastName: "<random string>" }
+```
+
+This lets you reuse a mock while customizing only the properties relevant to a test.
+
+#### Importing individual exports
+
+You can import individual functions and types instead of using a namespace:
+
+```typescript
+import { of, string, struct, type Mock } from 'fortepiano'
+
+interface User {
+  firstName: string
+  lastName: string
+}
+
+const userMock: Mock<User> = struct({
+  firstName: of('test'),
+  lastName: string,
+})
+
+console.log(userMock()())
 ```
 
 ## Contributing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fortepiano",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Playing actual music over fp-ts notes",
   "keywords": [
     "typescript",
@@ -43,13 +43,17 @@
     "eslint:fix": "eslint --fix ./",
     "prettier": "prettier --check ./",
     "prettier:fix": "prettier --write ./",
+    "changeset": "changeset",
+    "changeset:version": "changeset version",
     "prerelease": "yarn build",
-    "release": "yarn prerelease && npm publish",
+    "release": "yarn prerelease && changeset publish",
     "test": "jest",
     "test:watch": "jest --watchAll",
     "test:coverage": "jest --coverage"
   },
   "devDependencies": {
+    "@changesets/changelog-github": "^1.0.1",
+    "@changesets/cli": "^3.0.3",
     "@rushstack/eslint-patch": "^1.1.3",
     "@types/jest": "^26.0.24",
     "@types/node": "^22.8.7",
@@ -68,4 +72,4 @@
     "io-ts": "^2.2.0"
   },
   "packageManager": "yarn@4.18.1"
-}
+}