npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bytehide/next-shield

v1.1.0

Published

Next.js plugin for ByteHide Shield obfuscation.

Downloads

631

Readme

@bytehide/next-shield for Next.js

@bytehide/next-shield is a powerful plugin for Next.js projects that enables JavaScript obfuscation to enhance the security of your codebase. This plugin integrates seamlessly with your Next.js build process to obfuscate sensitive files, protecting your intellectual property.

Features

  • Code Obfuscation: Protect your JavaScript code from reverse engineering.
  • Customizable Options: Configure obfuscation settings to suit your needs.
  • File Exclusion: Exclude specific files from obfuscation.
  • Seamless Integration: Easily integrate with your Next.js project.

Installation

Install the plugin using npm or yarn:

npm install @bytehide/next-shield --save-dev

Usage

Basic Setup

To use the @bytehide/next-shield, create a custom next.config.js file and configure the plugin:

const { createShield } = require('@bytehide/next-shield');

const nextConfig: NextConfig = {
    /* Config options here */
    // reactStrictMode: true,
    // distDir: 'build',
};

const shieldConfig = createShield({
  projectToken: 'your-project-token', // Required: Your ByteHide project token
  replace: true,                      // Optional: Replace original files
  controlFlowFlattening: true,        // Optional: Enable control flow flattening
  debugProtection: false,             // Optional: Enable debug protection
  devtoolsBlocking: false,            // Optional: Enable devtools blocking
  exclude: ['_document.js'],          // Optional: Exclude specific files
}, nextConfig);

module.exports = shieldConfig;

Shield Configuration Options

| Option | Type | Default | Description | |----------------------|-----------|---------------|-----------------------------------------------------------------------------| | projectToken | string | Required | Token provided by ByteHide for obfuscation. | | replace | boolean | false | Whether to replace original files with obfuscated versions. | | obfuscatedExtension| string | .obf | File extension for obfuscated files. | | controlFlowFlattening | boolean | true | Enhance obfuscation by flattening control flow in the code. | | debugProtection | boolean | false | Prevent debugging tools from analyzing your code. | | devtoolsBlocking | boolean | false | Block browser developer tools. | | exclude | string[]| [] | List of filenames to exclude from obfuscation. |

How It Works

  1. During the Next.js build process, the plugin scans for JavaScript files in the build directory (.next/ by default).
  2. Excludes system and user-defined files.
  3. Sends the content of each file to the ByteHide obfuscation service.
  4. Saves the obfuscated code in the output directory.

Example

Here’s how an obfuscated file is generated:

  • Input: pages/index.js
  • Output: pages/index.obf.js (if replace is false) or replaces the original file.

Limitations

  • Requires a valid ByteHide project token.
  • Obfuscation might slightly increase build time.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Happy coding but keep it safe with @bytehide/next-shield! 🛡️