firestore-meilisearch 0.3.0 → 0.3.2

package/README.md

@@ -36,16 +36,16 @@ 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.
+## 🚀 Getting started
 
 #### Additional setup
 
 Before installing this extension, you'll need to:
 
 - [Set up Cloud Firestore in your Firebase project](https://firebase.google.com/docs/firestore/quickstart)
-- Run a Meilisearch instance. [Learn more about Meilisearch cloud](https://www.meilisearch.com/pricing). Alternatively there are many other easy ways [to download and run a Meilisearch instance](https://docs.meilisearch.com/learn/getting_started/installation.html#download-and-launch)
+- Run a Meilisearch instance:
+  - ⚡ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=firestore-meilisearch).
+  - 🪨 Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=firestore-meilisearch) our fast, open-source search engine on your own infrastructure.
 
 #### Data import format
 
@@ -76,9 +76,6 @@ a Google Cloud API or making outbound network requests to non-Google services.
 All Firebase services offer a free tier of usage.
 [Learn more about Firebase billing.](https://firebase.google.com/pricing)
 
-
-
-
 **Configuration Parameters:**
 
 * Cloud Functions location: Where do you want to deploy the functions created for this extension? If you need help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).

package/__tests__/adapter.test.ts

@@ -1,4 +1,5 @@
-import * as firebaseFunctionsTestInit from 'firebase-functions-test'
+import { describe, test, expect } from '@jest/globals'
+import firebaseFunctionsTestInit from 'firebase-functions-test'
 import { mockConsoleInfo } from './__mocks__/console'
 import * as firestore from 'firebase-admin/firestore'
 import {

package/__tests__/config.test.ts

@@ -1,3 +1,11 @@
+import {
+  describe,
+  test,
+  expect,
+  beforeEach,
+  afterEach,
+  jest,
+} from '@jest/globals'
 import { readFileSync } from 'fs'
 import { resolve as pathResolve } from 'path'
 import * as yaml from 'js-yaml'

package/__tests__/functions.test.ts

@@ -1,4 +1,12 @@
-import * as firebaseFunctionsTestInit from 'firebase-functions-test'
+import {
+  describe,
+  test,
+  expect,
+  beforeEach,
+  afterEach,
+  jest,
+} from '@jest/globals'
+import firebaseFunctionsTestInit from 'firebase-functions-test'
 import mockedEnv from 'mocked-env'
 import { mocked } from 'jest-mock'
 import {
@@ -49,6 +57,7 @@ describe('extension', () => {
   test('functions are exported', () => {
     const exportedFunctions = jest.requireActual('../src')
 
+    // @ts-ignore: We're asserting the export is a function
     expect(exportedFunctions.indexingWorker).toBeInstanceOf(Function)
   })
 

package/__tests__/tsconfig.json

@@ -1,5 +1,15 @@
 {
   "extends": "../tsconfig.json",
-  "files": ["test.types.d.ts"],
-  "include": ["**/*"]
+  "compilerOptions": {
+    "types": [
+      "jest",
+      "node"
+    ]
+  },
+  "files": [
+    "test.types.d.ts"
+  ],
+  "include": [
+    "**/*"
+  ]
 }

package/__tests__/util.test.ts

@@ -1,4 +1,12 @@
-import * as firebaseFunctionsTestInit from 'firebase-functions-test'
+import {
+  describe,
+  test,
+  expect,
+  beforeEach,
+  afterEach,
+  jest,
+} from '@jest/globals'
+import firebaseFunctionsTestInit from 'firebase-functions-test'
 import mockedEnv from 'mocked-env'
 import { ChangeType, getChangedDocumentId, getChangeType } from '../src/util'
 import defaultEnvironment from './data/environment'
@@ -151,19 +159,19 @@ describe('getFieldsToIndex', () => {
   test('return empty list', () => {
     adapter = require('../src/meilisearch-adapter')
     mockParseFieldsToIndex = adapter.parseFieldsToIndex()
-    expect(mockParseFieldsToIndex).toMatchObject([])
+    expect(mockParseFieldsToIndex).toEqual([])
   })
 
   test('return list with one field', () => {
     adapter = require('../src/meilisearch-adapter')
     mockParseFieldsToIndex = adapter.parseFieldsToIndex('field')
-    expect(mockParseFieldsToIndex).toMatchObject(['field'])
+    expect(mockParseFieldsToIndex).toEqual(['field'])
   })
 
   test('return list with multiple fields', () => {
     adapter = require('../src/meilisearch-adapter')
     mockParseFieldsToIndex = adapter.parseFieldsToIndex('field1,field2,field3')
-    expect(mockParseFieldsToIndex).toMatchObject(['field1', 'field2', 'field3'])
+    expect(mockParseFieldsToIndex).toEqual(['field1', 'field2', 'field3'])
   })
 
   test('return list with multiple fields and spaces', () => {
@@ -171,7 +179,7 @@ describe('getFieldsToIndex', () => {
     mockParseFieldsToIndex = adapter.parseFieldsToIndex(
       'field1, field2,  field3'
     )
-    expect(mockParseFieldsToIndex).toMatchObject(['field1', 'field2', 'field3'])
+    expect(mockParseFieldsToIndex).toEqual(['field1', 'field2', 'field3'])
   })
 
   test('return list of fiels with underscore', () => {
@@ -179,10 +187,6 @@ describe('getFieldsToIndex', () => {
     mockParseFieldsToIndex = adapter.parseFieldsToIndex(
       'field_1,field_2,field_3'
     )
-    expect(mockParseFieldsToIndex).toMatchObject([
-      'field_1',
-      'field_2',
-      'field_3',
-    ])
+    expect(mockParseFieldsToIndex).toEqual(['field_1', 'field_2', 'field_3'])
   })
 })

package/lib/import/config.js

@@ -1,8 +1,31 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseConfig = void 0;
 const commander_1 = require("commander");
-const inquirer = require("inquirer");
+const inquirer = __importStar(require("inquirer"));
 const FIRESTORE_VALID_CHARACTERS = /^[^/]+$/;
 const FIRESTORE_COLLECTION_NAME_MAX_CHARS = 6144;
 const PROJECT_ID_MAX_CHARS = 30;

package/lib/import/index.js

@@ -15,21 +15,44 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const admin = require("firebase-admin");
+const firebase_admin_1 = __importStar(require("firebase-admin"));
 const config_1 = require("./config");
-const logs = require("../logs");
+const logs = __importStar(require("../logs"));
 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.
     const config = await (0, config_1.parseConfig)();
     // Initialize Firebase using the Google Credentials in the GOOGLE_APPLICATION_CREDENTIALS environment variable.
-    admin.initializeApp({
-        credential: admin.credential.applicationDefault(),
+    firebase_admin_1.default.initializeApp({
+        credential: firebase_admin_1.credential.applicationDefault(),
         databaseURL: `https://${config.projectId}.firebaseio.com`,
     });
-    const database = admin.firestore();
+    const database = (0, firebase_admin_1.firestore)();
     // Initialize Meilisearch index.
     const index = (0, create_index_1.initMeilisearchIndex)(config.meilisearch);
     await retrieveCollectionFromFirestore(database, config, index);

package/lib/index.js

@@ -1,4 +1,27 @@
 'use strict';
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.indexingWorker = void 0;
 /*
@@ -16,11 +39,11 @@ exports.indexingWorker = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const functions = require("firebase-functions");
+const functions = __importStar(require("firebase-functions"));
 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 logs = __importStar(require("./logs"));
 const meilisearch_adapter_1 = require("./meilisearch-adapter");
 const config_1 = require("./config");
 const validate_1 = require("./validate");

package/lib/meilisearch-adapter.js

@@ -1,7 +1,30 @@
 'use strict';
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.adaptDocumentForMeilisearch = exports.adaptFieldsForMeilisearch = exports.parseFieldsToIndex = exports.isAFieldToIndex = void 0;
-const firestore = require("firebase-admin/firestore");
+const firestore = __importStar(require("firebase-admin/firestore"));
 const logs_1 = require("./logs");
 /**
  * Adapts GeoPoint Firestore instance to fit with Meilisearch geo point.

package/lib/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firestore-meilisearch",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
@@ -25,10 +25,12 @@
     "firebase-admin": "^11.5.0",
     "firebase-functions": "^4.2.1",
     "inquirer": "^8.2.2",
-    "meilisearch": "^0.30.0"
+    "meilisearch": "^0.30.0",
+    "typescript": "^4.4.3"
   },
   "devDependencies": {
     "@babel/preset-typescript": "^7.15.0",
+    "@jest/globals": "^29.7.0",
     "@types/jest": "^27.0.2",
     "@typescript-eslint/eslint-plugin": "^4.32.0",
     "@typescript-eslint/parser": "^4.32.0",
@@ -46,8 +48,7 @@
     "mocked-env": "^1.3.5",
     "prettier": "^2.4.1",
     "ts-jest": "^29.0.5",
-    "ts-node": "^10.2.1",
-    "typescript": "^4.4.3"
+    "ts-node": "^10.2.1"
   },
   "bin": "lib/import/index.js"
 }

package/src/import/index.ts

@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-import * as admin from 'firebase-admin'
+import admin, { credential, firestore } from 'firebase-admin'
 import { DocumentSnapshot } from 'firebase-functions/lib/v1/providers/firestore'
 import { CLIConfig, parseConfig } from './config'
 import * as logs from '../logs'
@@ -30,11 +30,11 @@ const run = async () => {
 
   // Initialize Firebase using the Google Credentials in the GOOGLE_APPLICATION_CREDENTIALS environment variable.
   admin.initializeApp({
-    credential: admin.credential.applicationDefault(),
+    credential: credential.applicationDefault(),
     databaseURL: `https://${config.projectId}.firebaseio.com`,
   })
 
-  const database = admin.firestore()
+  const database = firestore()
 
   // Initialize Meilisearch index.
   const index = initMeilisearchIndex(config.meilisearch)

package/src/version.ts

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

package/tsconfig.json

@@ -9,9 +9,9 @@
     "strict": true,
     "target": "es2018",
     "types": [
-      "jest",
       "node",
-    ]
+    ],
+    "esModuleInterop": true,
   },
   "compileOnSave": true,
   "include": [
@@ -19,5 +19,6 @@
   ],
   "exclude": [
     "node_modules",
+    "**/__tests__/**"
   ]
 }