CRUD operations are more stable and allow virtually any Collection or Document name.

Removed use of documents.createDocument API Endpoint, keys with # or ? characters cannot be created.

Author: LaughDonor

Query.js

@@ -2,11 +2,10 @@
 /* eslint quote-props: ["error", "always"] */
 
 /**
- * An object that acts as a Query to be a structured query.
+ * An internal object that acts as a Structured Query to be prepared before execution.
  * Chain methods to update query. Must call .execute to send request.
  *
  * @constructor
- * @private
  * @see {@link https://firebase.google.com/docs/firestore/reference/rest/v1/StructuredQuery Firestore Structured Query}
  * @param {string} from the base collection to query
  * @param {queryCallback} callback the function that is executed with the internally compiled query

Read.js

@@ -20,8 +20,8 @@ function get_ (path, request) {
  *
  * @private
  * @param {string} path the path to the document or collection to get
- * @param {string} request the Firestore Request object to manipulate
  * @param {string} pageToken if defined, is utilized for retrieving subsequent pages
+ * @param {string} request the Firestore Request object to manipulate
  * @return {object} the JSON response from the GET request
  */
 function getPage_ (path, pageToken, request) {
@@ -115,9 +115,10 @@ function getDocuments_ (path, request, ids) {
  */
 function query_ (path, request) {
   const grouped = getCollectionFromPath_(path)
+  request.route('runQuery')
   const callback = function (query) {
     // Send request to innermost document with given query
-    const responseObj = request.post(grouped[0] + ':runQuery', {
+    const responseObj = request.post(grouped[0], {
       'structuredQuery': query
     })
 

Request.js

@@ -43,15 +43,15 @@ var FirestoreRequest_ = function (url, authToken, options) {
    */
   const method = function (type, path) {
     options.method = type
-    return fetchObject_(url + (path || '') + queryString, options)
+    return fetchObject_(url + cleanPath_(path || '') + queryString, options)
   }
 
   /**
    * Adds a parameter to the URL query string.
    *  Can be repeated for additional key-value mappings
    *
-   * @param key the key to add
-   * @param value the value to set
+   * @param {string} key the key to add
+   * @param {string} value the value to set
    * @returns {FirestoreRequest_} this request to be chained
    */
   this.addParam = function (key, value) {
@@ -60,10 +60,22 @@ var FirestoreRequest_ = function (url, authToken, options) {
     queryString += (queryString.indexOf('?') === -1 ? '?' : '&') + key + '=' + value
     return this_
   }
+
+  /**
+   * Alters the route by prepending the query string.
+   *
+   * @param {string} route to set
+   * @returns {FirestoreRequest_} this request to be chained
+   */
+  this.route = function (route) {
+    queryString = ':' + route + queryString
+    return this_
+  }
+
   /**
    * Set request as a GET method
    *
-   * @param path the path to send the request to
+   * @param {string} path the path to send the request to
    * @returns {FirestoreRequest_} this request to be chained
    */
   this.get = function (path) {

Util.js

@@ -122,10 +122,41 @@ function getColDocFromPath_ (path, isDocument) {
   })
   const len = splitPath.length
 
+  cleanParts_(splitPath)
+
   // Set item path to document if isDocument, otherwise set to collection if exists.
   // This works because path is always in the format of "collection/document/collection/document/etc.."
   const item = len && len & 1 ^ isDocument ? splitPath.splice(len - 1, 1)[0] : ''
 
   // Remainder of path is in splitPath. Put back together and return.
   return [splitPath.join('/'), item]
 }
+
+/**
+ * Validates Collection and Document names
+ *
+ * @private
+ * @see {@link https://firebase.google.com/docs/firestore/quotas#collections_documents_and_fields Firestore Limits}
+ * @param {array} parts Array of strings representing document path
+ * @returns {array} of URI Encoded path names
+ * @throws {Error} Validation errors if it doesn't meet API guidelines
+ */
+function cleanParts_ (parts) {
+  return parts.map(function (part, i) {
+    var type = i & 1 ? 'Collection' : 'Document'
+    if (part === '.' || part === '..') { throw new TypeError(type + ' name cannot solely consist of a single period (.) or double periods (..)') }
+    if (part.indexOf('__') === 0 && part.endsWith('__')) { throw new TypeError(type + ' name cannot be a dunder name (begin and end with double underscores)') }
+    return encodeURIComponent(part)
+  })
+}
+
+/**
+ * Splits up path to be cleaned
+ *
+ * @private
+ * @param {string} path to be cleaned
+ * @returns {string} path that is URL-safe
+ */
+function cleanPath_ (path) {
+  return cleanParts_(path.split('/')).join('/')
+}

Write.js

@@ -5,22 +5,13 @@
  *
  * @private
  * @param {string} path the path where the document will be written
- * @param {string} documentId the document's ID in Firestore
  * @param {object} fields the document's fields
  * @param {string} request the Firestore Request object to manipulate
  * @return {object} the Document object written to Firestore
  */
 function createDocument_ (path, fields, request) {
-  const pathDoc = getDocumentFromPath_(path)
-  const firestoreObject = createFirestoreDocument_(fields)
-  const documentId = pathDoc[1]
-
-  if (documentId) {
-    request.addParam('documentId', documentId)
-  }
-
-  const newDoc = request.post(pathDoc[0], firestoreObject)
-  return unwrapDocumentFields_(newDoc)
+  request.addParam('currentDocument.exists', false)
+  return updateDocument_(path, fields, request)
 }
 
 /**
@@ -30,7 +21,7 @@ function createDocument_ (path, fields, request) {
  * @param {string} path the path of the document to update
  * @param {object} fields the document's new fields
  * @param {string} request the Firestore Request object to manipulate
- * @param {boolean} if true, the update will use a mask. i.e. true: updates only specific fields, false: overwrites document with specified fields
+ * @param {boolean} mask if true, the update will use a mask. i.e. true: updates only specific fields, false: overwrites document with specified fields
  * @return {object} the Document object written to Firestore
  */
 function updateDocument_ (path, fields, request, mask) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "firestore_google-apps-script",
-  "version": "24",
+  "version": "25",
   "description": "A Google Apps Script library for accessing Google Cloud Firestore",
   "homepage": "https://github.com/grahamearley/FirestoreGoogleAppsScript",
   "bugs": "https://github.com/grahamearley/FirestoreGoogleAppsScript/issues",
@@ -12,6 +12,7 @@
       "UrlFetchApp",
       "Utilities",
       "base64EncodeSafe_",
+      "cleanPath_",
       "createDocument_",
       "createFirestoreDocument_",
       "deleteDocument_",