refactor(storage): deprecate storage names to avoid collisions

Author: posva

docs/guide/firebase-composables.md

@@ -9,14 +9,14 @@ import {
   useAuth,
   useDatabase,
   useFirestore,
-  useStorage,
+  useFirebaseStorage,
 } from 'vuefire'
 
 const firebaseApp = useFirebaseApp()
 const auth = useAuth()
 const database = useDatabase()
 const firestore = useFirestore()
-const storage = useStorage()
+const storage = useFirebaseStorage()
 </script>
 ```
 

playground/src/pages/storage.vue

@@ -1,7 +1,7 @@
 <script lang="ts" setup>
 import { computed, ref, watch } from 'vue'
 import { useFileDialog } from '@vueuse/core'
-import { useCurrentUser, useStorage, useStorageObject } from 'vuefire'
+import { useCurrentUser, useFirebaseStorage, useStorageFile } from 'vuefire'
 import {
   deleteObject,
   ref as storageRef,
@@ -23,7 +23,7 @@ watch(
 
 const user = useCurrentUser()
 
-const storage = useStorage()
+const storage = useFirebaseStorage()
 const storageBucket = storageRef(storage, 'demo/' + user.value?.uid || '')
 const storageSource = computed(() =>
   filename.value ? storageRef(storageBucket, filename.value) : null
@@ -37,7 +37,7 @@ const {
   uploadTask,
   metadata,
   upload,
-} = useStorageObject(storageSource)
+} = useStorageFile(storageSource)
 
 // TODO: move to tests
 // useStorageTask(storageSource, null).data

src/index.ts

@@ -99,10 +99,15 @@ export type { VueFireAppCheckOptions } from './app-check'
  * Storage
  */
 export {
+  useFirebaseStorage,
+  useStorageFile,
+  useStorageFileUrl,
+  useStorageFileMetadata,
+  // deprecated apis
   useStorage,
-  useStorageMetadata,
-  useStorageUrl,
   useStorageObject,
+  useStorageUrl,
+  useStorageMetadata,
 } from './storage'
 
 /**

src/storage/index.ts

@@ -36,7 +36,7 @@ import { addPendingPromise } from '../ssr/plugin'
  * @param name - name of the application
  * @returns the Database instance
  */
-export function useStorage(name?: string) {
+export function useFirebaseStorage(name?: string) {
   return getStorage(useFirebaseApp(name))
 }
 
@@ -45,7 +45,7 @@ export function useStorage(name?: string) {
  *
  * @param storageRef - StorageReference
  */
-export function useStorageUrl(
+export function useStorageFileUrl(
   storageRef: _MaybeRef<_Nullable<StorageReference>>
 ) {
   const initialSourceValue = unref(storageRef)
@@ -98,7 +98,7 @@ export function useStorageUrl(
  *
  * @param storageRef - StorageReference
  */
-export function useStorageMetadata(
+export function useStorageFileMetadata(
   storageRef: _MaybeRef<_Nullable<StorageReference>>
 ) {
   const initialSourceValue = unref(storageRef)
@@ -168,15 +168,15 @@ export function useStorageMetadata(
  *
  * @param storageRef - StorageReference
  */
-export function useStorageObject(
+export function useStorageFile(
   storageRef: _MaybeRef<_Nullable<StorageReference>>
 ) {
-  const { url, refresh: refreshUrl } = useStorageUrl(storageRef)
+  const { url, refresh: refreshUrl } = useStorageFileUrl(storageRef)
   const {
     metadata,
     update: updateMetadata,
     refresh: refreshMetadata,
-  } = useStorageMetadata(storageRef)
+  } = useStorageFileMetadata(storageRef)
 
   const uploadTask = shallowRef<UploadTask | null>()
   const snapshot = shallowRef<UploadTaskSnapshot | null>()
@@ -284,3 +284,25 @@ export function useStorageObject(
     // promise,
   }
 }
+
+// DEPRECATION
+
+/**
+ * @deprecated use `useFirebaseStorage()` instead
+ */
+export const useStorage = useFirebaseStorage
+
+/**
+ * @deprecated use `useStorageFileUrl()` instead
+ */
+export const useStorageUrl = useStorageFileUrl
+
+/**
+ * @deprecated use `useStorageFileMetadata()` instead
+ */
+export const useStorageMetadata = useStorageFileMetadata
+
+/**
+ * @deprecated use `useStorageFile()` instead
+ */
+export const useStorageObject = useStorageFile

tests/storage/index.spec.ts

@@ -3,10 +3,10 @@ import { it, describe, expect } from 'vitest'
 import { uploadString } from 'firebase/storage'
 import { nextTick, ref } from 'vue'
 import {
-  useStorage,
-  useStorageMetadata,
-  useStorageObject,
-  useStorageUrl,
+  useFirebaseStorage,
+  useStorageFileMetadata,
+  useStorageFile,
+  useStorageFileUrl,
 } from '../../src'
 import { setupStorageRefs } from '../utils'
 
@@ -19,7 +19,7 @@ describe('Storage', () => {
     const wrapper = mount({
       template: 'no',
       setup() {
-        const { url, promise } = useStorageUrl(objectRef)
+        const { url, promise } = useStorageFileUrl(objectRef)
 
         return { url, promise }
       },
@@ -37,7 +37,7 @@ describe('Storage', () => {
     const wrapper = mount({
       template: 'no',
       setup() {
-        const { metadata, promise } = useStorageMetadata(objectRef)
+        const { metadata, promise } = useStorageFileMetadata(objectRef)
 
         return { metadata, promise }
       },
@@ -57,8 +57,7 @@ describe('Storage', () => {
     const wrapper = mount({
       template: 'no',
       setup() {
-        const { uploadTask, upload, uploadProgress } =
-          useStorageObject(objectRef)
+        const { uploadTask, upload, uploadProgress } = useStorageFile(objectRef)
 
         return { uploadTask, upload, uploadProgress }
       },