@revenexx/studio-shared 0.3.2 → 0.4.0

package/dist/runtime/types/dashboard.d.ts

@@ -0,0 +1,95 @@
+/**
+ * The dashboard contract, shared by every surface that has one (PE-618).
+ *
+ * It started in the cockpit's `shared/dashboards/types.ts`, where the home
+ * screen and its Nitro routes were the only readers. The Commerce Studio now
+ * renders the same dashboards from a published module that cannot see the
+ * host's `#shared` alias — so the shape moves here, and the cockpit's file
+ * re-exports it. One declaration, two consumers, no drift between the rows
+ * Nitro writes and the layout the grid reads.
+ *
+ * The layout vocabulary is deliberately identical to `shared/analytics/types`:
+ * two dashboard surfaces in one product must not grow two models of a grid.
+ */
+/** Grid placement on a twelve-column grid. `i` is the widget instance id. */
+export interface DashboardLayoutItem {
+    i: string;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+/** One placed widget. `type` resolves against the surface's widget registry. */
+export interface DashboardWidget {
+    id: string;
+    type: string;
+    /** Operator-set title; falls back to the registry entry's title when unset. */
+    title?: string;
+    config?: Record<string, unknown>;
+}
+/**
+ * Which surface a dashboard belongs to.
+ *
+ * A dashboard is made of the widgets available where it is edited, so it is
+ * only meaningful on its own surface: a Commerce dashboard listed in the
+ * cockpit's home switcher would open as a grid of widgets that screen cannot
+ * render. Stored on the row rather than encoded in the slug, because a
+ * convention nothing enforces is one typo away from the wrong surface.
+ */
+export type DashboardScope = 'home' | 'commerce';
+export declare const DASHBOARD_SCOPES: readonly DashboardScope[];
+/** `private` — owner only. `tenant` — anyone in the tenant may see it. */
+export type DashboardVisibility = 'private' | 'tenant';
+/**
+ * What a tenant-wide share grants. `view` is the default and the safe one; a
+ * dashboard several people can change becomes whatever the last one left
+ * behind, so `edit` is a decision the owner makes explicitly.
+ */
+export type DashboardTenantPermission = 'view' | 'edit';
+export interface Dashboard {
+    id: string;
+    slug: string;
+    name: string;
+    description?: string | null;
+    icon?: string | null;
+    /** The surface this dashboard belongs to. Older rows read as `home`. */
+    scope: DashboardScope;
+    ownerUserId: string;
+    /** Display name captured when the dashboard was created. */
+    ownerName?: string | null;
+    /** Who last saved it, and under what name at that moment. */
+    updatedByUserId?: string | null;
+    updatedByName?: string | null;
+    visibility: DashboardVisibility;
+    tenantPermission: DashboardTenantPermission;
+    layout: DashboardLayoutItem[];
+    widgets: DashboardWidget[];
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+    /**
+     * Server-derived, per caller. True for the owner, and for anyone in the
+     * tenant when the dashboard is shared with `edit`.
+     */
+    canEdit: boolean;
+    /** Server-derived: this caller created it. Only the owner may share or delete. */
+    isOwner: boolean;
+    /** Server-derived: true when this is the caller's landing dashboard. */
+    isDefault: boolean;
+}
+export interface DashboardListResponse {
+    dashboards: Dashboard[];
+    defaultDashboardId: string | null;
+}
+export interface DashboardWritePayload {
+    name?: string;
+    description?: string | null;
+    icon?: string | null;
+    visibility?: DashboardVisibility;
+    tenantPermission?: DashboardTenantPermission;
+    layout?: DashboardLayoutItem[];
+    widgets?: DashboardWidget[];
+    /** Required on update — a stale value is answered with 409, not an overwrite. */
+    version?: number;
+}
+export declare const MAX_DASHBOARD_COLUMNS = 12;

package/dist/runtime/types/dashboard.js

@@ -0,0 +1,2 @@
+export const DASHBOARD_SCOPES = ["home", "commerce"];
+export const MAX_DASHBOARD_COLUMNS = 12;

package/dist/types.d.mts

@@ -16,14 +16,26 @@ export { type TalkbackChannel, type TalkbackChannelOptions, type TalkbackMaybeRe
 
 export { type MediaLibraryClient } from '../dist/runtime/composables/useMediaLibrary.js'
 
+export { type SavedViewsStore, type StoredSavedView } from '../dist/runtime/composables/useSavedViews.js'
+
+export { type WidgetCategory, type WidgetCategoryGroup, type WidgetConfigField, type WidgetDefinition, type WidgetPreviewShape, type WidgetRegistry } from '../dist/runtime/lib/widgetRegistry.js'
+
+export { type StickyListView } from '../dist/runtime/composables/useStickyListView.js'
+
+export { type DetailSheetBinding } from '../dist/runtime/composables/useDetailSheet.js'
+
 export { type FloatingPanelDock, type FloatingPanelMode, type FloatingPanelOptions } from '../dist/runtime/composables/useFloatingPanel.js'
 
 export { type IsoOption } from '../dist/runtime/lib/isoLists.js'
 
 export { type Translate, type TranslateNamed, type Translator } from '../dist/runtime/lib/i18nBridge.js'
 
+export { type FieldSpan, type FormContextRow, type SectionOffset, type SpanSource } from '../dist/runtime/lib/formLayout.js'
+
 export { default } from './module.mjs'
 
 export * from '../dist/runtime/components/DataTable/types.js'
 
 export * from '../dist/runtime/types/storage.js'
+
+export * from '../dist/runtime/types/dashboard.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revenexx/studio-shared",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "type": "module",
   "description": "Shared revenexx Studio shell primitives (PageHeader, SidebarNav, StateCard, DataTable, …) + the platform provider contract (usePlatformAuth/usePlatformTenant). A Nuxt module — add it to `modules`.",
   "main": "./dist/module.mjs",
@@ -25,7 +25,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@nuxt/kit": "^4.0.0"
+    "@nuxt/kit": "^4.0.0",
+    "grid-layout-plus": "^1.1.1"
   },
   "peerDependencies": {
     "@revenexx/studio": "^0.2.3",