Functions

requireDomainId

Require domainId - throws if missing or placeholder. domainId is REQUIRED for all requests (extracted from JWT by Kong).

Signature:

requireDomainId(domainId: string | null | undefined): string

Parameters:

Returns:

string -

sanitizeOrgId

Sanitize orgId - returns undefined if missing or placeholder. orgId is OPTIONAL because users can belong to multiple organizations. Should be passed per-request when needed.

Signature:

sanitizeOrgId(orgId: string | null | undefined): string | undefined

Parameters:

Returns:

string \| undefined -

sanitizeWorkspaceId

Sanitize workspaceId - returns undefined if missing or placeholder. workspaceId is OPTIONAL, passed per-request when needed.

Signature:

sanitizeWorkspaceId(workspaceId: string | null | undefined): string | undefined

Parameters:

Returns:

string \| undefined -

extractDomainFromHeaders

Extract domainId from HTTP headers - required. Kong gateway sets x-domain-id header from JWT claims.

Signature:

extractDomainFromHeaders(headers: Record<string, string | string[] | undefined>): string

Parameters:

Returns:

string -

extractOrgFromHeaders

Extract optional orgId from HTTP headers. Returns undefined if not provided or placeholder value.

Signature:

extractOrgFromHeaders(headers: Record<string, string | string[] | undefined>): string | undefined

Parameters:

Returns:

string \| undefined -

extractWorkspaceFromHeaders

Extract optional workspaceId from HTTP headers. Returns undefined if not provided or placeholder value.

Signature:

extractWorkspaceFromHeaders(headers: Record<string, string | string[] | undefined>): string | undefined

Parameters:

Returns:

string \| undefined -