ts-prorm-orm 1.1.0 → 1.2.1

package/dist/cli/commands/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Aggregates every cloud/account command module and registers it. Each module
+// under this directory exports `commands: Command[]`; add a module here when you
+// add a new command group.
+const framework_1 = require("../framework");
+const auth_1 = require("./auth");
+const billing_1 = require("./billing");
+const pull_1 = require("./pull");
+const db_1 = require("./db");
+const store_1 = require("./store");
+const teams_1 = require("./teams");
+const keys_1 = require("./keys");
+const code_1 = require("./code");
+const runners_1 = require("./runners");
+const scaffold_1 = require("./scaffold");
+const config_1 = require("./config");
+const user_1 = require("./user");
+const secrets_1 = require("./secrets");
+const misc_1 = require("./misc");
+const system_1 = require("./system");
+(0, framework_1.register)(...auth_1.commands, ...billing_1.commands, ...pull_1.commands, ...db_1.commands, ...store_1.commands, ...teams_1.commands, ...keys_1.commands, ...code_1.commands, ...runners_1.commands, ...scaffold_1.commands, ...config_1.commands, ...user_1.commands, ...secrets_1.commands, ...misc_1.commands, ...system_1.commands);

package/dist/cli/commands/keys.d.ts

@@ -0,0 +1,2 @@
+import type { Command } from '../framework';
+export declare const commands: Command[];

package/dist/cli/commands/keys.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commands = void 0;
+// API Keys command module for the prorm CLI. Manages team-scoped API keys
+// (create, list, revoke) against the dashboard API. Keys are always scoped to a
+// team, resolved from --team or the stored default team slug.
+const framework_1 = require("../framework");
+const cloud_1 = require("../cloud");
+/** Resolve the team slug from --team or the stored default. */
+function resolveTeam(ctx) {
+    return ctx.flags.team || (0, cloud_1.loadConfig)().teamSlug;
+}
+const create = (0, framework_1.defineCommand)({
+    name: 'key create',
+    description: 'Create a team-scoped API key (the full key is shown only once).',
+    group: 'API Keys',
+    flags: [
+        { name: 'name', type: 'string', description: 'Human-readable name for the key.', required: true },
+        { name: 'team', type: 'string', description: 'Team slug (defaults to the selected team).' },
+        { name: 'expires', type: 'string', description: "Expiry, e.g. '30d' or an ISO date." },
+        { name: 'scopes', type: 'string', description: 'Comma-separated list of scopes.' },
+    ],
+    examples: [
+        'orm-cli key create --name ci-deploy',
+        'orm-cli key create --name ci-deploy --team acme --expires 30d',
+        'orm-cli key create --name reader --scopes read:db,read:storage',
+    ],
+    run: async (ctx) => {
+        (0, cloud_1.requireAuth)();
+        const team = resolveTeam(ctx);
+        if (!team) {
+            framework_1.out.error('No team selected (use --team).');
+            return 1;
+        }
+        const name = ctx.flags.name;
+        const expires = ctx.flags.expires;
+        const scopes = ctx.flags.scopes;
+        const data = await (0, cloud_1.api)('/api/dashboard/teams/' + team + '/keys', {
+            method: 'POST',
+            body: { name, expires, scopes: scopes ? scopes.split(',') : undefined },
+        });
+        framework_1.out.success('API key created — copy it now, it will not be shown again:');
+        framework_1.out.info(data.key);
+        framework_1.out.dim(`id ${data.id}, prefix ${data.prefix}`);
+        return 0;
+    },
+});
+const list = (0, framework_1.defineCommand)({
+    name: 'key list',
+    description: 'List the team-scoped API keys (full keys are never shown).',
+    group: 'API Keys',
+    flags: [
+        { name: 'team', type: 'string', description: 'Team slug (defaults to the selected team).' },
+        { name: 'json', type: 'boolean', description: 'Output raw JSON.' },
+    ],
+    examples: ['orm-cli key list', 'orm-cli key list --team acme', 'orm-cli key list --json'],
+    run: async (ctx) => {
+        (0, cloud_1.requireAuth)();
+        const team = resolveTeam(ctx);
+        if (!team) {
+            framework_1.out.error('No team selected (use --team).');
+            return 1;
+        }
+        const data = await (0, cloud_1.api)('/api/dashboard/teams/' + team + '/keys');
+        if (ctx.flags.json) {
+            framework_1.out.json(data);
+            return 0;
+        }
+        framework_1.out.table(data.keys.map((k) => ({
+            id: k.id,
+            name: k.name,
+            prefix: k.prefix,
+            lastUsedAt: k.lastUsedAt,
+            expiresAt: k.expiresAt,
+            revoked: k.revoked,
+        })));
+        return 0;
+    },
+});
+const revoke = (0, framework_1.defineCommand)({
+    name: 'key revoke',
+    description: 'Revoke a team-scoped API key by id.',
+    group: 'API Keys',
+    positionals: [{ name: 'id', description: 'The API key id to revoke.', required: true }],
+    flags: [{ name: 'team', type: 'string', description: 'Team slug (defaults to the selected team).' }],
+    examples: ['orm-cli key revoke key_123', 'orm-cli key revoke key_123 --team acme'],
+    run: async (ctx) => {
+        (0, cloud_1.requireAuth)();
+        const team = resolveTeam(ctx);
+        if (!team) {
+            framework_1.out.error('No team selected (use --team).');
+            return 1;
+        }
+        const id = ctx.positionals[0];
+        await (0, cloud_1.api)('/api/dashboard/teams/' + team + '/keys/' + id + '/revoke', { method: 'POST' });
+        framework_1.out.success(`Revoked key ${id}`);
+        return 0;
+    },
+});
+exports.commands = [create, list, revoke];

package/dist/cli/commands/misc.d.ts

@@ -0,0 +1,2 @@
+import type { Command } from '../framework';
+export declare const commands: Command[];

package/dist/cli/commands/misc.js

@@ -0,0 +1,282 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commands = void 0;
+// Miscellaneous top-level commands for the prorm CLI: docs search (backed by
+// AWS OpenSearch), a dashboard status summary, a browser opener, the CLI
+// version, and a connectivity ping. These sit outside the auth/db/storage
+// groups and are collected under the "Misc" group.
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const child_process_1 = require("child_process");
+const framework_1 = require("../framework");
+const cloud_1 = require("../cloud");
+const system_1 = require("./system");
+// ─── Helpers ──────────────────────────────────────────────────────────────────
+/** Heuristic: did an API error come from an unauthenticated (401) response? */
+function isUnauthorized(err) {
+    const msg = err instanceof Error ? err.message : String(err);
+    return /\b401\b/.test(msg) || /unauthori[sz]ed/i.test(msg);
+}
+/** Human-readable byte count. */
+function formatBytes(bytes) {
+    if (!Number.isFinite(bytes) || bytes <= 0)
+        return '0 B';
+    const units = ['B', 'KB', 'MB', 'GB', 'TB'];
+    const i = Math.min(units.length - 1, Math.floor(Math.log(bytes) / Math.log(1024)));
+    const value = bytes / 1024 ** i;
+    return `${i === 0 ? value : value.toFixed(1)} ${units[i]}`;
+}
+/** Platform command + args to open a URL in the default browser. */
+function browserOpener(url) {
+    switch (process.platform) {
+        case 'darwin':
+            return { cmd: 'open', args: [url] };
+        case 'win32':
+            // `start` is a cmd builtin; the empty "" is the window title arg.
+            return { cmd: 'cmd', args: ['/c', 'start', '', url] };
+        default:
+            return { cmd: 'xdg-open', args: [url] };
+    }
+}
+/** Read the CLI/library version from the nearest package.json. */
+function readVersion() {
+    for (const rel of ['../package.json', '../../package.json']) {
+        try {
+            const raw = fs.readFileSync(path.join(__dirname, rel), 'utf8');
+            const pkg = JSON.parse(raw);
+            if (pkg.version)
+                return pkg.version;
+        }
+        catch {
+            // Try the next candidate.
+        }
+    }
+    return undefined;
+}
+// ─── Commands ─────────────────────────────────────────────────────────────────
+const search = (0, framework_1.defineCommand)({
+    name: 'search',
+    description: 'Search the prorm docs (backed by AWS OpenSearch).',
+    group: 'Misc',
+    positionals: [
+        { name: 'query', description: 'Words to search for.', required: true, variadic: true },
+    ],
+    flags: [
+        { name: 'limit', type: 'number', description: 'Max number of results.', default: 8 },
+        { name: 'json', type: 'boolean', description: 'Output raw JSON.' },
+    ],
+    examples: [
+        'orm-cli search connection pooling',
+        'orm-cli search "custom dialect" --limit 3',
+        'orm-cli search migrations --json',
+    ],
+    run: async (ctx) => {
+        const query = ctx.positionals.join(' ').trim();
+        if (!query) {
+            framework_1.out.error('A search query is required.');
+            return 1;
+        }
+        const limit = typeof ctx.flags.limit === 'number' ? ctx.flags.limit : 8;
+        const { results } = await (0, cloud_1.api)('/api/search', {
+            method: 'POST',
+            body: { query, limit },
+            auth: false,
+        });
+        if (ctx.flags.json) {
+            framework_1.out.json(results);
+            return 0;
+        }
+        if (!results.length) {
+            framework_1.out.info(`No results for "${query}".`);
+            return 0;
+        }
+        framework_1.out.table(results.map((r) => ({ title: r.title, href: r.href })));
+        return 0;
+    },
+});
+const status = (0, framework_1.defineCommand)({
+    name: 'status',
+    description: 'Show a summary of your prorm account, team, and resource usage.',
+    group: 'Misc',
+    flags: [{ name: 'json', type: 'boolean', description: 'Output raw JSON.' }],
+    examples: ['orm-cli status', 'orm-cli status --json'],
+    run: async (ctx) => {
+        let data;
+        try {
+            data = await (0, cloud_1.api)('/api/dashboard/status');
+        }
+        catch (err) {
+            if (isUnauthorized(err)) {
+                framework_1.out.warn('Not logged in');
+                framework_1.out.dim(`API: ${(0, cloud_1.loadConfig)().apiUrl}`);
+                framework_1.out.info('Run `orm-cli auth login` to sign in.');
+                return 1;
+            }
+            throw err;
+        }
+        if (ctx.flags.json) {
+            framework_1.out.json(data);
+            return 0;
+        }
+        if (data.user) {
+            framework_1.out.info(`User:     ${data.user.name ?? data.user.email ?? data.user.id ?? '(unknown)'}`);
+        }
+        if (data.team) {
+            framework_1.out.info(`Team:     ${data.team.name ?? data.team.slug ?? data.team.id}`);
+        }
+        if (data.plan)
+            framework_1.out.info(`Plan:     ${data.plan}`);
+        const counts = data.counts;
+        framework_1.out.info(`Code:     ${counts.code}`);
+        framework_1.out.info(`Runners:  ${counts.runners}`);
+        framework_1.out.info(`Databases: ${counts.databases}`);
+        framework_1.out.info(`Storage:  ${formatBytes(counts.storageBytes)}`);
+        return 0;
+    },
+});
+const OPEN_PATHS = {
+    dashboard: '/dashboard',
+    teams: '/dashboard/teams',
+    databases: '/dashboard/databases',
+    storage: '/dashboard/storage',
+    docs: '/docs',
+};
+const open = (0, framework_1.defineCommand)({
+    name: 'open',
+    description: 'Open a prorm dashboard or docs page in your browser.',
+    group: 'Misc',
+    positionals: [
+        {
+            name: 'target',
+            description: 'What to open.',
+            choices: Object.keys(OPEN_PATHS),
+        },
+    ],
+    examples: ['orm-cli open', 'orm-cli open databases', 'orm-cli open docs'],
+    run: (ctx) => {
+        const target = ctx.positionals[0] ?? 'dashboard';
+        const routePath = OPEN_PATHS[target] ?? OPEN_PATHS.dashboard;
+        const base = (0, cloud_1.loadConfig)().apiUrl.replace(/\/?$/, '');
+        const url = `${base.replace(/\/$/, '')}${routePath}`;
+        framework_1.out.info(`Opening ${url}`);
+        try {
+            const { cmd, args } = browserOpener(url);
+            const child = (0, child_process_1.spawn)(cmd, args, { detached: true, stdio: 'ignore' });
+            child.on('error', () => framework_1.out.dim(url));
+            child.unref();
+        }
+        catch {
+            // Couldn't spawn an opener — the URL is already printed above.
+            framework_1.out.dim(url);
+        }
+        return 0;
+    },
+});
+const version = (0, framework_1.defineCommand)({
+    name: 'version',
+    description: 'Print the prorm CLI version.',
+    group: 'Misc',
+    examples: ['orm-cli version'],
+    flags: [{ name: 'check-update', type: 'boolean', description: 'Also check the npm registry for a newer version.' }],
+    run: async (ctx) => {
+        const v = readVersion();
+        if (!v) {
+            framework_1.out.error('Could not determine version (package.json not found).');
+            return 1;
+        }
+        framework_1.out.info(v);
+        if (ctx.flags['check-update']) {
+            const info = await (0, system_1.fetchLatestVersion)(v);
+            if (info.updateAvailable) {
+                framework_1.out.warn(`A newer version is available: v${info.latest} (run \`orm-cli upgrade\`).`);
+            }
+            else if (info.latest) {
+                framework_1.out.dim('You are on the latest version.');
+            }
+        }
+        return 0;
+    },
+});
+const ping = (0, framework_1.defineCommand)({
+    name: 'ping',
+    description: 'Check whether the prorm API is reachable and measure latency.',
+    group: 'Misc',
+    flags: [{ name: 'json', type: 'boolean', description: 'Output raw JSON.' }],
+    examples: ['orm-cli ping', 'orm-cli ping --json'],
+    run: async (ctx) => {
+        const apiUrl = (0, cloud_1.loadConfig)().apiUrl;
+        const start = Date.now();
+        let reachable = true;
+        let degraded = false;
+        let error;
+        try {
+            // Unauthenticated: any completed HTTP response (even 401/5xx) proves the
+            // host is reachable. Only a NetworkError (DNS/timeout/refused) is "down".
+            await (0, cloud_1.api)('/api/dashboard/status', { auth: false, retries: 0 });
+        }
+        catch (err) {
+            if (err instanceof cloud_1.NetworkError) {
+                reachable = false;
+                error = err.message;
+            }
+            else {
+                // Reachable but the server returned an error (e.g. a 500) — reachable,
+                // but flag it as degraded rather than pretending everything is fine.
+                const status = err.status;
+                if (typeof status === 'number' && status >= 500) {
+                    degraded = true;
+                    error = err instanceof Error ? err.message : String(err);
+                }
+            }
+        }
+        const latencyMs = Date.now() - start;
+        if (ctx.flags.json) {
+            framework_1.out.json({ apiUrl, reachable, degraded, latencyMs, error });
+            return reachable ? 0 : 1;
+        }
+        if (reachable && degraded) {
+            framework_1.out.warn(`${apiUrl} reachable in ${latencyMs}ms but returned a server error${error ? `: ${error}` : ''}`);
+            return 0;
+        }
+        if (reachable) {
+            framework_1.out.success(`${apiUrl} reachable in ${latencyMs}ms`);
+            return 0;
+        }
+        framework_1.out.error(`${apiUrl} unreachable${error ? `: ${error}` : ''}`);
+        return 1;
+    },
+});
+exports.commands = [search, status, open, version, ping];

package/dist/cli/commands/pull.d.ts

@@ -0,0 +1,2 @@
+import type { Command } from '../framework';
+export declare const commands: Command[];