| AEAD_ID |
Type : number
|
Default value : 0x0001
|
| enc |
Type : unknown
|
Default value : new TextEncoder()
|
| hpkeSuiteId |
Type : unknown
|
Default value : concat(
enc.encode("HPKE"),
i2osp(KEM_ID, 2),
i2osp(KDF_ID, 2),
i2osp(AEAD_ID, 2),
)
|
| KDF_ID |
Type : number
|
Default value : 0x0001
|
| KEM_ID |
Type : number
|
Default value : 0x0010
|
| kemSuiteId |
Type : unknown
|
Default value : concat(enc.encode("KEM"), i2osp(KEM_ID, 2))
|
| Nk |
Type : number
|
Default value : 16
|
| Nn |
Type : number
|
Default value : 12
|
| Nsecret |
Type : number
|
Default value : 32
|
| SHA256_LEN |
Type : number
|
Default value : 32
|
| ALG_TO_WEBCRYPTO |
Type : Record<KmsSigningAlg, KeyAlgorithm>
|
Default value : {
ES256: {
name: "ECDSA",
// @ts-expect-error - WebCrypto KeyAlgorithm doesn't include namedCurve in its type
namedCurve: "P-256",
},
}
|
| DisplayImageSchema |
Type : unknown
|
Default value : z
.object({
uri: z.string().min(1).describe("Image URI."),
})
.describe("Display image reference.")
.strict()
|
| NoneTrustPolicySchema |
Type : unknown
|
Default value : z
.object({
policy: z.literal("none").describe("No disclosure policy enforcement."),
})
.describe("No disclosure policy.")
.strict()
|
| allRoles |
Type : []
|
Default value : [
Role.Tenants,
Role.IssuanceOffer,
Role.Issuances,
Role.PresentationRequest,
Role.Presentations,
Role.Clients,
Role.Users,
Role.Registrar,
]
|
|
List of all roles |
| AttributeProviderAuthSchema |
Type : unknown
|
Default value : z
.discriminatedUnion("type", [NoneAuthSchema, ApiKeyAuthSchema])
.describe("Authentication method used to call the attribute provider.")
|
| NoneAuthSchema |
Type : unknown
|
Default value : z
.object({
type: z
.literal("none")
.describe("Disable authentication for attribute provider calls."),
})
.describe("No authentication variant.")
|
| UpdateAttributeProviderSchema |
Type : unknown
|
Default value : CreateAttributeProviderSchema.partial()
.describe(
"Payload for partially updating an attribute provider configuration.",
)
.strict()
|
| ApiKeyConfigSchema |
Type : unknown
|
Default value : z
.object({
headerName: z.string(),
value: z.string(),
})
.strict()
|
|
Configuration for API key authentication in webhooks. |
| WebHookAuthConfigHeaderSchema |
Type : unknown
|
Default value : z
.object({
type: z.literal(AuthConfig.API_KEY),
config: ApiKeyConfigSchema,
})
.strict()
|
|
Configuration for webhook authentication. |
| WebHookAuthConfigNoneSchema |
Type : unknown
|
Default value : z
.object({
type: z.literal(AuthConfig.NONE),
})
.strict()
|
| WebHookAuthConfigSchema |
Type : unknown
|
Default value : z.discriminatedUnion("type", [
WebHookAuthConfigNoneSchema,
WebHookAuthConfigHeaderSchema,
])
|
| WebhookConfigSchema |
Type : unknown
|
Default value : z
.object({
url: z.string(),
auth: WebHookAuthConfigSchema,
includeRawTokensFor: z.array(z.string()).optional(),
})
.strict()
|
| WebHookAuthConfigNoneSchema |
Type : unknown
|
Default value : z
.object({
type: z.literal("none").describe("Disable authentication."),
})
.describe("Webhook no-authentication variant.")
.strict()
|
| AppDataSource |
Type : unknown
|
Default value : new DataSource(dataSourceOptions)
|
| dataSourceOptions |
Type : DataSourceOptions
|
| dbType |
Type : unknown
|
Default value : process.env.DB_TYPE as "sqlite" | "postgres" | undefined
|
| ATTESTATION_LOS_VALUES |
Type : unknown
|
Default value : [
"iso_18045_high",
"iso_18045_moderate",
"iso_18045_enhanced-basic",
"iso_18045_basic",
] as const
|
| BINDING_TYPE_VALUES |
Type : unknown
|
Default value : ["claim", "key", "biometric", "none"] as const
|
| CATEGORY_VALUES |
Type : unknown
|
Default value : [
"identity",
"health",
"finance",
"education",
"mobility",
"employment",
"other",
] as const
|
| DeprecateSchemaMetadataSchema |
Type : unknown
|
Default value : z
.object({
deprecated: z.boolean(),
message: z.string().optional(),
supersededByVersion: z.string().optional(),
})
.strict()
|
| FORMAT_VALUES |
Type : unknown
|
Default value : ["dc+sd-jwt", "mso_mdoc"] as const
|
| TAG_VALUES |
Type : unknown
|
Default value : [
"pid",
"eudi",
"kyc",
"aml",
"age-verification",
"residency",
"membership",
"education",
"employment",
"mobility",
] as const
|
| UpdateIssuerOfferSchema |
Type : unknown
|
Default value : z
.object({
credentialOfferUrl: z.string().optional(),
description: z.string().optional(),
})
.strict()
|
| VOCABULARY_STATUS_VALUES |
Type : unknown
|
Default value : ["active", "deprecated"] as const
|
| AttestationBasedPolicySchema |
Type : unknown
|
Default value : z
.object({
policy: z.literal("attestationBased"),
values: z.array(PolicyCredentialSchema),
})
.strict()
|
| EmbeddedDisclosurePolicySchema |
Type : unknown
|
Default value : z
.object({
policy: z.string(),
})
.strict()
|
| PolicyCredentialSchema |
Type : unknown
|
Default value : z
.object({
claims: z.array(z.any()).optional(),
credentials: z.array(z.any()),
credential_sets: z.array(z.any()).optional(),
})
.strict()
|
| AttributeProviderClaimsSourceSchema |
Type : unknown
|
Default value : z
.object({
type: z.literal("attributeProvider"),
attributeProviderId: z.string(),
})
.strict()
|
| ClaimsSourceSchema |
Type : unknown
|
Default value : z.union([
InlineClaimsSourceSchema,
AttributeProviderClaimsSourceSchema,
WebhookClaimsSourceSchema,
])
|
| FlowType |
Type : unknown
|
Default value : {
AUTH_CODE: "authorization_code",
PRE_AUTH_CODE: "pre_authorized_code",
} as const
|
| InlineClaimsSourceSchema |
Type : unknown
|
Default value : z
.object({
type: z.literal("inline"),
claims: z.record(z.string(), z.unknown()),
})
.strict()
|
| OfferRequestBase |
Type : OfferRequestConstructor
|
Default value : createZodDto(
OfferRequestSchema,
) as OfferRequestConstructor
|
| WebhookClaimsSourceSchema |
Type : unknown
|
Default value : z
.object({
type: z.literal("webhook"),
webhook: WebhookConfigSchema,
})
.strict()
|
| AuthenticationMethodAuthSchema |
Type : unknown
|
Default value : z
.object({
method: z.literal("auth"),
config: AuthenticationUrlConfigSchema,
})
.strict()
|
| AuthenticationMethodNoneSchema |
Type : unknown
|
Default value : z
.object({
method: z.literal("none"),
})
.strict()
|
| AuthenticationMethodPresentationSchema |
Type : unknown
|
Default value : z
.object({
method: z.literal("presentationDuringIssuance"),
config: PresentationDuringIssuanceConfigSchema,
})
.strict()
|
| AuthenticationUrlConfigSchema |
Type : unknown
|
Default value : z
.object({
url: z.string(),
webhook: WebhookConfigSchema.optional(),
})
.strict()
|
| PresentationDuringIssuanceConfigSchema |
Type : unknown
|
Default value : z
.object({
type: z.string(),
})
.strict()
|
| ChainedAsAuthorizeQuerySchema |
Type : unknown
|
Default value : z
.object({
client_id: z.string(),
request_uri: z.string(),
state: z.string().optional(),
})
.strict()
|
| Openid4vpRequestSchema |
Type : unknown
|
Default value : z
.object({
request: z.string(),
client_id: z.string().optional(),
})
.strict()
|
| DbKmsConfigSchema |
Type : unknown
|
Default value : BaseKmsProviderConfigSchema.extend({
type: withMeta(z.literal("db"), {
description: "Type of the KMS provider.",
examples: ["db"],
}),
})
|
| HttpKmsAuthConfigSchema |
Type : unknown
|
Default value : z.discriminatedUnion("type", [
HttpAuthNoneConfigSchema,
HttpAuthBearerConfigSchema,
HttpAuthOauth2ConfigSchema,
HttpAuthMtlsConfigSchema,
])
|
| KMS_PROVIDER_TYPES |
Type : unknown
|
Default value : [
"db",
"vault",
"aws-kms",
"pkcs11",
"http",
"csc",
] as const
|
| BCRYPT_ROUNDS |
Type : number
|
Default value : 10
|
| certEditorSchemaBundle |
Type : unknown
|
Default value : defineEditorSchemaBundle({
domain: "cert",
schemas: [
defineEditorSchema({
name: "CertImportDto",
schema: CertImportSchema,
}),
],
})
|
| configuredLogLevel |
Type : unknown
|
Default value : (
process.env.LOG_LEVEL ??
(process.env.NODE_ENV === "production" ? "warn" : "debug")
).toLowerCase()
|
| toX509Certificates |
Type : unknown
|
Default value : (certificates: Uint8Array[]) =>
certificates.map(
(certificate) => new x509.X509Certificate(toBuffer(certificate)),
)
|
| webCrypto |
Type : unknown
|
Default value : globalThis.crypto
|
| X509_CHAIN_DEBUG |
Type : unknown
|
Default value : X509_CHAIN_TRACE || configuredLogLevel === "debug"
|
| X509_CHAIN_TRACE |
Type : unknown
|
Default value : configuredLogLevel === "trace"
|
| ChainedAsVpConfigSchema |
Type : unknown
|
Default value : z
.object({
enabled: z.boolean(),
presentationConfigId: z.string(),
})
.strict()
|
| UpstreamOidcConfigSchema |
Type : unknown
|
Default value : z
.object({
issuer: z.string(),
clientId: z.string(),
clientSecret: z.string().optional(),
scopes: z.array(z.string()).optional(),
})
.strict()
|
| FieldDisplaySchema |
Type : unknown
|
Default value : z
.object({
locale: z.string(),
name: z.string(),
description: z.string().optional(),
})
.strict()
|
| PresentationConfigUpdateSchema |
Type : unknown
|
Default value : PresentationConfigCreateSchema.partial()
.describe("Payload for updating presentation verifier configuration.")
.strict()
|
| TenantUrlPlaceholderSchema |
Type : unknown
|
Default value : z
.string()
.regex(/^<TENANT_URL>(?:\/.*)?$/, "expected a URL")
|
| TrustListUrlSchema |
Type : unknown
|
Default value : z.union([z.url(), TenantUrlPlaceholderSchema])
|
| rolesSchema |
Type : unknown
|
Default value : z
.array(z.enum(Role))
.min(1)
.describe("Roles assigned to the client. At least one role is required.")
|
| CLIENTS_PROVIDER |
Type : string
|
Default value : "CLIENTS_PROVIDER"
|
| CompleteDeferredSchema |
Type : unknown
|
Default value : z
.object({
claims: z.record(z.string(), z.unknown()),
})
.strict()
|
| FailDeferredSchema |
Type : unknown
|
Default value : z
.object({
error: z.string().optional(),
})
.strict()
|
| UpdateRegistrarConfigSchema |
Type : unknown
|
Default value : CreateRegistrarConfigSchema.partial()
.describe("Payload for partially updating registrar integration settings.")
.strict()
|
| ImportTenantSchema |
Type : unknown
|
Default value : CreateTenantSchema.pick({
name: true,
description: true,
}).describe("Payload used when importing tenant metadata from config files.")
|
| NonBlankStringSchema |
Type : unknown
|
Default value : z.string().trim().min(1)
|
| RoleSchema |
Type : unknown
|
Default value : z.enum(
allRoles as [(typeof allRoles)[number], ...(typeof allRoles)[number][]],
)
|
| RoleSchema |
Type : unknown
|
Default value : z.enum(
allRoles as [(typeof allRoles)[number], ...(typeof allRoles)[number][]],
)
|
| UpdateUserSchema |
Type : unknown
|
Default value : CreateUserSchema.partial().extend({
password: z.string().min(8).optional(),
})
|
| UpdateWebhookEndpointSchema |
Type : unknown
|
Default value : CreateWebhookEndpointSchema.partial()
.describe(
"Payload for partially updating a webhook endpoint configuration.",
)
.strict()
|
| WebhookAuthNoneSchema |
Type : unknown
|
Default value : z
.object({
type: z.literal("none").describe("Disable webhook authentication."),
})
.describe("No webhook authentication variant.")
|
| WebhookAuthSchema |
Type : unknown
|
Default value : z
.discriminatedUnion("type", [
WebhookAuthNoneSchema,
WebhookAuthApiKeySchema,
])
.describe("Authentication strategy for webhook delivery.")
|
| CRV_P256 |
Type : number
|
Default value : 1
|
| KTY_EC |
Type : number
|
Default value : 2
|
| DCQL_CREDENTIAL_FORMATS |
Type : unknown
|
Default value : ["dc+sd-jwt", "mso_mdoc"] as const
|
| DEFAULT_API_PATH |
Type : string
|
Default value : "/csc/v2"
|
| DEFAULT_HASH_ALGORITHM_OID |
Type : string
|
Default value : "2.16.840.1.101.3.4.2.1"
|
| DEFAULT_SIGN_ALGORITHM_OID |
Type : string
|
Default value : "1.2.840.10045.4.3.2"
|
| DEFAULT_CLIENT_ATTESTATION_SIGNING_ALG_VALUES_SUPPORTED |
Type : unknown
|
Default value : [
"ES256",
] as const
|
| DEFAULT_CODE_CHALLENGE_METHODS_SUPPORTED |
Type : unknown
|
Default value : ["S256"] as const
|
| DEFAULT_DPOP_SIGNING_ALG_VALUES_SUPPORTED |
Type : unknown
|
Default value : [
"ES256",
"ES384",
"ES512",
] as const
|
| DEFAULT_TOKEN_ENDPOINT_AUTH_METHODS_SUPPORTED |
Type : unknown
|
Default value : [
"attest_jwt_client_auth",
"none",
] as const
|
| DEFAULT_LANG |
Type : string
|
Default value : "en"
|
|
Default language for trust list entries |
| DEFAULT_PROVIDER_ID |
Type : string
|
Default value : "db"
|
| DEFAULT_PROVIDER_ID |
Type : string
|
Default value : "db"
|
| DEFAULT_REVOCATION_POLICY |
Type : NonNullable<VerifyPolicy['revocation']>
|
Default value : {
enabled: true,
failClosed: true,
}
|
| DEFAULT_VERIFIER_SKEW_SECONDS |
Type : number
|
Default value : 60
|
| DeferredCredentialRequestSchema |
Type : unknown
|
Default value : z
.object({
transaction_id: z.string(),
})
.strict()
|
| DisplayInfoSchema |
Type : unknown
|
Default value : z
.object({
name: z.string().optional(),
locale: z.string().optional(),
logo: DisplayLogoSchema.optional(),
})
.catchall(z.unknown())
|
| DisplayLogoSchema |
Type : unknown
|
Default value : z
.object({
uri: z.string(),
alt_text: z.string().optional(),
})
.catchall(z.unknown())
|
| ECDSA_P256_SIGNATURE_ALG |
Type : object
|
Default value : {
name: "ECDSA",
hash: "SHA-256" as const,
}
|
| editorSchemaBundles |
Type : readonly EditorSchemaBundle[]
|
Default value : [
clientEditorSchemaBundle,
tenantEditorSchemaBundle,
attributeProviderEditorSchemaBundle,
webhookEndpointEditorSchemaBundle,
keyChainEditorSchemaBundle,
kmsEditorSchemaBundle,
certEditorSchemaBundle,
statusListEditorSchemaBundle,
registrarEditorSchemaBundle,
issuanceEditorSchemaBundle,
credentialEditorSchemaBundle,
presentationEditorSchemaBundle,
trustListEditorSchemaBundle,
webhookEditorSchemaBundle,
]
|
| ENCRYPTION_KEY_PROVIDER |
Type : string
|
Default value : "ENCRYPTION_KEY_PROVIDER"
|
|
Injection token for the encryption key provider. |
| ENV_PLACEHOLDER_REGEX |
Type : unknown
|
Default value : /^\$\{([A-Z0-9_]+)\}$/
|
| FederationTrustAnchorConfigSchema |
Type : unknown
|
Default value : z
.object({
entityId: z.string(),
entityConfigurationUri: z.string(),
})
.strict()
|
| FILE_STORAGE |
Type : unknown
|
Default value : Symbol("FILE_STORAGE")
|
| IS_PUBLIC_KEY |
Type : string
|
Default value : "isPublic"
|
| Public |
Type : unknown
|
Default value : () => SetMetadata(IS_PUBLIC_KEY, true)
|
| JOSE_TO_CLASSIC_COSE_ALG |
Type : Record<JoseAlgorithm, number>
|
Default value : {
ES256: -7,
ES384: -35,
ES512: -36,
}
|
| JSON_SCHEMA_DRAFT_2020_12 |
Type : string
|
Default value : "https://json-schema.org/draft/2020-12/schema"
|
| KeyAttestationsRequiredSchema |
Type : unknown
|
Default value : z
.object({
key_storage: z.array(z.string()).optional(),
user_authentication: z.array(z.string()).optional(),
})
.strict()
|
| kmsEditorSchemaBundle |
Type : unknown
|
Default value : defineEditorSchemaBundle({
domain: "kms",
schemas: [
defineEditorSchema({
name: "KmsConfigDto",
schema: KmsConfigSchema,
}),
],
})
|
| MSO_MDOC_FORMAT |
Type : MsoMdocFormatIdentifier
|
Default value : "mso_mdoc"
|
|
Format identifier constants for runtime checks |
| SD_JWT_DC_FORMAT |
Type : unknown
|
Default value : "dc+sd-jwt" as const
|
| NotificationRequestSchema |
Type : unknown
|
Default value : z
.object({
notification_id: z.string(),
event: z.enum([
"credential_accepted",
"credential_failure",
"credential_deleted",
]),
})
.strict()
|
| otelSDK |
Type : unknown
|
Default value : new NodeSDK({
resource: resourceFromAttributes({
[ATTR_SERVICE_NAME]: process.env.OTEL_SERVICE_NAME || "eudiplo-backend",
[ATTR_SERVICE_VERSION]: process.env.VERSION || "unknown",
}),
traceExporter: new OTLPTraceExporter(),
metricReader: new PeriodicExportingMetricReader({
exporter: new OTLPMetricExporter(),
exportIntervalMillis: 30_000,
}),
logRecordProcessors: [
new BatchLogRecordProcessor({
exporter: new OTLPLogExporter(),
}),
],
instrumentations: [
getNodeAutoInstrumentations({
// fs instrumentation is very noisy and adds little value
"@opentelemetry/instrumentation-fs": { enabled: false },
// Enable HTTP metrics (server request duration, etc.)
"@opentelemetry/instrumentation-http": {
enabled: true,
},
}),
],
})
|
|
OpenTelemetry SDK bootstrap — must be started BEFORE NestJS initializes. All three signals (metrics, traces, logs) are exported via OTLP to an OpenTelemetry Collector. Configure the collector endpoint via: OTEL_EXPORTER_OTLP_ENDPOINT (default: http://localhost:4318) To disable OTel entirely (e.g. local dev without collector), set: OTEL_SDK_DISABLED=true |
| P256_OID_DER |
Type : unknown
|
Default value : Buffer.from([
0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x03, 0x01, 0x07,
])
|
| pkcs11ModulePromise |
Type : Promise | undefined
|
| PresentationRequestBase |
Type : PresentationRequestConstructor
|
Default value : createZodDto(
PresentationRequestSchema,
) as PresentationRequestConstructor
|
| ResponseType |
Type : unknown
|
Default value : {
URI: "uri",
DC_API: "dc-api",
ISO_18013_7: "iso-18013-7",
} as const
|
|
Values for the type of response expected from the presentation request. |
| RegistrationCertificatePurposeSchema |
Type : unknown
|
Default value : z
.object({
lang: z.string(),
content: z.string(),
})
.strict()
|
| RegistrationCertificateRequestSchema |
Type : unknown
|
Default value : z
.object({
id: z.string().optional(),
body: RegistrationCertificateBodySchema.optional(),
jwt: z.string().optional(),
})
.strict()
|
| ResolveIssuerMetadataSchema |
Type : unknown
|
Default value : z
.object({
issuerUrl: z.url(),
})
.strict()
|
| ResolveSchemaMetadataJwtSchema |
Type : unknown
|
Default value : z
.object({
signedJwt: z.string(),
})
.strict()
|
| ResolveSchemaMetadataSchema |
Type : unknown
|
Default value : z
.object({
schemaMetadataUrl: z.url(),
})
.strict()
|
| Roles |
Type : unknown
|
Default value : (...roles: Role[]) => SetMetadata(ROLES_KEY, roles)
|
| ROLES_KEY |
Type : string
|
Default value : "roles"
|
| SESSION_STATUS_CHANGED |
Type : string
|
Default value : "session.status.changed"
|
| SessionCleanupModeSchema |
Type : unknown
|
Default value : z
.enum(["full", "anonymize"])
.describe("Cleanup strategy for expired sessions.")
|
| TENANT_RELATION_FIELDS |
Type : unknown
|
Default value : ["tenantId", "tenant"] as const
|
| TenantBaseResponseDto |
Type : unknown
|
Default value : OmitType(TenantEntity, ["clients"] as const)
|
| USERS_PROVIDER |
Type : string
|
Default value : "USERS_PROVIDER"
|
| webhookEditorSchemaBundle |
Type : unknown
|
Default value : defineEditorSchemaBundle({
domain: "webhook",
schemas: [
defineEditorSchema({
name: "WebhookConfig",
schema: WebhookConfigSchema,
}),
],
})
|