firestore-meilisearch 0.1.0

package/.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 80
+quote_type = single
+
+[*.{js,ts}]
+quote_type = single
+curly_bracket_next_line = false
+spaces_around_brackets = inside
+indent_brace_style = BSD KNF

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug Report 🐞
+about: Create a report to help us improve.
+title: ''
+labels: ''
+assignees: ''
+---
+
+<!-- This is not an exhaustive model but a help. No step is mandatory. -->
+
+**Description**
+Description of what the bug is about.
+
+**Expected behavior**
+What you expected to happen.
+
+**Current behavior**
+What happened.
+
+**Screenshots or Logs**
+If applicable, add screenshots or logs to help explain your problem.
+
+**Environment (please complete the following information):**
+- OS: [e.g. Debian GNU/Linux]
+- Meilisearch version: [e.g. v.0.20.0]
+- firestore-meilisearch version: [e.g v0.1.0]

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,18 @@
+---
+name: Feature Request 💡
+about: Suggest a new idea for the project.
+title: ''
+labels: ''
+assignees: ''
+---
+
+<!-- This is not an exhaustive model but a help. No step is mandatory. -->
+
+**Description**
+Brief explanation of the feature.
+
+**Basic example**
+If the proposal involves something new or a change, include a basic example. How would you use the feature? In which context?
+
+**Other**
+Any other things you want to add.

package/.github/ISSUE_TEMPLATE/other.md

@@ -0,0 +1,7 @@
+---
+name: Other
+about: Any other topic you want to talk about.
+title: ''
+labels: ''
+assignees: ''
+---

package/.github/dependatbot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+- package-ecosystem: 'npm'
+  directory: '/'
+  schedule:
+    interval: weekly
+    time: "04:00"
+  open-pull-requests-limit: 10
+  labels:
+  - skip-changelog
+  - dependencies
+  ignore:
+  - dependency-name: 'eslint*'
+  - dependency-name: 'prettier*'
+  rebase-strategy: disabled
+- package-ecosystem: github-actions
+  directory: '/functions'
+  schedule:
+    interval: weekly
+    time: "04:00"
+  labels:
+    - skip-changelog
+    - dependencies

package/.github/release-draft-template.yml

@@ -0,0 +1,33 @@
+name-template: 'v$RESOLVED_VERSION 🔥'
+tag-template: 'v$RESOLVED_VERSION'
+exclude-labels:
+  - 'skip-changelog'
+version-resolver:
+  minor:
+    labels:
+      - 'breaking-change'
+  default: patch
+categories:
+  - title: '⚠️ Breaking changes'
+    label: 'breaking-change'
+  - title: '🚀 Enhancements'
+    label: 'enhancement'
+  - title: '🐛 Bug Fixes'
+    label: 'bug'
+  - title: '🔒 Security'
+    label: 'security'
+template: |
+  $CHANGES
+
+  Thanks again to $CONTRIBUTORS! 🎉
+no-changes-template: 'Changes are coming soon 😎'
+sort-direction: 'ascending'
+replacers:
+  - search: '/(?:and )?@dependabot-preview(?:\[bot\])?,?/g'
+    replace: ''
+  - search: '/(?:and )?@dependabot(?:\[bot\])?,?/g'
+    replace: ''
+  - search: '/(?:and )?@bors(?:\[bot\])?,?/g'
+    replace: ''
+  - search: '/(?:and )?@meili-bot,?/g'
+    replace: ''

package/.github/scripts/check-release.sh

@@ -0,0 +1,42 @@
+#!/bin/sh
+
+# Checking if current tag matches the package version
+current_tag=$(echo $GITHUB_REF | cut -d '/' -f 3 | tr -d ' ',v)
+package_file_tag=$(grep '"version":' package.json | cut -d ':' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
+package_function_tag=$(grep '"version":' functions/package.json | cut -d ':' -f 2- | tr -d ' ' | tr -d '"' | tr -d ',')
+extension_tag=$(grep "version:" extension.yaml | cut -d ":" -f 2- | tr -d " " )
+version_js_tag=$(grep "version =" functions/src/version.ts | cut -d "=" -f 2- | tr -d " " | tr -d "'" )
+version_ts_tag=$(grep "version =" functions/lib/version.js | cut -d "=" -f 2- | tr -d " "| tr -d "'" | tr -d ";" | tail -n1 )
+
+if [ "$current_tag" != "$package_file_tag" ]; then
+  echo "Error: the current tag does not match the version in package file."
+  echo "$current_tag vs $package_file_tag"
+  exit 1
+fi
+
+if [ "$current_tag" != "$package_function_tag" ]; then
+  echo "Error: the current tag does not match the version in package file inside the function directory."
+  echo "$current_tag vs $package_function_tag"
+  exit 1
+fi
+
+if [ "$current_tag" != "$extension_tag" ]; then
+  echo "Error: the current tag does not match the version in the extension file."
+  echo "$current_tag vs $extension_tag"
+  exit 1
+fi
+
+if [ "$current_tag" != "$version_ts_tag" ]; then
+  echo "Error: the current tag does not match the version in the version.ts file."
+  echo "$current_tag vs $version_ts_tag"
+  exit 1
+fi
+
+if [ "$current_tag" != "$version_js_tag" ]; then
+  echo "Error: the current tag does not match the version in the version.js file, you need to build the package."
+  echo "$current_tag vs $version_js_tag"
+  exit 1
+fi
+
+echo 'OK'
+exit 0

package/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: publish to npm
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+      - name: Check release validity
+        run: sh .github/scripts/check-release.sh
+      - name: Install dependencies
+        run: yarn && yarn install:functions
+      - name: Enter functions directory
+        run: cd functions
+      - name: Publish with latest tag
+        if: "!github.event.release.prerelease"
+        run: npm publish .
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - name: Publish with beta tag
+        if: "github.event.release.prerelease"
+        run: npm publish . --tag beta
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/.github/workflows/release-drafter.yml

@@ -0,0 +1,16 @@
+name: Release Drafter
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        with:
+          config-name: release-draft-template.yml
+        env:
+          GITHUB_TOKEN: ${{ secrets.RELEASE_DRAFTER_TOKEN }}

package/.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    # trying and staging branches are for BORS config
+    branches:
+      - trying
+      - staging
+      - main
+
+jobs:
+  linter:
+    name: linter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - name: Install dependencies
+        run: yarn install:functions
+      - name: Run style check
+        run: yarn lint
+
+  integration-tests:
+    name: integration-tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: ["14", "16", "17"]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install dependencies
+        run: yarn install:functions
+      - name: Run tests with coverage
+        run: yarn test:coverage

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Version 0.1.0
+
+Initial release of the _Search in your Firestore content with Meilisearch_ extension.

package/CONTRIBUTING.md

@@ -0,0 +1,236 @@
+# 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 ❤️