@guanghechen/filepart 1.0.4 → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present guanghechen (https://github.com/guanghechen)
+
+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/README.md

@@ -0,0 +1,144 @@
+<header>
+  <h1 align="center">
+    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/filepart@2.0.0/packages/filepart#readme">@guanghechen/filepart</a>
+  </h1>
+  <div align="center">
+    <a href="https://www.npmjs.com/package/@guanghechen/filepart">
+      <img
+        alt="Npm Version"
+        src="https://img.shields.io/npm/v/@guanghechen/filepart.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/filepart">
+      <img
+        alt="Npm Download"
+        src="https://img.shields.io/npm/dm/@guanghechen/filepart.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/filepart">
+      <img
+        alt="Npm License"
+        src="https://img.shields.io/npm/l/@guanghechen/filepart.svg"
+      />
+    </a>
+    <a href="#install">
+      <img
+        alt="Module Formats: cjs, esm"
+        src="https://img.shields.io/badge/module_formats-cjs%2C%20esm-green.svg"
+      />
+    </a>
+    <a href="https://github.com/nodejs/node">
+      <img
+        alt="Node.js Version"
+        src="https://img.shields.io/node/v/@guanghechen/filepart"
+      />
+    </a>
+    <a href="https://github.com/facebook/jest">
+      <img
+        alt="Tested with Jest"
+        src="https://img.shields.io/badge/tested_with-jest-9c465e.svg"
+      />
+    </a>
+    <a href="https://github.com/prettier/prettier">
+      <img
+        alt="Code Style: prettier"
+        src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"
+      />
+    </a>
+  </div>
+</header>
+<br/>
+
+File helper utilities for calculating file part ranges and generating part names. Useful for
+splitting large files into smaller chunks.
+
+## Install
+
+- npm
+
+  ```bash
+  npm install --save @guanghechen/filepart
+  ```
+
+- yarn
+
+  ```bash
+  yarn add @guanghechen/filepart
+  ```
+
+## Usage
+
+### Calculate File Parts by Size
+
+Split a file into parts of a specific size:
+
+```typescript
+import { calcFilePartItemsBySize } from '@guanghechen/filepart'
+
+const fileSize = 1000 // bytes
+const partSize = 300  // bytes per part
+
+const parts = [...calcFilePartItemsBySize(fileSize, partSize)]
+// Result:
+// [
+//   { sid: 1, start: 0, end: 300 },
+//   { sid: 2, start: 300, end: 600 },
+//   { sid: 3, start: 600, end: 900 },
+//   { sid: 4, start: 900, end: 1000 }
+// ]
+```
+
+### Calculate File Parts by Count
+
+Split a file into a specific number of parts:
+
+```typescript
+import { calcFilePartItemsByCount } from '@guanghechen/filepart'
+
+const fileSize = 1000 // bytes
+const partCount = 3   // number of parts
+
+const parts = [...calcFilePartItemsByCount(fileSize, partCount)]
+// Result:
+// [
+//   { sid: 1, start: 0, end: 334 },
+//   { sid: 2, start: 334, end: 668 },
+//   { sid: 3, start: 668, end: 1000 }
+// ]
+```
+
+### Generate Part Names
+
+Generate file part names with padded sequence numbers:
+
+```typescript
+import { calcFilePartNames, calcFilePartNamesByCount } from '@guanghechen/filepart'
+
+// From existing parts
+const parts = [{ sid: 1 }, { sid: 2 }, { sid: 3 }]
+const names = [...calcFilePartNames(parts, '.part')]
+// Result: ['.part1', '.part2', '.part3']
+
+// For 14 parts (with zero-padding)
+const names14 = [...calcFilePartNamesByCount(14, '.part')]
+// Result: ['.part01', '.part02', ... '.part14']
+
+// Single part returns empty string (no suffix needed)
+const singlePart = [...calcFilePartNamesByCount(1, '.part')]
+// Result: ['']
+```
+
+### Constants
+
+```typescript
+import { DEFAULT_FILEPART_CODE_PREFIX } from '@guanghechen/filepart'
+
+console.log(DEFAULT_FILEPART_CODE_PREFIX) // '.ghc-part'
+```
+
+## Reference
+
+- [homepage][homepage]
+
+[homepage]:
+  https://github.com/guanghechen/sora/tree/@guanghechen/filepart@2.0.0/packages/filepart#readme

package/lib/cjs/index.cjs

@@ -1,7 +1,8 @@
 'use strict';
 
 var invariant = require('@guanghechen/invariant');
-var filepart_types = require('@guanghechen/filepart.types');
+
+const DEFAULT_FILEPART_CODE_PREFIX = '.ghc-part';
 
 function* calcFilePartItemsBySize(fileSize, partSize) {
     if (fileSize <= 0) {
@@ -74,13 +75,8 @@ function* calcFilePartNamesByCount(partTotal, partCodePrefix) {
     }
 }
 
+exports.DEFAULT_FILEPART_CODE_PREFIX = DEFAULT_FILEPART_CODE_PREFIX;
 exports.calcFilePartItemsByCount = calcFilePartItemsByCount;
 exports.calcFilePartItemsBySize = calcFilePartItemsBySize;
 exports.calcFilePartNames = calcFilePartNames;
 exports.calcFilePartNamesByCount = calcFilePartNamesByCount;
-Object.keys(filepart_types).forEach(function (k) {
-    if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-        enumerable: true,
-        get: function () { return filepart_types[k]; }
-    });
-});

package/lib/esm/index.mjs

@@ -1,5 +1,6 @@
 import { invariant } from '@guanghechen/invariant';
-export * from '@guanghechen/filepart.types';
+
+const DEFAULT_FILEPART_CODE_PREFIX = '.ghc-part';
 
 function* calcFilePartItemsBySize(fileSize, partSize) {
     if (fileSize <= 0) {
@@ -72,4 +73,4 @@ function* calcFilePartNamesByCount(partTotal, partCodePrefix) {
     }
 }
 
-export { calcFilePartItemsByCount, calcFilePartItemsBySize, calcFilePartNames, calcFilePartNamesByCount };
+export { DEFAULT_FILEPART_CODE_PREFIX, calcFilePartItemsByCount, calcFilePartItemsBySize, calcFilePartNames, calcFilePartNamesByCount };

package/lib/types/index.d.ts

@@ -1,5 +1,22 @@
-import { IFilePartItem } from '@guanghechen/filepart.types';
-export * from '@guanghechen/filepart.types';
+declare const DEFAULT_FILEPART_CODE_PREFIX = ".ghc-part";
+
+/**
+ * An part item of file.
+ */
+interface IFilePartItem {
+    /**
+     * Sequence no of a part.
+     */
+    sid: number;
+    /**
+     * Start position of a part in sourcefile.
+     */
+    start: number;
+    /**
+     * End position of a part in sourcefile.
+     */
+    end: number;
+}
 
 /**
  * Generate file part items by part size.
@@ -27,4 +44,5 @@ declare function calcFilePartItemsByCount(fileSize: number, partTotal: number):
 declare function calcFilePartNames(parts: ReadonlyArray<Pick<IFilePartItem, 'sid'>>, partCodePrefix: string): IterableIterator<string>;
 declare function calcFilePartNamesByCount(partTotal: number, partCodePrefix: string): IterableIterator<string>;
 
-export { calcFilePartItemsByCount, calcFilePartItemsBySize, calcFilePartNames, calcFilePartNamesByCount };
+export { DEFAULT_FILEPART_CODE_PREFIX, calcFilePartItemsByCount, calcFilePartItemsBySize, calcFilePartNames, calcFilePartNamesByCount };
+export type { IFilePartItem };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/filepart",
-  "version": "1.0.4",
+  "version": "2.0.1",
   "description": "File helper",
   "author": {
     "name": "guanghechen",
@@ -8,10 +8,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/filepart@1.0.3",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/filepart@2.0.0",
     "directory": "packages/filepart"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/filepart@1.0.3/packages/filepart#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/filepart@2.0.0/packages/filepart#readme",
   "keywords": [
     "file helper",
     "split file",
@@ -20,10 +20,10 @@
   "type": "module",
   "exports": {
     ".": {
+      "types": "./lib/types/index.d.ts",
       "source": "./src/index.ts",
       "import": "./lib/esm/index.mjs",
-      "require": "./lib/cjs/index.cjs",
-      "types": "./lib/types/index.d.ts"
+      "require": "./lib/cjs/index.cjs"
     }
   },
   "source": "./src/index.ts",
@@ -40,8 +40,13 @@
     "README.md"
   ],
   "dependencies": {
-    "@guanghechen/filepart.types": "^1.0.3",
-    "@guanghechen/invariant": "^6.0.5"
+    "@guanghechen/invariant": "^7.0.1"
   },
-  "gitHead": "163ec00ff9d6f2d26673bccd3b6f6f31db195d7a"
-}
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  }
+}