@tailor-platform/sdk 1.68.0 → 1.70.0

package/docs/cli/tailordb.md

@@ -2,29 +2,17 @@
 
 Commands for managing TailorDB tables, data, and schema migrations.
 
-<!-- politty:command:tailordb:heading:start -->
-
 ## tailordb
 
-<!-- politty:command:tailordb:heading:end -->
-
-<!-- politty:command:tailordb:description:start -->
-
 Manage TailorDB tables and data.
 
-<!-- politty:command:tailordb:description:end -->
-
-<!-- politty:command:tailordb:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk tailordb [command]
+tailor-sdk tailordb <command>
 ```
 
-<!-- politty:command:tailordb:usage:end -->
-
-<!-- politty:command:tailordb:subcommands:start -->
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
 **Commands**
 
@@ -34,48 +22,22 @@ tailor-sdk tailordb [command]
 | [`tailordb migration`](#tailordb-migration) | Manage TailorDB schema migrations.                                        |
 | [`tailordb erd`](#tailordb-erd)             | Generate TailorDB ERD viewer artifacts from local TailorDB schema. (beta) |
 
-<!-- politty:command:tailordb:subcommands:end -->
-
-<!-- politty:command:tailordb:global-options-link:start -->
-
-See [Global Options](../cli-reference.md#global-options) for options available to all commands.
-
-<!-- politty:command:tailordb:global-options-link:end -->
-
-<!-- politty:command:tailordb truncate:heading:start -->
-
 ### tailordb truncate
 
-<!-- politty:command:tailordb truncate:heading:end -->
-
-<!-- politty:command:tailordb truncate:description:start -->
-
 Truncate (delete all records from) TailorDB tables.
 
-<!-- politty:command:tailordb truncate:description:end -->
-
-<!-- politty:command:tailordb truncate:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk tailordb truncate [options] [types]
 ```
 
-<!-- politty:command:tailordb truncate:usage:end -->
-
-<!-- politty:command:tailordb truncate:arguments:start -->
-
 **Arguments**
 
 | Argument | Description            | Required |
 | -------- | ---------------------- | -------- |
 | `types`  | Type names to truncate | No       |
 
-<!-- politty:command:tailordb truncate:arguments:end -->
-
-<!-- politty:command:tailordb truncate:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                                                | Required | Default              | Env                               |
@@ -87,14 +49,8 @@ tailor-sdk tailordb truncate [options] [types]
 | `--all`                         | `-a`  | Truncate all tables in all owned namespaces (excludes external namespaces) | No       | `false`              | -                                 |
 | `--namespace <NAMESPACE>`       | `-n`  | Truncate all tables in specified namespace                                 | No       | -                    | -                                 |
 
-<!-- politty:command:tailordb truncate:options:end -->
-
-<!-- politty:command:tailordb truncate:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb truncate:global-options-link:end -->
-
 **Usage Examples:**
 
 ```bash
@@ -125,32 +81,18 @@ tailor-sdk tailordb truncate User Post --yes
 - Use `--yes` flag to skip confirmation prompts (useful for scripts and CI/CD)
 - Namespaces declared with `{ external: true }` are skipped by `--all` and rejected with a dedicated error when targeted by `--namespace`. Run truncate from the app that owns the namespace.
 
-<!-- politty:command:tailordb migration:heading:start -->
-
 ### tailordb migration
 
-<!-- politty:command:tailordb migration:heading:end -->
-
-<!-- politty:command:tailordb migration:description:start -->
-
 Manage TailorDB schema migrations.
 
-<!-- politty:command:tailordb migration:description:end -->
-
 Note: Migration scripts are automatically executed during `tailor-sdk deploy`. See [Automatic Migration Execution](../services/tailordb-migration.md#automatic-migration-execution) for details.
 
-<!-- politty:command:tailordb migration:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk tailordb migration [command]
+tailor-sdk tailordb migration <command>
 ```
 
-<!-- politty:command:tailordb migration:usage:end -->
-
-<!-- politty:command:tailordb migration:subcommands:start -->
-
 **Commands**
 
 | Command                                                       | Description                                                                                                               |
@@ -161,37 +103,18 @@ tailor-sdk tailordb migration [command]
 | [`tailordb migration status`](#tailordb-migration-status)     | Show the current migration status for TailorDB namespaces, including applied and pending migrations.                      |
 | [`tailordb migration sync`](#tailordb-migration-sync)         | Sync remote TailorDB schema to a specific migration snapshot (recovery from --no-schema-check drift).                     |
 
-<!-- politty:command:tailordb migration:subcommands:end -->
-
-<!-- politty:command:tailordb migration:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb migration:global-options-link:end -->
-<!-- politty:command:tailordb migration generate:heading:start -->
-
 #### tailordb migration generate
 
-<!-- politty:command:tailordb migration generate:heading:end -->
-
-<!-- politty:command:tailordb migration generate:description:start -->
-
 Generate migration files by detecting schema differences between current local types and the previous migration snapshot.
 
-<!-- politty:command:tailordb migration generate:description:end -->
-
-<!-- politty:command:tailordb migration generate:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk tailordb migration generate [options]
 ```
 
-<!-- politty:command:tailordb migration generate:usage:end -->
-
-<!-- politty:command:tailordb migration generate:options:start -->
-
 **Options**
 
 | Option              | Alias | Description                                | Required | Default              | Env                               |
@@ -201,47 +124,24 @@ tailor-sdk tailordb migration generate [options]
 | `--name <NAME>`     | `-n`  | Optional description for the migration     | No       | -                    | -                                 |
 | `--init`            | -     | Delete existing migrations and start fresh | No       | `false`              | -                                 |
 
-<!-- politty:command:tailordb migration generate:options:end -->
-
-<!-- politty:command:tailordb migration generate:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb migration generate:global-options-link:end -->
-<!-- politty:command:tailordb migration script:heading:start -->
-
 #### tailordb migration script
 
-<!-- politty:command:tailordb migration script:heading:end -->
-
-<!-- politty:command:tailordb migration script:description:start -->
-
 Add a migration script (migrate.ts) template to an existing migration directory.
 
-<!-- politty:command:tailordb migration script:description:end -->
-
-<!-- politty:command:tailordb migration script:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk tailordb migration script [options] <number>
 ```
 
-<!-- politty:command:tailordb migration script:usage:end -->
-
-<!-- politty:command:tailordb migration script:arguments:start -->
-
 **Arguments**
 
 | Argument | Description                                           | Required |
 | -------- | ----------------------------------------------------- | -------- |
 | `number` | Migration number to add a script to (e.g., 0001 or 1) | Yes      |
 
-<!-- politty:command:tailordb migration script:arguments:end -->
-
-<!-- politty:command:tailordb migration script:options:start -->
-
 **Options**
 
 | Option                    | Alias | Description                                                       | Required | Default              | Env                               |
@@ -249,48 +149,24 @@ tailor-sdk tailordb migration script [options] <number>
 | `--config <CONFIG>`       | `-c`  | Path to SDK config file                                           | No       | `"tailor.config.ts"` | `TAILOR_PLATFORM_SDK_CONFIG_PATH` |
 | `--namespace <NAMESPACE>` | `-n`  | Target TailorDB namespace (required if multiple namespaces exist) | No       | -                    | -                                 |
 
-<!-- politty:command:tailordb migration script:options:end -->
-
-<!-- politty:command:tailordb migration script:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb migration script:global-options-link:end -->
-
-<!-- politty:command:tailordb migration set:heading:start -->
-
 #### tailordb migration set
 
-<!-- politty:command:tailordb migration set:heading:end -->
-
-<!-- politty:command:tailordb migration set:description:start -->
-
 Set migration checkpoint to a specific number.
 
-<!-- politty:command:tailordb migration set:description:end -->
-
-<!-- politty:command:tailordb migration set:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk tailordb migration set [options] <number>
 ```
 
-<!-- politty:command:tailordb migration set:usage:end -->
-
-<!-- politty:command:tailordb migration set:arguments:start -->
-
 **Arguments**
 
 | Argument | Description                               | Required |
 | -------- | ----------------------------------------- | -------- |
 | `number` | Migration number to set (e.g., 0001 or 1) | Yes      |
 
-<!-- politty:command:tailordb migration set:arguments:end -->
-
-<!-- politty:command:tailordb migration set:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                                       | Required | Default              | Env                               |
@@ -301,37 +177,18 @@ tailor-sdk tailordb migration set [options] <number>
 | `--yes`                         | `-y`  | Skip confirmation prompts                                         | No       | `false`              | -                                 |
 | `--namespace <NAMESPACE>`       | `-n`  | Target TailorDB namespace (required if multiple namespaces exist) | No       | -                    | -                                 |
 
-<!-- politty:command:tailordb migration set:options:end -->
-
-<!-- politty:command:tailordb migration set:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb migration set:global-options-link:end -->
-<!-- politty:command:tailordb migration status:heading:start -->
-
 #### tailordb migration status
 
-<!-- politty:command:tailordb migration status:heading:end -->
-
-<!-- politty:command:tailordb migration status:description:start -->
-
 Show the current migration status for TailorDB namespaces, including applied and pending migrations.
 
-<!-- politty:command:tailordb migration status:description:end -->
-
-<!-- politty:command:tailordb migration status:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk tailordb migration status [options]
 ```
 
-<!-- politty:command:tailordb migration status:usage:end -->
-
-<!-- politty:command:tailordb migration status:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                                       | Required | Default              | Env                               |
@@ -341,48 +198,24 @@ tailor-sdk tailordb migration status [options]
 | `--config <CONFIG>`             | `-c`  | Path to SDK config file                                           | No       | `"tailor.config.ts"` | `TAILOR_PLATFORM_SDK_CONFIG_PATH` |
 | `--namespace <NAMESPACE>`       | `-n`  | Target TailorDB namespace (shows all namespaces if not specified) | No       | -                    | -                                 |
 
-<!-- politty:command:tailordb migration status:options:end -->
-
-<!-- politty:command:tailordb migration status:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb migration status:global-options-link:end -->
-
-<!-- politty:command:tailordb migration sync:heading:start -->
-
 #### tailordb migration sync
 
-<!-- politty:command:tailordb migration sync:heading:end -->
-
-<!-- politty:command:tailordb migration sync:description:start -->
-
 Sync remote TailorDB schema to a specific migration snapshot (recovery from --no-schema-check drift).
 
-<!-- politty:command:tailordb migration sync:description:end -->
-
-<!-- politty:command:tailordb migration sync:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk tailordb migration sync [options] <number>
 ```
 
-<!-- politty:command:tailordb migration sync:usage:end -->
-
-<!-- politty:command:tailordb migration sync:arguments:start -->
-
 **Arguments**
 
 | Argument | Description                                                                    | Required |
 | -------- | ------------------------------------------------------------------------------ | -------- |
 | `number` | Migration number to sync to (e.g., 0001 or 1; 0 targets the baseline snapshot) | Yes      |
 
-<!-- politty:command:tailordb migration sync:arguments:end -->
-
-<!-- politty:command:tailordb migration sync:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                                       | Required | Default              | Env                               |
@@ -393,79 +226,41 @@ tailor-sdk tailordb migration sync [options] <number>
 | `--yes`                         | `-y`  | Skip confirmation prompts                                         | No       | `false`              | -                                 |
 | `--namespace <NAMESPACE>`       | `-n`  | Target TailorDB namespace (required if multiple namespaces exist) | No       | -                    | -                                 |
 
-<!-- politty:command:tailordb migration sync:options:end -->
-
-<!-- politty:command:tailordb migration sync:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb migration sync:global-options-link:end -->
-
 **See also:** For migration concepts, configuration, workflow, and troubleshooting, see the [TailorDB Migrations guide](../services/tailordb-migration.md).
 
-<!-- politty:command:tailordb erd:heading:start -->
-
 ### tailordb erd
 
-<!-- politty:command:tailordb erd:heading:end -->
-
-<!-- politty:command:tailordb erd:description:start -->
-
 Generate TailorDB ERD viewer artifacts from local TailorDB schema. (beta)
 
-<!-- politty:command:tailordb erd:description:end -->
-
-<!-- politty:command:tailordb erd:usage:start -->
-
 **Usage**
 
 ```
-tailor-sdk tailordb erd [command]
+tailor-sdk tailordb erd <command>
 ```
 
-<!-- politty:command:tailordb erd:usage:end -->
-
-<!-- politty:command:tailordb erd:subcommands:start -->
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
 **Commands**
 
 | Command                                       | Description                                                       |
 | --------------------------------------------- | ----------------------------------------------------------------- |
 | [`tailordb erd export`](#tailordb-erd-export) | Export TailorDB ERD static viewer from local TailorDB schema.     |
+| [`tailordb erd diff`](#tailordb-erd-diff)     | Render TailorDB ERD schema diff HTML from exported ERD viewers.   |
 | [`tailordb erd serve`](#tailordb-erd-serve)   | Generate and serve TailorDB ERD locally with watch reload. (beta) |
 | [`tailordb erd deploy`](#tailordb-erd-deploy) | Deploy ERD static website for TailorDB namespace(s).              |
 
-<!-- politty:command:tailordb erd:subcommands:end -->
-
-<!-- politty:command:tailordb erd:global-options-link:start -->
-
-See [Global Options](../cli-reference.md#global-options) for options available to all commands.
-
-<!-- politty:command:tailordb erd:global-options-link:end -->
-<!-- politty:command:tailordb erd export:heading:start -->
-
 #### tailordb erd export
 
-<!-- politty:command:tailordb erd export:heading:end -->
-
-<!-- politty:command:tailordb erd export:description:start -->
-
 Export TailorDB ERD static viewer from local TailorDB schema.
 
-<!-- politty:command:tailordb erd export:description:end -->
-
-<!-- politty:command:tailordb erd export:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk tailordb erd export [options]
 ```
 
-<!-- politty:command:tailordb erd export:usage:end -->
-
-<!-- politty:command:tailordb erd export:options:start -->
-
 **Options**
 
 | Option                    | Alias | Description                                                                                    | Required | Default              | Env                               |
@@ -474,26 +269,33 @@ tailor-sdk tailordb erd export [options]
 | `--namespace <NAMESPACE>` | `-n`  | TailorDB namespace name (optional if only one namespace is defined in config)                  | No       | -                    | -                                 |
 | `--output <OUTPUT>`       | `-o`  | Output directory path for TailorDB ERD viewer files (writes to `<outputDir>/<namespace>/dist`) | No       | `".tailor-sdk/erd"`  | -                                 |
 
-<!-- politty:command:tailordb erd export:options:end -->
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb erd export:global-options-link:start -->
+#### tailordb erd diff
 
-See [Global Options](../cli-reference.md#global-options) for options available to all commands.
+Render TailorDB ERD schema diff HTML from exported ERD viewers.
 
-<!-- politty:command:tailordb erd export:global-options-link:end -->
-<!-- politty:command:tailordb erd serve:heading:start -->
+**Usage**
 
-#### tailordb erd serve
+```
+tailor-sdk tailordb erd diff [options]
+```
 
-<!-- politty:command:tailordb erd serve:heading:end -->
+**Options**
 
-<!-- politty:command:tailordb erd serve:description:start -->
+| Option                        | Alias | Description                                                             | Required | Default |
+| ----------------------------- | ----- | ----------------------------------------------------------------------- | -------- | ------- |
+| `--base-html <BASE_HTML>`     | -     | Base ERD viewer HTML file                                               | No       | -       |
+| `--head-html <HEAD_HTML>`     | -     | Head ERD viewer HTML file                                               | No       | -       |
+| `--namespace <NAMESPACE>`     | `-n`  | TailorDB namespace name (defaults to the provided ERD schema namespace) | No       | -       |
+| `--output <OUTPUT>`           | `-o`  | Output ERD diff HTML file                                               | Yes      | -       |
+| `--output-json <OUTPUT_JSON>` | -     | Optional output JSON file for the computed diff                         | No       | -       |
 
-Generate and serve TailorDB ERD locally with watch reload. (beta)
+See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb erd serve:description:end -->
+#### tailordb erd serve
 
-<!-- politty:command:tailordb erd serve:usage:start -->
+Generate and serve TailorDB ERD locally with watch reload. (beta)
 
 **Usage**
 
@@ -501,10 +303,6 @@ Generate and serve TailorDB ERD locally with watch reload. (beta)
 tailor-sdk tailordb erd serve [options]
 ```
 
-<!-- politty:command:tailordb erd serve:usage:end -->
-
-<!-- politty:command:tailordb erd serve:options:start -->
-
 **Options**
 
 | Option                    | Alias | Description                                                               | Required | Default              | Env                               |
@@ -514,37 +312,18 @@ tailor-sdk tailordb erd serve [options]
 | `--port <PORT>`           | -     | Local server port (0 selects a free port)                                 | No       | `0`                  | -                                 |
 | `--open`                  | -     | Open the ERD viewer in the default browser                                | No       | `false`              | -                                 |
 
-<!-- politty:command:tailordb erd serve:options:end -->
-
-<!-- politty:command:tailordb erd serve:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb erd serve:global-options-link:end -->
-<!-- politty:command:tailordb erd deploy:heading:start -->
-
 #### tailordb erd deploy
 
-<!-- politty:command:tailordb erd deploy:heading:end -->
-
-<!-- politty:command:tailordb erd deploy:description:start -->
-
 Deploy ERD static website for TailorDB namespace(s).
 
-<!-- politty:command:tailordb erd deploy:description:end -->
-
-<!-- politty:command:tailordb erd deploy:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk tailordb erd deploy [options]
 ```
 
-<!-- politty:command:tailordb erd deploy:usage:end -->
-
-<!-- politty:command:tailordb erd deploy:options:start -->
-
 **Options**
 
 | Option                          | Alias | Description                                                                         | Required | Default              | Env                               |
@@ -554,18 +333,13 @@ tailor-sdk tailordb erd deploy [options]
 | `--config <CONFIG>`             | `-c`  | Path to SDK config file                                                             | No       | `"tailor.config.ts"` | `TAILOR_PLATFORM_SDK_CONFIG_PATH` |
 | `--namespace <NAMESPACE>`       | `-n`  | TailorDB namespace name (optional - deploys all namespaces with erdSite if omitted) | No       | -                    | -                                 |
 
-<!-- politty:command:tailordb erd deploy:options:end -->
-
-<!-- politty:command:tailordb erd deploy:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:tailordb erd deploy:global-options-link:end -->
-
 **Notes:**
 
 - ERD commands build from the local TailorDB schema, including plugin-generated TailorDB types.
 - `tailordb erd export` writes a self-contained `index.html` viewer to `<output>/<namespace>/dist`.
+- `tailordb erd diff` compares exported self-contained viewer HTML files and writes a visual ERD viewer that can switch between the current schema and the highlighted diff.
 - `tailordb erd serve` watches the config file and TailorDB type files, then reloads the browser viewer when the rebuilt `index.html` reports a new embedded schema revision.
 - `tailordb erd deploy` still requires `erdSite` in `tailor.config.ts` because it uploads the generated viewer to a configured Static Website.
 

package/docs/cli/upgrade.md

@@ -1,27 +1,13 @@
-<!-- politty:command:upgrade:heading:start -->
-
 ## upgrade
 
-<!-- politty:command:upgrade:heading:end -->
-
-<!-- politty:command:upgrade:description:start -->
-
 Run codemods to upgrade your project to a newer SDK version.
 
-<!-- politty:command:upgrade:description:end -->
-
-<!-- politty:command:upgrade:usage:start -->
-
 **Usage**
 
 ```
 tailor-sdk upgrade [options]
 ```
 
-<!-- politty:command:upgrade:usage:end -->
-
-<!-- politty:command:upgrade:options:start -->
-
 **Options**
 
 | Option          | Alias | Description                                   | Required | Default |
@@ -30,14 +16,8 @@ tailor-sdk upgrade [options]
 | `--dry-run`     | `-d`  | Preview changes without modifying files       | No       | `false` |
 | `--path <PATH>` | -     | Project directory to upgrade                  | No       | `"."`   |
 
-<!-- politty:command:upgrade:options:end -->
-
-<!-- politty:command:upgrade:global-options-link:start -->
-
 See [Global Options](../cli-reference.md#global-options) for options available to all commands.
 
-<!-- politty:command:upgrade:global-options-link:end -->
-
 ### How It Works
 
 The `upgrade` command runs codemods that automatically transform your project code for breaking changes between SDK versions. The target version (`--to`) is auto-detected from the installed `@tailor-platform/sdk` in `node_modules`.