Postel
API reference

@postel/edge

Public API of @postel/edge — verify, createKeyset, jwksHandler, dedup, signFixture, and the structured error classes. Generated from source via TypeDoc.

Classes

MalformedHeader

Defined in: typescript/packages/edge/src/errors.ts:25

Extends

Constructors

Constructor
new MalformedHeader(message, options?): MalformedHeader;

Defined in: typescript/packages/edge/src/errors.ts:11

Parameters
ParameterType
messagestring
options?ErrorOptions
Returns

MalformedHeader

Inherited from

PostelError.constructor

Properties

PropertyModifierTypeOverridesInherited fromDefined in
cause?publicunknown-PostelError.causedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
codereadonly"MALFORMED_HEADER"PostelError.code-typescript/packages/edge/src/errors.ts:26
messagepublicstring-PostelError.messagedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-PostelError.namedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstring-PostelError.stackdocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1078

abstract PostelError

Defined in: typescript/packages/edge/src/errors.ts:8

Extends

  • Error

Extended by

Constructors

Constructor
new PostelError(message, options?): PostelError;

Defined in: typescript/packages/edge/src/errors.ts:11

Parameters
ParameterType
messagestring
options?ErrorOptions
Returns

PostelError

Overrides
Error.constructor

Properties

PropertyModifierTypeInherited fromDefined in
cause?publicunknownError.causedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
codeabstractPostelErrorCode-typescript/packages/edge/src/errors.ts:9
messagepublicstringError.messagedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstringError.namedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstringError.stackdocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1078

RawBytesMismatchDetected

Defined in: typescript/packages/edge/src/errors.ts:33

Extends

Constructors

Constructor
new RawBytesMismatchDetected(message, options?): RawBytesMismatchDetected;

Defined in: typescript/packages/edge/src/errors.ts:11

Parameters
ParameterType
messagestring
options?ErrorOptions
Returns

RawBytesMismatchDetected

Inherited from

PostelError.constructor

Properties

PropertyModifierTypeOverridesInherited fromDefined in
cause?publicunknown-PostelError.causedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
codereadonly"RAW_BYTES_MISMATCH_DETECTED"PostelError.code-typescript/packages/edge/src/errors.ts:34
messagepublicstring-PostelError.messagedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-PostelError.namedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstring-PostelError.stackdocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1078

SignatureInvalid

Defined in: typescript/packages/edge/src/errors.ts:17

Extends

Constructors

Constructor
new SignatureInvalid(message, options?): SignatureInvalid;

Defined in: typescript/packages/edge/src/errors.ts:11

Parameters
ParameterType
messagestring
options?ErrorOptions
Returns

SignatureInvalid

Inherited from

PostelError.constructor

Properties

PropertyModifierTypeOverridesInherited fromDefined in
cause?publicunknown-PostelError.causedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
codereadonly"SIGNATURE_INVALID"PostelError.code-typescript/packages/edge/src/errors.ts:18
messagepublicstring-PostelError.messagedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-PostelError.namedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstring-PostelError.stackdocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1078

TimestampTooOld

Defined in: typescript/packages/edge/src/errors.ts:21

Extends

Constructors

Constructor
new TimestampTooOld(message, options?): TimestampTooOld;

Defined in: typescript/packages/edge/src/errors.ts:11

Parameters
ParameterType
messagestring
options?ErrorOptions
Returns

TimestampTooOld

Inherited from

PostelError.constructor

Properties

PropertyModifierTypeOverridesInherited fromDefined in
cause?publicunknown-PostelError.causedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
codereadonly"TIMESTAMP_TOO_OLD"PostelError.code-typescript/packages/edge/src/errors.ts:22
messagepublicstring-PostelError.messagedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-PostelError.namedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstring-PostelError.stackdocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1078

UnknownKeyId

Defined in: typescript/packages/edge/src/errors.ts:29

Extends

Constructors

Constructor
new UnknownKeyId(message, options?): UnknownKeyId;

Defined in: typescript/packages/edge/src/errors.ts:11

Parameters
ParameterType
messagestring
options?ErrorOptions
Returns

UnknownKeyId

Inherited from

PostelError.constructor

Properties

PropertyModifierTypeOverridesInherited fromDefined in
cause?publicunknown-PostelError.causedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26
codereadonly"UNKNOWN_KEY_ID"PostelError.code-typescript/packages/edge/src/errors.ts:30
messagepublicstring-PostelError.messagedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1077
namepublicstring-PostelError.namedocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?publicstring-PostelError.stackdocs/node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.es5.d.ts:1078

Interfaces

DedupAdapter

Defined in: typescript/packages/edge/src/types.ts:63

Properties

PropertyModifierTypeDefined in
recordreadonly(messageId, ttlSeconds) => Promise<DedupResult>typescript/packages/edge/src/types.ts:64

DedupOptions

Defined in: typescript/packages/edge/src/types.ts:54

Properties

PropertyModifierTypeDefined in
adapterreadonlyDedupAdaptertypescript/packages/edge/src/types.ts:56
ttlreadonlystring | numbertypescript/packages/edge/src/types.ts:55

DedupResult

Defined in: typescript/packages/edge/src/types.ts:59

Properties

PropertyModifierTypeDefined in
duplicatereadonlybooleantypescript/packages/edge/src/types.ts:60

InMemoryDedupOptions

Defined in: typescript/packages/edge/src/dedup.ts:13

Properties

PropertyModifierTypeDefined in
now?readonly() => Datetypescript/packages/edge/src/dedup.ts:14

Jwk

Defined in: typescript/packages/edge/src/types.ts:21

Indexable

[key: string]: unknown

Properties


Jwks

Defined in: typescript/packages/edge/src/types.ts:31

Properties

PropertyModifierTypeDefined in
keysreadonlyreadonly Jwk[]typescript/packages/edge/src/types.ts:32

JwksHandlerOptions

Defined in: typescript/packages/edge/src/types.ts:49

Properties

PropertyModifierTypeDefined in
keysreadonlyreadonly Jwk[]typescript/packages/edge/src/types.ts:50
tenantId?readonlystringtypescript/packages/edge/src/types.ts:51

Keyset

Defined in: typescript/packages/edge/src/types.ts:42

Properties

PropertyModifierTypeDefined in
findByKidreadonly(kid) => Promise<Jwk | undefined>typescript/packages/edge/src/types.ts:43
refreshreadonly() => Promise<void>typescript/packages/edge/src/types.ts:44

KeysetOptions

Defined in: typescript/packages/edge/src/types.ts:35

Properties

PropertyModifierTypeDefined in
cacheTtl?readonlynumbertypescript/packages/edge/src/types.ts:38
fetch?readonly(input, init?) => Promise<Response>typescript/packages/edge/src/types.ts:39
jwksUrireadonlystringtypescript/packages/edge/src/types.ts:36
refreshEvery?readonlynumbertypescript/packages/edge/src/types.ts:37

SignedFixture

Defined in: typescript/packages/edge/src/types.ts:74

Properties

PropertyModifierTypeDefined in
bodyreadonlystringtypescript/packages/edge/src/types.ts:76
headersreadonlyWebhookHeaderstypescript/packages/edge/src/types.ts:75

SignFixtureOptions

Defined in: typescript/packages/edge/src/types.ts:67

Type Parameters

Type ParameterDefault type
TDataunknown

Properties

PropertyModifierTypeDefined in
messageId?readonlystringtypescript/packages/edge/src/types.ts:70
payloadreadonlyWebhookEvent<TData>typescript/packages/edge/src/types.ts:69
secretreadonlystringtypescript/packages/edge/src/types.ts:68
timestamp?readonlyDatetypescript/packages/edge/src/types.ts:71

VerifyOptions

Defined in: typescript/packages/edge/src/types.ts:11

Properties

PropertyModifierTypeDefined in
now?readonly() => Datetypescript/packages/edge/src/types.ts:13
toleranceSeconds?readonlynumbertypescript/packages/edge/src/types.ts:12

VerifyResult

Defined in: typescript/packages/edge/src/types.ts:16

Type Parameters

Type ParameterDefault type
TDataunknown

Properties

PropertyModifierTypeDefined in
eventreadonlyWebhookEvent<TData>typescript/packages/edge/src/types.ts:17
matchedSecretIndexreadonlynumbertypescript/packages/edge/src/types.ts:18

WebhookEvent

Defined in: typescript/packages/edge/src/types.ts:3

Type Parameters

Type ParameterDefault type
TDataunknown

Properties

PropertyModifierTypeDefined in
data?readonlyTDatatypescript/packages/edge/src/types.ts:6
timestamp?readonlystringtypescript/packages/edge/src/types.ts:5
typereadonlystringtypescript/packages/edge/src/types.ts:4

Type Aliases

PostelErrorCode

type PostelErrorCode = 
  | "SIGNATURE_INVALID"
  | "TIMESTAMP_TOO_OLD"
  | "MALFORMED_HEADER"
  | "UNKNOWN_KEY_ID"
  | "RAW_BYTES_MISMATCH_DETECTED";

Defined in: typescript/packages/edge/src/errors.ts:1


Secret

type Secret = string;

Defined in: typescript/packages/edge/src/types.ts:9


SecretOrKeyset

type SecretOrKeyset = 
  | Secret
  | ReadonlyArray<Secret>
  | Keyset;

Defined in: typescript/packages/edge/src/types.ts:47


WebhookHeaders

type WebhookHeaders = Readonly<Record<string, string>>;

Defined in: typescript/packages/edge/src/types.ts:1

Functions

createKeyset()

function createKeyset(options): Keyset;

Defined in: typescript/packages/edge/src/keyset.ts:19

Parameters

ParameterType
optionsKeysetOptions

Returns

Keyset


dedup()

function dedup(messageId, options): Promise<DedupResult>;

Defined in: typescript/packages/edge/src/dedup.ts:4

Parameters

ParameterType
messageIdstring
optionsDedupOptions

Returns

Promise<DedupResult>


inMemoryDedupAdapter()

function inMemoryDedupAdapter(options?): DedupAdapter;

Defined in: typescript/packages/edge/src/dedup.ts:17

Parameters

ParameterType
options?InMemoryDedupOptions

Returns

DedupAdapter


jwksHandler()

function jwksHandler(options): (request) => Response;

Defined in: typescript/packages/edge/src/jwks-handler.ts:4

Parameters

ParameterType
optionsJwksHandlerOptions

Returns

(request) => Response


signFixture()

function signFixture<TData>(options): Promise<SignedFixture>;

Defined in: typescript/packages/edge/src/sign-fixture.ts:13

Type Parameters

Type ParameterDefault type
TDataunknown

Parameters

ParameterType
optionsSignFixtureOptions<TData>

Returns

Promise<SignedFixture>


verify()

function verify<TData>(
   rawBody, 
   headers, 
   secretOrKeyset, 
options?): Promise<VerifyResult<TData>>;

Defined in: typescript/packages/edge/src/verify.ts:113

Type Parameters

Type ParameterDefault type
TDataunknown

Parameters

ParameterType
rawBodystring | ArrayBuffer | Uint8Array<ArrayBufferLike>
headersWebhookHeaders
secretOrKeysetSecretOrKeyset
options?VerifyOptions

Returns

Promise<VerifyResult<TData>>

On this page