@sanity/sdk 0.0.0-alpha.21 → 0.0.0-alpha.23

package/src/auth/logout.ts

@@ -1,4 +1,4 @@
-import {createAction} from '../resources/createAction'
+import {bindActionGlobally} from '../store/createActionBinder'
 import {DEFAULT_API_VERSION, REQUEST_TAG_PREFIX} from './authConstants'
 import {AuthStateType} from './authStateType'
 import {authStore} from './authStore'
@@ -6,40 +6,38 @@ import {authStore} from './authStore'
 /**
  * @public
  */
-export const logout = createAction(authStore, ({state}) => {
+export const logout = bindActionGlobally(authStore, async ({state}) => {
   const {clientFactory, apiHost, providedToken, storageArea, storageKey} = state.get().options
 
-  return async function () {
-    // If a token is statically provided, logout does nothing
-    if (providedToken) return
+  // If a token is statically provided, logout does nothing
+  if (providedToken) return
 
-    const {authState} = state.get()
+  const {authState} = state.get()
 
-    // If we already have an inflight request, no-op
-    if (authState.type === AuthStateType.LOGGED_OUT && authState.isDestroyingSession) return
-    const token = authState.type === AuthStateType.LOGGED_IN && authState.token
+  // If we already have an inflight request, no-op
+  if (authState.type === AuthStateType.LOGGED_OUT && authState.isDestroyingSession) return
+  const token = authState.type === AuthStateType.LOGGED_IN && authState.token
 
-    try {
-      if (token) {
-        state.set('loggingOut', {
-          authState: {type: AuthStateType.LOGGED_OUT, isDestroyingSession: true},
-        })
-
-        const client = clientFactory({
-          token,
-          requestTagPrefix: REQUEST_TAG_PREFIX,
-          apiVersion: DEFAULT_API_VERSION,
-          ...(apiHost && {apiHost}),
-          useProjectHostname: false,
-        })
+  try {
+    if (token) {
+      state.set('loggingOut', {
+        authState: {type: AuthStateType.LOGGED_OUT, isDestroyingSession: true},
+      })
 
-        await client.request<void>({uri: '/auth/logout', method: 'POST'})
-      }
-    } finally {
-      state.set('logoutSuccess', {
-        authState: {type: AuthStateType.LOGGED_OUT, isDestroyingSession: false},
+      const client = clientFactory({
+        token,
+        requestTagPrefix: REQUEST_TAG_PREFIX,
+        apiVersion: DEFAULT_API_VERSION,
+        ...(apiHost && {apiHost}),
+        useProjectHostname: false,
       })
-      storageArea?.removeItem(storageKey)
+
+      await client.request<void>({uri: '/auth/logout', method: 'POST'})
     }
+  } finally {
+    state.set('logoutSuccess', {
+      authState: {type: AuthStateType.LOGGED_OUT, isDestroyingSession: false},
+    })
+    storageArea?.removeItem(storageKey)
   }
 })

package/src/auth/refreshStampedToken.test.ts

@@ -1,8 +1,8 @@
 import {of, Subscription, throwError} from 'rxjs'
 import {afterEach, beforeEach, describe, expect, it, vi} from 'vitest'
 
-import {createSanityInstance} from '../instance/sanityInstance'
-import {createResourceState} from '../resources/createResource'
+import {createSanityInstance} from '../store/createSanityInstance'
+import {createStoreState} from '../store/createStoreState'
 import {AuthStateType} from './authStateType'
 import {type AuthState, authStore} from './authStore'
 import {refreshStampedToken} from './refreshStampedToken'
@@ -46,14 +46,14 @@ describe('refreshStampedToken', () => {
     }
 
     // Create the resource state
-    const state = createResourceState(initialState)
+    const state = createStoreState(initialState)
 
     // Call refreshStampedToken ONCE
     // Because TParams is [], createInternalAction will call the inner function for us
     const subscription: Subscription = refreshStampedToken({state, instance})
 
-    // Advance time by 10 minutes so the interval fires
-    vi.advanceTimersByTime(10 * 60 * 1000)
+    // Advance time by 12 hours so the interval fires
+    vi.advanceTimersByTime(12 * 60 * 60 * 1000)
 
     // The client request should have been called once
     expect(mockClient.observable.request).toHaveBeenCalledTimes(1)
@@ -89,12 +89,12 @@ describe('refreshStampedToken', () => {
       token: 'sk-initial-token-st123',
       currentUser: null,
     }
-    const state = createResourceState(initialState)
+    const state = createStoreState(initialState)
 
     const subscription: Subscription = refreshStampedToken({state, instance})
 
     // Move time forward to trigger the interval
-    vi.advanceTimersByTime(10 * 60 * 1000)
+    vi.advanceTimersByTime(12 * 60 * 60 * 1000)
 
     // Should have set an error state
     expect(state.get().authState).toEqual({
@@ -119,7 +119,7 @@ describe('refreshStampedToken', () => {
       type: AuthStateType.LOGGED_OUT,
       isDestroyingSession: false,
     } as AuthState
-    const state = createResourceState(initialState)
+    const state = createStoreState(initialState)
 
     const subscription: Subscription = refreshStampedToken({state, instance})
 
@@ -156,7 +156,7 @@ describe('refreshStampedToken', () => {
       token: 'sk-nonstamped-token2', // Note: doesn't include '-st'
       currentUser: null,
     }
-    const state = createResourceState(initialState)
+    const state = createStoreState(initialState)
 
     const subscription: Subscription = refreshStampedToken({state, instance})
 

package/src/auth/refreshStampedToken.ts

@@ -1,6 +1,14 @@
-import {distinctUntilChanged, filter, interval, map, switchMap, takeWhile} from 'rxjs'
+import {
+  distinctUntilChanged,
+  filter,
+  interval,
+  map,
+  type Subscription,
+  switchMap,
+  takeWhile,
+} from 'rxjs'
 
-import {type ActionContext, createInternalAction} from '../resources/createAction'
+import {type StoreContext} from '../store/defineStore'
 import {DEFAULT_API_VERSION} from './authConstants'
 import {AuthStateType} from './authStateType'
 import {type AuthState, type AuthStoreState} from './authStore'
@@ -8,61 +16,59 @@ import {type AuthState, type AuthStoreState} from './authStore'
 /**
  * @internal
  */
-export const refreshStampedToken = createInternalAction(
-  ({state}: ActionContext<AuthStoreState>) => {
-    const {clientFactory, apiHost, storageArea, storageKey} = state.get().options
+export const refreshStampedToken = ({state}: StoreContext<AuthStoreState>): Subscription => {
+  const {clientFactory, apiHost, storageArea, storageKey} = state.get().options
 
-    const refreshToken$ = state.observable.pipe(
-      map(({authState}) => authState),
-      filter(
-        (authState): authState is Extract<AuthState, {type: AuthStateType.LOGGED_IN}> =>
-          authState.type === AuthStateType.LOGGED_IN,
-      ),
-      distinctUntilChanged(),
-      filter((authState) => authState.token.includes('-st')), // Ensure we only try to refresh stamped tokens
-      switchMap((authState) =>
-        interval(10 * 60 * 1000).pipe(
-          takeWhile(() => state.get().authState.type === AuthStateType.LOGGED_IN),
-          map(() => authState.token),
-          distinctUntilChanged(),
-          map((token) =>
-            clientFactory({
-              apiVersion: DEFAULT_API_VERSION,
-              requestTagPrefix: 'sdk.token-refresh',
-              useProjectHostname: false,
-              token,
-              ignoreBrowserTokenWarning: true,
-              ...(apiHost && {apiHost}),
-            }),
-          ),
-          switchMap((client) =>
-            client.observable.request<{token: string}>({
-              uri: 'auth/refresh-token',
-              method: 'POST',
-              body: {
-                token: authState.token,
-              },
-            }),
-          ),
+  const refreshInterval = 12 * 60 * 60 * 1000 // refresh the token every 12 hours
+
+  const refreshToken$ = state.observable.pipe(
+    map(({authState}) => authState),
+    filter(
+      (authState): authState is Extract<AuthState, {type: AuthStateType.LOGGED_IN}> =>
+        authState.type === AuthStateType.LOGGED_IN,
+    ),
+    distinctUntilChanged(),
+    filter((authState) => authState.token.includes('-st')), // Ensure we only try to refresh stamped tokens
+    switchMap((authState) =>
+      interval(refreshInterval).pipe(
+        takeWhile(() => state.get().authState.type === AuthStateType.LOGGED_IN),
+        map(() => authState.token),
+        distinctUntilChanged(),
+        map((token) =>
+          clientFactory({
+            apiVersion: DEFAULT_API_VERSION,
+            requestTagPrefix: 'sdk.token-refresh',
+            useProjectHostname: false,
+            token,
+            ignoreBrowserTokenWarning: true,
+            ...(apiHost && {apiHost}),
+          }),
+        ),
+        switchMap((client) =>
+          client.observable.request<{token: string}>({
+            uri: 'auth/refresh-token',
+            method: 'POST',
+            body: {
+              token: authState.token,
+            },
+          }),
         ),
       ),
-    )
+    ),
+  )
 
-    return function () {
-      return refreshToken$.subscribe({
-        next: (response) => {
-          state.set('setRefreshStampedToken', (prev) => ({
-            authState:
-              prev.authState.type === AuthStateType.LOGGED_IN
-                ? {...prev.authState, token: response.token}
-                : prev.authState,
-          }))
-          storageArea?.setItem(storageKey, JSON.stringify({token: response.token}))
-        },
-        error: (error) => {
-          state.set('setRefreshStampedTokenError', {authState: {type: AuthStateType.ERROR, error}})
-        },
-      })
-    }
-  },
-)
+  return refreshToken$.subscribe({
+    next: (response) => {
+      state.set('setRefreshStampedToken', (prev) => ({
+        authState:
+          prev.authState.type === AuthStateType.LOGGED_IN
+            ? {...prev.authState, token: response.token}
+            : prev.authState,
+      }))
+      storageArea?.setItem(storageKey, JSON.stringify({token: response.token}))
+    },
+    error: (error) => {
+      state.set('setRefreshStampedTokenError', {authState: {type: AuthStateType.ERROR, error}})
+    },
+  })
+}

package/src/auth/subscribeToStateAndFetchCurrentUser.test.ts

@@ -2,8 +2,8 @@ import {type CurrentUser} from '@sanity/types'
 import {delay, of, throwError} from 'rxjs'
 import {beforeEach, describe, it} from 'vitest'
 
-import {createSanityInstance} from '../instance/sanityInstance'
-import {createResourceState} from '../resources/createResource'
+import {createSanityInstance} from '../store/createSanityInstance'
+import {createStoreState} from '../store/createStoreState'
 import {AuthStateType} from './authStateType'
 import {authStore} from './authStore'
 import {subscribeToStateAndFetchCurrentUser} from './subscribeToStateAndFetchCurrentUser'
@@ -20,7 +20,7 @@ describe('subscribeToStateAndFetchCurrentUser', () => {
     const clientFactory = vi.fn().mockReturnValue(mockClient)
     const instance = createSanityInstance({projectId: 'p', dataset: 'd', auth: {clientFactory}})
 
-    const state = createResourceState(authStore.getInitialState(instance))
+    const state = createStoreState(authStore.getInitialState(instance))
     const subscription = subscribeToStateAndFetchCurrentUser({state, instance})
 
     expect(state.get()).toMatchObject({authState: {type: AuthStateType.LOGGED_OUT}})
@@ -51,7 +51,7 @@ describe('subscribeToStateAndFetchCurrentUser', () => {
     const clientFactory = vi.fn().mockReturnValue(mockClient)
     const instance = createSanityInstance({projectId: 'p', dataset: 'd', auth: {clientFactory}})
 
-    const state = createResourceState(authStore.getInitialState(instance))
+    const state = createStoreState(authStore.getInitialState(instance))
     const subscription = subscribeToStateAndFetchCurrentUser({state, instance})
 
     expect(state.get()).toMatchObject({authState: {type: AuthStateType.LOGGED_OUT}})
@@ -86,7 +86,7 @@ describe('subscribeToStateAndFetchCurrentUser', () => {
     const clientFactory = vi.fn().mockReturnValue(mockClient)
     const instance = createSanityInstance({projectId: 'p', dataset: 'd', auth: {clientFactory}})
 
-    const state = createResourceState(authStore.getInitialState(instance))
+    const state = createStoreState(authStore.getInitialState(instance))
     const subscription = subscribeToStateAndFetchCurrentUser({state, instance})
 
     expect(state.get()).toMatchObject({authState: {type: AuthStateType.LOGGED_OUT}})

package/src/auth/subscribeToStateAndFetchCurrentUser.ts

@@ -1,55 +1,53 @@
 import {type CurrentUser} from '@sanity/types'
-import {distinctUntilChanged, filter, map, switchMap} from 'rxjs'
+import {distinctUntilChanged, filter, map, type Subscription, switchMap} from 'rxjs'
 
-import {type ActionContext, createInternalAction} from '../resources/createAction'
+import {type StoreContext} from '../store/defineStore'
 import {DEFAULT_API_VERSION, REQUEST_TAG_PREFIX} from './authConstants'
 import {AuthStateType} from './authStateType'
 import {type AuthState, type AuthStoreState} from './authStore'
 
-export const subscribeToStateAndFetchCurrentUser = createInternalAction(
-  ({state}: ActionContext<AuthStoreState>) => {
-    const {clientFactory, apiHost} = state.get().options
+export const subscribeToStateAndFetchCurrentUser = ({
+  state,
+}: StoreContext<AuthStoreState>): Subscription => {
+  const {clientFactory, apiHost} = state.get().options
 
-    const currentUser$ = state.observable
-      .pipe(
-        map(({authState}) => authState),
-        filter(
-          (authState): authState is Extract<AuthState, {type: AuthStateType.LOGGED_IN}> =>
-            authState.type === AuthStateType.LOGGED_IN && !authState.currentUser,
-        ),
-        map((authState) => authState.token),
-        distinctUntilChanged(),
-      )
-      .pipe(
-        map((token) =>
-          clientFactory({
-            apiVersion: DEFAULT_API_VERSION,
-            requestTagPrefix: REQUEST_TAG_PREFIX,
-            token,
-            ignoreBrowserTokenWarning: true,
-            useProjectHostname: false,
-            ...(apiHost && {apiHost}),
-          }),
-        ),
-        switchMap((client) =>
-          client.observable.request<CurrentUser>({uri: '/users/me', method: 'GET'}),
-        ),
-      )
+  const currentUser$ = state.observable
+    .pipe(
+      map(({authState}) => authState),
+      filter(
+        (authState): authState is Extract<AuthState, {type: AuthStateType.LOGGED_IN}> =>
+          authState.type === AuthStateType.LOGGED_IN && !authState.currentUser,
+      ),
+      map((authState) => authState.token),
+      distinctUntilChanged(),
+    )
+    .pipe(
+      map((token) =>
+        clientFactory({
+          apiVersion: DEFAULT_API_VERSION,
+          requestTagPrefix: REQUEST_TAG_PREFIX,
+          token,
+          ignoreBrowserTokenWarning: true,
+          useProjectHostname: false,
+          ...(apiHost && {apiHost}),
+        }),
+      ),
+      switchMap((client) =>
+        client.observable.request<CurrentUser>({uri: '/users/me', method: 'GET'}),
+      ),
+    )
 
-    return function () {
-      return currentUser$.subscribe({
-        next: (currentUser) => {
-          state.set('setCurrentUser', (prev) => ({
-            authState:
-              prev.authState.type === AuthStateType.LOGGED_IN
-                ? {...prev.authState, currentUser}
-                : prev.authState,
-          }))
-        },
-        error: (error) => {
-          state.set('setError', {authState: {type: AuthStateType.ERROR, error}})
-        },
-      })
-    }
-  },
-)
+  return currentUser$.subscribe({
+    next: (currentUser) => {
+      state.set('setCurrentUser', (prev) => ({
+        authState:
+          prev.authState.type === AuthStateType.LOGGED_IN
+            ? {...prev.authState, currentUser}
+            : prev.authState,
+      }))
+    },
+    error: (error) => {
+      state.set('setError', {authState: {type: AuthStateType.ERROR, error}})
+    },
+  })
+}

package/src/auth/subscribeToStorageEventsAndSetToken.test.ts

@@ -1,9 +1,8 @@
 import {Observable, Subject} from 'rxjs'
 import {beforeEach, describe, it} from 'vitest'
 
-import {createSanityInstance} from '../instance/sanityInstance'
-import {type SanityInstance} from '../instance/types'
-import {createResourceState} from '../resources/createResource'
+import {createSanityInstance, type SanityInstance} from '../store/createSanityInstance'
+import {createStoreState} from '../store/createStoreState'
 import {AuthStateType} from './authStateType'
 import {authStore} from './authStore'
 import {subscribeToStorageEventsAndSetToken} from './subscribeToStorageEventsAndSetToken'
@@ -35,7 +34,7 @@ describe('subscribeToStorageEventsAndSetToken', () => {
   })
 
   it('sets the state to logged in when a matching storage event returns a token', () => {
-    const state = createResourceState(authStore.getInitialState(instance))
+    const state = createStoreState(authStore.getInitialState(instance))
     const {storageKey} = state.get().options
     const subscription = subscribeToStorageEventsAndSetToken({state, instance})
 
@@ -55,7 +54,7 @@ describe('subscribeToStorageEventsAndSetToken', () => {
 
   it('sets the state to logged in when a matching storage event returns null', () => {
     vi.mocked(getTokenFromStorage).mockReturnValue('existing-token')
-    const state = createResourceState(authStore.getInitialState(instance))
+    const state = createStoreState(authStore.getInitialState(instance))
     const {storageKey} = state.get().options
 
     const subscription = subscribeToStorageEventsAndSetToken({state, instance})

package/src/auth/subscribeToStorageEventsAndSetToken.ts

@@ -1,31 +1,29 @@
-import {defer, distinctUntilChanged, filter, map} from 'rxjs'
+import {defer, distinctUntilChanged, filter, map, type Subscription} from 'rxjs'
 
-import {type ActionContext, createInternalAction} from '../resources/createAction'
+import {type StoreContext} from '../store/defineStore'
 import {AuthStateType} from './authStateType'
 import {type AuthStoreState} from './authStore'
 import {getStorageEvents, getTokenFromStorage} from './utils'
 
-export const subscribeToStorageEventsAndSetToken = createInternalAction(
-  ({state}: ActionContext<AuthStoreState>) => {
-    const {storageArea, storageKey} = state.get().options
+export const subscribeToStorageEventsAndSetToken = ({
+  state,
+}: StoreContext<AuthStoreState>): Subscription => {
+  const {storageArea, storageKey} = state.get().options
 
-    const tokenFromStorage$ = defer(getStorageEvents).pipe(
-      filter(
-        (e): e is StorageEvent & {newValue: string} =>
-          e.storageArea === storageArea && e.key === storageKey,
-      ),
-      map(() => getTokenFromStorage(storageArea, storageKey)),
-      distinctUntilChanged(),
-    )
+  const tokenFromStorage$ = defer(getStorageEvents).pipe(
+    filter(
+      (e): e is StorageEvent & {newValue: string} =>
+        e.storageArea === storageArea && e.key === storageKey,
+    ),
+    map(() => getTokenFromStorage(storageArea, storageKey)),
+    distinctUntilChanged(),
+  )
 
-    return function () {
-      return tokenFromStorage$.subscribe((token) => {
-        state.set('updateTokenFromStorageEvent', {
-          authState: token
-            ? {type: AuthStateType.LOGGED_IN, token, currentUser: null}
-            : {type: AuthStateType.LOGGED_OUT, isDestroyingSession: false},
-        })
-      })
-    }
-  },
-)
+  return tokenFromStorage$.subscribe((token) => {
+    state.set('updateTokenFromStorageEvent', {
+      authState: token
+        ? {type: AuthStateType.LOGGED_IN, token, currentUser: null}
+        : {type: AuthStateType.LOGGED_OUT, isDestroyingSession: false},
+    })
+  })
+}