create-zuplo-api 1.0.0 → 1.4.0

package/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) Zuplo, Inc. All rights reserved.
+
+This software and associated documentation files (the "Software") is intended to be used
+only by Zuplo customers solely to develop and test applications that will be deployed
+to Zuplo hosted services. You and others in your organization may use these files on your
+Development Devices solely for the above stated purpose.
+
+Outside of uses stated above, no license is granted for any other purpose including
+without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, host, and/or sell copies of the Software.
+
+The software may include third party components with separate legal notices or governed by
+other agreements, as described in licenses either embedded in or accompanying 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,16 @@
+# create-zuplo-api
+
+The official way to create a new Zuplo API Gateway.
+
+<p align="center">
+  <img src="https://github.com/zuplo/zuplo/blob/main/media/screenshot-cli.png?raw=true" width="800">
+</p>
+
+## Usage
+
+```sh
+npm create zuplo-api@latest
+```
+
+Do not omit the @latest tag, otherwise `npm` may resolve to a cached and
+outdated version of this package.

package/create-zuplo-api.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+/* eslint-disable */
+process.removeAllListeners("warning");
+import "./dist/cli.js";

package/dist/cli.js

@@ -0,0 +1,50 @@
+import * as dotenv from "dotenv";
+dotenv.config();
+import * as Sentry from "@sentry/node";
+import { logger } from "./common/logger.js";
+import { printCriticalFailureToConsoleAndExit, printDiagnosticsToConsole, } from "./common/output.js";
+import { gte } from "semver";
+import { readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import { MAX_WAIT_PENDING_TIME_MS, SENTRY_DSN } from "./common/constants.js";
+import { shutdownAnalytics } from "./common/analytics/lib.js";
+import { create } from "./create/handler.js";
+const MIN_NODE_VERSION = "18.0.0";
+if (gte(process.versions.node, MIN_NODE_VERSION)) {
+    let packageJson;
+    try {
+        packageJson = JSON.parse(readFileSync(fileURLToPath(new URL("../package.json", import.meta.url)), "utf-8"));
+    }
+    catch (e) {
+        logger.error(e);
+        printCriticalFailureToConsoleAndExit(`Unable to load create-zuplo-api package. The package.json is missing or malformed.`);
+    }
+    Sentry.init({
+        dsn: SENTRY_DSN,
+        release: packageJson?.version,
+    });
+    try {
+        printDiagnosticsToConsole("");
+        printDiagnosticsToConsole("Zuplo: The Programmable API Gateway");
+        printDiagnosticsToConsole("");
+        await create();
+        void Sentry.close(MAX_WAIT_PENDING_TIME_MS).then(() => {
+            process.exit(0);
+        });
+    }
+    catch (err) {
+        if (err instanceof Error) {
+            Sentry.captureException(err);
+        }
+        printCriticalFailureToConsoleAndExit(err.message ?? err);
+    }
+    finally {
+        await shutdownAnalytics();
+    }
+}
+else {
+    printCriticalFailureToConsoleAndExit(`The create-zuplo-api package requires at least node.js v${MIN_NODE_VERSION}. You are using v${process.versions.node}. Please update your version of node.js.
+
+    Consider using a Node.js version manager such as https://github.com/nvm-sh/nvm.`);
+}
+//# sourceMappingURL=cli.js.map

package/dist/common/analytics/lib.js

@@ -0,0 +1,54 @@
+import { defaultIntegrations } from "@sentry/node";
+import { PostHog } from "posthog-node";
+import { POST_HOG_CAPTURE_KEY, ZUPLO_USER_ID_ARGV_KEY } from "../constants.js";
+import { machineId } from "../machine-id/lib.js";
+let _postHog;
+let _context;
+function init() {
+    if (process.env.ZUPLO_DO_NOT_TRACK) {
+        return undefined;
+    }
+    _postHog = new PostHog(POST_HOG_CAPTURE_KEY, {
+        host: "https://app.posthog.com",
+        flushAt: 1,
+        flushInterval: 1,
+    });
+    _context = defaultIntegrations.filter((integration) => integration.name == "Context")[0];
+    return _postHog;
+}
+export async function captureEvent({ argv, event, properties, groups, sendFeatureFlags, timestamp, disableGeoip, }) {
+    if (_postHog === undefined) {
+        init();
+    }
+    if (_postHog) {
+        properties = properties ?? {};
+        properties.$set_once = properties.$set_once ?? {};
+        if (argv[ZUPLO_USER_ID_ARGV_KEY] &&
+            typeof argv[ZUPLO_USER_ID_ARGV_KEY] === "string") {
+            properties.$set_once["user-id"] = argv[ZUPLO_USER_ID_ARGV_KEY];
+        }
+        if (argv.account && typeof argv.account === "string") {
+            properties.$set_once["account"] = argv["account"];
+        }
+        if (argv.project && typeof argv.project === "string") {
+            properties.$set_once["project"] = argv["project"];
+        }
+        if (process.env.CI) {
+            properties["ci"] = process.env.CI;
+        }
+        await _context?.addContext(properties);
+        _postHog?.capture({
+            distinctId: argv[ZUPLO_USER_ID_ARGV_KEY] || machineId(),
+            event,
+            properties,
+            groups,
+            sendFeatureFlags,
+            timestamp,
+            disableGeoip,
+        });
+    }
+}
+export async function shutdownAnalytics() {
+    return _postHog?.shutdownAsync();
+}
+//# sourceMappingURL=lib.js.map

package/dist/common/constants.js

@@ -0,0 +1,5 @@
+export const ZUPLO_USER_ID_ARGV_KEY = "zuplo-user-id";
+export const SENTRY_DSN = "https://e98d81e78b23b65fa607473823a9957a@o1036703.ingest.sentry.io/4505953760313344";
+export const MAX_WAIT_PENDING_TIME_MS = 1000;
+export const POST_HOG_CAPTURE_KEY = "phc_LDSwSTOvIjiDDZql2g54Q7xEXoQ0EN9RMYb3STbdz1V";
+//# sourceMappingURL=constants.js.map

package/dist/common/logger.js

@@ -0,0 +1,14 @@
+import * as Pino from "pino";
+export const logger = Pino.pino({
+    level: process.env.LOG_LEVEL || "info",
+    transport: {
+        targets: [
+            {
+                target: "@zuplo/pino-pretty-configurations",
+                level: process.env.LOG_LEVEL || "info",
+                options: {},
+            },
+        ],
+    },
+});
+//# sourceMappingURL=logger.js.map

package/dist/common/machine-id/lib.js

@@ -0,0 +1,65 @@
+import { execSync } from "node:child_process";
+import { createHash } from "node:crypto";
+const win32RegBinPath = {
+    skipped: "",
+    native: "%windir%\\System32",
+    mixed: "%windir%\\sysnative\\cmd.exe /c %windir%\\System32",
+};
+const guid = {
+    darwin: "ioreg -rd1 -c IOPlatformExpertDevice",
+    win32: `${win32RegBinPath[isWindowsProcessMixedOrNativeArchitecture()]}\\REG.exe ` +
+        "QUERY HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Cryptography " +
+        "/v MachineGuid",
+    linux: "( cat /var/lib/dbus/machine-id /etc/machine-id 2> /dev/null || hostname ) | head -n 1 || :",
+};
+function isWindowsProcessMixedOrNativeArchitecture() {
+    if (process.platform !== "win32") {
+        return "skipped";
+    }
+    if (process.arch === "ia32" && process.env["PROCESSOR_ARCHITEW6432"]) {
+        return "mixed";
+    }
+    return "native";
+}
+function hash(guid) {
+    return createHash("sha256").update(guid).digest("hex");
+}
+function expose(result) {
+    switch (process.platform) {
+        case "darwin":
+            return result
+                .split("IOPlatformUUID")[1]
+                .split("\n")[0]
+                .replace(/=|\s+]"/gi, "")
+                .toLowerCase();
+        case "win32":
+            return result
+                .toString()
+                .split("REG_SZ")[1]
+                .replace(/\r+|\n+|\s+/gi, "")
+                .toLowerCase();
+        case "linux":
+            return result
+                .toString()
+                .replace(/\r+|\n+|\s+/gi, "")
+                .toLowerCase();
+        case "freebsd":
+            return result
+                .toString()
+                .replace(/\r+|\n+|\s+/gi, "")
+                .toLowerCase();
+        default:
+            throw new Error(`Unsupported platform: ${process.platform}`);
+    }
+}
+export function machineId() {
+    switch (process.platform) {
+        case "darwin":
+        case "win32":
+        case "linux":
+            return hash(expose(execSync(guid[process.platform]).toString()));
+        default:
+            return "e16fc483-5593-4d71-b485-a6533693da9b";
+    }
+}
+//# sourceMappingURL=lib.js.map

package/dist/common/output.js

@@ -0,0 +1,51 @@
+import * as Sentry from "@sentry/node";
+import chalk from "chalk";
+import { MAX_WAIT_PENDING_TIME_MS } from "./constants.js";
+export function printDiagnosticsToConsole(message) {
+    console.error(chalk.bold.blue(message));
+}
+export function printCriticalFailureToConsoleAndExit(message) {
+    console.error(chalk.bold.red(message));
+    void Sentry.close(MAX_WAIT_PENDING_TIME_MS).then(() => {
+        process.exit(1);
+    });
+}
+export function printResultToConsole(message) {
+    console.log(chalk.bold.green(message));
+}
+export function printTableToConsole(table) {
+    console.table(table);
+}
+export function printResultToConsoleAndExitGracefully(message) {
+    printResultToConsole(message);
+    void Sentry.close(MAX_WAIT_PENDING_TIME_MS).then(() => {
+        process.exit(0);
+    });
+}
+export function printTableToConsoleAndExitGracefully(table) {
+    printTableToConsole(table);
+    void Sentry.close(MAX_WAIT_PENDING_TIME_MS).then(() => {
+        process.exit(0);
+    });
+}
+export default function setBlocking() {
+    if (typeof process === "undefined")
+        return;
+    [process.stdout, process.stderr].forEach((_stream) => {
+        const stream = _stream;
+        if (stream._handle &&
+            stream.isTTY &&
+            typeof stream._handle.setBlocking === "function") {
+            stream._handle.setBlocking(true);
+        }
+    });
+}
+export function textOrJson(text) {
+    try {
+        return JSON.parse(text);
+    }
+    catch (e) {
+        return text;
+    }
+}
+//# sourceMappingURL=output.js.map

package/dist/create/handler.js

@@ -0,0 +1,36 @@
+import input from "@inquirer/input";
+import { printCriticalFailureToConsoleAndExit, printDiagnosticsToConsole, printResultToConsole, } from "../common/output.js";
+import { logger } from "../common/logger.js";
+import { captureEvent } from "../common/analytics/lib.js";
+export async function create() {
+    await captureEvent({ argv: {}, event: "create-zuplo-api" });
+    const name = await input({
+        message: "What do you want to name your project?",
+    });
+    if (name) {
+        const core = await import("@zuplo/core");
+        try {
+            const rootDirectory = process.cwd();
+            printDiagnosticsToConsole("");
+            printDiagnosticsToConsole(`Scaffolding project in ${rootDirectory}/${name}...`);
+            const _result = await core.default.create({
+                rootDirectory,
+                name,
+                logger,
+            });
+            printDiagnosticsToConsole("");
+            printDiagnosticsToConsole("Done. Now run:");
+            printDiagnosticsToConsole("");
+            printResultToConsole(`  cd ${name}`);
+            printResultToConsole(`  npm install`);
+            printResultToConsole(`  npm run dev`);
+        }
+        catch (err) {
+            printDiagnosticsToConsole(err.message ?? err);
+        }
+    }
+    else {
+        printCriticalFailureToConsoleAndExit("Please enter a name for your project");
+    }
+}
+//# sourceMappingURL=handler.js.map

package/package.json

@@ -1,12 +1,61 @@
 {
   "name": "create-zuplo-api",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
+  "version": "1.4.0",
+  "type": "module",
+  "repository": "https://github.com/zuplo/create-zuplo-api",
+  "description": "The official way to create a new Zuplo API Gateway",
+  "author": "Zuplo, Inc.",
+  "license": "See LICENSE in LICENSE.txt",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc --build",
+    "sentry:sourcemaps": "sentry-cli sourcemaps inject --org zuplo --project create-zuplo-api ./dist"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC"
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "bin": {
+    "create-zuplo-api": "create-zuplo-api.js"
+  },
+  "lint-staged": {
+    "**/*.{ts,json,md,yml,js,css,html}": [
+      "prettier --write"
+    ],
+    "**/*.{ts,js}": [
+      "eslint --cache --fix --ignore-path .eslintignore"
+    ]
+  },
+  "devDependencies": {
+    "@sentry/cli": "^2.21.1",
+    "@types/node": "^18.5.3",
+    "@types/semver": "^7.5.3",
+    "@typescript-eslint/eslint-plugin": "^6.7.3",
+    "@typescript-eslint/parser": "^6.7.3",
+    "eslint": "^8.50.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-unicorn": "^48.0.1",
+    "husky": "^8.0.3",
+    "lint-staged": "^14.0.1",
+    "prettier-plugin-organize-imports": "^3.2.3",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^3.1.2",
+    "@sentry/node": "^7.72.0",
+    "@swc/core": "^1.3.90",
+    "@zuplo/core": "^5.1327.0",
+    "@zuplo/pino-pretty-configurations": "^1.5.0",
+    "@zuplo/runtime": "^5.1327.0",
+    "chalk": "^5.3.0",
+    "dotenv": "^16.3.1",
+    "esbuild": "^0.19.3",
+    "jsonc-parser": "^3.2.0",
+    "pino": "^8.15.1",
+    "pino-pretty": "^10.2.0",
+    "posthog-node": "^3.1.2",
+    "prettier": "^3.0.3",
+    "rollup-plugin-node-polyfills": "^0.2.1",
+    "semver": "^7.5.4"
+  }
 }