xrootd 0.2.0 → 0.2.2

package/README.md

@@ -1,9 +1,11 @@
-# 🚀 XRootD TypeScript Support (`xrootd`)
+# XRootD TypeScript Support
 
 A high-performance, enterprise-grade Node.js binding for the [XRootD](https://github.com/xrootd/xrootd) client library. Designed to bring seamless, extreme-throughput data access to the TypeScript ecosystem.
 
+Github Repo: [**Wu-Yijun/xrootd**](https://github.com/Wu-Yijun/xrootd); NPM package: [**XRootD**](https://www.npmjs.com/package/xrootd)
+
 > [!NOTE]
-> **Work in Progress**: This package is currently under active development. While core features are highly functional, the API may undergo minor refinements.
+> **Work in Progress**: This package is currently under active development with some features not supported yet. While core features are highly functional, the API may undergo refinements. Api interfaces are not tests thoroughly so it may be unstable.
 
 
 ## Supported Capabilities
@@ -130,8 +132,8 @@ Unlike traditional Node.js C++ addons, `xrootd` is architected for **High Energy
 
 This project is released under a **Dual License** strategy to balance open-source compatibility and developer freedom:
 
-1. **[GNU GPLv3](https://www.google.com/search?q=https://www.gnu.org/licenses/gpl-3.0.en.html)**: The native binding codebase adheres to the GPLv3 license to remain fully compatible with the upstream C++ XRootD project.
-2. **[MIT](https://www.google.com/search?q=https://opensource.org/licenses/MIT)**: The core TypeScript APIs, interface definitions, and glue layers are provided under the MIT license, allowing you to integrate the TS components into your own software architectures without viral restrictive requirements.
+1. **[GNU GPLv3](LICENSE-GPLv3)**: The native binding codebase adheres to the GPLv3 license to remain fully compatible with the upstream C++ XRootD project.
+2. **[MIT](LICENSE-MIT)**: The core TypeScript APIs, interface definitions, and glue layers are provided under the MIT license, allowing you to integrate the TS components into your own software architectures without viral restrictive requirements.
 
 *Disclaimer: This project is a third-party community initiative built for modern web ecosystems and is not affiliated with, officially endorsed by, or sponsored by the core XRootD project.*
 

package/dist/index.cjs

@@ -742,9 +742,6 @@ var XRootDEnvironment = class {
 		if (!success) console.warn(`[xrootd] Warning: Failed to set integer configuration "${key}"=${intVal}. It might have been overridden by a system environment variable.`);
 		return success;
 	}
-	/**
-	* 设置字符串配置项，返回是否设置成功。
-	*/
 	putString(key, strVal) {
 		if (key === "SecProtocol") {
 			process.env.XrdSecPROTOCOL = strVal;

package/dist/index.d.cts

@@ -232,6 +232,7 @@ declare const MkDirFlags: {
 type MkDirFlags = typeof MkDirFlags[keyof typeof MkDirFlags];
 //#endregion
 //#region lib/file.d.ts
+type Combined = number & {};
 /**
  * XRootD File 客户端
  * 提供对远程文件的异步读写操作及 Node.js 风格的流式接口。
@@ -245,7 +246,7 @@ declare class File$1 {
    * @param flags 打开标志位
    * @param mode 访问权限模式
    */
-  open(url: string, flags?: OpenFlags, mode?: AccessMode): Promise<void>;
+  open(url: string, flags?: OpenFlags | Combined, mode?: AccessMode | Combined): Promise<void>;
   /**
    * 关闭文件
    */
@@ -834,7 +835,7 @@ declare class XRootDEnvironment {
   /**
    * 设置字符串配置项，返回是否设置成功。
    */
-  putString(key: XRootDEnvConfigStringKey | XRootDEnvConfigBoolKey, strVal: string): boolean;
+  putString<Key extends XRootDEnvConfigStringKey | XRootDEnvConfigBoolKey>(key: Key, strVal: XRootDEnvConfig[Key]): boolean;
   /**
    * 设置布尔配置项，返回是否设置成功。
    */

package/dist/index.d.mts

@@ -232,6 +232,7 @@ declare const MkDirFlags: {
 type MkDirFlags = typeof MkDirFlags[keyof typeof MkDirFlags];
 //#endregion
 //#region lib/file.d.ts
+type Combined = number & {};
 /**
  * XRootD File 客户端
  * 提供对远程文件的异步读写操作及 Node.js 风格的流式接口。
@@ -245,7 +246,7 @@ declare class File$1 {
    * @param flags 打开标志位
    * @param mode 访问权限模式
    */
-  open(url: string, flags?: OpenFlags, mode?: AccessMode): Promise<void>;
+  open(url: string, flags?: OpenFlags | Combined, mode?: AccessMode | Combined): Promise<void>;
   /**
    * 关闭文件
    */
@@ -834,7 +835,7 @@ declare class XRootDEnvironment {
   /**
    * 设置字符串配置项，返回是否设置成功。
    */
-  putString(key: XRootDEnvConfigStringKey | XRootDEnvConfigBoolKey, strVal: string): boolean;
+  putString<Key extends XRootDEnvConfigStringKey | XRootDEnvConfigBoolKey>(key: Key, strVal: XRootDEnvConfig[Key]): boolean;
   /**
    * 设置布尔配置项，返回是否设置成功。
    */

package/dist/index.mjs

@@ -717,9 +717,6 @@ var XRootDEnvironment = class {
 		if (!success) console.warn(`[xrootd] Warning: Failed to set integer configuration "${key}"=${intVal}. It might have been overridden by a system environment variable.`);
 		return success;
 	}
-	/**
-	* 设置字符串配置项，返回是否设置成功。
-	*/
 	putString(key, strVal) {
 		if (key === "SecProtocol") {
 			process.env.XrdSecPROTOCOL = strVal;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xrootd",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Prebuilt Node.js Native Addon for XRootD, allowing JS access to EOS file systems",
   "type": "module",
   "exports": {
@@ -77,7 +77,7 @@
     "build": "pnpm run build:addon && pnpm run build:binaries && pnpm run build:tsc && pnpm run build:ts",
     "build:clean": "rm -r ./build && pnpm run build",
     "pack": "mkdir -p packages && pnpm pack --pack-destination ./packages",
-    "test:prep": "unrun ./tests/prepare.ts",
-    "test": "node --test tests/*.mjs"
+    "test:prepare": "unrun ./tests/prepare/main.ts",
+    "test": "unrun tests/native.mjs && unrun tests/url.ts && unrun tests/fs.ts"
   }
 }