@carbonorm/carbonnode 3.7.6 → 3.7.8

package/src/api/utils/normalizeSingularRequest.ts

@@ -0,0 +1,144 @@
+import { C6Constants as C6C } from "../C6Constants";
+import { C6RestfulModel, iRestMethods, RequestQueryBody } from "../types/ormInterfaces";
+
+/**
+ * Converts a singular T-shaped request into complex ORM format for GET/PUT/DELETE
+ * Enforces that all primary keys are present for singular syntax and that the table has PKs.
+ * Optionally accepts a previously removed primary key (key/value) to reconstruct WHERE.
+ */
+export function normalizeSingularRequest<
+  Method extends iRestMethods,
+  T extends Record<string, any>,
+  Custom extends Record<string, any> = {},
+  Overrides extends Record<string, any> = {}
+> (
+  requestMethod: Method,
+  request: RequestQueryBody<Method, T, Custom, Overrides>,
+  restModel: C6RestfulModel<string, T, any>,
+  removedPrimary?: { key: string; value: any }
+): RequestQueryBody<Method, T, Custom, Overrides> {
+  if (request == null || typeof request !== 'object') return request;
+
+  const specialKeys = new Set([
+    C6C.SELECT,
+    C6C.UPDATE,
+    C6C.DELETE,
+    C6C.WHERE,
+    C6C.JOIN,
+    C6C.PAGINATION,
+  ]);
+
+  // Determine if the request is already complex (has any special key besides PAGINATION)
+  const keys = Object.keys(request as any);
+  const hasComplexKeys = keys.some(k => k !== C6C.PAGINATION && specialKeys.has(k));
+  if (hasComplexKeys) return request; // already complex
+
+  // We treat it as singular when it's not complex.
+  // For GET, PUT, DELETE only
+  if (!(requestMethod === C6C.GET || requestMethod === C6C.PUT || requestMethod === C6C.DELETE)) {
+    return request;
+  }
+
+  const pkShorts: string[] = Array.isArray(restModel.PRIMARY_SHORT) ? [...restModel.PRIMARY_SHORT] : [];
+  if (!pkShorts.length) {
+    // For GET requests, do not enforce primary key presence; treat as a collection query.
+    if (requestMethod === C6C.GET) return request;
+    throw new Error(`Table (${restModel.TABLE_NAME}) has no primary key; singular request syntax is not allowed.`);
+  }
+
+  // Build pk map from request + possibly removed primary key
+  const pkValues: Record<string, any> = {};
+  for (const pk of pkShorts) {
+    const fromRequest = (request as any)[pk];
+    if (fromRequest !== undefined && fromRequest !== null) {
+      pkValues[pk] = fromRequest;
+      continue;
+    }
+    if (removedPrimary && removedPrimary.key === pk) {
+      pkValues[pk] = removedPrimary.value;
+      continue;
+    }
+  }
+
+  const missing = pkShorts.filter(pk => !(pk in pkValues));
+  if (missing.length) {
+    // For GET requests, if not all PKs are provided, treat as a collection query and leave as-is.
+    if (requestMethod === C6C.GET) {
+      return request;
+    }
+    throw new Error(`Singular request requires all primary key(s) [${pkShorts.join(', ')}] for table (${restModel.TABLE_NAME}). Missing: [${missing.join(', ')}]`);
+  }
+
+  // Strip API metadata that should remain at root
+  const {
+    dataInsertMultipleRows,
+    cacheResults,
+    fetchDependencies,
+    debug,
+    success,
+    error,
+    ...rest
+  } = request as any;
+
+  if (requestMethod === C6C.GET) {
+    const normalized: any = {
+      WHERE: { ...pkValues },
+    };
+    // Preserve pagination if any was added previously
+    if ((request as any)[C6C.PAGINATION]) {
+      normalized[C6C.PAGINATION] = (request as any)[C6C.PAGINATION];
+    }
+    return {
+      ...normalized,
+      dataInsertMultipleRows,
+      cacheResults,
+      fetchDependencies,
+      debug,
+      success,
+      error,
+    } as any;
+  }
+
+  if (requestMethod === C6C.DELETE) {
+    const normalized: any = {
+      [C6C.DELETE]: true,
+      WHERE: { ...pkValues },
+    };
+    return {
+      ...normalized,
+      dataInsertMultipleRows,
+      cacheResults,
+      fetchDependencies,
+      debug,
+      success,
+      error,
+    } as any;
+  }
+
+  // PUT
+  const updateBody: Record<string, any> = {};
+  for (const k of Object.keys(rest)) {
+    if (pkShorts.includes(k)) continue; // don't update PK columns
+    // Skip special request keys if any slipped through
+    if (specialKeys.has(k)) continue;
+    updateBody[k] = (rest as any)[k];
+  }
+  if (Object.keys(updateBody).length === 0) {
+    throw new Error(`Singular PUT request for table (${restModel.TABLE_NAME}) must include at least one non-primary field to update.`);
+  }
+
+  const normalized: any = {
+    [C6C.UPDATE]: updateBody,
+    WHERE: { ...pkValues },
+  };
+
+  return {
+    ...normalized,
+    dataInsertMultipleRows,
+    cacheResults,
+    fetchDependencies,
+    debug,
+    success,
+    error,
+  } as any;
+}

package/src/index.ts

@@ -35,6 +35,7 @@ export * from "./api/utils/apiHelpers";
 export * from "./api/utils/cacheManager";
 export * from "./api/utils/determineRuntimeJsType";
 export * from "./api/utils/logger";
+export * from "./api/utils/normalizeSingularRequest";
 export * from "./api/utils/sortAndSerializeQueryObject";
 export * from "./api/utils/testHelpers";
 export * from "./api/utils/toastNotifier";