Merge branch 'v2' into feat/nuxt-skip-hydrate-in-payload

Author: posva

.github/CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Contributions are welcome and will be fully credited!
 
-We accept contributions via Pull Requests on [Github](https://github.com/{{ githubAccount }}/{{ name }}).
+We accept contributions via Pull Requests on [Github](https://github.com/vuejs/pinia).
 
 ## Pull Requests
 
@@ -19,7 +19,7 @@ Here are some guidelines to make the process smoother:
 
 ### Bug reports
 
-Always try to provide as much information as possible. If you are reporting a bug, try to provide a repro on jsfiddle.net (or anything else) or a stacktrace at the very least. This will help us check the problem quicker.
+Always try to provide as much information as possible. If you are reporting a bug, try to provide a repro on [this playground](https://play.pinia.vuejs.org) (or anything else) or a stacktrace at the very least. This will help us check the problem quicker.
 
 ### Feature requests
 
@@ -86,3 +86,7 @@ pnpm run docs:translation:compare <lang> upstream/v2
 ```
 
 <!-- TODO: add an example once we have got one -->
+
+### Translating Search text
+
+The search box is powered by Algolia and you will need to translate the properties. Inspire yourself from `.vitepress/config/zh.ts` `zhSearch` variable.

.github/workflows/pkg.pr.new.yml

@@ -25,11 +25,8 @@ jobs:
       uses: actions/checkout@v4
       with:
         fetch-depth: 0
-
-    - run: corepack enable
-
-    - name: Set node
-      uses: actions/setup-node@v4
+    - uses: pnpm/action-setup@v4
+    - uses: actions/setup-node@v4
       with:
         node-version: lts/*
         cache: pnpm

README.md

@@ -6,7 +6,7 @@
 <br/>
 <p align="center">
   <a href="https://npmjs.com/package/pinia"><img src="https://badgen.net/npm/v/pinia" alt="npm package"></a>
-  <a href="https://github.com/vuejs/pinia/actions/workflows/test.yml?query=branch%3Av2"><img src="https://github.com/vuejs/pinia/workflows/test/badge.svg?branch=v2" alt="build status"></a>
+  <a href="https://github.com/vuejs/pinia/actions/workflows/ci.yml"><img src="https://github.com/vuejs/pinia/actions/workflows/ci.yml/badge.svg" alt="build status"></a>
   <a href="https://codecov.io/gh/vuejs/pinia"><img src="https://codecov.io/gh/vuejs/pinia/graph/badge.svg?token=rU2xxQ6BGH"/></a>
 </p>
 <br/>

codecov.yml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    patch: off
+    project:
+      default:
+        threshold: 2%

package.json

@@ -35,32 +35,32 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@types/lodash.kebabcase": "^4.1.9",
     "@types/node": "^20.14.12",
-    "@vitest/coverage-v8": "^2.0.4",
-    "@vitest/ui": "^2.0.4",
-    "@vue/compiler-sfc": "~3.4.34",
-    "@vue/server-renderer": "~3.4.34",
+    "@vitest/coverage-v8": "^2.1.1",
+    "@vitest/ui": "^2.1.1",
+    "@vue/compiler-sfc": "~3.5.10",
+    "@vue/server-renderer": "~3.5.10",
     "chalk": "^5.3.0",
     "conventional-changelog-cli": "^2.2.2",
     "enquirer": "^2.4.1",
     "execa": "^9.3.0",
     "globby": "^14.0.1",
-    "happy-dom": "^14.12.3",
+    "happy-dom": "^15.7.4",
     "lint-staged": "^15.2.7",
     "lodash.kebabcase": "^4.1.1",
     "minimist": "^1.2.8",
     "p-series": "^3.0.0",
     "pascalcase": "^2.0.0",
     "prettier": "^3.3.3",
     "rimraf": "^6.0.1",
-    "rollup": "^4.18.0",
+    "rollup": "^4.22.5",
     "rollup-plugin-typescript2": "^0.36.0",
     "semver": "^7.6.3",
     "simple-git-hooks": "^2.11.1",
-    "typedoc": "^0.26.5",
-    "typedoc-plugin-markdown": "^4.2.3",
-    "typescript": "~5.5.4",
-    "vitest": "^2.0.4",
-    "vue": "~3.4.34"
+    "typedoc": "^0.26.7",
+    "typedoc-plugin-markdown": "^4.2.8",
+    "typescript": "~5.6.2",
+    "vitest": "^2.1.1",
+    "vue": "~3.5.10"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged",

packages/docs/api/@pinia/nuxt/functions/default.md

@@ -10,16 +10,16 @@ editLink: false
 
 # Function: default()
 
-> **default**(`this`, `inlineOptions`, `nuxt`): `_ModuleSetupReturn`
+> **default**(`this`, `resolvedOptions`, `nuxt`): `ModuleSetupReturn`
 
 ## Parameters
 
 • **this**: `void`
 
-• **inlineOptions**: [`ModuleOptions`](../interfaces/ModuleOptions.md)
+• **resolvedOptions**: [`ModuleOptions`](../interfaces/ModuleOptions.md)
 
 • **nuxt**: `Nuxt`
 
 ## Returns
 
-`_ModuleSetupReturn`
+`ModuleSetupReturn`

packages/docs/api/@pinia/testing/interfaces/TestingPinia.md

@@ -47,7 +47,7 @@ App used by Pinia
 
 ### state
 
-> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../../../pinia/type-aliases/StateTree.md)\>\>
+> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../../../pinia/type-aliases/StateTree.md)\>, `Record`\<`string`, [`StateTree`](../../../pinia/type-aliases/StateTree.md)\>\>
 
 root state
 

packages/docs/api/pinia/index.md

@@ -18,6 +18,9 @@ editLink: false
 
 ### Interfaces
 
+- [\_StoreOnActionListenerContext](interfaces/StoreOnActionListenerContext.md)
+- [\_StoreWithState](interfaces/StoreWithState.md)
+- [\_SubscriptionCallbackMutationBase](interfaces/SubscriptionCallbackMutationBase.md)
 - [DefineSetupStoreOptions](interfaces/DefineSetupStoreOptions.md)
 - [DefineStoreOptions](interfaces/DefineStoreOptions.md)
 - [DefineStoreOptionsBase](interfaces/DefineStoreOptionsBase.md)
@@ -34,23 +37,9 @@ editLink: false
 - [SubscriptionCallbackMutationDirect](interfaces/SubscriptionCallbackMutationDirect.md)
 - [SubscriptionCallbackMutationPatchFunction](interfaces/SubscriptionCallbackMutationPatchFunction.md)
 - [SubscriptionCallbackMutationPatchObject](interfaces/SubscriptionCallbackMutationPatchObject.md)
-- [\_StoreOnActionListenerContext](interfaces/StoreOnActionListenerContext.md)
-- [\_StoreWithState](interfaces/StoreWithState.md)
-- [\_SubscriptionCallbackMutationBase](interfaces/SubscriptionCallbackMutationBase.md)
 
 ### Type Aliases
 
-- [PiniaStorePlugin](type-aliases/PiniaStorePlugin.md)
-- [StateTree](type-aliases/StateTree.md)
-- [Store](type-aliases/Store.md)
-- [StoreActions](type-aliases/StoreActions.md)
-- [StoreGeneric](type-aliases/StoreGeneric.md)
-- [StoreGetters](type-aliases/StoreGetters.md)
-- [StoreOnActionListener](type-aliases/StoreOnActionListener.md)
-- [StoreOnActionListenerContext](type-aliases/StoreOnActionListenerContext.md)
-- [StoreState](type-aliases/StoreState.md)
-- [SubscriptionCallback](type-aliases/SubscriptionCallback.md)
-- [SubscriptionCallbackMutation](type-aliases/SubscriptionCallbackMutation.md)
 - [\_ActionsTree](type-aliases/ActionsTree.md)
 - [\_Awaited](type-aliases/Awaited.md)
 - [\_DeepPartial](type-aliases/DeepPartial.md)
@@ -73,6 +62,17 @@ editLink: false
 - [\_StoreWithActions](type-aliases/StoreWithActions.md)
 - [\_StoreWithGetters](type-aliases/StoreWithGetters.md)
 - [\_UnwrapAll](type-aliases/UnwrapAll.md)
+- [PiniaStorePlugin](type-aliases/PiniaStorePlugin.md)
+- [StateTree](type-aliases/StateTree.md)
+- [Store](type-aliases/Store.md)
+- [StoreActions](type-aliases/StoreActions.md)
+- [StoreGeneric](type-aliases/StoreGeneric.md)
+- [StoreGetters](type-aliases/StoreGetters.md)
+- [StoreOnActionListener](type-aliases/StoreOnActionListener.md)
+- [StoreOnActionListenerContext](type-aliases/StoreOnActionListenerContext.md)
+- [StoreState](type-aliases/StoreState.md)
+- [SubscriptionCallback](type-aliases/SubscriptionCallback.md)
+- [SubscriptionCallbackMutation](type-aliases/SubscriptionCallbackMutation.md)
 
 ### Variables
 

packages/docs/api/pinia/interfaces/Pinia.md

@@ -34,7 +34,7 @@ Every application must own its own pinia to be able to create stores
 
 ### state
 
-> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../type-aliases/StateTree.md)\>\>
+> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../type-aliases/StateTree.md)\>, `Record`\<`string`, [`StateTree`](../type-aliases/StateTree.md)\>\>
 
 root state
 

packages/docs/api/pinia/interfaces/StoreProperties.md

@@ -22,18 +22,18 @@ Properties of a store.
 
 ## Properties
 
-### $id
-
-> **$id**: `Id`
-
-Unique identifier of the store
-
-***
-
 ### \_customProperties
 
 > **\_customProperties**: `Set`\<`string`\>
 
 Used by devtools plugin to retrieve properties added with plugins. Removed
 in production. Can be used by the user to add property keys of the store
 that should be displayed in devtools.
+
+***
+
+### $id
+
+> **$id**: `Id`
+
+Unique identifier of the store