chore(#4): shared composable extending (#5)

* chore(#4): initial implementation of composable extending

* chore(#4): ci node version update

* chore(#4): lock files updated

* chore(#4): dependencies update

* chore(#4): rollup config update

* docs(#4): corrects, updates

* chore(#4): types redefined

.github/issue_template.md

@@ -1,15 +1,15 @@
 **Description**:
 ---
-Some issue description.
+Issue description should be here.
 
 **Tasks**:
 ---
 - [ ] task name
 
 **Research**:
 ---
-None
+*None*
 
 **Screenshots**:
 ---
-None
+*None*

.github/pull_request_template.md

@@ -1,14 +1,15 @@
 <!--- Please crate an issue if this PR is not connected with anyone. --->
 
+<!--- Example - Closing: #10 --->
 Closing: #[issue number]
 
-**Tasks**:
+**Todo**:
 ---
 * [ ] issue connected
 * [ ] summary
 * [ ] self review
-* [ ] issue todos
+* [ ] issue todos done
 
 **Summary**:
 ---
-*Write here some summary.*
+*Write here summary of changes.*

.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [14]
+        node: [20]
 
     steps:
       - name: Checkout 🛎

.gitignore

@@ -81,6 +81,8 @@ dist
 
 # IDE / Editor
 .idea
+.vscode
+.history
 
 # Service worker
 sw.*
@@ -95,8 +97,10 @@ sw.*
 .reify-cache
 **/**/.reify-cache
 
+# Dist
 lib
 .husky/_
 
+# Test generations
 package
 vue-use-state-effect/

.nvmrc

@@ -0,0 +1 @@
+20.17.0

BACKLOG.md

@@ -1,11 +1,13 @@
 ### Missing features, things to do:
 
+- [ ] history tracking
 - [ ] state reset
 - [ ] cached multi-state / threads
 - [ ] docs on Nuxt Content
 - [ ] Q&A section
 
 ### Done:
 
+- [x] extending - `0.1.5`
 - [x] destroying destination - `0.1.2`
 - [x] unit tests - `0.1.0`

CHANGELOG.md

@@ -1,7 +1,19 @@
+### 0.1.5 (10.01.2025)
+
+- [**feature**] addons/extending ([#5](https://github.com/lukasborawski/vue-use-state-effect/pull/5))
+- updated dependencies
+- removed Vue demo, **Nuxt** demo became default
+- Nuxt demo update
+  - fresh version of the framework
+  - composables updated to showcase extending
+- docs update
+- Typescript version bump to `^5`
+- Node version bump to `^20`
+
 ### 0.1.4 (25.10.2022)
 
 - removed unnecessary lib build
-- removed doubled `getCurrentInstanc` check
+- removed doubled `getCurrentInstance` check
 
 ### 0.1.2 (09.06.2022)
 

README.md

@@ -1,10 +1,10 @@
 ## Vue Use State Effect
 
-**CAUTION**: Built and tested for/with **Vue 3** and/or **Nuxt 3** (RC-12).
+**CAUTION**: Built and tested with **Nuxt 3.15**.
 
-Fast and small library, built on top of the native `scopeEffect` **Vue 3 API** that will provide safe and sharable (across the app) state for your local composables and functions. It might be a good replacement for **Vuex** or **Pinia** state management, if you need smaller and less extensive solution.
+Fast and lightweight library (composable) that utilizes the native `EffectScope` **Vue 3 API**. It is designed to offer secure and shareable (across the app) state for your local composables and functions. It can serve as a viable replacement or alternative to **Vuex** or **Pinia** state management, particularly if you require a smaller and less extensive solution.
 
-**Check out the Stackblitz Nuxt 3 demo [here](https://stackblitz.com/edit/vue-use-state-effect-demo).** 🚀
+**Check out the Stackblitz Nuxt demo [here](https://stackblitz.com/edit/vue-use-state-effect-demo).** 🚀
 
 ### Motivation / Story
 
@@ -35,32 +35,12 @@ Create local composable with some state and pass it to the `useStateEffect`.
 ```javascript
 import { useStateEffect } from 'vue-use-state-effect'
 
-const composable = () => {
-  /* your composable logic here */
-}
-
-export const useSharedComposable = useStateEffect(composable, { ...config })
-```
-
-Interface (**TypeScript**).
-
-```typescript
-interface UseStateEffectConfig {
-  readonly name?: string | null
-  readonly destroy?: boolean | 'custom'
-  readonly debug?: boolean
-}
-export type UseStateEffectOptions<T = any> = {
-  readonly destroyLabels: string[]
-  readonly props: ExtractPropTypes<{ stateEffectDestroyLabel: string } | T>
-}
-
-export function useStateEffect<T extends (...args: any[]) => ReturnType<T>>(
-  composable: T,
-  config?: UseStateEffectConfig,
-): (opts?: UseStateEffectOptions<opts.props>) => {
-  [keyof in string | 'state']: ReturnType<T>
-}
+export const sharedComposable = useStateEffect(
+  (...args) => {
+    /* your composable logic here */
+  },
+  { ...config },
+)
 ```
 
 Please check the configuration, all the details and examples [here](https://github.com/lukasborawski/vue-use-state-effect).

__tests__/index.spec.js

@@ -1,4 +1,4 @@
-import { useStateEffect } from '~/lib/index.cjs'
+import { useStateEffect } from '~/lib/index.js'
 import { ref, getCurrentInstance } from 'vue'
 
 const config = {
@@ -75,6 +75,15 @@ describe('vue-use-state-effect', () => {
       const receivedState = useStateEffect(composableMock)()
       expect(JSON.stringify(receivedState)).toMatch('_syg')
     })
+    it('returns state with addons', () => {
+      const receivedState = useStateEffect((...args) => {
+        const [options] = args
+        return {
+          state: { test: options.addons.test },
+        }
+      })({ addons: { test: 'test' } })
+      expect(receivedState).toEqual({ state: { _syg: 'StateEffect', _uid: 1, state: { test: 'test' } } })
+    })
   })
 
   describe('was invoked with config and', () => {