@chevre/factory 3.1.0 → 3.343.0-alpha.2

package/lib/account/transaction/transfer.d.ts

@@ -0,0 +1,32 @@
+import { IExtendId } from '../../autoGenerated';
+import { IAccount } from '../action/moneyTransfer';
+import * as TransactionFactory from '../transaction';
+import { AccountTransactionType } from '../transactionType';
+export type IStartParamsWithoutDetail = TransactionFactory.IStartParams<AccountTransactionType.Transfer, IObjectWithoutDetail>;
+/**
+ * 取引開始パラメーター
+ */
+export type IStartParams = TransactionFactory.IStartParams<AccountTransactionType.Transfer, IObject>;
+export interface IObjectWithoutDetail extends TransactionFactory.IObjectWithoutDetail {
+    fromLocation: TransactionFactory.ISimpleAccount;
+    toLocation: TransactionFactory.ISimpleAccount;
+}
+/**
+ * 取引対象物
+ */
+export interface IObject extends TransactionFactory.IObject {
+    /**
+     * 転送元
+     */
+    fromLocation: Pick<IAccount, 'accountNumber' | 'name' | 'typeOf'>;
+    /**
+     * 転送先
+     */
+    toLocation: Pick<IAccount, 'accountNumber' | 'name' | 'typeOf'>;
+}
+/**
+ * 転送取引
+ */
+export interface IAttributes extends TransactionFactory.IAttributes<IStartParams> {
+}
+export type ITransaction = IExtendId<IAttributes>;

package/lib/account/transaction/withdraw.d.ts

@@ -0,0 +1,31 @@
+import { IExtendId } from '../../autoGenerated';
+import { IAccount } from '../action/moneyTransfer';
+import * as TransactionFactory from '../transaction';
+import { AccountTransactionType } from '../transactionType';
+export type IStartParamsWithoutDetail = TransactionFactory.IStartParams<AccountTransactionType.Withdraw, IObjectWithoutDetail>;
+/**
+ * 取引開始パラメーター
+ */
+export type IStartParams = TransactionFactory.IStartParams<AccountTransactionType.Withdraw, IObject>;
+export interface IObjectWithoutDetail extends TransactionFactory.IObjectWithoutDetail {
+    fromLocation: TransactionFactory.ISimpleAccount;
+    /**
+     * 利用可能金額確認をしない場合、force: true
+     */
+    force?: boolean;
+}
+/**
+ * 取引対象物
+ */
+export interface IObject extends TransactionFactory.IObject {
+    /**
+     * 出金元
+     */
+    fromLocation: Pick<IAccount, 'accountNumber' | 'name' | 'typeOf'>;
+}
+/**
+ * 出金取引
+ */
+export interface IAttributes extends TransactionFactory.IAttributes<IStartParams> {
+}
+export type ITransaction = IExtendId<IAttributes>;

package/lib/account/transaction.d.ts

@@ -0,0 +1,144 @@
+import { IExtendId } from '../autoGenerated';
+import { OrganizationType } from '../organizationType';
+import { SortType } from '../sortType';
+import { TransactionStatusType } from '../transactionStatusType';
+import * as MoneyTransferActionFactory from './action/moneyTransfer';
+import { AccountTransactionType } from './transactionType';
+export import IAgent = MoneyTransferActionFactory.IAgent;
+export import IRecipient = MoneyTransferActionFactory.IRecipient;
+export interface ISimpleAccount {
+    accountNumber: string;
+}
+export interface IProject {
+    id: string;
+    typeOf: OrganizationType.Project;
+}
+export interface IObjectWithoutDetail {
+    amount: {
+        value: number;
+    };
+    description?: string;
+}
+export interface IObject {
+    /**
+     * 金額
+     */
+    amount: {
+        value: number;
+    };
+    description?: string;
+}
+/**
+ * 口座取引開始パラメータ
+ */
+export interface IStartParams<T extends AccountTransactionType, TObject extends IObject> {
+    project: IProject;
+    /**
+     * 取引タイプ
+     */
+    typeOf: T;
+    /**
+     * 取引識別子
+     * 同識別子に対する進行中取引のユニークネスは保証される
+     */
+    identifier?: string;
+    /**
+     * 取引番号
+     * サービス使用側が指定するグローバルユニークな番号
+     * 必須化(2022-09-26~)
+     */
+    transactionNumber: string;
+    /**
+     * 取引主体
+     */
+    agent: IAgent;
+    /**
+     * 取引物受取者
+     */
+    recipient: IRecipient;
+    /**
+     * 取引対象
+     */
+    object: TObject;
+    /**
+     * 取引進行期限
+     */
+    expires: Date;
+}
+export interface IPotentialActions {
+    moneyTransfer: MoneyTransferActionFactory.IAttributes;
+}
+/**
+ * 口座取引属性
+ */
+export type IAttributes<TStartParams> = TStartParams & {
+    /**
+     * 取引状態
+     */
+    status: TransactionStatusType;
+    /**
+     * 取引開始日時
+     */
+    startDate: Date;
+    /**
+     * 取引終了日時
+     */
+    endDate?: Date;
+    /**
+     * 事後に発生するアクション
+     */
+    potentialActions?: IPotentialActions;
+};
+/**
+ * 口座取引
+ */
+export type ITransaction<TStartParams> = IExtendId<IAttributes<TStartParams>>;
+export interface ISortOrder {
+    startDate?: SortType;
+}
+export interface ISearchConditions {
+    limit?: number;
+    page?: number;
+    sort?: ISortOrder;
+    project?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    typeOf?: {
+        $eq?: AccountTransactionType;
+    };
+    status?: {
+        $in?: TransactionStatusType[];
+    };
+    startDate?: {
+        $gte?: Date;
+        $lte?: Date;
+    };
+    identifier?: {
+        $eq?: string;
+    };
+    transactionNumber?: {
+        $eq?: string;
+    };
+    object?: {
+        fromLocation?: {
+            accountNumber?: {
+                $eq?: string;
+            };
+        };
+        toLocation?: {
+            accountNumber?: {
+                $eq?: string;
+            };
+        };
+        location?: {
+            /**
+             * 口座番号
+             */
+            accountNumber?: {
+                $eq?: string;
+            };
+        };
+    };
+}

package/lib/account/transactionType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 口座取引タイプ
+ */
+export declare enum AccountTransactionType {
+    /**
+     * 出金取引
+     */
+    Withdraw = "Withdraw",
+    /**
+     * 入金取引
+     */
+    Deposit = "Deposit",
+    /**
+     * 転送取引
+     */
+    Transfer = "Transfer"
+}

package/lib/account/transactionType.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountTransactionType = void 0;
+/**
+ * 口座取引タイプ
+ */
+var AccountTransactionType;
+(function (AccountTransactionType) {
+    /**
+     * 出金取引
+     */
+    AccountTransactionType["Withdraw"] = "Withdraw";
+    /**
+     * 入金取引
+     */
+    AccountTransactionType["Deposit"] = "Deposit";
+    /**
+     * 転送取引
+     */
+    AccountTransactionType["Transfer"] = "Transfer";
+})(AccountTransactionType = exports.AccountTransactionType || (exports.AccountTransactionType = {}));

package/lib/account.d.ts

@@ -0,0 +1,127 @@
+import { AccountTransactionType } from './account/transactionType';
+import { AccountType } from './accountType';
+import { IProject } from './project';
+import { SortType } from './sortType';
+import * as MoneyTransferActionFactory from './account/action/moneyTransfer';
+import * as TransactionFactory from './account/transaction';
+import * as DepositTransactionFactory from './account/transaction/deposit';
+import * as TransferTransactionFactory from './account/transaction/transfer';
+import * as WithdrawTransactionFactory from './account/transaction/withdraw';
+/**
+ * 口座ステータスタイプ
+ */
+export declare namespace action {
+    export import moneyTransfer = MoneyTransferActionFactory;
+}
+export declare namespace transaction {
+    export import IAgent = TransactionFactory.IAgent;
+    export import IRecipient = TransactionFactory.IRecipient;
+    export import IPotentialActions = TransactionFactory.IPotentialActions;
+    type ISearchConditions = TransactionFactory.ISearchConditions;
+    type IStartParamsWithoutDetail<T extends AccountTransactionType> = T extends AccountTransactionType.Deposit ? DepositTransactionFactory.IStartParamsWithoutDetail : T extends AccountTransactionType.Withdraw ? WithdrawTransactionFactory.IStartParamsWithoutDetail : T extends AccountTransactionType.Transfer ? TransferTransactionFactory.IStartParamsWithoutDetail : never;
+    type IStartParams<T extends AccountTransactionType> = T extends AccountTransactionType.Deposit ? DepositTransactionFactory.IStartParams : T extends AccountTransactionType.Withdraw ? WithdrawTransactionFactory.IStartParams : T extends AccountTransactionType.Transfer ? TransferTransactionFactory.IStartParams : never;
+    type IAttributes<T> = T extends AccountTransactionType.Deposit ? DepositTransactionFactory.IAttributes : T extends AccountTransactionType.Withdraw ? WithdrawTransactionFactory.IAttributes : T extends AccountTransactionType.Transfer ? TransferTransactionFactory.IAttributes : never;
+    type ITransaction<T> = T extends AccountTransactionType.Deposit ? DepositTransactionFactory.ITransaction : T extends AccountTransactionType.Withdraw ? WithdrawTransactionFactory.ITransaction : T extends AccountTransactionType.Transfer ? TransferTransactionFactory.ITransaction : never;
+    export import withdraw = WithdrawTransactionFactory;
+    export import deposit = DepositTransactionFactory;
+    export import transfer = TransferTransactionFactory;
+}
+export import transactionType = AccountTransactionType;
+/**
+ * 進行中取引
+ */
+export interface IPendingTransaction {
+    typeOf: AccountTransactionType;
+    /**
+     * 取引ID
+     */
+    id: string;
+    /**
+     * 取引金額
+     */
+    amount: number;
+}
+/**
+ * 口座
+ */
+export interface IAccount {
+    project: Pick<IProject, 'id' | 'typeOf'>;
+    /**
+     * 口座種別
+     */
+    typeOf: AccountType.Account;
+    /**
+     * 通貨
+     */
+    accountType: string;
+    /**
+     * 口座番号
+     */
+    accountNumber: string;
+    /**
+     * 口座名義
+     */
+    name: string;
+    /**
+     * 残高
+     */
+    balance: number;
+    /**
+     * 利用可能残高
+     */
+    availableBalance: number;
+    /**
+     * 進行中取引リスト
+     */
+    pendingTransactions?: IPendingTransaction[];
+    /**
+     * 口座開設日時
+     */
+    openDate: Date;
+    /**
+     * 口座閉鎖日時
+     */
+    closeDate?: Date;
+}
+/**
+ * ソート条件
+ */
+export interface ISortOrder {
+    /**
+     * 開設日時順
+     */
+    openDate?: SortType;
+}
+export interface IProjectSearchConditions {
+    id?: {
+        $eq?: string;
+        $ne?: string;
+    };
+}
+/**
+ * 口座検索条件
+ */
+export interface ISearchConditions {
+    limit?: number;
+    page?: number;
+    sort?: ISortOrder;
+    accountNumber?: {
+        $eq?: string;
+        $in?: string[];
+        $regex?: string;
+    };
+    accountNumbers?: string[];
+    accountType?: string;
+    name?: {
+        $regex?: string;
+    };
+    openDate?: {
+        $gte?: Date;
+        $lte?: Date;
+    };
+    project?: IProjectSearchConditions;
+    typeOf?: {
+        $eq?: string;
+        $in?: string[];
+    };
+}

package/lib/account.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionType = exports.transaction = exports.action = void 0;
+var transactionType_1 = require("./account/transactionType");
+var MoneyTransferActionFactory = require("./account/action/moneyTransfer");
+var DepositTransactionFactory = require("./account/transaction/deposit");
+var TransferTransactionFactory = require("./account/transaction/transfer");
+var WithdrawTransactionFactory = require("./account/transaction/withdraw");
+/**
+ * 口座ステータスタイプ
+ */
+// export enum AccountStatusType {
+//     /**
+//      * 開設済
+//      */
+//     Opened = 'Opened',
+//     /**
+//      * 解約済
+//      */
+//     Closed = 'Closed'
+// }
+var action;
+(function (action) {
+    action.moneyTransfer = MoneyTransferActionFactory;
+})(action = exports.action || (exports.action = {}));
+var transaction;
+(function (transaction) {
+    transaction.withdraw = WithdrawTransactionFactory;
+    transaction.deposit = DepositTransactionFactory;
+    transaction.transfer = TransferTransactionFactory;
+})(transaction = exports.transaction || (exports.transaction = {}));
+exports.transactionType = transactionType_1.AccountTransactionType;

package/lib/{factory/accountTitle.d.ts → accountTitle.d.ts}

@@ -1,6 +1,6 @@
 import { IProject } from './project';
 import { IPropertyValue } from './propertyValue';
-import SortType from './sortType';
+import { SortType } from './sortType';
 export interface IDefinedTerm {
     typeOf: 'DefinedTerm';
     termCode: string;
@@ -9,10 +9,10 @@ export interface IDefinedTerm {
 }
 /**
  * 勘定科目インターフェース
- * @see https://pending.schema.org/CategoryCode
+ * {@link https://pending.schema.org/CategoryCode}
  */
 export interface IAccountTitle {
-    project: IProject;
+    project: Pick<IProject, 'id' | 'typeOf'>;
     typeOf: 'AccountTitle';
     /**
      * A short textual code that uniquely identifies the value.
@@ -45,21 +45,22 @@ export interface IAccountTitle {
     additionalProperty?: IPropertyValue<string>[];
 }
 /**
- * ソート条件インターフェース
+ * ソート条件
  */
 export interface ISortOrder {
     codeValue?: SortType;
-    name?: SortType;
 }
 /**
- * 検索条件インターフェース
+ * 検索条件
  */
 export interface ISearchConditions {
     limit?: number;
     page?: number;
     sort?: ISortOrder;
     project?: {
-        ids?: string[];
+        id?: {
+            $eq?: string;
+        };
     };
     codeValue?: string | {
         $eq?: string;

package/lib/accountType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 予約済の口座タイプ
+ */
+export declare enum AccountType {
+    Account = "Account",
+    Checking = "Checking",
+    Current = "Current",
+    Deposit = "Deposit",
+    Loan = "Loan",
+    Personal = "Personal",
+    Prepaid = "Prepaid",
+    Savings = "Savings",
+    Transaction = "Transaction",
+    Transactional = "Transactional"
+}

package/lib/accountType.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountType = void 0;
+/**
+ * 予約済の口座タイプ
+ */
+var AccountType;
+(function (AccountType) {
+    AccountType["Account"] = "Account";
+    AccountType["Checking"] = "Checking";
+    AccountType["Current"] = "Current";
+    AccountType["Deposit"] = "Deposit";
+    AccountType["Loan"] = "Loan";
+    AccountType["Personal"] = "Personal";
+    AccountType["Prepaid"] = "Prepaid";
+    AccountType["Savings"] = "Savings";
+    AccountType["Transaction"] = "Transaction";
+    AccountType["Transactional"] = "Transactional";
+})(AccountType = exports.AccountType || (exports.AccountType = {}));

package/lib/action/authorize/award/point.d.ts

@@ -0,0 +1,51 @@
+import * as ActionFactory from '../../../action';
+import { ActionType } from '../../../actionType';
+import { TransactionType } from '../../../transactionType';
+import * as AuthorizeActionFactory from '../../authorize';
+export type IAgent = ActionFactory.IParticipantAsSeller;
+export type IRecipient = ActionFactory.IParticipantAsWebApplication | ActionFactory.IParticipantAsPerson;
+export declare enum ObjectType {
+    PointAward = "PointAward"
+}
+/**
+ * オーソリ対象
+ */
+export interface IObject {
+    typeOf: ObjectType;
+    /**
+     * 金額
+     */
+    amount: number;
+    /**
+     * 入金先カード番号
+     */
+    toAccountNumber: string;
+    /**
+     * 説明
+     */
+    notes?: string;
+}
+export interface IResult {
+    price: number;
+    amount: number;
+}
+export interface IPurpose {
+    typeOf: TransactionType;
+    id: string;
+}
+export type IError = any;
+/**
+ * ポイントインセンティブ承認アクション属性
+ */
+export interface IAttributes extends AuthorizeActionFactory.IAttributes<IObject, IResult> {
+    typeOf: ActionType.AuthorizeAction;
+    object: IObject;
+    agent: IAgent;
+    recipient: IRecipient;
+    purpose: IPurpose;
+}
+/**
+ * ポイントインセンティブ承認アクション
+ * 注文取引のインセンティブとしてポイントを付与する場合に使用されます。
+ */
+export type IAction = ActionFactory.IAction<IAttributes>;

package/lib/action/authorize/award/point.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectType = void 0;
+var ObjectType;
+(function (ObjectType) {
+    ObjectType["PointAward"] = "PointAward";
+})(ObjectType = exports.ObjectType || (exports.ObjectType = {}));

package/lib/action/authorize/offer/moneyTransfer.d.ts

@@ -0,0 +1,39 @@
+import * as ActionFactory from '../../../action';
+import { ActionType } from '../../../actionType';
+import * as MoneyTransferTransactionFactory from '../../../assetTransaction/moneyTransfer';
+import { IOffer } from '../../../offer';
+import * as OrderFactory from '../../../order';
+import { PriceCurrency } from '../../../priceCurrency';
+import { TransactionType } from '../../../transactionType';
+import * as AuthorizeActionFactory from '../../authorize';
+export type IAgent = ActionFactory.IParticipantAsWebApplication | ActionFactory.IParticipantAsPerson | ActionFactory.IParticipantAsSeller;
+export type IRecipient = ActionFactory.IParticipantAsWebApplication | ActionFactory.IParticipantAsPerson;
+export type IRequestBody = any;
+export type IResponseBody = MoneyTransferTransactionFactory.ITransaction;
+export import IPendingTransaction = OrderFactory.IMoneyTransferPendingTransaction;
+export interface IResult {
+    price: number;
+    priceCurrency: PriceCurrency;
+    requestBody?: IRequestBody;
+    responseBody: IResponseBody;
+}
+export import IItemOffered = OrderFactory.IMoneyTransfer;
+export interface IAcceptedOffer extends Omit<IOffer, 'addOn' | 'availability' | 'availableAtOrFrom'> {
+    itemOffered: IItemOffered;
+    seller: ActionFactory.IParticipantAsSeller;
+}
+export type IObject = IAcceptedOffer;
+export interface ITransactionPurpose {
+    typeOf: TransactionType;
+    id: string;
+}
+export type IPurpose = ITransactionPurpose;
+export type IError = any;
+export interface IAttributes extends AuthorizeActionFactory.IAttributes<IObject, IResult> {
+    typeOf: ActionType.AuthorizeAction;
+    agent: IAgent;
+    recipient: IRecipient;
+    object: IObject;
+    purpose: IPurpose;
+}
+export type IAction = ActionFactory.IAction<IAttributes>;

package/lib/action/authorize/offer/product.d.ts

@@ -0,0 +1,70 @@
+import * as ActionFactory from '../../../action';
+import { ActionType } from '../../../actionType';
+import * as RegisterServiceTransactionFactory from '../../../assetTransaction/registerService';
+import { AssetTransactionType } from '../../../assetTransactionType';
+import { IOffer } from '../../../offer';
+import * as OrderFactory from '../../../order';
+import { IIssuedThroughAsProduct, IPermit } from '../../../permit';
+import { PriceCurrency } from '../../../priceCurrency';
+import { IProduct, IServiceOutput as IProductServiceOutput, ITicketPriceSpecification } from '../../../product';
+import { ISeller } from '../../../seller';
+import { TransactionType } from '../../../transactionType';
+import * as AuthorizeActionFactory from '../../authorize';
+import { IPointAward } from '../../transfer/moneyTransfer';
+export type IAgent = ActionFactory.IParticipantAsSeller;
+export type IRecipient = ActionFactory.IParticipantAsWebApplication | ActionFactory.IParticipantAsPerson;
+export type IPermitIssuedByProduct = Omit<IPermit, 'issuedThrough'> & {
+    issuedThrough?: IIssuedThroughAsProduct;
+};
+export type IItemOffered = Pick<IProduct, 'typeOf' | 'id' | 'name'> & {
+    serviceOutput: IProductServiceOutput & IPermitIssuedByProduct;
+    pointAward?: IPointAward;
+};
+export type IAcceptedOfferWithoutDetail = RegisterServiceTransactionFactory.IAcceptedOfferWithoutDetail;
+export type ISellerMakesOffer = Pick<ISeller, 'id' | 'name' | 'typeOf'>;
+export interface IAcceptedOffer extends Pick<IOffer, 'typeOf' | 'id' | 'identifier' | 'itemOffered' | 'name' | 'priceCurrency' | 'seller'> {
+    /**
+     * オファーコード
+     */
+    identifier?: string;
+    /**
+     * オファー対象アイテム
+     */
+    itemOffered: IItemOffered;
+    /**
+     * 販売者
+     */
+    seller: ISellerMakesOffer;
+    priceSpecification?: ITicketPriceSpecification;
+}
+export type IObjectWithoutDetail = IAcceptedOfferWithoutDetail[];
+export type IObject = IAcceptedOffer[];
+export type IResultAcceptedOffer = OrderFactory.IAcceptedOffer<OrderFactory.IPermit>[];
+export interface IResult {
+    price: number;
+    priceCurrency: PriceCurrency;
+    acceptedOffers: IResultAcceptedOffer;
+    requestBody: RegisterServiceTransactionFactory.IStartParamsWithoutDetail;
+    responseBody: RegisterServiceTransactionFactory.ITransaction;
+}
+export interface IPurpose {
+    typeOf: TransactionType.PlaceOrder;
+    id: string;
+}
+export type IError = any;
+export interface IInstrument {
+    typeOf: AssetTransactionType.RegisterService;
+    transactionNumber: string;
+}
+export interface IAttributes extends AuthorizeActionFactory.IAttributes<IObject, IResult> {
+    typeOf: ActionType.AuthorizeAction;
+    agent: IAgent;
+    instrument: IInstrument;
+    recipient: IRecipient;
+    object: IObject;
+    purpose: IPurpose;
+}
+/**
+ * プロダクトオファー承認アクション
+ */
+export type IAction = ActionFactory.IAction<IAttributes>;