@arkyc/types 1.2.4 → 1.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/errors.d.mts +16 -0
- package/dist/errors.d.mts.map +1 -0
- package/dist/index.d.mts +2 -1
- package/package.json +1 -1
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
//#region src/errors.d.ts
|
|
2
|
+
/**
|
|
3
|
+
* Stable, machine-readable error keys that Arkyc **deliberately raises**.
|
|
4
|
+
*
|
|
5
|
+
* These form a client-facing contract: the human-readable `message` may change,
|
|
6
|
+
* but the `error` key on a response envelope will not. Branch on the key, not
|
|
7
|
+
* the message. Responses without an `error` key are unexpected/unhandled and
|
|
8
|
+
* should be treated generically by HTTP status.
|
|
9
|
+
*
|
|
10
|
+
* The typed clients surface this as `ArkycApiError.error` (`@arkyc/sdk`) and
|
|
11
|
+
* `WidgetApiError.error` (`@arkyc/widget`).
|
|
12
|
+
*/
|
|
13
|
+
type ApiErrorKey = 'missing_client_token' | 'invalid_client_token' | 'session_expired' | 'missing_api_key' | 'invalid_api_key' | 'invalid_workflow' | 'invalid_webhook';
|
|
14
|
+
//#endregion
|
|
15
|
+
export { ApiErrorKey };
|
|
16
|
+
//# sourceMappingURL=errors.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"errors.d.mts","names":[],"sources":["../src/errors.ts"],"mappings":";;AAWA;;;;AAAuB;;;;;;KAAX,WAAA"}
|
package/dist/index.d.mts
CHANGED
|
@@ -13,4 +13,5 @@ import { WebhookChecks, WebhookDelivery, WebhookDeliveryStatus, WebhookEndpoint,
|
|
|
13
13
|
import { ActorType, AuditLog } from "./audit.mjs";
|
|
14
14
|
import { CreateSessionParams, SdkOptions, SessionResource } from "./sdk.mjs";
|
|
15
15
|
import { WidgetMode, WidgetOptions, WidgetResult, WidgetStep } from "./widget.mjs";
|
|
16
|
-
|
|
16
|
+
import { ApiErrorKey } from "./errors.mjs";
|
|
17
|
+
export { ADDRESS_METHODS, AVAILABLE_WORKFLOW_STEP_KEYS, ActorType, AddressMethod, AddressMethodResult, AddressOnFail, AddressResultData, AddressStepConfig, AddressVerification, AdminPermission, AdminPermissionGroup, AdminPermissionKey, AdminRoleSlug, AnyPermissionGroup, AnyPermissionKey, ApiErrorKey, ApiKey, ApiKeyWithSecret, AuditLog, CaptureModel, CreateSessionParams, DEFAULT_ADDRESS_CONFIG, DEFAULT_GLOBAL_SETTINGS, DEFAULT_WORKFLOW_CONFIG, DecisionReason, DocumentCapture, DocumentPortrait, DocumentType, Entity, FaceMatchCheck, FaceMatchResultData, GlobalSetting, GlobalSettings, Id, InvitationStatus, IsoDate, IsoDateTime, LivenessChallenge, LivenessCheck, LivenessMode, LivenessResultData, MembershipStatus, Metadata, OcrAuthenticity, OcrFields, OcrResult, OcrResultData, Organization, OrganizationInvitation, OrganizationMember, OrganizationScoped, OrganizationSettings, Permission, PermissionGroup, PermissionKey, PostalAddress, Project, ProjectBranding, ProjectContext, ProjectEnvironment, ProjectHandoffSettings, ProjectMember, ProjectScoped, ProjectSettings, ProjectStatus, PublicUser, REALTIME_EVENT, RealtimeEventName, RealtimeTransport, Review, ReviewAction, ReviewActionEvent, ReviewNote, Role, RolePermission, SdkOptions, SessionResource, SessionTransitionEvent, SpoofSignals, SystemRoleSlug, Timestamps, User, UserPermission, VerificationDecision, VerificationSession, VerificationStatus, VerificationThresholds, WORKFLOW_STEP_KEYS, WebhookChecks, WebhookDelivery, WebhookDeliveryStatus, WebhookEndpoint, WebhookEndpointStatus, WebhookEvent, WebhookEventName, WidgetMode, WidgetOptions, WidgetResult, WidgetStep, Workflow, WorkflowConfig, WorkflowOptions, WorkflowStep, WorkflowStepKey, parseRealtimeChannel, realtimeChannels, workflowAddressConfig, workflowEnabledSteps, workflowEnables, workflowRunsOcr };
|