@shell-shock/core 0.17.8 → 0.17.11

package/dist/types/command.cjs

@@ -1 +1,402 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=[`T`,`K`,`Pick`,`l+e#!e"!fRb!b"Pde""N#!w#y`],t=[`T`,`Partial`,`l+e#!e"!fRb!Pde"!gN#"w"y`],n=[`T`,`K`,()=>e,()=>i,`Omit`,`b!b"e!!e!!ge!"o$#o##w%y`],r=[`K`,`T`,`Record`,`l'e#"Rb!b"Pde"!N#!w#y`],i=[`T`,`U`,`Exclude`,`l6!Re$!RPe#!e$"qk#%QRb!b"Pde"!p)w#y`],a=[`CommandParameterType`,`P&')P&'JFJw!y`],o={string:`string`,number:`number`,boolean:`boolean`},s=[()=>o,()=>o,`CommandParameterKind`,`i!i"gfw#y`],c=[`name`,`The option name.`,()=>s,`kind`,`The option kind.`,`title`,`The display title.`,`description`,`The option description.`,`alias`,`Alternative option names.`,`default`,`The default value.`,!1,`env`,`The environment variable name or false to disable.`,`optional`,`Whether the option is optional.`,`variadic`,`Whether the option accepts multiple values.`,`BaseCommandParameter`,`P&4!?"n#4$?%&4&?'&4(?)&F4*?+P&')&F'F)FJ4,8?-P&..J4/?0)41?2)43?4Mw5y`],l=[`default`,`The default value.`,!1,`variadic`,`Whether the option accepts multiple values.`,`BaseSingleCommandParameter`,`PP&')J4!8?".#4$?%Mw&y`],u=[`default`,`The default value.`,!0,`variadic`,`Whether the option accepts multiple values.`,`BaseVariadicCommandParameter`,`PP&F'F)FJ4!8?".#4$?%Mw&y`],d=[()=>c,`string`,`kind`,`The option kind.`,`default`,`The default value.`,`email`,`uri`,`uuid`,`ipv4`,`ipv6`,`date`,`time`,`date-time`,`duration`,`format`,`A standard string format to validate the option value against.`,`choices`,`The allowed choices for the option value.`,`BaseStringCommandParameter`,`Pn!."4#?$P&&FJ4%8?&P.'.(.).*.+.,.-.../J408?1&F428?3Mw4y`],f=[()=>d,`default`,`The default value.`,!1,`variadic`,`Whether the option accepts multiple values.`,`SingleStringCommandParameter`,`Pn!&4"8?#.$4%?&Mw'y`],p=[()=>d,`default`,`The default value.`,!0,`variadic`,`Whether the option accepts multiple values.`,`VariadicStringCommandParameter`,`Pn!&F4"8?#.$4%?&Mw'y`],m=[()=>f,()=>p,`StringCommandParameter`,`Pn!n"Jw#y`],h=[()=>c,`number`,`kind`,`The option kind.`,`default`,`The default value.`,`choices`,`The allowed choices for the option value.`,`BaseNumberCommandParameter`,`Pn!."4#?$P''FJ4%8?&'F4'8?(Mw)y`],g=[()=>h,`default`,`The default value.`,!1,`variadic`,`Whether the option accepts multiple values.`,`SingleNumberCommandParameter`,`Pn!'4"8?#.$4%?&Mw'y`],_=[()=>h,`default`,`The default value.`,!0,`variadic`,`Whether the option accepts multiple values.`,`VariadicNumberCommandParameter`,`Pn!'F4"8?#.$4%?&Mw'y`],v=[()=>g,()=>_,`NumberCommandParameter`,`Pn!n"Jw#y`],y=[()=>c,`boolean`,`kind`,`The option kind.`,`default`,`The default value.`,`BaseBooleanCommandParameter`,`Pn!."4#?$P))FJ4%8?&Mw'y`],b=[()=>y,`default`,`The default value.`,!1,`variadic`,`Whether the option accepts multiple values.`,`SingleBooleanCommandParameter`,`Pn!)4"8?#.$4%?&Mw'y`],x=[()=>y,`default`,`The default value.`,!0,`variadic`,`Whether the option accepts multiple values.`,`VariadicBooleanCommandParameter`,`Pn!)F4"8?#.$4%?&Mw'y`],S=[()=>b,()=>x,`BooleanCommandParameter`,`Pn!n"Jw#y`],C=[()=>m,()=>v,()=>S,`CommandParameter`,`Pn!n"n#Jw$y`],w=[`T`,()=>e,`kind`,`alias`,()=>t,()=>n,`kind`,`alias`,`alias`,`AsCommandParameterConfig`,`b!Pe"!P.#.$Jo"#e"!P.'.(Jo&#o%"PP&&FJ4)8MKw*y`],T=[()=>w,()=>m,`StringCommandParameterConfig`,`n"o!"w#y`],E=[()=>w,()=>v,`NumberCommandParameterConfig`,`n"o!"w#y`],D=[()=>w,()=>S,`BooleanCommandParameterConfig`,`n"o!"w#y`],O=[()=>T,()=>E,()=>D,`CommandParameterConfig`,`Pn!n"n#Jw$y`],k=[()=>b,`isNegativeOf`,`The option this negates.`,`skipAddingNegative`,`Whether to skip adding a negative option.`,`BooleanCommandOption`,`Pn!&4"8?#)4$8?%Mw&y`],A=[()=>m,()=>v,()=>k,()=>x,`CommandOption`,`Pn!n"n#n$Jw%y`],j=[()=>w,()=>A,`CommandOptionConfig`,`n"o!"w#y`],M=[()=>m,()=>v,()=>S,`CommandArgument`,`Pn!n"n#Jw$y`],N=[()=>w,()=>M,`CommandArgumentConfig`,`n"o!"w#y`],P=[`id`,`The command id.`,`name`,`The command name.`,`path`,`The full command path value.`,`segments`,`The path segments.`,`title`,`The display title.`,`description`,`The command description.`,`alias`,`Alternative command names.`,`icon`,`The command icon.`,`reference`,`A URL to the command documentation or reference.`,`isVirtual`,`Whether the command is virtual.`,`CommandBase`,`PP&,J4!?"&4#?$P&,J4%?&&F4'?(&4)8?*&4+8?,&F4-8?.&4/8?0&418?2)43?4Mw5y`],F=[()=>P,`id`,`The command id.`,`entry`,`The resolved entry definition.`,`tags`,`Optional tags for the command.`,`file`,`source`,`A string representing the source of the command, which can be "file", a specific plugin name, or any other string value that describes the source that added the command.`,`CommandConfig`,`Pn!&4"?#!4$?%&F4&8?'P.(&J4)8?*Mw+y`],I=[()=>F,`title`,`The display title.`,`description`,`The command description.`,`alias`,`Alternative command names.`,`tags`,`A set of tags for the command.`,`file`,`source`,`A string representing the source of the command, which can be "file", a specific plugin name, or any other string value that describes the source that added the command.`,()=>r,()=>A,`options`,`The command options.`,()=>M,`args`,`The positional arguments provided to the command.`,0,`parent`,`The parent command.`,()=>r,0,`children`,`Child commands.`,`CommandTree`,`Pn!P&4"?#&4$?%&F4&?'&F4(?)P.*&J4+?,&n.o-#4/?0n1F42?3P,n4J45?6&n8o7#49?:MKw;y`],L=[()=>n,()=>I,`parent`,`children`,`parent`,`The parent command id.`,()=>r,0,`children`,`Serialized child commands.`,`SerializedCommandTree`,`Pn"P.#.$Jo!#PP,&J4%?&&n(o'#4)?*MKw+y`],R=[`title`,`The display name of the command.`,`description`,`A brief description of what the command does.`,`alias`,`One or more alternative names for the command.`,`tags`,`Optional tags for the command.`,`icon`,`An optional icon to visually represent the command in user interfaces.`,`reference`,`A URL to the command documentation or reference.`,`CommandMetadata`,`P&4!8?"&4#8?$P&&FJ4%8?&&F4'8?(&4)8?*&4+8?,Mw-y`],z=[()=>R,`metadata`,()=>r,()=>j,`JSONSchema7Object`,`StandardJSONSchemaV1`,`options`,()=>N,`args`,`default`,`CommandModule`,`Pn!4"8P&n$o##"w%"w&!J4'8Pn(F!"w&!J4)8!4*8Mw+y`];exports.CommandParameterKinds=o,exports.__ΩAsCommandParameterConfig=w,exports.__ΩBaseBooleanCommandParameter=y,exports.__ΩBaseCommandParameter=c,exports.__ΩBaseNumberCommandParameter=h,exports.__ΩBaseSingleCommandParameter=l,exports.__ΩBaseStringCommandParameter=d,exports.__ΩBaseVariadicCommandParameter=u,exports.__ΩBooleanCommandOption=k,exports.__ΩBooleanCommandParameter=S,exports.__ΩBooleanCommandParameterConfig=D,exports.__ΩCommandArgument=M,exports.__ΩCommandArgumentConfig=N,exports.__ΩCommandBase=P,exports.__ΩCommandConfig=F,exports.__ΩCommandMetadata=R,exports.__ΩCommandModule=z,exports.__ΩCommandOption=A,exports.__ΩCommandOptionConfig=j,exports.__ΩCommandParameter=C,exports.__ΩCommandParameterConfig=O,exports.__ΩCommandParameterKind=s,exports.__ΩCommandParameterType=a,exports.__ΩCommandTree=I,exports.__ΩNumberCommandParameter=v,exports.__ΩNumberCommandParameterConfig=E,exports.__ΩSerializedCommandTree=L,exports.__ΩSingleBooleanCommandParameter=b,exports.__ΩSingleNumberCommandParameter=g,exports.__ΩSingleStringCommandParameter=f,exports.__ΩStringCommandParameter=m,exports.__ΩStringCommandParameterConfig=T,exports.__ΩVariadicBooleanCommandParameter=x,exports.__ΩVariadicNumberCommandParameter=_,exports.__ΩVariadicStringCommandParameter=p;
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+//#region src/types/command.ts
+const __ΩPick = [
+	"T",
+	"K",
+	"Pick",
+	"l+e#!e\"!fRb!b\"Pde\"\"N#!w#y"
+];
+const __ΩPartial = [
+	"T",
+	"Partial",
+	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
+];
+const __ΩOmit = [
+	"T",
+	"K",
+	() => __ΩPick,
+	() => __ΩExclude,
+	"Omit",
+	"b!b\"e!!e!!ge!\"o$#o##w%y"
+];
+const __ΩRecord = [
+	"K",
+	"T",
+	"Record",
+	"l'e#\"Rb!b\"Pde\"!N#!w#y"
+];
+const __ΩExclude = [
+	"T",
+	"U",
+	"Exclude",
+	"l6!Re$!RPe#!e$\"qk#%QRb!b\"Pde\"!p)w#y"
+];
+const __ΩCommandParameterType = [
+	"string",
+	"number",
+	"boolean",
+	"CommandParameterType",
+	"P.!.\".#Jw$y"
+];
+const __ΩBaseCommandParameter = [
+	"name",
+	"The option name.",
+	() => __ΩCommandParameterType,
+	"type",
+	"The option kind.",
+	"title",
+	"The display title.",
+	"description",
+	"The option description.",
+	"alias",
+	"Alternative option names.",
+	"default",
+	"The default value.",
+	false,
+	"env",
+	"The environment variable name or false to disable.",
+	"required",
+	"Whether the option is required.",
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"BaseCommandParameter",
+	"P&4!?\"n#4$?%&4&?'&4(?)&F4*?+P&')&F'F)FJ4,8?-P&..J4/?0)41?2)43?4Mw5y"
+];
+const __ΩBaseSingleCommandParameter = [
+	"default",
+	"The default value.",
+	false,
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"BaseSingleCommandParameter",
+	"PP&')J4!8?\".#4$?%Mw&y"
+];
+const __ΩBaseVariadicCommandParameter = [
+	"default",
+	"The default value.",
+	true,
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"BaseVariadicCommandParameter",
+	"PP&F'F)FJ4!8?\".#4$?%Mw&y"
+];
+const __ΩBaseStringCommandParameter = [
+	() => __ΩBaseCommandParameter,
+	"string",
+	"type",
+	"The option kind.",
+	"default",
+	"The default value.",
+	"format",
+	"A standard string format to validate the option value against.",
+	"choices",
+	"The allowed choices for the option value.",
+	"BaseStringCommandParameter",
+	"Pn!.\"4#?$P&&FJ4%8?&P!&J4'8?(&F4)8?*Mw+y"
+];
+const __ΩSingleStringCommandParameter = [
+	() => __ΩBaseStringCommandParameter,
+	"default",
+	"The default value.",
+	false,
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"SingleStringCommandParameter",
+	"Pn!&4\"8?#.$4%?&Mw'y"
+];
+const __ΩVariadicStringCommandParameter = [
+	() => __ΩBaseStringCommandParameter,
+	"default",
+	"The default value.",
+	true,
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"VariadicStringCommandParameter",
+	"Pn!&F4\"8?#.$4%?&Mw'y"
+];
+const __ΩStringCommandParameter = [
+	() => __ΩSingleStringCommandParameter,
+	() => __ΩVariadicStringCommandParameter,
+	"StringCommandParameter",
+	"Pn!n\"Jw#y"
+];
+const __ΩBaseNumberCommandParameter = [
+	() => __ΩBaseCommandParameter,
+	"number",
+	"type",
+	"The option kind.",
+	"default",
+	"The default value.",
+	"choices",
+	"The allowed choices for the option value.",
+	"BaseNumberCommandParameter",
+	"Pn!.\"4#?$P''FJ4%8?&'F4'8?(Mw)y"
+];
+const __ΩSingleNumberCommandParameter = [
+	() => __ΩBaseNumberCommandParameter,
+	"default",
+	"The default value.",
+	false,
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"SingleNumberCommandParameter",
+	"Pn!'4\"8?#.$4%?&Mw'y"
+];
+const __ΩVariadicNumberCommandParameter = [
+	() => __ΩBaseNumberCommandParameter,
+	"default",
+	"The default value.",
+	true,
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"VariadicNumberCommandParameter",
+	"Pn!'F4\"8?#.$4%?&Mw'y"
+];
+const __ΩNumberCommandParameter = [
+	() => __ΩSingleNumberCommandParameter,
+	() => __ΩVariadicNumberCommandParameter,
+	"NumberCommandParameter",
+	"Pn!n\"Jw#y"
+];
+const __ΩBaseBooleanCommandParameter = [
+	() => __ΩBaseCommandParameter,
+	"boolean",
+	"type",
+	"The option kind.",
+	"default",
+	"The default value.",
+	"BaseBooleanCommandParameter",
+	"Pn!.\"4#?$P))FJ4%8?&Mw'y"
+];
+const __ΩSingleBooleanCommandParameter = [
+	() => __ΩBaseBooleanCommandParameter,
+	"default",
+	"The default value.",
+	false,
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"SingleBooleanCommandParameter",
+	"Pn!)4\"8?#.$4%?&Mw'y"
+];
+const __ΩVariadicBooleanCommandParameter = [
+	() => __ΩBaseBooleanCommandParameter,
+	"default",
+	"The default value.",
+	true,
+	"variadic",
+	"Whether the option accepts multiple values.",
+	"VariadicBooleanCommandParameter",
+	"Pn!)F4\"8?#.$4%?&Mw'y"
+];
+const __ΩBooleanCommandParameter = [
+	() => __ΩSingleBooleanCommandParameter,
+	() => __ΩVariadicBooleanCommandParameter,
+	"BooleanCommandParameter",
+	"Pn!n\"Jw#y"
+];
+const __ΩCommandParameter = [
+	() => __ΩStringCommandParameter,
+	() => __ΩNumberCommandParameter,
+	() => __ΩBooleanCommandParameter,
+	"CommandParameter",
+	"Pn!n\"n#Jw$y"
+];
+const __ΩAsCommandParameterConfig = [
+	"T",
+	() => __ΩPick,
+	"type",
+	() => __ΩPartial,
+	() => __ΩOmit,
+	"type",
+	"alias",
+	"alias",
+	"AsCommandParameterConfig",
+	"b!Pe\"!.#o\"#e\"!P.&.'Jo%#o$\"PP&&FJ4(8MKw)y"
+];
+const __ΩStringCommandParameterConfig = [
+	() => __ΩAsCommandParameterConfig,
+	() => __ΩStringCommandParameter,
+	"StringCommandParameterConfig",
+	"n\"o!\"w#y"
+];
+const __ΩNumberCommandParameterConfig = [
+	() => __ΩAsCommandParameterConfig,
+	() => __ΩNumberCommandParameter,
+	"NumberCommandParameterConfig",
+	"n\"o!\"w#y"
+];
+const __ΩBooleanCommandParameterConfig = [
+	() => __ΩAsCommandParameterConfig,
+	() => __ΩBooleanCommandParameter,
+	"BooleanCommandParameterConfig",
+	"n\"o!\"w#y"
+];
+const __ΩCommandParameterConfig = [
+	() => __ΩStringCommandParameterConfig,
+	() => __ΩNumberCommandParameterConfig,
+	() => __ΩBooleanCommandParameterConfig,
+	"CommandParameterConfig",
+	"Pn!n\"n#Jw$y"
+];
+const __ΩBooleanCommandOption = [
+	() => __ΩSingleBooleanCommandParameter,
+	"isNegativeOf",
+	"The option this negates.",
+	"skipAddingNegative",
+	"Whether to skip adding a negative option.",
+	"BooleanCommandOption",
+	"Pn!&4\"8?#)4$8?%Mw&y"
+];
+const __ΩCommandOption = [
+	() => __ΩStringCommandParameter,
+	() => __ΩNumberCommandParameter,
+	() => __ΩBooleanCommandOption,
+	() => __ΩVariadicBooleanCommandParameter,
+	"CommandOption",
+	"Pn!n\"n#n$Jw%y"
+];
+const __ΩCommandOptionConfig = [
+	() => __ΩAsCommandParameterConfig,
+	() => __ΩCommandOption,
+	"CommandOptionConfig",
+	"n\"o!\"w#y"
+];
+const __ΩCommandArgument = [
+	() => __ΩStringCommandParameter,
+	() => __ΩNumberCommandParameter,
+	() => __ΩBooleanCommandParameter,
+	"CommandArgument",
+	"Pn!n\"n#Jw$y"
+];
+const __ΩCommandArgumentConfig = [
+	() => __ΩAsCommandParameterConfig,
+	() => __ΩCommandArgument,
+	"CommandArgumentConfig",
+	"n\"o!\"w#y"
+];
+const __ΩCommandMetadata = [
+	"title",
+	"The display name of the command.",
+	"description",
+	"A brief description of what the command does.",
+	"alias",
+	"One or more alternative names for the command.",
+	"tags",
+	"Optional tags for the command.",
+	"icon",
+	"An optional icon to visually represent the command in user interfaces.",
+	"docs",
+	"A URL to the command documentation or reference.",
+	"CommandMetadata",
+	"P&4!8?\"&4#8?$P&&FJ4%8?&&F4'8?(&4)8?*&4+8?,Mw-y"
+];
+const __ΩCommandBase = [
+	() => __ΩCommandMetadata,
+	"id",
+	"The command id.",
+	"name",
+	"The command name.",
+	"path",
+	"The full command path value.",
+	"segments",
+	"The path segments.",
+	"alias",
+	"Alternative command names.",
+	"virtual",
+	"Whether the command is virtual.",
+	"CommandBase",
+	"Pn!P&,J4\"?#&4$?%P&,J4&?'&F4(?)&F4*8?+)4,?-Mw.y"
+];
+const __ΩCommandConfig = [
+	() => __ΩCommandBase,
+	"id",
+	"The command id.",
+	"entry",
+	"The resolved entry definition.",
+	() => __ΩCommandMetadata,
+	"tags",
+	"tags",
+	"CommandConfig",
+	"Pn!&4\"?#!4$?%n&.'f4(8Mw)y"
+];
+const __ΩCommandTree = [
+	() => __ΩRecord,
+	() => __ΩCommandOption,
+	"options",
+	"The command options.",
+	() => __ΩCommandArgument,
+	"args",
+	"The positional arguments provided to the command.",
+	0,
+	"parent",
+	"The parent command.",
+	() => __ΩRecord,
+	0,
+	"children",
+	"Child commands.",
+	"CommandTree",
+	"P!P&n\"o!#4#?$n%F4&?'P,n(J4)?*&n,o+#4-?.MKw/y"
+];
+const __ΩSerializedCommandTree = [
+	() => __ΩOmit,
+	() => __ΩCommandTree,
+	"parent",
+	"children",
+	"parent",
+	"The parent command id.",
+	() => __ΩRecord,
+	0,
+	"children",
+	"Serialized child commands.",
+	"SerializedCommandTree",
+	"Pn\"P.#.$Jo!#PP,&J4%?&&n(o'#4)?*MKw+y"
+];
+const __ΩCommandModule = [
+	() => __ΩCommandMetadata,
+	"metadata",
+	() => __ΩRecord,
+	() => __ΩCommandOptionConfig,
+	"options",
+	() => __ΩCommandArgumentConfig,
+	"args",
+	"default",
+	"CommandModule",
+	"Pn!4\"8P&n$o##!J4%8Pn&!JF4'8!4(8Mw)y"
+];
+
+//#endregion
+exports.__ΩAsCommandParameterConfig = __ΩAsCommandParameterConfig;
+exports.__ΩBaseBooleanCommandParameter = __ΩBaseBooleanCommandParameter;
+exports.__ΩBaseCommandParameter = __ΩBaseCommandParameter;
+exports.__ΩBaseNumberCommandParameter = __ΩBaseNumberCommandParameter;
+exports.__ΩBaseSingleCommandParameter = __ΩBaseSingleCommandParameter;
+exports.__ΩBaseStringCommandParameter = __ΩBaseStringCommandParameter;
+exports.__ΩBaseVariadicCommandParameter = __ΩBaseVariadicCommandParameter;
+exports.__ΩBooleanCommandOption = __ΩBooleanCommandOption;
+exports.__ΩBooleanCommandParameter = __ΩBooleanCommandParameter;
+exports.__ΩBooleanCommandParameterConfig = __ΩBooleanCommandParameterConfig;
+exports.__ΩCommandArgument = __ΩCommandArgument;
+exports.__ΩCommandArgumentConfig = __ΩCommandArgumentConfig;
+exports.__ΩCommandBase = __ΩCommandBase;
+exports.__ΩCommandConfig = __ΩCommandConfig;
+exports.__ΩCommandMetadata = __ΩCommandMetadata;
+exports.__ΩCommandModule = __ΩCommandModule;
+exports.__ΩCommandOption = __ΩCommandOption;
+exports.__ΩCommandOptionConfig = __ΩCommandOptionConfig;
+exports.__ΩCommandParameter = __ΩCommandParameter;
+exports.__ΩCommandParameterConfig = __ΩCommandParameterConfig;
+exports.__ΩCommandParameterType = __ΩCommandParameterType;
+exports.__ΩCommandTree = __ΩCommandTree;
+exports.__ΩNumberCommandParameter = __ΩNumberCommandParameter;
+exports.__ΩNumberCommandParameterConfig = __ΩNumberCommandParameterConfig;
+exports.__ΩSerializedCommandTree = __ΩSerializedCommandTree;
+exports.__ΩSingleBooleanCommandParameter = __ΩSingleBooleanCommandParameter;
+exports.__ΩSingleNumberCommandParameter = __ΩSingleNumberCommandParameter;
+exports.__ΩSingleStringCommandParameter = __ΩSingleStringCommandParameter;
+exports.__ΩStringCommandParameter = __ΩStringCommandParameter;
+exports.__ΩStringCommandParameterConfig = __ΩStringCommandParameterConfig;
+exports.__ΩVariadicBooleanCommandParameter = __ΩVariadicBooleanCommandParameter;
+exports.__ΩVariadicNumberCommandParameter = __ΩVariadicNumberCommandParameter;
+exports.__ΩVariadicStringCommandParameter = __ΩVariadicStringCommandParameter;
+//# sourceMappingURL=command.cjs.map

package/dist/types/command.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.cjs","names":[],"sources":[],"mappings":""}

package/dist/types/command.d.cts

@@ -1,18 +1,9 @@
-import { ResolvedEntryTypeDefinition } from "powerlines";
-import { StandardJSONSchemaV1 } from "@standard-schema/spec";
-import { JsonSchema7TupleType } from "@stryke/json";
-import { AnyFunction } from "@stryke/types/base";
-import { JSONSchema7Object } from "json-schema";
-import * as z3 from "zod/v3";
+import { JsonSchemaStringFormat, SchemaInput } from "@powerlines/schema";
+import { AnyFunction, RequiredKeys } from "@stryke/types/base";
+import { ResolvedEntryFileReference } from "powerlines";
 
 //#region src/types/command.d.ts
-type CommandParameterType = string | number | boolean | (string | number)[];
-declare const CommandParameterKinds: {
-  readonly string: "string";
-  readonly number: "number";
-  readonly boolean: "boolean";
-};
-type CommandParameterKind = (typeof CommandParameterKinds)[keyof typeof CommandParameterKinds];
+type CommandParameterType = "string" | "number" | "boolean";
 interface BaseCommandParameter {
   /**
    * The option name.
@@ -21,7 +12,7 @@ interface BaseCommandParameter {
   /**
    * The option kind.
    */
-  kind: CommandParameterKind;
+  type: CommandParameterType;
   /**
    * The display title.
    */
@@ -43,9 +34,9 @@ interface BaseCommandParameter {
    */
   env: string | false;
   /**
-   * Whether the option is optional.
+   * Whether the option is required.
    */
-  optional: boolean;
+  required: boolean;
   /**
    * Whether the option accepts multiple values.
    */
@@ -75,7 +66,7 @@ interface BaseStringCommandParameter extends BaseCommandParameter {
   /**
    * The option kind.
    */
-  kind: "string";
+  type: "string";
   /**
    * The default value.
    */
@@ -83,7 +74,7 @@ interface BaseStringCommandParameter extends BaseCommandParameter {
   /**
    * A standard string format to validate the option value against.
    */
-  format?: "email" | "uri" | "uuid" | "ipv4" | "ipv6" | "date" | "time" | "date-time" | "duration";
+  format?: JsonSchemaStringFormat | string;
   /**
    * The allowed choices for the option value.
    */
@@ -114,7 +105,7 @@ interface BaseNumberCommandParameter extends BaseCommandParameter {
   /**
    * The option kind.
    */
-  kind: "number";
+  type: "number";
   /**
    * The default value.
    */
@@ -149,7 +140,7 @@ interface BaseBooleanCommandParameter extends BaseCommandParameter {
   /**
    * The option kind.
    */
-  kind: "boolean";
+  type: "boolean";
   /**
    * The default value.
    */
@@ -177,7 +168,7 @@ interface VariadicBooleanCommandParameter extends BaseBooleanCommandParameter {
 }
 type BooleanCommandParameter = SingleBooleanCommandParameter | VariadicBooleanCommandParameter;
 type CommandParameter = StringCommandParameter | NumberCommandParameter | BooleanCommandParameter;
-type AsCommandParameterConfig<T extends BaseCommandParameter> = Pick<T, "kind" | "alias"> & Partial<Omit<T, "kind" | "alias">> & {
+type AsCommandParameterConfig<T extends BaseCommandParameter> = Pick<T, "type"> & Partial<Omit<T, "type" | "alias">> & {
   alias?: string | string[];
 };
 type StringCommandParameterConfig = AsCommandParameterConfig<StringCommandParameter>;
@@ -198,7 +189,48 @@ type CommandOption = StringCommandParameter | NumberCommandParameter | BooleanCo
 type CommandOptionConfig = AsCommandParameterConfig<CommandOption>;
 type CommandArgument = StringCommandParameter | NumberCommandParameter | BooleanCommandParameter;
 type CommandArgumentConfig = AsCommandParameterConfig<CommandArgument>;
-interface CommandBase {
+interface CommandMetadata {
+  /**
+   * The display name of the command.
+   *
+   * @remarks
+   * This value will be used in various displays of the user interface and documentation. If not provided, a formatted value of the command name will be used.
+   */
+  title?: string;
+  /**
+   * A brief description of what the command does.
+   *
+   * @remarks
+   * This value will be used in various displays of the user interface and documentation. If not provided, a default message may be shown.
+   */
+  description?: string;
+  /**
+   * One or more alternative names for the command.
+   */
+  alias?: string | string[];
+  /**
+   * Optional tags for the command.
+   *
+   * @remarks
+   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.
+   */
+  tags?: string[];
+  /**
+   * An optional icon to visually represent the command in user interfaces.
+   *
+   * @remarks
+   * This can be a string containing an emoji, a Unicode character, or any other symbol that helps to visually identify the command. If not provided, no icon will be displayed.
+   */
+  icon?: string;
+  /**
+   * A URL to the command documentation or reference.
+   *
+   * @remarks
+   * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the command. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{docs}/command/subcommand`.
+   */
+  docs?: string;
+}
+interface CommandBase extends CommandMetadata {
   /**
    * The command id.
    */
@@ -215,33 +247,17 @@ interface CommandBase {
    * The path segments.
    */
   segments: string[];
-  /**
-   * The display title.
-   */
-  title?: string;
-  /**
-   * The command description.
-   */
-  description?: string;
   /**
    * Alternative command names.
    */
   alias?: string[];
-  /**
-   * The command icon.
-   */
-  icon?: string;
-  /**
-   * A URL to the command documentation or reference.
-   */
-  reference?: string;
   /**
    * Whether the command is virtual.
    *
    * @remarks
    * Virtual commands are considered forks in the command tree and are not directly executable. They are used to group related subcommands together without having an actual command handler or entry point.
    */
-  isVirtual: boolean;
+  virtual: boolean;
 }
 interface CommandConfig extends CommandBase {
   /**
@@ -251,43 +267,10 @@ interface CommandConfig extends CommandBase {
   /**
    * The resolved entry definition.
    */
-  entry: ResolvedEntryTypeDefinition;
-  /**
-   * Optional tags for the command.
-   *
-   * @remarks
-   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.
-   */
-  tags?: string[];
-  /**
-   * A string representing the source of the command, which can be "file", a specific plugin name, or any other string value that describes the source that added the command.
-   */
-  source?: "file" | string;
+  entry: ResolvedEntryFileReference;
+  tags?: CommandMetadata["tags"];
 }
-type CommandTree = CommandConfig & {
-  /**
-   * The display title.
-   */
-  title: string;
-  /**
-   * The command description.
-   */
-  description: string;
-  /**
-   * Alternative command names.
-   */
-  alias: string[];
-  /**
-   * A set of tags for the command.
-   *
-   * @remarks
-   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.
-   */
-  tags: string[];
-  /**
-   * A string representing the source of the command, which can be "file", a specific plugin name, or any other string value that describes the source that added the command.
-   */
-  source: "file" | string;
+type CommandTree = RequiredKeys<CommandConfig, "title" | "description" | "alias" | "tags"> & {
   /**
    * The command options.
    */
@@ -315,53 +298,12 @@ type SerializedCommandTree = Omit<CommandTree, "parent" | "children"> & {
    */
   children: Record<string, SerializedCommandTree>;
 };
-interface CommandMetadata {
-  /**
-   * The display name of the command.
-   *
-   * @remarks
-   * This value will be used in various displays of the user interface and documentation. If not provided, a formatted value of the command name will be used.
-   */
-  title?: string;
-  /**
-   * A brief description of what the command does.
-   *
-   * @remarks
-   * This value will be used in various displays of the user interface and documentation. If not provided, a default message may be shown.
-   */
-  description?: string;
-  /**
-   * One or more alternative names for the command.
-   */
-  alias?: string | string[];
-  /**
-   * Optional tags for the command.
-   *
-   * @remarks
-   * Tags can be used to categorize and organize commands, and can also be utilized by plugins to provide additional functionality or filtering based on tags.
-   */
-  tags?: string[];
-  /**
-   * An optional icon to visually represent the command in user interfaces.
-   *
-   * @remarks
-   * This can be a string containing an emoji, a Unicode character, or any other symbol that helps to visually identify the command. If not provided, no icon will be displayed.
-   */
-  icon?: string;
-  /**
-   * A URL to the command documentation or reference.
-   *
-   * @remarks
-   * This URL can be used in various displays of the user interface and documentation to provide users with a reference for the command. It can also be used by plugins to link to the documentation in relevant contexts. If the token `{command}` is included in the URL, it will be replaced with the full command path to provide links to command specific documentation. For example, `myapp command subcommand` will be translated to `{referenceLink}/command/subcommand`.
-   */
-  reference?: string;
-}
 interface CommandModule {
   metadata?: CommandMetadata;
-  options?: Record<string, CommandOptionConfig> | JSONSchema7Object | StandardJSONSchemaV1<Record<string, CommandParameterType>> | z3.AnyZodObject;
-  args?: CommandArgumentConfig[] | JsonSchema7TupleType | StandardJSONSchemaV1<CommandParameterType[]> | z3.AnyZodTuple;
+  options?: Record<string, CommandOptionConfig> | SchemaInput;
+  args?: (CommandArgumentConfig | SchemaInput)[];
   default?: AnyFunction;
 }
 //#endregion
-export { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterKind, CommandParameterKinds, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter };
+export { AsCommandParameterConfig, BaseBooleanCommandParameter, BaseCommandParameter, BaseNumberCommandParameter, BaseSingleCommandParameter, BaseStringCommandParameter, BaseVariadicCommandParameter, BooleanCommandOption, BooleanCommandParameter, BooleanCommandParameterConfig, CommandArgument, CommandArgumentConfig, CommandBase, CommandConfig, CommandMetadata, CommandModule, CommandOption, CommandOptionConfig, CommandParameter, CommandParameterConfig, CommandParameterType, CommandTree, NumberCommandParameter, NumberCommandParameterConfig, SerializedCommandTree, SingleBooleanCommandParameter, SingleNumberCommandParameter, SingleStringCommandParameter, StringCommandParameter, StringCommandParameterConfig, VariadicBooleanCommandParameter, VariadicNumberCommandParameter, VariadicStringCommandParameter };
 //# sourceMappingURL=command.d.cts.map