firestore-meilisearch 0.1.1 → 0.1.2

package/CONTRIBUTING.md

@@ -1,236 +0,0 @@
-# Contributing
-
-First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.
-
-<!-- MarkdownTOC autolink="true" style="ordered" indent="   " -->
-
-- [Assumptions](#assumptions)
-- [How to Contribute](#how-to-contribute)
-- [Development Workflow](#development-workflow)
-- [Git Guidelines](#git-guidelines)
-- [Release Process (for internal team only)](#release-process-for-internal-team-only)
-
-<!-- /MarkdownTOC -->
-
-## Assumptions
-
-1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) (PR) workflow.**
-2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).**
-3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
-
-## How to Contribute
-
-1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/meilisearch/meilisearch-js/issues/) or [open a new one](https://github.com/meilisearch/meilisearch-js/issues/new).
-2. Once done, [fork the firestore-meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. Ask a maintainer if you want your issue to be checked before making a PR.
-3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
-4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository.
-5. Make the changes on your branch.
-6. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the main meilisearch-js repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
- We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/meilisearch-js/releases/).
-7. You will need to build the project with `yarn build` before pushing files.
-8. Don't forget to add `js` files from the `./lib/` directory to your PR.
-
-## Development Workflow
-
-### Requirements <!-- omit in toc -->
-
-To run this project, you will need:
-
-- Node >= 14 && node <= 17
-- Npm >= v7
-- A google account
-- Latest version of `firebase-tools` the Firebase CLI:
-  ``` bash
-  yarn global add firebase-tools
-  ```
-  Add the directory for the commands of the packages installed globally in yarn, to access of firebase binary:
-  ``` bash
-  export PATH="$(yarn global bin):$PATH"
-  ```
-
-### Setup <!-- omit in toc -->
-
-Sign in with your Google Account:
-``` bash
-firebase login
-```
-Enable the extension developer commands:
-``` bash
-firebase --open-sesame extdev
-```
-Install dependencies:
-``` bash
-yarn install:functions
-```
-Build the project:
-``` bash
-yarn build
-```
-Launch Meilisearch instance:
-``` bash
-curl -L https://install.meilisearch.com | sh # download Meilisearch
-./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
-```
-You may need to [install Java](https://www.java.com/en/download/help/download_options.html) to run the emulator.</br>
-Set emulator:
-```bash
-firebase init emulators
-```
-Launch emulator:
-``` bash
-firebase ext:dev:emulators:start --test-params=test-params-example.env --import=dataset --project=name-of-the-project
-```
-or just
-``` bash
-yarn emulator
-```
-The emulator runs with environment parameters found in `test-params-example.env` and with a provided dataset found in `/dataset`.
-
-Once it is running, open the emulator in a browser at the following address: http://localhost:4000
-
-NB: If you want to change your Meilisearch credentials or the plugins options you need to edit the `test-params-example.env` file.
-
-### Tests and Linter <!-- omit in toc -->
-
-Each PR should pass the tests and the linter to be accepted.
-
-```bash
-curl -L https://install.meilisearch.com | sh # download Meilisearch
-./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
-
-# Tests
-yarn test
-
-# Tests in watch mode
-yarn test:watch
-
-# Linter
-yarn lint
-
-# Linter with fixing
-yarn lint:fix
-
-# Build the project
-yarn build
-```
-
-### Run the backfilled-data script
-
-- Set up credentials. The import script uses the application's default credentials to communicate with Firebase. Please follow the instructions [generate a private key file for your service account](https://firebase.google.com/docs/admin/setup#initialize-sdk).
-
-- Run the import script interactively and run ONE of the following commands:
-  - Run interactively:
-    ```bash
-    yarn run-cli
-    ```
-
-  - Or run non-interactively with paramaters:
-    ```bash
-    yarn run-cli \
-      --project <project_id> \
-      --source-collection-path <collection_name> \
-      --index <index_uid> \
-      --batch-size <100/default=300> \
-      --host <host_address> \
-      --api-key <api_key> \
-      --non-interactive
-    ```
-    **Note**: The `--batch-size` and `--query-collection-group` arguments are optional. To see its usage, run the above command with `--help`.
-
-- Run the project for development:
-Launch Meilisearch instance:
-``` bash
-curl -L https://install.meilisearch.com | sh # download Meilisearch
-./meilisearch --master-key=masterKey --no-analytics # run Meilisearch
-```
-Launch the watcher on the project:
-``` bash
-yarn watch
-```
-Launch the watcher on the script. You have to modify the informations of the playground script by your own parameters inside the `package.json` file:
-``` bash
-yarn playground
-```
-
-### Generate the README
-
-The Firebase CLI offers the possibility of automatically generating the `README.md` file with the following command:
-```bash
-firebase ext:info ./path/to/extension --markdown > README.md
-```
-**Note:** Be careful this will only regenerate the text of the central part of the `README.md` from the Title: `Search in your Firestore content with Meilisearch` to the `**Cloud Functions:**` section.
-
-## Git Guidelines
-
-### Git Branches <!-- omit in toc -->
-
-All changes must be made in a branch and submitted as PR.
-We do not enforce any branch naming style, but please use something descriptive of your changes.
-
-### Git Commits <!-- omit in toc -->
-
-As minimal requirements, your commit message should:
-- be capitalized
-- not finish by a dot or any other punctuation character (!,?)
-- start with a verb so that we can read your commit message this way: "This commit will ...", where "..." is the commit message.
-  e.g.: "Fix the home page button" or "Add more tests for create_index method"
-
-We don't follow any other convention, but if you want to use one, we recommend [this one](https://chris.beams.io/posts/git-commit/).
-
-### GitHub Pull Requests <!-- omit in toc -->
-
-Some notes on GitHub PRs:
-
-- [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
-  The draft PR can be very useful if you want to show that you are working on something and make your work visible.
-- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
-- All PRs must be reviewed and approved by at least one maintainer.
-- The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/meilisearch-js/releases/).
-
-## Release Process (for internal team only)
-
-Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/).
-
-### Automation to Rebase and Merge the PRs <!-- omit in toc -->
-
-This project integrates a bot that helps us manage pull requests merging.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md)._
-
-### Automated Changelogs <!-- omit in toc -->
-
-This project integrates a tool to create automated changelogs.<br>
-_[Read more about this](https://github.com/meilisearch/integration-guides/blob/main/resources/release-drafter.md)._
-
-### How to Publish the Release <!-- omit in toc -->
-
-⚠️ Before doing anything, make sure you got through the guide about [Releasing an Integration](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md).
-
-1. To update the version package in all needed files you can run the `version.sh` script with the version number in argument: `"X.X.X"`. If you want to modify it by hand you have to update the version in the following files:
-- [`package.json`](/package.json).
-- [`package.json`](/functions/packag e.json) in the functions directory.
-- [`extension.yaml`](/extension.yaml).
-- [`version.ts`](/functions/src/version.ts).
-
-After which don't forget to rebuild the project.
-</br>
-The `version.sh` script will `add` and `commit` the modification but you till need to verify it and push it.
-```bash
-sh script/version.sh X.X.X
-```
-
-2. Test the extension by installing it in Firestore:
-```bash
-firebase ext:install . --project=[your_project_id]
-```
-
-3. Publish the extension by running the following command in the root of the extension directory:
-```bash
-firebase ext:dev:publish meilisearch/firestore-meilisearch
-```
-**Note**: `meilisearch` is the `publisher id` for this extension.
-
-Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-go/releases): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommandations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.
-
-<hr>
-
-Thank you again for reading this through, we can not wait to begin to work with you if you made your way through this contributing guide ❤️

package/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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
-
-       http://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.

package/POSTINSTALL.md

@@ -1,40 +0,0 @@
-### See it in action
-
-You can test out this extension right away!
-
-1.  Go to your [Cloud Firestore dashboard](https://console.firebase.google.com/project/${param:PROJECT_ID}/firestore/data) in the Firebase console
-
-2.  If it doesn't already exist, create the collection you specified during installation: `${param:COLLECTION_PATH}`
-
-3.  Create, update, or delete a document in the collection called `${param:COLLECTION_PATH}` that contains any fields with any values that you'd like.
-
-4.  You can check the status of tasks in your Meilisearch instance using the following query:
-
-    ```
-    curl \
-      -X GET '`${param:MEILISEARCH_HOST}`/tasks'
-    ```
-    You can read more on [tasks](https://docs.meilisearch.com/reference/api/tasks.html#tasks) in the documentation.
-
-### Using the extension
-
-Whenever a document is created, updated, or deleted in the specified collection `${param:COLLECTION_PATH}`, this extension sends that update to your Meilisearch instance.
-
-This extension:
-- Indexes a document in Meilisearch and sends all the fields or configured fields defined in the extension
-- Updates a document in your Meilisearch index
-- Deletes a document from your Meilisearch index
-
-### _(Optional)_ Import existing documents
-
-This extension does not export your existing document dataset in Meilisearch. It will only export the documents that have been modified or created after installation. To populate your Meilisearch database with all the documents in your Firestore collection, you need to run the import script provided by this extension.
-
-The import script reads all existing documents in a Cloud Firestore collection or group collection and indexes them into Meilisearch.
-
-**Important:** Run the import script over the entire collection _after_ installing this extension; otherwise, you may lose the current writes in your database during the import.
-
-Learn more about using the import script to [backfill your existing collection](https://github.com/meilisearch/firestore-meilisearch/blob/main/guides/IMPORT_EXISTING_DOCUMENTS.md).
-
-### Monitoring
-
-As a best practice, you can [monitor the activity](https://firebase.google.com/docs/extensions/manage-installed-extensions#monitor) of your installed extension, including checks on its health, usage, and logs.

package/PREINSTALL.md

@@ -1,42 +0,0 @@
-Use this extension to synchronize documents from a Cloud Firestore collection to a Meilisearch index. This allows you to use full-text search in your Cloud Firestore documents.
-
-This extension listens to each creation, update, or deletion of your documents to keep them in sync with your Meilisearch index. This ensures that the data in Meilisearch mirrors your content in Cloud Firestore. You can then run queries on this mirrored dataset.
-
-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.
-
-#### 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. There are many easy ways [to download and run a Meilisearch instance](https://docs.meilisearch.com/learn/getting_started/installation.html#download-and-launch)
-
-#### Data import format
-
-Documents indexed in Meilisearch must have a [unique id](https://docs.meilisearch.com/learn/core_concepts/documents.html#primary-field). The extension will use Firestone's default field: `Document ID` for this purpose. `Document ID` will be renamed  to`_firestore_id` to be used as the [document id](https://docs.meilisearch.com/learn/core_concepts/documents.html#document-id). If your documents  have another field containing the string `id`, it will not be set as the primary key.
-
-**Important:**  If your documents contain a field called `_firestore_id`, it will be ignored.
-
-[Geosearch](https://docs.meilisearch.com/reference/features/geosearch.html#geosearch) has a specific format in Meilisearch, your documents must have a valid `_geo` field with an object composed of `lat` and `lng`. If a `GeoPoint` from Firestore with the name `_geo` is found, the field `latitude` is renamed to `lat` and `longitude` to `lng`.
-If a `GeoPoint` is found without the name `_geo`, it is added as an array.
-
-#### Backfill your Meilisearch data
-
-This extension does not export all existing documents into Meilisearch unless they have been modified or created after its installation. You can run the [import script](https://github.com/meilisearch/firestore-meilisearch/) provided by this extension to retrieve your Meilisearch dataset with all the documents present in your Firestore collection
-
-#### Billing
-
-To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)
-
-* You will be charged a small amount (typically around $0.01/month) for the Firebase resources required by this extension, even if it is not used.
-* This extension uses other Firebase or Google Cloud services which may have
-  associated charges if you exceed the service’s free tier:
-  *   Cloud Firestore
-  *   Cloud Functions (Node.js 10+ runtime. [See FAQs](https://firebase.google.com/support/faq#extensions-pricing))
-
-When you use Firebase extensions, you're only charged for the underlying
-resources that you use. A paid-tier billing plan is only required if the
-extension uses a service that requires a paid-tier plan, for example calling
-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)

package/README.md

@@ -1,128 +0,0 @@
-<h1 align="center">firestore-meilisearch</h1>
-
-<p align="center">
-  <img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_firebase.svg" alt="Meilisearch-Firestore" width="200" height="200" />
-</p>
-
-<h1 align="center">Meilisearch Firestore</h1>
-
-<h4 align="center">
-  <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
-  <a href="https://docs.meilisearch.com">Documentation</a> |
-  <a href="https://slack.meilisearch.com">Slack</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>
-</h4>
-
-<p align="center">
-  <a href="https://github.com/meilisearch/firestore-meilisearch/actions"><img src="https://github.com/meilisearch/firestore-meilisearch/workflows/Tests/badge.svg" alt="Test"></a>
-  <a href="https://github.com/meilisearch/firestore-meilisearch/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
-  <a href="https://ms-bors.herokuapp.com/repositories/8"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
-</p>
-
-<p align="center">⚡ The Meilisearch API extension written for Firebase</p>
-
-# Search in your Firestore content with Meilisearch
-
-**Author**: Meilisearch (**[https://meilisearch.com](https://meilisearch.com)**)
-
-**Description**: Full-text Search on Firebase with Meilisearch
-
-**Details**: Use this extension to synchronize documents from a Cloud Firestore collection to a Meilisearch index. This allows you to use full-text search in your Cloud Firestore documents.
-
-This extension listens to each creation, update, or deletion of your documents to keep them in sync with your Meilisearch index. This ensures that the data in Meilisearch mirrors your content in Cloud Firestore. You can then run queries on this mirrored dataset.
-
-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.
-
-#### 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. There are many easy ways [to download and run a Meilisearch instance](https://docs.meilisearch.com/learn/getting_started/installation.html#download-and-launch)
-
-#### Data import format
-
-Documents indexed in Meilisearch must have a [unique id](https://docs.meilisearch.com/learn/core_concepts/documents.html#primary-field). The extension will use Firestone's default field: `Document ID` for this purpose. `Document ID` will be renamed  to`_firestore_id` to be used as the [document id](https://docs.meilisearch.com/learn/core_concepts/documents.html#document-id). If your documents  have another field containing the string `id`, it will not be set as the primary key.
-
-**Important:**  If your documents contain a field called `_firestore_id`, it will be ignored.
-
-[Geosearch](https://docs.meilisearch.com/reference/features/geosearch.html#geosearch) has a specific format in Meilisearch, your documents must have a valid `_geo` field with an object composed of `lat` and `lng`. If a `GeoPoint` from Firestore with the name `_geo` is found, the field `latitude` is renamed to `lat` and `longitude` to `lng`.
-If a `GeoPoint` is found without the name `_geo`, it is added as an array.
-
-#### Backfill your Meilisearch data
-
-This extension does not export all existing documents into Meilisearch unless they have been modified or created after its installation. You can run the [import script](https://github.com/meilisearch/firestore-meilisearch/) provided by this extension to retrieve your Meilisearch dataset with all the documents present in your Firestore collection
-
-#### Billing
-
-To install an extension, your project must be on the [Blaze (pay as you go) plan](https://firebase.google.com/pricing)
-
-* You will be charged a small amount (typically around $0.01/month) for the Firebase resources required by this extension, even if it is not used.
-* This extension uses other Firebase or Google Cloud services which may have
-  associated charges if you exceed the service’s free tier:
-  *   Cloud Firestore
-  *   Cloud Functions (Node.js 10+ runtime. [See FAQs](https://firebase.google.com/support/faq#extensions-pricing))
-
-When you use Firebase extensions, you're only charged for the underlying
-resources that you use. A paid-tier billing plan is only required if the
-extension uses a service that requires a paid-tier plan, for example calling
-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).
-
-* Collection path: What is the path of the collection you would like to export into Meilisearch?
-
-* Fields to index in Meilisearch: 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.
-
-* Meilisearch Index Name: What Meilisearch index do you want to index your data in?
-
-* Meilisearch host: What is the URL of the host of your Meilisearch database? Make sure your URL starts with `http://` or `https://`
-
-* Meilisearch API key: What is your Meilisearch API key with permission to perform actions on indexes? Both the API keys and the master key are valid choices but we strongly recommend using an API key for security purposes. Check out our guide on [security](https://docs.meilisearch.com/learn/security/master_api_keys.html).
-
-
-
-**Cloud Functions:**
-
-* **indexingWorker:** Cloud function triggered by document modification in Firestore to import changes into Meilisearch.
-
----
-
-## 🧩 Install this extension
-
-### Console
-
-[![Install this extension in your Firebase project](https://www.gstatic.com/mobilesdk/210513_mobilesdk/install-extension.png "Install this extension in your Firebase project")][install-link]
-
-[install-link]: https://console.firebase.google.com/project/_/extensions/install?ref=publisher_id/extension_name
-
-### Firebase CLI
-
-```bash
-firebase ext:install meilisearch/firestore-meilisearch --project=[your-project-id]
-```
-
-> Learn more about installing extensions in the Firebase Extensions documentation:
-> [console](https://firebase.google.com/docs/extensions/install-extensions?platform=console),
-> [CLI](https://firebase.google.com/docs/extensions/install-extensions?platform=cli)
-
----
-
-## ⚙️ Development Workflow and Contributing
-
-Any new contribution is more than welcome in this project!
-
-If you want to know more about the development workflow or wish to contribute, please see our [contributing guidelines](/CONTRIBUTING.md) for detailed instructions!
-
-<hr>
-
-**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you wish to contribute, make suggestions, or want to know what's going on right now, visit the [integration-guides](https://github.com/meilisearch/integration-guides) repository.

package/bors.toml

@@ -1,8 +0,0 @@
-status = [
-  'linter',
-  'integration-tests (14)',
-  'integration-tests (16)',
-  'integration-tests (17)'
-]
-# 1 hour timeout
-timeout-sec = 3600