@shell-shock/core 0.6.0 → 0.7.0

package/dist/types/command.d.cts

@@ -1,94 +1,359 @@
-import { ReflectionKind } from "@powerlines/deepkit/vendor/type";
+import { ReflectionFunction, ReflectionKind, ReflectionParameter, ReflectionProperty, SerializedTypes } from "@powerlines/deepkit/vendor/type";
 import { AnyFunction } from "@stryke/types/base";
 import { ResolvedEntryTypeDefinition } from "powerlines/types/resolved";
 
 //#region src/types/command.d.ts
-interface BaseCommandOption {
+interface BaseCommandArgument {
+  /**
+   * The option name.
+   */
   name: string;
+  /**
+   * The option kind.
+   */
   kind: ReflectionKind;
+  /**
+   * The display title.
+   */
   title: string;
+  /**
+   * The option description.
+   */
   description: string;
+  /**
+   * Alternative option names.
+   */
   alias: string[];
+  /**
+   * The environment variable name or false to disable.
+   */
   env: string | false;
+  /**
+   * Whether the option is optional.
+   */
   optional: boolean;
 }
-interface StringCommandOption extends BaseCommandOption {
+interface StringCommandArgument extends BaseCommandArgument {
+  /**
+   * The option kind.
+   */
   kind: ReflectionKind.string;
+  /**
+   * The default value.
+   */
   default?: string;
+  /**
+   * Whether the option accepts multiple values.
+   */
   variadic: boolean;
 }
-interface NumberCommandOption extends BaseCommandOption {
+interface NumberCommandArgument extends BaseCommandArgument {
+  /**
+   * The option kind.
+   */
   kind: ReflectionKind.number;
+  /**
+   * The default value.
+   */
   default?: number;
+  /**
+   * Whether the option accepts multiple values.
+   */
   variadic: boolean;
 }
-interface BooleanCommandOption extends BaseCommandOption {
+interface BooleanCommandArgument extends BaseCommandArgument {
+  /**
+   * The option kind.
+   */
   kind: ReflectionKind.boolean;
+  /**
+   * The default value.
+   */
   default?: boolean;
+  /**
+   * The option this negates.
+   */
   isNegativeOf?: string;
+  /**
+   * Whether to skip adding a negative option.
+   */
+  skipAddingNegative?: boolean;
+}
+interface StringCommandOption extends StringCommandArgument {
+  /**
+   * The property reflection.
+   */
+  reflection?: ReflectionProperty;
+}
+interface NumberCommandOption extends NumberCommandArgument {
+  /**
+   * The property reflection.
+   */
+  reflection?: ReflectionProperty;
+}
+interface BooleanCommandOption extends BooleanCommandArgument {
+  /**
+   * The property reflection.
+   */
+  reflection?: ReflectionProperty;
+  /**
+   * The option this negates.
+   */
+  isNegativeOf?: string;
+  /**
+   * Whether to skip adding a negative option.
+   */
   skipAddingNegative?: boolean;
 }
 type CommandOption = StringCommandOption | NumberCommandOption | BooleanCommandOption;
+interface StringCommandParameter extends StringCommandArgument {
+  /**
+   * The parameter reflection.
+   */
+  reflection: ReflectionParameter;
+}
+interface NumberCommandParameter extends NumberCommandArgument {
+  /**
+   * The parameter reflection.
+   */
+  reflection: ReflectionParameter;
+}
+interface BooleanCommandParameter extends BooleanCommandArgument {
+  /**
+   * The parameter reflection.
+   */
+  reflection: ReflectionParameter;
+}
+type CommandParameter = StringCommandParameter | NumberCommandParameter | BooleanCommandParameter;
 interface CommandPath {
+  /**
+   * The full path value.
+   */
   value: string | null;
+  /**
+   * The path segments.
+   */
   segments: string[];
 }
 interface CommandBase {
+  /**
+   * The command id.
+   */
   id: string | null;
+  /**
+   * The command name.
+   */
   name: string;
+  /**
+   * The display title.
+   */
   title?: string;
+  /**
+   * The command description.
+   */
   description?: string;
+  /**
+   * Alternative command names.
+   */
   alias?: string[];
+  /**
+   * The command icon.
+   */
+  icon?: string;
+  /**
+   * The command path.
+   */
   path: CommandPath;
+  /**
+   * Whether the command is virtual.
+   */
   isVirtual: boolean;
 }
 interface CommandInput extends CommandBase {
+  /**
+   * The command id.
+   */
   id: string;
+  /**
+   * The resolved entry definition.
+   */
   entry: ResolvedEntryTypeDefinition;
 }
+/**
+ * Represents a dynamic command segment with metadata and matching behavior.
+ */
 type CommandDynamicSegment = {
+  /**
+   * The parameter reflection.
+   */
+  reflection?: ReflectionParameter;
+  /**
+   * The segment value.
+   */
+  segment: string;
+  /**
+   * The segment name.
+   */
   name: string;
+  /**
+   * The segment title.
+   */
   title: string;
+  /**
+   * The segment description.
+   */
   description: string;
+  /**
+   * Whether the segment is optional.
+   */
   optional: boolean;
 } & ({
+  /**
+   * The default value.
+   */
   default?: string;
+  /**
+   * Whether the segment is a catch-all.
+   */
   catchAll: false;
+  /**
+   * Whether the segment is variadic.
+   */
   variadic: false;
 } | {
+  /**
+   * The default value.
+   */
   default?: string;
+  /**
+   * Whether the segment is a catch-all.
+   */
   catchAll: true;
+  /**
+   * Whether the segment is variadic.
+   */
   variadic: false;
 } | {
+  /**
+   * The default values.
+   */
   default?: string[];
+  /**
+   * Whether the segment is a catch-all.
+   */
   catchAll: true;
+  /**
+   * Whether the segment is variadic.
+   */
   variadic: true;
 });
 interface CommandTreePath extends CommandPath {
+  /**
+   * Dynamic segment definitions.
+   */
   dynamics: Record<string, CommandDynamicSegment>;
 }
 type CommandTree = CommandInput & {
+  /**
+   * The display title.
+   */
   title: string;
+  /**
+   * The command description.
+   */
   description: string;
+  /**
+   * Alternative command names.
+   */
   alias: string[];
+  /**
+   * The command path with dynamics.
+   */
   path: CommandTreePath;
+  /**
+   * The command options.
+   */
   options: Record<string, CommandOption>;
+  /**
+   * The positional parameter options provided to the command.
+   */
+  params: CommandParameter[];
+  /**
+   * The parent command.
+   */
   parent: null | CommandTree;
+  /**
+   * Child commands.
+   */
   children: Record<string, CommandTree>;
+  /**
+   * The command handler reflection.
+   */
+  reflection: ReflectionFunction | null;
+};
+type SerializedCommandOption = Omit<CommandOption, "reflection">;
+type SerializedCommandDynamicSegment = Omit<CommandDynamicSegment, "reflection">;
+type SerializedCommandTreePath = Omit<CommandTreePath, "dynamics"> & {
+  dynamics: Record<string, SerializedCommandDynamicSegment>;
 };
-type SerializedCommandTree = Omit<CommandTree, "parent" | "children"> & {
+type SerializedCommandParameter = Omit<CommandParameter, "reflection">;
+type SerializedCommandTree = Omit<CommandTree, "options" | "path" | "params" | "parent" | "children" | "reflection"> & {
+  /**
+   * The command options.
+   */
+  options: Record<string, SerializedCommandOption>;
+  /**
+   * The command path with dynamics.
+   */
+  path: SerializedCommandTreePath;
+  /**
+   * The positional parameter options provided to the command.
+   */
+  params: SerializedCommandParameter[];
+  /**
+   * The parent command id.
+   */
   parent: null | string;
+  /**
+   * Serialized child commands.
+   */
   children: Record<string, SerializedCommandTree>;
+  /**
+   * The command handler reflection.
+   */
+  reflection?: SerializedTypes;
 };
 interface Metadata {
+  /**
+   * 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[];
+  /**
+   * 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;
 }
 interface CommandModule {
   metadata?: Metadata;
   default?: AnyFunction;
 }
 //#endregion
-export { BaseCommandOption, BooleanCommandOption, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandPath, CommandTree, CommandTreePath, Metadata, NumberCommandOption, SerializedCommandTree, StringCommandOption };
+export { BaseCommandArgument, BooleanCommandArgument, BooleanCommandOption, BooleanCommandParameter, CommandBase, CommandDynamicSegment, CommandInput, CommandModule, CommandOption, CommandParameter, CommandPath, CommandTree, CommandTreePath, Metadata, NumberCommandArgument, NumberCommandOption, NumberCommandParameter, SerializedCommandDynamicSegment, SerializedCommandOption, SerializedCommandParameter, SerializedCommandTree, SerializedCommandTreePath, StringCommandArgument, StringCommandOption, StringCommandParameter };
 //# sourceMappingURL=command.d.cts.map

package/dist/types/command.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"command.d.cts","names":[],"sources":["../../src/types/command.ts"],"sourcesContent":[],"mappings":";;;;;UAsBiB,iBAAA;;EAAA,IAAA,EAET,cAF0B;EAUjB,KAAA,EAAA,MAAA;EAMA,WAAA,EAAA,MAAA;EAMA,KAAA,EAAA,MAAA,EAAA;EAOL,GAAA,EAAA,MAAA,GAAA,KAAa;EACrB,QAAA,EAAA,OAAA;;AAEA,UAtBa,mBAAA,SAA4B,iBAsBzC,CAAA;EAAoB,IAAA,EArBhB,cAAA,CAAe,MAqBC;EAEP,OAAA,CAAA,EAAA,MAAW;EAKX,QAAA,EAAA,OAAW;AAU5B;AAKY,UAtCK,mBAAA,SAA4B,iBAsCZ,CAAA;EAuBhB,IAAA,EA5DT,cAAA,CAAe,MA4DU;EACN,OAAA,CAAA,EAAA,MAAA;EAAf,QAAA,EAAA,OAAA;;AADwC,UAvDnC,oBAAA,SAA6B,iBAuDM,CAAA;EAIxC,IAAA,EA1DJ,cAAA,CAAe,OA0DA;EAAG,OAAA,CAAA,EAAA,OAAA;EAIlB,YAAA,CAAA,EAAA,MAAA;EACkB,kBAAA,CAAA,EAAA,OAAA;;AACT,KA1DL,aAAA,GACR,mBAyDa,GAxDb,mBAwDa,GAvDb,oBAuDa;AACU,UAtDV,WAAA,CAsDU;EAAf,KAAA,EAAA,MAAA,GAAA,IAAA;EAAM,QAAA,EAAA,MAAA,EAAA;AAGlB;AAAyC,UApDxB,WAAA,CAoDwB;EAAL,EAAA,EAAA,MAAA,GAAA,IAAA;EAET,IAAA,EAAA,MAAA;EAAf,KAAA,CAAA,EAAA,MAAA;EAAM,WAAA,CAAA,EAAA,MAAA;EAGD,KAAA,CAAA,EAAA,MAAQ,EAAA;EAMR,IAAA,EAzDT,WAyDsB;;;UArDb,YAAA,SAAqB;;SAE7B;;KAGG,qBAAA;;;;;;;;;;;;;;;;;;UAuBK,eAAA,SAAwB;YAC7B,eAAe;;KAGf,WAAA,GAAc;;;;QAIlB;WACG,eAAe;iBACT;YACL,eAAe;;KAGf,qBAAA,GAAwB,KAAK;;YAE7B,eAAe;;UAGV,QAAA;;;;;UAMA,aAAA;aACJ;YACD"}
+{"version":3,"file":"command.d.cts","names":[],"sources":["../../src/types/command.ts"],"sourcesContent":[],"mappings":";;;;;UA4BiB,mBAAA;;AAAjB;AA+BA;EAeiB,IAAA,EAAA,MAAA;EAeA;AAmBjB;AAOA;EAOiB,IAAA,EAtFT,cAsFS;EAeL;;;EAGR,KAAA,EAAA,MAAA;EAAoB;AAExB;AAOA;EAOiB,WAAA,EAAA,MAAA;EAOL;;;EAGR,KAAA,EAAA,MAAA,EAAA;EAAuB;AAE3B;AAWA;EAmCiB,GAAA,EAAA,MAAA,GAAA,KAAa;EAclB;AAsEZ;;EAIY,QAAA,EAAA,OAAA;;AAJwC,UA/OnC,qBAAA,SAA8B,mBA+OK,CAAA;EAOxC;;;EAoBc,IAAA,EAtQlB,cAAA,CAAe,MAsQG;EAAf;;;EAYgB,OAAA,CAAA,EAAA,MAAA;EAAf;;;EAOA,QAAA,EAAA,OAAA;AAEZ;AAKY,UArRK,qBAAA,SAA8B,mBAqRV,CAAA;EAAQ;;;EACjC,IAAA,EAlRJ,cAAA,CAAe,MAkRX;EAAM;AAGlB;AAEA;EACE,OAAA,CAAA,EAAA,MAAA;EADkC;;;EAW5B,QAAA,EAAA,OAAA;;AAYmB,UAnSV,sBAAA,SAA+B,mBAmSrB,CAAA;EAAf;;;EAOK,IAAA,EAtST,cAAA,CAAe,OAsSE;EA+BR;;;;;;;;;;;;;UAtTA,mBAAA,SAA4B;;;;eAI9B;;UAGE,mBAAA,SAA4B;;;;eAI9B;;UAGE,oBAAA,SAA6B;;;;eAI/B;;;;;;;;;;KAWH,aAAA,GACR,sBACA,sBACA;UAEa,sBAAA,SAA+B;;;;cAIlC;;UAGG,sBAAA,SAA+B;;;;cAIlC;;UAGG,uBAAA,SAAgC;;;;cAInC;;KAGF,gBAAA,GACR,yBACA,yBACA;UAEa,WAAA;;;;;;;;;;UAWA,WAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;QA4BT;;;;;;UAOS,YAAA,SAAqB;;;;;;;;SAQ7B;;;;;KAMG,qBAAA;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAkEE,eAAA,SAAwB;;;;YAI7B,eAAe;;KAGf,WAAA,GAAc;;;;;;;;;;;;;;;;QAgBlB;;;;WAIG,eAAe;;;;UAIhB;;;;iBAIO;;;;YAIL,eAAe;;;;cAIb;;KAGF,uBAAA,GAA0B,KAAK;KAE/B,+BAAA,GAAkC,KAC5C;KAIU,yBAAA,GAA4B,KAAK;YACjC,eAAe;;KAGf,0BAAA,GAA6B,KAAK;KAElC,qBAAA,GAAwB,KAClC;;;;WAMS,eAAe;;;;QAIlB;;;;UAIE;;;;;;;;YAQE,eAAe;;;;eAIZ;;UAGE,QAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;UA+BA,aAAA;aACJ;YACD"}