@chevre/factory 3.0.1 → 3.343.0-alpha.2

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

@@ -1,42 +1,44 @@
 import { IAccountTitle } from './accountTitle';
-import IMultilingualString from './multilingualString';
-import PriceCurrency from './priceCurrency';
-import PriceSpecificationType from './priceSpecificationType';
+import { IMultilingualString } from './multilingualString';
+import { PriceCurrency } from './priceCurrency';
+import { PriceSpecificationType } from './priceSpecificationType';
 import { IProject } from './project';
 import { IQuantitativeValue } from './quantitativeValue';
-import SortType from './sortType';
+import { SortType } from './sortType';
 import { UnitCode } from './unitCode';
 /**
- * 勘定インターフェース
+ * 勘定
  */
 export interface IAccounting {
     typeOf: 'Accounting';
     /**
      * 営業収益
      */
-    operatingRevenue: IAccountTitle;
-    /**
-     * 営業外収益
-     */
-    nonOperatingRevenue?: IAccountTitle;
+    operatingRevenue?: IAccountTitle;
     /**
      * 売上金額
      */
-    accountsReceivable: number;
+    accountsReceivable?: number;
 }
 /**
- * 価格仕様インターフェース
+ * 適用数量
+ * n以上n以下のアイテム数に適用する設定
+ */
+export type IEligibleQuantity = Pick<IQuantitativeValue<UnitCode>, 'maxValue' | 'minValue' | 'typeOf' | 'unitCode'>;
+export type IEligibleTransactionVolume = Pick<IPriceSpecification<PriceSpecificationType>, 'typeOf' | 'price' | 'priceCurrency' | 'valueAddedTaxIncluded'>;
+/**
+ * 価格仕様
  */
 export interface IPriceSpecification<T extends PriceSpecificationType> {
-    project: IProject;
+    project?: Pick<IProject, 'id' | 'typeOf'>;
     id?: string;
     typeOf: T;
     name?: string | IMultilingualString;
-    description?: string | IMultilingualString;
-    eligibleQuantity?: IQuantitativeValue<UnitCode>;
-    eligibleTransactionVolume?: IPriceSpecification<PriceSpecificationType>;
-    maxPrice?: number;
-    minPrice?: number;
+    /**
+     * 適用数量
+     */
+    eligibleQuantity?: IEligibleQuantity;
+    eligibleTransactionVolume?: IEligibleTransactionVolume;
     /**
      * 発生金額
      */
@@ -45,8 +47,6 @@ export interface IPriceSpecification<T extends PriceSpecificationType> {
      * 通貨
      */
     priceCurrency: PriceCurrency;
-    validFrom?: Date;
-    validThrough?: Date;
     valueAddedTaxIncluded: boolean;
     /**
      * 勘定内容
@@ -54,13 +54,13 @@ export interface IPriceSpecification<T extends PriceSpecificationType> {
     accounting?: IAccounting;
 }
 /**
- * ソート条件インターフェース
+ * 価格仕様ソート条件
  */
 export interface ISortOrder {
     price?: SortType;
 }
 /**
- * 検索条件インターフェース
+ * 価格仕様検索条件
  */
 export interface ISearchConditions<T extends PriceSpecificationType> {
     limit?: number;
@@ -70,7 +70,6 @@ export interface ISearchConditions<T extends PriceSpecificationType> {
         id?: {
             $eq?: string;
         };
-        ids?: string[];
     };
     id?: {
         $eq?: string;
@@ -78,7 +77,15 @@ export interface ISearchConditions<T extends PriceSpecificationType> {
     ids?: string[];
     typeOf?: T;
     appliesToCategoryCode?: {
-        $elemMatch?: any;
+        $elemMatch?: {
+            codeValue?: {
+                $eq?: string;
+                $in?: string[];
+            };
+            'inCodeSet.identifier'?: {
+                $eq?: string;
+            };
+        };
         codeValue?: {
             $eq?: string;
             $in?: string[];
@@ -90,10 +97,18 @@ export interface ISearchConditions<T extends PriceSpecificationType> {
             };
         };
     };
+    price?: {
+        $eq?: number;
+    };
     validFrom?: Date;
     validThrough?: Date;
     appliesToVideoFormats?: string[];
     appliesToMovieTicket?: {
         serviceTypes?: string[];
+        serviceOutput?: {
+            typeOf?: {
+                $eq?: string;
+            };
+        };
     };
 }

package/lib/priceSpecification.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,7 +1,7 @@
 /**
  * 価格仕様タイプ
  */
-declare enum PriceSpecificationType {
+export declare enum PriceSpecificationType {
     /**
      * 基本価格仕様
      */
@@ -23,4 +23,3 @@ declare enum PriceSpecificationType {
      */
     UnitPriceSpecification = "UnitPriceSpecification"
 }
-export default PriceSpecificationType;

package/lib/{factory/priceSpecificationType.js → priceSpecificationType.js}

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PriceSpecificationType = void 0;
 /**
  * 価格仕様タイプ
  */
@@ -25,5 +26,4 @@ var PriceSpecificationType;
      * 単価仕様
      */
     PriceSpecificationType["UnitPriceSpecification"] = "UnitPriceSpecification";
-})(PriceSpecificationType || (PriceSpecificationType = {}));
-exports.default = PriceSpecificationType;
+})(PriceSpecificationType = exports.PriceSpecificationType || (exports.PriceSpecificationType = {}));

package/lib/product.d.ts

@@ -0,0 +1,254 @@
+import { ICategoryCode } from './categoryCode';
+import { IMultilingualString } from './multilingualString';
+import { IName as IOfferName, IOffer as IBaseOffer } from './offer';
+import { OfferType } from './offerType';
+import { IPermit } from './permit';
+import { IPriceSpecification as ICategoryCodeChargeSpecification } from './priceSpecification/categoryCodeChargeSpecification';
+import { IPriceSpecification as ICompoundPriceSpecification } from './priceSpecification/compoundPriceSpecification';
+import { IPriceSpecification as IMovieTicketTypeChargeSpecification } from './priceSpecification/movieTicketTypeChargeSpecification';
+import { IPriceSpecification as IUnitPriceSpecification } from './priceSpecification/unitPriceSpecification';
+import { IProject } from './project';
+import { IPropertyValue } from './propertyValue';
+import { IQuantitativeValue } from './quantitativeValue';
+import { SortType } from './sortType';
+import { IThing } from './thing';
+import { UnitCode } from './unitCode';
+import * as UnitPriceOfferFactory from './unitPriceOffer';
+/**
+ * プロダクトタイプ
+ */
+export declare enum ProductType {
+    /**
+     * 興行
+     */
+    EventService = "EventService",
+    /**
+     * メンバーシップサービス
+     */
+    MembershipService = "MembershipService",
+    /**
+     * ペイメントカード
+     */
+    PaymentCard = "PaymentCard",
+    /**
+     * アドオン
+     */
+    Product = "Product",
+    /**
+     * 旅客サービス
+     */
+    Transportation = "Transportation"
+}
+export interface IHasOfferCatalog {
+    typeOf: 'OfferCatalog';
+    id: string;
+}
+export type IMembershipPointsEarned = Pick<IQuantitativeValue<string>, 'name' | 'typeOf' | 'unitText' | 'value'>;
+export type IServiceOutput = Pick<IPermit, 'typeOf' | 'amount'> & {
+    membershipPointsEarned?: IMembershipPointsEarned;
+    automaticRenewal?: boolean;
+};
+/**
+ * 外部サービス認証情報
+ */
+export interface ICredentials {
+    siteId?: string;
+    sitePass?: string;
+    authorizeServerDomain?: string;
+    clientId?: string;
+    clientSecret?: string;
+}
+export interface IAvailableChannel {
+    typeOf: 'ServiceChannel';
+    serviceUrl?: string;
+    credentials?: ICredentials;
+}
+export type IServiceType = Pick<ICategoryCode, 'codeValue' | 'inCodeSet' | 'typeOf'>;
+export type IOffer = Pick<IBaseOffer, 'typeOf' | 'priceCurrency' | 'availabilityEnds' | 'availabilityStarts' | 'validFrom' | 'validThrough'> & {
+    seller?: {
+        id?: string;
+    };
+};
+/**
+ * プロダクト
+ * {@link https://schema.org/Product}
+ */
+export interface IProduct extends Pick<IThing, 'name' | 'description'> {
+    project: Pick<IProject, 'id' | 'typeOf'>;
+    typeOf: ProductType;
+    id?: string;
+    availableChannel?: IAvailableChannel;
+    description?: IMultilingualString;
+    /**
+     * Indicates an OfferCatalog listing for this Organization, Person, or Service.
+     */
+    hasOfferCatalog?: IHasOfferCatalog;
+    name?: IMultilingualString;
+    /**
+     * An offer to provide this item
+     */
+    offers?: IOffer[];
+    /**
+     * The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".
+     */
+    productID: string;
+    /**
+     * The tangible thing generated by the service, e.g. a passport, permit, etc.
+     */
+    serviceOutput?: IServiceOutput;
+    /**
+     * The type of service being offered, e.g. veterans' benefits, emergency relief, etc.
+     */
+    serviceType?: IServiceType;
+    additionalProperty?: IPropertyValue<string>[];
+}
+export interface ISortOrder {
+    productID?: SortType;
+}
+export interface ISearchConditions {
+    limit?: number;
+    page?: number;
+    sort?: ISortOrder;
+    project?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    hasOfferCatalog?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    id?: {
+        $eq?: string;
+        $in?: string[];
+    };
+    name?: {
+        $regex?: string;
+    };
+    productID?: {
+        $eq?: string;
+        $in?: string[];
+        $regex?: string;
+    };
+    provider?: {
+        id?: {
+            /**
+             * プロバイダーに指定IDの販売者が含まれる
+             */
+            $eq?: string;
+        };
+    };
+    typeOf?: {
+        $eq?: string;
+        $in?: string[];
+    };
+    offers?: {
+        $elemMatch?: {
+            availabilityEnds?: {
+                $gte?: Date;
+                $lte?: Date;
+            };
+            availabilityStarts?: {
+                $gte?: Date;
+                $lte?: Date;
+            };
+            validFrom?: {
+                $gte?: Date;
+                $lte?: Date;
+            };
+            validThrough?: {
+                $gte?: Date;
+                $lte?: Date;
+            };
+            'seller.id'?: {
+                $in?: string[];
+            };
+        };
+    };
+    serviceOutput?: {
+        typeOf?: {
+            $eq?: string;
+        };
+        amount?: {
+            currency?: {
+                $eq?: string;
+            };
+        };
+    };
+    serviceType?: {
+        codeValue?: {
+            $eq?: string;
+        };
+    };
+}
+/**
+ * サービスアウトプット検索条件
+ */
+export interface IServiceOutputSearchConditions {
+    limit?: number;
+    page?: number;
+    project?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    accessCode?: {
+        $eq?: string;
+    };
+    id?: {
+        $eq?: string;
+    };
+    identifier?: {
+        $eq?: string;
+        $in?: string[];
+    };
+    issuedBy?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    issuedThrough?: {
+        id?: {
+            $eq?: string;
+        };
+        serviceType?: {
+            codeValue?: {
+                $eq?: string;
+            };
+        };
+        typeOf?: {
+            $eq?: ProductType;
+        };
+    };
+    typeOf?: {
+        $eq?: string;
+    };
+}
+export type ICategoryCodeChargePriceComponent = Omit<ICategoryCodeChargeSpecification, 'project'>;
+export type IMovieTicketTypeChargePriceComponent = Omit<IMovieTicketTypeChargeSpecification, 'project'>;
+export type ITicketUnitPriceComponent = Omit<IUnitPriceSpecification, 'project'>;
+export type ITicketPriceComponent = ICategoryCodeChargePriceComponent | IMovieTicketTypeChargePriceComponent | ITicketUnitPriceComponent;
+export type IEligibleQuantity = Pick<IQuantitativeValue<UnitCode.C62>, 'maxValue' | 'typeOf' | 'unitCode' | 'value'>;
+/**
+ * プロダクトオファーの価格仕様
+ */
+export type ITicketPriceSpecification = Omit<ICompoundPriceSpecification<ITicketPriceComponent>, 'project'>;
+export import IMinimizedTicketAddOn = UnitPriceOfferFactory.IAddOn4unitPriceOffer;
+/**
+ * プロダクトオファー
+ */
+export interface ITicketOffer extends Pick<IBaseOffer, 'acceptedPaymentMethod' | // add(2023-11-15~)
+'name' | 'description' | 'alternateName' | 'color' | 'typeOf' | 'id' | 'availability' | 'availableAtOrFrom' | 'category' | 'eligibleMembershipType' | 'eligibleSeatingType' | 'eligibleMonetaryAmount' | 'eligibleSubReservation' | 'eligibleQuantity' | 'offeredThrough' | 'priceCurrency' | 'validFrom' | 'validThrough' | 'validRateLimit' | 'additionalProperty'> {
+    addOn?: IMinimizedTicketAddOn[];
+    identifier: string;
+    name: IOfferName;
+    priceSpecification: ITicketPriceSpecification;
+    itemOffered?: UnitPriceOfferFactory.IItemOffered;
+    offerIndex?: number;
+    /**
+     * カタログ内ソートインデックス
+     */
+    sortIndex?: number;
+    typeOf: OfferType.Offer;
+}

package/lib/product.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductType = void 0;
+/**
+ * プロダクトタイプ
+ */
+var ProductType;
+(function (ProductType) {
+    /**
+     * 興行
+     */
+    ProductType["EventService"] = "EventService";
+    /**
+     * メンバーシップサービス
+     */
+    ProductType["MembershipService"] = "MembershipService";
+    /**
+     * ペイメントカード
+     */
+    ProductType["PaymentCard"] = "PaymentCard";
+    /**
+     * アドオン
+     */
+    ProductType["Product"] = "Product";
+    /**
+     * 旅客サービス
+     */
+    ProductType["Transportation"] = "Transportation";
+})(ProductType = exports.ProductType || (exports.ProductType = {}));

package/lib/programMembership.d.ts

@@ -0,0 +1,16 @@
+import { IThing } from './thing';
+export declare enum ProgramMembershipType {
+    ProgramMembership = "ProgramMembership"
+}
+/**
+ * Used to describe membership in a loyalty programs
+ * (e.g. "StarAliance"), traveler clubs (e.g. "AAA"), purchase clubs ("Safeway Club"), etc.
+ * {@link https://schema.org/ProgramMembership}
+ */
+export interface IProgramMembership extends Pick<IThing, 'name'> {
+    typeOf: ProgramMembershipType;
+    /**
+     * A unique identifier for the membership.
+     */
+    membershipNumber?: string;
+}

package/lib/{factory/programMembership.js → programMembership.js}

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProgramMembershipType = void 0;
 var ProgramMembershipType;
 (function (ProgramMembershipType) {
     ProgramMembershipType["ProgramMembership"] = "ProgramMembership";

package/lib/project.d.ts

@@ -0,0 +1,107 @@
+import { IMerchantReturnPolicy } from './merchantReturnPolicy';
+import { IOrganization } from './organization';
+import { OrganizationType } from './organizationType';
+import { SortType } from './sortType';
+/**
+ * 通知パラメータ
+ */
+export interface IInformParams {
+    /**
+     * 通知先
+     */
+    recipient?: {
+        id?: string;
+        name?: string;
+        url?: string;
+    };
+}
+export interface IOnPaymentStatusChanged {
+    informPayment?: IInformParams[];
+}
+/**
+ * 予約使用時イベント
+ */
+export interface IOnReservationUsed {
+    informAction?: IInformParams[];
+}
+/**
+ * 注文ステータス変更時イベント
+ */
+export interface IOnOrderStatusChanged {
+    informOrder?: IInformParams[];
+}
+/**
+ * ウェブフック設定
+ */
+export interface IWebhookSettings {
+    /**
+     * リクエストタイムアウト
+     * {@link https://github.com/request/request#timeouts}
+     */
+    timeout?: number;
+}
+export interface ISendEmailMessageSettings {
+    sender?: {
+        email?: string;
+    };
+}
+/**
+ * プロジェクト設定
+ */
+export interface ISettings {
+    importEventsInWeeks?: number;
+    onOrderStatusChanged?: IOnOrderStatusChanged;
+    webhook?: IWebhookSettings;
+    sendEmailMessage?: ISendEmailMessageSettings;
+    sendgridApiKey?: string;
+    transactionWebhookUrls?: string[];
+    useMyCreditCards?: boolean;
+    useUsernameAsGMOMemberId?: boolean;
+}
+export interface ISubscription {
+    identifier?: string;
+    /**
+     * プロダクトとしての興行管理を利用するかどうか
+     */
+    useEventServiceAsProduct?: boolean;
+    /**
+     * サブカタログ管理を利用するかどうか
+     */
+    useOfferCatalogItem?: boolean;
+}
+export type IHasMerchantReturnPolicy = Pick<IMerchantReturnPolicy, 'sameAs' | 'typeOf'>;
+/**
+ * プロジェクト
+ */
+export interface IProject extends Pick<IOrganization, 'id' | 'logo' | 'name' | 'typeOf'> {
+    typeOf: OrganizationType.Project;
+    id: string;
+    alternateName?: string;
+    description?: string;
+    hasMerchantReturnPolicy?: IHasMerchantReturnPolicy;
+    name?: string;
+    settings?: ISettings;
+    subscription?: ISubscription;
+}
+/**
+ * ソート条件
+ */
+export interface ISortOrder {
+    _id?: SortType;
+}
+/**
+ * プロジェクト検索条件
+ */
+export interface ISearchConditions {
+    limit?: number;
+    page?: number;
+    sort?: ISortOrder;
+    id?: {
+        $eq?: string;
+    };
+    ids?: string[];
+    /**
+     * 名称
+     */
+    name?: string;
+}

package/lib/project.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/propertyValue/locationFeatureSpecification.d.ts

@@ -0,0 +1,4 @@
+import * as PropertyValueFactory from '../propertyValue';
+export interface IPropertyValue extends Pick<PropertyValueFactory.IPropertyValue<string>, 'name' | 'value'> {
+    typeOf: PropertyValueFactory.PropertyValueType.LocationFeatureSpecification;
+}

package/lib/propertyValue/locationFeatureSpecification.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,3 +1,6 @@
+export declare enum PropertyValueType {
+    LocationFeatureSpecification = "LocationFeatureSpecification"
+}
 /**
  * 属性値インターフェース
  */

package/lib/propertyValue.js

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

package/lib/qualitativeValue.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/quantitativeValue.d.ts

@@ -0,0 +1,34 @@
+import { IThing } from './thing';
+import { UnitCode } from './unitCode';
+export type QuantitativeValueType = 'QuantitativeValue';
+export declare enum StringValue {
+    Infinity = "Infinity"
+}
+/**
+ * A point value or interval for product characteristics and other purposes.
+ * {@link https://schema.org/QuantitativeValue}
+ */
+export interface IQuantitativeValue<T extends UnitCode | string> extends Pick<IThing, 'description' | 'name'> {
+    /**
+     * The upper value of some characteristic or property.
+     */
+    maxValue?: number;
+    /**
+     * The lower value of some characteristic or property.
+     */
+    minValue?: number;
+    typeOf: QuantitativeValueType;
+    /**
+     * The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL.
+     * Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon.
+     */
+    unitCode?: T;
+    /**
+     * A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for unitCode.
+     */
+    unitText?: string;
+    /**
+     * The value of the quantitative value or property value node.
+     */
+    value?: number | StringValue;
+}

package/lib/quantitativeValue.js

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