@strimz/shared-types 0.1.0 → 0.2.0

package/dist/index.js

@@ -41,6 +41,8 @@ var merchantSchema = z.object({
   tier: merchantTierSchema,
   status: merchantStatusSchema,
   payoutAddress: evmAddressSchema.nullable(),
+  walletAddress: evmAddressSchema.nullable(),
+  onboardingCompleted: z.boolean(),
   defaultCurrency: z.enum(["USDC", "EURC"]),
   countryCode: z.string().length(2).nullable(),
   websiteUrl: z.string().url().nullable(),
@@ -57,6 +59,16 @@ var createMerchantInputSchema = z.object({
   countryCode: z.string().length(2).optional(),
   websiteUrl: z.string().url().optional()
 });
+var merchantEmailPrefsSchema = z.object({
+  /** "You received X USDC" one-off payment notifications. */
+  paymentReceived: z.boolean(),
+  /** "You were paid X for subscription Y" per-charge notifications. */
+  subscriptionCharged: z.boolean()
+});
+var DEFAULT_MERCHANT_EMAIL_PREFS = {
+  paymentReceived: true,
+  subscriptionCharged: true
+};
 var updateMerchantInputSchema = z.object({
   businessName: z.string().min(2).max(120),
   payoutAddress: evmAddressSchema,
@@ -64,11 +76,52 @@ var updateMerchantInputSchema = z.object({
   websiteUrl: z.string().url().nullable(),
   logoUrl: z.string().url().nullable(),
   countryCode: z.string().length(2).nullable(),
-  metadata: metadataSchema
+  metadata: metadataSchema,
+  emailPrefs: merchantEmailPrefsSchema.partial()
 }).partial();
 var changeTierInputSchema = z.object({
   tier: merchantTierSchema
 });
+var onboardMerchantInputSchema = z.object({
+  businessName: z.string().min(2).max(120),
+  businessSector: z.string().min(2).max(80),
+  countryCode: z.string().length(2).regex(/^[A-Z]{2}$/, "must be a 2-letter ISO country code"),
+  websiteUrl: z.string().url().optional(),
+  logoUrl: z.string().url().optional(),
+  phone: z.string().min(6).max(20).optional(),
+  payoutAddress: evmAddressSchema,
+  defaultCurrency: z.enum(["USDC", "EURC"]).optional()
+});
+var merchantPublicBrandSchema = z.object({
+  id: idSchema,
+  businessName: z.string().min(2).max(120),
+  logoUrl: z.string().url().nullable(),
+  walletAddress: evmAddressSchema.nullable()
+});
+var merchantBalanceSchema = z.object({
+  /** Payout wallet, checksummed; null when the merchant hasn't set one. */
+  payoutAddress: evmAddressSchema.nullable(),
+  /** Privy embedded wallet, checksummed if resolvable. */
+  walletAddress: evmAddressSchema.nullable(),
+  /**
+   * True when `payoutAddress === walletAddress`, i.e. the merchant
+   * can sign a transfer from the dashboard via Privy. False for
+   * merchants using an external wallet as payout — the UI falls back
+   * to "copy the address, transfer with your wallet."
+   */
+  canSignFromDashboard: z.boolean(),
+  balances: z.array(
+    z.object({
+      currency: z.enum(["USDC", "EURC"]),
+      contractAddress: evmAddressSchema,
+      /** Base-6 integer as string. */
+      raw: z.string(),
+      /** Human-formatted, e.g. `1234.56`. */
+      formatted: z.string(),
+      decimals: z.number().int().min(0).max(30)
+    })
+  )
+});
 var merchantMemberSchema = z.object({
   id: idSchema,
   merchantId: idSchema,
@@ -107,11 +160,16 @@ var apiKeyScopeSchema = z.enum([
   "storefronts_write",
   "agents_read",
   "agents_write",
-  // Meta-tx relayer — submitting payer-signed EIP-3009 / EIP-2612
+  // Meta-tx relayer. Submitting payer-signed EIP-3009 / EIP-2612
   // authorizations on the merchant's behalf. Granted to keys used by
   // hosted checkout and merchants embedding the SDK.
   "relay_read",
-  "relay_write"
+  "relay_write",
+  // Self-service key management from an API key holder. Rarely used
+  // day-to-day; needed for partner onboarding flows that mint scoped
+  // keys per sub-tenant.
+  "api_keys_read",
+  "api_keys_write"
 ]);
 var apiKeySchema = z.object({
   id: idSchema,
@@ -134,7 +192,7 @@ var createApiKeyInputSchema = z.object({
 });
 var createApiKeyOutputSchema = z.object({
   apiKey: apiKeySchema,
-  /** Full plaintext key — shown exactly once. */
+  /** Full plaintext key. Shown exactly once. */
   secret: z.string()
 });
 var rotateApiKeyInputSchema = z.object({
@@ -168,6 +226,9 @@ var paymentSessionStatusSchema = z.enum([
   "expired",
   "cancelled"
 ]);
+var callbackUrlSchema = z.string().url().refine((v) => v.startsWith("https://") || v.startsWith("http://"), {
+  message: "must be an http:// or https:// URL"
+});
 var paymentSessionSchema = z.object({
   id: idSchema,
   merchantId: idSchema,
@@ -197,8 +258,8 @@ var paymentSessionSchema = z.object({
   description: z.string().max(500).nullable(),
   payerWalletAddress: evmAddressSchema.nullable(),
   payerEmail: z.string().email().nullable(),
-  successUrl: z.string().url().nullable(),
-  cancelUrl: z.string().url().nullable(),
+  successUrl: callbackUrlSchema.nullable(),
+  cancelUrl: callbackUrlSchema.nullable(),
   sourceChain: z.enum(["arc", "ethereum", "base", "polygon", "arbitrum", "optimism", "avalanche", "solana"]).nullable(),
   bridgeTxHash: evmTxHashSchema.nullable(),
   onchainTxHash: evmTxHashSchema.nullable(),
@@ -288,12 +349,12 @@ var subscriptionPlanSchema = z.object({
   /**
    * On-chain StrimzRegistry merchant id (uint96) as a decimal string.
    * See `paymentSessionSchema.chainMerchantId`. Null when the merchant
-   * hasn't been registered on-chain yet — the hosted enrolment page
+   * hasn't been registered on-chain yet. The hosted enrolment page
    * refuses to take signatures in that state.
    */
   chainMerchantId: z.string().regex(/^[0-9]+$/u, "must be a non-negative decimal integer string").nullable(),
   /**
-   * ERC-20 token contract address resolved from `currency` — the
+   * ERC-20 token contract address resolved from `currency`. This is the
    * EIP-2612 `verifyingContract` the wallet signs over.
    */
   tokenAddress: evmAddressSchema.nullable(),
@@ -444,6 +505,16 @@ var submitRefundSignatureInputSchema = z.object({
   id: idSchema,
   refundTxHash: evmTxHashSchema
 });
+var refundSigningInstructionsSchema = z.object({
+  token: evmAddressSchema,
+  to: evmAddressSchema,
+  amount: tokenAmountSchema,
+  note: z.string()
+});
+var refundCreateOutputSchema = z.object({
+  refund: refundSchema,
+  signingInstructions: refundSigningInstructionsSchema
+});
 var webhookEventNameSchema = z.enum([
   "payment.created",
   "payment.completed",
@@ -490,7 +561,7 @@ var createWebhookEndpointInputSchema = z.object({
 });
 var createWebhookEndpointOutputSchema = z.object({
   endpoint: webhookEndpointSchema,
-  /** Full signing secret — shown exactly once. */
+  /** Full signing secret. Shown exactly once. */
   signingSecret: z.string()
 });
 var webhookDeliveryStatusSchema = z.enum([
@@ -514,6 +585,11 @@ var webhookDeliverySchema = z.object({
   deliveredAt: isoTimestampSchema.nullable(),
   createdAt: isoTimestampSchema
 });
+var webhookDeliveryDetailSchema = webhookDeliverySchema.extend({
+  deliveryId: z.string(),
+  responseBody: z.string().nullable(),
+  requestPayload: z.record(z.string(), z.unknown())
+});
 var replayDeliveryInputSchema = z.object({
   id: idSchema
 });
@@ -695,6 +771,18 @@ var createStorefrontProductInputSchema = storefrontProductSchema.omit({
 }).extend({
   imageUrl: httpsUrlSchema.optional()
 });
+var storefrontCheckoutInputSchema = z.object({
+  customerEmail: z.string().email().optional(),
+  returnPath: z.string().max(200).optional()
+});
+var storefrontCheckoutResponseSchema = z.object({
+  /** Fully-qualified checkout URL — payer redirects here to sign. */
+  checkoutUrl: z.string().url(),
+  /** Payment-session id (one-time) or plan id (subscription). */
+  ref: idSchema,
+  /** Which downstream checkout the URL points at. */
+  kind: z.enum(["payment_session", "subscription_plan"])
+});
 var invoiceStatusSchema = z.enum(["draft", "sent", "paid", "overdue", "void"]);
 var invoiceLineItemSchema = z.object({
   description: z.string().min(1).max(500),
@@ -839,8 +927,8 @@ var tokenMetadataSchema = z.object({
   symbol: z.string(),
   /**
    * EIP-712 domain version. Read from ERC-5267 `eip712Domain()` when
-   * available; otherwise defaults to "1". Used by typed-data builders
-   * — domain mismatch produces a different digest and the contract's
+   * available; otherwise defaults to "1". Used by typed-data builders.
+   * A domain mismatch produces a different digest, so the contract's
    * ecrecover would recover a different address.
    */
   version: z.string(),
@@ -852,7 +940,74 @@ var tokenPermitNonceSchema = z.object({
   owner: addressSchema,
   nonce: z.string().regex(/^[0-9]+$/u, "must be a decimal integer string")
 });
+var contactTopicSchema = z.enum(["sales", "support", "partnership", "security", "other"]);
+var contactRequestInputSchema = z.object({
+  name: z.string().min(2).max(120),
+  email: emailSchema,
+  company: z.string().min(1).max(120).optional(),
+  topic: contactTopicSchema,
+  message: z.string().min(20).max(4e3)
+});
+var contactRequestOutputSchema = z.object({
+  ok: z.literal(true)
+});
+var notificationKindSchema = z.enum([
+  "payment_received",
+  "subscription_started",
+  "refund_processed",
+  /** Message an admin broadcast to this merchant (or all merchants). */
+  "admin_broadcast"
+]);
+var broadcastAudienceSchema = z.enum(["all", "merchant"]);
+var createBroadcastInputSchema = z.object({
+  title: z.string().min(4).max(160),
+  body: z.string().min(4).max(4e3),
+  audience: broadcastAudienceSchema.default("all"),
+  /** Required when `audience === 'merchant'`; ignored otherwise. */
+  merchantId: z.string().optional()
+}).refine((v) => v.audience !== "merchant" || !!v.merchantId, {
+  message: "merchantId is required when audience is merchant",
+  path: ["merchantId"]
+});
+var broadcastSchema = z.object({
+  id: idSchema,
+  title: z.string(),
+  body: z.string(),
+  audience: broadcastAudienceSchema,
+  merchantId: idSchema.nullable(),
+  merchantEmail: z.string().nullable(),
+  senderId: idSchema,
+  senderEmail: z.string(),
+  emailedAt: isoTimestampSchema.nullable(),
+  createdAt: isoTimestampSchema
+});
+var broadcastListResponseSchema = z.object({
+  data: z.array(broadcastSchema)
+});
+var notificationSchema = z.object({
+  /** Deterministic client id — `{kind}:{sourceId}`. Safe for React keys. */
+  id: z.string().min(1),
+  kind: notificationKindSchema,
+  title: z.string().min(1),
+  detail: z.string(),
+  /** Dashboard route the tray links to. */
+  href: z.string().min(1),
+  /** ISO timestamp of the source event; drives sort + read comparison. */
+  createdAt: isoTimestampSchema,
+  /** Server-derived from the merchant's `notificationsLastReadAt`. */
+  read: z.boolean(),
+  /** Optional foreign key back to the source row (for deep-linking). */
+  sourceId: idSchema.optional()
+});
+var notificationListResponseSchema = z.object({
+  data: z.array(notificationSchema),
+  unreadCount: z.number().int().min(0),
+  lastReadAt: isoTimestampSchema.nullable()
+});
+var markNotificationsReadResponseSchema = z.object({
+  lastReadAt: isoTimestampSchema
+});
 
-export { agentActionExecutedEventSchema, agentActionOutcomeSchema, agentActionTypeSchema, agentActivityLogSchema, agentCapabilitySchema, agentIdentitySchema, agentJobCompletedEventSchema, agentJobDisputedEventSchema, agentJobProposedEventSchema, agentJobSchema, agentJobStatusSchema, agentMerchantConfigSchema, apiKeyKindSchema, apiKeySchema, apiKeyScopeSchema, arcEnvironmentSchema, cancelSubscriptionInputSchema, changeTierInputSchema, complianceLogSchema, complianceProviderSchema, complianceScreeningContextSchema, complianceStatusSchema, complianceWalletBlockedEventSchema, complianceWalletFlaggedEventSchema, countryCodeSchema, createAgentJobInputSchema, createApiKeyInputSchema, createApiKeyOutputSchema, createInvoiceInputSchema, createMerchantInputSchema, createPaymentSessionInputSchema, createRefundInputSchema, createStorefrontInputSchema, createStorefrontProductInputSchema, createSubscriptionInputSchema, createSubscriptionPlanInputSchema, createWebhookEndpointInputSchema, createWebhookEndpointOutputSchema, customerSchema, emailSchema, evmAddressSchema, evmTxHashSchema, httpUrlSchema, httpsUrlSchema, idSchema, inviteMemberInputSchema, invoiceCreatedEventSchema, invoiceLineItemSchema, invoiceOverdueEventSchema, invoicePaidEventSchema, invoiceSchema, invoiceStatusSchema, isoTimestampSchema, loginInputSchema, loginOutputSchema, makePaginatedSchema, merchantMemberSchema, merchantRoleSchema, merchantSchema, merchantStatusSchema, merchantTierSchema, metadataSchema, modeSchema, paginationInputSchema, paymentCompletedEventSchema, paymentCreatedEventSchema, paymentCurrencySchema, paymentFailedEventSchema, paymentSessionSchema, paymentSessionStatusSchema, refundCompletedEventSchema, refundCreatedEventSchema, refundFailedEventSchema, refundReasonSchema, refundSchema, refundStatusSchema, replayDeliveryInputSchema, rotateApiKeyInputSchema, storefrontProductSchema, storefrontProductTypeSchema, storefrontSchema, storefrontStatusSchema, submitPaymentSessionInputSchema, submitRefundSignatureInputSchema, subscriptionCancelledEventSchema, subscriptionChargeFailedEventSchema, subscriptionChargeOutcomeSchema, subscriptionChargeSchema, subscriptionChargeStatusSchema, subscriptionChargedEventSchema, subscriptionCreatedEventSchema, subscriptionIntervalSchema, subscriptionLapsedEventSchema, subscriptionPlanSchema, subscriptionPlanStatusSchema, subscriptionRecoveryAttemptEventSchema, subscriptionRecoveryOutcomeEventSchema, subscriptionSchema, subscriptionStatusSchema, tokenAmountSchema, tokenCapabilitiesSchema, tokenMetadataSchema, tokenPermitNonceSchema, tokenSymbolSchema, transactionKindSchema, transactionSchema, transactionStatusSchema, uintSchema, updateAgentConfigInputSchema, updateMerchantInputSchema, upsertCustomerInputSchema, webhookDeliverySchema, webhookDeliveryStatusSchema, webhookEndpointSchema, webhookEndpointStatusSchema, webhookEventNameSchema, webhookEventSchema };
+export { DEFAULT_MERCHANT_EMAIL_PREFS, agentActionExecutedEventSchema, agentActionOutcomeSchema, agentActionTypeSchema, agentActivityLogSchema, agentCapabilitySchema, agentIdentitySchema, agentJobCompletedEventSchema, agentJobDisputedEventSchema, agentJobProposedEventSchema, agentJobSchema, agentJobStatusSchema, agentMerchantConfigSchema, apiKeyKindSchema, apiKeySchema, apiKeyScopeSchema, arcEnvironmentSchema, broadcastAudienceSchema, broadcastListResponseSchema, broadcastSchema, callbackUrlSchema, cancelSubscriptionInputSchema, changeTierInputSchema, complianceLogSchema, complianceProviderSchema, complianceScreeningContextSchema, complianceStatusSchema, complianceWalletBlockedEventSchema, complianceWalletFlaggedEventSchema, contactRequestInputSchema, contactRequestOutputSchema, contactTopicSchema, countryCodeSchema, createAgentJobInputSchema, createApiKeyInputSchema, createApiKeyOutputSchema, createBroadcastInputSchema, createInvoiceInputSchema, createMerchantInputSchema, createPaymentSessionInputSchema, createRefundInputSchema, createStorefrontInputSchema, createStorefrontProductInputSchema, createSubscriptionInputSchema, createSubscriptionPlanInputSchema, createWebhookEndpointInputSchema, createWebhookEndpointOutputSchema, customerSchema, emailSchema, evmAddressSchema, evmTxHashSchema, httpUrlSchema, httpsUrlSchema, idSchema, inviteMemberInputSchema, invoiceCreatedEventSchema, invoiceLineItemSchema, invoiceOverdueEventSchema, invoicePaidEventSchema, invoiceSchema, invoiceStatusSchema, isoTimestampSchema, loginInputSchema, loginOutputSchema, makePaginatedSchema, markNotificationsReadResponseSchema, merchantBalanceSchema, merchantEmailPrefsSchema, merchantMemberSchema, merchantPublicBrandSchema, merchantRoleSchema, merchantSchema, merchantStatusSchema, merchantTierSchema, metadataSchema, modeSchema, notificationKindSchema, notificationListResponseSchema, notificationSchema, onboardMerchantInputSchema, paginationInputSchema, paymentCompletedEventSchema, paymentCreatedEventSchema, paymentCurrencySchema, paymentFailedEventSchema, paymentSessionSchema, paymentSessionStatusSchema, refundCompletedEventSchema, refundCreateOutputSchema, refundCreatedEventSchema, refundFailedEventSchema, refundReasonSchema, refundSchema, refundSigningInstructionsSchema, refundStatusSchema, replayDeliveryInputSchema, rotateApiKeyInputSchema, storefrontCheckoutInputSchema, storefrontCheckoutResponseSchema, storefrontProductSchema, storefrontProductTypeSchema, storefrontSchema, storefrontStatusSchema, submitPaymentSessionInputSchema, submitRefundSignatureInputSchema, subscriptionCancelledEventSchema, subscriptionChargeFailedEventSchema, subscriptionChargeOutcomeSchema, subscriptionChargeSchema, subscriptionChargeStatusSchema, subscriptionChargedEventSchema, subscriptionCreatedEventSchema, subscriptionIntervalSchema, subscriptionLapsedEventSchema, subscriptionPlanSchema, subscriptionPlanStatusSchema, subscriptionRecoveryAttemptEventSchema, subscriptionRecoveryOutcomeEventSchema, subscriptionSchema, subscriptionStatusSchema, tokenAmountSchema, tokenCapabilitiesSchema, tokenMetadataSchema, tokenPermitNonceSchema, tokenSymbolSchema, transactionKindSchema, transactionSchema, transactionStatusSchema, uintSchema, updateAgentConfigInputSchema, updateMerchantInputSchema, upsertCustomerInputSchema, webhookDeliveryDetailSchema, webhookDeliverySchema, webhookDeliveryStatusSchema, webhookEndpointSchema, webhookEndpointStatusSchema, webhookEventNameSchema, webhookEventSchema };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map