@svadmin/surface 0.8.19 → 0.9.0

package/dist/workflows/types.d.ts

@@ -0,0 +1,103 @@
+import type { TSchema } from '@sinclair/typebox';
+import type { JsonObject, JsonValue, SurfaceCatalog, SurfacePolicy, SurfaceSpec } from '../types.js';
+/** Identity comes from authenticated server middleware, never from model JSON. */
+export interface SurfaceWorkflowContext {
+    readonly tenantId: string;
+    readonly actorId: string;
+}
+export type SurfaceApprovalPolicy = 'confirm' | 'four-eyes';
+export type SurfaceActionPhase = 'propose' | 'approve' | 'reject' | 'execute' | 'read';
+export interface SurfaceActionDescriptor {
+    readonly id: string;
+    readonly version: string;
+    readonly label: string;
+    readonly inputSchema: TSchema;
+    readonly approval: SurfaceApprovalPolicy;
+}
+export interface SurfaceRegisteredAction extends SurfaceActionDescriptor {
+    readonly validateInput: (value: unknown) => boolean;
+    readonly authorize: (request: {
+        context: SurfaceWorkflowContext;
+        phase: SurfaceActionPhase;
+        args: JsonObject;
+        requesterId: string;
+    }) => boolean | Promise<boolean>;
+    /** Reauthorize in the business backend too. Forward idempotencyKey to it.
+     * The workflow cannot promise exactly-once effects across an external service.
+     */
+    readonly execute: (request: {
+        context: SurfaceWorkflowContext;
+        args: JsonObject;
+        idempotencyKey: string;
+    }) => JsonValue | Promise<JsonValue>;
+}
+export interface SurfaceStoredRevision {
+    readonly tenantId: string;
+    readonly surfaceId: string;
+    readonly revision: number;
+    readonly spec: SurfaceSpec;
+    readonly actorId: string;
+    readonly createdAt: number;
+}
+export type SurfaceActionStatus = 'pending' | 'approved' | 'executing' | 'succeeded' | 'indeterminate' | 'rejected';
+export interface SurfaceActionProposal {
+    readonly id: string;
+    readonly tenantId: string;
+    readonly requesterId: string;
+    readonly requestKey: string;
+    readonly surfaceId: string;
+    readonly surfaceRevision: number;
+    readonly actionId: string;
+    readonly actionVersion: string;
+    readonly actionLabel: string;
+    readonly args: JsonObject;
+    readonly digest: string;
+    readonly approval: SurfaceApprovalPolicy;
+    readonly status: SurfaceActionStatus;
+    readonly createdAt: number;
+    readonly expiresAt: number;
+    readonly approvedBy?: string;
+    readonly result?: JsonValue;
+}
+export interface SurfaceWorkflowAuditEvent {
+    readonly sequence?: number;
+    readonly tenantId: string;
+    readonly surfaceId: string;
+    readonly proposalId?: string;
+    readonly actorId: string;
+    readonly event: string;
+    readonly at: number;
+    readonly metadata: JsonObject;
+}
+export interface SurfaceWorkflowTransaction {
+    getRevision(tenantId: string, surfaceId: string, revision?: number): SurfaceStoredRevision | undefined;
+    putRevision(revision: SurfaceStoredRevision): void;
+    getProposal(tenantId: string, id: string): SurfaceActionProposal | undefined;
+    findRequest(tenantId: string, requesterId: string, requestKey: string): SurfaceActionProposal | undefined;
+    putProposal(proposal: SurfaceActionProposal): void;
+    audit(event: SurfaceWorkflowAuditEvent): void;
+}
+export interface SurfaceWorkflowStore extends SurfaceWorkflowTransaction {
+    /** Synchronous atomic transaction. Must roll back on exceptions; no await. */
+    transaction<T>(work: (tx: SurfaceWorkflowTransaction) => T): T;
+    listAudit(tenantId: string, surfaceId: string, after: number, limit: number): readonly SurfaceWorkflowAuditEvent[];
+}
+export interface SurfaceWorkflowAccess {
+    readonly catalog: SurfaceCatalog;
+    readonly policy: SurfacePolicy;
+}
+export interface SurfaceWorkflowOptions {
+    readonly store: SurfaceWorkflowStore;
+    readonly actions: readonly SurfaceRegisteredAction[];
+    readonly authorizeSurface: (request: {
+        context: SurfaceWorkflowContext;
+        operation: 'read' | 'save' | 'audit';
+        surfaceId: string;
+    }) => SurfaceWorkflowAccess | null | Promise<SurfaceWorkflowAccess | null>;
+    readonly now?: () => number;
+    readonly proposalLifetimeMs?: number;
+}
+export declare class SurfaceWorkflowError extends Error {
+    readonly code: 'denied' | 'invalid_input' | 'conflict' | 'not_found' | 'expired' | 'invalid_state' | 'indeterminate';
+    constructor(code: 'denied' | 'invalid_input' | 'conflict' | 'not_found' | 'expired' | 'invalid_state' | 'indeterminate', message?: string);
+}

package/dist/workflows/types.js

@@ -0,0 +1,8 @@
+export class SurfaceWorkflowError extends Error {
+    code;
+    constructor(code, message = code) {
+        super(message);
+        this.code = code;
+        this.name = 'SurfaceWorkflowError';
+    }
+}

package/dist/workflows.d.ts

@@ -0,0 +1,5 @@
+export { createInteractiveSurfaceDefinitions, withSurfaceAppearance, surfaceAppearanceSchema } from './workflows/catalog.js';
+export { createSurfaceFormController } from './workflows/client.js';
+export type { SurfaceWorkflowTransport, SurfaceWorkflowClientScope, SurfaceWorkflowClientState } from './workflows/client.js';
+export type { SurfaceActionDescriptor, SurfaceActionProposal, SurfaceApprovalPolicy } from './workflows/types.js';
+export { defaultSurfaceDefinitions, styledSurfaceDefinitions } from './builtin-definitions.js';

package/dist/workflows.js

@@ -0,0 +1,4 @@
+// DOM-free contracts: no server implementation or Svelte components in this entry.
+export { createInteractiveSurfaceDefinitions, withSurfaceAppearance, surfaceAppearanceSchema } from './workflows/catalog.js';
+export { createSurfaceFormController } from './workflows/client.js';
+export { defaultSurfaceDefinitions, styledSurfaceDefinitions } from './builtin-definitions.js';

package/package.json

@@ -1,15 +1,21 @@
 {
   "name": "@svadmin/surface",
-  "version": "0.8.19",
+  "version": "0.9.0",
   "description": "Validated declarative surfaces for svadmin dashboards",
   "type": "module",
-  "sideEffects": false,
+  "sideEffects": [
+    "./dist/styles.css",
+    "./dist/styles/editor.css"
+  ],
   "files": [
     "dist",
     "README.md",
     "compatibility.json",
     "!dist/**/*.test.*",
-    "!dist/**/*.spec.*"
+    "!dist/**/*.test-*",
+    "!dist/**/*.spec.*",
+    "!dist/**/*.spec-*",
+    "STYLING.md"
   ],
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,28 +28,66 @@
       "types": "./dist/svelte.d.ts",
       "svelte": "./dist/svelte.js",
       "default": "./dist/svelte.js"
+    },
+    "./styles.css": {
+      "style": "./dist/styles.css",
+      "default": "./dist/styles.css"
+    },
+    "./editor.css": {
+      "style": "./dist/styles/editor.css",
+      "default": "./dist/styles/editor.css"
+    },
+    "./svar": {
+      "types": "./dist/svar.d.ts",
+      "svelte": "./dist/svar.js",
+      "default": "./dist/svar.js"
+    },
+    "./workflows": {
+      "types": "./dist/workflows.d.ts",
+      "default": "./dist/workflows.js"
+    },
+    "./interactive": {
+      "types": "./dist/interactive.d.ts",
+      "svelte": "./dist/interactive.js",
+      "default": "./dist/interactive.js"
+    },
+    "./openui": {
+      "types": "./dist/openui.d.ts",
+      "default": "./dist/openui.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "node": "./dist/server.js"
+    },
+    "./server/sqlite": {
+      "types": "./dist/server-sqlite.d.ts",
+      "node": "./dist/server-sqlite.js"
     }
   },
   "peerDependencies": {
-    "@svadmin/core": ">=0.34.2 <0.53.0",
-    "@svadmin/ui": ">=0.40.6 <0.73.0",
+    "@svadmin/core": ">=0.34.2 <0.54.0",
+    "@svadmin/ui": ">=0.40.6 <0.74.0",
     "svelte": "^5.56.8"
   },
   "dependencies": {
     "@sinclair/typebox": "^0.34.52"
   },
   "devDependencies": {
+    "@pandacss/dev": "1.12.1",
     "@sveltejs/vite-plugin-svelte": "^7.3.0",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/svelte": "^5.4.2",
     "@testing-library/user-event": "^14.6.6",
     "happy-dom": "^20.11.12",
+    "postcss": "^8.5.26",
     "vitest": "^4.1.11"
   },
   "scripts": {
-    "build": "node ../../node_modules/@sveltejs/package/svelte-package.js -i src -o dist",
-    "check": "svelte-check --tsgo-experimental-api --tsconfig ./tsconfig.json --threshold error",
-    "test": "vitest run --config ./vitest.config.ts"
+    "build": "node scripts/build-editor-styles.mjs && node scripts/prepare-design.mjs && node ../../node_modules/@sveltejs/package/svelte-package.js -i src -o dist",
+    "check": "svelte-check --tsgo-experimental-api --tsconfig ./tsconfig.check.json --threshold error",
+    "test": "vitest run --config ./vitest.config.ts",
+    "styles:build": "node scripts/build-editor-styles.mjs",
+    "styles:check": "node scripts/build-editor-styles.mjs --check"
   },
   "license": "MIT",
   "publishConfig": {