@js-utils-kit/fs 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sriman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1 @@
+var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));let c=require(`fs`);c=s(c);let l=require(`path`);l=s(l);let u=require(`archiver`);u=s(u);function d({format:e,source:t,destination:n,options:r={},log:i=!0,onSuccess:a}){let o=l.default.resolve(t);if(!c.default.existsSync(o)||!c.default.statSync(o).isDirectory())throw Error(`Source directory "${t}" does not exist or is not a directory.`);let s=c.default.createWriteStream(n);e===`zip`&&(r={...r,zlib:{level:9}});let d=(0,u.default)(e,r);return new Promise((e,r)=>{s.on(`close`,()=>{let t=d.pointer();i&&console.log(`${n} created: ${t} total bytes`),a&&a(t),e()}),d.on(`error`,e=>{r(e)}),d.pipe(s),d.directory(t,!1),d.finalize().catch(e=>r(e instanceof Error?e:Error(String(e))))})}exports.createArchive=d;var f=require(`@js-utils-kit/types`);Object.keys(f).forEach(function(e){e!==`default`&&!Object.prototype.hasOwnProperty.call(exports,e)&&Object.defineProperty(exports,e,{enumerable:!0,get:function(){return f[e]}})});

package/dist/index.d.cts

@@ -0,0 +1,38 @@
+import { CreateArchiveOptions } from "@js-utils-kit/types";
+export * from "@js-utils-kit/types";
+
+//#region src/createArchive.d.ts
+
+/**
+ * Creates a {@link ArchiveFormat } archive from a specified directory.
+ *
+ * This function uses the `archiver` library to package a directory into an archive file.
+ * It supports optional compression for `zip` and returns a Promise that resolves
+ * when the archive is successfully created.
+ *
+ * @example
+ *
+ * Function usage:
+ *
+ * ```ts
+ * await createArchive({
+ *   format: "zip",
+ *   source: "dist/",
+ *   destination: "dist.zip",
+ * });
+ * ```
+ *
+ * @returns A Promise that resolves when the archive is created
+ *
+ * @throws If an error occurs during the archiving process
+ */
+declare function createArchive({
+  format,
+  source,
+  destination,
+  options,
+  log,
+  onSuccess
+}: CreateArchiveOptions): Promise<void>;
+//#endregion
+export { createArchive };

package/dist/index.d.mts

@@ -0,0 +1,38 @@
+import { CreateArchiveOptions } from "@js-utils-kit/types";
+export * from "@js-utils-kit/types";
+
+//#region src/createArchive.d.ts
+
+/**
+ * Creates a {@link ArchiveFormat } archive from a specified directory.
+ *
+ * This function uses the `archiver` library to package a directory into an archive file.
+ * It supports optional compression for `zip` and returns a Promise that resolves
+ * when the archive is successfully created.
+ *
+ * @example
+ *
+ * Function usage:
+ *
+ * ```ts
+ * await createArchive({
+ *   format: "zip",
+ *   source: "dist/",
+ *   destination: "dist.zip",
+ * });
+ * ```
+ *
+ * @returns A Promise that resolves when the archive is created
+ *
+ * @throws If an error occurs during the archiving process
+ */
+declare function createArchive({
+  format,
+  source,
+  destination,
+  options,
+  log,
+  onSuccess
+}: CreateArchiveOptions): Promise<void>;
+//#endregion
+export { createArchive };

package/dist/index.mjs

@@ -0,0 +1 @@
+import e from"fs";import t from"path";import n from"archiver";export*from"@js-utils-kit/types";function r({format:r,source:i,destination:a,options:o={},log:s=!0,onSuccess:c}){let l=t.resolve(i);if(!e.existsSync(l)||!e.statSync(l).isDirectory())throw Error(`Source directory "${i}" does not exist or is not a directory.`);let u=e.createWriteStream(a);r===`zip`&&(o={...o,zlib:{level:9}});let d=n(r,o);return new Promise((e,t)=>{u.on(`close`,()=>{let t=d.pointer();s&&console.log(`${a} created: ${t} total bytes`),c&&c(t),e()}),d.on(`error`,e=>{t(e)}),d.pipe(u),d.directory(i,!1),d.finalize().catch(e=>t(e instanceof Error?e:Error(String(e))))})}export{r as createArchive};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@js-utils-kit/fs",
+  "version": "1.0.0",
+  "description": "File system utilities",
+  "private": false,
+  "license": "MIT",
+  "author": {
+    "name": "Sriman",
+    "email": "136729116+TenEplaysOfficial@users.noreply.github.com",
+    "url": "https://tene.vercel.app"
+  },
+  "homepage": "https://js-utils.js.org",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/teneplaysofficial/js-utils-kit",
+    "directory": "packages/fs"
+  },
+  "bugs": {
+    "url": "https://github.com/teneplaysofficial/js-utils-kit/issues"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "dependencies": {
+    "archiver": "^7.0.1",
+    "@js-utils-kit/types": "1.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run"
+  }
+}