@dismissible/nestjs-dismissible-hooks

Lifecycle hooks interfaces for Dismissible applications.

Part of the Dismissible API - This library is part of the Dismissible API ecosystem. Visit dismissible.io for more information and documentation.

Overview

This library provides the core interfaces for implementing lifecycle hooks in the Dismissible system:

• IDismissibleLifecycleHook - Interface for lifecycle hooks
• IHookResult - Result returned by pre-hooks
• IHookMutations - Mutations that can be applied by pre-hooks
• IRequestContext - Request context passed through dismissible operations
• DISMISSIBLE_HOOKS - Injection token for lifecycle hooks

Installation

npm install @dismissible/nestjs-dismissible-hooks

Getting Started

Basic Usage

Implement the IDismissibleLifecycleHook interface to create custom lifecycle hooks:

import { Injectable } from '@nestjs/common';
import {
  IDismissibleLifecycleHook,
  IHookResult,
  IRequestContext,
} from '@dismissible/nestjs-dismissible-hooks';

@Injectable()
export class MyLifecycleHook implements IDismissibleLifecycleHook {
  readonly priority = 0;

  async onBeforeRequest(
    itemId: string,
    userId: string,
    context?: IRequestContext,
  ): Promise<IHookResult> {
    // Your logic here
    return { proceed: true };
  }
}

API Reference

IDismissibleLifecycleHook

Interface for lifecycle hooks that can intercept dismissible operations.

Methods

• onBeforeRequest(itemId, userId, context?) - Called at the start of any operation
• onAfterRequest(itemId, item, userId, context?) - Called at the end of any operation
• onBeforeGet(itemId, item, userId, context?) - Called before returning an existing item
• onAfterGet(itemId, item, userId, context?) - Called after returning an existing item
• onBeforeCreate(itemId, userId, context?) - Called before creating a new item
• onAfterCreate(itemId, item, userId, context?) - Called after creating a new item
• onBeforeDismiss(itemId, userId, context?) - Called before dismissing an item
• onAfterDismiss(itemId, item, userId, context?) - Called after dismissing an item
• onBeforeRestore(itemId, userId, context?) - Called before restoring an item
• onAfterRestore(itemId, item, userId, context?) - Called after restoring an item

IHookResult

Result returned by pre-hooks.

interface IHookResult {
  proceed: boolean;
  reason?: string;
  mutations?: IHookMutations;
}

IHookMutations

Mutations that can be applied by pre-hooks.

interface IHookMutations {
  id?: string;
  userId?: string;
  context?: Partial<IRequestContext>;
}

IRequestContext

Request context passed through dismissible operations.

interface IRequestContext {
  requestId: string;
  authorizationHeader?: string;
}

Related Packages

This library is typically used alongside other Dismissible packages:

• @dismissible/nestjs-dismissible - Main dismissible service and module
• @dismissible/nestjs-dismissible-item - Core data models
• @dismissible/nestjs-jwt-auth-hook - JWT authentication hook implementation

License

MIT