@varavel/vdl 0.0.0-dev

package/README.md

@@ -0,0 +1,56 @@
+# Varavel Definition Language (VDL)
+
+Open-source cross-language definition engine for modern stacks. Define your data structures, APIs, contracts, and generate type-safe code for your backend and frontend instantly.
+
+## Installation
+
+```bash
+npm install -g @varavel/vdl
+```
+
+Or as a dev dependency:
+
+```bash
+npm install --save-dev @varavel/vdl
+```
+
+## Usage
+
+After installation, the `vdl` command will be available:
+
+```bash
+vdl --help # See available commands
+```
+
+## Programmatic Usage
+
+You can also use this package programmatically in Node.js:
+
+```javascript
+const vdl = require("@varavel/vdl");
+const { execSync } = require("child_process");
+
+// Get the path to the binary
+console.log(vdl.binaryPath);
+
+// Execute VDL commands
+execSync(`"${vdl.binaryPath}" version`, { stdio: "inherit" });
+```
+
+## Supported Platforms
+
+- **macOS**: x64, ARM64 (Apple Silicon)
+- **Linux**: x64, ARM64
+- **Windows**: x64, ARM64
+
+## How It Works
+
+This package downloads the appropriate pre-compiled VDL binary for your platform during installation. The binary is fetched from the [official GitHub releases](https://github.com/varavelio/vdl/releases).
+
+## Documentation
+
+Visit https://varavel.com/vdl for full documentation.
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,42 @@
+#!/usr/bin/env node
+
+const path = require("node:path");
+const fs = require("node:fs");
+
+/**
+ * Get the path to the installed VDL binary
+ * @returns {string} Absolute path to the vdl binary
+ */
+function getBinaryPath() {
+  const binaryName = process.platform === "win32" ? "vdl.exe" : "vdl";
+  const binaryPath = path.join(__dirname, "bin", binaryName);
+
+  if (!fs.existsSync(binaryPath)) {
+    throw new Error(
+      `VDL binary not found at ${binaryPath}. ` +
+        `Installation may have failed. Try reinstalling: npm install @varavel/vdl`,
+    );
+  }
+
+  return binaryPath;
+}
+
+/**
+ * Get the version of the installed VDL package (without v prefix)
+ * @returns {string} Version string
+ */
+function getVersion() {
+  const packageJson = require("./package.json");
+  return packageJson.version;
+}
+
+module.exports = {
+  getBinaryPath,
+  getVersion,
+  binaryPath: getBinaryPath(),
+};
+
+// If run directly, print the binary path
+if (require.main === module) {
+  console.log(getBinaryPath());
+}

package/install.js

@@ -0,0 +1,312 @@
+#!/usr/bin/env node
+
+const { execSync } = require("node:child_process");
+const fs = require("node:fs");
+const path = require("node:path");
+const https = require("node:https");
+
+const PLATFORM_MAP = {
+  darwin: "darwin",
+  linux: "linux",
+  win32: "windows",
+};
+
+const ARCH_MAP = {
+  x64: "amd64",
+  arm64: "arm64",
+};
+
+/**
+ * Gets the platform name in VDL release format.
+ * @returns {string} Platform name (darwin, linux, or windows)
+ * @throws {Error} If the platform is not supported
+ */
+function getPlatform() {
+  const platform = PLATFORM_MAP[process.platform];
+  if (!platform) {
+    throw new Error(
+      `Unsupported platform: ${process.platform}. VDL supports darwin, linux, and win32.`,
+    );
+  }
+  return platform;
+}
+
+/**
+ * Gets the architecture name in VDL release format.
+ * @returns {string} Architecture name (amd64 or arm64)
+ * @throws {Error} If the architecture is not supported
+ */
+function getArch() {
+  const arch = ARCH_MAP[process.arch];
+  if (!arch) {
+    throw new Error(
+      `Unsupported architecture: ${process.arch}. VDL supports x64 and arm64.`,
+    );
+  }
+  return arch;
+}
+
+/**
+ * Gets the version from package.json.
+ * @returns {string} Version string without 'v' prefix
+ */
+function getVersion() {
+  const packageJson = require("./package.json");
+  return packageJson.version.replace(/^v/, "");
+}
+
+/**
+ * Gets the binary name for the current platform.
+ * @returns {string} Binary name (vdl.exe for Windows, vdl for others)
+ */
+function getBinaryName() {
+  return process.platform === "win32" ? "vdl.exe" : "vdl";
+}
+
+/**
+ * Constructs the GitHub release download URL for the current platform.
+ * @returns {string} Download URL
+ */
+function getDownloadURL() {
+  const version = getVersion();
+  const platform = getPlatform();
+  const arch = getArch();
+  const ext = platform === "windows" ? "zip" : "tar.gz";
+  const filename = `vdl_${platform}_${arch}.${ext}`;
+
+  return `https://github.com/varavelio/vdl/releases/download/v${version}/${filename}`;
+}
+
+/**
+ * Ensures the bin directory exists and returns its path.
+ * @returns {string} Absolute path to the bin directory
+ */
+function ensureBinDir() {
+  const binDir = path.join(__dirname, "bin");
+  if (!fs.existsSync(binDir)) fs.mkdirSync(binDir, { recursive: true });
+  return binDir;
+}
+
+/**
+ * Extracts a tar.gz archive and locates the VDL binary.
+ * @param {Buffer} buffer - Archive buffer
+ * @param {string} binDir - Target bin directory
+ * @param {string} binaryName - Expected binary name
+ * @returns {Promise<void>}
+ * @throws {Error} If extraction fails or binary not found
+ */
+function extractTarGz(buffer, binDir, binaryName) {
+  return new Promise((resolve, reject) => {
+    const now = Date.now().toString();
+    const tempTar = path.join(binDir, `${now}_temp.tar.gz`);
+    const tempDir = path.join(binDir, `${now}_temp_extract`);
+
+    try {
+      fs.writeFileSync(tempTar, buffer);
+
+      if (!fs.existsSync(tempDir)) {
+        fs.mkdirSync(tempDir, { recursive: true });
+      }
+
+      execSync(`tar -xzf "${tempTar}" -C "${tempDir}"`, {
+        stdio: "pipe",
+      });
+
+      let binaryFound = false;
+      const searchPaths = [
+        path.join(tempDir, binaryName),
+        path.join(tempDir, "vdl", binaryName),
+      ];
+
+      for (const searchPath of searchPaths) {
+        if (fs.existsSync(searchPath)) {
+          const destPath = path.join(binDir, binaryName);
+          fs.copyFileSync(searchPath, destPath);
+          fs.chmodSync(destPath, 0o755);
+          binaryFound = true;
+          break;
+        }
+      }
+
+      if (!binaryFound) {
+        const files = execSync(`find "${tempDir}" -type f`, {
+          encoding: "utf8",
+        });
+        reject(
+          new Error(
+            `Binary ${binaryName} not found in archive.\nFound files:\n${files}`,
+          ),
+        );
+      } else {
+        resolve();
+      }
+    } catch (error) {
+      reject(new Error(`Failed to extract tar.gz: ${error.message}`));
+    } finally {
+      try {
+        if (fs.existsSync(tempTar)) {
+          fs.unlinkSync(tempTar);
+        }
+        if (fs.existsSync(tempDir)) {
+          fs.rmSync(tempDir, { recursive: true, force: true });
+        }
+      } catch (_) {}
+    }
+  });
+}
+
+/**
+ * Extracts a zip archive and locates the VDL binary.
+ * @param {Buffer} buffer - Archive buffer
+ * @param {string} binDir - Target bin directory
+ * @param {string} binaryName - Expected binary name
+ * @returns {Promise<void>}
+ * @throws {Error} If extraction fails or binary not found
+ */
+function extractZip(buffer, binDir, binaryName) {
+  return new Promise((resolve, reject) => {
+    const now = Date.now().toString();
+    const tempZip = path.join(binDir, `${now}_temp.zip`);
+    const tempDir = path.join(binDir, `${now}_temp_extract`);
+
+    try {
+      fs.writeFileSync(tempZip, buffer);
+
+      if (!fs.existsSync(tempDir)) {
+        fs.mkdirSync(tempDir, { recursive: true });
+      }
+
+      if (process.platform === "win32") {
+        execSync(
+          `powershell -command "Expand-Archive -Path '${tempZip}' -DestinationPath '${tempDir}' -Force"`,
+          { stdio: "pipe" },
+        );
+      } else {
+        execSync(`unzip -q "${tempZip}" -d "${tempDir}"`, { stdio: "pipe" });
+      }
+
+      let binaryFound = false;
+      const searchPaths = [
+        path.join(tempDir, binaryName),
+        path.join(tempDir, "vdl", binaryName),
+      ];
+
+      for (const searchPath of searchPaths) {
+        if (fs.existsSync(searchPath)) {
+          const destPath = path.join(binDir, binaryName);
+          fs.copyFileSync(searchPath, destPath);
+          if (process.platform !== "win32") {
+            fs.chmodSync(destPath, 0o755);
+          }
+          binaryFound = true;
+          break;
+        }
+      }
+
+      if (!binaryFound) {
+        reject(new Error(`Binary ${binaryName} not found after extraction`));
+      } else {
+        resolve();
+      }
+    } catch (error) {
+      reject(new Error(`Failed to extract zip: ${error.message}`));
+    } finally {
+      try {
+        if (fs.existsSync(tempZip)) {
+          fs.unlinkSync(tempZip);
+        }
+        if (fs.existsSync(tempDir)) {
+          fs.rmSync(tempDir, { recursive: true, force: true });
+        }
+      } catch (_) {}
+    }
+  });
+}
+
+/**
+ * Downloads a file from the given URL with redirect support.
+ * @param {string} url - URL to download from
+ * @returns {Promise<Buffer>} Downloaded file as buffer
+ * @throws {Error} If download fails
+ */
+function download(url) {
+  return new Promise((resolve, reject) => {
+    https
+      .get(url, (response) => {
+        if (
+          response.statusCode === 301 ||
+          response.statusCode === 302 ||
+          response.statusCode === 307 ||
+          response.statusCode === 308
+        ) {
+          return download(response.headers.location)
+            .then(resolve)
+            .catch(reject);
+        }
+
+        if (response.statusCode !== 200) {
+          reject(
+            new Error(
+              `Failed to download: HTTP ${response.statusCode}\n` +
+                `URL: ${url}\n` +
+                `This usually means the binary for your platform hasn't been released yet.`,
+            ),
+          );
+          return;
+        }
+
+        const chunks = [];
+        let totalLength = 0;
+
+        response.on("data", (chunk) => {
+          chunks.push(chunk);
+          totalLength += chunk.length;
+        });
+
+        response.on("end", () => {
+          resolve(Buffer.concat(chunks));
+        });
+
+        response.on("error", reject);
+      })
+      .on("error", reject);
+  });
+}
+
+/**
+ * Main installation routine.
+ * Downloads and installs the VDL binary for the current platform.
+ * @returns {Promise<void>}
+ */
+async function install() {
+  try {
+    const platform = getPlatform();
+    const binaryName = getBinaryName();
+    const url = getDownloadURL();
+    const binDir = ensureBinDir();
+
+    const buffer = await download(url);
+
+    if (platform === "windows") {
+      await extractZip(buffer, binDir, binaryName);
+    } else {
+      await extractTarGz(buffer, binDir, binaryName);
+    }
+
+    const binaryPath = path.join(binDir, binaryName);
+    if (!fs.existsSync(binaryPath)) {
+      throw new Error(`Binary not found at ${binaryPath} after installation`);
+    }
+
+    if (process.platform !== "win32") {
+      fs.chmodSync(binaryPath, 0o755);
+    }
+  } catch (error) {
+    console.error("Installation failed:");
+    console.error(error.message);
+    process.exit(1);
+  }
+}
+
+if (require.main === module) install();
+module.exports = { install };

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@varavel/vdl",
+  "version": "0.0.0-dev",
+  "description": "Open-source cross-language definition engine for modern stacks. Define your data structures, APIs, contracts, and generate type-safe code for your backend and frontend instantly.",
+  "author": "Varavel",
+  "license": "MIT",
+  "homepage": "https://varavel.com/vdl",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/varavelio/vdl.git",
+    "directory": "installers/npm"
+  },
+  "bugs": {
+    "url": "https://github.com/varavelio/vdl/issues"
+  },
+  "main": "index.js",
+  "bin": {
+    "vdl": "bin/vdl"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
+  },
+  "keywords": [
+    "rpc",
+    "schema",
+    "codegen",
+    "api",
+    "varavel"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "files": [
+    "bin/",
+    "install.js",
+    "index.js",
+    "README.md"
+  ]
+}