nuxt-ui-tools 1.1.0 → 1.3.0

package/dist/runtime/dashboard/utils/builders/dashboard-params.d.ts

@@ -1,85 +0,0 @@
-import type { QueryCodec } from '../../../query-state/index.js';
-import type { DashboardComparison, DashboardDateRange, DashboardOption, DashboardOptionValue, DashboardParamDefinition, DashboardParamOptions, DashboardRemoteOptionsConfig } from '../../types/index.js';
-type ResolveParamValue<TValue, TDefault> = undefined extends TDefault ? TValue | undefined : TValue;
-declare function stringParam<const TDefault extends string | undefined = undefined>(options?: DashboardParamOptions<TDefault>): DashboardParamDefinition<ResolveParamValue<string, TDefault>> & {
-    readonly kind: 'string';
-};
-declare function numberParam<const TDefault extends number | undefined = undefined>(options?: DashboardParamOptions<TDefault>): DashboardParamDefinition<ResolveParamValue<number, TDefault>> & {
-    readonly kind: 'number';
-};
-declare function booleanParam<const TDefault extends boolean | undefined = undefined>(options?: DashboardParamOptions<TDefault>): DashboardParamDefinition<ResolveParamValue<boolean, TDefault>> & {
-    readonly kind: 'boolean';
-};
-declare function dateParam<const TDefault extends Date | undefined = undefined>(options?: DashboardParamOptions<TDefault>): DashboardParamDefinition<ResolveParamValue<Date, TDefault>> & {
-    readonly kind: 'date';
-};
-declare function dateRangeParam<const TDefault extends DashboardDateRange | undefined = undefined>(options?: DashboardParamOptions<TDefault>): DashboardParamDefinition<ResolveParamValue<DashboardDateRange, TDefault>> & {
-    readonly kind: 'dateRange';
-};
-declare function enumParam<const TValues extends readonly DashboardOptionValue[]>(values: TValues, options: DashboardParamOptions<readonly TValues[number][]> & {
-    multiple: true;
-}): DashboardParamDefinition<TValues[number][]> & {
-    readonly kind: 'enum';
-};
-declare function enumParam<const TValues extends readonly DashboardOptionValue[], const TDefault extends TValues[number] | undefined = undefined>(values: TValues, options?: DashboardParamOptions<TDefault> & {
-    multiple?: false;
-}): DashboardParamDefinition<ResolveParamValue<TValues[number], TDefault>> & {
-    readonly kind: 'enum';
-};
-declare function optionsParam<const TItems extends readonly DashboardOption[]>(items: TItems, options: DashboardParamOptions<readonly TItems[number]['value'][]> & {
-    multiple: true;
-}): DashboardParamDefinition<TItems[number]['value'][]> & {
-    readonly kind: 'options';
-};
-declare function optionsParam<const TItems extends readonly DashboardOption[], const TDefault extends TItems[number]['value'] | undefined = undefined>(items: TItems, options?: DashboardParamOptions<TDefault> & {
-    multiple?: false;
-}): DashboardParamDefinition<ResolveParamValue<TItems[number]['value'], TDefault>> & {
-    readonly kind: 'options';
-};
-declare function remoteParam(config: DashboardRemoteOptionsConfig & DashboardParamOptions<readonly string[]> & {
-    multiple: true;
-}): DashboardParamDefinition<string[]> & {
-    readonly kind: 'remote';
-};
-declare function remoteParam<const TDefault extends string | undefined = undefined>(config: DashboardRemoteOptionsConfig & DashboardParamOptions<TDefault> & {
-    multiple?: false;
-}): DashboardParamDefinition<ResolveParamValue<string, TDefault>> & {
-    readonly kind: 'remote';
-};
-/** Values of `p.comparison`, in menu order. */
-export declare const DASHBOARD_COMPARISONS: readonly ["previous", "year", "none"];
-declare function comparisonParam<const TDefault extends DashboardComparison | undefined = undefined>(options?: DashboardParamOptions<TDefault>): DashboardParamDefinition<ResolveParamValue<DashboardComparison, TDefault>> & {
-    readonly kind: 'comparison';
-};
-declare function customParam<TValue, const TDefault extends TValue | undefined = undefined>(codec: QueryCodec<TValue>, options?: DashboardParamOptions<TDefault>): DashboardParamDefinition<ResolveParamValue<TValue, TDefault>> & {
-    readonly kind: 'custom';
-};
-/**
- * The `p` builder handed to every `params` callback. Each method declares one typed, URL-synced
- * param; the engine renders no controls, the app binds `v-model` to the resulting value.
- *
- * Every param accepts `defaultValue` (narrows away `undefined`), `urlKey`, `omitDefault`, and
- * `historyMode`. Option-backed params (`enum`, `options`, `remote`) also accept `multiple: true`,
- * which turns the value into an always-defined array.
- */
-export declare const dashboardParamBuilder: {
-    boolean: typeof booleanParam;
-    /**
-     * Comparison period: `'previous'`, `'year'`, or `'none'`. Its option handle carries localized
-     * labels; `resolveDashboardComparisonRange(range, mode)` turns it into the range to fetch.
-     */
-    comparison: typeof comparisonParam;
-    custom: typeof customParam;
-    date: typeof dateParam;
-    /** Inclusive date range, serialized as `YYYY-MM-DD..YYYY-MM-DD`. */
-    dateRange: typeof dateRangeParam;
-    /** Value(s) from a literal list, e.g. `p.enum([2024, 2025, 2026], { defaultValue: 2026 })`. */
-    enum: typeof enumParam;
-    number: typeof numberParam;
-    /** Value(s) from labeled items: `{ value, label, icon?, avatar?, description? }`. */
-    options: typeof optionsParam;
-    /** Id(s) picked from a remote, searchable, paginated option source. */
-    remote: typeof remoteParam;
-    string: typeof stringParam;
-};
-export {};

package/dist/runtime/dashboard/utils/builders/dashboard-params.js

@@ -1,87 +0,0 @@
-import {
-  createListCodec,
-  createOptionValueCodec,
-  createSafeCodec,
-  dateRangeCodec,
-  localDateCodec,
-  optionalBooleanCodec,
-  optionalNumberCodec,
-  optionalStringCodec
-} from "../params/codecs.js";
-function defineParam(kind, codec, options = {}) {
-  const multiple = options.multiple === true;
-  return {
-    codec: multiple ? createListCodec(codec) : codec,
-    defaultValue: options.defaultValue ?? (multiple ? [] : void 0),
-    historyMode: options.historyMode,
-    items: options.items,
-    kind,
-    multiple,
-    omitDefault: options.omitDefault,
-    remote: options.remote,
-    urlKey: options.urlKey
-  };
-}
-function stringParam(options) {
-  return defineParam("string", optionalStringCodec, options);
-}
-function numberParam(options) {
-  return defineParam("number", optionalNumberCodec, options);
-}
-function booleanParam(options) {
-  return defineParam("boolean", optionalBooleanCodec, options);
-}
-function dateParam(options) {
-  return defineParam("date", localDateCodec, options);
-}
-function dateRangeParam(options) {
-  return defineParam("dateRange", dateRangeCodec, options);
-}
-function enumParam(values, options) {
-  const items = values.map((value) => ({ label: String(value), value }));
-  return defineParam("enum", createOptionValueCodec(values), { ...options, items });
-}
-function optionsParam(items, options) {
-  const codec = createOptionValueCodec(items.map((item) => item.value));
-  return defineParam("options", codec, { ...options, items });
-}
-function remoteParam(config) {
-  const { load, pagination, queryKey, resolveSelected, search, ...options } = config;
-  const remote = { load, pagination, queryKey, resolveSelected, search };
-  return defineParam("remote", optionalStringCodec, { ...options, remote });
-}
-export const DASHBOARD_COMPARISONS = [
-  "previous",
-  "year",
-  "none"
-];
-function comparisonParam(options) {
-  const items = DASHBOARD_COMPARISONS.map((value) => ({ label: value, value }));
-  return defineParam("comparison", createOptionValueCodec(DASHBOARD_COMPARISONS), {
-    ...options,
-    items
-  });
-}
-function customParam(codec, options) {
-  return defineParam("custom", createSafeCodec(codec), options);
-}
-export const dashboardParamBuilder = {
-  boolean: booleanParam,
-  /**
-   * Comparison period: `'previous'`, `'year'`, or `'none'`. Its option handle carries localized
-   * labels; `resolveDashboardComparisonRange(range, mode)` turns it into the range to fetch.
-   */
-  comparison: comparisonParam,
-  custom: customParam,
-  date: dateParam,
-  /** Inclusive date range, serialized as `YYYY-MM-DD..YYYY-MM-DD`. */
-  dateRange: dateRangeParam,
-  /** Value(s) from a literal list, e.g. `p.enum([2024, 2025, 2026], { defaultValue: 2026 })`. */
-  enum: enumParam,
-  number: numberParam,
-  /** Value(s) from labeled items: `{ value, label, icon?, avatar?, description? }`. */
-  options: optionsParam,
-  /** Id(s) picked from a remote, searchable, paginated option source. */
-  remote: remoteParam,
-  string: stringParam
-};