1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*
* Copyright 2017 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 FIRSetOptions;
@class FSTDatabaseID;
@class FSTDocumentKey;
@class FSTObjectValue;
@class FSTFieldMask;
@class FSTFieldValue;
@class FSTFieldTransform;
@class FSTMutation;
@class FSTPrecondition;
@class FSTSnapshotVersion;
NS_ASSUME_NONNULL_BEGIN
/** The result of parsing document data (e.g. for a setData call). */
@interface FSTParsedSetData : NSObject
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithData:(FSTObjectValue *)data
fieldMask:(nullable FSTFieldMask *)fieldMask
fieldTransforms:(NSArray<FSTFieldTransform *> *)fieldTransforms
NS_DESIGNATED_INITIALIZER;
@property(nonatomic, strong, readonly) FSTObjectValue *data;
@property(nonatomic, strong, readonly, nullable) FSTFieldMask *fieldMask;
@property(nonatomic, strong, readonly) NSArray<FSTFieldTransform *> *fieldTransforms;
/**
* Converts the parsed document data into 1 or 2 mutations (depending on whether there are any
* field transforms) using the specified document key and precondition.
*/
- (NSArray<FSTMutation *> *)mutationsWithKey:(FSTDocumentKey *)key
precondition:(FSTPrecondition *)precondition;
@end
/** The result of parsing "update" data (i.e. for an updateData call). */
@interface FSTParsedUpdateData : NSObject
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithData:(FSTObjectValue *)data
fieldMask:(FSTFieldMask *)fieldMask
fieldTransforms:(NSArray<FSTFieldTransform *> *)fieldTransforms
NS_DESIGNATED_INITIALIZER;
@property(nonatomic, strong, readonly) FSTObjectValue *data;
@property(nonatomic, strong, readonly) FSTFieldMask *fieldMask;
@property(nonatomic, strong, readonly) NSArray<FSTFieldTransform *> *fieldTransforms;
/**
* Converts the parsed update data into 1 or 2 mutations (depending on whether there are any
* field transforms) using the specified document key and precondition.
*/
- (NSArray<FSTMutation *> *)mutationsWithKey:(FSTDocumentKey *)key
precondition:(FSTPrecondition *)precondition;
@end
/**
* An internal representation of FIRDocumentReference, representing a key in a specific database.
* This is necessary because keys assume a database from context (usually the current one).
* FSTDocumentKeyReference binds a key to a specific databaseID.
*
* TODO(b/64160088): Make FSTDocumentKey aware of the specific databaseID it is tied to.
*/
@interface FSTDocumentKeyReference : NSObject
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithKey:(FSTDocumentKey *)key
databaseID:(FSTDatabaseID *)databaseID NS_DESIGNATED_INITIALIZER;
@property(nonatomic, strong, readonly) FSTDocumentKey *key;
@property(nonatomic, strong, readonly) FSTDatabaseID *databaseID;
@end
/**
* An interface that allows arbitrary pre-converting of user data.
*
* Returns the converted value (can return back the input to act as a no-op).
*/
typedef id _Nullable (^FSTPreConverterBlock)(id _Nullable);
/**
* Helper for parsing raw user input (provided via the API) into internal model classes.
*/
@interface FSTUserDataConverter : NSObject
- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithDatabaseID:(FSTDatabaseID *)databaseID
preConverter:(FSTPreConverterBlock)preConverter NS_DESIGNATED_INITIALIZER;
/** Parse document data (e.g. from a setData call). */
- (FSTParsedSetData *)parsedSetData:(id)input options:(FIRSetOptions *)options;
/** Parse "update" data (i.e. from an updateData call). */
- (FSTParsedUpdateData *)parsedUpdateData:(id)input;
/** Parse a "query value" (e.g. value in a where filter or a value in a cursor bound). */
- (FSTFieldValue *)parsedQueryValue:(id)input;
@end
NS_ASSUME_NONNULL_END
|
