@docusign/cli 1.1.0-rc → 1.3.0-rc

package/dist/templates/ai-skills/aiSkills.spec.ts

@@ -0,0 +1,57 @@
+import * as fs from 'fs';
+import * as path from 'path';
+
+const SKILLS_DIR = path.join(__dirname, '.claude', 'skills');
+const read = (...parts: string[]): string => fs.readFileSync(path.join(__dirname, ...parts), 'utf8');
+
+const frontmatter = (text: string): Record<string, string> => {
+  const match = /^---\n([\s\S]*?)\n---/.exec(text);
+  if (!match) return {};
+  return Object.fromEntries(
+    match[1]
+      .split('\n')
+      .map(line => /^([a-z-]+):\s*(.*)$/.exec(line))
+      .filter((m): m is RegExpExecArray => m !== null)
+      .map(m => [m[1], m[2]]),
+  );
+};
+
+describe('AI skill templates', () => {
+  const skillDirs = fs.readdirSync(SKILLS_DIR, { withFileTypes: true }).filter(entry => entry.isDirectory());
+
+  it.each(skillDirs.map(dir => [dir.name]))('%s should name itself after its folder and describe when to use it', name => {
+    const meta = frontmatter(read('.claude', 'skills', name, 'SKILL.md'));
+
+    expect(meta.name).toBe(name);
+    expect(meta.description?.length).toBeGreaterThan(40);
+  });
+
+  describe('ds-package-autopilot', () => {
+    const skill = read('.claude', 'skills', 'ds-package-autopilot', 'SKILL.md');
+
+    it('should be listed for every assistant that lists skills', () => {
+      expect(read('.cursor', 'rules', 'docusign.mdc')).toContain('.claude/skills/ds-package-autopilot/SKILL.md');
+      expect(read('.gemini', 'instructions.md')).toContain('.claude/skills/ds-package-autopilot/SKILL.md');
+      expect(read('.github', 'instructions', 'docusign.instructions.md')).toContain('ds-package-autopilot');
+    });
+
+    it('should cover the whole lifecycle a user can ask for', () => {
+      ['ds pkg create', 'ds pkg add', 'ds pkg export', 'ds pkg install --file', 'ds pkg install --resume', 'ds pkg view-details'].forEach(command =>
+        expect(skill).toContain(command),
+      );
+      ['REQUIREMENT_MAPPING', 'BULK_PUBLISH_CONSENT', '--draft-workflows', '--prefix', 'requirements.json'].forEach(term =>
+        expect(skill).toContain(term),
+      );
+    });
+
+    it('should name the four restricted scopes an app needs', () => {
+      ['act_read', 'act_write', 'transaction_management_api', 'proof_create_transaction'].forEach(scope => expect(skill).toContain(scope));
+    });
+
+    it('should carry no secret: no token, no link code, no real account or package id', () => {
+      expect(skill).not.toMatch(/eyJ[A-Za-z0-9_-]{20,}/);
+      expect(skill).not.toMatch(/[?&](code|state|hash|mtsec|sig)=[A-Za-z0-9+/=_-]{12,}/);
+      expect(skill).not.toMatch(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/);
+    });
+  });
+});

package/dist/templates/integration/README.md

@@ -0,0 +1,40 @@
+# Integration
+
+Tools for your integration keys (IKs).
+
+## Directory structure
+
+- **logs/**: CSV files written by `ds integration logs`
+
+## Download the API logs of an integration key
+
+```bash
+ds integration logs --ik <integration-key>             # last hour
+ds integration logs --ik <integration-key> --limit 7d  # last 7 days
+ds ik logs --ik <integration-key> --limit 30d          # 'ik' is short for 'integration'
+```
+
+| Option       | Default   | What it does                                                                                                                                          |
+| ------------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--ik`       | required  | The integration key (client ID). A GUID, or a GUID with up to six letters and a `-` or `_` in front. Case does not matter.                            |
+| `--limit`    | `1h`      | How far back to read, from now: `10m`, `1h`, `6h`, `12h`, `1d`, `7d`, `15d` or `30d`. The longest window is 30 days.                                  |
+| `--max-rows` | `1000000` | Stop before the download if the window holds more rows than this. Each row is roughly 0.6 to 0.9 KB, so the default is a file of about 0.6 to 0.9 GB. |
+
+The file is `logs/<integration-key>_<limit>_<time>.csv`, with one header row and one row per request.
+
+- Logs come from the environment you are logged in to, for the account you are logged in to. An integration key that
+  does not belong to this account returns no rows.
+- While it downloads, the command prints a progress line after every 25,000 rows, for example
+  `Fetched 25,000 of 1,000,000 rows (2.5%) in 11s, 2,273 rows/s, about 7m 9s left`. The estimate is the average speed so far,
+  so treat it as a rough guide. The same lines go to the debug log in `~/.docusign/logs`.
+- The command counts the rows first. If there are more than `--max-rows` (1,000,000 by default), it stops before it
+  downloads anything. Use a shorter `--limit`, or raise `--max-rows`.
+- A file that ends in `.csv.partial` is an export that stopped early. The rows it holds are real, but the pull is not
+  complete. Run the command again.
+
+## Columns
+
+The columns are the fields the log dataset returns, in the order it returns them, with one row per request, oldest
+first. A field added to the dataset shows up as a new column without a CLI update.
+
+A text cell that starts with `=`, `+`, `-` or `@` begins with an extra `'`, so a spreadsheet does not run it as a formula.

package/dist/templates/package/README.md

@@ -0,0 +1,107 @@
+# Package Feature
+
+This directory contains files for managing DocuSign packages in this project.
+
+## Directory Structure
+
+- **files/**: Package content files to include in your packages
+
+## Getting Started
+
+### Create a package
+
+```bash
+ds package create --name=my-package
+```
+
+### Add components to a package
+
+Each component is given as `<id>:<name>`. Quote names that contain spaces.
+
+```bash
+ds package add --name=my-package --esign-templates "555:NDA" "775:MSA"
+ds package add --name=my-package --workflow "111:Invoice approval" --webform "9f2:Intake form"
+```
+
+| Flag                | Component type      |
+| ------------------- | ------------------- |
+| `--esign-templates` | eSignature template |
+| `--templates`       | Document template   |
+| `--workflow`        | Maestro workflow    |
+| `--webform`         | Web form            |
+
+List several components after one flag or repeat the flag; different types can be combined in one call. Use `--id=<packageId>` instead of `--name` to pick one package when names are shared.
+
+### Remove components
+
+```bash
+ds package remove --name=my-package --esign-templates "775:MSA"
+```
+
+To change a component, remove it and add it again.
+
+### See what a package contains and where it stands
+
+```bash
+ds package view-details --name=my-package
+ds package status --name=my-package
+```
+
+`status` reports Processing while an import, export or publish is running, Installed once the package has been installed, otherwise the package's own status (Draft, Published, Archived or Review).
+
+### Export a package
+
+```bash
+ds package export --name=my-package
+ds package export --name=my-package --output=./backups/my-package.zip
+```
+
+The zip is saved in this project's `package/files` folder as `<package name>-<first 8 characters of the id>.zip`, unless you pass `--output`. Exporting publishes the package first, and a Published package cannot take new components. The CLI refuses to export a package with no components, since the zip would be empty.
+
+### Install a package in another account
+
+A private package cannot be installed by id from another account. Export it, log in to the target account, and install the zip.
+
+```bash
+ds package export --name=my-package                      # in the source account
+ds auth login                                            # choose the target account
+ds package install --file my-package-1a2b3c4d.zip --prefix "copy-"
+```
+
+A bare file name is also looked up in this project's `package/files` folder. `--prefix` puts text in front of the name of every component the install creates; use it for test installs, because the CLI cannot remove installed components.
+
+You can also install a package that is already on the server, from your account or a public one:
+
+```bash
+ds package install --name=my-package
+ds package install --id=<packageId> --source public
+```
+
+The install runs on the server and the CLI follows it. It can stop twice to ask for something:
+
+- **Connections.** An app in the package needs a connection in this account. Pick one you already have, or connect a new one: the CLI opens the app's sign-in page and waits until the connection is active.
+- **Consent.** Workflows must be consented to before they are published. The CLI opens the consent page. Use `--draft-workflows` to create the workflows as drafts and skip this step.
+
+| Flag                 | What it does                                                              |
+| -------------------- | ------------------------------------------------------------------------- |
+| `--file <zip>`       | Install from a zip file                                                   |
+| `--prefix <text>`    | Put `<text>` in front of the name of every component the install creates  |
+| `--update`           | Overwrite components that already exist in this account                   |
+| `--draft-workflows`  | Create workflows as drafts instead of publishing them                     |
+| `--connection a=c`   | Use connection `c` for app `a`, so the install does not stop to ask       |
+| `--no-browser`       | Print links instead of opening them                                       |
+| `-y`                 | Do not ask for confirmation (needed without a terminal)                   |
+| `--resume [--event]` | Continue an install that stopped, for example because the terminal closed |
+| `--cancel [--event]` | Stop an install that is waiting for you; what it already created stays    |
+
+If the terminal closes, the install keeps running. Run `ds package install --resume` to pick it up again. Run `ds package install -h` for exit codes, what to do when an install fails, and how it behaves without a terminal.
+
+### Get help
+
+```bash
+ds package -h
+```
+
+## About Packages
+
+Packages allow you to bundle and distribute your DocuSign configurations and assets. Each package has a unique ID assigned by the server. Names do not need to be unique — use descriptive names to identify packages by purpose.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusign/cli",
-  "version": "1.1.0-rc",
+  "version": "1.3.0-rc",
   "author": "Docusign",
   "description": "The Docusign CLI simplifies the implementation of Docusign Agreement Manager. With this CLI, you can bulk configure Agreement Manager with custom fields and types, map fields to types, provide AI training sets for custom extractions, programmatically test extraction accuracy, and export/import your setup across accounts. This offering is currently in beta.",
   "main": "dist/index.mjs",