@jacebenson/jsn 0.0.10 → 1.0.2

package/src/commands/tickets.js

@@ -1,121 +0,0 @@
-import { formatRecordForDisplay, getStringField, buildQuerySuffix } from '../helpers.js';
-
-export function ticketsCmd(wrap) {
-  return {
-    command: 'tickets [subcommand]',
-    aliases: ['ticket'],
-    describe: 'Query generic tickets (e.g. "tickets list --query active=true")',
-    builder: (yargs) => {
-      return yargs
-        .command({
-          command: 'list',
-          aliases: ['ls'],
-          describe: 'List tickets',
-          builder: (y) => y
-            .option('query', { type: 'string', describe: 'Encoded query (e.g. "active=true^priority=1")' })
-            .option('columns', { alias: 'c', type: 'string', describe: 'Comma-separated columns (e.g. "number,short_description,priority")' })
-            .option('limit', { alias: 'l', type: 'number', default: 20, describe: 'Max records' })
-            .option('offset', { alias: 'o', type: 'number', default: 0, describe: 'Offset' }),
-          handler: wrap(async (argv, app) => {
-            const columns = argv.columns ? argv.columns.split(',') : ['number', 'short_description', 'state', 'assigned_to'];
-            const params = new URLSearchParams();
-            params.set('sysparm_limit', String(argv.limit));
-            params.set('sysparm_offset', String(argv.offset));
-            params.set('sysparm_display_value', 'all');
-            params.set('sysparm_fields', ['sys_id', ...columns].join(','));
-            const q = argv.query ? argv.query + '^ORDERBYDESCsys_updated_on' : 'ORDERBYDESCsys_updated_on';
-            params.set('sysparm_query', q);
-            const records = await app.sdk.list('ticket', params);
-            const displayRecords = records.map(r => formatRecordForDisplay(r, columns));
-            const breadcrumbs = [
-              { action: 'create', cmd: 'jsn tickets create --data \'{...}\'', description: 'Create a new ticket' },
-            ];
-            if (records.length === argv.limit) {
-              breadcrumbs.push({
-                action: 'next',
-                cmd: `jsn tickets list --limit ${argv.limit} --offset ${argv.offset + argv.limit}${buildQuerySuffix(argv.query)}`,
-                description: `Next page`,
-              });
-            }
-            if (argv.offset > 0) {
-              breadcrumbs.push({
-                action: 'prev',
-                cmd: `jsn tickets list --limit ${argv.limit} --offset ${Math.max(0, argv.offset - argv.limit)}${buildQuerySuffix(argv.query)}`,
-                description: 'Previous page',
-              });
-            }
-            app.ok({
-              table: 'ticket',
-              count: records.length,
-              columns,
-              records: displayRecords,
-              pagination: { limit: argv.limit, offset: argv.offset },
-              context: { instance_url: app.getEffectiveInstance() },
-            }, { summary: `${records.length} ticket(s)`, breadcrumbs });
-          }),
-        })
-        .command({
-          command: 'show <number>',
-          aliases: ['get'],
-          describe: 'Show a ticket',
-          handler: wrap(async (argv, app) => {
-            const params = new URLSearchParams();
-            params.set('sysparm_query', `number=${argv.number}`);
-            params.set('sysparm_limit', '1');
-            params.set('sysparm_display_value', 'all');
-            const records = await app.sdk.list('ticket', params);
-            if (records.length === 0) {
-              throw new Error(`Ticket not found: ${argv.number}`);
-            }
-            app.ok(records[0], { summary: `Ticket ${argv.number}` });
-          }),
-        })
-        .command({
-          command: 'create',
-          describe: 'Create a new ticket',
-          builder: (y) => y.option('data', { type: 'string', demandOption: true, describe: 'JSON fields (e.g. \'{"state":"2","priority":"1"}\')' }),
-          handler: wrap(async (argv, app) => {
-            const recordData = JSON.parse(argv.data);
-            const record = await app.sdk.create('ticket', recordData);
-            app.ok(record, { summary: `Created ticket ${getStringField(record, 'number')}` });
-          }),
-        })
-        .command({
-          command: 'update <number>',
-          describe: 'Update a ticket',
-          builder: (y) => y.option('data', { type: 'string', demandOption: true, describe: 'JSON fields (e.g. \'{"state":"2","priority":"1"}\')' }),
-          handler: wrap(async (argv, app) => {
-            const recordData = JSON.parse(argv.data);
-            const findParams = new URLSearchParams();
-            findParams.set('sysparm_query', `number=${argv.number}`);
-            findParams.set('sysparm_limit', '1');
-            const records = await app.sdk.list('ticket', findParams);
-            if (records.length === 0) {
-              throw new Error(`Ticket not found: ${argv.number}`);
-            }
-            const sysID = getStringField(records[0], 'sys_id');
-            const updated = await app.sdk.update('ticket', sysID, recordData);
-            app.ok(updated, { summary: `Updated ticket ${argv.number}` });
-          }),
-        })
-        .command({
-          command: 'delete <number>',
-          describe: 'Delete a ticket',
-          handler: wrap(async (argv, app) => {
-            const findParams = new URLSearchParams();
-            findParams.set('sysparm_query', `number=${argv.number}`);
-            findParams.set('sysparm_limit', '1');
-            const records = await app.sdk.list('ticket', findParams);
-            if (records.length === 0) {
-              throw new Error(`Ticket not found: ${argv.number}`);
-            }
-            const sysID = getStringField(records[0], 'sys_id');
-            await app.sdk.delete('ticket', sysID);
-            app.ok({ number: argv.number, message: 'Ticket deleted' }, { summary: `Deleted ticket ${argv.number}` });
-          }),
-        })
-
-    },
-    handler: () => {},
-  };
-}

package/src/commands/users.js

@@ -1,57 +0,0 @@
-import { formatRecordForDisplay } from '../helpers.js';
-
-export function usersCmd(wrap) {
-  return {
-    command: 'users [subcommand]',
-    aliases: ['user'],
-    describe: 'Search and display users',
-    builder: (yargs) => {
-      return yargs
-        .command({
-          command: 'list',
-          aliases: ['ls'],
-          describe: 'List users',
-          builder: (y) => y
-            .option('query', { type: 'string', describe: 'Encoded query (e.g. "nameLIKEincident" or "active=true")' })
-            .option('columns', { alias: 'c', type: 'string', describe: 'Comma-separated columns (e.g. "number,short_description")' })
-            .option('limit', { alias: 'l', type: 'number', default: 20, describe: 'Max records' }),
-          handler: wrap(async (argv, app) => {
-            const columns = argv.columns ? argv.columns.split(',') : ['user_name', 'name', 'email', 'active'];
-            const params = new URLSearchParams();
-            params.set('sysparm_limit', String(argv.limit));
-            params.set('sysparm_display_value', 'all');
-            params.set('sysparm_fields', ['sys_id', ...columns].join(','));
-            if (argv.query) params.set('sysparm_query', argv.query);
-            const records = await app.sdk.list('sys_user', params);
-            app.ok({
-              table: 'sys_user',
-              count: records.length,
-              columns,
-              records: records.map(r => formatRecordForDisplay(r, columns)),
-              context: { instance_url: app.getEffectiveInstance() },
-            }, { summary: `${records.length} user(s)` });
-          }),
-        })
-        .command({
-          command: 'show <identifier>',
-          aliases: ['get'],
-          describe: 'Show a user by user_name or sys_id',
-          handler: wrap(async (argv, app) => {
-            const id = argv.identifier;
-            const isSysID = id.length === 32 && /^[0-9a-fA-F]+$/.test(id);
-            const params = new URLSearchParams();
-            params.set('sysparm_query', isSysID ? `sys_id=${id}` : `user_name=${id}`);
-            params.set('sysparm_limit', '1');
-            params.set('sysparm_display_value', 'all');
-            const records = await app.sdk.list('sys_user', params);
-            if (records.length === 0) {
-              throw new Error(`User not found: ${id}`);
-            }
-            app.ok(records[0], { summary: `User ${id}` });
-          }),
-        })
-
-    },
-    handler: () => {},
-  };
-}

package/src/commands/version.js

@@ -1,25 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-function getVersion() {
-  try {
-    const __dirname = path.dirname(fileURLToPath(import.meta.url));
-    const pkgPath = path.join(__dirname, '..', '..', 'package.json');
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-    return pkg.version;
-  } catch {
-    return '0.0.0';
-  }
-}
-
-export function versionCmd(wrap) {
-  return {
-    command: 'version',
-    describe: 'Show version information',
-    handler: wrap(async (_argv, app) => {
-      const version = getVersion();
-      app.ok({ version }, { summary: `jsn ${version}` });
-    }),
-  };
-}

package/src/config.js

@@ -1,154 +0,0 @@
-// Layered configuration: flags > env > local > global > defaults
-
-import fs from 'node:fs';
-import path from 'node:path';
-import os from 'node:os';
-
-const APP_NAME = 'servicenow';
-
-export function globalConfigDir() {
-  const xdg = process.env.XDG_CONFIG_HOME;
-  if (xdg) return path.join(xdg, APP_NAME);
-  return path.join(os.homedir(), '.config', APP_NAME);
-}
-
-export function globalConfigPath() {
-  return path.join(globalConfigDir(), 'config.json');
-}
-
-export function localConfigPath() {
-  return path.join(process.cwd(), `.${APP_NAME}`, 'config.json');
-}
-
-export function cacheDir() {
-  const xdg = process.env.XDG_CACHE_HOME;
-  if (xdg) return path.join(xdg, APP_NAME);
-  return path.join(os.homedir(), '.cache', APP_NAME);
-}
-
-export function normalizeInstanceURL(url) {
-  if (!url) return '';
-  url = url.trim();
-  url = url.replace(/\/$/, '');
-  if (!/^https?:\/\//i.test(url)) {
-    url = 'https://' + url;
-  }
-  return url;
-}
-
-function loadFromFile(cfg, filePath, source) {
-  try {
-    const data = fs.readFileSync(filePath, 'utf-8');
-    const fileCfg = JSON.parse(data);
-    if (fileCfg.instance_url) {
-      cfg.instanceURL = fileCfg.instance_url;
-      cfg.sources.instance_url = source;
-    }
-    if (fileCfg.format) {
-      cfg.format = fileCfg.format;
-      cfg.sources.format = source;
-    }
-    if (fileCfg.default_profile) {
-      cfg.defaultProfile = fileCfg.default_profile;
-      cfg.activeProfile = fileCfg.default_profile;
-      cfg.sources.default_profile = source;
-    }
-    if (fileCfg.profiles && typeof fileCfg.profiles === 'object') {
-      cfg.profiles = { ...cfg.profiles, ...fileCfg.profiles };
-      cfg.sources.profiles = source;
-    }
-  } catch {
-    // File doesn't exist or is malformed — skip
-  }
-}
-
-function loadFromEnv(cfg) {
-  if (process.env.SERVICENOW_INSTANCE_URL) {
-    cfg.instanceURL = process.env.SERVICENOW_INSTANCE_URL;
-    cfg.sources.instance_url = 'env';
-  }
-  if (process.env.SERVICENOW_FORMAT) {
-    cfg.format = process.env.SERVICENOW_FORMAT;
-    cfg.sources.format = 'env';
-  }
-}
-
-export function createConfig() {
-  return {
-    instanceURL: '',
-    profiles: {},
-    defaultProfile: '',
-    activeProfile: '',
-    format: 'auto',
-    sources: {},
-  };
-}
-
-export function loadConfig(overrides = {}) {
-  const cfg = createConfig();
-
-  loadFromFile(cfg, globalConfigPath(), 'global');
-  loadFromFile(cfg, localConfigPath(), 'local');
-  loadFromEnv(cfg);
-
-  if (overrides.instance) {
-    cfg.instanceURL = overrides.instance;
-    cfg.sources.instance_url = 'flag';
-  }
-  if (overrides.format) {
-    cfg.format = overrides.format;
-    cfg.sources.format = 'flag';
-  }
-  if (overrides.profile) {
-    cfg.activeProfile = overrides.profile;
-    if (cfg.profiles[overrides.profile] && cfg.profiles[overrides.profile].instance_url) {
-      cfg.instanceURL = cfg.profiles[overrides.profile].instance_url;
-      cfg.sources.instance_url = 'profile';
-    }
-  }
-
-  return cfg;
-}
-
-export function saveConfig(cfg) {
-  const dir = globalConfigDir();
-  fs.mkdirSync(dir, { recursive: true, mode: 0o750 });
-  const payload = {
-    instance_url: cfg.instanceURL || undefined,
-    profiles: Object.keys(cfg.profiles).length > 0 ? cfg.profiles : undefined,
-    default_profile: cfg.defaultProfile || undefined,
-    format: cfg.format || undefined,
-  };
-  fs.writeFileSync(globalConfigPath(), JSON.stringify(payload, null, 2), { mode: 0o600 });
-}
-
-export function saveLocalConfig(cfg) {
-  const dir = path.dirname(localConfigPath());
-  fs.mkdirSync(dir, { recursive: true, mode: 0o750 });
-  const payload = {
-    instance_url: cfg.instanceURL || undefined,
-    profiles: Object.keys(cfg.profiles).length > 0 ? cfg.profiles : undefined,
-    default_profile: cfg.defaultProfile || undefined,
-    format: cfg.format || undefined,
-  };
-  fs.writeFileSync(localConfigPath(), JSON.stringify(payload, null, 2), { mode: 0o600 });
-}
-
-export function getEffectiveInstance(cfg) {
-  const name = cfg.activeProfile || cfg.defaultProfile;
-  if (name && cfg.profiles[name] && cfg.profiles[name].instance_url) {
-    return cfg.profiles[name].instance_url;
-  }
-  return cfg.instanceURL || '';
-}
-
-export function getActiveProfile(cfg) {
-  const name = cfg.activeProfile || cfg.defaultProfile;
-  if (!name) return null;
-  return cfg.profiles[name] || null;
-}
-
-export function setProfile(cfg, name, profile) {
-  cfg.profiles[name] = profile;
-  return saveConfig(cfg);
-}

package/src/context.js

@@ -1,62 +0,0 @@
-// ServiceNow runtime context: current user, scope, update set
-
-export async function getCurrentUser(sdk) {
-  const params = new URLSearchParams();
-  params.set('sysparm_query', 'user_name=javascript:gs.getUserName()');
-  params.set('sysparm_limit', '1');
-  params.set('sysparm_display_value', 'all');
-  params.set('sysparm_fields', 'sys_id,user_name,name');
-  const records = await sdk.list('sys_user', params);
-  if (records.length === 0) return null;
-  const r = records[0];
-  return {
-    sys_id: r.sys_id?.value || r.sys_id,
-    user_name: r.user_name?.display_value || r.user_name,
-    name: r.name?.display_value || r.name,
-  };
-}
-
-export async function getCurrentApplication(sdk, userSysID) {
-  const params = new URLSearchParams();
-  params.set('sysparm_query', `user=${userSysID}^name=apps.current_app`);
-  params.set('sysparm_limit', '1');
-  params.set('sysparm_fields', 'value');
-  const records = await sdk.list('sys_user_preference', params);
-  if (records.length === 0) return { scope: 'global' };
-  const val = records[0].value?.value || records[0].value;
-  if (!val) return { scope: 'global' };
-
-  // Try to resolve sys_id to scope name
-  try {
-    const app = await sdk.get('sys_scope', val);
-    if (app) return { scope: app.scope || 'global' };
-  } catch {
-    // fallback
-  }
-  try {
-    const app2 = await sdk.get('sys_app', val);
-    if (app2) return { scope: app2.scope || 'global' };
-  } catch {
-    // fallback
-  }
-  return { scope: val };
-}
-
-export async function getCurrentUpdateSet(sdk, userSysID) {
-  const params = new URLSearchParams();
-  params.set('sysparm_query', `user=${userSysID}^name=sys_update_set`);
-  params.set('sysparm_limit', '1');
-  params.set('sysparm_fields', 'value');
-  const records = await sdk.list('sys_user_preference', params);
-  if (records.length === 0) return null;
-  const val = records[0].value?.value || records[0].value;
-  if (!val || val === '-') return { name: 'Default', sys_id: '' };
-
-  try {
-    const us = await sdk.get('sys_update_set', val);
-    if (us) return { name: us.name || val, sys_id: val };
-  } catch {
-    // fallback
-  }
-  return { name: val, sys_id: val };
-}

package/src/errors.js

@@ -1,101 +0,0 @@
-// Structured error types with code, message, and optional hint.
-
-export const CodeUsage = 'usage_error';
-export const CodeNotFound = 'not_found';
-export const CodeAuth = 'auth_error';
-export const CodeForbidden = 'forbidden';
-export const CodeRateLimit = 'rate_limited';
-export const CodeNetwork = 'network_error';
-export const CodeAPI = 'api_error';
-export const CodeAmbiguous = 'ambiguous';
-export const CodeEmptyResult = 'empty_result';
-
-export class AppError extends Error {
-  constructor(code, message, hint = '', status = 0, cause = null) {
-    super(message);
-    this.name = 'AppError';
-    this.code = code;
-    this.hint = hint;
-    this.status = status;
-    this.cause = cause;
-  }
-
-  toString() {
-    if (this.hint) {
-      return `${this.code}: ${this.message}\nHint: ${this.hint}`;
-    }
-    return `${this.code}: ${this.message}`;
-  }
-}
-
-export function errUsage(msg) {
-  return new AppError(CodeUsage, msg);
-}
-
-export function errUsageHint(msg, hint) {
-  return new AppError(CodeUsage, msg, hint);
-}
-
-export function errNotFound(resource, identifier) {
-  return new AppError(
-    CodeNotFound,
-    `${resource} not found: ${identifier}`,
-    `Check the ${resource} exists and you have access to it.`
-  );
-}
-
-export function errNotFoundHint(resource, identifier, hint) {
-  return new AppError(CodeNotFound, `${resource} not found: ${identifier}`, hint);
-}
-
-export function errAuth(msg) {
-  return new AppError(CodeAuth, msg, 'Run: jsn auth login');
-}
-
-export function errForbidden(msg) {
-  return new AppError(CodeForbidden, msg, '', 403);
-}
-
-export function errRateLimit(retryAfter) {
-  return new AppError(
-    CodeRateLimit,
-    `Rate limited. Retry after ${retryAfter} seconds.`,
-    'Wait before retrying, or use pagination for large queries.'
-  );
-}
-
-export function errNetwork(cause) {
-  return new AppError(
-    CodeNetwork,
-    `Network error: ${cause.message || cause}`,
-    'Check your internet connection and instance URL.',
-    0,
-    cause
-  );
-}
-
-export function errAPI(status, msg) {
-  let hint = 'Check the API documentation for this endpoint.';
-  if (status >= 500) {
-    hint = 'The ServiceNow instance may be experiencing issues. Try again later.';
-  }
-  return new AppError(CodeAPI, `API error (status ${status}): ${msg}`, hint, status);
-}
-
-export function errAmbiguous(resource, matches) {
-  return new AppError(
-    CodeAmbiguous,
-    `Multiple ${resource} found matching your query`,
-    `Did you mean one of: ${matches.join(', ')}?`
-  );
-}
-
-export function asError(err) {
-  if (!err) return null;
-  if (err instanceof AppError) return err;
-  return new AppError('unknown', err.message || String(err));
-}
-
-export function isErrorCode(err, code) {
-  return err instanceof AppError && err.code === code;
-}

package/src/helpers.js

@@ -1,60 +0,0 @@
-// Shared helper utilities
-
-export function getStringField(record, field) {
-  if (!record || typeof record !== 'object') return '';
-  const val = record[field];
-  if (val == null) return '';
-  if (typeof val === 'string') return val;
-  if (typeof val === 'object') {
-    if (val.display_value != null) return String(val.display_value);
-    if (val.value != null) return String(val.value);
-  }
-  return String(val);
-}
-
-export function formatRecordForDisplay(record, columns) {
-  const result = {};
-
-  function extractValue(val) {
-    if (val == null) return '';
-    if (typeof val === 'string') return val;
-    if (typeof val === 'object') {
-      if (val.display_value != null && val.display_value !== '') return String(val.display_value);
-      if (val.value != null) return String(val.value);
-    }
-    return String(val);
-  }
-
-  if (record.sys_id != null) {
-    result.sys_id = extractValue(record.sys_id);
-  }
-
-  for (const col of columns) {
-    if (record[col] != null) {
-      result[col] = extractValue(record[col]);
-    } else {
-      result[col] = '';
-    }
-  }
-  return result;
-}
-
-export function truncateString(str, maxLen) {
-  if (!str || str.length <= maxLen) return str;
-  return str.slice(0, maxLen - 3) + '...';
-}
-
-export function isHexString(str) {
-  return /^[0-9a-fA-F]+$/.test(str);
-}
-
-export function extractProfileName(instanceURL) {
-  let name = instanceURL.replace(/^https?:\/\//, '');
-  name = name.replace(/\.service-now\.com$/, '');
-  name = name.replace(/\.servicenowservices\.com$/, '');
-  return name;
-}
-
-export function buildQuerySuffix(query) {
-  return query ? ` --query "${query}"` : '';
-}