nucleus-core-ts 0.9.968 → 0.9.970

package/dist/src/Client/ApiCaller/index.d.ts

@@ -11,5 +11,5 @@ export { createServerFactory, type ServerFactory } from './server';
  * in the app and not the one that holds the accounts.
  */
 export { SYSTEM_TABLES } from './system-tables';
-export type { AdminCreateUserPayload, AdminCreateUserResponse, AlertEvent, AlertType, AllGeneratedEndpoints, AllGeneratedEndpointsWithConfig, AllGeneratedEndpointsWithEntityTypes, ApiCallerConfig, ApiResponse, ApplicationMetrics, AuditCategory, AuditSeverity, AuthEndpointDefinitions, AuthenticationConfig, AuthFeatureConfig, AuthFeatureKey, BaseErrorResponse, BulkCreateUsersPayload, BulkCreateUsersResponse, BulkEndpointKey, ChangeUserIdPayload, ChangeUserIdResponse, ChatActionResponse, ChatAttachmentDTO, ChatConversationDTO, ChatConversationListResponse, ChatConversationResponse, ChatCreateConversationPayload, ChatEndpointDefinitions, ChatMessageDTO, ChatMessageListResponse, ChatMessageResponse, ChatParticipantDTO, ChatParticipantsResponse, ChatReadResponse, ChatSendMessagePayload, CheckSubdomainPayload, CheckSubdomainResponse, ClientHookConfig, CohortBulkOpsResponse, CohortEndpointDefinitions, CohortPayload, CohortUpdatePayload, ConfigEndpointDefinitions, ConfigEnvResponse, ConfigGetResponse, ConfigOverridesClearResponse, ConfigOverridesGetResponse, ConfigRestartPayload, ConfigRestartResponse, ConfigSectionGetResponse, ConfigSectionMeta, ConfigSectionsListResponse, ConfigSectionUpdatePayload, ConfigSectionUpdateResponse, CookieStore, CreateHostnamePayload, CreateHostnameResponse, CreateRegistrationPayload, DatabaseMetrics, DeleteResponse, DnsInstructionDTO, DomainEndpointDefinitions, DomainHostnameDTO, DomainHostnameListResponse, DomainHostnameResponse, DomainInstructionsResponse, DomainRegistrationDTO, DomainRegistrationListResponse, DomainRegistrationResponse, DomainResolutionDTO, DomainResolveResponse, EndpointAction, EndpointActions, EndpointDefinition, EndpointMethod, EndpointState, EntityEndpointKey, EntityRecord, ExtraEndpoints, FlowDeleteResponse, FlowDetailResponse, FlowListResponse, FlowPublishResponse, FlowSavePayload, FlowSaveResponse, GeneratedAuthEndpoints, GeneratedEndpointsFromConfig, HeadersStore, HttpMethod, ImpersonatePayload, ImpersonateResponse, ImpersonateStopResponse, InferEntity, ListResponse, LiveCpuLog, LiveDaprEvent, LiveDaprEventType, LiveMemoryLog, LiveMonitoringChangeSettingsPayload, LiveMonitoringConfigs, LiveMonitoringLogLimits, LiveMonitoringLogsResponse, LiveMonitoringSettingsResponse, LiveMonitoringStreamSnapshot, LiveMonitoringStreamUpdate, LiveRequest, LiveWorkerInfo, LiveWsEvent, LiveWsEventType, LoginPayload, LoginSuccess, LoginSuccessData, LogLevel, MagicLinkPayload, MarketplaceBalanceDTO, MarketplaceBalanceResponse, MarketplaceEndpointDefinitions, MeResponse, MeResponseData, MeSuccessResponse, MetricPeak, MonitoringAcknowledgeResponse, MonitoringAlertsResponse, MonitoringEndpointDefinitions, MonitoringHistoryResponse, MonitoringSnapshot, MonitoringSnapshotResponse, MutationResponse, NotificationListResponse, NotificationSeenAllResponse, NotificationSeenResponse, NotificationUnseenCountResponse, OpenDisputePayload, PaginationMeta, PasswordChangePayload, PasswordResetConfirmPayload, PasswordResetRequestPayload, PasswordResetResponse, PasswordSetPayload, PaymentDisputeDTO, PaymentDisputeListResponse, PaymentDisputeResponse, PaymentSplitDTO, PaymentSplitListResponse, PaymentSplitResponse, PayoutRequestDTO, PayoutRequestListResponse, PayoutRequestResponse, ProvisionTenantPayload, ProvisionTenantResponse, RecordSplitPayload, RedisMetrics, RefreshSuccess, RefreshSuccessData, RegisterPayload, RegisterSuccess, RegisterSuccessData, RequestPayoutPayload, ResolvedEnvEntry, SelfSignupPayload, SelfSignupResponse, ServerFactoryConfig, ServerLogPage, ServerLogQuery, ServerLogRecord, ServerLogSource, ServerLogsResponse, SessionApprovePayload, SessionApproveResponse, SessionCurrentResponse, SessionInfo, SessionRejectPayload, SessionRejectResponse, SessionRevokeAllPayload, SessionRevokeAllResponse, SessionRevokePayload, SessionRevokeResponse, SessionStatsResponse, SessionsListResponse, SessionsPendingResponse, SettlementPolicyDTO, SettlementPolicyPayload, SettlementPolicyResponse, SingleResponse, StandardQueryParams, StandardReturn, StartOptions, SystemAddressEntity, SystemAuditLogEntity, SystemClaimEntity, SystemFileEntity, SystemMetrics, SystemMonitoringMetricEntity, SystemPhoneEntity, SystemProfileEntity, SystemRoleClaimEntity, SystemRoleEntity, SystemUserCohortEntity, SystemUserEntity, SystemUserRoleEntity, TenantDetailResponse, TenantEndpointDefinitions, TenantListItem, TenantListResponse, TenantReactivatePayload, TenantReactivateResponse, TenantSuspendPayload, TenantSuspendResponse, UserData, VerificationDecidePayload, VerificationDecideResponse, VerificationEndpointDefinitions, VerificationPendingResponse, VerificationStartPayload, VerificationStartResponse, VerificationStatusResponse, WebAuthnAuthenticationOptions, WebAuthnAuthenticationResponseJSON, WebAuthnAuthenticatorAttachment, WebAuthnAuthOptionsPayload, WebAuthnAuthOptionsResponse, WebAuthnAuthVerifyPayload, WebAuthnAuthVerifyResponse, WebAuthnCredentialSummary, WebAuthnDeviceType, WebAuthnListResponse, WebAuthnPublicKeyCredentialDescriptor, WebAuthnRegisterOptionsPayload, WebAuthnRegisterOptionsResponse, WebAuthnRegisterVerifyPayload, WebAuthnRegisterVerifyResponse, WebAuthnRegistrationOptions, WebAuthnRegistrationResponseJSON, WebAuthnRenamePayload, WebAuthnRenameResponse, WebAuthnRevokePayload, WebAuthnRevokeResponse, WebAuthnTransport, } from './types';
+export type { AdminCreateUserPayload, AdminCreateUserResponse, AdminLockUserPayload, AdminLockUserResponse, AdminMarkEmailVerifiedPayload, AdminMarkEmailVerifiedResponse, AdminUnlockUserPayload, AdminUnlockUserResponse, AlertEvent, AlertType, AllGeneratedEndpoints, AllGeneratedEndpointsWithConfig, AllGeneratedEndpointsWithEntityTypes, ApiCallerConfig, ApiResponse, ApplicationMetrics, AuditCategory, AuditSeverity, AuthEndpointDefinitions, AuthenticationConfig, AuthFeatureConfig, AuthFeatureKey, BaseErrorResponse, BulkCreateUsersPayload, BulkCreateUsersResponse, BulkEndpointKey, ChangeUserIdPayload, ChangeUserIdResponse, ChatActionResponse, ChatAttachmentDTO, ChatConversationDTO, ChatConversationListResponse, ChatConversationResponse, ChatCreateConversationPayload, ChatEndpointDefinitions, ChatMessageDTO, ChatMessageListResponse, ChatMessageResponse, ChatParticipantDTO, ChatParticipantsResponse, ChatReadResponse, ChatSendMessagePayload, CheckSubdomainPayload, CheckSubdomainResponse, ClientHookConfig, CohortBulkOpsResponse, CohortEndpointDefinitions, CohortPayload, CohortUpdatePayload, ConfigEndpointDefinitions, ConfigEnvResponse, ConfigGetResponse, ConfigOverridesClearResponse, ConfigOverridesGetResponse, ConfigRestartPayload, ConfigRestartResponse, ConfigSectionGetResponse, ConfigSectionMeta, ConfigSectionsListResponse, ConfigSectionUpdatePayload, ConfigSectionUpdateResponse, CookieStore, CreateHostnamePayload, CreateHostnameResponse, CreateRegistrationPayload, DatabaseMetrics, DeleteResponse, DnsInstructionDTO, DomainEndpointDefinitions, DomainHostnameDTO, DomainHostnameListResponse, DomainHostnameResponse, DomainInstructionsResponse, DomainRegistrationDTO, DomainRegistrationListResponse, DomainRegistrationResponse, DomainResolutionDTO, DomainResolveResponse, EndpointAction, EndpointActions, EndpointDefinition, EndpointMethod, EndpointState, EntityEndpointKey, EntityRecord, ExtraEndpoints, FlowDeleteResponse, FlowDetailResponse, FlowListResponse, FlowPublishResponse, FlowSavePayload, FlowSaveResponse, GeneratedAuthEndpoints, GeneratedEndpointsFromConfig, HeadersStore, HttpMethod, ImpersonatePayload, ImpersonateResponse, ImpersonateStopResponse, InferEntity, ListResponse, LiveCpuLog, LiveDaprEvent, LiveDaprEventType, LiveMemoryLog, LiveMonitoringChangeSettingsPayload, LiveMonitoringConfigs, LiveMonitoringLogLimits, LiveMonitoringLogsResponse, LiveMonitoringSettingsResponse, LiveMonitoringStreamSnapshot, LiveMonitoringStreamUpdate, LiveRequest, LiveWorkerInfo, LiveWsEvent, LiveWsEventType, LoginPayload, LoginSuccess, LoginSuccessData, LogLevel, MagicLinkPayload, MarketplaceBalanceDTO, MarketplaceBalanceResponse, MarketplaceEndpointDefinitions, MeResponse, MeResponseData, MeSuccessResponse, MetricPeak, MonitoringAcknowledgeResponse, MonitoringAlertsResponse, MonitoringEndpointDefinitions, MonitoringHistoryResponse, MonitoringSnapshot, MonitoringSnapshotResponse, MutationResponse, NotificationListResponse, NotificationSeenAllResponse, NotificationSeenResponse, NotificationUnseenCountResponse, OpenDisputePayload, PaginationMeta, PasswordChangePayload, PasswordResetConfirmPayload, PasswordResetRequestPayload, PasswordResetResponse, PasswordSetPayload, PaymentDisputeDTO, PaymentDisputeListResponse, PaymentDisputeResponse, PaymentSplitDTO, PaymentSplitListResponse, PaymentSplitResponse, PayoutRequestDTO, PayoutRequestListResponse, PayoutRequestResponse, ProvisionTenantPayload, ProvisionTenantResponse, RecordSplitPayload, RedisMetrics, RefreshSuccess, RefreshSuccessData, RegisterPayload, RegisterSuccess, RegisterSuccessData, RequestPayoutPayload, ResolvedEnvEntry, SelfSignupPayload, SelfSignupResponse, ServerFactoryConfig, ServerLogPage, ServerLogQuery, ServerLogRecord, ServerLogSource, ServerLogsResponse, SessionApprovePayload, SessionApproveResponse, SessionCurrentResponse, SessionInfo, SessionRejectPayload, SessionRejectResponse, SessionRevokeAllPayload, SessionRevokeAllResponse, SessionRevokePayload, SessionRevokeResponse, SessionStatsResponse, SessionsListResponse, SessionsPendingResponse, SettlementPolicyDTO, SettlementPolicyPayload, SettlementPolicyResponse, SingleResponse, StandardQueryParams, StandardReturn, StartOptions, SystemAddressEntity, SystemAuditLogEntity, SystemClaimEntity, SystemFileEntity, SystemMetrics, SystemMonitoringMetricEntity, SystemPhoneEntity, SystemProfileEntity, SystemRoleClaimEntity, SystemRoleEntity, SystemUserCohortEntity, SystemUserEntity, SystemUserRoleEntity, TenantDetailResponse, TenantEndpointDefinitions, TenantListItem, TenantListResponse, TenantReactivatePayload, TenantReactivateResponse, TenantSuspendPayload, TenantSuspendResponse, UserData, VerificationDecidePayload, VerificationDecideResponse, VerificationEndpointDefinitions, VerificationPendingResponse, VerificationStartPayload, VerificationStartResponse, VerificationStatusResponse, WebAuthnAuthenticationOptions, WebAuthnAuthenticationResponseJSON, WebAuthnAuthenticatorAttachment, WebAuthnAuthOptionsPayload, WebAuthnAuthOptionsResponse, WebAuthnAuthVerifyPayload, WebAuthnAuthVerifyResponse, WebAuthnCredentialSummary, WebAuthnDeviceType, WebAuthnListResponse, WebAuthnPublicKeyCredentialDescriptor, WebAuthnRegisterOptionsPayload, WebAuthnRegisterOptionsResponse, WebAuthnRegisterVerifyPayload, WebAuthnRegisterVerifyResponse, WebAuthnRegistrationOptions, WebAuthnRegistrationResponseJSON, WebAuthnRenamePayload, WebAuthnRenameResponse, WebAuthnRevokePayload, WebAuthnRevokeResponse, WebAuthnTransport, } from './types';
 export { AUTH_ENDPOINT_CONFIGS, AUTH_ENDPOINTS, CHAT_ENDPOINTS, COHORT_ENDPOINTS, CONFIG_ENDPOINTS, DOMAIN_ENDPOINTS, MARKETPLACE_ENDPOINTS, MONITORING_ENDPOINTS, PAYMENT_ENDPOINTS, TENANT_ENDPOINTS, VERIFICATION_ENDPOINTS, } from './types';

package/dist/src/Client/ApiCaller/server.d.ts

@@ -1,3 +1,12 @@
 import type { ApiResponse, CookieStore, EndpointDefinition, HeadersStore, ServerFactoryConfig } from './types';
+/**
+ * Give a `{success, …}` response the same `{success, message, data}` shape the
+ * rest of the API already has — without swallowing the fields that steer the
+ * caller.
+ *
+ * A response that already carries `data` is left exactly as it is; so is
+ * anything that is not a plain object.
+ */
+export declare function normalizeResponseShape(response: unknown): unknown;
 export declare function createServerFactory<TEndpoints extends Record<string, EndpointDefinition>>(endpoints: TEndpoints, config: ServerFactoryConfig, getCookies: () => Promise<CookieStore>, getHeaders: () => Promise<HeadersStore>): <K extends keyof TEndpoints & string>(endpointKey: K, payload: TEndpoints[K]["_payload"]) => Promise<ApiResponse<TEndpoints[K]["_success"], TEndpoints[K]["_error"]>>;
 export type ServerFactory<TEndpoints extends Record<string, EndpointDefinition>> = ReturnType<typeof createServerFactory<TEndpoints>>;

package/dist/src/Client/ApiCaller/types.d.ts

@@ -12,6 +12,16 @@ export interface ApiResponse<TSuccess, TError> {
     errors?: TError;
     code?: number | null;
     message?: string;
+    /**
+     * The server's id for this request, present on failures.
+     *
+     * The API deliberately does not return the reason a 5xx happened — it can
+     * carry SQL, schema, paths, secrets — and logs it instead. This is the thread
+     * between the two: quote it and the reason is one grep away. Without it
+     * "Internal Server Error" on screen and the explanation in the log had
+     * nothing joining them.
+     */
+    requestId?: string;
 }
 export type EndpointMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
 export interface EndpointDefinition<TPayload = unknown, TSuccess = unknown, TError = unknown> {

package/dist/src/ElysiaPlugin/routes/auth/impersonationCookies.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The cookies an impersonation session leaves in the browser.
+ *
+ * Three of them are labels the UI reads to show "you are viewing as …". The
+ * fourth, `nucleus_imp_sig`, is not a label: it is `signRefreshToken(godminId)`,
+ * a real refresh token with a real lifetime, and `/auth/admin/impersonate/stop`
+ * mints a full administrator session for whoever presents it.
+ *
+ * Logging out cleared the three auth cookies and left all four of these behind.
+ * An administrator who started an impersonation, then logged out, walked away
+ * from a browser still holding a thirty-day key back into their own account —
+ * on a shared or kiosk machine that is the whole story. They are listed here so
+ * both the stop handler and the logout handler clear the same set, and so the
+ * next cookie added to the flow has one place to be added to.
+ */
+export declare const IMPERSONATION_COOKIE_NAMES: readonly ["nucleus_impersonating_as", "nucleus_godmin_id", "nucleus_impersonating_email", "nucleus_imp_sig"];

package/dist/src/types.d.ts

@@ -517,6 +517,16 @@ export interface NucleusConfigOptions {
             passwordTools?: {
                 enabled?: boolean;
             };
+            /**
+             * Viewing the product as another account. On by default.
+             *
+             * The route layer already honoured this key; it was missing from the type,
+             * so anything reading the config in a type-checked context could not see
+             * it.
+             */
+            impersonate?: {
+                enabled?: boolean;
+            };
         };
         register?: {
             route?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nucleus-core-ts",
-	"version": "0.9.968",
+	"version": "0.9.970",
 	"description": "Production-ready, enterprise-grade TypeScript framework for building multi-tenant APIs",
 	"author": "Hidayet Can Özcan <hidayetcan@gmail.com>",
 	"license": "SEE LICENSE IN LICENSE",

package/scripts/build.ts

@@ -383,12 +383,9 @@ async function removeSourceMaps() {
   // to have GNU findutils on PATH.
   let removed = 0
   const walk = async (dir: string): Promise<void> => {
-    let entries: Awaited<ReturnType<typeof readdir>>
-    try {
-      entries = await readdir(dir, { withFileTypes: true })
-    } catch {
-      return // the directory is optional; nothing to clean if it was never built
-    }
+    // An unreadable directory is not an error here: nothing to clean if it was
+    // never built.
+    const entries = await readdir(dir, { withFileTypes: true }).catch(() => [])
     for (const entry of entries) {
       const full = join(dir, entry.name)
       if (entry.isDirectory()) {