@servicenow/sdk-build-plugins 4.6.0 → 4.7.0

package/src/utils.ts

@@ -4,9 +4,11 @@ import {
     type ObjectShape,
     type Diagnostics,
     type Compiler,
-    type PluginApiDoc,
     type Record as FluentRecord,
+    type OutputFile,
+    type Transform,
 } from '@servicenow/sdk-build-core'
+import { create } from 'xmlbuilder2'
 
 export function toReference(shape: Shape) {
     return shape.ifRecord()?.getId() ?? shape.ifString()?.getValue() ?? ''
@@ -130,17 +132,52 @@ export const showGuidFieldDiagnostic = (
     }
 }
 
-/**
- * Creates a documentation entry for first-party SDK plugins.
- *
- * @param apiName - The API name (e.g., 'BusinessRule', 'Acl')
- * @param tags - Keywords for categorization (typically includes the ServiceNow table name)
- * @returns A complete PluginApiDoc entry
- */
-export function createSdkDocEntry(apiName: string, tags: string[]): PluginApiDoc {
+export async function generateChoiceSetFile(
+    choiceSet: FluentRecord,
+    choices: FluentRecord[],
+    config: { scope: string; scopeId: string },
+    transform: Transform
+): Promise<OutputFile> {
+    const tableName = choiceSet.get('name').asString().getValue()
+    const elementName = choiceSet.get('element').asString().getValue()
+    const xml = create().ele('record_update')
+    const root = xml.ele('sys_choice_set', { table: tableName, field: elementName })
+
+    choices.forEach((choice) => {
+        const child = root.ele('sys_choice', { action: choice.getAction() })
+        child.ele('sys_id').txt(choice.getId().getValue())
+        child.ele('name').txt(tableName)
+        child.ele('element').txt(elementName)
+
+        for (const prop of [
+            'label',
+            'value',
+            'sequence',
+            'dependent_value',
+            'hint',
+            'inactive',
+            'inactive_on_update',
+            'language',
+        ]) {
+            choice
+                .get(prop)
+                .ifDefined()
+                ?.toString()
+                .pipe((p) => child.ele(prop).txt(p.getValue()))
+        }
+    })
+
+    const child = root.ele('sys_choice_set', { action: choiceSet.getAction() })
+    child.ele('sys_id').txt(choiceSet.getId().getValue())
+    child.ele('sys_scope', { display_value: config.scope }).txt(config.scopeId)
+    child.ele('name').txt(tableName)
+    child.ele('element').txt(elementName)
+
     return {
-        apiName,
-        tags,
+        source: choiceSet,
+        name: `${await transform.getUpdateName(choiceSet)}.xml`,
+        category: choiceSet.getInstallCategory(),
+        content: xml.end({ prettyPrint: true }),
     }
 }
 

package/src/ux-list-menu-config-plugin.ts

@@ -1,11 +1,9 @@
 import { Plugin, CallExpressionShape, type Record } from '@servicenow/sdk-build-core'
 
 import { NowIdShape } from './now-id-plugin'
-import { createSdkDocEntry } from './utils'
 
 export const UxListMenuConfigPlugin = Plugin.create({
     name: 'UxListMenuConfigPlugin',
-    docs: [createSdkDocEntry('UxListMenuConfig', ['sys_ux_list_menu_config'])],
     records: {
         sys_ux_list_menu_config: {
             relationships: {

package/src/view-plugin.ts

@@ -2,7 +2,6 @@ import { Plugin, Record, RecordId, Shape, ts } from '@servicenow/sdk-build-core'
 
 export const ViewPlugin = Plugin.create({
     name: 'ViewPlugin',
-    docs: [],
     records: {
         sys_ui_view: {
             coalesce: ['name'],

package/src/workspace-plugin.ts

@@ -8,7 +8,6 @@ import {
     Database,
 } from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
-import { createSdkDocEntry } from './utils'
 import { parsePagePropChromeTabJson, createChromeTabJsonStringForPageProp } from './workspace-plugin/chrome-tab'
 import { createPage } from './workspace-plugin/page'
 import {
@@ -43,7 +42,6 @@ type InnerTransformFromObjectShape = Parameters<Parameters<ObjectShape['transfor
 
 export const WorkspacePlugin = Plugin.create({
     name: 'WorkspacePlugin',
-    docs: [createSdkDocEntry('Workspace', ['sys_ux_page_registry'])],
     records: {
         sys_ux_page_registry: {
             relationships: {