nuxt-ui-tools 1.12.0 → 1.13.0

package/README.md

@@ -3,15 +3,21 @@
 Nuxt module and runtime toolkit for UI-heavy Nuxt apps, with a local playground for integration testing and demos.
 
 The release-ready public runtimes are available through `nuxt-ui-tools/table`,
-`nuxt-ui-tools/form`, `nuxt-ui-tools/query-state`, `nuxt-ui-tools/shared`, and
-`nuxt-ui-tools/i18n`. Installing the Nuxt module also exposes the same domains
-through `#ui-tools/*`, auto-imports their primary functions, and registers their
+`nuxt-ui-tools/form`, `nuxt-ui-tools/query-state`, `nuxt-ui-tools/spreadsheet`,
+`nuxt-ui-tools/shared`, and `nuxt-ui-tools/i18n`. Installing the Nuxt module also exposes the
+same domains through `#ui-tools/*`, auto-imports their primary functions, and registers their
 top-level components.
 
 The shared entrypoint exports the breakpoint-aware runtime helpers
 `getResponsiveValue`, `parseResponsiveValue`, `resolveResponsiveValueAtBreakpoint`,
-and `useResponsiveValue`. The spreadsheet import engine is still internal and is
-not part of the package export map or Nuxt public surface.
+and `useResponsiveValue`.
+
+The spreadsheet import reads files with SheetJS, an optional peer. npm only serves SheetJS up to
+0.18.5, which has known vulnerabilities; install 0.20.2 or later from the SheetJS CDN:
+
+```bash
+bun add https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz
+```
 
 ## Structure
 

package/dist/module.json

@@ -5,7 +5,7 @@
   "configKey": "nuxtUiTools",
   "docs": "https://ui.nuxt.com/docs/getting-started/installation/nuxt",
   "name": "nuxt-ui-tools",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -46,6 +46,44 @@ function getPublicComponents(runtimeDir, options) {
       global: options.global,
       name: `${prefix}DataList${part}`
     })),
+    // Spreadsheet
+    {
+      filePath: `${runtimeDir}/spreadsheet/components/spreadsheet-import.vue`,
+      global: options.global,
+      name: `${prefix}SpreadsheetImport`
+    },
+    {
+      filePath: `${runtimeDir}/spreadsheet/components/spreadsheet-import-root.vue`,
+      global: options.global,
+      name: `${prefix}SpreadsheetImportRoot`
+    },
+    ...[
+      "Dropzone",
+      "FileCard",
+      "SourceSettings",
+      "ExpectedColumns",
+      "TemplateButton",
+      "ColumnMapping",
+      "ValueMapping",
+      "Table",
+      "TableToolbar",
+      "RowInspector",
+      "Stats",
+      "Stat",
+      "ExportButton",
+      "SubmitButton",
+      "Summary",
+      "Progress"
+    ].map((part) => ({
+      filePath: `${runtimeDir}/spreadsheet/components/parts/spreadsheet-import-${toKebabCase(part)}.vue`,
+      global: options.global,
+      name: `${prefix}SpreadsheetImport${part}`
+    })),
+    ...["Stepper", "Step", "StepNav"].map((part) => ({
+      filePath: `${runtimeDir}/spreadsheet/components/steps/spreadsheet-import-${toKebabCase(part)}.vue`,
+      global: options.global,
+      name: `${prefix}SpreadsheetImport${part}`
+    })),
     // Dashboard
     ...[
       "Grid",
@@ -174,6 +212,13 @@ function setupImports(runtimeDir) {
       { from: "table", name: "tableSource" },
       { from: "table", name: "useTable" }
     ]),
+    // Spreadsheet
+    ...withRuntime(runtimeDir, [
+      { from: "spreadsheet", name: "defineSpreadsheetSchema" },
+      { from: "spreadsheet", name: "spreadsheetSteps" },
+      { from: "spreadsheet", name: "useSpreadsheetImport" },
+      { from: "spreadsheet", name: "useSpreadsheetSteps" }
+    ]),
     // Dashboard
     ...withRuntime(runtimeDir, [
       { from: "dashboard", name: "defineDashboardSchema" },
@@ -377,6 +422,7 @@ const publicRuntimeDomains = [
   "query-prefetch",
   "query-state",
   "shared",
+  "spreadsheet",
   "table"
 ];
 const require$1 = createRequire(import.meta.url);

package/dist/runtime/dashboard/components/dashboard-stat.d.vue.ts

@@ -1,7 +1,7 @@
 import type { LazyTextValue } from '#ui-tools/shared/types/utils';
 import type { DashboardBlockBaseProps, DashboardBlockUi, DashboardSeriesColor, DashboardSourceLike, DashboardStatUi, DashboardStatus, DashboardValueFormat } from '../types/index.js';
 declare const __VLS_export: <TData>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
-    props: import("vue").PublicProps & __VLS_PrettifyLocal<Omit<DashboardBlockBaseProps, "ui" | "title" | "subtitle"> & {
+    props: import("vue").PublicProps & __VLS_PrettifyLocal<Omit<DashboardBlockBaseProps, "title" | "ui" | "subtitle"> & {
         source: DashboardSourceLike<TData>;
         /** KPI label, shown above the value. */
         label: LazyTextValue;

package/dist/runtime/dashboard/components/dashboard-stat.vue.d.ts

@@ -1,7 +1,7 @@
 import type { LazyTextValue } from '#ui-tools/shared/types/utils';
 import type { DashboardBlockBaseProps, DashboardBlockUi, DashboardSeriesColor, DashboardSourceLike, DashboardStatUi, DashboardStatus, DashboardValueFormat } from '../types/index.js';
 declare const __VLS_export: <TData>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
-    props: import("vue").PublicProps & __VLS_PrettifyLocal<Omit<DashboardBlockBaseProps, "ui" | "title" | "subtitle"> & {
+    props: import("vue").PublicProps & __VLS_PrettifyLocal<Omit<DashboardBlockBaseProps, "title" | "ui" | "subtitle"> & {
         source: DashboardSourceLike<TData>;
         /** KPI label, shown above the value. */
         label: LazyTextValue;

package/dist/runtime/file-preview/components/shell/file-preview-stage.d.vue.ts

@@ -17,13 +17,13 @@ type __VLS_Slots = {} & {
     default?: (props: typeof __VLS_64) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    ready: (details: readonly FilePreviewDetail[]) => any;
     previous: () => any;
+    ready: (details: readonly FilePreviewDetail[]) => any;
     download: () => any;
     next: () => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onReady?: ((details: readonly FilePreviewDetail[]) => any) | undefined;
     onPrevious?: (() => any) | undefined;
+    onReady?: ((details: readonly FilePreviewDetail[]) => any) | undefined;
     onDownload?: (() => any) | undefined;
     onNext?: (() => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

package/dist/runtime/file-preview/components/shell/file-preview-stage.vue.d.ts

@@ -17,13 +17,13 @@ type __VLS_Slots = {} & {
     default?: (props: typeof __VLS_64) => any;
 };
 declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    ready: (details: readonly FilePreviewDetail[]) => any;
     previous: () => any;
+    ready: (details: readonly FilePreviewDetail[]) => any;
     download: () => any;
     next: () => any;
 }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onReady?: ((details: readonly FilePreviewDetail[]) => any) | undefined;
     onPrevious?: (() => any) | undefined;
+    onReady?: ((details: readonly FilePreviewDetail[]) => any) | undefined;
     onDownload?: (() => any) | undefined;
     onNext?: (() => any) | undefined;
 }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

package/dist/runtime/i18n/locales/en.js

@@ -318,144 +318,265 @@ export default defineUiToolsLocale({
       }
     },
     spreadsheet: {
-      common: {
-        arraySummary: "{count} item(s)",
-        arrayValue: "Array value",
-        clickToChangeHeaderRow: "Click on a row to change the header position",
-        closeImport: "Close import",
-        continue: "Continue",
-        exportDiscardedRows: "Export {count} discarded rows",
-        importRows: "Import {count} rows",
-        importSummary: "{importable} of {total} rows will be imported",
-        objectSummary: "{count} field(s)",
-        objectValue: "Object value",
-        preparingReview: "Preparing review...",
-        preparingReviewDescription: "Validation and review data are being prepared.",
-        previous: "Previous",
-        referencesStepHint: "Resolve what you can here, then review row validity in the next step",
-        sheetStats: "{rows} rows \xB7 {columns} columns",
-        steps: "Steps"
+      issues: {
+        required: "Required value is missing",
+        number: "\u201C{value}\u201D is not a number",
+        date: "\u201C{value}\u201D is not a date this column reads",
+        boolean: "\u201C{value}\u201D is not yes or no",
+        unknownValue: "\u201C{value}\u201D is not a known value \xB7 choose it in Values",
+        notFound: "\u201C{value}\u201D is not a known value",
+        skipped: "Left out: \u201C{value}\u201D is set to skip its rows",
+        duplicate: "Same key as row {row}",
+        exists: "Already stored",
+        email: "Not an email address",
+        pattern: "Unexpected format",
+        minLength: "At least {min} characters",
+        maxLength: "At most {max} characters",
+        min: "{value} is below {min}",
+        max: "{value} is above {max}",
+        between: "{value} is not between {min} and {max}",
+        notFuture: "The date is in the future"
+      },
+      template: {
+        sheet: "Import",
+        guide: "Columns",
+        column: "Column",
+        required: "Required",
+        allowed: "Allowed values",
+        description: "Description",
+        yes: "Yes"
       },
       steps: {
-        matching: {
-          assigned: "Assigned",
-          autoMapped: "Auto-mapped",
-          autoMappedField: "Auto-mapped field",
-          available: "Available",
-          columnFallback: "Column {index}",
-          description: "Review how file columns map to system fields. Fix any missing or ambiguous matches.",
-          ignoreField: "Ignore this field",
-          ignored: "Ignored",
-          ignoredColumns: "Ignored spreadsheet columns",
-          matched: "Matched",
-          missing: "Missing",
-          needsMatch: "Needs match",
-          optional: "Optional",
-          required: "Required",
-          requirement: "Requirement",
-          searchColumns: "Search spreadsheet columns...",
-          selectColumn: "Select a spreadsheet column...",
-          spreadsheetColumn: "Spreadsheet column",
-          statusHeader: "Status",
-          systemField: "System field",
-          title: "Column matching"
-        },
-        references: {
-          description: "Match imported values to internal products. Resolve once, apply to all matching rows.",
-          title: "Reconciliation"
+        file: "File",
+        columns: "Columns",
+        values: "Values",
+        review: "Review",
+        submit: "Import",
+        auto: "nothing to do"
+      },
+      stepHints: {
+        file: "The Excel or CSV file",
+        columns: "File columns \u2192 fields",
+        values: "Unknown values",
+        review: "Valid rows and issues",
+        submit: "Summary and import"
+      },
+      headings: {
+        file: {
+          title: "File to import",
+          description: "Excel or CSV. The sheet and the row of column names are found for you."
+        },
+        columns: {
+          title: "Columns",
+          description: "Each field reads the column of the file with its name. Choose a column for what is missing."
+        },
+        values: {
+          title: "Values",
+          description: "These values match no known value. Each choice applies to every row using the value."
         },
         review: {
-          affectsFullRow: "Affects the full row",
-          allIssues: "All issues",
-          allRows: "All rows {count}",
-          autoTrim: "Auto-trim",
-          backToTable: "Back to table",
-          blocking: "Blocking {count}",
-          blockingIssues: "Blocking issues",
-          blockingStatus: "Blocking",
-          byIssueType: "By issue type",
-          byProperty: "By property",
-          description: "Review rows, discard overflow, and confirm the final import payload.",
-          discard: "Discard",
-          discardRow: "Discard row",
-          discarded: "Discarded {count}",
-          discardedStatus: "Discarded",
-          groupedByIssueType: "Grouped by issue type",
-          importLimit: "Import limit: {importable} of {total}",
-          inspectingRow: "Inspecting row #{row}",
-          invalid: "Invalid {count}",
-          issueBadgeBlocking: "BLOCKING",
-          issueBadgeWarning: "WARNING",
-          issueGroups: "{count} issue groups",
-          issueRowsProgress: "{current} of {total} with issues",
-          issuesOnThisRow: "Issues on this row",
-          next: "Next",
-          noBlockingIssues: "No blocking issues",
-          noValue: "\u2014",
-          nothingDiscarded: "Nothing discarded",
-          overflowDescription: "Select rows to discard below, or auto-trim the last {count} rows. Discarded rows can be exported.",
-          overflowTitle: "Import limit exceeded \u2014 {total} rows detected, max is {max}",
-          prev: "Prev",
-          property: "Property: {key}",
-          propertyGroups: "{count} property groups",
-          ready: "ready",
-          restore: "Restore",
-          restoreRow: "Restore row",
-          row: "Row",
-          rowData: "Row data",
-          rowLevelIssue: "Row-level issue",
-          ruleKey: "Rule key: {key}",
-          selected: "{count} selected",
-          title: "Review & import",
-          valid: "Valid {count}",
-          validRow: "Valid row",
-          validRows: "{count} valid rows",
-          validStatus: "Valid",
-          valueInFile: "Value in file",
-          viewAllRowsWithThisIssue: "View all {count} rows with this issue",
-          warningStatus: "Warning",
-          warnings: "Warnings {count}",
-          warningsOnly: "Warnings only",
-          willNotBeImported: "Will not be imported"
-        },
-        structure: {
-          autoDetected: "Auto-detected",
-          description: "Select the correct sheet and verify the header row detected by the system.",
-          headerDetectedAtRow: "Header detected at row {row}",
-          loadWorkbookFirstDescription: "The structure step becomes available after a file is uploaded.",
-          loadWorkbookFirstTitle: "Load a workbook first",
-          previewTitle: "Sheet preview",
-          sheetLabel: "Sheet",
-          stageTitle: "Confirm file structure",
-          title: "Structure"
+          title: "Review",
+          description: "Click a cell to edit it. Click a row number to see its issues."
         },
-        upload: {
-          description: "Drag and drop or select an Excel / CSV file to begin the import process.",
-          stageTitle: "Upload your file",
-          title: "Upload file"
+        submit: {
+          title: "Ready to import",
+          description: "Check the summary, then import."
         }
       },
-      upload: {
-        downloadTemplate: "Download template",
-        downloadTemplateDescription: "Get the expected format for assessment imports",
-        dropzoneDescription: "or click to browse \u2014 .xlsx, .xls, .csv supported",
-        dropzoneLabel: "Drop your spreadsheet here",
-        parsingFailed: "Workbook parsing failed"
+      nav: {
+        back: "Back",
+        continue: "Continue",
+        cancel: "Cancel",
+        close: "Close",
+        import: "Import {count} rows",
+        another: "Import another file",
+        blockers: {
+          file: "Choose a file to continue",
+          columns: "Required columns missing: {count}",
+          values: "Values to choose: {count}",
+          review: "No row to import",
+          invalid: "Rows with errors are left out: {count}"
+        }
       },
-      validation: {
-        between: "{value} must be between {min} and {max}",
-        invalidBooleanInput: 'Enter Yes or No instead of "{value}"',
-        invalidNumberInput: 'Enter a valid number instead of "{value}"',
-        max: "{value} must be lower than or equal to {max}",
-        maxLength: "Max {max} characters, got {length}",
-        min: "{value} must be greater than or equal to {min}",
-        minLength: "Min {min} characters, got {length}",
-        missingValue: 'Add a value for "{field}"',
-        number: "This field must be a valid number",
-        oneOf: "{value} must be one of {values}",
-        parseFailed: 'We could not read the value for "{field}"',
-        required: "This field is required",
-        unrecognizedValue: 'The value "{value}" is not recognized'
+      file: {
+        dropTitle: "Drop your file here",
+        dropBrowse: "or browse",
+        dropHint: "{types} \xB7 up to {count} rows",
+        dropHintNoLimit: "{types}",
+        paste: "You can also paste rows copied from a spreadsheet.",
+        reading: "Reading {name}\u2026",
+        readFailed: "This file can\u2019t be read. Check that it is an Excel or CSV file.",
+        replace: "Replace",
+        summary: "{rows} rows \xB7 {sheets} sheets",
+        sheet: "Sheet",
+        sheetOption: "{name} \xB7 {count} rows",
+        headerRow: "Column names on",
+        rowOption: "Row {row} \xB7 {preview}",
+        emptyRow: "Row {row}",
+        detected: "Found automatically",
+        titleRows: "{count} title rows above",
+        ambiguous: "Several sheets match. Check this is the right one.",
+        noMatch: "No expected column in this sheet. Check the sheet and the row of column names.",
+        useDetected: "Use what was found",
+        previewTitle: "title",
+        previewHeader: "column names",
+        expected: "Expected columns",
+        expectedCount: "{count} columns",
+        optional: "optional",
+        fromContext: "Highlighted columns depend on your selection.",
+        template: "Template"
+      },
+      columns: {
+        field: "Field",
+        column: "Column in the file",
+        samples: "In the file",
+        none: "Not in the file",
+        columnFor: "Column for {field}",
+        emptyColumn: "Empty column",
+        statuses: {
+          matched: "Found",
+          manual: "Chosen",
+          default: "Default value",
+          missing: "Missing",
+          unmatched: "Not in the file"
+        },
+        suggestion: "\u201C{header}\u201D has values like {samples}",
+        useSuggestion: "Use it",
+        reset: "Undo",
+        reads: "reads {field}",
+        found: "{count} fields found in the file",
+        allFound: "Every field was found in the file",
+        unused: "Not imported: {columns}"
+      },
+      values: {
+        value: "Value in the file",
+        rows: "Rows",
+        answer: "Becomes",
+        rowCount: "{count} rows",
+        choose: "Choose\u2026",
+        search: "Search\u2026",
+        loading: "Loading the list\u2026",
+        valueFor: "Answer for {value}",
+        scope: "For {conditions}",
+        condition: "{label}: {values}",
+        leaveEmpty: "Leave empty",
+        skipRows: "Don\u2019t import these rows",
+        create: "Create \u201C{value}\u201D",
+        statuses: {
+          open: "To choose",
+          user: "Chosen",
+          policy: "By default",
+          recognized: "Found"
+        },
+        recognized: "{count} values found in the list",
+        nothing: "Every value was found in the list"
+      },
+      table: {
+        tabs: {
+          all: "All",
+          importable: "To import",
+          invalid: "Invalid",
+          discarded: "Left out"
+        },
+        levels: {
+          all: "All issues",
+          blocking: "Blocking",
+          warnings: "Warnings"
+        },
+        modes: {
+          all: "New and updates",
+          create: "New",
+          update: "Updates"
+        },
+        search: "Search rows",
+        anyIssue: "Any issue",
+        byColumn: "By column",
+        byIssue: "By issue",
+        columnIssueOption: "{field} \xB7 {count} rows",
+        issueOption: "{field} \xB7 {message} \xB7 {count}",
+        clearFilter: "Clear",
+        selected: "{count} selected",
+        discard: "Leave out",
+        restore: "Restore",
+        clearSelection: "Clear",
+        row: "Row",
+        selectRow: "Select row {row}",
+        selectAll: "Select all visible rows",
+        inspectRow: "Inspect row {row}",
+        empty: "No rows match these filters.",
+        emptyCell: "empty",
+        edited: "Edited \xB7 in the file: {value}",
+        defaulted: "Default value",
+        created: "new",
+        stored: "Stored: {value}",
+        rowCount: "{count} rows",
+        modeCreate: "New",
+        modeUpdate: "Update",
+        status: {
+          valid: "Valid",
+          warning: "Warning",
+          blocking: "Blocking",
+          discarded: "Left out"
+        },
+        reasons: {
+          manual: "Left out by you",
+          value: "Left out by a value answer",
+          limit: "Past the row limit",
+          duplicate: "Duplicate of another row",
+          existing: "Already stored, left as it is"
+        }
+      },
+      inspector: {
+        title: "Row {row}",
+        close: "Close",
+        position: "{current} of {total} rows with issues",
+        positionNone: "{total} rows with issues",
+        previous: "Previous row with issues",
+        next: "Next row with issues",
+        issues: "Issues",
+        noIssue: "No issue on this row",
+        values: "Values",
+        inFile: "In the file",
+        revert: "Revert",
+        discard: "Leave out this row",
+        restore: "Restore this row",
+        allRows: "All {count} rows with this issue",
+        answerIt: "Choose it in Values"
+      },
+      stats: {
+        importable: "rows to import",
+        invalid: "rows with errors",
+        discarded: "rows left out",
+        create: "{count} new",
+        update: "{count} updates",
+        warnings: "{count} with warnings",
+        blocking: "{count} blocking issues"
+      },
+      review: {
+        issuesColumn: "Issues",
+        export: "Invalid rows"
+      },
+      summary: {
+        file: "File",
+        toImport: "Rows to import",
+        create: "New records",
+        update: "Updated records",
+        invalid: "Invalid, not imported",
+        discarded: "Left out",
+        edited: "Cells edited",
+        created: "Values created"
+      },
+      progress: {
+        running: "Importing\u2026",
+        count: "{done} of {total}",
+        done: "{count} rows imported",
+        doneHint: "The import is complete.",
+        rejected: "Rows refused: {count}",
+        rejectedHint: "They are back in review with the reason. Fix them and send them again.",
+        retry: "Send them again",
+        review: "See them",
+        error: "The import failed",
+        tryAgain: "Try again"
       }
     },
     table: {