@strimz/shared-types 0.1.0 → 0.2.0

package/dist/index.cjs

@@ -43,6 +43,8 @@ var merchantSchema = zod.z.object({
   tier: merchantTierSchema,
   status: merchantStatusSchema,
   payoutAddress: evmAddressSchema.nullable(),
+  walletAddress: evmAddressSchema.nullable(),
+  onboardingCompleted: zod.z.boolean(),
   defaultCurrency: zod.z.enum(["USDC", "EURC"]),
   countryCode: zod.z.string().length(2).nullable(),
   websiteUrl: zod.z.string().url().nullable(),
@@ -59,6 +61,16 @@ var createMerchantInputSchema = zod.z.object({
   countryCode: zod.z.string().length(2).optional(),
   websiteUrl: zod.z.string().url().optional()
 });
+var merchantEmailPrefsSchema = zod.z.object({
+  /** "You received X USDC" one-off payment notifications. */
+  paymentReceived: zod.z.boolean(),
+  /** "You were paid X for subscription Y" per-charge notifications. */
+  subscriptionCharged: zod.z.boolean()
+});
+var DEFAULT_MERCHANT_EMAIL_PREFS = {
+  paymentReceived: true,
+  subscriptionCharged: true
+};
 var updateMerchantInputSchema = zod.z.object({
   businessName: zod.z.string().min(2).max(120),
   payoutAddress: evmAddressSchema,
@@ -66,11 +78,52 @@ var updateMerchantInputSchema = zod.z.object({
   websiteUrl: zod.z.string().url().nullable(),
   logoUrl: zod.z.string().url().nullable(),
   countryCode: zod.z.string().length(2).nullable(),
-  metadata: metadataSchema
+  metadata: metadataSchema,
+  emailPrefs: merchantEmailPrefsSchema.partial()
 }).partial();
 var changeTierInputSchema = zod.z.object({
   tier: merchantTierSchema
 });
+var onboardMerchantInputSchema = zod.z.object({
+  businessName: zod.z.string().min(2).max(120),
+  businessSector: zod.z.string().min(2).max(80),
+  countryCode: zod.z.string().length(2).regex(/^[A-Z]{2}$/, "must be a 2-letter ISO country code"),
+  websiteUrl: zod.z.string().url().optional(),
+  logoUrl: zod.z.string().url().optional(),
+  phone: zod.z.string().min(6).max(20).optional(),
+  payoutAddress: evmAddressSchema,
+  defaultCurrency: zod.z.enum(["USDC", "EURC"]).optional()
+});
+var merchantPublicBrandSchema = zod.z.object({
+  id: idSchema,
+  businessName: zod.z.string().min(2).max(120),
+  logoUrl: zod.z.string().url().nullable(),
+  walletAddress: evmAddressSchema.nullable()
+});
+var merchantBalanceSchema = zod.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: zod.z.boolean(),
+  balances: zod.z.array(
+    zod.z.object({
+      currency: zod.z.enum(["USDC", "EURC"]),
+      contractAddress: evmAddressSchema,
+      /** Base-6 integer as string. */
+      raw: zod.z.string(),
+      /** Human-formatted, e.g. `1234.56`. */
+      formatted: zod.z.string(),
+      decimals: zod.z.number().int().min(0).max(30)
+    })
+  )
+});
 var merchantMemberSchema = zod.z.object({
   id: idSchema,
   merchantId: idSchema,
@@ -109,11 +162,16 @@ var apiKeyScopeSchema = zod.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 = zod.z.object({
   id: idSchema,
@@ -136,7 +194,7 @@ var createApiKeyInputSchema = zod.z.object({
 });
 var createApiKeyOutputSchema = zod.z.object({
   apiKey: apiKeySchema,
-  /** Full plaintext key — shown exactly once. */
+  /** Full plaintext key. Shown exactly once. */
   secret: zod.z.string()
 });
 var rotateApiKeyInputSchema = zod.z.object({
@@ -170,6 +228,9 @@ var paymentSessionStatusSchema = zod.z.enum([
   "expired",
   "cancelled"
 ]);
+var callbackUrlSchema = zod.z.string().url().refine((v) => v.startsWith("https://") || v.startsWith("http://"), {
+  message: "must be an http:// or https:// URL"
+});
 var paymentSessionSchema = zod.z.object({
   id: idSchema,
   merchantId: idSchema,
@@ -199,8 +260,8 @@ var paymentSessionSchema = zod.z.object({
   description: zod.z.string().max(500).nullable(),
   payerWalletAddress: evmAddressSchema.nullable(),
   payerEmail: zod.z.string().email().nullable(),
-  successUrl: zod.z.string().url().nullable(),
-  cancelUrl: zod.z.string().url().nullable(),
+  successUrl: callbackUrlSchema.nullable(),
+  cancelUrl: callbackUrlSchema.nullable(),
   sourceChain: zod.z.enum(["arc", "ethereum", "base", "polygon", "arbitrum", "optimism", "avalanche", "solana"]).nullable(),
   bridgeTxHash: evmTxHashSchema.nullable(),
   onchainTxHash: evmTxHashSchema.nullable(),
@@ -290,12 +351,12 @@ var subscriptionPlanSchema = zod.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: zod.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(),
@@ -446,6 +507,16 @@ var submitRefundSignatureInputSchema = zod.z.object({
   id: idSchema,
   refundTxHash: evmTxHashSchema
 });
+var refundSigningInstructionsSchema = zod.z.object({
+  token: evmAddressSchema,
+  to: evmAddressSchema,
+  amount: tokenAmountSchema,
+  note: zod.z.string()
+});
+var refundCreateOutputSchema = zod.z.object({
+  refund: refundSchema,
+  signingInstructions: refundSigningInstructionsSchema
+});
 var webhookEventNameSchema = zod.z.enum([
   "payment.created",
   "payment.completed",
@@ -492,7 +563,7 @@ var createWebhookEndpointInputSchema = zod.z.object({
 });
 var createWebhookEndpointOutputSchema = zod.z.object({
   endpoint: webhookEndpointSchema,
-  /** Full signing secret — shown exactly once. */
+  /** Full signing secret. Shown exactly once. */
   signingSecret: zod.z.string()
 });
 var webhookDeliveryStatusSchema = zod.z.enum([
@@ -516,6 +587,11 @@ var webhookDeliverySchema = zod.z.object({
   deliveredAt: isoTimestampSchema.nullable(),
   createdAt: isoTimestampSchema
 });
+var webhookDeliveryDetailSchema = webhookDeliverySchema.extend({
+  deliveryId: zod.z.string(),
+  responseBody: zod.z.string().nullable(),
+  requestPayload: zod.z.record(zod.z.string(), zod.z.unknown())
+});
 var replayDeliveryInputSchema = zod.z.object({
   id: idSchema
 });
@@ -697,6 +773,18 @@ var createStorefrontProductInputSchema = storefrontProductSchema.omit({
 }).extend({
   imageUrl: httpsUrlSchema.optional()
 });
+var storefrontCheckoutInputSchema = zod.z.object({
+  customerEmail: zod.z.string().email().optional(),
+  returnPath: zod.z.string().max(200).optional()
+});
+var storefrontCheckoutResponseSchema = zod.z.object({
+  /** Fully-qualified checkout URL — payer redirects here to sign. */
+  checkoutUrl: zod.z.string().url(),
+  /** Payment-session id (one-time) or plan id (subscription). */
+  ref: idSchema,
+  /** Which downstream checkout the URL points at. */
+  kind: zod.z.enum(["payment_session", "subscription_plan"])
+});
 var invoiceStatusSchema = zod.z.enum(["draft", "sent", "paid", "overdue", "void"]);
 var invoiceLineItemSchema = zod.z.object({
   description: zod.z.string().min(1).max(500),
@@ -841,8 +929,8 @@ var tokenMetadataSchema = zod.z.object({
   symbol: zod.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: zod.z.string(),
@@ -854,7 +942,75 @@ var tokenPermitNonceSchema = zod.z.object({
   owner: addressSchema,
   nonce: zod.z.string().regex(/^[0-9]+$/u, "must be a decimal integer string")
 });
+var contactTopicSchema = zod.z.enum(["sales", "support", "partnership", "security", "other"]);
+var contactRequestInputSchema = zod.z.object({
+  name: zod.z.string().min(2).max(120),
+  email: emailSchema,
+  company: zod.z.string().min(1).max(120).optional(),
+  topic: contactTopicSchema,
+  message: zod.z.string().min(20).max(4e3)
+});
+var contactRequestOutputSchema = zod.z.object({
+  ok: zod.z.literal(true)
+});
+var notificationKindSchema = zod.z.enum([
+  "payment_received",
+  "subscription_started",
+  "refund_processed",
+  /** Message an admin broadcast to this merchant (or all merchants). */
+  "admin_broadcast"
+]);
+var broadcastAudienceSchema = zod.z.enum(["all", "merchant"]);
+var createBroadcastInputSchema = zod.z.object({
+  title: zod.z.string().min(4).max(160),
+  body: zod.z.string().min(4).max(4e3),
+  audience: broadcastAudienceSchema.default("all"),
+  /** Required when `audience === 'merchant'`; ignored otherwise. */
+  merchantId: zod.z.string().optional()
+}).refine((v) => v.audience !== "merchant" || !!v.merchantId, {
+  message: "merchantId is required when audience is merchant",
+  path: ["merchantId"]
+});
+var broadcastSchema = zod.z.object({
+  id: idSchema,
+  title: zod.z.string(),
+  body: zod.z.string(),
+  audience: broadcastAudienceSchema,
+  merchantId: idSchema.nullable(),
+  merchantEmail: zod.z.string().nullable(),
+  senderId: idSchema,
+  senderEmail: zod.z.string(),
+  emailedAt: isoTimestampSchema.nullable(),
+  createdAt: isoTimestampSchema
+});
+var broadcastListResponseSchema = zod.z.object({
+  data: zod.z.array(broadcastSchema)
+});
+var notificationSchema = zod.z.object({
+  /** Deterministic client id — `{kind}:{sourceId}`. Safe for React keys. */
+  id: zod.z.string().min(1),
+  kind: notificationKindSchema,
+  title: zod.z.string().min(1),
+  detail: zod.z.string(),
+  /** Dashboard route the tray links to. */
+  href: zod.z.string().min(1),
+  /** ISO timestamp of the source event; drives sort + read comparison. */
+  createdAt: isoTimestampSchema,
+  /** Server-derived from the merchant's `notificationsLastReadAt`. */
+  read: zod.z.boolean(),
+  /** Optional foreign key back to the source row (for deep-linking). */
+  sourceId: idSchema.optional()
+});
+var notificationListResponseSchema = zod.z.object({
+  data: zod.z.array(notificationSchema),
+  unreadCount: zod.z.number().int().min(0),
+  lastReadAt: isoTimestampSchema.nullable()
+});
+var markNotificationsReadResponseSchema = zod.z.object({
+  lastReadAt: isoTimestampSchema
+});
 
+exports.DEFAULT_MERCHANT_EMAIL_PREFS = DEFAULT_MERCHANT_EMAIL_PREFS;
 exports.agentActionExecutedEventSchema = agentActionExecutedEventSchema;
 exports.agentActionOutcomeSchema = agentActionOutcomeSchema;
 exports.agentActionTypeSchema = agentActionTypeSchema;
@@ -871,6 +1027,10 @@ exports.apiKeyKindSchema = apiKeyKindSchema;
 exports.apiKeySchema = apiKeySchema;
 exports.apiKeyScopeSchema = apiKeyScopeSchema;
 exports.arcEnvironmentSchema = arcEnvironmentSchema;
+exports.broadcastAudienceSchema = broadcastAudienceSchema;
+exports.broadcastListResponseSchema = broadcastListResponseSchema;
+exports.broadcastSchema = broadcastSchema;
+exports.callbackUrlSchema = callbackUrlSchema;
 exports.cancelSubscriptionInputSchema = cancelSubscriptionInputSchema;
 exports.changeTierInputSchema = changeTierInputSchema;
 exports.complianceLogSchema = complianceLogSchema;
@@ -879,10 +1039,14 @@ exports.complianceScreeningContextSchema = complianceScreeningContextSchema;
 exports.complianceStatusSchema = complianceStatusSchema;
 exports.complianceWalletBlockedEventSchema = complianceWalletBlockedEventSchema;
 exports.complianceWalletFlaggedEventSchema = complianceWalletFlaggedEventSchema;
+exports.contactRequestInputSchema = contactRequestInputSchema;
+exports.contactRequestOutputSchema = contactRequestOutputSchema;
+exports.contactTopicSchema = contactTopicSchema;
 exports.countryCodeSchema = countryCodeSchema;
 exports.createAgentJobInputSchema = createAgentJobInputSchema;
 exports.createApiKeyInputSchema = createApiKeyInputSchema;
 exports.createApiKeyOutputSchema = createApiKeyOutputSchema;
+exports.createBroadcastInputSchema = createBroadcastInputSchema;
 exports.createInvoiceInputSchema = createInvoiceInputSchema;
 exports.createMerchantInputSchema = createMerchantInputSchema;
 exports.createPaymentSessionInputSchema = createPaymentSessionInputSchema;
@@ -911,13 +1075,21 @@ exports.isoTimestampSchema = isoTimestampSchema;
 exports.loginInputSchema = loginInputSchema;
 exports.loginOutputSchema = loginOutputSchema;
 exports.makePaginatedSchema = makePaginatedSchema;
+exports.markNotificationsReadResponseSchema = markNotificationsReadResponseSchema;
+exports.merchantBalanceSchema = merchantBalanceSchema;
+exports.merchantEmailPrefsSchema = merchantEmailPrefsSchema;
 exports.merchantMemberSchema = merchantMemberSchema;
+exports.merchantPublicBrandSchema = merchantPublicBrandSchema;
 exports.merchantRoleSchema = merchantRoleSchema;
 exports.merchantSchema = merchantSchema;
 exports.merchantStatusSchema = merchantStatusSchema;
 exports.merchantTierSchema = merchantTierSchema;
 exports.metadataSchema = metadataSchema;
 exports.modeSchema = modeSchema;
+exports.notificationKindSchema = notificationKindSchema;
+exports.notificationListResponseSchema = notificationListResponseSchema;
+exports.notificationSchema = notificationSchema;
+exports.onboardMerchantInputSchema = onboardMerchantInputSchema;
 exports.paginationInputSchema = paginationInputSchema;
 exports.paymentCompletedEventSchema = paymentCompletedEventSchema;
 exports.paymentCreatedEventSchema = paymentCreatedEventSchema;
@@ -926,13 +1098,17 @@ exports.paymentFailedEventSchema = paymentFailedEventSchema;
 exports.paymentSessionSchema = paymentSessionSchema;
 exports.paymentSessionStatusSchema = paymentSessionStatusSchema;
 exports.refundCompletedEventSchema = refundCompletedEventSchema;
+exports.refundCreateOutputSchema = refundCreateOutputSchema;
 exports.refundCreatedEventSchema = refundCreatedEventSchema;
 exports.refundFailedEventSchema = refundFailedEventSchema;
 exports.refundReasonSchema = refundReasonSchema;
 exports.refundSchema = refundSchema;
+exports.refundSigningInstructionsSchema = refundSigningInstructionsSchema;
 exports.refundStatusSchema = refundStatusSchema;
 exports.replayDeliveryInputSchema = replayDeliveryInputSchema;
 exports.rotateApiKeyInputSchema = rotateApiKeyInputSchema;
+exports.storefrontCheckoutInputSchema = storefrontCheckoutInputSchema;
+exports.storefrontCheckoutResponseSchema = storefrontCheckoutResponseSchema;
 exports.storefrontProductSchema = storefrontProductSchema;
 exports.storefrontProductTypeSchema = storefrontProductTypeSchema;
 exports.storefrontSchema = storefrontSchema;
@@ -966,6 +1142,7 @@ exports.uintSchema = uintSchema;
 exports.updateAgentConfigInputSchema = updateAgentConfigInputSchema;
 exports.updateMerchantInputSchema = updateMerchantInputSchema;
 exports.upsertCustomerInputSchema = upsertCustomerInputSchema;
+exports.webhookDeliveryDetailSchema = webhookDeliveryDetailSchema;
 exports.webhookDeliverySchema = webhookDeliverySchema;
 exports.webhookDeliveryStatusSchema = webhookDeliveryStatusSchema;
 exports.webhookEndpointSchema = webhookEndpointSchema;