xlsx.parse | Runstamp Docs

Read workbook bytes into the structured model.

Use describe("xlsx.parse") when your code needs the complete live JSON Schemas.

At a glance

Property	Value
Package	`@runstamp/xlsx`
Domain / verb	`xlsx` / `parse`
Customer jobs	read
Deterministic	Yes
Side effects	none

Availability

Local	SDK	CLI	MCP	Managed API
public ga	public ga	public ga	public ga	public ga

Managed API route: POST /api/v2/operations/xlsx/parse. Managed execution requires a free-trial workspace or an active Platform or Enterprise workspace, and an environment-bound API key.

Input and result

Schema	Required fields	Optional fields
Input	`workbookBase64`	`artifactId`, `locators`
Options	none	`deterministic`, `deterministicSeed`, `timeoutMs`, `locale`, `lossPolicy`, `limits`
Result value	`output`, `artifacts`	none

Every success also carries losses, diagnostics, and a hash-bound receipt.

Defaults, limits, and format constraints

Defaults

Path	Default
`$.deterministic`	`default=true`
`$.lossPolicy`	`default="collect"`

Formats and profiles

No separate format selector is declared. Accepted artifacts are bounded by the exact input schema.

Other limits

Path	Constraint
`$.workbookBase64`	`minLength=8` `maxLength=89478488`
`$.artifactId`	`minLength=1` `maxLength=256`
`$.locators`	`maxItems=1000000`
`$.locators[].artifactId`	`minLength=1` `maxLength=256`
`$.locators[].value`	`minItems=2` `maxItems=2`
`$.locators[].value[]`	`minLength=1` `maxLength=255`
`$.timeoutMs`	`minimum=1` `maximum=600000`
`$.limits.maxInputBytes`	`minimum=1` `maximum=67108864`
`$.limits.maxOutputBytes`	`minimum=1` `maximum=134217728`
`$.limits.maxPages`	`minimum=1` `maximum=1048576`
`$.limits.maxElements`	`minimum=1` `maximum=1000000`
`$.limits.maxArchiveEntries`	`minimum=1` `maximum=2000`
`$.limits.maxExpansionRatio`	`minimum=1` `maximum=1000`
`$.limits.maxDurationMs`	`exclusiveMinimum=0` `maximum=600000`

Invoke

const input = await fetch("https://runstamp.com/demo-evidence/operation-evidence/xlsx/xlsx.parse/input.json").then((response) => response.json());
const result = await runstamp.run("xlsx.parse", input);
if (!result.ok) throw new Error(`${result.error.code}: ${result.error.remediation}`);
console.log(result.value, result.losses, result.diagnostics, result.receipt);

curl -fsS https://runstamp.com/demo-evidence/operation-evidence/xlsx/xlsx.parse/input.json -o input.json
npx -p @runstamp/sdk runstamp ops invoke xlsx.parse --input input.json

{
  "tool": "runstamp_invoke_operation",
  "arguments": {
    "operation": "xlsx.parse",
    "input": "<JSON from https://runstamp.com/demo-evidence/operation-evidence/xlsx/xlsx.parse/input.json>",
    "execution_mode": "local"
  }
}

Errors and losses

Declared errors (18)

xlsx/INVALID_INPUT
xlsx/RESOURCE_LIMIT
xlsx/TIMEOUT
xlsx/XLSX_ABORTED
xlsx/XLSX_ARCHIVE_UNSAFE
xlsx/XLSX_BUDGET_EXCEEDED
xlsx/XLSX_CELL_NOT_FOUND
xlsx/XLSX_ENCRYPTED_UNSUPPORTED
xlsx/XLSX_FORMULA_INJECTION
xlsx/XLSX_MAPPING_UNRESOLVED
xlsx/SCHEMA_REJECTED
common/SCHEMA_REJECTED
common/OPERATION_CANCELLED
common/OPERATION_TIMEOUT
common/CONTRACT_VIOLATION
common/RESOURCE_LIMIT_EXCEEDED
common/INPUT_CORRUPT
xlsx/LOSS_POLICY_VIOLATED

Declared losses (1)

xlsx/XLSX_OPAQUE_PART_PRESERVED

SDK AbortSignal, CLI exit 130, and MCP cancellation return the typed common/OPERATION_CANCELLED failure envelope.

Verified example and exact contract

Fixture: icp-workflow (Four decision cells from the compliance-remediation workbook).
Example input — SHA-256 203e30747ad8fdb46b0ae3c0676413dd8381db5c71a2c3aa03ac2f05da3e3ead.
Example result — SHA-256 bfd81127816194492c8808e5d8ed472fa80f20d87a0106ff3e9e528d73ae2552.
Verified result SHA-256: e8cffe20b31ef0c771647da0562bc8ac0dafc7ff5cbe9577143e0115de273b88.
Qualification lane: 11-pdf-xlsx.

Contract fingerprints

Descriptor: df419e720f88244010f382cde80309d742f878466e3d1d534318bb2d52894ebb.
Input schema: ad529d26cefb1e24df652865ca74c9674b49ed7170a34a372e52939b559664cf.
Options schema: 270bc192b082d67454d7cbb48a246232a1b2b2c37dc87090c704d05f0573e8f1.
Result value schema: b540f0189bfb516b18d19bdd9b0fe74b973441cb04148a366f7112203706fc4e.

The machine-readable operation reference publishes the complete schemas, qualification results, and evidence bindings for every operation.

Read workbook bytes into the structured model.

Use describe("xlsx.parse") when your code needs the complete live JSON Schemas.

At a glance

Property	Value
Package	`@runstamp/xlsx`
Domain / verb	`xlsx` / `parse`
Customer jobs	read
Deterministic	Yes
Side effects	none

Availability

Local	SDK	CLI	MCP	Managed API
public ga	public ga	public ga	public ga	public ga

Managed API route: POST /api/v2/operations/xlsx/parse. Managed execution requires a free-trial workspace or an active Platform or Enterprise workspace, and an environment-bound API key.

Input and result

Schema	Required fields	Optional fields
Input	`workbookBase64`	`artifactId`, `locators`
Options	none	`deterministic`, `deterministicSeed`, `timeoutMs`, `locale`, `lossPolicy`, `limits`
Result value	`output`, `artifacts`	none

Every success also carries losses, diagnostics, and a hash-bound receipt.

Defaults, limits, and format constraints

Defaults

Path	Default
`$.deterministic`	`default=true`
`$.lossPolicy`	`default="collect"`

Formats and profiles

No separate format selector is declared. Accepted artifacts are bounded by the exact input schema.

Other limits

Path	Constraint
`$.workbookBase64`	`minLength=8` `maxLength=89478488`
`$.artifactId`	`minLength=1` `maxLength=256`
`$.locators`	`maxItems=1000000`
`$.locators[].artifactId`	`minLength=1` `maxLength=256`
`$.locators[].value`	`minItems=2` `maxItems=2`
`$.locators[].value[]`	`minLength=1` `maxLength=255`
`$.timeoutMs`	`minimum=1` `maximum=600000`
`$.limits.maxInputBytes`	`minimum=1` `maximum=67108864`
`$.limits.maxOutputBytes`	`minimum=1` `maximum=134217728`
`$.limits.maxPages`	`minimum=1` `maximum=1048576`
`$.limits.maxElements`	`minimum=1` `maximum=1000000`
`$.limits.maxArchiveEntries`	`minimum=1` `maximum=2000`
`$.limits.maxExpansionRatio`	`minimum=1` `maximum=1000`
`$.limits.maxDurationMs`	`exclusiveMinimum=0` `maximum=600000`

Invoke

const input = await fetch("https://runstamp.com/demo-evidence/operation-evidence/xlsx/xlsx.parse/input.json").then((response) => response.json());
const result = await runstamp.run("xlsx.parse", input);
if (!result.ok) throw new Error(`${result.error.code}: ${result.error.remediation}`);
console.log(result.value, result.losses, result.diagnostics, result.receipt);

curl -fsS https://runstamp.com/demo-evidence/operation-evidence/xlsx/xlsx.parse/input.json -o input.json
npx -p @runstamp/sdk runstamp ops invoke xlsx.parse --input input.json

{
  "tool": "runstamp_invoke_operation",
  "arguments": {
    "operation": "xlsx.parse",
    "input": "<JSON from https://runstamp.com/demo-evidence/operation-evidence/xlsx/xlsx.parse/input.json>",
    "execution_mode": "local"
  }
}

Errors and losses

Declared errors (18)

xlsx/INVALID_INPUT
xlsx/RESOURCE_LIMIT
xlsx/TIMEOUT
xlsx/XLSX_ABORTED
xlsx/XLSX_ARCHIVE_UNSAFE
xlsx/XLSX_BUDGET_EXCEEDED
xlsx/XLSX_CELL_NOT_FOUND
xlsx/XLSX_ENCRYPTED_UNSUPPORTED
xlsx/XLSX_FORMULA_INJECTION
xlsx/XLSX_MAPPING_UNRESOLVED
xlsx/SCHEMA_REJECTED
common/SCHEMA_REJECTED
common/OPERATION_CANCELLED
common/OPERATION_TIMEOUT
common/CONTRACT_VIOLATION
common/RESOURCE_LIMIT_EXCEEDED
common/INPUT_CORRUPT
xlsx/LOSS_POLICY_VIOLATED

Declared losses (1)

xlsx/XLSX_OPAQUE_PART_PRESERVED

SDK AbortSignal, CLI exit 130, and MCP cancellation return the typed common/OPERATION_CANCELLED failure envelope.

Verified example and exact contract

Fixture: icp-workflow (Four decision cells from the compliance-remediation workbook).
Example input — SHA-256 203e30747ad8fdb46b0ae3c0676413dd8381db5c71a2c3aa03ac2f05da3e3ead.
Example result — SHA-256 bfd81127816194492c8808e5d8ed472fa80f20d87a0106ff3e9e528d73ae2552.
Verified result SHA-256: e8cffe20b31ef0c771647da0562bc8ac0dafc7ff5cbe9577143e0115de273b88.
Qualification lane: 11-pdf-xlsx.

Contract fingerprints

Descriptor: df419e720f88244010f382cde80309d742f878466e3d1d534318bb2d52894ebb.
Input schema: ad529d26cefb1e24df652865ca74c9674b49ed7170a34a372e52939b559664cf.
Options schema: 270bc192b082d67454d7cbb48a246232a1b2b2c37dc87090c704d05f0573e8f1.
Result value schema: b540f0189bfb516b18d19bdd9b0fe74b973441cb04148a366f7112203706fc4e.

The machine-readable operation reference publishes the complete schemas, qualification results, and evidence bindings for every operation.