@semics-tech/emdash-esign-pro 0.0.0-stage → 1.0.0-rc.0

package/LICENSE

@@ -0,0 +1,98 @@
+semics Pro plugins for EmDash: commercial licence
+Version 1.0 (draft)
+
+Copyright (c) 2026 SEMICS LTD. All rights reserved.
+
+[Draft written in plain English by the build agents, not by a lawyer. It needs the lawyer's review before
+launch (docs/legal/brief.md §13, question 17). BUILD-PLAN D6 and R90.]
+
+1. Who this licence is between
+
+   This licence is between SEMICS LTD (company number 12871299), registered in England and Wales, registered
+   office Slowley Hall, Tamworth Road, Coventry, CV7 8EB ("we", "us"), and the person or organisation that
+   bought the licence ("you"). Contact: support@semics.co.uk.
+
+   It covers the semics Pro plugin packages for EmDash (@semics-tech/emdash-events-pro and
+   @semics-tech/emdash-esign-pro), with their documentation and updates ("the Software"). You buy a licence
+   through our online reseller Paddle.com, which is the Merchant of Record; our terms of sale at
+   https://plugins.semics.co.uk/terms also apply.
+
+2. The licence key and the Update Term
+
+   When you buy or renew, you receive a licence key for your plan. The key names the production hostnames it
+   covers and the products it unlocks: one production hostname for Events Pro, E-sign Pro and Suite Pro, or
+   up to 10 production hostnames for Agency. Each production hostname needs its own place in a key.
+
+   The "Update Term" is one year from the date you pay. Each renewal adds another year.
+
+3. What you may do
+
+   We grant you a non-exclusive, non-transferable licence to:
+
+   (a) install and run the Software on the production hostnames your key covers;
+   (b) install and run it without a key, in any number, on local and preview hosts used for development and
+       testing: localhost, 127.0.0.1, [::1], *.localhost, *.workers.dev and *.pages.dev;
+   (c) make the copies you need for those installs, for backups and for your build and deployment pipeline;
+   (d) modify the Software for your own use on the hostnames this licence covers, for example to fix a bug or
+       fit it to your site; and
+   (e) let your staff and contractors do these things for you, as long as they follow this licence.
+
+   An agency may install the Software for its clients on the hostnames its key covers. The licence stays with
+   the buyer unless we agree in writing to move it.
+
+4. Updates, and the versions you keep
+
+   During the Update Term you may install every version of the Software we release, and you get email
+   support.
+
+   Your right to use each version released during the Update Term is perpetual: it does not end when the
+   Update Term ends, when you cancel, or when you stop renewing. A version released after your Update Term
+   ends needs a renewed key; the key you already have does not unlock it.
+
+   The key is checked offline on your site. We cannot switch it off remotely, and your site never needs to
+   contact us for the Software to keep working.
+
+5. What you must not do
+
+   You must not:
+
+   (a) sell, rent, lend, sublicense, redistribute or publish the Software or a modified version of it, or
+       offer it to others as a product, plugin or hosted service of its own;
+   (b) share your licence key, or use it on hostnames it does not cover;
+   (c) remove, disable or get around the licence check, or help anyone else do so; or
+   (d) remove copyright or licence notices.
+
+   Nothing here stops you doing what the law allows you to do whatever a contract says, such as making a
+   back-up copy or decompiling for interoperability where the law permits it.
+
+6. Your data and the free plugins
+
+   The Software stores its data in your own site. Your data stays yours: when your licence ends, or you go
+   back to the free plugins, nothing is deleted or locked, and you can export it.
+
+   The free plugins (Events and E-sign) are open source under the MIT licence. The parts of this package that
+   come from them remain available to you under MIT; this licence covers the Pro additions.
+
+7. Refunds and ending this licence
+
+   You may have a full refund within 14 days of a purchase or renewal, for any reason (see
+   https://plugins.semics.co.uk/refunds). After a refund we issue no new keys, updates or support for that
+   licence, and you should remove the key from your site.
+
+   If you seriously break section 5 and do not put it right within 30 days of our written notice, we may end
+   this licence. You must then stop using the Software and delete your copies.
+
+   Sections 4 (except after we end this licence under this section), 5, 6, 8 and 9 continue after this
+   licence ends.
+
+8. Our responsibility
+
+   Our responsibility for the Software, and the limits on it, are set out in our terms of sale at
+   https://plugins.semics.co.uk/terms. If you are a consumer, nothing in this licence affects your legal
+   rights.
+
+9. Law
+
+   This licence is governed by the law of England and Wales, and the courts of England and Wales have
+   jurisdiction. If you are a consumer living elsewhere in the UK or the EU, you also keep the protection of
+   the law where you live and may bring a claim in your local courts.

package/dist/index.d.mts

@@ -0,0 +1,5 @@
+// Auto-generated by emdash-plugin build. Do not edit.
+import type { PluginDescriptor } from "emdash";
+
+declare const descriptor: PluginDescriptor;
+export default descriptor;

package/dist/index.mjs

@@ -0,0 +1,561 @@
+// Auto-generated by emdash-plugin build. Do not edit.
+// Source: emdash-plugin.jsonc + package.json
+//
+// Default-exports a sandboxed plugin descriptor. Pass it directly into
+// emdash's `plugins:` or `sandboxed:` array — no factory call needed.
+
+/** @type {import("emdash").PluginDescriptor} */
+const descriptor = Object.freeze({
+	"id": "semics-esign",
+	"version": "1.0.0-rc.0",
+	"format": "standard",
+	"entrypoint": "@semics-tech/emdash-esign-pro/sandbox",
+	"capabilities": [
+		"media:read",
+		"media:bytes:read",
+		"network:request",
+		"email:send"
+	],
+	"allowedHosts": [
+		"challenges.cloudflare.com"
+	],
+	"storage": {
+		"templates": {
+			"indexes": [
+				"status",
+				"kind",
+				"public"
+			]
+		},
+		"envelopes": {
+			"indexes": [
+				"status",
+				"expiresAt",
+				"createdAt",
+				"clientId",
+				"externalRef",
+				"pdfSha256",
+				"signerEmail",
+				[
+					"status",
+					"expiresAt"
+				]
+			]
+		},
+		"signers": {
+			"indexes": [
+				"envelopeId",
+				"email",
+				"copyTokenHash"
+			],
+			"uniqueIndexes": [
+				"tokenHash"
+			]
+		},
+		"snapshots": {
+			"indexes": [
+				"envelopeId"
+			]
+		},
+		"artifacts": {
+			"indexes": [
+				"envelopeId",
+				[
+					"envelopeId",
+					"kind"
+				]
+			]
+		},
+		"audit_events": {
+			"indexes": [
+				"envelopeId",
+				[
+					"envelopeId",
+					"seq"
+				]
+			]
+		},
+		"clients": {
+			"indexes": [
+				"createdAt"
+			],
+			"uniqueIndexes": [
+				"clientId"
+			]
+		},
+		"nonces": {
+			"indexes": [
+				"expiresAt"
+			],
+			"uniqueIndexes": [
+				"nonce"
+			]
+		},
+		"outbox": {
+			"indexes": [
+				[
+					"status",
+					"nextAttemptAt"
+				]
+			]
+		},
+		"bulk": {
+			"indexes": [
+				[
+					"kind",
+					"createdAt"
+				]
+			]
+		},
+		"pdf_templates": {
+			"indexes": [
+				"status"
+			]
+		},
+		"pdf_files": {
+			"indexes": [
+				"sha256"
+			]
+		}
+	},
+	"hooks": [
+		"plugin:activate",
+		"cron"
+	],
+	"routes": [
+		{
+			"name": "public/envelopes/from-intent",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 16384
+			},
+			"public": true
+		},
+		{
+			"name": "public/session",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 8192
+			},
+			"public": true
+		},
+		{
+			"name": "public/otp/send",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 8192
+			},
+			"public": true
+		},
+		{
+			"name": "public/otp/verify",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 8192
+			},
+			"public": true
+		},
+		{
+			"name": "public/submit",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 262144
+			},
+			"public": true
+		},
+		{
+			"name": "public/decline",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 8192
+			},
+			"public": true
+		},
+		{
+			"name": "public/download",
+			"methods": [
+				"GET"
+			],
+			"request": {
+				"body": "none"
+			},
+			"response": "raw",
+			"public": true
+		},
+		{
+			"name": "public/verify",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 8192
+			},
+			"public": true
+		},
+		{
+			"name": "public/receipts/lookup",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 8192
+			},
+			"public": true
+		},
+		{
+			"name": "public/templates/catalog",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 65536
+			},
+			"public": true
+		},
+		{
+			"name": "public/self-serve/start",
+			"methods": [
+				"POST"
+			],
+			"request": {
+				"body": "json",
+				"maxBytes": 65536
+			},
+			"public": true
+		},
+		"admin",
+		"templates/create",
+		"templates/update",
+		"templates/get",
+		"templates/list",
+		"templates/archive",
+		"envelopes/create",
+		"envelopes/send",
+		"envelopes/get",
+		"envelopes/list",
+		"envelopes/resend",
+		"envelopes/void",
+		"outbox/status",
+		"pro/licence",
+		"pro/envelopes/send",
+		"pro/templates/self-serve",
+		"pro/bulk/start",
+		"pro/pdf-templates/upload",
+		"pro/pdf-templates/update",
+		"pro/pdf-templates/send",
+		{
+			"name": "pro/mcp/templates",
+			"permission": "plugins:manage"
+		},
+		{
+			"name": "pro/mcp/send",
+			"permission": "plugins:manage"
+		},
+		{
+			"name": "pro/mcp/status",
+			"permission": "plugins:manage"
+		},
+		{
+			"name": "pro/mcp/remind",
+			"permission": "plugins:manage"
+		},
+		{
+			"name": "pro/mcp/void",
+			"permission": "plugins:manage"
+		}
+	],
+	"mcp": {
+		"tools": [
+			{
+				"name": "listTemplates",
+				"description": "List the e-sign templates by name: id, name, current version and status. Pass status \"archived\" for archived ones.",
+				"route": "pro/mcp/templates",
+				"permission": "plugins:manage",
+				"destructive": false,
+				"inputSchema": {
+					"type": "object",
+					"properties": {
+						"status": {
+							"type": "string",
+							"enum": [
+								"active",
+								"archived"
+							]
+						}
+					},
+					"additionalProperties": false
+				}
+			},
+			{
+				"name": "sendForSignature",
+				"description": "Send a template for signature. Each signer is emailed a signing link. One signer: the envelope is created as a draft and sent within a minute. 2-10 signers sign in parallel (default) or in order (routing \"sequential\").",
+				"route": "pro/mcp/send",
+				"permission": "plugins:manage",
+				"destructive": false,
+				"inputSchema": {
+					"type": "object",
+					"properties": {
+						"templateId": {
+							"type": "string",
+							"description": "From listTemplates."
+						},
+						"templateVersion": {
+							"type": "integer",
+							"minimum": 1,
+							"description": "A pinned version; default the current one."
+						},
+						"title": {
+							"type": "string",
+							"description": "Envelope title (optional)."
+						},
+						"fields": {
+							"type": "object",
+							"additionalProperties": {
+								"type": "string"
+							},
+							"description": "Values for the template's {{placeholders}}."
+						},
+						"signers": {
+							"type": "array",
+							"minItems": 1,
+							"maxItems": 10,
+							"items": {
+								"type": "object",
+								"properties": {
+									"name": {
+										"type": "string"
+									},
+									"email": {
+										"type": "string"
+									}
+								},
+								"required": [
+									"name",
+									"email"
+								],
+								"additionalProperties": false
+							}
+						},
+						"routing": {
+							"type": "string",
+							"enum": [
+								"parallel",
+								"sequential"
+							]
+						}
+					},
+					"required": [
+						"templateId",
+						"signers"
+					],
+					"additionalProperties": false
+				}
+			},
+			{
+				"name": "getEnvelopeStatus",
+				"description": "An envelope's status (draft, sent, in_progress, completed, declined, voided, expired), dates and each signer's status, with a short-lived signed PDF link once completed.",
+				"route": "pro/mcp/status",
+				"permission": "plugins:manage",
+				"destructive": false,
+				"inputSchema": {
+					"type": "object",
+					"properties": {
+						"id": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 100,
+							"description": "The envelope id."
+						}
+					},
+					"required": [
+						"id"
+					],
+					"additionalProperties": false
+				}
+			},
+			{
+				"name": "remindSigners",
+				"description": "Email the next pending signer a reminder with a fresh signing link (the old link stops working). One signer per call; `remaining` says how many more are due. A signer is reminded at most once an hour.",
+				"route": "pro/mcp/remind",
+				"permission": "plugins:manage",
+				"destructive": false,
+				"inputSchema": {
+					"type": "object",
+					"properties": {
+						"id": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 100,
+							"description": "The envelope id."
+						}
+					},
+					"required": [
+						"id"
+					],
+					"additionalProperties": false
+				}
+			},
+			{
+				"name": "voidEnvelope",
+				"description": "Void an open envelope: its signing links stop working at once. This cannot be undone.",
+				"route": "pro/mcp/void",
+				"permission": "plugins:manage",
+				"destructive": true,
+				"inputSchema": {
+					"type": "object",
+					"properties": {
+						"id": {
+							"type": "string",
+							"minLength": 1,
+							"maxLength": 100,
+							"description": "The envelope id."
+						}
+					},
+					"required": [
+						"id"
+					],
+					"additionalProperties": false
+				}
+			}
+		]
+	},
+	"adminPages": [
+		{
+			"path": "/envelopes",
+			"label": "Envelopes",
+			"icon": "file"
+		},
+		{
+			"path": "/templates",
+			"label": "Templates",
+			"icon": "file-text"
+		},
+		{
+			"path": "/integrations",
+			"label": "Integrations",
+			"icon": "link"
+		},
+		{
+			"path": "/settings",
+			"label": "Settings",
+			"icon": "gear"
+		},
+		{
+			"path": "/bulk",
+			"label": "Bulk send",
+			"icon": "users"
+		},
+		{
+			"path": "/self-serve",
+			"label": "Self-serve forms",
+			"icon": "globe"
+		},
+		{
+			"path": "/pdf-templates",
+			"label": "PDF templates",
+			"icon": "file"
+		}
+	],
+	"settingsSchema": {
+		"senderName": {
+			"label": "Sender name",
+			"description": "Shown as the sender of signing emails.",
+			"type": "string"
+		},
+		"consentVersion": {
+			"label": "Consent version",
+			"description": "Recorded with every signature; bump when the wording changes.",
+			"type": "string",
+			"default": "1"
+		},
+		"consentWording": {
+			"label": "Consent wording",
+			"description": "Shown to signers before they sign.",
+			"type": "string",
+			"default": "I agree to use electronic records and an electronic signature for this document.",
+			"multiline": true
+		},
+		"expiryDays": {
+			"label": "Envelope expiry (days)",
+			"type": "number",
+			"default": 30,
+			"min": 1,
+			"max": 365
+		},
+		"reminderCadenceDays": {
+			"label": "Reminder cadence (days)",
+			"description": "Pro: automatic reminders.",
+			"type": "number",
+			"default": 3,
+			"min": 1,
+			"max": 30
+		},
+		"otpDefault": {
+			"label": "Require email code by default",
+			"description": "Pro: one-time code before signing.",
+			"type": "boolean",
+			"default": false
+		},
+		"otpContractTemplates": {
+			"label": "Require email code for contract templates",
+			"description": "Pro.",
+			"type": "boolean",
+			"default": true
+		},
+		"retentionPersonalDataMonths": {
+			"label": "Keep personal data (months)",
+			"type": "number",
+			"default": 12,
+			"min": 1,
+			"max": 120
+		},
+		"retentionSignedRecordsYears": {
+			"label": "Keep signed records (years)",
+			"type": "number",
+			"default": 7,
+			"min": 1,
+			"max": 50
+		},
+		"turnstileSiteKey": {
+			"label": "Turnstile site key",
+			"type": "string"
+		},
+		"turnstileSecretKey": {
+			"label": "Turnstile secret key",
+			"type": "secret"
+		},
+		"integrationMasterKey": {
+			"label": "Integration master key",
+			"description": "Client secrets are derived from this key; it is never shown again.",
+			"type": "secret"
+		},
+		"licenceKey": {
+			"label": "Pro licence key",
+			"description": "The semics1. key from your purchase email. Not needed on local or preview hosts. Stored encrypted.",
+			"type": "secret"
+		}
+	}
+});
+
+export default descriptor;