@ramathibodi/nuxt-commons 4.0.3 → 4.0.4

package/README.md

@@ -107,6 +107,11 @@ npm run lint
 npm run test
 ```
 
+## Concepts
+
+- [Model Components — Endpoint Reference](docs/model-endpoints.md) — how `modelName` translates to GraphQL operations and REST API endpoints, with body/response shapes and the `By<Qualifier>` rule for `model/*` components.
+- [Document Template JSON Spec](docs/document-template-json-spec.md) — schema and conventions for document templates.
+
 ## Documentation
 
 Generate documentation artifacts from source:

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": "^4.3.1"
   },
-  "version": "4.0.3",
+  "version": "4.0.4",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/runtime/composables/apiModel.d.ts

@@ -1,15 +1,16 @@
 import type { FormDialogCallback } from '../types/formDialog.js';
 import { type GraphqlModelConfigProps } from './graphqlModelOperation.js';
-interface ApiHeaderProps {
-    headers?: any[];
-}
-interface ApiInitialDataProps {
-    initialData?: Record<string, any>;
-}
+import type { HeaderProps, InitialDataProps } from './graphqlModel.js';
 export interface ApiModelProps {
     api?: boolean;
 }
-export type ApiModelComposableProps = GraphqlModelConfigProps & Partial<ApiHeaderProps> & Partial<ApiInitialDataProps>;
+export type ApiModelComposableProps = GraphqlModelConfigProps & Partial<HeaderProps> & Partial<InitialDataProps>;
+/**
+ * Strip a `By<Qualifier>` suffix from a model name (mirrors GraphQL's
+ * `computedModelName` rule). Used for mutation/search endpoint resolution.
+ * Reads keep the full modelName so qualifiers like `ByGroupKey` survive.
+ */
+export declare function stripModelByQualifier(modelName: string): string;
 /**
  * Build a REST API endpoint URL for a model.
  * @param modelName - The model name (e.g., 'Patient')
@@ -37,4 +38,3 @@ export declare function useApiModel<T extends ApiModelComposableProps>(props: T)
     reload: () => void;
     isLoading: import("vue").Ref<boolean, boolean>;
 };
-export {};

package/dist/runtime/composables/apiModel.js

@@ -4,6 +4,9 @@ import { useAlert } from "./alert.js";
 import { useApi } from "./api.js";
 import { arrayWrap } from "../utils/array.js";
 import pLimit from "p-limit";
+export function stripModelByQualifier(modelName) {
+  return modelName.split("By")[0].trim();
+}
 export function buildApiEndpoint(modelName, action) {
   const lowercasedName = modelName.charAt(0).toLowerCase() + modelName.slice(1);
   const base = `/model/${lowercasedName}`;
@@ -46,12 +49,12 @@ export function useApiModel(props) {
     }
     return [.../* @__PURE__ */ new Set([...fieldsProps, ...tmpFields])];
   });
-  function getModelName() {
-    return props.modelName.split("By")[0].trim();
+  function mutationModelName() {
+    return stripModelByQualifier(props.modelName);
   }
   function createItem(item, callback, importing = false) {
     isLoading.value = true;
-    const endpoint = buildApiEndpoint(getModelName(), "create");
+    const endpoint = buildApiEndpoint(mutationModelName(), "create");
     return api.postPromise(endpoint, { input: item, fields: fields.value }).then((result) => {
       if (canServerPageable.value) {
         if (!importing) loadItems(currentOptions.value);
@@ -89,7 +92,7 @@ export function useApiModel(props) {
   }
   function updateItem(item, callback) {
     isLoading.value = true;
-    const endpoint = buildApiEndpoint(getModelName(), "update");
+    const endpoint = buildApiEndpoint(mutationModelName(), "update");
     return api.postPromise(endpoint, { input: item, fields: fields.value }).then((result) => {
       if (canServerPageable.value) {
         loadItems(currentOptions.value);
@@ -110,7 +113,7 @@ export function useApiModel(props) {
   }
   function deleteItem(item, callback) {
     isLoading.value = true;
-    const endpoint = buildApiEndpoint(getModelName(), "delete");
+    const endpoint = buildApiEndpoint(mutationModelName(), "delete");
     return api.postPromise(endpoint, { input: item, fields: fields.value }).catch((error) => {
       alert?.addAlert({ alertType: "error", message: error?.message || String(error) });
     }).finally(() => {
@@ -121,7 +124,7 @@ export function useApiModel(props) {
   }
   function loadItems(options) {
     currentOptions.value = options;
-    const endpoint = buildApiEndpoint(getModelName(), "pageable");
+    const endpoint = buildApiEndpoint(props.modelName, "pageable");
     isLoading.value = true;
     api.postPromise(
       endpoint,
@@ -148,7 +151,7 @@ export function useApiModel(props) {
       loadItems(currentOptions.value);
     } else {
       isLoading.value = true;
-      const endpoint = buildApiEndpoint(getModelName());
+      const endpoint = buildApiEndpoint(props.modelName);
       api.postPromise(
         endpoint,
         { variables: props.modelBy, fields: fields.value }

package/dist/runtime/composables/apiModelItem.js

@@ -1,7 +1,7 @@
 import { computed, ref, watch } from "vue";
 import { useAlert } from "./alert.js";
 import { useApi } from "./api.js";
-import { buildApiEndpoint } from "./apiModel.js";
+import { buildApiEndpoint, stripModelByQualifier } from "./apiModel.js";
 export function useApiModelItem(props) {
   const alert = useAlert();
   const api = useApi();
@@ -38,7 +38,7 @@ export function useApiModelItem(props) {
   }
   function createItem(createItem2, callback) {
     isLoading.value = true;
-    const endpoint = buildApiEndpoint(props.modelName, "create");
+    const endpoint = buildApiEndpoint(stripModelByQualifier(props.modelName), "create");
     return api.postPromise(endpoint, {
       input: createItem2,
       fields: fields.value
@@ -54,7 +54,7 @@ export function useApiModelItem(props) {
   }
   function updateItem(updateItem2, callback) {
     isLoading.value = true;
-    const endpoint = buildApiEndpoint(props.modelName, "update");
+    const endpoint = buildApiEndpoint(stripModelByQualifier(props.modelName), "update");
     return api.postPromise(endpoint, {
       input: updateItem2,
       fields: fields.value
@@ -70,7 +70,7 @@ export function useApiModelItem(props) {
   }
   function deleteItem(deleteItem2, callback) {
     isLoading.value = true;
-    const endpoint = buildApiEndpoint(props.modelName, "delete");
+    const endpoint = buildApiEndpoint(stripModelByQualifier(props.modelName), "delete");
     return api.postPromise(endpoint, {
       input: deleteItem2,
       fields: fields.value

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ramathibodi/nuxt-commons",
-  "version": "4.0.3",
+  "version": "4.0.4",
   "description": "Ramathibodi Nuxt modules for common components",
   "repository": {
     "type": "git",