@fieldia/viewer 0.1.0

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@fieldia/viewer",
+  "version": "0.1.0",
+  "description": "Mount a Fieldia page in any web page: plain DOM, no framework.",
+  "license": "MIT",
+  "homepage": "https://fieldia.dev",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "module": "./src/index.mjs",
+  "types": "./src/index.d.ts",
+  "unpkg": "./bundle/fieldia.js",
+  "jsdelivr": "./bundle/fieldia.js",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./src/index.d.mts",
+        "require": "./src/index.d.ts"
+      },
+      "import": "./src/index.mjs",
+      "require": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./bundle/fieldia.js": "./bundle/fieldia.js",
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@fieldia/core": "0.1.0",
+    "@fieldia/widgets": "0.1.0",
+    "tslib": "^2.8.1"
+  },
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fieldia-dev/fieldia",
+    "directory": "libs/viewer"
+  },
+  "files": [
+    "src",
+    "bundle",
+    "README.md",
+    "LICENSE"
+  ]
+}

package/src/index.d.mts

@@ -0,0 +1 @@
+export * from './lib/viewer.mjs';

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/viewer';

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/viewer"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/viewer/src/index.ts"],"names":[],"mappings":";;;AAAA,uDAA6B"}

package/src/index.mjs

@@ -0,0 +1,2 @@
+export * from './lib/viewer.mjs';
+//# sourceMappingURL=index.mjs.map

package/src/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../../libs/viewer/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/src/lib/viewer.d.mts

@@ -0,0 +1,58 @@
+import { type Form, type FormOptions, type Page, type Locale } from '@fieldia/core';
+import { type WidgetFactory } from '@fieldia/widgets';
+export type Skin = 'underline' | 'outlined';
+/** Every word the viewer shows, so a page can be translated. `{n}`, `{total}` and `{time}` are filled in. */
+export interface ViewerLabels {
+    save: string;
+    discard: string;
+    saving: string;
+    saved: string;
+    submit: string;
+    next: string;
+    back: string;
+    stepOf: string;
+    submitted: string;
+    submitAnother: string;
+    draftFound: string;
+    restore: string;
+    discardDraft: string;
+    ok: string;
+    cancel: string;
+    loading: string;
+}
+export declare const VIEWER_LABELS: Record<Locale, ViewerLabels>;
+/** English, kept under its old name. */
+export declare const DEFAULT_LABELS: ViewerLabels;
+/** Fill a slot with the app's own content. Return a function to clean up. */
+export type SlotRenderer = (element: HTMLElement, context: {
+    form: Form;
+    name: string;
+}) => void | (() => void);
+export interface ViewerOptions extends Omit<FormOptions, 'page'> {
+    page: Page;
+    /** A form made elsewhere, to share one record between two views. */
+    form?: Form;
+    skin?: Skin;
+    /** Widgets that replace or add to the built-in ones, by `type` or `type.widget`. */
+    widgets?: Record<string, WidgetFactory>;
+    slots?: Record<string, SlotRenderer>;
+    /** The page's language: viewer labels, validation messages and widget words. Arabic runs right to left. */
+    locale?: Locale;
+    /** Labels that win over the language's defaults. */
+    labels?: Partial<ViewerLabels>;
+    dir?: 'ltr' | 'rtl';
+    /** How to ask before a button with `confirm` runs. Defaults to a small dialog. */
+    confirm?: (message: string) => Promise<boolean>;
+}
+export interface ViewerHandle {
+    readonly form: Form;
+    readonly element: HTMLElement;
+    setSkin(skin: Skin): void;
+    destroy(): void;
+}
+/**
+ * Render a page into `host` and keep it in step with its form. Plain DOM: the
+ * React, Angular and Vue bindings are thin shells around this function.
+ * Throws when the page does not validate, listing every problem.
+ */
+export declare function mountViewer(host: HTMLElement, options: ViewerOptions): ViewerHandle;

package/src/lib/viewer.d.ts

@@ -0,0 +1,58 @@
+import { type Form, type FormOptions, type Page, type Locale } from '@fieldia/core';
+import { type WidgetFactory } from '@fieldia/widgets';
+export type Skin = 'underline' | 'outlined';
+/** Every word the viewer shows, so a page can be translated. `{n}`, `{total}` and `{time}` are filled in. */
+export interface ViewerLabels {
+    save: string;
+    discard: string;
+    saving: string;
+    saved: string;
+    submit: string;
+    next: string;
+    back: string;
+    stepOf: string;
+    submitted: string;
+    submitAnother: string;
+    draftFound: string;
+    restore: string;
+    discardDraft: string;
+    ok: string;
+    cancel: string;
+    loading: string;
+}
+export declare const VIEWER_LABELS: Record<Locale, ViewerLabels>;
+/** English, kept under its old name. */
+export declare const DEFAULT_LABELS: ViewerLabels;
+/** Fill a slot with the app's own content. Return a function to clean up. */
+export type SlotRenderer = (element: HTMLElement, context: {
+    form: Form;
+    name: string;
+}) => void | (() => void);
+export interface ViewerOptions extends Omit<FormOptions, 'page'> {
+    page: Page;
+    /** A form made elsewhere, to share one record between two views. */
+    form?: Form;
+    skin?: Skin;
+    /** Widgets that replace or add to the built-in ones, by `type` or `type.widget`. */
+    widgets?: Record<string, WidgetFactory>;
+    slots?: Record<string, SlotRenderer>;
+    /** The page's language: viewer labels, validation messages and widget words. Arabic runs right to left. */
+    locale?: Locale;
+    /** Labels that win over the language's defaults. */
+    labels?: Partial<ViewerLabels>;
+    dir?: 'ltr' | 'rtl';
+    /** How to ask before a button with `confirm` runs. Defaults to a small dialog. */
+    confirm?: (message: string) => Promise<boolean>;
+}
+export interface ViewerHandle {
+    readonly form: Form;
+    readonly element: HTMLElement;
+    setSkin(skin: Skin): void;
+    destroy(): void;
+}
+/**
+ * Render a page into `host` and keep it in step with its form. Plain DOM: the
+ * React, Angular and Vue bindings are thin shells around this function.
+ * Throws when the page does not validate, listing every problem.
+ */
+export declare function mountViewer(host: HTMLElement, options: ViewerOptions): ViewerHandle;