Skip to content

Clarify Plugin Lifecycle terminology to distinguish from database Triggers #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 3 commits into from
Closed

Clarify Plugin Lifecycle terminology to distinguish from database Triggers #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25940cd
Initial plan
Copilot Jan 24, 2026
7a4a845
Clarify Plugin Lifecycle terminology to avoid confusion with Triggers
Copilot Jan 24, 2026
0989ab9
删除 HOOK_TRIGGER_CLARIFICATION.md
hotlong Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions packages/spec/src/system/plugin.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { describe, it, expect } from 'vitest';
import {
PluginContextSchema,
import {
PluginContextSchema,
PluginLifecycleSchema,
PluginSchema,
type PluginContextData,
type PluginLifecycleHooks,
type PluginLifecycleCallbacks,
type PluginDefinition,
} from './plugin.zod';

Expand Down Expand Up @@ -139,13 +139,13 @@ describe('PluginContextSchema', () => {

describe('PluginLifecycleSchema', () => {
it('should accept empty lifecycle (all hooks optional)', () => {
const lifecycle: PluginLifecycleHooks = {};
const lifecycle: PluginLifecycleCallbacks = {};

expect(() => PluginLifecycleSchema.parse(lifecycle)).not.toThrow();
});

it('should accept lifecycle with onInstall hook', () => {
const lifecycle: PluginLifecycleHooks = {
const lifecycle: PluginLifecycleCallbacks = {
onInstall: async (context: PluginContextData) => {
// Installation logic
},
Expand All @@ -155,7 +155,7 @@ describe('PluginLifecycleSchema', () => {
});

it('should accept lifecycle with onEnable hook', () => {
const lifecycle: PluginLifecycleHooks = {
const lifecycle: PluginLifecycleCallbacks = {
onEnable: async (context: PluginContextData) => {
// Enable logic
},
Expand All @@ -165,7 +165,7 @@ describe('PluginLifecycleSchema', () => {
});

it('should accept lifecycle with onDisable hook', () => {
const lifecycle: PluginLifecycleHooks = {
const lifecycle: PluginLifecycleCallbacks = {
onDisable: async (context: PluginContextData) => {
// Disable logic
},
Expand All @@ -175,7 +175,7 @@ describe('PluginLifecycleSchema', () => {
});

it('should accept lifecycle with onUninstall hook', () => {
const lifecycle: PluginLifecycleHooks = {
const lifecycle: PluginLifecycleCallbacks = {
onUninstall: async (context: PluginContextData) => {
// Uninstall logic
},
Expand All @@ -185,7 +185,7 @@ describe('PluginLifecycleSchema', () => {
});

it('should accept lifecycle with onUpgrade hook', () => {
const lifecycle: PluginLifecycleHooks = {
const lifecycle: PluginLifecycleCallbacks = {
onUpgrade: async (context: PluginContextData, fromVersion: string, toVersion: string) => {
// Upgrade logic
},
Expand All @@ -195,7 +195,7 @@ describe('PluginLifecycleSchema', () => {
});

it('should accept lifecycle with all hooks', () => {
const lifecycle: PluginLifecycleHooks = {
const lifecycle: PluginLifecycleCallbacks = {
onInstall: async (context: PluginContextData) => {
await context.ql.object('plugin_data').syncSchema();
},
Expand Down
12 changes: 6 additions & 6 deletions packages/spec/src/system/plugin.zod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ export const PluginLifecycleSchema = z.object({
.args(PluginContextSchema)
.returns(z.promise(z.void()))
.optional()
.describe('Hook called on plugin installation'),
.describe('Lifecycle callback on plugin installation'),

/**
* Called when the plugin is enabled.
Expand All @@ -184,7 +184,7 @@ export const PluginLifecycleSchema = z.object({
.args(PluginContextSchema)
.returns(z.promise(z.void()))
.optional()
.describe('Hook called when plugin is enabled'),
.describe('Lifecycle callback when plugin is enabled'),

/**
* Called when the plugin is disabled.
Expand All @@ -196,7 +196,7 @@ export const PluginLifecycleSchema = z.object({
.args(PluginContextSchema)
.returns(z.promise(z.void()))
.optional()
.describe('Hook called when plugin is disabled'),
.describe('Lifecycle callback when plugin is disabled'),

/**
* Called when the plugin is uninstalled.
Expand All @@ -208,7 +208,7 @@ export const PluginLifecycleSchema = z.object({
.args(PluginContextSchema)
.returns(z.promise(z.void()))
.optional()
.describe('Hook called on plugin uninstallation'),
.describe('Lifecycle callback on plugin uninstallation'),

/**
* Called when the plugin is upgraded to a new version.
Expand All @@ -222,7 +222,7 @@ export const PluginLifecycleSchema = z.object({
.args(PluginContextSchema, z.string(), z.string())
.returns(z.promise(z.void()))
.optional()
.describe('Hook called on plugin upgrade'),
.describe('Lifecycle callback on plugin upgrade'),
});

/**
Expand All @@ -248,5 +248,5 @@ export const PluginSchema = PluginLifecycleSchema.extend({
* TypeScript types
*/
export type PluginContextData = z.infer<typeof PluginContextSchema>;
export type PluginLifecycleHooks = z.infer<typeof PluginLifecycleSchema>;
export type PluginLifecycleCallbacks = z.infer<typeof PluginLifecycleSchema>;
export type PluginDefinition = z.infer<typeof PluginSchema>;
Loading