@energica-city/shared-amplify-utils/dist/queries/helpers.js

Shared utilities for AWS Amplify projects

import { logger } from '../log';
/**
 * Logs the start of a database operation.
 * @internal
 * @param nameStr - The model name
 * @param operation - The type of operation being performed.
 * @param data - Additional data to log with the operation.
 */
export const logOperation = (nameStr, operation, data) => {
    const presentParticiple = operation === 'create'
        ? 'Creating'
        : operation === 'update'
            ? 'Updating'
            : operation === 'delete'
                ? 'Deleting'
                : operation === 'get'
                    ? 'Getting'
                    : 'Listing';
    logger.info(`${presentParticiple} ${nameStr}`, {
        operation,
        model: nameStr,
        ...(data ? { data } : {}),
    });
};
/**
 * Logs the successful completion of a database operation.
 * @internal
 * @param operation - The type of operation that was completed.
 * @param additionalInfo - Any additional information to include in the log.
 */
export const logSuccess = (operation, additionalInfo) => {
    const pastTense = operation === 'create'
        ? 'created'
        : operation === 'update'
            ? 'updated'
            : operation === 'delete'
                ? 'deleted'
                : operation === 'get'
                    ? 'retrieved'
                    : 'listed';
    logger.info(`Successfully ${pastTense}`, {
        operation,
        ...(additionalInfo ? { additionalInfo } : {}),
    });
};
/**
 * Validates a GraphQL-like response object.
 * Ensures the response is present, correctly structured, and free of errors.
 *
 * @template R The expected type of the `data` property in the response
 * @param props The arguments for the validation
 * @returns The `data` from the response
 * @throws Will throw an error if the response is invalid
 */
export const validateResponse = (props) => {
    const { response, operation, name, input } = props;
    // Validate that response exists
    if (response === null || response === undefined) {
        const errorMsg = `No response received for ${name} ${operation}`;
        logger.error(errorMsg, { input });
        throw new Error(errorMsg);
    }
    // Validate that response has the expected structure
    if (typeof response !== 'object' || !('data' in response)) {
        const errorMsg = `Invalid response structure for ${name} ${operation}`;
        logger.error(errorMsg, { response, input });
        throw new Error(errorMsg);
    }
    const { data, errors } = response;
    // Check for GraphQL errors
    if (errors && errors.length > 0) {
        const errorMessages = errors.map(error => {
            const message = error?.message || 'Unknown error';
            const errorMessage = `GraphQL error during ${name} ${operation}: ${message}`;
            logger.error(errorMessage, { specificError: error, input });
            return errorMessage;
        });
        throw new Error(errorMessages.join('\n'));
    }
    // Validate data presence
    if (data === null || data === undefined) {
        const errorMsg = `No data returned for ${name} ${operation}`;
        logger.error(errorMsg, {
            searchCriteria: input,
            operation,
            model: name,
        });
        throw new Error(errorMsg);
    }
    return data;
};
/**
 * Validates a database response and returns the data if valid.
 * @internal
 * @param response - The response from the database operation.
 * @param operation - The type of operation that was performed.
 * @param input - The input that was provided to the operation.
 * @returns The validated data from the response.
 */
export const validateAndReturn = (response, operation, input) => {
    return validateResponse({
        response,
        operation: 'mutation',
        name: operation,
        input,
    });
};
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../queries/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,OAAe,EACf,SAAwB,EACxB,IAAc,EACR,EAAE;IACR,MAAM,iBAAiB,GACrB,SAAS,KAAK,QAAQ;QACpB,CAAC,CAAC,UAAU;QACZ,CAAC,CAAC,SAAS,KAAK,QAAQ;YACtB,CAAC,CAAC,UAAU;YACZ,CAAC,CAAC,SAAS,KAAK,QAAQ;gBACtB,CAAC,CAAC,UAAU;gBACZ,CAAC,CAAC,SAAS,KAAK,KAAK;oBACnB,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,SAAS,CAAC;IAEtB,MAAM,CAAC,IAAI,CAAC,GAAG,iBAAiB,IAAI,OAAO,EAAE,EAAE;QAC7C,SAAS;QACT,KAAK,EAAE,OAAO;QACd,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1B,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,SAAwB,EACxB,cAAwB,EAClB,EAAE;IACR,MAAM,SAAS,GACb,SAAS,KAAK,QAAQ;QACpB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,SAAS,KAAK,QAAQ;YACtB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,SAAS,KAAK,QAAQ;gBACtB,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,SAAS,KAAK,KAAK;oBACnB,CAAC,CAAC,WAAW;oBACb,CAAC,CAAC,QAAQ,CAAC;IAErB,MAAM,CAAC,IAAI,CAAC,gBAAgB,SAAS,EAAE,EAAE;QACvC,SAAS;QACT,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC9C,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAI,KAKnC,EAAK,EAAE;IACN,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IAEnD,gCAAgC;IAChC,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAChD,MAAM,QAAQ,GAAG,4BAA4B,IAAI,IAAI,SAAS,EAAE,CAAC;QACjE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,oDAAoD;IACpD,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,IAAI,QAAQ,CAAC,EAAE,CAAC;QAC1D,MAAM,QAAQ,GAAG,kCAAkC,IAAI,IAAI,SAAS,EAAE,CAAC;QACvE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;IAElC,2BAA2B;IAC3B,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YACvC,MAAM,OAAO,GACV,KAA8B,EAAE,OAAO,IAAI,eAAe,CAAC;YAC9D,MAAM,YAAY,GAAG,wBAAwB,IAAI,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;YAC7E,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YAC5D,OAAO,YAAY,CAAC;QACtB,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,yBAAyB;IACzB,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,wBAAwB,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7D,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE;YACrB,cAAc,EAAE,KAAK;YACrB,SAAS;YACT,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QACH,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,QAA6B,EAC7B,SAAiB,EACjB,KAAc,EACX,EAAE;IACL,OAAO,gBAAgB,CAAC;QACtB,QAAQ;QACR,SAAS,EAAE,UAAU;QACrB,IAAI,EAAE,SAAS;QACf,KAAK;KACN,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["import { logger } from '../log';\nimport type { OperationType, DatabaseResponse } from './types';\n\n/**\n * Logs the start of a database operation.\n * @internal\n * @param nameStr - The model name\n * @param operation - The type of operation being performed.\n * @param data - Additional data to log with the operation.\n */\nexport const logOperation = (\n  nameStr: string,\n  operation: OperationType,\n  data?: unknown,\n): void => {\n  const presentParticiple =\n    operation === 'create'\n      ? 'Creating'\n      : operation === 'update'\n        ? 'Updating'\n        : operation === 'delete'\n          ? 'Deleting'\n          : operation === 'get'\n            ? 'Getting'\n            : 'Listing';\n\n  logger.info(`${presentParticiple} ${nameStr}`, {\n    operation,\n    model: nameStr,\n    ...(data ? { data } : {}),\n  });\n};\n\n/**\n * Logs the successful completion of a database operation.\n * @internal\n * @param operation - The type of operation that was completed.\n * @param additionalInfo - Any additional information to include in the log.\n */\nexport const logSuccess = (\n  operation: OperationType,\n  additionalInfo?: unknown,\n): void => {\n  const pastTense =\n    operation === 'create'\n      ? 'created'\n      : operation === 'update'\n        ? 'updated'\n        : operation === 'delete'\n          ? 'deleted'\n          : operation === 'get'\n            ? 'retrieved'\n            : 'listed';\n\n  logger.info(`Successfully ${pastTense}`, {\n    operation,\n    ...(additionalInfo ? { additionalInfo } : {}),\n  });\n};\n\n/**\n * Validates a GraphQL-like response object.\n * Ensures the response is present, correctly structured, and free of errors.\n *\n * @template R The expected type of the `data` property in the response\n * @param props The arguments for the validation\n * @returns The `data` from the response\n * @throws Will throw an error if the response is invalid\n */\nexport const validateResponse = <R>(props: {\n  response: { data: R | null; errors?: unknown[] } | null | undefined;\n  operation: string;\n  name: string;\n  input?: unknown;\n}): R => {\n  const { response, operation, name, input } = props;\n\n  // Validate that response exists\n  if (response === null || response === undefined) {\n    const errorMsg = `No response received for ${name} ${operation}`;\n    logger.error(errorMsg, { input });\n    throw new Error(errorMsg);\n  }\n\n  // Validate that response has the expected structure\n  if (typeof response !== 'object' || !('data' in response)) {\n    const errorMsg = `Invalid response structure for ${name} ${operation}`;\n    logger.error(errorMsg, { response, input });\n    throw new Error(errorMsg);\n  }\n\n  const { data, errors } = response;\n\n  // Check for GraphQL errors\n  if (errors && errors.length > 0) {\n    const errorMessages = errors.map(error => {\n      const message =\n        (error as { message?: string })?.message || 'Unknown error';\n      const errorMessage = `GraphQL error during ${name} ${operation}: ${message}`;\n      logger.error(errorMessage, { specificError: error, input });\n      return errorMessage;\n    });\n    throw new Error(errorMessages.join('\\n'));\n  }\n\n  // Validate data presence\n  if (data === null || data === undefined) {\n    const errorMsg = `No data returned for ${name} ${operation}`;\n    logger.error(errorMsg, {\n      searchCriteria: input,\n      operation,\n      model: name,\n    });\n    throw new Error(errorMsg);\n  }\n\n  return data;\n};\n\n/**\n * Validates a database response and returns the data if valid.\n * @internal\n * @param response - The response from the database operation.\n * @param operation - The type of operation that was performed.\n * @param input - The input that was provided to the operation.\n * @returns The validated data from the response.\n */\nexport const validateAndReturn = <T>(\n  response: DatabaseResponse<T>,\n  operation: string,\n  input: unknown,\n): T => {\n  return validateResponse({\n    response,\n    operation: 'mutation',\n    name: operation,\n    input,\n  });\n};\n"]}