@clerc/core 1.0.3 → 1.1.0

package/README.md

@@ -2,7 +2,9 @@
 
 [![NPM version](https://img.shields.io/npm/v/@clerc/core?color=a1b858&label=)](https://www.npmjs.com/package/@clerc/core)
 
-See [Clerc](https://github.com/clercjs/clerc) for documentation.
+## Documenation
+
+Read the [documentation](https://clerc.so1ve.dev) for more details.
 
 ## 📝 License
 

package/dist/chunk-15K8U1wQ.mjs

@@ -0,0 +1,18 @@
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __exportAll = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+
+//#endregion
+export { __exportAll as t };

package/dist/{index.d.ts → index.d.mts}

@@ -1,8 +1,51 @@
-import * as Types from "@clerc/advanced-types";
 import * as Parser from "@clerc/parser";
 import { DOUBLE_DASH, FlagOptions, IgnoreFunction, InferFlags, InvalidSchemaError, KNOWN_FLAG, PARAMETER, ParsedResult, TypeFunction, TypeValue, UNKNOWN_FLAG } from "@clerc/parser";
 import { CamelCase, DeepPrettify, LiteralUnion, MaybeArray, PartialRequired, Prettify, UnionToIntersection } from "@clerc/utils";
 
+//#region ../advanced-types/src/errors.d.ts
+declare class FlagValidationError extends Error {}
+declare namespace index_d_exports {
+  export { Enum, FlagValidationError, Range, Regex };
+}
+/**
+* Creates a Enum type function that validates the input against allowed values.
+* The display name will be formatted as "value1 | value2 | ..." for help
+* output.
+*
+* @example
+*
+* ```typescript
+* const format = Enum(["json", "yaml", "xml"]);
+* // Help output will show: json | yaml | xml
+* ```
+*
+* @param values - Array of allowed string values
+* @returns A TypeFunction that validates and returns the input value
+* @throws {Error} If the value is not in the allowed values list
+*/
+declare function Enum<T extends string>(...values: T[]): TypeFunction<T>;
+/**
+* Creates a range type function that validates the input is a number within the
+* specified range.
+*
+* @param min - The minimum acceptable value (inclusive)
+* @param max - The maximum acceptable value (inclusive)
+* @returns A TypeFunction that validates the input value
+* @throws {Error} If the value is not a number or is outside the specified
+*   range
+*/
+declare function Range(min: number, max: number): TypeFunction<number>;
+/**
+* Creates a regex type function that validates the input against the provided
+* pattern.
+*
+* @param pattern - The regular expression pattern to validate against
+* @param description - Optional description for display purposes
+* @returns A TypeFunction that validates the input value
+* @throws {Error} If the value does not match the regex pattern
+*/
+declare function Regex(pattern: RegExp, description?: string): TypeFunction<string>;
+//#endregion
 //#region src/types/clerc.d.ts
 type ErrorHandler = (error: unknown) => void;
 //#endregion
@@ -48,7 +91,8 @@ interface CommandOptions<Parameters extends readonly ParameterDefinitionValue[]
   parameters?: Parameters;
   flags?: Flags;
   /**
-  * A callback function to conditionally stop parsing. When it returns true, parsing stops and remaining arguments are preserved in ignored.
+  * A callback function to conditionally stop parsing. When it returns true,
+  * parsing stops and remaining arguments are preserved in ignored.
   */
   ignore?: IgnoreFunction;
 }
@@ -70,8 +114,7 @@ type CommandHandler<C extends Command = Command, GF extends ClercFlagsDefinition
 //#region src/types/interceptor.d.ts
 type InterceptorContext<C extends Command = Command, GF extends ClercFlagsDefinition = {}> = DeepPrettify<BaseContext<C, GF>>;
 /**
-* Function to call the next interceptor in the chain.
-* **MUST** be awaited.
+* Function to call the next interceptor in the chain. **MUST** be awaited.
 */
 type InterceptorNext = () => void | Promise<void>;
 type InterceptorHandler<C extends Command = Command, GF extends ClercFlagsDefinition = {}> = (context: InterceptorContext<C, GF>, next: InterceptorNext) => void | Promise<void>;
@@ -167,4 +210,4 @@ declare const definePlugin: (plugin: Plugin) => Plugin;
 declare const normalizeFlagValue: (flag: ClercFlagDefinitionValue) => ClercFlagOptions;
 declare const normalizeParameterValue: (parameter: ParameterDefinitionValue) => ParameterOptions;
 //#endregion
-export { BaseContext, Clerc, ClercFlagDefinitionValue, ClercFlagOptions, ClercFlagsDefinition, Command, CommandCustomOptions, CommandHandler, CommandHandlerContext, CommandOptions, CommandWithHandler, CommandsMap, CommandsRecord, ContextStore, type CreateOptions, DOUBLE_DASH, ErrorHandler, FlagCustomOptions, InferParameters, Interceptor, InterceptorContext, InterceptorHandler, InterceptorNext, InterceptorObject, InvalidCommandError, InvalidParametersError, InvalidSchemaError, KNOWN_FLAG, MakeEmitterEvents, MissingRequiredFlagError, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, ParameterCustomOptions, ParameterDefinitionValue, ParameterOptions, type ParseOptions, type Parser, Plugin, Types, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, extractParameterInfo, normalizeFlagValue, normalizeParameterValue, resolveCommand };
+export { BaseContext, Clerc, ClercFlagDefinitionValue, ClercFlagOptions, ClercFlagsDefinition, Command, CommandCustomOptions, CommandHandler, CommandHandlerContext, CommandOptions, CommandWithHandler, CommandsMap, CommandsRecord, ContextStore, type CreateOptions, DOUBLE_DASH, ErrorHandler, FlagCustomOptions, InferParameters, Interceptor, InterceptorContext, InterceptorHandler, InterceptorNext, InterceptorObject, InvalidCommandError, InvalidParametersError, InvalidSchemaError, KNOWN_FLAG, MakeEmitterEvents, MissingRequiredFlagError, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, ParameterCustomOptions, ParameterDefinitionValue, ParameterOptions, type ParseOptions, type Parser, Plugin, index_d_exports as Types, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, extractParameterInfo, normalizeFlagValue, normalizeParameterValue, resolveCommand };

package/dist/{index.js → index.mjs}

@@ -1,8 +1,81 @@
-import * as Types from "@clerc/advanced-types";
+import { t as __exportAll } from "./chunk-15K8U1wQ.mjs";
 import { DOUBLE_DASH, DOUBLE_DASH as DOUBLE_DASH$1, InvalidSchemaError, KNOWN_FLAG, PARAMETER, PARAMETER as PARAMETER$1, UNKNOWN_FLAG, parse } from "@clerc/parser";
 import { camelCase, looseIsArray, toArray } from "@clerc/utils";
 import { LiteEmit } from "lite-emit";
 
+//#region ../advanced-types/src/errors.ts
+var FlagValidationError = class extends Error {};
+
+//#endregion
+//#region ../advanced-types/src/index.ts
+var src_exports = /* @__PURE__ */ __exportAll({
+	Enum: () => Enum,
+	FlagValidationError: () => FlagValidationError,
+	Range: () => Range,
+	Regex: () => Regex
+});
+/**
+* Creates a Enum type function that validates the input against allowed values.
+* The display name will be formatted as "value1 | value2 | ..." for help
+* output.
+*
+* @example
+*
+* ```typescript
+* const format = Enum(["json", "yaml", "xml"]);
+* // Help output will show: json | yaml | xml
+* ```
+*
+* @param values - Array of allowed string values
+* @returns A TypeFunction that validates and returns the input value
+* @throws {Error} If the value is not in the allowed values list
+*/
+function Enum(...values) {
+	const fn = ((value) => {
+		if (!values.includes(value)) throw new FlagValidationError(`Invalid value: ${value}. Must be one of: ${values.join(", ")}`);
+		return value;
+	});
+	fn.display = values.join(" | ");
+	return fn;
+}
+/**
+* Creates a range type function that validates the input is a number within the
+* specified range.
+*
+* @param min - The minimum acceptable value (inclusive)
+* @param max - The maximum acceptable value (inclusive)
+* @returns A TypeFunction that validates the input value
+* @throws {Error} If the value is not a number or is outside the specified
+*   range
+*/
+function Range(min, max) {
+	const fn = ((value) => {
+		const num = Number(value);
+		if (Number.isNaN(num) || num < min || num > max) throw new FlagValidationError(`Invalid value: ${value}. Must be a number between ${min} and ${max}`);
+		return num;
+	});
+	fn.display = `${min} - ${max}`;
+	return fn;
+}
+/**
+* Creates a regex type function that validates the input against the provided
+* pattern.
+*
+* @param pattern - The regular expression pattern to validate against
+* @param description - Optional description for display purposes
+* @returns A TypeFunction that validates the input value
+* @throws {Error} If the value does not match the regex pattern
+*/
+function Regex(pattern, description) {
+	const fn = ((value) => {
+		if (!pattern.test(value)) throw new FlagValidationError(`Invalid value: ${value}. Must match pattern: ${pattern}`);
+		return value;
+	});
+	fn.display = description ?? `Regex: ${pattern.toString()}`;
+	return fn;
+}
+
+//#endregion
 //#region src/command.ts
 function resolveCommand(commandsMap, parameters) {
 	for (let i = parameters.length; i >= 0; i--) {
@@ -347,4 +420,4 @@ function createStopAtFirstParameter() {
 const definePlugin = (plugin) => plugin;
 
 //#endregion
-export { Clerc, DOUBLE_DASH, InvalidCommandError, InvalidParametersError, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, Types, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, extractParameterInfo, normalizeFlagValue, normalizeParameterValue, resolveCommand };
+export { Clerc, DOUBLE_DASH, InvalidCommandError, InvalidParametersError, InvalidSchemaError, KNOWN_FLAG, MissingRequiredFlagError, MissingRequiredMetadataError, NoCommandSpecifiedError, NoSuchCommandError, PARAMETER, src_exports as Types, UNKNOWN_FLAG, createStopAtFirstParameter, defineCommand, definePlugin, extractParameterInfo, normalizeFlagValue, normalizeParameterValue, resolveCommand };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerc/core",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve)",
   "type": "module",
   "description": "Clerc core",
@@ -24,19 +24,12 @@
   "license": "MIT",
   "sideEffects": false,
   "exports": {
-    ".": "./dist/index.js"
-  },
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "dist/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "./dist/*",
-        "./dist/index.d.ts"
-      ]
-    }
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
   },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "files": [
     "dist"
   ],
@@ -45,11 +38,11 @@
   },
   "dependencies": {
     "lite-emit": "^4.0.0",
-    "@clerc/advanced-types": "1.0.3",
-    "@clerc/parser": "1.0.3",
-    "@clerc/utils": "1.0.3"
+    "@clerc/parser": "1.1.0",
+    "@clerc/utils": "1.1.0"
   },
   "devDependencies": {
-    "is-platform": "^1.0.0"
+    "is-platform": "^1.0.0",
+    "@clerc/advanced-types": "1.1.0"
   }
 }