@substrio/cli 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# @substrio/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.
+The Substrio CLI: deploy functions, manage secrets, stream logs, run a local dev server.
+Bin name is `substrio`. Every command is non-interactive when given its flags or stdin, so an agent never needs a TTY.
+
+## Install
+
+```
+npm install -g @substrio/cli
+```
+
+(or run it once with `npx @substrio/cli <command>`).
+
+## Five commands from a fresh machine to a working result
+
+```
+substrio init --url http://localhost:9000 --tenant myapp --yes
+substrio login --url http://localhost:9000 --key - --tenant myapp < keyfile
+substrio status
+substrio dev
+substrio deploy
+```
+
+- `substrio init --url URL --tenant SLUG --yes` scaffolds a project (`substrio.toml`, no key stored in it).
+- `substrio login [--url URL] --key - [--tenant SLUG]` reads the key from stdin (never from argv, never in shell history) and saves a profile. Without `--url` the profile is the hosted platform, `https://mcp.substrio.com`. Set `--profile NAME` to save under a name other than the default.
+- `substrio status` reports server health and the config in use.
+- `substrio dev [--attach URL] [--server PATH] [--port N] [--data DIR] [--no-build] [--no-logs]` runs the app on a local server with hot reload. Data and keys stay under `.substrio/dev` (or `--data DIR`).
+- `substrio deploy [--dry-run]` deploys the declared collections, functions and rules.
+
+## Non-interactive forms
+
+- Any flag that would otherwise prompt takes `-` to read from stdin (for example `substrio login --key -`), or can be set from an environment variable (`SUBSTRIO_SERVER_BIN`, `SUBSTRIO_KEY`; see below).
+- `substrio key export --env FILE [--var NAME] [--force]` writes `NAME=KEY` (default variable name `SUBSTRIO_KEY`) to `FILE`, created owner-only (mode 0600), and never prints the key. Use this to feed a key to an MCP client config or a CI secret store.
+- `substrio mcp config [--client claude|cursor|generic] [--name NAME] [--env VAR]` prints an MCP client config as JSON to stdout (`substrio mcp config > .mcp.json`); the key itself is never read or printed, only a reference to the environment variable.
+
+## Where the key is stored
+
+A saved profile's key lives in the CLI's local config directory, never in `substrio.toml` and never printed by `substrio login` or `substrio init`. To get the key into a file for another tool, use `substrio key export --env FILE` (0600, owner-only).
+
+## The local substrio_server binary
+
+`substrio dev` and `substrio test` need a `substrio_server` binary; the CLI does not download one. `resolveServerBinary` (`src/local/server.mjs`) looks, in order:
+
+1. `--server PATH` given on the command line.
+2. `SUBSTRIO_SERVER_BIN` environment variable.
+3. `substrio_server` on `PATH`.
+4. `build/bin/substrio_server` relative to the checkout the CLI file sits in (only exists when run from a source checkout, never under `node_modules`).
+
+If none of these resolve, the command fails with a `FILE_NOT_FOUND` error and a hint to build the binary (`cmake --build build --target substrio_server`) or pass `--server PATH` / set `SUBSTRIO_SERVER_BIN`.
+
+## Exit codes
+
+| Code | Meaning |
+|---|---|
+| 0 | success |
+| 1 | failure (anything not listed below) |
+| 2 | usage: bad arguments or input |
+| 3 | auth: no credentials, or refused |
+| 4 | not found |
+| 5 | conflict: exists already or changed meanwhile |
+| 6 | server error (5xx) |
+| 7 | network: the server could not be reached |
+| 8 | partial: a bulk operation stored some documents and refused others |
+
+## Docs
+
+See `docs/install.md` in this repository for npm/pnpm/yarn/bun install notes and the server binary's current state.

package/bin/substrio.mjs

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+
+/**
+ * Substrio CLI: main entry point. Global flags are parsed once (src/cli.mjs);
+ * every command, its usage and what it needs come from one table
+ * (src/command-table.mjs). `--help` on any command prints its usage and
+ * exits 0 before anything runs. `substrio help` lists every command.
+ */
+
+import { readFileSync } from 'node:fs';
+import { ErrorCode, applyGlobals, emit, fail, parseGlobal } from '../src/cli.mjs';
+import { COMMANDS, Needs, commandHelp, findCommand, needsOf, topHelp } from '../src/command-table.mjs';
+
+const DIM = '\x1b[2m';
+const RESET = '\x1b[0m';
+// The version is the package's own (package.json, which npm pack ships).
+const VERSION = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8')).version;
+
+// The config and API client a command needs, validated to that level.
+async function contextFor(needs) {
+    if (needs === Needs.NOTHING) return {};
+    const { loadConfig, validateConfig } = await import('../src/config.mjs');
+    const config = loadConfig();
+    if (needs === Needs.CONFIG) return { config };
+    const err = validateConfig(config, needs === Needs.KEY);
+    if (err) fail(err, "Run 'substrio login' or 'substrio init' to configure.", ErrorCode.CREDENTIAL_REQUIRED);
+    const { SubstrioAPI } = await import('../src/api.mjs');
+    return { config, api: new SubstrioAPI(config) };
+}
+
+// --dev: the dev profile of this project (saved by `substrio dev`) decides the server, tenant and key.
+async function selectDevServer(flags) {
+    if (flags.profile) fail('--dev and --profile each select a profile; give one', null, ErrorCode.INVALID_ARGUMENT);
+    const { devConnection } = await import('../src/config.mjs');
+    try {
+        Object.assign(process.env, devConnection(process.cwd()));
+    } catch (err) {
+        fail(err.message, 'Start it with "substrio dev" in this directory.', ErrorCode.CREDENTIAL_REQUIRED);
+    }
+}
+
+async function main() {
+    let parsed;
+    try {
+        parsed = parseGlobal(process.argv.slice(2));
+    } catch (err) {
+        // The flags did not parse; --json still asks for the typed error.
+        applyGlobals({ json: process.argv.includes('--json') });
+        fail(err.message, "Run 'substrio help' for usage.");
+    }
+    const { command, args, flags } = parsed;
+    applyGlobals(flags);
+    if (flags.dev) await selectDevServer(flags);
+
+    if (flags.version) {
+        emit({ version: VERSION }, ({ version }) => console.log(version));
+        return;
+    }
+    if (!command) {
+        console.log(topHelp(VERSION));
+        return;
+    }
+    const entry = findCommand(command);
+    if (!entry) fail(`Unknown command: ${command}`, `Commands: ${COMMANDS.map((c) => c.names[0]).join(', ')}. Run 'substrio help'.`);
+
+    if (flags.help) {
+        // An operation's own help reads the server's catalog (a GET, nothing
+        // changes); without a configured server, or for the command itself,
+        // the usage from the table.
+        if (entry.help && args.length) {
+            const { loadConfig, validateConfig } = await import('../src/config.mjs');
+            const config = loadConfig();
+            if (!validateConfig(config, false)) {
+                const { SubstrioAPI } = await import('../src/api.mjs');
+                try {
+                    if (await entry.help({ api: new SubstrioAPI(config), config, args, command })) return;
+                } catch (err) {
+                    // No catalog or no such operation: the usage below.
+                    console.error(`${DIM}  (${err.message})${RESET}`);
+                }
+            }
+        }
+        console.log(commandHelp(entry));
+        return;
+    }
+
+    const ctx = await contextFor(needsOf(entry, args));
+    await entry.run({ ...ctx, args, command });
+}
+
+main().catch((err) => fail(err, null, ErrorCode.UNKNOWN));

package/package.json

@@ -1,6 +1,46 @@
 {
-  "name": "@substrio/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+    "name": "@substrio/cli",
+    "version": "0.1.1",
+    "description": "Substrio CLI: deploy functions, manage secrets, stream logs",
+    "homepage": "https://github.com/illtronicevents-a11y/substrio#readme",
+    "bugs": "https://github.com/illtronicevents-a11y/substrio/issues",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/illtronicevents-a11y/substrio.git",
+        "directory": "packages/substrio-cli"
+    },
+    "type": "module",
+    "sideEffects": false,
+    "bin": {
+        "substrio": "bin/substrio.mjs"
+    },
+    "exports": {
+        "./test": "./src/testing/index.mjs",
+        "./package.json": "./package.json"
+    },
+    "scripts": {
+        "test": "node --test --test-timeout=60000 \"test/*.test.mjs\""
+    },
+    "files": [
+        "bin/",
+        "src/"
+    ],
+    "dependencies": {
+        "@substrio/sdk": "^0.1.0",
+        "esbuild": "^0.25.10"
+    },
+    "engines": {
+        "node": ">=18.0.0"
+    },
+    "keywords": [
+        "substrio",
+        "baas",
+        "cli",
+        "deploy",
+        "serverless"
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "license": "Apache-2.0"
 }

package/src/api.mjs

@@ -0,0 +1,107 @@
+/**
+ * Substrio CLI: HTTP API Client
+ * 
+ * Wraps built-in fetch with auth headers.
+ * All methods return the raw fetch Response so callers can handle parsing.
+ */
+
+import { CliError, ErrorCode } from './cli.mjs';
+
+/**
+ * The reason a failed API call gives, for people and agents to act on. A substrio
+ * error body carries a generic `error` label for its code and, when the
+ * handler said more, a `detail` (a sentence such as "Tenant already exists",
+ * or the name of the field at fault); both are shown.
+ * @param {any} data      - the parsed error body (may be empty)
+ * @param {number} status - the HTTP status, when the body says nothing
+ * @returns {string}
+ */
+export function errorText(data, status) {
+    const error = data?.error;
+    const label = (typeof error === 'string' ? error : error?.message) || data?.message || '';
+    const detail = typeof data?.detail === 'string' ? data.detail : '';
+    if (detail) return label ? `${label}: ${detail}` : detail;
+    return label || `HTTP ${status}`;
+}
+
+export class SubstrioAPI {
+    /**
+     * @param {object} config - { url, tenant, master_key }
+     */
+    constructor(config) {
+        this.url = config.url;
+        // null: no tenant header (a call that names none, such as a login's
+        // whoami); else the tenant, 'default' when none is configured.
+        this.tenant = config.tenant === null ? null : (config.tenant || 'default');
+        this.masterKey = config.master_key;
+    }
+
+    /**
+     * Make a raw authenticated request. Returns the fetch Response directly.
+     * @param {string} method   - HTTP method
+     * @param {string} path     - API path (e.g., '/v1/_secrets')
+     * @param {any}    [body]   - Request body (string, Buffer, a web ReadableStream sent as it is read, or object → JSON)
+     * @param {object} [extraHeaders] - Additional headers to merge
+     * @returns {Promise<Response>}
+     */
+    async raw(method, path, body = undefined, extraHeaders = {}) {
+        const url = `${this.url}${path}`;
+
+        const headers = {
+            ...(this.tenant === null ? {} : { 'X-Substrio-Tenant': this.tenant }),
+            ...extraHeaders,
+        };
+
+        if (this.masterKey) {
+            headers['X-Substrio-Master-Key'] = this.masterKey;
+        }
+
+        // Default content-type to JSON unless overridden
+        if (!headers['Content-Type']) {
+            headers['Content-Type'] = 'application/json';
+        }
+
+        const opts = { method, headers };
+
+        if (body !== undefined) {
+            if (body instanceof ReadableStream) {
+                opts.body = body;
+                opts.duplex = 'half';
+            } else if (typeof body === 'object' && !(body instanceof Buffer) && !(body instanceof Uint8Array)) {
+                opts.body = JSON.stringify(body);
+            } else {
+                opts.body = body;
+            }
+        }
+
+        try {
+            return await fetch(url, opts);
+        } catch (err) {
+            // No HTTP answer at all: a typed network error (exit code NETWORK).
+            const why = err.cause?.code === 'ECONNREFUSED' ? 'is the Substrio server running?' : (err.cause?.message || err.message);
+            throw new CliError(`Cannot connect to ${this.url}: ${why}`, { code: ErrorCode.NETWORK_ERROR });
+        }
+    }
+
+    // Convenience methods: all return raw Response
+    async get(path) { return this.raw('GET', path); }
+    async post(path, body) { return this.raw('POST', path, body); }
+    async put(path, body) { return this.raw('PUT', path, body); }
+    async patch(path, body) { return this.raw('PATCH', path, body); }
+    async delete(path) { return this.raw('DELETE', path); }
+
+    /**
+     * Legacy request() for backward compat: parses response automatically.
+     */
+    async request(method, path, body = undefined) {
+        const res = await this.raw(method, path, body);
+        let data;
+        const contentType = res.headers.get('content-type') || '';
+        if (contentType.includes('application/json')) {
+            data = await res.json();
+        } else {
+            data = await res.text();
+        }
+        return { status: res.status, data, ok: res.ok };
+    }
+}