@yarn-tool/pkg-version-query 3.0.2 → 3.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,39 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.0.4](https://github.com/bluelovers/ws-yarn-workspaces/compare/@yarn-tool/pkg-version-query@3.0.3...@yarn-tool/pkg-version-query@3.0.4) (2026-03-02)
7
+
8
+
9
+
10
+ ### 📚 Documentation
11
+
12
+ * **ncu:** 新增 NCU 工具模組文件並增強 JSDoc 註解 ([6a7132f](https://github.com/bluelovers/ws-yarn-workspaces/commit/6a7132f1b1fa0ba801b2939675b584270e042cee))
13
+
14
+
15
+ ### 🛠 Build System
16
+
17
+ * **ncu:** add JSDoc documentation for ncu packages ([02b2220](https://github.com/bluelovers/ws-yarn-workspaces/commit/02b22204eea616853507a6ad06118aa73f6c4a9b))
18
+
19
+
20
+ ### ♻️ Chores
21
+
22
+ * Add test config and global types for tsdx ([88a8df6](https://github.com/bluelovers/ws-yarn-workspaces/commit/88a8df6eef5dc59d9e0d9268b21706dceb5ab2a1))
23
+ * 更新 Jest 快照連結並增強類型定義與文件 ([b663b97](https://github.com/bluelovers/ws-yarn-workspaces/commit/b663b97d78d223dc8b3927ea2433938350144de7))
24
+ * add __root.ts test utility to workspace packages ([a771727](https://github.com/bluelovers/ws-yarn-workspaces/commit/a7717278883c86d9ed8ab89f42070d3385c173a7))
25
+ * **deps:** 升級多項依賴套件版本 ([1382602](https://github.com/bluelovers/ws-yarn-workspaces/commit/1382602ca94ff236b251fd1481b6332468de4621))
26
+
27
+
28
+
29
+ ## [3.0.3](https://github.com/bluelovers/ws-yarn-workspaces/compare/@yarn-tool/pkg-version-query@3.0.2...@yarn-tool/pkg-version-query@3.0.3) (2025-09-07)
30
+
31
+
32
+
33
+ ### 📌 Dependencies
34
+
35
+ * fix and update deps avoid use yargs@18 ([5ed9a5c](https://github.com/bluelovers/ws-yarn-workspaces/commit/5ed9a5cd953eeebd28d4ee970e99bed6fb966317))
36
+
37
+
38
+
6
39
  ## [3.0.2](https://github.com/bluelovers/ws-yarn-workspaces/compare/@yarn-tool/pkg-version-query@3.0.1...@yarn-tool/pkg-version-query@3.0.2) (2024-05-03)
7
40
 
8
41
 
package/README.md CHANGED
@@ -1,8 +1,18 @@
1
- # README.md
1
+ # @yarn-tool/pkg-version-query
2
2
 
3
-
3
+ Query package versions from npm registry with LRU cache support. Supports version ranges, npm: protocol, and semver syntax handling.
4
4
 
5
- ## install
5
+ 從 npm registry 查詢套件版本,支援 LRU 快取、版本範圍語法與 npm: 協議處理。
6
+
7
+ ## Features / 功能特色
8
+
9
+ - 🔍 **Version Query** - Query package versions from npm registry
10
+ - 💾 **LRU Cache** - Cache query results to reduce API calls
11
+ - 📦 **Semver Support** - Handle semver version ranges (^, ~, etc.)
12
+ - 🔗 **npm: Protocol** - Support npm: alias protocol syntax
13
+ - ⚡ **Performance** - File-system backed cache for persistence
14
+
15
+ ## Installation / 安裝
6
16
 
7
17
  ```bash
8
18
  yarn add @yarn-tool/pkg-version-query
@@ -10,3 +20,115 @@ yarn-tool add @yarn-tool/pkg-version-query
10
20
  yt add @yarn-tool/pkg-version-query
11
21
  ```
12
22
 
23
+ ## Usage / 使用方式
24
+
25
+ ### Basic Usage / 基本使用
26
+
27
+ ```typescript
28
+ import queryVersionWithCache from '@yarn-tool/pkg-version-query';
29
+
30
+ // Query latest version
31
+ const version = await queryVersionWithCache('lodash');
32
+ console.log(version); // => '4.17.21'
33
+
34
+ // Query specific version range
35
+ const version = await queryVersionWithCache('typescript', '^4.0.0');
36
+ console.log(version); // => '4.9.5'
37
+
38
+ // Query with dist-tag
39
+ const version = await queryVersionWithCache('react', 'next');
40
+ ```
41
+
42
+ ### With Custom Cache Options / 自訂快取選項
43
+
44
+ ```typescript
45
+ import { queryVersionWithCache, getCache } from '@yarn-tool/pkg-version-query';
46
+
47
+ // Get cache instance for advanced operations
48
+ const cache = getCache();
49
+
50
+ // Clear cache
51
+ cache.clear();
52
+
53
+ // Dump cache to filesystem
54
+ await cache.fsDump();
55
+
56
+ // Query with custom cache
57
+ const version = await queryVersionWithCache('lodash', 'latest', {
58
+ cacheAgentOptions: {
59
+ max: 1000, // Max items in cache
60
+ }
61
+ });
62
+ ```
63
+
64
+ ### Query by npm package argument / 使用 npm 套件參數查詢
65
+
66
+ ```typescript
67
+ import { queryVersionByNpmPackageArgWithCache } from '@yarn-tool/pkg-version-query';
68
+
69
+ // Query using npm package argument syntax
70
+ const version = await queryVersionByNpmPackageArgWithCache('lodash@^4.0.0');
71
+ ```
72
+
73
+ ## API Reference / API 參考
74
+
75
+ ### `queryVersionWithCache(name, targetVersion?, options?)`
76
+
77
+ Query package version with LRU cache.
78
+
79
+ **Parameters:**
80
+ - `name` (string) - Package name
81
+ - `targetVersion` (string, optional) - Target version or range, default: `'latest'`
82
+ - `options` (IOptionsQueryVersion, optional) - Query options
83
+ - `notThrowError` (boolean) - Return undefined instead of throwing on error
84
+ - `cacheAgent` (Cache) - Custom cache instance
85
+ - `cacheAgentOptions` (IOptionsLRUCacheFS) - Cache configuration
86
+
87
+ **Returns:** `Bluebird<string>` - Promise resolving to version string
88
+
89
+ ### `queryVersionByNpmPackageArgWithCache(input, options?)`
90
+
91
+ Query version using npm package argument syntax.
92
+
93
+ **Parameters:**
94
+ - `input` (string) - Package argument (e.g., `'lodash@^4.0.0'`)
95
+ - `options` (IOptionsQueryVersion, optional) - Query options
96
+
97
+ **Returns:** `Bluebird<string>` - Promise resolving to version string
98
+
99
+ ### `getCache(options?)`
100
+
101
+ Get or create the global cache instance.
102
+
103
+ **Parameters:**
104
+ - `options` (IOptionsLRUCacheFS, optional) - Cache configuration
105
+
106
+ **Returns:** `Cache<string, ICachedVersionResult>`
107
+
108
+ ### Types / 類型
109
+
110
+ ```typescript
111
+ interface ICachedVersionResult {
112
+ key: string; // Cache key
113
+ name: string; // Package name
114
+ version: string; // Requested version/range
115
+ result?: string; // Resolved version (on success)
116
+ error?: Error; // Error object (on failure)
117
+ }
118
+
119
+ interface IOptionsQueryVersion {
120
+ notThrowError?: boolean;
121
+ cacheAgent?: Cache<string, ICachedVersionResult>;
122
+ cacheAgentOptions?: IOptionsLRUCacheFS<string, ICachedVersionResult>;
123
+ }
124
+ ```
125
+
126
+ ## Related Packages / 相關套件
127
+
128
+ - [@yarn-tool/ncu](../ncu) - npm-check-updates wrapper using this package
129
+ - [package-json](https://github.com/sindresorhus/package-json) - Underlying npm registry client
130
+ - [lru-cache-fs2](https://github.com/bluelovers/lru-cache-fs2) - File-system backed LRU cache
131
+
132
+ ## License / 授權
133
+
134
+ ISC
package/index.d.ts CHANGED
@@ -1,3 +1,22 @@
1
+ /**
2
+ * @yarn-tool/pkg-version-query
3
+ *
4
+ * Query package versions from npm registry with LRU cache support.
5
+ * 從 npm registry 查詢套件版本,支援 LRU 快取機制。
6
+ *
7
+ * @packageDocumentation
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * import queryVersionWithCache from '@yarn-tool/pkg-version-query';
12
+ *
13
+ * // Query latest version
14
+ * const version = await queryVersionWithCache('lodash');
15
+ *
16
+ * // Query specific version range
17
+ * const version = await queryVersionWithCache('typescript', '^4.0.0');
18
+ * ```
19
+ */
1
20
  import { queryVersionByNpmPackageArgWithCache } from './lib/queryVersionByNpmPackageArg';
2
21
  import { queryVersionWithCache } from './lib/queryVersion';
3
22
  import { getCache } from './lib/cacheAgent';
package/index.js CHANGED
@@ -1,4 +1,23 @@
1
1
  "use strict";
2
+ /**
3
+ * @yarn-tool/pkg-version-query
4
+ *
5
+ * Query package versions from npm registry with LRU cache support.
6
+ * 從 npm registry 查詢套件版本,支援 LRU 快取機制。
7
+ *
8
+ * @packageDocumentation
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * import queryVersionWithCache from '@yarn-tool/pkg-version-query';
13
+ *
14
+ * // Query latest version
15
+ * const version = await queryVersionWithCache('lodash');
16
+ *
17
+ * // Query specific version range
18
+ * const version = await queryVersionWithCache('typescript', '^4.0.0');
19
+ * ```
20
+ */
2
21
  Object.defineProperty(exports, "__esModule", { value: true });
3
22
  exports.getCache = exports.queryVersionWithCache = exports.queryVersionByNpmPackageArgWithCache = void 0;
4
23
  const queryVersionByNpmPackageArg_1 = require("./lib/queryVersionByNpmPackageArg");
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,mFAAyF;AAMhF,qHANA,kEAAoC,OAMA;AAL7C,qDAA2D;AAMlD,sGANA,oCAAqB,OAMA;AAL9B,iDAA4C;AAOnC,yFAPA,qBAAQ,OAOA;AAEjB,kBAAe,oCAAqB,CAAA","sourcesContent":["import { queryVersionByNpmPackageArgWithCache } from './lib/queryVersionByNpmPackageArg';\nimport { queryVersionWithCache } from './lib/queryVersion';\nimport { getCache } from './lib/cacheAgent';\n\nexport type { ICachedVersionResult, IOptionsQueryVersion } from './lib/types';\n\nexport { queryVersionByNpmPackageArgWithCache }\nexport { queryVersionWithCache }\n\nexport { getCache }\n\nexport default queryVersionWithCache\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;AAEH,mFAAyF;AAMhF,qHANA,kEAAoC,OAMA;AAL7C,qDAA2D;AAMlD,sGANA,oCAAqB,OAMA;AAL9B,iDAA4C;AAOnC,yFAPA,qBAAQ,OAOA;AAEjB,kBAAe,oCAAqB,CAAA","sourcesContent":["/**\n * @yarn-tool/pkg-version-query\n *\n * Query package versions from npm registry with LRU cache support.\n * 從 npm registry 查詢套件版本,支援 LRU 快取機制。\n *\n * @packageDocumentation\n *\n * @example\n * ```ts\n * import queryVersionWithCache from '@yarn-tool/pkg-version-query';\n *\n * // Query latest version\n * const version = await queryVersionWithCache('lodash');\n *\n * // Query specific version range\n * const version = await queryVersionWithCache('typescript', '^4.0.0');\n * ```\n */\n\nimport { queryVersionByNpmPackageArgWithCache } from './lib/queryVersionByNpmPackageArg';\nimport { queryVersionWithCache } from './lib/queryVersion';\nimport { getCache } from './lib/cacheAgent';\n\nexport type { ICachedVersionResult, IOptionsQueryVersion } from './lib/types';\n\nexport { queryVersionByNpmPackageArgWithCache }\nexport { queryVersionWithCache }\n\nexport { getCache }\n\nexport default queryVersionWithCache\n"]}
package/lib/core.d.ts CHANGED
@@ -1,6 +1,22 @@
1
+ /**
2
+ * Core version query function using package-json.
3
+ * 使用 package-json 的核心版本查詢函數。
4
+ *
5
+ * @module core
6
+ *
7
+ * 提供底層的 npm registry 查詢功能,封裝 package-json 模組。
8
+ */
1
9
  import { Options, AbbreviatedVersion, AbbreviatedMetadata, FullMetadataOptions, FullMetadata } from 'package-json';
2
10
  import Bluebird from 'bluebird';
3
11
  import { IOptionsQueryVersion } from './types';
12
+ /**
13
+ * Query package information from npm registry.
14
+ * 從 npm registry 查詢套件資訊。
15
+ *
16
+ * @param packageName - Package name to query / 要查詢的套件名稱
17
+ * @param options - Query options / 查詢選項
18
+ * @returns Promise resolving to package metadata / 回傳套件元資料的 Promise
19
+ */
4
20
  export declare function _queryVersion(packageName: string, options: IOptionsQueryVersion<FullMetadataOptions>): Bluebird<FullMetadata>;
5
21
  export declare function _queryVersion(packageName: string, options: Omit<Options, 'allVersions' | 'version'> & {
6
22
  allVersions?: false;
package/lib/core.js CHANGED
@@ -1,4 +1,12 @@
1
1
  "use strict";
2
+ /**
3
+ * Core version query function using package-json.
4
+ * 使用 package-json 的核心版本查詢函數。
5
+ *
6
+ * @module core
7
+ *
8
+ * 提供底層的 npm registry 查詢功能,封裝 package-json 模組。
9
+ */
2
10
  Object.defineProperty(exports, "__esModule", { value: true });
3
11
  exports._queryVersion = _queryVersion;
4
12
  const tslib_1 = require("tslib");
package/lib/core.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"core.js","sourceRoot":"","sources":["core.ts"],"names":[],"mappings":";;AAsBA,sCAeC;;AArCD,wEAMsB;AACtB,gEAAgC;AAehC,SAAgB,aAAa,CAAC,WAAmB,EAAE,OAAuC;IAEzF,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,EAAE,EAAC;IAEf,OAAO,kBAAQ,CAAC,OAAO,CAAC,IAAA,sBAAY,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;SACzD,KAAK,CAAC,CAAC,CAAC,EAAE;QAEV,IAAI,OAAO,CAAC,aAAa,EACzB,CAAC;YACA,OAAM;QACP,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC,CAAQ,CACR;AACH,CAAC","sourcesContent":["import _packageJson, {\n\tOptions,\n\tAbbreviatedVersion,\n\tAbbreviatedMetadata,\n\tFullMetadataOptions,\n\tFullMetadata,\n} from 'package-json';\nimport Bluebird from 'bluebird';\nimport { IOptionsQueryVersion } from './types';\n\nexport function _queryVersion(packageName: string,\n\toptions: IOptionsQueryVersion<FullMetadataOptions>,\n): Bluebird<FullMetadata>;\nexport function _queryVersion(packageName: string,\n\toptions: Omit<Options, 'allVersions' | 'version'> & {\n\t\tallVersions?: false,\n\t\tversion: string,\n\t},\n): Bluebird<AbbreviatedVersion>\nexport function _queryVersion(packageName: string,\n\toptions?: IOptionsQueryVersion<Options>,\n): Bluebird<AbbreviatedMetadata>\nexport function _queryVersion(packageName: string, options?: IOptionsQueryVersion<Options>)\n{\n\toptions ??= {};\n\n\treturn Bluebird.resolve(_packageJson(packageName, options))\n\t\t.catch(e =>\n\t\t{\n\t\t\tif (options.notThrowError)\n\t\t\t{\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\treturn Promise.reject(e)\n\t\t}) as any\n\t\t;\n}\n"]}
1
+ {"version":3,"file":"core.js","sourceRoot":"","sources":["core.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AAgCH,sCAeC;;AA7CD,wEAMsB;AACtB,gEAAgC;AAuBhC,SAAgB,aAAa,CAAC,WAAmB,EAAE,OAAuC;IAEzF,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,EAAE,EAAC;IAEf,OAAO,kBAAQ,CAAC,OAAO,CAAC,IAAA,sBAAY,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;SACzD,KAAK,CAAC,CAAC,CAAC,EAAE;QAEV,IAAI,OAAO,CAAC,aAAa,EACzB,CAAC;YACA,OAAM;QACP,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC,CAAQ,CACR;AACH,CAAC","sourcesContent":["/**\n * Core version query function using package-json.\n * 使用 package-json 的核心版本查詢函數。\n *\n * @module core\n *\n * 提供底層的 npm registry 查詢功能,封裝 package-json 模組。\n */\n\nimport _packageJson, {\n\tOptions,\n\tAbbreviatedVersion,\n\tAbbreviatedMetadata,\n\tFullMetadataOptions,\n\tFullMetadata,\n} from 'package-json';\nimport Bluebird from 'bluebird';\nimport { IOptionsQueryVersion } from './types';\n\n/**\n * Query package information from npm registry.\n * 從 npm registry 查詢套件資訊。\n *\n * @param packageName - Package name to query / 要查詢的套件名稱\n * @param options - Query options / 查詢選項\n * @returns Promise resolving to package metadata / 回傳套件元資料的 Promise\n */\nexport function _queryVersion(packageName: string,\n\toptions: IOptionsQueryVersion<FullMetadataOptions>,\n): Bluebird<FullMetadata>;\nexport function _queryVersion(packageName: string,\n\toptions: Omit<Options, 'allVersions' | 'version'> & {\n\t\tallVersions?: false,\n\t\tversion: string,\n\t},\n): Bluebird<AbbreviatedVersion>\nexport function _queryVersion(packageName: string,\n\toptions?: IOptionsQueryVersion<Options>,\n): Bluebird<AbbreviatedMetadata>\nexport function _queryVersion(packageName: string, options?: IOptionsQueryVersion<Options>)\n{\n\toptions ??= {};\n\n\treturn Bluebird.resolve(_packageJson(packageName, options))\n\t\t.catch(e =>\n\t\t{\n\t\t\tif (options.notThrowError)\n\t\t\t{\n\t\t\t\treturn\n\t\t\t}\n\n\t\t\treturn Promise.reject(e)\n\t\t}) as any\n\t\t;\n}\n"]}
@@ -1,6 +1,36 @@
1
+ /**
2
+ * Query package versions with cache support.
3
+ * 查詢套件版本並支援快取機制。
4
+ *
5
+ * @module queryVersion
6
+ *
7
+ * 主要功能:
8
+ * - 從 npm registry 查詢套件版本
9
+ * - 支援 LRU 快取,減少重複查詢
10
+ * - 處理版本範圍語法 (如 ^, ~, npm: 協議)
11
+ * - 錯誤處理與快取錯誤結果
12
+ */
1
13
  import { Options } from 'package-json';
2
14
  import Bluebird from 'bluebird';
3
15
  import { IOptionsQueryVersion } from './types';
16
+ /**
17
+ * Query package version with LRU cache.
18
+ * 使用 LRU 快取查詢套件版本。
19
+ *
20
+ * @param name - Package name / 套件名稱
21
+ * @param targetVersion - Target version or range (default: 'latest') / 目標版本或範圍
22
+ * @param options - Query options / 查詢選項
23
+ * @returns Promise resolving to version string / 回傳版本字串的 Promise
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const version = await queryVersionWithCache('lodash');
28
+ * // => '4.17.21'
29
+ *
30
+ * const version = await queryVersionWithCache('typescript', '^4.0.0');
31
+ * // => '4.9.5'
32
+ * ```
33
+ */
4
34
  export declare function queryVersionWithCache(name: string, targetVersion?: string, options?: IOptionsQueryVersion<Options>): Bluebird<string>;
5
35
  export declare function queryVersion(name: string, targetVersion?: string, save?: boolean, options?: IOptionsQueryVersion<Options>): Bluebird<string>;
6
36
  export default queryVersionWithCache;
@@ -1,4 +1,16 @@
1
1
  "use strict";
2
+ /**
3
+ * Query package versions with cache support.
4
+ * 查詢套件版本並支援快取機制。
5
+ *
6
+ * @module queryVersion
7
+ *
8
+ * 主要功能:
9
+ * - 從 npm registry 查詢套件版本
10
+ * - 支援 LRU 快取,減少重複查詢
11
+ * - 處理版本範圍語法 (如 ^, ~, npm: 協議)
12
+ * - 錯誤處理與快取錯誤結果
13
+ */
2
14
  Object.defineProperty(exports, "__esModule", { value: true });
3
15
  exports.queryVersionWithCache = queryVersionWithCache;
4
16
  exports.queryVersion = queryVersion;
@@ -11,6 +23,24 @@ const core_1 = require("./core");
11
23
  const queryVersionCacheRaw_1 = require("./queryVersionCacheRaw");
12
24
  const handleAmpersandAndSpaces_1 = require("@lazy-node/semver-ampersand/lib/handleAmpersandAndSpaces");
13
25
  const const_1 = require("@lazy-node/semver-ampersand/lib/const");
26
+ /**
27
+ * Query package version with LRU cache.
28
+ * 使用 LRU 快取查詢套件版本。
29
+ *
30
+ * @param name - Package name / 套件名稱
31
+ * @param targetVersion - Target version or range (default: 'latest') / 目標版本或範圍
32
+ * @param options - Query options / 查詢選項
33
+ * @returns Promise resolving to version string / 回傳版本字串的 Promise
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * const version = await queryVersionWithCache('lodash');
38
+ * // => '4.17.21'
39
+ *
40
+ * const version = await queryVersionWithCache('typescript', '^4.0.0');
41
+ * // => '4.9.5'
42
+ * ```
43
+ */
14
44
  function queryVersionWithCache(name, targetVersion = 'latest', options) {
15
45
  return bluebird_1.default.resolve((0, queryVersionCacheRaw_1.queryVersionCacheRaw)(name, targetVersion, options))
16
46
  .then(data => {
@@ -1 +1 @@
1
- {"version":3,"file":"queryVersion.js","sourceRoot":"","sources":["queryVersion.ts"],"names":[],"mappings":";;AAUA,sDAwBC;AAED,oCAwDC;;AA5FD,+CAAmF;AACnF,gEAAgC;AAChC,6CAAwC;AACxC,qDAAmD;AACnD,iCAAuC;AACvC,iEAA8D;AAE9D,uGAAoG;AACpG,iEAA6E;AAE7E,SAAgB,qBAAqB,CAAC,IAAY,EAAE,gBAAwB,QAAQ,EAAE,OAAuC;IAE5H,OAAO,kBAAQ,CAAC,OAAO,CAAC,IAAA,2CAAoB,EAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;SACzE,IAAI,CAAC,IAAI,CAAC,EAAE;;QAEZ,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EACf,CAAC;YACA,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAClC,CAAC;aACI,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EACrB,CAAC;YACA,OAAO,IAAI,CAAC,MAAM,CAAA;QACnB,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,mCAAI,aAAa,EAAE,IAAI,EAAC,OAAO,CAAC;aACrE,KAAK,CAAC,CAAC,CAAC,EAAE;YACV,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAChB,CAAC;gBACA,OAAO,IAAI,CAAC,MAAM,CAAA;YACnB,CAAC;YAED,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACzB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAgB,YAAY,CAAC,IAAY,EAAE,gBAAwB,QAAQ,EAAE,OAAgB,IAAI,EAAE,OAAuC;IAEzI,IAAI,OAAO,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,IAAb,aAAa,GAAK,QAAQ,CAAA,CAAC;IACzC,IAAI,GAAG,GAAG,IAAA,gCAAe,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAE/C,OAAO,IAAA,oBAAa,EAAC,IAAI,EAAE;QAC1B,OAAO;KACP,CAAC;SACA,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QAEhB,OAAO,MAAM,CAAC,OAAO,CAAA;IACtB,CAAC,CAAC;SACD,KAAK,CAAC,mCAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QAExC,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAC9B,CAAC;YACA,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;YAEtC,IAAI,GAAG,KAAK,CAAA;QACb,CAAC;QAED,IAAI,4BAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,EACtC,CAAC;YACA,OAAO,GAAG,IAAA,mDAAwB,EAAC,OAAO,CAAC,CAAA;YAE3C,IAAI,GAAG,KAAK,CAAA;QACb,CAAC;QAED,IAAI,IAAI,EACR,CAAC;YACA,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACzB,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAC,OAAO,CAAC,CAAA;IAClD,CAAC,CAAC;SACD,QAAQ,CAAC,mCAAoB,EAAE,mCAAoB,EAAE,CAAC,KAAK,EAAE,EAAE;QAE/D,IAAI,IAAI,IAAA,qBAAQ,EAAC,OAAO,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE;YAClC,GAAG;YACH,IAAI;YACJ,OAAO;YACP,KAAK;SACL,CAAC,CAAC;IACJ,CAAC,CAAC;SACD,GAAG,CAAC,MAAM,CAAC,EAAE;QAEb,IAAI,IAAI,IAAA,qBAAQ,EAAC,OAAO,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE;YAClC,GAAG;YACH,IAAI;YACJ,OAAO;YACP,MAAM;SACN,CAAC,CAAC;IACJ,CAAC,CAAC,CACD;AACH,CAAC;AAED,kBAAe,qBAAqB,CAAA","sourcesContent":["import { PackageNotFoundError, VersionNotFoundError, Options } from 'package-json';\nimport Bluebird from 'bluebird';\nimport { getCache } from './cacheAgent';\nimport { _createCacheKey } from './createCacheKey';\nimport { _queryVersion } from './core';\nimport { queryVersionCacheRaw } from './queryVersionCacheRaw';\nimport { IOptionsQueryVersion } from './types';\nimport { handleAmpersandAndSpaces } from '@lazy-node/semver-ampersand/lib/handleAmpersandAndSpaces';\nimport { reAmpersandAndSpaces } from '@lazy-node/semver-ampersand/lib/const';\n\nexport function queryVersionWithCache(name: string, targetVersion: string = 'latest', options?: IOptionsQueryVersion<Options>): Bluebird<string>\n{\n\treturn Bluebird.resolve(queryVersionCacheRaw(name, targetVersion, options))\n\t\t.then(data =>\n\t\t{\n\t\t\tif (data?.error)\n\t\t\t{\n\t\t\t\treturn Promise.reject(data.error)\n\t\t\t}\n\t\t\telse if (data?.result)\n\t\t\t{\n\t\t\t\treturn data.result\n\t\t\t}\n\n\t\t\treturn queryVersion(name, data?.version ?? targetVersion, true,options)\n\t\t\t\t.catch(e => {\n\t\t\t\t\tif (data?.result)\n\t\t\t\t\t{\n\t\t\t\t\t\treturn data.result\n\t\t\t\t\t}\n\n\t\t\t\t\treturn Promise.reject(e)\n\t\t\t\t})\n\t\t})\n}\n\nexport function queryVersion(name: string, targetVersion: string = 'latest', save: boolean = true, options?: IOptionsQueryVersion<Options>): Bluebird<string>\n{\n\tlet version = targetVersion ??= 'latest';\n\tlet key = _createCacheKey(name, targetVersion);\n\n\treturn _queryVersion(name, {\n\t\tversion,\n\t})\n\t\t.then((result) =>\n\t\t{\n\t\t\treturn result.version\n\t\t})\n\t\t.catch(VersionNotFoundError, async (e) =>\n\t\t{\n\t\t\tlet bool = true;\n\n\t\t\tif (version.startsWith('npm:'))\n\t\t\t{\n\t\t\t\tversion = version.replace(/^npm:/, '')\n\n\t\t\t\tbool = false\n\t\t\t}\n\n\t\t\tif (reAmpersandAndSpaces.test(version))\n\t\t\t{\n\t\t\t\tversion = handleAmpersandAndSpaces(version)\n\n\t\t\t\tbool = false\n\t\t\t}\n\n\t\t\tif (bool)\n\t\t\t{\n\t\t\t\treturn Promise.reject(e)\n\t\t\t}\n\n\t\t\treturn queryVersion(name, version, false,options)\n\t\t})\n\t\t.tapCatch(VersionNotFoundError, PackageNotFoundError, (error) =>\n\t\t{\n\t\t\tsave && getCache(options).set(key, {\n\t\t\t\tkey,\n\t\t\t\tname,\n\t\t\t\tversion,\n\t\t\t\terror,\n\t\t\t});\n\t\t})\n\t\t.tap(result =>\n\t\t{\n\t\t\tsave && getCache(options).set(key, {\n\t\t\t\tkey,\n\t\t\t\tname,\n\t\t\t\tversion,\n\t\t\t\tresult,\n\t\t\t});\n\t\t})\n\t\t;\n}\n\nexport default queryVersionWithCache\n"]}
1
+ {"version":3,"file":"queryVersion.js","sourceRoot":"","sources":["queryVersion.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;AA8BH,sDAwBC;AAED,oCAwDC;;AA9GD,+CAAmF;AACnF,gEAAgC;AAChC,6CAAwC;AACxC,qDAAmD;AACnD,iCAAuC;AACvC,iEAA8D;AAE9D,uGAAoG;AACpG,iEAA6E;AAE7E;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,qBAAqB,CAAC,IAAY,EAAE,gBAAwB,QAAQ,EAAE,OAAuC;IAE5H,OAAO,kBAAQ,CAAC,OAAO,CAAC,IAAA,2CAAoB,EAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;SACzE,IAAI,CAAC,IAAI,CAAC,EAAE;;QAEZ,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EACf,CAAC;YACA,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAClC,CAAC;aACI,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EACrB,CAAC;YACA,OAAO,IAAI,CAAC,MAAM,CAAA;QACnB,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,EAAE,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,mCAAI,aAAa,EAAE,IAAI,EAAC,OAAO,CAAC;aACrE,KAAK,CAAC,CAAC,CAAC,EAAE;YACV,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAChB,CAAC;gBACA,OAAO,IAAI,CAAC,MAAM,CAAA;YACnB,CAAC;YAED,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACzB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,SAAgB,YAAY,CAAC,IAAY,EAAE,gBAAwB,QAAQ,EAAE,OAAgB,IAAI,EAAE,OAAuC;IAEzI,IAAI,OAAO,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,IAAb,aAAa,GAAK,QAAQ,CAAA,CAAC;IACzC,IAAI,GAAG,GAAG,IAAA,gCAAe,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAE/C,OAAO,IAAA,oBAAa,EAAC,IAAI,EAAE;QAC1B,OAAO;KACP,CAAC;SACA,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QAEhB,OAAO,MAAM,CAAC,OAAO,CAAA;IACtB,CAAC,CAAC;SACD,KAAK,CAAC,mCAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE;QAExC,IAAI,IAAI,GAAG,IAAI,CAAC;QAEhB,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAC9B,CAAC;YACA,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;YAEtC,IAAI,GAAG,KAAK,CAAA;QACb,CAAC;QAED,IAAI,4BAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,EACtC,CAAC;YACA,OAAO,GAAG,IAAA,mDAAwB,EAAC,OAAO,CAAC,CAAA;YAE3C,IAAI,GAAG,KAAK,CAAA;QACb,CAAC;QAED,IAAI,IAAI,EACR,CAAC;YACA,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;QACzB,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAC,OAAO,CAAC,CAAA;IAClD,CAAC,CAAC;SACD,QAAQ,CAAC,mCAAoB,EAAE,mCAAoB,EAAE,CAAC,KAAK,EAAE,EAAE;QAE/D,IAAI,IAAI,IAAA,qBAAQ,EAAC,OAAO,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE;YAClC,GAAG;YACH,IAAI;YACJ,OAAO;YACP,KAAK;SACL,CAAC,CAAC;IACJ,CAAC,CAAC;SACD,GAAG,CAAC,MAAM,CAAC,EAAE;QAEb,IAAI,IAAI,IAAA,qBAAQ,EAAC,OAAO,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE;YAClC,GAAG;YACH,IAAI;YACJ,OAAO;YACP,MAAM;SACN,CAAC,CAAC;IACJ,CAAC,CAAC,CACD;AACH,CAAC;AAED,kBAAe,qBAAqB,CAAA","sourcesContent":["/**\n * Query package versions with cache support.\n * 查詢套件版本並支援快取機制。\n *\n * @module queryVersion\n *\n * 主要功能:\n * - 從 npm registry 查詢套件版本\n * - 支援 LRU 快取,減少重複查詢\n * - 處理版本範圍語法 (如 ^, ~, npm: 協議)\n * - 錯誤處理與快取錯誤結果\n */\n\nimport { PackageNotFoundError, VersionNotFoundError, Options } from 'package-json';\nimport Bluebird from 'bluebird';\nimport { getCache } from './cacheAgent';\nimport { _createCacheKey } from './createCacheKey';\nimport { _queryVersion } from './core';\nimport { queryVersionCacheRaw } from './queryVersionCacheRaw';\nimport { IOptionsQueryVersion } from './types';\nimport { handleAmpersandAndSpaces } from '@lazy-node/semver-ampersand/lib/handleAmpersandAndSpaces';\nimport { reAmpersandAndSpaces } from '@lazy-node/semver-ampersand/lib/const';\n\n/**\n * Query package version with LRU cache.\n * 使用 LRU 快取查詢套件版本。\n *\n * @param name - Package name / 套件名稱\n * @param targetVersion - Target version or range (default: 'latest') / 目標版本或範圍\n * @param options - Query options / 查詢選項\n * @returns Promise resolving to version string / 回傳版本字串的 Promise\n *\n * @example\n * ```ts\n * const version = await queryVersionWithCache('lodash');\n * // => '4.17.21'\n *\n * const version = await queryVersionWithCache('typescript', '^4.0.0');\n * // => '4.9.5'\n * ```\n */\nexport function queryVersionWithCache(name: string, targetVersion: string = 'latest', options?: IOptionsQueryVersion<Options>): Bluebird<string>\n{\n\treturn Bluebird.resolve(queryVersionCacheRaw(name, targetVersion, options))\n\t\t.then(data =>\n\t\t{\n\t\t\tif (data?.error)\n\t\t\t{\n\t\t\t\treturn Promise.reject(data.error)\n\t\t\t}\n\t\t\telse if (data?.result)\n\t\t\t{\n\t\t\t\treturn data.result\n\t\t\t}\n\n\t\t\treturn queryVersion(name, data?.version ?? targetVersion, true,options)\n\t\t\t\t.catch(e => {\n\t\t\t\t\tif (data?.result)\n\t\t\t\t\t{\n\t\t\t\t\t\treturn data.result\n\t\t\t\t\t}\n\n\t\t\t\t\treturn Promise.reject(e)\n\t\t\t\t})\n\t\t})\n}\n\nexport function queryVersion(name: string, targetVersion: string = 'latest', save: boolean = true, options?: IOptionsQueryVersion<Options>): Bluebird<string>\n{\n\tlet version = targetVersion ??= 'latest';\n\tlet key = _createCacheKey(name, targetVersion);\n\n\treturn _queryVersion(name, {\n\t\tversion,\n\t})\n\t\t.then((result) =>\n\t\t{\n\t\t\treturn result.version\n\t\t})\n\t\t.catch(VersionNotFoundError, async (e) =>\n\t\t{\n\t\t\tlet bool = true;\n\n\t\t\tif (version.startsWith('npm:'))\n\t\t\t{\n\t\t\t\tversion = version.replace(/^npm:/, '')\n\n\t\t\t\tbool = false\n\t\t\t}\n\n\t\t\tif (reAmpersandAndSpaces.test(version))\n\t\t\t{\n\t\t\t\tversion = handleAmpersandAndSpaces(version)\n\n\t\t\t\tbool = false\n\t\t\t}\n\n\t\t\tif (bool)\n\t\t\t{\n\t\t\t\treturn Promise.reject(e)\n\t\t\t}\n\n\t\t\treturn queryVersion(name, version, false,options)\n\t\t})\n\t\t.tapCatch(VersionNotFoundError, PackageNotFoundError, (error) =>\n\t\t{\n\t\t\tsave && getCache(options).set(key, {\n\t\t\t\tkey,\n\t\t\t\tname,\n\t\t\t\tversion,\n\t\t\t\terror,\n\t\t\t});\n\t\t})\n\t\t.tap(result =>\n\t\t{\n\t\t\tsave && getCache(options).set(key, {\n\t\t\t\tkey,\n\t\t\t\tname,\n\t\t\t\tversion,\n\t\t\t\tresult,\n\t\t\t});\n\t\t})\n\t\t;\n}\n\nexport default queryVersionWithCache\n"]}
package/lib/types.d.ts CHANGED
@@ -1,6 +1,18 @@
1
+ /**
2
+ * Type definitions for @yarn-tool/pkg-version-query.
3
+ * @yarn-tool/pkg-version-query 的類型定義。
4
+ *
5
+ * @packageDocumentation
6
+ *
7
+ * 包含版本查詢結果、快取選項等相關類型定義。
8
+ */
1
9
  import { VersionNotFoundError, PackageNotFoundError, Options, AbbreviatedMetadata } from 'package-json';
2
10
  import { ITSRequireAtLeastOne } from 'ts-type/lib/type/record';
3
11
  import Cache, { IOptionsLRUCacheFS } from 'lru-cache-fs2';
12
+ /**
13
+ * Core structure for cached version query result.
14
+ * 快取版本查詢結果的核心結構。
15
+ */
4
16
  export interface ICachedVersionResultCore {
5
17
  key: string;
6
18
  name: string;
package/lib/types.js CHANGED
@@ -1,3 +1,11 @@
1
1
  "use strict";
2
+ /**
3
+ * Type definitions for @yarn-tool/pkg-version-query.
4
+ * @yarn-tool/pkg-version-query 的類型定義。
5
+ *
6
+ * @packageDocumentation
7
+ *
8
+ * 包含版本查詢結果、快取選項等相關類型定義。
9
+ */
2
10
  Object.defineProperty(exports, "__esModule", { value: true });
3
11
  //# sourceMappingURL=types.js.map
package/lib/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"","sourcesContent":["import { VersionNotFoundError, PackageNotFoundError, Options, AbbreviatedMetadata } from 'package-json';\nimport { ITSRequireAtLeastOne } from 'ts-type/lib/type/record';\nimport Cache, { IOptionsLRUCacheFS } from 'lru-cache-fs2';\n\nexport interface ICachedVersionResultCore\n{\n\tkey: string,\n\tname: string;\n\tversion: string;\n\tresult?: string;\n\terror?: VersionNotFoundError | PackageNotFoundError;\n}\n\nexport type ICachedVersionResult = ITSRequireAtLeastOne<ICachedVersionResultCore, 'result' | 'error'>\n\nexport type IOptionsQueryVersion<T extends Options | AbbreviatedMetadata> = T & {\n\n\tnotThrowError?: boolean,\n\n\tcacheAgent?: Cache<string, ICachedVersionResult>;\n\tcacheAgentOptions?: IOptionsLRUCacheFS<string, ICachedVersionResult>;\n\n}\n"]}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG","sourcesContent":["/**\n * Type definitions for @yarn-tool/pkg-version-query.\n * @yarn-tool/pkg-version-query 的類型定義。\n *\n * @packageDocumentation\n *\n * 包含版本查詢結果、快取選項等相關類型定義。\n */\n\nimport { VersionNotFoundError, PackageNotFoundError, Options, AbbreviatedMetadata } from 'package-json';\nimport { ITSRequireAtLeastOne } from 'ts-type/lib/type/record';\nimport Cache, { IOptionsLRUCacheFS } from 'lru-cache-fs2';\n\n/**\n * Core structure for cached version query result.\n * 快取版本查詢結果的核心結構。\n */\nexport interface ICachedVersionResultCore\n{\n\tkey: string,\n\tname: string;\n\tversion: string;\n\tresult?: string;\n\terror?: VersionNotFoundError | PackageNotFoundError;\n}\n\nexport type ICachedVersionResult = ITSRequireAtLeastOne<ICachedVersionResultCore, 'result' | 'error'>\n\nexport type IOptionsQueryVersion<T extends Options | AbbreviatedMetadata> = T & {\n\n\tnotThrowError?: boolean,\n\n\tcacheAgent?: Cache<string, ICachedVersionResult>;\n\tcacheAgentOptions?: IOptionsLRUCacheFS<string, ICachedVersionResult>;\n\n}\n"]}
package/package.json CHANGED
@@ -1,11 +1,18 @@
1
1
  {
2
2
  "name": "@yarn-tool/pkg-version-query",
3
- "version": "3.0.2",
4
- "description": "",
3
+ "version": "3.0.4",
4
+ "description": "Query package versions from npm registry with LRU cache support. Supports version ranges, npm: protocol, and semver syntax handling. 從 npm registry 查詢套件版本,支援 LRU 快取、版本範圍語法與 npm: 協議處理。",
5
5
  "keywords": [
6
+ "npm",
7
+ "registry",
8
+ "version",
9
+ "query",
10
+ "cache",
11
+ "lru-cache",
12
+ "package-json",
13
+ "semver",
6
14
  "yarn",
7
15
  "yarn-tool",
8
- "npm",
9
16
  "lerna",
10
17
  "workspaces",
11
18
  "pkg",
@@ -44,17 +51,17 @@
44
51
  "tsc:showConfig": "ynpx get-current-tsconfig -p"
45
52
  },
46
53
  "dependencies": {
47
- "@lazy-node/semver-ampersand": "^3.0.2",
48
- "@yarn-tool/npm-package-arg-util": "^2.0.1",
49
- "cache-path": "^4.0.2",
54
+ "@lazy-node/semver-ampersand": "^3.0.4",
55
+ "@yarn-tool/npm-package-arg-util": "^2.0.3",
56
+ "cache-path": "^4.0.4",
50
57
  "lru-cache-fs2": "^2.0.8",
51
58
  "package-json": "<7 >=6.5",
52
- "semver": "^7.6.0",
59
+ "semver": "^7.7.4",
53
60
  "ts-type": "^3.0.1",
54
61
  "tslib": ">=2"
55
62
  },
56
63
  "publishConfig": {
57
64
  "access": "public"
58
65
  },
59
- "gitHead": "089606f66f3c5501a8f3fdfc42e5a85b57f4d0e9"
66
+ "gitHead": "ae9b0817b25b1019ba68c88e541bbffc7d84047c"
60
67
  }