yinzerflow 0.2.10 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yinzerflow",
-  "version": "0.2.10",
+  "version": "0.3.0",
   "author": "Patrick Rizzardi <patrick@redact.digital> (https://redact.digital)",
   "license": "MIT",
   "homepage": "https://github.com/yinzers/YinzerFlow/blob/main/docs/start-here.md",

package/example/README.md

@@ -1,11 +0,0 @@
-For the types to work, you need to connect to the docker container using the IDE
-
-1. Ensure the [Dev Containers](https://marketplace.cursorapi.com/items?itemName=ms-vscode-remote.remote-containers) extension is installed in IDE 
-2. Start this image using `docker compose up -d`
-3. To start the test server run `bun start`
-4. Use `Ctrl + Shift + P`
-5. Select "Dev Containers: Attach to Running Container ..."
-6. Select this container which should be something like `yinzerflow-testing-app...`
-7. In the IDE that just opened, select folder `/app/yinzerflow-local`
-
-To aid in development, you can use the `bun run build:watch` command in the yinzerflow (the actual module) terminal

package/example/app/handlers/example.ts

@@ -1,27 +0,0 @@
-
-import type { HandlerCallback } from 'yinzerflow';
-
-export const exampleHandler: HandlerCallback<{
-    body: {
-        something: string;
-    };
-    response: {
-        message: string;
-        success: boolean;
-        data: {
-            something: string;
-        }
-    }
-}> = async ({ request }) => {
-    const { something } = request.body;
-
-    throw new Error("test");
-
-    return {
-        success: true,
-        message: "Hello World",
-        data: {
-            something
-        }
-    };
-};

package/example/app/index.ts

@@ -1,107 +0,0 @@
-import { registerExampleRoutes } from "@app/routes/example.ts";
-import { registerGroupExampleRoutes } from "@app/routes/group-example.ts";
-import log from "app/util/customLogger.ts";
-import { YinzerFlow, type HandlerCallback } from "yinzerflow";
-
-const app = new YinzerFlow({
-  cors: {
-    enabled: true,
-    origin: "http://localhost:8085",
-    methods: ["GET", "POST", "PUT", "DELETE", "OPTIONS"],
-    allowedHeaders: ["Content-Type", "Authorization", "x-session-id"],
-    preflightContinue: false,
-  },
-  logLevel: "info",
-  networkLogs: true,
-  // logger: log,
-  // networkLogger: log,
-});
-
-
-
-// app.onError((ctx) => {
-//   ctx.response.setStatusCode(500);
-//   return {
-//     success: false,
-//     message: "Something went wrong",
-//   };
-// });
-
-app.onNotFound((ctx) => {
-  ctx.response.setStatusCode(404);
-  return {
-    success: false,
-    message: "Not Found",
-  };
-});
-
-app.beforeAll([
-  (_) => {
-    console.log("======== beforeAll ========");
-  },
-]);
-
-app.afterAll([
-  (ctx) => {
-    // ctx.response.setStatusCode(202);
-    console.log("afterAll");
-  },
-]);
-
-const login: HandlerCallback<{
-  response: {
-    success: boolean;
-    message: string;
-  };
-  body: {
-    email: string;
-    password: string;
-  };
-}> = (({ request }) => {
-  const { email, password } = request.body;
-  console.log("========================");
-  console.log(email, password);
-  console.log("========================");
-
-  return {
-    success: true,
-    message: "Login successful",
-  };
-})
-
-app.post("/login", login);
-
-app.group("/api", (app) => {
-  app.post(
-    "/get/:id",
-    ((ctx) => {
-      console.log("route handler");
-      console.log(ctx.request);
-
-      return {
-        message: false
-      };
-    }),
-    {
-      beforeHooks: [
-        (ctx) => {
-          ctx.response.setStatusCode(200);
-          console.log("beforeRoute");
-        },
-      ],
-      afterHooks: [
-        () => {
-          console.log("afterRoute");
-        },
-      ],
-    }
-  );
-});
-
-// Register example routes
-registerExampleRoutes(app);
-registerGroupExampleRoutes(app);
-
-// Start the server AFTER defining all routes
-await app.listen();
-

package/example/app/routes/example.ts

@@ -1,18 +0,0 @@
-import { exampleHandler } from '@app/handlers/example.ts';
-import type { YinzerFlow } from 'yinzerflow';
-
-/**
- * Register example routes on the main app instance
- */
-export const registerExampleRoutes = (app: YinzerFlow) => {
-    /**
-     * Get all users
-     */
-    app.post('/get-users', exampleHandler);
-
-    /**
-     * Add an override reason for a user to be able to add a payout method
-     * This is used to remove all requirements bypassing any checks such as the $20 minimum balance
-     */
-    // app.post('/user/update', updateUserController);
-};

package/example/app/routes/group-example.ts

@@ -1,13 +0,0 @@
-import { exampleHandler } from '@app/handlers/example.ts';
-import type { YinzerFlow } from 'yinzerflow';
-
-export const registerGroupExampleRoutes = (app: YinzerFlow): void => {
-    app.group('/admin', (group) => {
-        /**
-         * Get all users
-         */
-        group.post('/get-users', exampleHandler);
-
-
-    });
-};

package/example/app/util/customLogger.ts

@@ -1,166 +0,0 @@
-
-import type { TransformableInfo } from 'logform';
-import { addColors, createLogger, format, transports } from 'winston';
-
-/**
- * Logging levels in winston conform to the severity ordering specified by RFC5424: severity of all levels is assumed to
- *  be numerically ascending from most important to least important.
- */
-enum LogLevel {
-  CRITICAL = 0,
-  ERROR = 1,
-  WARN = 2,
-  INFO = 3,
-}
-
-enum LogColor {
-  CRITICAL = 'bold white redBG',
-  ERROR = 'bold red',
-  WARN = 'bold yellow',
-  INFO = 'bold cyan',
-}
-
-interface Transports {
-  console: transports.ConsoleTransportInstance;
-  file: transports.FileTransportInstance;
-}
-
-/**
- * Define the levels that winston will use. This is used later on
- * when we create the logger
- */
-const logLevels = {
-  critical: LogLevel.CRITICAL,
-  error: LogLevel.ERROR,
-  warn: LogLevel.WARN,
-  info: LogLevel.INFO,
-};
-
-
-
-/**
- * This lets us add custom logging levels and colors so that
- * winston recognizes them
- */
-addColors({
-  critical: LogColor.CRITICAL,
-  error: LogColor.ERROR,
-  warn: LogColor.WARN,
-  info: LogColor.INFO,
-});
-
-/**
- * Safely formats a message for logging, handling different types appropriately
- */
-const formatLogMessage = (message: unknown, meta: Record<string, unknown> = {}): string => {
-  let formattedMessage = '';
-
-  if (typeof message === 'string') {
-    formattedMessage = message;
-  } else if (typeof message === 'object' && message !== null) {
-    formattedMessage = JSON.stringify(message);
-  } else {
-    formattedMessage = String(message);
-  }
-
-  const metaKeys = Object.keys(meta);
-  if (metaKeys.length === 0) {
-    return formattedMessage;
-  }
-
-  const formattedMeta = JSON.stringify(meta, null, 2);
-
-  return `${formattedMessage}\n${formattedMeta}`;
-};
-
-/**
- * This is the format that will be used for all logs except File logs
- */
-const formatter = format.combine(
-  /** Adds color to the format */
-  format.colorize(),
-
-  /** Adds timestamp to the format */
-  format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
-
-  /** Format the way the log is output to the console */
-  format.printf((info: TransformableInfo) => {
-    const { timestamp, level, message, ...meta } = info;
-    const formattedMessage = formatLogMessage(message, Object.keys(meta).length > 0 ? meta : undefined);
-    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-    return `${timestamp} [${level}]: ${formattedMessage}`;
-  }),
-);
-
-/**
- * This is the format that will be used for all File logs
- * The only difference is that we don't want to add color because it will mess up the log file
- */
-const fileFormatter = format.combine(
-  /** Adds timestamp to the format */
-  format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }),
-
-  /** Format the way the log is output to the console */
-  format.printf((info: TransformableInfo) => {
-    const { timestamp, level, message, ...meta } = info;
-    const formattedMessage = formatLogMessage(message, Object.keys(meta).length > 0 ? meta : undefined);
-    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-    return `${timestamp} [${level}]: ${formattedMessage}`;
-  }),
-);
-
-/** ======================================== Defineing Transports ============================================ */
-const transporters: Transports = {
-  console: new transports.Console({
-    format: formatter,
-  }),
-  file: new transports.File({
-    filename: 'storage/logs/info.log',
-    format: fileFormatter,
-  }),
-
-};
-
-/**
- * Creates and configures the logger based on the current configuration
- */
-const createConfiguredLogger = (): ReturnType<typeof createLogger> => {
-  const transportsToUse = [];
-  for (const transport of ['console', 'file']) {
-    switch (transport) {
-      case 'console':
-        transportsToUse.push(transporters.console);
-        break;
-      case 'file':
-        transportsToUse.push(transporters.file);
-        break;
-      default:
-        transportsToUse.push(transporters.console);
-        break;
-    }
-  }
-
-  return createLogger({
-    level: 'info',
-    transports: transportsToUse,
-    levels: logLevels,
-  });
-};
-
-// Create the logger with the configured settings
-const log = createConfiguredLogger();
-
-export default log;
-export const networkLog = createLogger({
-  level: 'info',
-  transports: [
-    new transports.Console({
-      format: formatter,
-    }),
-    new transports.File({
-      filename: 'storage/logs/info.log',
-      format: fileFormatter,
-    }),
-  ],
-  levels: logLevels,
-});

package/example/docker-compose.yml

@@ -1,28 +0,0 @@
-services:
-  app:
-    user: bun
-    image: oven/bun:1.2.17
-    working_dir: /app/yinzerflow-local
-    volumes:
-      - .:/app/yinzerflow-local
-      - ../yinzerflow/lib:/app/yinzerflow/lib
-    ports:
-      - "3000:5000"
-    command: sh -c "bun install && tail -f /dev/null"
-    tty: true
-    stdin_open: true
-    networks:
-      - yinzerflow-network
-
-  benchmark:
-    image: williamyeh/wrk
-    restart: no
-    command: ["-t20", "-c400", "-d10s", "http://api:5000/status"]
-    depends_on:
-      - app
-    networks:
-      - yinzerflow-network
-
-networks:
-  yinzerflow-network:
-    driver: bridge

package/example/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "yinzerflow-local",
-  "type": "module",
-  "scripts": {
-    "start": "bun --watch app/index.ts"
-  },
-  "dependencies": {
-    "logform": "^2.7.0",
-    "winston": "^3.17.0",
-    "yinzerflow": "file:../yinzerflow/lib"
-  },
-  "devDependencies": {
-    "bun-types": "1.2.17",
-    "typescript": "^5.8.2"
-  }
-}

package/example/tsconfig.json

@@ -1,54 +0,0 @@
-{
-  "compilerOptions": {
-    "composite": true,
-    "target": "ESNext",
-    "useDefineForClassFields": true,
-    "module": "NodeNext",
-    "lib": ["ESNext"],
-    "skipLibCheck": true,
-    "types": ["bun-types"],
-
-    /* Bundler mode */
-    "moduleResolution": "NodeNext",
-    "moduleDetection": "force",
-    "allowImportingTsExtensions": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "jsx": "preserve",
-    "alwaysStrict": true,
-    "declaration": true,
-    "outDir": "lib",
-    "declarationDir": "lib",
-    "verbatimModuleSyntax": true,
-    "baseUrl": ".",
-    "paths": {
-      "@app/*": ["./app/*"]
-    },
-    "sourceMap": false,
-    "removeComments": true,
-    "declarationMap": true,
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true,
-    "allowSyntheticDefaultImports": true,
-    "allowJs": false,
-    "forceConsistentCasingInFileNames": true,
-    "noImplicitAny": true,
-    "noImplicitReturns": true,
-    "noImplicitThis": true,
-    "noImplicitOverride": true,
-    "strictFunctionTypes": true,
-    "strictNullChecks": true,
-    "strictPropertyInitialization": true,
-    "allowUnreachableCode": false,
-    "allowUnusedLabels": false,
-    "exactOptionalPropertyTypes": true,
-    "noUncheckedIndexedAccess": true,
-    "strictBindCallApply": true
-  },
-  "include": ["app/**/*"]
-}