@chevre/factory 4.393.0-alpha.21 → 4.393.0-alpha.23

package/lib/action/trade/pay.d.ts

@@ -5,13 +5,15 @@ import { ActionType } from '../../actionType';
 import { AssetTransactionType } from '../../assetTransactionType';
 import { CreativeWorkType } from '../../creativeWorkType';
 import { IPaymentServiceOutput } from '../../invoice';
-import { ITotalPaymentDue, OrderType } from '../../order';
+import { IOrder, ITotalPaymentDue, OrderType } from '../../order';
 import { IMovieTicketPaymentCard } from '../../paymentMethod/paymentCard/movieTicket';
 import { IPropertyValue } from '../../propertyValue';
 import { IAlterTranResult, IRecipe as IPayCreditCardRecipe } from '../../recipe/payCreditCard';
 import { IRecipe as IPayMovieTicketRecipe, ISeatInfoSyncIn, ISeatInfoSyncResult } from '../../recipe/payMovieTicket';
 import { PaymentServiceType } from '../../service/paymentService';
+import { IAction as IAuthorizeInvoiceAction } from '../authorize/invoice';
 import { IPayTransactionAsPurpose, IRefundTransactionAsPurpose } from '../interact/inform';
+import { IAction as IRefundAction } from './refund';
 export { IAlterTranResult, ISeatInfoSyncIn, ISeatInfoSyncResult, IPayCreditCardRecipe, IPayMovieTicketRecipe };
 export import IAgent = ActionFactory.IParticipantAsProject;
 export import IRecipient = ActionFactory.IParticipantAsSeller;
@@ -97,7 +99,7 @@ export interface IPaymentService {
 export type IObject = [IPaymentService];
 export interface IInformPayment {
     purpose: IPayTransactionAsPurpose | IRefundTransactionAsPurpose;
-    recipient: Pick<ActionFactory.IParticipantAsSeller, 'id' | 'name' | 'typeOf'>;
+    recipient?: never;
     /**
      * potentialAction id
      */
@@ -107,11 +109,15 @@ export interface IPotentialActions {
     add2report: boolean;
     informPayment?: IInformPayment[];
 }
-export interface IInstrument {
+export type IOrderAsInstrument = Pick<IOrder, 'orderNumber' | 'typeOf'>;
+export type IAuthorizeActionAsInstrument = Pick<IAuthorizeInvoiceAction, 'id' | 'typeOf'>;
+export interface IPayTransactionAsInstrument {
     id: string;
     transactionNumber: string;
     typeOf: AssetTransactionType.Pay;
 }
+export type IRefundActionAsInstrument = Pick<IRefundAction, 'id' | 'typeOf'>;
+export type IInstrument = IPayTransactionAsInstrument | IOrderAsInstrument | IAuthorizeActionAsInstrument | IRefundActionAsInstrument;
 export interface IResult {
 }
 export interface ILocation {
@@ -124,11 +130,10 @@ export interface ILocation {
 export interface IAttributes extends Pick<ActionFactory.IAttributes<ActionType.PayAction, IObject, IResult>, 'agent' | 'error' | 'instrument' | 'location' | 'object' | 'potentialActions' | 'purpose' | 'recipient' | 'result' | 'project' | 'sameAs' | 'typeOf'> {
     agent: IAgent;
     /**
-     * redefine IInstrument(2024-06-15~)
      * 注文決済の場合、決済取引として存在(2024-06-15~)
      * 返品手数料決済の場合、存在しない
      */
-    instrument?: IInstrument;
+    instrument?: IPayTransactionAsInstrument | IInstrument[];
     potentialActions?: IPotentialActions;
     purpose: IPurpose;
     recipient: IRecipient;

package/lib/action/trade/refund.d.ts

@@ -1,9 +1,11 @@
 import * as ActionFactory from '../../action';
 import { ActionType } from '../../actionType';
+import { IOrder } from '../../order';
 import { IAlterTranResult, IRecipe as IRefundCreditCardRecipe } from '../../recipe/refundCreditCard';
 import { IRecipe as IRefundMovieTicketRecipe, ISeatInfoSyncCancelIn, ISeatInfoSyncCancelResult, ISeatInfoSyncIn, ISeatInfoSyncResult } from '../../recipe/refundMovieTicket';
 import { TransactionType } from '../../transactionType';
 import { IRefundTransactionAsPurpose } from '../interact/inform';
+import { IAction as IReturnInvoiceAction } from '../transfer/return/invoice';
 import { IOrderAsPayPurpose, IPaymentMethod, IPaymentService as IPaymentServiceOnPay, IPurposeAsAssetTransaction, IPurposeAsReturnAction } from './pay';
 export { IAlterTranResult, ISeatInfoSyncCancelIn, ISeatInfoSyncCancelResult, ISeatInfoSyncIn, ISeatInfoSyncResult, IRefundCreditCardRecipe, IRefundMovieTicketRecipe };
 export type IAgent = ActionFactory.IParticipantAsSeller;
@@ -31,7 +33,7 @@ export interface IResult {
 }
 export interface IInformPayment {
     purpose: IRefundTransactionAsPurpose;
-    recipient: Pick<ActionFactory.IParticipantAsSeller, 'id' | 'name' | 'typeOf'>;
+    recipient?: never;
     /**
      * potentialAction id
      */
@@ -49,13 +51,20 @@ export type IPurpose = IOrderAsPayPurpose | // 決済カードIF承認時の着
 IPurposeAsReturnAction | // 注文返品の場合
 IPurposeAsPlaceOrder | // 注文取引における発行済決済URL無効化の場合
 IPurposeAsAssetTransaction;
+export type IOrderAsInstrument = Pick<IOrder, 'orderNumber' | 'typeOf'>;
+export type IReturnActionAsInstrument = Pick<IReturnInvoiceAction, 'id' | 'typeOf'>;
+export type IInstrument = IOrderAsInstrument | IReturnActionAsInstrument;
 export interface IAttributes extends Pick<ActionFactory.IAttributes<ActionType.RefundAction, IObject, IResult>, 'agent' | 'error' | 'object' | 'potentialActions' | 'purpose' | 'recipient' | 'result' | 'project' | 'sameAs' | 'typeOf'> {
     agent: IAgent;
     recipient?: IRecipient;
     purpose: IPurpose;
     potentialActions?: IPotentialActions;
+    /**
+     * add(2025-02-17~)
+     */
+    instrument?: IInstrument[];
 }
 /**
- * 返金アクション
+ * refund action
  */
 export type IAction = ActionFactory.IAction<IAttributes>;

package/lib/assetTransaction/pay.d.ts

@@ -1,4 +1,4 @@
-import { IAction as IPayAction, ILocation, IMovieTicket, IOrderAsPayPurpose, IPendingTransaction, IRecipient as IPayRecipient } from '../action/trade/pay';
+import { IAction as IPayAction, IInstrument, ILocation, IMovieTicket, IOrderAsPayPurpose, IPendingTransaction, IRecipient as IPayRecipient } from '../action/trade/pay';
 import * as AssetTransactionFactory from '../assetTransaction';
 import { AssetTransactionType } from '../assetTransactionType';
 import { IExtendId } from '../autoGenerated';
@@ -121,6 +121,10 @@ export interface IStartParams extends AssetTransactionFactory.IStartParams<Asset
     location?: ILocation;
     recipient: IRecipient;
     potentialAction?: IPotentialAction[];
+    /**
+     * add(2025-02-18~)
+     */
+    instrument?: IInstrument[];
 }
 export interface IOptimizedPayAction4order {
     object: {

package/lib/assetTransaction/refund.d.ts

@@ -1,5 +1,5 @@
 import { IPaymentMethod, IPurposeAsReturnAction } from '../action/trade/pay';
-import { IAttributes as IRefundActionAttributes, IRecipient as IRefundRecipient } from '../action/trade/refund';
+import { IAttributes as IRefundActionAttributes, IInstrument, IRecipient as IRefundRecipient } from '../action/trade/refund';
 import * as AssetTransactionFactory from '../assetTransaction';
 import { AssetTransactionType } from '../assetTransactionType';
 import { IExtendId } from '../autoGenerated';
@@ -22,9 +22,18 @@ export interface IObject {
 }
 export type IObjectWithoutDetail = Pick<IObject, 'typeOf' | 'id' | 'paymentMethod' | 'refundFee'>;
 export type IPotentialAction = IPotentialInformAction;
-export type IStartParamsWithoutDetail = AssetTransactionFactory.IStartParams<AssetTransactionType.Refund, IAgent, IRecipient, IObjectWithoutDetail>;
+export interface IStartParamsWithoutDetail extends AssetTransactionFactory.IStartParams<AssetTransactionType.Refund, IAgent, IRecipient, IObjectWithoutDetail> {
+    /**
+     * add(2025-02-18~)
+     */
+    instrument: IInstrument[];
+}
 export interface IStartParams extends AssetTransactionFactory.IStartParams<AssetTransactionType.Refund, IAgent, IRecipient, IObject> {
     potentialAction?: IPotentialAction[];
+    /**
+     * add(2025-02-18~)
+     */
+    instrument?: IInstrument[];
 }
 export type IRefundPurpose = IPurposeAsReturnAction;
 export interface IPotentialActionsParams {
@@ -52,7 +61,7 @@ export interface IPotentialActions {
 }
 export type ITransaction = IExtendId<IAttributes>;
 /**
- * 返金取引
+ * refund transaction
  */
 export interface IAttributes extends AssetTransactionFactory.IAttributes<IStartParams, IResult, IError, IPotentialActions> {
     potentialAction?: IPotentialAction[];

package/lib/product.d.ts

@@ -66,16 +66,6 @@ export interface ICredentials {
     clientId?: string;
     clientSecret?: string;
 }
-export interface IInformPayment {
-    recipient?: {
-        id?: never;
-        name?: never;
-        url?: string;
-    };
-}
-export interface IOnPaymentStatusChanged {
-    informPayment?: IInformPayment[];
-}
 export interface IAvailableChannel {
     typeOf: 'ServiceChannel';
     serviceUrl?: string;
@@ -88,7 +78,7 @@ export type IOffer = Pick<IBaseOffer, 'typeOf' | 'priceCurrency' | 'availability
     };
 };
 /**
- * プロダクト
+ * product
  * {@link https://schema.org/Product}
  */
 export interface IProduct extends Pick<IThing, 'name' | 'description'> {

package/lib/task/pay.d.ts

@@ -1,18 +1,21 @@
-import { IAttributes as IPayActionAttributes, IPurposeAsReturnAction } from '../action/trade/pay';
+import { IAttributes as IPayActionAttributes, IOrderAsInstrument, IPurposeAsReturnAction, IRefundActionAsInstrument } from '../action/trade/pay';
 import { IOptimizedPayAction4order } from '../assetTransaction/pay';
 import { IExtendId } from '../autoGenerated';
 import * as TaskFactory from '../task';
 import { TaskName } from '../taskName';
+export type IPayReturnFeeActionInstrument = IOrderAsInstrument | IRefundActionAsInstrument;
 /**
- * 返品手数料決済の場合
+ * in case of pay return fee
  */
-export interface IPayReturnFeeAction extends Pick<IPayActionAttributes, 'object' | 'potentialActions' | 'purpose' | 'typeOf'> {
+export interface IPayReturnFeeAction extends Pick<IPayActionAttributes, 'object' | 'potentialActions' | 'purpose' | 'typeOf' | 'instrument'> {
+    instrument?: IPayReturnFeeActionInstrument[];
     purpose: IPurposeAsReturnAction;
 }
 /**
- * 注文決済の場合
+ * in case of pay order
  */
 export type IPayOrderAction = Pick<IOptimizedPayAction4order, 'object' | 'purpose'> & {
+    instrument?: never;
     typeOf?: never;
     potentialActions?: never;
 };
@@ -22,6 +25,6 @@ export interface IAttributes extends TaskFactory.IAttributes {
     data: IData;
 }
 /**
- * 決済タスク
+ * pay task
  */
 export type ITask = IExtendId<IAttributes>;

package/lib/task/refund.d.ts

@@ -2,12 +2,12 @@ import { IAttributes as IRefundActionAttributes } from '../action/trade/refund';
 import { IExtendId } from '../autoGenerated';
 import * as TaskFactory from '../task';
 import { TaskName } from '../taskName';
-export type IData = Pick<IRefundActionAttributes, 'agent' | 'object' | 'potentialActions' | 'project' | 'purpose' | 'recipient' | 'typeOf'>;
+export type IData = Pick<IRefundActionAttributes, 'agent' | 'object' | 'potentialActions' | 'project' | 'purpose' | 'recipient' | 'typeOf' | 'instrument'>;
 export interface IAttributes extends TaskFactory.IAttributes {
     name: TaskName.Refund;
     data: IData;
 }
 /**
- * 返金タスク
+ * refund task
  */
 export type ITask = IExtendId<IAttributes>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chevre/factory",
-  "version": "4.393.0-alpha.21",
+  "version": "4.393.0-alpha.23",
   "description": "Chevre Factory Library for Javascript",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",