@opentripplanner/core-utils 14.0.0-alpha.2 → 14.0.1

package/lib/itinerary.d.ts

@@ -1,4 +1,4 @@
-import { Company, Config, ElevationProfile, ElevationProfileComponent, FlexBookingInfo, ItineraryOnlyLegsRequired, LatLngArray, Leg, MassUnitOption, Money, Place, Step, Stop, TncFare } from "@opentripplanner/types";
+import { AppliedFareProduct, Company, Config, Currency, ElevationProfile, ElevationProfileComponent, FlexBookingInfo, ItineraryOnlyLegsRequired, LatLngArray, Leg, MassUnitOption, Money, Place, Step, Stop, TncFare } from "@opentripplanner/types";
 export declare const transitModes: string[];
 /**
  * @param  {config} config OTP-RR configuration object
@@ -134,15 +134,31 @@ export declare function calculateEmissions(itinerary: ItineraryOnlyLegsRequired,
  */
 export declare function getDisplayedStopId(placeOrStop: Place | Stop): string;
 /**
- * Extracts useful data from the fare products on a leg, such as the leg cost and transfer info.
- * @param leg Leg with fare products (must have used getLegsWithFares)
- * @param category Rider category
- * @param container Fare container (cash, electronic)
- * @returns Object containing price as well as the transfer discount amount, if a transfer was used.
+ * Removes the first part of the OTP standard scope (":"), if it is present
+ * @param item String that is potentially scoped with `:` character
+ * @returns    descoped string
  */
-export declare function getLegCost(leg: Leg, mediumId: string | null, riderCategoryId: string | null): {
+export declare const descope: (item: string) => string;
+export type ExtendedMoney = Money & {
+    originalAmount?: number;
+};
+export declare const zeroDollars: (currency: Currency) => Money;
+/**
+ * Extracts useful data from the fare products on a leg, such as the leg cost and transfer info.
+ * @param leg                Leg with Fares v2 information
+ * @param mediumId           Desired medium ID to calculate fare for
+ * @param riderCategoryId    Desire rider category to calculate fare for
+ * @param seenFareIds        Fare IDs used on previous legs. Used to detect transfer discounts.
+ * @returns                  Object containing price as well as transfer/dependent
+ *                           fare information. `AppliedFareProduct` should contain
+ *                           all the information needed, but the other fields are kept to
+ *                           make the transition to Fares V2 less jarring.
+ */
+export declare function getLegCost(leg: Leg, mediumId: string | null, riderCategoryId: string | null, seenFareIds?: string[]): {
+    alternateFareProducts?: AppliedFareProduct[];
+    appliedFareProduct?: AppliedFareProduct;
+    isDependent?: boolean;
     price?: Money;
-    transferAmount?: Money | undefined;
     productUseId?: string;
 };
 /**
@@ -150,6 +166,7 @@ export declare function getLegCost(leg: Leg, mediumId: string | null, riderCateg
  * @param legs Itinerary legs with fare products (must have used getLegsWithFares)
  * @param category Rider category (youth, regular, senior)
  * @param container Fare container (cash, electronic)
+ * @param seenFareIds List of fare product IDs that have already been seen on prev legs.
  * @returns Money object for the total itinerary cost.
  */
 export declare function getItineraryCost(legs: Leg[], mediumId: string | null, riderCategoryId: string | null): Money | undefined;

package/lib/itinerary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"itinerary.d.ts","sourceRoot":"","sources":["../src/itinerary.ts"],"names":[],"mappings":"AACA,OAAO,EACL,OAAO,EACP,MAAM,EACN,gBAAgB,EAChB,yBAAyB,EACzB,eAAe,EACf,yBAAyB,EACzB,WAAW,EACX,GAAG,EACH,cAAc,EACd,KAAK,EACL,KAAK,EACL,IAAI,EACJ,IAAI,EACJ,OAAO,EACR,MAAM,wBAAwB,CAAC;AAIhC,eAAO,MAAM,YAAY,UAQxB,CAAC;AAEF;;;GAGG;AAEH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAOxD;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAE9C;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE/C;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAEvD;AACD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAKxD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAItD;AACD,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAElD;AACD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAEpD;AACD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAErD;AACD,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAEvE;AACD,wBAAgB,gCAAgC,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAElE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAQxC;AAGD,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAEhD;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAI5C;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAI/C;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAInD;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAG3C;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAGrD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQlD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAIjD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAahD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAMlD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAiClD;AAED,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,yBAAyB,GACnC,WAAW,EAAE,CASf;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,EAAE,CAYjD;AAID,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAc1E;AAID,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EAAE,EAAE,EAClB,QAAQ,EAAE,MAAM,GACf,MAAM,CAkCR;AAED,wBAAgB,6BAA6B,CAAC,OAAO,EAAE;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,yBAAyB,CAK5B;AAID,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,IAAI,EAAE,EACb,cAAc,SAAI,GACjB,gBAAgB,CAgDlB;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,SAAe,GAAG,MAAM,CAYtE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,OAAO,EAAO,GACxB,OAAO,CAST;AAED;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,EAC3B,SAAS,GAAE,OAAO,EAAO,GACxB,MAAM,CAMR;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG7D;AAED,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,yBAAyB,GACnC;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;CACtB,CAcA;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,yBAAyB,GACnC,OAAO,CAmBT;AA4BD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAEhC,SAAS,EAAE,yBAAyB,EACpC,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EAC5C,KAAK,CAAC,EAAE,cAAc,GACrB,MAAM,CA2BR;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,KAAK,GAAG,IAAI,GAAG,MAAM,CASpE;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,eAAe,EAAE,MAAM,GAAG,IAAI,GAC7B;IACD,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,cAAc,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAyBA;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,GAAG,EAAE,EACX,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,eAAe,EAAE,MAAM,GAAG,IAAI,GAC7B,KAAK,GAAG,SAAS,CA2BnB;AAiBD,eAAO,MAAM,8BAA8B,QAAS,GAAG,KAAG,GA6BxD,CAAC;AAEH,sEAAsE;AACtE,eAAO,MAAM,oBAAoB,QAC1B,KAAK,GAAG,EAAE,OAAO,GAAG,gBAAgB,CAAC,KACzC,MAAM,GAAG,IAMX,CAAC;AAEF,wEAAwE;AACxE,eAAO,MAAM,mBAAmB,QACzB,KAAK,GAAG,EAAE,OAAO,GAAG,eAAe,CAAC,KACxC,MAAM,GAAG,IAIX,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,QACrB,KAAK,GAAG,EAAE,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,KAC3D,MAEF,CAAC"}
+{"version":3,"file":"itinerary.d.ts","sourceRoot":"","sources":["../src/itinerary.ts"],"names":[],"mappings":"AACA,OAAO,EACL,kBAAkB,EAClB,OAAO,EACP,MAAM,EACN,QAAQ,EACR,gBAAgB,EAChB,yBAAyB,EACzB,eAAe,EACf,yBAAyB,EACzB,WAAW,EACX,GAAG,EACH,cAAc,EACd,KAAK,EACL,KAAK,EACL,IAAI,EACJ,IAAI,EACJ,OAAO,EACR,MAAM,wBAAwB,CAAC;AAIhC,eAAO,MAAM,YAAY,UAQxB,CAAC;AAEF;;;GAGG;AAEH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAOxD;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAE9C;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE/C;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAEvD;AACD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAKxD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAItD;AACD,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAElD;AACD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAEpD;AACD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAErD;AACD,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAEvE;AACD,wBAAgB,gCAAgC,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAElE;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAQxC;AACD,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAEhD;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAI5C;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAI/C;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAInD;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAG3C;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAGrD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQlD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAIjD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAahD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAMlD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,CAiClD;AAED,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,yBAAyB,GACnC,WAAW,EAAE,CASf;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,EAAE,EAAE,CAYjD;AAID,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAc1E;AAID,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EAAE,EAAE,EAClB,QAAQ,EAAE,MAAM,GACf,MAAM,CAkCR;AAED,wBAAgB,6BAA6B,CAAC,OAAO,EAAE;IACrD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,yBAAyB,CAK5B;AAID,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,IAAI,EAAE,EACb,cAAc,SAAI,GACjB,gBAAgB,CAgDlB;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,SAAe,GAAG,MAAM,CAYtE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,OAAO,EAAO,GACxB,OAAO,CAST;AAED;;;;;;GAMG;AACH,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,EAC3B,SAAS,GAAE,OAAO,EAAO,GACxB,MAAM,CAMR;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG7D;AAED,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,yBAAyB,GACnC;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;CACtB,CAcA;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,yBAAyB,GACnC,OAAO,CAmBT;AA4BD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAEhC,SAAS,EAAE,yBAAyB,EACpC,eAAe,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EAC5C,KAAK,CAAC,EAAE,cAAc,GACrB,MAAM,CA2BR;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,KAAK,GAAG,IAAI,GAAG,MAAM,CASpE;AAED;;;;GAIG;AACH,eAAO,MAAM,OAAO,SAAU,MAAM,KAAG,MAA+B,CAAC;AAEvE,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG;IAAE,cAAc,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhE,eAAO,MAAM,WAAW,aAAc,QAAQ,KAAG,KAG/C,CAAC;AAEH;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,GAAG,EAAE,GAAG,EACR,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,eAAe,EAAE,MAAM,GAAG,IAAI,EAC9B,WAAW,CAAC,EAAE,MAAM,EAAE,GACrB;IACD,qBAAqB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC7C,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAkDA;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,GAAG,EAAE,EACX,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,eAAe,EAAE,MAAM,GAAG,IAAI,GAC7B,KAAK,GAAG,SAAS,CA4BnB;AAiBD,eAAO,MAAM,8BAA8B,QAAS,GAAG,KAAG,GA6BxD,CAAC;AAEH,sEAAsE;AACtE,eAAO,MAAM,oBAAoB,QAC1B,KAAK,GAAG,EAAE,OAAO,GAAG,gBAAgB,CAAC,KACzC,MAAM,GAAG,IAMX,CAAC;AAEF,wEAAwE;AACxE,eAAO,MAAM,mBAAmB,QACzB,KAAK,GAAG,EAAE,OAAO,GAAG,eAAe,CAAC,KACxC,MAAM,GAAG,IAIX,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,QACrB,KAAK,GAAG,EAAE,OAAO,GAAG,eAAe,GAAG,gBAAgB,CAAC,KAC3D,MAEF,CAAC"}