Interface: AppManifestSpec<C, A>

What an author declares. The host reads it as JSON from the module's manifest export: configSchema and each action's input are serialised with z.toJSONSchema(schema, { io: 'input' }) (defaulted fields optional), each output with { io: 'output' }.

Type Parameters

C

C extends z.ZodType = z.ZodType

A

A extends Record<string, ActionSpec> = Record<string, ActionSpec>

Properties

actions

actions: A;

---

capabilities?

optional capabilities?: string[];

Capability tags, e.g. ['sanctions.screen'].

---

category?

optional category?: string;

Where the console's catalogue files the app, e.g. 'Sanctions & PEP'.

---

configSchema

configSchema: C;

The tenant's non-secret configuration; the module parses it with this schema.

---

description?

optional description?: string;

---

docsUrl?

optional docsUrl?: string;

An https address.

---

handoff?

optional handoff?: "sumsub";

The vendor SDK the applicant continues a pending session in.

---

hosts?

optional hosts?: string[];

The hosts the app sends requests to (api.vendor.example, *.vendor.example).

---

memoryMiB?

optional memoryMiB?: number;

The module's memory, 16 to 256 MiB (64 by default).

---

name

name: string;

acme-screening: lower case, digits and dashes.

---

needs?

optional needs?: "documents"[];

---

pricingNote?

optional pricingNote?: string;

How the vendor charges, in one line.

---

secrets?

optional secrets?: (
  | string
  | {
  description?: string;
  name: string;
})[];

The secrets a tenant provides when installing; the module names them in requests.

---

vendor?

optional vendor?: string;

Who runs the service the app calls, e.g. 'OpenSanctions'; omit for apps that call no vendor.

---

version

version: string;

1.2.0.

---

webhookExternalId?

optional webhookExternalId?: WebhookExternalIdSource;

How the API finds the external id of a webhook whose URL names none.