@svgrid/enterprise 1.2.0 → 2.0.0

package/src/index.ts

@@ -5,10 +5,15 @@ export {
   isLicenseKeySet,
   hasValidLicense,
   assertEnterpriseLicensed,
+  nudgeEnterprise,
+  checkLicenseKey,
+  type LicenseInfo,
+  type LicenseStatus,
 } from './license'
 
 export {
   exportGrid,
+  copyExportToClipboard,
   type ExportFormat,
   type ExportOptions,
   type ExportColumn,
@@ -16,19 +21,34 @@ export {
   type ExportStyles,
   type ExportHeaderFooterLine,
   type ExportSheet,
+  type ExportRowSource,
+  type ExportProgress,
+  type ExportResult,
+  type ClipboardFormat,
+  type ClipboardExportOptions,
 } from './export'
+export { default as SvExportMenu } from './SvExportMenu.svelte'
+export { buildPdfDocDefinition, type PdfExportOptions, type PdfPageSize } from './export-pdf'
 export { printGrid, type PrintOptions } from './print'
 export {
   importData,
+  readImportMatrix,
+  mapImportMatrix,
+  mapImportMatrixAsync,
+  autoMapColumns,
+  inferImportColumnTypes,
   type ImportFormat,
   type ImportFieldType,
   type ImportOptions,
   type ImportResult,
+  type ImportProgress,
   type ImportColumnMap,
   type ImportColumnTypes,
+  type ImportGridColumn,
   type ImportRowError,
   type ImportValidator,
 } from './import'
+export { default as SvImportDialog } from './SvImportDialog.svelte'
 export { installEnterprise, type EnterpriseGridApi, type EnterpriseAIApi, type EnterprisePivotApi } from './install'
 export {
   createStagedEditing,
@@ -56,6 +76,259 @@ export {
   type PivotValueConfig,
 } from './pivot'
 
+export {
+  titleCase,
+  resolveIdField,
+  schemaToColumns,
+  schemaToFormFields,
+  validateField,
+  applyComputed,
+  validateEntity,
+  type EntitySchema,
+  type EntityField,
+  type EntityFieldType,
+  type EntityHooks,
+  type FormFieldDescriptor,
+  type StudioEditorType,
+  type StandardSchemaV1,
+  type StandardSchemaResult,
+  type ValidationOp,
+  type ValidationRuleSpec,
+} from './schema'
+
+export {
+  planQuery,
+  coerce,
+  createInMemoryDataSource,
+  createKitDataSource,
+  createKitHandlers,
+  createSqlDataSource,
+  planToSql,
+  type QueryPlan,
+  type PlanPredicate,
+  type PlanOp,
+  type KitDataSourceOptions,
+  type KitHandlerOptions,
+  type KitHandlers,
+  type KitMessage,
+  type SqlDialect,
+  type SqlPlan,
+  type SqlExecutor,
+  type SqlDataSourceConfig,
+  type WritableDataSource,
+} from './sveltekit'
+
+export {
+  createSupabaseDataSource,
+  createRestDataSource,
+  offsetLimitAdapter,
+  dummyJsonAdapter,
+  jsonServerAdapter,
+  introspectSupabaseTable,
+  createSupabaseRealtime,
+  createRelationLookup,
+  createSupabaseAuth,
+  aggregateRows,
+  chartFieldsFromSchema,
+  normalizeFilters,
+  buildEntitySchema,
+  pickLabelField,
+  linkRelationLabels,
+  type SupabaseDataSourceConfig,
+  type SupabaseClientLike,
+  type RestDataSourceConfig,
+  type RestAdapter,
+  type OffsetLimitOptions,
+  type IntrospectSupabaseOptions,
+  type IntrospectedColumn,
+  type ColumnReference,
+  type NormalizedFilter,
+  type NormalizedPredicate,
+  type SupabaseRealtimeConfig,
+  type SupabaseRealtimeClientLike,
+  type SupabaseRealtimeHandle,
+  type RealtimeChannelLike,
+  type RealtimeChange,
+  type RelationLookup,
+  type RelationLookupConfig,
+  type RelationOption,
+  type SupabaseAuthConfig,
+  type SupabaseAuthController,
+  type SupabaseAuthClientLike,
+  type AuthState,
+  type AuthUser,
+  withEntityRules,
+  withRelationLabels,
+  reduceValue,
+  kpiSeries,
+  sparklinePoints,
+  seriesDelta,
+  formatKpiValue,
+  dashboardFromSchema,
+  type AggregateReduce,
+  type AggregateRequest,
+  type AggregateBucket,
+  type AggregateSource,
+  type DashboardSpec,
+  type DashboardWidget,
+  type KpiWidget,
+  type ChartWidget,
+  type RelationLabelConfig,
+} from './sources'
+
+export {
+  buildInitialValues,
+  controlKind,
+  editMode,
+  rowId,
+  toSubmitValues,
+  validateAll,
+  type EditMode,
+  type ControlKind,
+} from './edit-panel'
+export { default as SvGridEditPanel } from './SvGridEditPanel.svelte'
+export { default as SvLookupInput } from './SvLookupInput.svelte'
+export { default as SvFileInput } from './SvFileInput.svelte'
+export { default as SvAuthGate } from './SvAuthGate.svelte'
+export { default as SvSchemaChart } from './SvSchemaChart.svelte'
+export { default as SvSchemaDashboard } from './SvSchemaDashboard.svelte'
+export { default as SvBoard } from './SvBoard.svelte'
+export { default as SvSchedule } from './SvSchedule.svelte'
+export { default as SvRecordDetail } from './SvRecordDetail.svelte'
+
+export {
+  FIELD_TYPES,
+  blankField,
+  addField,
+  removeField,
+  updateField,
+  moveField,
+  validateSchema,
+  isSchemaValid,
+  sampleRows,
+  type SchemaIssue,
+  type SchemaIssueLevel,
+} from './schema-designer'
+// NOTE: The visual designer components (SvSchemaDesigner, SvStudioDesigner) are
+// the commercial "SvGrid Studio" seller. They live entirely in the PRIVATE
+// website repo (website/src/lib/designer), NOT in this public package - they
+// import the public API below. The Studio *codegen* below stays public because
+// the MCP server depends on it.
+// The Studio project model + codegen (also on the pure `@svgrid/enterprise/studio`
+// subpath) - re-exported so the designer and its model come from one import.
+export {
+  createProject,
+  defaultScreenFor,
+  emitStudioProject,
+  emitStudioAppBundle,
+  emitStudioApp,
+  sampleApps,
+  getSampleApp,
+  liveDataSamples,
+  getLiveDataSample,
+  type SampleApp,
+  sanitizeStudioProject,
+  buildStudioBugReport,
+  type BugReport,
+  type BugReportInput,
+  addBlock,
+  addBlockAt,
+  removeBlock,
+  moveBlock,
+  reorderBlock,
+  updateBlock,
+  addScreen,
+  removeScreen,
+  updateScreen,
+  duplicateScreen,
+  reorderScreen,
+  insertBlock,
+  addEntity,
+  removeEntity,
+  updateEntity,
+  setDataSource,
+  defaultEntitySource,
+  setEntityDataSource,
+  entityDataSource,
+  setTheme,
+  setThemePreset,
+  setShell,
+  sanitizeProject,
+  screenFromTemplate,
+  addScreenFromTemplate,
+  serializeProject,
+  parseProject,
+  blockPalette,
+  validateProject,
+  isProjectValid,
+  entityOf,
+  studioThemes,
+  defaultStudioTheme,
+  getStudioTheme,
+  resolveThemeTokens,
+  isDarkTheme,
+  themeStyleString,
+  type StudioTheme,
+  type StudioProject,
+  type Screen,
+  type ScreenNav,
+  type Block,
+  type BlockKind,
+  type BlockConfig,
+  type GridConfig,
+  type GridEditing,
+  type GridDensity,
+  type GridAlign,
+  type PagerPosition,
+  type GridColumnConfig,
+  type ChartConfig,
+  type KpiConfig,
+  type KpiFormat,
+  type DashboardConfig,
+  type MasterDetailConfig,
+  type LookupConfig,
+  type Reduce,
+  type DataSourceKind,
+  type EntityDataSource,
+  type MemorySource,
+  type RestSource,
+  type SqlSource,
+  type SupabaseSource,
+  type RestMethod,
+  type ParamLocation,
+  type ParamType,
+  type RequestParam,
+  type SqlDialectKind,
+  type ProjectTheme,
+  type ShellConfig,
+  type ShellStyle,
+  type ScreenTemplate,
+  type PaletteItem,
+  type ProjectIssue,
+  type GeneratedFile,
+} from './studio'
+export {
+  buildConnectionString,
+  parseConnectionString,
+  redactConnectionString,
+  isFileDialect,
+  DRIVER_PACKAGE,
+  DEFAULT_PORT,
+  countTableRows,
+  probeConnection,
+  type SqlConnectionParts,
+  type TableRowCount,
+  type SqlDialectName,
+} from './studio'
+
+export {
+  buildDisplayRows,
+  isDetailRow,
+  toggleExpanded,
+  type DetailRow,
+} from './master-detail'
+export { default as SvGridMasterDetail } from './SvGridMasterDetail.svelte'
+
 export { default as SvPivotDesigner } from './SvPivotDesigner.svelte'
 export {
   ALL_AGGREGATORS,
@@ -99,4 +372,13 @@ export {
   aiClassify,
   type AIClassifyOptions,
   type AIClassifyResult,
+  // Natural-language export
+  aiExport,
+  type AIExportOptions,
+  type AIExportPlan,
+  // Anomaly detection
+  aiFindAnomalies,
+  type AIAnomaly,
+  type AIAnomalyOptions,
+  type AIAnomalyResult,
 } from './ai'

package/src/install.ts

@@ -1,114 +1,134 @@
-import type { RowData, TableFeatures, SvGridApi } from '@svgrid/grid'
-import { exportGrid, type ExportOptions } from './export'
-import { printGrid, type PrintOptions } from './print'
-import { importData, type ImportOptions, type ImportResult } from './import'
-import { isLicenseKeySet } from './license'
-import { emitUnlicensedNudge } from './watermark'
-import {
-  aiFilter, aiSmartFill, aiSummarize, aiClassify,
-  type AIFilterOptions, type AIFilterResult,
-  type AISmartFillOptions, type AISmartFillResult,
-  type AISummarizeOptions, type AISummary,
-  type AIClassifyOptions, type AIClassifyResult,
-} from './ai'
-import {
-  createPivotModel,
-  type PivotConfig,
-  type PivotResult,
-} from './pivot'
-
-export type EnterpriseAIApi<TData extends RowData> = {
-  /** Natural-language -> filter + sort plan (and optionally apply it). */
-  filter(query: string, opts?: AIFilterOptions): Promise<AIFilterResult>
-  /** Propose values for empty cells based on a few worked examples. */
-  smartFill<TValue = unknown>(opts: AISmartFillOptions): Promise<AISmartFillResult<TValue>>
-  /** One-paragraph + bullets summary of a row, selection, group, or the whole view. */
-  summarize(opts: AISummarizeOptions): Promise<AISummary>
-  /** Classify free-text cells into one of a known set of labels. */
-  classify(opts: AIClassifyOptions): Promise<AIClassifyResult>
-  // TData is referenced so the type stays bound to the row shape even
-  // though the helpers all read through `api.getData()`. Lets callers
-  // get correct inference downstream without explicit generics.
-  readonly _rowType?: TData
-}
-
-export type EnterprisePivotApi<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = {
-  /**
-   * Build a pivot row/column model from the grid's current data. Returns
-   * `{ rows, columns }` you can feed to a separate `<SvGrid>` instance
-   * (the typical pattern - the source grid stays unmodified). Pure: no
-   * mutation, no DOM access.
-   */
-  build(config: PivotConfig<TData>): PivotResult<TFeatures>
-  /**
-   * Build a pivot from an arbitrary array (not necessarily the grid's
-   * data). Useful for previewing a designer's config against a sample
-   * before committing.
-   */
-  buildFrom<TIn extends RowData>(
-    data: ReadonlyArray<TIn>,
-    config: PivotConfig<TIn>,
-  ): PivotResult<TFeatures>
-}
-
-export type EnterpriseGridApi<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> = SvGridApi<TFeatures, TData> & {
-  /** Export the current visible rows to the chosen format. */
-  exportData(opts: ExportOptions<TData>): Promise<void>
-  /** Open a printable view of the current visible rows in a new window. */
-  print(opts?: PrintOptions<TData>): Promise<void>
-  /** Read an Excel / CSV / TSV / JSON file (or inline text) into typed
-   *  rows. Caller decides whether to commit into the grid or preview
-   *  the parsed result first via the returned `ImportResult`. */
-  importData(opts: ImportOptions<TData>): Promise<ImportResult<TData>>
-  /** AI helpers (Pro). All calls route through a consumer-registered
-   *  AIProvider via setAIProvider(); no model client is bundled. */
-  ai: EnterpriseAIApi<TData>
-  /** Pivot table builder (Pro). Pure - returns `{ rows, columns }` you
-   *  hand to a separate `<SvGrid>` instance. */
-  pivot: EnterprisePivotApi<TFeatures, TData>
-}
-
-/**
- * Augment a SvGridApi instance with Pro methods (`exportData`, `print`,
- * `ai.*`). Mutates and returns the same object so existing references
- * keep working.
- *
- * If no license key has been set, the Pro methods still function but the
- * grid shows a small "unlicensed" watermark linking to jqwidgets.com and
- * the console emits a one-time nudge. Revoked or malformed keys throw on
- * first call.
- */
-export function installEnterprise<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(api: SvGridApi<TFeatures, TData>): EnterpriseGridApi<TFeatures, TData> {
-  const pro = api as EnterpriseGridApi<TFeatures, TData>
-  pro.exportData = (opts) => exportGrid(pro, opts)
-  pro.print = (opts) => printGrid(pro, opts)
-  pro.importData = (opts) => importData(pro, opts)
-  pro.ai = {
-    filter: (query, opts) => aiFilter(pro, query, opts),
-    smartFill: (opts) => aiSmartFill(pro, opts),
-    summarize: (opts) => aiSummarize(pro, opts),
-    classify: (opts) => aiClassify(pro, opts),
-  }
-  pro.pivot = {
-    build: (config) =>
-      createPivotModel<TFeatures, TData>(pro.getData(), config),
-    buildFrom: <TIn extends RowData>(data: ReadonlyArray<TIn>, config: PivotConfig<TIn>) =>
-      // PivotConfig is variance-strict in TIn; the runtime call only needs
-      // the row shape to match config.rows / config.cols field names, which
-      // the caller-side generic enforces.
-      createPivotModel<TFeatures, TIn>(data, config),
-  }
-  // Surface the soft-gate state at install time so the watermark appears
-  // alongside the grid, not just after the user clicks Export.
-  if (!isLicenseKeySet()) emitUnlicensedNudge()
-  return pro
-}
+import type { RowData, TableFeatures, SvGridApi } from '@svgrid/grid'
+import {
+  exportGrid,
+  copyExportToClipboard,
+  type ExportOptions,
+  type ExportResult,
+  type ClipboardExportOptions,
+} from './export'
+import { printGrid, type PrintOptions } from './print'
+import { importData, type ImportOptions, type ImportResult } from './import'
+import { isLicenseKeySet } from './license'
+import { emitUnlicensedNudge } from './watermark'
+import {
+  aiFilter, aiSmartFill, aiSummarize, aiClassify, aiExport, aiFindAnomalies,
+  type AIFilterOptions, type AIFilterResult,
+  type AISmartFillOptions, type AISmartFillResult,
+  type AISummarizeOptions, type AISummary,
+  type AIClassifyOptions, type AIClassifyResult,
+  type AIExportOptions, type AIExportPlan,
+  type AIAnomalyOptions, type AIAnomalyResult,
+} from './ai'
+import {
+  createPivotModel,
+  type PivotConfig,
+  type PivotResult,
+} from './pivot'
+
+export type EnterpriseAIApi<TData extends RowData> = {
+  /** Natural-language -> filter + sort plan (and optionally apply it). */
+  filter(query: string, opts?: AIFilterOptions): Promise<AIFilterResult>
+  /** Propose values for empty cells based on a few worked examples. */
+  smartFill<TValue = unknown>(opts: AISmartFillOptions): Promise<AISmartFillResult<TValue>>
+  /** One-paragraph + bullets summary of a row, selection, group, or the whole view. */
+  summarize(opts: AISummarizeOptions): Promise<AISummary>
+  /** Classify free-text cells into one of a known set of labels. */
+  classify(opts: AIClassifyOptions): Promise<AIClassifyResult>
+  /** Natural-language export: "export EU orders from Q2 as a grouped PDF". */
+  export(query: string, opts?: AIExportOptions): Promise<AIExportPlan>
+  /** Scan a slice for anomalies / outliers, returning a structured list. */
+  findAnomalies(opts?: AIAnomalyOptions): Promise<AIAnomalyResult>
+  // TData is referenced so the type stays bound to the row shape even
+  // though the helpers all read through `api.getData()`. Lets callers
+  // get correct inference downstream without explicit generics.
+  readonly _rowType?: TData
+}
+
+export type EnterprisePivotApi<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = {
+  /**
+   * Build a pivot row/column model from the grid's current data. Returns
+   * `{ rows, columns }` you can feed to a separate `<SvGrid>` instance
+   * (the typical pattern - the source grid stays unmodified). Pure: no
+   * mutation, no DOM access.
+   */
+  build(config: PivotConfig<TData>): PivotResult<TFeatures>
+  /**
+   * Build a pivot from an arbitrary array (not necessarily the grid's
+   * data). Useful for previewing a designer's config against a sample
+   * before committing.
+   */
+  buildFrom<TIn extends RowData>(
+    data: ReadonlyArray<TIn>,
+    config: PivotConfig<TIn>,
+  ): PivotResult<TFeatures>
+}
+
+export type EnterpriseGridApi<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> = SvGridApi<TFeatures, TData> & {
+  /** Export the current visible rows to the chosen format. Returns the built
+   *  file ({@link ExportResult}) for the dependency-free paths (undefined for
+   *  the vendored-writer xlsx paths, which download directly). */
+  exportData(opts: ExportOptions<TData>): Promise<ExportResult | undefined>
+  /** Copy the grid (view / selection / all) to the clipboard in a native text
+   *  format (default `tsv`, pastes into Excel / Sheets as columns). */
+  copyExport(opts?: ClipboardExportOptions<TData>): Promise<void>
+  /** Open a printable view of the current visible rows in a new window. */
+  print(opts?: PrintOptions<TData>): Promise<void>
+  /** Read an Excel / CSV / TSV / JSON file (or inline text) into typed
+   *  rows. Caller decides whether to commit into the grid or preview
+   *  the parsed result first via the returned `ImportResult`. */
+  importData(opts: ImportOptions<TData>): Promise<ImportResult<TData>>
+  /** AI helpers (Pro). All calls route through a consumer-registered
+   *  AIProvider via setAIProvider(); no model client is bundled. */
+  ai: EnterpriseAIApi<TData>
+  /** Pivot table builder (Pro). Pure - returns `{ rows, columns }` you
+   *  hand to a separate `<SvGrid>` instance. */
+  pivot: EnterprisePivotApi<TFeatures, TData>
+}
+
+/**
+ * Augment a SvGridApi instance with Pro methods (`exportData`, `print`,
+ * `ai.*`). Mutates and returns the same object so existing references
+ * keep working.
+ *
+ * If no license key has been set, the Pro methods still function but the
+ * grid shows a small "unlicensed" watermark linking to jqwidgets.com and
+ * the console emits a one-time nudge. Revoked or malformed keys throw on
+ * first call.
+ */
+export function installEnterprise<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(api: SvGridApi<TFeatures, TData>): EnterpriseGridApi<TFeatures, TData> {
+  const pro = api as EnterpriseGridApi<TFeatures, TData>
+  pro.exportData = (opts) => exportGrid(pro, opts)
+  pro.copyExport = (opts) => copyExportToClipboard(pro, opts)
+  pro.print = (opts) => printGrid(pro, opts)
+  pro.importData = (opts) => importData(pro, opts)
+  pro.ai = {
+    filter: (query, opts) => aiFilter(pro, query, opts),
+    smartFill: (opts) => aiSmartFill(pro, opts),
+    summarize: (opts) => aiSummarize(pro, opts),
+    classify: (opts) => aiClassify(pro, opts),
+    export: (query, opts) => aiExport(pro, query, opts),
+    findAnomalies: (opts) => aiFindAnomalies(pro, opts),
+  }
+  pro.pivot = {
+    build: (config) =>
+      createPivotModel<TFeatures, TData>(pro.getData(), config),
+    buildFrom: <TIn extends RowData>(data: ReadonlyArray<TIn>, config: PivotConfig<TIn>) =>
+      // PivotConfig is variance-strict in TIn; the runtime call only needs
+      // the row shape to match config.rows / config.cols field names, which
+      // the caller-side generic enforces.
+      createPivotModel<TFeatures, TIn>(data, config),
+  }
+  // Surface the soft-gate state at install time so the watermark appears
+  // alongside the grid, not just after the user clicks Export.
+  if (!isLicenseKeySet()) emitUnlicensedNudge()
+  return pro
+}

package/src/license-core.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, it } from 'vitest'
+import { checkLicenseKey } from './license-core'
+
+describe('checkLicenseKey', () => {
+  it('unset for null / empty', () => {
+    expect(checkLicenseKey(null)).toEqual({ status: 'unset', valid: false })
+    expect(checkLicenseKey(undefined)).toEqual({ status: 'unset', valid: false })
+    expect(checkLicenseKey('')).toEqual({ status: 'unset', valid: false })
+  })
+
+  it('invalid for a wrong prefix', () => {
+    expect(checkLicenseKey('nope-123')).toEqual({ status: 'invalid', valid: false })
+  })
+
+  it('dev / eval keys are valid but flagged', () => {
+    expect(checkLicenseKey('SVENTERPRISE-DEV-abc')).toEqual({ status: 'dev', valid: true })
+    expect(checkLicenseKey('SVENTERPRISE-EVAL-acme-2026')).toEqual({ status: 'eval', valid: true })
+  })
+
+  it('any other SVENTERPRISE- key is licensed', () => {
+    expect(checkLicenseKey('SVENTERPRISE-ACME-2026-9XYZ')).toEqual({ status: 'licensed', valid: true })
+  })
+})

package/src/license-core.ts

@@ -0,0 +1,35 @@
+// Pure license classification - no DOM, no Svelte, no module state. Shared by
+// the browser gate (license.ts, via setLicenseKey) AND the Node/MCP generator
+// (which reads the key from the SVGRID_LICENSE_KEY env var). One definition of
+// "what a valid key is," so the two contexts can never drift.
+//
+// This is deliberately NOT crypto (see license.ts). It classifies a key string;
+// callers decide what to do with the result. The Studio is soft-gate only:
+// unlicensed use still works, it just nudges.
+import { REVOKED_KEYS } from './revoked.js'
+
+export const VALID_PREFIX = 'SVENTERPRISE-'
+
+export type LicenseStatus =
+  | 'unset' // no key provided
+  | 'invalid' // present but wrong prefix (usually a typo)
+  | 'revoked' // valid prefix but on the revoked list
+  | 'dev' // SVENTERPRISE-DEV... - works, not for production
+  | 'eval' // SVENTERPRISE-EVAL... - works, not for production
+  | 'licensed' // any other SVENTERPRISE-... - paid production
+
+export type LicenseInfo = {
+  status: LicenseStatus
+  /** True when the key permits use (dev / eval / licensed). */
+  valid: boolean
+}
+
+/** Classify a license key string. Pure and side-effect-free. */
+export function checkLicenseKey(key: string | null | undefined): LicenseInfo {
+  if (key == null || key === '') return { status: 'unset', valid: false }
+  if (!key.startsWith(VALID_PREFIX)) return { status: 'invalid', valid: false }
+  if (REVOKED_KEYS.has(key)) return { status: 'revoked', valid: false }
+  if (key.startsWith('SVENTERPRISE-DEV')) return { status: 'dev', valid: true }
+  if (key.startsWith('SVENTERPRISE-EVAL')) return { status: 'eval', valid: true }
+  return { status: 'licensed', valid: true }
+}