https://github.com/mikaelvesavuori/triplecheck-repository-firestore

Database utility for using Firestore with TripleCheck broker.
https://github.com/mikaelvesavuori/triplecheck-repository-firestore

broker consumer-contracts consumer-driven-contracts contract-testing firestore pacts triplecheck

Last synced: about 2 months ago
JSON representation

Database utility for using Firestore with TripleCheck broker.

• Host: GitHub
• URL: https://github.com/mikaelvesavuori/triplecheck-repository-firestore
• Owner: mikaelvesavuori
• License: mit
• Created: 2021-04-25T12:18:08.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-05T00:03:38.000Z (over 1 year ago)
• Last Synced: 2025-01-16T16:22:18.650Z (4 months ago)
• Topics: broker, consumer-contracts, consumer-driven-contracts, contract-testing, firestore, pacts, triplecheck
• Language: TypeScript
• Homepage:
• Size: 1.19 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# triplecheck-repository-firestore

![TripleCheck database repository](readme/triplecheck-repository.png)

## TripleCheck: Firestore database repository

Database utility for using Firestore with TripleCheck broker. It implements the repository base at [triplecheck-core](https://github.com/mikaelvesavuori/triplecheck-core).

## Instructions

In your `triplecheck-broker` implementation, do a regular import for `triplecheck-repository-firestore` and pass the repository to the broker. A basic implementation could look like:

```TypeScript

import { FirestoreRepository } from 'triplecheck-repository-firestore';

import { TripleCheckBroker } from 'triplecheck-broker';

// If inside Google Cloud Platform:

// Pass the repo your Firestore configuration and the collection name

const repository = FirestoreRepository(undefined, "your-database-name");

// If outside Google Cloud Platform:

// Pass the repo your Firestore configuration and the collection name

// Keyfile/config only needed when running outside of GCP context

// @see https://cloud.google.com/firestore/docs/quickstart-servers

const repository = FirestoreRepository({

  projectId: 'your-project-id',

  keyFilename: 'keyfile.json'

}, "your-database-name");

const request = "Get this from your API request and transform it as needed";

const payload = "Body";

const { responseData, status, headers } = await TripleCheckBroker(

  request,

  payload,

  repository

);

```