@servicenow/sdk-build-core 3.0.2 → 4.0.0

package/now.config.schema.json

@@ -0,0 +1,336 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "description": "ServiceNow SDK configuration schema",
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+        "$schema": {
+            "type": "string",
+            "description": "Schema file to validate this configuration file"
+        },
+        "scope": {
+            "type": "string",
+            "minLength": 4,
+            "maxLength": 18,
+            "pattern": "^((x|sn)_[a-z0-9_]+|global)$",
+            "description": "Scope of the application (example: 'x_myapp' or 'sn_myapp')"
+        },
+        "name": {
+            "type": "string",
+            "minLength": 4,
+            "maxLength": 100,
+            "description": "Name of the application (example: 'MyApp')"
+        },
+        "scopeId": {
+            "type": "string",
+            "minLength": 32,
+            "maxLength": 32,
+            "pattern": "^[0-9a-f]{32}$",
+            "description": "Scope ID of the application (example: 'fc1b5713c3db3110d6489a038a40dd85')"
+        },
+        "entitiesDir": {
+            "type": "string",
+            "minLength": 1,
+            "deprecated": true,
+            "description": "DEPRECATED: Use 'fluentDir' instead"
+        },
+        "fluentDir": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Directory containing .now.ts fluent files of the application",
+            "default": "src/fluent"
+        },
+        "clientDir": {
+            "type": "string",
+            "description": "Directory containing client files of the application, such as HTML and TypeScript files. Set to empty to disable the client build.",
+            "default": "src/client"
+        },
+        "generatedDir": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Directory relative to 'fluentDir' where Fluent will generate files, such as keys.ts",
+            "default": "generated"
+        },
+        "staticContentDir": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Directory containing static asset files of the application",
+            "default": "dist/static"
+        },
+        "staticContentPaths": {
+            "type": "object",
+            "description": "Mapping of source files to static output paths.",
+            "patternProperties": {
+                ".*": {
+                    "type": "string",
+                    "minLength": 1
+                }
+            }
+        },
+        "npmUpdateCheck": {
+            "type": [
+                "number",
+                "boolean"
+            ],
+            "default": 10
+        },
+        "serverModulesDir": {
+            "type": "string",
+            "description": "Directory containing modular files to be built into sys_modules",
+            "default": "src/server"
+        },
+        "modulePaths": {
+            "type": "object",
+            "description": "Mapping between file glob patterns to resolve imported file paths to valid runtime paths. This is needed if your Fluent files are importing modules from a different location than the runtime modules. For example, if you have a custom TypeScript setup that transpiles modules from a 'src' directory to a 'dist' directory, you would need to specify that mapping here.",
+            "patternProperties": {
+                ".*": {
+                    "type": "string"
+                }
+            }
+        },
+        "tsconfigPath": {
+            "type": "string",
+            "description": "Path to tsconfig file to be used for transpilation of server module typescript. ServiceNow SDK will emit build errors following the referenced tsconfig. (example: './src/server/tsconfig.json')"
+        },
+        "transpiledSourceDir": {
+            "type": "string",
+            "deprecated": true,
+            "description": "DEPRECATED: Use 'modulePaths' instead"
+        },
+        "metadataDir": {
+            "type": "string",
+            "description": "Directory containing metadata xml for the app",
+            "default": "metadata"
+        },
+        "appOutputDir": {
+            "type": "string",
+            "description": "Location to output built application for packaging during fluent build command",
+            "default": "dist/app"
+        },
+        "packOutputDir": {
+            "type": "string",
+            "description": "Location to output the zip file during build process, to be later installed on the instance during install command",
+            "default": "target"
+        },
+        "sourceDir": {
+            "type": "string",
+            "deprecated": true,
+            "description": "DEPRECATED: This is no longer needed"
+        },
+        "ignoreTransformTableList": {
+            "type": "array",
+            "description": "List of tables to ignore when transforming entities to ServiceNow tables",
+            "items": {
+                "type": "string",
+                "minLength": 1,
+                "pattern": "^[a-z_\\d]+$"
+            }
+        },
+
+        "dependencies": {
+            "type": "object",
+            "additionalProperties": false,
+            "description": "Reference dependencies on other ServiceNow application tables and entities",
+            "properties": {
+                "applications": {
+                    "type": "object",
+                    "deprecated": true,
+                    "additionalProperties": false,
+                    "description": "List of applications that this application depends on",
+                    "patternProperties": {
+                        "^global$|^x|sn_[a-z0-9_]+$": {
+                            "type": "object",
+                            "additionalProperties": false,
+                            "properties": {
+                                "tables": {
+                                    "type": "array",
+                                    "description": "List of tables that this application depends on (example: 'cmdb_ci')",
+                                    "items": {
+                                        "type": "string",
+                                        "minLength": 1,
+                                        "pattern": "^[a-z_][a-z0-9_]*[a-z0-9]$"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "active": {
+            "type": "boolean",
+            "description": "Is the application active"
+        },
+        "accessControls": {
+            "type": "object",
+            "additionalProperties": false,
+            "description": "Manage scoping restrictions and access to the application",
+            "properties": {
+                "scopedAdministration": {
+                    "type": "boolean",
+                    "description": "If true, System Admins will be prevented from accessing the application",
+                    "default": false
+                },
+                "canEditInStudio": {
+                    "type": "boolean",
+                    "description": "Can the application be opened in developer studio",
+                    "default": true
+                },
+                "runtimeAccessTracking": {
+                    "type": "string",
+                    "enum": [
+                        "none",
+                        "permissive",
+                        "enforcing"
+                    ],
+                    "description": "Runtime access tracking for the application",
+                    "default": "permissive"
+                },
+                "restrictTableAccess": {
+                    "type": "boolean",
+                    "description": "Restrict design time access to tables from outside the application",
+                    "default": false
+                },
+                "private": {
+                    "type": "boolean",
+                    "description": "Mark the application as private",
+                    "default": false
+                },
+                "trackable": {
+                    "type": "boolean",
+                    "description": "Mark the application as trackable",
+                    "default": true
+                },
+                "uninstallBlocked": {
+                    "type": "boolean",
+                    "description": "Uninstall blocked for the application",
+                    "default": false
+                },
+                "hideOnUI": {
+                    "type": "boolean",
+                    "description": "Application hidden in UI",
+                    "default": false
+                },
+                "userRole": {
+                    "type": "string",
+                    "description": "Role required for end users to access the application and its tables",
+                    "pattern": "^[0-9a-f]{32}$"
+                }
+            }
+        },
+        "jsLevel": {
+            "type": "string",
+            "enum": [
+                "es_latest",
+                "helsinki_es5",
+                "traditional"
+            ],
+            "description": "JavaScript level for the application",
+            "default": "es_latest"
+        },
+        "licensing": {
+            "type": "object",
+            "additionalProperties": false,
+            "description": " If this application is licensable, set the subscription requirement and model.",
+            "properties": {
+                "licensable": {
+                    "type": "boolean",
+                    "description": "Mark package as licensable",
+                    "default": true
+                },
+                "enforceLicense": {
+                    "type": "string",
+                    "enum": [
+                        "none",
+                        "log",
+                        "enforce"
+                    ],
+                    "description": "Subscription requirement for the application",
+                    "default": "log"
+                },
+                "licenseModel": {
+                    "type": "string",
+                    "enum": [
+                        "none",
+                        "fulfiller",
+                        "producer",
+                        "capacity",
+                        "mixed",
+                        "app_use"
+                    ],
+                    "description": "License model for the application",
+                    "default": "none"
+                },
+                "licenseCategory": {
+                    "type": "string",
+                    "enum": [
+                        "none",
+                        "general",
+                        "beta"
+                    ],
+                    "description": "License category for the application",
+                    "default": "none"
+                },
+                "subscriptionEntitlement": {
+                    "type": "string",
+                    "description": "SysID of the subscription entitlement for the application",
+                    "pattern": "^[0-9a-f]{32}$"
+                }
+            }
+        },
+        "menu": {
+            "type": "string",
+            "description": "SysID of the application's primary menu for default table modules",
+            "pattern": "^[0-9a-f]{32}$"
+        },
+        "description": {
+            "type": "string",
+            "description": "Description of the application"
+        },
+        "logo": {
+            "type": "string",
+            "description": "SysID of the app logo",
+            "pattern": "^[0-9a-f]{32}$"
+        },
+        "guidedSetupGuid": {
+            "type": "string",
+            "description": "SysID of the Guided Setup to start when the application is upgraded",
+            "pattern": "^[0-9a-f]{32}$"
+        },
+        "installedAsDependency": {
+            "type": "boolean",
+            "description": "App was installed as a dependency",
+            "default": false
+        },
+        "scripts": {
+            "type": "object",
+            "description": "Define scripts that are executed with the SDK task runner. The task functions are async and are passed APIs for cross-environment compatibility. Use prebuild to run a script before the build process for custom build tasks.",
+            "patternProperties": {
+                ".*": {
+                    "type": "string",
+                    "pattern": "\\.m?js$"
+                }
+            }
+        },
+        "tableOutputFormat": {
+            "type": "string",
+            "enum": [
+                "bootstrap",
+                "component"
+            ],
+            "default": "bootstrap",
+            "description": "Artifact type built for table definitions. Traditional bootstrap or separate component records."
+        }
+    },
+    "required": [
+        "scope",
+        "scopeId"
+    ],
+    "not": {
+        "required": [
+            "modulePaths",
+            "tsconfigPath"
+        ],
+        "message": "Cannot specify both 'modulePaths' and 'tsconfigPath'. Use 'tsconfigPath' to supply a custom tsconfig.json file to use for internal transpilation during build. Use 'modulePaths' to map paths from 'serverModulesDir' to output directory if using a separate transpilation step"
+    }
+}

package/package.json

@@ -1,38 +1,48 @@
 {
   "name": "@servicenow/sdk-build-core",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "description": "ServiceNow SDK Build System Core Libraries",
   "license": "MIT",
   "main": "./dist/index.js",
   "files": [
     "dist",
-    "src"
+    "src",
+    "now.config.schema.json"
   ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
   "dependencies": {
-    "fast-xml-parser": "4.4.1",
+    "fast-glob": "3.3.2",
+    "json5": "2.2.3",
+    "jsonschema": "1.4.1",
     "lodash": "4.17.21",
+    "pathe": "1.1.2",
+    "prettier": "3.6.1",
+    "readable-stream": "4.5.2",
+    "ts-morph": "23.0.0",
+    "vscode-languageserver": "9.0.1",
     "xmlbuilder2": "3.1.1",
     "zod": "3.22.4",
-    "@servicenow/sdk-core": "3.0.2",
-    "@servicenow/sdk-project": "3.0.2"
+    "fflate": "0.8.2",
+    "@servicenow/sdk-core": "4.0.0"
   },
   "overrides": {
     "micromatch": "4.0.7"
   },
   "devDependencies": {
-    "@types/lodash": "4.14.195"
+    "@types/lodash": "4.17.6",
+    "@types/readable-stream": "4.0.15",
+    "type-fest": "4.26.1"
   },
   "engines": {
-    "node": ">=18.16.1",
-    "pnpm": ">=9.4.0"
+    "node": ">=20.18.0",
+    "pnpm": ">=10.8.0"
   },
   "scripts": {
     "build": "tsc -b",
     "clean": "tsc -b --clean",
-    "lint": "eslint . --ext .ts",
-    "prettier:check": "prettier --check --ignore-path=../../.prettierignore .",
-    "prettier:write": "prettier --write --ignore-path=../../.prettierignore .",
     "watch": "tsc -b -w",
-    "test": "tsc -b tsconfig.test.json && export NODE_OPTIONS=\"--max-old-space-size=8192 --experimental-vm-modules\" && jest --colors --reporters=default --no-cache --logHeapUsage"
+    "test": "export NODE_OPTIONS=\"--max-old-space-size=8192 --experimental-vm-modules\" && jest --colors --reporters=default --no-cache --logHeapUsage"
   }
 }

package/src/app.ts

@@ -0,0 +1,33 @@
+import type { FileSystem } from './fs'
+import type { NowConfig } from './now-config'
+import { readJson } from './json'
+import type { PackageJson } from 'type-fest'
+
+export type App = {
+    /**
+     * The parsed package.json
+     */
+    package: Package
+
+    /**
+     * SDK-specific configuration
+     */
+    config: NowConfig
+
+    /**
+     * Root directory of the project
+     */
+    rootDir: string
+}
+
+export type Package = PackageJson & {
+    name: string
+    version: string
+    now?: NowConfig
+    dependencies?: Record<string, string>
+    devDependencies?: Record<string, string>
+}
+
+export function parsePackageJson(rootDir: string, fs: FileSystem): Package {
+    return readJson(rootDir, 'package.json', fs)
+}