v1.0.0

* feat next version (v1.0.0)

* refine types & code

* test coverage: set, reset, subscribe

* test coverage: action

* test: coverage: computed values

* test coverage: core

* test coverage: fp utility functions

* test coverage: proxy

* test coverage: subscription

* chore: update readme

Author: sultan99

README.md

@@ -1,6 +1,6 @@
 {
   "name": "holycow",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "private": true,
   "keywords": [
     "state management",
@@ -9,22 +9,33 @@
   "license": "MIT",
   "author": "sultan99",
   "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sultan99/holycow"
+  },
+  "scripts": {
+    "test": "jest --coverage --config=packages/state/jest.config.js",
+    "test:watch": "jest --watch --config=packages/state/jest.config.js",
+    "tsc": "tsc -w"
+  },
   "devDependencies": {
-    "@babel/core": "^7.19.3",
-    "@babel/preset-env": "^7.19.3",
+    "@babel/core": "^7.19.6",
+    "@babel/preset-env": "^7.19.4",
     "@babel/preset-typescript": "^7.18.6",
-    "@types/jest": "^29.1.1",
-    "@types/node": "^18.8.0",
-    "@types/ramda": "^0.28.15",
-    "@types/react": "^18.0.21",
-    "@typescript-eslint/eslint-plugin": "^5.38.1",
-    "@typescript-eslint/parser": "^5.38.1",
-    "babel-jest": "^29.1.2",
-    "eslint": "^8.24.0",
-    "eslint-plugin-jest": "^27.0.4",
-    "eslint-plugin-react": "^7.31.8",
-    "jest": "^29.1.2",
+    "@types/jest": "^29.2.0",
+    "@types/node": "^18.11.7",
+    "@types/react": "^18.0.24",
+    "@types/react-dom": "^18.0.8",
+    "@typescript-eslint/eslint-plugin": "^5.41.0",
+    "@typescript-eslint/parser": "^5.41.0",
+    "babel-jest": "^29.2.2",
+    "eslint": "^8.26.0",
+    "eslint-plugin-jest": "^27.1.3",
+    "eslint-plugin-react": "^7.31.10",
+    "jest": "^29.2.2",
+    "jest-environment-jsdom": "^29.2.2",
     "react": "^18.2.0",
+    "react-dom": "^18.2.0",
     "typescript": "^4.8.4"
   }
 }

package-lock.json

@@ -1,5 +1,8 @@
 module.exports = {
+  testEnvironment: `jsdom`,
+  testMatch: [`**/specs.ts`],
   testPathIgnorePatterns: [
+    `<rootDir>/dist/`,
     `<rootDir>/node_modules/`,
   ],
 }

package.json

@@ -1,11 +1,11 @@
 {
   "name": "@holycow/state",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/sultan99/restate",
-    "directory": "packages/store"
+    "url": "https://github.com/sultan99/holycow",
+    "directory": "packages/state"
   },
   "author": "sultan99",
   "main": "dist/index",
@@ -25,10 +25,6 @@
     "tsc": "tsc -w"
   },
   "peerDependencies": {
-    "ramda": "^0.27.1",
     "react": "^18.2.0"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

packages/state/jest.config.js

@@ -0,0 +1,10 @@
+import type {Action} from './types'
+
+const actionFns = new WeakSet<Action<any, any>>()
+
+export const isAction = <I>(fn: Action<I, any>) => actionFns.has(fn)
+
+export const action = <I, R>(fn: Action<I, R>) => {
+  actionFns.add(fn)
+  return fn
+}

packages/state/package-lock.json

@@ -0,0 +1,24 @@
+import {act} from 'react-dom/test-utils'
+import {renderHook} from '../test-utils'
+import {usePosts} from '../test-utils/posts'
+
+afterEach(() => {
+  usePosts.reset()
+})
+
+describe(`🎬 Action`, () => {
+  const newPost = {id: 5, title: `Hello World`}
+
+  it(`should set a value via action`, () => {
+    act(() => usePosts.addPost(newPost))
+    expect(usePosts.posts[4]).toEqual(newPost)
+    expect(usePosts.posts.length).toBe(5)
+  })
+
+  it(`should set a value via action using hook`, () => {
+    const {result} = renderHook(usePosts)
+    act(() => result.addPost(newPost))
+    expect(result.posts[4]).toEqual(newPost)
+    expect(result.posts.length).toBe(5)
+  })
+})

packages/state/package.json

@@ -0,0 +1,14 @@
+import type {ProxyState} from '../proxy/types'
+import type {State} from '../core/types'
+import type {ValOrFunc} from '../fp/types'
+
+export type SetPayload<P> = P extends string ? P : never
+
+export type Action<I, A = undefined> = (state: ProxyState<State<I>>) =>
+  A extends any[]
+    ? (...args: A) => void
+    : A extends SetPayload<A>
+      ? (payload: ValOrFunc<I, A>) => void
+      : A extends undefined
+        ? () => void
+        : A