@servicenow/sdk-build-plugins 4.4.1 → 4.6.0

package/src/service-portal/widget-plugin.ts

@@ -1,11 +1,10 @@
-import { CallExpressionShape, isGUID, Plugin, type Shape } from '@servicenow/sdk-build-core'
-import { noThrow, reverseObject } from '../utils'
-import { type SPTemplate, WidgetCategories } from '@servicenow/sdk-core/runtime/service-portal'
-import { NowIdShape } from '../now-id-plugin'
-import { NowIncludeShape } from '../now-include-plugin'
+import { CallExpressionShape, Plugin } from '@servicenow/sdk-build-core'
+import { createSdkDocEntry } from '../utils'
+import { createWidgetToRecord, createWidgetToShape } from './utils'
 
 export const SPWidgetPlugin = Plugin.create({
     name: 'SPWidgetPlugin',
+    docs: [createSdkDocEntry('SPWidget', ['sp_widget'])],
     records: {
         sp_widget: {
             relationships: {
@@ -13,83 +12,8 @@ export const SPWidgetPlugin = Plugin.create({
                 m2m_sp_ng_pro_sp_widget: { via: 'sp_widget', descendant: true },
                 sp_ng_template: { via: 'sp_widget', descendant: true },
             },
-            toShape(record, { descendants }) {
-                const dependencies = descendants.query('m2m_sp_widget_dependency')
-                const angularProviders = descendants.query('m2m_sp_ng_pro_sp_widget')
-                const templates = descendants.query('sp_ng_template').map((template) => {
-                    return {
-                        $id: template.getId(),
-                        id: template.get('id'),
-                        htmlTemplate: template.get('template'),
-                    }
-                })
-
-                const category = reverseObject(WidgetCategories)[record.get('category').ifString()?.getValue() || '']
-
-                return {
-                    success: true,
-                    value: new CallExpressionShape({
-                        source: record,
-                        callee: 'SPWidget',
-                        args: [
-                            record.transform(({ $ }) => ({
-                                $id: $.val(NowIdShape.from(record)),
-                                name: $,
-                                category: $.val(category).def('custom'),
-                                clientScript: $.from('client_script').def(''),
-                                serverScript: $.from('script').def(''),
-                                controllerAs: $.from('controller_as').def('c'),
-                                htmlTemplate: $.from('template').def(''),
-                                customCss: $.from('css').def(''),
-                                dataTable: $.from('data_table').def('sp_instance'),
-                                demoData: $.from('demo_data')
-                                    .map((d) => {
-                                        const json = d.ifString()?.getValue()
-
-                                        const parsed = noThrow(() => json && JSON.parse(json))
-                                        return parsed instanceof Error ? json : parsed
-                                    })
-                                    .def(''),
-                                description: $.def(''),
-                                docs: $.def(''),
-                                fields: $.from('field_list')
-                                    .map((fields) => {
-                                        const fieldStr = fields.ifString()?.getValue()
-                                        return fieldStr && fieldStr.split(',')
-                                    })
-                                    .def(''),
-                                hasPreview: $.from('has_preview').toBoolean().def(false),
-                                id: $.def(''),
-                                internal: $.toBoolean().def(false),
-                                linkScript: $.from('link').def(''),
-                                roles: $.map((role) => {
-                                    const roleStr = role.ifString()?.getValue()
-                                    return roleStr && roleStr.split(',')
-                                }).def(''),
-                                servicenow: $.toBoolean().def(false),
-                                optionSchema: $.from('option_schema')
-                                    .map((v) => {
-                                        const json = v.ifString()?.getValue()
-                                        const parsed = noThrow(() => json && JSON.parse(json))
-                                        return parsed instanceof Error ? json : parsed
-                                    })
-                                    .def(''),
-                                public: $.toBoolean().def(false),
-                                dependencies: $.val(
-                                    dependencies.length > 0
-                                        ? dependencies.map((dep) => dep.get('sp_dependency'))
-                                        : undefined
-                                ),
-                                angularProviders: $.val(
-                                    angularProviders.length > 0
-                                        ? angularProviders.map((ap) => ap.get('sp_angular_provider'))
-                                        : undefined
-                                ),
-                                templates: $.val(templates.length > 0 ? templates : undefined),
-                            })),
-                        ],
-                    }),
-                }
+            async toShape(record, { descendants }) {
+                return createWidgetToShape(record, descendants, 'SPWidget')
             },
         },
         m2m_sp_widget_dependency: {
@@ -108,148 +32,18 @@ export const SPWidgetPlugin = Plugin.create({
                     return { success: false }
                 }
 
-                const widget = callExpression.getArgument(0).asObject()
-                const dependencies =
-                    widget
-                        .get('dependencies')
-                        .ifArray()
-                        ?.map((dep) => (dep.isString() ? dep.getValue() : dep.ifRecord()?.getId())) || []
-                const angularProviders =
-                    widget
-                        .get('angularProviders')
-                        .ifArray()
-                        ?.map((ap) => (ap.isString() ? ap.getValue() : ap.ifRecord()?.getId())) || []
-
-                const templates =
-                    widget
-                        .get('templates')
-                        .ifArray()
-                        ?.map((shp) => shp.getValue() as SPTemplate) || []
-                const widgetId = widget.get('id').ifString()
-                if (widgetId && !/^[a-zA-Z0-9_-]+$/g.test(widgetId.getValue())) {
-                    diagnostics.error(
-                        widgetId.getOriginalNode(),
-                        `Invalid value: must contain only alphanumeric, -, or _ characters`
-                    )
-                }
-
-                const roles = widget
-                    .get('roles')
-                    .ifArray()
-                    ?.map((role) => {
-                        if (role.isString()) {
-                            return role
-                        }
-                        if (role.isRecord()) {
-                            return role.get('name')
-                        }
-
-                        return undefined
-                    })
-                    .filter((role) => role) as Shape[] | undefined
-
-                if (roles) {
-                    roles
-                        .filter((role) => isGUID(role.getValue() as string))
-                        .forEach((role) =>
-                            diagnostics.error(
-                                role!.getOriginalNode(),
-                                `expecting role names or role records created by the Role or Record plugins, not sys_ids`
-                            )
-                        )
-                }
-
-                const controller = widget.get('controllerAs').ifString()?.getValue() || 'c'
-                const servicenow =
-                    (widget.get('servicenow').ifBoolean()?.getValue() &&
-                        (config.scope.startsWith('sn_') || config.scope.startsWith('snc_'))) ||
-                    false
-
-                const widgetRecord = await factory.createRecord({
-                    source: callExpression,
-                    table: 'sp_widget',
-                    explicitId: widget.get('$id'),
-                    properties: widget.transform(({ $ }) => ({
-                        name: $,
-                        category: $.map((v) => {
-                            const catKey = v.ifString()?.getValue() || ''
-                            return WidgetCategories[catKey as keyof typeof WidgetCategories]
-                        }).def('custom'),
-                        client_script: $.from('clientScript').def(getDefaultClientScript(controller)),
-                        script: $.from('serverScript').def(SP_WIDGET_DEFAULT_SERVER_SCRIPT),
-                        controller_as: $.from('controllerAs').def('c'),
-                        template: $.from('htmlTemplate').def(SP_WIDGET_DEFAULT_HTML_TEMPLATE),
-                        css: $.from('customCss').def(''),
-                        data_table: $.from('dataTable').def('sp_instance'),
-                        demo_data: $.from('demoData')
-                            .map((v) =>
-                                v.ifString() || v instanceof NowIncludeShape ? v : JSON.stringify(v.getValue())
-                            )
-                            .def(''),
-                        description: $.def(''),
-                        docs: $.map((v) => (v.isString() ? v : v.ifRecord()?.getId())),
-                        field_list: $.from('fields')
-                            .map((v) => v.getValue()?.toString())
-                            .def(''),
-                        has_preview: $.from('hasPreview').toBoolean().def(false),
-                        id: $.def(''),
-                        internal: $.def(false),
-                        servicenow: $.val(servicenow),
-                        link: $.from('linkScript').def(SP_WIDGET_DEFAULT_LINK_SCRIPT),
-                        roles: $.val(roles?.map((r) => r.getValue()).toString()).def(''),
-                        option_schema: $.from('optionSchema')
-                            .map((v) => {
-                                const json = v.getValue()
-                                return json && JSON.stringify(json)
-                            })
-                            .def(''),
-                        public: $.def(false),
-                    })),
-                })
-
-                return {
-                    success: true,
-                    value: widgetRecord.with(
-                        ...(await Promise.all(
-                            templates.map(async (template: SPTemplate) => {
-                                return await factory.createRecord({
-                                    source: callExpression,
-                                    table: 'sp_ng_template',
-                                    explicitId: template.$id as string,
-                                    properties: {
-                                        id: template.id,
-                                        sp_widget: widgetRecord.getId(),
-                                        template: template.htmlTemplate,
-                                    },
-                                })
-                            })
-                        )),
-                        ...(await Promise.all(
-                            dependencies.map(async (dep) => {
-                                return await factory.createRecord({
-                                    source: callExpression,
-                                    table: 'm2m_sp_widget_dependency',
-                                    properties: {
-                                        sp_dependency: dep!,
-                                        sp_widget: widgetRecord.getId(),
-                                    },
-                                })
-                            })
-                        )),
-                        ...(await Promise.all(
-                            angularProviders.map(async (ap) => {
-                                return await factory.createRecord({
-                                    source: callExpression,
-                                    table: 'm2m_sp_ng_pro_sp_widget',
-                                    properties: {
-                                        sp_angular_provider: ap!,
-                                        sp_widget: widgetRecord.getId(),
-                                    },
-                                })
-                            })
-                        ))
-                    ),
-                }
+                return createWidgetToRecord(
+                    callExpression,
+                    { diagnostics, factory, config },
+                    {
+                        callee: 'SPWidget',
+                        table: 'sp_widget',
+                        getDefaultClientScript,
+                        defaultServerScript: SP_WIDGET_DEFAULT_SERVER_SCRIPT,
+                        defaultLinkScript: SP_WIDGET_DEFAULT_LINK_SCRIPT,
+                        defaultHtmlTemplate: SP_WIDGET_DEFAULT_HTML_TEMPLATE,
+                    }
+                )
             },
         },
     ],

package/src/sla-plugin.ts

@@ -1,5 +1,6 @@
 import { CallExpressionShape, Plugin, DurationShape } from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
+import { createSdkDocEntry } from './utils'
 import {
     validateUserSpecifiedDuration,
     validateRelativeDuration,
@@ -36,6 +37,7 @@ const DEFAULT_DURATION_ON_PLATFORM = '1970-01-01 00:00:00'
  */
 export const SLAPlugin = Plugin.create({
     name: 'SLAPlugin',
+    docs: [createSdkDocEntry('Sla', ['contract_sla'])],
 
     records: {
         contract_sla: {

package/src/static-content-plugin.ts

@@ -3,6 +3,7 @@ import * as mime from 'mime-types'
 import { Shape, Plugin, type Record, unloadBuilder, gzipSync, type RecordContext } from '@servicenow/sdk-build-core'
 import { path as pathModule } from '@servicenow/sdk-build-core'
 import { INVALID_XML_CHARACTERS } from './utils'
+import { TRANSLATIONS_ASSET_NAME } from '@servicenow/isomorphic-rollup'
 
 // based on tectonic code for attachments
 // https://code.devsnc.com/dev/sn-tectonic/blob/b3ab42ce742158cb5a0d00efd540b97eeafcbdd7/core/metadata-transform-san-diego/utils/index.js#L66
@@ -91,6 +92,7 @@ const toNoOpShape = (record: Record) => {
 
 export const StaticContentPlugin = Plugin.create({
     name: 'StaticContentPlugin',
+    docs: [],
     records: {
         // TODO: remove when we have generic attachment support
         sys_attachment: {
@@ -165,6 +167,8 @@ export const StaticContentPlugin = Plugin.create({
                     // Build-time manifest produced by the uiPageSourceManifest rollup plugin.
                     // Consumed by UiPage during build to determine which source files to include
                     // in the source artifact record. Not a deployable asset.
+                } else if (relativePath === TRANSLATIONS_ASSET_NAME) {
+                    logger.debug('translations not supported yet')
                 } else if (mimeType === 'application/javascript') {
                     tableName = 'sys_ux_lib_asset'
                     assetName = pathModule.join(