Type-hint contracts instead of implementations

jeromegamez · jeromegamez · commit d5b468f0144d · 2021-04-24T02:21:13.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## Unreleased
+### Changed
+* Type-hints have been updated to point to the interfaces that the underlying SDK provides
+  since more recent versions. 
+
 ## 3.1.0 - 2021-02-03
 ### Added
 * Support for tenant awareness via `FIREBASE_AUTH_TENANT_ID` environment variable
diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
     ],
     "require": {
         "php": "^7.2|~8.0.0",
-        "kreait/firebase-php": "^5.14.1",
+        "kreait/firebase-php": "^5.18",
         "illuminate/contracts": "^6.0|^7.0|^8.0",
         "illuminate/support": "^6.0|^7.0|^8.0"
     },
diff --git a/src/Facades/Firebase.php b/src/Facades/Firebase.php
@@ -10,13 +10,13 @@
  * @method static \Kreait\Laravel\Firebase\FirebaseProject project(string $name = null)
  * @method static string getDefaultProject()
  * @method static void setDefaultProject(string $name)
- * @method static \Kreait\Firebase\Auth auth()
- * @method static \Kreait\Firebase\Database database()
- * @method static \Kreait\Firebase\DynamicLinks dynamicLinks()
- * @method static \Kreait\Firebase\Firestore firestore()
- * @method static \Kreait\Firebase\Messaging messaging()
- * @method static \Kreait\Firebase\RemoteConfig remoteConfig()
- * @method static \Kreait\Firebase\Storage storage()
+ * @method static \Kreait\Firebase\Contract\Auth auth()
+ * @method static \Kreait\Firebase\Contract\Database database()
+ * @method static \Kreait\Firebase\Contract\DynamicLinks dynamicLinks()
+ * @method static \Kreait\Firebase\Contract\Firestore firestore()
+ * @method static \Kreait\Firebase\Contract\Messaging messaging()
+ * @method static \Kreait\Firebase\Contract\RemoteConfig remoteConfig()
+ * @method static \Kreait\Firebase\Contract\Storage storage()
  *
  * @see \Kreait\Laravel\Firebase\FirebaseProjectManager
  * @see \Kreait\Laravel\Firebase\FirebaseProject
diff --git a/src/Facades/FirebaseAuth.php b/src/Facades/FirebaseAuth.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \Kreait\Firebase\Auth
+ * @see \Kreait\Firebase\Contract\Auth
  * @deprecated 3.0 Use {@see \Kreait\Laravel\Firebase\Facades\Firebase::auth()} instead.
  */
 final class FirebaseAuth extends Facade
diff --git a/src/Facades/FirebaseDatabase.php b/src/Facades/FirebaseDatabase.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \Kreait\Firebase\Database
+ * @see \Kreait\Firebase\Contract\Database
  * @deprecated 3.0 Use {@see \Kreait\Laravel\Firebase\Facades\Firebase::database()} instead.
  */
 final class FirebaseDatabase extends Facade
diff --git a/src/Facades/FirebaseDynamicLinks.php b/src/Facades/FirebaseDynamicLinks.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \Kreait\Firebase\DynamicLinks
+ * @see \Kreait\Firebase\Contract\DynamicLinks
  * @deprecated 3.0 Use {@see \Kreait\Laravel\Firebase\Facades\Firebase::dynamicLinks()} instead.
  */
 final class FirebaseDynamicLinks extends Facade
diff --git a/src/Facades/FirebaseFirestore.php b/src/Facades/FirebaseFirestore.php
@@ -7,8 +7,8 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \Kreait\Firebase\Firestore
- * @mixin \Kreait\Firebase\Firestore
+ * @see \Kreait\Firebase\Contract\Firestore
+ * @mixin \Kreait\Firebase\Contract\Firestore
  *
  * @deprecated 3.0 Use {@see \Kreait\Laravel\Firebase\Facades\Firebase::firestore()} instead.
  */
diff --git a/src/Facades/FirebaseMessaging.php b/src/Facades/FirebaseMessaging.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \Kreait\Firebase\Messaging
+ * @see \Kreait\Firebase\Contract\Messaging
  * @deprecated 3.0 Use {@see \Kreait\Laravel\Firebase\Facades\Firebase::messaging()} instead.
  */
 final class FirebaseMessaging extends Facade
diff --git a/src/Facades/FirebaseRemoteConfig.php b/src/Facades/FirebaseRemoteConfig.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \Kreait\Firebase\RemoteConfig
+ * @see \Kreait\Firebase\Contract\RemoteConfig
  * @deprecated 3.0 Use {@see \Kreait\Laravel\Firebase\Facades\Firebase::remoteConfig()} instead.
  */
 final class FirebaseRemoteConfig extends Facade
diff --git a/src/Facades/FirebaseStorage.php b/src/Facades/FirebaseStorage.php
@@ -7,7 +7,7 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \Kreait\Firebase\Storage
+ * @see \Kreait\Firebase\Contract\Storage
  * @deprecated 3.0 Use {@see \Kreait\Laravel\Firebase\Facades\Firebase::storage()} instead.
  */
 final class FirebaseStorage extends Facade
diff --git a/src/FirebaseProject.php b/src/FirebaseProject.php
@@ -14,25 +14,25 @@ class FirebaseProject
     /** @var array */
     protected $config;
 
-    /** @var \Kreait\Firebase\Auth|null */
+    /** @var \Kreait\Firebase\Contract\Auth|null */
     protected $auth;
 
-    /** @var \Kreait\Firebase\Database|null */
+    /** @var \Kreait\Firebase\Contract\Database|null */
     protected $database;
 
-    /** @var \Kreait\Firebase\DynamicLinks|null */
+    /** @var \Kreait\Firebase\Contract\DynamicLinks|null */
     protected $dynamicLinks;
 
-    /** @var \Kreait\Firebase\Firestore|null */
+    /** @var \Kreait\Firebase\Contract\Firestore|null */
     protected $firestore;
 
-    /** @var \Kreait\Firebase\Messaging|null */
+    /** @var \Kreait\Firebase\Contract\Messaging|null */
     protected $messaging;
 
-    /** @var \Kreait\Firebase\RemoteConfig|null */
+    /** @var \Kreait\Firebase\Contract\RemoteConfig|null */
     protected $remoteConfig;
 
-    /** @var \Kreait\Firebase\Storage|null */
+    /** @var \Kreait\Firebase\Contract\Storage|null */
     protected $storage;
 
     public function __construct(Firebase\Factory $factory, array $config)
@@ -41,7 +41,7 @@ public function __construct(Firebase\Factory $factory, array $config)
         $this->config = $config;
     }
 
-    public function auth(): Firebase\Auth
+    public function auth(): Firebase\Contract\Auth
     {
         if (!$this->auth) {
             $this->auth = $this->factory->createAuth();
@@ -50,7 +50,7 @@ public function auth(): Firebase\Auth
         return $this->auth;
     }
 
-    public function database(): Firebase\Database
+    public function database(): Firebase\Contract\Database
     {
         if (!$this->database) {
             $this->database = $this->factory->createDatabase();
@@ -59,7 +59,7 @@ public function database(): Firebase\Database
         return $this->database;
     }
 
-    public function dynamicLinks(): Firebase\DynamicLinks
+    public function dynamicLinks(): Firebase\Contract\DynamicLinks
     {
         if (!$this->dynamicLinks) {
             $this->dynamicLinks = $this->factory->createDynamicLinksService($this->config['dynamic_links']['default_domain'] ?? null);
@@ -68,7 +68,7 @@ public function dynamicLinks(): Firebase\DynamicLinks
         return $this->dynamicLinks;
     }
 
-    public function firestore(): Firebase\Firestore
+    public function firestore(): Firebase\Contract\Firestore
     {
         if (!$this->firestore) {
             $this->firestore = $this->factory->createFirestore();
@@ -77,7 +77,7 @@ public function firestore(): Firebase\Firestore
         return $this->firestore; // @codeCoverageIgnore
     }
 
-    public function messaging(): Firebase\Messaging
+    public function messaging(): Firebase\Contract\Messaging
     {
         if (!$this->messaging) {
             $this->messaging = $this->factory->createMessaging();
@@ -86,7 +86,7 @@ public function messaging(): Firebase\Messaging
         return $this->messaging;
     }
 
-    public function remoteConfig(): Firebase\RemoteConfig
+    public function remoteConfig(): Firebase\Contract\RemoteConfig
     {
         if (!$this->remoteConfig) {
             $this->remoteConfig = $this->factory->createRemoteConfig();
@@ -95,7 +95,7 @@ public function remoteConfig(): Firebase\RemoteConfig
         return $this->remoteConfig;
     }
 
-    public function storage(): Firebase\Storage
+    public function storage(): Firebase\Contract\Storage
     {
         if (!$this->storage) {
             $this->storage = $this->factory->createStorage();
diff --git a/src/ServiceProvider.php b/src/ServiceProvider.php
@@ -43,10 +43,11 @@ public function register()
 
     private function registerComponents(): void
     {
-        $this->app->singleton(Firebase\Auth::class, static function (Container $app) {
+        $this->app->singleton(Firebase\Contract\Auth::class, static function (Container $app) {
             return $app->make(FirebaseProjectManager::class)->project()->auth();
         });
-        $this->app->alias(Firebase\Auth::class, 'firebase.auth');
+        $this->app->alias(Firebase\Contract\Auth::class, Firebase\Auth::class);
+        $this->app->alias(Firebase\Contract\Auth::class, 'firebase.auth');
 
         $this->app->singleton(Firebase\Database::class, static function (Container $app) {
             return $app->make(FirebaseProjectManager::class)->project()->database();
