New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@zenfs/core

Package Overview
Dependencies
Maintainers
1
Versions
165
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@zenfs/core - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

dist/config.d.ts
dist/config.js

31

dist/index.d.ts

@@ -1,29 +0,2 @@

/**
* ZenFS's main module. This is exposed in the browser via the ZenFS global.
*/
import * as fs from './emulation/index.js';
import { FileSystem } from './filesystem.js';
import { type Backend, type BackendConfig } from './backends/backend.js';
/**
* Initializes ZenFS with the given file systems.
*/
export declare function initialize(mounts: {
[point: string]: FileSystem;
}, uid?: number, gid?: number): void;
/**
* Defines a mapping of mount points to their configurations
*/
export interface ConfigMapping {
[mountPoint: string]: FileSystem | BackendConfig | Backend;
}
/**
* A configuration for ZenFS
*/
export type Configuration = FileSystem | BackendConfig | ConfigMapping;
/**
* Creates filesystems with the given configuration, and initializes ZenFS with it.
* See the Configuration type for more info on the configuration object.
*/
export declare function configure(config: Configuration): Promise<void>;
export type { Backend, BackendConfig } from './backends/backend.js';
export * from './backends/backend.js';
export * from './backends/AsyncMirror.js';

@@ -36,2 +9,3 @@ export * from './backends/AsyncStore.js';

export * from './ApiError.js';
export * from './config.js';
export * from './cred.js';

@@ -45,3 +19,4 @@ export * from './file.js';

export * from './utils.js';
import * as fs from './emulation/index.js';
export { fs };
export default fs;

42

dist/index.js

@@ -1,40 +0,2 @@

/**
* ZenFS's main module. This is exposed in the browser via the ZenFS global.
*/
import * as fs from './emulation/index.js';
import { FileSystem } from './filesystem.js';
import { Cred } from './cred.js';
import { isBackend, resolveBackendConfig } from './backends/backend.js';
import { setCred } from './emulation/shared.js';
/**
* Initializes ZenFS with the given file systems.
*/
export function initialize(mounts, uid = 0, gid = 0) {
setCred(new Cred(uid, gid, uid, gid, uid, gid));
fs.initialize(mounts);
}
/**
* Creates filesystems with the given configuration, and initializes ZenFS with it.
* See the Configuration type for more info on the configuration object.
*/
export async function configure(config) {
if ('backend' in config || config instanceof FileSystem) {
// single FS
config = { '/': config };
}
for (let [point, value] of Object.entries(config)) {
if (typeof value == 'number') {
//should never happen
continue;
}
if (value instanceof FileSystem) {
continue;
}
if (isBackend(value)) {
value = { backend: value };
}
config[point] = await resolveBackendConfig(value);
}
initialize(config);
}
export * from './backends/backend.js';
export * from './backends/AsyncMirror.js';

@@ -47,2 +9,3 @@ export * from './backends/AsyncStore.js';

export * from './ApiError.js';
export * from './config.js';
export * from './cred.js';

@@ -56,3 +19,4 @@ export * from './file.js';

export * from './utils.js';
import * as fs from './emulation/index.js';
export { fs };
export default fs;

83

license.md

@@ -1,7 +0,5 @@

ZenFS's license follows:
Copyright (c) 2023-2024 James P. and other ZenFS contributors.
====
Copyright (c) 2013-2023 John Vilk and other BrowserFS contributors.
Copyright (c) 2013-2023 John Vilk and other ZenFS contributors.
Permission is hereby granted, free of charge, to any person obtaining a copy of

@@ -25,7 +23,5 @@ this software and associated documentation files (the "Software"), to deal in

====
This license applies to all parts of ZenFS, except for the following items:
- The test fixtures located in `test/fixtures/files/node`. Their license follows:
- The test fixtures located in `test/fixtures/node`. Their license follows:
"""

@@ -51,74 +47,1 @@ Copyright Joyent, Inc. and other Node contributors. All rights reserved.

"""
- The Emscripten file system in src/generic/emscripten_fs.ts is a modified
version of Emscripten's NODEFS. Emscripten's license follows:
"""
Emscripten is available under 2 licenses, the MIT license and the
University of Illinois/NCSA Open Source License.
Both are permissive open source licenses, with little if any
practical difference between them.
The reason for offering both is that (1) the MIT license is
well-known, while (2) the University of Illinois/NCSA Open Source
License allows Emscripten's code to be integrated upstream into
LLVM, which uses that license, should the opportunity arise.
The full text of both licenses follows.
==============================================================================
Copyright (c) 2010-2011 Emscripten authors, see AUTHORS file.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
==============================================================================
Copyright (c) 2010-2011 Emscripten authors, see AUTHORS file.
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal with the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimers.
Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimers
in the documentation and/or other materials provided with the
distribution.
Neither the names of Mozilla,
nor the names of its contributors may be used to endorse
or promote products derived from this Software without specific prior
written permission.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.
"""

138

package.json
{
"name": "@zenfs/core",
"version": "0.4.0",
"description": "A filesystem in your browser",
"main": "dist/index.js",
"types": "dist",
"keywords": [
"filesystem",
"node",
"storage"
],
"bin": {
"make-index": "./scripts/make-index.js"
},
"type": "module",
"homepage": "https://github.com/zen-fs/core",
"author": "James P. <jp@drvortex.dev> (https://drvortex.dev)",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/zen-fs/core.git"
},
"bugs": {
"url": "https://github.com/zen-fs/core/issues"
},
"engines": {
"node": ">= 18"
},
"exports": {
"./*": "./dist/*"
},
"typesVersions": {
"*": {
"*": [
"./dist/*"
]
}
},
"scripts": {
"format": "prettier --write src test",
"format:check": "prettier --check src test",
"lint": "eslint src test && tsc -p tsconfig.json --noEmit",
"test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest",
"build": "node scripts/build.js",
"build:docs": "typedoc --out docs --name ZenFS src/index.ts",
"dev": "node scripts/build.js --watch",
"prepublishOnly": "npm run build"
},
"dependencies": {
"@types/node": "^14.0.0",
"@types/readable-stream": "^4.0.10",
"minimatch": "^9.0.3",
"readable-stream": "^4.5.2"
},
"devDependencies": {
"@jest/globals": "^29.5.0",
"@types/jest": "^29.5.1",
"@typescript-eslint/eslint-plugin": "^5.55.0",
"@typescript-eslint/parser": "^5.55.0",
"cross-env": "^7.0.3",
"esbuild": "^0.17.18",
"eslint": "^8.36.0",
"jest": "^29.5.0",
"prettier": "^2.8.7",
"ts-jest": "^29.1.0",
"typedoc": "^0.25.1",
"typescript": "^4.9.5"
}
"name": "@zenfs/core",
"version": "0.4.1",
"description": "A filesystem in your browser",
"main": "dist/index.js",
"types": "dist",
"keywords": [
"filesystem",
"node",
"storage"
],
"bin": {
"make-index": "scripts/make-index.js"
},
"type": "module",
"homepage": "https://github.com/zen-fs/core",
"author": "James P. <jp@drvortex.dev> (https://drvortex.dev)",
"contributors": [
"John Vilk <jvilk@cs.umass.edu>"
],
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/zen-fs/core.git"
},
"bugs": {
"url": "https://github.com/zen-fs/core/issues"
},
"engines": {
"node": ">= 18"
},
"exports": {
".": "./dist/index.js",
"./*": "./dist/*"
},
"typesVersions": {
"*": {
"*": [
"./dist/*"
]
}
},
"scripts": {
"format": "prettier --write src test",
"format:check": "prettier --check src test",
"lint": "eslint src test && tsc -p tsconfig.json --noEmit",
"test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest",
"build": "node scripts/build.js",
"build:docs": "typedoc --out docs --name ZenFS src/index.ts",
"dev": "node scripts/build.js --watch",
"prepublishOnly": "npm run build"
},
"dependencies": {
"@types/node": "^14.0.0",
"@types/readable-stream": "^4.0.10",
"minimatch": "^9.0.3",
"readable-stream": "^4.5.2"
},
"devDependencies": {
"@jest/globals": "^29.5.0",
"@types/jest": "^29.5.1",
"@typescript-eslint/eslint-plugin": "^5.55.0",
"@typescript-eslint/parser": "^5.55.0",
"cross-env": "^7.0.3",
"esbuild": "^0.17.18",
"eslint": "^8.36.0",
"jest": "^29.5.0",
"prettier": "^2.8.7",
"ts-jest": "^29.1.0",
"typedoc": "^0.25.1",
"typescript": "^4.9.5"
}
}

14

readme.md
# ZenFS
ZenFS is an in-browser file system that emulates the [Node JS file system API](http://nodejs.org/api/fs.html) and supports storing and retrieving files from various backends. ZenFS also integrates nicely with other tools.
ZenFS is a file system that emulates the [Node JS file system API](http://nodejs.org/api/fs.html).
It works using a system of backends, which are used by ZenFS to store and retrieve data. ZenFS can also integrate nicely with other tools.
ZenFS is a fork of [BrowserFS](https://github.com/jvilk/BrowserFS).
## Backends

@@ -36,3 +40,3 @@

fs.writeFileSync('/test.txt', 'Cool, I can do this in the browser!');
fs.writeFileSync('/test.txt', 'Cool, I can do this in any JS environment (including browsers)!');

@@ -70,5 +74,5 @@ const contents = fs.readFileSync('/test.txt', 'utf-8');

>
> 1. A string that maps to a built-in backend
> 2. A `Backend` object, if the backend has no required options
> 3. An object that has the options accepted by the backend and a `backend` property which is (1) or (2)
> 1. A `Backend` object, if the backend has no required options
> 2. An object that has the options accepted by the backend and a `backend` property which is a `Backend` object
> 3. A `FileSystem` instance (_not recommended_)

@@ -75,0 +79,0 @@ Here is an example that mounts the `Storage` backend from `@zenfs/dom` on `/`:

dist/browser.min.js

Sorry, the diff of this file is too big to display

dist/browser.min.js.map

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc