@tenonhq/dovetail-core 0.0.85

package/dist/wizard.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLoginInfo = getLoginInfo;
+exports.setupDotEnv = setupDotEnv;
+const inquirer_1 = __importDefault(require("inquirer"));
+const FileUtils_1 = require("./FileUtils");
+async function getLoginInfo() {
+    return await inquirer_1.default.prompt([
+        {
+            type: "input",
+            name: "instance",
+            message: "What instance would you like to connect to?(ex. test123.service-now.com)",
+        },
+        {
+            type: "input",
+            name: "username",
+            message: "What is your username on that instance?",
+        },
+        {
+            type: "password",
+            name: "password",
+            message: "What is your password on that instance?",
+        },
+    ]);
+}
+async function setupDotEnv(answers) {
+    process.env.SN_USER = answers.username;
+    process.env.SN_PASSWORD = answers.password;
+    process.env.SN_INSTANCE = answers.instance;
+    (0, FileUtils_1.writeEnvVars)({
+        vars: [
+            { key: "SN_USER", value: answers.username },
+            { key: "SN_PASSWORD", value: answers.password },
+            { key: "SN_INSTANCE", value: answers.instance },
+        ],
+    });
+}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@tenonhq/dovetail-core",
+  "version": "0.0.85",
+  "description": "Next-gen file syncer",
+  "license": "GPL-3.0",
+  "main": "./dist/index.js",
+  "author": "Multiple",
+  "private": false,
+  "scripts": {
+    "copy:skills": "mkdir -p skills && cp ../../skills/*.md ./skills/",
+    "prepack": "npm run copy:skills && tsc && npm run validate-dist",
+    "validate-dist": "node -e \"var fs=require('fs');if(!fs.existsSync('./dist/index.js')){console.error('FATAL: dist/index.js missing after build');process.exit(1)}\"",
+    "test": "jest --ci --reporters=jest-junit --reporters=default --coverage --coverageReporters=cobertura --coverageReporters=html",
+    "version:bump": "node ./../../Scripts/bump-version.js ./package.json",
+    "postpublish": "npm run version:bump"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tenonhq/dovetail.git"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "devDependencies": {
+    "@tenonhq/dovetail-types": "^0.0.17",
+    "@types/dotenv": "^6.1.1",
+    "@types/inquirer": "^8.2.10",
+    "@types/jest": "^29.5.5",
+    "@types/lodash": "^4.14.199",
+    "@types/node": ">=20.8.4",
+    "@types/prettier": "^2.7.3",
+    "@types/progress": "^2.0.5",
+    "@types/tough-cookie": "^4.0.5",
+    "@types/yargs": "^17.0.28",
+    "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@tenonhq/dovetail-clickup": "^0.0.7",
+    "@tenonhq/dovetail-schema": "^0.0.5",
+    "axios": "^1.5.1",
+    "axios-cookiejar-support": "^4.0.7",
+    "axios-rate-limit": "^1.3.0",
+    "chalk": "^4.1.2",
+    "chokidar": "^3.5.3",
+    "dotenv": "^16.3.1",
+    "inquirer": "^8.2.6",
+    "lodash": "^4.17.21",
+    "prettier": "3.0.3",
+    "progress": "^2.0.3",
+    "tough-cookie": "^4.1.3",
+    "winston": "^3.11.0",
+    "yargs": "^17.7.2"
+  },
+  "bin": {
+    "dove": "./dist/index.js",
+    "sinc": "./dist/index.js"
+  },
+  "files": [
+    "dist/**/*",
+    "skills/**/*",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/skills/dove-configure-pipeline.md

@@ -0,0 +1,158 @@
+# Configure Dovetail Build Pipeline
+
+## Task
+$ARGUMENTS
+
+## Instructions for Claude
+
+### Directory Context
+
+Dovetail commands can be run from two locations:
+- **From `ServiceNow/` directory:** `npx sinc <command>`
+- **From Craftsman root:** `npm run sinc:<command>` (proxy scripts)
+
+Available root scripts: `sinc:init`, `sinc:start`, `sinc:dev`, `sinc:build`, `sinc:deploy`, `sinc:push`, `sinc:refresh`, `sinc:status`
+
+When running from Craftsman root, `dove.config.js` is at `ServiceNow/dove.config.js`. When running from `ServiceNow/`, it is at `./dove.config.js`. Use the path appropriate to the current working directory.
+
+---
+
+The user wants to configure or modify their `dove.config.js` plugin pipeline. Help them set up the `rules` array with the correct plugins, ordering, and options.
+
+### Key Principles
+
+1. **Rule matching is first-match-wins.** Place the most specific regex patterns first. If `.secret.ts` should have no plugins, that rule MUST come before the generic `.ts` rule.
+2. **Plugin chain is sequential.** The output of one plugin feeds into the next. Order matters.
+3. **Babel preset execution is REVERSED** (last preset runs first), but **Babel plugin execution is FORWARD** (first plugin runs first). This is standard Babel behavior but confusing in config.
+
+### Step 1: Identify the user's file types and needs
+
+Ask what file types they have if not specified:
+- `.ts` files (server-side TypeScript)
+- `.js` files (server-side JavaScript)
+- `.client.js` or `.wp.js` files (client-side, need Webpack bundling)
+- `.scss` files (SCSS stylesheets)
+- Any files that should be excluded from processing
+
+### Step 2: Build the rules array
+
+For each file type, construct a rule using these templates:
+
+**Server-side TypeScript (most common):**
+```javascript
+{
+  match: /\.ts$/,
+  plugins: [
+    {
+      name: "@tenonhq/dovetail-typescript-plugin",
+      options: { transpile: false }
+    },
+    {
+      name: "@tenonhq/dovetail-babel-plugin",
+      options: {
+        presets: [
+          "@tenonhq/dovetail-servicenow",
+          "@babel/env",
+          "@babel/typescript"
+        ],
+        plugins: [
+          "@tenonhq/dovetail-remove-modules",
+          "@babel/proposal-class-properties",
+          "@babel/proposal-object-rest-spread"
+        ]
+      }
+    }
+  ]
+}
+```
+
+**Server-side JavaScript:**
+```javascript
+{
+  match: /\.js$/,
+  plugins: [
+    {
+      name: "@tenonhq/dovetail-babel-plugin",
+      options: {
+        presets: [
+          "@tenonhq/dovetail-servicenow",
+          "@babel/env"
+        ],
+        plugins: [
+          "@tenonhq/dovetail-remove-modules"
+        ]
+      }
+    }
+  ]
+}
+```
+
+**Client-side Webpack bundle:**
+```javascript
+{
+  match: /\.wp\.js$/,
+  plugins: [
+    {
+      name: "@tenonhq/dovetail-webpack-plugin",
+      options: {
+        configGenerator: (context) => ({
+          mode: "production",
+          output: { library: context.name }
+        })
+      }
+    }
+  ]
+}
+```
+
+**SCSS:**
+```javascript
+{
+  match: /\.scss$/,
+  plugins: [
+    { name: "@tenonhq/dovetail-sass-plugin", options: {} }
+  ]
+}
+```
+
+**Skip processing:**
+```javascript
+{
+  match: /\.secret\.ts$/,
+  plugins: []
+}
+```
+
+### Step 3: Assemble the complete config
+
+Write the full `dove.config.js` with rules ordered most-specific to least-specific. Include other fields: `sourceDirectory`, `buildDirectory`, `excludes`, `includes`, `tableOptions`, `refreshInterval`, `scopes`.
+
+### Step 4: List npm install commands
+
+Provide a single `npm i -D` command with all required packages.
+
+### Available Plugins Reference
+
+| Plugin | Purpose | npm Package |
+|--------|---------|-------------|
+| TypeScript | Type-check and/or transpile `.ts` | `@tenonhq/dovetail-typescript-plugin` |
+| Babel | Run Babel transforms | `@tenonhq/dovetail-babel-plugin` |
+| ESLint | Lint before sync (blocks on errors) | `@tenonhq/dovetail-eslint-plugin` |
+| Prettier | Format output code | `@tenonhq/dovetail-prettier-plugin` |
+| SASS | Compile SCSS to CSS | `@tenonhq/dovetail-sass-plugin` |
+| Webpack | Bundle frontend JS | `@tenonhq/dovetail-webpack-plugin` |
+
+### Babel Sub-Packages (used inside babel-plugin options)
+
+| Package | Purpose | Config Key |
+|---------|---------|------------|
+| `@tenonhq/dovetail-babel-plugin-remove-modules` | Strip import/export for ServiceNow | `plugins: ["@tenonhq/dovetail-remove-modules"]` |
+| `@tenonhq/dovetail-babel-preset-servicenow` | Sanitize for Rhino engine | `presets: ["@tenonhq/dovetail-servicenow"]` |
+
+### Critical Warnings
+
+- **Never use `useBuiltIns`** with `@babel/env` -- ServiceNow's Rhino engine locks base class prototypes, so polyfills will fail.
+- **Always include `@tenonhq/dovetail-servicenow`** as the FIRST Babel preset listed (runs last) for server-side code -- it handles `__proto__` and reserved word issues.
+- **Always include `@tenonhq/dovetail-remove-modules`** as a Babel plugin for server-side code -- ServiceNow does not support ES modules.
+- If using TypeScript plugin for type-checking only (`transpile: false`), Babel must handle the actual transpilation.
+- Webpack rules MUST come before generic `.js` rules in the rules array.

package/skills/dove-create-plugin.md

@@ -0,0 +1,174 @@
+# Create a Custom Dovetail Plugin
+
+## Task
+$ARGUMENTS
+
+## Instructions for Claude
+
+### Directory Context
+
+Dovetail commands can be run from two locations:
+- **From `ServiceNow/` directory:** `npx sinc <command>`
+- **From Craftsman root:** `npm run sinc:<command>` (proxy scripts)
+
+Available root scripts: `sinc:init`, `sinc:start`, `sinc:dev`, `sinc:build`, `sinc:deploy`, `sinc:push`, `sinc:refresh`, `sinc:status`
+
+Plugin files and `dove.config.js` live in the `ServiceNow/` directory. When referencing paths from the Craftsman root, prefix with `ServiceNow/`.
+
+---
+
+Help the user create a custom Dovetail build plugin. A plugin is a Node.js module that transforms file content during the build pipeline.
+
+### Plugin Interface
+
+A Dovetail plugin must export an object with a `run` function:
+
+```typescript
+interface Plugin {
+  run: (
+    context: FileContext,
+    content: string,
+    options: any
+  ) => Promise<PluginResults>;
+}
+
+interface FileContext {
+  filePath: string;     // Absolute path to the source file
+  name: string;         // Record display name
+  tableName: string;    // ServiceNow table name
+  targetField: string;  // Field name in ServiceNow
+  ext: string;          // File extension
+  sys_id: string;       // ServiceNow record sys_id
+  scope: string;        // Application scope
+}
+
+interface PluginResults {
+  success: boolean;     // If false, build is halted
+  output: string;       // Transformed content (passed to next plugin)
+}
+```
+
+### Minimal Plugin Template
+
+```javascript
+// my-dovetail-plugin/index.js
+module.exports = {
+  run: async function(context, content, options) {
+    try {
+      let output = content;
+
+      // Example: Add a header comment
+      if (options.addHeader) {
+        output = "// Generated from " + context.name + "\n" + output;
+      }
+
+      return { success: true, output: output };
+    } catch (e) {
+      console.error("Plugin error: " + e.message);
+      return { success: false, output: "" };
+    }
+  }
+};
+```
+
+### Plugin Registration in dove.config.js
+
+```javascript
+rules: [
+  {
+    match: /\.ts$/,
+    plugins: [
+      {
+        name: "my-dovetail-plugin",
+        options: { addHeader: true }
+      }
+    ]
+  }
+]
+```
+
+**Important:** Dovetail resolves plugins from `node_modules/` using the plugin name as a path segment. For local plugins, you have three options:
+
+1. **Use npm link:**
+   ```bash
+   cd plugins/my-plugin && npm link
+   npm link my-dovetail-plugin
+   ```
+2. **Use npm workspaces** (recommended for monorepos)
+3. **Publish to npm** as a scoped package (recommended for shared plugins)
+
+### Using the FileContext
+
+```javascript
+run: async function(context, content, options) {
+  // Different behavior per table
+  if (context.tableName === "sys_script_include") {
+    // Server-side script include
+  } else if (context.tableName === "sp_widget") {
+    // Service Portal widget
+  }
+
+  // Different behavior per file extension
+  if (context.ext === ".ts") {
+    // TypeScript file
+  }
+
+  console.log("Processing: " + context.name + " (" + context.sys_id + ")");
+
+  return { success: true, output: content };
+}
+```
+
+### Plugin Chain Behavior
+
+Plugins run sequentially. Each plugin receives the OUTPUT of the previous plugin as its `content` parameter. If any plugin returns `{ success: false }`, the entire build for that file is halted.
+
+```
+Source File Content
+    |
+    v
+Plugin 1 (e.g., TypeScript type-check) --> output
+    |
+    v
+Plugin 2 (e.g., Babel transpile) --> output
+    |
+    v
+Plugin 3 (e.g., Prettier format) --> output
+    |
+    v
+Final content pushed to ServiceNow
+```
+
+### Example: Minification Plugin
+
+```javascript
+// my-minify-plugin/index.js
+var terser = require("terser");
+
+module.exports = {
+  run: async function(context, content, options) {
+    try {
+      if (context.ext === ".css" || context.ext === ".scss") {
+        return { success: true, output: content };
+      }
+
+      var result = await terser.minify(content, {
+        compress: options.compress !== false,
+        mangle: options.mangle !== false
+      });
+
+      return { success: true, output: result.code };
+    } catch (e) {
+      console.error("Minification failed for " + context.name + ": " + e.message);
+      return { success: false, output: "" };
+    }
+  }
+};
+```
+
+### Error Handling
+
+- Return `{ success: false, output: "" }` to stop the build for that file
+- Throw an exception for unexpected errors (caught by PluginManager)
+- Log useful error messages -- they appear in the Dovetail console output
+- Check `dovetail-debug-*.log` for detailed error traces

package/skills/dove-create-record.md

@@ -0,0 +1,135 @@
+# Create ServiceNow Records
+
+## Task
+$ARGUMENTS
+
+## Instructions for Claude
+
+### Directory Context
+
+Dovetail commands can be run from two locations:
+- **From `ServiceNow/` directory:** `npx sinc <command>`
+- **From Craftsman root:** `npm run sinc:<command>` (proxy scripts)
+
+The `create` command requires running from the `ServiceNow/` directory directly, as it accepts flags and arguments that npm run scripts don't forward.
+
+---
+
+Help the user create new records on a ServiceNow instance using Dovetail's `create` command. After creation, the record is automatically pulled back and scaffolded locally.
+
+### Command Syntax
+
+```bash
+npx dove create <table> [options]
+```
+
+### Options
+
+| Flag | Alias | Type | Description |
+|------|-------|------|-------------|
+| `--name` | `-n` | string | Record name |
+| `--scope` | `-s` | string | Target scope (e.g., x_cadso_core) |
+| `--from` | `-f` | string | Path to JSON file with field values |
+| `--field` | | array | Inline field values (key=value) |
+| `--ci` | | boolean | Skip interactive prompts |
+
+### Examples
+
+#### Create a Script Include (interactive)
+
+```bash
+npx dove create sys_script_include
+# Prompts for: name, scope
+```
+
+#### Create with flags
+
+```bash
+npx dove create sys_script_include --name "MyNewUtil" --scope x_cadso_core
+```
+
+#### Create with inline field values
+
+```bash
+npx dove create sys_script_include \
+  --name "MyNewUtil" \
+  --scope x_cadso_core \
+  --field active=true \
+  --field access=public
+```
+
+#### Create from JSON file
+
+```bash
+npx dove create sys_script_include --from new-script.json --scope x_cadso_core
+```
+
+**JSON file format (`new-script.json`):**
+```json
+{
+  "name": "MyNewUtil",
+  "active": "true",
+  "access": "public",
+  "script": "var MyNewUtil = Class.create();\nMyNewUtil.prototype = {\n  initialize: function() {},\n  type: 'MyNewUtil'\n};"
+}
+```
+
+#### Create a Business Rule
+
+```bash
+npx dove create sys_script --name "Validate Record" --scope x_cadso_automate
+```
+
+#### CI/Automation mode
+
+```bash
+npx dove create sys_script_include \
+  --name "AutoCreated" \
+  --scope x_cadso_core \
+  --from record.json \
+  --ci
+```
+
+### What Happens After Create
+
+1. **Record is created** on the ServiceNow instance via the `api/cadso/dovetail/createRecord` endpoint
+2. **GlideRecord** uses `initialize()` and `newRecord()` to ensure all default values are set
+3. **Manifest is refreshed** for the target scope
+4. **Local files are scaffolded** — directory, field files (script.js, etc.), and metaData.json
+5. **You can immediately begin editing** the local files and push changes
+
+### Update Set Integration
+
+If the target scope has an active update set configured (via `.dove-update-sets.json` or the dashboard), the new record is created within that update set.
+
+```bash
+# Set up update set first
+npx dove createUpdateSet --name "FEAT-123" --scope x_cadso_core
+
+# Create record — automatically goes into FEAT-123 update set
+npx dove create sys_script_include --name "NewFeature" --scope x_cadso_core
+```
+
+### Common Table Names
+
+| Table | Creates |
+|-------|---------|
+| `sys_script_include` | Script Include (server-side utility class) |
+| `sys_script` | Business Rule |
+| `sys_ui_script` | UI Script (client-side) |
+| `sys_ui_page` | UI Page |
+| `sys_ux_client_script` | UX Client Script |
+| `sys_processor` | Processor |
+| `sys_ws_operation` | REST API Operation |
+| `sys_rest_message_fn` | REST Message Function |
+| `sys_ui_action` | UI Action |
+| `sysevent_script_action` | Event Script Action |
+
+### Troubleshooting
+
+- **"Table name is required"** — Provide the table as the first argument: `npx dove create sys_script_include`
+- **"Record name is required"** — Use `--name` flag or include `name` in the JSON file
+- **"Scope is required in CI mode"** — Add `--scope x_cadso_core` when using `--ci`
+- **"Failed to create record"** — Check that the `api/cadso/dovetail/createRecord` endpoint exists on the target instance
+- **"Local sync failed"** — Record was created on instance. Run `npx dove refresh` to pull it manually
+- **Record not in expected update set** — Verify `.dove-update-sets.json` has the correct scope mapping. Use `npx dove currentUpdateSet` to check

package/skills/dove-debug-build.md

@@ -0,0 +1,117 @@
+# Debug Dovetail Build Transformations
+
+## Task
+$ARGUMENTS
+
+## Instructions for Claude
+
+### Directory Context
+
+Dovetail commands can be run from two locations:
+- **From `ServiceNow/` directory:** `npx sinc <command>`
+- **From Craftsman root:** `npm run sinc:<command>` (proxy scripts)
+
+Available root scripts: `sinc:init`, `sinc:start`, `sinc:dev`, `sinc:build`, `sinc:deploy`, `sinc:push`, `sinc:refresh`, `sinc:status`
+
+When this skill references `npx sinc <command>`, use `npm run sinc:<command>` if working from the Craftsman root. The `build/` and `src/` directories referenced below are at `ServiceNow/build/` and `ServiceNow/src/` relative to the Craftsman root.
+
+---
+
+Help the user understand, inspect, or debug the Dovetail build transformation pipeline -- what happens between source code and what reaches ServiceNow.
+
+### Step 1: Run a Local Build
+
+To see build output without pushing to ServiceNow:
+
+```bash
+npx dove build
+```
+
+Output files appear in the `build/` directory (configured via `buildDirectory` in `dove.config.js`), mirroring the source directory structure.
+
+To build only changed files (compared to a git branch):
+
+```bash
+npx dove build --diff main
+```
+
+### Step 2: Compare Source vs Output
+
+```
+src/sys_script_include/MyScript/script.ts       <-- Source (TypeScript)
+build/sys_script_include/MyScript/script.ts      <-- Output (transpiled JS)
+```
+
+### Step 3: Understand Transformation Stages
+
+For a typical TypeScript server-side pipeline (`typescript-plugin` + `babel-plugin`):
+
+**Stage 1: TypeScript Plugin** (`transpile: false`)
+- Runs the TypeScript compiler for type checking only
+- Does NOT modify the code
+- Errors here = TypeScript type errors
+
+**Stage 2: Babel Plugin** (with presets and plugins)
+
+Babel plugins run first (in order):
+1. `@tenonhq/dovetail-remove-modules` -- Strips `import`/`export` statements
+2. `@babel/proposal-class-properties` -- Transforms class property syntax
+3. `@babel/proposal-object-rest-spread` -- Transforms `...spread` syntax
+
+Babel presets run in reverse order:
+1. `@babel/typescript` (listed last, runs first) -- Strips type annotations
+2. `@babel/env` -- Transpiles ES6+ to ES5
+3. `@tenonhq/dovetail-servicenow` (listed first, runs last) -- Sanitizes for Rhino: replaces `__proto__` with `__proto_sn__`, converts `obj.default` to `obj["default"]`
+
+### Step 4: Diagnose Common Issues
+
+**"Cannot read property 'X' of undefined" in ServiceNow**
+- Likely: `import` statements were not removed. Check that `@tenonhq/dovetail-remove-modules` is in Babel plugins.
+- The import variable becomes `undefined` because ServiceNow has no module system.
+
+**"Illegal access to reserved word" in ServiceNow**
+- Likely: Missing `@tenonhq/dovetail-servicenow` preset. Code like `obj.default` or `obj.class` crashes Rhino.
+- Fix: Ensure `@tenonhq/dovetail-servicenow` is the FIRST preset listed (= runs LAST).
+
+**"__proto__" security error in ServiceNow**
+- Likely: Missing `@tenonhq/dovetail-servicenow` preset. Babel's class transpilation generates `__proto__` references.
+
+**"TypeError: Cannot extend a non-class" or prototype errors**
+- Likely: Using `useBuiltIns` with `@babel/env`. Rhino locks base class prototypes.
+- Fix: Remove `useBuiltIns` from `@babel/env` config.
+
+**Build succeeds but code does nothing in ServiceNow**
+- Check if `export default` was on the main class/function. The `remove-modules` plugin strips exports. In ServiceNow script includes, the class/function name must match the script include name.
+
+### Special Comment Tags
+
+The `@tenonhq/dovetail-remove-modules` Babel plugin supports these comment tags:
+
+**`@keepModule`** -- Preserve an import (for actual ServiceNow modules):
+```javascript
+//@keepModule
+import moduleDos from "myModuleDos";
+```
+
+**`@expandModule`** -- Expand imports to dot notation:
+```javascript
+//@expandModule
+import { helper } from "x_cadso_core";
+// becomes: x_cadso_core.helper
+```
+
+**`@moduleAlias=newName`** -- Rename the module reference with `@expandModule`:
+```javascript
+//@expandModule
+//@moduleAlias=MyApp
+import { helper } from "x_cadso_core";
+// becomes: MyApp.helper
+```
+
+### Step 5: Test Incrementally
+
+If you cannot determine which stage causes an issue:
+
+1. **Remove all plugins** from the rule and push raw source -- does it work?
+2. **Add plugins back one at a time** and rebuild after each addition.
+3. **Check the `build/` directory** after each rebuild to see intermediate output.