@servicenow/sdk-build-plugins 4.5.0 → 4.6.0

package/src/workspace-plugin.ts

@@ -5,6 +5,7 @@ import {
     type Record,
     type Shape,
     type ObjectShape,
+    Database,
 } from '@servicenow/sdk-build-core'
 import { NowIdShape } from './now-id-plugin'
 import { createSdkDocEntry } from './utils'
@@ -47,68 +48,36 @@ export const WorkspacePlugin = Plugin.create({
         sys_ux_page_registry: {
             relationships: {
                 sys_ux_registry_m2m_category: {
-                    via: (parent, child) =>
-                        child.getCreator()?.getName() === 'WorkspacePlugin' &&
-                        parent.getId().getValue() ===
-                            (child.get('page_registry').isRecord()
-                                ? child.get('page_registry').asRecord().getId().getValue()
-                                : child.get('page_registry').asString().getValue()),
+                    via: 'page_registry',
                     descendant: true,
                 },
                 sys_ux_page_property: {
-                    via: (parent, child) =>
-                        child.getCreator()?.getName() === 'WorkspacePlugin' &&
-                        parent.getId().getValue() ===
-                            (child.get('page').isRecord()
-                                ? child.get('page').asRecord().getId().getValue()
-                                : child.get('page').asString().getValue()),
+                    via: 'page',
                     descendant: true,
                 },
                 sys_ux_app_config: {
-                    via: (parent, child) =>
-                        child.getCreator()?.getName() === 'WorkspacePlugin' &&
-                        child.getId().getValue() ===
-                            (parent.get('admin_panel').isRecord()
-                                ? parent.get('admin_panel').asRecord().getId().getValue()
-                                : parent.get('admin_panel').asString().getValue()),
+                    via: 'admin_panel',
+                    inverse: true,
                     descendant: true,
                     relationships: {
                         sys_ux_screen: {
-                            via: (parent, child) =>
-                                child.getCreator()?.getName() === 'WorkspacePlugin' &&
-                                parent.getId().getValue() ===
-                                    (child.get('app_config').isRecord()
-                                        ? child.get('app_config').asRecord().getId().getValue()
-                                        : child.get('app_config').asString().getValue()),
+                            via: 'app_config',
                             descendant: true,
                             relationships: {
                                 sys_ux_macroponent: {
-                                    via: (parent, child) =>
-                                        child.getCreator()?.getName() === 'WorkspacePlugin' &&
-                                        child.getId().getValue() ===
-                                            (parent.get('macroponent').isRecord()
-                                                ? parent.get('macroponent').asRecord().getId().getValue()
-                                                : parent.get('macroponent').asString().getValue()),
+                                    via: 'macroponent',
+                                    inverse: true,
                                     descendant: true,
                                 },
                             },
                         },
                         sys_ux_app_route: {
-                            via: (parent, child) =>
-                                child.getCreator()?.getName() === 'WorkspacePlugin' &&
-                                parent.getId().getValue() ===
-                                    (child.get('app_config').isRecord()
-                                        ? child.get('app_config').asRecord().getId().getValue()
-                                        : child.get('app_config').asString().getValue()),
+                            via: 'app_config',
                             descendant: true,
                             relationships: {
                                 sys_ux_screen_type: {
-                                    via: (parent, child) =>
-                                        child.getCreator()?.getName() === 'WorkspacePlugin' &&
-                                        child.getId().getValue() ===
-                                            (parent.get('screen_type').isRecord()
-                                                ? parent.get('screen_type').asRecord().getId().getValue()
-                                                : parent.get('screen_type').asString().getValue()),
+                                    via: 'screen_type',
+                                    inverse: true,
                                     descendant: true,
                                 },
                             },
@@ -116,10 +85,33 @@ export const WorkspacePlugin = Plugin.create({
                     },
                 },
             },
-            async toShape(pageRegRecord, { factory, descendants }) {
+            async toShape(pageRegRecord, { factory, descendants: descendantsDB }) {
                 if (pageRegRecord.getCreator()?.getName() !== 'WorkspacePlugin') {
                     return { success: false }
                 }
+
+                const excludedRecords: Record[] = []
+                const supportedRecords: Record[] = []
+                const partiallySupportedTables = new Set<string>([
+                    'sys_ux_registry_m2m_category',
+                    'sys_ux_page_property',
+                    'sys_ux_app_config',
+                    'sys_ux_screen',
+                    'sys_ux_macroponent',
+                    'sys_ux_app_route',
+                    'sys_ux_screen_type',
+                ])
+                descendantsDB.query().forEach((descendant) => {
+                    if (
+                        partiallySupportedTables.has(descendant.getTable()) &&
+                        descendant.getCreator()?.getName() !== 'WorkspacePlugin'
+                    ) {
+                        excludedRecords.push(descendant)
+                    } else {
+                        supportedRecords.push(descendant)
+                    }
+                })
+                const descendants = new Database(supportedRecords)
                 // Get 'path' and 'title'
                 // TODO 'active'
                 const path: string = pageRegRecord.get('path').asString().getValue() ?? ''
@@ -226,6 +218,14 @@ export const WorkspacePlugin = Plugin.create({
                     defaultRecordOverrides,
                 })
 
+                if (excludedRecords.length > 0) {
+                    return {
+                        success: 'partial',
+                        value: callExpressionShape,
+                        unhandledRecords: excludedRecords,
+                    }
+                }
+
                 return {
                     success: true,
                     value: callExpressionShape,