Skip to content

README.md

Latest commit

 

History

History
181 lines (150 loc) · 8.25 KB

README.md

File metadata and controls

181 lines (150 loc) · 8.25 KB

NodeJS file system providers for Essential JS 2 File Manager

Repository Description
This repository contains the Node.js file system provider used for the Syncfusion Essential JS 2 File Manager component. The provider exposes server‑side APIs that allow the File Manager to interact with the physical file system and perform standard file operations.

The Node.js provider enables secure and extensible backend support for file browsing, management, and access control in JavaScript‑based File Manager applications.

Project Overview

The purpose of this project is to provide a Node.js server implementation that supports file system operations required by the Syncfusion Essential JS 2 File Manager. It demonstrates how client‑side File Manager requests are handled by a Node.js service to perform actions such as reading files, uploading content, and managing folders.

Key Features

The Node.js file system provider module allows you to work with the physical file system. It also provides the methods for performing various file actions like creating a new folder, renaming files, and deleting files.

NodeJs File System Provider Serves the file system providers support for the FileManager component with the NodeJS.

The following actions can be performed with NodeJS file system provider.

Actions Description
Read Reads the files from NodeJS file system.
Details Gets the file's details which consists of Type, Size, Location and Modified date.
Download Downloads the selected file or folder from NodeJS file system.
Upload Uploads a file in NodeJS file system. It accepts uploaded media with the following characteristics:
  • Maximum file size: 30MB
  • Accepted Media MIME types: */*
Create Creates a New folder.
Delete Deletes a folder or file.
Copy Copys the selected files or folders from target.
Move Moves the files or folders to the desired location.
Rename Renames a folder or file.
Search Full-text questions perform linguistic searches against text data in full-text indexes by operating on words and phrases.

Access Control

The EJ2 FileManager allows you to define access permissions for files and folders using a set of access rules to user(s). The rules and roles should be specified in the accessRules.json available in the root folder of the package. The following table represents the access rule properties available for the files and folders.

Properties Description
Read Allows access to read a file or folder.
Write Allows permission to edit a file or folder.
WriteContents Allows permission to edit the content of folder.
Copy Allows permission to copy a file or folder.
Download Allows permission to download a file or folder.
Upload Allows permission to upload into the folder.
IsFile Specifies whether the rule is specified for folder or file.
Role Specifies the role to which the rule is applied.
Path Specifies the path to apply the rules which are defined.

For Example

{
    "role": "Administator",
    "rules":[
        //Denies downloading the 'Videos' folder.
        {"path":"/Videos/", "isFile": false,"role": "Administator", "download": "deny"},
        //Denies uploading files in all folders under 'Pictures' by displaying a custom access denied message.
        {"path":"/Pictures/*","isFile": false, "role": "Administator","upload": "deny","message":"you don't have permission for this, Contact admisinistrator for access."  },
        //Denies deleting and renaming all files in 'Downloads' folder.
        {"path":"/Downloads/*.*","isFile":true, "role": "Administator","write": "deny", },
        //Denies opening all 'png' files in 'Employees' folder.
        {"path":"/Pictures/Employees/*.png","isFile":true, "role": "Administator","read": "deny" },
        //Denies downloading all files with name 'FileManager' in 'Documents' folder.
        {"path":"/Documents/FileManager.*","isFile":true, "role": "Administator", "download": "deny", "message":"you don't have permission for this, Contact admisinistrator for access."  },
    ]
}

Prerequisites

Ensure the following requirements are met before running this project:

  • Node.js (LTS recommended)
  • npm package manager
  • Basic knowledge of JavaScript and Node.js
  • Syncfusion Essential JS 2 File Manager setup

Installation

Install the Node.js File System Provider

Install the Node.js file system provider package using npm:

npm install @syncfusion/ej2-filemanager-node-filesystem

Install Dependencies

Navigate to the provider directory inside node_modules and install required dependencies:

npm install

Running the Service

To start the Node.js file system service, run:

npm start

By default, the service runs at:http://localhost:8090/

Configure the Directory

To change the root directory, use the -d flag:

node filesystem-server.js -d D:/Projects

Configure the Port

To change the port number:

set PORT=3000 && node filesystem-server.js -d D:/Projects

Usage

File Manager AjaxSettings

To access the basic actions like Read, Delete, Copy, Move, Rename, Search, and Get Details of File Manager using NodeJS file system service, just map the following code snippet in the Ajaxsettings property of File Manager.

Here, the hostUrl will be your locally hosted port number.

  var hostUrl = http://localhost:8090/;
        ajaxSettings: {
            url: hostUrl,
        }

File download AjaxSettings

To perform download operation, initialize the downloadUrl property in ajaxSettings of the File Manager component.

  var hostUrl = http://localhost:8090/;
  ajaxSettings: {
            url: hostUrl,
            downloadUrl: hostUrl + 'Download'
        },

File upload AjaxSettings

To perform upload operation, initialize the uploadUrl property in ajaxSettings of the File Manager component.

  var hostUrl = http://localhost:8090/;
  ajaxSettings: {
            url: hostUrl,
            uploadUrl: hostUrl + 'Upload'
        },

File image preview AjaxSettings

To perform image preview support in the File Manager component, initialize the getImageUrl property in ajaxSettings of the File Manager component.

  var hostUrl = http://localhost:8090/;
  ajaxSettings: {
            url: hostUrl,
            getImageUrl: hostUrl + 'GetImage'
        },

The FileManager will be rendered as follows.

File Manager

Documentation

Additional Resources

Troubleshooting

  • Ensure the Node.js service is running and accessible.
  • Verify the configured port and directory path.
  • Check file system permissions for read/write access.
  • Restart the service after configuration updates.

Support

Product support is available for through following mediums.

License

Check the license detail here.

Changelog

Check the changelog here

© Copyright 2020 Syncfusion, Inc. All Rights Reserved. The Syncfusion Essential Studio license and copyright applies to this distribution.