From 239aec50f270bc9025b1c28490dbdfbc720ab9d5 Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Thu, 3 Jun 2021 14:43:17 +0200 Subject: [PATCH] feat: remove deprecated APIs --- __tests__/subscriptions.spec.ts | 2 -- docs/core-concepts/index.md | 2 +- docs/core-concepts/state.md | 2 +- src/deprecated.ts | 12 ------------ src/index.ts | 3 --- src/store.ts | 3 --- src/types.ts | 5 ----- test-dts/deprecated.test-d.ts | 21 --------------------- 8 files changed, 2 insertions(+), 48 deletions(-) delete mode 100644 src/deprecated.ts delete mode 100644 test-dts/deprecated.test-d.ts diff --git a/__tests__/subscriptions.spec.ts b/__tests__/subscriptions.spec.ts index b07aefc3..61a91402 100644 --- a/__tests__/subscriptions.spec.ts +++ b/__tests__/subscriptions.spec.ts @@ -25,7 +25,6 @@ describe('Subscriptions', () => { expect(spy).toHaveBeenCalledTimes(1) expect(spy).toHaveBeenCalledWith( expect.objectContaining({ - storeName: 'main', storeId: 'main', type: MutationType.direct, }), @@ -44,7 +43,6 @@ describe('Subscriptions', () => { expect(spy).toHaveBeenCalledWith( expect.objectContaining({ payload: patch, - storeName: 'main', storeId: 'main', type: MutationType.patchObject, }), diff --git a/docs/core-concepts/index.md b/docs/core-concepts/index.md index 17b67b41..fe0c295c 100644 --- a/docs/core-concepts/index.md +++ b/docs/core-concepts/index.md @@ -8,7 +8,7 @@ import { defineStore } from 'pinia' // useStore could be anything like useUser, useCart export const useStore = defineStore({ // unique id of the store across your application - id: 'storeName', + id: 'storeId', }) ``` diff --git a/docs/core-concepts/state.md b/docs/core-concepts/state.md index 48a7bedc..a1af14c5 100644 --- a/docs/core-concepts/state.md +++ b/docs/core-concepts/state.md @@ -6,7 +6,7 @@ The state is, most of the time, the central part of your store. People often sta import { defineStore } from 'pinia' const useStore = defineStore({ - id: 'storeName', + id: 'storeId', // can also be defined with an arrow function if you prefer that syntax state() { return { diff --git a/src/deprecated.ts b/src/deprecated.ts deleted file mode 100644 index 1d08727c..00000000 --- a/src/deprecated.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { defineStore } from './store' - -/** - * {@inheritDoc defineStore} - * @deprecated Use {@link defineStore} - */ -export const createStore = ((options: any) => { - console.warn( - '[🍍]: "createStore" has been deprecated and will be removed on the sable release, use "defineStore" instead.' - ) - return defineStore(options) -}) as typeof defineStore diff --git a/src/index.ts b/src/index.ts index cd3aa43d..a3d669ab 100644 --- a/src/index.ts +++ b/src/index.ts @@ -49,6 +49,3 @@ export type { _Spread, _StoreObject, } from './mapHelpers' - -// TODO: remove in beta -export { createStore } from './deprecated' diff --git a/src/store.ts b/src/store.ts index 0ff26be7..105d1121 100644 --- a/src/store.ts +++ b/src/store.ts @@ -137,7 +137,6 @@ function initStore< partialStateOrMutator(pinia.state.value[$id] as UnwrapRef) subscriptionMutation = { type: MutationType.patchFunction, - storeName: $id, storeId: $id, events: debuggerEvents as DebuggerEvent[], } @@ -146,7 +145,6 @@ function initStore< subscriptionMutation = { type: MutationType.patchObject, payload: partialStateOrMutator, - storeName: $id, storeId: $id, events: debuggerEvents as DebuggerEvent[], } @@ -188,7 +186,6 @@ function initStore< if (isListening) { callback( { - storeName: $id, storeId: $id, type: MutationType.direct, events: debuggerEvents as DebuggerEvent, diff --git a/src/types.ts b/src/types.ts index e4094006..608d7180 100644 --- a/src/types.ts +++ b/src/types.ts @@ -70,11 +70,6 @@ export interface _SubscriptionCallbackMutationBase { */ type: MutationType - /** - * @deprecated use `storeId` instead. - */ - storeName: string - /** * `id` of the store doing the mutation. */ diff --git a/test-dts/deprecated.test-d.ts b/test-dts/deprecated.test-d.ts deleted file mode 100644 index 43e40b7b..00000000 --- a/test-dts/deprecated.test-d.ts +++ /dev/null @@ -1,21 +0,0 @@ -import { createStore, expectType } from './' - -const useDeprecated = createStore({ - id: 'name', - state: () => ({ a: 'on' as 'on' | 'off', nested: { counter: 0 } }), - getters: { - upper: (state) => state.a.toUpperCase(), - }, -}) - -const deprecatedStore = useDeprecated() - -expectType<{ a: 'on' | 'off' }>(deprecatedStore.$state) -expectType(deprecatedStore.nested.counter) -expectType<'on' | 'off'>(deprecatedStore.a) - -// @ts-expect-error -deprecatedStore.nonExistant - -// @ts-expect-error -deprecatedStore.nonExistant.stuff -- 2.47.2