Hey everyone! Today we have very special news for you all: We're changing our logo!
Why?
You see, on today's standards, having a simple logo is essential. Our logo aligns perfectly with these design principles but it can always be improved.
+
New logo!
Hey everyone! Today we have very special news for you all: We're changing our logo!
Why?
You see, on today's standards, having a simple logo is essential. Our logo aligns perfectly with these design principles but it can always be improved.
We were chilling, you know, cooking sern handler v3, sern gui, npm create @sern/bot and serncord when we thought about changing the logo to a sleek design with less colors.
And here we are!
Who did our new branding?
Ropox!
Bro's the GOAT. This website is maintained by him, the domain costs are funded by him and also he started brainstorming how the logo would be on paper:
@@ -22,10 +24,10 @@
And there it all clicked:
seren tried by the way!
-
Anyways, here it is:
Pretty nice!
By the way, we have animations and variations on the way, so make sure to stay updated in the discord server!
Finally, from the entire sern team, thank you for sticking around ❤️
Release 3.0.0
3.0 Release
Join our discord
Features
Dependency Management
ServiceAPI (recommended to use this over useContainer hooks)- Dependencies type must be globally augmented in order for Services api to function properly
- new methods on ModuleManager
- getPublishableCommands()
- Init Hooks
- implement starting behavior for dependencies
- To enforce and type check this, use the
Initializabletype when making your Dependencies type!
- Emitter interface
- More generic interface to define any event emitter
- You can now swap out the SernEmitter with whatever emitter now.
class DatabaseService implements Init {
//some hypothetical database
_pgsql : database()
async init() {
await _pgsql.load()
}
}
await makeDependencies({
build: root => root.add({
db: new DatabaseService() //will be init'ed automatically
})
})
- new SernEmitter event
modulesLoaded, which allows users to customize behavior after all modules are loaded!
export default eventModule({
name: 'modulesLoaded',
type: EventType.Sern,
execute: () => {
console.log('All modules loaded')
}
})
Quality of Life
faster module loading
- I utilize async generators for reading files now. A lot faster than the first iteration.
better error handling
Less boilerplate
- Services api cleans up v2 boilerplate
class modules devex got upgraded and work better than before
automatically ignore any files not ending in (mts, cts, mjs, cjs, ts, js)
- ignore commands and events with
!prefix on filename or directory (ie:!filename.tsor!directorywill be ignored by sern)
- ignore commands and events with
ServiceAPI (recommended to use this over useContainer hooks)- Dependencies type must be globally augmented in order for Services api to function properly
Less boilerplate
new methods on ModuleManager
automatically ignore any files not ending in (mts, cts, mjs, cjs, ts, js)
- ignore commands / events with
!prefix on filename or directory (ie:!filename.tsor!directory)
- ignore commands / events with
new SernEmitter event
modulesLoaded, which allows users to customize behavior after all modules are loaded!Init Hooks
- implement starting behavior for dependencies
Experimental
- Experimental things may be subject to removal, need feedback and are not guaranteed stable
- dev / prod mode
- sern will behave differently depending on mode set
- init sern from
fileoption- reads from local sern.config.json
Sern.init('file');
Breaking changes
- Sern.makeDependencies -> makeDependencies
- it is asynchronous and top level function now. Make sure to await it before initing for proper synchronization.
- module store and manager internally changed, so those using them may recieve breaking changes
- BaseOptions type removed
- Sern.makeDependencies({ build: () => {} })
+ await makeDependencies({ build: () => {} })
Deprecations
- Removed all previous marked deprecations in v3
- ModuleStore will be removed as a dependency in v4. The only way to access modules should be through ModuleManager
- Default Dependencies will be made internal in the v4. Users should only have access to its interface / contract
Release 2.5.0
2.5 Release
Join our discord
- Thank you for using sern in your projects. It's only going to get better!
- I apologize for the sudden small breaking change. After this update, there won't be any for a while.
+
Anyways, here it is:
Pretty nice!
By the way, we have animations and variations on the way, so make sure to stay updated in the discord server!
Finally, from the entire sern team, thank you for sticking around ❤️
Release 3.0.0
3.0 Release
Join our discord
Features
Dependency Management
ServiceAPI (recommended to use this over useContainer hooks)- Dependencies type must be globally augmented in order for Services api to function properly
- new methods on ModuleManager
- getPublishableCommands()
- Init Hooks
- implement starting behavior for dependencies
- To enforce and type check this, use the
Initializabletype when making your Dependencies type!
- Emitter interface
- More generic interface to define any event emitter
- You can now swap out the SernEmitter with whatever emitter now.
class DatabaseService implements Init {
//some hypothetical database
_pgsql : database()
async init() {
await _pgsql.load()
}
}
await makeDependencies({
build: root => root.add({
db: new DatabaseService() //will be init'ed automatically
})
})
- new SernEmitter event
modulesLoaded, which allows users to customize behavior after all modules are loaded!
export default eventModule({
name: 'modulesLoaded',
type: EventType.Sern,
execute: () => {
console.log('All modules loaded')
}
})
Quality of Life
faster module loading
- I utilize async generators for reading files now. A lot faster than the first iteration.
better error handling
Less boilerplate
- Services api cleans up v2 boilerplate
class modules devex got upgraded and work better than before
automatically ignore any files not ending in (mts, cts, mjs, cjs, ts, js)
- ignore commands and events with
!prefix on filename or directory (ie:!filename.tsor!directorywill be ignored by sern)
- ignore commands and events with
ServiceAPI (recommended to use this over useContainer hooks)- Dependencies type must be globally augmented in order for Services api to function properly
Less boilerplate
new methods on ModuleManager
automatically ignore any files not ending in (mts, cts, mjs, cjs, ts, js)
- ignore commands / events with
!prefix on filename or directory (ie:!filename.tsor!directory)
- ignore commands / events with
new SernEmitter event
modulesLoaded, which allows users to customize behavior after all modules are loaded!Init Hooks
- implement starting behavior for dependencies
Experimental
- Experimental things may be subject to removal, need feedback and are not guaranteed stable
- dev / prod mode
- sern will behave differently depending on mode set
- init sern from
fileoption- reads from local sern.config.json
Sern.init('file');
Breaking changes
- Sern.makeDependencies -> makeDependencies
- it is asynchronous and top level function now. Make sure to await it before initing for proper synchronization.
- module store and manager internally changed, so those using them may recieve breaking changes
- BaseOptions type removed
- Sern.makeDependencies({ build: () => {} })
+ await makeDependencies({ build: () => {} })
Deprecations
- Removed all previous marked deprecations in v3
- ModuleStore will be removed as a dependency in v4. The only way to access modules should be through ModuleManager
- Default Dependencies will be made internal in the v4. Users should only have access to its interface / contract
Release 2.5.0
2.5 Release
Join our discord
- Thank you for using sern in your projects. It's only going to get better!
- I apologize for the sudden small breaking change. After this update, there won't be any for a while.
Wow! We're increasing our semantic versioning by
+0.3.9
What does this mean?
Breaking changes
- controller parameter for plugins has been removed
- You'll need to import it instead
- This breaks old CommandPlugin, but not old EventPlugin
Deprecations
- CommandPlugin and EventPlugin have been renamed InitPlugin and ControlPlugin
Reason
- The naming of plugins was getting too complex. For example, plugin naming evolved into CommandModuleCommandPlugin, CommandModuleEventPlugin and more.
- I realize that this affects all plugins. I have updated all plugins to match these changes
- The old way of declaring plugins has been deprecated in favor of newer functions that facilitate and ease typings
- CommandControlPlugin
- CommandInitPlugin
- EventControlPlugin
- EventInitPlugin
- DiscordEventControlPlugin -This will probably be the last breaking change in a while. Thanks for using sern!
Release 2.0.0
Release 2.0.0
2.0 Release
Join our discord!
Wow! We're finally increasing our semantic versioning by +1.7.9.
What does this mean?
Plugin Support for Event Modules
You can now use plugins for event modules. Previous version would throw an error if the
plugins field was populated.
export function commandPlTest() : SernEmitterPlugin {
return {
type: PluginType.Command,
execute: ({ mod}, controller) => {
if(mod.name === 'module.register') {
console.log('Event Module created correctly')
return controller.next()
}
console.log('event name is wrong')
return controller.stop()
}
}
}
Applying this plugin to some eventModule:
export default eventModule({
name: 'error',
type: EventType.Sern,
plugins: [commandPlTest()],
execute(m) {
console.log(m)
},
})
Dependency Injection and Decoupling
The powerful npm package iti decouples sern even more.
@@ -40,16 +42,16 @@ from anywhere.
New CommandTypes
2.0 includes all the new role select menus. CommandType.MenuSelect has been renamed into
CommandType.StringSelect. The remaining SelectMenus are
CommandType.RoleSelect, CommandType.ChannelSelect, CommandType.UserSelect, CommandType.MentionableSelect
export default commandModule({
type: CommandType.RoleSelect,
execute(ctx) {
ctx.reply('role select')
},
})
In addition, commandModules with ContextMenus have been renamed.
- CommandType.MenuUser, CommandType.MenuMsg
+ CommandType.CtxUser, CommandType.CtxMsg
Typings Simplification
Pre 2.0:
Post 2.0:
CommandPlugin<T> and EventPlugin<T> typings have also been static'ified, transformed from types to interfaces
Breaking Changes
All deprecation warnings from previous versions have taken effect, and are removed in 2.0.
- type Module = EventModule | CommandModule
+ type AnyModule = EventModule | CommandModule
-export type SpreadParams<T extends (...args: never) => unknown> = (
- args: Parameters<T>[number],
- ) => unknown;
Override type has been removed due to redundancy
- discord.js : 14.5
+ discord.js : 14.7
-typescript: 4.7
+ typescript: 4.9
+ interface Wrapper {
+ readonly defaultPrefix?: string;
+ readonly commands: string;
+ readonly events?: string;
+ readonly containerConfig : {
+ get: (...keys: (keyof Dependencies)[]) => unknown[];
+ }
+}
- interface Wrapper {
- readonly client: Client;
- readonly sernEmitter?: SernEmitter;
- readonly defaultPrefix?: string;
- readonly commands: string;
- readonly events?:
- | string
- | { mod: EventModule; absPath: string }[]
- | (() => { mod: EventModule; absPath: string }[]);
-}
+ DefaultLogger
+ DefaultModuleManager
+ SernEmitter
+ DefaultErrorHandling
+ type Singleton<T> = () => T
+ type Transient<T> = () => () => T;
+ type LogPayload<T = unknown> = { message: T }
+ export const single = <T>() => T
+ export const many = <T>() => () => T
Including the previous section, some names to symbols and data structures were altered to -be better represented. view changelog
Context refactoring
The context data structure has been internally altered to represent its dynamics better.
How to get started with sern!
Hello everyone!
I'm Sr Izan, your fellow user and contributor.
Today I'm going to show you how to get started with sern and all its cool features.
Step 1: Install the CLI.
Install the CLI:
npm i -g @sern/cli
and then run
sern init
You can also run sern init -y if you want to use the default options.
The CLI is written in Typescript and open-sourced on Github. (thanks evo!)
Step 2: Have some way to store secrets.
Normally you'd need a way to store secrets, and the best way to do that is by installing another package: dotenv
just npm i dotenv in the project folder and add require('dotenv').config() to your import section. Then, when you login, process.env.TOKEN (or however you have it named on your .env file) should do the trick.
If you're using ESM, configure dotenv with import 'dotenv/config' instead of require('dotenv').config().
And... that's it?
Yes, that's it. Here's a little FAQ to get you started. You can also join the Discord for any problems.
Extra: Video tutorial!
FAQ
Q: How do I publish a slash command?
+be better represented. view changelog
Context refactoring
The context data structure has been internally altered to represent its dynamics better.
How to get started with sern!
Hello everyone!
I'm Sr Izan, your fellow user and contributor.
Today I'm going to show you how to get started with sern and all its cool features.
Step 1: Install the CLI.
Install the CLI:
npm i -g @sern/cli
and then run
sern init
You can also run sern init -y if you want to use the default options.
The CLI is written in Typescript and open-sourced on Github. (thanks evo!)
Step 2: Have some way to store secrets.
Normally you'd need a way to store secrets, and the best way to do that is by installing another package: dotenv
just npm i dotenv in the project folder and add require('dotenv').config() to your import section. Then, when you login, process.env.TOKEN (or however you have it named on your .env file) should do the trick.
If you're using ESM, configure dotenv with import 'dotenv/config' instead of require('dotenv').config().
And... that's it?
Yes, that's it. Here's a little FAQ to get you started. You can also join the Discord for any problems.
Extra: Video tutorial!
FAQ
Q: How do I publish a slash command?
A: Install the publish extension. Little video:
Q: Any snippet VSCode extension?
A: Yeah, just search sern Snippets made by a verified publisher called Sr Izan (haha yeah me funny!)
Q: HEEEELLLPPPP!!!!
-A: Hey, don't panic! We're here to help so, join the Discord. We're trying to get to 100 members!
Release 1.2.0
Release 1.2.0
Class-based modules
Today we're announcing the ability to create class based modules! To get started, install
npm install @sern/handler@latest
Quick List of changes!
Class based modules
Incorporate class based modules into your project instead of the traditional commandModule or eventModule
Extend the new CommandExecutable or EventExecutable
import { CommandType, CommandExecutable, type Args, type Context } from '@sern/handler';
import { publish } from '../plugins/publish.js';
import { serendipityOnly } from '../plugins/serendipityOnly.js';
export default class extends CommandExecutable<CommandType.Both> {
type = CommandType.Both as const;
description = 'What is the meaning of life?'
override onEvent = [
serendipityOnly()
];
override plugins = [
publish(),
];
execute = async (ctx: Context, args: Args) => {
await ctx.reply('42')
};
}
execute must not be a method of the class. It should be as above, a property on the class!
import { CommandType, EventExecutable, type EventType } from '@sern/handler';
import type { GuildMember } from 'discord.js'
export default class extends EventExecutable<EventType.Discord> {
type = EventType.Discord as const;
execute = (member: GuildMember) => {
console.log(member)
};
}
Now, you might ask why this feature was added.
Simply put, to give flexibility to the developers.
I believe that you should build your own structures however you might like and customize to your liking.
In addition, decorators now unofficially work with modules!
Feel free to use TypeScript experimental decorators to augment and customize your classes.
Deprecation Warnings
The next update will bring sern v2 with some important features. Here are some things to watch out for.
- Wrapper#client will be deprecated
- Wrapper#sernEmitter will be deprecated
- a SernEmitter will be automatically created once Sern#init is called
- The option to pass in a function or array for Wrapper#events will be deprecated. Only strings are accepted.
- Sern#addExternal will be deprecated in favor of a better way.
Dependencies Update
- TypeScript has been updated to 4.8.3
- Discord.js has been upgraded to 14.5