@nuanu-ai/agentify-contracts 0.6.0 → 0.8.0

package/dist/index.js

@@ -22,37 +22,43 @@
  */
 import { z } from "zod";
 import { AgentOrderStatusSchema, CatalogPageSchema, ErrorEnvelopeSchema, MerchantCardListSchema, OrderAcceptResponseSchema, OrderCallResponseSchema, OrderListQuerySchema, OrderListSchema, OrderWithStatusSchema, PurchaseRequestSchema, QuoteAnswerAckSchema, ReceiptListSchema, WorkerPollRequestSchema, WorkerPollResponseSchema, } from "./api.js";
-import { CardSchema, FulfillmentSchema, MerchantCardSchema, PriceCheckSchema, PublicCardSchema, ServiceNameSchema, TagsSchema, } from "./card.js";
+import { CardSchema, FulfillmentSchema, MerchantCardSchema, PriceCheckSchema, PublicCardSchema, SellerSchema, ServiceNameSchema, TagsSchema, } from "./card.js";
 import { WorkerEnvelopeSchema } from "./envelope.js";
 import { OrderEventSchema, RefundDueReasonSchema } from "./events.js";
 import { EvmAddressSchema } from "./evm-address.js";
 import { AcceptanceSchema, DeliverySchema, HandlerAnswerSchema, RefusalCodeSchema, RefusalSchema, } from "./handler.js";
-import { CabinetKeySchema, DisabledKeySchema, ForgottenCabinetKeySchema, IssuedKeySchema, IssueKeyRequestSchema, MerchantKeyListSchema, MerchantKeySchema, PayoutWalletRequestSchema, PayoutWalletSchema, PendingPayoutWalletSchema, RegisteredMerchantSchema, RegistrationRequestSchema, SellerNameRequestSchema, SellerNameSchema, } from "./merchant.js";
+import { DisabledKeySchema, IssuedKeySchema, IssueKeyRequestSchema, MerchantKeyListSchema, MerchantKeySchema, PayoutWalletSchema, PendingPayoutWalletSchema, SellerNameRequestSchema, SellerNameSchema, } from "./merchant.js";
 import { OrderSchema } from "./order.js";
 import { OrderStatusSchema } from "./order-status.js";
 import { FieldSpecSchema, ParamNameSchema, ParamSpecSchema, ParamTypeSchema, } from "./param-spec.js";
-import { AmountSchema, CurrencyCodeSchema, IdentifierSchema, MoneySchema, SalePriceSchema, TimestampSchema, } from "./primitives.js";
+import { AmountSchema, CurrencyCodeSchema, IdentifierSchema, MoneySchema, OpenWordSchema, SalePriceSchema, TimestampSchema, } from "./primitives.js";
 import { QuotePurposeSchema, QuoteRequestSchema, QuoteResponseSchema } from "./quote.js";
 import { ReceiptOutcomeSchema, ReceiptSchema } from "./receipt.js";
 import { CallErrorSchema, OrderCallResultSchema, ProblemSchema, PublishResultSchema, } from "./results.js";
+import { SellerSiteSchema } from "./seller-site.js";
 import { SellingStateSchema } from "./selling.js";
-export { AgentOrderStatusSchema, API_ROUTES, AUTH_MODES, CatalogPageSchema, ERROR_CODES, ErrorEnvelopeSchema, expandPath, HTTP_METHODS, MERCHANT_KEY_HEADER, MerchantCardListSchema, merchantKeyFrom, merchantKeyHeaderValue, mountableRoutes, OrderAcceptResponseSchema, OrderCallResponseSchema, OrderListQuerySchema, OrderListSchema, OrderWithStatusSchema, PurchaseRequestSchema, pathParamsOf, QuoteAnswerAckSchema, ReceiptListSchema, WorkerPollRequestSchema, WorkerPollResponseSchema, } from "./api.js";
-export { bazaarDeclarationOf, CardSchema, deliveryCheckFor, FulfillmentSchema, MerchantCardSchema, PriceCheckSchema, PublicCardSchema, publicCardOf, purchaseCheckFor, ServiceNameSchema, TagsSchema, } from "./card.js";
+import { ErasedShipToSchema, ShipToLocalitySchema, ShipToSchema } from "./ship-to.js";
+import { RecordedShipmentSchema, ShipmentSchema } from "./shipment.js";
+export { AgentOrderStatusSchema, API_ROUTES, AUTH_MODES, CatalogPageSchema, cardsOf, ERROR_CODES, ErrorEnvelopeSchema, expandPath, HTTP_METHODS, MERCHANT_KEY_HEADER, MerchantCardListSchema, merchantKeyFrom, merchantKeyHeaderValue, mountableRoutes, OrderAcceptResponseSchema, OrderCallResponseSchema, OrderListQuerySchema, OrderListSchema, OrderWithStatusSchema, PurchaseRequestSchema, pathParamsOf, QuoteAnswerAckSchema, ReceiptListSchema, WorkerPollRequestSchema, WorkerPollResponseSchema, } from "./api.js";
+export { bazaarDeclarationOf, CardSchema, deliveryCheckFor, FulfillmentSchema, MerchantCardSchema, PriceCheckSchema, PublicCardSchema, publicCardOf, purchaseCheckFor, SellerSchema, ServiceNameSchema, TagsSchema, } from "./card.js";
 export { WORKER_ENVELOPE_KINDS, WORKER_ENVELOPE_PAYLOADS, WorkerEnvelopeSchema, } from "./envelope.js";
 export { ORDER_EVENT_TYPES, OrderEventSchema, RefundDueReasonSchema } from "./events.js";
 export { checksummedAddressOf, EvmAddressSchema } from "./evm-address.js";
 export { AcceptanceSchema, DeliverySchema, HandlerAnswerSchema, RECOMMENDED_REFUSAL_CODES, RefusalCodeSchema, RefusalSchema, } from "./handler.js";
-export { CabinetKeySchema, DisabledKeySchema, ForgottenCabinetKeySchema, IssuedKeySchema, IssueKeyRequestSchema, MerchantKeyListSchema, MerchantKeySchema, PayoutWalletRequestSchema, PayoutWalletSchema, PendingPayoutWalletSchema, RegisteredMerchantSchema, RegistrationRequestSchema, SellerNameRequestSchema, SellerNameSchema, } from "./merchant.js";
+export { DisabledKeySchema, IssuedKeySchema, IssueKeyRequestSchema, MerchantKeyListSchema, MerchantKeySchema, PayoutWalletSchema, PendingPayoutWalletSchema, SellerNameRequestSchema, SellerNameSchema, } from "./merchant.js";
 export { OrderSchema } from "./order.js";
 export { ORDER_STATUSES, OrderStatusSchema } from "./order-status.js";
 export { FieldSpecSchema, ParamNameSchema, ParamSpecSchema, ParamTypeSchema, PROTOTYPE_KEY_IS_DROPPED, paramSpecToValidator, } from "./param-spec.js";
 export { notPlainTextIn } from "./plain-text.js";
 export { PAYABLE_CURRENCIES, PAYABLE_DECIMALS, priceProblemsOf } from "./price-rule.js";
-export { AmountSchema, CurrencyCodeSchema, IdentifierSchema, MoneySchema, SalePriceSchema, TimestampSchema, } from "./primitives.js";
+export { AmountSchema, CurrencyCodeSchema, IdentifierSchema, MoneySchema, OpenWordSchema, SalePriceSchema, TimestampSchema, } from "./primitives.js";
 export { QuotePurposeSchema, QuoteRequestSchema, QuoteResponseSchema } from "./quote.js";
 export { ReceiptOutcomeSchema, ReceiptSchema } from "./receipt.js";
 export { CARD_REJECTED, CallErrorSchema, MERCHANT_FINDINGS, ORDER_CALL_ERROR_CODES, ORDER_CALL_RESULTS, OrderCallResultSchema, ProblemSchema, PublishResultSchema, } from "./results.js";
+export { SellerSiteSchema } from "./seller-site.js";
 export { SELLING_STATES, SellingStateSchema } from "./selling.js";
+export { ErasedShipToSchema, localityOf, ShipToLocalitySchema, ShipToSchema, } from "./ship-to.js";
+export { RecordedShipmentSchema, ShipmentSchema } from "./shipment.js";
 /**
  * The version of the public contract. It grows when the meaning of the fields
  * changes, not when a schema is added: a consumer uses it to decide whether it
@@ -76,17 +82,16 @@ export const schemas = Object.freeze({
     acceptance: AcceptanceSchema,
     agent_order_status: AgentOrderStatusSchema,
     amount: AmountSchema,
-    cabinet_key: CabinetKeySchema,
     call_error: CallErrorSchema,
     card: CardSchema,
     catalog_page: CatalogPageSchema,
     currency_code: CurrencyCodeSchema,
     delivery: DeliverySchema,
     disabled_key: DisabledKeySchema,
+    erased_ship_to: ErasedShipToSchema,
     error_envelope: ErrorEnvelopeSchema,
     evm_address: EvmAddressSchema,
     field_spec: FieldSpecSchema,
-    forgotten_cabinet_key: ForgottenCabinetKeySchema,
     fulfillment: FulfillmentSchema,
     handler_answer: HandlerAnswerSchema,
     identifier: IdentifierSchema,
@@ -97,6 +102,7 @@ export const schemas = Object.freeze({
     merchant_key: MerchantKeySchema,
     merchant_key_list: MerchantKeyListSchema,
     money: MoneySchema,
+    open_word: OpenWordSchema,
     order: OrderSchema,
     order_accept_response: OrderAcceptResponseSchema,
     order_call_response: OrderCallResponseSchema,
@@ -110,7 +116,6 @@ export const schemas = Object.freeze({
     param_spec: ParamSpecSchema,
     param_type: ParamTypeSchema,
     payout_wallet: PayoutWalletSchema,
-    payout_wallet_request: PayoutWalletRequestSchema,
     pending_payout_wallet: PendingPayoutWalletSchema,
     price_check: PriceCheckSchema,
     problem: ProblemSchema,
@@ -124,16 +129,20 @@ export const schemas = Object.freeze({
     receipt: ReceiptSchema,
     receipt_list: ReceiptListSchema,
     receipt_outcome: ReceiptOutcomeSchema,
-    registered_merchant: RegisteredMerchantSchema,
-    registration_request: RegistrationRequestSchema,
     refund_due_reason: RefundDueReasonSchema,
     refusal: RefusalSchema,
     refusal_code: RefusalCodeSchema,
     sale_price: SalePriceSchema,
+    seller: SellerSchema,
     seller_name: SellerNameSchema,
     seller_name_request: SellerNameRequestSchema,
     selling_state: SellingStateSchema,
+    seller_site: SellerSiteSchema,
     service_name: ServiceNameSchema,
+    ship_to: ShipToSchema,
+    ship_to_locality: ShipToLocalitySchema,
+    shipment: ShipmentSchema,
+    recorded_shipment: RecordedShipmentSchema,
     tags: TagsSchema,
     timestamp: TimestampSchema,
     worker_envelope: WorkerEnvelopeSchema,

package/dist/merchant.d.ts

@@ -1,19 +1,16 @@
 /**
- * How a merchant comes to exist, the name their products are sold under, the
- * wallet their sales are paid into, and the keys they open the door with.
+ * What a merchant says about themselves: the name their products are sold
+ * under, the wallet their sales are paid into, and the keys they open the door
+ * with.
  *
- * The first two belong together because registering is the act that produces
- * both: one call makes the merchant and the key its cabinet will call as them
- * with, and what comes back carries that key once. Split across two files, a
- * reader working out what registering leaves a merchant holding would have to
- * read both to find that it is a key of a kind no list here carries. The name is here for the same reason read the other way round — it is a
- * fact about the merchant and about none of their cards, and the one question a
- * reader arrives with is which of the two names a merchant has is which.
+ * The name is here rather than beside the card because it is a fact about the
+ * merchant and about none of their cards, and the one question a reader
+ * arrives with is which of the two names a merchant has is which.
  *
  * Two rules run through the file and are worth saying once.
  *
- * The secret appears in exactly three documents, and every one of them is the
- * answer to a call that has just made a key. Nothing that is ever drawn again —
+ * The secret appears in one document, the answer to the call that has just
+ * made a key. Nothing that is ever drawn again —
  * the list a merchant reads, the row that comes back from disabling one — can
  * carry it, and the shapes below refuse it rather than merely omit it. What is
  * kept on our side is a digest, so there is nothing to put in those documents
@@ -51,11 +48,8 @@ export declare const MerchantKeySchema: z.ZodObject<{
  * refuses, on the one page where being refused looks like the product being
  * broken.
  *
- * It is not always one of the keys beside it, and that is the thing a reader is
- * likeliest to assume and be wrong about. A cabinet calls with a key made for a
- * cabinet, and those are in nobody's list, so a client that looked this
- * identifier up among the rows would find nothing — which is an answer rather
- * than an error, and a screen has to be built for it.
+ * It is always one of the keys beside it: every key is one a merchant issued
+ * for their own code, and the dashboard calls with none (ADR-0030).
  *
  * An object rather than a bare array, for that reason before any other — an
  * array has nowhere to put it.
@@ -108,34 +102,6 @@ export declare const DisabledKeySchema: z.ZodObject<{
         disabled_at: z.ZodNullable<z.ZodISODateTime>;
     }, z.core.$strict>;
 }, z.core.$strict>;
-/**
- * A key made for a cabinet, which is the secret and nothing else.
- *
- * Every other answer that makes a key carries the row beside it, and this one
- * cannot. A key made for a cabinet is in no merchant's list — they did not
- * issue it and have no reason to know it exists — so an identifier here would
- * name a row that no screen of theirs draws and no call of theirs reaches: not
- * the list it is absent from, and not the revoking, which takes the keys a
- * merchant issued and refuses this kind by name. What the caller does with this
- * is put it on the row of whoever just signed in, and that is the whole of what
- * it needs.
- */
-export declare const CabinetKeySchema: z.ZodObject<{
-    secret: z.ZodString;
-}, z.core.$strict>;
-/**
- * That the key a call was made with is gone.
- *
- * A constant, and deliberately: the call has one outcome. It removes the key it
- * was made with and no other, so there is nothing to count — a number here
- * could only be about rows this call cannot reach — and nothing to name, since
- * the caller is holding the only key it names. What is left to say is that it
- * is done, and it is said in a field rather than left to a status code so that
- * a client reads one document and not two kinds of evidence.
- */
-export declare const ForgottenCabinetKeySchema: z.ZodObject<{
-    forgotten: z.ZodLiteral<true>;
-}, z.core.$strict>;
 /**
  * What a merchant's products are sold under, as the merchant reads it back.
  *
@@ -155,6 +121,7 @@ export declare const ForgottenCabinetKeySchema: z.ZodObject<{
  */
 export declare const SellerNameSchema: z.ZodObject<{
     seller_name: z.ZodNullable<z.ZodString>;
+    seller_site: z.ZodNullable<z.ZodString>;
 }, z.core.$strict>;
 /**
  * What a merchant sends to change what their products are sold under.
@@ -169,13 +136,14 @@ export declare const SellerNameSchema: z.ZodObject<{
  * which is this same call, or an end to selling, which is the pause — and the
  * pause leaves their cards where they can find them again.
  *
- * So it is two documents rather than one, and a cabinet still reads back the
+ * So it is two documents rather than one, and a dashboard still reads back the
  * shape it sent. The message on a null is written here rather than left to a
  * type error, because "expected string, received null" describes the shape and
  * says nothing about which act the sender was reaching for.
  */
 export declare const SellerNameRequestSchema: z.ZodObject<{
-    seller_name: z.ZodPipe<z.ZodString, z.ZodString>;
+    seller_name: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodString>>;
+    seller_site: z.ZodOptional<z.ZodPipe<z.ZodString, z.ZodString>>;
 }, z.core.$strict>;
 /**
  * A change of the wallet that has been asked for, announced, and has not taken
@@ -183,10 +151,9 @@ export declare const SellerNameRequestSchema: z.ZodObject<{
  *
  * It exists because a replacement does not apply at once where the money is
  * real (ADR-0019). The address a merchant is paid at is the one setting whose
- * change redirects money, and any key of theirs reaches it — the cabinet's, or
- * one sitting in their own server's environment — so on the live deployment a
- * replacement is told to every account of the merchant first and takes effect
- * forty-eight hours after that. What this document says is the two facts a
+ * change redirects money, and a dashboard session that is not the owner's could
+ * ask for one, so on the live deployment a replacement is told to every account
+ * of the merchant first and takes effect forty-eight hours after that. What this document says is the two facts a
  * merchant needs in that window: what replaces the address, and from when.
  *
  * Both are required. An address with no moment says nothing about when the
@@ -228,9 +195,10 @@ export declare const PendingPayoutWalletSchema: z.ZodObject<{
  * without this they would ask again, or conclude the change was lost.
  *
  * It is carried without moving `CONTRACT_VERSION`, which is the one known
- * exception to the rule that a new required field moves it (ADR-0006 §2): no
- * worker of the SDK reads this route, so the version would stop every
- * installed worker for a field none of them sees. What that costs is that a
+ * exception to the rule that a new required field moves it once a merchant we
+ * do not control runs the SDK (ADR-0006 §2): no worker of the SDK reads this
+ * route, so the version would stop every installed worker for a field none of
+ * them sees. What that costs is that a
  * merchant's own code holding this schema from an older release of this
  * package refuses the answer until the package is upgraded.
  */
@@ -241,79 +209,12 @@ export declare const PayoutWalletSchema: z.ZodObject<{
         takes_effect_at: z.ZodISODateTime;
     }, z.core.$strict>>;
 }, z.core.$strict>;
-/**
- * What a merchant sends to change where their sales are paid.
- *
- * The same field held to the same rule, and one difference, which is the same
- * difference the seller name has and rests on something harder. There is no
- * null. A merchant goes from having no wallet to having one and from one wallet
- * to another, and not back: a merchant who took their address away would keep
- * every card they had already published on sale, and the payment request an
- * agent is answered with cannot be built at all without an address — so the
- * products would stop being buyable and nothing anywhere would say why. What
- * somebody reaching for null actually wants is one of two other acts: a
- * different address, which is this same call, or an end to selling, which is
- * the pause, and the pause leaves their cards where they can put them back.
- *
- * There is nowhere here to put a key, and a document carrying one is refused
- * rather than trimmed. This contract knows where a merchant is paid and has no
- * business knowing anything that could spend it.
- */
-export declare const PayoutWalletRequestSchema: z.ZodObject<{
-    payout_wallet: z.ZodPipe<z.ZodString, z.ZodString>;
-}, z.core.$strict>;
-/**
- * What somebody sends to become a merchant.
- *
- * One field, and what is not here is most of what is worth reading. The address
- * and the password belong to the account rather than to the merchant, and they
- * stay on the other side of the boundary (ADR-0014 §1) — a gateway that took
- * either would be holding a person's credentials on the money path, which is
- * what this route's whole shape is arranged to avoid.
- *
- * The name the seller's products are sold under is not here either, and that
- * omission is a decision rather than a simplification. It is a public answer,
- * and asking for it here asks for it at the one moment a merchant knows least:
- * no products, no catalogue seen, no idea what the name is for. It is asked for
- * on the screen after this one instead, where there is room to say why it
- * matters, and it can be changed afterwards from the merchant's own settings.
- *
- * The shape refuses a name rather than ignoring one, because a field quietly
- * dropped is a person believing they have chosen what buyers will read.
- */
-export declare const RegistrationRequestSchema: z.ZodObject<{
-    invitation: z.ZodString;
-}, z.core.$strict>;
-/**
- * What registering answers with: a merchant and the key their cabinet will call
- * as them with.
- *
- * The key is made for a cabinet rather than for the merchant's own code, and
- * that is what the caller of this route is. So it is in no list: a merchant who
- * has just registered has no keys of their own at all, and the first one they
- * do have is one they ask for. No row travels beside the secret for the same
- * reason no row appears in the list — the merchant did not issue it and cannot
- * disable it, so an identifier for it would be a value with nothing to do.
- *
- * No name comes back either, because none was chosen. A merchant who has just
- * registered is listed under nothing at all, and a field here would either be a
- * name this call invented or a null that says the same thing at more length.
- */
-export declare const RegisteredMerchantSchema: z.ZodObject<{
-    merchant_id: z.ZodString;
-    secret: z.ZodString;
-}, z.core.$strict>;
 export type SellerName = z.infer<typeof SellerNameSchema>;
 export type SellerNameRequest = z.infer<typeof SellerNameRequestSchema>;
 export type PayoutWallet = z.infer<typeof PayoutWalletSchema>;
-export type PayoutWalletRequest = z.infer<typeof PayoutWalletRequestSchema>;
 export type PendingPayoutWallet = z.infer<typeof PendingPayoutWalletSchema>;
 export type MerchantKey = z.infer<typeof MerchantKeySchema>;
 export type MerchantKeyList = z.infer<typeof MerchantKeyListSchema>;
 export type IssueKeyRequest = z.infer<typeof IssueKeyRequestSchema>;
 export type IssuedKey = z.infer<typeof IssuedKeySchema>;
 export type DisabledKey = z.infer<typeof DisabledKeySchema>;
-export type CabinetKey = z.infer<typeof CabinetKeySchema>;
-export type ForgottenCabinetKey = z.infer<typeof ForgottenCabinetKeySchema>;
-export type RegistrationRequest = z.infer<typeof RegistrationRequestSchema>;
-export type RegisteredMerchant = z.infer<typeof RegisteredMerchantSchema>;