@odingard/guardian-sdk 0.0.0-stage → 0.2.0

package/dist-dts/contracts/commerce.d.ts

@@ -0,0 +1,133 @@
+import { z } from "zod";
+import type { TaskId } from "./identifiers.js";
+export declare const CommercePurchaseParametersV1Schema: z.ZodObject<{
+    schema: z.ZodLiteral<"commerce.purchase.v1">;
+    connectionId: z.core.$ZodBranded<z.ZodString, "ConnectionId", "out">;
+    merchantId: z.ZodString;
+    merchantCategory: z.ZodString;
+    amountCents: z.ZodNumber;
+    currency: z.ZodLiteral<"USD">;
+    orderDescription: z.ZodString;
+    idempotencyKey: z.ZodString;
+    taskId: z.ZodOptional<z.core.$ZodBranded<z.ZodString, "TaskId", "out">>;
+}, z.core.$strict>;
+export declare const CommerceRefundParametersV1Schema: z.ZodObject<{
+    schema: z.ZodLiteral<"commerce.refund.v1">;
+    connectionId: z.core.$ZodBranded<z.ZodString, "ConnectionId", "out">;
+    chargeId: z.ZodString;
+    amountCents: z.ZodOptional<z.ZodNumber>;
+    reason: z.ZodString;
+}, z.core.$strict>;
+export declare const CommerceReturnParametersV1Schema: z.ZodObject<{
+    schema: z.ZodLiteral<"commerce.return.v1">;
+    connectionId: z.core.$ZodBranded<z.ZodString, "ConnectionId", "out">;
+    chargeId: z.ZodString;
+    reason: z.ZodString;
+}, z.core.$strict>;
+export declare const SubscriptionCreateParametersV1Schema: z.ZodObject<{
+    schema: z.ZodLiteral<"subscription.create.v1">;
+    connectionId: z.core.$ZodBranded<z.ZodString, "ConnectionId", "out">;
+    merchantId: z.ZodString;
+    planId: z.ZodString;
+    amountCents: z.ZodNumber;
+    currency: z.ZodLiteral<"USD">;
+    interval: z.ZodEnum<{
+        week: "week";
+        month: "month";
+        year: "year";
+    }>;
+    idempotencyKey: z.ZodString;
+}, z.core.$strict>;
+export type CommercePurchaseParametersV1 = z.infer<typeof CommercePurchaseParametersV1Schema>;
+export type CommerceRefundParametersV1 = z.infer<typeof CommerceRefundParametersV1Schema>;
+export type CommerceReturnParametersV1 = z.infer<typeof CommerceReturnParametersV1Schema>;
+export type SubscriptionCreateParametersV1 = z.infer<typeof SubscriptionCreateParametersV1Schema>;
+/**
+ * Generic monetary-authority facts a registered action derives from its
+ * validated parameters. The envelope's declared facts must equal these —
+ * an agent cannot understate an amount or smuggle a category, because the
+ * kernel re-derives the facts from the digested material parameters.
+ */
+export type ActionAuthorityFacts = Readonly<{
+    valueCents?: number;
+    merchantId?: string;
+    merchantCategory?: string;
+    recurring?: boolean;
+    taskId?: TaskId;
+}>;
+export declare function commercePurchaseVerificationProjection(input: CommercePurchaseParametersV1): Readonly<{
+    domain: "odingard.guardian.commerce-projection.v1";
+    action: "commerce.purchase";
+    connectionId: string & z.core.$brand<"ConnectionId">;
+    merchantId: string;
+    merchantCategory: string;
+    amountCents: number;
+    currency: "USD";
+    descriptionDigest: string;
+    idempotencyKey: string;
+    taskId: (string & z.core.$brand<"TaskId">) | null;
+}>;
+export declare function commercePurchaseEnvelopeProjection(input: CommercePurchaseParametersV1): Readonly<{
+    domain: "odingard.guardian.commerce-projection.v1";
+    action: "commerce.purchase";
+    connectionId: string & z.core.$brand<"ConnectionId">;
+    merchantId: string;
+    merchantCategory: string;
+    amountCents: number;
+    currency: "USD";
+    descriptionDigest: string;
+    idempotencyKey: string;
+    taskId: (string & z.core.$brand<"TaskId">) | null;
+}>;
+export declare function commerceRefundVerificationProjection(input: CommerceRefundParametersV1): Readonly<{
+    domain: "odingard.guardian.commerce-projection.v1";
+    action: "commerce.refund";
+    connectionId: string & z.core.$brand<"ConnectionId">;
+    chargeId: string;
+    amountCents: number | null;
+    reasonDigest: string;
+}>;
+export declare function commerceRefundEnvelopeProjection(input: CommerceRefundParametersV1): Readonly<{
+    domain: "odingard.guardian.commerce-projection.v1";
+    action: "commerce.refund";
+    connectionId: string & z.core.$brand<"ConnectionId">;
+    chargeId: string;
+    amountCents: number | null;
+    reasonDigest: string;
+}>;
+export declare function commerceReturnVerificationProjection(input: CommerceReturnParametersV1): Readonly<{
+    domain: "odingard.guardian.commerce-projection.v1";
+    action: "commerce.return";
+    connectionId: string & z.core.$brand<"ConnectionId">;
+    chargeId: string;
+    reasonDigest: string;
+}>;
+export declare function commerceReturnEnvelopeProjection(input: CommerceReturnParametersV1): Readonly<{
+    domain: "odingard.guardian.commerce-projection.v1";
+    action: "commerce.return";
+    connectionId: string & z.core.$brand<"ConnectionId">;
+    chargeId: string;
+    reasonDigest: string;
+}>;
+export declare function subscriptionCreateVerificationProjection(input: SubscriptionCreateParametersV1): Readonly<{
+    domain: "odingard.guardian.commerce-projection.v1";
+    action: "subscription.create";
+    connectionId: string & z.core.$brand<"ConnectionId">;
+    merchantId: string;
+    planId: string;
+    amountCents: number;
+    currency: "USD";
+    interval: "week" | "month" | "year";
+    idempotencyKey: string;
+}>;
+export declare function subscriptionCreateEnvelopeProjection(input: SubscriptionCreateParametersV1): Readonly<{
+    domain: "odingard.guardian.commerce-projection.v1";
+    action: "subscription.create";
+    connectionId: string & z.core.$brand<"ConnectionId">;
+    merchantId: string;
+    planId: string;
+    amountCents: number;
+    currency: "USD";
+    interval: "week" | "month" | "year";
+    idempotencyKey: string;
+}>;