feat(immer): initial

lerna.json

@@ -1,6 +1,7 @@
 {
   "packages": [
     "./packages/core",
+    "./packages/immer",
     "./packages/lens",
     "./packages/fp-ts",
     "./packages/react",

package.json

@@ -14,8 +14,9 @@
   "homepage": "https://github.com/raveclassic/frp-ts#readme",
   "workspaces": [
     "./packages/core",
-    "./packages/lens",
+    "./packages/immer",
     "./packages/fp-ts",
+    "./packages/lens",
     "./packages/react",
     "./packages/test-utils",
     "./packages/utils"

packages/immer/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.js"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

packages/immer/jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+	testRunner: 'jasmine2',
+	displayName: 'immer',
+	preset: '../../jest.preset.js',
+	globals: {
+		'ts-jest': {
+			tsconfig: '<rootDir>/tsconfig.spec.json',
+		},
+	},
+	transform: {
+		'^.+\\.[tj]s$': 'ts-jest',
+	},
+	moduleFileExtensions: ['ts', 'js', 'html'],
+	coverageDirectory: '../../coverage/packages/immer',
+}

packages/immer/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@frp-ts/immer",
+  "version": "1.0.0-alpha.15",
+  "description": "Immer integration package",
+  "typedocMain": "./src/index.ts",
+  "author": "raveclassic",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/raveclassic/frp-ts.git"
+  },
+  "bugs": {
+    "url": "https://github.com/raveclassic/frp-ts/issues"
+  },
+  "homepage": "https://github.com/raveclassic/frp-ts#readme",
+  "scripts": {},
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "immer": "^9.0.12",
+    "tslib": "^2.3.1"
+  },
+  "dependencies": {
+    "@frp-ts/core": "^1.0.0-alpha.15",
+    "@frp-ts/utils": "^1.0.0-alpha.15"
+  },
+  "devDependencies": {
+    "immer": "^9.0.12",
+    "tslib": "^2.3.1"
+  }
+}

packages/immer/project.json

@@ -0,0 +1,41 @@
+{
+  "root": "packages/immer",
+  "sourceRoot": "packages/immer/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nrwl/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/immer",
+        "main": "packages/immer/src/index.ts",
+        "tsConfig": "packages/immer/tsconfig.lib.json",
+        "assets": ["packages/immer/*.md"]
+      }
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["packages/immer/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["coverage/packages/immer"],
+      "options": {
+        "jestConfig": "packages/immer/jest.config.js",
+        "passWithNoTests": true,
+        "codeCoverage": true
+      }
+    },
+    "deploy": {
+      "executor": "ngx-deploy-npm:deploy",
+      "options": {
+        "access": "public",
+        "noBuild": true
+      }
+    }
+  },
+  "tags": []
+}

packages/immer/src/immer.spec.ts

@@ -0,0 +1,67 @@
+import { newAtom } from '@frp-ts/core'
+import { produceMany } from './immer'
+import { produce } from 'immer'
+
+describe('immer', () => {
+	describe('direct integration', () => {
+		it('updates the state with "produce"', () => {
+			interface State {
+				readonly foo: number
+			}
+			const state = newAtom<State>({ foo: 0 })
+			state.modify(
+				produce((state) => {
+					state.foo++
+				}),
+			)
+			expect(state.get()).toEqual<State>({ foo: 1 })
+		})
+	})
+	describe('produceMany', () => {
+		it('updates nested values', () => {
+			interface State {
+				readonly foo: number
+			}
+			const state = newAtom<State>({ foo: 0 })
+			const methods = produceMany(state, {
+				inc: () => (state) => {
+					state.foo += 1
+				},
+			})
+			methods.inc()
+			expect(state.get().foo).toEqual(1)
+		})
+	})
+	describe('stress test', () => {
+		it('runs', () => {
+			interface Dog {
+				name: string
+			}
+			interface House {
+				dog: Dog
+			}
+			interface AppState {
+				house: House
+			}
+
+			const initialState: AppState = { house: { dog: { name: 'Fido' } } }
+			const storeState = newAtom(initialState)
+			const storeMethods = produceMany(storeState, {
+				renameTheDog: (newName: string) => (state) => {
+					state.house.dog.name = newName
+				},
+			})
+
+			const store = { ...storeState, ...storeMethods }
+
+			store.renameTheDog('Odif')
+			expect(store.get()).toEqual<AppState>({
+				house: {
+					dog: {
+						name: 'Odif',
+					},
+				},
+			})
+		})
+	})
+})

packages/immer/src/immer.ts

@@ -0,0 +1,23 @@
+import { Atom } from '@frp-ts/core'
+import { mapRecord } from '@frp-ts/utils'
+import immer, { Draft } from 'immer'
+
+interface Recipe<Value> {
+	// any is needed due to variance
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	(...args: readonly any[]): (draft: Draft<Value>) => void
+}
+
+export function produceMany<Input, Recipes extends Record<PropertyKey, Recipe<Input>>>(
+	input: Atom<Input>,
+	recipes: Recipes,
+): {
+	readonly [Name in keyof Recipes]: (...args: Parameters<Recipes[Name]>) => void
+} {
+	return mapRecord(
+		recipes,
+		(recipe) =>
+			(...args) =>
+				input.set(immer(input.get(), recipe(...args))),
+	)
+}

packages/immer/src/index.ts

@@ -0,0 +1 @@
+export { produceMany } from './immer'

packages/immer/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": ["."],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

packages/immer/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": []
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["**/*.spec.ts"]
+}

packages/immer/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["**/*.test.ts", "**/*.spec.ts", "**/*.d.ts"]
+}

packages/utils/src/index.ts

@@ -1 +1,2 @@
 export { memo1, memo2, constVoid, memoMany } from './function'
+export { recordKeys, mapRecord } from './record'

packages/utils/src/record.spec.ts

@@ -0,0 +1,14 @@
+import { mapRecord, recordKeys } from './record'
+
+describe('record', () => {
+	describe('recordKeys', () => {
+		it('returns keys a list of keys', () => {
+			expect(recordKeys({ foo: 'foo', bar: 123 })).toEqual(['foo', 'bar'])
+		})
+	})
+	describe('mapObject', () => {
+		it('maps values of an object', () => {
+			expect(mapRecord({ foo: 1, bar: 2 }, (value) => `${value}`)).toEqual({ foo: '1', bar: '2' })
+		})
+	})
+})

packages/utils/src/record.ts

@@ -0,0 +1,16 @@
+export function recordKeys<T extends Record<string, unknown>>(obj: T): readonly (keyof T & string)[] {
+	// eslint-disable-next-line no-restricted-syntax
+	return Object.keys(obj) as never
+}
+
+export function mapRecord<Input extends Record<PropertyKey, unknown>, Result>(
+	input: Input,
+	f: (value: Input[keyof Input], key: keyof Input) => Result,
+): { readonly [Key in keyof Input]: Result } {
+	// eslint-disable-next-line no-restricted-syntax
+	const result: Record<keyof Input, Result> = {} as never
+	for (const key of recordKeys(input)) {
+		result[key] = f(input[key], key)
+	}
+	return result
+}

pnpm-workspace.yaml

@@ -1,7 +1,8 @@
 packages:
   - packages/core
-  - packages/lens
+  - packages/immer
   - packages/fp-ts
+  - packages/lens
   - packages/react
   - packages/test-utils
   - packages/utils

tsconfig.base.json

@@ -16,6 +16,7 @@
     "baseUrl": ".",
     "paths": {
       "@frp-ts/core": ["packages/core/src/index.ts"],
+      "@frp-ts/immer": ["packages/immer/src/index.ts"],
       "@frp-ts/fp-ts": ["packages/fp-ts/src/index.ts"],
       "@frp-ts/lens": ["packages/lens/src/index.ts"],
       "@frp-ts/react": ["packages/react/src/index.ts"],

workspace.json

@@ -2,6 +2,7 @@
   "version": 2,
   "projects": {
     "core": "packages/core",
+    "immer": "packages/immer",
     "fp-ts": "packages/fp-ts",
     "lens": "packages/lens",
     "react": "packages/react",