@api-client/ui 0.5.58 → 0.6.0

package/build/src/modeling/internals/ApiModelingDescriptionScreen.js

@@ -0,0 +1,356 @@
+import { __esDecorate, __runInitializers } from "tslib";
+import { html, nothing } from 'lit';
+import { ApiModelingScreen } from './ApiModelingScreen.js';
+import { state } from 'lit/decorators.js';
+import { live } from 'lit/directives/live.js';
+import { renderHelp } from '../../help/render.js';
+let ApiModelingDescriptionScreen = (() => {
+    let _classSuper = ApiModelingScreen;
+    let _isCustomLicense_decorators;
+    let _isCustomLicense_initializers = [];
+    let _isCustomLicense_extraInitializers = [];
+    let _isContactEnabled_decorators;
+    let _isContactEnabled_initializers = [];
+    let _isContactEnabled_extraInitializers = [];
+    return class ApiModelingDescriptionScreen extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _isCustomLicense_decorators = [state()];
+            _isContactEnabled_decorators = [state()];
+            __esDecorate(this, null, _isCustomLicense_decorators, { kind: "accessor", name: "isCustomLicense", static: false, private: false, access: { has: obj => "isCustomLicense" in obj, get: obj => obj.isCustomLicense, set: (obj, value) => { obj.isCustomLicense = value; } }, metadata: _metadata }, _isCustomLicense_initializers, _isCustomLicense_extraInitializers);
+            __esDecorate(this, null, _isContactEnabled_decorators, { kind: "accessor", name: "isContactEnabled", static: false, private: false, access: { has: obj => "isContactEnabled" in obj, get: obj => obj.isContactEnabled, set: (obj, value) => { obj.isContactEnabled = value; } }, metadata: _metadata }, _isContactEnabled_initializers, _isContactEnabled_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
+        }
+        #isCustomLicense_accessor_storage = __runInitializers(this, _isCustomLicense_initializers, false
+        /**
+         * Whether contact information is enabled.
+         */
+        );
+        /**
+         * Whether a custom license name is being used.
+         */
+        get isCustomLicense() { return this.#isCustomLicense_accessor_storage; }
+        set isCustomLicense(value) { this.#isCustomLicense_accessor_storage = value; }
+        #isContactEnabled_accessor_storage = (__runInitializers(this, _isCustomLicense_extraInitializers), __runInitializers(this, _isContactEnabled_initializers, false));
+        /**
+         * Whether contact information is enabled.
+         */
+        get isContactEnabled() { return this.#isContactEnabled_accessor_storage; }
+        set isContactEnabled(value) { this.#isContactEnabled_accessor_storage = value; }
+        handleModelChange(model) {
+            this.checkCustomLicense(model);
+            this.checkContactEnabled(model);
+        }
+        /**
+         * Checks if the current license is a custom one and updates the state.
+         * @param model The current API model.
+         */
+        checkCustomLicense(model = this.model) {
+            if (!model?.license?.name) {
+                this.isCustomLicense = false;
+                return;
+            }
+            const commonLicenses = ['MIT', 'Apache-2.0', 'GPL-3.0'];
+            this.isCustomLicense = !commonLicenses.includes(model.license.name);
+        }
+        /**
+         * Checks if contact information is available and updates the state.
+         * @param model The current API model.
+         */
+        checkContactEnabled(model) {
+            const currentModel = model || this.model;
+            this.isContactEnabled = !!currentModel?.contact;
+        }
+        handleMetaChange(e) {
+            const model = this.model;
+            if (!model) {
+                return;
+            }
+            const node = e.target;
+            if (node.value && !node.reportValidity()) {
+                return;
+            }
+            const { name, value } = node;
+            switch (name) {
+                case 'name':
+                case 'version':
+                case 'description':
+                    if (name === 'name' && !value) {
+                        return;
+                    }
+                    model.info[name] = value;
+                    break;
+                case 'termsOfService':
+                    model.termsOfService = value || undefined;
+                    break;
+                case 'licenseUrl':
+                    if (!model.license) {
+                        model.license = { name: '' };
+                    }
+                    model.license.url = value || undefined;
+                    break;
+                case 'customLicenseName':
+                    if (!model.license) {
+                        model.license = { name: '' };
+                    }
+                    model.license.name = value;
+                    break;
+                case 'contactName':
+                    if (!model.contact)
+                        model.contact = {};
+                    model.contact.name = value || undefined;
+                    break;
+                case 'contactEmail':
+                    if (!model.contact)
+                        model.contact = {};
+                    model.contact.email = value || undefined;
+                    break;
+                case 'contactUrl':
+                    if (!model.contact)
+                        model.contact = {};
+                    model.contact.url = value || undefined;
+                    break;
+                default:
+                    return;
+            }
+            this.model?.notifyChange();
+            this.requestUpdate();
+        }
+        handleLicenseSelect(e) {
+            const model = this.model;
+            if (!model) {
+                return;
+            }
+            const select = e.target;
+            const { value } = select;
+            if (value === 'custom') {
+                this.isCustomLicense = true;
+                const isStandard = model.license && ['MIT', 'Apache-2.0', 'GPL-3.0'].includes(model.license.name);
+                if (!model.license || isStandard) {
+                    model.license = { name: '' };
+                }
+            }
+            else if (value) {
+                this.isCustomLicense = false;
+                model.license = {
+                    name: value,
+                    url: this.getLicenseUrl(value),
+                };
+            }
+            else {
+                this.isCustomLicense = false;
+                model.license = undefined;
+            }
+            this.model?.notifyChange();
+            this.requestUpdate();
+        }
+        handleContactToggle(e) {
+            const model = this.model;
+            if (!model) {
+                return;
+            }
+            const toggle = e.target;
+            this.isContactEnabled = !!toggle.checked;
+            if (this.isContactEnabled) {
+                if (!model.contact) {
+                    model.contact = {};
+                }
+            }
+            else {
+                model.contact = undefined;
+            }
+            this.model?.notifyChange();
+            this.requestUpdate();
+        }
+        getLicenseUrl(name) {
+            switch (name) {
+                case 'MIT':
+                    return 'https://opensource.org/licenses/MIT';
+                case 'Apache-2.0':
+                    return 'https://opensource.org/licenses/Apache-2.0';
+                case 'GPL-3.0':
+                    return 'https://www.gnu.org/licenses/gpl-3.0';
+                default:
+                    return undefined;
+            }
+        }
+        render() {
+            const model = this.model;
+            if (!model) {
+                return nothing;
+            }
+            return html `${this.renderMetaFields(model)}<ui-divider type="full"></ui-divider>${this.renderLegalFields(model)}<ui-divider type="full"></ui-divider>${this.renderContactSection(model)}`;
+        }
+        renderMetaFields(model) {
+            return html `
+      <div class="form-section meta-section">
+        <div class="row">
+          <ui-outlined-text-field
+            class="input"
+            name="name"
+            .value="${live(model.info.name || '')}"
+            label="Name"
+            required
+            minLength="2"
+            @change="${this.handleMetaChange}"
+          ></ui-outlined-text-field>
+          ${renderHelp('api', 'description:name-input')}
+        </div>
+        <div class="row">
+          <ui-outlined-text-field
+            class="input"
+            name="description"
+            .value="${live(model.info.description || '')}"
+            label="Description"
+            @change="${this.handleMetaChange}"
+          ></ui-outlined-text-field>
+          ${renderHelp('api', 'description:description-input')}
+        </div>
+        <div class="row">
+          <ui-outlined-text-field
+            class="input"
+            name="version"
+            .value="${live(model.info.version || 'v1')}"
+            label="Version"
+            required
+            @change="${this.handleMetaChange}"
+          ></ui-outlined-text-field>
+          ${renderHelp('api', 'description:version-input')}
+        </div>
+      </div>
+    `;
+        }
+        renderLegalFields(model) {
+            const licenseName = model.license?.name || '';
+            const licenseValue = this.isCustomLicense ? 'custom' : licenseName;
+            return html `
+      <div class="form-section legal-section">
+        <div class="row">
+          <ui-outlined-text-field
+            class="input"
+            name="termsOfService"
+            .value="${live(model.termsOfService || '')}"
+            label="Terms of Service (URL)"
+            @change="${this.handleMetaChange}"
+            type="url"
+          ></ui-outlined-text-field>
+          ${renderHelp('api', 'description:terms-of-service-input')}
+        </div>
+        <div class="row">
+          <ui-select
+            class="input"
+            label="License"
+            name="license"
+            .value="${licenseValue}"
+            @change="${this.handleLicenseSelect}"
+          >
+            <ui-option value=""><div>None</div></ui-option>
+            <ui-option value="MIT"><div>MIT</div></ui-option>
+            <ui-option value="Apache-2.0"><div>Apache 2.0</div></ui-option>
+            <ui-option value="GPL-3.0"><div>GNU GPLv3</div></ui-option>
+            <ui-option value="custom"><div>Custom</div></ui-option>
+          </ui-select>
+          ${renderHelp('api', 'description:license-input')}
+        </div>
+        ${this.isCustomLicense ? this.renderCustomLicenseName(model) : nothing}
+        ${model.license ? this.renderLicenseUrl(model) : nothing}
+      </div>
+    `;
+        }
+        renderCustomLicenseName(model) {
+            return html `
+      <div class="row">
+        <ui-outlined-text-field
+          class="input"
+          name="customLicenseName"
+          .value="${live(model.license?.name || '')}"
+          label="Custom License Name"
+          @change="${this.handleMetaChange}"
+          required
+        ></ui-outlined-text-field>
+        ${renderHelp('api', 'description:custom-license-name-input')}
+      </div>
+    `;
+        }
+        renderLicenseUrl(model) {
+            return html `
+      <div class="row">
+        <ui-outlined-text-field
+          class="input"
+          name="licenseUrl"
+          .value="${live(model.license?.url || '')}"
+          label="License URL"
+          @change="${this.handleMetaChange}"
+          type="url"
+        ></ui-outlined-text-field>
+        ${renderHelp('api', 'description:license-url-input')}
+      </div>
+    `;
+        }
+        renderContactSection(model) {
+            return html `
+      <div class="form-section contact-section">
+        <div class="row">
+          <div class="input enum">
+            <ui-switch
+              .checked="${this.isContactEnabled}"
+              id="contactEnabled"
+              @change="${this.handleContactToggle}"
+            ></ui-switch>
+            <label for="contactEnabled" class="body-medium">Contact Information</label>
+          </div>
+          ${renderHelp('api', 'description:contact-info-toggle')}
+        </div>
+        ${this.isContactEnabled ? this.renderContactFields(model) : nothing}
+      </div>
+    `;
+        }
+        renderContactFields(model) {
+            const contact = model.contact || {};
+            return html `
+      <div class="row">
+        <ui-outlined-text-field
+          class="input"
+          name="contactName"
+          .value="${live(contact.name || '')}"
+          label="Contact Name"
+          @change="${this.handleMetaChange}"
+        ></ui-outlined-text-field>
+        ${renderHelp('api', 'description:contact-name-input')}
+      </div>
+      <div class="row">
+        <ui-outlined-text-field
+          class="input"
+          name="contactEmail"
+          .value="${live(contact.email || '')}"
+          label="Contact Email"
+          type="email"
+          @change="${this.handleMetaChange}"
+        ></ui-outlined-text-field>
+        ${renderHelp('api', 'description:contact-email-input')}
+      </div>
+      <div class="row">
+        <ui-outlined-text-field
+          class="input"
+          name="contactUrl"
+          .value="${live(contact.url || '')}"
+          label="Contact URL"
+          type="url"
+          @change="${this.handleMetaChange}"
+        ></ui-outlined-text-field>
+        ${renderHelp('api', 'description:contact-url-input')}
+      </div>
+    `;
+        }
+        constructor() {
+            super(...arguments);
+            __runInitializers(this, _isContactEnabled_extraInitializers);
+        }
+    };
+})();
+/**
+ * A screen for editing API description information.
+ * Used in API modeling.
+ */
+export default ApiModelingDescriptionScreen;
+//# sourceMappingURL=ApiModelingDescriptionScreen.js.map

package/build/src/modeling/internals/ApiModelingDescriptionScreen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiModelingDescriptionScreen.js","sourceRoot":"","sources":["../../../../src/modeling/internals/ApiModelingDescriptionScreen.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAuB,OAAO,EAAE,MAAM,KAAK,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;;sBASS,iBAAiB;;;;;;;iBAAtD,4BAA6B,SAAQ,WAAiB;;;2CAIxE,KAAK,EAAE;4CAKP,KAAK,EAAE;YALC,kMAAmB,eAAe,6BAAf,eAAe,yGAAQ;YAK1C,qMAAmB,gBAAgB,6BAAhB,gBAAgB,2GAAQ;;;QAL3C,2FAAqC,KAAK;QAEnD;;WAEG;UAJgD;QAHnD;;WAEG;QACM,IAAmB,eAAe,qDAAQ;QAA1C,IAAmB,eAAe,2DAAQ;QAK1C,2JAAsC,KAAK,GAAA;QAHpD;;WAEG;QACM,IAAmB,gBAAgB,sDAAQ;QAA3C,IAAmB,gBAAgB,4DAAQ;QAE1C,iBAAiB,CAAC,KAA2B;YACrD,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;YAC9B,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAA;QACjC,CAAC;QAED;;;WAGG;QACH,kBAAkB,CAAC,QAA8B,IAAI,CAAC,KAAK;YACzD,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;gBAC1B,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;gBAC5B,OAAM;YACR,CAAC;YACD,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,CAAA;YACvD,IAAI,CAAC,eAAe,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QACrE,CAAC;QAED;;;WAGG;QACH,mBAAmB,CAAC,KAAgB;YAClC,MAAM,YAAY,GAAG,KAAK,IAAI,IAAI,CAAC,KAAK,CAAA;YACxC,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC,YAAY,EAAE,OAAO,CAAA;QACjD,CAAC;QAES,gBAAgB,CAAC,CAAQ;YACjC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;YACxB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAM;YACR,CAAC;YACD,MAAM,IAAI,GAAG,CAAC,CAAC,MAA0B,CAAA;YACzC,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;gBACzC,OAAM;YACR,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;YAE5B,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,MAAM,CAAC;gBACZ,KAAK,SAAS,CAAC;gBACf,KAAK,aAAa;oBAChB,IAAI,IAAI,KAAK,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;wBAC9B,OAAM;oBACR,CAAC;oBACD,KAAK,CAAC,IAAI,CAAC,IAA0C,CAAC,GAAG,KAAK,CAAA;oBAC9D,MAAK;gBACP,KAAK,gBAAgB;oBACnB,KAAK,CAAC,cAAc,GAAG,KAAK,IAAI,SAAS,CAAA;oBACzC,MAAK;gBACP,KAAK,YAAY;oBACf,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;wBACnB,KAAK,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;oBAC9B,CAAC;oBACD,KAAK,CAAC,OAAO,CAAC,GAAG,GAAG,KAAK,IAAI,SAAS,CAAA;oBACtC,MAAK;gBACP,KAAK,mBAAmB;oBACtB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;wBACnB,KAAK,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;oBAC9B,CAAC;oBACD,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,KAAK,CAAA;oBAC1B,MAAK;gBACP,KAAK,aAAa;oBAChB,IAAI,CAAC,KAAK,CAAC,OAAO;wBAAE,KAAK,CAAC,OAAO,GAAG,EAAE,CAAA;oBACtC,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,KAAK,IAAI,SAAS,CAAA;oBACvC,MAAK;gBACP,KAAK,cAAc;oBACjB,IAAI,CAAC,KAAK,CAAC,OAAO;wBAAE,KAAK,CAAC,OAAO,GAAG,EAAE,CAAA;oBACtC,KAAK,CAAC,OAAO,CAAC,KAAK,GAAG,KAAK,IAAI,SAAS,CAAA;oBACxC,MAAK;gBACP,KAAK,YAAY;oBACf,IAAI,CAAC,KAAK,CAAC,OAAO;wBAAE,KAAK,CAAC,OAAO,GAAG,EAAE,CAAA;oBACtC,KAAK,CAAC,OAAO,CAAC,GAAG,GAAG,KAAK,IAAI,SAAS,CAAA;oBACtC,MAAK;gBACP;oBACE,OAAM;YACV,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,CAAA;YAC1B,IAAI,CAAC,aAAa,EAAE,CAAA;QACtB,CAAC;QAES,mBAAmB,CAAC,CAAc;YAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;YACxB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAM;YACR,CAAC;YACD,MAAM,MAAM,GAAG,CAAC,CAAC,MAAyB,CAAA;YAC1C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;YAExB,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACvB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAA;gBAC3B,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBACjG,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,UAAU,EAAE,CAAC;oBACjC,KAAK,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,CAAA;gBAC9B,CAAC;YACH,CAAC;iBAAM,IAAI,KAAK,EAAE,CAAC;gBACjB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;gBAC5B,KAAK,CAAC,OAAO,GAAG;oBACd,IAAI,EAAE,KAAK;oBACX,GAAG,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;iBAC/B,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,eAAe,GAAG,KAAK,CAAA;gBAC5B,KAAK,CAAC,OAAO,GAAG,SAAS,CAAA;YAC3B,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,CAAA;YAC1B,IAAI,CAAC,aAAa,EAAE,CAAA;QACtB,CAAC;QAES,mBAAmB,CAAC,CAAQ;YACpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;YACxB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAM;YACR,CAAC;YACD,MAAM,MAAM,GAAG,CAAC,CAAC,MAAyB,CAAA;YAC1C,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAA;YACxC,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;oBACnB,KAAK,CAAC,OAAO,GAAG,EAAE,CAAA;gBACpB,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,OAAO,GAAG,SAAS,CAAA;YAC3B,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,CAAA;YAC1B,IAAI,CAAC,aAAa,EAAE,CAAA;QACtB,CAAC;QAED,aAAa,CAAC,IAAY;YACxB,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,KAAK;oBACR,OAAO,qCAAqC,CAAA;gBAC9C,KAAK,YAAY;oBACf,OAAO,4CAA4C,CAAA;gBACrD,KAAK,SAAS;oBACZ,OAAO,sCAAsC,CAAA;gBAC/C;oBACE,OAAO,SAAS,CAAA;YACpB,CAAC;QACH,CAAC;QAEQ,MAAM;YACb,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;YACxB,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,OAAO,OAAO,CAAA;YAChB,CAAC;YACD,OAAO,IAAI,CAAA,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,wCAAwC,IAAI,CAAC,iBAAiB,CACpG,KAAK,CACN,wCAAwC,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAA;QAC/E,CAAC;QAES,gBAAgB,CAAC,KAAe;YACxC,OAAO,IAAI,CAAA;;;;;;sBAMO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;;;;uBAI1B,IAAI,CAAC,gBAAgB;;YAEhC,UAAU,CAAC,KAAK,EAAE,wBAAwB,CAAC;;;;;;sBAMjC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;;uBAEjC,IAAI,CAAC,gBAAgB;;YAEhC,UAAU,CAAC,KAAK,EAAE,+BAA+B,CAAC;;;;;;sBAMxC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;;;uBAG/B,IAAI,CAAC,gBAAgB;;YAEhC,UAAU,CAAC,KAAK,EAAE,2BAA2B,CAAC;;;KAGrD,CAAA;QACH,CAAC;QAES,iBAAiB,CAAC,KAAe;YACzC,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE,CAAA;YAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAA;YAElE,OAAO,IAAI,CAAA;;;;;;sBAMO,IAAI,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC;;uBAE/B,IAAI,CAAC,gBAAgB;;;YAGhC,UAAU,CAAC,KAAK,EAAE,oCAAoC,CAAC;;;;;;;sBAO7C,YAAY;uBACX,IAAI,CAAC,mBAAmB;;;;;;;;YAQnC,UAAU,CAAC,KAAK,EAAE,2BAA2B,CAAC;;UAEhD,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO;UACpE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO;;KAE3D,CAAA;QACH,CAAC;QAES,uBAAuB,CAAC,KAAe;YAC/C,OAAO,IAAI,CAAA;;;;;oBAKK,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC;;qBAE9B,IAAI,CAAC,gBAAgB;;;UAGhC,UAAU,CAAC,KAAK,EAAE,uCAAuC,CAAC;;KAE/D,CAAA;QACH,CAAC;QAES,gBAAgB,CAAC,KAAe;YACxC,OAAO,IAAI,CAAA;;;;;oBAKK,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;;qBAE7B,IAAI,CAAC,gBAAgB;;;UAGhC,UAAU,CAAC,KAAK,EAAE,+BAA+B,CAAC;;KAEvD,CAAA;QACH,CAAC;QAES,oBAAoB,CAAC,KAAe;YAC5C,OAAO,IAAI,CAAA;;;;;0BAKW,IAAI,CAAC,gBAAgB;;yBAEtB,IAAI,CAAC,mBAAmB;;;;YAIrC,UAAU,CAAC,KAAK,EAAE,iCAAiC,CAAC;;UAEtD,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO;;KAEtE,CAAA;QACH,CAAC;QAES,mBAAmB,CAAC,KAAe;YAC3C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,IAAI,EAAE,CAAA;YACnC,OAAO,IAAI,CAAA;;;;;oBAKK,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;;qBAEvB,IAAI,CAAC,gBAAgB;;UAEhC,UAAU,CAAC,KAAK,EAAE,gCAAgC,CAAC;;;;;;oBAMzC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;;;qBAGxB,IAAI,CAAC,gBAAgB;;UAEhC,UAAU,CAAC,KAAK,EAAE,iCAAiC,CAAC;;;;;;oBAM1C,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;;;qBAGtB,IAAI,CAAC,gBAAgB;;UAEhC,UAAU,CAAC,KAAK,EAAE,+BAA+B,CAAC;;KAEvD,CAAA;QACH,CAAC;;;;;;;AA3UH;;;GAGG;AACH,4CAwUC","sourcesContent":["import { html, type TemplateResult, nothing } from 'lit'\nimport { ApiModelingScreen } from './ApiModelingScreen.js'\nimport { state } from 'lit/decorators.js'\nimport { live } from 'lit/directives/live.js'\nimport { renderHelp } from '../../help/render.js'\nimport type { ApiModel } from '@api-client/core/browser.js'\nimport type { UiSelectElement } from '../../md/select/ui-select.js'\nimport type { UiSwitchElement } from '../../md/switch/ui-switch.js'\n\n/**\n * A screen for editing API description information.\n * Used in API modeling.\n */\nexport default class ApiModelingDescriptionScreen extends ApiModelingScreen {\n  /**\n   * Whether a custom license name is being used.\n   */\n  @state() protected accessor isCustomLicense = false\n\n  /**\n   * Whether contact information is enabled.\n   */\n  @state() protected accessor isContactEnabled = false\n\n  protected handleModelChange(model: ApiModel | undefined): void {\n    this.checkCustomLicense(model)\n    this.checkContactEnabled(model)\n  }\n\n  /**\n   * Checks if the current license is a custom one and updates the state.\n   * @param model The current API model.\n   */\n  checkCustomLicense(model: ApiModel | undefined = this.model): void {\n    if (!model?.license?.name) {\n      this.isCustomLicense = false\n      return\n    }\n    const commonLicenses = ['MIT', 'Apache-2.0', 'GPL-3.0']\n    this.isCustomLicense = !commonLicenses.includes(model.license.name)\n  }\n\n  /**\n   * Checks if contact information is available and updates the state.\n   * @param model The current API model.\n   */\n  checkContactEnabled(model?: ApiModel): void {\n    const currentModel = model || this.model\n    this.isContactEnabled = !!currentModel?.contact\n  }\n\n  protected handleMetaChange(e: Event): void {\n    const model = this.model\n    if (!model) {\n      return\n    }\n    const node = e.target as HTMLInputElement\n    if (node.value && !node.reportValidity()) {\n      return\n    }\n    const { name, value } = node\n\n    switch (name) {\n      case 'name':\n      case 'version':\n      case 'description':\n        if (name === 'name' && !value) {\n          return\n        }\n        model.info[name as 'name' | 'description' | 'version'] = value\n        break\n      case 'termsOfService':\n        model.termsOfService = value || undefined\n        break\n      case 'licenseUrl':\n        if (!model.license) {\n          model.license = { name: '' }\n        }\n        model.license.url = value || undefined\n        break\n      case 'customLicenseName':\n        if (!model.license) {\n          model.license = { name: '' }\n        }\n        model.license.name = value\n        break\n      case 'contactName':\n        if (!model.contact) model.contact = {}\n        model.contact.name = value || undefined\n        break\n      case 'contactEmail':\n        if (!model.contact) model.contact = {}\n        model.contact.email = value || undefined\n        break\n      case 'contactUrl':\n        if (!model.contact) model.contact = {}\n        model.contact.url = value || undefined\n        break\n      default:\n        return\n    }\n    this.model?.notifyChange()\n    this.requestUpdate()\n  }\n\n  protected handleLicenseSelect(e: CustomEvent): void {\n    const model = this.model\n    if (!model) {\n      return\n    }\n    const select = e.target as UiSelectElement\n    const { value } = select\n\n    if (value === 'custom') {\n      this.isCustomLicense = true\n      const isStandard = model.license && ['MIT', 'Apache-2.0', 'GPL-3.0'].includes(model.license.name)\n      if (!model.license || isStandard) {\n        model.license = { name: '' }\n      }\n    } else if (value) {\n      this.isCustomLicense = false\n      model.license = {\n        name: value,\n        url: this.getLicenseUrl(value),\n      }\n    } else {\n      this.isCustomLicense = false\n      model.license = undefined\n    }\n    this.model?.notifyChange()\n    this.requestUpdate()\n  }\n\n  protected handleContactToggle(e: Event): void {\n    const model = this.model\n    if (!model) {\n      return\n    }\n    const toggle = e.target as UiSwitchElement\n    this.isContactEnabled = !!toggle.checked\n    if (this.isContactEnabled) {\n      if (!model.contact) {\n        model.contact = {}\n      }\n    } else {\n      model.contact = undefined\n    }\n    this.model?.notifyChange()\n    this.requestUpdate()\n  }\n\n  getLicenseUrl(name: string): string | undefined {\n    switch (name) {\n      case 'MIT':\n        return 'https://opensource.org/licenses/MIT'\n      case 'Apache-2.0':\n        return 'https://opensource.org/licenses/Apache-2.0'\n      case 'GPL-3.0':\n        return 'https://www.gnu.org/licenses/gpl-3.0'\n      default:\n        return undefined\n    }\n  }\n\n  override render(): TemplateResult | typeof nothing {\n    const model = this.model\n    if (!model) {\n      return nothing\n    }\n    return html`${this.renderMetaFields(model)}<ui-divider type=\"full\"></ui-divider>${this.renderLegalFields(\n        model\n      )}<ui-divider type=\"full\"></ui-divider>${this.renderContactSection(model)}`\n  }\n\n  protected renderMetaFields(model: ApiModel): TemplateResult {\n    return html`\n      <div class=\"form-section meta-section\">\n        <div class=\"row\">\n          <ui-outlined-text-field\n            class=\"input\"\n            name=\"name\"\n            .value=\"${live(model.info.name || '')}\"\n            label=\"Name\"\n            required\n            minLength=\"2\"\n            @change=\"${this.handleMetaChange}\"\n          ></ui-outlined-text-field>\n          ${renderHelp('api', 'description:name-input')}\n        </div>\n        <div class=\"row\">\n          <ui-outlined-text-field\n            class=\"input\"\n            name=\"description\"\n            .value=\"${live(model.info.description || '')}\"\n            label=\"Description\"\n            @change=\"${this.handleMetaChange}\"\n          ></ui-outlined-text-field>\n          ${renderHelp('api', 'description:description-input')}\n        </div>\n        <div class=\"row\">\n          <ui-outlined-text-field\n            class=\"input\"\n            name=\"version\"\n            .value=\"${live(model.info.version || 'v1')}\"\n            label=\"Version\"\n            required\n            @change=\"${this.handleMetaChange}\"\n          ></ui-outlined-text-field>\n          ${renderHelp('api', 'description:version-input')}\n        </div>\n      </div>\n    `\n  }\n\n  protected renderLegalFields(model: ApiModel): TemplateResult {\n    const licenseName = model.license?.name || ''\n    const licenseValue = this.isCustomLicense ? 'custom' : licenseName\n\n    return html`\n      <div class=\"form-section legal-section\">\n        <div class=\"row\">\n          <ui-outlined-text-field\n            class=\"input\"\n            name=\"termsOfService\"\n            .value=\"${live(model.termsOfService || '')}\"\n            label=\"Terms of Service (URL)\"\n            @change=\"${this.handleMetaChange}\"\n            type=\"url\"\n          ></ui-outlined-text-field>\n          ${renderHelp('api', 'description:terms-of-service-input')}\n        </div>\n        <div class=\"row\">\n          <ui-select\n            class=\"input\"\n            label=\"License\"\n            name=\"license\"\n            .value=\"${licenseValue}\"\n            @change=\"${this.handleLicenseSelect}\"\n          >\n            <ui-option value=\"\"><div>None</div></ui-option>\n            <ui-option value=\"MIT\"><div>MIT</div></ui-option>\n            <ui-option value=\"Apache-2.0\"><div>Apache 2.0</div></ui-option>\n            <ui-option value=\"GPL-3.0\"><div>GNU GPLv3</div></ui-option>\n            <ui-option value=\"custom\"><div>Custom</div></ui-option>\n          </ui-select>\n          ${renderHelp('api', 'description:license-input')}\n        </div>\n        ${this.isCustomLicense ? this.renderCustomLicenseName(model) : nothing}\n        ${model.license ? this.renderLicenseUrl(model) : nothing}\n      </div>\n    `\n  }\n\n  protected renderCustomLicenseName(model: ApiModel): TemplateResult {\n    return html`\n      <div class=\"row\">\n        <ui-outlined-text-field\n          class=\"input\"\n          name=\"customLicenseName\"\n          .value=\"${live(model.license?.name || '')}\"\n          label=\"Custom License Name\"\n          @change=\"${this.handleMetaChange}\"\n          required\n        ></ui-outlined-text-field>\n        ${renderHelp('api', 'description:custom-license-name-input')}\n      </div>\n    `\n  }\n\n  protected renderLicenseUrl(model: ApiModel): TemplateResult {\n    return html`\n      <div class=\"row\">\n        <ui-outlined-text-field\n          class=\"input\"\n          name=\"licenseUrl\"\n          .value=\"${live(model.license?.url || '')}\"\n          label=\"License URL\"\n          @change=\"${this.handleMetaChange}\"\n          type=\"url\"\n        ></ui-outlined-text-field>\n        ${renderHelp('api', 'description:license-url-input')}\n      </div>\n    `\n  }\n\n  protected renderContactSection(model: ApiModel): TemplateResult {\n    return html`\n      <div class=\"form-section contact-section\">\n        <div class=\"row\">\n          <div class=\"input enum\">\n            <ui-switch\n              .checked=\"${this.isContactEnabled}\"\n              id=\"contactEnabled\"\n              @change=\"${this.handleContactToggle}\"\n            ></ui-switch>\n            <label for=\"contactEnabled\" class=\"body-medium\">Contact Information</label>\n          </div>\n          ${renderHelp('api', 'description:contact-info-toggle')}\n        </div>\n        ${this.isContactEnabled ? this.renderContactFields(model) : nothing}\n      </div>\n    `\n  }\n\n  protected renderContactFields(model: ApiModel): TemplateResult {\n    const contact = model.contact || {}\n    return html`\n      <div class=\"row\">\n        <ui-outlined-text-field\n          class=\"input\"\n          name=\"contactName\"\n          .value=\"${live(contact.name || '')}\"\n          label=\"Contact Name\"\n          @change=\"${this.handleMetaChange}\"\n        ></ui-outlined-text-field>\n        ${renderHelp('api', 'description:contact-name-input')}\n      </div>\n      <div class=\"row\">\n        <ui-outlined-text-field\n          class=\"input\"\n          name=\"contactEmail\"\n          .value=\"${live(contact.email || '')}\"\n          label=\"Contact Email\"\n          type=\"email\"\n          @change=\"${this.handleMetaChange}\"\n        ></ui-outlined-text-field>\n        ${renderHelp('api', 'description:contact-email-input')}\n      </div>\n      <div class=\"row\">\n        <ui-outlined-text-field\n          class=\"input\"\n          name=\"contactUrl\"\n          .value=\"${live(contact.url || '')}\"\n          label=\"Contact URL\"\n          type=\"url\"\n          @change=\"${this.handleMetaChange}\"\n        ></ui-outlined-text-field>\n        ${renderHelp('api', 'description:contact-url-input')}\n      </div>\n    `\n  }\n}\n"]}

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

@@ -0,0 +1,74 @@
+import { type TemplateResult, nothing } from 'lit';
+import { ApiEditor } from './ApiEditor.js';
+import type { ApiAction, ApiModel, DomainEntity, ExposedEntity } from '@api-client/core/browser.js';
+import '../../md/icons/ui-icon.js';
+import '../../md/chip/ui-chip.js';
+import '../../md/divider/ui-divider.js';
+import '../../md/button/ui-button.js';
+import '../../md/icon-button/ui-icon-button.js';
+import '../../md/dropdown-list/ui-dropdown-list.js';
+import '../../md/list/ui-list.js';
+import '../../md/list/ui-list-item.js';
+/**
+ * An entity card displaying information about an exposed entity
+ * in the API model, including its domain entity and configured actions.
+ *
+ * @fires remove - Fired when the user requests to remove the exposed entity.
+ * @fires select - Fired when the user clicks on an action chip. The event detail contains the action kind.
+ * @fires edit - Fired when the user clicks the Edit button.
+ */
+export default class ApiModelingEntityCard extends ApiEditor {
+    /**
+     * Computed exposed entity being edited.
+     */
+    accessor exposed: ExposedEntity | undefined;
+    /**
+     * Computed domain entity that corresponds to the exposed entity being edited.
+     */
+    accessor entity: DomainEntity | undefined;
+    /**
+     * Some exposed entities (specifically downstream associated entities) may not have collection actions
+     * (when the association is one-to-one and are not linked).
+     * When this flag is true, the collection actions section is shown.
+     * @attribute
+     */
+    accessor showCollectionActions: boolean;
+    protected setupModel(model?: ApiModel, domainKey?: string): void | Promise<void>;
+    protected handleMenuSelect(e: CustomEvent): void;
+    protected handleActionChipClick(e: Event): void;
+    protected handleEditButtonClick(): void;
+    protected render(): TemplateResult | typeof nothing;
+    /**
+     * Renders the header section of the entity card.
+     * @param exposed The exposed entity
+     * @param entity The domain entity
+     * @returns The template for the header section
+     */
+    protected renderHeader(exposed: ExposedEntity, entity: DomainEntity): TemplateResult;
+    /**
+     * Renders the actions section.
+     * @param exposed The exposed entity
+     * @returns The template for the actions section
+     */
+    protected renderActions(exposed: ExposedEntity): TemplateResult;
+    /**
+     * Renders the collection actions section.
+     * @param exposed The exposed entity
+     * @returns The template for the collection actions section
+     */
+    protected renderCollectionActions(exposed: ExposedEntity): TemplateResult;
+    /**
+     * Renders the resource actions section.
+     * @param exposed The exposed entity
+     * @returns The template for the resource actions section
+     */
+    protected renderResourceActions(exposed: ExposedEntity): TemplateResult;
+    /**
+     * Renders a list of API actions.
+     * @param actions The list of API actions to render.
+     * @param type The type of actions ('collection' or 'resource').
+     * @returns A TemplateResult containing the rendered actions list.
+     */
+    protected renderActionsList(actions: ApiAction[], type: 'collection' | 'resource'): TemplateResult;
+}
+//# sourceMappingURL=ApiModelingEntityCard.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiModelingEntityCard.d.ts","sourceRoot":"","sources":["../../../../src/modeling/internals/ApiModelingEntityCard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,cAAc,EAAE,OAAO,EAAE,MAAM,KAAK,CAAA;AAGxD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAA;AAGnG,OAAO,2BAA2B,CAAA;AAClC,OAAO,0BAA0B,CAAA;AACjC,OAAO,gCAAgC,CAAA;AACvC,OAAO,8BAA8B,CAAA;AACrC,OAAO,wCAAwC,CAAA;AAC/C,OAAO,4CAA4C,CAAA;AACnD,OAAO,0BAA0B,CAAA;AACjC,OAAO,+BAA+B,CAAA;AAEtC;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,SAAS;IAC1D;;OAEG;IACM,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,CAAA;IACpD;;OAEG;IACM,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,CAAA;IAElD;;;;;OAKG;IAC0B,QAAQ,CAAC,qBAAqB,UAAQ;cAEhD,UAAU,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBzF,SAAS,CAAC,gBAAgB,CAAC,CAAC,EAAE,WAAW,GAAG,IAAI;IAYhD,SAAS,CAAC,qBAAqB,CAAC,CAAC,EAAE,KAAK,GAAG,IAAI;IAe/C,SAAS,CAAC,qBAAqB,IAAI,IAAI;cAIpB,MAAM,IAAI,cAAc,GAAG,OAAO,OAAO;IAsB5D;;;;;OAKG;IACH,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,GAAG,cAAc;IAapF;;;;OAIG;IACH,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,aAAa,GAAG,cAAc;IAY/D;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,CAAC,OAAO,EAAE,aAAa,GAAG,cAAc;IAQzE;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,CAAC,OAAO,EAAE,aAAa,GAAG,cAAc;IAQvE;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,GAAG,UAAU,GAAG,cAAc;CAwBnG"}