@jaypie/express 1.2.20 → 1.2.22

package/dist/cjs/expressHandler.d.ts

@@ -5,6 +5,13 @@ export type JaypieHandlerValidate = (req: Request, res: Response) => Promise<boo
 export type ExpressHandlerLocals = (req: Request, res: Response) => Promise<unknown> | unknown;
 export interface ExpressHandlerOptions {
     chaos?: string;
+    /**
+     * When true, the handler's return value is wrapped with
+     * `fabricApiResponse` before `res.json()`. Plain objects become
+     * `{ data: value }`; pre-wrapped `{ data }` or `{ errors }` payloads
+     * pass through unchanged. `null` / `undefined` become `{ data: null }`.
+     */
+    fabric?: boolean;
     locals?: Record<string, unknown | ExpressHandlerLocals>;
     name?: string;
     secrets?: string[];

package/dist/cjs/fabricApiResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Wrap a service return value in the canonical Jaypie API envelope.
+ *
+ * Rules:
+ * - `null` / `undefined` → `{ data: null }`
+ * - `{ data }` with exactly one key → passthrough
+ * - `{ errors }` with exactly one key → passthrough
+ * - everything else (including `{ data, other }`) → `{ data: value }`
+ *
+ * The "only one key, and that key is `data` or `errors`" check prevents
+ * false positives where a domain object happens to contain a `data` field.
+ */
+export declare function fabricApiResponse(result: unknown): unknown;
+export default fabricApiResponse;

package/dist/cjs/index.cjs

@@ -1357,6 +1357,48 @@ var cors_helper = (config) => {
     };
 };
 
+//
+//
+// Helpers
+//
+function isWrappedData(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        !Array.isArray(value) &&
+        Object.keys(value).length === 1 &&
+        "data" in value);
+}
+function isWrappedErrors(value) {
+    return (typeof value === "object" &&
+        value !== null &&
+        !Array.isArray(value) &&
+        Object.keys(value).length === 1 &&
+        "errors" in value);
+}
+//
+//
+// Main
+//
+/**
+ * Wrap a service return value in the canonical Jaypie API envelope.
+ *
+ * Rules:
+ * - `null` / `undefined` → `{ data: null }`
+ * - `{ data }` with exactly one key → passthrough
+ * - `{ errors }` with exactly one key → passthrough
+ * - everything else (including `{ data, other }`) → `{ data: value }`
+ *
+ * The "only one key, and that key is `data` or `errors`" check prevents
+ * false positives where a domain object happens to contain a `data` field.
+ */
+function fabricApiResponse(result) {
+    if (result === null || result === undefined)
+        return { data: null };
+    if (isWrappedData(result) || isWrappedErrors(result))
+        return result;
+    return { data: result };
+}
+
 //
 //
 // Helper Functions
@@ -1719,7 +1761,7 @@ function expressHandler(handlerOrOptions, optionsOrHandler) {
     //
     // Validate
     //
-    let { chaos, locals, name, secrets, setup = [], teardown = [], unavailable, validate, } = options;
+    let { chaos, fabric, locals, name, secrets, setup = [], teardown = [], unavailable, validate, } = options;
     if (typeof handler !== "function") {
         throw new errors.BadRequestError(`Argument "${handler}" doesn't match type "function"`);
     }
@@ -1873,6 +1915,9 @@ function expressHandler(handlerOrOptions, optionsOrHandler) {
             // Process
             //
             response = (await jaypieFunction(req, res, ...params));
+            if (fabric) {
+                response = fabricApiResponse(response);
+            }
             //
             //
             // Error Handling
@@ -1989,7 +2034,11 @@ function expressHandler(handlerOrOptions, optionsOrHandler) {
         // Replace UUIDs with :id for better aggregation
         path = path.replace(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/gi, ":id");
         // Add request data to session report
-        logger$1.report({ path, status: String(res.statusCode) });
+        logger$1.report({
+            method: req.method,
+            path,
+            status: String(res.statusCode),
+        });
         // Submit metric if Datadog is configured
         if (datadog.hasDatadogEnv()) {
             let metricPrefix = "project";
@@ -2270,7 +2319,11 @@ function expressStreamHandler(handlerOrOptions, optionsOrHandler) {
             }
             path = path.replace(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/gi, ":id");
             // Add request data to session report
-            logger.report({ path, status: String(res.statusCode) });
+            logger.report({
+                method: req.method,
+                path,
+                status: String(res.statusCode),
+            });
             // Submit metric if Datadog is configured
             if (datadog.hasDatadogEnv()) {
                 let metricPrefix = "project";
@@ -2362,6 +2415,7 @@ exports.echoRoute = echoRoute;
 exports.expressHandler = expressHandler;
 exports.expressHttpCodeHandler = httpHandler;
 exports.expressStreamHandler = expressStreamHandler;
+exports.fabricApiResponse = fabricApiResponse;
 exports.forbiddenRoute = forbiddenRoute;
 exports.getCurrentInvoke = getCurrentInvoke;
 exports.getCurrentInvokeUuid = getCurrentInvokeUuid;