jaypie

Prerequisites: Node.js 22+

Overview

The jaypie package is the main entry point for Jaypie applications. It re-exports utilities from multiple Jaypie packages for convenient single-import access.

Installation

npm install jaypie

Quick Reference

Re-exported Packages

Package	Exports
@jaypie/aws	getEnvSecret, getSecret, loadEnvSecrets, sendMessage, getMessages
@jaypie/datadog	submitMetric
@jaypie/errors	All error classes, isJaypieError, jaypieErrorFromStatus
@jaypie/express	expressHandler, expressStreamHandler, cors
@jaypie/kit	force, uuid, sleep, cloneDeep, environment checks
@jaypie/lambda	lambdaHandler, lambdaStreamHandler
@jaypie/logger	log

Exports

Error Classes

import {
  BadGatewayError,
  BadRequestError,
  ConfigurationError,
  ForbiddenError,
  GatewayTimeoutError,
  GoneError,
  InternalError,
  MethodNotAllowedError,
  NotFoundError,
  NotImplementedError,
  RejectedError,
  TeapotError,
  TooManyRequestsError,
  UnavailableError,
  UnauthorizedError,
  isJaypieError,
  jaypieErrorFromStatus,
} from "jaypie";

Handlers

import {
  expressHandler,
  expressStreamHandler,
  lambdaHandler,
  lambdaStreamHandler,
  cors,
} from "jaypie";

Logging

import { log } from "jaypie";

log.trace("message");
log.debug("message");
log.info("message");
log.warn("message");
log.error("message");
log.fatal("message");
log.var({ key: value });

Utilities

import {
  cloneDeep,
  force,
  sleep,
  uuid,
} from "jaypie";

// Type coercion
force.array(value);
force.boolean(value);
force.number(value);
force.object(value);
force.positive(value);
force.string(value);

// UUID generation
const id = uuid();

// Async sleep
await sleep(1000);

// Deep clone
const copy = cloneDeep(original);

Environment Checks

import {
  isLocalEnv,
  isNodeTestEnv,
  isProductionEnv,
} from "jaypie";

if (isLocalEnv()) { /* PROJECT_ENV === "local" */ }
if (isProductionEnv()) { /* PROJECT_ENV === "production" */ }
if (isNodeTestEnv()) { /* NODE_ENV === "test" */ }

AWS Integration

import {
  getEnvSecret,
  getMessages,
  getSecret,
  getSingletonMessage,
  loadEnvSecrets,
  sendMessage,
} from "jaypie";

// Secrets
const secret = await getEnvSecret("API_KEY");
await loadEnvSecrets("API_KEY", "DB_URI");

// SQS
await sendMessage({ data: "payload" });
const messages = getMessages(sqsEvent);

Datadog

import { submitMetric } from "jaypie";

submitMetric("api.requests", 1, { endpoint: "/users" });

Constants

import { HTTP, JAYPIE } from "jaypie";

HTTP.CODE.OK;           // 200
HTTP.CODE.NOT_FOUND;    // 404
JAYPIE.LIB.EXPRESS;     // "@jaypie/express"

Usage Examples

Express Handler

import { expressHandler, log, NotFoundError } from "jaypie";

export default expressHandler(
  async (req, res) => {
    log.trace("[getUser] fetching");
    const user = await db.users.findById(req.params.id);
    if (!user) throw NotFoundError();
    return { data: user };
  },
  {
    name: "getUser",
    secrets: ["MONGODB_URI"],
  }
);

Lambda Handler

import { lambdaHandler, log, getMessages } from "jaypie";

export const handler = lambdaHandler(
  async (event) => {
    const messages = getMessages(event);
    for (const msg of messages) {
      log.trace("[process] handling message");
      await processMessage(msg);
    }
    return { processed: messages.length };
  },
  {
    name: "processQueue",
  }
);

Peer Dependencies

For additional functionality, install optional packages:

# LLM integration
npm install @jaypie/llm

# CDK constructs
npm install @jaypie/constructs

Related

• Handler Lifecycle - Handler patterns
• Error Handling - Error types
• Logging - Logging best practices
• @jaypie/kit - Utility functions