update to effect 3.0.0

.changeset/weak-mirrors-sin.md

@@ -0,0 +1,20 @@
+---
+"@fp-ts/optic": minor
+---
+
+- update to effect 3.0.0
+- remove `experimental` module
+- rename `ReadonlyArray` module to `Array`
+- remove `data` folder:
+
+  Before
+
+  ```ts
+  import * as StringOptic from "@fp-ts/optic/data/String";
+  ```
+
+  Now
+
+  ```ts
+  import * as StringOptic from "@fp-ts/optic/String";
+  ```

.eslintrc.cjs

@@ -1,6 +1,6 @@
 /* eslint-disable no-undef */
 module.exports = {
-  ignorePatterns: ["build", "dist", "dtslint", "*.mjs", "docs", "*.md"],
+  ignorePatterns: ["build", "dist", "dtslint", "tmp", "*.mjs", "docs", "*.md"],
   parser: "@typescript-eslint/parser",
   parserOptions: {
     ecmaVersion: 2018,

.gitignore

@@ -7,3 +7,4 @@ yarn-error.log
 tmp/
 build/
 dist/
+tmp/

README.md

@@ -51,7 +51,7 @@ If you also want to **become a sponsor** to ensure this library continues to imp
 
 ## Requirements
 
-- TypeScript 5.0 or newer
+- TypeScript 5.4 or newer
 - The `strict` flag enabled in your `tsconfig.json` file
 
 ```
@@ -85,11 +85,11 @@ import * as Optic from "@fp-ts/optic";
 Let's say we have an employee and we need to upper case the first character of his company street name.
 
 ```ts
-import * as O from "effect/Option";
+import * as Option from "effect/Option";
 
 interface Street {
   readonly num: number;
-  readonly name: O.Option<string>;
+  readonly name: Option.Option<string>;
 }
 interface Address {
   readonly city: string;
@@ -112,7 +112,7 @@ const from: Employee = {
       city: "london",
       street: {
         num: 23,
-        name: O.some("high street"),
+        name: Option.some("high street"),
       },
     },
   },
@@ -126,7 +126,7 @@ const to: Employee = {
       city: "london",
       street: {
         num: 23,
-        name: O.some("High street"),
+        name: Option.some("High street"),
       },
     },
   },
@@ -137,8 +137,9 @@ Let's see what could we do with `@fp-ts/optic`
 
 ```ts
 import * as Optic from "@fp-ts/optic";
-import * as StringOptic from "@fp-ts/optic/data/String";
+import * as StringOptic from "@fp-ts/optic/String";
 import * as String from "effect/String";
+import * as assert from "node:assert";
 
 const _firstChar: Optic.Optional<Employee, string> = Optic.id<Employee>()
   .at("company")
@@ -150,7 +151,7 @@ const _firstChar: Optic.Optional<Employee, string> = Optic.id<Employee>()
 
 const capitalizeName = Optic.modify(_firstChar)(String.toUpperCase);
 
-expect(capitalizeName(from)).toEqual(to);
+assert.deepStrictEqual(capitalizeName(from), to);
 ```
 
 # Understanding Optics
@@ -165,7 +166,7 @@ export interface Optic<
   out GetError,
   out SetError,
   out GetPiece,
-  out SetWholeAfter
+  out SetWholeAfter,
 > {
   readonly getOptic: (
     GetWhole: GetWhole
@@ -532,19 +533,19 @@ The `some` method is a utility function that creates an optic that focuses on th
 
 ```ts
 import { pipe } from "effect";
-import * as O from "effect/Option";
+import * as Option from "effect/Option";
 import * as Optic from "@fp-ts/optic";
 
 // This creates a prism that focuses on the 'Some' case of the 'Option<number>' object.
-const _some: Optic.Prism<O.Option<number>, number> = Optic.id<
-  O.Option<number>
+const _some: Optic.Prism<Option.Option<number>, number> = Optic.id<
+  Option.Option<number>
 >().some();
 
-const option: O.Option<number> = O.some(42);
+const option: Option.Option<number> = Option.some(42);
 
-const result: O.Option<number> = pipe(option, Optic.getOption(_some)); // returns some(42)
+const result: Option.Option<number> = pipe(option, Optic.getOption(_some)); // returns some(42)
 
-const updated: O.Option<number> = pipe(option, Optic.replace(_some)(23)); // returns some(23)
+const updated: Option.Option<number> = pipe(option, Optic.replace(_some)(23)); // returns some(23)
 ```
 
 ## index

docs/modules/data/ReadonlyArray.ts.md → docs/modules/Array.ts.md

@@ -1,10 +1,10 @@
 ---
-title: data/ReadonlyArray.ts
-nav_order: 7
+title: Array.ts
+nav_order: 1
 parent: Modules
 ---
 
-## ReadonlyArray overview
+## Array overview
 
 Added in v1.0.0
 

docs/modules/data/Boolean.ts.md → docs/modules/Boolean.ts.md

@@ -1,6 +1,6 @@
 ---
-title: data/Boolean.ts
-nav_order: 1
+title: Boolean.ts
+nav_order: 2
 parent: Modules
 ---
 

docs/modules/data/Chunk.ts.md → docs/modules/Chunk.ts.md

@@ -1,6 +1,6 @@
 ---
-title: data/Chunk.ts
-nav_order: 2
+title: Chunk.ts
+nav_order: 3
 parent: Modules
 ---
 

docs/modules/data/Date.ts.md → docs/modules/Date.ts.md

@@ -1,6 +1,6 @@
 ---
-title: data/Date.ts
-nav_order: 3
+title: Date.ts
+nav_order: 4
 parent: Modules
 ---
 

docs/modules/data/Either.ts.md → docs/modules/Either.ts.md

@@ -1,6 +1,6 @@
 ---
-title: data/Either.ts
-nav_order: 4
+title: Either.ts
+nav_order: 5
 parent: Modules
 ---
 
@@ -28,8 +28,8 @@ An optic that accesses the `Left` case of an `Either`.
 
 ```ts
 export declare const left: {
-  <E, A>(): Prism<Either.Either<E, A>, E>
-  <E, A, B>(): PolyPrism<Either.Either<E, A>, Either.Either<B, A>, E, B>
+  <A, E>(): Prism<Either.Either<A, E>, E>
+  <A, E, B>(): PolyPrism<Either.Either<A, E>, Either.Either<A, B>, E, B>
 }
 ```
 
@@ -43,8 +43,8 @@ An optic that accesses the `Right` case of an `Either`.
 
 ```ts
 export declare const right: {
-  <E, A>(): Prism<Either.Either<E, A>, A>
-  <E, A, B>(): PolyPrism<Either.Either<E, A>, Either.Either<E, B>, A, B>
+  <A, E>(): Prism<Either.Either<A, E>, A>
+  <A, E, B>(): PolyPrism<Either.Either<A, E>, Either.Either<B, E>, A, B>
 }
 ```
 

docs/modules/data/HashMap.ts.md → docs/modules/HashMap.ts.md

@@ -1,6 +1,6 @@
 ---
-title: data/HashMap.ts
-nav_order: 5
+title: HashMap.ts
+nav_order: 6
 parent: Modules
 ---
 

docs/modules/data/Option.ts.md → docs/modules/Option.ts.md

@@ -1,6 +1,6 @@
 ---
-title: data/Option.ts
-nav_order: 6
+title: Option.ts
+nav_order: 8
 parent: Modules
 ---
 

docs/modules/data/SortedMap.ts.md → docs/modules/SortedMap.ts.md

@@ -1,6 +1,6 @@
 ---
-title: data/SortedMap.ts
-nav_order: 8
+title: SortedMap.ts
+nav_order: 9
 parent: Modules
 ---
 

docs/modules/data/String.ts.md → docs/modules/String.ts.md

@@ -1,6 +1,6 @@
 ---
-title: data/String.ts
-nav_order: 9
+title: String.ts
+nav_order: 10
 parent: Modules
 ---