@chevre/factory 3.0.1 → 3.343.0-alpha.2

package/lib/event/screeningEvent.d.ts

@@ -0,0 +1,325 @@
+import * as COA from '@motionpicture/coa-service';
+import * as EventFactory from '../event';
+import * as ScreeningEventSeriesFactory from '../event/screeningEventSeries';
+import { EventType } from '../eventType';
+import { OfferType } from '../offerType';
+import { PlaceType } from '../placeType';
+import { IServiceType as IProductServiceType, ProductType } from '../product';
+import * as ReservationFactory from '../reservation';
+import { ReservationType } from '../reservationType';
+import * as WebAPIFactory from '../service/webAPI';
+import * as AnyEventFactory from './anyEvent';
+export import IAggregateReservation = AnyEventFactory.IAggregateReservation;
+export import IOfferWithAggregateReservation = AnyEventFactory.IOfferWithAggregateReservation;
+export import IAggregateOffer = AnyEventFactory.IAggregateOffer;
+export import IPlaceWithAggregateOffer = AnyEventFactory.IPlaceWithAggregateOffer;
+export import IAggregateEntranceGate = AnyEventFactory.IAggregateEntranceGate;
+export interface IServiceOutput {
+    typeOf: ReservationType.EventReservation;
+    reservedTicket?: {
+        typeOf: ReservationFactory.TicketType;
+        /**
+         * チケットに割り当てられる座席
+         * 指定席でない場合、存在しない
+         */
+        ticketedSeat?: {
+            typeOf: PlaceType.Seat;
+        };
+    };
+}
+export type IServiceType = IProductServiceType & {
+    id?: string;
+};
+/**
+ * 興行
+ */
+export interface IItemOffered {
+    id: string;
+    /**
+     * プロダクト名称
+     */
+    name?: {
+        ja?: string;
+    };
+    /**
+     * サービス区分
+     */
+    serviceType?: IServiceType;
+    /**
+     * サービスアウトプット
+     */
+    serviceOutput?: IServiceOutput;
+    typeOf: ProductType.EventService;
+    availableChannel: ReservationFactory.IServiceChannel;
+}
+export type IOfferedThrough = WebAPIFactory.IService<WebAPIFactory.Identifier>;
+export import ISellerMakesOffer = AnyEventFactory.ISellerMakesOffer;
+export import ISeller = AnyEventFactory.ISeller;
+export import IEligibleQuantity = AnyEventFactory.IEligibleQuantity;
+/**
+ * イベントに対するオファー
+ */
+export interface IOffer {
+    typeOf: OfferType.Offer;
+    /**
+     * 情報提供終了日時(オンライン取引アプリケーションの設定)
+     * @deprecated Use seller.makesOffer
+     */
+    availabilityEnds: Date;
+    /**
+     * 情報提供開始日時(オンライン取引アプリケーションの設定)
+     * @deprecated Use seller.makesOffer
+     */
+    availabilityStarts: Date;
+    eligibleQuantity: IEligibleQuantity;
+    itemOffered: IItemOffered;
+    /**
+     * オファー供給サービス
+     */
+    offeredThrough?: IOfferedThrough;
+    /**
+     * 販売可能期間from(オンライン取引アプリケーションの設定)
+     * @deprecated Use seller.makesOffer
+     */
+    validFrom: Date;
+    /**
+     * 販売可能期間through(オンライン取引アプリケーションの設定)
+     * @deprecated Use seller.makesOffer
+     */
+    validThrough: Date;
+    unacceptedPaymentMethod?: string[];
+    seller: ISeller;
+}
+export type IOffer4COA = Pick<IOffer, 'typeOf' | 'offeredThrough'> & {
+    itemOffered: {
+        serviceOutput: Pick<IServiceOutput, 'reservedTicket'>;
+    };
+};
+export interface ICOAInfo {
+    theaterCode: string;
+    dateJouei: string;
+    titleCode: string;
+    titleBranchNum: string;
+    timeBegin: string;
+    timeEnd: string;
+    screenCode: string;
+    /**
+     * トレーラー時間
+     * トレーラー含む本編以外の時間（分）
+     */
+    trailerTime: number;
+    /**
+     * サービス区分
+     * 「通常興行」「レイトショー」など
+     */
+    kbnService?: COA.factory.master.IKubunNameResult;
+    /**
+     * 音響区分
+     */
+    kbnAcoustic?: COA.factory.master.IKubunNameResult;
+    /**
+     * サービスデイ名称
+     * 「映画の日」「レディースデイ」など ※割引区分、割引コード、特定日等の組み合わせで登録するため名称で連携の方が容易
+     */
+    nameServiceDay: string;
+    /**
+     * 購入可能枚数
+     */
+    availableNum: number;
+    /**
+     * 予約開始日
+     * 予約可能になる日付(YYYYMMDD)
+     */
+    rsvStartDate: string;
+    /**
+     * 予約終了日
+     * 予約終了になる日付(YYYYMMDD)
+     */
+    rsvEndDate: string;
+    /**
+     * 先行予約フラグ
+     * 先行予約の場合は'1'、それ以外は'0'
+     */
+    flgEarlyBooking: string;
+}
+/**
+ * COA券種情報
+ */
+export type ICOAOffer = COA.factory.reserve.IUpdReserveTicket & {
+    /**
+     * チケット名
+     */
+    ticketName: string;
+    /**
+     * チケット名（カナ）
+     */
+    ticketNameKana: string;
+    /**
+     * チケット名（英）
+     */
+    ticketNameEng: string;
+    /**
+     * ポイント割引の場合の消費ポイント
+     */
+    usePoint: number;
+};
+export type IWorkPerformed = ScreeningEventSeriesFactory.IWorkPerformed;
+export import ILocation = AnyEventFactory.ILocation;
+export type ISuperEvent = Pick<ScreeningEventSeriesFactory.IEvent, 'typeOf' | 'id' | 'videoFormat' | 'soundFormat' | 'workPerformed' | 'location' | 'kanaName' | 'name' | 'additionalProperty' | 'startDate' | 'endDate' | 'description' | 'headline' | 'dubLanguage' | 'subtitleLanguage' | 'identifier' | 'alternativeHeadline' | 'duration' | 'coaInfo'>;
+export import IName = AnyEventFactory.IName;
+/**
+ * イベント属性
+ * workPerformed->superEvent.workPerformed完全移行(2023-02-20~)
+ */
+export interface IAttributes extends Omit<AnyEventFactory.IAttributes, 'offers' | 'typeOf' | 'workPerformed'> {
+    /**
+     * コンテンツ
+     */
+    /**
+     * 親イベント
+     * 施設コンテンツに相当
+     */
+    superEvent: ISuperEvent;
+    /**
+     * 販売情報
+     */
+    offers: IOffer | IOffer4COA;
+    /**
+     * その他COA情報
+     * 基本的にsskts対応
+     */
+    coaInfo?: ICOAInfo;
+    typeOf: EventType.ScreeningEvent;
+}
+/**
+ * イベント
+ */
+export type IEvent = EventFactory.IEvent<IAttributes>;
+export import ILocation4create = AnyEventFactory.ILocation4create;
+export import ISeller4create = AnyEventFactory.ISeller4create;
+export type ISuperEvent4create = Pick<ISuperEvent, 'id'>;
+export type IOffers4create = Pick<IOffer, 'unacceptedPaymentMethod'> & {
+    /**
+     * 最大予約数を指定
+     */
+    eligibleQuantity: Pick<IEligibleQuantity, 'maxValue'>;
+    /**
+     * 興行IDと座席有無を指定
+     */
+    itemOffered: Pick<IItemOffered, 'id' | 'serviceOutput'>;
+    /**
+     * 販売者IDとアプリケーション設定
+     */
+    seller: ISeller4create;
+};
+export type ICreateParams = Pick<IAttributes, 'project' | 'typeOf' | 'doorTime' | 'startDate' | 'endDate' | 'eventStatus' | 'additionalProperty'> & {
+    /**
+     * ルームコードとキャパシティを指定
+     */
+    location: ILocation4create;
+    /**
+     * 施設コンテンツIDを指定
+     */
+    superEvent: ISuperEvent4create;
+    offers: IOffers4create;
+};
+/**
+ * イベント更新パラメータ
+ */
+export type IUpdateParams = ICreateParams;
+/**
+ * ソート条件
+ */
+export type ISortOrder = EventFactory.ISortOrder;
+export interface IOfferSearchConditions {
+    /**
+     * apiリクエストクライアントがseller.makesOffer.$elemMatchに含まれるものを検索
+     */
+    availableFrom?: Date;
+    /**
+     * apiリクエストクライアントがseller.makesOffer.$elemMatchに含まれるものを検索
+     */
+    availableThrough?: Date;
+    /**
+     * apiリクエストクライアントがseller.makesOffer.$elemMatchに含まれるものを検索
+     */
+    validFrom?: Date;
+    /**
+     * apiリクエストクライアントがseller.makesOffer.$elemMatchに含まれるものを検索
+     */
+    validThrough?: Date;
+    itemOffered?: {
+        id?: {
+            $in?: string[];
+        };
+        serviceType?: {
+            ids?: string[];
+        };
+        serviceOutput?: {
+            reservedTicket?: {
+                ticketedSeat?: {
+                    typeOfs?: string[];
+                };
+            };
+        };
+    };
+    seller?: {
+        makesOffer?: {
+            $elemMatch?: {
+                availabilityEnds?: {
+                    $gte?: Date;
+                    $lte?: Date;
+                };
+                availabilityStarts?: {
+                    $gte?: Date;
+                    $lte?: Date;
+                };
+                validFrom?: {
+                    $gte?: Date;
+                    $lte?: Date;
+                };
+                validThrough?: {
+                    $gte?: Date;
+                    $lte?: Date;
+                };
+                'availableAtOrFrom.id'?: {
+                    $eq?: string;
+                };
+            };
+        };
+    };
+}
+/**
+ * イベント検索条件
+ */
+export interface ISearchConditions extends EventFactory.ISearchConditions<EventType.ScreeningEvent> {
+    location?: {
+        /**
+         * ルームコード
+         */
+        branchCode?: {
+            $eq?: string;
+            $in?: string[];
+        };
+    };
+    /**
+     * 販売情報
+     */
+    offers?: IOfferSearchConditions;
+    superEvent?: {
+        ids?: string[];
+        location?: {
+            id?: {
+                $eq?: string;
+            };
+        };
+        /**
+         * 施設コンテンツの施設コードリスト
+         */
+        locationBranchCodes?: string[];
+        /**
+         * 施設コンテンツのコンテンツコードリスト
+         */
+        workPerformedIdentifiers?: string[];
+    };
+}

package/lib/event/screeningEvent.js

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

package/lib/event/screeningEventSeries.d.ts

@@ -0,0 +1,211 @@
+import * as COA from '@motionpicture/coa-service';
+import { ICreativeWork as IMovie } from '../creativeWork/movie';
+import * as EventFactory from '../event';
+import { EventType } from '../eventType';
+import { ILanguage } from '../language';
+import { IMultilingualString } from '../multilingualString';
+import { OfferType } from '../offerType';
+import { PlaceType } from '../placeType';
+/**
+ * 施設コンテンツに対するオファー
+ */
+export interface IOffer {
+    typeOf: OfferType.Offer;
+    /**
+     * 利用不可決済方法区分
+     */
+    unacceptedPaymentMethod?: string[];
+}
+export interface IVideoFormat {
+    typeOf: string;
+    name: string;
+}
+export interface ISoundFormat {
+    typeOf: string;
+    name: string;
+}
+/**
+ * コンテンツ
+ * contentRatingはCOAのみ存在
+ */
+export type IWorkPerformed = Pick<IMovie, 'typeOf' | 'id' | 'identifier' | 'name' | 'duration' | 'contentRating'> & {
+    /**
+     * 同コンテンツに対する複数施設コンテンツのバージョン
+     * identifier+versionでuniqueな想定
+     */
+    version?: string;
+};
+export interface IOrganizer {
+    /**
+     * 販売者ID
+     */
+    id: string;
+}
+export interface ICOAInfo {
+    titleBranchNum: string;
+    /**
+     * 映倫区分
+     */
+    kbnEirin?: COA.factory.master.IKubunNameResult;
+    /**
+     * 映像区分
+     * ２D、３D
+     */
+    kbnEizou?: COA.factory.master.IKubunNameResult;
+    /**
+     * 上映方式区分(ＩＭＡＸ，４ＤＸ等)
+     */
+    kbnJoueihousiki?: COA.factory.master.IKubunNameResult;
+    /**
+     * 字幕吹替区分(字幕、吹き替え)
+     */
+    kbnJimakufukikae?: COA.factory.master.IKubunNameResult;
+    /**
+     * ムビチケ使用フラグ
+     * 1：ムビチケ使用対象
+     */
+    flgMvtkUse: string;
+    /**
+     * ムビチケ利用開始日
+     * ※日付は西暦8桁 "YYYYMMDD"
+     */
+    dateMvtkBegin: string;
+}
+export interface ILocation {
+    typeOf: PlaceType.MovieTheater;
+    /**
+     * 施設ID
+     */
+    id: string;
+    /**
+     * コード
+     */
+    branchCode: string;
+    /**
+     * 名称
+     */
+    name?: IMultilingualString;
+    /**
+     * カナ名称
+     */
+    kanaName?: string;
+}
+export interface IAttributes extends Pick<EventFactory.IAttributes<EventType.ScreeningEventSeries>, 'project' | 'typeOf' | 'identifier' | 'name' | 'alternativeHeadline' | 'description' | 'duration' | 'endDate' | 'eventStatus' | 'headline' | 'location' | 'offers' | 'startDate' | 'workPerformed' | 'additionalProperty'> {
+    /**
+     * 字幕利用可能言語
+     */
+    subtitleLanguage?: ILanguage;
+    /**
+     * 吹替利用可能言語
+     */
+    dubLanguage?: ILanguage;
+    /**
+     * 上映方式
+     */
+    videoFormat: IVideoFormat[] | COA.factory.master.IKubunNameResult;
+    /**
+     * 音響方式
+     */
+    soundFormat: ISoundFormat[];
+    /**
+     * コンテンツ
+     */
+    workPerformed: IWorkPerformed;
+    /**
+     * 施設
+     */
+    location: ILocation;
+    organizer: IOrganizer;
+    /**
+     * カナ名称
+     */
+    kanaName: string;
+    /**
+     * 名称
+     */
+    name: IMultilingualString;
+    /**
+     * 終了日時
+     * ISO 8601 date format
+     */
+    endDate?: Date;
+    /**
+     * 開始日時
+     * ISO 8601 date format
+     */
+    startDate?: Date;
+    /**
+     * 販売情報
+     */
+    offers?: IOffer;
+    /**
+     * その他COA情報
+     * @deprecated 基本的にCinemaSunshineの互換性維持目的であり、そのうち廃止予定
+     */
+    coaInfo?: ICOAInfo;
+}
+/**
+ * 施設コンテンツ
+ */
+export type IEvent = EventFactory.IEvent<IAttributes>;
+export type ICreateParams = Omit<IAttributes, 'location' | 'workPerformed' | 'coaInfo' | 'organizer' | 'videoFormat' | 'alternativeHeadline'> & {
+    location: {
+        id: string;
+    };
+    workPerformed: {
+        identifier: string;
+        /**
+         * 同コンテンツに対する複数施設コンテンツのバージョン
+         * identifier+versionでuniqueな想定
+         */
+        version?: string;
+    };
+    videoFormat: IVideoFormat[];
+};
+/**
+ * ソート条件
+ */
+export type ISortOrder = EventFactory.ISortOrder;
+/**
+ * 検索条件
+ */
+export interface ISearchConditions extends EventFactory.ISearchConditions<EventType.ScreeningEventSeries> {
+    sort?: ISortOrder;
+    location?: {
+        branchCode?: {
+            $eq?: string;
+            $in?: string[];
+        };
+        /**
+         * 施設コードリスト
+         */
+        branchCodes?: string[];
+        /**
+         * 施設ID
+         */
+        id?: {
+            $eq?: string;
+        };
+    };
+    videoFormat?: {
+        typeOf?: {
+            $eq?: string;
+            $in?: string[];
+        };
+    };
+    soundFormat?: {
+        typeOf?: {
+            $eq?: string;
+            $in?: string[];
+        };
+    };
+    workPerformed?: {
+        /**
+         * コンテンツコード
+         */
+        identifiers?: string[];
+        version?: {
+            $eq?: string;
+        };
+    };
+}

package/lib/event/screeningEventSeries.js

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

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

@@ -1,14 +1,15 @@
 import * as CreativeWorkFactory from './creativeWork';
-import EventStatusType from './eventStatusType';
-import EventType from './eventType';
-import IMultilingualString from './multilingualString';
+import { EventStatusType } from './eventStatusType';
+import { EventType } from './eventType';
+import { IMultilingualString } from './multilingualString';
 import * as OfferFactory from './offer';
 import * as PlaceFactory from './place';
 import { IProject } from './project';
 import { IPropertyValue } from './propertyValue';
-import SortType from './sortType';
+import { SortType } from './sortType';
+export type IOffer = Pick<OfferFactory.IOffer, 'typeOf' | 'unacceptedPaymentMethod' | 'seller' | 'eligibleQuantity' | 'itemOffered' | 'offeredThrough'>;
 export interface IAttributes<T extends EventType> {
-    project: IProject;
+    project: Pick<IProject, 'id' | 'typeOf'>;
     /**
      * イベントタイプ
      */
@@ -16,7 +17,7 @@ export interface IAttributes<T extends EventType> {
     /**
      * イベント識別子
      */
-    identifier?: any;
+    identifier?: string;
     /**
      * イベント名称
      */
@@ -51,7 +52,7 @@ export interface IAttributes<T extends EventType> {
     /**
      * イベントが実行される場所
      */
-    location?: PlaceFactory.IPlace;
+    location?: Omit<PlaceFactory.IPlace, 'project'>;
     /**
      * 最大収容人数
      */
@@ -60,7 +61,7 @@ export interface IAttributes<T extends EventType> {
      * An offer to provide this item—for example, an offer to sell a product,
      * rent the DVD of a movie, perform a service, or give away tickets to an event.
      */
-    offers?: OfferFactory.IOffer | OfferFactory.IOffer[];
+    offers?: IOffer | IOffer[];
     /**
      * 残り収容人数
      */
@@ -71,37 +72,46 @@ export interface IAttributes<T extends EventType> {
      */
     startDate?: Date;
     /**
-     * イベントで上演される作品
+     * イベントで上演されるコンテンツ
      */
     workPerformed?: CreativeWorkFactory.ICreativeWork;
     additionalProperty?: IPropertyValue<string>[];
 }
 /**
- * イベントインターフェース
+ * イベント
  */
-export declare type IEvent<T extends IAttributes<EventType>> = T & {
+export type IEvent<T extends IAttributes<EventType>> = T & {
     id: string;
 };
 /**
- * ソート条件インターフェース
+ * ソート条件
  */
 export interface ISortOrder {
-    name?: string;
-    doorTime?: SortType;
-    endDate?: SortType;
     startDate?: SortType;
 }
 export interface ISearchConditions<T extends EventType> {
     limit?: number;
     page?: number;
     sort?: ISortOrder;
+    id?: {
+        $eq?: string;
+        $in?: string[];
+    };
+    organizer?: {
+        id?: {
+            $eq?: string;
+        };
+    };
     project?: {
-        ids?: string[];
+        id?: {
+            $eq?: string;
+        };
     };
     /**
      * イベントタイプ
      */
-    typeOf: T;
+    typeOf?: T;
+    typeOfIn?: EventType[];
     /**
      * イベント名称
      */
@@ -140,29 +150,19 @@ export interface ISearchConditions<T extends EventType> {
      * イベントステータス
      */
     eventStatuses?: EventStatusType[];
-    location?: {
-        branchCode?: {
+    hasOfferCatalog?: {
+        id?: {
             $eq?: string;
         };
-        /**
-         * 場所の識別子リスト
-         */
-        branchCodes?: string[];
     };
-    superEvent?: {
-        ids?: string[];
-        location?: {
-            id?: {
+    additionalProperty?: {
+        $elemMatch?: {
+            name?: {
+                /**
+                 * 一致する名称の追加特性がひとつでも存在する
+                 */
                 $eq?: string;
             };
         };
-        /**
-         * 親イベント(劇場の上映イベント)が実施される場所の識別子リスト
-         */
-        locationBranchCodes?: string[];
-        /**
-         * イベントで上演される作品識別子リスト
-         */
-        workPerformedIdentifiers?: string[];
     };
 }

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

@@ -1,10 +1,9 @@
 /**
  * イベントステータス
  */
-declare enum EventStatusType {
+export declare enum EventStatusType {
     EventCancelled = "EventCancelled",
     EventPostponed = "EventPostponed",
     EventRescheduled = "EventRescheduled",
     EventScheduled = "EventScheduled"
 }
-export default EventStatusType;