define action recipe

CHANGELOG.md

@@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ### Added
 
+- define action recipe
+
 ### Changed
 
 ### Deprecated

src/action/accept/pay.ts

@@ -2,12 +2,11 @@ import * as ActionFactory from '../../action';
 import { ActionType } from '../../actionType';
 import { IAgent, IObjectWithoutDetail } from '../../assetTransaction/pay';
 import { AssetTransactionType } from '../../assetTransactionType';
+import { IRecipe } from '../../recipe/publishPaymentUrl';
 import { TransactionType } from '../../transactionType';
 import * as AcceptActionFactory from '../accept';
 
-export {
-    IAgent
-};
+export { IAgent, IRecipe };
 export interface IObject { // 決済取引を受け入れる
     object: IObjectWithoutDetail;
     transactionNumber: string;

src/index.ts

@@ -115,6 +115,7 @@ import * as PropertyValueFactory from './propertyValue';
 import * as LocationFeatureSpecificationFactory from './propertyValue/locationFeatureSpecification';
 import * as QualitativeValueFactory from './qualitativeValue';
 import * as QuantitativeValueFactory from './quantitativeValue';
+import * as RecipeFactory from './recipe';
 import * as AccountingReportFactory from './report/accountingReport';
 import * as ReservationFactory from './reservation';
 import * as BusReservationFactory from './reservation/busReservation';
@@ -472,6 +473,7 @@ export namespace propertyValue {
 
 export import qualitativeValue = QualitativeValueFactory;
 export import quantitativeValue = QuantitativeValueFactory;
+export import recipe = RecipeFactory;
 
 export namespace report {
     export import accountingReport = AccountingReportFactory;

src/recipe.ts

@@ -0,0 +1,32 @@
+import { ActionType } from './actionType';
+import { OrganizationType } from './organizationType';
+
+export enum RecipeCategory {
+    publishPaymentUrl = 'publishPaymentUrl'
+}
+export enum StepIdentifier {
+    entryTran = 'entryTran',
+    execTran = 'execTran'
+}
+export interface IHowToDirection {
+    typeOf: 'HowToDirection';
+    beforeMedia: any;
+    afterMedia: any;
+    // text: string;
+}
+export interface IHowToStep {
+    typeOf: 'HowToStep';
+    identifier: StepIdentifier;
+    itemListElement: IHowToDirection[];
+}
+export interface IHowToSection {
+    typeOf: 'HowToSection';
+    itemListElement: IHowToStep[];
+}
+export interface IRecipe {
+    project: { id: string; typeOf: OrganizationType.Project };
+    typeOf: 'Recipe';
+    recipeCategory: RecipeCategory;
+    step: IHowToSection[];
+    recipeFor: { id: string; typeOf: ActionType };
+}

src/recipe/publishPaymentUrl.ts

@@ -0,0 +1,28 @@
+import { IEntryTranArgs, IEntryTranResult, IExecTran3dsResult, IExecTranArgs, IExecTranResult } from '../assetTransaction/pay';
+import * as RecipeFactory from '../recipe';
+
+export interface IDirectionEntryTran extends RecipeFactory.IHowToDirection {
+    beforeMedia: IEntryTranArgs;
+    afterMedia: IEntryTranResult;
+}
+export interface IDirectionExecTran extends RecipeFactory.IHowToDirection {
+    beforeMedia: IExecTranArgs;
+    afterMedia: IExecTranResult | IExecTran3dsResult;
+}
+export interface IStepEntryTran extends RecipeFactory.IHowToStep {
+    identifier: RecipeFactory.StepIdentifier.entryTran;
+    itemListElement: [IDirectionEntryTran];
+}
+export interface IStepExecTran extends RecipeFactory.IHowToStep {
+    identifier: RecipeFactory.StepIdentifier.execTran;
+    itemListElement: [IDirectionExecTran];
+}
+export type IHowToStep = IStepEntryTran | IStepExecTran;
+export interface IHowToSection {
+    typeOf: 'HowToSection';
+    itemListElement: IHowToStep[];
+}
+export interface IRecipe extends RecipeFactory.IRecipe {
+    recipeCategory: RecipeFactory.RecipeCategory.publishPaymentUrl;
+    step: IHowToSection[];
+}