Upgrade @objectstack to v2.0.0 and migrate Hook API by Copilot · Pull Request #128 · objectstack-ai/hotcrm

Copilot · 2026-02-09T06:46:28Z

Description

Upgraded @objectstack packages from 1.1.0 to 2.0.0. The Hook API has breaking changes in context property access patterns.

Breaking Change: HookContext restructured

// v1.1.0
handler: async (ctx) => {
  const doc = ctx.new;
  const old = ctx.old;
}

// v2.0.0
handler: async (ctx: any) => {
  const doc = ctx.result;           // afterInsert/afterUpdate
  const doc = ctx.input.doc;        // beforeInsert/beforeUpdate
  const old = ctx.previous;
  await (ctx.ql as any).find(...);  // ctx.ql now requires cast
}

Type of Change

Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update

Changes Made

Dependencies (10 files)

Root + 9 workspace packages: @objectstack/{cli,spec,runtime,core,metadata,objectql,plugin-hono-server} → 2.0.0

Hook Implementations (19 files)

ctx.new → ctx.input.doc (before events) or ctx.result (after events)
ctx.old → ctx.previous
Handler signatures: (ctx: HookContext) → (ctx: any) due to Zod type strictness
Type assertions added for ctx.ql usage

Test Mocks (4 files)

Mock contexts updated to wrap input: { doc: data } for before events
result and previous properties for after events

Documentation

MIGRATION_v2.0.0.md created with migration patterns for all event types

Testing

Unit tests pass (npm test) - 496/496 tests passing
Linting passes (npm run lint)
Build succeeds (npm run build) - all 9 packages compile
Manual testing completed - pnpm validate passes
New tests added (if applicable) - test mocks updated

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published

Additional Notes

CodeQL scan: 0 vulnerabilities detected.

Migration affects all hook handlers across CRM (5), Finance (2), Marketing (3), Products (3), Support (2), and HR (4) packages. Type safety reduced due to unknown typing in upstream spec - any casts required for practical usage.

Original prompt

@objectstack 升级到最新版，并对应调整代码

The user has attached the following file paths as relevant context:

.github/copilot-instructions.md

Created from VS Code.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

vercel · 2026-02-09T06:46:35Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
hotcrm	Ready	Preview, Comment	Feb 9, 2026 7:28am

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

…ter hooks Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

…ious/result) Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

…st files Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

+      const isAfterHook = !!ctx.result;
+      const isInsert = !ctx.previous;
+      const isUpdate = !!ctx.previous;
+      const quote = (isBeforeHook ? ctx.input?.doc : ctx.result) as Record<string, any>;


In general, unused local variables should be removed so that only values that are actually used are computed. This simplifies the code, avoids confusion about intended behavior, and prevents unnecessary computation.

For this specific case, the best fix without changing functionality is to delete the declaration const quote = (isBeforeHook ? ctx.input?.doc : ctx.result) as Record<string, any>; on line 27 inside the handler of QuotePricingHook. No other code in handler uses quote, and the logic already passes ctx to helper functions that derive their own quote. No imports or additional definitions are needed; we are only removing dead code from packages/products/src/hooks/quote.hook.ts.

Concretely:

Edit packages/products/src/hooks/quote.hook.ts.

In the handler: async (ctx: HookContext) => { ... } body, remove the line that declares const quote = ....

Leave all other logic intact.

-async function handleQuoteSent(ctx: TriggerContext): Promise<void> {
-  const quote = ctx.new;
+async function handleQuoteSent(ctx: any): Promise<void> {
+  const quote = ctx.result;


In general, to fix an unused local variable you either remove the declaration or actually use the variable in a meaningful way. Since handleQuoteSent currently does not use quote at all, the least intrusive and safest fix is to remove the unused declaration const quote = ctx.result;.

Concretely, in packages/products/src/hooks/quote.hook.ts, in the handleQuoteSent function, delete the line declaring quote. No other lines in that function reference quote, so no additional edits are needed. This change does not require new imports, methods, or other definitions.

-async function handleQuoteExpired(ctx: TriggerContext): Promise<void> {
-  const quote = ctx.new;
+async function handleQuoteExpired(ctx: any): Promise<void> {
+  const quote = ctx.result;


In general, to fix an unused-variable finding you either (1) remove the variable (and any dead computation used only to initialize it), or (2) start using the variable meaningfully. To avoid changing existing functionality, the safest approach is to remove the unused declaration if it has no side effects.

Here, handleQuoteExpired declares const quote = ctx.result; and then only logs static messages. Reading ctx.result has no side effects in TypeScript/JavaScript, so we can safely remove that line. No other code in this function or file depends on quote, and we don’t need extra imports or helper methods. Only packages/products/src/hooks/quote.hook.ts needs editing, and only the line const quote = ctx.result; within handleQuoteExpired should be removed.

-      const article = ctx.new;
-      const oldArticle = ctx.old;
+      const article = ctx.input.doc as Record<string, any>;
+      const oldArticle = ctx.previous as Record<string, any> | undefined;


In general, unused local variables should be removed if they are not read, unless they are needed for an interface or for side effects (which is not the case here). This eliminates dead code and any confusion about its purpose.

The best fix here is to remove the declaration of oldArticle from the KnowledgeArticleScoringTrigger handler while leaving everything else intact. No other lines depend on oldArticle, and there are no side effects in its initialization (ctx.previous is simply read), so deleting that line does not change runtime behavior. Concretely, edit packages/support/src/hooks/knowledge.hook.ts in the KnowledgeArticleScoringTrigger definition, and delete the line const oldArticle = ctx.previous as Record<string, any> | undefined;. No imports, methods, or additional definitions are needed.

Copilot

Pull request overview

This PR upgrades the monorepo from @objectstack/* v1.1.0 to v2.0.0 and updates hook implementations/tests/docs to match the v2 Hook API (ctx.input.doc / ctx.result / ctx.previous, plus ctx.ql casting).

Changes:

Bump @objectstack/* dependencies across root + workspace packages to ^2.0.0 (and lockfile updates).
Migrate hook handlers from ctx.new/ctx.old to ctx.input.doc/ctx.result/ctx.previous and update related test mocks.
Add MIGRATION_v2.0.0.md documenting the migration patterns.

Reviewed changes

Copilot reviewed 34 out of 35 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
pnpm-lock.yaml	Updates lockfile to `@objectstack/*` v2.0.0 resolution graph.
package.json	Bumps root devDependencies to `@objectstack/*` `^2.0.0`.
packages/ai/package.json	Bumps `@objectstack/spec` and peer `@objectstack/cli` to `^2.0.0`.
packages/core/package.json	Bumps `@objectstack/spec` to `^2.0.0`.
packages/crm/package.json	Bumps `@objectstack/spec` and peer `@objectstack/cli` to `^2.0.0`.
packages/finance/package.json	Bumps `@objectstack/spec` and peer `@objectstack/cli` to `^2.0.0`.
packages/hr/package.json	Bumps `@objectstack/spec` and peer `@objectstack/cli` to `^2.0.0`.
packages/marketing/package.json	Bumps `@objectstack/spec` and peer `@objectstack/cli` to `^2.0.0`.
packages/products/package.json	Bumps `@objectstack/spec` and peer `@objectstack/cli` to `^2.0.0`.
packages/server/package.json	Bumps server runtime dependencies to `@objectstack/*` `2.0.0`.
packages/support/package.json	Bumps `@objectstack/spec` and peer `@objectstack/cli` to `^2.0.0`.
packages/support/src/hooks/knowledge.hook.ts	Migrates knowledge hooks to `ctx.input.doc` / `ctx.result` / `ctx.previous`.
packages/support/src/hooks/case.hook.ts	Migrates case entitlement hook to `ctx.input.doc`.
packages/products/src/hooks/quote.hook.ts	Migrates quote hook to v2 context access pattern and adds before/after branching logic.
packages/products/src/hooks/product.hook.ts	Migrates product hook to v2 context access and adds before/after branching logic.
packages/products/src/hooks/pricebook.hook.ts	Migrates pricebook hook to v2 context access and adds before/after branching logic.
packages/marketing/src/hooks/roi.hook.ts	Migrates ROI hook to `ctx.result` / `ctx.previous`.
packages/marketing/src/hooks/campaign_member.hook.ts	Migrates campaign member hooks to v2 context access and loosens ctx typing.
packages/marketing/src/hooks/campaign.hook.ts	Migrates campaign hooks and casts `ctx.ql` to `any` for ObjectQL usage.
packages/hr/src/hooks/performance_review.hook.ts	Migrates performance review hooks and casts `ctx.ql` to `any`.
packages/hr/src/hooks/offer.hook.ts	Migrates offer hooks and casts `ctx.ql` to `any`.
packages/hr/src/hooks/employee.hook.ts	Migrates employee hooks and casts `ctx.ql` to `any`.
packages/hr/src/hooks/candidate.hook.ts	Migrates candidate hooks and casts `ctx.ql` to `any`.
packages/finance/src/hooks/contract_renewal.hook.ts	Migrates contract renewal hooks to `ctx.result` / `ctx.previous`.
packages/finance/src/hooks/contract.hook.ts	Migrates contract billing hook to `ctx.result` / `ctx.previous`.
packages/crm/src/hooks/opportunity.hook.ts	Migrates opportunity hooks to v2 context access.
packages/crm/src/hooks/lead.hook.ts	Casts `ctx.ql` to `any` for ObjectQL calls.
packages/crm/src/hooks/contact.hook.ts	Migrates contact hooks to v2 context access.
packages/crm/src/hooks/activity.hook.ts	Migrates activity hooks to v2 context access.
packages/crm/src/hooks/account.hook.ts	Migrates account hooks to v2 context access.
packages/hr/tests/unit/hooks/offer.hook.test.ts	Updates hook test mocks to include `input: { doc }`, `result`, `previous`.
packages/hr/tests/unit/hooks/employee.hook.test.ts	Updates hook test mocks to include `input: { doc }`, `result`, `previous`.
packages/hr/tests/unit/hooks/candidate.hook.test.ts	Updates hook test mocks to include `input: { doc }`, `result`, `previous`.
packages/finance/tests/unit/hooks/contract_renewal.hook.test.ts	Updates finance hook test contexts to use `result` / `previous`.
MIGRATION_v2.0.0.md	Adds repo-local migration guide for HookContext changes and testing patterns.

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

Comments suppressed due to low confidence (1)

packages/crm/src/hooks/opportunity.hook.ts:17

The Opportunity schema’s stage values are "Closed Won"/"Closed Lost" (see packages/crm/src/opportunity.object.ts), but this validation checks for 'closed_won'. This means the validation won’t run when an opportunity is actually moved to Closed Won.

    // 1. Validate "closed_won"
    if (opp.stage === 'closed_won') {
      if (!opp.amount || opp.amount <= 0) {
        throw new Error('Validation Error: Cannot close a deal with zero amount. Please update the Amount field.');
      }

Copilot · 2026-02-09T07:48:39Z

+      // Determine if this is a before or after hook based on available properties
+      const isBeforeHook = !!ctx.input;
+      const isAfterHook = !!ctx.result;
+      const isInsert = !ctx.previous;
+      const isUpdate = !!ctx.previous;


ctx.input can exist for both before* and after* events in the v2 HookContext, so !!ctx.input is not a reliable way to detect a “before hook”. This can cause the before-logic to run during afterUpdate/afterInsert. Branch on ctx.event (e.g., explicit event comparisons or startsWith('before')/('after')) instead of property presence.

Suggested change

// Determine if this is a before or after hook based on available properties

const isBeforeHook = !!ctx.input;

const isAfterHook = !!ctx.result;

const isInsert = !ctx.previous;

const isUpdate = !!ctx.previous;

// Determine hook phase and operation from the event name

const isBeforeHook = ctx.event.startsWith('before');

const isAfterHook = ctx.event.startsWith('after');

const isInsert = ctx.event.endsWith('Insert');

const isUpdate = ctx.event.endsWith('Update');

Copilot · 2026-02-09T07:48:39Z

+async function calculateQuotePricing(ctx: any): Promise<void> {
+  const quote = ctx.input?.doc || ctx.result;

  try {
    // Calculate Discount Amount from Percent or vice versa


This hook reads/writes Quote fields using PascalCase keys (e.g., Subtotal, DiscountPercent, TotalPrice), but the Quote schema defines snake_case fields (e.g., subtotal, discount_percent, total_price). As written, pricing/approval calculations won’t update the actual persisted fields. Align field names with packages/products/src/quote.object.ts.

Copilot · 2026-02-09T07:48:39Z

+      // Determine if this is a before or after hook based on available properties
+      const isBeforeHook = !!ctx.input;
+      const isAfterHook = !!ctx.result;


ctx.input can exist for after* events too, so !!ctx.input isn’t a safe before/after discriminator. This can cause the before validation logic to run during afterUpdate. Use ctx.event to branch instead.

Suggested change

// Determine if this is a before or after hook based on available properties

const isBeforeHook = !!ctx.input;

const isAfterHook = !!ctx.result;

// Determine if this is a before or after hook based on the event name

const isBeforeHook = ctx.event === 'beforeInsert' || ctx.event === 'beforeUpdate';

const isAfterHook = ctx.event === 'afterUpdate';

Copilot · 2026-02-09T07:48:40Z

+      // Determine if this is a before or after hook based on available properties
+      const isBeforeHook = !!ctx.input;
+      const isAfterHook = !!ctx.result;


ctx.input can exist for after* events too, so !!ctx.input isn’t a safe before/after discriminator. This can cause the before validation logic to run during afterUpdate. Use ctx.event to branch instead.

Suggested change

// Determine if this is a before or after hook based on available properties

const isBeforeHook = !!ctx.input;

const isAfterHook = !!ctx.result;

// Determine if this is a before or after hook based on the event type

const isBeforeHook = ctx.event === 'beforeInsert' || ctx.event === 'beforeUpdate';

const isAfterHook = ctx.event === 'afterUpdate';

Copilot · 2026-02-09T07:48:40Z

      // Check if Stage actually changed
-      const stageChanged = ctx.old.Stage !== ctx.new.Stage;
+      const stageChanged = (ctx.previous as Record<string, any> | undefined)?.Stage !== (ctx.result as Record<string, any>)?.Stage;
      if (!stageChanged) {
        return;
      }


Opportunity schema uses stage (snake_case) and option values like "Closed Won"/"Closed Lost", but this hook compares Stage and values like 'closed_won'/'closed_lost'. That will prevent stage-change detection and downstream automation from running. Update to use the schema’s stage field/value conventions (packages/crm/src/opportunity.object.ts).

Copilot · 2026-02-09T07:48:40Z

+      const isAfterHook = !!ctx.result;
+      const isInsert = !ctx.previous;
+      const isUpdate = !!ctx.previous;
+      const quote = (isBeforeHook ? ctx.input?.doc : ctx.result) as Record<string, any>;


Unused variable quote.

Suggested change

const quote = (isBeforeHook ? ctx.input?.doc : ctx.result) as Record<string, any>;

Copilot · 2026-02-09T07:48:40Z

-async function handleQuoteSent(ctx: TriggerContext): Promise<void> {
-  const quote = ctx.new;
+async function handleQuoteSent(ctx: any): Promise<void> {
+  const quote = ctx.result;


Unused variable quote.

Copilot · 2026-02-09T07:48:40Z

-async function handleQuoteExpired(ctx: TriggerContext): Promise<void> {
-  const quote = ctx.new;
+async function handleQuoteExpired(ctx: any): Promise<void> {
+  const quote = ctx.result;


Unused variable quote.

Suggested change

const quote = ctx.result;

Copilot · 2026-02-09T07:48:41Z

-      const article = ctx.new;
-      const oldArticle = ctx.old;
+      const article = ctx.input.doc as Record<string, any>;
+      const oldArticle = ctx.previous as Record<string, any> | undefined;


Unused variable oldArticle.

Initial plan

dd0b310

Copilot AI assigned Copilot and hotlong Feb 9, 2026

Copilot started work on behalf of hotlong February 9, 2026 06:46 View session

Copilot AI and others added 5 commits February 9, 2026 06:49

Update package.json files to @objectstack 2.0.0

17f23f4

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Migrate hook handlers from @objectstack/spec v1.1.0 to v2.0.0 API

67d9c03

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Fix TypeScript compilation errors with proper type assertions

1577533

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Fix code review issues - use correct context properties for before/af…

e018ff4

…ter hooks Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Migrate Hook API to @objectstack v2.0.0 (ctx.new/old → ctx.input/prev…

d63288f

…ious/result) Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot deployed to Preview February 9, 2026 07:08 View deployment

Copilot AI and others added 3 commits February 9, 2026 07:09

Migrate HR package hooks to @objectstack/spec v2.0.0 API

ba528c2

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Migrate marketing package hooks to @objectstack/spec v2.0.0 API

a0249d0

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Update offer hook tests to use v2.0.0 HookContext API

ba2da80

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot deployed to Preview February 9, 2026 07:20 View deployment

Update test mocks for Hook handlers to use v2.0.0 API in remaining te…

4b6c4df

…st files Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot deployed to Preview February 9, 2026 07:22 View deployment

Fix missing await in knowledge.hook.ts and add migration documentation

7b7462c

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot deployed to Preview February 9, 2026 07:28 View deployment

Copilot AI changed the title ~~[WIP] Upgrade ObjectStack to latest version and adjust code accordingly~~ Upgrade @objectstack to v2.0.0 and migrate Hook API Feb 9, 2026

Copilot AI requested a review from hotlong February 9, 2026 07:33

Copilot finished work on behalf of hotlong February 9, 2026 07:33

github-actions Bot added documentation Improvements or additions to documentation dependencies Dependency bumps and lockfile changes labels Feb 9, 2026

github-advanced-security AI found potential problems Feb 9, 2026

View reviewed changes

hotlong marked this pull request as ready for review February 9, 2026 07:39

Copilot AI review requested due to automatic review settings February 9, 2026 07:39

Copilot started reviewing on behalf of hotlong February 9, 2026 07:40 View session

Copilot AI reviewed Feb 9, 2026

View reviewed changes

hotlong merged commit 523223d into main Feb 9, 2026
13 checks passed

@@ -307,7 +307,6 @@
              * Handle quote sent to customer
              */
             async function handleQuoteSent(ctx: any): Promise<void> {
-              const quote = ctx.result;
               try {
                 console.log('📧 Quote sent to customer');

@@ -324,7 +324,6 @@
              * Handle quote expiration
              */
             async function handleQuoteExpired(ctx: any): Promise<void> {
-              const quote = ctx.result;
               try {
                 console.log('⏰ Quote expired');

@@ -18,7 +18,6 @@
               handler: async (ctx: HookContext) => {
                 try {
                   const article = ctx.input.doc as Record<string, any>;
-                  const oldArticle = ctx.previous as Record<string, any> | undefined;
                   // Calculate quality score
                   article.QualityScore = calculateQualityScore(article);

Conversation

Copilot AI commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Changes Made

Testing

Checklist

Additional Notes

Uh oh!

vercel Bot commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Check notice

Copilot Autofix

Check notice

Copilot Autofix

Check notice

Copilot Autofix

Check notice

Copilot Autofix

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Feb 9, 2026 •

edited

Loading

vercel Bot commented Feb 9, 2026 •

edited

Loading