diff --git a/maas-schemas-ts/package.json b/maas-schemas-ts/package.json index 05f5098d7..bc75f3966 100644 --- a/maas-schemas-ts/package.json +++ b/maas-schemas-ts/package.json @@ -1,6 +1,6 @@ { "name": "maas-schemas-ts", - "version": "13.6.1", + "version": "13.7.0", "description": "TypeScript types and io-ts validators for maas-schemas", "main": "index.js", "files": [ diff --git a/maas-schemas-ts/src/core/components/common.ts b/maas-schemas-ts/src/core/components/common.ts index fe263c34d..bdcc56ac9 100644 --- a/maas-schemas-ts/src/core/components/common.ts +++ b/maas-schemas-ts/src/core/components/common.ts @@ -8,7 +8,7 @@ MaaS common components that are used consistently within our own objects */ import * as t from 'io-ts'; -import * as Units_ from './units'; +import * as Units_ from 'maas-schemas-ts/core/components/units'; import { NonEmptyArray } from 'fp-ts/lib/NonEmptyArray'; import { nonEmptyArray } from 'io-ts-types/lib/nonEmptyArray'; diff --git a/maas-schemas-ts/src/core/itinerary.ts b/maas-schemas-ts/src/core/itinerary.ts index 6dfc6d68f..2c6ff0547 100644 --- a/maas-schemas-ts/src/core/itinerary.ts +++ b/maas-schemas-ts/src/core/itinerary.ts @@ -7,14 +7,15 @@ OpenTripPlanner itinerary, augmented with leg bookings per leg */ -import * as Units_ from "maas-schemas-ts/core/components/units"; -import * as t from "io-ts"; -import * as Common_ from "maas-schemas-ts/core/components/common"; -import * as State_ from "maas-schemas-ts/core/components/state"; -import * as Fare_ from "maas-schemas-ts/core/components/fare"; -import * as Leg_ from "maas-schemas-ts/core/leg"; -import * as ProductOption_ from "maas-schemas-ts/core/product-option"; -import * as Booking_ from "maas-schemas-ts/core/booking"; +import * as Units_ from 'maas-schemas-ts/core/components/units'; +import * as t from 'io-ts'; +import * as Common_ from 'maas-schemas-ts/core/components/common'; +import * as State_ from 'maas-schemas-ts/core/components/state'; +import * as Fare_ from 'maas-schemas-ts/core/components/fare'; +import * as Leg_ from 'maas-schemas-ts/core/leg'; +import * as ProductOption_ from 'maas-schemas-ts/core/product-option'; +import * as Booking_ from 'maas-schemas-ts/core/booking'; +import * as TravelMode_ from 'maas-schemas-ts/core/components/travel-mode'; type Defined = | Record @@ -32,7 +33,7 @@ const Defined = t.union([ t.null, ]); -export const schemaId = "http://maasglobal.com/core/itinerary.json"; +export const schemaId = 'http://maasglobal.com/core/itinerary.json'; // Id // The purpose of this remains a mystery @@ -42,25 +43,25 @@ export const Id = Units_.Uuid; // ItineraryProgress // The purpose of this remains a mystery export type ItineraryProgress = t.Branded< - string & ("IN_PROGRESS" | "IN_PROGRESS_PURCHASABLE" | "FINISHED"), + string & ('IN_PROGRESS' | 'IN_PROGRESS_PURCHASABLE' | 'FINISHED'), ItineraryProgressBrand >; export const ItineraryProgress = t.brand( t.intersection([ t.string, t.union([ - t.literal("IN_PROGRESS"), - t.literal("IN_PROGRESS_PURCHASABLE"), - t.literal("FINISHED"), + t.literal('IN_PROGRESS'), + t.literal('IN_PROGRESS_PURCHASABLE'), + t.literal('FINISHED'), ]), ]), ( - x + x, ): x is t.Branded< - string & ("IN_PROGRESS" | "IN_PROGRESS_PURCHASABLE" | "FINISHED"), + string & ('IN_PROGRESS' | 'IN_PROGRESS_PURCHASABLE' | 'FINISHED'), ItineraryProgressBrand > => true, - "ItineraryProgress" + 'ItineraryProgress', ); export interface ItineraryProgressBrand { readonly ItineraryProgress: unique symbol; @@ -82,7 +83,7 @@ export type Itinerary = t.Branded< fares?: Array; legs?: Array; productOptions?: Array; - type?: "outward" | "return"; + type?: 'outward' | 'return'; bookings?: Array; progress?: ItineraryProgress; fingerprint?: string; @@ -114,7 +115,7 @@ export const Itinerary = t.brand( fares: t.array(Fare_.Fare), legs: t.array(Leg_.Leg), productOptions: t.array(ProductOption_.ProductOption), - type: t.union([t.literal("outward"), t.literal("return")]), + type: t.union([t.literal('outward'), t.literal('return')]), bookings: t.array(Booking_.Booking), progress: ItineraryProgress, fingerprint: t.string, @@ -132,7 +133,7 @@ export const Itinerary = t.brand( }), ]), ( - x + x, ): x is t.Branded< { id?: Id; @@ -147,7 +148,7 @@ export const Itinerary = t.brand( fares?: Array; legs?: Array; productOptions?: Array; - type?: "outward" | "return"; + type?: 'outward' | 'return'; bookings?: Array; progress?: ItineraryProgress; fingerprint?: string; @@ -164,7 +165,7 @@ export const Itinerary = t.brand( }, ItineraryBrand > => true, - "Itinerary" + 'Itinerary', ); export interface ItineraryBrand { readonly Itinerary: unique symbol; diff --git a/maas-schemas-ts/src/core/plan.ts b/maas-schemas-ts/src/core/plan.ts index cd313df8a..07b61a19e 100644 --- a/maas-schemas-ts/src/core/plan.ts +++ b/maas-schemas-ts/src/core/plan.ts @@ -7,10 +7,11 @@ OpenTripPlanner compatible format for plans, extended with id for legs and itine */ -import * as t from "io-ts"; -import * as Place_ from "maas-schemas-ts/core/components/place"; -import * as Units_ from "maas-schemas-ts/core/components/units"; -import * as Itinerary_ from "maas-schemas-ts/core/itinerary"; +import * as t from 'io-ts'; +import * as Place_ from 'maas-schemas-ts/core/components/place'; +import * as Units_ from 'maas-schemas-ts/core/components/units'; +import * as Common_ from 'maas-schemas-ts/core/components/common'; +import * as Itinerary_ from 'maas-schemas-ts/core/itinerary'; type Defined = | Record @@ -28,30 +29,26 @@ const Defined = t.union([ t.null, ]); -export const schemaId = "http://maasglobal.com/core/plan.json"; +export const schemaId = 'http://maasglobal.com/core/plan.json'; // PlanProgress // The purpose of this remains a mystery export type PlanProgress = t.Branded< - string & ("IN_PROGRESS" | "FINISHED" | "FAILED"), + string & ('IN_PROGRESS' | 'FINISHED' | 'FAILED'), PlanProgressBrand >; export const PlanProgress = t.brand( t.intersection([ t.string, - t.union([ - t.literal("IN_PROGRESS"), - t.literal("FINISHED"), - t.literal("FAILED"), - ]), + t.union([t.literal('IN_PROGRESS'), t.literal('FINISHED'), t.literal('FAILED')]), ]), ( - x + x, ): x is t.Branded< - string & ("IN_PROGRESS" | "FINISHED" | "FAILED"), + string & ('IN_PROGRESS' | 'FINISHED' | 'FAILED'), PlanProgressBrand > => true, - "PlanProgress" + 'PlanProgress', ); export interface PlanProgressBrand { readonly PlanProgress: unique symbol; @@ -59,14 +56,11 @@ export interface PlanProgressBrand { // Itineraries // The purpose of this remains a mystery -export type Itineraries = t.Branded< - Array, - ItinerariesBrand ->; +export type Itineraries = t.Branded, ItinerariesBrand>; export const Itineraries = t.brand( t.array(Itinerary_.Itinerary), (x): x is t.Branded, ItinerariesBrand> => true, - "Itineraries" + 'Itineraries', ); export interface ItinerariesBrand { readonly Itineraries: unique symbol; @@ -108,7 +102,7 @@ export const Plan1 = t.brand( }), ]), ( - x + x, ): x is t.Branded< { from?: Place_.Place; @@ -125,7 +119,7 @@ export const Plan1 = t.brand( }, Plan1Brand > => true, - "Plan1" + 'Plan1', ); export interface Plan1Brand { readonly Plan1: unique symbol; @@ -159,7 +153,7 @@ export const Plan2 = t.brand( }), ]), ( - x + x, ): x is t.Branded< { from?: Place_.Place; @@ -172,7 +166,7 @@ export const Plan2 = t.brand( }, Plan2Brand > => true, - "Plan2" + 'Plan2', ); export interface Plan2Brand { readonly Plan2: unique symbol; @@ -184,7 +178,7 @@ export type Plan = t.Branded; export const Plan = t.brand( t.union([Plan1, Plan2]), (x): x is t.Branded => true, - "Plan" + 'Plan', ); export interface PlanBrand { readonly Plan: unique symbol; diff --git a/maas-schemas-ts/src/maas-backend/routes/routes-query/request.ts b/maas-schemas-ts/src/maas-backend/routes/routes-query/request.ts index d0496d2c7..018ba8cb0 100644 --- a/maas-schemas-ts/src/maas-backend/routes/routes-query/request.ts +++ b/maas-schemas-ts/src/maas-backend/routes/routes-query/request.ts @@ -7,12 +7,14 @@ Request schema for routes query */ -import * as t from "io-ts"; -import * as UnitsGeo_ from "maas-schemas-ts/core/components/units-geo"; -import * as Address_ from "maas-schemas-ts/core/components/address"; -import * as Station_ from "maas-schemas-ts/core/components/station"; -import * as Units_ from "maas-schemas-ts/core/components/units"; -import * as ApiCommon_ from "maas-schemas-ts/core/components/api-common"; +import * as t from 'io-ts'; +import * as UnitsGeo_ from 'maas-schemas-ts/core/components/units-geo'; +import * as Address_ from 'maas-schemas-ts/core/components/address'; +import * as Station_ from 'maas-schemas-ts/core/components/station'; +import * as Units_ from 'maas-schemas-ts/core/components/units'; +import * as TravelMode_ from 'maas-schemas-ts/core/components/travel-mode'; +import * as Common_ from 'maas-schemas-ts/core/components/common'; +import * as ApiCommon_ from 'maas-schemas-ts/core/components/api-common'; type Defined = | Record @@ -31,7 +33,7 @@ const Defined = t.union([ ]); export const schemaId = - "http://maasglobal.com/maas-backend/routes/routes-query/request.json"; + 'http://maasglobal.com/maas-backend/routes/routes-query/request.json'; // Payload // The purpose of this remains a mystery @@ -50,7 +52,7 @@ export type Payload = t.Branded< leaveAtReturn?: Units_.Time; arriveByReturn?: Units_.Time; modes?: TravelMode_.SuperMode; - transitMode?: string & ("TRAIN" | "BUS" | "SUBWAY" | "TRAM" | "RAIL"); + transitMode?: string & ('TRAIN' | 'BUS' | 'SUBWAY' | 'TRAM' | 'RAIL'); options?: {}; bookingIdToExtend?: Units_.Uuid; requestId?: Common_.RequestId; @@ -69,7 +71,7 @@ export type Payload = t.Branded< | Units_.Time | Units_.Time | TravelMode_.SuperMode - | (string & ("TRAIN" | "BUS" | "SUBWAY" | "TRAM" | "RAIL")) + | (string & ('TRAIN' | 'BUS' | 'SUBWAY' | 'TRAM' | 'RAIL')) | {} | Units_.Uuid | Common_.RequestId @@ -96,11 +98,11 @@ export const Payload = t.brand( transitMode: t.intersection([ t.string, t.union([ - t.literal("TRAIN"), - t.literal("BUS"), - t.literal("SUBWAY"), - t.literal("TRAM"), - t.literal("RAIL"), + t.literal('TRAIN'), + t.literal('BUS'), + t.literal('SUBWAY'), + t.literal('TRAM'), + t.literal('RAIL'), ]), ]), options: t.type({}), @@ -126,22 +128,22 @@ export const Payload = t.brand( t.intersection([ t.string, t.union([ - t.literal("TRAIN"), - t.literal("BUS"), - t.literal("SUBWAY"), - t.literal("TRAM"), - t.literal("RAIL"), + t.literal('TRAIN'), + t.literal('BUS'), + t.literal('SUBWAY'), + t.literal('TRAM'), + t.literal('RAIL'), ]), ]), t.type({}), Units_.Uuid, Common_.RequestId, t.union([t.string, t.number, t.boolean]), - ]) + ]), ), ]), ( - x + x, ): x is t.Branded< { from?: UnitsGeo_.ShortLocationString; @@ -157,7 +159,7 @@ export const Payload = t.brand( leaveAtReturn?: Units_.Time; arriveByReturn?: Units_.Time; modes?: TravelMode_.SuperMode; - transitMode?: string & ("TRAIN" | "BUS" | "SUBWAY" | "TRAM" | "RAIL"); + transitMode?: string & ('TRAIN' | 'BUS' | 'SUBWAY' | 'TRAM' | 'RAIL'); options?: {}; bookingIdToExtend?: Units_.Uuid; requestId?: Common_.RequestId; @@ -176,7 +178,7 @@ export const Payload = t.brand( | Units_.Time | Units_.Time | TravelMode_.SuperMode - | (string & ("TRAIN" | "BUS" | "SUBWAY" | "TRAM" | "RAIL")) + | (string & ('TRAIN' | 'BUS' | 'SUBWAY' | 'TRAM' | 'RAIL')) | {} | Units_.Uuid | Common_.RequestId @@ -184,7 +186,7 @@ export const Payload = t.brand( >, PayloadBrand > => true, - "Payload" + 'Payload', ); export interface PayloadBrand { readonly Payload: unique symbol; @@ -216,7 +218,7 @@ export const Request = t.brand( }), ]), ( - x + x, ): x is t.Branded< { identityId?: Units_.IdentityId; @@ -228,7 +230,7 @@ export const Request = t.brand( }, RequestBrand > => true, - "Request" + 'Request', ); export interface RequestBrand { readonly Request: unique symbol; diff --git a/maas-schemas-ts/translation.log b/maas-schemas-ts/translation.log index 1f816a31f..5e5c70048 100644 --- a/maas-schemas-ts/translation.log +++ b/maas-schemas-ts/translation.log @@ -175,9 +175,15 @@ INFO: primitive type "number" used outside top-level definitions WARNING: minLength field not supported outside top-level definitions in ./core/components/car-rental.json WARNING: maxLength field not supported outside top-level definitions - in ../maas-schemas/schemas/core/components/car-rental.json + in ./core/components/car-rental.json INFO: missing description in ./core/components/car-rental.json +WARNING: skipping examples handling for $ref object + in ./core/components/common.json +WARNING: skipping default value handling for $ref object + in ./core/components/common.json +INFO: missing description + in ./core/components/common.json INFO: missing description in ./core/components/common.json INFO: missing description @@ -596,6 +602,24 @@ WARNING: minItems field not supported outside top-level definitions in ./core/itinerary.json WARNING: minItems field not supported outside top-level definitions in ./core/itinerary.json +INFO: primitive type "string" used outside top-level definitions + in ./core/itinerary.json +WARNING: minLength field not supported outside top-level definitions + in ./core/itinerary.json +INFO: primitive type "string" used outside top-level definitions + in ./core/itinerary.json +INFO: primitive type "string" used outside top-level definitions + in ./core/itinerary.json +WARNING: minLength field not supported outside top-level definitions + in ./core/itinerary.json +INFO: primitive type "string" used outside top-level definitions + in ./core/itinerary.json +WARNING: minLength field not supported outside top-level definitions + in ./core/itinerary.json +INFO: primitive type "string" used outside top-level definitions + in ./core/itinerary.json +INFO: missing description + in ./core/itinerary.json INFO: missing description in ./core/itinerary.json INFO: primitive type "string" used outside top-level definitions @@ -640,10 +664,18 @@ WARNING: skipping examples handling for $ref object in ./core/leg.json WARNING: skipping default value handling for $ref object in ./core/leg.json +INFO: primitive type "string" used outside top-level definitions + in ./core/leg.json +INFO: primitive type "number" used outside top-level definitions + in ./core/leg.json INFO: missing description - in ../maas-schemas/schemas/core/leg.json + in ./core/leg.json INFO: missing description - in ../maas-schemas/schemas/core/leg.json + in ./core/leg.json +INFO: missing description + in ./core/leg.json +INFO: missing description + in ./core/leg.json INFO: missing description in ./core/leg.json INFO: missing description @@ -827,9 +859,11 @@ INFO: missing description INFO: missing description in ./core/plan.json INFO: missing description - in ../maas-schemas/schemas/core/plan.json + in ./core/plan.json +INFO: missing description + in ./core/plan.json INFO: missing description - in ../maas-schemas/schemas/core/plan.json + in ./core/plan.json INFO: primitive type "number" used outside top-level definitions in ./core/product.json WARNING: minimum field not supported outside top-level definitions @@ -1370,14 +1404,10 @@ WARNING: maxItems field not supported outside top-level definitions in ./maas-backend/push-notification/request.json INFO: primitive type "string" used outside top-level definitions in ./maas-backend/routes/routes-query/request.json -INFO: primitive type "string" used outside top-level definitions - in ./maas-backend/routes/routes-query/request.json WARNING: patternProperty support has limitations in ./maas-backend/routes/routes-query/request.json INFO: primitive type "string" used outside top-level definitions in ./maas-backend/routes/routes-query/request.json -INFO: primitive type "string" used outside top-level definitions - in ./maas-backend/routes/routes-query/request.json INFO: missing description in ./maas-backend/routes/routes-query/request.json INFO: primitive type "integer" used outside top-level definitions diff --git a/maas-schemas/package.json b/maas-schemas/package.json index 933486221..92bd71517 100644 --- a/maas-schemas/package.json +++ b/maas-schemas/package.json @@ -1,6 +1,6 @@ { "name": "maas-schemas", - "version": "13.6.1", + "version": "13.7.0", "description": "Schemas for MaaS infrastructure", "main": "index.js", "engine": {