@jacebenson/jsn 1.0.6 → 2.0.1

package/src/commands/dev/scopes.js

@@ -0,0 +1,156 @@
+import { formatRecordForDisplay, getStringField, interactiveList } from '../../helpers.js';
+
+export function scopesCmd(wrap) {
+  return {
+    command: 'scopes [subcommand]',
+    aliases: ['scope', 'sc'],
+    describe: 'Manage application scopes',
+    builder: (yargs) => {
+      return yargs
+        .command({
+          command: 'list',
+          aliases: ['ls'],
+          describe: 'List application scopes',
+          builder: (y) => y
+            .option('query', { type: 'string', describe: 'Encoded query (e.g. "nameLIKEincident" or "active=true")' })
+            .option('columns', { alias: ['c', 'fields'], 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(',') : ['name', 'scope', 'short_description', 'active'];
+            const query = argv.query || '';
+
+            const picked = await interactiveList({
+              app, table: 'sys_scope', singular: 'scope', columns, limit: argv.limit, query, labelField: 'name',
+              formatLabel: r => `${getStringField(r, 'name')} [${getStringField(r, 'scope') || '?'}]`,
+            });
+            if (picked) {
+              picked._context = { instance_url: app.getEffectiveInstance(), table: 'sys_scope' };
+              return app.ok(picked, { summary: `Scope: ${getStringField(picked, 'name')}` });
+            }
+
+            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(','));
+            const q = argv.query ? argv.query + '^ORDERBYDESCsys_updated_on' : 'ORDERBYDESCsys_updated_on';
+            params.set('sysparm_query', q);
+            const records = await app.sdk.list('sys_scope', params);
+            app.ok({
+              table: 'sys_scope',
+              count: records.length,
+              columns,
+              records: records.map(r => formatRecordForDisplay(r, columns)),
+              context: { instance_url: app.getEffectiveInstance() },
+            }, { summary: `${records.length} scope(s)` });
+          }),
+        })
+        .command({
+          command: 'show <scope>',
+          aliases: ['get'],
+          describe: 'Show a scope',
+          handler: wrap(async (argv, app) => {
+            const params = new URLSearchParams();
+            params.set('sysparm_query', `scope=${argv.scope}`);
+            params.set('sysparm_limit', '1');
+            params.set('sysparm_display_value', 'all');
+            const records = await app.sdk.list('sys_scope', params);
+            if (records.length === 0) {
+              throw new Error(`Scope not found: ${argv.scope}`);
+            }
+            app.ok(records[0], { summary: `Scope ${argv.scope}` });
+          }),
+        })
+        .command({
+          command: 'set <scope>',
+          describe: 'Set the current application scope',
+          handler: wrap(async (argv, app) => {
+            const params = new URLSearchParams();
+            params.set('sysparm_query', `scope=${argv.scope}`);
+            params.set('sysparm_limit', '1');
+            params.set('sysparm_fields', 'sys_id,scope');
+            const records = await app.sdk.list('sys_scope', params);
+            if (records.length === 0) {
+              throw new Error(`Scope not found: ${argv.scope}`);
+            }
+            const scopeSysID = getStringField(records[0], 'sys_id');
+            // Update user preference
+            const user = await app.sdk.list('sys_user', new URLSearchParams({
+              sysparm_query: 'user_name=javascript:gs.getUserName()',
+              sysparm_limit: '1',
+              sysparm_fields: 'sys_id',
+            }));
+            if (user.length === 0) {
+              throw new Error('Could not determine current user');
+            }
+            const userSysID = getStringField(user[0], 'sys_id');
+            const prefParams = new URLSearchParams();
+            prefParams.set('sysparm_query', `user=${userSysID}^name=apps.current_app`);
+            prefParams.set('sysparm_limit', '1');
+            const prefs = await app.sdk.list('sys_user_preference', prefParams);
+            if (prefs.length > 0) {
+              await app.sdk.update('sys_user_preference', getStringField(prefs[0], 'sys_id'), { value: scopeSysID });
+            } else {
+              await app.sdk.create('sys_user_preference', {
+                user: userSysID,
+                name: 'apps.current_app',
+                value: scopeSysID,
+                type: 'string',
+              });
+            }
+            app.ok({ scope: argv.scope, sys_id: scopeSysID }, { summary: `Current scope: ${argv.scope}` });
+          }),
+        })
+        .command({
+          command: 'create',
+          describe: 'Create a new application scope',
+          builder: (y) => y
+            .option('name', { alias: 'n', type: 'string', demandOption: true, describe: 'Application name' })
+            .option('scope', { type: 'string', describe: 'Scope value (auto-generated from name if omitted)' }),
+          handler: wrap(async (argv, app) => {
+            let scope = argv.scope;
+            if (!scope) {
+              // Auto-generate scope from name: lowercase, replace spaces/special chars
+              scope = 'x_' + argv.name.toLowerCase()
+                .replace(/[^a-z0-9_]/g, '_')
+                .replace(/_+/g, '_')
+                .replace(/^_|_$/g, '')
+                .substring(0, 38); // x_ + max 35 chars = 37, leave room
+            }
+            // Check for existing scope
+            const existing = await app.sdk.list('sys_scope', new URLSearchParams({
+              sysparm_query: `scope=${scope}`,
+              sysparm_limit: '1',
+            }));
+            if (existing.length > 0) {
+              throw new Error(`Scope '${scope}' already exists. Use a different name or --scope flag.`);
+            }
+            const record = await app.sdk.create('sys_scope', {
+              name: argv.name,
+              scope,
+              short_description: argv.name,
+            });
+            app.ok(record, {
+              summary: `Created scope: ${scope}`,
+              breadcrumbs: [{
+                action: 'show',
+                cmd: `jsn dev scopes show ${scope}`,
+                description: 'View the new scope',
+              }],
+            });
+          }),
+        })
+
+    },
+    handler: (argv) => {
+      if (!argv._[1]) {
+        console.log('Manage ServiceNow application scopes.\n');
+        console.log('Commands:');
+        console.log('  list           List application scopes');
+        console.log('  show <scope>   Show a scope');
+        console.log('  set  <scope>   Set the current application scope');
+        console.log('  create         Create a new application scope');
+        console.log('\nRun "jsn dev scopes <command> --help" for details.');
+      }
+    },
+  };
+}

package/src/commands/dev/updatesets.js

@@ -0,0 +1,184 @@
+import { formatRecordForDisplay, getStringField, interactiveList } from '../../helpers.js';
+
+export function updateSetsCmd(wrap) {
+  return {
+    command: 'updatesets [subcommand]',
+    aliases: ['updateset', 'us'],
+    describe: 'Manage update sets',
+    builder: (yargs) => {
+      return yargs
+        .command({
+          command: 'list',
+          aliases: ['ls'],
+          describe: 'List update sets',
+          builder: (y) => y
+            .option('query', { type: 'string', describe: 'Encoded query (e.g. "nameLIKEincident" or "active=true")' })
+            .option('columns', { alias: ['c', 'fields'], 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(',') : ['name', 'state', 'application'];
+            const query = argv.query || '';
+
+            const picked = await interactiveList({
+              app, table: 'sys_update_set', singular: 'update set', columns, limit: argv.limit, query, labelField: 'name',
+              formatLabel: r => `${getStringField(r, 'name')} [${getStringField(r, 'state') || '?'}]`,
+            });
+            if (picked) {
+              picked._context = { instance_url: app.getEffectiveInstance(), table: 'sys_update_set' };
+              return app.ok(picked, { summary: `Update set: ${getStringField(picked, 'name')}` });
+            }
+
+            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(','));
+            const q = argv.query ? argv.query + '^ORDERBYDESCsys_updated_on' : 'ORDERBYDESCsys_updated_on';
+            params.set('sysparm_query', q);
+            const records = await app.sdk.list('sys_update_set', params);
+            app.ok({
+              table: 'sys_update_set',
+              count: records.length,
+              columns,
+              records: records.map(r => formatRecordForDisplay(r, columns)),
+              context: { instance_url: app.getEffectiveInstance() },
+            }, { summary: `${records.length} update set(s)` });
+          }),
+        })
+        .command({
+          command: 'show <name>',
+          aliases: ['get'],
+          describe: 'Show an update set',
+          handler: wrap(async (argv, app) => {
+            const params = new URLSearchParams();
+            params.set('sysparm_query', `name=${argv.name}`);
+            params.set('sysparm_limit', '1');
+            params.set('sysparm_display_value', 'all');
+            const records = await app.sdk.list('sys_update_set', params);
+            if (records.length === 0) {
+              throw new Error(`Update set not found: ${argv.name}`);
+            }
+            app.ok(records[0], { summary: `Update set ${argv.name}` });
+          }),
+        })
+        .command({
+          command: 'set <name>',
+          describe: 'Set the current update set',
+          handler: wrap(async (argv, app) => {
+            const params = new URLSearchParams();
+            params.set('sysparm_query', `name=${argv.name}`);
+            params.set('sysparm_limit', '1');
+            params.set('sysparm_fields', 'sys_id,name');
+            const records = await app.sdk.list('sys_update_set', params);
+            if (records.length === 0) {
+              throw new Error(`Update set not found: ${argv.name}`);
+            }
+            const sysID = getStringField(records[0], 'sys_id');
+            // Update user preference
+            const user = await app.sdk.list('sys_user', new URLSearchParams({
+              sysparm_query: 'user_name=javascript:gs.getUserName()',
+              sysparm_limit: '1',
+              sysparm_fields: 'sys_id',
+            }));
+            if (user.length === 0) {
+              throw new Error('Could not determine current user');
+            }
+            const userSysID = getStringField(user[0], 'sys_id');
+            // Find or create preference
+            const prefParams = new URLSearchParams();
+            prefParams.set('sysparm_query', `user=${userSysID}^name=sys_update_set`);
+            prefParams.set('sysparm_limit', '1');
+            const prefs = await app.sdk.list('sys_user_preference', prefParams);
+            if (prefs.length > 0) {
+              await app.sdk.update('sys_user_preference', getStringField(prefs[0], 'sys_id'), { value: sysID });
+            } else {
+              await app.sdk.create('sys_user_preference', {
+                user: userSysID,
+                name: 'sys_update_set',
+                value: sysID,
+                type: 'string',
+              });
+            }
+            app.ok({ update_set: argv.name, sys_id: sysID }, { summary: `Current update set: ${argv.name}` });
+          }),
+        })
+        .command({
+          command: 'create',
+          describe: 'Create a new update set',
+          builder: (y) => y
+            .option('name', { alias: 'n', type: 'string', demandOption: true, describe: 'Update set name' })
+            .option('description', { type: 'string', describe: 'Description' }),
+          handler: wrap(async (argv, app) => {
+            const record = await app.sdk.create('sys_update_set', {
+              name: argv.name,
+              description: argv.description || argv.name,
+              state: 'in progress',
+            });
+
+            // Auto-set as current update set
+            const sysID = record?.sys_id?.value || record?.sys_id;
+            try {
+              const user = await app.sdk.list('sys_user', new URLSearchParams({
+                sysparm_query: 'user_name=javascript:gs.getUserName()',
+                sysparm_limit: '1',
+                sysparm_fields: 'sys_id',
+              }));
+              if (user.length > 0) {
+                const userSysID = user[0].sys_id?.value || user[0].sys_id;
+                // Check for existing preference
+                const prefParams = new URLSearchParams();
+                prefParams.set('sysparm_query', `user=${userSysID}^name=sys_update_set`);
+                prefParams.set('sysparm_limit', '1');
+                const prefs = await app.sdk.list('sys_user_preference', prefParams);
+                if (prefs.length > 0) {
+                  const prefID = prefs[0].sys_id?.value || prefs[0].sys_id;
+                  await app.sdk.update('sys_user_preference', prefID, { value: sysID });
+                } else {
+                  await app.sdk.create('sys_user_preference', {
+                    user: userSysID,
+                    name: 'sys_update_set',
+                    value: sysID,
+                    type: 'string',
+                  });
+                }
+              }
+            } catch {
+              // Non-fatal — auto-set is a convenience, not mandatory
+            }
+
+            app.ok(record, {
+              summary: `Created update set: ${argv.name}`,
+              breadcrumbs: [
+                {
+                  action: 'set',
+                  cmd: `jsn dev updatesets set "${argv.name}"`,
+                  description: 'Switch to this update set',
+                },
+                {
+                  action: 'complete',
+                  cmd: `jsn dev updatesets complete "${argv.name}"`,
+                  description: 'Mark as complete when done',
+                },
+              ],
+            });
+          }),
+        })
+
+    },
+    handler: (argv) => {
+      if (!argv._[1]) {
+        console.log('Manage ServiceNow update sets.\n');
+        console.log('Commands:');
+        console.log('  list           List update sets');
+        console.log('  show <name>    Show an update set');
+        console.log('  set  <name>    Set the current update set');
+        console.log('  create         Create a new update set (auto-sets as current)');
+        console.log('  complete <name>  Mark an update set as complete (coming soon)');
+        console.log('  yolo           Silence the "Default update set" warning');
+        console.log('\nRun "jsn dev updatesets <command> --help" for details.');
+        console.log('\nTip: Create an update set first:');
+        console.log('  jsn dev updatesets create --name "My Feature"');
+        console.log('  # → Auto-set as current, then record changes are captured.');
+      }
+    },
+  };
+}

package/src/commands/dev.js

@@ -0,0 +1,53 @@
+// Parent dev command
+
+import {
+  actionsCmd, includesCmd, rulesCmd,
+  clientScriptsCmd, uiActionsCmd, uiPoliciesCmd,
+  tablesCmd, columnsCmd, importCmd,
+  spPagesCmd, spWidgetsCmd, uiPagesCmd, appMenuCmd, scRAPICmd,
+  aclsCmd, rolesCmd, propertiesCmd,
+} from './dev/_simple.js';
+import { flowsCmd } from './dev/flows.js';
+import { formsCmd } from './dev/forms.js';
+import { listsCmd } from './dev/lists.js';
+import { updateSetsCmd } from './dev/updatesets.js';
+import { scopesCmd } from './dev/scopes.js';
+import { evalCmd } from './dev/eval.js';
+import { restCmd } from './dev/rest.js';
+import { logsCmd } from './dev/logs.js';
+
+export function devCmd(wrap) {
+  return {
+    command: 'dev [subcommand]',
+    describe: 'Manage ServiceNow development artifacts',
+    builder: (yargs) => {
+      return yargs
+        .command(flowsCmd(wrap))
+        .command(actionsCmd(wrap))
+        .command(includesCmd(wrap))
+        .command(rulesCmd(wrap))
+        .command(clientScriptsCmd(wrap))
+        .command(uiActionsCmd(wrap))
+        .command(uiPoliciesCmd(wrap))
+        .command(tablesCmd(wrap))
+        .command(columnsCmd(wrap))
+        .command(formsCmd(wrap))
+        .command(listsCmd(wrap))
+        .command(importCmd(wrap))
+        .command(spPagesCmd(wrap))
+        .command(spWidgetsCmd(wrap))
+        .command(uiPagesCmd(wrap))
+        .command(appMenuCmd(wrap))
+        .command(scRAPICmd(wrap))
+        .command(aclsCmd(wrap))
+        .command(rolesCmd(wrap))
+        .command(updateSetsCmd(wrap))
+        .command(scopesCmd(wrap))
+        .command(propertiesCmd(wrap))
+        .command(logsCmd(wrap))
+        .command(evalCmd(wrap))
+        .command(restCmd(wrap));
+    },
+    handler: () => {},
+  };
+}

package/src/commands/groupmembers.js

@@ -0,0 +1,152 @@
+import { formatRecordForDisplay, getStringField } from '../helpers.js';
+
+export function groupMembersCmd(wrap) {
+  return {
+    command: 'groupmembers [subcommand]',
+    aliases: ['groupmember', 'gmember', 'gm'],
+    describe: 'Manage group memberships',
+    builder: (yargs) => {
+      return yargs
+        .command({
+          command: 'list',
+          aliases: ['ls'],
+          describe: 'List group members',
+          builder: (y) => y
+            .option('query', { type: 'string', describe: 'Encoded query (e.g. "nameLIKEincident" or "active=true")' })
+            .option('columns', { alias: ['c', 'fields'], 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', 'group.name'];
+            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_grmember', params);
+            app.ok({
+              table: 'sys_user_grmember',
+              count: records.length,
+              columns,
+              records: records.map(r => formatRecordForDisplay(r, columns)),
+              context: { instance_url: app.getEffectiveInstance() },
+            }, { summary: `${records.length} group member(s)` });
+          }),
+        })
+        .command({
+          command: 'add',
+          describe: 'Add a user to a group',
+          builder: (y) => y
+            .option('group', { alias: 'g', type: 'string', demandOption: true, describe: 'Group name or sys_id (required)' })
+            .option('user', { alias: 'u', type: 'string', demandOption: true, describe: 'Username or sys_id (required)' }),
+          handler: wrap(async (argv, app) => {
+            const groupName = argv.group;
+            const userName = argv.user;
+
+            // Resolve group sys_id
+            const isGroupSysID = groupName.length === 32 && /^[0-9a-fA-F]+$/.test(groupName);
+            const groupParams = new URLSearchParams();
+            groupParams.set('sysparm_query', isGroupSysID ? `sys_id=${groupName}` : `name=${groupName}`);
+            groupParams.set('sysparm_limit', '1');
+            groupParams.set('sysparm_fields', 'sys_id');
+            const groupRecords = await app.sdk.list('sys_user_group', groupParams);
+            if (groupRecords.length === 0) {
+              throw new Error(`Group not found: ${groupName}`);
+            }
+            const groupSysID = getStringField(groupRecords[0], 'sys_id');
+
+            // Resolve user sys_id
+            const isUserSysID = userName.length === 32 && /^[0-9a-fA-F]+$/.test(userName);
+            const userParams = new URLSearchParams();
+            userParams.set('sysparm_query', isUserSysID ? `sys_id=${userName}` : `user_name=${userName}`);
+            userParams.set('sysparm_limit', '1');
+            userParams.set('sysparm_fields', 'sys_id');
+            const userRecords = await app.sdk.list('sys_user', userParams);
+            if (userRecords.length === 0) {
+              throw new Error(`User not found: ${userName}`);
+            }
+            const userSysID = getStringField(userRecords[0], 'sys_id');
+
+            // Check if membership already exists
+            const checkParams = new URLSearchParams();
+            checkParams.set('sysparm_query', `group=${groupSysID}^user=${userSysID}`);
+            checkParams.set('sysparm_limit', '1');
+            checkParams.set('sysparm_fields', 'sys_id');
+            const existing = await app.sdk.list('sys_user_grmember', checkParams);
+            if (existing.length > 0) {
+              throw new Error(`User ${userName} is already a member of group ${groupName}`);
+            }
+
+            // Create the membership
+            const record = await app.sdk.create('sys_user_grmember', {
+              group: groupSysID,
+              user: userSysID,
+            });
+            app.ok(record, {
+              summary: `Added ${userName} to ${groupName}`,
+              breadcrumbs: [
+                { action: 'list', cmd: `jsn groupmembers list --query "group.name=${groupName}"`, description: 'List group members' },
+                { action: 'remove', cmd: `jsn groupmembers remove --group "${groupName}" --user "${userName}"`, description: 'Remove this member' },
+              ],
+            });
+          }),
+        })
+        .command({
+          command: 'remove',
+          describe: 'Remove a user from a group',
+          builder: (y) => y
+            .option('group', { alias: 'g', type: 'string', demandOption: true, describe: 'Group name or sys_id (required)' })
+            .option('user', { alias: 'u', type: 'string', demandOption: true, describe: 'Username or sys_id (required)' }),
+          handler: wrap(async (argv, app) => {
+            const groupName = argv.group;
+            const userName = argv.user;
+
+            // Resolve group sys_id
+            const isGroupSysID = groupName.length === 32 && /^[0-9a-fA-F]+$/.test(groupName);
+            const groupParams = new URLSearchParams();
+            groupParams.set('sysparm_query', isGroupSysID ? `sys_id=${groupName}` : `name=${groupName}`);
+            groupParams.set('sysparm_limit', '1');
+            groupParams.set('sysparm_fields', 'sys_id');
+            const groupRecords = await app.sdk.list('sys_user_group', groupParams);
+            if (groupRecords.length === 0) {
+              throw new Error(`Group not found: ${groupName}`);
+            }
+            const groupSysID = getStringField(groupRecords[0], 'sys_id');
+
+            // Resolve user sys_id
+            const isUserSysID = userName.length === 32 && /^[0-9a-fA-F]+$/.test(userName);
+            const userParams = new URLSearchParams();
+            userParams.set('sysparm_query', isUserSysID ? `sys_id=${userName}` : `user_name=${userName}`);
+            userParams.set('sysparm_limit', '1');
+            userParams.set('sysparm_fields', 'sys_id');
+            const userRecords = await app.sdk.list('sys_user', userParams);
+            if (userRecords.length === 0) {
+              throw new Error(`User not found: ${userName}`);
+            }
+            const userSysID = getStringField(userRecords[0], 'sys_id');
+
+            // Find the membership record
+            const findParams = new URLSearchParams();
+            findParams.set('sysparm_query', `group=${groupSysID}^user=${userSysID}`);
+            findParams.set('sysparm_limit', '1');
+            findParams.set('sysparm_fields', 'sys_id');
+            const membershipRecords = await app.sdk.list('sys_user_grmember', findParams);
+            if (membershipRecords.length === 0) {
+              throw new Error(`User ${userName} is not a member of group ${groupName}`);
+            }
+            const membershipSysID = getStringField(membershipRecords[0], 'sys_id');
+
+            // Delete the membership
+            await app.sdk.delete('sys_user_grmember', membershipSysID);
+            app.ok({ user: userName, group: groupName }, {
+              summary: `Removed ${userName} from ${groupName}`,
+              breadcrumbs: [
+                { action: 'list', cmd: `jsn groupmembers list --query "group.name=${groupName}"`, description: 'List group members' },
+                { action: 'add', cmd: `jsn groupmembers add --group "${groupName}" --user "${userName}"`, description: 'Add user back to group' },
+              ],
+            });
+          }),
+        });
+    },
+    handler: () => {},
+  };
+}