@shell-shock/plugin-theme 0.4.34 → 0.4.36

package/dist/theme-B_q1llDJ.d.mts

@@ -0,0 +1,417 @@
+import { a as THEME_MESSAGE_VARIANTS, i as THEME_COLOR_VARIANTS } from "./constants-Bs8URqjD.mjs";
+import { t as SpinnerPreset } from "./spinners-BB6Z_PUM.mjs";
+//#region src/types/theme.d.ts
+type ThemeMessageVariant = (typeof THEME_MESSAGE_VARIANTS)[number];
+type ThemeColorVariant = (typeof THEME_COLOR_VARIANTS)[number];
+interface ThemeColorSubItem {
+  primary: string;
+  secondary: string;
+  tertiary: string;
+}
+interface ThemeColorBodySubItem extends ThemeColorSubItem {
+  link: string;
+}
+interface ThemeColorBannerSubItem {
+  title: string;
+  header: string;
+  footer: string;
+  command: string;
+  description: string;
+}
+interface ThemeColorMessageState {
+  help: string;
+  success: string;
+  info: string;
+  debug: string;
+  warning: string;
+  danger: string;
+  error: string;
+}
+interface ThemeColorPromptLabelState {
+  active: string;
+  warning: string;
+  error: string;
+  submitted: string;
+  cancelled: string;
+  disabled: string;
+}
+interface ThemeColorSpinnerState {
+  active: string;
+  error: string;
+  success: string;
+  help: string;
+  info: string;
+  warning: string;
+}
+interface ThemeColorDescriptionPromptState extends ThemeColorPromptLabelState {
+  inactive: string;
+}
+interface ThemeColorInputPromptState extends ThemeColorDescriptionPromptState {
+  placeholder: string;
+}
+interface ThemeColorBannerSubItemUserConfig {
+  title: Partial<ThemeColorSubItem> | string;
+  link: Partial<ThemeColorSubItem> | string;
+  header: Partial<ThemeColorSubItem> | string;
+  footer: Partial<ThemeColorSubItem> | string;
+  command: Partial<ThemeColorSubItem> | string;
+  description: Partial<ThemeColorSubItem> | string;
+}
+interface ThemeColorBannerSubItemResolvedConfig {
+  title: ThemeColorSubItem;
+  link: ThemeColorSubItem;
+  header: ThemeColorSubItem;
+  footer: ThemeColorSubItem;
+  command: ThemeColorSubItem;
+  description: ThemeColorSubItem;
+}
+interface ThemeColorMessageSubItemUserConfig {
+  link: Partial<ThemeColorMessageState> | string;
+  header: Partial<ThemeColorMessageState> | string;
+  footer: Partial<ThemeColorMessageState> | string;
+  description: Partial<ThemeColorMessageState> | string;
+}
+interface ThemeColorMessageSubItemResolvedConfig {
+  link: ThemeColorMessageState;
+  header: ThemeColorMessageState;
+  footer: ThemeColorMessageState;
+  description: ThemeColorMessageState;
+}
+interface ThemeColorUsageSubItem {
+  bin: string;
+  command: string;
+  dynamic: string;
+  options: string;
+  args: string;
+  description: string;
+}
+interface ThemeColorPromptSubItemUserConfig {
+  icon: Partial<ThemeColorPromptLabelState> | string;
+  message: Partial<ThemeColorPromptLabelState> | string;
+  input: Partial<ThemeColorInputPromptState> | string;
+  description: Partial<ThemeColorDescriptionPromptState> | string;
+}
+interface ThemeColorPromptSubItemResolvedConfig {
+  icon: ThemeColorPromptLabelState;
+  message: ThemeColorPromptLabelState;
+  input: ThemeColorInputPromptState;
+  description: ThemeColorDescriptionPromptState;
+}
+interface ThemeColorSpinnerSubItemUserConfig {
+  icon: Partial<ThemeColorSpinnerState> | string;
+  message: Partial<ThemeColorSpinnerState> | string;
+}
+interface ThemeColorSpinnerSubItemResolvedConfig {
+  icon: ThemeColorSpinnerState;
+  message: ThemeColorSpinnerState;
+}
+interface ThemeColorTagSubItemUserConfig {
+  $default: string | undefined;
+  [tag: string]: string | undefined;
+}
+interface ThemeColorTagSubItemResolvedConfig {
+  $default: string;
+  [tag: string]: string;
+}
+interface ThemeColorTextItemsUserConfig {
+  banner: Partial<ThemeColorBannerSubItemUserConfig> | string;
+  heading: Partial<ThemeColorSubItem> | string;
+  body: Partial<ThemeColorBodySubItem> | string;
+  message: Partial<ThemeColorMessageSubItemUserConfig> | string;
+  usage: Partial<ThemeColorUsageSubItem> | string;
+  prompt: Partial<ThemeColorPromptSubItemUserConfig> | string;
+  spinner: Partial<ThemeColorSpinnerSubItemUserConfig> | string;
+  tags: Partial<ThemeColorTagSubItemUserConfig> | string;
+}
+interface ThemeColorTextItemsResolvedConfig {
+  banner: ThemeColorBannerSubItemResolvedConfig;
+  heading: ThemeColorSubItem;
+  body: ThemeColorBodySubItem;
+  message: ThemeColorMessageSubItemResolvedConfig;
+  usage: ThemeColorUsageSubItem;
+  prompt: ThemeColorPromptSubItemResolvedConfig;
+  spinner: ThemeColorSpinnerSubItemResolvedConfig;
+  tags: ThemeColorTagSubItemResolvedConfig;
+}
+interface ThemeColorBorderSubItemUserConfig<TState extends object> {
+  outline: Partial<TState> | string;
+  divider: Partial<TState> | string;
+}
+interface ThemeColorBorderAppSubItemUserConfig<TState extends object> {
+  table: Partial<TState> | string;
+  divider: Partial<TState> | string;
+  blockquote: Partial<TState> | string;
+}
+interface ThemeColorBorderSubItemResolvedConfig<TState extends object> {
+  outline: TState;
+  divider: TState;
+}
+interface ThemeColorBorderAppSubItemResolvedConfig<TState extends object> {
+  table: TState;
+  divider: TState;
+  blockquote: TState;
+}
+interface ThemeColorBorderItemsUserConfig {
+  app: Partial<ThemeColorBorderAppSubItemUserConfig<ThemeColorSubItem>> | Partial<ThemeColorSubItem> | string;
+  banner: Partial<ThemeColorBorderSubItemUserConfig<ThemeColorSubItem>> | Partial<ThemeColorSubItem> | string;
+  message: Partial<ThemeColorBorderSubItemUserConfig<ThemeColorMessageState>> | Partial<ThemeColorMessageState> | string;
+}
+interface ThemeColorBorderItemsResolvedConfig {
+  app: ThemeColorBorderAppSubItemResolvedConfig<ThemeColorSubItem>;
+  banner: ThemeColorBorderSubItemResolvedConfig<ThemeColorSubItem>;
+  message: ThemeColorBorderSubItemResolvedConfig<ThemeColorMessageState>;
+}
+interface ThemeColorTypesUserConfig {
+  text: Partial<ThemeColorTextItemsUserConfig> | string;
+  border: Partial<ThemeColorBorderItemsUserConfig> | string;
+}
+interface ThemeColorsResolvedConfig {
+  text: ThemeColorTextItemsResolvedConfig;
+  border: ThemeColorBorderItemsResolvedConfig;
+}
+interface ThemeStyleBorderTypeConfig {
+  topLeft: string;
+  topRight: string;
+  bottomLeft: string;
+  bottomRight: string;
+  top: string;
+  bottom: string;
+  left: string;
+  right: string;
+  meta?: Record<string, any>;
+}
+type ThemeStyleBorderBaseIdentifiers = "single" | "double" | "bold" | "round" | "thick" | "extra-thick" | "single-double" | "double-single" | "classic" | "diagonal" | "diagonal-thick" | "pointer" | "arrow" | "outward-arrow" | "inward-arrow" | "double-arrow" | "outward-double-arrow" | "inward-double-arrow";
+/**
+ * The identifiers of border styles to use in the theme.
+ *
+ * @remarks
+ * The available border styles are:
+ * - `"single"`: Single line border (default)
+ * - `"double"`: Double line border
+ * - `"bold"`: Bold line border
+ * - `"round"`: Rounded corner border
+ * - `"thick"`: Thick line border
+ * - `"extra-thick"`: Extra thick line border
+ * - `"diagonal"`: Diagonal line border
+ * - `"diagonal-thick"`: Thick diagonal line border
+ * - `"single-double"`: Single line on top and bottom, double line on sides
+ * - `"double-single"`: Double line on top and bottom, single line on sides
+ * - `"classic"`: Classic ASCII style border
+ * - `"pointer"`: Pointer style border
+ * - `"arrow"`: Arrow style border
+ * - `"outward-arrow"`: Outward arrow style border
+ * - `"inward-arrow"`: Inward arrow style border (alias for `"arrow"`)
+ * - `"double-arrow"`: Double arrow style border
+ * - `"outward-double-arrow"`: Outward double arrow style border
+ * - `"inward-double-arrow"`: Inward double arrow style border (alias for `"double-arrow"`)
+ * - `"single-corners"`: Single line border with single line corners
+ * - `"double-corners"`: Double line border with double line corners
+ * - `"bold-corners"`: Bold line border with bold line corners
+ * - `"round-corners"`: Rounded corner border with rounded corners
+ * - `"thick-corners"`: Thick line border with thick corners
+ * - `"extra-thick-corners"`: Extra thick line border with extra thick corners
+ * - `"diagonal-corners"`: Diagonal line border with diagonal corners
+ * - `"diagonal-thick-corners"`: Thick diagonal line border with diagonal corners
+ * - `"single-double-corners"`: Single line on top and bottom, double line on sides, with corners
+ * - `"double-single-corners"`: Double line on top and bottom, single line on sides, with corners
+ * - `"classic-corners"`: Classic ASCII style border with corners
+ * - `"pointer-corners"`: Pointer style border with corners
+ * - `"arrow-corners"`: Arrow style border with corners
+ * - `"outward-arrow-corners"`: Outward arrow style border with corners
+ * - `"inward-arrow-corners"`: Inward arrow style border with corners (alias for `"arrow-corners"`)
+ * - `"double-arrow-corners"`: Double arrow style border with corners
+ * - `"outward-double-arrow-corners"`: Outward double arrow style border with corners
+ * - `"inward-double-arrow-corners"`: Inward double arrow style border with corners (alias for `"double-arrow-corners"`)
+ * - `"none"`: No border
+ *
+ * @see {@link https://www.npmjs.com/package/boxen | Boxen documentation}
+ */
+type ThemeStyleBorderIdentifiers = ThemeStyleBorderBaseIdentifiers | `${ThemeStyleBorderBaseIdentifiers}-corners` | "none";
+type ThemeStyleBorderType = ThemeStyleBorderIdentifiers | ThemeStyleBorderTypeConfig;
+interface ThemeBorderStyleMessageStateUserConfig {
+  help: ThemeStyleBorderType;
+  success: ThemeStyleBorderType;
+  info: ThemeStyleBorderType;
+  debug: ThemeStyleBorderType;
+  warning: ThemeStyleBorderType;
+  danger: ThemeStyleBorderType;
+  error: ThemeStyleBorderType;
+}
+interface ThemeBorderStyleMessageStateResolvedConfig {
+  help: ThemeStyleBorderTypeConfig;
+  success: ThemeStyleBorderTypeConfig;
+  info: ThemeStyleBorderTypeConfig;
+  debug: ThemeStyleBorderTypeConfig;
+  warning: ThemeStyleBorderTypeConfig;
+  danger: ThemeStyleBorderTypeConfig;
+  error: ThemeStyleBorderTypeConfig;
+}
+interface ThemeBorderStyleSubItemUserConfig<TState extends object> {
+  outline: Partial<TState> | ThemeStyleBorderType;
+  divider: Partial<TState> | ThemeStyleBorderType;
+}
+interface ThemeBorderStyleAppSubItemUserConfig<TState extends object> {
+  table: Partial<TState> | ThemeStyleBorderType;
+  divider: Partial<TState> | ThemeStyleBorderType;
+  blockquote: Partial<TState> | ThemeStyleBorderType;
+}
+interface ThemeBorderStyleSubItemResolvedConfig<TState extends object> {
+  outline: TState;
+  divider: TState;
+}
+interface ThemeBorderStyleAppSubItemResolvedConfig<TState extends object> {
+  table: TState;
+  divider: TState;
+  blockquote: TState;
+}
+interface ThemeBorderStyleSectionTypesUserConfig {
+  primary: ThemeStyleBorderType;
+  secondary: ThemeStyleBorderType;
+  tertiary: ThemeStyleBorderType;
+}
+interface ThemeBorderStyleSectionTypesResolvedConfig {
+  primary: ThemeStyleBorderTypeConfig;
+  secondary: ThemeStyleBorderTypeConfig;
+  tertiary: ThemeStyleBorderTypeConfig;
+}
+interface ThemeBorderStylesUserConfig {
+  app: ThemeBorderStyleAppSubItemUserConfig<ThemeBorderStyleSectionTypesUserConfig> | ThemeStyleBorderType;
+  banner: ThemeBorderStyleSubItemUserConfig<ThemeBorderStyleSectionTypesUserConfig> | ThemeStyleBorderType;
+  message: ThemeBorderStyleSubItemUserConfig<ThemeBorderStyleMessageStateUserConfig> | ThemeStyleBorderType;
+}
+interface ThemeBorderStylesResolvedConfig {
+  banner: ThemeBorderStyleSubItemResolvedConfig<ThemeBorderStyleSectionTypesResolvedConfig>;
+  message: ThemeBorderStyleSubItemResolvedConfig<ThemeBorderStyleMessageStateResolvedConfig>;
+  app: ThemeBorderStyleAppSubItemResolvedConfig<ThemeBorderStyleSectionTypesResolvedConfig>;
+}
+interface ThemePaddingUserConfig {
+  app: number;
+  banner: number;
+  message: number;
+  table: number;
+}
+interface ThemePaddingResolvedConfig {
+  app: number;
+  banner: number;
+  message: number;
+  table: number;
+}
+interface ThemeIconMessageStateConfig {
+  help: string;
+  success: string;
+  info: string;
+  debug: string;
+  warning: string;
+  danger: string;
+  error: string;
+}
+interface ThemeIconSubItemConfig {
+  primary: string;
+  secondary: string;
+  tertiary: string;
+}
+interface ThemeIconLinkStateConfig {
+  external: string;
+}
+interface ThemeIconPromptStateConfig {
+  active: string;
+  warning: string;
+  error: string;
+  submitted: string;
+  cancelled: string;
+  disabled: string;
+}
+interface ThemeIconSpinnerStateConfig {
+  help: string;
+  success: string;
+  info: string;
+  warning: string;
+  error: string;
+}
+interface ThemeIconTypeUserConfig<TState extends object> {
+  header: Partial<TState> | string;
+}
+interface ThemeIconTypeResolvedConfig<TState extends object> {
+  header: TState;
+}
+interface ThemeIconsUserConfig {
+  link: Partial<ThemeIconLinkStateConfig> | string;
+  message: ThemeIconTypeUserConfig<ThemeIconMessageStateConfig> | string;
+  banner: ThemeIconTypeUserConfig<ThemeIconSubItemConfig> | string;
+  prompt: Partial<ThemeIconPromptStateConfig> | string;
+  spinner: Partial<ThemeIconSpinnerStateConfig> | string;
+}
+interface ThemeIconsResolvedConfig {
+  link: ThemeIconLinkStateConfig;
+  message: ThemeIconTypeResolvedConfig<ThemeIconMessageStateConfig>;
+  banner: ThemeIconTypeResolvedConfig<ThemeIconSubItemConfig>;
+  prompt: ThemeIconPromptStateConfig;
+  spinner: ThemeIconSpinnerStateConfig;
+}
+interface ThemeLabelMessageStateConfig {
+  help: string;
+  success: string;
+  info: string;
+  debug: string;
+  warning: string;
+  danger: string;
+  error: string;
+}
+interface ThemeLabelBannerSubItemConfig {
+  primary: string;
+  secondary: string;
+  tertiary: string;
+}
+interface ThemeLabelTypeUserConfig<TState extends object> {
+  header: Partial<TState> | string;
+  footer?: Partial<TState> | string;
+}
+interface ThemeLabelTypeResolvedConfig<TState extends object> {
+  header: TState;
+  footer: Partial<TState>;
+}
+interface ThemeLabelsUserConfig {
+  message: ThemeLabelTypeUserConfig<ThemeLabelMessageStateConfig> | string;
+  banner: ThemeLabelTypeUserConfig<ThemeLabelBannerSubItemConfig> | string;
+}
+interface ThemeLabelsResolvedConfig {
+  message: ThemeLabelTypeResolvedConfig<ThemeLabelMessageStateConfig>;
+  banner: ThemeLabelTypeResolvedConfig<ThemeLabelBannerSubItemConfig>;
+}
+interface ThemeSpinnerUserConfig {
+  /**
+   * The interval in milliseconds between each frame of the spinner animation.
+   *
+   * @defaultValue 80
+   */
+  interval?: number;
+  /**
+   * An array of strings representing the frames of the spinner animation. Each string is a frame that will be displayed in sequence to create the animation effect.
+   */
+  frames: string[];
+}
+type ThemeSpinnerResolvedConfig = Required<ThemeSpinnerUserConfig>;
+interface ThemeUserConfig {
+  $theme?: string;
+  colors?: Partial<ThemeColorTypesUserConfig> | string;
+  borderStyles?: Partial<ThemeBorderStylesUserConfig> | ThemeStyleBorderType;
+  padding?: Partial<ThemePaddingUserConfig> | number;
+  icons?: Partial<ThemeIconsUserConfig> | string;
+  labels?: Partial<ThemeLabelsUserConfig> | string;
+  spinner?: ThemeSpinnerUserConfig | SpinnerPreset;
+  settings?: Record<string, unknown>;
+}
+interface ThemeResolvedConfig {
+  name: string;
+  colors: ThemeColorsResolvedConfig;
+  borderStyles: ThemeBorderStylesResolvedConfig;
+  padding: ThemePaddingResolvedConfig;
+  icons: ThemeIconsResolvedConfig;
+  labels: ThemeLabelsResolvedConfig;
+  spinner: ThemeSpinnerResolvedConfig;
+  settings: Record<string, unknown>;
+  [key: string]: unknown;
+}
+//#endregion
+export { ThemeLabelTypeUserConfig as $, ThemeColorSpinnerSubItemResolvedConfig as A, ThemeColorsResolvedConfig as B, ThemeColorMessageState as C, ThemeColorPromptSubItemResolvedConfig as D, ThemeColorPromptLabelState as E, ThemeColorTextItemsResolvedConfig as F, ThemeIconSubItemConfig as G, ThemeIconMessageStateConfig as H, ThemeColorTextItemsUserConfig as I, ThemeIconsResolvedConfig as J, ThemeIconTypeResolvedConfig as K, ThemeColorTypesUserConfig as L, ThemeColorSubItem as M, ThemeColorTagSubItemResolvedConfig as N, ThemeColorPromptSubItemUserConfig as O, ThemeColorTagSubItemUserConfig as P, ThemeLabelTypeResolvedConfig as Q, ThemeColorUsageSubItem as R, ThemeColorInputPromptState as S, ThemeColorMessageSubItemUserConfig as T, ThemeIconPromptStateConfig as U, ThemeIconLinkStateConfig as V, ThemeIconSpinnerStateConfig as W, ThemeLabelBannerSubItemConfig as X, ThemeIconsUserConfig as Y, ThemeLabelMessageStateConfig as Z, ThemeColorBorderItemsResolvedConfig as _, ThemeBorderStyleSectionTypesResolvedConfig as a, ThemeResolvedConfig as at, ThemeColorBorderSubItemUserConfig as b, ThemeBorderStyleSubItemUserConfig as c, ThemeStyleBorderBaseIdentifiers as ct, ThemeColorBannerSubItem as d, ThemeStyleBorderTypeConfig as dt, ThemeLabelsResolvedConfig as et, ThemeColorBannerSubItemResolvedConfig as f, ThemeUserConfig as ft, ThemeColorBorderAppSubItemUserConfig as g, ThemeColorBorderAppSubItemResolvedConfig as h, ThemeBorderStyleMessageStateUserConfig as i, ThemePaddingUserConfig as it, ThemeColorSpinnerSubItemUserConfig as j, ThemeColorSpinnerState as k, ThemeBorderStylesResolvedConfig as l, ThemeStyleBorderIdentifiers as lt, ThemeColorBodySubItem as m, ThemeBorderStyleAppSubItemUserConfig as n, ThemeMessageVariant as nt, ThemeBorderStyleSectionTypesUserConfig as o, ThemeSpinnerResolvedConfig as ot, ThemeColorBannerSubItemUserConfig as p, ThemeIconTypeUserConfig as q, ThemeBorderStyleMessageStateResolvedConfig as r, ThemePaddingResolvedConfig as rt, ThemeBorderStyleSubItemResolvedConfig as s, ThemeSpinnerUserConfig as st, ThemeBorderStyleAppSubItemResolvedConfig as t, ThemeLabelsUserConfig as tt, ThemeBorderStylesUserConfig as u, ThemeStyleBorderType as ut, ThemeColorBorderItemsUserConfig as v, ThemeColorMessageSubItemResolvedConfig as w, ThemeColorDescriptionPromptState as x, ThemeColorBorderSubItemResolvedConfig as y, ThemeColorVariant as z };
+//# sourceMappingURL=theme-B_q1llDJ.d.mts.map

package/dist/theme-B_q1llDJ.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme-B_q1llDJ.d.mts","names":[],"sources":["../src/types/theme.ts"],"mappings":""}