vlad-iakovlev / grammy-named-session

Named session for grammY

grammy-named-session

Named session for grammY. Works the same way as built-in session but allows you to set custom name for data access.

How to install

npm install grammy-named-session

How to use

import { Bot, Context } from 'grammy';
import { namedSession } from 'grammy-named-session';

interface Item {
  id: string
  value: string
}

interface MyState {
  items: Item[]
  users: Record<number, string>
}

interface MyContext extends Context {
  myState: MyState
}

const myStateMiddleware = (dirName: string) => {
  return namedSession<MyContext, 'myState'>({
    // type MaybePromise<T> = Promise<T> | T

    // Initial data, required
    // (ctx: MyContext) => MaybePromise<MyContext['myState']>
    getInitial: () => ({
      items: [],
      users: {},
    }),

    // Session key, required
    // (ctx: MyContext) => MaybePromise<string | undefined>
    getSessionKey: (ctx) =>
      ctx.chat?.id === undefined ? undefined : `my_${ctx.chat.id}`,

    // Storage adapter, required
    // (ctx: MyContext) => MaybePromise<StorageAdapter<MyContext['myState']>>
    getStorage: () => new FileAdapter({ dirName }),

    // Access name, must be the same as in the types, required
    // string
    name: 'myState',
  })
}

(async () => {
  const bot = new Bot<MyContext>('<bot-token>');

  bot.use(myStateMiddleware('db/v1'));

  bot.command('start', async (ctx) => {
    // Access data as usual but with custom name
    await ctx.mySession.users[ctx.from.id] = ctx.from.first_name;
  });
})()

grammy-named-session's Issues

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch main on the remote Git repository with URL https://[secure]@github.com/vlad-yakovlev/grammy-named-session.git.

This can be caused by:

• a misconfiguration of the repositoryUrl option
• the repository being unavailable
• or missing push permission for the user configured via the Git credentials on your CI environment

---

Good luck with your project ✨

Your semantic-release bot 📦🚀