@coin-voyage/shared 2.4.0-beta.3 → 2.4.0-beta.4

package/dist/api/client.js

@@ -1,7 +1,7 @@
 import { createHmac } from "crypto";
-import { now } from "../utils/time";
 import { zPayOrder, zPayOrderMetadata } from "../schemas/pay-order";
 import { PayOrderMode } from "../types/enums";
+import { now } from "../utils/time";
 import { WS_URL } from "./config";
 import { fetchApi } from "./fetcher";
 export class ApiClient {

package/dist/schemas/pay-order.d.ts

@@ -16,6 +16,9 @@ export declare const zPayOrderMetadata: z.ZodObject<{
         currency: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
 }, z.core.$catchall<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodAny>, z.ZodObject<{}, z.core.$loose>]>>>;
+export declare const zPayOrderSettings: z.ZodObject<{
+    hide_footer: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
 export declare const zPayOrder: z.ZodObject<{
     metadata: z.ZodOptional<z.ZodObject<{
         items: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -34,6 +37,9 @@ export declare const zPayOrder: z.ZodObject<{
             currency: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>>;
     }, z.core.$catchall<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodAny>, z.ZodObject<{}, z.core.$loose>]>>>>;
+    settings: z.ZodOptional<z.ZodObject<{
+        hide_footer: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
     intent: z.ZodObject<{
         asset: z.ZodOptional<z.ZodObject<{
             chain_id: z.ZodNumber;

package/dist/schemas/pay-order.js

@@ -41,9 +41,15 @@ export const zPayOrderMetadata = z
 }, {
     message: "A maximum of 20 additional custom fields is allowed",
 });
+// NOTE: be careful to modify this type only in backward-compatible ways.
+// Add OPTIONAL fields, etc. Anything else requires a migration.
+export const zPayOrderSettings = z.object({
+    hide_footer: z.boolean().optional().describe("Hide the Coin Voyage footer in supported payment UIs."),
+});
 // also validate not both token_amount and fiat are present
 export const zPayOrder = z.object({
     metadata: zPayOrderMetadata.optional(),
+    settings: zPayOrderSettings.optional(),
     intent: z
         .object({
         asset: z

package/dist/types/api.d.ts

@@ -1,7 +1,7 @@
 import { FiatCurrency } from "../currency/currencies";
 import { ChainId, ChainType, PaymentMethod, PaymentRail, PayOrderStatus } from "./enums";
 import { PayOrderEvent } from "./events";
-import { CurrencyAmount, CurrencyBase, CurrencyWithAmount, FiatAmount, PaymentData, PayOrderMetadata, QuoteWithCurrency } from "./model";
+import { CurrencyAmount, CurrencyBase, CurrencyWithAmount, FiatAmount, PaymentData, PayOrderMetadata, PayOrderSettings, QuoteWithCurrency } from "./model";
 export type PayOrderParams = {
     /**
      * Intent of the order.
@@ -11,6 +11,10 @@ export type PayOrderParams = {
      * Metadata to attach to the payOrder.
      */
     metadata?: PayOrderMetadata;
+    /**
+     * UI and behavior settings to attach to the payOrder.
+     */
+    settings?: PayOrderSettings;
 };
 export type PayOrderQuoteParams = {
     wallet_address: string;

package/dist/types/model.d.ts

@@ -1,18 +1,21 @@
 import { z } from "zod";
 import { FiatCurrency } from "../currency/currencies";
-import { zPayOrderMetadata } from "../schemas/pay-order";
+import { zPayOrderMetadata, zPayOrderSettings } from "../schemas/pay-order";
 import { ChainId, PaymentRail, PayOrderMode, PayOrderStatus, ProviderStatus, StepKind } from "./enums";
 export type PayOrder = {
     id: string;
     mode: PayOrderMode;
     status: PayOrderStatus;
     metadata?: ParsedPayOrderMetadata;
+    settings?: ParsedPayOrderSettings;
     fulfillment: FulfillmentData;
     payment?: PaymentData;
 };
 type MetadataExtraFields = Record<string, unknown>;
 export type ParsedPayOrderMetadata = z.output<typeof zPayOrderMetadata> & MetadataExtraFields;
 export type PayOrderMetadata = z.infer<typeof zPayOrderMetadata>;
+export type ParsedPayOrderSettings = z.output<typeof zPayOrderSettings>;
+export type PayOrderSettings = z.infer<typeof zPayOrderSettings>;
 export interface Currency extends CurrencyBase {
     id?: string;
     name: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coin-voyage/shared",
   "description": "Shared utilities for Coin Voyage",
-  "version": "2.4.0-beta.3",
+  "version": "2.4.0-beta.4",
   "private": false,
   "sideEffects": false,
   "exports": {