cotomy 0.1.66 → 0.1.67

package/README.md

@@ -20,6 +20,13 @@ npm i cotomy
 Cotomy will continue to expand with more detailed usage instructions and code examples added to the README in the future.  
 For the latest updates, please check the official documentation or repository regularly.
 
+### Entity API forms
+
+`CotomyEntityApiForm` targets REST endpoints that identify records with a single surrogate key.  
+Attach `data-cotomy-entity-key="<id>"` to the form when editing an existing entity; omit the attribute (or leave it empty) to issue a `POST` to the base `action` URL.  
+On `201 Created`, the form reads the `Location` header and stores the generated key back into `data-cotomy-entity-key`, enabling subsequent `PUT` submissions.  
+Composite or natural keys are no longer supported—migrate any legacy markup that relied on `data-cotomy-keyindex` or multiple key inputs to the new surrogate-key flow.
+
 The core of Cotomy is `CotomyElement`, which is constructed as a wrapper for `Element`.  
 By passing HTML and CSS strings to the constructor, it is possible to generate Element designs with a limited scope.
 

package/dist/browser/cotomy.js

@@ -2524,31 +2524,34 @@ class CotomyApiForm extends CotomyForm {
     }
 }
 class CotomyEntityApiForm extends CotomyApiForm {
+    get entityKey() {
+        return this.attribute("data-cotomy-entity-key") ?? undefined;
+    }
+    get requiresEntityKey() {
+        return this.attribute("data-cotomy-identify") !== "false";
+    }
+    get hasEntityKey() {
+        return !!this.entityKey;
+    }
     actionUrl() {
-        const base = this.attribute("action");
-        const keys = this.externalKey ? [this.externalKey] : this.pathKeyInputs.map(e => encodeURIComponent(e.value));
-        return `${base}/${keys.join("/")}`;
+        const action = this.attribute("action");
+        const normalized = action.replace(/\/+$/, "");
+        if (!this.entityKey) {
+            return action.endsWith("/") ? action : `${normalized}/`;
+        }
+        return `${normalized}/${encodeURIComponent(this.entityKey)}`;
     }
     method() {
         if (this.hasAttribute("method") && this.attribute("method") !== "") {
             return this.attribute("method");
         }
-        if (this.externalKey)
-            return "put";
-        if (this.pathKeyInputs.length > 0 && this.pathKeyInputs.every(e => e.readonly))
-            return "put";
-        if (this.keyInputs.length > 0 && this.keyInputs.every(e => e.readonly))
-            return "put";
-        return "post";
+        return this.hasEntityKey ? "put" : "post";
     }
-    get externalKey() {
-        return this.attribute("data-cotomy-key") || undefined;
-    }
-    setExternalKey(response) {
-        if (this.requiresExternalKey && response.status === StatusCodes.CREATED) {
-            if (this.hasExternalKey) {
+    setEntityKey(response) {
+        if (this.requiresEntityKey && response.status === StatusCodes.CREATED) {
+            if (this.hasEntityKey) {
                 if (CotomyDebugSettings.isEnabled(CotomyDebugFeature.FormLoad)) {
-                    console.warn("External key already exists, but server responded with 201 Created. Possible duplicate POST.");
+                    console.warn("Entity key already exists, but server responded with 201 Created. Possible duplicate POST.");
                 }
                 return;
             }
@@ -2577,49 +2580,19 @@ class CotomyEntityApiForm extends CotomyApiForm {
             }
             const addedParts = locationParts.slice(actionParts.length).filter(Boolean);
             if (addedParts.length === 1 && addedParts[0]) {
-                this.attribute("data-cotomy-key", addedParts[0]);
+                this.attribute("data-cotomy-entity-key", addedParts[0]);
             }
             else {
-                const msg = `Location does not contain a single external key segment.
+                const msg = `Location does not contain a single entity key segment.
                 action="${baseAction}", location="${locPath}", added=["${addedParts.join('","')}"]`;
                 throw new Error(msg);
             }
         }
     }
-    get requiresExternalKey() {
-        return this.attribute("data-cotomy-identify") !== "false" && this.keyInputs.length == 0 && this.pathKeyInputs.length == 0;
-    }
-    get hasExternalKey() {
-        return !!this.externalKey;
-    }
-    get pathKeyInputs() {
-        return this.find("[data-cotomy-keyindex]").sort((a, b) => {
-            const aIndex = parseInt(a.attribute("data-cotomy-keyindex") ?? "0");
-            const bIndex = parseInt(b.attribute("data-cotomy-keyindex") ?? "0");
-            return aIndex - bIndex;
-        });
-    }
-    get keyInputs() {
-        return this.contains("[data-cotomy-key]") ? this.find("[data-cotomy-key]").sort((a, b) => {
-            const aIndex = parseInt(a.attribute("data-cotomy-key") ?? "0");
-            const bIndex = parseInt(b.attribute("data-cotomy-key") ?? "0");
-            return aIndex - bIndex;
-        }) : this.find("[name][data-cotomy-key]");
-    }
-    get usePathKey() {
-        const use = this.pathKeyInputs.length > 0 || this.requiresExternalKey;
-        if (use && this.hasExternalKey && CotomyDebugSettings.isEnabled(CotomyDebugFeature.FormLoad)) {
-            console.warn("Both externalKey and pathKeyInputs are present. Using externalKey and ignoring pathKeyInputs.");
-        }
-        return use;
-    }
-    get pathKeyString() {
-        return this.externalKey || this.pathKeyInputs.map(e => e.value).join("/");
-    }
     async submitToApiAsync(formData) {
         const response = await super.submitToApiAsync(formData);
-        if (this.requiresExternalKey && response.status === StatusCodes.CREATED) {
-            this.setExternalKey(response);
+        if (this.requiresEntityKey && response.status === StatusCodes.CREATED) {
+            this.setEntityKey(response);
         }
         return response;
     }
@@ -2684,9 +2657,7 @@ class CotomyEntityFillApiForm extends CotomyEntityApiForm {
         return new CotomyViewRenderer(this, this.bindNameGenerator());
     }
     async loadAsync() {
-        const hasPathKeys = this.pathKeyInputs.length > 0 && this.pathKeyInputs.every(e => !!e.value);
-        const hasKeyInputs = this.keyInputs.length > 0 && this.keyInputs.every(e => !!e.value);
-        if (!this.hasExternalKey && !hasPathKeys && !hasKeyInputs) {
+        if (!this.hasEntityKey) {
             return new CotomyApiResponse();
         }
         const api = this.apiClient();
@@ -2738,8 +2709,6 @@ class CotomyEntityFillApiForm extends CotomyEntityApiForm {
             await this.fillObjectAsync(this.bindNameGenerator(), await response.objectAsync());
             await this.renderer().applyAsync(response);
         }
-        this.pathKeyInputs.forEach(e => e.readonly = true);
-        this.keyInputs.forEach(e => e.readonly = true);
         this.find("textarea").forEach(e => e.input());
     }
 }