@ahqstore/cli 0.10.6 → 0.10.7

package/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "ahqstore_cli_rs"
-version = "0.10.6"
+version = "0.10.7"
 description = "AHQ Store CLI"
 repository = "https://github.com/ahqstore/cli"
 homepage = "https://github.com/ahqstore/cli"

package/README.md

@@ -2,38 +2,87 @@
 
 Read more about it [here](https://ahqstore.github.io)
 
-# Changelog
+This is the Official AHQ Store CLI and the CLI with the most number of ports.
+The original CLI has been written in rust lang and we're quite excited to tell you how versatile this tool actually is. This tool is **OFFICIALLY** available and mainted for :
 
-## 0.6.0 **(m)** 05-Sep-2024 10:37PM IST
+- [Crates.io (Original)](https://crates.io/crates/ahqstore_cli_rs)
+- [npmjs (Port)](https://www.npmjs.com/package/@ahqstore/cli)
+- [jsr (Port)](https://jsr.io/@ahqstore/cli)
+- [PyPi (Port)](https://pypi.org/project/ahqstore-cli/)
+- [Nuget (Port)](https://www.nuget.org/packages/AHQStoreCLI)
+- [Golang (Port; Not Tested)](https://github.com/ahqstore/cli/tree/main/go)
 
-- Introduced ahqstore-types apps validation
-- Now you can view schemas in [docs.rs](https://docs.rs/ahqstore_cli_rs)
-- Update Dependencies
+All the platforms use the same codebase (the rust codebase). We're making use of the C-Abi to
+make the CLI compatible to the following languages/runtimes:
 
-## 0.5.5 03-Sep-2024 10:20PM IST
+- Cargo
+- NodeJS
+- Deno
+- Bun
+- Python
+- .NET C#
+- Golang
 
-- update ahqstore-types
+# Usage
 
-## 0.5.4 01-Sep-2024 10:07PM IST
+Head over to https://ahqstore.github.io/guide/cli/ for usage references!
 
-- **[CRITICAL]** Fixes invalid config files being generated
+# Installation
 
-## 0.5.1 23-Aug-2024 10:09PM IST
+## Rust
 
-- Fix NPM Publish error
+There are two ways to install in Rust Lang, `cargo install` and `cargo binstall`
 
-## 0.5.0 **(I)** 23-Aug-2024 10:05PM IST
+## cargo install (official)
 
-- Update to the new resources scheme (ahqstore-types v3.1.0)
-- Update Dependencies
+```sh
+cargo install ahqstore_cli_rs
+```
 
-## 0.4.x **(m)**
+### cargo binstall
 
-- Update to ahqstore-types 2.3.0
+```sh
+cargo binstall ahqstore_cli_rs
+```
 
-**NOTE:**
+## NodeJS
 
-- **I** Internal Breaking Changes
-- **m** Minor Breaking / Minor Addition Changes
-- **B** Breaking Changes
-- **P** Patch Changes
+```sh
+npm i -g @ahqstore/cli
+```
+
+## Deno
+
+### Using npmjs
+
+```sh
+deno install -g npm:@ahqstore/cli
+```
+
+### Using JSR
+
+```sh
+deno install -A -f -g -n ahqstore https://jsr.io/@ahqstore/cli/0.10.7/js/cli.js
+```
+
+## Bun
+
+```sh
+bun install -g @ahqstore/cli
+```
+
+## Python
+
+```sh
+pip install ahqstore-cli
+```
+
+## GoLang
+
+To be yet figured out
+
+## .NET C#
+
+```sh
+dotnet tool install --global AHQStoreCLI
+```

package/js/cli.js

@@ -1,9 +1,12 @@
 #! /usr/bin/env node
 // @ts-check
 
-import { join } from "node:path";
+/* @ts-self-types="./types.d.ts" */
+
+import { join, dirname } from "node:path";
 import { existsSync, mkdirSync, rmSync } from "node:fs";
 import { argv, env, platform } from "node:process";
+import { fileURLToPath } from 'node:url';
 
 import { downloadModuleWithProgress } from "./download.js";
 
@@ -12,7 +15,12 @@ import c from "ansi-colors";
 import koffi from "koffi";
 
 import pkg from "../package.json" with { type: "json" };
+import { homedir } from "node:os";
 
+/**
+ * This function is internal and should not be used
+ * @returns {{ prefix: string; suffix: string; }}
+ */
 export function getPrefixSuffix() {
   let prefix = "";
   let suffix = "";
@@ -39,7 +47,9 @@ export function getPrefixSuffix() {
 }
 
 /**
+ * This function is internal and should not be used
  * @param {string} name
+ * @returns {string}
  */
 function getLibraryFilename(name) {
   const { prefix, suffix } = getPrefixSuffix();
@@ -47,7 +57,18 @@ function getLibraryFilename(name) {
   return `${prefix}${name}${suffix}`;
 }
 
-const dylibDir = join(import.meta.dirname, "lib");
+let __dirname = `${homedir()}/ahqstore-js`;
+
+try {
+  __dirname = dirname(fileURLToPath(import.meta.url));
+} catch (e) {
+  try {
+    mkdirSync(`${__dirname}`);
+    mkdirSync(`${__dirname}/lib`);
+  } catch (e) {}
+}
+
+const dylibDir = join(__dirname, "lib");
 const dylib = join(dylibDir, getLibraryFilename("ahqstore_cli_rs"));
 
 if (!(existsSync(dylibDir) && existsSync(dylib))) {

package/js/download.js

@@ -16,6 +16,10 @@ const bar = new SingleBar({
   hideCursor: true,
 });
 
+/**
+ * This function is internal and should not be used
+ * @returns {string}
+ */
 function getDownload() {
   const { prefix, suffix } = getPrefixSuffix();
 
@@ -23,14 +27,14 @@ function getDownload() {
 }
 
 /**
- * 
+ * This function is internal and should not be used
  * @param {number} ms 
  * @returns {Promise<undefined>}
  */
 const delay = (ms) => new Promise((resolve) => setTimeout(() => resolve(undefined), ms));
 
 /**
- * 
+ * This function is internal and should not be used
  * @param {string} file 
  * @returns {Promise<undefined>}
  */

package/jsr.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://jsr.io/schema/config-file.v1.json",
+  "name": "@ahqstore/cli",
+  "version": "0.10.7",
+  "license": "MIT",
+  "exports": {
+    ".": "./js/cli.js"
+  },
+  "publish": {
+    "include": ["./js/**/**", "package.json", "README.md"]
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahqstore/cli",
-  "version": "0.10.6",
+  "version": "0.10.7",
   "description": "AHQ Store Official CLI, A port of the rust version to NodeJS",
   "keywords": [
     "cli",
@@ -21,7 +21,7 @@
   "bin": {
     "ahqstore": "./js/cli.js"
   },
-  "readme": "README.md",
+  "readme": "./README.md",
   "scripts": {
     "postinstall": "node js/postinstall.js"
   },
@@ -32,5 +32,8 @@
   },
   "engines": {
     "node": ">=22"
+  },
+  "devDependencies": {
+    "jsr": "^0.13.5"
   }
 }