koatty_schedule 2.0.0 → 2.1.1

package/.rollup.config.js

@@ -3,61 +3,58 @@
  * @Usage: 
  * @Author: richen
  * @Date: 2021-12-17 10:20:44
- * @LastEditTime: 2021-12-18 11:58:46
+ * @LastEditTime: 2024-11-04 22:04:45
  */
+import commonjs from '@rollup/plugin-commonjs';
 import json from "@rollup/plugin-json";
+import resolve from '@rollup/plugin-node-resolve';
+import { builtinModules } from 'module';
+import del from "rollup-plugin-delete";
 import typescript from 'rollup-plugin-typescript2';
 // import babel from '@rollup/plugin-babel';
+const pkg = require('./package.json');
 
 export default [
-    {
-        input: './src/index.ts',
-        output: [{
-            format: 'cjs',
-            file: './dist/index.js',
-            banner: require('./scripts/copyright')
-        }],
-        plugins: [
-            // babel({
-            //     babelHelpers: "runtime",
-            //     configFile: './babel.config.js',
-            //     exclude: 'node_modules/**',
-            // }),
-            json(),
-            typescript({
-                tsconfigOverride: {
-                    compilerOptions: {
-                        declaration: false,
-                        declarationMap: false,
-                        module: "ESNext"
-                    }
-                }
-            })
-        ]
-    },
-    {
-        input: './src/index.ts',
-        output: [{
-            format: 'es',
-            file: './dist/index.mjs',
-            banner: require('./scripts/copyright')
-        }],
-        plugins: [
-            // babel({
-            //     babelHelpers: "runtime",
-            //     configFile: './babel.config.js',
-            //     exclude: 'node_modules/**',
-            // }),
-            json(),
-            typescript({
-                tsconfigOverride: {
-                    compilerOptions: {
-                        declaration: false,
-                        declarationMap: false,
-                        module: "ESNext"
-                    }
-                }
-            })
-        ]
-    }
+  {
+    input: './src/index.ts',
+    output: [
+      {
+        format: 'cjs',
+        file: './dist/index.js',
+        banner: require('./scripts/copyright'),
+      },
+      {
+        format: 'es',
+        file: './dist/index.mjs',
+        banner: require('./scripts/copyright'),
+      },
+    ],
+    plugins: [
+      del({ targets: ["dist/*", "temp/*", "docs/api"] }),
+      // babel({
+      //     babelHelpers: "runtime",
+      //     configFile: './babel.config.js',
+      //     exclude: 'node_modules/**',
+      // }),
+      json(),
+      resolve({
+        preferBuiltins: true, // 优先选择内置模块
+      }),
+      commonjs(),
+      typescript({
+        tsconfigOverride: {
+          compilerOptions: {
+            declaration: false,
+            declarationMap: false,
+            module: "ESNext"
+          }
+        }
+      })
+    ],
+    external: [
+      ...builtinModules, // 排除 Node.js 内置模块
+      ...Object.keys(pkg.dependencies || {}), // 排除 package.json 中的外部依赖
+    ],
+  },
+
 ]

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.1.1](https://github.com/thinkkoa/koatty_schedule/compare/v2.1.0...v2.1.1) (2025-06-09)
+
+### [1.6.2](https://github.com/thinkkoa/koatty_schedule/compare/v2.0.1...v1.6.2) (2024-11-07)
+
+## [2.1.0](https://github.com/thinkkoa/koatty_schedule/compare/v2.0.1...v2.1.0) (2025-06-09)
+
+
+### Features
+
+* add schedule and redlock decorators with config management ([c1b5359](https://github.com/thinkkoa/koatty_schedule/commit/c1b535940df2b8a3403bf024137519246945870e))
+* enhance ConfigManager with singleton pattern, environment config loading ([00db6eb](https://github.com/thinkkoa/koatty_schedule/commit/00db6eb97bdae226aaf433b23c770704b33d05e8))
+* introduce DecoratorType enum, refactor decorator management system, ([e58e718](https://github.com/thinkkoa/koatty_schedule/commit/e58e718975e663820778352bedb6421e6852ba9f))
+
+
+### Bug Fixes
+
+* simplify error handling in ConfigManager and RedLocker ([7be75fc](https://github.com/thinkkoa/koatty_schedule/commit/7be75fc7f4160094b57ca64905df4c81f77adb51))
+
+
+### Refactor
+
+* use MethodDecoratorManager ([ff077c7](https://github.com/thinkkoa/koatty_schedule/commit/ff077c7211bb6cf258c6885e1d7dcbdacde90ef1))
+
+### [2.0.1](https://github.com/thinkkoa/koatty_schedule/compare/v2.0.0...v2.0.1) (2024-01-17)
+
 ## [2.0.0](https://github.com/thinkkoa/koatty_schedule/compare/v1.6.0...v2.0.0) (2024-01-17)
 
 

package/dist/index.d.ts

@@ -1,49 +1,55 @@
 /*!
 * @Author: richen
-* @Date: 2024-01-17 13:04:42
+* @Date: 2025-06-10 01:38:16
 * @License: BSD (3-Clause)
 * @Copyright (c) - <richenlin(at)gmail.com>
 * @HomePage: https://koatty.org/
 */
-import { RedisOptions } from 'ioredis';
+import { Settings } from '@sesamecare-oss/redlock';
 
 /**
- * Redis-based distributed locks. Redis server config from db.ts.
+ * Decorator types supported by the system
+ */
+export declare enum DecoratorType {
+    SCHEDULED = "SCHEDULED",
+    REDLOCK = "REDLOCK"
+}
+
+/**
+ * Redis-based distributed lock decorator with optimized preprocessing
  *
  * @export
- * @param {string} [name] The locker name. If name is duplicated, lock sharing contention will result.
- * @param {number} [lockTimeOut] Automatic release of lock within a limited maximum time. default 10000
- * @param {number} [waitLockRetry] Try to acquire lock max time. default 3
+ * @param {string} [name] - The locker name. If name is duplicated, lock sharing contention will result.
+ * @param {RedLockOptions} [options] - RedLock configuration options
+ *
+ * Options:
+ * - lockTimeOut?: number - Lock timeout in milliseconds (default: 10000)
+ * - retryCount?: number - The max number of times Redlock will attempt to lock a resource (default: 3)
+ * - RedisOptions: RedisOptions - Redis connection configuration
  *
  * @returns {MethodDecorator}
+ * @throws {Error} When decorator is used on wrong class type or invalid configuration
  */
-export declare function RedLock(name?: string, options?: RedLockOptions): MethodDecorator;
+export declare function RedLock(lockName?: string, options?: RedLockOptions): MethodDecorator;
 
 /**
- * @description: RedLockOptions
- * @return {*}
+ * Configuration options for RedLock
  */
-declare interface RedLockOptions {
-    /**
-     * lock a resource times
-     */
+export declare interface RedLockOptions extends Partial<Settings> {
     lockTimeOut?: number;
-    /**
-     * The max number of times Redlock will attempt to lock a resource
-     */
-    retryCount?: number;
-    /**
-     * redis config
-     */
-    RedisOptions: RedisOptions;
+    clockDriftFactor?: number;
+    maxRetries?: number;
+    retryDelayMs?: number;
 }
 
 /**
- * Schedule task
+ * Schedule task decorator with optimized preprocessing
  *
  * @export
- * @param {string} cron
- * @param {string} timezone
+ * @param {string} cron - Cron expression for task scheduling
+ * @param {string} [timezone='Asia/Beijing'] - Timezone for the schedule
+ *
+ * Cron expression format:
  * * Seconds: 0-59
  * * Minutes: 0-59
  * * Hours: 0-23
@@ -52,7 +58,27 @@ declare interface RedLockOptions {
  * * Day of Week: 1-7 (Sun-Sat)
  *
  * @returns {MethodDecorator}
+ * @throws {Error} When cron expression is invalid or decorator is used on wrong class type
  */
 export declare function Scheduled(cron: string, timezone?: string): MethodDecorator;
 
+/**
+ * @deprecated Use RedLock instead. This will be removed in v3.0.0
+ */
+export declare const SchedulerLock: typeof RedLock;
+
+/**
+ * Validate cron expression format
+ * @param cron - Cron expression to validate
+ * @throws {Error} When cron expression is invalid
+ */
+export declare function validateCronExpression(cron: string): void;
+
+/**
+ * Validate RedLock options
+ * @param options - RedLock options to validate
+ * @throws {Error} When options are invalid
+ */
+export declare function validateRedLockOptions(options: RedLockOptions): void;
+
 export { }