@vit-foundation/ui 0.10.0 → 0.11.0

package/dist/edit/helpers.js

@@ -20,3 +20,24 @@ export function pageCopyEdit(page, sectionKey, locale, options) {
 export function entityEdit(entity, id, locale) {
     return (field, options) => ({ ref: { kind: 'entity', entity, id, field }, locale, ...options });
 }
+/**
+ * Property-descriptor factory for one entity's scalar fields — the panel
+ * sibling of `entityEdit`, naming the row once:
+ *
+ *   const property = entityProperty('milestones', milestone.id);
+ *   occurredOn: property('occurred_on', { type: 'date', label: 'Data' })
+ */
+export function entityProperty(entity, id) {
+    return (field, spec) => ({ ref: { kind: 'entity', entity, id, field }, ...spec });
+}
+/**
+ * A panel property over one interface-wording message — how strings that can
+ * never hold a caret (an `<option>` label, an input placeholder) still edit.
+ */
+export function chromeProperty(key, spec) {
+    return { ref: { kind: 'chrome', key }, ...spec };
+}
+/** Names one entity collection at one render site. */
+export function collectionOf(entity, scope) {
+    return scope === undefined ? { entity } : { entity, scope };
+}

package/dist/edit/index.d.ts

@@ -1,6 +1,12 @@
 export { getEditAdapter, setEditAdapter } from './context.js';
 export { default as ActionLabel } from './ActionLabel.svelte';
 export { default as Editable } from './Editable.svelte';
-export { chromeEdit, entityEdit, pageCopyEdit } from './helpers.js';
+export { default as AddSlot } from './chrome/AddSlot.svelte';
+export { default as ConfirmDialog } from './chrome/ConfirmDialog.svelte';
+export { default as EditFrame } from './chrome/EditFrame.svelte';
+export type { EditFrameSpec } from './chrome/EditFrame.svelte';
+export { default as EditPanel } from './chrome/EditPanel.svelte';
+export { default as EditPopover } from './chrome/EditPopover.svelte';
+export { chromeEdit, chromeProperty, collectionOf, entityEdit, entityProperty, pageCopyEdit } from './helpers.js';
 export { localize } from './types.js';
-export type { ContentRef, EditableEntity, EditAdapter, EditDescriptor, LocalizedText } from './types.js';
+export type { CollectionRef, ContentRef, EditableEntity, EditAdapter, EditDescriptor, EntityOp, LocalizedText, PropertyDescriptor, PropertyOption, PropertyType } from './types.js';

package/dist/edit/index.js

@@ -1,5 +1,10 @@
 export { getEditAdapter, setEditAdapter } from './context.js';
 export { default as ActionLabel } from './ActionLabel.svelte';
 export { default as Editable } from './Editable.svelte';
-export { chromeEdit, entityEdit, pageCopyEdit } from './helpers.js';
+export { default as AddSlot } from './chrome/AddSlot.svelte';
+export { default as ConfirmDialog } from './chrome/ConfirmDialog.svelte';
+export { default as EditFrame } from './chrome/EditFrame.svelte';
+export { default as EditPanel } from './chrome/EditPanel.svelte';
+export { default as EditPopover } from './chrome/EditPopover.svelte';
+export { chromeEdit, chromeProperty, collectionOf, entityEdit, entityProperty, pageCopyEdit } from './helpers.js';
 export { localize } from './types.js';

package/dist/edit/types.d.ts

@@ -51,9 +51,75 @@ export interface EditDescriptor {
     /** Accessible name for the edit control, e.g. "Títol del weekly #12". */
     label?: string;
 }
+/**
+ * The value kinds a property panel can edit. Everything in this content model
+ * serializes to a string on the wire — an ISO date, a URL, an enum member, a
+ * storage path — so there is no typed value union: the ADAPTER parses, and
+ * the host's schemas stay the sole validators.
+ */
+export type PropertyType = 'text' | 'url' | 'date' | 'select' | 'image';
+/** One choice of a `select` property. */
+export interface PropertyOption {
+    value: string;
+    label: string;
+}
+/**
+ * Identity + shape of one panel-edited property. Unlike `EditDescriptor`,
+ * `locale` is optional: dates, urls, enum members and image paths are not
+ * localized, and its absence says so to the adapter.
+ */
+export interface PropertyDescriptor {
+    ref: ContentRef;
+    /** Present only for localized text properties. */
+    locale?: Locale;
+    type: PropertyType;
+    /** Panel row label — required, the panel renders it. */
+    label: string;
+    /** Required when `type` is 'select'. */
+    options?: readonly PropertyOption[];
+    placeholder?: string;
+    /** Clearing the field saves null (linkUrl, externalUrl). */
+    nullable?: boolean;
+}
+/**
+ * Names one entity collection at one render site. `scope` disambiguates when
+ * the same entity renders in several lists (a board grid vs. a full roster).
+ */
+export interface CollectionRef {
+    entity: EditableEntity;
+    scope?: string;
+}
+/**
+ * A structural collection operation. Deliberately WITHOUT an `update` verb:
+ * field values always travel through `save`/`saveProperty` — one save path
+ * per value — and ops stay purely about existence and order.
+ */
+export type EntityOp = {
+    kind: 'create';
+    collection: CollectionRef;
+    anchor?: {
+        id: string | number;
+        placement: 'before' | 'after';
+    };
+} | {
+    kind: 'remove';
+    collection: CollectionRef;
+    id: string | number;
+} | {
+    kind: 'reorder';
+    collection: CollectionRef;
+    id: string | number;
+    anchor: {
+        id: string | number;
+        placement: 'before' | 'after';
+    };
+};
 /**
  * What a consuming app plugs in to make the components writable. The package
- * never talks to a database: `save` is the whole persistence contract.
+ * never talks to a database: `save` is the whole persistence contract for
+ * inline text, and the three OPTIONAL members below are the property-panel
+ * and structural halves — leave them off and the components render no panel
+ * or collection affordance at all, byte-identical to a read-only build.
  *
  * Implementations must:
  * - back `isEditing` with reactive state (`$state`) — it gates every edit
@@ -68,4 +134,18 @@ export interface EditDescriptor {
 export interface EditAdapter {
     readonly isEditing: boolean;
     save(descriptor: EditDescriptor, value: string): Promise<void>;
+    /**
+     * Panel property save. The value stays a string on the wire (ISO date,
+     * url, enum member, image path); `null` clears a `nullable` property.
+     */
+    saveProperty?(descriptor: PropertyDescriptor, value: string | null): Promise<void>;
+    /**
+     * Structural collection ops. `create` may resolve the new row's id so the
+     * UI can point at it after the host's refresh.
+     */
+    applyOp?(op: EntityOp): Promise<{
+        id?: string | number;
+    } | void>;
+    /** Image upload; resolves to the stored path an `image` property saves. */
+    uploadImage?(descriptor: PropertyDescriptor, file: File): Promise<string>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vit-foundation/ui",
-	"version": "0.10.0",
+	"version": "0.11.0",
 	"scripts": {
 		"dev": "vite dev",
 		"build": "vite build && npm run prepack",