@api-client/ui 0.5.58 → 0.6.0

package/build/src/modeling/internals/DomainEntityEditor.d.ts

@@ -0,0 +1,168 @@
+import { nothing, type PropertyValues, type TemplateResult } from 'lit';
+import { DomainEntity } from '@api-client/core/modeling/DomainEntity.js';
+import type { DomainAssociation } from '@api-client/core/modeling/DomainAssociation.js';
+import type { DomainProperty } from '@api-client/core/modeling/DomainProperty.js';
+import { ModelingElement } from './ModelingElement.js';
+import { type EntitySemantic } from '@api-client/core/modeling/Semantics.js';
+import type { UiListSelection } from '../../md/list/ui-list.js';
+/**
+ * Dispatched when a field (either a `DomainProperty` or a `DomainAssociation`) within the entity is selected.
+ *
+ * @event DomainEntityEditor#select
+ * @type {CustomEvent}
+ * @property {object} detail - The event details.
+ * @property {string} detail.key - The key of the selected field.
+ * @property {string} detail.kind - The kind of the selected field (e.g., `DomainPropertyKind`,
+ * `DomainAssociationKind`).
+ */
+/**
+ * Dispatched when the user wants to navigate to a parent entity.
+ *
+ * @event DomainEntityEditor#openentity
+ * @type {CustomEvent}
+ * @property {object} detail - The event details.
+ * @property {string} detail.key - The key of the parent entity to navigate to.
+ * @property {string} detail.kind - The kind of the parent entity. It will always be `DomainEntityKind`.
+ */
+/**
+ * An element that provides an editor interface for a domain entity.
+ * @fires DomainEntityEditor#select - A custom event with the `key` and `type` when a property was selected.
+ * @fires DomainEntityEditor#openentity - A custom event with the `key` and `type` when a property was selected.
+ */
+export default class DomainEntityEditor extends ModelingElement {
+    protected domainElement: DomainEntity | undefined;
+    /**
+     * The currently selected tab in the editor.
+     * @attribute
+     */
+    accessor contentTab: 'design' | 'preview';
+    /**
+     * The key of the currently selected property.
+     * @attribute
+     */
+    accessor selectedProperty: string | undefined;
+    /**
+     * The mime type of the preview to render.
+     * @attribute
+     */
+    accessor mime: string;
+    /**
+     * When set, the preview tab will generate example (mock) data.
+     * By default it only render values as defined in the schema.
+     * @attribute
+     */
+    accessor mockValues: boolean;
+    /**
+     * The generated schema preview.
+     */
+    accessor schemaPreview: string | undefined;
+    protected willUpdate(cp: PropertyValues<this>): void;
+    protected computeEntity(): void;
+    handleMetaChange(e: Event): void;
+    handleContentTabChange(e: Event): void;
+    /**
+     * Generates the example data for the preview tab.
+     */
+    generateExample(): void;
+    notifyChange(): void;
+    /**
+     * A handler for the mime type change event.
+     */
+    handleMimeChange(e: Event): void;
+    /**
+     * A handler for the field item click to select a field.
+     * @param e The click event.
+     */
+    handleFieldListSelect(e: CustomEvent<UiListSelection>): void;
+    /**
+     * Selects a field in the editor and dispatches a custom event with the key and kind of the field.
+     * @param key The key of the field to select.
+     * @param kind The kind of the field to select.
+     */
+    select(key: string, kind: string): void;
+    addProperty(name?: string): void;
+    addAssociation(name?: string): void;
+    handleFieldMenuSelect(e: CustomEvent<{
+        item: HTMLElement;
+    }>): void;
+    /**
+     * Opens the auto fields selection dialog
+     */
+    openAutoFieldsDialog(): void;
+    protected handleChooseParent(): Promise<void>;
+    protected handleDeleteParent(e: Event): void;
+    protected handleNavigateParent(e: Event): void;
+    addParentEntity(key: string, domain?: string): void;
+    protected handleInheritanceDragEnter(e: DragEvent): void;
+    protected handleInheritanceDragOver(e: DragEvent): void;
+    protected handleInheritanceDragLeave(e: DragEvent): void;
+    protected handleInheritanceDrop(e: DragEvent): void;
+    protected handleTaxonomyChange(e: Event): void;
+    protected handleTaxonomyClear(e: Event): void;
+    protected handleFieldContextMenuSelect(e: CustomEvent<{
+        item: HTMLElement;
+    }>): void;
+    /**
+     * Duplicates a field (property or association).
+     * Creates a copy with the same properties but a new unique name.
+     * @param key The key of the field to duplicate.
+     * @param kind The kind of the field to duplicate.
+     */
+    duplicateField(key: string, kind: string): void;
+    /**
+     * Duplicates a property field.
+     * @param key The key of the property to duplicate.
+     */
+    protected duplicateProperty(key: string): void;
+    /**
+     * Duplicates an association field.
+     * @param key The key of the association to duplicate.
+     */
+    private duplicateAssociation;
+    /**
+     * Generates a unique name by appending a number to the base name.
+     * @param baseName The base name to make unique.
+     * @returns A unique name within the current entity.
+     */
+    protected generateUniqueName(baseName: string): string;
+    deleteField(key: string, kind: string): void;
+    openEntity(key: string): void;
+    /**
+     * Converts a property to an association.
+     * Keeps as many properties as possible.
+     * @param key The key of the property to convert.
+     */
+    convertToAssociation(key: string): void;
+    /**
+     * Converts an association to a property.
+     * Keeps as many properties as possible.
+     * @param key The key of the association to convert.
+     */
+    convertToProperty(key: string): void;
+    protected handleTaxonomySelect(e: CustomEvent<{
+        item: HTMLElement;
+    }>): void;
+    protected handleDeleteTaxonomy(e: Event): void;
+    protected render(): TemplateResult | typeof nothing;
+    protected renderForm(model: DomainEntity): TemplateResult;
+    protected renderMetaInputs(model: DomainEntity): TemplateResult;
+    protected renderParentEntity(model: DomainEntity): TemplateResult;
+    protected renderParentItems(model: DomainEntity): TemplateResult | typeof nothing;
+    protected renderContentTabs(): TemplateResult;
+    protected renderTabsContent(model: DomainEntity): TemplateResult;
+    protected renderDesignTabContent(model: DomainEntity): TemplateResult;
+    protected renderPreviewTabContent(): TemplateResult;
+    protected renderPreviewMimeSelector(): TemplateResult;
+    protected renderFieldsSection(model: DomainEntity): TemplateResult;
+    protected renderFieldAddButton(): TemplateResult;
+    protected renderFieldsEmptyState(): TemplateResult;
+    protected renderFieldsList(items: DomainEntity): TemplateResult;
+    protected renderField(item: DomainAssociation | DomainProperty): TemplateResult;
+    protected createFieldContextualMenu(item: DomainAssociation | DomainProperty): TemplateResult;
+    protected renderDataGovernanceSection(model: DomainEntity): TemplateResult;
+    protected renderTaxonomyInput(model: DomainEntity): TemplateResult | typeof nothing;
+    protected renderSelectedSemantics(selected: EntitySemantic[]): TemplateResult | typeof nothing;
+    protected renderTaxonomyItem(semantic: EntitySemantic): TemplateResult;
+    protected renderTaxonomyCategories(categories: Record<string, EntitySemantic[]>): TemplateResult[];
+}
+//# sourceMappingURL=DomainEntityEditor.d.ts.map

package/build/src/modeling/internals/DomainEntityEditor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DomainEntityEditor.d.ts","sourceRoot":"","sources":["../../../../src/modeling/internals/DomainEntityEditor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,KAAK,CAAA;AAK7E,OAAO,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAA;AAIxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AACvF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AACjF,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAItD,OAAO,EACL,KAAK,cAAc,EAKpB,MAAM,wCAAwC,CAAA;AAG/C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAG/D;;;;;;;;;GASG;AAEH;;;;;;;;GAQG;AAEH;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,eAAe;IAC7D,SAAS,CAAC,aAAa,EAAE,YAAY,GAAG,SAAS,CAAA;IAEjD;;;OAGG;IACwC,QAAQ,CAAC,UAAU,EAAE,QAAQ,GAAG,SAAS,CAAW;IAE/F;;;OAGG;IACwC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAA;IAExF;;;OAGG;IACyB,QAAQ,CAAC,IAAI,SAAqB;IAC9D;;;;OAIG;IAC0B,QAAQ,CAAC,UAAU,UAAQ;IAExD;;OAEG;IACM,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;cAEhC,UAAU,CAAC,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI;IAc7D,SAAS,CAAC,aAAa,IAAI,IAAI;IAS/B,gBAAgB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAyBhC,sBAAsB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAatC;;OAEG;IACH,eAAe,IAAI,IAAI;IASd,YAAY,IAAI,IAAI;IAK7B;;OAEG;IACH,gBAAgB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAShC;;;OAGG;IACH,qBAAqB,CAAC,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,IAAI;IAS5D;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAcvC,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAUhC,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAUnC,qBAAqB,CAAC,CAAC,EAAE,WAAW,CAAC;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,CAAC,GAAG,IAAI;IAkBlE;;OAEG;IACH,oBAAoB,IAAI,IAAI;cA2BZ,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAoBnD,SAAS,CAAC,kBAAkB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAe5C,SAAS,CAAC,oBAAoB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAS9C,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IAkBnD,SAAS,CAAC,0BAA0B,CAAC,CAAC,EAAE,SAAS,GAAG,IAAI;IAexD,SAAS,CAAC,yBAAyB,CAAC,CAAC,EAAE,SAAS,GAAG,IAAI;IAYvD,SAAS,CAAC,0BAA0B,CAAC,CAAC,EAAE,SAAS,GAAG,IAAI;IASxD,SAAS,CAAC,qBAAqB,CAAC,CAAC,EAAE,SAAS,GAAG,IAAI;IAoBnD,SAAS,CAAC,oBAAoB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAY9C,SAAS,CAAC,mBAAmB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAW7C,SAAS,CAAC,4BAA4B,CAAC,CAAC,EAAE,WAAW,CAAC;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,CAAC,GAAG,IAAI;IAuBnF;;;;;OAKG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAa/C;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAuF9C;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAgE5B;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAuBtD,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAe5C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAS7B;;;;OAIG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAyCvC;;;;OAIG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAgDpC,SAAS,CAAC,oBAAoB,CAAC,CAAC,EAAE,WAAW,CAAC;QAAE,IAAI,EAAE,WAAW,CAAA;KAAE,CAAC,GAAG,IAAI;IAU3E,SAAS,CAAC,oBAAoB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;cAS3B,MAAM,IAAI,cAAc,GAAG,OAAO,OAAO;IAQ5D,SAAS,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc;IASzD,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc;IAgD/D,SAAS,CAAC,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc;IA2BjE,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc,GAAG,OAAO,OAAO;IA2BjF,SAAS,CAAC,iBAAiB,IAAI,cAAc;IAS7C,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc;IAYhE,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc;IAKrE,SAAS,CAAC,uBAAuB,IAAI,cAAc;IASnD,SAAS,CAAC,yBAAyB,IAAI,cAAc;IAerD,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc;IAYlE,SAAS,CAAC,oBAAoB,IAAI,cAAc;IAmChD,SAAS,CAAC,sBAAsB,IAAI,cAAc;IAUlD,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc;IAQ/D,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,iBAAiB,GAAG,cAAc,GAAG,cAAc;IAgB/E,SAAS,CAAC,yBAAyB,CAAC,IAAI,EAAE,iBAAiB,GAAG,cAAc,GAAG,cAAc;IAiE7F,SAAS,CAAC,2BAA2B,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc;IAU1E,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,YAAY,GAAG,cAAc,GAAG,OAAO,OAAO;IA8EnF,SAAS,CAAC,uBAAuB,CAAC,QAAQ,EAAE,cAAc,EAAE,GAAG,cAAc,GAAG,OAAO,OAAO;IAQ9F,SAAS,CAAC,kBAAkB,CAAC,QAAQ,EAAE,cAAc,GAAG,cAAc;IAmBtE,SAAS,CAAC,wBAAwB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,GAAG,cAAc,EAAE;CA2BnG"}