@wolfstar/shared-http-pieces

The shared commands and pieces used by Star Network's HTTP-only bots.

Description

The shared commands used for Star Network's HTTP-only bots.

Setup

• Define locales/{{lng}}/commands/shared:infoEmbedDescription as a string. This is the content displayed in /info's embed description.
• Define the information variables.
• Importing @wolfstar/shared-http-pieces/register registers a preGenericsInitialization hook that adds this package's bundled locales and commands/shared namespace to your Client's i18n configuration automatically, while retaining the consumer's own locale path and namespaces. As long as it's imported before new Client(...) — before or after @wolfstar/plugin-i18next/register, which the Stars CLI injects on its own — no manual wiring is required. The resolved path is also exported as localesPath, if you need it directly.

As a module

Instead of importing register, list the package in modules in stars.config (it needs @wolfstar/kit, an optional peer dependency):

// stars.config.ts
import { defineConfig } from '@wolfstar/http-framework/config';

export default defineConfig({ modules: ['@wolfstar/shared-http-pieces'] });

The module adds this package's locales with ctx.addLocales (the generated stars:locales plugin merges them into the i18n option before @wolfstar/plugin-i18next builds its handler, keeping the project's own languages) and registers the @wolfstar/shared-http-pieces/pieces plugin, which loads the shared commands and listeners and the plugin's own register entrypoint. Importing @wolfstar/shared-http-pieces/register keeps working; use one or the other, not both. Sentry and the information variables below are set up the same way either way.

Usage

You can either register after setting environment parameters:

process.env.CLIENT_REPOSITORY = 'https://github.com/wolfstar-project/wolfstar';
process.env.CLIENT_INVITE =
	'https://discord.com/oauth2/authorize?client_id=266624760782258186&permissions=534185897078&scope=bot%20applications.commands';

import '@wolfstar/shared-http-pieces/register';

Or import its utilities as well as registering:

import { setRepository, setInvite } from '@wolfstar/shared-http-pieces';
import '@wolfstar/shared-http-pieces/register';

setRepository('wolfstar'); // setRepository('https://github.com/wolfstar-project/wolfstar');
setInvite('266624760782258186', '534185897078');

Furthermore, error handling can be enabled by setting the SENTRY_DSN, @wolfstar/shared-http-pieces includes a way to register Sentry and registers handlers to handle errors into Sentry. The plugin also reads SENTRY_ROOT to set RewriteFrames's root, defaults to process.cwd().