Code Monkey home page Code Monkey logo

skeet-firestore's Introduction

Skeet Framework Logo

Follow @ELSOUL_LABO2

Skeet Framework Plugin - Firestore

Skeet Firestore Plugin for CRUD Firestore operation with Firestore Converter. Type safe, easy to use, and easy to test. This plugin is for serverside with Firebase Admin SDK. (Client side helper functions for Firestore is in ./lib/skeet/firestore on the Skeet Client)

Installation

$ skeet yarn add -p @skeet-framework/firestore

or

$ yarn add @skeet-framework/firestore

Skeet Firestore Docs

Features

All CRUD operations are supported with Firestore Converter. createdAt and updatedAt are automatically added to the document with Firebase ServerTimestamp.

  • Add Collection Item
  • Adds Collection Items
  • Get Collection Item
  • Query Collection Items
  • Update Collection Item
  • Delete Collection Item

Usage

Initialize

import * as admin from 'firebase-admin'

admin.initializeApp()

Add Collection Item

import { firestore } from 'firebase-admin'
import { add } from '@skeet-framework/firestore'

const db = firestore()
const data: User = {
  name: 'John Doe',
  age: 30,
}

async function run() {
  try {
    const path = 'Users'
    const docRef = await add<User>(db, path, data)
    console.log(`Document added with ID: ${docRef.id}`)
  } catch (error) {
    console.error(`Error adding document: ${error}`)
  }
}

run()

Adds Collection Items

import { firestore } from 'firebase-admin'
import { adds } from '@skeet-framework/firestore'

const db = firestore()
const users: User[] = [
  { name: 'John Doe', age: 30 },
  { name: 'Jane Smith', age: 25 },
  // ... more users ...
]

async function run() {
  try {
    const path = 'Users'
    const results = await adds<User>(db, path, users)
    console.log(`Added ${users.length} users in ${results.length} batches.`)
  } catch (error) {
    console.error(`Error adding documents: ${error}`)
  }
}

run()

Get Collection Item

import { firestore } from 'firebase-admin'
import * as admin from 'firebase-admin'
import { get } from '@skeet-framework/firestore'

const db = admin.firestore()
async function run() {
  try {
    const path = 'Users'
    const docId = 'user123'
    const user = await get<User>(db, path, docId)
    console.log(`User: ${JSON.stringify(user)}`)
  } catch (error) {
    console.error(`Error getting document: ${error}`)
  }
}

run()

Query Collection Items

import { firestore } from 'firebase-admin'
import * as admin from 'firebase-admin'
import { query, QueryCondition } from '@skeet-framework/firestore'

const db = admin.firestore()

// Simple query to get users over 25 years old
const simpleConditions: QueryCondition[] = [
  { field: 'age', operator: '>', value: 25 },
]

// Advanced query to get users over 25 years old, ordered by desc
// Limitations: If you include a filter with a range comparison (<, <=, >, >=), your first ordering must be on the same field
// So we can't use multiple fields with a range comparison for now.
// https://firebase.google.com/docs/firestore/query-data/order-limit-data
const advancedConditions: QueryCondition[] = [
  { field: 'age', operator: '>', value: 25 },
  { field: 'age', orderDirection: 'desc' },
]

// Query to get users over 25 years old and limit the results to 5
const limitedConditions: QueryCondition[] = [
  { field: 'age', operator: '>', value: 25 },
  { limit: 5 },
]

async function run() {
  try {
    const path = 'Users'

    // Using the simple conditions
    const usersByAge = await query<User>(db, path, simpleConditions)
    console.log(`Found ${usersByAge.length} users over 25 years old.`)

    // Using the advanced conditions
    const orderedUsers = await query<User>(db, path, advancedConditions)
    console.log(
      `Found ${orderedUsers.length} users over 25 years old, ordered by name.`
    )

    // Using the limited conditions
    const limitedUsers = await query<User>(db, path, limitedConditions)
    console.log(
      `Found ${limitedUsers.length} users over 25 years old, limited to 5.`
    )
  } catch (error) {
    console.error(`Error querying collection: ${error}`)
  }
}

run()

Update Collection Item

import { firestore } from 'firebase-admin'
import * as admin from 'firebase-admin'
import { update } from '@skeet-framework/firestore'

const db = admin.firestore()
const updatedData: User = {
  age: 38,
}

async function run() {
  try {
    const path = 'Users'
    const docId = '123456'
    const success = await update<User>(db, path, docId, updatedData)
    if (success) {
      console.log(`Document with ID ${docId} updated successfully.`)
    }
  } catch (error) {
    console.error(`Error updating document: ${error}`)
  }
}

run()

Delete Collection Item

import { firestore } from 'firebase-admin'
import * as admin from 'firebase-admin'
import { delete } from '@skeet-framework/firestore'

async function run() {
  try {
    const path = 'Users'
    const docId = '123456'
    const success = await delete(db, path, docId)
    if (success) {
      console.log(`Document with ID ${docId} deleted successfully.`)
    }
  } catch (error) {
    console.error(`Error deleting document: ${error}`)
  }
}

Skeet Framework Document

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/elsoul/skeet This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The package is available as open source under the terms of the Apache-2.0 License.

Code of Conduct

Everyone interacting in the SKEET project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

skeet-firestore's People

Contributors

euledge avatar kishithemechanic avatar poppin-fumi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

euledge

skeet-firestore's Issues

Incorrect usage example of advancedConditions

READMEにある advancedConditionsの条件で ageとnameの複合条件の例示がありますが
テストの中のコメントと一致していないと思います。

README

{ field: 'name', orderDirection: 'asc' },

テスト内のコメント

// Limitations: If you include a filter with a range comparison (<, <=, >, >=), your first ordering must be on the same field

Some environment has timestamp related error with add method

Only skeet-solana-mobile template web front end has this issue.
elsoul/skeet-solana-mobile-stack#47

skeet functions + add method from @skeet-framework/firestore didn't work suddenly.
Before it worked well. (This repository didn't updated for this moment thought)

Also asking for Firebase support team.

>  Error: Error adding document: Error: Value for argument "data" is not a valid Firestore document. Couldn't serialize object of type "rme" (found in field "createdAt"). Firestore doesn't support JavaScript objects with custom prototypes (i.e. objects that were created via the "new" operator).
>      at Poa (/Users/ktm/dev/skeet-solana-mobile-stack/functions/skeet/dist/index.js:1324:711)
>      at /Users/ktm/dev/skeet-solana-mobile-stack/functions/skeet/dist/index.js:1353:1058
>      at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
>      at async runFunction (/Users/ktm/dev/skeet-solana-mobile-stack/node_modules/firebase-tools/lib/emulator/functionsEmulatorRuntime.js:506:9)
>      at async runHTTPS (/Users/ktm/dev/skeet-solana-mobile-stack/node_modules/firebase-tools/lib/emulator/functionsEmulatorRuntime.js:531:5)
>      at async /Users/ktm/dev/skeet-solana-mobile-stack/node_modules/firebase-tools/lib/emulator/functionsEmulatorRuntime.js:694:21

need client Api with Firestore Security Rule

クライアント側からアクセス可能なプラグインがあると嬉しい

Details of Improvement

このプラグインは、Admin SDKを用いて実装されているため FirestoreのSecurty Ruleを無視してアクセスすることが可能になっています。

バックエンドで行う想定のプラグインだとは思いますが、クライアント APIを使用すれば、クライアントからSecurity Ruleで制御された安全なアクセスが可能になります。

Reference, Snapshotをチェーンして必要なデータを取得するのはAdmin SDKと同じように煩雑な操作があり毎回書くのは面倒と感じます。

Expected behavior

  • 現在のインタフェースと同様な(Firestore Converter、型安全)クライアントAPIを用いてSecurity Ruleによって制御されているプラグインが提供されると嬉しい

Reference

https://firebase.google.com/docs/reference/js/firestore_?hl=ja

We want to force code format before commit

Details of Improvement

I want to prevent the coding style from being different in the developer's environment when committing the source code.
I committed without formatting in #18, Reviewer had to format it again.

Expected behavior

  • Use the pre-commit hook to automatically run prettier before committing so everyone commits with the same code style.

Reference

not installed eslint plugins

Details of Improvement

  • The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in ".eslintrc.json".

Details

ESLint: 8.27.0

ESLint couldn't find the plugin "@typescript-eslint/eslint-plugin".

(The package "@typescript-eslint/eslint-plugin" was not found when loaded as a Node module from the directory "/workspaces/skeet-dev/skeet-firestore".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

    npm install @typescript-eslint/eslint-plugin@latest --save-dev

The plugin "@typescript-eslint/eslint-plugin" was referenced from the config file in ".eslintrc.json".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

[Question] document html write one line is code format rule in this project

以下のように、documentのhtmlで改行なしに1行で書いているのは意図してのことでしょうか?

image

今のprettierの設定だと、強制的に改行してしまうので、この書き方を保つのならばformatさせないように .prettierignore に含めたほうが良いと思います。

  • yarn format だと.prettierignoreにないのでhtmlもフォーマットされてしまう。
.next
out
dist
build
src/__generated__
src/schema.graphql
  • lint-stagedによるコミット時のhookにはhtmlは含まれないのでフォーマットされない。
  "lint-staged": {
    "*.{ts,css,md}": "prettier --write"
  }

README still refers to it as delete.

Details of Improvement

In v2.3.2, the alias of deleteCollectionItem has been changed to remove, but the README description has not been updated and still says delete.

ScreenShot

image

Expected behavior

  • The README description should be updated correctly.

add test methods for adds, query, update, delete

Details of Improvement

  • I want to adds test method (Add, Query, Update, Delete).

Reference Issue

#9

Expected behavior

implements tests below

  • Adds Collection Items
  • Get Collection Item
  • Query Collection Items
  • Update Collection Item
  • Delete Collection Item

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.