@oscaraccountant/cli 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OscarAI OÜ
+
+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

@@ -1,3 +1,30 @@
-# Temporary Holding Version
+# @oscaraccountant/cli
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`oscar`, the command-line tool of the Oscar accounting API.
+
+```bash
+npx @oscaraccountant/cli login          # log in in the browser (or --device, or --api-key)
+npx @oscaraccountant/cli whoami
+npx @oscaraccountant/cli invoices list --all
+```
+
+Or install it once: `npm install --global @oscaraccountant/cli`, then run `oscar`.
+
+`oscar login` stores its credential in the keychain of the OS. On a server or
+in CI, set `OSCAR_API_KEY` to an organization API key instead: it wins over
+the login.
+
+The package holds a small Node script. The binary itself comes in one optional package per
+platform (`@oscaraccountant/cli-linux-x64`, `-linux-arm64`, `-darwin-arm64`, `-darwin-x64`,
+`-win32-x64`, `-win32-arm64`), and npm installs only the one for your machine. There is no
+install script.
+
+When `oscar` says that the binary is missing, npm skipped the optional package: this happens
+when a lockfile was made on another platform, or with `--omit=optional`. Delete `node_modules`
+and `package-lock.json` and install again.
+
+The documentation of the commands is `oscar --help`, and the guides and the
+reference of the API are at <https://oscaraccountant.com/docs>. The source is
+<https://github.com/oscaraccountant/oscaraccountant-rust>.
+
+MIT License, copyright OscarAI OÜ.

package/bin/oscar.js

@@ -0,0 +1,153 @@
+#!/usr/bin/env node
+// The `oscar` command of @oscaraccountant/cli. It finds the binary of this platform in its optional
+// dependency @oscaraccountant/cli-<platform>-<arch>, runs it with the same arguments, and ends
+// with the same exit code or signal. No dependency and no postinstall script: the pattern of
+// esbuild and Biome.
+'use strict';
+
+const childProcess = require('child_process');
+const fs = require('fs');
+
+const PACKAGES = {
+  'darwin-arm64': '@oscaraccountant/cli-darwin-arm64',
+  'darwin-x64': '@oscaraccountant/cli-darwin-x64',
+  'linux-x64': '@oscaraccountant/cli-linux-x64',
+  'linux-arm64': '@oscaraccountant/cli-linux-arm64',
+  'win32-x64': '@oscaraccountant/cli-win32-x64',
+  'win32-arm64': '@oscaraccountant/cli-win32-arm64',
+};
+
+// The signals the shim passes on to the binary. On Windows the console sends Ctrl+C to every
+// process on it, so the shim only keeps itself alive.
+const SIGNALS = ['SIGINT', 'SIGTERM', 'SIGHUP', 'SIGQUIT', 'SIGBREAK'];
+
+function version() {
+  try {
+    return require('../package.json').version;
+  } catch {
+    return 'latest';
+  }
+}
+
+/** The platform package of this machine, or null when there is none. */
+function packageName(platform, arch) {
+  return PACKAGES[`${platform}-${arch}`] || null;
+}
+
+/** The message when the binary cannot be found. */
+function missingMessage(platform, arch, name) {
+  if (name === null) {
+    return (
+      `oscar: there is no oscar binary for ${platform}-${arch}.\n` +
+      `The supported platforms are: ${Object.keys(PACKAGES).join(', ')}.\n`
+    );
+  }
+  return (
+    `oscar: the binary for ${platform}-${arch} is missing: the optional package ${name} is not installed.\n` +
+    'This happens when a lockfile was made on another platform (https://github.com/npm/cli/issues/4828),\n' +
+    'or when optional dependencies are turned off (--omit=optional, --no-optional).\n' +
+    'To fix it, delete node_modules and package-lock.json and install again with optional dependencies,\n' +
+    `or run: npx @oscaraccountant/cli@${version()}\n`
+  );
+}
+
+/**
+ * The path of the binary: OSCAR_CLI_BINARY when set (for tests), else the file of the platform
+ * package. null when it is not installed.
+ */
+function binaryPath(env, platform, arch, resolve) {
+  if (env.OSCAR_CLI_BINARY) {
+    return env.OSCAR_CLI_BINARY;
+  }
+  const name = packageName(platform, arch);
+  if (name === null) {
+    return null;
+  }
+  const file = platform === 'win32' ? 'oscar.exe' : 'oscar';
+  try {
+    return resolve(`${name}/bin/${file}`);
+  } catch {
+    return null;
+  }
+}
+
+/** Some package managers drop the executable bit; put it back when the file allows it. */
+function ensureExecutable(file, platform) {
+  if (platform === 'win32') {
+    return;
+  }
+  try {
+    fs.accessSync(file, fs.constants.X_OK);
+  } catch {
+    try {
+      fs.chmodSync(file, 0o755);
+    } catch {
+      // The run below reports the real error.
+    }
+  }
+}
+
+/** The exit code of a process that a signal ended, as a shell reports it. */
+function signalExitCode(signal) {
+  const number = require('os').constants.signals[signal];
+  return 128 + (number || 1);
+}
+
+function main() {
+  const platform = process.platform;
+  const arch = process.arch;
+  const binary = binaryPath(process.env, platform, arch, require.resolve);
+  if (binary === null) {
+    process.stderr.write(missingMessage(platform, arch, packageName(platform, arch)));
+    process.exit(1);
+  }
+  ensureExecutable(binary, platform);
+  const child = childProcess.spawn(binary, process.argv.slice(2), {
+    stdio: 'inherit',
+    windowsHide: false,
+  });
+  const forwarders = new Map();
+  for (const signal of SIGNALS) {
+    const forward = () => {
+      if (platform !== 'win32' && child.exitCode === null) {
+        try {
+          child.kill(signal);
+        } catch {
+          // The child has ended already.
+        }
+      }
+    };
+    try {
+      process.on(signal, forward);
+      forwarders.set(signal, forward);
+    } catch {
+      // A signal this platform does not have.
+    }
+  }
+  child.on('error', (error) => {
+    process.stderr.write(`oscar: cannot run ${binary}: ${error.message}\n`);
+    process.exit(1);
+  });
+  child.on('exit', (code, signal) => {
+    for (const [name, forward] of forwarders) {
+      process.removeListener(name, forward);
+    }
+    if (signal) {
+      // End the same way, so the caller sees the signal.
+      setTimeout(() => process.exit(signalExitCode(signal)), 200);
+      try {
+        process.kill(process.pid, signal);
+      } catch {
+        process.exit(signalExitCode(signal));
+      }
+      return;
+    }
+    process.exit(code === null ? 1 : code);
+  });
+}
+
+module.exports = { PACKAGES, binaryPath, missingMessage, packageName, signalExitCode, version };
+
+if (require.main === module) {
+  main();
+}

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@oscaraccountant/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "oscar, the command-line tool of the Oscar accounting API",
+  "license": "MIT",
+  "author": "OscarAI OÜ",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/oscaraccountant/oscaraccountant-rust.git"
+  },
+  "homepage": "https://oscaraccountant.com/docs",
+  "bugs": {
+    "url": "https://github.com/oscaraccountant/oscaraccountant-rust/issues"
+  },
+  "keywords": [
+    "oscar",
+    "accounting",
+    "api",
+    "cli",
+    "bookkeeping",
+    "invoices",
+    "estonia"
+  ],
+  "bin": {
+    "oscar": "bin/oscar.js"
+  },
+  "files": [
+    "bin/oscar.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "@oscaraccountant/cli-darwin-arm64": "0.1.0",
+    "@oscaraccountant/cli-darwin-x64": "0.1.0",
+    "@oscaraccountant/cli-linux-x64": "0.1.0",
+    "@oscaraccountant/cli-linux-arm64": "0.1.0",
+    "@oscaraccountant/cli-win32-x64": "0.1.0",
+    "@oscaraccountant/cli-win32-arm64": "0.1.0"
+  }
+}