@unbound-app/cli 0.11.0 → 1.1.1

package/dist/settings/schema.d.mts

@@ -0,0 +1,133 @@
+import { TSchema } from "typebox";
+/** A value one schema-declared setting holds. */
+type SettingPrimitive = string | number | boolean;
+/** A value any schema-declared setting holds. */
+type SettingValue = SettingPrimitive | string[];
+type OptionLabel = string | {
+  title: string;
+  subtitle?: string;
+};
+/** A settings.ts predicate: it reads every setting and says whether a row shows or is enabled. */
+type Predicate = (settings: never) => boolean;
+/** Every builder's options; the generated typings narrow them per builder and `displayAs`. */
+export type BuilderOptions = {
+  title?: string;
+  subtitle?: string;
+  hidden?: boolean;
+  requiresRestart?: boolean;
+  visibleWhen?: string | Predicate;
+  disabledWhen?: string | Predicate;
+  displayAs?: string;
+  default?: SettingValue;
+  min?: number;
+  max?: number;
+  step?: number;
+  units?: string[];
+  minLength?: number;
+  maxLength?: number;
+  placeholder?: string;
+  alpha?: boolean;
+  presets?: string[];
+  palette?: boolean;
+  maxSize?: number;
+  options?: Record<string, OptionLabel>;
+  of?: TSchema;
+  minItems?: number;
+  maxItems?: number;
+  action?: string;
+  confirm?: string;
+  tone?: string;
+};
+/** The options of `defineSettings`. */
+export type DefineOptions = {
+  title?: string;
+};
+/**
+ * @description Builds a `boolean` setting.
+ * @param options Its labels, default and display.
+ * @returns Its schema.
+ */
+declare function boolean(options: BuilderOptions): TSchema;
+/**
+ * @description Builds a `number` setting.
+ * @param options Its labels, default, range and display.
+ * @returns Its schema.
+ */
+declare function number(options: BuilderOptions): TSchema;
+/**
+ * @description Builds a whole-number setting.
+ * @param options Its labels, default, range and display.
+ * @returns Its schema.
+ */
+declare function integer(options: BuilderOptions): TSchema;
+/**
+ * @description Builds a `string` setting, or with no options an `array` item.
+ * @param options Its labels, default, display and the display's options.
+ * @returns Its schema.
+ */
+declare function string(options?: BuilderOptions): TSchema;
+/**
+ * @description Builds a setting holding one of its options' keys, or with only `options` an `array` item.
+ * @param options Its labels, default, options and display.
+ * @returns Its schema.
+ */
+declare function choice(options: BuilderOptions): TSchema;
+/**
+ * @description Builds a list setting of `of` items.
+ * @param options Its labels, item, limits and display.
+ * @returns Its schema.
+ */
+declare function array(options: BuilderOptions): TSchema;
+/**
+ * @description Builds a section of settings.
+ * @param options Its labels and display.
+ * @param properties Its settings and buttons.
+ * @returns Its schema.
+ */
+declare function section(options: BuilderOptions, properties: Record<string, TSchema>): TSchema;
+/**
+ * @description Builds a button row that runs an export of src/actions.ts; it stores nothing.
+ * @param options Its labels, action, confirmation and display.
+ * @returns Its schema.
+ */
+declare function button(options: BuilderOptions): TSchema;
+/**
+ * @description Builds a notice row that shows a message in its panel; it stores nothing.
+ * @param options Its labels, tone and `visibleWhen`.
+ * @returns Its schema.
+ */
+declare function notice(options: BuilderOptions): TSchema;
+/** The setting builders, one per stored primitive; `displayAs` picks the widget. */
+export declare const setting: {
+  boolean: typeof boolean;
+  number: typeof number;
+  integer: typeof integer;
+  string: typeof string;
+  choice: typeof choice;
+  array: typeof array;
+  section: typeof section;
+  button: typeof button;
+  notice: typeof notice;
+};
+/**
+ * @description Declares a plugin's settings: the default export of its settings.ts.
+ * @param properties The settings, sections and buttons, built with {@link setting}.
+ * @param options The message key of the title of the section holding the top-level settings.
+ * @returns The TypeBox object schema, marked as a settings schema.
+ */
+export declare function defineSettings(properties: Record<string, TSchema>, options?: DefineOptions): TSchema;
+declare const _default: {
+  defineSettings: typeof defineSettings;
+  setting: {
+    boolean: typeof boolean;
+    number: typeof number;
+    integer: typeof integer;
+    string: typeof string;
+    choice: typeof choice;
+    array: typeof array;
+    section: typeof section;
+    button: typeof button;
+    notice: typeof notice;
+  };
+};
+export { _default as default };

package/dist/settings/schema.mjs

@@ -0,0 +1,169 @@
+import Type$1 from "typebox";
+// src/settings/schema.ts
+function defined(values) {
+	return Object.fromEntries(Object.entries(values).filter(([, value]) => value !== void 0));
+}
+function condition(value) {
+	return typeof value === "function" ? { predicate: true } : value;
+}
+function meta(kind, displayAs, options, extra = {}) {
+	return {
+		kind,
+		displayAs,
+		...defined({
+			title: options.title,
+			subtitle: options.subtitle,
+			hidden: options.hidden,
+			requiresRestart: options.requiresRestart,
+			visibleWhen: condition(options.visibleWhen),
+			disabledWhen: condition(options.disabledWhen),
+			default: options.default,
+			...extra
+		})
+	};
+}
+function numeric(kind, options) {
+	const ranged = options.min !== void 0 && options.max !== void 0;
+	return meta(kind, options.displayAs ?? (ranged ? "slider" : "input"), options, {
+		minimum: options.min,
+		maximum: options.max,
+		multipleOf: options.step,
+		units: options.units
+	});
+}
+function choices({ options = {} }) {
+	return Object.entries(options).map(([value, label]) => typeof label === "string" ? {
+		const: value,
+		title: label
+	} : {
+		const: value,
+		...label
+	});
+}
+/**
+* @description Builds a `boolean` setting.
+* @param options Its labels, default and display.
+* @returns Its schema.
+*/
+function boolean(options) {
+	return Type$1.Boolean(meta("boolean", options.displayAs ?? "switch", options));
+}
+/**
+* @description Builds a `number` setting.
+* @param options Its labels, default, range and display.
+* @returns Its schema.
+*/
+function number(options) {
+	return Type$1.Number(numeric("number", options));
+}
+/**
+* @description Builds a whole-number setting.
+* @param options Its labels, default, range and display.
+* @returns Its schema.
+*/
+function integer(options) {
+	return Type$1.Integer(numeric("integer", options));
+}
+/**
+* @description Builds a `string` setting, or with no options an `array` item.
+* @param options Its labels, default, display and the display's options.
+* @returns Its schema.
+*/
+function string(options = {}) {
+	return Type$1.String(meta("string", options.displayAs ?? "input", {
+		default: "",
+		...options
+	}, {
+		minLength: options.minLength,
+		maxLength: options.maxLength,
+		placeholder: options.placeholder,
+		alpha: options.alpha,
+		presets: options.presets,
+		palette: options.palette,
+		maxSize: options.maxSize
+	}));
+}
+/**
+* @description Builds a setting holding one of its options' keys, or with only `options` an `array` item.
+* @param options Its labels, default, options and display.
+* @returns Its schema.
+*/
+function choice(options) {
+	const list = choices(options);
+	const displayAs = options.displayAs ?? (list.length > 5 ? "picker" : "radio");
+	return Type$1.Union(list.map((option) => Type$1.Literal(option.const)), meta("choice", displayAs, options, { options: list }));
+}
+/**
+* @description Builds a list setting of `of` items.
+* @param options Its labels, item, limits and display.
+* @returns Its schema.
+*/
+function array(options) {
+	const item = Object.fromEntries(Object.entries(options.of ?? {}).filter(([key]) => key !== "default"));
+	const displayAs = options.displayAs ?? (item.kind === "choice" ? "checkboxes" : "list");
+	return Type$1.Array(Type$1.Unknown(), meta("array", displayAs, {
+		default: [],
+		...options
+	}, {
+		minItems: options.minItems,
+		maxItems: options.maxItems,
+		of: item
+	}));
+}
+/**
+* @description Builds a section of settings.
+* @param options Its labels and display.
+* @param properties Its settings and buttons.
+* @returns Its schema.
+*/
+function section(options, properties) {
+	return Type$1.Object(properties, meta("section", options.displayAs ?? "group", options));
+}
+/**
+* @description Builds a button row that runs an export of src/actions.ts; it stores nothing.
+* @param options Its labels, action, confirmation and display.
+* @returns Its schema.
+*/
+function button(options) {
+	return Type$1.Null(meta("button", options.displayAs ?? "button", options, {
+		action: options.action,
+		confirm: options.confirm
+	}));
+}
+/**
+* @description Builds a notice row that shows a message in its panel; it stores nothing.
+* @param options Its labels, tone and `visibleWhen`.
+* @returns Its schema.
+*/
+function notice(options) {
+	return Type$1.Null(meta("notice", "notice", options, { tone: options.tone ?? "info" }));
+}
+/** The setting builders, one per stored primitive; `displayAs` picks the widget. */
+const setting = {
+	boolean,
+	number,
+	integer,
+	string,
+	choice,
+	array,
+	section,
+	button,
+	notice
+};
+/**
+* @description Declares a plugin's settings: the default export of its settings.ts.
+* @param properties The settings, sections and buttons, built with {@link setting}.
+* @param options The message key of the title of the section holding the top-level settings.
+* @returns The TypeBox object schema, marked as a settings schema.
+*/
+function defineSettings(properties, options = {}) {
+	return Type$1.Object(properties, defined({
+		kind: "settings",
+		title: options.title
+	}));
+}
+var schema_default = {
+	defineSettings,
+	setting
+};
+export { schema_default as default, defineSettings, setting };