npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@grammyjs/storage-firestore

v2.4.2

Published

Google Firestore storage adapter for grammY

Downloads

1,777

Readme

Google Firestore storage adapter for grammY

Storage adapter that can be used to store your session data on Google Cloud Firestore when using sessions.

Installation

npm install @grammyjs/storage-firestore --save

You should also have @google-cloud/firestore installed.

Introduction

Set up your Firestore database by following https://cloud.google.com/firestore/docs/quickstart-servers#node.js.

You should now have:

  1. A project ID for you google cloud project
  2. A keyfile containing the firestore authentication credentials
  3. A Telegram bot token

Put those values into the following example code:

import { Bot, Context, session, SessionFlavor } from "grammy";
import { adapter } from "@grammyjs/storage-firestore";
import { Firestore } from "@google-cloud/firestore";

interface SessionData {
  counter: number;
}
type MyContext = Context & SessionFlavor<SessionData>;

// Connect to Firestore
const db = new Firestore({
  // adjust these values:
  projectId: "YOUR_PROJECT_ID",
  keyFilename: "firestore-keyfile.json",
});

// Create bot and register session middleware
const bot = new Bot<MyContext>("");
bot.use(
  session({
    initial: () => ({ counter: 0 }),
    storage: adapter(db.collection("sessions")),
  })
);

// Register your usual middleware, and start the bot
bot.command("stats", (ctx) =>
  ctx.reply(`Already got ${ctx.session.counter} photos!`)
);
bot.on(":photo", (ctx) => ctx.session.counter++);

bot.start();

On firestore, you are billed per operation. If your bot does not need the session data for most of the messages it processes, this would cause a lot of superfluous reads and writes. Imagine your bot is in a group chat where it only counts photos but otherwise ignores all messages. Then it would not make sense to retrieve the session data for every request, and to write back the identical data. The solution is to use the built-in lazy mode of grammY, so just replace bot.use(session ...) by bot.use(lazySession ...), and remember to await ctx.session whenever you use it. You must also flavor your context with LazySessionFlavor instead of just SessionFlavor.