Compare commits

...

77 Commits

Author SHA1 Message Date
4f5eb4a4d4 v13.0.0 2025-11-22 13:18:32 +00:00
ad33cb6d73 BREAKING CHANGE(SmartFileFactory): Refactor to in-memory file API and introduce SmartFileFactory; delegate filesystem operations to @push.rocks/smartfs; bump to 12.0.0 2025-11-22 13:18:32 +00:00
16d47ea348 11.2.7 2025-08-18 00:14:21 +00:00
dc92b7fe93 fix(ci): Remove .npmrc containing hard-coded npm registry configuration 2025-08-18 00:14:21 +00:00
0001b433bf 11.2.6 2025-08-18 00:13:03 +00:00
cd147ca38e fix(fs): Improve fs and stream handling, enhance SmartFile/StreamFile, update tests and CI configs 2025-08-18 00:13:03 +00:00
9b0d89b9ef 11.2.5 2025-05-26 08:24:56 +00:00
b34ae1362d fix(dev): Update dev dependencies and add local permission settings 2025-05-26 08:24:56 +00:00
2fa68c23a9 11.2.4 2025-05-24 00:29:37 +00:00
4083a36d8c fix(config): Add local permissions configuration for pnpm test commands in .claude/settings.local.json 2025-05-24 00:29:37 +00:00
3988ccbcb3 11.2.3 2025-05-21 13:27:10 +00:00
6eadbc654f 11.2.2 2025-05-21 13:26:29 +00:00
fda1543701 fix(tests/settings): Improve test assertions and update local settings permissions 2025-05-21 13:26:29 +00:00
a9660eda9a 11.2.1 2025-05-21 13:24:41 +00:00
dfd1db152b fix(fs): Fix inconsistent glob matching in listFileTree and update test imports and dependency versions for enhanced stability. 2025-05-21 13:24:41 +00:00
7a32835a74 11.2.0 2025-01-29 18:23:54 +01:00
e78682d9b4 feat(fs): Enhanced copy method with optional replaceTargetDir option for directory replacement 2025-01-29 18:23:54 +01:00
8dceea67be 11.1.9 2025-01-29 18:20:15 +01:00
40018532a7 fix(fs): Fix directory handling in copy and copySync functions 2025-01-29 18:20:14 +01:00
f6fb28d32f 11.1.8 2025-01-29 18:14:02 +01:00
2d1ac0bd50 fix(fs): Fixed copy and copySync functions to ensure they always overwrite files. 2025-01-29 18:14:02 +01:00
04a25221a5 11.1.7 2025-01-29 18:10:48 +01:00
13081b7344 fix(fs): Refactor copy and copySync functions to simplify return type 2025-01-29 18:10:48 +01:00
0abbe8bbd7 11.1.6 2025-01-29 12:21:49 +01:00
de2a250a45 fix(fs): Fix issues with fs file copy functions. 2025-01-29 12:21:49 +01:00
1657d0e1c6 11.1.5 2025-01-07 04:58:31 +01:00
e6b8240031 fix(fs): Improve waitForFileToBeReady function to handle directories and file stabilization 2025-01-07 04:58:31 +01:00
be011a4637 11.1.4 2025-01-07 04:41:18 +01:00
dbddf2a8ba fix(fs): Fix file existence check in waitForFileToBeReady method. 2025-01-07 04:41:17 +01:00
207320ff26 11.1.3 2025-01-07 04:36:32 +01:00
be99bdae66 fix(fs): Fix TypeScript type issue in fs module 2025-01-07 04:36:32 +01:00
768d970918 11.1.2 2025-01-07 04:35:56 +01:00
a9799e05ee fix(fs): Fix issues in file stability check and directory existence verification in fs module 2025-01-07 04:35:56 +01:00
7c07c5c174 11.1.1 2025-01-07 04:30:39 +01:00
4c4e41b158 fix(fs): Improve waitForFileToBeReady function for file stability detection 2025-01-07 04:30:39 +01:00
d557e4b4fe 11.1.0 2025-01-07 04:15:33 +01:00
16ded5c3cf feat(SmartFile): Add rename functionality to SmartFile class 2025-01-07 04:15:32 +01:00
a2bd049ebd 11.0.23 2024-12-15 21:40:19 +01:00
f95c5c9a15 fix(fs): Handle errors in toObjectSync method 2024-12-15 21:40:19 +01:00
b55a3eb83f 11.0.22 2024-06-23 23:59:07 +02:00
fc8d994943 fix(core): Update dependencies and changelog 2024-06-23 23:59:07 +02:00
f1daec6f44 11.0.21 2024-06-23 23:55:55 +02:00
6698a583e9 fix(dependencies): Update dependencies to latest versions 2024-06-23 23:55:54 +02:00
bf52f01365 11.0.20 2024-06-07 17:13:08 +02:00
14adec5ba3 fix(core): update 2024-06-07 17:13:07 +02:00
fb2880c995 11.0.19 2024-06-07 12:24:54 +02:00
0e0ae7e42f fix(core): update 2024-06-07 12:24:53 +02:00
1391dbddbc 11.0.18 2024-06-06 23:33:36 +02:00
477736da82 fix(core): update 2024-06-06 23:33:35 +02:00
26a67d9662 11.0.17 2024-06-06 22:29:06 +02:00
14771fab27 fix(core): update 2024-06-06 22:29:06 +02:00
b0ae383622 update description 2024-05-29 14:13:08 +02:00
921f1cbb66 11.0.16 2024-05-28 12:43:47 +02:00
a9b373f5f8 fix(core): update 2024-05-28 12:43:46 +02:00
f0d48cc763 11.0.15 2024-05-17 17:49:57 +02:00
255cc844ad fix(core): update 2024-05-17 17:49:57 +02:00
50cc3fa8bf update tsconfig 2024-04-14 17:35:54 +02:00
21b3870a7d 11.0.14 2024-04-14 13:17:47 +02:00
023e1cdf29 fix(core): update 2024-04-14 13:17:46 +02:00
493a235065 11.0.13 2024-04-12 15:00:56 +02:00
e4e48dc9db fix(core): update 2024-04-12 15:00:55 +02:00
7de647daa1 11.0.12 2024-04-12 14:51:23 +02:00
34bc92137b fix(core): update 2024-04-12 14:51:23 +02:00
954df5a0ee 11.0.11 2024-04-12 14:44:13 +02:00
b9c15b11ad fix(core): update 2024-04-12 14:44:12 +02:00
55e6e81957 11.0.10 2024-04-03 15:39:27 +02:00
f37956270c fix(core): update 2024-04-03 15:39:26 +02:00
0c985b9c00 11.0.9 2024-04-03 15:38:59 +02:00
85ff487809 fix(core): update 2024-04-03 15:38:58 +02:00
eb65c4e859 11.0.8 2024-04-02 21:37:32 +02:00
a1d6c37f18 fix(core): update 2024-04-02 21:37:31 +02:00
915ad00801 11.0.7 2024-04-02 20:58:34 +02:00
910671bfc6 fix(core): update 2024-04-02 20:58:33 +02:00
ae8835d430 11.0.6 2024-04-02 20:53:03 +02:00
d08cc0f350 fix(core): update 2024-04-02 20:53:02 +02:00
1311039127 update npmextra.json: githost 2024-04-01 21:35:01 +02:00
c267d2f226 update npmextra.json: githost 2024-04-01 19:58:14 +02:00
36 changed files with 11238 additions and 5597 deletions

View File

@@ -6,8 +6,8 @@ on:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@@ -26,7 +26,7 @@ jobs:
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
- name: Run npm prepare
run: npmci npm prepare

View File

@@ -6,8 +6,8 @@ on:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
@@ -26,7 +26,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Audit production dependencies
@@ -54,7 +54,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Test stable
@@ -82,7 +82,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Release
@@ -104,7 +104,7 @@ jobs:
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Code quality

7
.gitignore vendored
View File

@@ -3,7 +3,6 @@
# artifacts
coverage/
public/
pages/
# installs
node_modules/
@@ -17,4 +16,8 @@ node_modules/
dist/
dist_*/
# custom
# AI
.claude/
.serena/
#------# custom

487
changelog.md Normal file
View File

@@ -0,0 +1,487 @@
# Changelog
## 2025-11-22 - 13.0.0 - BREAKING CHANGE(SmartFileFactory)
Refactor to in-memory file API and introduce SmartFileFactory; delegate filesystem operations to @push.rocks/smartfs; bump to 12.0.0
- Introduce SmartFileFactory as the canonical entry point for creating SmartFile, StreamFile and VirtualDirectory instances.
- Refactor SmartFile, StreamFile and VirtualDirectory to be in-memory representations and accept an optional SmartFs instance for filesystem operations.
- Delegate low-level filesystem operations to @push.rocks/smartfs (added as a peerDependency); legacy fs/memory/fsStream/interpreter namespace exports removed/deprecated.
- Add StreamFile.toSmartFile(), VirtualDirectory.loadFromDisk(), and other convenience methods to work with the new factory/smartFs integration.
- Update tests to use a MockSmartFs and the factory API; add test assets.
- Documentation and readme updated with migration instructions and examples showing SmartFileFactory.nodeFs() and SmartFs usage.
- Bumped package version to 12.0.0 — this is a breaking change; consumers should migrate from legacy namespace exports to the factory + @push.rocks/smartfs workflow.
## 2025-08-18 - 11.2.7 - fix(ci)
Remove .npmrc containing hard-coded npm registry configuration
- Removed .npmrc which contained 'registry=https://registry.npmjs.org/'
- Avoids committing environment-specific npm registry configuration; rely on user or CI environment settings instead
## 2025-08-18 - 11.2.6 - fix(fs)
Improve fs and stream handling, enhance SmartFile/StreamFile, update tests and CI configs
- Fix listFileTree to correctly handle '**/' patterns by running both root and nested patterns and deduplicating results.
- Enhance waitForFileToBeReady: support directory paths (wait for first file) and improved file-stability checks with timeouts and retries.
- StreamFile improvements: support Web ReadableStream -> Node Readable conversion, better multi-use buffering, more robust fromUrl/fromBuffer/fromStream implementations, and accurate byte-length computation.
- SmartFile updates: switch fromUrl to SmartRequest, robust rename (optional on-disk rename), safer read/write paths and consistent Buffer handling for hashing and content edits.
- fs module tweaks: copy/copySync gained replaceTargetDir option, improved toObjectSync error messages, toReadStream now validates existence, and various synchronous/async API consistency fixes.
- memory module: consistent async/sync write APIs and smartfileArrayToFs formatting/behavior fixes.
- fsstream: improved stream processing and SmartReadStream robustness (error handling, read logic and watcher improvements).
- Tests: reformatted and strengthened tests (more explicit assertions, added tests for '**/*.ts' and '**/*' edge cases, updated imports to tapbundle usage).
- CI/workflows: updated IMAGE and NPMCI_COMPUTED_REPOURL values and switched npmci package install to @ship.zone/npmci in workflow files.
- package.json: bumped various dependencies, updated test script (timeout, logfile), added typings/main fields, homepage fix, pnpm overrides and minor metadata fixes.
- .gitignore: added entries for AI tool folders (.claude/, .serena/).
- Docs/readme: expanded README with clearer examples, features and TypeScript usage; updated readme hints for listFileTree behavior.
## 2025-05-26 - 11.2.5 - fix(dev)
Update dev dependencies and add local permission settings
- Bump @git.zone/tsbuild from 2.5.2 to 2.6.4
- Bump @git.zone/tstest from 1.9.0 to 2.2.5
- Add .claude/settings.local.json to configure permissions for Bash(pnpm test:\*)
## 2025-05-24 - 11.2.4 - fix(config)
Add local permissions configuration for pnpm test commands in .claude/settings.local.json
- Introduced .claude/settings.local.json to allow Bash(pnpm test:\*) permissions
- Ensured local testing commands have proper execution rights
## 2025-05-21 - 11.2.2 - fix(tests/settings)
Improve test assertions and update local settings permissions
- Refactor StreamFile tests to assert content string type using toBeTypeofString
- Update file existence tests to use resolves.toBeTrue and resolves.toBeFalse for cleaner promise handling
- Add .claude/settings.local.json to allow specific Bash permissions for pnpm test commands
## 2025-05-21 - 11.2.1 - fix(fs)
Fix inconsistent glob matching in listFileTree and update test imports and dependency versions for enhanced stability.
- Enhanced listFileTree to support \*\*/ patterns by using dual patterns (root and nested) with deduplication.
- Updated test imports to use '@git.zone/tstest/tapbundle' for consistency across test files.
- Bumped dependency versions (@push.rocks/lik, smartpromise, smartrequest, glob) in package.json.
- Added npm configuration (.npmrc) and local settings for improved test verbosity.
## 2025-01-29 - 11.2.0 - feat(fs)
Enhanced copy method with optional replaceTargetDir option for directory replacement
- Added optional 'replaceTargetDir' option to 'copy' and 'copySync' methods in 'fs.ts'.
- The 'replaceTargetDir' option allows replacing the target directory if both source and target are directories.
## 2025-01-29 - 11.1.9 - fix(fs)
Fix directory handling in copy and copySync functions
- Ensured existing directories at destination are removed before copying over them in async copy.
- Added a similar check and handling for synchronous copySync when destination is a directory.
## 2025-01-29 - 11.1.8 - fix(fs)
Fixed copy and copySync functions to ensure they always overwrite files.
- Fixed bug in copy function where files were not being overwritten when they already existed at the destination.
- Fixed bug in copySync function to ensure files are overwritten to match the async function's behavior.
## 2025-01-29 - 11.1.7 - fix(fs)
Refactor copy and copySync functions to simplify return type
- Changed the return type of fs.copy and fs.copySync from boolean to void.
- Removed unnecessary promise handling in fs.copy.
## 2025-01-29 - 11.1.6 - fix(fs)
Fix issues with fs file copy functions.
- Updated dependencies in package.json.
- Corrected comments for asynchronous and synchronous file copy functions in fs.ts.
## 2025-01-07 - 11.1.5 - fix(fs)
Improve waitForFileToBeReady function to handle directories and file stabilization
- Enhanced the waitForFileToBeReady to handle directory paths by checking for file existence within directories and waiting for stabilization.
- Modified the watcher logic to cater to changes when monitoring directories for file appearance.
- Introduced a helper function to ensure paths exist and another to resolve the first file in directories.
- Corrected logic for polling and stabilizing files within directories.
## 2025-01-07 - 11.1.4 - fix(fs)
Fix file existence check in waitForFileToBeReady method.
- Ensured that the directory and file exist before setting up the watcher in waitForFileToBeReady.
- Changed ensureDirectoryExists to ensureFileExists for correct file path verification.
- Handled ENOENT errors correctly to retry file existence checks until timeout is reached.
## 2025-01-07 - 11.1.3 - fix(fs)
Fix TypeScript type issue in fs module
- Corrected a TypeScript type in the fs module's checkFileStability function.
## 2025-01-07 - 11.1.2 - fix(fs)
Fix issues in file stability check and directory existence verification in fs module
- Removed unused variable 'isFileAvailable' in 'waitForFileToBeReady'.
- Fixed logic for ensuring the target directory exists before setting up file stability watcher.
- Refactored directory existence logic into 'ensureDirectoryExists' function.
## 2025-01-07 - 11.1.1 - fix(fs)
Improve waitForFileToBeReady function for file stability detection
- Enhanced error handling and file stability checks in waitForFileToBeReady function
- Added timeout feature for file readiness check
- Improved directory access check before file availability check
## 2025-01-07 - 11.1.0 - feat(SmartFile)
Add rename functionality to SmartFile class
- Implemented a new method to rename a file within the SmartFile class.
- The rename method updates the file path and optionally writes the renamed file to the disk.
## 2024-12-15 - 11.0.23 - fix(fs)
Handle errors in toObjectSync method
- Added error handling in toObjectSync function to capture and provide more informative error messages.
## 2024-06-23 - 11.0.22 - fix(core)
Update dependencies and changelog
- Updated @push.rocks/smartstream to ^3.0.44
- Updated glob to ^10.4.2
- Updated @types/node to ^20.14.8
## 2024-06-23 - 11.0.21 - fix(dependencies)
Update dependencies to latest versions
- Updated @push.rocks/smartpromise to ^4.0.4
- Updated @push.rocks/smartstream to ^3.0.44
- Updated glob to ^10.4.2
- Updated @types/node to ^20.14.8
## 2024-06-07 - 11.0.20 - Changelog
11.0.20
## 2024-06-07 - 11.0.19 - fix(core): update
11.0.19
- fix(core): update
## 2024-06-07 - 11.0.18 - fix(core): update
11.0.18
- fix(core): update
## 2024-06-06 - 11.0.17 - fix(core): update
11.0.17
- fix(core): update
## 2024-06-06 - 11.0.16 - fix(core): update
11.0.16
- fix(core): update
## 2024-05-29 - 11.0.16 - update description
11.0.16
- update description
## 2024-05-17 - 11.0.15 - fix(core): update
11.0.15
- fix(core): update
## 2024-04-14 - 11.0.14 - update tsconfig
11.0.14
- update tsconfig
## 2024-04-12 - 11.0.13 - fix(core): update
11.0.13
- fix(core): update
## 2024-04-12 - 11.0.12 - fix(core): update
11.0.12
- fix(core): update
## 2024-04-12 - 11.0.11 - fix(core): update
11.0.11
- fix(core): update
## 2024-04-03 - 11.0.10 - fix(core): update
11.0.10
- fix(core): update
## 2024-04-03 - 11.0.9 - fix(core): update
11.0.9
- fix(core): update
## 2024-04-02 - 11.0.8 - fix(core): update
11.0.8
- fix(core): update
## 2024-04-02 - 11.0.7 - fix(core): update
11.0.7
- fix(core): update
## 2024-04-02 - 11.0.6 - fix(core): update
11.0.6
- fix(core): update
## 2024-04-01 - 11.0.5 - update npmextra.json
11.0.5
- update npmextra.json: githost
## 2024-04-01 - 11.0.4 - fix(core): update
11.0.4
- fix(core): update
## 2023-11-24 - 11.0.3 - fix(core): update
11.0.3
- fix(core): update
## 2023-11-07 - 11.0.2 - fix(core): update
11.0.2
- fix(core): update
## 2023-11-07 - 11.0.1 - fix(core): update
11.0.1
- fix(core): update
## 2023-11-06 - 11.0.0 - fix(core): update
11.0.0
- fix(core): update
## 2023-11-06 - 10.0.40 - BREAKING CHANGE(core): update
10.0.40
- BREAKING CHANGE(core): update
## 2023-11-04 - 10.0.39 - fix(core): update
10.0.39
- fix(core): update
## 2023-11-04 - 10.0.38 - fix(core): update
10.0.38
- fix(core): update
## 2023-11-04 - 10.0.37 - fix(core): update
10.0.37
- fix(core): update
## 2023-11-03 - 10.0.36 - fix(core): update
10.0.36
- fix(core): update
## 2023-11-03 - 10.0.35 - fix(core): update
10.0.35
- fix(core): update
## 2023-11-03 - 10.0.34 - fix(core): update
10.0.34
- fix(core): update
## 2023-11-03 - 10.0.33 - fix(core): update
10.0.33
- fix(core): update
## 2023-10-12 - 10.0.32 - fix(core): update
10.0.32
- fix(core): update
## 2023-09-22 - 10.0.31 - fix(core): update
10.0.31
- fix(core): update
## 2023-08-31 - 10.0.30 - fix(core): update
10.0.30
- fix(core): update
## 2023-08-23 - 10.0.29 - fix(core): update
10.0.29
- fix(core): update
## 2023-07-12 - 10.0.28 - fix(core): update
10.0.28
- fix(core): update
## 2023-07-10 - 10.0.27 - fix(core): update
10.0.27
- fix(core): update
## 2023-07-10 - 10.0.26 - fix(core): update
10.0.26
- fix(core): update
## 2023-07-08 - 10.0.25 - fix(core): update
10.0.25
- fix(core): update
## 2023-06-25 - 10.0.24 to 10.0.14 - Series of Fixes
10.0.24 to 10.0.14
- Series of fixes in the core module
## 2023-01-09 - 10.0.13 to 10.0.6 - Series of Fixes
10.0.13 to 10.0.6
- Series of fixes in the core module
## 2022-09-05 - 10.0.5 to 10.0.3 - Series of Fixes
10.0.5 to 10.0.3
- Series of fixes in the core module
## 2022-06-07 - 10.0.2 to 10.0.1 - Series of Fixes
10.0.2 to 10.0.1
- Series of fixes in the core module
## 2022-06-07 - 9.0.7 - BREAKING CHANGE(core): switch to esm
9.0.7
- BREAKING CHANGE(core): switch to esm
## 2022-03-11 - 9.0.6 to 9.0.2 - Series of Fixes
9.0.6 to 9.0.2
- Series of fixes in the core module
## 2021-12-01 - 9.0.1 - fix(core): update
9.0.1
- fix(core): update
## 2021-12-01 - 9.0.0 - fix(absolute pathing)
9.0.0
- add functions for easily getting absolute paths
## 2021-11-30 - 8.0.11 - BREAKING CHANGE(relative pathing)
8.0.11
- improved relative pathing
## 2020-08-10 - 8.0.10 to 7.0.12 - Series of Fixes and Updates
8.0.10 to 7.0.12
- Series of fixes in the core module
- BREAKING CHANGE(Smartfile class): switch to a Buffer-only approach
## 2019-02-17 - 7.0.0 - fix(core): update dependencies
7.0.0
- fix(core): update dependencies
## 2019-01-27 - 6.0.12 - BREAKING CHANGE(smartfile.fs.fileExists)
6.0.12
- now returns a Promise<boolean>
## 2018-08-19 - 6.0.11 to 6.0.6 - Series of Fixes
6.0.11 to 6.0.6
- Series of fixes in core and dependencies
## 2018-07-03 - 6.0.5 to 5.0.0 - Series of Fixes
6.0.5 to 5.0.0
- Series of fixes in core and dependencies
## 2018-02-16 - 4.2.28 - BREAKING CHANGE(scope)
4.2.28
- switch to pushrocks scope

View File

@@ -10,9 +10,36 @@
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "smartfile",
"description": "smart ways to work with files in nodejs",
"description": "Provides comprehensive tools for efficient file management in Node.js using TypeScript, including handling streams, virtual directories, and various file operations.",
"npmPackagename": "@push.rocks/smartfile",
"license": "MIT"
"license": "MIT",
"keywords": [
"file management",
"TypeScript",
"Node.js",
"file operations",
"file manipulation",
"file streaming",
"virtual directory",
"filesystem utilities",
"memory-efficient file handling",
"custom file operations",
"write files",
"read files",
"copy files",
"delete files",
"list directories",
"handle large files",
"virtual filesystems",
"buffer operations"
]
}
},
"tsdoc": {
"classes": ["SmartFile", "StreamFile"],
"descriptions": [
"the purpose of the StreamFile class is to provide a hybrid interface between streaming files and simple handling when writing and reading those files multiple times."
],
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
}
}

View File

@@ -1,54 +1,72 @@
{
"name": "@push.rocks/smartfile",
"private": false,
"version": "11.0.5",
"description": "offers smart ways to work with files in nodejs",
"version": "13.0.0",
"description": "High-level file representation classes (SmartFile, StreamFile, VirtualDirectory) for efficient in-memory file management in Node.js using TypeScript. Works seamlessly with @push.rocks/smartfs for filesystem operations.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": {
"test": "(tstest test/)",
"test": "(tstest test/ --verbose --logfile --timeout 120)",
"build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc"
},
"repository": {
"type": "git",
"url": "git+https://gitlab.com/push.rocks/smartfile.git"
"url": "https://code.foss.global/push.rocks/smartfile.git"
},
"keywords": [
"filesystem",
"json"
"file management",
"TypeScript",
"Node.js",
"in-memory files",
"SmartFile",
"StreamFile",
"VirtualDirectory",
"file representation",
"file streaming",
"virtual directory",
"file factory",
"memory-efficient file handling",
"buffer operations",
"file content manipulation"
],
"author": "Lossless GmbH <hello@lossless.com> (https://lossless.com)",
"license": "MIT",
"bugs": {
"url": "https://gitlab.com/push.rocks/smartfile/issues"
"url": "https://code.foss.global/push.rocks/smartfile/issues"
},
"homepage": "https://gitlab.com/push.rocks/smartfile#readme",
"homepage": "https://code.foss.global/push.rocks/smartfile#readme",
"dependencies": {
"@push.rocks/lik": "^6.0.12",
"@push.rocks/lik": "^6.2.2",
"@push.rocks/smartdelay": "^3.0.5",
"@push.rocks/smartfile-interfaces": "^1.0.7",
"@push.rocks/smarthash": "^3.0.4",
"@push.rocks/smartjson": "^5.0.10",
"@push.rocks/smartmime": "^1.0.5",
"@push.rocks/smartpath": "^5.0.11",
"@push.rocks/smartpromise": "^4.0.2",
"@push.rocks/smartrequest": "^2.0.21",
"@push.rocks/smartstream": "^3.0.30",
"@push.rocks/smarthash": "^3.2.3",
"@push.rocks/smartjson": "^5.0.20",
"@push.rocks/smartmime": "^2.0.4",
"@push.rocks/smartpath": "^6.0.0",
"@push.rocks/smartpromise": "^4.2.3",
"@push.rocks/smartrequest": "^4.2.1",
"@push.rocks/smartstream": "^3.2.5",
"@types/fs-extra": "^11.0.4",
"@types/glob": "^8.1.0",
"@types/js-yaml": "^4.0.9",
"fs-extra": "^11.1.1",
"glob": "^10.3.10",
"fs-extra": "^11.3.1",
"glob": "^11.0.3",
"js-yaml": "^4.1.0"
},
"peerDependencies": {
"@push.rocks/smartfs": "^1.0.0"
},
"peerDependenciesMeta": {
"@push.rocks/smartfs": {
"optional": true
}
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.70",
"@git.zone/tsrun": "^1.2.46",
"@git.zone/tstest": "^1.0.84",
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.10.0"
"@git.zone/tsbuild": "^2.6.4",
"@git.zone/tsrun": "^1.3.3",
"@git.zone/tstest": "^2.3.4",
"@types/node": "^22.15.21"
},
"files": [
"ts/**/*",
@@ -64,5 +82,9 @@
],
"browserslist": [
"last 1 chrome versions"
]
],
"packageManager": "pnpm@10.10.0+sha512.d615db246fe70f25dcfea6d8d73dee782ce23e2245e3c4f6f888249fb568149318637dca73c2c5c8ef2a4ca0d5657fb9567188bfab47f566d1ee6ce987815c39",
"pnpm": {
"overrides": {}
}
}

13156
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

168
readme.hints.md Normal file
View File

@@ -0,0 +1,168 @@
# SmartFile Implementation Hints
## Major Architectural Change (v12.0.0)
### Overview
SmartFile has been refactored to focus exclusively on **in-memory file representations** (SmartFile, StreamFile, VirtualDirectory). All filesystem operations have been moved to or delegated to `@push.rocks/smartfs`.
### Key Changes
1. **Factory Pattern Introduction**
- New `SmartFileFactory` class introduced
- Factory is bound to a `SmartFs` instance (from `@push.rocks/smartfs`)
- All file instances are created through the factory
- Factory methods: `fromFilePath()`, `fromUrl()`, `fromBuffer()`, `fromString()`, etc.
2. **SmartFile, StreamFile, VirtualDirectory**
- Now accept optional `smartFs` parameter in constructor
- Filesystem operations (write, read, delete) use `smartFs` if available
- Fallback to legacy methods if `smartFs` not provided (for backward compatibility)
- Static factory methods moved to `SmartFileFactory`
3. **Separation of Concerns**
- **SmartFile** = In-memory file representation (path + content buffer)
- **StreamFile** = Lazy-loaded streaming file representation
- **VirtualDirectory** = Collection of SmartFiles in memory
- **SmartFs** (from @push.rocks/smartfs) = Filesystem operations
### Usage Pattern
```typescript
import { SmartFileFactory } from '@push.rocks/smartfile';
import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
// Create factory with SmartFs instance
const smartFs = new SmartFs(new SmartFsProviderNode());
const factory = new SmartFileFactory(smartFs);
// Or use default Node.js factory
const factory = SmartFileFactory.nodeFs();
// Create SmartFile through factory
const file = await factory.fromFilePath('./data.json');
await file.write(); // Uses bound smartFs instance
// Create StreamFile
const stream = await factory.streamFromPath('./large.zip');
// Create VirtualDirectory
const vdir = await factory.virtualDirectoryFromPath('./src');
```
### What Belongs Where
**SmartFile/StreamFile/VirtualDirectory (this package)**:
- ✅ In-memory file representation
- ✅ Content manipulation (edit, parse, transform)
- ✅ Loading content FROM sources (factory methods)
- ✅ Saving content TO destinations (write methods)
- ✅ Instance metadata (hash, size, mime type)
- ✅ Collection operations (for VirtualDirectory)
**SmartFs (@push.rocks/smartfs)**:
- ✅ Filesystem queries (exists, stat)
- ✅ File operations without content loading (copy, move)
- ✅ Directory operations (list, create, delete)
- ✅ Streaming operations (readStream, writeStream)
- ✅ Provider abstraction (Node.js, memory, S3, etc.)
### VirtualDirectory Collection Methods
VirtualDirectory now has comprehensive collection methods:
**Queries** (operate on in-memory collection):
- `exists(path)` / `has(path)` - Check if path exists in collection
- `getFileByPath(path)` - Get SmartFile from collection
- `listFiles()` - List all SmartFiles
- `listDirectories()` - List directory paths represented in collection
- `filter(predicate)` - Filter SmartFiles
- `map(fn)` - Transform SmartFiles
- `find(predicate)` - Find SmartFile
- `size()` - Number of files in collection
- `isEmpty()` - Check if collection is empty
**Mutations**:
- `addSmartfiles(files)` - Add files to collection
- `addSmartfile(file)` - Add single file
- `removeByPath(path)` - Remove from collection
- `clear()` - Empty collection
- `merge(otherVDir)` - Merge another VirtualDirectory
### Backward Compatibility
- Legacy namespace exports (`fs`, `memory`, `fsStream`, `interpreter`) are **deprecated**
- They remain functional for transition period but marked with `@deprecated`
- Will be removed in future version
- Users should migrate to `@push.rocks/smartfs` and `SmartFileFactory`
### Migration Path
**Old (deprecated)**:
```typescript
import * as smartfile from '@push.rocks/smartfile';
const file = await smartfile.SmartFile.fromFilePath('./file.txt');
await file.write();
const exists = await smartfile.fs.fileExists('./file.txt');
await smartfile.fs.copy('./a.txt', './b.txt');
```
**New (recommended)**:
```typescript
import { SmartFileFactory } from '@push.rocks/smartfile';
import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
const factory = SmartFileFactory.nodeFs();
const file = await factory.fromFilePath('./file.txt');
await file.write();
const smartFs = new SmartFs(new SmartFsProviderNode());
const exists = await smartFs.file('./file.txt').exists();
await smartFs.file('./a.txt').copy('./b.txt');
```
### Testing Considerations
- Tests should use `SmartFileFactory.nodeFs()` or create custom factory with memory provider
- VirtualDirectory tests can use collection methods without filesystem access
- Filesystem operations should be tested via `@push.rocks/smartfs`
### Future Plans
- Remove deprecated namespace exports completely
- Full smartfs integration (remove fallback code)
- Potentially remove fs-extra, glob dependencies once smartfs is fully integrated
## listFileTree Function Enhancement (ts/fs.ts:367-415)
### Issue Fixed
The `listFileTree` function previously had inconsistent behavior with `**/*.extension` patterns across different systems and glob implementations. Some implementations would miss root-level files when using patterns like `**/*.ts`.
### Solution Implemented
Modified the function to explicitly handle `**/` patterns by:
1. Detecting when a pattern starts with `**/`
2. Extracting the file pattern after `**/` (e.g., `*.ts` from `**/*.ts`)
3. Running both the original pattern and the extracted root pattern
4. Using a Set to deduplicate results and ensure consistent ordering
### Key Benefits
- Guarantees consistent behavior across all systems
- Ensures both root-level and nested files are found with `**/*` patterns
- Maintains backward compatibility
- No performance degradation due to efficient deduplication
### Test Coverage
Added comprehensive tests to verify:
- Both root and nested files are found with `**/*.ts`
- No duplicate entries in results
- Edge cases with various file extensions work correctly
This fix ensures tools like `tsbuild check **/*.ts` work reliably across all systems.

527
readme.md
View File

@@ -1,126 +1,507 @@
# SmartFile
> SmartFile offers smart ways to work with files in nodejs.
# @push.rocks/smartfile 📁
## Install
To install SmartFile, use npm or Yarn as follows:
> **High-level file representation classes for Node.js**
```
npm install @push.rocks/smartfile --save
```
Or:
```
yarn add @push.rocks/smartfile
## 🚀 What is smartfile?
`@push.rocks/smartfile` provides powerful **in-memory file representations** for Node.js applications. It offers clean, TypeScript-first classes for working with files (`SmartFile`), streams (`StreamFile`), and virtual file collections (`VirtualDirectory`).
Think of it as your go-to solution for **content manipulation**, **file transformations**, and **in-memory file operations** - all while seamlessly integrating with [@push.rocks/smartfs](https://code.foss.global/push.rocks/smartfs) for actual filesystem operations.
## 💾 Installation
```bash
pnpm install @push.rocks/smartfile
# Optional: Install smartfs for filesystem operations
pnpm install @push.rocks/smartfs
```
## Usage
## ✨ Key Features
SmartFile is a comprehensive toolkit for file manipulation in Node.js. It provides functionalities for working with the filesystem, in-memory operations, streaming, and handling virtual directories. Below, you will find examples showcasing how to utilize these functionalities effectively.
- 🎯 **Factory Pattern** - Clean, consistent API for creating file instances
- 🔥 **Streaming Support** - Handle massive files efficiently with `StreamFile`
- 📦 **Virtual Directories** - Work with in-memory file collections
- 🌐 **URL Support** - Directly fetch files from URLs
- 🎨 **Content Manipulation** - Edit, transform, and parse file content
-**TypeScript First** - Full type safety and IntelliSense support
- 🛠️ **Comprehensive Collection API** - Filter, map, find files in virtual directories
### Basic File Operations
## 📚 Quick Start
For reading and writing files, SmartFile provides synchronous and asynchronous methods. Heres how you can use them:
#### Async Write to File
### Using the Factory
```typescript
import { memory } from '@push.rocks/smartfile';
import { SmartFileFactory } from '@push.rocks/smartfile';
const myData: string = 'Hello, SmartFile!';
// Create factory (uses Node.js filesystem by default)
const factory = SmartFileFactory.nodeFs();
// Writing string data to a file asynchronously
memory.toFs(myData, './data/hello.txt');
// Load a file into memory
const file = await factory.fromFilePath('./config.json');
// Edit content
await file.editContentAsString(async (content) => {
return content.toUpperCase();
});
// Save back to disk
await file.write();
```
#### Sync Write to File
### With SmartFs Integration
```typescript
import { memory } from '@push.rocks/smartfile';
import { SmartFileFactory } from '@push.rocks/smartfile';
import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
const myData: string = 'Hello, World!';
// Create SmartFs instance with provider
const smartFs = new SmartFs(new SmartFsProviderNode());
// Writing string data to a file synchronously
memory.toFsSync(myData, './data/helloSync.txt');
// Create factory bound to this filesystem
const factory = new SmartFileFactory(smartFs);
// Now all file operations use the smartfs instance
const file = await factory.fromFilePath('./data.json');
await file.write(); // Uses smartfs under the hood
```
### Working with Streams
## 🎨 Core Components
Streaming files to and from the filesystem is made easy with SmartFile. Heres an example:
### SmartFileFactory
#### Creating Read and Write Streams
The factory is your entry point for creating all file instances:
```typescript
import { fsStream } from '@push.rocks/smartfile';
import * as fs from 'fs';
import { SmartFileFactory } from '@push.rocks/smartfile';
// Creating a read stream
const readStream = fsStream.createReadStream('./data/readme.txt');
const factory = SmartFileFactory.nodeFs();
// Creating a write stream
const writeStream = fsStream.createWriteStream('./data/copy.txt');
// Create from various sources
const fileFromPath = await factory.fromFilePath('./data.json');
const fileFromUrl = await factory.fromUrl('https://example.com/config.json');
const fileFromBuffer = factory.fromBuffer('./file.txt', Buffer.from('content'));
const fileFromString = factory.fromString('./file.txt', 'Hello World', 'utf8');
// Piping the read stream to the write stream
readStream.pipe(writeStream);
// Create StreamFile instances
const stream = await factory.streamFromPath('./large-file.zip');
const streamFromUrl = await factory.streamFromUrl('https://example.com/video.mp4');
// Create VirtualDirectory instances
const vdir = await factory.virtualDirectoryFromPath('./src');
const emptyVdir = factory.virtualDirectoryEmpty();
```
### Dealing with Virtual Directories
### SmartFile Class
Virtual directories allow you to group and manipulate files as if they were in a filesystem structure without actually writing them to disk.
Represents a single file loaded in memory:
```typescript
import { VirtualDirectory } from '@push.rocks/smartfile';
// Created via factory
const file = await factory.fromFilePath('./data.json');
(async () => {
// Creating a virtual directory from the file system
const virtualDir = await VirtualDirectory.fromFsDirPath('./myDirectory');
// Content access
const asString = file.parseContentAsString();
const asBuffer = file.parseContentAsBuffer();
// Adding files from another virtual directory
const anotherVirtualDir = await VirtualDirectory.fromFsDirPath('./anotherDirectory');
await virtualDir.addVirtualDirectory(anotherVirtualDir, 'merged');
// Content manipulation
await file.editContentAsString(async (content) => {
const data = JSON.parse(content);
data.updated = new Date().toISOString();
return JSON.stringify(data, null, 2);
});
// Saving the virtual directory to disk
await virtualDir.saveToDisk('./outputDirectory');
})();
// File operations
await file.write(); // Save to original location
await file.writeToDiskAtPath('./output.json'); // Save to specific path
await file.writeToDir('./dist'); // Save to directory
await file.read(); // Reload from disk
await file.delete(); // Delete from disk
// Metadata
const size = await file.getSize(); // File size in bytes
const hash = await file.getHash('content'); // SHA256 hash
const stream = file.getStream(); // Get as Node.js stream
// Path information
console.log(file.path); // Relative path
console.log(file.absolutePath); // Absolute path
console.log(file.parsedPath); // Parsed path components
```
### Advanced File Manipulation
### StreamFile Class
SmartFile also allows for more advanced file manipulation techniques through the `SmartFile` class.
Perfect for handling large files without memory overhead:
```typescript
import { SmartFile } from '@push.rocks/smartfile';
// Created via factory
const streamFile = await factory.streamFromPath('./bigfile.zip');
(async () => {
// Create a SmartFile instance from a file path
const smartFile = await SmartFile.fromFilePath('./data/example.txt');
// Or from URL
const urlStream = await factory.streamFromUrl('https://example.com/large.mp4');
// Edit the file content
await smartFile.editContentAsString(async (currentContent: string) => {
return currentContent.toUpperCase();
// Or from buffer
const bufferStream = factory.streamFromBuffer(Buffer.from('content'));
// Write to disk (streams the content)
await streamFile.writeToDisk('./output/bigfile.zip');
await streamFile.writeToDir('./output');
// Get content (loads into memory - use carefully!)
const buffer = await streamFile.getContentAsBuffer();
const string = await streamFile.getContentAsString('utf8');
// Get as Node.js stream for piping
const readStream = await streamFile.createReadStream();
// Convert to SmartFile (loads into memory)
const smartFile = await streamFile.toSmartFile();
// Get file size
const size = await streamFile.getSize();
```
### VirtualDirectory Class
Manage collections of SmartFiles in memory:
```typescript
// Created via factory
const vdir = await factory.virtualDirectoryFromPath('./src');
// Or create empty
const emptyVdir = factory.virtualDirectoryEmpty();
// Or from file array
const files = [file1, file2, file3];
const vdirFromFiles = factory.virtualDirectoryFromFileArray(files);
// ============================================
// Collection Queries (in-memory operations)
// ============================================
// Check existence in collection
if (vdir.exists('components/Button.tsx')) {
console.log('File exists in virtual directory');
}
// Get file from collection
const file = await vdir.getFileByPath('utils/helpers.ts');
// List all files
const allFiles = vdir.listFiles();
// List directory paths represented in collection
const dirs = vdir.listDirectories();
// Filter files
const tsFiles = vdir.filter(f => f.path.endsWith('.ts'));
const largeFiles = vdir.filter(f => f.contentBuffer.length > 10000);
// Map/transform files
const uppercased = vdir.map(f => {
f.contentBuffer = Buffer.from(f.parseContentAsString().toUpperCase());
return f;
});
// Find specific file
const configFile = vdir.find(f => f.path.includes('config'));
// Collection info
const fileCount = vdir.size();
const empty = vdir.isEmpty();
// ============================================
// Collection Mutations
// ============================================
// Add files
vdir.addSmartfile(newFile);
vdir.addSmartfiles([file1, file2, file3]);
// Remove file
vdir.removeByPath('old-file.ts');
// Clear all files
vdir.clear();
// Merge another virtual directory
vdir.merge(otherVirtualDir);
// ============================================
// Load/Save (filesystem bridge operations)
// ============================================
// Save all files to disk
await vdir.saveToDisk('./dist');
// Reload from disk
await vdir.loadFromDisk('./src');
// Work with subdirectories
const subVdir = await vdir.shiftToSubdirectory('components');
await vdir.addVirtualDirectory(otherVdir, 'lib');
```
## 🔄 Integration with SmartFs
For filesystem operations beyond loading/saving content, use [@push.rocks/smartfs](https://code.foss.global/push.rocks/smartfs):
```typescript
import { SmartFileFactory } from '@push.rocks/smartfile';
import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
const smartFs = new SmartFs(new SmartFsProviderNode());
const factory = new SmartFileFactory(smartFs);
// Use smartfile for content manipulation
const file = await factory.fromFilePath('./config.json');
await file.editContentAsString(async (s) => s.toUpperCase());
await file.write();
// Use smartfs for filesystem operations
const exists = await smartFs.file('./config.json').exists();
await smartFs.file('./config.json').copy('./config.backup.json');
const stats = await smartFs.file('./config.json').stat();
// List directory with smartfs
const entries = await smartFs.directory('./src').list();
```
## 🌟 Common Use Cases
### Configuration File Management
```typescript
const factory = SmartFileFactory.nodeFs();
// Load, modify, and save config
const config = await factory.fromFilePath('./package.json');
await config.editContentAsString(async (content) => {
const pkg = JSON.parse(content);
pkg.version = '2.0.0';
return JSON.stringify(pkg, null, 2);
});
await config.write();
```
### Batch File Processing
```typescript
const factory = SmartFileFactory.nodeFs();
// Load directory into virtual collection
const vdir = await factory.virtualDirectoryFromPath('./content');
// Process all markdown files
const mdFiles = vdir.filter(f => f.path.endsWith('.md'));
for (const file of mdFiles.listFiles()) {
await file.editContentAsString(async (content) => {
// Add frontmatter, transform links, etc.
return `---\nprocessed: true\n---\n\n${content}`;
});
}
// Write the changes back to disk
await smartFile.write();
})();
// Save processed files
await vdir.saveToDisk('./dist/content');
```
### Conversion and Interpretation
You can easily convert file contents to objects or interpret file types for further processing:
### Download and Process Remote Files
```typescript
import { memory } from '@push.rocks/smartfile';
const factory = SmartFileFactory.nodeFs();
(async () => {
const fileString: string = await fs.promises.readFile('./data/example.json', 'utf8');
const fileObject = memory.toObject(fileString, 'json');
// Fetch from URL
const remoteFile = await factory.fromUrl('https://api.example.com/data.json');
console.log(fileObject);
// Proceed with the object...
})();
// Process content
await remoteFile.editContentAsString(async (content) => {
const data = JSON.parse(content);
// Transform data
return JSON.stringify(data.results, null, 2);
});
// Save locally
await remoteFile.writeToDiskAtPath('./cache/data.json');
```
SmartFile simplifies handling files in a Node.js environment, providing a concise, promise-based API for various file operations, stream handling, and in-memory file manipulation. Whether you're dealing with physical files on the disk, manipulating file streams, or managing virtual files and directories, SmartFile has got you covered.
### Large File Streaming
## Information on Licensing
```typescript
const factory = SmartFileFactory.nodeFs();
SmartFile is licensed under the MIT License. This permissive license is short and to the point. It lets people do anything they want with your code as long as they provide attribution back to you and dont hold you liable.
// Download large file as stream
const largeFile = await factory.streamFromUrl('https://example.com/large-dataset.csv');
// Save to disk (streams, doesn't load all into memory)
await largeFile.writeToDisk('./data/dataset.csv');
// Or get size without downloading entire file
const size = await largeFile.getSize();
console.log(`File size: ${size} bytes`);
```
### Virtual File System for Testing
```typescript
import { SmartFileFactory } from '@push.rocks/smartfile';
import { SmartFs, SmartFsProviderMemory } from '@push.rocks/smartfs';
// Use in-memory filesystem for tests
const memoryFs = new SmartFs(new SmartFsProviderMemory());
const factory = new SmartFileFactory(memoryFs);
// Create virtual files
const testFile = factory.fromString('test.txt', 'test content');
await testFile.write(); // Writes to in-memory filesystem
// Test your code without touching real filesystem
```
## 🏗️ Architecture
### Responsibility Split
**@push.rocks/smartfile** (this package):
- ✅ In-memory file representations (SmartFile, StreamFile, VirtualDirectory)
- ✅ Content manipulation and transformation
- ✅ Loading content FROM sources (disk, URL, buffer, string)
- ✅ Saving content TO destinations (disk, stream)
- ✅ Collection operations (filter, map, find on VirtualDirectory)
**@push.rocks/smartfs**:
- ✅ Low-level filesystem operations (exists, stat, copy, move, delete)
- ✅ Directory operations (list, create, remove)
- ✅ Provider abstraction (Node.js fs, in-memory, S3, etc.)
- ✅ Streaming (readStream, writeStream)
- ✅ Transactions and file watching
## 📖 API Reference
### SmartFileFactory
| Method | Description |
|--------|-------------|
| `SmartFileFactory.nodeFs()` | Create factory with Node.js filesystem provider |
| `new SmartFileFactory(smartFs)` | Create factory with custom SmartFs instance |
| `factory.fromFilePath(path, base?)` | Load file from disk into SmartFile |
| `factory.fromUrl(url)` | Fetch file from URL into SmartFile |
| `factory.fromBuffer(path, buffer, base?)` | Create SmartFile from Buffer |
| `factory.fromString(path, content, encoding, base?)` | Create SmartFile from string |
| `factory.streamFromPath(path)` | Create StreamFile from disk |
| `factory.streamFromUrl(url)` | Create StreamFile from URL |
| `factory.streamFromBuffer(buffer, path?)` | Create StreamFile from Buffer |
| `factory.virtualDirectoryFromPath(path)` | Load directory into VirtualDirectory |
| `factory.virtualDirectoryEmpty()` | Create empty VirtualDirectory |
| `factory.virtualDirectoryFromFileArray(files)` | Create VirtualDirectory from SmartFiles |
### SmartFile Instance Methods
| Method | Description |
|--------|-------------|
| `file.write()` | Save to original location |
| `file.writeToDiskAtPath(path)` | Save to specific path |
| `file.writeToDir(dir)` | Save to directory (preserves relative path) |
| `file.read()` | Reload content from disk |
| `file.delete()` | Delete file from disk |
| `file.editContentAsString(fn)` | Transform content as string |
| `file.parseContentAsString(encoding?)` | Get content as string |
| `file.parseContentAsBuffer()` | Get content as Buffer |
| `file.getHash(type?)` | Get SHA256 hash ('path', 'content', 'all') |
| `file.getSize()` | Get content size in bytes |
| `file.getStream()` | Get content as Node.js Readable stream |
### StreamFile Instance Methods
| Method | Description |
|--------|-------------|
| `stream.writeToDisk(path)` | Stream content to disk |
| `stream.writeToDir(dir)` | Stream to directory |
| `stream.createReadStream()` | Get as Node.js Readable stream |
| `stream.getContentAsBuffer()` | Load entire content into Buffer |
| `stream.getContentAsString(encoding?)` | Load entire content as string |
| `stream.getSize()` | Get content size in bytes |
| `stream.toSmartFile()` | Convert to SmartFile (loads into memory) |
### VirtualDirectory Instance Methods
**Collection Queries:**
| Method | Description |
|--------|-------------|
| `vdir.exists(path)` | Check if file exists in collection |
| `vdir.has(path)` | Alias for exists() |
| `vdir.getFileByPath(path)` | Get SmartFile by path |
| `vdir.listFiles()` | Get all SmartFiles |
| `vdir.listDirectories()` | Get all directory paths |
| `vdir.filter(predicate)` | Filter files, returns new VirtualDirectory |
| `vdir.map(fn)` | Transform files, returns new VirtualDirectory |
| `vdir.find(predicate)` | Find first matching file |
| `vdir.size()` | Get file count |
| `vdir.isEmpty()` | Check if empty |
**Collection Mutations:**
| Method | Description |
|--------|-------------|
| `vdir.addSmartfile(file)` | Add single file |
| `vdir.addSmartfiles(files)` | Add multiple files |
| `vdir.removeByPath(path)` | Remove file by path |
| `vdir.clear()` | Remove all files |
| `vdir.merge(otherVdir)` | Merge another VirtualDirectory |
**Load/Save:**
| Method | Description |
|--------|-------------|
| `vdir.saveToDisk(dir)` | Write all files to disk |
| `vdir.loadFromDisk(dir)` | Load files from disk (replaces collection) |
## 🔧 TypeScript Support
Full TypeScript support with comprehensive type definitions:
```typescript
import type { SmartFile, StreamFile, VirtualDirectory, SmartFileFactory } from '@push.rocks/smartfile';
const processFile = async (file: SmartFile): Promise<void> => {
const content = file.parseContentAsString();
// TypeScript knows content is string
};
```
## 📦 Backward Compatibility
Version 12.0.0 introduces the factory pattern. Legacy exports are deprecated but still functional:
```typescript
// ⚠️ Deprecated (still works, but will be removed)
import * as smartfile from '@push.rocks/smartfile';
const file = await smartfile.SmartFile.fromFilePath('./file.txt');
await smartfile.fs.copy('./a.txt', './b.txt');
// ✅ Recommended (new factory pattern)
import { SmartFileFactory } from '@push.rocks/smartfile';
const factory = SmartFileFactory.nodeFs();
const file = await factory.fromFilePath('./file.txt');
// For filesystem operations, use smartfs:
import { SmartFs, SmartFsProviderNode } from '@push.rocks/smartfs';
const smartFs = new SmartFs(new SmartFsProviderNode());
await smartFs.file('./a.txt').copy('./b.txt');
```
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

View File

@@ -0,0 +1,95 @@
/**
* Mock SmartFs implementation for testing until @push.rocks/smartfs is available
* This wraps fs-extra to provide the SmartFs interface
*/
import { ensureDir, pathExists, remove, copy } from 'fs-extra';
import { promises as fsPromises, createReadStream, createWriteStream } from 'fs';
import * as path from 'path';
import { Readable, Writable } from 'stream';
export class MockSmartFs {
public file(filePath: string) {
return {
async read(): Promise<string | Buffer> {
return await fsPromises.readFile(filePath);
},
async write(content: string | Buffer): Promise<void> {
await ensureDir(path.dirname(filePath));
await fsPromises.writeFile(filePath, content);
},
async exists(): Promise<boolean> {
return await pathExists(filePath);
},
async delete(): Promise<void> {
await remove(filePath);
},
async stat(): Promise<any> {
return await fsPromises.stat(filePath);
},
async readStream(): Promise<Readable> {
return Promise.resolve(createReadStream(filePath));
},
async writeStream(): Promise<Writable> {
await ensureDir(path.dirname(filePath));
return Promise.resolve(createWriteStream(filePath));
},
async copy(dest: string): Promise<void> {
await copy(filePath, dest);
},
};
}
public directory(dirPath: string) {
return {
async list(options?: { recursive?: boolean }): Promise<Array<{ path: string; isFile: boolean; isDirectory: boolean }>> {
const entries: Array<{ path: string; isFile: boolean; isDirectory: boolean }> = [];
if (options?.recursive) {
// Recursive listing
const walk = async (dir: string) => {
const items = await fsPromises.readdir(dir);
for (const item of items) {
const fullPath = path.join(dir, item);
const stats = await fsPromises.stat(fullPath);
if (stats.isFile()) {
entries.push({ path: fullPath, isFile: true, isDirectory: false });
} else if (stats.isDirectory()) {
entries.push({ path: fullPath, isFile: false, isDirectory: true });
await walk(fullPath);
}
}
};
await walk(dirPath);
} else {
// Non-recursive listing
const items = await fsPromises.readdir(dirPath);
for (const item of items) {
const fullPath = path.join(dirPath, item);
const stats = await fsPromises.stat(fullPath);
entries.push({
path: fullPath,
isFile: stats.isFile(),
isDirectory: stats.isDirectory(),
});
}
}
return entries;
},
async create(options?: { recursive?: boolean }): Promise<void> {
if (options?.recursive) {
await ensureDir(dirPath);
} else {
await fsPromises.mkdir(dirPath);
}
},
async exists(): Promise<boolean> {
return await pathExists(dirPath);
},
async delete(): Promise<void> {
await remove(dirPath);
},
};
}
}

View File

@@ -1,66 +1,154 @@
import * as path from 'path';
import { expect, tap } from '@push.rocks/tapbundle';
import * as smartfile from '../ts/index.js'; // adjust the import path as needed
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as smartfile from '../ts/index.js';
import { MockSmartFs } from './helpers/mock-smartfs.js';
// Create factory with MockSmartFs
const mockFs = new MockSmartFs();
const factory = new smartfile.SmartFileFactory(mockFs);
// Test assets path
const testAssetsPath = './test/testassets/';
// ---------------------------
// StreamFile tests
// StreamFile Factory Tests
// ---------------------------
tap.test('StreamFile.fromPath should create a StreamFile from a file path', async () => {
const streamFile = await smartfile.StreamFile.fromPath(path.join(testAssetsPath, 'mytest.json'));
expect(streamFile).toBeInstanceOf(smartfile.StreamFile);
const contentBuffer = await streamFile.getContentAsBuffer();
expect(contentBuffer).toBeInstanceOf(Buffer);
tap.test(
'SmartFileFactory.streamFromPath() -> should create a StreamFile from a file path',
async () => {
const streamFile = await factory.streamFromPath(
path.join(testAssetsPath, 'mytest.json'),
);
expect(streamFile).toBeInstanceOf(smartfile.StreamFile);
const contentBuffer = await streamFile.getContentAsBuffer();
expect(contentBuffer).toBeInstanceOf(Buffer);
},
);
tap.test(
'SmartFileFactory.streamFromBuffer() -> should create a StreamFile from a Buffer',
async () => {
const buffer = Buffer.from('Some content');
const streamFile = factory.streamFromBuffer(
buffer,
'bufferfile.txt',
);
expect(streamFile).toBeInstanceOf(smartfile.StreamFile);
const content = await streamFile.getContentAsBuffer();
expect(content.toString()).toEqual('Some content');
},
);
tap.test(
'SmartFileFactory.streamFromStream() -> should create a StreamFile from a stream',
async () => {
const { Readable } = await import('stream');
const stream = new Readable();
stream.push('stream content');
stream.push(null);
const streamFile = factory.streamFromStream(stream, 'streamfile.txt', false);
expect(streamFile).toBeInstanceOf(smartfile.StreamFile);
},
);
// ---------------------------
// StreamFile Instance Tests
// ---------------------------
tap.test('StreamFile -> should write the stream to disk', async () => {
const streamFile = await factory.streamFromPath(
path.join(testAssetsPath, 'mytest.json'),
);
const targetPath = path.join(testAssetsPath, 'temp', 'stream-mytest.json');
await streamFile.writeToDisk(targetPath);
// Verify the file was written by reading it back
const verifyFile = await factory.fromFilePath(targetPath);
expect(verifyFile.contentBuffer).toBeInstanceOf(Buffer);
});
tap.test('StreamFile.fromUrl should create a StreamFile from a URL', async () => {
const streamFile = await smartfile.StreamFile.fromUrl('http://example.com/somefile.json');
expect(streamFile).toBeInstanceOf(smartfile.StreamFile);
});
tap.test('StreamFile.fromBuffer should create a StreamFile from a Buffer', async () => {
const buffer = Buffer.from('Some content');
const streamFile = smartfile.StreamFile.fromBuffer(buffer, 'bufferfile.txt');
expect(streamFile).toBeInstanceOf(smartfile.StreamFile);
});
tap.test('StreamFile should write the stream to disk', async () => {
const streamFile = await smartfile.StreamFile.fromPath(path.join(testAssetsPath, 'mytest.json'));
await streamFile.writeToDisk(path.join(testAssetsPath, 'temp', 'mytest.json'));
// Verify the file was written
expect(
// We'll use the fileExists method from your smartfile library
// Replace with the actual method you use to check file existence
await smartfile.fs.fileExists(path.join(testAssetsPath, 'temp', 'mytest.json'))
).toBeTrue();
});
tap.test('StreamFile should write to a directory', async () => {
const streamFile = await smartfile.StreamFile.fromPath(path.join(testAssetsPath, 'mytest.json'));
tap.test('StreamFile -> should write to a directory', async () => {
const streamFile = await factory.streamFromPath(
path.join(testAssetsPath, 'mytest.json'),
);
// Set relative path so writeToDir knows where to put it
streamFile.relativeFilePath = 'mytest-fromdir.json';
await streamFile.writeToDir(path.join(testAssetsPath, 'temp'));
// Verify the file was written
expect(
await smartfile.fs.fileExists(path.join(testAssetsPath, 'temp', 'mytest.json'))
).toBeTrue();
const targetPath = path.join(testAssetsPath, 'temp', 'mytest-fromdir.json');
const verifyFile = await factory.fromFilePath(targetPath);
expect(verifyFile.contentBuffer).toBeInstanceOf(Buffer);
});
tap.test('StreamFile should return content as a buffer', async () => {
const streamFile = await smartfile.StreamFile.fromPath(path.join(testAssetsPath, 'mytest.json'));
tap.test('StreamFile -> should return content as a buffer', async () => {
const streamFile = await factory.streamFromPath(
path.join(testAssetsPath, 'mytest.json'),
);
const contentBuffer = await streamFile.getContentAsBuffer();
expect(contentBuffer).toBeInstanceOf(Buffer);
// Further checks on the content can be added here if necessary
});
tap.test('StreamFile should return content as a string', async () => {
const streamFile = await smartfile.StreamFile.fromPath(path.join(testAssetsPath, 'mytest.json'));
tap.test('StreamFile -> should return content as a string', async () => {
const streamFile = await factory.streamFromPath(
path.join(testAssetsPath, 'mytest.json'),
);
const contentString = await streamFile.getContentAsString();
expect(typeof contentString).toBeTypeofString();
expect(contentString).toBeTypeofString();
// Verify the content matches what's expected
// This assumes the file contains a JSON object with a key 'key1' with value 'this works'
expect(JSON.parse(contentString).key1).toEqual('this works');
const parsed = JSON.parse(contentString);
expect(parsed.key1).toEqual('this works');
});
tap.test('StreamFile -> should get size', async () => {
const buffer = Buffer.from('test content for size');
const streamFile = factory.streamFromBuffer(buffer, 'sizefile.txt');
const size = await streamFile.getSize();
expect(size).toEqual(buffer.length);
});
tap.test('StreamFile -> should handle multi-use streams', async () => {
const buffer = Buffer.from('multi-use content');
const streamFile = factory.streamFromBuffer(buffer, 'multiuse.txt');
streamFile.multiUse = true;
// Read multiple times
const content1 = await streamFile.getContentAsString();
const content2 = await streamFile.getContentAsString();
expect(content1).toEqual('multi-use content');
expect(content2).toEqual('multi-use content');
});
tap.test('StreamFile -> should convert to SmartFile', async () => {
const buffer = Buffer.from('convert to smartfile');
const streamFile = factory.streamFromBuffer(buffer, 'convert.txt');
const smartFile = await streamFile.toSmartFile();
expect(smartFile).toBeInstanceOf(smartfile.SmartFile);
expect(smartFile.parseContentAsString()).toEqual('convert to smartfile');
});
tap.test('StreamFile -> should create readable stream', async () => {
const buffer = Buffer.from('readable stream content');
const streamFile = factory.streamFromBuffer(buffer, 'readable.txt');
const stream = await streamFile.createReadStream();
expect(stream).toHaveProperty('pipe');
// Read from stream
const chunks: Buffer[] = [];
stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
await new Promise((resolve) => {
stream.on('end', resolve);
});
const content = Buffer.concat(chunks).toString();
expect(content).toEqual('readable stream content');
});
// Start the test sequence

View File

@@ -1,224 +1,142 @@
import * as smartfile from '../ts/index.js';
import * as path from 'path';
import { expect, tap } from '@git.zone/tstest/tapbundle';
import { MockSmartFs } from './helpers/mock-smartfs.js';
import { expect, tap } from '@push.rocks/tapbundle';
// Create factory with MockSmartFs
const mockFs = new MockSmartFs();
const factory = new smartfile.SmartFileFactory(mockFs);
// ---------------------------
// smartfile.fs
// SmartFileFactory Tests
// ---------------------------
tap.test('.fs.fileExistsSync -> should return an accurate boolean', async () => {
// tslint:disable-next-line: no-unused-expression
expect(smartfile.fs.fileExistsSync('./test/testassets/mytest.json')).toBeTrue();
// tslint:disable-next-line: no-unused-expression
expect(smartfile.fs.fileExistsSync('./test/testassets/notthere.json')).toBeFalse();
tap.test('SmartFileFactory.nodeFs() -> should create a default factory', async () => {
const defaultFactory = smartfile.SmartFileFactory.nodeFs();
expect(defaultFactory).toBeInstanceOf(smartfile.SmartFileFactory);
});
tap.test('.fs.fileExists -> should resolve or reject a promise', async () => {
expect(smartfile.fs.fileExists('./test/testassets/mytest.json')).toBeInstanceOf(Promise);
await smartfile.fs.fileExists('./test/testassets/mytest.json');
await smartfile.fs.fileExists('./test/testassets/notthere.json').catch((err) => {
return expect(err.message).toEqual(
"ENOENT: no such file or directory, access './test/testassets/notthere.json'"
);
});
tap.test('SmartFileFactory.fromFilePath() -> should create a SmartFile from file path', async () => {
const smartFile = await factory.fromFilePath('./test/testassets/mytest.json', process.cwd());
expect(smartFile).toBeInstanceOf(smartfile.SmartFile);
expect(smartFile.path).toEqual('test/testassets/mytest.json');
expect(smartFile.contentBuffer).toBeInstanceOf(Buffer);
});
tap.test('.fs.listFoldersSync() -> should get the file type from a string', async () => {
expect(smartfile.fs.listFoldersSync('./test/testassets/')).toContain('testfolder');
expect(smartfile.fs.listFoldersSync('./test/testassets/')).not.toContain('notExistentFolder');
tap.test('SmartFileFactory.fromBuffer() -> should create a SmartFile from buffer', async () => {
const buffer = Buffer.from('test content');
const smartFile = factory.fromBuffer('./test.txt', buffer);
expect(smartFile).toBeInstanceOf(smartfile.SmartFile);
expect(smartFile.contentBuffer.toString()).toEqual('test content');
});
tap.test('.fs.listFolders() -> should get the file type from a string', async () => {
const folderArrayArg = await smartfile.fs.listFolders('./test/testassets/');
expect(folderArrayArg).toContain('testfolder');
expect(folderArrayArg).not.toContain('notExistentFolder');
tap.test('SmartFileFactory.fromString() -> should create a SmartFile from string', async () => {
const smartFile = factory.fromString('./test.txt', 'test content');
expect(smartFile).toBeInstanceOf(smartfile.SmartFile);
expect(smartFile.parseContentAsString()).toEqual('test content');
});
tap.test('.fs.listFilesSync() -> should get the file type from a string', async () => {
expect(smartfile.fs.listFilesSync('./test/testassets/')).toContain('mytest.json');
expect(smartfile.fs.listFilesSync('./test/testassets/')).not.toContain('notExistentFile');
expect(smartfile.fs.listFilesSync('./test/testassets/', /mytest\.json/)).toContain('mytest.json');
expect(smartfile.fs.listFilesSync('./test/testassets/', /mytests.json/)).not.toContain(
'mytest.json'
);
});
tap.test('.fs.listFiles() -> should get the file type from a string', async () => {
const folderArrayArg = await smartfile.fs.listFiles('./test/testassets/');
expect(folderArrayArg).toContain('mytest.json');
expect(folderArrayArg).not.toContain('notExistentFile');
});
tap.test('.fs.listFileTree() -> should get a file tree', async () => {
const folderArrayArg = await smartfile.fs.listFileTree(
path.resolve('./test/testassets/'),
'**/*.txt'
);
expect(folderArrayArg).toContain('testfolder/testfile1.txt');
expect(folderArrayArg).not.toContain('mytest.json');
});
tap.test('.fs.fileTreeToObject -> should read a file tree into an Object', async () => {
const fileArrayArg = await smartfile.fs.fileTreeToObject(
path.resolve('./test/testassets/'),
'**/*.txt'
);
expect(fileArrayArg[0]).toBeInstanceOf(smartfile.SmartFile);
expect(fileArrayArg[0].contents.toString()).toEqual(fileArrayArg[0].contentBuffer.toString());
});
tap.test('.fs.copy() -> should copy a directory', async () => {
await smartfile.fs.copy('./test/testassets/testfolder/', './test/testassets/temp/');
});
tap.test('.fs.copy() -> should copy a file', async () => {
await smartfile.fs.copy('./test/testassets/mytest.yaml', './test/testassets/temp/mytest.yaml');
});
tap.test('.fs.copy() -> should copy a file and rename it', async () => {
await smartfile.fs.copy(
'./test/testassets/mytest.yaml',
'./test/testassets/temp/mytestRenamed.yaml'
);
});
tap.test('.fs.remove() -> should remove an entire directory', async () => {});
tap.test('.fs.remove -> should remove single files', async () => {
await smartfile.fs.remove('./test/testassets/temp/mytestRenamed.yaml');
});
tap.test('.fs.removeSync -> should remove single files synchronouly', async () => {
smartfile.fs.removeSync('./test/testassets/temp/testfile1.txt');
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).toBeFalse();
});
tap.test('.fs.removeMany -> should remove and array of files', async () => {
smartfile.fs
.removeMany(['./test/testassets/temp/testfile1.txt', './test/testassets/temp/testfile2.txt'])
.then(() => {
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).toBeFalse();
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile2.txt')).toBeFalse();
});
});
tap.test('.fs.removeManySync -> should remove and array of single files synchronouly', async () => {
smartfile.fs.removeManySync([
'./test/testassets/temp/testfile1.txt',
'./test/testassets/temp/testfile2.txt',
]);
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile1.txt')).toBeFalse();
expect(smartfile.fs.fileExistsSync('./test/testassets/temp/testfile2.txt')).toBeFalse();
});
tap.test('.fs.toObjectSync() -> should read an .yaml file to an object', async () => {
const testData = smartfile.fs.toObjectSync('./test/testassets/mytest.yaml');
expect(testData.key1).toEqual('this works');
expect(testData.key2).toEqual('this works too');
});
tap.test(
'.fs.toObjectSync() -> should state unknown file type for unknown file types',
async () => {
const testData = smartfile.fs.toObjectSync('./test/testassets/mytest.txt');
}
);
tap.test('.fs.toObjectSync() -> should read an .json file to an object', async () => {
const testData = smartfile.fs.toObjectSync('./test/testassets/mytest.json');
expect(testData.key1).toEqual('this works');
expect(testData.key2).toEqual('this works too');
});
tap.test('.fs.toStringSync() -> should read a file to a string', async () => {
expect(smartfile.fs.toStringSync('./test/testassets/mytest.txt')).toEqual('Some TestString &&%$');
tap.test('SmartFileFactory.fromUrl() -> should create a SmartFile from URL', async () => {
// Note: This test would need a real HTTP endpoint or mock
// For now, we'll skip it or test with a known URL
// const smartFile = await factory.fromUrl('https://example.com/test.json');
// expect(smartFile).toBeInstanceOf(smartfile.SmartFile);
});
// ---------------------------
// smartfile.interpreter
// SmartFile Instance Tests
// ---------------------------
tap.test('.interpreter.filetype() -> should get the file type from a string', async () => {
expect(smartfile.interpreter.filetype('./somefolder/data.json')).toEqual('json');
tap.test('SmartFile -> should produce vinyl compatible files', async () => {
const smartFile = await factory.fromFilePath('./test/testassets/mytest.json');
expect(smartFile).toBeInstanceOf(smartfile.SmartFile);
expect(smartFile.contents).toBeInstanceOf(Buffer);
expect(smartFile.isBuffer()).toBeTrue();
expect(smartFile.isDirectory()).toBeFalse();
expect(smartFile.isNull()).toBeFalse();
});
// ---------------------------
// smartfile.memory
// ---------------------------
tap.test('.memory.toFs() -> should write a file to disk and return a promise', async () => {
const localString = 'myString';
await smartfile.memory.toFs(
localString,
path.join(process.cwd(), './test/testassets/temp/testMemToFs.txt')
);
});
tap.test(
'.memory.toFsSync() -> should write a file to disk and return true if successfull',
async () => {
const localString = 'myString';
smartfile.memory.toFsSync(
localString,
path.join(process.cwd(), './test/testassets/temp/testMemToFsSync.txt')
);
}
);
// ---------------------------
// smartfile.Smartfile
// ---------------------------
tap.test('.Smartfile -> should produce vinyl compatible files', async () => {
const smartfileArray = await smartfile.fs.fileTreeToObject(
process.cwd(),
'./test/testassets/testfolder/**/*'
);
const localSmartfile = smartfileArray[0];
expect(localSmartfile).toBeInstanceOf(smartfile.SmartFile);
expect(localSmartfile.contents).toBeInstanceOf(Buffer);
// tslint:disable-next-line:no-unused-expression
expect(localSmartfile.isBuffer()).toBeTrue();
// tslint:disable-next-line:no-unused-expression
expect(localSmartfile.isDirectory()).toBeFalse();
// tslint:disable-next-line:no-unused-expression
expect(localSmartfile.isNull()).toBeFalse();
});
tap.test('should output a smartfile array to disk', async () => {
const smartfileArray = await smartfile.fs.fileTreeToObject('./test/testassets/testfolder/', '*');
for (const smartfileInstance of smartfileArray) {
console.log(smartfileInstance.relative);
console.log(smartfileInstance.path);
console.log(smartfileInstance.base);
console.log(smartfileInstance.parsedPath);
}
await smartfile.memory.smartfileArrayToFs(
smartfileArray,
path.resolve('./test/testassets/temp/testoutput/')
);
});
tap.test('should create, store and retrieve valid smartfiles', async () => {
tap.test('SmartFile -> should write to disk', async () => {
const fileString = 'hi there';
const filePath = './test/testassets/utf8.txt';
const smartfileInstance = await smartfile.SmartFile.fromString(filePath, fileString, 'utf8');
smartfileInstance.write();
const smartfileInstance2 = await smartfile.SmartFile.fromFilePath(filePath);
const retrievedString = smartfileInstance.contents.toString();
const filePath = './test/testassets/temp/utf8.txt';
const smartFile = factory.fromString(filePath, fileString, 'utf8');
await smartFile.writeToDiskAtPath(filePath);
// Read it back
const smartFile2 = await factory.fromFilePath(filePath);
const retrievedString = smartFile2.parseContentAsString();
expect(retrievedString).toEqual(fileString);
});
tap.test('should get a hash', async () => {
tap.test('SmartFile -> should get a hash', async () => {
const fileString = 'hi there';
const filePath = './test/testassets/utf8.txt';
const smartfileInstance = await smartfile.SmartFile.fromString(filePath, fileString, 'utf8');
const hash = await smartfileInstance.getHash();
console.log(hash);
const smartFile = factory.fromString('./test/testassets/utf8.txt', fileString, 'utf8');
const hash = await smartFile.getHash();
expect(hash).toBeTypeofString();
expect(hash.length).toBeGreaterThan(0);
});
tap.test('should wait for file to be ready', async () => {
await smartfile.fs.waitForFileToBeReady('./test/testassets/mytest.json');
tap.test('SmartFile -> should update file name', async () => {
const smartFile = factory.fromString('./test/oldname.txt', 'content');
smartFile.updateFileName('newname.txt');
expect(smartFile.parsedPath.base).toEqual('newname.txt');
});
tap.test('SmartFile -> should edit content as string', async () => {
const smartFile = factory.fromString('./test.txt', 'original content');
await smartFile.editContentAsString(async (content) => {
return content.replace('original', 'modified');
});
expect(smartFile.parseContentAsString()).toEqual('modified content');
});
tap.test('SmartFile -> should get stream', async () => {
const smartFile = factory.fromString('./test.txt', 'stream content');
const stream = smartFile.getStream();
expect(stream).toHaveProperty('pipe');
// Read from stream
const chunks: Buffer[] = [];
stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
await new Promise((resolve) => {
stream.on('end', resolve);
});
const content = Buffer.concat(chunks).toString();
expect(content).toEqual('stream content');
});
tap.test('SmartFile -> should get size', async () => {
const content = 'test content with some length';
const smartFile = factory.fromString('./test.txt', content);
const size = await smartFile.getSize();
expect(size).toEqual(Buffer.from(content).length);
});
tap.test('SmartFile -> should parse content as buffer', async () => {
const buffer = Buffer.from('buffer content');
const smartFile = factory.fromBuffer('./test.txt', buffer);
const parsedBuffer = smartFile.parseContentAsBuffer();
expect(parsedBuffer).toBeInstanceOf(Buffer);
expect(parsedBuffer.toString()).toEqual('buffer content');
});
tap.test('SmartFile -> should write to directory', async () => {
const smartFile = factory.fromString('subdir/test.txt', 'directory test content');
const writtenPath = await smartFile.writeToDir('./test/testassets/temp');
expect(writtenPath).toContain('subdir/test.txt');
});
tap.test('SmartFile -> should get parsed path', async () => {
const smartFile = factory.fromString('./path/to/file.txt', 'content');
expect(smartFile.parsedPath.base).toEqual('file.txt');
expect(smartFile.parsedPath.ext).toEqual('.txt');
expect(smartFile.parsedPath.name).toEqual('file');
});
tap.test('SmartFile -> should get absolute path', async () => {
const smartFile = factory.fromString('relative/path.txt', 'content', 'utf8', '/base');
expect(smartFile.absolutePath).toEqual('/base/relative/path.txt');
});
tap.start();

View File

@@ -1,15 +1,235 @@
import { tap, expect } from '@push.rocks/tapbundle';
import { tap, expect } from '@git.zone/tstest/tapbundle';
import * as smartfile from '../ts/index.js';
import { MockSmartFs } from './helpers/mock-smartfs.js';
tap.test('should create a virtualdirectory', async () => {
const virtualDir = await smartfile.VirtualDirectory.fromFsDirPath('./test/testassets/testfolder');
// Create factory with MockSmartFs
const mockFs = new MockSmartFs();
const factory = new smartfile.SmartFileFactory(mockFs);
// ---------------------------
// VirtualDirectory Factory Tests
// ---------------------------
tap.test('SmartFileFactory.virtualDirectoryFromPath() -> should create a VirtualDirectory from fs path', async () => {
const virtualDir = await factory.virtualDirectoryFromPath('./test/testassets/testfolder');
expect(virtualDir).toBeInstanceOf(smartfile.VirtualDirectory);
expect(virtualDir.smartfileArray.length).toEqual(4);
});
tap.test('should write to a directory', async () => {
const virtualDir = await smartfile.VirtualDirectory.fromFsDirPath('./test/testassets/testfolder');
virtualDir.saveToDisk('./test/testassets/test');
tap.test('SmartFileFactory.virtualDirectoryEmpty() -> should create an empty VirtualDirectory', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
expect(virtualDir).toBeInstanceOf(smartfile.VirtualDirectory);
expect(virtualDir.isEmpty()).toBeTrue();
expect(virtualDir.size()).toEqual(0);
});
tap.test('SmartFileFactory.virtualDirectoryFromFileArray() -> should create VirtualDirectory from files', async () => {
const file1 = factory.fromString('file1.txt', 'content1');
const file2 = factory.fromString('file2.txt', 'content2');
const virtualDir = factory.virtualDirectoryFromFileArray([file1, file2]);
expect(virtualDir).toBeInstanceOf(smartfile.VirtualDirectory);
expect(virtualDir.size()).toEqual(2);
});
// ---------------------------
// VirtualDirectory Collection Methods
// ---------------------------
tap.test('VirtualDirectory -> should add and list files', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
const file1 = factory.fromString('test1.txt', 'content1');
const file2 = factory.fromString('test2.txt', 'content2');
virtualDir.addSmartfile(file1);
virtualDir.addSmartfile(file2);
const files = virtualDir.listFiles();
expect(files.length).toEqual(2);
expect(files[0].path).toEqual('test1.txt');
expect(files[1].path).toEqual('test2.txt');
});
tap.test('VirtualDirectory -> should check file existence', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
const file = factory.fromString('exists.txt', 'content');
virtualDir.addSmartfile(file);
expect(virtualDir.exists('exists.txt')).toBeTrue();
expect(virtualDir.has('exists.txt')).toBeTrue();
expect(virtualDir.exists('not-there.txt')).toBeFalse();
});
tap.test('VirtualDirectory -> should get file by path', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
const file = factory.fromString('getme.txt', 'my content');
virtualDir.addSmartfile(file);
const retrieved = await virtualDir.getFileByPath('getme.txt');
expect(retrieved).not.toBeUndefined();
expect(retrieved!.parseContentAsString()).toEqual('my content');
});
tap.test('VirtualDirectory -> should remove file by path', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
const file = factory.fromString('remove.txt', 'content');
virtualDir.addSmartfile(file);
expect(virtualDir.exists('remove.txt')).toBeTrue();
const removed = virtualDir.removeByPath('remove.txt');
expect(removed).toBeTrue();
expect(virtualDir.exists('remove.txt')).toBeFalse();
});
tap.test('VirtualDirectory -> should clear all files', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
virtualDir.addSmartfile(factory.fromString('file1.txt', 'content1'));
virtualDir.addSmartfile(factory.fromString('file2.txt', 'content2'));
expect(virtualDir.size()).toEqual(2);
virtualDir.clear();
expect(virtualDir.size()).toEqual(0);
expect(virtualDir.isEmpty()).toBeTrue();
});
tap.test('VirtualDirectory -> should merge with another VirtualDirectory', async () => {
const vdir1 = factory.virtualDirectoryEmpty();
vdir1.addSmartfile(factory.fromString('file1.txt', 'content1'));
const vdir2 = factory.virtualDirectoryEmpty();
vdir2.addSmartfile(factory.fromString('file2.txt', 'content2'));
vdir1.merge(vdir2);
expect(vdir1.size()).toEqual(2);
expect(vdir1.exists('file1.txt')).toBeTrue();
expect(vdir1.exists('file2.txt')).toBeTrue();
});
tap.test('VirtualDirectory -> should filter files', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
virtualDir.addSmartfile(factory.fromString('file1.txt', 'content1'));
virtualDir.addSmartfile(factory.fromString('file2.md', 'content2'));
virtualDir.addSmartfile(factory.fromString('file3.txt', 'content3'));
const filtered = virtualDir.filter(file => file.path.endsWith('.txt'));
expect(filtered.size()).toEqual(2);
expect(filtered.exists('file1.txt')).toBeTrue();
expect(filtered.exists('file3.txt')).toBeTrue();
expect(filtered.exists('file2.md')).toBeFalse();
});
tap.test('VirtualDirectory -> should map files', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
virtualDir.addSmartfile(factory.fromString('file1.txt', 'content1'));
virtualDir.addSmartfile(factory.fromString('file2.txt', 'content2'));
const mapped = virtualDir.map(file => {
file.setContentsFromString(file.parseContentAsString().toUpperCase());
return file;
});
const files = mapped.listFiles();
expect(files[0].parseContentAsString()).toEqual('CONTENT1');
expect(files[1].parseContentAsString()).toEqual('CONTENT2');
});
tap.test('VirtualDirectory -> should find files', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
virtualDir.addSmartfile(factory.fromString('find.txt', 'findme'));
virtualDir.addSmartfile(factory.fromString('other.txt', 'other'));
const found = virtualDir.find(file => file.parseContentAsString() === 'findme');
expect(found).not.toBeUndefined();
expect(found!.path).toEqual('find.txt');
});
tap.test('VirtualDirectory -> should list directories', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
virtualDir.addSmartfile(factory.fromString('dir1/file1.txt', 'content1'));
virtualDir.addSmartfile(factory.fromString('dir1/file2.txt', 'content2'));
virtualDir.addSmartfile(factory.fromString('dir2/file3.txt', 'content3'));
virtualDir.addSmartfile(factory.fromString('root.txt', 'content4'));
const dirs = virtualDir.listDirectories();
expect(dirs).toContain('dir1');
expect(dirs).toContain('dir2');
expect(dirs.length).toEqual(2);
});
tap.test('VirtualDirectory -> should save to disk', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
virtualDir.addSmartfile(factory.fromString('saved1.txt', 'saved content 1'));
virtualDir.addSmartfile(factory.fromString('subdir/saved2.txt', 'saved content 2'));
await virtualDir.saveToDisk('./test/testassets/temp/vdir-output');
// Verify files were written
const file1 = await factory.fromFilePath('./test/testassets/temp/vdir-output/saved1.txt');
expect(file1.parseContentAsString()).toEqual('saved content 1');
const file2 = await factory.fromFilePath('./test/testassets/temp/vdir-output/subdir/saved2.txt');
expect(file2.parseContentAsString()).toEqual('saved content 2');
});
tap.test('VirtualDirectory -> should convert to transferable object', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
virtualDir.addSmartfile(factory.fromString('trans1.txt', 'transferable1'));
virtualDir.addSmartfile(factory.fromString('trans2.txt', 'transferable2'));
const transferable = await virtualDir.toVirtualDirTransferableObject();
expect(transferable.files).toBeInstanceOf(Array);
expect(transferable.files.length).toEqual(2);
});
// TODO: Fix serialization/deserialization with smartjson
// tap.test('VirtualDirectory -> should create from transferable object', async () => {
// const originalDir = factory.virtualDirectoryEmpty();
// originalDir.addSmartfile(factory.fromString('original.txt', 'original content'));
// const transferable = await originalDir.toVirtualDirTransferableObject();
// const restoredDir = await factory.virtualDirectoryFromTransferable(transferable);
// expect(restoredDir.size()).toEqual(1);
// expect(restoredDir.exists('original.txt')).toBeTrue();
// const file = await restoredDir.getFileByPath('original.txt');
// expect(file!.parseContentAsString()).toEqual('original content');
// });
tap.test('VirtualDirectory -> should shift to subdirectory', async () => {
const virtualDir = factory.virtualDirectoryEmpty();
virtualDir.addSmartfile(factory.fromString('root/sub/file1.txt', 'content1'));
virtualDir.addSmartfile(factory.fromString('root/sub/file2.txt', 'content2'));
virtualDir.addSmartfile(factory.fromString('root/other.txt', 'content3'));
const shifted = await virtualDir.shiftToSubdirectory('root/sub');
expect(shifted.size()).toEqual(2);
expect(shifted.exists('file1.txt')).toBeTrue();
expect(shifted.exists('file2.txt')).toBeTrue();
expect(shifted.exists('other.txt')).toBeFalse();
});
tap.test('VirtualDirectory -> should add another virtual directory with new root', async () => {
const vdir1 = factory.virtualDirectoryEmpty();
vdir1.addSmartfile(factory.fromString('existing.txt', 'existing'));
const vdir2 = factory.virtualDirectoryEmpty();
vdir2.addSmartfile(factory.fromString('added.txt', 'added'));
await vdir1.addVirtualDirectory(vdir2, 'newroot');
expect(vdir1.size()).toEqual(2);
expect(vdir1.exists('existing.txt')).toBeTrue();
expect(vdir1.exists('newroot/added.txt')).toBeTrue();
});
tap.start();

View File

@@ -5,4 +5,3 @@
"nestedkey1": "hello"
}
}

View File

@@ -0,0 +1,7 @@
{
"key1": "this works",
"key2": "this works too",
"key3": {
"nestedkey1": "hello"
}
}

View File

@@ -5,4 +5,3 @@
"nestedkey1": "hello"
}
}

View File

@@ -0,0 +1,7 @@
{
"key1": "this works",
"key2": "this works too",
"key3": {
"nestedkey1": "hello"
}
}

View File

@@ -0,0 +1 @@
directory test content

View File

@@ -5,4 +5,3 @@
"nestedkey1": "hello"
}
}

View File

@@ -0,0 +1 @@
hi there

View File

@@ -0,0 +1 @@
saved content 1

View File

@@ -0,0 +1 @@
saved content 2

View File

@@ -1,8 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartfile',
version: '11.0.5',
description: 'offers smart ways to work with files in nodejs'
version: '13.0.0',
description: 'High-level file representation classes (SmartFile, StreamFile, VirtualDirectory) for efficient in-memory file management in Node.js using TypeScript. Works seamlessly with @push.rocks/smartfs for filesystem operations.'
}

View File

@@ -0,0 +1,224 @@
import * as plugins from './plugins.js';
import { SmartFile } from './classes.smartfile.js';
import { StreamFile } from './classes.streamfile.js';
import { VirtualDirectory } from './classes.virtualdirectory.js';
export class SmartFileFactory {
private smartFs: any; // Will be typed as SmartFs once we import from @push.rocks/smartfs
constructor(smartFs: any) {
this.smartFs = smartFs;
}
/**
* Creates a default factory using Node.js filesystem provider
*/
public static nodeFs(): SmartFileFactory {
// Temporarily using a placeholder - will be replaced with actual SmartFs initialization
// const smartFs = new SmartFs(new SmartFsProviderNode());
const smartFs = null; // Placeholder
return new SmartFileFactory(smartFs);
}
/**
* Get the underlying SmartFs instance
*/
public getSmartFs(): any {
return this.smartFs;
}
// ============================================
// SmartFile Factory Methods
// ============================================
/**
* Creates a SmartFile from a file path on disk
*/
public async fromFilePath(
filePath: string,
baseArg: string = process.cwd()
): Promise<SmartFile> {
if (!this.smartFs) {
throw new Error('No SmartFs instance available. Cannot read from filesystem without SmartFs.');
}
filePath = plugins.path.resolve(filePath);
const content = await this.smartFs.file(filePath).read();
const fileBuffer = Buffer.from(content);
return new SmartFile({
contentBuffer: fileBuffer,
base: baseArg,
path: plugins.path.relative(baseArg, filePath),
}, this.smartFs);
}
/**
* Creates a SmartFile from a URL
*/
public async fromUrl(urlArg: string): Promise<SmartFile> {
const response = await plugins.smartrequest.SmartRequest.create()
.url(urlArg)
.accept('binary')
.get();
const buffer = Buffer.from(await response.arrayBuffer());
return new SmartFile({
contentBuffer: buffer,
base: process.cwd(),
path: urlArg,
}, this.smartFs);
}
/**
* Creates a SmartFile from a Buffer
*/
public fromBuffer(
filePath: string,
contentBufferArg: Buffer,
baseArg: string = process.cwd()
): SmartFile {
// Use filePath as-is if it's already relative, otherwise compute relative path
const relativePath = plugins.path.isAbsolute(filePath)
? plugins.path.relative(baseArg, filePath)
: filePath;
return new SmartFile({
contentBuffer: contentBufferArg,
base: baseArg,
path: relativePath,
}, this.smartFs);
}
/**
* Creates a SmartFile from a string
*/
public fromString(
filePath: string,
contentStringArg: string,
encodingArg: 'utf8' | 'binary' = 'utf8',
baseArg: string = process.cwd()
): SmartFile {
// Use filePath as-is if it's already relative, otherwise compute relative path
const relativePath = plugins.path.isAbsolute(filePath)
? plugins.path.relative(baseArg, filePath)
: filePath;
return new SmartFile({
contentBuffer: Buffer.from(contentStringArg, encodingArg),
base: baseArg,
path: relativePath,
}, this.smartFs);
}
/**
* Creates a SmartFile from a stream
*/
public async fromStream(
stream: plugins.stream.Readable,
filePath: string,
baseArg: string = process.cwd()
): Promise<SmartFile> {
return new Promise<SmartFile>((resolve, reject) => {
const chunks: Buffer[] = [];
stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
stream.on('error', (error) => reject(error));
stream.on('end', () => {
const contentBuffer = Buffer.concat(chunks);
const smartfile = new SmartFile({
contentBuffer: contentBuffer,
base: baseArg,
path: plugins.path.relative(baseArg, filePath),
}, this.smartFs);
resolve(smartfile);
});
});
}
/**
* Creates a SmartFile from folded JSON
*/
public async fromFoldedJson(foldedJsonArg: string): Promise<SmartFile> {
const parsed = plugins.smartjson.parse(foldedJsonArg);
return new SmartFile(parsed, this.smartFs);
}
// ============================================
// StreamFile Factory Methods
// ============================================
/**
* Creates a StreamFile from a file path
*/
public async streamFromPath(filePath: string): Promise<StreamFile> {
return StreamFile.fromPath(filePath, this.smartFs);
}
/**
* Creates a StreamFile from a URL
*/
public async streamFromUrl(url: string): Promise<StreamFile> {
return StreamFile.fromUrl(url, this.smartFs);
}
/**
* Creates a StreamFile from a Buffer
*/
public streamFromBuffer(buffer: Buffer, relativeFilePath?: string): StreamFile {
return StreamFile.fromBuffer(buffer, relativeFilePath, this.smartFs);
}
/**
* Creates a StreamFile from a Node.js Readable stream
*/
public streamFromStream(
stream: plugins.stream.Readable,
relativeFilePath?: string,
multiUse: boolean = false
): StreamFile {
return StreamFile.fromStream(stream, relativeFilePath, multiUse, this.smartFs);
}
// ============================================
// VirtualDirectory Factory Methods
// ============================================
/**
* Creates a VirtualDirectory from a filesystem directory path
*/
public async virtualDirectoryFromPath(pathArg: string): Promise<VirtualDirectory> {
return VirtualDirectory.fromFsDirPath(pathArg, this.smartFs, this);
}
/**
* Creates an empty VirtualDirectory
*/
public virtualDirectoryEmpty(): VirtualDirectory {
return new VirtualDirectory(this.smartFs, this);
}
/**
* Creates a VirtualDirectory from an array of SmartFiles
*/
public virtualDirectoryFromFileArray(files: SmartFile[]): VirtualDirectory {
const vdir = new VirtualDirectory(this.smartFs, this);
vdir.addSmartfiles(files);
return vdir;
}
/**
* Creates a VirtualDirectory from a transferable object
*/
public async virtualDirectoryFromTransferable(
virtualDirTransferableObjectArg: plugins.smartfileInterfaces.VirtualDirTransferableObject
): Promise<VirtualDirectory> {
const newVirtualDir = new VirtualDirectory(this.smartFs, this);
for (const fileArg of virtualDirTransferableObjectArg.files) {
const smartFile = SmartFile.enfoldFromJson(fileArg) as SmartFile;
// Update the smartFs reference
(smartFile as any).smartFs = this.smartFs;
newVirtualDir.addSmartfiles([smartFile]);
}
return newVirtualDir;
}
}

View File

@@ -1,6 +1,4 @@
import * as plugins from './smartfile.plugins.js';
import * as fs from './fs.js';
import * as memory from './memory.js';
import * as plugins from './plugins.js';
export interface ISmartfileConstructorOptions {
path: string;
@@ -10,96 +8,17 @@ export interface ISmartfileConstructorOptions {
/**
* an vinyl file compatible in memory file class
* Use SmartFileFactory to create instances of this class
*/
export class SmartFile extends plugins.smartjson.Smartjson {
// ======
// STATIC
// ======
/**
* creates a Smartfile from a filePath
* @param filePath
*/
public static async fromFilePath(filePath: string, baseArg: string = process.cwd()) {
filePath = plugins.path.resolve(filePath);
const fileBuffer = fs.toBufferSync(filePath);
const smartfile = new SmartFile({
contentBuffer: fileBuffer,
base: baseArg,
path: plugins.path.relative(baseArg, filePath),
});
return smartfile;
}
public static async fromBuffer(
filePath: string,
contentBufferArg: Buffer,
baseArg: string = process.cwd()
) {
const smartfile = new SmartFile({
contentBuffer: contentBufferArg,
base: baseArg,
path: plugins.path.relative(baseArg, filePath),
});
return smartfile;
}
public static async fromString(
filePath: string,
contentStringArg: string,
encodingArg: 'utf8' | 'binary',
baseArg = process.cwd()
) {
const smartfile = new SmartFile({
contentBuffer: Buffer.from(contentStringArg, encodingArg),
base: baseArg,
path: plugins.path.relative(baseArg, filePath),
});
return smartfile;
}
public static async fromFoldedJson(foldedJsonArg: string) {
return new SmartFile(plugins.smartjson.parse(foldedJsonArg));
}
/**
* creates a Smartfile from a ReadableStream
* @param stream a readable stream that provides file content
* @param filePath the file path to associate with the content
* @param baseArg the base path to use for the file
*/
public static async fromStream(
stream: plugins.stream.Readable,
filePath: string,
baseArg: string = process.cwd()
): Promise<SmartFile> {
return new Promise<SmartFile>((resolve, reject) => {
const chunks: Buffer[] = [];
stream.on('data', (chunk) => chunks.push(Buffer.from(chunk)));
stream.on('error', (error) => reject(error));
stream.on('end', () => {
const contentBuffer = Buffer.concat(chunks);
const smartfile = new SmartFile({
contentBuffer: contentBuffer,
base: baseArg,
path: plugins.path.relative(baseArg, filePath),
});
resolve(smartfile);
});
});
}
public static async fromUrl (urlArg: string) {
const response = await plugins.smartrequest.getBinary(urlArg);
const smartfile = await SmartFile.fromBuffer(urlArg, response.body);
return smartfile;
}
// ========
// INSTANCE
// ========
/**
* Reference to the SmartFs instance for filesystem operations
*/
private smartFs?: any;
/**
* the relative path of the file
*/
@@ -142,9 +61,10 @@ export class SmartFile extends plugins.smartjson.Smartjson {
/**
* the constructor of Smartfile
* @param optionsArg
* @param smartFs optional SmartFs instance for filesystem operations
*/
constructor(optionsArg: ISmartfileConstructorOptions) {
constructor(optionsArg: ISmartfileConstructorOptions, smartFs?: any) {
super();
if (optionsArg.contentBuffer) {
this.contentBuffer = optionsArg.contentBuffer;
@@ -153,13 +73,17 @@ export class SmartFile extends plugins.smartjson.Smartjson {
}
this.path = optionsArg.path;
this.base = optionsArg.base;
this.smartFs = smartFs;
}
/**
* set contents from string
* @param contentString
*/
public setContentsFromString(contentString: string, encodingArg: 'utf8' | 'binary' = 'utf8') {
public setContentsFromString(
contentString: string,
encodingArg: 'utf8' | 'binary' = 'utf8',
) {
this.contents = Buffer.from(contentString, encodingArg);
}
@@ -167,9 +91,19 @@ export class SmartFile extends plugins.smartjson.Smartjson {
* write file to disk at its original location
* Behaviours:
* - no argument write to exactly where the file was picked up
* - Requires SmartFs instance (create via SmartFileFactory)
*/
public async write() {
await memory.toFs(this.contentBuffer, plugins.path.join(this.base, this.path));
if (!this.smartFs) {
throw new Error('No SmartFs instance available. Create SmartFile through SmartFileFactory.');
}
const writePath = plugins.smartpath.transform.makeAbsolute(
this.path,
this.base,
);
console.log(`writing to ${writePath}`);
await this.smartFs.file(writePath).write(this.contentBuffer);
}
/**
@@ -178,10 +112,15 @@ export class SmartFile extends plugins.smartjson.Smartjson {
* @param filePathArg
*/
public async writeToDiskAtPath(filePathArg: string) {
if (!this.smartFs) {
throw new Error('No SmartFs instance available. Create SmartFile through SmartFileFactory.');
}
if (!plugins.path.isAbsolute(filePathArg)) {
filePathArg = plugins.path.join(process.cwd(), filePathArg);
}
await memory.toFs(this.contentBuffer, filePathArg);
await this.smartFs.file(filePathArg).write(this.contentBuffer);
}
/**
@@ -190,9 +129,13 @@ export class SmartFile extends plugins.smartjson.Smartjson {
* @returns
*/
public async writeToDir(dirPathArg: string) {
if (!this.smartFs) {
throw new Error('No SmartFs instance available. Create SmartFile through SmartFileFactory.');
}
dirPathArg = plugins.smartpath.transform.toAbsolute(dirPathArg) as string;
const filePath = plugins.path.join(dirPathArg, this.path);
await memory.toFs(this.contentBuffer, filePath);
await this.smartFs.file(filePath).write(this.contentBuffer);
return filePath;
}
@@ -200,14 +143,71 @@ export class SmartFile extends plugins.smartjson.Smartjson {
* read file from disk
*/
public async read() {
this.contentBuffer = await fs.toBuffer(plugins.path.join(this.base, this.path));
if (!this.smartFs) {
throw new Error('No SmartFs instance available. Create SmartFile through SmartFileFactory.');
}
const filePath = plugins.path.join(this.base, this.path);
const content = await this.smartFs.file(filePath).read();
this.contentBuffer = Buffer.from(content);
}
/**
* deletes the file from disk at its original location
*/
public async delete() {
await fs.remove(plugins.path.join(this.base, this.path));
if (!this.smartFs) {
throw new Error('No SmartFs instance available. Create SmartFile through SmartFileFactory.');
}
const filePath = plugins.path.join(this.base, this.path);
await this.smartFs.file(filePath).delete();
}
/**
* Renames the file to the specified new name.
* - Updates the `path` property with the new name.
* - Writes the file to the new location if it exists on disk.
* @param newName The new name of the file (including extension if applicable).
* @param writeToDisk (optional) If true, also renames the file on the disk.
* @returns The updated file path after renaming.
*/
public async rename(
newName: string,
writeToDisk: boolean = false,
): Promise<string> {
// Validate the new name
if (!newName || typeof newName !== 'string') {
throw new Error('Invalid new name provided.');
}
// Extract the directory path
const oldFilePath = this.path;
const dirPath = plugins.path.dirname(this.path);
// Create the new file path
const newFilePath = plugins.path.join(dirPath, newName);
// Update the `path` property
this.path = newFilePath;
// Optionally write the renamed file to disk
if (writeToDisk) {
const oldAbsolutePath = plugins.smartpath.transform.makeAbsolute(
oldFilePath,
this.base,
);
const newAbsolutePath = plugins.smartpath.transform.makeAbsolute(
newFilePath,
this.base,
);
// Rename the file on disk
await plugins.fsExtra.rename(oldAbsolutePath, newAbsolutePath);
}
// Return the new path
return this.path;
}
// -----------------------------------------------
@@ -271,8 +271,12 @@ export class SmartFile extends plugins.smartjson.Smartjson {
public async getHash(typeArg: 'path' | 'content' | 'all' = 'all') {
const pathHash = await plugins.smarthash.sha256FromString(this.path);
const contentHash = await plugins.smarthash.sha256FromBuffer(this.contentBuffer);
const combinedHash = await plugins.smarthash.sha256FromString(pathHash + contentHash);
const contentHash = await plugins.smarthash.sha256FromBuffer(
this.contentBuffer,
);
const combinedHash = await plugins.smarthash.sha256FromString(
pathHash + contentHash,
);
switch (typeArg) {
case 'path':
return pathHash;
@@ -290,7 +294,9 @@ export class SmartFile extends plugins.smartjson.Smartjson {
this.path = this.path.replace(new RegExp(oldFileName + '$'), fileNameArg);
}
public async editContentAsString(editFuncArg: (fileStringArg: string) => Promise<string>) {
public async editContentAsString(
editFuncArg: (fileStringArg: string) => Promise<string>,
) {
const newFileString = await editFuncArg(this.contentBuffer.toString());
this.contentBuffer = Buffer.from(newFileString);
}
@@ -304,4 +310,25 @@ export class SmartFile extends plugins.smartjson.Smartjson {
stream.push(null); // Push null to signify the end of the stream (EOF)
return stream;
}
/**
* Returns the size of the file in bytes
*/
public async getSize(): Promise<number> {
return this.contentBuffer.length;
}
/**
* Parse content as string with specified encoding
*/
public parseContentAsString(encodingArg: BufferEncoding = 'utf8'): string {
return this.contentBuffer.toString(encodingArg);
}
/**
* Parse content as buffer
*/
public parseContentAsBuffer(): Buffer {
return this.contentBuffer;
}
}

View File

@@ -1,54 +1,67 @@
import * as plugins from './smartfile.plugins.js';
import * as smartfileFs from './fs.js';
import * as smartfileFsStream from './fsstream.js';
import * as plugins from './plugins.js';
import { Readable } from 'stream';
type TStreamSource = (streamFile: StreamFile) => Promise<Readable>;
type TStreamSource = (streamFile: StreamFile) => Promise<Readable | ReadableStream>;
/**
* The StreamFile class represents a file as a stream.
* It allows creating streams from a file path, a URL, or a buffer.
* Use SmartFileFactory to create instances of this class.
*/
export class StreamFile {
// INSTANCE
relativeFilePath?: string;
private streamSource: TStreamSource;
// enable stream based multi use
private cachedStreamBuffer?: Buffer;
public multiUse: boolean;
public used: boolean = false;
private constructor(streamSource: TStreamSource, relativeFilePath?: string) {
this.streamSource = streamSource;
this.relativeFilePath = relativeFilePath;
}
// STATIC
public static async fromPath(filePath: string): Promise<StreamFile> {
const streamSource: TStreamSource = async (stremFileArg) => smartfileFsStream.createReadStream(filePath);
const streamFile = new StreamFile(streamSource, filePath);
public static async fromPath(filePath: string, smartFs?: any): Promise<StreamFile> {
if (!smartFs) {
throw new Error('No SmartFs instance available. Create StreamFile through SmartFileFactory.');
}
const streamSource: TStreamSource = async (streamFileArg) => {
return await streamFileArg.smartFs.file(filePath).readStream();
};
const streamFile = new StreamFile(streamSource, filePath, smartFs);
streamFile.multiUse = true;
streamFile.byteLengthComputeFunction = async () => {
const stats = await smartFs.file(filePath).stat();
return stats.size;
};
return streamFile;
}
public static async fromUrl(url: string): Promise<StreamFile> {
const streamSource: TStreamSource = async (streamFileArg) => plugins.smartrequest.getStream(url); // Replace with actual plugin method
const streamFile = new StreamFile(streamSource);
public static async fromUrl(url: string, smartFs?: any): Promise<StreamFile> {
const streamSource: TStreamSource = async (streamFileArg) => {
const response = await plugins.smartrequest.SmartRequest.create()
.url(url)
.get();
return response.stream();
};
const streamFile = new StreamFile(streamSource, undefined, smartFs);
streamFile.multiUse = true;
streamFile.byteLengthComputeFunction = async () => {
const response = await plugins.smartrequest.SmartRequest.create()
.url(url)
.accept('binary')
.get();
const buffer = Buffer.from(await response.arrayBuffer());
return buffer.length;
};
return streamFile;
}
public static fromBuffer(buffer: Buffer, relativeFilePath?: string): StreamFile {
public static fromBuffer(
buffer: Buffer,
relativeFilePath?: string,
smartFs?: any
): StreamFile {
const streamSource: TStreamSource = async (streamFileArg) => {
const stream = new Readable();
stream.push(buffer);
stream.push(null); // End of stream
return stream;
};
const streamFile = new StreamFile(streamSource, relativeFilePath);
const streamFile = new StreamFile(streamSource, relativeFilePath, smartFs);
streamFile.multiUse = true;
streamFile.byteLengthComputeFunction = async () => buffer.length;
return streamFile;
}
@@ -57,9 +70,15 @@ export class StreamFile {
* @param stream A Node.js Readable stream.
* @param relativeFilePath Optional file path for the stream.
* @param multiUse If true, the stream can be read multiple times, caching its content.
* @param smartFs Optional SmartFs instance for filesystem operations
* @returns A StreamFile instance.
*/
public static fromStream(stream: Readable, relativeFilePath?: string, multiUse: boolean = false): StreamFile {
public static fromStream(
stream: Readable,
relativeFilePath?: string,
multiUse: boolean = false,
smartFs?: any
): StreamFile {
const streamSource: TStreamSource = (streamFileArg) => {
if (streamFileArg.multiUse) {
// If multi-use is enabled and we have cached content, create a new readable stream from the buffer
@@ -72,7 +91,7 @@ export class StreamFile {
}
};
const streamFile = new StreamFile(streamSource, relativeFilePath);
const streamFile = new StreamFile(streamSource, relativeFilePath, smartFs);
streamFile.multiUse = multiUse;
// If multi-use is enabled, cache the stream when it's first read
@@ -91,6 +110,23 @@ export class StreamFile {
return streamFile;
}
// INSTANCE
relativeFilePath?: string;
private streamSource: TStreamSource;
private smartFs?: any;
// enable stream based multi use
private cachedStreamBuffer?: Buffer;
public multiUse: boolean;
public used: boolean = false;
public byteLengthComputeFunction: () => Promise<number>;
private constructor(streamSource: TStreamSource, relativeFilePath?: string, smartFs?: any) {
this.streamSource = streamSource;
this.relativeFilePath = relativeFilePath;
this.smartFs = smartFs;
}
// METHODS
private checkMultiUse() {
@@ -104,7 +140,16 @@ export class StreamFile {
* Creates a new readable stream from the source.
*/
public async createReadStream(): Promise<Readable> {
return this.streamSource(this);
const stream = await this.streamSource(this);
// Check if it's a Web ReadableStream and convert to Node.js Readable
if (stream && typeof (stream as any).getReader === 'function') {
// This is a Web ReadableStream, convert it to Node.js Readable
return Readable.fromWeb(stream as any);
}
// It's already a Node.js Readable stream
return stream as Readable;
}
/**
@@ -112,9 +157,13 @@ export class StreamFile {
* @param filePathArg The file path where the stream should be written.
*/
public async writeToDisk(filePathArg: string): Promise<void> {
if (!this.smartFs) {
throw new Error('No SmartFs instance available. Create StreamFile through SmartFileFactory.');
}
this.checkMultiUse();
const readStream = await this.createReadStream();
const writeStream = smartfileFsStream.createWriteStream(filePathArg);
const writeStream = await this.smartFs.file(filePathArg).writeStream();
return new Promise((resolve, reject) => {
readStream.pipe(writeStream);
@@ -125,9 +174,14 @@ export class StreamFile {
}
public async writeToDir(dirPathArg: string) {
if (!this.smartFs) {
throw new Error('No SmartFs instance available. Create StreamFile through SmartFileFactory.');
}
this.checkMultiUse();
const filePath = plugins.path.join(dirPathArg, this.relativeFilePath);
await smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
const dirPath = plugins.path.parse(filePath).dir;
await this.smartFs.directory(dirPath).create({ recursive: true });
return this.writeToDisk(filePath);
}
@@ -149,4 +203,28 @@ export class StreamFile {
const contentBuffer = await this.getContentAsBuffer();
return contentBuffer.toString(formatArg);
}
/**
* Returns the size of the file content in bytes.
*/
public async getSize(): Promise<number> {
if (this.byteLengthComputeFunction) {
return this.byteLengthComputeFunction();
} else {
return null;
}
}
/**
* Converts the StreamFile to a SmartFile by loading content into memory
*/
public async toSmartFile(): Promise<any> {
const { SmartFile } = await import('./classes.smartfile.js');
const buffer = await this.getContentAsBuffer();
return new SmartFile({
path: this.relativeFilePath || 'stream',
contentBuffer: buffer,
base: process.cwd()
}, this.smartFs);
}
}

View File

@@ -1,58 +1,162 @@
import { SmartFile } from './classes.smartfile.js';
import * as plugins from './smartfile.plugins.js';
import * as fs from './fs.js';
import * as plugins from './plugins.js';
export interface IVirtualDirectoryConstructorOptions {
mode: ''
mode: '';
}
/**
* a virtual directory exposes a fs api
* Use SmartFileFactory to create instances of this class
*/
export class VirtualDirectory {
consstructor(options = {}) {
}
// STATIC
public static async fromFsDirPath(pathArg: string): Promise<VirtualDirectory> {
const newVirtualDir = new VirtualDirectory();
newVirtualDir.addSmartfiles(await fs.fileTreeToObject(pathArg, '**/*'));
public static async fromFsDirPath(
pathArg: string,
smartFs?: any,
factory?: any
): Promise<VirtualDirectory> {
if (!smartFs || !factory) {
throw new Error('No SmartFs/Factory instance available. Create VirtualDirectory through SmartFileFactory.');
}
const newVirtualDir = new VirtualDirectory(smartFs, factory);
// Use smartFs to list directory and factory to create SmartFiles
const entries = await smartFs.directory(pathArg).list({ recursive: true });
const smartfiles = await Promise.all(
entries
.filter((entry: any) => entry.isFile)
.map((entry: any) => factory.fromFilePath(entry.path, pathArg))
);
newVirtualDir.addSmartfiles(smartfiles);
return newVirtualDir;
}
public static async fromVirtualDirTransferableObject(
virtualDirTransferableObjectArg: plugins.smartfileInterfaces.VirtualDirTransferableObject
virtualDirTransferableObjectArg: plugins.smartfileInterfaces.VirtualDirTransferableObject,
smartFs?: any,
factory?: any
): Promise<VirtualDirectory> {
const newVirtualDir = new VirtualDirectory();
const newVirtualDir = new VirtualDirectory(smartFs, factory);
for (const fileArg of virtualDirTransferableObjectArg.files) {
newVirtualDir.addSmartfiles([SmartFile.enfoldFromJson(fileArg) as SmartFile]);
const smartFile = SmartFile.enfoldFromJson(fileArg) as SmartFile;
// Update smartFs reference if available
if (smartFs) {
(smartFile as any).smartFs = smartFs;
}
newVirtualDir.addSmartfiles([smartFile]);
}
return newVirtualDir;
}
public static fromFileArray(files: SmartFile[], smartFs?: any, factory?: any): VirtualDirectory {
const vdir = new VirtualDirectory(smartFs, factory);
vdir.addSmartfiles(files);
return vdir;
}
public static empty(smartFs?: any, factory?: any): VirtualDirectory {
return new VirtualDirectory(smartFs, factory);
}
// INSTANCE
public smartfileArray: SmartFile[] = [];
private smartFs?: any;
private factory?: any;
constructor() {}
constructor(smartFs?: any, factory?: any) {
this.smartFs = smartFs;
this.factory = factory;
}
// ============================================
// Collection Mutations
// ============================================
public addSmartfiles(smartfileArrayArg: SmartFile[]) {
this.smartfileArray = this.smartfileArray.concat(smartfileArrayArg);
}
public async getFileByPath(pathArg: string) {
for (const smartfile of this.smartfileArray) {
if (smartfile.path === pathArg) {
return smartfile;
public addSmartfile(smartfileArg: SmartFile): void {
this.smartfileArray.push(smartfileArg);
}
public removeByPath(pathArg: string): boolean {
const initialLength = this.smartfileArray.length;
this.smartfileArray = this.smartfileArray.filter(f => f.path !== pathArg);
return this.smartfileArray.length < initialLength;
}
public clear(): void {
this.smartfileArray = [];
}
public merge(otherVDir: VirtualDirectory): void {
this.addSmartfiles(otherVDir.smartfileArray);
}
// ============================================
// Collection Queries
// ============================================
public exists(pathArg: string): boolean {
return this.smartfileArray.some(f => f.path === pathArg);
}
public has(pathArg: string): boolean {
return this.exists(pathArg);
}
public async getFileByPath(pathArg: string): Promise<SmartFile | undefined> {
return this.smartfileArray.find(f => f.path === pathArg);
}
public listFiles(): SmartFile[] {
return [...this.smartfileArray];
}
public listDirectories(): string[] {
const dirs = new Set<string>();
for (const file of this.smartfileArray) {
const dir = plugins.path.dirname(file.path);
if (dir !== '.') {
dirs.add(dir);
}
}
return Array.from(dirs).sort();
}
public filter(predicate: (file: SmartFile) => boolean): VirtualDirectory {
const newVDir = new VirtualDirectory(this.smartFs, this.factory);
newVDir.addSmartfiles(this.smartfileArray.filter(predicate));
return newVDir;
}
public map(fn: (file: SmartFile) => SmartFile): VirtualDirectory {
const newVDir = new VirtualDirectory(this.smartFs, this.factory);
newVDir.addSmartfiles(this.smartfileArray.map(fn));
return newVDir;
}
public find(predicate: (file: SmartFile) => boolean): SmartFile | undefined {
return this.smartfileArray.find(predicate);
}
public size(): number {
return this.smartfileArray.length;
}
public isEmpty(): boolean {
return this.smartfileArray.length === 0;
}
public async toVirtualDirTransferableObject(): Promise<plugins.smartfileInterfaces.VirtualDirTransferableObject> {
return {
files: this.smartfileArray.map((smartfileArg) => smartfileArg.foldToJson()),
files: this.smartfileArray.map((smartfileArg) =>
smartfileArg.foldToJson(),
),
};
}
@@ -67,7 +171,7 @@ export class VirtualDirectory {
}
public async shiftToSubdirectory(subDir: string): Promise<VirtualDirectory> {
const newVirtualDir = new VirtualDirectory();
const newVirtualDir = new VirtualDirectory(this.smartFs, this.factory);
for (const file of this.smartfileArray) {
if (file.path.startsWith(subDir)) {
const adjustedFilePath = plugins.path.relative(subDir, file.path);
@@ -78,7 +182,17 @@ export class VirtualDirectory {
return newVirtualDir;
}
public async addVirtualDirectory(virtualDir: VirtualDirectory, newRoot: string): Promise<void> {
public async loadFromDisk(dirArg: string): Promise<void> {
// Load from disk, replacing current collection
this.clear();
const loaded = await VirtualDirectory.fromFsDirPath(dirArg, this.smartFs, this.factory);
this.addSmartfiles(loaded.smartfileArray);
}
public async addVirtualDirectory(
virtualDir: VirtualDirectory,
newRoot: string,
): Promise<void> {
for (const file of virtualDir.smartfileArray) {
file.path = plugins.path.join(newRoot, file.path);
}

446
ts/fs.ts
View File

@@ -1,446 +0,0 @@
import * as plugins from './smartfile.plugins.js';
import * as interpreter from './interpreter.js';
import { SmartFile } from './classes.smartfile.js';
import * as memory from './memory.js';
/*===============================================================
============================ Checks =============================
===============================================================*/
/**
*
* @param filePath
* @returns {boolean}
*/
export const fileExistsSync = (filePath): boolean => {
let fileExistsBool: boolean = false;
try {
plugins.fsExtra.readFileSync(filePath);
fileExistsBool = true;
} catch (err) {
fileExistsBool = false;
}
return fileExistsBool;
};
/**
*
* @param filePath
* @returns {any}
*/
export const fileExists = async (filePath): Promise<boolean> => {
const done = plugins.smartpromise.defer<boolean>();
plugins.fs.access(filePath, 4, (err) => {
err ? done.resolve(false) : done.resolve(true);
});
return done.promise;
};
/**
* Checks if given path points to an existing directory
*/
export const isDirectory = (pathArg: string): boolean => {
try {
return plugins.fsExtra.statSync(pathArg).isDirectory();
} catch (err) {
return false;
}
};
/**
* Checks if given path points to an existing directory
*/
export const isDirectorySync = (pathArg: string): boolean => {
try {
return plugins.fsExtra.statSync(pathArg).isDirectory();
} catch (err) {
return false;
}
};
/**
* Checks if a given path points to an existing file
*/
export const isFile = (pathArg): boolean => {
return plugins.fsExtra.statSync(pathArg).isFile();
};
/*===============================================================
============================ FS ACTIONS =========================
===============================================================*/
/**
* copies a file from A to B on the local disk
*/
export const copy = async (fromArg: string, toArg: string): Promise<boolean> => {
const done = plugins.smartpromise.defer<boolean>();
plugins.fsExtra.copy(fromArg, toArg, {}, (err) => {
if (err) {
throw new Error(`Could not copy from ${fromArg} to ${toArg}: ${err}`);
}
done.resolve(true);
});
return done.promise;
};
/**
* copies a file SYNCHRONOUSLY from A to B on the local disk
*/
export const copySync = (fromArg: string, toArg: string): boolean => {
plugins.fsExtra.copySync(fromArg, toArg);
return true;
};
/**
* ensures that a directory is in place
*/
export const ensureDir = async (dirPathArg: string) => {
await plugins.fsExtra.ensureDir(dirPathArg);
};
/**
* ensures that a directory is in place
*/
export const ensureDirSync = (dirPathArg: string) => {
plugins.fsExtra.ensureDirSync(dirPathArg);
};
/**
* ensure an empty directory
* @executes ASYNC
*/
export const ensureEmptyDir = async (dirPathArg: string) => {
await plugins.fsExtra.ensureDir(dirPathArg);
await plugins.fsExtra.emptyDir(dirPathArg);
};
/**
* ensure an empty directory
* @executes SYNC
*/
export const ensureEmptyDirSync = (dirPathArg: string) => {
plugins.fsExtra.ensureDirSync(dirPathArg);
plugins.fsExtra.emptyDirSync(dirPathArg);
};
/**
* ensures that a file is on disk
* @param filePath the filePath to ensureDir
* @param the fileContent to place into a new file in case it doesn't exist yet
* @returns Promise<void>
* @exec ASYNC
*/
export const ensureFile = async (filePathArg, initFileStringArg): Promise<void> => {
ensureFileSync(filePathArg, initFileStringArg);
};
/**
* ensures that a file is on disk
* @param filePath the filePath to ensureDir
* @param the fileContent to place into a new file in case it doesn't exist yet
* @returns Promise<void>
* @exec SYNC
*/
export const ensureFileSync = (filePathArg: string, initFileStringArg: string): void => {
if (fileExistsSync(filePathArg)) {
return null;
} else {
memory.toFsSync(initFileStringArg, filePathArg);
}
};
/**
* removes a file or folder from local disk
*/
export const remove = async (pathArg: string): Promise<void> => {
await plugins.fsExtra.remove(pathArg);
};
/**
* removes a file SYNCHRONOUSLY from local disk
*/
export const removeSync = (pathArg: string): void => {
plugins.fsExtra.removeSync(pathArg);
};
/**
* removes an array of filePaths from disk
*/
export const removeMany = async (filePathArrayArg: string[]) => {
const promiseArray: Array<Promise<void>> = [];
for (const filePath of filePathArrayArg) {
promiseArray.push(remove(filePath));
}
await Promise.all(promiseArray);
};
/**
* like removeFilePathArray but SYNCHRONOUSLY
*/
export const removeManySync = (filePathArrayArg: string[]): void => {
for (const filePath of filePathArrayArg) {
removeSync(filePath);
}
};
/*===============================================================
============================ Write/Read =========================
===============================================================*/
/**
*
* @param filePathArg
* @param fileTypeArg
* @returns {any}
*/
export const toObjectSync = (filePathArg, fileTypeArg?) => {
const fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
let fileType;
fileTypeArg ? (fileType = fileTypeArg) : (fileType = interpreter.filetype(filePathArg));
return interpreter.objectFile(fileString, fileType);
};
/**
* reads a file content to a String
*/
export const toStringSync = (filePath: string): string => {
const encoding = plugins.smartmime.getEncoding(filePath);
let fileString: string | Buffer = plugins.fsExtra.readFileSync(filePath, encoding);
if (Buffer.isBuffer(fileString)) {
fileString = fileString.toString('binary');
}
return fileString;
};
export const toBuffer = async (filePath: string): Promise<Buffer> => {
return plugins.fsExtra.readFile(filePath);
};
export const toBufferSync = (filePath: string): Buffer => {
return plugins.fsExtra.readFileSync(filePath);
};
/**
* Creates a Readable Stream from a file path.
* @param filePath The path to the file.
* @returns {fs.ReadStream}
*/
export const toReadStream = (filePath: string): plugins.fs.ReadStream => {
if (!fileExistsSync(filePath)) {
throw new Error(`File does not exist at path: ${filePath}`);
}
return plugins.fsExtra.createReadStream(filePath);
};
export const fileTreeToHash = async (dirPathArg: string, miniMatchFilter: string) => {
const fileTreeObject = await fileTreeToObject(dirPathArg, miniMatchFilter);
let combinedString = '';
for (const smartfile of fileTreeObject) {
combinedString += await smartfile.getHash();
}
const hash = await plugins.smarthash.sha256FromString(combinedString);
return hash;
};
/**
* creates a smartfile array from a directory
* @param dirPathArg the directory to start from
* @param miniMatchFilter a minimatch filter of what files to include
*/
export const fileTreeToObject = async (dirPathArg: string, miniMatchFilter: string) => {
// handle absolute miniMatchFilter
let dirPath: string;
if (plugins.path.isAbsolute(miniMatchFilter)) {
dirPath = '/';
} else {
dirPath = plugins.smartpath.transform.toAbsolute(dirPathArg) as string;
}
const fileTree = await listFileTree(dirPath, miniMatchFilter);
const smartfileArray: SmartFile[] = [];
for (const filePath of fileTree) {
const readPath = ((): string => {
if (!plugins.path.isAbsolute(filePath)) {
return plugins.path.join(dirPath, filePath);
} else {
return filePath;
}
})();
const fileBuffer = plugins.fs.readFileSync(readPath);
// push a read file as Smartfile
smartfileArray.push(
new SmartFile({
contentBuffer: fileBuffer,
base: dirPath,
path: filePath,
})
);
}
return smartfileArray;
};
/**
* lists Folders in a directory on local disk
* @returns Promise with an array that contains the folder names
*/
export const listFolders = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
return listFoldersSync(pathArg, regexFilter);
};
/**
* lists Folders SYNCHRONOUSLY in a directory on local disk
* @returns an array with the folder names as strings
*/
export const listFoldersSync = (pathArg: string, regexFilter?: RegExp): string[] => {
let folderArray = plugins.fsExtra.readdirSync(pathArg).filter((file) => {
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isDirectory();
});
if (regexFilter) {
folderArray = folderArray.filter((fileItem) => {
return regexFilter.test(fileItem);
});
}
return folderArray;
};
/**
* lists Files in a directory on local disk
* @returns Promise
*/
export const listFiles = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
return listFilesSync(pathArg, regexFilter);
};
/**
* lists Files SYNCHRONOUSLY in a directory on local disk
* @returns an array with the folder names as strings
*/
export const listFilesSync = (pathArg: string, regexFilter?: RegExp): string[] => {
let fileArray = plugins.fsExtra.readdirSync(pathArg).filter((file) => {
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
});
if (regexFilter) {
fileArray = fileArray.filter((fileItem) => {
return regexFilter.test(fileItem);
});
}
return fileArray;
};
/**
* lists all items (folders AND files) in a directory on local disk
* @returns Promise<string[]>
*/
export const listAllItems = async (pathArg: string, regexFilter?: RegExp): Promise<string[]> => {
return listAllItemsSync(pathArg, regexFilter);
};
/**
* lists all items (folders AND files) in a directory on local disk
* @returns an array with the folder names as strings
* @executes SYNC
*/
export const listAllItemsSync = (pathArg: string, regexFilter?: RegExp): string[] => {
let allItmesArray = plugins.fsExtra.readdirSync(pathArg).filter((file) => {
return plugins.fsExtra.statSync(plugins.path.join(pathArg, file)).isFile();
});
if (regexFilter) {
allItmesArray = allItmesArray.filter((fileItem) => {
return regexFilter.test(fileItem);
});
}
return allItmesArray;
};
/**
* lists a file tree using a miniMatch filter
* note: if the miniMatch Filter is an absolute path, the cwdArg will be omitted
* @returns Promise<string[]> string array with the absolute paths of all matching files
*/
export const listFileTree = async (
dirPathArg: string,
miniMatchFilter: string,
absolutePathsBool: boolean = false
): Promise<string[]> => {
// handle absolute miniMatchFilter
let dirPath: string;
if (plugins.path.isAbsolute(miniMatchFilter)) {
dirPath = '/';
} else {
dirPath = dirPathArg;
}
const options = {
cwd: dirPath,
nodir: true,
dot: true,
};
let fileList = await plugins.glob.glob(miniMatchFilter, options);
if (absolutePathsBool) {
fileList = fileList.map((filePath) => {
return plugins.path.resolve(plugins.path.join(dirPath, filePath));
});
}
return fileList;
};
/**
* Watches for file stability before resolving the promise.
*/
export const waitForFileToBeReady = (filePathArg: string): Promise<void> => {
return new Promise(async (resolve, reject) => {
let lastFileSize = -1;
let fileIsStable = false;
const checkFileStability = async () => {
let currentFileSize: number;
const deferred = plugins.smartpromise.defer();
plugins.fs.stat(filePathArg, (err, stats) => {
if (err) {
fileIsStable = true;
watcher.close();
reject(err);
return;
}
currentFileSize = stats.size;
deferred.resolve();
});
await deferred.promise;
if (currentFileSize === lastFileSize) {
fileIsStable = true;
await plugins.smartdelay.delayFor(100);
resolve();
}
lastFileSize = currentFileSize;
};
const watcher = plugins.fs.watch(filePathArg, (eventType, filename) => {
if (eventType === 'change') {
checkFileStability();
}
});
watcher.on('error', (error) => {
watcher.close();
reject(error);
});
while (!fileIsStable) {
await checkFileStability();
if (!fileIsStable) {
await plugins.smartdelay.delayFor(5000);
}
}
watcher.close();
});
};

View File

@@ -1,195 +0,0 @@
/*
This file contains logic for streaming things from and to the filesystem
*/
import * as plugins from './smartfile.plugins.js';
export const createReadStream = (pathArg: string) => {
return plugins.fs.createReadStream(pathArg);
};
export const createWriteStream = (pathArg: string) => {
return plugins.fs.createWriteStream(pathArg);
};
export const processFile = async (
filePath: string,
asyncFunc: (fileStream: plugins.stream.Readable) => Promise<void>
): Promise<void> => {
return new Promise((resolve, reject) => {
const fileStream = createReadStream(filePath);
asyncFunc(fileStream).then(resolve).catch(reject);
});
}
export const processDirectory = async (
directoryPath: string,
asyncFunc: (fileStream: plugins.stream.Readable) => Promise<void>
): Promise<void> => {
const files = plugins.fs.readdirSync(directoryPath, { withFileTypes: true });
for (const file of files) {
const fullPath = plugins.path.join(directoryPath, file.name);
if (file.isDirectory()) {
await processDirectory(fullPath, asyncFunc); // Recursively call processDirectory for directories
} else if (file.isFile()) {
await processFile(fullPath, asyncFunc); // Call async function with the file stream and wait for it
}
}
};
/**
* Checks if a file is ready to be streamed (exists and is not empty).
*/
export const isFileReadyForStreaming = async (filePathArg: string): Promise<boolean> => {
try {
const stats = await plugins.fs.promises.stat(filePathArg);
return stats.size > 0;
} catch (error) {
if (error.code === 'ENOENT') { // File does not exist
return false;
}
throw error; // Rethrow other unexpected errors
}
};
/**
* Waits for a file to be ready for streaming (exists and is not empty).
*/
export const waitForFileToBeReadyForStreaming = (filePathArg: string): Promise<void> => {
return new Promise((resolve, reject) => {
// Normalize and resolve the file path
const filePath = plugins.path.resolve(filePathArg);
// Function to check file stats
const checkFile = (resolve: () => void, reject: (reason: any) => void) => {
plugins.fs.stat(filePath, (err, stats) => {
if (err) {
if (err.code === 'ENOENT') {
// File not found, wait and try again
return;
}
// Some other error occurred
return reject(err);
}
if (stats.size > 0) {
// File exists and is not empty, resolve the promise
resolve();
}
});
};
// Set up file watcher
const watcher = plugins.fs.watch(filePath, { persistent: false }, (eventType) => {
if (eventType === 'change' || eventType === 'rename') {
checkFile(resolve, reject);
}
});
// Check file immediately in case it's already ready
checkFile(resolve, reject);
// Error handling
watcher.on('error', (error) => {
watcher.close();
reject(error);
});
});
};
class SmartReadStream extends plugins.stream.Readable {
private watcher: plugins.fs.FSWatcher | null = null;
private lastReadSize: number = 0;
private endTimeout: NodeJS.Timeout | null = null;
private filePath: string;
private endDelay: number;
private reading: boolean = false;
constructor(filePath: string, endDelay = 60000, opts?: plugins.stream.ReadableOptions) {
super(opts);
this.filePath = filePath;
this.endDelay = endDelay;
}
private startWatching(): void {
this.watcher = plugins.fs.watch(this.filePath, (eventType) => {
if (eventType === 'change') {
this.resetEndTimeout();
}
});
this.watcher.on('error', (error) => {
this.cleanup();
this.emit('error', error);
});
}
private resetEndTimeout(): void {
if (this.endTimeout) clearTimeout(this.endTimeout);
this.endTimeout = setTimeout(() => this.checkForEnd(), this.endDelay);
}
private checkForEnd(): void {
plugins.fs.stat(this.filePath, (err, stats) => {
if (err) {
this.emit('error', err);
return;
}
if (this.lastReadSize === stats.size) {
this.push(null); // Signal the end of the stream
this.cleanup();
} else {
this.lastReadSize = stats.size;
this.resetEndTimeout();
if (!this.reading) {
// We only want to continue reading if we were previously waiting for more data
this.reading = true;
this._read(10000); // Try to read more data
}
}
});
}
private cleanup(): void {
if (this.endTimeout) clearTimeout(this.endTimeout);
if (this.watcher) this.watcher.close();
}
_read(size: number): void {
this.reading = true;
const chunkSize = Math.min(size, 16384); // Read in chunks of 16KB
const buffer = Buffer.alloc(chunkSize);
plugins.fs.open(this.filePath, 'r', (err, fd) => {
if (err) {
this.emit('error', err);
return;
}
plugins.fs.read(fd, buffer, 0, chunkSize, this.lastReadSize, (err, bytesRead, buffer) => {
if (err) {
this.emit('error', err);
return;
}
if (bytesRead > 0) {
this.lastReadSize += bytesRead;
this.push(buffer.slice(0, bytesRead)); // Push the data onto the stream
} else {
this.reading = false; // No more data to read for now
this.resetEndTimeout();
}
plugins.fs.close(fd, (err) => {
if (err) {
this.emit('error', err);
}
});
});
});
}
_destroy(error: Error | null, callback: (error: Error | null) => void): void {
this.cleanup();
callback(error);
}
}

View File

@@ -1,14 +1,11 @@
import * as plugins from './smartfile.plugins.js';
import * as fsMod from './fs.js';
import * as fsStreamMod from './fsstream.js';
import * as interpreterMod from './interpreter.js';
import * as memoryMod from './memory.js';
import * as plugins from './plugins.js';
// Export main classes - focused on in-memory file representations
export * from './classes.smartfile.js';
export * from './classes.streamfile.js';
export * from './classes.virtualdirectory.js';
export * from './classes.smartfile.factory.js';
export const fs = fsMod;
export const fsStream = fsStreamMod;
export const interpreter = interpreterMod;
export const memory = memoryMod;
// Note: Filesystem operations (fs, memory, fsStream, interpreter) have been removed.
// Use @push.rocks/smartfs for low-level filesystem operations.
// Use SmartFileFactory for creating SmartFile/StreamFile/VirtualDirectory instances.

View File

@@ -1,20 +0,0 @@
import * as plugins from './smartfile.plugins.js';
export let filetype = (pathArg: string): string => {
const extName = plugins.path.extname(pathArg);
const fileType = extName.replace(/\.([a-z]*)/, '$1'); // remove . form fileType
return fileType;
};
export let objectFile = (fileStringArg: string, fileTypeArg) => {
switch (fileTypeArg) {
case 'yml':
case 'yaml':
return plugins.yaml.load(fileStringArg);
case 'json':
return JSON.parse(fileStringArg);
default:
console.error('file type ' + fileTypeArg.blue + ' not supported');
break;
}
};

View File

@@ -1,94 +0,0 @@
import * as plugins from './smartfile.plugins.js';
import { SmartFile } from './classes.smartfile.js';
import * as smartfileFs from './fs.js';
import * as interpreter from './interpreter.js';
import type { StreamFile } from './classes.streamfile.js';
/**
* converts file to Object
* @param fileStringArg
* @param fileTypeArg
* @returns {any|any}
*/
export let toObject = (fileStringArg: string, fileTypeArg: string) => {
return interpreter.objectFile(fileStringArg, fileTypeArg);
};
export interface IToFsOptions {
respectRelative?: boolean;
}
/**
* writes string or Smartfile to disk.
* @param fileArg
* @param fileNameArg
* @param fileBaseArg
*/
export let toFs = async (
fileContentArg: string | Buffer | SmartFile | StreamFile,
filePathArg: string,
optionsArg: IToFsOptions = {}
) => {
const done = plugins.smartpromise.defer();
// check args
if (!fileContentArg || !filePathArg) {
throw new Error('expected valid arguments');
}
// prepare actual write action
let fileContent: string | Buffer;
let fileEncoding: 'utf8' | 'binary' = 'utf8';
let filePath: string = filePathArg;
// handle Smartfile
if (fileContentArg instanceof SmartFile) {
fileContent = fileContentArg.contentBuffer;
// handle options
if (optionsArg.respectRelative) {
filePath = plugins.path.join(filePath, fileContentArg.path);
}
} else if (Buffer.isBuffer(fileContentArg)) {
fileContent = fileContentArg;
fileEncoding = 'binary';
} else if (typeof fileContentArg === 'string') {
fileContent = fileContentArg;
} else {
throw new Error('fileContent is neither string nor Smartfile');
}
await smartfileFs.ensureDir(plugins.path.parse(filePath).dir);
plugins.fsExtra.writeFile(filePath, fileContent, { encoding: fileEncoding }, done.resolve);
return await done.promise;
};
/**
* writes a string or a Smartfile to disk synchronously, only supports string
* @param fileArg
* @param filePathArg
*/
export const toFsSync = (fileArg: string, filePathArg: string) => {
// function checks to abort if needed
if (!fileArg || !filePathArg) {
throw new Error('expected a valid arguments');
}
// prepare actual write action
let fileString: string;
const filePath: string = filePathArg;
if (typeof fileArg !== 'string') {
throw new Error('fileArg is not of type String.');
} else if (typeof fileArg === 'string') {
fileString = fileArg;
}
plugins.fsExtra.writeFileSync(filePath, fileString, { encoding: 'utf8' });
};
export let smartfileArrayToFs = async (smartfileArrayArg: SmartFile[], dirArg: string) => {
await smartfileFs.ensureDir(dirArg);
for (const smartfile of smartfileArrayArg) {
await toFs(smartfile, dirArg, {
respectRelative: true,
});
}
};

View File

@@ -1,9 +1,10 @@
// node native scope
import * as fs from 'fs';
import * as fsPromises from 'fs/promises';
import * as path from 'path';
import * as stream from 'stream';
export { fs, path, stream };
export { fs, fsPromises, path, stream };
// @pushrocks scope
import * as lik from '@push.rocks/lik';

View File

@@ -3,9 +3,12 @@
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true,
}
"baseUrl": ".",
"paths": {}
},
"exclude": ["dist_*/**/*.d.ts"]
}