Update Firestore protos (#713)

Author: mikelehen

packages/firestore/src/protos/firestore_proto_api.d.ts

@@ -33,14 +33,16 @@ export declare type FieldFilterOp =
   | 'LESS_THAN_OR_EQUAL'
   | 'GREATER_THAN'
   | 'GREATER_THAN_OR_EQUAL'
-  | 'EQUAL';
+  | 'EQUAL'
+  | 'ARRAY_CONTAINS';
 export interface IFieldFilterOpEnum {
   OPERATOR_UNSPECIFIED: FieldFilterOp;
   LESS_THAN: FieldFilterOp;
   LESS_THAN_OR_EQUAL: FieldFilterOp;
   GREATER_THAN: FieldFilterOp;
   GREATER_THAN_OR_EQUAL: FieldFilterOp;
   EQUAL: FieldFilterOp;
+  ARRAY_CONTAINS: FieldFilterOp;
   values(): Array<FieldFilterOp>;
 }
 export declare const FieldFilterOpEnum: IFieldFilterOpEnum;
@@ -64,15 +66,6 @@ export interface IIndexFieldModeEnum {
   values(): Array<IndexFieldMode>;
 }
 export declare const IndexFieldModeEnum: IIndexFieldModeEnum;
-export declare type IndexOperationMetadataOperationType =
-  | 'OPERATION_TYPE_UNSPECIFIED'
-  | 'CREATING_INDEX';
-export interface IIndexOperationMetadataOperationTypeEnum {
-  OPERATION_TYPE_UNSPECIFIED: IndexOperationMetadataOperationType;
-  CREATING_INDEX: IndexOperationMetadataOperationType;
-  values(): Array<IndexOperationMetadataOperationType>;
-}
-export declare const IndexOperationMetadataOperationTypeEnum: IIndexOperationMetadataOperationTypeEnum;
 export declare type IndexState =
   | 'STATE_UNSPECIFIED'
   | 'CREATING'
@@ -219,6 +212,8 @@ export declare namespace firestoreV1beta1ApiClientInterfaces {
   interface FieldTransform {
     fieldPath?: string;
     setToServerValue?: FieldTransformSetToServerValue;
+    appendMissingElements?: ArrayValue;
+    removeAllFromArray?: ArrayValue;
   }
   interface Filter {
     compositeFilter?: CompositeFilter;
@@ -235,14 +230,6 @@ export declare namespace firestoreV1beta1ApiClientInterfaces {
     fieldPath?: string;
     mode?: IndexFieldMode;
   }
-  interface IndexOperationMetadata {
-    startTime?: string;
-    endTime?: string;
-    index?: string;
-    operationType?: IndexOperationMetadataOperationType;
-    cancelled?: boolean;
-    documentProgress?: Progress;
-  }
   interface LatLng {
     latitude?: number;
     longitude?: number;
@@ -293,10 +280,6 @@ export declare namespace firestoreV1beta1ApiClientInterfaces {
     exists?: boolean;
     updateTime?: string;
   }
-  interface Progress {
-    workCompleted?: string;
-    workEstimated?: string;
-  }
   interface Projection {
     fields?: Array<FieldReference>;
   }
@@ -425,7 +408,6 @@ export declare type FieldTransform = firestoreV1beta1ApiClientInterfaces.FieldTr
 export declare type Filter = firestoreV1beta1ApiClientInterfaces.Filter;
 export declare type Index = firestoreV1beta1ApiClientInterfaces.Index;
 export declare type IndexField = firestoreV1beta1ApiClientInterfaces.IndexField;
-export declare type IndexOperationMetadata = firestoreV1beta1ApiClientInterfaces.IndexOperationMetadata;
 export declare type LatLng = firestoreV1beta1ApiClientInterfaces.LatLng;
 export declare type ListCollectionIdsRequest = firestoreV1beta1ApiClientInterfaces.ListCollectionIdsRequest;
 export declare type ListCollectionIdsResponse = firestoreV1beta1ApiClientInterfaces.ListCollectionIdsResponse;
@@ -437,7 +419,6 @@ export declare type MapValue = firestoreV1beta1ApiClientInterfaces.MapValue;
 export declare type Operation = firestoreV1beta1ApiClientInterfaces.Operation;
 export declare type Order = firestoreV1beta1ApiClientInterfaces.Order;
 export declare type Precondition = firestoreV1beta1ApiClientInterfaces.Precondition;
-export declare type Progress = firestoreV1beta1ApiClientInterfaces.Progress;
 export declare type Projection = firestoreV1beta1ApiClientInterfaces.Projection;
 export declare type QueryTarget = firestoreV1beta1ApiClientInterfaces.QueryTarget;
 export declare type ReadOnly = firestoreV1beta1ApiClientInterfaces.ReadOnly;

packages/firestore/src/protos/google/api/http.proto

@@ -1,4 +1,4 @@
-// Copyright 2016 Google Inc.
+// Copyright 2018 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -24,22 +24,30 @@ option java_package = "com.google.api";
 option objc_class_prefix = "GAPI";
 
 
-// Defines the HTTP configuration for a service. It contains a list of
+// Defines the HTTP configuration for an API service. It contains a list of
 // [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
 // to one or more HTTP REST API methods.
 message Http {
   // A list of HTTP configuration rules that apply to individual API methods.
   //
   // **NOTE:** All service configuration rules follow "last one wins" order.
   repeated HttpRule rules = 1;
+
+  // When set to true, URL path parmeters will be fully URI-decoded except in
+  // cases of single segment matches in reserved expansion, where "%2F" will be
+  // left encoded.
+  //
+  // The default behavior is to not decode RFC 6570 reserved characters in multi
+  // segment matches.
+  bool fully_decode_reserved_expansion = 2;
 }
 
 // `HttpRule` defines the mapping of an RPC method to one or more HTTP
-// REST APIs.  The mapping determines what portions of the request
-// message are populated from the path, query parameters, or body of
-// the HTTP request.  The mapping is typically specified as an
-// `google.api.http` annotation, see "google/api/annotations.proto"
-// for details.
+// REST API methods. The mapping specifies how different portions of the RPC
+// request message are mapped to URL path, URL query parameters, and
+// HTTP request body. The mapping is typically specified as an
+// `google.api.http` annotation on the RPC method,
+// see "google/api/annotations.proto" for details.
 //
 // The mapping consists of a field specifying the path template and
 // method kind.  The path template can refer to fields in the request
@@ -87,6 +95,11 @@ message Http {
 // parameters. Assume the following definition of the request message:
 //
 //
+//     service Messaging {
+//       rpc GetMessage(GetMessageRequest) returns (Message) {
+//         option (google.api.http).get = "/v1/messages/{message_id}";
+//       }
+//     }
 //     message GetMessageRequest {
 //       message SubMessage {
 //         string subfield = 1;
@@ -199,7 +212,7 @@ message Http {
 // to the request message are as follows:
 //
 // 1. The `body` field specifies either `*` or a field path, or is
-//    omitted. If omitted, it assumes there is no HTTP body.
+//    omitted. If omitted, it indicates there is no HTTP request body.
 // 2. Leaf fields (recursive expansion of nested messages in the
 //    request) can be classified into three types:
 //     (a) Matched in the URL template.
@@ -218,28 +231,34 @@ message Http {
 //     FieldPath = IDENT { "." IDENT } ;
 //     Verb     = ":" LITERAL ;
 //
-// The syntax `*` matches a single path segment. It follows the semantics of
-// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
-// Expansion.
+// The syntax `*` matches a single path segment. The syntax `**` matches zero
+// or more path segments, which must be the last part of the path except the
+// `Verb`. The syntax `LITERAL` matches literal text in the path.
 //
-// The syntax `**` matches zero or more path segments. It follows the semantics
-// of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved
-// Expansion. NOTE: it must be the last segment in the path except the Verb.
-//
-// The syntax `LITERAL` matches literal text in the URL path.
-//
-// The syntax `Variable` matches the entire path as specified by its template;
-// this nested template must not contain further variables. If a variable
+// The syntax `Variable` matches part of the URL path as specified by its
+// template. A variable template must not contain other variables. If a variable
 // matches a single path segment, its template may be omitted, e.g. `{var}`
 // is equivalent to `{var=*}`.
 //
+// If a variable contains exactly one path segment, such as `"{var}"` or
+// `"{var=*}"`, when such a variable is expanded into a URL path, all characters
+// except `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the
+// Discovery Document as `{var}`.
+//
+// If a variable contains one or more path segments, such as `"{var=foo/*}"`
+// or `"{var=**}"`, when such a variable is expanded into a URL path, all
+// characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables
+// show up in the Discovery Document as `{+var}`.
+//
+// NOTE: While the single segment variable matches the semantics of
+// [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2
+// Simple String Expansion, the multi segment variable **does not** match
+// RFC 6570 Reserved Expansion. The reason is that the Reserved Expansion
+// does not expand special characters like `?` and `#`, which would lead
+// to invalid URLs.
+//
 // NOTE: the field paths in variables and in the `body` must not refer to
 // repeated fields or map fields.
-//
-// Use CustomHttpPattern to specify any HTTP method that is not included in the
-// `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for
-// a given URL path rule. The wild-card rule is useful for services that provide
-// content to Web (HTML) clients.
 message HttpRule {
   // Selects methods to which this rule applies.
   //
@@ -265,7 +284,10 @@ message HttpRule {
     // Used for updating a resource.
     string patch = 6;
 
-    // Custom pattern is used for defining custom verbs.
+    // The custom pattern is used for specifying an HTTP method that is not
+    // included in the `pattern` field, such as HEAD, or "*" to leave the
+    // HTTP method unspecified for this rule. The wild-card rule is useful
+    // for services that provide content to Web (HTML) clients.
     CustomHttpPattern custom = 8;
   }
 

packages/firestore/src/protos/google/firestore/v1beta1/common.proto

@@ -1,4 +1,4 @@
-// Copyright 2017 Google Inc.
+// Copyright 2018 Google Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@ option java_multiple_files = true;
 option java_outer_classname = "CommonProto";
 option java_package = "com.google.firestore.v1beta1";
 option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\V1beta1";
 
 
 // A set of field paths on a document.

packages/firestore/src/protos/google/firestore/v1beta1/document.proto

@@ -1,4 +1,4 @@
-// Copyright 2017 Google Inc.
+// Copyright 2018 Google Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -27,6 +27,7 @@ option java_multiple_files = true;
 option java_outer_classname = "DocumentProto";
 option java_package = "com.google.firestore.v1beta1";
 option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\V1beta1";
 
 
 // A Firestore document.
@@ -42,7 +43,7 @@ message Document {
   // The map keys represent field names.
   //
   // A simple field name contains only characters `a` to `z`, `A` to `Z`,
-  // `0` to `9`, or `_`, and must not start with `0` to `9` or `_`. For example,
+  // `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
   // `foo_bar_17`.
   //
   // Field names matching the regular expression `__.*__` are reserved. Reserved
@@ -72,7 +73,7 @@ message Document {
 
   // Output only. The time at which the document was last changed.
   //
-  // This value is initally set to the `create_time` then increases
+  // This value is initially set to the `create_time` then increases
   // monotonically with each change to the document. It can also be
   // compared to values from other documents and the `read_time` of a query.
   google.protobuf.Timestamp update_time = 4;

packages/firestore/src/protos/google/firestore/v1beta1/firestore.proto

@@ -1,4 +1,4 @@
-// Copyright 2017 Google Inc.
+// Copyright 2018 Google Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -31,6 +31,7 @@ option java_multiple_files = true;
 option java_outer_classname = "FirestoreProto";
 option java_package = "com.google.firestore.v1beta1";
 option objc_class_prefix = "GCFS";
+option php_namespace = "Google\\Cloud\\Firestore\\V1beta1";
 
 // Specification of the Firestore API.
 
@@ -55,70 +56,114 @@ option objc_class_prefix = "GCFS";
 service Firestore {
   // Gets a single document.
   rpc GetDocument(GetDocumentRequest) returns (Document) {
-    option (google.api.http) = { get: "/v1beta1/{name=projects/*/databases/*/documents/*/**}" };
+    option (google.api.http) = {
+      get: "/v1beta1/{name=projects/*/databases/*/documents/*/**}"
+    };
   }
 
   // Lists documents.
   rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse) {
-    option (google.api.http) = { get: "/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collection_id}" };
+    option (google.api.http) = {
+      get: "/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collection_id}"
+    };
   }
 
   // Creates a new document.
   rpc CreateDocument(CreateDocumentRequest) returns (Document) {
-    option (google.api.http) = { post: "/v1beta1/{parent=projects/*/databases/*/documents/**}/{collection_id}" body: "document" };
+    option (google.api.http) = {
+      post: "/v1beta1/{parent=projects/*/databases/*/documents/**}/{collection_id}"
+      body: "document"
+    };
   }
 
   // Updates or inserts a document.
   rpc UpdateDocument(UpdateDocumentRequest) returns (Document) {
-    option (google.api.http) = { patch: "/v1beta1/{document.name=projects/*/databases/*/documents/*/**}" body: "document" };
+    option (google.api.http) = {
+      patch: "/v1beta1/{document.name=projects/*/databases/*/documents/*/**}"
+      body: "document"
+    };
   }
 
   // Deletes a document.
   rpc DeleteDocument(DeleteDocumentRequest) returns (google.protobuf.Empty) {
-    option (google.api.http) = { delete: "/v1beta1/{name=projects/*/databases/*/documents/*/**}" };
+    option (google.api.http) = {
+      delete: "/v1beta1/{name=projects/*/databases/*/documents/*/**}"
+    };
   }
 
   // Gets multiple documents.
   //
   // Documents returned by this method are not guaranteed to be returned in the
   // same order that they were requested.
   rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (stream BatchGetDocumentsResponse) {
-    option (google.api.http) = { post: "/v1beta1/{database=projects/*/databases/*}/documents:batchGet" body: "*" };
+    option (google.api.http) = {
+      post: "/v1beta1/{database=projects/*/databases/*}/documents:batchGet"
+      body: "*"
+    };
   }
 
   // Starts a new transaction.
   rpc BeginTransaction(BeginTransactionRequest) returns (BeginTransactionResponse) {
-    option (google.api.http) = { post: "/v1beta1/{database=projects/*/databases/*}/documents:beginTransaction" body: "*" };
+    option (google.api.http) = {
+      post: "/v1beta1/{database=projects/*/databases/*}/documents:beginTransaction"
+      body: "*"
+    };
   }
 
   // Commits a transaction, while optionally updating documents.
   rpc Commit(CommitRequest) returns (CommitResponse) {
-    option (google.api.http) = { post: "/v1beta1/{database=projects/*/databases/*}/documents:commit" body: "*" };
+    option (google.api.http) = {
+      post: "/v1beta1/{database=projects/*/databases/*}/documents:commit"
+      body: "*"
+    };
   }
 
   // Rolls back a transaction.
   rpc Rollback(RollbackRequest) returns (google.protobuf.Empty) {
-    option (google.api.http) = { post: "/v1beta1/{database=projects/*/databases/*}/documents:rollback" body: "*" };
+    option (google.api.http) = {
+      post: "/v1beta1/{database=projects/*/databases/*}/documents:rollback"
+      body: "*"
+    };
   }
 
   // Runs a query.
   rpc RunQuery(RunQueryRequest) returns (stream RunQueryResponse) {
-    option (google.api.http) = { post: "/v1beta1/{parent=projects/*/databases/*/documents}:runQuery" body: "*" };
+    option (google.api.http) = {
+      post: "/v1beta1/{parent=projects/*/databases/*/documents}:runQuery"
+      body: "*"
+      additional_bindings {
+        post: "/v1beta1/{parent=projects/*/databases/*/documents/*/**}:runQuery"
+        body: "*"
+      }
+    };
   }
 
   // Streams batches of document updates and deletes, in order.
   rpc Write(stream WriteRequest) returns (stream WriteResponse) {
-    option (google.api.http) = { post: "/v1beta1/{database=projects/*/databases/*}/documents:write" body: "*" };
+    option (google.api.http) = {
+      post: "/v1beta1/{database=projects/*/databases/*}/documents:write"
+      body: "*"
+    };
   }
 
   // Listens to changes.
   rpc Listen(stream ListenRequest) returns (stream ListenResponse) {
-    option (google.api.http) = { post: "/v1beta1/{database=projects/*/databases/*}/documents:listen" body: "*" };
+    option (google.api.http) = {
+      post: "/v1beta1/{database=projects/*/databases/*}/documents:listen"
+      body: "*"
+    };
   }
 
   // Lists all the collection IDs underneath a document.
   rpc ListCollectionIds(ListCollectionIdsRequest) returns (ListCollectionIdsResponse) {
-    option (google.api.http) = { post: "/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds" body: "*" };
+    option (google.api.http) = {
+      post: "/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds"
+      body: "*"
+      additional_bindings {
+        post: "/v1beta1/{parent=projects/*/databases/*/documents/*/**}:listCollectionIds"
+        body: "*"
+      }
+    };
   }
 }