@shuffl/cli 0.3.0 → 0.5.0

package/dist/index.js

@@ -3,7 +3,7 @@ import { chmod, mkdir, readFile, rename, rm, writeFile, } from 'node:fs/promises
 import { createRequire } from 'node:module';
 import { homedir } from 'node:os';
 import { dirname, join } from 'node:path';
-import { createShuffl, ORPCError } from '@shuffl/sdk';
+import { createShuffl, createShufflCompany, ORPCError } from '@shuffl/sdk';
 import { commands } from './commands.generated.js';
 // package.json sits one level above both src/ and dist/.
 const { version } = createRequire(import.meta.url)('../package.json');
@@ -43,7 +43,7 @@ function parse(args) {
         const [name, ...value] = arg.slice(2).split('=');
         if (!name || name in flags)
             throw new Error(`Duplicate or invalid flag: ${arg}`);
-        if (['help', 'json', 'token-stdin', 'version'].includes(name)) {
+        if (['company', 'help', 'json', 'token-stdin', 'version'].includes(name)) {
             if (value.length)
                 throw new Error(`--${name} takes no value`);
             flags[name] = true;
@@ -72,6 +72,31 @@ function scalar(raw, schema) {
         return JSON.parse(raw);
     return raw;
 }
+async function save(file, credentials) {
+    await mkdir(dirname(file), { mode: 0o700, recursive: true });
+    const temporary = `${file}.${randomUUID()}.tmp`;
+    try {
+        await writeFile(temporary, JSON.stringify(credentials) + '\n', {
+            flag: 'wx',
+            mode: 0o600,
+        });
+        await rename(temporary, file);
+        await chmod(file, 0o600);
+    }
+    finally {
+        await rm(temporary, { force: true });
+    }
+}
+async function load(file) {
+    try {
+        return JSON.parse(await readFile(file, 'utf8'));
+    }
+    catch (error) {
+        if (error.code !== 'ENOENT')
+            throw new Error('Cannot read CLI configuration. Run shuffl login again.');
+        return undefined;
+    }
+}
 export async function runCli(args, io = {
     env: process.env,
     stderr: (s) => process.stderr.write(s),
@@ -81,8 +106,12 @@ export async function runCli(args, io = {
     const json = args.includes('--json');
     try {
         const { positional, flags } = parse(args);
-        const configFile = join(io.env.SHUFFL_CONFIG_DIR ??
-            join(io.env.XDG_CONFIG_HOME ?? join(homedir(), '.config'), 'shuffl'), 'config.json');
+        const configDirectory = io.env.SHUFFL_CONFIG_DIR ??
+            join(io.env.XDG_CONFIG_HOME ?? join(homedir(), '.config'), 'shuffl');
+        const configFile = join(configDirectory, 'config.json');
+        // #1692: a company key is saved apart from the workspace key, and only
+        // `shuffl company` commands send it.
+        const companyFile = join(configDirectory, 'company.json');
         if (flags.version && !positional.length) {
             io.stdout(json ? `${JSON.stringify({ version })}\n` : `${version}\n`);
             return 0;
@@ -90,27 +119,38 @@ export async function runCli(args, io = {
         if (flags.help || !positional.length) {
             const definition = commands.find((c) => c.command.join(' ') === positional.join(' '));
             io.stdout(definition
-                ? `${definition.summary}\nPermission: ${definition.permission} (${definition.access})\n\nshuffl ${definition.command.join(' ')} [--input JSON | --input-file FILE] [--json]\n${Object.entries(definition.input?.properties ?? {})
+                ? `${definition.summary}\nPermission: ${definition.permission} (${definition.access})${definition.credential === 'company' ? '\nCredential: a company key (SHUFFL_COMPANY_KEY or shuffl login --company)' : ''}\n\nshuffl ${definition.command.join(' ')} [--input JSON | --input-file FILE] [--json]\n${Object.entries(definition.input?.properties ?? {})
                     .map(([key, value]) => `  --${key.replace(/[A-Z]/g, (c) => `-${c.toLowerCase()}`)} <${value.type ?? 'json'}>`)
                     .join('\n')}\n`
-                : `Shuffl CLI ${version}\n\n  shuffl login --base-url URL --token-stdin\n  shuffl logout\n  shuffl --version\n${commands.map((c) => `  shuffl ${c.command.join(' ')} — ${c.summary}`).join('\n')}\n\nUse --help on a command for inputs. Use --json for machine-readable output.\nCreate a key in Settings → API keys and choose the endpoint permissions this CLI needs.\n`);
+                : `Shuffl CLI ${version}\n\n  shuffl login --base-url URL --token-stdin\n  shuffl login --company --base-url URL --token-stdin\n  shuffl logout [--company]\n  shuffl --version\n${commands.map((c) => `  shuffl ${c.command.join(' ')} — ${c.summary}`).join('\n')}\n\nUse --help on a command for inputs. Use --json for machine-readable output.\nCreate a key in Settings → API keys and choose the endpoint permissions this CLI needs.\nshuffl company commands use a company key from Company settings → API keys instead.\n`);
             return 0;
         }
         if (positional.length === 1 && positional[0] === 'logout') {
-            if (Object.keys(flags).some((k) => k !== 'json'))
+            if (Object.keys(flags).some((k) => !['company', 'json'].includes(k)))
                 throw new Error('Unknown logout flag.');
-            await rm(configFile, { force: true });
+            await rm(flags.company ? companyFile : configFile, { force: true });
             io.stdout(json
                 ? '{}\n'
-                : 'Signed out locally. Revoke the token in Settings to disable other copies.\n');
+                : `Signed out locally. Revoke the ${flags.company ? 'key in Company settings' : 'token in Settings'} to disable other copies.\n`);
             return 0;
         }
         if (positional.length === 1 && positional[0] === 'login') {
-            if (Object.keys(flags).some((k) => !['base-url', 'token-stdin', 'json'].includes(k)))
+            if (Object.keys(flags).some((k) => !['base-url', 'company', 'token-stdin', 'json'].includes(k)))
                 throw new Error('Unknown login flag.');
             if (!flags['token-stdin'] || typeof flags['base-url'] !== 'string')
                 throw new Error('Use login --base-url URL --token-stdin. The token is read from standard input.');
             const token = (await io.stdin()).trim();
+            if (flags.company) {
+                if (!/^shuffl_company_[A-Za-z0-9_-]{43}$/.test(token))
+                    throw new Error('Expected a Shuffl company key.');
+                const baseUrl = new URL(flags['base-url']).origin;
+                const company = await request(() => createShufflCompany({ baseUrl, token }).current());
+                await save(companyFile, { baseUrl, token });
+                io.stdout(json
+                    ? JSON.stringify({ company }) + '\n'
+                    : `Signed in to company ${company.organizationId} with ${company.permissions.length} permission${company.permissions.length === 1 ? '' : 's'}.\n`);
+                return 0;
+            }
             if (!/^shuffl_api_[A-Za-z0-9_-]{43}$/.test(token))
                 throw new Error('Expected a Shuffl API token.');
             const baseUrl = new URL(flags['base-url']).origin;
@@ -119,19 +159,7 @@ export async function runCli(args, io = {
                 token,
             });
             const team = await request(() => client.teams.current());
-            await mkdir(dirname(configFile), { mode: 0o700, recursive: true });
-            const temporary = `${configFile}.${randomUUID()}.tmp`;
-            try {
-                await writeFile(temporary, JSON.stringify({ baseUrl, token }) + '\n', {
-                    flag: 'wx',
-                    mode: 0o600,
-                });
-                await rename(temporary, configFile);
-                await chmod(configFile, 0o600);
-            }
-            finally {
-                await rm(temporary, { force: true });
-            }
+            await save(configFile, { baseUrl, token });
             io.stdout(json ? JSON.stringify({ team }) + '\n' : `Signed in to ${team.name}.\n`);
             return 0;
         }
@@ -165,25 +193,26 @@ export async function runCli(args, io = {
                     throw new Error(`Input ${key} was provided more than once.`);
                 input[key] = scalar(flags[flag], fields[key]);
             }
-        let saved;
-        try {
-            saved = JSON.parse(await readFile(configFile, 'utf8'));
-        }
-        catch (error) {
-            if (error.code !== 'ENOENT')
-                throw new Error('Cannot read CLI configuration. Run shuffl login again.');
-        }
-        const token = io.env.SHUFFL_TOKEN ?? saved?.token;
+        const company = command.credential === 'company';
+        const environmentToken = company
+            ? io.env.SHUFFL_COMPANY_KEY
+            : io.env.SHUFFL_TOKEN;
+        const saved = await load(company ? companyFile : configFile);
+        const token = environmentToken ?? saved?.token;
         const baseUrl = typeof flags['base-url'] === 'string'
             ? flags['base-url']
             : (io.env.SHUFFL_BASE_URL ?? saved?.baseUrl);
         if (!token || !baseUrl)
-            throw new Error('Run shuffl login, or set SHUFFL_TOKEN and SHUFFL_BASE_URL.');
-        if (!io.env.SHUFFL_TOKEN &&
+            throw new Error(company
+                ? 'Run shuffl login --company, or set SHUFFL_COMPANY_KEY and SHUFFL_BASE_URL.'
+                : 'Run shuffl login, or set SHUFFL_TOKEN and SHUFFL_BASE_URL.');
+        if (!environmentToken &&
             saved &&
             new URL(baseUrl).origin !== new URL(saved.baseUrl).origin)
             throw new Error('Saved credentials belong to a different server. Sign in to the target server first.');
-        let method = createShuffl({ baseUrl, token });
+        let method = company
+            ? createShufflCompany({ baseUrl, token })
+            : createShuffl({ baseUrl, token });
         for (const name of command.path)
             method = method[name];
         const output = await request(() => method(input));

package/dist/types.d.ts

@@ -13,4 +13,6 @@ export interface CommandDefinition {
     summary: string;
     scope: string | null;
     input: JsonSchema | null;
+    /** company: a company key command, under `shuffl company` (#1692). */
+    credential?: 'company';
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "dependencies": {
     "@orpc/client": "1.15.3",
-    "@shuffl/api-contracts": "0.3.0",
-    "@shuffl/sdk": "0.3.0"
+    "@shuffl/api-contracts": "0.5.0",
+    "@shuffl/sdk": "0.5.0"
   },
   "description": "Shuffl command line: every public API operation as a scriptable command with JSON output.",
   "engines": {
@@ -33,7 +33,7 @@
   "sideEffects": false,
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "bin": {
     "shuffl": "./dist/bin.js"
   }