@shell-shock/core 0.17.21 → 0.17.23

package/dist/command-CtfR7hKM.d.cts

@@ -0,0 +1,308 @@
+import { JsonSchemaStringFormat, SchemaConfig } from "@power-plant/schema";
+import { AnyFunction, RequiredKeys } from "@stryke/types/base";
+import { ResolvedEntryFileReference } from "powerlines";
+//#region src/types/command.d.ts
+type CommandParameterType = "string" | "number" | "boolean";
+interface BaseCommandParameter {
+  /**
+   * The option name.
+   */
+  name: string;
+  /**
+   * The option kind.
+   */
+  type: CommandParameterType;
+  /**
+   * The display title.
+   */
+  title: string;
+  /**
+   * The option description.
+   */
+  description: string;
+  /**
+   * Alternative option names.
+   */
+  alias: string[];
+  /**
+   * The default value.
+   */
+  default?: string | number | boolean | string[] | number[] | boolean[];
+  /**
+   * The environment variable name or false to disable.
+   */
+  env: string | false;
+  /**
+   * Whether the option is required.
+   */
+  required: boolean;
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: boolean;
+}
+interface BaseSingleCommandParameter {
+  /**
+   * The default value.
+   */
+  default?: string | number | boolean;
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: false;
+}
+interface BaseVariadicCommandParameter {
+  /**
+   * The default value.
+   */
+  default?: string[] | number[] | boolean[];
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: true;
+}
+interface BaseStringCommandParameter extends BaseCommandParameter {
+  /**
+   * The option kind.
+   */
+  type: "string";
+  /**
+   * The default value.
+   */
+  default?: string | string[];
+  /**
+   * A standard string format to validate the option value against.
+   */
+  format?: JsonSchemaStringFormat | string;
+  /**
+   * The allowed choices for the option value.
+   */
+  choices?: string[];
+}
+interface SingleStringCommandParameter extends BaseStringCommandParameter {
+  /**
+   * The default value.
+   */
+  default?: string;
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: false;
+}
+interface VariadicStringCommandParameter extends BaseStringCommandParameter {
+  /**
+   * The default value.
+   */
+  default?: string[];
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: true;
+}
+type StringCommandParameter = SingleStringCommandParameter | VariadicStringCommandParameter;
+interface BaseNumberCommandParameter extends BaseCommandParameter {
+  /**
+   * The option kind.
+   */
+  type: "number";
+  /**
+   * The default value.
+   */
+  default?: number | number[];
+  /**
+   * The allowed choices for the option value.
+   */
+  choices?: number[];
+}
+interface SingleNumberCommandParameter extends BaseNumberCommandParameter {
+  /**
+   * The default value.
+   */
+  default?: number;
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: false;
+}
+interface VariadicNumberCommandParameter extends BaseNumberCommandParameter {
+  /**
+   * The default value.
+   */
+  default?: number[];
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: true;
+}
+type NumberCommandParameter = SingleNumberCommandParameter | VariadicNumberCommandParameter;
+interface BaseBooleanCommandParameter extends BaseCommandParameter {
+  /**
+   * The option kind.
+   */
+  type: "boolean";
+  /**
+   * The default value.
+   */
+  default?: boolean | boolean[];
+}
+interface SingleBooleanCommandParameter extends BaseBooleanCommandParameter {
+  /**
+   * The default value.
+   */
+  default?: boolean;
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: false;
+}
+interface VariadicBooleanCommandParameter extends BaseBooleanCommandParameter {
+  /**
+   * The default value.
+   */
+  default?: boolean[];
+  /**
+   * Whether the option accepts multiple values.
+   */
+  variadic: true;
+}
+type BooleanCommandParameter = SingleBooleanCommandParameter | VariadicBooleanCommandParameter;
+type CommandParameter = StringCommandParameter | NumberCommandParameter | BooleanCommandParameter;
+type AsCommandParameterConfig<T extends BaseCommandParameter> = Pick<T, "type"> & Partial<Omit<T, "type" | "alias">> & {
+  alias?: string | string[];
+};
+type StringCommandParameterConfig = AsCommandParameterConfig<StringCommandParameter>;
+type NumberCommandParameterConfig = AsCommandParameterConfig<NumberCommandParameter>;
+type BooleanCommandParameterConfig = AsCommandParameterConfig<BooleanCommandParameter>;
+type CommandParameterConfig = StringCommandParameterConfig | NumberCommandParameterConfig | BooleanCommandParameterConfig;
+interface BooleanCommandOption extends SingleBooleanCommandParameter {
+  /**
+   * The option this negates.
+   */
+  isNegativeOf?: string;
+  /**
+   * Whether to skip adding a negative option.
+   */
+  skipAddingNegative?: boolean;
+}
+type CommandOption = StringCommandParameter | NumberCommandParameter | BooleanCommandOption | VariadicBooleanCommandParameter;
+type CommandOptionConfig = AsCommandParameterConfig<CommandOption>;
+type CommandArgument = StringCommandParameter | NumberCommandParameter | BooleanCommandParameter;
+type CommandArgumentConfig = AsCommandParameterConfig<CommandArgument>;
+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.
+   */
+  id: string | null;
+  /**
+   * The command name.
+   */
+  name: string;
+  /**
+   * The full command path value.
+   */
+  path: string | null;
+  /**
+   * The path segments.
+   */
+  segments: string[];
+  /**
+   * Alternative command names.
+   */
+  alias?: 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.
+   */
+  virtual: boolean;
+}
+interface CommandConfig extends CommandBase {
+  /**
+   * The command id.
+   */
+  id: string;
+  /**
+   * The resolved entry definition.
+   */
+  entry: ResolvedEntryFileReference;
+  tags?: CommandMetadata["tags"];
+}
+type CommandTree = RequiredKeys<CommandConfig, "title" | "description" | "alias" | "tags"> & {
+  /**
+   * The command options.
+   */
+  options: Record<string, CommandOption>;
+  /**
+   * The positional arguments provided to the command.
+   */
+  args: CommandArgument[];
+  /**
+   * The parent command.
+   */
+  parent: null | CommandTree;
+  /**
+   * Child commands.
+   */
+  children: Record<string, CommandTree>;
+};
+type SerializedCommandTree = Omit<CommandTree, "parent" | "children"> & {
+  /**
+   * The parent command id.
+   */
+  parent: null | string;
+  /**
+   * Serialized child commands.
+   */
+  children: Record<string, SerializedCommandTree>;
+};
+interface CommandModule {
+  metadata?: CommandMetadata;
+  options?: Record<string, CommandOptionConfig> | SchemaConfig;
+  args?: (CommandArgumentConfig | SchemaConfig)[];
+  default?: AnyFunction;
+}
+//#endregion
+export { StringCommandParameterConfig as A, NumberCommandParameter as C, SingleNumberCommandParameter as D, SingleBooleanCommandParameter as E, VariadicNumberCommandParameter as M, VariadicStringCommandParameter as N, SingleStringCommandParameter as O, CommandTree as S, SerializedCommandTree as T, CommandOption as _, BaseSingleCommandParameter as a, CommandParameterConfig as b, BooleanCommandOption as c, CommandArgument as d, CommandArgumentConfig as f, CommandModule as g, CommandMetadata as h, BaseNumberCommandParameter as i, VariadicBooleanCommandParameter as j, StringCommandParameter as k, BooleanCommandParameter as l, CommandConfig as m, BaseBooleanCommandParameter as n, BaseStringCommandParameter as o, CommandBase as p, BaseCommandParameter as r, BaseVariadicCommandParameter as s, AsCommandParameterConfig as t, BooleanCommandParameterConfig as u, CommandOptionConfig as v, NumberCommandParameterConfig as w, CommandParameterType as x, CommandParameter as y };
+//# sourceMappingURL=command-CtfR7hKM.d.cts.map

package/dist/command-CtfR7hKM.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command-CtfR7hKM.d.cts","names":[],"sources":["../src/types/command.ts"],"mappings":";;;;KAsBY;UAEK;;;;EAIf;;;;EAKA,MAAM;;;;EAKN;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;UAGe;;;;EAIf;;;;EAKA;;UAGe;;;;EAIf;;;;EAKA;;UAGe,mCAAmC;;;;EAIlD;;;;EAKA;;;;EAKA,SAAS;;;;EAKT;;UAGe,qCAAqC;;;;EAIpD;;;;EAKA;;UAGe,uCAAuC;;;;EAItD;;;;EAKA;;KAGU,yBACV,+BAA+B;UAEhB,mCAAmC;;;;EAIlD;;;;EAKA;;;;EAKA;;UAGe,qCAAqC;;;;EAIpD;;;;EAKA;;UAGe,uCAAuC;;;;EAItD;;;;EAKA;;KAGU,yBACV,+BAA+B;UAEhB,oCAAoC;;;;EAInD;;;;EAKA;;UAGe,sCAAsC;;;;EAIrD;;;;EAKA;;UAGe,wCAAwC;;;;EAIvD;;;;EAKA;;KAGU,0BACV,gCAAgC;KAEtB,mBACV,yBAAyB,yBAAyB;KAExC,yBAAyB,UAAU,wBAAwB,KACrE,aAGA,QAAQ,KAAK;EACX;;KAGQ,+BACV,yBAAyB;KACf,+BACV,yBAAyB;KACf,gCACV,yBAAyB;KAEf,yBACR,+BACA,+BACA;UAEa,6BAA6B;;;;EAI5C;;;;EAKA;;KAGU,gBACR,yBACA,yBACA,uBACA;KACQ,sBAAsB,yBAAyB;KAE/C,kBACV,yBAAyB,yBAAyB;KACxC,wBAAwB,yBAAyB;UAE5C;;;;;;;EAOf;;;;;;;EAQA;;;;EAKA;;;;;;;EAQA;;;;;;;EAQA;;;;;;;EAQA;;UAGe,oBAAoB;;;;EAInC;;;;EAKA;;;;EAKA;;;;EAKA;;;;EAKA;;;;;;;EAQA;;UAGe,sBAAsB;;;;EAIrC;;;;EAKA,OAAO;EAEP,OAAO;;KAGG,cAAc,aACxB;;;;EAMA,SAAS,eAAe;;;;EAKxB,MAAM;;;;EAKN,eAAe;;;;EAKf,UAAU,eAAe;;KAGf,wBAAwB,KAAK;;;;EAIvC;;;;EAKA,UAAU,eAAe;;UAGV;EACf,WAAW;EACX,UAAU,eAAe,uBAAuB;EAChD,QAAQ,wBAAwB;EAChC,UAAU"}