@arkyc/types 1.2.9 → 1.2.10

package/dist/access.d.mts

@@ -0,0 +1,95 @@
+import { Entity, Id, ProjectScoped } from "./common.mjs";
+
+//#region src/access.d.ts
+/**
+ * A gated project capability. Extended access generalizes what used to be the
+ * single AI-processing grant: projects request one or more capabilities, a
+ * platform admin approves each independently, and the app enforces the grant at
+ * runtime. New gated (and, later, paywalled) features are added here plus a row
+ * in {@link ACCESS_CAPABILITIES}, not a new subsystem.
+ */
+type AccessCapability = 'ai' | 'pii';
+/**
+ * The lifecycle of a capability grant. `none` is synthetic (no row yet) and only
+ * appears in API/UI responses; it is never persisted.
+ */
+type AccessGrantStatus = 'none' | 'pending' | 'granted' | 'revoked';
+/** Categories of personal data a project may request access to (PII capability). */
+type PiiCategory = 'identity' | 'address';
+/** When a project needs the PII: before the session is decided, or only after. */
+type PiiTiming = 'before' | 'after';
+/**
+ * Capability-specific request detail. Only meaningful for `pii`: what data the
+ * project needs, when, and their justification for being able to protect it.
+ */
+interface AccessGrantDetails {
+  categories?: PiiCategory[];
+  timing?: PiiTiming;
+  justification?: string | null;
+}
+/** A per-`(project, capability)` entitlement with a request/review lifecycle. */
+interface AccessGrant extends Entity, ProjectScoped {
+  capability: AccessCapability;
+  status: AccessGrantStatus;
+  details: AccessGrantDetails | null;
+  note: string | null;
+  requested_by: Id | null;
+  requested_at: string | null;
+  reviewed_by: Id | null;
+  reviewed_at: string | null;
+}
+/** Registry metadata for one capability. */
+interface AccessCapabilityMeta {
+  key: AccessCapability;
+  label: string;
+  /** Whether projects can self-request it (vs admin-only grant). */
+  requestable: boolean;
+  /** Whether a request must carry {@link AccessGrantDetails} (PII does). */
+  requiresDetails: boolean;
+}
+/**
+ * The capability registry: the single source of truth for what can be gated.
+ * Enforcement and UIs iterate this rather than hard-coding capability names.
+ * (Room is left here for future `plan`/`billable` metadata behind a paywall.)
+ */
+declare const ACCESS_CAPABILITIES: Record<AccessCapability, AccessCapabilityMeta>;
+/** All capability keys, in display order. */
+declare const ACCESS_CAPABILITY_KEYS: AccessCapability[];
+/**
+ * Identity fields extracted from the document (the `identity` PII category).
+ */
+interface ExtractedIdentity {
+  first_name: string | null;
+  last_name: string | null;
+  full_name: string | null;
+  date_of_birth: string | null;
+  document_number: string | null;
+  expiry_date: string | null;
+  nationality: string | null;
+}
+/**
+ * Residential address fields (the `address` PII category).
+ */
+interface ExtractedAddress {
+  line1: string | null;
+  line2: string | null;
+  city: string | null;
+  region: string | null;
+  postal_code: string | null;
+  country: string | null;
+  latitude: number | null;
+  longitude: number | null;
+}
+/**
+ * The extracted personal data a project may read once granted the `pii`
+ * capability. Only the granted {@link PiiCategory | categories} are present, and
+ * (for `after` timing) only once the session is decided. Absent entirely when
+ * the project has no granted PII entitlement.
+ */
+interface ExtractedData {
+  identity?: ExtractedIdentity;
+  address?: ExtractedAddress;
+}
+//#endregion
+export { ACCESS_CAPABILITIES, ACCESS_CAPABILITY_KEYS, AccessCapability, AccessCapabilityMeta, AccessGrant, AccessGrantDetails, AccessGrantStatus, ExtractedAddress, ExtractedData, ExtractedIdentity, PiiCategory, PiiTiming };
+//# sourceMappingURL=access.d.mts.map

package/dist/access.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"access.d.mts","names":[],"sources":["../src/access.ts"],"mappings":";;;;;AASA;;;;AAA4B;KAAhB,gBAAA;;;;AAMiB;KAAjB,iBAAA;;KAGA,WAAA;;KAGA,SAAA;AAAZ;;;;AAAA,UAMiB,kBAAA;EACf,UAAA,GAAa,WAAA;EACb,MAAA,GAAS,SAAS;EAClB,aAAA;AAAA;;UAIe,WAAA,SAAoB,MAAA,EAAQ,aAAA;EAC3C,UAAA,EAAY,gBAAA;EACZ,MAAA,EAAQ,iBAAA;EACR,OAAA,EAAS,kBAAA;EACT,IAAA;EACA,YAAA,EAAc,EAAA;EACd,YAAA;EACA,WAAA,EAAa,EAAA;EACb,WAAA;AAAA;;UAIe,oBAAA;EACf,GAAA,EAAK,gBAAgB;EACrB,KAAA;EAdmC;EAgBnC,WAAA;EAhBwD;EAkBxD,eAAA;AAAA;;;;;;cAQW,mBAAA,EAAqB,MAAA,CAAO,gBAAA,EAAkB,oBAAA;;cAM9C,sBAAA,EAAwB,gBAAgB;;;;UAKpC,iBAAA;EACf,UAAA;EACA,SAAA;EACA,SAAA;EACA,aAAA;EACA,eAAA;EACA,WAAA;EACA,WAAA;AAAA;;;;UAMe,gBAAA;EACf,KAAA;EACA,KAAA;EACA,IAAA;EACA,MAAA;EACA,WAAA;EACA,OAAA;EACA,QAAA;EACA,SAAA;AAAA;;;;;;;UASe,aAAA;EACf,QAAA,GAAW,iBAAA;EACX,OAAA,GAAU,gBAAgB;AAAA"}

package/dist/access.mjs

@@ -0,0 +1,26 @@
+//#region src/access.ts
+/**
+* The capability registry: the single source of truth for what can be gated.
+* Enforcement and UIs iterate this rather than hard-coding capability names.
+* (Room is left here for future `plan`/`billable` metadata behind a paywall.)
+*/
+const ACCESS_CAPABILITIES = {
+	ai: {
+		key: "ai",
+		label: "AI document processing",
+		requestable: true,
+		requiresDetails: false
+	},
+	pii: {
+		key: "pii",
+		label: "Extracted PII access",
+		requestable: true,
+		requiresDetails: true
+	}
+};
+/** All capability keys, in display order. */
+const ACCESS_CAPABILITY_KEYS = ["ai", "pii"];
+//#endregion
+export { ACCESS_CAPABILITIES, ACCESS_CAPABILITY_KEYS };
+
+//# sourceMappingURL=access.mjs.map

package/dist/access.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"access.mjs","names":[],"sources":["../src/access.ts"],"sourcesContent":["import type { Entity, Id, ProjectScoped } from './common'\n\n/**\n * A gated project capability. Extended access generalizes what used to be the\n * single AI-processing grant: projects request one or more capabilities, a\n * platform admin approves each independently, and the app enforces the grant at\n * runtime. New gated (and, later, paywalled) features are added here plus a row\n * in {@link ACCESS_CAPABILITIES}, not a new subsystem.\n */\nexport type AccessCapability = 'ai' | 'pii'\n\n/**\n * The lifecycle of a capability grant. `none` is synthetic (no row yet) and only\n * appears in API/UI responses; it is never persisted.\n */\nexport type AccessGrantStatus = 'none' | 'pending' | 'granted' | 'revoked'\n\n/** Categories of personal data a project may request access to (PII capability). */\nexport type PiiCategory = 'identity' | 'address'\n\n/** When a project needs the PII: before the session is decided, or only after. */\nexport type PiiTiming = 'before' | 'after'\n\n/**\n * Capability-specific request detail. Only meaningful for `pii`: what data the\n * project needs, when, and their justification for being able to protect it.\n */\nexport interface AccessGrantDetails {\n  categories?: PiiCategory[]\n  timing?: PiiTiming\n  justification?: string | null\n}\n\n/** A per-`(project, capability)` entitlement with a request/review lifecycle. */\nexport interface AccessGrant extends Entity, ProjectScoped {\n  capability: AccessCapability\n  status: AccessGrantStatus\n  details: AccessGrantDetails | null\n  note: string | null\n  requested_by: Id | null\n  requested_at: string | null\n  reviewed_by: Id | null\n  reviewed_at: string | null\n}\n\n/** Registry metadata for one capability. */\nexport interface AccessCapabilityMeta {\n  key: AccessCapability\n  label: string\n  /** Whether projects can self-request it (vs admin-only grant). */\n  requestable: boolean\n  /** Whether a request must carry {@link AccessGrantDetails} (PII does). */\n  requiresDetails: boolean\n}\n\n/**\n * The capability registry: the single source of truth for what can be gated.\n * Enforcement and UIs iterate this rather than hard-coding capability names.\n * (Room is left here for future `plan`/`billable` metadata behind a paywall.)\n */\nexport const ACCESS_CAPABILITIES: Record<AccessCapability, AccessCapabilityMeta> = {\n  ai: { key: 'ai', label: 'AI document processing', requestable: true, requiresDetails: false },\n  pii: { key: 'pii', label: 'Extracted PII access', requestable: true, requiresDetails: true },\n}\n\n/** All capability keys, in display order. */\nexport const ACCESS_CAPABILITY_KEYS: AccessCapability[] = ['ai', 'pii']\n\n/**\n * Identity fields extracted from the document (the `identity` PII category).\n */\nexport interface ExtractedIdentity {\n  first_name: string | null\n  last_name: string | null\n  full_name: string | null\n  date_of_birth: string | null\n  document_number: string | null\n  expiry_date: string | null\n  nationality: string | null\n}\n\n/**\n * Residential address fields (the `address` PII category).\n */\nexport interface ExtractedAddress {\n  line1: string | null\n  line2: string | null\n  city: string | null\n  region: string | null\n  postal_code: string | null\n  country: string | null\n  latitude: number | null\n  longitude: number | null\n}\n\n/**\n * The extracted personal data a project may read once granted the `pii`\n * capability. Only the granted {@link PiiCategory | categories} are present, and\n * (for `after` timing) only once the session is decided. Absent entirely when\n * the project has no granted PII entitlement.\n */\nexport interface ExtractedData {\n  identity?: ExtractedIdentity\n  address?: ExtractedAddress\n}\n"],"mappings":";;;;;;AA4DA,MAAa,sBAAsE;CACjF,IAAI;EAAE,KAAK;EAAM,OAAO;EAA0B,aAAa;EAAM,iBAAiB;CAAM;CAC5F,KAAK;EAAE,KAAK;EAAO,OAAO;EAAwB,aAAa;EAAM,iBAAiB;CAAK;AAC7F;;AAGA,MAAa,yBAA6C,CAAC,MAAM,KAAK"}

package/dist/index.d.mts

@@ -11,7 +11,8 @@ import { AddressMethodResult, AddressResultData, AddressVerification, DocumentCa
 import { Review, ReviewAction, ReviewNote } from "./review.mjs";
 import { WebhookChecks, WebhookDelivery, WebhookDeliveryStatus, WebhookEndpoint, WebhookEndpointStatus, WebhookEvent, WebhookEventName } from "./webhook.mjs";
 import { ActorType, AuditLog } from "./audit.mjs";
+import { ACCESS_CAPABILITIES, ACCESS_CAPABILITY_KEYS, AccessCapability, AccessCapabilityMeta, AccessGrant, AccessGrantDetails, AccessGrantStatus, ExtractedAddress, ExtractedData, ExtractedIdentity, PiiCategory, PiiTiming } from "./access.mjs";
 import { CreateSessionParams, SdkOptions, SessionResource } from "./sdk.mjs";
 import { WidgetMode, WidgetOptions, WidgetResult, WidgetStep } from "./widget.mjs";
 import { ApiErrorKey } from "./errors.mjs";
-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 };
+export { ACCESS_CAPABILITIES, ACCESS_CAPABILITY_KEYS, ADDRESS_METHODS, AVAILABLE_WORKFLOW_STEP_KEYS, AccessCapability, AccessCapabilityMeta, AccessGrant, AccessGrantDetails, AccessGrantStatus, 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, ExtractedAddress, ExtractedData, ExtractedIdentity, 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, PiiCategory, PiiTiming, 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 };

package/dist/index.mjs

@@ -1,4 +1,5 @@
 import { DEFAULT_GLOBAL_SETTINGS } from "./settings.mjs";
 import { REALTIME_EVENT, parseRealtimeChannel, realtimeChannels } from "./realtime.mjs";
 import { ADDRESS_METHODS, AVAILABLE_WORKFLOW_STEP_KEYS, DEFAULT_ADDRESS_CONFIG, DEFAULT_WORKFLOW_CONFIG, WORKFLOW_STEP_KEYS, workflowAddressConfig, workflowEnabledSteps, workflowEnables, workflowRunsOcr } from "./workflow.mjs";
-export { ADDRESS_METHODS, AVAILABLE_WORKFLOW_STEP_KEYS, DEFAULT_ADDRESS_CONFIG, DEFAULT_GLOBAL_SETTINGS, DEFAULT_WORKFLOW_CONFIG, REALTIME_EVENT, WORKFLOW_STEP_KEYS, parseRealtimeChannel, realtimeChannels, workflowAddressConfig, workflowEnabledSteps, workflowEnables, workflowRunsOcr };
+import { ACCESS_CAPABILITIES, ACCESS_CAPABILITY_KEYS } from "./access.mjs";
+export { ACCESS_CAPABILITIES, ACCESS_CAPABILITY_KEYS, ADDRESS_METHODS, AVAILABLE_WORKFLOW_STEP_KEYS, DEFAULT_ADDRESS_CONFIG, DEFAULT_GLOBAL_SETTINGS, DEFAULT_WORKFLOW_CONFIG, REALTIME_EVENT, WORKFLOW_STEP_KEYS, parseRealtimeChannel, realtimeChannels, workflowAddressConfig, workflowEnabledSteps, workflowEnables, workflowRunsOcr };

package/dist/rbac.d.mts

@@ -18,9 +18,9 @@ type SystemRoleSlug = 'owner' | 'admin' | 'reviewer' | 'developer' | 'readonly';
  * These gate the super-admin surface above organizations and are only ever granted
  * through {@link AdminPermission} (never an organization role). Rows carry `admin: true`.
  */
-type AdminPermissionKey = 'admin.organizations.view' | 'admin.organizations.manage' | 'admin.users.view' | 'admin.users.manage' | 'admin.settings.view' | 'admin.settings.update' | 'admin.audit.view' | 'admin.billing.view' | 'admin.billing.update' | 'admin.ai_processing.view' | 'admin.ai_processing.manage';
+type AdminPermissionKey = 'admin.organizations.view' | 'admin.organizations.manage' | 'admin.users.view' | 'admin.users.manage' | 'admin.settings.view' | 'admin.settings.update' | 'admin.audit.view' | 'admin.billing.view' | 'admin.billing.update' | 'admin.extended_access.view' | 'admin.extended_access.manage';
 /** The domain groups platform-admin permissions are organised under. */
-type AdminPermissionGroup = 'admin.organizations' | 'admin.users' | 'admin.settings' | 'admin.audit' | 'admin.billing' | 'admin.ai_processing';
+type AdminPermissionGroup = 'admin.organizations' | 'admin.users' | 'admin.settings' | 'admin.audit' | 'admin.billing' | 'admin.extended_access';
 /** Any permission string, organization- or platform-scope. */
 type AnyPermissionKey = PermissionKey | AdminPermissionKey;
 /** Any permission group, organization- or platform-scope. */

package/dist/sdk.d.mts

@@ -1,5 +1,6 @@
 import { Metadata } from "./common.mjs";
 import { VerificationDecision, VerificationStatus } from "./verification.mjs";
+import { ExtractedData } from "./access.mjs";
 
 //#region src/sdk.d.ts
 /** Options for constructing the server SDK client (`new Arkyc(...)`). */
@@ -26,6 +27,8 @@ interface SessionResource {
   decision: VerificationDecision | null;
   /** Short-lived client token for launching the widget (create response only). */
   client_token?: string;
+  /** Extracted PII, present only when the project holds a granted `pii` entitlement. */
+  extracted?: ExtractedData | null;
   expires_at: string;
   created_at: string;
 }

package/dist/sdk.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"sdk.d.mts","names":[],"sources":["../src/sdk.ts"],"mappings":";;;;;UAIiB,UAAA;EAAA;EAEf,SAAA;;EAEA,OAAA;EAFA;EAIA,SAAA;AAAA;;UAIe,mBAAA;EACf,aAAA;EACA,QAAA,GAAW,QAAQ;;EAEnB,gBAAA;AAAA;;UAIe,eAAA;EACf,EAAA;EACA,MAAA,EAAQ,kBAAA;EACR,cAAA;EACA,QAAA,EAAU,oBAAoB;EAJA;EAM9B,YAAA;EACA,UAAA;EACA,UAAA;AAAA"}
+{"version":3,"file":"sdk.d.mts","names":[],"sources":["../src/sdk.ts"],"mappings":";;;;;;UAKiB,UAAA;EAAA;EAEf,SAAA;;EAEA,OAAA;EAFA;EAIA,SAAA;AAAA;;UAIe,mBAAA;EACf,aAAA;EACA,QAAA,GAAW,QAAQ;;EAEnB,gBAAA;AAAA;;UAIe,eAAA;EACf,EAAA;EACA,MAAA,EAAQ,kBAAA;EACR,cAAA;EACA,QAAA,EAAU,oBAAA;EAJoB;EAM9B,YAAA;EAJQ;EAMR,SAAA,GAAY,aAAA;EACZ,UAAA;EACA,UAAA;AAAA"}

package/dist/settings.d.mts

@@ -35,6 +35,15 @@ interface GlobalSettings {
   capture: {
     model: CaptureModel;
   };
+  /** Signed session-asset links (captured document/selfie images). */
+  assets: {
+    /**
+     * How long a signed asset URL stays valid, in seconds. The link embeds its
+     * own expiry, so a change only affects newly minted URLs; existing links
+     * keep their original window. Bounded to [60, 86400] (1 minute to 24 hours).
+     */
+    url_ttl_seconds: number;
+  };
 }
 /** The persisted singleton row backing {@link GlobalSettings}. */
 interface GlobalSetting extends Entity {

package/dist/settings.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"settings.d.mts","names":[],"sources":["../src/settings.ts"],"mappings":";;;;;AASA;;;;AAA6B;KAAjB,iBAAA;;;;AAOY;AAOxB;KAPY,YAAA;;;;;;UAOK,cAAA;EASf;EAPA,QAAA;IACE,IAAA;IACA,aAAA,iBAUA;IARA,eAAA;EAAA;EAQmB;EALrB,QAAA;IACE,SAAA,EAAW,iBAAA;EAAA;EAS8B;EAN3C,OAAA;IACE,KAAA,EAAO,YAAY;EAAA;AAAA;AAMG;AAAA,UADT,aAAA,SAAsB,MAAM;EAC3C,QAAA,EAAU,cAAA;AAAA;;cAIC,uBAAA,EAAyB,cAYrC"}
+{"version":3,"file":"settings.d.mts","names":[],"sources":["../src/settings.ts"],"mappings":";;;;;AASA;;;;AAA6B;KAAjB,iBAAA;;;;AAOY;AAOxB;KAPY,YAAA;;;;;;UAOK,cAAA;EASf;EAPA,QAAA;IACE,IAAA;IACA,aAAA,iBAUA;IARA,eAAA;EAAA;EAiBA;EAdF,QAAA;IACE,SAAA,EAAW,iBAAA;EAAA;EAkBgB;EAf7B,OAAA;IACE,KAAA,EAAO,YAAY;EAAA;EAerB;EAZA,MAAA;IAYwB;AAAA;AAI1B;;;IAVI,eAAA;EAAA;AAAA;;UAKa,aAAA,SAAsB,MAAM;EAC3C,QAAA,EAAU,cAAA;AAAA;;cAIC,uBAAA,EAAyB,cAerC"}

package/dist/settings.mjs

@@ -7,7 +7,8 @@ const DEFAULT_GLOBAL_SETTINGS = {
 		signups_enabled: true
 	},
 	realtime: { transport: "off" },
-	capture: { model: "passive" }
+	capture: { model: "passive" },
+	assets: { url_ttl_seconds: 1800 }
 };
 //#endregion
 export { DEFAULT_GLOBAL_SETTINGS };

package/dist/settings.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"settings.mjs","names":[],"sources":["../src/settings.ts"],"sourcesContent":["import type { Entity } from './common'\n\n/**\n * Realtime transport for verification events (Phase 16). `pusher` covers both\n * hosted Pusher Channels (default, via a cluster) and self-hosted soketi (opt-in,\n * via a host) — they share the Pusher protocol. `polling` carries no push\n * transport: clients poll the session endpoint instead (a universal fallback that\n * needs no infrastructure). `off` disables live updates entirely.\n */\nexport type RealtimeTransport = 'pusher' | 'firebase' | 'polling' | 'off'\n\n/**\n * Which capture/liveness flow the widget offers (Phase 17). `passive` = the\n * current selfie flow; `active` = guided active-liveness challenges; `both` =\n * offer active, falling back to passive on failure/unsupported devices.\n */\nexport type CaptureModel = 'passive' | 'active' | 'both'\n\n/**\n * Platform-wide settings, managed by platform admins on the `/admin` surface and\n * read by the app at runtime. A single typed record (see {@link GlobalSetting}),\n * always merged over {@link DEFAULT_GLOBAL_SETTINGS} so every key is present.\n */\nexport interface GlobalSettings {\n  /** Branding/basics for the whole platform. */\n  platform: {\n    name: string\n    support_email: string | null\n    /** Whether new organization sign-ups are accepted. */\n    signups_enabled: boolean\n  }\n  /** Realtime delivery configuration (consumed in Phase 16). */\n  realtime: {\n    transport: RealtimeTransport\n  }\n  /** Default capture/liveness flow offered to widgets (Phase 17). */\n  capture: {\n    model: CaptureModel\n  }\n}\n\n/** The persisted singleton row backing {@link GlobalSettings}. */\nexport interface GlobalSetting extends Entity {\n  settings: GlobalSettings\n}\n\n/** Defaults applied when a settings key is unset. */\nexport const DEFAULT_GLOBAL_SETTINGS: GlobalSettings = {\n  platform: {\n    name: 'Arkyc',\n    support_email: null,\n    signups_enabled: true,\n  },\n  realtime: {\n    transport: 'off',\n  },\n  capture: {\n    model: 'passive',\n  },\n}\n"],"mappings":";;AA+CA,MAAa,0BAA0C;CACrD,UAAU;EACR,MAAM;EACN,eAAe;EACf,iBAAiB;CACnB;CACA,UAAU,EACR,WAAW,MACb;CACA,SAAS,EACP,OAAO,UACT;AACF"}
+{"version":3,"file":"settings.mjs","names":[],"sources":["../src/settings.ts"],"sourcesContent":["import type { Entity } from './common'\n\n/**\n * Realtime transport for verification events (Phase 16). `pusher` covers both\n * hosted Pusher Channels (default, via a cluster) and self-hosted soketi (opt-in,\n * via a host) — they share the Pusher protocol. `polling` carries no push\n * transport: clients poll the session endpoint instead (a universal fallback that\n * needs no infrastructure). `off` disables live updates entirely.\n */\nexport type RealtimeTransport = 'pusher' | 'firebase' | 'polling' | 'off'\n\n/**\n * Which capture/liveness flow the widget offers (Phase 17). `passive` = the\n * current selfie flow; `active` = guided active-liveness challenges; `both` =\n * offer active, falling back to passive on failure/unsupported devices.\n */\nexport type CaptureModel = 'passive' | 'active' | 'both'\n\n/**\n * Platform-wide settings, managed by platform admins on the `/admin` surface and\n * read by the app at runtime. A single typed record (see {@link GlobalSetting}),\n * always merged over {@link DEFAULT_GLOBAL_SETTINGS} so every key is present.\n */\nexport interface GlobalSettings {\n  /** Branding/basics for the whole platform. */\n  platform: {\n    name: string\n    support_email: string | null\n    /** Whether new organization sign-ups are accepted. */\n    signups_enabled: boolean\n  }\n  /** Realtime delivery configuration (consumed in Phase 16). */\n  realtime: {\n    transport: RealtimeTransport\n  }\n  /** Default capture/liveness flow offered to widgets (Phase 17). */\n  capture: {\n    model: CaptureModel\n  }\n  /** Signed session-asset links (captured document/selfie images). */\n  assets: {\n    /**\n     * How long a signed asset URL stays valid, in seconds. The link embeds its\n     * own expiry, so a change only affects newly minted URLs; existing links\n     * keep their original window. Bounded to [60, 86400] (1 minute to 24 hours).\n     */\n    url_ttl_seconds: number\n  }\n}\n\n/** The persisted singleton row backing {@link GlobalSettings}. */\nexport interface GlobalSetting extends Entity {\n  settings: GlobalSettings\n}\n\n/** Defaults applied when a settings key is unset. */\nexport const DEFAULT_GLOBAL_SETTINGS: GlobalSettings = {\n  platform: {\n    name: 'Arkyc',\n    support_email: null,\n    signups_enabled: true,\n  },\n  realtime: {\n    transport: 'off',\n  },\n  capture: {\n    model: 'passive',\n  },\n  assets: {\n    url_ttl_seconds: 1800,\n  },\n}\n"],"mappings":";;AAwDA,MAAa,0BAA0C;CACrD,UAAU;EACR,MAAM;EACN,eAAe;EACf,iBAAiB;CACnB;CACA,UAAU,EACR,WAAW,MACb;CACA,SAAS,EACP,OAAO,UACT;CACA,QAAQ,EACN,iBAAiB,KACnB;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkyc/types",
-  "version": "1.2.9",
+  "version": "1.2.10",
   "description": "Shared domain types and contracts for Arkyc",
   "license": "MIT",
   "keywords": [