@kotii/anzii-plugins-viewguard

ViewGuard is a Node.js plugin for the Anzii backend framework that provides view-level authentication for server-side rendered (SSR) applications. It ensures that only authenticated users can access protected views, while remaining modular and compatible with other Anzii plugins.

Installation

npm install @kotii/anzii-plugins-viewguard

Using with Anzii

1. Register the Plugin

Register your plugins when creating an Anzii instance:

import { anzii } from "anzii";
import ViewGuard from "@kotii/anzii-plugins-viewguard";
import HelloPlugin from "./plugins/Hello.js";

const plugins = {
  ViewGuard: ViewGuard,
  Hello: HelloPlugin,
};

anzii(plugins);

Create Your plugin

Note: From within the plugin, anzii events are available

class Hello {
  constructor(pao) {
    this.pao = pao; // Every plugin is passed this object
  }

  init() {
    this.listens({
      "handle-hello-task": this.handleHelloTask.bind(this), // Event and handling method
    }); // Call listens() method (available to every anzii plugin) to set events that this module  listens to
  } // Define the required init() method

  handleHelloTask(data) {
    const self = this;

    self.callback = data.callback;
    self.emit({
      type: "get-env-variables",
      data: {
        envPath: envPath,
        meta: "",
        callback: (envVariables) => {
          console.log("Fetched Environment Variables:", envVariables);
        },
      },
    });
  }
}

export default Hello;

How it Works

The plugin automatically registers an event listener for run-view-authentication. Whenever a view is requested:

1. ViewGuard checks if the request has an authenticated user (req.authUser).
2. If the user is authenticated, the view is rendered immediately.
3. Otherwise, it emits a view-guard event for other plugins or logic to handle authentication.
4. The authentication result is returned asynchronously via a callback.

API

new ViewGuard(pao)

Creates a new ViewGuard instance.

• pao – The Anzii backend plugin context used to register listeners and emit events.

Methods

init()

Registers the listener for view authentication:

viewGuard.init();

Questions & Support

For questions and support please use @kotii/anzii-plugins-reactjs's Suppport page on Github repo.

Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

Changelog

Detailed changes for each release are documented in our Changelog.

Release Notes

A summary of release changes can be found in our Release Notes.

Stay In Touch

Twitter @ntsakosurprise.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

Licence

MIT - see the LICENSE file for details.

© Kotii Ecosystem 2025-present. Ntsako (Surprise) Mashele