feat(firestore): add support for remaining string expressions (#7978)

Adds support for string expressions `ltrim`, `rtrim`, `stringRepeat`
`stringReplaceOne` `stringReplaceAll`, `stringIndexOf`.

Ported from: googleapis/java-firestore#2326

Author: dlarocque

firebase-firestore/CHANGELOG.md

@@ -13,6 +13,8 @@
   [#7893](https://github.com/firebase/firebase-android-sdk/pull/7893)
 - [feature] Added support for `rand` and `trunc` Pipeline expressions.
   [#7886](https://github.com/firebase/firebase-android-sdk/pull/7886)
+- [feature] Added support for `ltrim`, `rtrim`, `stringIndexOf`, `stringRepeat`, `stringReplaceOne`, and `stringReplaceAll` Pipeline expressions.
+  [#7978](https://github.com/firebase/firebase-android-sdk/pull/7978)
 - [feature] Added support for `mapGet` `mapSet`, `mapEntries`, and `mapKeys` Pipeline expressions.
   [#7987](https://github.com/firebase/firebase-android-sdk/pull/7987)
 

firebase-firestore/api.txt

@@ -1134,6 +1134,15 @@ package com.google.firebase.firestore.pipeline {
     method public final com.google.firebase.firestore.pipeline.Expression logicalMinimum(com.google.firebase.firestore.pipeline.Expression... others);
     method public final com.google.firebase.firestore.pipeline.Expression logicalMinimum(java.lang.Object... others);
     method public static final com.google.firebase.firestore.pipeline.Expression logicalMinimum(String fieldName, java.lang.Object... others);
+    method public final com.google.firebase.firestore.pipeline.Expression ltrim();
+    method public static final com.google.firebase.firestore.pipeline.Expression ltrim(com.google.firebase.firestore.pipeline.Expression stringExpression);
+    method public static final com.google.firebase.firestore.pipeline.Expression ltrim(String fieldName);
+    method public final com.google.firebase.firestore.pipeline.Expression ltrimValue(com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public static final com.google.firebase.firestore.pipeline.Expression ltrimValue(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public static final com.google.firebase.firestore.pipeline.Expression ltrimValue(com.google.firebase.firestore.pipeline.Expression stringExpression, String valuesToTrim);
+    method public final com.google.firebase.firestore.pipeline.Expression ltrimValue(String valuesToTrim);
+    method public static final com.google.firebase.firestore.pipeline.Expression ltrimValue(String fieldName, com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public static final com.google.firebase.firestore.pipeline.Expression ltrimValue(String fieldName, String valuesToTrim);
     method public static final com.google.firebase.firestore.pipeline.Expression map(java.util.Map<java.lang.String,?> elements);
     method public final com.google.firebase.firestore.pipeline.Expression mapEntries();
     method public static final com.google.firebase.firestore.pipeline.Expression mapEntries(com.google.firebase.firestore.pipeline.Expression mapExpr);
@@ -1235,6 +1244,15 @@ package com.google.firebase.firestore.pipeline {
     method public final com.google.firebase.firestore.pipeline.Expression roundToPrecision(int decimalPlace);
     method public static final com.google.firebase.firestore.pipeline.Expression roundToPrecision(String numericField, com.google.firebase.firestore.pipeline.Expression decimalPlace);
     method public static final com.google.firebase.firestore.pipeline.Expression roundToPrecision(String numericField, int decimalPlace);
+    method public final com.google.firebase.firestore.pipeline.Expression rtrim();
+    method public static final com.google.firebase.firestore.pipeline.Expression rtrim(com.google.firebase.firestore.pipeline.Expression stringExpression);
+    method public static final com.google.firebase.firestore.pipeline.Expression rtrim(String fieldName);
+    method public final com.google.firebase.firestore.pipeline.Expression rtrimValue(com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public static final com.google.firebase.firestore.pipeline.Expression rtrimValue(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public static final com.google.firebase.firestore.pipeline.Expression rtrimValue(com.google.firebase.firestore.pipeline.Expression stringExpression, String valuesToTrim);
+    method public final com.google.firebase.firestore.pipeline.Expression rtrimValue(String valuesToTrim);
+    method public static final com.google.firebase.firestore.pipeline.Expression rtrimValue(String fieldName, com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public static final com.google.firebase.firestore.pipeline.Expression rtrimValue(String fieldName, String valuesToTrim);
     method public final com.google.firebase.firestore.pipeline.Expression split(com.google.firebase.firestore.Blob delimiter);
     method public final com.google.firebase.firestore.pipeline.Expression split(com.google.firebase.firestore.pipeline.Expression delimiter);
     method public static final com.google.firebase.firestore.pipeline.Expression split(com.google.firebase.firestore.pipeline.Expression value, com.google.firebase.firestore.Blob delimiter);
@@ -1266,6 +1284,30 @@ package com.google.firebase.firestore.pipeline {
     method public final com.google.firebase.firestore.pipeline.BooleanExpression stringContains(String substring);
     method public static final com.google.firebase.firestore.pipeline.BooleanExpression stringContains(String fieldName, com.google.firebase.firestore.pipeline.Expression substring);
     method public static final com.google.firebase.firestore.pipeline.BooleanExpression stringContains(String fieldName, String substring);
+    method public final com.google.firebase.firestore.pipeline.Expression stringIndexOf(com.google.firebase.firestore.pipeline.Expression substring);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringIndexOf(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression substring);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringIndexOf(com.google.firebase.firestore.pipeline.Expression stringExpression, String substring);
+    method public final com.google.firebase.firestore.pipeline.Expression stringIndexOf(String substring);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringIndexOf(String fieldName, com.google.firebase.firestore.pipeline.Expression substring);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringIndexOf(String fieldName, String substring);
+    method public final com.google.firebase.firestore.pipeline.Expression stringRepeat(com.google.firebase.firestore.pipeline.Expression count);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringRepeat(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression count);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringRepeat(com.google.firebase.firestore.pipeline.Expression stringExpression, int count);
+    method public final com.google.firebase.firestore.pipeline.Expression stringRepeat(int count);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringRepeat(String fieldName, com.google.firebase.firestore.pipeline.Expression count);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringRepeat(String fieldName, int count);
+    method public final com.google.firebase.firestore.pipeline.Expression stringReplaceAll(com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringReplaceAll(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringReplaceAll(com.google.firebase.firestore.pipeline.Expression stringExpression, String oldValue, String newValue);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringReplaceAll(String fieldName, com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public final com.google.firebase.firestore.pipeline.Expression stringReplaceAll(String oldValue, String newValue);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringReplaceAll(String fieldName, String oldValue, String newValue);
+    method public final com.google.firebase.firestore.pipeline.Expression stringReplaceOne(com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringReplaceOne(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringReplaceOne(com.google.firebase.firestore.pipeline.Expression stringExpression, String oldValue, String newValue);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringReplaceOne(String fieldName, com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public final com.google.firebase.firestore.pipeline.Expression stringReplaceOne(String oldValue, String newValue);
+    method public static final com.google.firebase.firestore.pipeline.Expression stringReplaceOne(String fieldName, String oldValue, String newValue);
     method public final com.google.firebase.firestore.pipeline.Expression stringReverse();
     method public static final com.google.firebase.firestore.pipeline.Expression stringReverse(com.google.firebase.firestore.pipeline.Expression str);
     method public static final com.google.firebase.firestore.pipeline.Expression stringReverse(String fieldName);
@@ -1607,6 +1649,12 @@ package com.google.firebase.firestore.pipeline {
     method public com.google.firebase.firestore.pipeline.Expression logicalMaximum(String fieldName, java.lang.Object... others);
     method public com.google.firebase.firestore.pipeline.Expression logicalMinimum(com.google.firebase.firestore.pipeline.Expression expr, java.lang.Object... others);
     method public com.google.firebase.firestore.pipeline.Expression logicalMinimum(String fieldName, java.lang.Object... others);
+    method public com.google.firebase.firestore.pipeline.Expression ltrim(com.google.firebase.firestore.pipeline.Expression stringExpression);
+    method public com.google.firebase.firestore.pipeline.Expression ltrim(String fieldName);
+    method public com.google.firebase.firestore.pipeline.Expression ltrimValue(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public com.google.firebase.firestore.pipeline.Expression ltrimValue(com.google.firebase.firestore.pipeline.Expression stringExpression, String valuesToTrim);
+    method public com.google.firebase.firestore.pipeline.Expression ltrimValue(String fieldName, com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public com.google.firebase.firestore.pipeline.Expression ltrimValue(String fieldName, String valuesToTrim);
     method public com.google.firebase.firestore.pipeline.Expression map(java.util.Map<java.lang.String,?> elements);
     method public com.google.firebase.firestore.pipeline.Expression mapEntries(com.google.firebase.firestore.pipeline.Expression mapExpr);
     method public com.google.firebase.firestore.pipeline.Expression mapEntries(String mapField);
@@ -1678,6 +1726,12 @@ package com.google.firebase.firestore.pipeline {
     method public com.google.firebase.firestore.pipeline.Expression roundToPrecision(com.google.firebase.firestore.pipeline.Expression numericExpr, int decimalPlace);
     method public com.google.firebase.firestore.pipeline.Expression roundToPrecision(String numericField, com.google.firebase.firestore.pipeline.Expression decimalPlace);
     method public com.google.firebase.firestore.pipeline.Expression roundToPrecision(String numericField, int decimalPlace);
+    method public com.google.firebase.firestore.pipeline.Expression rtrim(com.google.firebase.firestore.pipeline.Expression stringExpression);
+    method public com.google.firebase.firestore.pipeline.Expression rtrim(String fieldName);
+    method public com.google.firebase.firestore.pipeline.Expression rtrimValue(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public com.google.firebase.firestore.pipeline.Expression rtrimValue(com.google.firebase.firestore.pipeline.Expression stringExpression, String valuesToTrim);
+    method public com.google.firebase.firestore.pipeline.Expression rtrimValue(String fieldName, com.google.firebase.firestore.pipeline.Expression valuesToTrim);
+    method public com.google.firebase.firestore.pipeline.Expression rtrimValue(String fieldName, String valuesToTrim);
     method public com.google.firebase.firestore.pipeline.Expression split(com.google.firebase.firestore.pipeline.Expression value, com.google.firebase.firestore.Blob delimiter);
     method public com.google.firebase.firestore.pipeline.Expression split(com.google.firebase.firestore.pipeline.Expression value, com.google.firebase.firestore.pipeline.Expression delimiter);
     method public com.google.firebase.firestore.pipeline.Expression split(com.google.firebase.firestore.pipeline.Expression value, String delimiter);
@@ -1698,6 +1752,22 @@ package com.google.firebase.firestore.pipeline {
     method public com.google.firebase.firestore.pipeline.BooleanExpression stringContains(com.google.firebase.firestore.pipeline.Expression stringExpression, String substring);
     method public com.google.firebase.firestore.pipeline.BooleanExpression stringContains(String fieldName, com.google.firebase.firestore.pipeline.Expression substring);
     method public com.google.firebase.firestore.pipeline.BooleanExpression stringContains(String fieldName, String substring);
+    method public com.google.firebase.firestore.pipeline.Expression stringIndexOf(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression substring);
+    method public com.google.firebase.firestore.pipeline.Expression stringIndexOf(com.google.firebase.firestore.pipeline.Expression stringExpression, String substring);
+    method public com.google.firebase.firestore.pipeline.Expression stringIndexOf(String fieldName, com.google.firebase.firestore.pipeline.Expression substring);
+    method public com.google.firebase.firestore.pipeline.Expression stringIndexOf(String fieldName, String substring);
+    method public com.google.firebase.firestore.pipeline.Expression stringRepeat(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression count);
+    method public com.google.firebase.firestore.pipeline.Expression stringRepeat(com.google.firebase.firestore.pipeline.Expression stringExpression, int count);
+    method public com.google.firebase.firestore.pipeline.Expression stringRepeat(String fieldName, com.google.firebase.firestore.pipeline.Expression count);
+    method public com.google.firebase.firestore.pipeline.Expression stringRepeat(String fieldName, int count);
+    method public com.google.firebase.firestore.pipeline.Expression stringReplaceAll(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public com.google.firebase.firestore.pipeline.Expression stringReplaceAll(com.google.firebase.firestore.pipeline.Expression stringExpression, String oldValue, String newValue);
+    method public com.google.firebase.firestore.pipeline.Expression stringReplaceAll(String fieldName, com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public com.google.firebase.firestore.pipeline.Expression stringReplaceAll(String fieldName, String oldValue, String newValue);
+    method public com.google.firebase.firestore.pipeline.Expression stringReplaceOne(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public com.google.firebase.firestore.pipeline.Expression stringReplaceOne(com.google.firebase.firestore.pipeline.Expression stringExpression, String oldValue, String newValue);
+    method public com.google.firebase.firestore.pipeline.Expression stringReplaceOne(String fieldName, com.google.firebase.firestore.pipeline.Expression oldValue, com.google.firebase.firestore.pipeline.Expression newValue);
+    method public com.google.firebase.firestore.pipeline.Expression stringReplaceOne(String fieldName, String oldValue, String newValue);
     method public com.google.firebase.firestore.pipeline.Expression stringReverse(com.google.firebase.firestore.pipeline.Expression str);
     method public com.google.firebase.firestore.pipeline.Expression stringReverse(String fieldName);
     method public com.google.firebase.firestore.pipeline.Expression substring(com.google.firebase.firestore.pipeline.Expression stringExpression, com.google.firebase.firestore.pipeline.Expression index, com.google.firebase.firestore.pipeline.Expression length);