cocoapods-catalyst-validator 0.1.0.beta.1

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/InstallationsIDController/FIRInstallationsStatus.h

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+/**
+ * The enum represent possible states of the installation ID.
+ *
+ * WARNING: The enum is stored to Keychain as a part of `FIRInstallationsStoredItem`. Modification
+ * of it can lead to incompatibility with previous version. Any modification must be evaluated and,
+ * if it is really needed, the `storageVersion` must be bumped and proper migration code added.
+ */
+typedef NS_ENUM(NSInteger, FIRInstallationsStatus) {
+  /** Represents either an initial status when a FIRInstallationsItem instance was created but not
+   * stored to Keychain or an undefined status (e.g. when the status failed to deserialize).
+   */
+  FIRInstallationStatusUnknown,
+  /// The Firebase Installation has not yet been registered with FIS.
+  FIRInstallationStatusUnregistered,
+  /// The Firebase Installation has successfully been registered with FIS.
+  FIRInstallationStatusRegistered,
+};

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStore.h

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+@class FBLPromise<ValueType>;
+@class FIRInstallationsItem;
+@class GULKeychainStorage;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// The user defaults suite name used to store data.
+extern NSString *const kFIRInstallationsStoreUserDefaultsID;
+
+/// The class is responsible for storing and accessing the installations data.
+@interface FIRInstallationsStore : NSObject
+
+/**
+ * The default initializer.
+ * @param storage The secure storage to save installations data.
+ * @param accessGroup The Keychain Access Group to store and request the installations data.
+ */
+- (instancetype)initWithSecureStorage:(GULKeychainStorage *)storage
+                          accessGroup:(nullable NSString *)accessGroup;
+
+/**
+ * Retrieves existing installation ID if there is.
+ * @param appID The Firebase(Google) Application ID.
+ * @param appName The Firebase Application Name.
+ *
+ * @return Returns a `FBLPromise` instance. The promise is resolved with a FIRInstallationsItem
+ * instance if there is a valid installation stored for `appID` and `appName`. The promise is
+ * rejected with a specific error when the installation has not been found or with another possible
+ * error.
+ */
+- (FBLPromise<FIRInstallationsItem *> *)installationForAppID:(NSString *)appID
+                                                     appName:(NSString *)appName;
+
+/**
+ * Saves the given installation.
+ *
+ * @param installationItem The installation data.
+ * @return Returns a promise that is resolved with `[NSNull null]` on success.
+ */
+- (FBLPromise<NSNull *> *)saveInstallation:(FIRInstallationsItem *)installationItem;
+
+/**
+ * Removes installation data for the given app parameters.
+ * @param appID The Firebase(Google) Application ID.
+ * @param appName The Firebase Application Name.
+ *
+ * @return Returns a promise that is resolved with `[NSNull null]` on success.
+ */
+- (FBLPromise<NSNull *> *)removeInstallationForAppID:(NSString *)appID appName:(NSString *)appName;
+
+@end
+
+NS_ASSUME_NONNULL_END

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStore.m

@@ -0,0 +1,126 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStore.h"
+
+#import <GoogleUtilities/GULUserDefaults.h>
+
+#if __has_include(<FBLPromises/FBLPromises.h>)
+#import <FBLPromises/FBLPromises.h>
+#else
+#import "FBLPromises.h"
+#endif
+
+#import <GoogleUtilities/GULKeychainStorage.h>
+
+#import "FirebaseInstallations/Source/Library/Errors/FIRInstallationsErrorUtil.h"
+#import "FirebaseInstallations/Source/Library/FIRInstallationsItem.h"
+#import "FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredItem.h"
+
+NSString *const kFIRInstallationsStoreUserDefaultsID = @"com.firebase.FIRInstallations";
+
+@interface FIRInstallationsStore ()
+@property(nonatomic, readonly) GULKeychainStorage *secureStorage;
+@property(nonatomic, readonly, nullable) NSString *accessGroup;
+@property(nonatomic, readonly) dispatch_queue_t queue;
+@property(nonatomic, readonly) GULUserDefaults *userDefaults;
+@end
+
+@implementation FIRInstallationsStore
+
+- (instancetype)initWithSecureStorage:(GULKeychainStorage *)storage
+                          accessGroup:(NSString *)accessGroup {
+  self = [super init];
+  if (self) {
+    _secureStorage = storage;
+    _accessGroup = [accessGroup copy];
+    _queue = dispatch_queue_create("com.firebase.FIRInstallationsStore", DISPATCH_QUEUE_SERIAL);
+
+    NSString *userDefaultsSuiteName = _accessGroup ?: kFIRInstallationsStoreUserDefaultsID;
+    _userDefaults = [[GULUserDefaults alloc] initWithSuiteName:userDefaultsSuiteName];
+  }
+  return self;
+}
+
+- (FBLPromise<FIRInstallationsItem *> *)installationForAppID:(NSString *)appID
+                                                     appName:(NSString *)appName {
+  NSString *itemID = [FIRInstallationsItem identifierWithAppID:appID appName:appName];
+  return [self installationExistsForAppID:appID appName:appName]
+      .then(^id(id result) {
+        return [self.secureStorage getObjectForKey:itemID
+                                       objectClass:[FIRInstallationsStoredItem class]
+                                       accessGroup:self.accessGroup];
+      })
+      .then(^id(FIRInstallationsStoredItem *_Nullable storedItem) {
+        if (storedItem == nil) {
+          return [FIRInstallationsErrorUtil installationItemNotFoundForAppID:appID appName:appName];
+        }
+
+        FIRInstallationsItem *item = [[FIRInstallationsItem alloc] initWithAppID:appID
+                                                                 firebaseAppName:appName];
+        [item updateWithStoredItem:storedItem];
+        return item;
+      });
+}
+
+- (FBLPromise<NSNull *> *)saveInstallation:(FIRInstallationsItem *)installationItem {
+  FIRInstallationsStoredItem *storedItem = [installationItem storedItem];
+  NSString *identifier = [installationItem identifier];
+
+  return
+      [self.secureStorage setObject:storedItem forKey:identifier accessGroup:self.accessGroup].then(
+          ^id(id result) {
+            return [self setInstallationExists:YES forItemWithIdentifier:identifier];
+          });
+}
+
+- (FBLPromise<NSNull *> *)removeInstallationForAppID:(NSString *)appID appName:(NSString *)appName {
+  NSString *identifier = [FIRInstallationsItem identifierWithAppID:appID appName:appName];
+  return [self.secureStorage removeObjectForKey:identifier accessGroup:self.accessGroup].then(
+      ^id(id result) {
+        return [self setInstallationExists:NO forItemWithIdentifier:identifier];
+      });
+}
+
+#pragma mark - User defaults
+
+- (FBLPromise<NSNull *> *)installationExistsForAppID:(NSString *)appID appName:(NSString *)appName {
+  NSString *identifier = [FIRInstallationsItem identifierWithAppID:appID appName:appName];
+  return [FBLPromise onQueue:self.queue
+                          do:^id _Nullable {
+                            return [[self userDefaults] objectForKey:identifier] != nil
+                                       ? [NSNull null]
+                                       : [FIRInstallationsErrorUtil
+                                             installationItemNotFoundForAppID:appID
+                                                                      appName:appName];
+                          }];
+}
+
+- (FBLPromise<NSNull *> *)setInstallationExists:(BOOL)exists
+                          forItemWithIdentifier:(NSString *)identifier {
+  return [FBLPromise onQueue:self.queue
+                          do:^id _Nullable {
+                            if (exists) {
+                              [[self userDefaults] setBool:YES forKey:identifier];
+                            } else {
+                              [[self userDefaults] removeObjectForKey:identifier];
+                            }
+
+                            return [NSNull null];
+                          }];
+}
+
+@end

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredAuthToken.h

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * The enum represent possible states of the installation auth token.
+ *
+ * WARNING: The enum is stored to Keychain as a part of `FIRInstallationsStoredAuthToken`.
+ * Modification of it can lead to incompatibility with previous version. Any modification must be
+ * evaluated and, if it is really needed, the `storageVersion` must be bumped and proper migration
+ * code added.
+ */
+typedef NS_ENUM(NSInteger, FIRInstallationsAuthTokenStatus) {
+  /// An initial status or an undefined value.
+  FIRInstallationsAuthTokenStatusUnknown,
+  /// The auth token has been received from the server.
+  FIRInstallationsAuthTokenStatusTokenReceived
+};
+
+/**
+ * This class serializes and deserializes the installation data into/from `NSData` to be stored in
+ * Keychain. This class is primarily used by `FIRInstallationsStore`. It is also used on the logic
+ * level as a data object (see `FIRInstallationsItem.authToken`).
+ *
+ * WARNING: Modification of the class properties can lead to incompatibility with the stored data
+ * encoded by the previous class versions. Any modification must be evaluated and, if it is really
+ * needed, the `storageVersion` must be bumped and proper migration code added.
+ */
+@interface FIRInstallationsStoredAuthToken : NSObject <NSSecureCoding, NSCopying>
+@property FIRInstallationsAuthTokenStatus status;
+
+/// The installation auth token string that can be used to authorize requests to Firebase backend.
+@property(nullable, copy) NSString *token;
+/// The installation auth token expiration date.
+@property(nullable, copy) NSDate *expirationDate;
+
+/// The version of local storage.
+@property(nonatomic, readonly) NSInteger storageVersion;
+
+@end
+
+NS_ASSUME_NONNULL_END

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredAuthToken.m

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredAuthToken.h"
+
+#import "FirebaseInstallations/Source/Library/FIRInstallationsLogger.h"
+
+NSString *const kFIRInstallationsStoredAuthTokenStatusKey = @"status";
+NSString *const kFIRInstallationsStoredAuthTokenTokenKey = @"token";
+NSString *const kFIRInstallationsStoredAuthTokenExpirationDateKey = @"expirationDate";
+NSString *const kFIRInstallationsStoredAuthTokenStorageVersionKey = @"storageVersion";
+
+NSInteger const kFIRInstallationsStoredAuthTokenStorageVersion = 1;
+
+@implementation FIRInstallationsStoredAuthToken
+
+- (NSInteger)storageVersion {
+  return kFIRInstallationsStoredAuthTokenStorageVersion;
+}
+
+- (nonnull id)copyWithZone:(nullable NSZone *)zone {
+  FIRInstallationsStoredAuthToken *clone = [[FIRInstallationsStoredAuthToken alloc] init];
+  clone.status = self.status;
+  clone.token = [self.token copy];
+  clone.expirationDate = self.expirationDate;
+  return clone;
+}
+
+- (void)encodeWithCoder:(nonnull NSCoder *)aCoder {
+  [aCoder encodeInteger:self.status forKey:kFIRInstallationsStoredAuthTokenStatusKey];
+  [aCoder encodeObject:self.token forKey:kFIRInstallationsStoredAuthTokenTokenKey];
+  [aCoder encodeObject:self.expirationDate
+                forKey:kFIRInstallationsStoredAuthTokenExpirationDateKey];
+  [aCoder encodeInteger:self.storageVersion
+                 forKey:kFIRInstallationsStoredAuthTokenStorageVersionKey];
+}
+
+- (nullable instancetype)initWithCoder:(nonnull NSCoder *)aDecoder {
+  NSInteger storageVersion =
+      [aDecoder decodeIntegerForKey:kFIRInstallationsStoredAuthTokenStorageVersionKey];
+  if (storageVersion > kFIRInstallationsStoredAuthTokenStorageVersion) {
+    FIRLogWarning(kFIRLoggerInstallations,
+                  kFIRInstallationsMessageCodeAuthTokenCoderVersionMismatch,
+                  @"FIRInstallationsStoredAuthToken was encoded by a newer coder version %ld. "
+                  @"Current coder version is %ld. Some auth token data may be lost.",
+                  (long)storageVersion, (long)kFIRInstallationsStoredAuthTokenStorageVersion);
+  }
+
+  FIRInstallationsStoredAuthToken *object = [[FIRInstallationsStoredAuthToken alloc] init];
+  object.status = [aDecoder decodeIntegerForKey:kFIRInstallationsStoredAuthTokenStatusKey];
+  object.token = [aDecoder decodeObjectOfClass:[NSString class]
+                                        forKey:kFIRInstallationsStoredAuthTokenTokenKey];
+  object.expirationDate =
+      [aDecoder decodeObjectOfClass:[NSDate class]
+                             forKey:kFIRInstallationsStoredAuthTokenExpirationDateKey];
+
+  return object;
+}
+
++ (BOOL)supportsSecureCoding {
+  return YES;
+}
+
+@end

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredItem.h

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "FirebaseInstallations/Source/Library/InstallationsIDController/FIRInstallationsStatus.h"
+
+@class FIRInstallationsStoredAuthToken;
+@class FIRInstallationsStoredIIDCheckin;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * The class is supposed to be used by `FIRInstallationsStore` only. It is required to
+ * serialize/deserialize the installation data into/from `NSData` to be stored in Keychain.
+ *
+ * WARNING: Modification of the class properties can lead to incompatibility with the stored data
+ * encoded by the previous class versions. Any modification must be evaluated and, if it is really
+ * needed, the `storageVersion` must be bumped and proper migration code added.
+ */
+@interface FIRInstallationsStoredItem : NSObject <NSSecureCoding>
+
+///  A stable identifier that uniquely identifies the app instance.
+@property(nonatomic, copy, nullable) NSString *firebaseInstallationID;
+/// The `refreshToken` is used to authorize the installation auth token requests.
+@property(nonatomic, copy, nullable) NSString *refreshToken;
+
+@property(nonatomic, nullable) FIRInstallationsStoredAuthToken *authToken;
+@property(nonatomic) FIRInstallationsStatus registrationStatus;
+
+/// Instance ID default auth token imported from IID store as a part of IID migration.
+@property(nonatomic, nullable) NSString *IIDDefaultToken;
+
+/// The version of local storage.
+@property(nonatomic, readonly) NSInteger storageVersion;
+@end
+
+NS_ASSUME_NONNULL_END

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredItem.m

@@ -0,0 +1,80 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import "FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredItem.h"
+
+#import "FirebaseInstallations/Source/Library/FIRInstallationsLogger.h"
+#import "FirebaseInstallations/Source/Library/InstallationsStore/FIRInstallationsStoredAuthToken.h"
+
+NSString *const kFIRInstallationsStoredItemFirebaseInstallationIDKey = @"firebaseInstallationID";
+NSString *const kFIRInstallationsStoredItemRefreshTokenKey = @"refreshToken";
+NSString *const kFIRInstallationsStoredItemAuthTokenKey = @"authToken";
+NSString *const kFIRInstallationsStoredItemRegistrationStatusKey = @"registrationStatus";
+NSString *const kFIRInstallationsStoredItemIIDDefaultTokenKey = @"IIDDefaultToken";
+NSString *const kFIRInstallationsStoredItemStorageVersionKey = @"storageVersion";
+
+NSInteger const kFIRInstallationsStoredItemStorageVersion = 1;
+
+@implementation FIRInstallationsStoredItem
+
+- (NSInteger)storageVersion {
+  return kFIRInstallationsStoredItemStorageVersion;
+}
+
+- (void)encodeWithCoder:(nonnull NSCoder *)aCoder {
+  [aCoder encodeObject:self.firebaseInstallationID
+                forKey:kFIRInstallationsStoredItemFirebaseInstallationIDKey];
+  [aCoder encodeObject:self.refreshToken forKey:kFIRInstallationsStoredItemRefreshTokenKey];
+  [aCoder encodeObject:self.authToken forKey:kFIRInstallationsStoredItemAuthTokenKey];
+  [aCoder encodeInteger:self.registrationStatus
+                 forKey:kFIRInstallationsStoredItemRegistrationStatusKey];
+  [aCoder encodeObject:self.IIDDefaultToken forKey:kFIRInstallationsStoredItemIIDDefaultTokenKey];
+  [aCoder encodeInteger:self.storageVersion forKey:kFIRInstallationsStoredItemStorageVersionKey];
+}
+
+- (nullable instancetype)initWithCoder:(nonnull NSCoder *)aDecoder {
+  NSInteger storageVersion =
+      [aDecoder decodeIntegerForKey:kFIRInstallationsStoredItemStorageVersionKey];
+  if (storageVersion > self.storageVersion) {
+    FIRLogWarning(kFIRLoggerInstallations,
+                  kFIRInstallationsMessageCodeInstallationCoderVersionMismatch,
+                  @"FIRInstallationsStoredItem was encoded by a newer coder version %ld. Current "
+                  @"coder version is %ld. Some installation data may be lost.",
+                  (long)storageVersion, (long)kFIRInstallationsStoredItemStorageVersion);
+  }
+
+  FIRInstallationsStoredItem *item = [[FIRInstallationsStoredItem alloc] init];
+  item.firebaseInstallationID =
+      [aDecoder decodeObjectOfClass:[NSString class]
+                             forKey:kFIRInstallationsStoredItemFirebaseInstallationIDKey];
+  item.refreshToken = [aDecoder decodeObjectOfClass:[NSString class]
+                                             forKey:kFIRInstallationsStoredItemRefreshTokenKey];
+  item.authToken = [aDecoder decodeObjectOfClass:[FIRInstallationsStoredAuthToken class]
+                                          forKey:kFIRInstallationsStoredItemAuthTokenKey];
+  item.registrationStatus =
+      [aDecoder decodeIntegerForKey:kFIRInstallationsStoredItemRegistrationStatusKey];
+  item.IIDDefaultToken =
+      [aDecoder decodeObjectOfClass:[NSString class]
+                             forKey:kFIRInstallationsStoredItemIIDDefaultTokenKey];
+
+  return item;
+}
+
++ (BOOL)supportsSecureCoding {
+  return YES;
+}
+
+@end

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/Private/FirebaseInstallationsInternal.h

@@ -0,0 +1,19 @@
+// Copyright 2020 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// An umbrella header, for any other libraries in this repo to access Firebase
+// Installations Public headers. Any package manager complexity should be
+// handled here.
+
+#import <FirebaseInstallations/FirebaseInstallations.h>

data/examples/AExample/Pods/FirebaseInstallations/FirebaseInstallations/Source/Library/Public/FirebaseInstallations/FIRInstallations.h

@@ -0,0 +1,127 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <Foundation/Foundation.h>
+
+@class FIRApp;
+@class FIRInstallationsAuthTokenResult;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** A notification with this name is sent each time an installation is created or deleted. */
+// clang-format off
+// clang-format12 merges the next two lines.
+FOUNDATION_EXPORT const NSNotificationName FIRInstallationIDDidChangeNotification
+    NS_SWIFT_NAME(InstallationIDDidChange);
+/** `userInfo` key for the `FirebaseApp.name` in `FIRInstallationIDDidChangeNotification`. */
+FOUNDATION_EXPORT NSString *const kFIRInstallationIDDidChangeNotificationAppNameKey
+    NS_SWIFT_NAME(InstallationIDDidChangeAppNameKey);
+// clang-format on
+
+/**
+ * An installation ID handler block.
+ * @param identifier The installation ID string if exists or `nil` otherwise.
+ * @param error The error when `identifier == nil` or `nil` otherwise.
+ */
+typedef void (^FIRInstallationsIDHandler)(NSString *__nullable identifier,
+                                          NSError *__nullable error)
+    NS_SWIFT_NAME(InstallationsIDHandler);
+
+/**
+ * An authorization token handler block.
+ * @param tokenResult An instance of `InstallationsAuthTokenResult` in case of success or `nil`
+ * otherwise.
+ * @param error The error when `tokenResult == nil` or `nil` otherwise.
+ */
+typedef void (^FIRInstallationsTokenHandler)(
+    FIRInstallationsAuthTokenResult *__nullable tokenResult, NSError *__nullable error)
+    NS_SWIFT_NAME(InstallationsTokenHandler);
+
+/**
+ * The class provides API for Firebase Installations.
+ * Each configured `FirebaseApp` has a corresponding single instance of `Installations`.
+ * An instance of the class provides access to the installation info for the `FirebaseApp` as well
+ * as the ability to delete it. A Firebase Installation is unique by `FirebaseApp.name` and
+ * `FirebaseApp.options.googleAppID` .
+ */
+NS_SWIFT_NAME(Installations)
+@interface FIRInstallations : NSObject
+
+- (instancetype)init NS_UNAVAILABLE;
+
+/**
+ * Returns a default instance of `Installations`.
+ * @returns An instance of `Installations` for `FirebaseApp.defaultApp().
+ * @throw Throws an exception if the default app is not configured yet or required  `FirebaseApp`
+ * options are missing.
+ */
++ (FIRInstallations *)installations NS_SWIFT_NAME(installations());
+
+/**
+ * Returns an instance of `Installations` for an application.
+ * @param application A configured `FirebaseApp` instance.
+ * @returns An instance of `Installations` corresponding to the passed application.
+ * @throw Throws an exception if required `FirebaseApp` options are missing.
+ */
++ (FIRInstallations *)installationsWithApp:(FIRApp *)application
+    NS_SWIFT_NAME(installations(app:));
+
+/**
+ * The method creates or retrieves an installation ID. The installation ID is a stable identifier
+ * that uniquely identifies the app instance. NOTE: If the application already has an existing
+ * FirebaseInstanceID then the InstanceID identifier will be used.
+ * @param completion A completion handler which is invoked when the operation completes. See
+ * `InstallationsIDHandler` for additional details.
+ */
+- (void)installationIDWithCompletion:(FIRInstallationsIDHandler)completion;
+
+/**
+ * Retrieves (locally if it exists or from the server) a valid installation auth token. An existing
+ * token may be invalidated or expired, so it is recommended to fetch the installation auth token
+ * before each server request. The method does the same as `Installations.authTokenForcingRefresh(:,
+ * completion:)` with forcing refresh `NO`.
+ * @param completion A completion handler which is invoked when the operation completes. See
+ * `InstallationsTokenHandler` for additional details.
+ */
+- (void)authTokenWithCompletion:(FIRInstallationsTokenHandler)completion;
+
+/**
+ * Retrieves (locally or from the server depending on `forceRefresh` value) a valid installation
+ * auth token. An existing token may be invalidated or expire, so it is recommended to fetch the
+ * installation auth token before each server request. This method should be used with `forceRefresh
+ * == YES` when e.g. a request with the previously fetched installation auth token failed with "Not
+ * Authorized" error.
+ * @param forceRefresh If `YES` then the locally cached installation auth token will be ignored and
+ * a new one will be requested from the server. If `NO`, then the locally cached installation auth
+ * token will be returned if exists and has not expired yet.
+ * @param completion  A completion handler which is invoked when the operation completes. See
+ * `InstallationsTokenHandler` for additional details.
+ */
+- (void)authTokenForcingRefresh:(BOOL)forceRefresh
+                     completion:(FIRInstallationsTokenHandler)completion;
+
+/**
+ * Deletes all the installation data including the unique identifier, auth tokens and
+ * all related data on the server side. A network connection is required for the method to
+ * succeed. If fails, the existing installation data remains untouched.
+ * @param completion A completion handler which is invoked when the operation completes. `error ==
+ * nil` indicates success.
+ */
+- (void)deleteWithCompletion:(void (^)(NSError *__nullable error))completion;
+
+@end
+
+NS_ASSUME_NONNULL_END