@redmix/api-server 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Redmix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# Redwood [Fastify](https://www.fastify.io) Server
+
+## About
+
+This package contains code for Redwood's Fastify server:
+
+- used during local dev for API Side
+- used for Production Deploys requiring long-running process (i.e. not serverless)
+
+#### TODO
+
+- add code structure walk-through
+- add package leads
+- add contributing related info
+
+## package.json Server Binaries
+
+Run the Redwood Fastify Server programmatically.
+
+From package.json
+
+```
+  "bin": {
+    "rw-api-server-watch": "./dist/watch.js",
+    "rw-log-formatter": "./dist/logFormatter/bin.js",
+    "rw-server": "./dist/index.js"
+  },
+```
+
+> Note: because we use Yargs to parse in index, using these within the context of a Redwood CLI command will throw due to Yargs object "collision". Needs to be re-architected in the future.
+
+### `rw-server`
+
+Indended for dev and prototyping (i.e. pre-production).
+
+This command runs both the API and Web server on the same port and is not performant at scale for production use. Instead, use the separate commands to run the API and (if needed) Web servers independently, along with tools like PM2, Nginx, or Kubernetes, which appropriately handle concurrent requests, errors, static asset, etc. for production contexts.
+
+- Runs web on redwood.toml web.port (default 8910)
+- API listens on web port at path redwood.toml web.apiUrl
+- Command Options:
+  - port (default 8910)
+  - socket (optional)
+  - apiHost (default redwood.toml web.apiUrl)
+
+### `rw-server api`
+
+For production use.
+
+- Runs api on redwood.toml api.port (default 8911)
+- Command Options:
+  - port (default 8911)
+  - socket (optional)
+  - apiRootPath (default '/')
+
+### `rw-server web`
+
+Not optimized for production use at scale (see comments above for `rw-server`). Recommended to use CDN or Nginx as performant alternatives.
+
+- Runs web on redwood.toml web.port (default 8910)
+- GraphQL endpoint is set to redwood.toml web.apiUrl/graphql
+- Command Options:
+  - port (default 8910)
+  - socket (optional)
+  - apiHost (default redwood.toml web.apiUrl)

package/dist/apiCLIConfig.d.ts

@@ -0,0 +1,6 @@
+import type { Argv } from 'yargs';
+import type { APIParsedOptions } from './types';
+export declare const description = "Start a server for serving the api side";
+export declare function builder(yargs: Argv<APIParsedOptions>): void;
+export declare function handler(options: APIParsedOptions): Promise<void>;
+//# sourceMappingURL=apiCLIConfig.d.ts.map

package/dist/apiCLIConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiCLIConfig.d.ts","sourceRoot":"","sources":["../src/apiCLIConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAA;AAEjC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C,eAAO,MAAM,WAAW,4CAA4C,CAAA;AAEpE,wBAAgB,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,gBAAgB,CAAC,QAyBpD;AAED,wBAAsB,OAAO,CAAC,OAAO,EAAE,gBAAgB,iBAGtD"}

package/dist/apiCLIConfig.js

@@ -0,0 +1,71 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var apiCLIConfig_exports = {};
+__export(apiCLIConfig_exports, {
+  builder: () => builder,
+  description: () => description,
+  handler: () => handler
+});
+module.exports = __toCommonJS(apiCLIConfig_exports);
+const description = "Start a server for serving the api side";
+function builder(yargs) {
+  yargs.options({
+    port: {
+      description: "The port to listen at",
+      type: "number",
+      alias: "p"
+    },
+    host: {
+      description: "The host to listen at. Note that you most likely want this to be '0.0.0.0' in production",
+      type: "string"
+    },
+    apiRootPath: {
+      description: "Root path where your api functions are served",
+      type: "string",
+      alias: ["api-root-path", "rootPath", "root-path"],
+      default: "/"
+    },
+    // This became a no-op in v7 because env files weren't loaded by default
+    // but removing it would break yargs parsing for older projects,
+    // so leaving it here so that yargs doesn't throw an error
+    loadEnvFiles: {
+      hidden: true
+    }
+  });
+}
+async function handler(options) {
+  const { handler: handler2 } = await import("./apiCLIConfigHandler.js");
+  await handler2(options);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  builder,
+  description,
+  handler
+});

package/dist/apiCLIConfigHandler.d.ts

@@ -0,0 +1,3 @@
+import type { APIParsedOptions } from './types';
+export declare function handler(options?: APIParsedOptions): Promise<void>;
+//# sourceMappingURL=apiCLIConfigHandler.d.ts.map

package/dist/apiCLIConfigHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiCLIConfigHandler.d.ts","sourceRoot":"","sources":["../src/apiCLIConfigHandler.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C,wBAAsB,OAAO,CAAC,OAAO,GAAE,gBAAqB,iBAqC3D"}

package/dist/apiCLIConfigHandler.js

@@ -0,0 +1,68 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var apiCLIConfigHandler_exports = {};
+__export(apiCLIConfigHandler_exports, {
+  handler: () => handler
+});
+module.exports = __toCommonJS(apiCLIConfigHandler_exports);
+var import_chalk = __toESM(require("chalk"));
+var import_fastify_web = require("@redmix/fastify-web");
+var import_cliHelpers = require("./cliHelpers");
+var import_createServer = require("./createServer");
+async function handler(options = {}) {
+  const timeStart = Date.now();
+  console.log(import_chalk.default.dim.italic("Starting API Server..."));
+  options.apiRootPath = (0, import_fastify_web.coerceRootPath)(options.apiRootPath ?? "/");
+  const fastify = await (0, import_createServer.createServer)({
+    apiRootPath: options.apiRootPath
+  });
+  options.host ??= (0, import_cliHelpers.getAPIHost)();
+  options.port ??= (0, import_cliHelpers.getAPIPort)();
+  await fastify.start();
+  fastify.log.trace(
+    { custom: { ...fastify.initialConfig } },
+    "Fastify server configuration"
+  );
+  fastify.log.trace(`Registered plugins
+${fastify.printPlugins()}`);
+  console.log(import_chalk.default.dim.italic("Took " + (Date.now() - timeStart) + " ms"));
+  let address = fastify.listeningOrigin;
+  if (process.env.NODE_ENV !== "production") {
+    address = address.replace(/http:\/\/\[::\]/, "http://localhost");
+  }
+  const apiServer = import_chalk.default.magenta(`${address}${options.apiRootPath}`);
+  const graphqlEndpoint = import_chalk.default.magenta(`${apiServer}graphql`);
+  console.log(`API server listening at ${apiServer}`);
+  console.log(`GraphQL endpoint at ${graphqlEndpoint}`);
+  process?.send?.("ready");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  handler
+});

package/dist/bin.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=bin.d.ts.map

package/dist/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":""}