firestore-meilisearch 0.1.11 → 0.3.0

package/.eslintrc.js

@@ -51,4 +51,15 @@ module.exports = {
       },
     ],
   },
+  settings: {
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
+    },
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
+        project: './tsconfig.json',
+      },
+    },
+  },
 }

package/README.md

@@ -8,8 +8,9 @@
 
 <h4 align="center">
   <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
+  <a href="https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=firestore-meilisearch">Meilisearch Cloud</a> |
   <a href="https://docs.meilisearch.com">Documentation</a> |
-  <a href="https://slack.meilisearch.com">Slack</a> |
+  <a href="https://discord.meilisearch.com">Discord</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
   <a href="https://www.meilisearch.com">Website</a> |
   <a href="https://docs.meilisearch.com/faq">FAQ</a>
@@ -35,6 +36,10 @@ This extension listens to each creation, update, or deletion of your documents t
 
 Note that this extension only listens for changes to _documents_ in a specific collection, but not changes in any _subcollection_. However, you can install additional instances of this extension to listen to other collections in your Firestore database.
 
+## ⚡ Supercharge your Meilisearch experience
+
+Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=firestore-meilisearch). Get started with a 14-day free trial! No credit card required.
+
 #### Additional setup
 
 Before installing this extension, you'll need to:
@@ -118,7 +123,7 @@ firebase ext:install meilisearch/firestore-meilisearch --project=[your-project-i
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.30.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.30.0).
+This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/firestore-meilisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
 
 ## ⚙️ Development Workflow and Contributing
 

package/__tests__/__snapshots__/config.test.ts.snap

@@ -0,0 +1,27 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`extensions config Test MeilisearchIndex parameters param exists 1`] = `
+{
+  "description": "What Meilisearch index do you want to index your data in?",
+  "example": "example: my_index",
+  "label": "Meilisearch Index Name",
+  "param": "MEILISEARCH_INDEX_NAME",
+  "required": true,
+  "type": "string",
+  "validationErrorMessage": "Must be a valid Index format. Index uid can be of type integer or string only composed of alphanumeric characters, hyphens (-) and underscores (_). Check out our guide on [index creation](https://docs.meilisearch.com/learn/core_concepts/indexes.html#index-creation).",
+  "validationRegex": "^[0-9A-Za-z_-]+$",
+}
+`;
+
+exports[`extensions config Test fieldsToIndex parameter param exists 1`] = `
+{
+  "default": "",
+  "description": "What fields do you want to index in Meilisearch? Create a comma-separated list of the field names, or leave it blank to include all fields. The id field is always indexed even when omitted from the list.",
+  "example": "example: name,description,...",
+  "label": "Fields to index in Meilisearch",
+  "param": "MEILISEARCH_FIELDS_TO_INDEX",
+  "required": false,
+  "validationErrorMessage": "Fields must be given through a comma-separated list.",
+  "validationRegex": "^[^,]?[a-zA-Z-_0-9,]*[^,]$",
+}
+`;

package/__tests__/__snapshots__/util.test.ts.snap

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getFieldsToIndex configuration detected from environment variables 1`] = `undefined`;

package/__tests__/adapter.test.ts

@@ -1,7 +1,10 @@
 import * as firebaseFunctionsTestInit from 'firebase-functions-test'
 import { mockConsoleInfo } from './__mocks__/console'
-import { firestore } from 'firebase-admin/lib/firestore'
-import { adaptDocument, adaptValues } from '../src/adapter'
+import * as firestore from 'firebase-admin/firestore'
+import {
+  adaptDocumentForMeilisearch,
+  adaptFieldsForMeilisearch,
+} from '../src/meilisearch-adapter'
 import defaultDocument from './data/document'
 
 // Mocking of Firebase functions
@@ -15,7 +18,9 @@ describe('extensions process', () => {
         `docs/${defaultDocument.id}`
       )
 
-      expect(adaptDocument(defaultDocument.id, snapshot, '')).toStrictEqual({
+      expect(
+        adaptDocumentForMeilisearch(defaultDocument.id, snapshot, '')
+      ).toStrictEqual({
         _firestore_id: defaultDocument.id,
         ...defaultDocument.document,
       })
@@ -27,7 +32,9 @@ describe('extensions process', () => {
         `docs/${defaultDocument.id}`
       )
 
-      expect(adaptDocument(defaultDocument.id, snapshot, '')).toStrictEqual({
+      expect(
+        adaptDocumentForMeilisearch(defaultDocument.id, snapshot, '')
+      ).toStrictEqual({
         _firestore_id: defaultDocument.id,
         id: '12345',
         ...defaultDocument.document,
@@ -41,7 +48,7 @@ describe('extensions process', () => {
       )
 
       expect(
-        adaptDocument(
+        adaptDocumentForMeilisearch(
           defaultDocument.id,
           snapshot,
           'title,overview,release_date'
@@ -57,21 +64,27 @@ describe('extensions process', () => {
 
   describe('adaptValues', () => {
     test('adaptValues an id value', () => {
-      expect(adaptValues('id', defaultDocument.id as any)).toStrictEqual([
-        'id',
-        defaultDocument.id,
-      ])
+      expect(
+        adaptFieldsForMeilisearch(
+          { id: defaultDocument.id } as firestore.DocumentData,
+          'id'
+        )
+      ).toStrictEqual({ id: defaultDocument.id })
     })
     test('adaptValues a geo point value', () => {
       const geoPoint = new firestore.GeoPoint(48.866667, 2.333333)
 
-      expect(adaptValues('_geo', geoPoint)).toStrictEqual([
-        '_geo',
-        {
+      expect(
+        adaptFieldsForMeilisearch(
+          { _geo: geoPoint } as firestore.DocumentData,
+          '_geo'
+        )
+      ).toStrictEqual({
+        _geo: {
           lat: 48.866667,
           lng: 2.333333,
         },
-      ])
+      })
       expect(mockConsoleInfo).toBeCalledWith(
         `A GeoPoint was found with the field name '_geo' for compatibility with Meilisearch the field 'latitude' was renamed to 'lat' and the field 'longitude' to 'lng'`
       )
@@ -79,13 +92,23 @@ describe('extensions process', () => {
     test('adaptValues a wrong geo point value', () => {
       const geoPoint = new firestore.GeoPoint(48.866667, 2.333333)
 
-      expect(adaptValues('wrong_geo', geoPoint)).toStrictEqual([
-        'wrong_geo',
-        geoPoint,
-      ])
+      expect(
+        adaptFieldsForMeilisearch(
+          { wrong_geo: geoPoint } as firestore.DocumentData,
+          'wrong_geo'
+        )
+      ).toStrictEqual({ wrong_geo: geoPoint })
       expect(mockConsoleInfo).toBeCalledWith(
         `A GeoPoint was found without the field name '_geo' if you want to use the geoSearch with Meilisearch rename it to '_geo'`
       )
     })
+    test('adaptValues with a _geo field at null', () => {
+      expect(
+        adaptFieldsForMeilisearch(
+          { _geo: null } as firestore.DocumentData,
+          '_geo'
+        )
+      ).toStrictEqual({})
+    })
   })
 })

package/__tests__/functions.test.ts

@@ -1,6 +1,6 @@
 import * as firebaseFunctionsTestInit from 'firebase-functions-test'
 import mockedEnv from 'mocked-env'
-import { mocked } from 'ts-jest/utils'
+import { mocked } from 'jest-mock'
 import {
   mockConsoleLog,
   mockConsoleInfo,
@@ -21,7 +21,7 @@ describe('extension', () => {
   let restoreEnv
 
   // Mocking of Meilisearch package
-  const mockedMeilisearch = mocked(MeiliSearch, true)
+  const mockedMeilisearch = mocked(MeiliSearch)
   const mockedAddDocuments = jest.fn()
   const mockedDeleteDocument = jest.fn()
   const mockedIndex = jest.fn(() => ({
@@ -42,6 +42,7 @@ describe('extension', () => {
   beforeEach(() => {
     restoreEnv = mockedEnv(defaultEnvironment)
     config = require('../src/config').config
+    config.collectionPath = 'collection'
   })
   afterEach(() => restoreEnv())
 

package/__tests__/util.test.ts

@@ -1,6 +1,6 @@
 import * as firebaseFunctionsTestInit from 'firebase-functions-test'
 import mockedEnv from 'mocked-env'
-import { getChangeType, ChangeType, getChangedDocumentId } from '../src/util'
+import { ChangeType, getChangedDocumentId, getChangeType } from '../src/util'
 import defaultEnvironment from './data/environment'
 
 describe('getChangeType', () => {
@@ -132,7 +132,7 @@ describe('getChangedDocumentId', () => {
 })
 
 describe('getFieldsToIndex', () => {
-  let util
+  let adapter
   let restoreEnv
   let mockParseFieldsToIndex
   const config = global.config
@@ -149,32 +149,36 @@ describe('getFieldsToIndex', () => {
   })
 
   test('return empty list', () => {
-    util = require('../src/util')
-    mockParseFieldsToIndex = util.parseFieldsToIndex()
+    adapter = require('../src/meilisearch-adapter')
+    mockParseFieldsToIndex = adapter.parseFieldsToIndex()
     expect(mockParseFieldsToIndex).toMatchObject([])
   })
 
   test('return list with one field', () => {
-    util = require('../src/util')
-    mockParseFieldsToIndex = util.parseFieldsToIndex('field')
+    adapter = require('../src/meilisearch-adapter')
+    mockParseFieldsToIndex = adapter.parseFieldsToIndex('field')
     expect(mockParseFieldsToIndex).toMatchObject(['field'])
   })
 
   test('return list with multiple fields', () => {
-    util = require('../src/util')
-    mockParseFieldsToIndex = util.parseFieldsToIndex('field1,field2,field3')
+    adapter = require('../src/meilisearch-adapter')
+    mockParseFieldsToIndex = adapter.parseFieldsToIndex('field1,field2,field3')
     expect(mockParseFieldsToIndex).toMatchObject(['field1', 'field2', 'field3'])
   })
 
   test('return list with multiple fields and spaces', () => {
-    util = require('../src/util')
-    mockParseFieldsToIndex = util.parseFieldsToIndex('field1, field2,  field3')
+    adapter = require('../src/meilisearch-adapter')
+    mockParseFieldsToIndex = adapter.parseFieldsToIndex(
+      'field1, field2,  field3'
+    )
     expect(mockParseFieldsToIndex).toMatchObject(['field1', 'field2', 'field3'])
   })
 
   test('return list of fiels with underscore', () => {
-    util = require('../src/util')
-    mockParseFieldsToIndex = util.parseFieldsToIndex('field_1,field_2,field_3')
+    adapter = require('../src/meilisearch-adapter')
+    mockParseFieldsToIndex = adapter.parseFieldsToIndex(
+      'field_1,field_2,field_3'
+    )
     expect(mockParseFieldsToIndex).toMatchObject([
       'field_1',
       'field_2',

package/jest.config.js

@@ -3,10 +3,13 @@ process.env.FIREBASE_CONFIG = '{}'
 module.exports = {
   rootDir: './',
   preset: 'ts-jest',
-  globals: {
-    'ts-jest': {
-      tsconfig: '<rootDir>/__tests__/tsconfig.json',
-    },
+  transform: {
+    '^.+\\.[tj]sx?$': [
+      'ts-jest',
+      {
+        tsconfig: '<rootDir>/__tests__/tsconfig.json',
+      },
+    ],
   },
   testEnvironment: 'node',
   testMatch: ['**/__tests__/*.test.ts'],

package/lib/import/index.js

@@ -19,7 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const admin = require("firebase-admin");
 const config_1 = require("./config");
 const logs = require("../logs");
-const adapter_1 = require("../adapter");
+const meilisearch_adapter_1 = require("../meilisearch-adapter");
 const create_index_1 = require("../meilisearch/create-index");
 const run = async () => {
     // Retrieve all arguments from the commande line.
@@ -80,7 +80,7 @@ async function retrieveCollectionFromFirestore(database, config, index) {
  */
 async function sendDocumentsToMeilisearch(docs, index, fieldsToIndex) {
     const document = docs.map(snapshot => {
-        return (0, adapter_1.adaptDocument)(snapshot.id, snapshot, fieldsToIndex);
+        return (0, meilisearch_adapter_1.adaptDocumentForMeilisearch)(snapshot.id, snapshot, fieldsToIndex);
     });
     try {
         await index.addDocuments(document, { primaryKey: '_firestore_id' });

package/lib/index.js

@@ -21,7 +21,7 @@ const firebase_functions_1 = require("firebase-functions");
 const create_index_1 = require("./meilisearch/create-index");
 const util_1 = require("./util");
 const logs = require("./logs");
-const adapter_1 = require("./adapter");
+const meilisearch_adapter_1 = require("./meilisearch-adapter");
 const config_1 = require("./config");
 const validate_1 = require("./validate");
 const index = (0, create_index_1.initMeilisearchIndex)(config_1.config.meilisearch);
@@ -30,19 +30,21 @@ logs.init();
  * IndexingWorker is responsible for aggregating a defined field from a Firestore collection into a Meilisearch index.
  * It is controlled by a Firestore handler.
  */
-exports.indexingWorker = functions.handler.firestore.document.onWrite(async (change) => {
+exports.indexingWorker = functions.firestore
+    .document(config_1.config.collectionPath + '/{documentId}')
+    .onWrite(async (snapshot) => {
     logs.start();
-    const changeType = (0, util_1.getChangeType)(change);
-    const documentId = (0, util_1.getChangedDocumentId)(change);
+    const changeType = (0, util_1.getChangeType)(snapshot);
+    const documentId = (0, util_1.getChangedDocumentId)(snapshot);
     switch (changeType) {
         case util_1.ChangeType.CREATE:
-            await handleAddDocument(documentId, change.after);
+            await handleAddDocument(documentId, snapshot.after);
             break;
         case util_1.ChangeType.DELETE:
             await handleDeleteDocument(documentId);
             break;
         case util_1.ChangeType.UPDATE:
-            await handleUpdateDocument(documentId, change.after);
+            await handleUpdateDocument(documentId, snapshot.after);
             break;
     }
     logs.complete();
@@ -56,7 +58,7 @@ async function handleAddDocument(documentId, snapshot) {
     try {
         logs.addDocument(documentId);
         if ((0, validate_1.validateDocumentId)(documentId)) {
-            const document = (0, adapter_1.adaptDocument)(documentId, snapshot, config_1.config.meilisearch.fieldsToIndex || '');
+            const document = (0, meilisearch_adapter_1.adaptDocumentForMeilisearch)(documentId, snapshot, config_1.config.meilisearch.fieldsToIndex || '');
             const { taskUid } = await index.addDocuments([document], {
                 primaryKey: '_firestore_id',
             });
@@ -98,7 +100,7 @@ async function handleUpdateDocument(documentId, after) {
     try {
         logs.updateDocument(documentId);
         if ((0, validate_1.validateDocumentId)(documentId)) {
-            const document = (0, adapter_1.adaptDocument)(documentId, after, config_1.config.meilisearch.fieldsToIndex || '');
+            const document = (0, meilisearch_adapter_1.adaptDocumentForMeilisearch)(documentId, after, config_1.config.meilisearch.fieldsToIndex || '');
             const { taskUid } = await index.addDocuments([document]);
             firebase_functions_1.logger.info(`Document update request for document with ID ${documentId} added to task list (task ID ${taskUid}).`);
         }

package/lib/meilisearch-adapter.js

@@ -0,0 +1,90 @@
+'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adaptDocumentForMeilisearch = exports.adaptFieldsForMeilisearch = exports.parseFieldsToIndex = exports.isAFieldToIndex = void 0;
+const firestore = require("firebase-admin/firestore");
+const logs_1 = require("./logs");
+/**
+ * Adapts GeoPoint Firestore instance to fit with Meilisearch geo point.
+ * @param {firestore.GeoPoint} geoPoint GeoPoint Firestore object.
+ * @return {MeilisearchGeoPoint} A properly formatted geo point for Meilisearch.
+ */
+function adaptGeoPoint(geoPoint) {
+    return {
+        lat: geoPoint.latitude,
+        lng: geoPoint.longitude,
+    };
+}
+/**
+ * Check if the field is added to the document send to Meilisearch.
+ *
+ * @param  {string[]} fieldsToIndex
+ * @param  {string} key
+ * @return {boolean} true if it is a field that should be indexed in Meilisearch
+ *
+ */
+function isAFieldToIndex(fieldsToIndex, key) {
+    if (fieldsToIndex.length === 0 ||
+        fieldsToIndex.includes('*') ||
+        fieldsToIndex.includes(key)) {
+        return true;
+    }
+    return false;
+}
+exports.isAFieldToIndex = isAFieldToIndex;
+/**
+ * Parse the fieldsToIndex string into an array.
+ *
+ * @param  {string} fieldsToIndex
+ * @return {string[]} An array of fields.
+ */
+function parseFieldsToIndex(fieldsToIndex) {
+    return fieldsToIndex ? fieldsToIndex.split(/[ ,]+/) : [];
+}
+exports.parseFieldsToIndex = parseFieldsToIndex;
+/**
+ * Update special fields to Meilisearch compatible format
+ * @param {firestore.DocumentData} document
+ * @param {string[]} rawFieldsToIndex
+ * @return {firestore.DocumentData} A properly formatted array of field and value.
+ */
+function adaptFieldsForMeilisearch(document, rawFieldsToIndex) {
+    const fieldsToIndex = parseFieldsToIndex(rawFieldsToIndex);
+    return Object.keys(document).reduce((doc, currentField) => {
+        const value = document[currentField];
+        if (!isAFieldToIndex(fieldsToIndex, currentField))
+            return doc;
+        if (value instanceof firestore.GeoPoint) {
+            if (currentField === '_geo') {
+                (0, logs_1.infoGeoPoint)(true);
+                return {
+                    ...doc,
+                    _geo: adaptGeoPoint(value),
+                };
+            }
+            else {
+                (0, logs_1.infoGeoPoint)(false);
+            }
+        }
+        else if (currentField === '_geo') {
+            return doc;
+        }
+        return { ...doc, [currentField]: value };
+    }, {});
+}
+exports.adaptFieldsForMeilisearch = adaptFieldsForMeilisearch;
+/**
+ * Adapts documents from the Firestore database to Meilisearch compatible documents.
+ * @param {string} documentId Document id.
+ * @param {DocumentSnapshot} snapshot Snapshot of the data contained in the document read from your Firestore database.
+ * @param {string} rawFieldsToIndex Value of the setting `FIELDS_TO_INDEX`
+ * @return {Record<string, any>} A properly formatted document to be added or updated in Meilisearch.
+ */
+function adaptDocumentForMeilisearch(documentId, snapshot, rawFieldsToIndex) {
+    const data = snapshot.data() || {};
+    if ('_firestore_id' in data) {
+        delete data.id;
+    }
+    const adaptedDoc = adaptFieldsForMeilisearch(data, rawFieldsToIndex);
+    return { _firestore_id: documentId, ...adaptedDoc };
+}
+exports.adaptDocumentForMeilisearch = adaptDocumentForMeilisearch;

package/lib/util.js

@@ -1,6 +1,6 @@
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeDocuments = exports.parseFieldsToIndex = exports.getChangedDocumentId = exports.getChangeType = exports.ChangeType = void 0;
+exports.getChangedDocumentId = exports.getChangeType = exports.ChangeType = void 0;
 var ChangeType;
 (function (ChangeType) {
     ChangeType[ChangeType["CREATE"] = 0] = "CREATE";
@@ -34,36 +34,3 @@ function getChangedDocumentId(change) {
     return change.before.id;
 }
 exports.getChangedDocumentId = getChangedDocumentId;
-/**
- * Parse the fieldsToIndex string into an array.
- *
- * @param  {string} fieldsToIndex
- * @return {string[]} An array of fields.
- */
-function parseFieldsToIndex(fieldsToIndex) {
-    return fieldsToIndex ? fieldsToIndex.split(/[ ,]+/) : [];
-}
-exports.parseFieldsToIndex = parseFieldsToIndex;
-/**
- * Remove unwanted fields from the document before it is send to Meilisearch.
- *
- * @param  {string[]} fieldsToIndex
- * @param  {Record<string, any>} document
- * @return {Record<string, any>} sanitized document
- *
- */
-function sanitizeDocuments(fieldsToIndex, document) {
-    if (fieldsToIndex.length === 0) {
-        return document;
-    }
-    if (fieldsToIndex.includes('*')) {
-        return document;
-    }
-    for (const key in document) {
-        if (!fieldsToIndex.includes(key)) {
-            delete document[key];
-        }
-    }
-    return document;
-}
-exports.sanitizeDocuments = sanitizeDocuments;

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.1.11';
+exports.version = '0.3.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firestore-meilisearch",
-  "version": "0.1.11",
+  "version": "0.3.0",
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
@@ -17,13 +17,13 @@
     "test:coverage": "jest --coverage"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=20.0.0"
   },
   "main": "lib/index.js",
   "dependencies": {
     "commander": "^9.1.0",
-    "firebase-admin": "^9.8.0",
-    "firebase-functions": "^3.16.0",
+    "firebase-admin": "^11.5.0",
+    "firebase-functions": "^4.2.1",
     "inquirer": "^8.2.2",
     "meilisearch": "^0.30.0"
   },
@@ -35,16 +35,17 @@
     "eslint": "^7.6.0",
     "eslint-config-google": "^0.14.0",
     "eslint-config-prettier": "^8.3.0",
+    "eslint-import-resolver-typescript": "^3.5.3",
     "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-jest": "^24.4.2",
     "eslint-plugin-prettier": "^4.0.0",
-    "firebase-functions-test": "^0.3.2",
-    "jest": "^27.2.2",
-    "jest-mock": "^27.1.1",
+    "firebase-functions-test": "^3.0.0",
+    "jest": "^29.4.3",
+    "jest-mock": "^29.4.3",
     "js-yaml": "^4.1.0",
     "mocked-env": "^1.3.5",
     "prettier": "^2.4.1",
-    "ts-jest": "^27.0.5",
+    "ts-jest": "^29.0.5",
     "ts-node": "^10.2.1",
     "typescript": "^4.4.3"
   },

package/src/import/index.ts

@@ -17,10 +17,10 @@
  */
 
 import * as admin from 'firebase-admin'
-import { DocumentSnapshot } from 'firebase-functions/lib/providers/firestore'
+import { DocumentSnapshot } from 'firebase-functions/lib/v1/providers/firestore'
 import { CLIConfig, parseConfig } from './config'
 import * as logs from '../logs'
-import { adaptDocument } from '../adapter'
+import { adaptDocumentForMeilisearch } from '../meilisearch-adapter'
 import { initMeilisearchIndex } from '../meilisearch/create-index'
 import { Index } from '../types'
 
@@ -106,7 +106,7 @@ async function sendDocumentsToMeilisearch(
   fieldsToIndex: string
 ): Promise<number> {
   const document = docs.map(snapshot => {
-    return adaptDocument(snapshot.id, snapshot, fieldsToIndex)
+    return adaptDocumentForMeilisearch(snapshot.id, snapshot, fieldsToIndex)
   })
   try {
     await index.addDocuments(document, { primaryKey: '_firestore_id' })

package/src/index.ts

@@ -17,11 +17,11 @@
 
 import * as functions from 'firebase-functions'
 import { Change, logger } from 'firebase-functions'
-import { DocumentSnapshot } from 'firebase-functions/lib/providers/firestore'
+import { DocumentSnapshot } from 'firebase-functions/lib/v1/providers/firestore'
 import { initMeilisearchIndex } from './meilisearch/create-index'
 import { getChangeType, getChangedDocumentId, ChangeType } from './util'
 import * as logs from './logs'
-import { adaptDocument } from './adapter'
+import { adaptDocumentForMeilisearch } from './meilisearch-adapter'
 import { config } from './config'
 import { validateDocumentId } from './validate'
 
@@ -33,26 +33,26 @@ logs.init()
  * IndexingWorker is responsible for aggregating a defined field from a Firestore collection into a Meilisearch index.
  * It is controlled by a Firestore handler.
  */
-export const indexingWorker = functions.handler.firestore.document.onWrite(
-  async (change: Change<DocumentSnapshot>): Promise<void> => {
+export const indexingWorker = functions.firestore
+  .document(config.collectionPath + '/{documentId}')
+  .onWrite(async (snapshot: Change<DocumentSnapshot>): Promise<void> => {
     logs.start()
-    const changeType = getChangeType(change)
-    const documentId = getChangedDocumentId(change)
+    const changeType = getChangeType(snapshot)
+    const documentId = getChangedDocumentId(snapshot)
 
     switch (changeType) {
       case ChangeType.CREATE:
-        await handleAddDocument(documentId, change.after)
+        await handleAddDocument(documentId, snapshot.after)
         break
       case ChangeType.DELETE:
         await handleDeleteDocument(documentId)
         break
       case ChangeType.UPDATE:
-        await handleUpdateDocument(documentId, change.after)
+        await handleUpdateDocument(documentId, snapshot.after)
         break
     }
     logs.complete()
-  }
-)
+  })
 
 /**
  * Handle addition of a document in the Meilisearch index.
@@ -66,7 +66,7 @@ async function handleAddDocument(
   try {
     logs.addDocument(documentId)
     if (validateDocumentId(documentId)) {
-      const document = adaptDocument(
+      const document = adaptDocumentForMeilisearch(
         documentId,
         snapshot,
         config.meilisearch.fieldsToIndex || ''
@@ -123,7 +123,7 @@ async function handleUpdateDocument(
   try {
     logs.updateDocument(documentId)
     if (validateDocumentId(documentId)) {
-      const document = adaptDocument(
+      const document = adaptDocumentForMeilisearch(
         documentId,
         after,
         config.meilisearch.fieldsToIndex || ''

package/src/meilisearch-adapter.ts

@@ -0,0 +1,120 @@
+'use strict'
+/*
+ * Copyright 2022 Meilisearch
+ *
+ * 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
+ *
+ *    https://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 { DocumentSnapshot } from 'firebase-functions/lib/v1/providers/firestore'
+import * as firestore from 'firebase-admin/firestore'
+import { infoGeoPoint } from './logs'
+
+type MeilisearchGeoPoint = {
+  lat: number
+  lng: number
+}
+
+/**
+ * Adapts GeoPoint Firestore instance to fit with Meilisearch geo point.
+ * @param {firestore.GeoPoint} geoPoint GeoPoint Firestore object.
+ * @return {MeilisearchGeoPoint} A properly formatted geo point for Meilisearch.
+ */
+function adaptGeoPoint(geoPoint: firestore.GeoPoint): MeilisearchGeoPoint {
+  return {
+    lat: geoPoint.latitude,
+    lng: geoPoint.longitude,
+  }
+}
+
+/**
+ * Check if the field is added to the document send to Meilisearch.
+ *
+ * @param  {string[]} fieldsToIndex
+ * @param  {string} key
+ * @return {boolean} true if it is a field that should be indexed in Meilisearch
+ *
+ */
+export function isAFieldToIndex(fieldsToIndex: string[], key: string): boolean {
+  if (
+    fieldsToIndex.length === 0 ||
+    fieldsToIndex.includes('*') ||
+    fieldsToIndex.includes(key)
+  ) {
+    return true
+  }
+  return false
+}
+
+/**
+ * Parse the fieldsToIndex string into an array.
+ *
+ * @param  {string} fieldsToIndex
+ * @return {string[]} An array of fields.
+ */
+export function parseFieldsToIndex(fieldsToIndex: string): string[] {
+  return fieldsToIndex ? fieldsToIndex.split(/[ ,]+/) : []
+}
+
+/**
+ * Update special fields to Meilisearch compatible format
+ * @param {firestore.DocumentData} document
+ * @param {string[]} rawFieldsToIndex
+ * @return {firestore.DocumentData} A properly formatted array of field and value.
+ */
+export function adaptFieldsForMeilisearch(
+  document: firestore.DocumentData,
+  rawFieldsToIndex: string
+): firestore.DocumentData {
+  const fieldsToIndex = parseFieldsToIndex(rawFieldsToIndex)
+
+  return Object.keys(document).reduce((doc, currentField) => {
+    const value = document[currentField]
+
+    if (!isAFieldToIndex(fieldsToIndex, currentField)) return doc
+    if (value instanceof firestore.GeoPoint) {
+      if (currentField === '_geo') {
+        infoGeoPoint(true)
+        return {
+          ...doc,
+          _geo: adaptGeoPoint(value),
+        }
+      } else {
+        infoGeoPoint(false)
+      }
+    } else if (currentField === '_geo') {
+      return doc
+    }
+    return { ...doc, [currentField]: value }
+  }, {})
+}
+
+/**
+ * Adapts documents from the Firestore database to Meilisearch compatible documents.
+ * @param {string} documentId Document id.
+ * @param {DocumentSnapshot} snapshot Snapshot of the data contained in the document read from your Firestore database.
+ * @param {string} rawFieldsToIndex Value of the setting `FIELDS_TO_INDEX`
+ * @return {Record<string, any>} A properly formatted document to be added or updated in Meilisearch.
+ */
+export function adaptDocumentForMeilisearch(
+  documentId: string,
+  snapshot: DocumentSnapshot,
+  rawFieldsToIndex: string
+): Record<string, any> {
+  const data = snapshot.data() || {}
+  if ('_firestore_id' in data) {
+    delete data.id
+  }
+  const adaptedDoc = adaptFieldsForMeilisearch(data, rawFieldsToIndex)
+
+  return { _firestore_id: documentId, ...adaptedDoc }
+}

package/src/util.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { DocumentSnapshot } from 'firebase-functions/lib/providers/firestore'
+import { DocumentSnapshot } from 'firebase-functions/lib/v1/providers/firestore'
 import { Change } from 'firebase-functions'
 
 export enum ChangeType {
@@ -50,40 +50,3 @@ export function getChangedDocumentId(change: Change<DocumentSnapshot>): string {
   }
   return change.before.id
 }
-
-/**
- * Parse the fieldsToIndex string into an array.
- *
- * @param  {string} fieldsToIndex
- * @return {string[]} An array of fields.
- */
-export function parseFieldsToIndex(fieldsToIndex: string): string[] {
-  return fieldsToIndex ? fieldsToIndex.split(/[ ,]+/) : []
-}
-
-/**
- * Remove unwanted fields from the document before it is send to Meilisearch.
- *
- * @param  {string[]} fieldsToIndex
- * @param  {Record<string, any>} document
- * @return {Record<string, any>} sanitized document
- *
- */
-export function sanitizeDocuments(
-  fieldsToIndex: string[],
-  document: Record<string, any>
-): Record<string, any> {
-  if (fieldsToIndex.length === 0) {
-    return document
-  }
-  if (fieldsToIndex.includes('*')) {
-    return document
-  }
-
-  for (const key in document) {
-    if (!fieldsToIndex.includes(key)) {
-      delete document[key]
-    }
-  }
-  return document
-}

package/src/version.ts

@@ -1 +1 @@
-export const version = '0.1.11'
+export const version = '0.3.0'

package/lib/adapter.js

@@ -1,53 +0,0 @@
-'use strict';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.adaptValues = exports.adaptDocument = void 0;
-const firestore_1 = require("firebase-admin/lib/firestore");
-const util_1 = require("./util");
-const logs = require("./logs");
-/**
- * Adapts documents from the Firestore database to Meilisearch compatible documents.
- * @param {string} documentId Document id.
- * @param {DocumentSnapshot} snapshot Snapshot of the data contained in the document read from your Firestore database.
- * @param {string} fieldsToIndex list of fields added in the document send to Meilisearch.
- * @return {Record<string, any>} A properly formatted document to be added or updated in Meilisearch.
- */
-function adaptDocument(documentId, snapshot, fieldsToIndex) {
-    const fields = (0, util_1.parseFieldsToIndex)(fieldsToIndex);
-    const data = snapshot.data() || {};
-    if ('_firestore_id' in data) {
-        delete data.id;
-    }
-    const document = (0, util_1.sanitizeDocuments)(fields, data);
-    return { _firestore_id: documentId, ...document };
-}
-exports.adaptDocument = adaptDocument;
-/**
- * Checks and adapts each values to be compatible with Meilisearch documents.
- * @param {string} field
- * @param {FirestoreRow} value
- * @return {[string,FirestoreRow]} A properly formatted array of field and value.
- */
-function adaptValues(field, value) {
-    if (value instanceof firestore_1.firestore.GeoPoint) {
-        if (field === '_geo') {
-            logs.infoGeoPoint(true);
-            return [field, adaptGeoPoint(value)];
-        }
-        else {
-            logs.infoGeoPoint(false);
-        }
-    }
-    return [field, value];
-}
-exports.adaptValues = adaptValues;
-/**
- * Adapts GeoPoint Firestore instance to fit with Meilisearch geo point.
- * @param {firestore.GeoPoint} geoPoint GeoPoint Firestore object.
- * @return {MeilisearchGeoPoint} A properly formatted geo point for Meilisearch.
- */
-const adaptGeoPoint = (geoPoint) => {
-    return {
-        lat: geoPoint.latitude,
-        lng: geoPoint.longitude,
-    };
-};

package/lib/meilisearch-index.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMeiliSearchIndex = void 0;
-const meilisearch_1 = require("meilisearch");
-/**
- * createMeiliSearchIndex
- * @param {MeiliSearchConfig}
- * @return {Index}
- */
-function createMeiliSearchIndex({ host, apiKey, indexUid, }) {
-    const client = new meilisearch_1.MeiliSearch({
-        host,
-        apiKey,
-    });
-    return client.index(indexUid);
-}
-exports.createMeiliSearchIndex = createMeiliSearchIndex;

package/src/adapter.ts

@@ -1,95 +0,0 @@
-'use strict'
-/*
- * Copyright 2022 Meilisearch
- *
- * 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
- *
- *    https://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 { DocumentSnapshot } from 'firebase-functions/lib/providers/firestore'
-import { firestore } from 'firebase-admin/lib/firestore'
-import { parseFieldsToIndex, sanitizeDocuments } from './util'
-import * as logs from './logs'
-
-type MeilisearchGeoPoint = {
-  lat: number
-  lng: number
-}
-
-type FirestoreRow =
-  | null
-  | boolean
-  | number
-  | string
-  | firestore.DocumentReference
-  | firestore.GeoPoint
-  | firestore.Timestamp
-  | Array<any>
-  | Map<any, any>
-  | MeilisearchGeoPoint
-
-/**
- * Adapts documents from the Firestore database to Meilisearch compatible documents.
- * @param {string} documentId Document id.
- * @param {DocumentSnapshot} snapshot Snapshot of the data contained in the document read from your Firestore database.
- * @param {string} fieldsToIndex list of fields added in the document send to Meilisearch.
- * @return {Record<string, any>} A properly formatted document to be added or updated in Meilisearch.
- */
-export function adaptDocument(
-  documentId: string,
-  snapshot: DocumentSnapshot,
-  fieldsToIndex: string
-): Record<string, any> {
-  const fields = parseFieldsToIndex(fieldsToIndex)
-
-  const data = snapshot.data() || {}
-  if ('_firestore_id' in data) {
-    delete data.id
-  }
-
-  const document = sanitizeDocuments(fields, data)
-
-  return { _firestore_id: documentId, ...document }
-}
-
-/**
- * Checks and adapts each values to be compatible with Meilisearch documents.
- * @param {string} field
- * @param {FirestoreRow} value
- * @return {[string,FirestoreRow]} A properly formatted array of field and value.
- */
-export function adaptValues(
-  field: string,
-  value: FirestoreRow
-): [string, FirestoreRow | MeilisearchGeoPoint] {
-  if (value instanceof firestore.GeoPoint) {
-    if (field === '_geo') {
-      logs.infoGeoPoint(true)
-      return [field, adaptGeoPoint(value)]
-    } else {
-      logs.infoGeoPoint(false)
-    }
-  }
-  return [field, value]
-}
-
-/**
- * Adapts GeoPoint Firestore instance to fit with Meilisearch geo point.
- * @param {firestore.GeoPoint} geoPoint GeoPoint Firestore object.
- * @return {MeilisearchGeoPoint} A properly formatted geo point for Meilisearch.
- */
-const adaptGeoPoint = (geoPoint: firestore.GeoPoint): MeilisearchGeoPoint => {
-  return {
-    lat: geoPoint.latitude,
-    lng: geoPoint.longitude,
-  }
-}