@jacebenson/jsn 0.0.10 → 1.0.2

package/scripts/pre-commit-check.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+# pre-commit-check.sh - Run this before committing to check architecture compliance
+
+echo "🔍 Checking architecture patterns..."
+
+# Check for forbidden SDK patterns
+FORBIDDEN_PATTERNS=(
+    "func.*Client.*ListForm"
+    "func.*Client.*ListList"
+    "func.*Client.*GetSP"
+    "func.*Client.*ListSP"
+)
+
+ERRORS=0
+
+for pattern in "${FORBIDDEN_PATTERNS[@]}"; do
+    matches=$(grep -r "$pattern" internal/sdk/*.go 2>/dev/null | grep -v "_test.go" | grep -v "^Binary")
+    if [ ! -z "$matches" ]; then
+        echo "❌ Found forbidden SDK pattern: $pattern"
+        echo "$matches"
+        ERRORS=$((ERRORS + 1))
+    fi
+done
+
+# Check that commands don't import old SDK types
+BAD_IMPORTS=(
+    "sdk.FormSection"
+    "sdk.FormElement"
+    "sdk.ListLayout"
+    "sdk.ListElement"
+    "sdk.SPPage"
+    "sdk.SPWidgetInstance"
+)
+
+for pattern in "${BAD_IMPORTS[@]}"; do
+    matches=$(grep -r "$pattern" internal/commands/**/*.go 2>/dev/null)
+    if [ ! -z "$matches" ]; then
+        echo "❌ Command using SDK type instead of local type: $pattern"
+        echo "$matches"
+        ERRORS=$((ERRORS + 1))
+    fi
+done
+
+# Run architecture tests
+echo "🧪 Running architecture tests..."
+if ! go test ./internal/sdk -run TestNoSDKHelperMethods -run TestCommandsUseDirectSDKList > /dev/null 2>&1; then
+    echo "❌ Architecture tests failed"
+    go test ./internal/sdk -v -run "TestNoSDKHelperMethods|TestCommandsUseDirectSDKList"
+    ERRORS=$((ERRORS + 1))
+fi
+
+if [ $ERRORS -eq 0 ]; then
+    echo "✅ All architecture checks passed!"
+    exit 0
+else
+    echo ""
+    echo "⚠️  Architecture violations found!"
+    echo "   Remember: Commands should call app.SDK.List() directly with local types."
+    echo "   See internal/commands/dev/forms.go for the correct pattern."
+    exit 1
+fi

package/src/app.js

@@ -1,157 +0,0 @@
-// App context: bundles config, auth, SDK, output, and runtime context
-
-import { AuthManager } from './auth.js';
-import { SDKClient } from './sdk.js';
-import { OutputWriter, FormatAuto, FormatJSON, FormatMarkdown, FormatQuiet, FormatStyled } from './output.js';
-import { getEffectiveInstance } from './config.js';
-import { extractProfileName } from './helpers.js';
-import { getCurrentUser, getCurrentApplication, getCurrentUpdateSet } from './context.js';
-import { errUsage, errAuth } from './errors.js';
-import process from 'node:process';
-
-
-export class App {
-  constructor(cfg) {
-    this.config = cfg;
-    this.auth = new AuthManager(this);
-    this.output = new OutputWriter({ format: resolveFormat(cfg.format) });
-    this.sdk = null;
-
-    const instance = getEffectiveInstance(cfg);
-    if (instance) {
-      this.sdk = new SDKClient(instance, this.auth);
-    }
-
-    this.context = {
-      profileName: '',
-      username: '',
-      scope: '',
-      updateSet: '',
-    };
-
-    this.loadContext();
-  }
-
-  loadContext() {
-    const instance = getEffectiveInstance(this.config);
-    if (!instance) return;
-    this.context.profileName = extractProfileName(instance);
-    for (const [name, profile] of Object.entries(this.config.profiles || {})) {
-      if (profile.instance_url === instance) {
-        this.context.profileName = name;
-        this.context.username = profile.username || '';
-        break;
-      }
-    }
-  }
-
-  getEffectiveInstance() {
-    return getEffectiveInstance(this.config);
-  }
-
-  async printContextHeader() {
-    if (!this.getEffectiveInstance() || !this.sdk) return;
-    if (process.env.JSN_NO_HEADER) return;
-    if (this.output.getFormat() === FormatJSON || this.output.getFormat() === FormatQuiet) return;
-
-    let userDisplayName = 'Unknown';
-    let userSysID = '';
-
-    try {
-      const user = await getCurrentUser(this.sdk);
-      if (user) {
-        userDisplayName = user.name || user.user_name;
-        userSysID = user.sys_id;
-        this.context.username = userDisplayName;
-      }
-    } catch {
-      // ignore
-    }
-
-    let displayUserName = userDisplayName;
-    if (displayUserName.length > 10) {
-      displayUserName = displayUserName.slice(0, 6) + '...';
-    }
-
-    let scope = 'global';
-    if (userSysID) {
-      try {
-        const app = await getCurrentApplication(this.sdk, userSysID);
-        if (app && app.scope) scope = app.scope;
-      } catch {
-        // ignore
-      }
-    }
-    this.context.scope = scope;
-
-    let updateSet = 'Default';
-    let updateSetSysID = '';
-    if (userSysID) {
-      try {
-        const us = await getCurrentUpdateSet(this.sdk, userSysID);
-        if (us && us.name && us.name !== '-') {
-          updateSet = us.name;
-          updateSetSysID = us.sys_id;
-        }
-      } catch {
-        // ignore
-      }
-    }
-    this.context.updateSet = updateSet;
-
-    const instance = this.getEffectiveInstance();
-    const instanceLink = instance;
-    const userLink = `${instance}/sys_user_list.do?sysparm_query=sys_id=${userSysID}`;
-    const scopeLink = `${instance}/sys_scope.do?sysparm_query=scope=${scope}`;
-    const updateSetLink = updateSetSysID
-      ? `${instance}/sys_update_set.do?sys_id=${updateSetSysID}`
-      : `${instance}/sys_update_set_list.do`;
-
-    const scopeFormatted = `[${scope}]`;
-
-    process.stderr.write('# Use `jsn updateset use` or `jsn scope use` to change scope/updateset\n');
-    process.stderr.write('PROFILE   USER      [SCOPE]           UPDATE SET\n');
-
-    const profileStr = `]8;;${instanceLink}\x07${String(this.context.profileName).padEnd(9)}]8;;\x07`;
-    const userStr = `]8;;${userLink}\x07${String(displayUserName).padEnd(9)}]8;;\x07`;
-    const scopeStr = `]8;;${scopeLink}\x07${String(scopeFormatted).padEnd(17)}]8;;\x07`;
-    const updateSetStr = `]8;;${updateSetLink}\x07${updateSet}]8;;\x07`;
-
-    process.stderr.write(`${profileStr} ${userStr} ${scopeStr} ${updateSetStr}\n\n`);
-  }
-
-  ok(data, opts = {}) {
-    this.output.ok(data, opts);
-  }
-
-  err(error) {
-    this.output.err(error);
-  }
-
-  isInteractive() {
-    return process.stdout.isTTY === true;
-  }
-
-  requireInstance() {
-    if (!this.getEffectiveInstance()) {
-      throw errUsage('Instance URL required. Set via --instance flag, SERVICENOW_INSTANCE_URL env, or config file.');
-    }
-  }
-
-  requireAuth() {
-    if (!this.auth.isAuthenticated()) {
-      throw errAuth('Not authenticated');
-    }
-  }
-}
-
-function resolveFormat(fmt) {
-  switch (fmt) {
-    case 'json': return FormatJSON;
-    case 'markdown':
-    case 'md': return FormatMarkdown;
-    case 'quiet': return FormatQuiet;
-    case 'styled': return FormatStyled;
-    default: return FormatAuto;
-  }
-}

package/src/auth.js

@@ -1,283 +0,0 @@
-// OAuth 2.0 with PKCE authentication
-
-import fs from 'node:fs';
-import path from 'node:path';
-import crypto from 'node:crypto';
-import readline from 'node:readline';
-import { globalConfigDir, normalizeInstanceURL } from './config.js';
-import { errAuth } from './errors.js';
-
-const DEFAULT_OAUTH_CLIENT_ID = '543e5655f77746a28228c6009a599dfb';
-const REDIRECT_URI = '/sdk-oauth.do';
-
-function credentialsPath(instance) {
-  const dir = path.join(globalConfigDir(), 'credentials');
-  fs.mkdirSync(dir, { recursive: true, mode: 0o700 });
-  const filename = Buffer.from(instance).toString('base64url') + '.json';
-  return path.join(dir, filename);
-}
-
-function getOAuthClientID() {
-  return process.env.SERVICENOW_OAUTH_CLIENT_ID || DEFAULT_OAUTH_CLIENT_ID;
-}
-
-function generatePKCE() {
-  const verifier = crypto.randomBytes(32).toString('base64url');
-  const challenge = crypto.createHash('sha256').update(verifier).digest('base64url');
-  const state = crypto.randomBytes(16).toString('base64url');
-  return { code_verifier: verifier, code_challenge: challenge, state };
-}
-
-function buildAuthURL(instanceURL, clientID, pkce) {
-  const u = new URL('/oauth_auth.do', instanceURL);
-  u.searchParams.set('response_type', 'code');
-  u.searchParams.set('client_id', clientID);
-  u.searchParams.set('redirect_uri', REDIRECT_URI);
-  u.searchParams.set('state', pkce.state);
-  u.searchParams.set('code_challenge', pkce.code_challenge);
-  u.searchParams.set('code_challenge_method', 'S256');
-  u.searchParams.set('scope', 'openid');
-  return u.toString();
-}
-
-function loadCredentials(instance) {
-  try {
-    const data = fs.readFileSync(credentialsPath(instance), 'utf-8');
-    return JSON.parse(data);
-  } catch {
-    return null;
-  }
-}
-
-function saveCredentials(instance, creds) {
-  fs.writeFileSync(credentialsPath(instance), JSON.stringify(creds, null, 2), { mode: 0o600 });
-}
-
-function deleteCredentials(instance) {
-  try {
-    fs.unlinkSync(credentialsPath(instance));
-  } catch {
-    // ignore
-  }
-}
-
-function askHidden(promptText) {
-  return new Promise((resolve) => {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-
-    const stdin = process.stdin;
-    const stdout = process.stdout;
-
-    if (!stdin.isTTY) {
-    rl.question(promptText, (answer) => {
-      rl.close();
-      resolve(answer.trim());
-    });
-    return;
-  }
-
-    stdout.write(promptText);
-
-    stdin.setRawMode(true);
-    stdin.resume();
-    stdin.setEncoding('utf-8');
-
-    let input = '';
-    const onData = (key) => {
-      if (key === '\r' || key === '\n') {
-        stdin.removeListener('data', onData);
-        stdin.setRawMode(false);
-        stdin.pause();
-        stdout.write('\n');
-        rl.close();
-        resolve(input);
-      } else if (key === '\u0003') {
-        process.exit();
-      } else if (key === '\u007f') {
-        if (input.length > 0) {
-          input = input.slice(0, -1);
-          stdout.write('\b \b');
-        }
-      } else {
-        input += key;
-        stdout.write('*');
-      }
-    };
-    stdin.on('data', onData);
-  });
-}
-
-export class AuthManager {
-  constructor(configProvider) {
-    this.configProvider = configProvider;
-    this.httpClient = { timeout: 30000 };
-  }
-
-  isAuthenticated() {
-    if (process.env.SERVICENOW_OAUTH_TOKEN) return true;
-    const instance = this.configProvider.getEffectiveInstance();
-    if (!instance) return false;
-    try {
-      this.getCredentialsFor(instance);
-      return true;
-    } catch {
-      return false;
-    }
-  }
-
-  isAuthenticatedFor(instance) {
-    if (!instance) return false;
-    const creds = loadCredentials(instance);
-    if (!creds) return false;
-    if (creds.expires_at && Date.now() >= creds.expires_at * 1000) return false;
-    return !!creds.access_token;
-  }
-
-  async getCredentials() {
-    if (process.env.SERVICENOW_OAUTH_TOKEN) {
-      return { auth_method: 'oauth', access_token: process.env.SERVICENOW_OAUTH_TOKEN };
-    }
-    const instance = this.configProvider.getEffectiveInstance();
-    if (!instance) {
-      throw errAuth('No instance configured');
-    }
-    return this.getCredentialsFor(instance);
-  }
-
-  getCredentialsFor(instance) {
-    const creds = loadCredentials(instance);
-    if (!creds) {
-      throw errAuth(`Not authenticated for ${instance}`);
-    }
-    // Check expiry — refresh if less than 5 minutes remaining
-    if (creds.expires_at && Date.now() >= (creds.expires_at - 300) * 1000) {
-      if (creds.refresh_token) {
-        return this.refreshToken(instance, creds);
-      }
-      throw errAuth('Token expired, please login again');
-    }
-    return creds;
-  }
-
-  async login(instanceURL) {
-    instanceURL = normalizeInstanceURL(instanceURL);
-    const clientID = getOAuthClientID();
-    const pkce = generatePKCE();
-    const authURL = buildAuthURL(instanceURL, clientID, pkce);
-
-    console.log();
-    console.log('Opening browser for OAuth authentication...');
-    console.log('If the browser does not open automatically, visit:');
-    console.log(authURL);
-    console.log();
-
-    // Try to open browser
-    const open = (await import('node:child_process')).spawn;
-    const platform = process.platform;
-    let cmd, args;
-    if (platform === 'darwin') {
-      cmd = 'open';
-      args = [authURL];
-    } else if (platform === 'win32') {
-      cmd = 'cmd';
-      args = ['/c', 'start', authURL];
-    } else {
-      cmd = 'xdg-open';
-      args = [authURL];
-    }
-    const child = open(cmd, args, { detached: true, stdio: 'ignore' });
-    child.on('error', () => {
-      // Browser open command not available — user will open the URL manually
-    });
-    child.unref();
-
-    console.log('After authenticating in the browser, copy the authorization code shown on the page.');
-    console.log('(input is hidden for security — just paste and press Enter)');
-    console.log();
-
-    const authCode = await askHidden('Authorization code (hidden on paste for security): ');
-    const code = authCode.trim();
-    if (!code) {
-      throw errAuth('Authorization code is required');
-    }
-
-    console.log('\nExchanging authorization code for tokens...');
-    const newCreds = await this.exchangeCode(instanceURL, clientID, code, pkce);
-    saveCredentials(instanceURL, newCreds);
-    return newCreds;
-  }
-
-  async exchangeCode(instanceURL, clientID, code, pkce) {
-    const tokenURL = `${instanceURL.replace(/\/$/, '')}/oauth_token.do`;
-    const body = new URLSearchParams();
-    body.set('grant_type', 'authorization_code');
-    body.set('client_id', clientID);
-    body.set('code', code);
-    body.set('redirect_uri', REDIRECT_URI);
-    body.set('code_verifier', pkce.code_verifier);
-
-    const resp = await fetch(tokenURL, {
-      method: 'POST',
-      headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-      body: body.toString(),
-    });
-
-    const text = await resp.text();
-    if (!resp.ok) {
-      throw errAuth(`Token exchange failed (status ${resp.status}): ${text}`);
-    }
-
-    const tokenResp = JSON.parse(text);
-    const expiresAt = tokenResp.expires_in ? Math.floor(Date.now() / 1000) + tokenResp.expires_in : 0;
-    return {
-      auth_method: 'oauth',
-      access_token: tokenResp.access_token,
-      refresh_token: tokenResp.refresh_token,
-      expires_at: expiresAt,
-      created_at: Math.floor(Date.now() / 1000),
-    };
-  }
-
-  async refreshToken(instance, creds) {
-    const tokenURL = `${instance.replace(/\/$/, '')}/oauth_token.do`;
-    const clientID = getOAuthClientID();
-    const body = new URLSearchParams();
-    body.set('grant_type', 'refresh_token');
-    body.set('client_id', clientID);
-    body.set('refresh_token', creds.refresh_token);
-
-    const resp = await fetch(tokenURL, {
-      method: 'POST',
-      headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-      body: body.toString(),
-    });
-
-    if (!resp.ok) {
-      const text = await resp.text();
-      throw errAuth(`Token refresh failed: ${text}`);
-    }
-
-    const tokenResp = await resp.json();
-    const newCreds = {
-      auth_method: 'oauth',
-      access_token: tokenResp.access_token,
-      refresh_token: tokenResp.refresh_token,
-      created_at: Math.floor(Date.now() / 1000),
-    };
-    if (tokenResp.expires_in) {
-      newCreds.expires_at = Math.floor(Date.now() / 1000) + tokenResp.expires_in;
-    }
-    saveCredentials(instance, newCreds);
-    return newCreds;
-  }
-
-  logout(instance) {
-    if (!instance) {
-      throw errAuth('No instance specified');
-    }
-    deleteCredentials(instance);
-  }
-}

package/src/cli.js

@@ -1,144 +0,0 @@
-// Root CLI using yargs
-
-import yargs from 'yargs';
-import { hideBin } from 'yargs/helpers';
-import process from 'node:process';
-import { loadConfig, getEffectiveInstance } from './config.js';
-import { App } from './app.js';
-
-// Command modules
-import { setupCmd } from './commands/setup.js';
-import { authCmd } from './commands/auth.js';
-import { profilesCmd } from './commands/profiles.js';
-import { recordsCmd } from './commands/records.js';
-import { incidentsCmd } from './commands/incidents.js';
-import { changesCmd } from './commands/changes.js';
-import { requestsCmd } from './commands/requests.js';
-import { tasksCmd } from './commands/tasks.js';
-import { usersCmd } from './commands/users.js';
-import { groupsCmd } from './commands/groups.js';
-import { groupMembersCmd } from './commands/groupmembers.js';
-import { groupRolesCmd } from './commands/grouproles.js';
-import { ticketsCmd } from './commands/tickets.js';
-import { versionCmd } from './commands/version.js';
-import { devCmd } from './commands/dev.js';
-
-function wrap(handler) {
-  return async (argv) => {
-    try {
-      const app = argv.app;
-      if (!app) {
-        process.stderr.write('Error: App context not initialized.\n');
-        process.exit(1);
-      }
-      await handler(argv, app);
-    } catch (err) {
-      const app = argv.app;
-      if (app) {
-        app.err(err);
-      } else {
-        process.stderr.write(`Error: ${err.message || err}\n`);
-      }
-      process.exit(1);
-    }
-  };
-}
-
-export const cli = yargs(hideBin(process.argv))
-  .scriptName('jsn')
-  .usage('Usage: $0 <command> [options]')
-  .option('instance', {
-    describe: 'ServiceNow instance URL (e.g., https://dev12345.service-now.com)',
-    type: 'string',
-    global: true,
-  })
-  .option('profile', {
-    alias: 'p',
-    describe: 'Configuration profile to use',
-    type: 'string',
-    global: true,
-  })
-  .option('format', {
-    describe: 'Output format: auto, json, markdown, styled, quiet',
-    type: 'string',
-    global: true,
-  })
-  .option('json', {
-    describe: 'Output in JSON format',
-    type: 'boolean',
-    global: true,
-  })
-  .option('quiet', {
-    alias: 'q',
-    describe: 'Output only data, no envelope',
-    type: 'boolean',
-    global: true,
-  })
-  .option('styled', {
-    describe: 'Force styled output',
-    type: 'boolean',
-    global: true,
-  })
-  .option('markdown', {
-    describe: 'Output in Markdown format',
-    type: 'boolean',
-    global: true,
-  })
-  .middleware((argv) => {
-    // Determine format from flags
-    let format = 'auto';
-    if (argv.json) format = 'json';
-    else if (argv.quiet) format = 'quiet';
-    else if (argv.styled) format = 'styled';
-    else if (argv.markdown) format = 'markdown';
-    else if (argv.format) format = argv.format;
-
-    const cfg = loadConfig({
-      instance: argv.instance,
-      profile: argv.profile,
-      format,
-    });
-
-    argv.app = new App(cfg);
-
-    // Check auth for non-auth commands
-    const cmd = argv._[0];
-    const skipAuth = ['help', 'version', 'setup', 'auth', undefined].includes(cmd);
-    if (!skipAuth) {
-      const instance = getEffectiveInstance(cfg);
-      if (!argv.app.auth.isAuthenticated() && instance) {
-        process.stderr.write(`\n⚠️  Not authenticated to ${instance}\n\n`);
-        process.stderr.write('To get started, run:\n');
-        process.stderr.write('  jsn setup           # Interactive setup\n');
-        process.stderr.write(`  jsn auth login ${instance}   # Login to instance\n\n`);
-      }
-    }
-
-    // Print context header for interactive terminals
-    if (!['help', 'version', 'completion'].includes(cmd)) {
-      argv.app.printContextHeader();
-    }
-  })
-  .command(setupCmd(wrap))
-  .command(authCmd(wrap))
-  .command(profilesCmd(wrap))
-  .command(recordsCmd(wrap))
-  .command(incidentsCmd(wrap))
-  .command(changesCmd(wrap))
-  .command(requestsCmd(wrap))
-  .command(tasksCmd(wrap))
-  .command(usersCmd(wrap))
-  .command(groupsCmd(wrap))
-  .command(groupMembersCmd(wrap))
-  .command(groupRolesCmd(wrap))
-  .command(ticketsCmd(wrap))
-  .command(devCmd(wrap))
-  .command(versionCmd(wrap))
-  .demandCommand(1, 'You must specify a command')
-  .help('help', 'Show help')
-  .version(false)
-  .strictCommands()
-  .strictOptions(false)
-  .epilogue('TIPS\n'
-    + '  --query is available on every list command (e.g. "incidents list --query priority=1")\n'
-    + '  Use "jsn <command> --help" for details, or "jsn <command> list --help" for list options');