@strimz/shared-types 0.1.1 → 0.2.0

package/dist/index.d.cts

@@ -1,15 +1,15 @@
 export { ArcEnvironment, EvmAddress, EvmTxHash, Id, IsoTimestamp, MerchantTier, Metadata, Mode, PaginationInput, PaymentCurrency, TokenAmount, TokenSymbol, arcEnvironmentSchema, countryCodeSchema, emailSchema, evmAddressSchema, evmTxHashSchema, httpUrlSchema, httpsUrlSchema, idSchema, isoTimestampSchema, makePaginatedSchema, merchantTierSchema, metadataSchema, modeSchema, paginationInputSchema, paymentCurrencySchema, tokenAmountSchema, tokenSymbolSchema, uintSchema } from './common.cjs';
-export { ChangeTierInput, CreateMerchantInput, InviteMemberInput, LoginInput, LoginOutput, Merchant, MerchantMember, MerchantRole, MerchantStatus, UpdateMerchantInput, changeTierInputSchema, createMerchantInputSchema, inviteMemberInputSchema, loginInputSchema, loginOutputSchema, merchantMemberSchema, merchantRoleSchema, merchantSchema, merchantStatusSchema, updateMerchantInputSchema } from './merchants.cjs';
+export { ChangeTierInput, CreateMerchantInput, DEFAULT_MERCHANT_EMAIL_PREFS, InviteMemberInput, LoginInput, LoginOutput, Merchant, MerchantBalanceView, MerchantEmailPrefs, MerchantMember, MerchantPublicBrand, MerchantRole, MerchantStatus, OnboardMerchantInput, UpdateMerchantInput, changeTierInputSchema, createMerchantInputSchema, inviteMemberInputSchema, loginInputSchema, loginOutputSchema, merchantBalanceSchema, merchantEmailPrefsSchema, merchantMemberSchema, merchantPublicBrandSchema, merchantRoleSchema, merchantSchema, merchantStatusSchema, onboardMerchantInputSchema, updateMerchantInputSchema } from './merchants.cjs';
 export { ApiKey, ApiKeyKind, ApiKeyScope, CreateApiKeyInput, CreateApiKeyOutput, RotateApiKeyInput, apiKeyKindSchema, apiKeySchema, apiKeyScopeSchema, createApiKeyInputSchema, createApiKeyOutputSchema, rotateApiKeyInputSchema } from './api-keys.cjs';
 export { Customer, UpsertCustomerInput, customerSchema, upsertCustomerInputSchema } from './customers.cjs';
-export { CreatePaymentSessionInput, PaymentSession, PaymentSessionStatus, SubmitPaymentSessionInput, createPaymentSessionInputSchema, paymentSessionSchema, paymentSessionStatusSchema, submitPaymentSessionInputSchema } from './payment-sessions.cjs';
+export { CreatePaymentSessionInput, PaymentSession, PaymentSessionStatus, SubmitPaymentSessionInput, callbackUrlSchema, createPaymentSessionInputSchema, paymentSessionSchema, paymentSessionStatusSchema, submitPaymentSessionInputSchema } from './payment-sessions.cjs';
 export { Transaction, TransactionKind, TransactionStatus, transactionKindSchema, transactionSchema, transactionStatusSchema } from './transactions.cjs';
 export { CancelSubscriptionInput, CreateSubscriptionInput, CreateSubscriptionPlanInput, Subscription, SubscriptionCharge, SubscriptionChargeOutcome, SubscriptionChargeStatus, SubscriptionInterval, SubscriptionPlan, SubscriptionPlanStatus, SubscriptionStatus, cancelSubscriptionInputSchema, createSubscriptionInputSchema, createSubscriptionPlanInputSchema, subscriptionChargeOutcomeSchema, subscriptionChargeSchema, subscriptionChargeStatusSchema, subscriptionIntervalSchema, subscriptionPlanSchema, subscriptionPlanStatusSchema, subscriptionSchema, subscriptionStatusSchema } from './subscriptions.cjs';
-export { CreateRefundInput, Refund, RefundReason, RefundStatus, SubmitRefundSignatureInput, createRefundInputSchema, refundReasonSchema, refundSchema, refundStatusSchema, submitRefundSignatureInputSchema } from './refunds.cjs';
-export { CreateWebhookEndpointInput, CreateWebhookEndpointOutput, ReplayDeliveryInput, WebhookDelivery, WebhookDeliveryStatus, WebhookEndpoint, WebhookEndpointStatus, WebhookEventName, createWebhookEndpointInputSchema, createWebhookEndpointOutputSchema, replayDeliveryInputSchema, webhookDeliverySchema, webhookDeliveryStatusSchema, webhookEndpointSchema, webhookEndpointStatusSchema, webhookEventNameSchema } from './webhooks.cjs';
+export { CreateRefundInput, Refund, RefundCreateOutput, RefundReason, RefundSigningInstructions, RefundStatus, SubmitRefundSignatureInput, createRefundInputSchema, refundCreateOutputSchema, refundReasonSchema, refundSchema, refundSigningInstructionsSchema, refundStatusSchema, submitRefundSignatureInputSchema } from './refunds.cjs';
+export { CreateWebhookEndpointInput, CreateWebhookEndpointOutput, ReplayDeliveryInput, WebhookDelivery, WebhookDeliveryDetail, WebhookDeliveryStatus, WebhookEndpoint, WebhookEndpointStatus, WebhookEventName, createWebhookEndpointInputSchema, createWebhookEndpointOutputSchema, replayDeliveryInputSchema, webhookDeliveryDetailSchema, webhookDeliverySchema, webhookDeliveryStatusSchema, webhookEndpointSchema, webhookEndpointStatusSchema, webhookEventNameSchema } from './webhooks.cjs';
 export { ComplianceLog, ComplianceProvider, ComplianceScreeningContext, ComplianceStatus, complianceLogSchema, complianceProviderSchema, complianceScreeningContextSchema, complianceStatusSchema } from './compliance.cjs';
 export { AgentActionOutcome, AgentActionType, AgentActivityLog, AgentCapability, AgentIdentity, AgentJob, AgentJobStatus, AgentMerchantConfig, CreateAgentJobInput, UpdateAgentConfigInput, agentActionOutcomeSchema, agentActionTypeSchema, agentActivityLogSchema, agentCapabilitySchema, agentIdentitySchema, agentJobSchema, agentJobStatusSchema, agentMerchantConfigSchema, createAgentJobInputSchema, updateAgentConfigInputSchema } from './agents.cjs';
-export { CreateStorefrontInput, CreateStorefrontProductInput, Storefront, StorefrontProduct, StorefrontProductType, StorefrontStatus, createStorefrontInputSchema, createStorefrontProductInputSchema, storefrontProductSchema, storefrontProductTypeSchema, storefrontSchema, storefrontStatusSchema } from './storefronts.cjs';
+export { CreateStorefrontInput, CreateStorefrontProductInput, Storefront, StorefrontCheckoutInput, StorefrontCheckoutResponse, StorefrontProduct, StorefrontProductType, StorefrontStatus, createStorefrontInputSchema, createStorefrontProductInputSchema, storefrontCheckoutInputSchema, storefrontCheckoutResponseSchema, storefrontProductSchema, storefrontProductTypeSchema, storefrontSchema, storefrontStatusSchema } from './storefronts.cjs';
 export { CreateInvoiceInput, Invoice, InvoiceLineItem, InvoiceStatus, createInvoiceInputSchema, invoiceLineItemSchema, invoiceSchema, invoiceStatusSchema } from './invoices.cjs';
 export { AgentActionExecutedEvent, AgentJobCompletedEvent, AgentJobDisputedEvent, AgentJobProposedEvent, ComplianceWalletBlockedEvent, ComplianceWalletFlaggedEvent, InvoiceCreatedEvent, InvoiceOverdueEvent, InvoicePaidEvent, PaymentCompletedEvent, PaymentCreatedEvent, PaymentFailedEvent, RefundCompletedEvent, RefundCreatedEvent, RefundFailedEvent, StrimzWebhookEvent, SubscriptionCancelledEvent, SubscriptionChargeFailedEvent, SubscriptionChargedEvent, SubscriptionCreatedEvent, SubscriptionLapsedEvent, SubscriptionRecoveryAttemptEvent, SubscriptionRecoveryOutcomeEvent, agentActionExecutedEventSchema, agentJobCompletedEventSchema, agentJobDisputedEventSchema, agentJobProposedEventSchema, complianceWalletBlockedEventSchema, complianceWalletFlaggedEventSchema, invoiceCreatedEventSchema, invoiceOverdueEventSchema, invoicePaidEventSchema, paymentCompletedEventSchema, paymentCreatedEventSchema, paymentFailedEventSchema, refundCompletedEventSchema, refundCreatedEventSchema, refundFailedEventSchema, subscriptionCancelledEventSchema, subscriptionChargeFailedEventSchema, subscriptionChargedEventSchema, subscriptionCreatedEventSchema, subscriptionLapsedEventSchema, subscriptionRecoveryAttemptEventSchema, subscriptionRecoveryOutcomeEventSchema, webhookEventSchema } from './events.cjs';
 import { z } from 'zod';
@@ -69,8 +69,8 @@ declare const tokenMetadataSchema: z.ZodObject<{
     symbol: string;
     name: string;
     version: string;
-    address: string;
     decimals: number;
+    address: string;
     capabilities: {
         permit2612: boolean;
         transferAuth3009: boolean;
@@ -79,8 +79,8 @@ declare const tokenMetadataSchema: z.ZodObject<{
     symbol: string;
     name: string;
     version: string;
-    address: string;
     decimals: number;
+    address: string;
     capabilities: {
         permit2612: boolean;
         transferAuth3009: boolean;
@@ -100,14 +100,299 @@ declare const tokenPermitNonceSchema: z.ZodObject<{
     owner: z.ZodString;
     nonce: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    owner: string;
     token: string;
+    owner: string;
     nonce: string;
 }, {
-    owner: string;
     token: string;
+    owner: string;
     nonce: string;
 }>;
 type TokenPermitNonce = z.infer<typeof tokenPermitNonceSchema>;
 
-export { type TokenCapabilities, type TokenMetadata, type TokenPermitNonce, tokenCapabilitiesSchema, tokenMetadataSchema, tokenPermitNonceSchema };
+/**
+ * Public marketing contact form. Not an authenticated API resource —
+ * routed straight to a support inbox by the contact module in
+ * `apps/api`. Kept shape-compatible with what the marketing form on
+ * the Strimz landing page already validates client-side.
+ */
+
+declare const contactTopicSchema: z.ZodEnum<["sales", "support", "partnership", "security", "other"]>;
+type ContactTopic = z.infer<typeof contactTopicSchema>;
+declare const contactRequestInputSchema: z.ZodObject<{
+    name: z.ZodString;
+    email: z.ZodString;
+    company: z.ZodOptional<z.ZodString>;
+    topic: z.ZodEnum<["sales", "support", "partnership", "security", "other"]>;
+    message: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    name: string;
+    email: string;
+    topic: "other" | "sales" | "support" | "partnership" | "security";
+    company?: string | undefined;
+}, {
+    message: string;
+    name: string;
+    email: string;
+    topic: "other" | "sales" | "support" | "partnership" | "security";
+    company?: string | undefined;
+}>;
+type ContactRequestInput = z.infer<typeof contactRequestInputSchema>;
+declare const contactRequestOutputSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    ok: true;
+}, {
+    ok: true;
+}>;
+type ContactRequestOutput = z.infer<typeof contactRequestOutputSchema>;
+
+/**
+ * Dashboard notifications. Derived server-side from recent activity
+ * (confirmed payment sessions, new subscribers, processed refunds).
+ * Read state is tracked on the merchant record via
+ * `notificationsLastReadAt` — `event.createdAt <= that timestamp` is
+ * "read", anything newer is "unread". No dedicated notifications
+ * table because the source rows already exist; a separate table would
+ * just be a denormalised copy.
+ */
+
+declare const notificationKindSchema: z.ZodEnum<["payment_received", "subscription_started", "refund_processed", "admin_broadcast"]>;
+type NotificationKind = z.infer<typeof notificationKindSchema>;
+declare const broadcastAudienceSchema: z.ZodEnum<["all", "merchant"]>;
+type BroadcastAudience = z.infer<typeof broadcastAudienceSchema>;
+declare const createBroadcastInputSchema: z.ZodEffects<z.ZodObject<{
+    title: z.ZodString;
+    body: z.ZodString;
+    audience: z.ZodDefault<z.ZodEnum<["all", "merchant"]>>;
+    /** Required when `audience === 'merchant'`; ignored otherwise. */
+    merchantId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    body: string;
+    audience: "merchant" | "all";
+    merchantId?: string | undefined;
+}, {
+    title: string;
+    body: string;
+    merchantId?: string | undefined;
+    audience?: "merchant" | "all" | undefined;
+}>, {
+    title: string;
+    body: string;
+    audience: "merchant" | "all";
+    merchantId?: string | undefined;
+}, {
+    title: string;
+    body: string;
+    merchantId?: string | undefined;
+    audience?: "merchant" | "all" | undefined;
+}>;
+type CreateBroadcastInput = z.infer<typeof createBroadcastInputSchema>;
+declare const broadcastSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    body: z.ZodString;
+    audience: z.ZodEnum<["all", "merchant"]>;
+    merchantId: z.ZodNullable<z.ZodString>;
+    merchantEmail: z.ZodNullable<z.ZodString>;
+    senderId: z.ZodString;
+    senderEmail: z.ZodString;
+    emailedAt: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    merchantId: string | null;
+    createdAt: string;
+    title: string;
+    body: string;
+    audience: "merchant" | "all";
+    merchantEmail: string | null;
+    senderId: string;
+    senderEmail: string;
+    emailedAt: string | null;
+}, {
+    id: string;
+    merchantId: string | null;
+    createdAt: string;
+    title: string;
+    body: string;
+    audience: "merchant" | "all";
+    merchantEmail: string | null;
+    senderId: string;
+    senderEmail: string;
+    emailedAt: string | null;
+}>;
+type Broadcast = z.infer<typeof broadcastSchema>;
+declare const broadcastListResponseSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        body: z.ZodString;
+        audience: z.ZodEnum<["all", "merchant"]>;
+        merchantId: z.ZodNullable<z.ZodString>;
+        merchantEmail: z.ZodNullable<z.ZodString>;
+        senderId: z.ZodString;
+        senderEmail: z.ZodString;
+        emailedAt: z.ZodNullable<z.ZodString>;
+        createdAt: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        merchantId: string | null;
+        createdAt: string;
+        title: string;
+        body: string;
+        audience: "merchant" | "all";
+        merchantEmail: string | null;
+        senderId: string;
+        senderEmail: string;
+        emailedAt: string | null;
+    }, {
+        id: string;
+        merchantId: string | null;
+        createdAt: string;
+        title: string;
+        body: string;
+        audience: "merchant" | "all";
+        merchantEmail: string | null;
+        senderId: string;
+        senderEmail: string;
+        emailedAt: string | null;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    data: {
+        id: string;
+        merchantId: string | null;
+        createdAt: string;
+        title: string;
+        body: string;
+        audience: "merchant" | "all";
+        merchantEmail: string | null;
+        senderId: string;
+        senderEmail: string;
+        emailedAt: string | null;
+    }[];
+}, {
+    data: {
+        id: string;
+        merchantId: string | null;
+        createdAt: string;
+        title: string;
+        body: string;
+        audience: "merchant" | "all";
+        merchantEmail: string | null;
+        senderId: string;
+        senderEmail: string;
+        emailedAt: string | null;
+    }[];
+}>;
+type BroadcastListResponse = z.infer<typeof broadcastListResponseSchema>;
+declare const notificationSchema: z.ZodObject<{
+    /** Deterministic client id — `{kind}:{sourceId}`. Safe for React keys. */
+    id: z.ZodString;
+    kind: z.ZodEnum<["payment_received", "subscription_started", "refund_processed", "admin_broadcast"]>;
+    title: z.ZodString;
+    detail: z.ZodString;
+    /** Dashboard route the tray links to. */
+    href: z.ZodString;
+    /** ISO timestamp of the source event; drives sort + read comparison. */
+    createdAt: z.ZodString;
+    /** Server-derived from the merchant's `notificationsLastReadAt`. */
+    read: z.ZodBoolean;
+    /** Optional foreign key back to the source row (for deep-linking). */
+    sourceId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    kind: "payment_received" | "subscription_started" | "refund_processed" | "admin_broadcast";
+    createdAt: string;
+    title: string;
+    detail: string;
+    href: string;
+    read: boolean;
+    sourceId?: string | undefined;
+}, {
+    id: string;
+    kind: "payment_received" | "subscription_started" | "refund_processed" | "admin_broadcast";
+    createdAt: string;
+    title: string;
+    detail: string;
+    href: string;
+    read: boolean;
+    sourceId?: string | undefined;
+}>;
+type NotificationView = z.infer<typeof notificationSchema>;
+declare const notificationListResponseSchema: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        /** Deterministic client id — `{kind}:{sourceId}`. Safe for React keys. */
+        id: z.ZodString;
+        kind: z.ZodEnum<["payment_received", "subscription_started", "refund_processed", "admin_broadcast"]>;
+        title: z.ZodString;
+        detail: z.ZodString;
+        /** Dashboard route the tray links to. */
+        href: z.ZodString;
+        /** ISO timestamp of the source event; drives sort + read comparison. */
+        createdAt: z.ZodString;
+        /** Server-derived from the merchant's `notificationsLastReadAt`. */
+        read: z.ZodBoolean;
+        /** Optional foreign key back to the source row (for deep-linking). */
+        sourceId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        kind: "payment_received" | "subscription_started" | "refund_processed" | "admin_broadcast";
+        createdAt: string;
+        title: string;
+        detail: string;
+        href: string;
+        read: boolean;
+        sourceId?: string | undefined;
+    }, {
+        id: string;
+        kind: "payment_received" | "subscription_started" | "refund_processed" | "admin_broadcast";
+        createdAt: string;
+        title: string;
+        detail: string;
+        href: string;
+        read: boolean;
+        sourceId?: string | undefined;
+    }>, "many">;
+    unreadCount: z.ZodNumber;
+    lastReadAt: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    data: {
+        id: string;
+        kind: "payment_received" | "subscription_started" | "refund_processed" | "admin_broadcast";
+        createdAt: string;
+        title: string;
+        detail: string;
+        href: string;
+        read: boolean;
+        sourceId?: string | undefined;
+    }[];
+    unreadCount: number;
+    lastReadAt: string | null;
+}, {
+    data: {
+        id: string;
+        kind: "payment_received" | "subscription_started" | "refund_processed" | "admin_broadcast";
+        createdAt: string;
+        title: string;
+        detail: string;
+        href: string;
+        read: boolean;
+        sourceId?: string | undefined;
+    }[];
+    unreadCount: number;
+    lastReadAt: string | null;
+}>;
+type NotificationListResponse = z.infer<typeof notificationListResponseSchema>;
+declare const markNotificationsReadResponseSchema: z.ZodObject<{
+    lastReadAt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    lastReadAt: string;
+}, {
+    lastReadAt: string;
+}>;
+type MarkNotificationsReadResponse = z.infer<typeof markNotificationsReadResponseSchema>;
+
+export { type Broadcast, type BroadcastAudience, type BroadcastListResponse, type ContactRequestInput, type ContactRequestOutput, type ContactTopic, type CreateBroadcastInput, type MarkNotificationsReadResponse, type NotificationKind, type NotificationListResponse, type NotificationView, type TokenCapabilities, type TokenMetadata, type TokenPermitNonce, broadcastAudienceSchema, broadcastListResponseSchema, broadcastSchema, contactRequestInputSchema, contactRequestOutputSchema, contactTopicSchema, createBroadcastInputSchema, markNotificationsReadResponseSchema, notificationKindSchema, notificationListResponseSchema, notificationSchema, tokenCapabilitiesSchema, tokenMetadataSchema, tokenPermitNonceSchema };