Merge branch 'master' into feature/toggleable-shape-expressions

openactive · Feb 21, 2024 · 611cbf0 · 611cbf0
2 parents 8ed19ec + 691f78f
commit 611cbf0
Show file tree

Hide file tree

Showing 62 changed files with 5,375 additions and 1,289 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -98,6 +98,19 @@
               "NODE_APP_INSTANCE": "dev"
             },
         },
+        {
+            "name": "test-interface-criteria - unit tests",
+            "type": "node",
+            "request": "launch",
+            "cwd": "${workspaceFolder}/packages/test-interface-criteria/",
+            "runtimeArgs": [
+              "--inspect-brk",
+              "node_modules/.bin/jest",
+              "--runInBand"
+              ],
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen"
+        },
         {
             "name": "validate-feeds",
             "type": "node",

diff --git a/packages/openactive-broker-microservice/package-lock.json b/packages/openactive-broker-microservice/package-lock.json
diff --git a/packages/openactive-integration-tests/package-lock.json b/packages/openactive-integration-tests/package-lock.json
diff --git a/packages/test-interface-criteria/.eslintrc.js b/packages/test-interface-criteria/.eslintrc.js
@@ -1,7 +1,9 @@
 module.exports = {
   extends: 'airbnb-base',
+  plugins: ['jest'],
   env: {
     node: true,
+    'jest/globals': true,
   },
   globals: {
     expectAsync: true,

diff --git a/...pes/criteria/TestOpportunityBookable.d.ts → ...src/criteria/TestOpportunityBookable.d.ts b/...pes/criteria/TestOpportunityBookable.d.ts → ...src/criteria/TestOpportunityBookable.d.ts
diff --git a/...OpportunityBookableAdditionalDetails.d.ts → ...OpportunityBookableAdditionalDetails.d.ts b/...OpportunityBookableAdditionalDetails.d.ts → ...OpportunityBookableAdditionalDetails.d.ts
diff --git a/...stOpportunityBookableAttendeeDetails.d.ts → ...stOpportunityBookableAttendeeDetails.d.ts b/...stOpportunityBookableAttendeeDetails.d.ts → ...stOpportunityBookableAttendeeDetails.d.ts
diff --git a/...a/TestOpportunityBookableCancellable.d.ts → ...a/TestOpportunityBookableCancellable.d.ts b/...a/TestOpportunityBookableCancellable.d.ts → ...a/TestOpportunityBookableCancellable.d.ts
diff --git a/...portunityBookableCancellableNoWindow.d.ts → ...portunityBookableCancellableNoWindow.d.ts b/...portunityBookableCancellableNoWindow.d.ts → ...portunityBookableCancellableNoWindow.d.ts
diff --git a/...nityBookableCancellableOutsideWindow.d.ts → ...nityBookableCancellableOutsideWindow.d.ts b/...nityBookableCancellableOutsideWindow.d.ts → ...nityBookableCancellableOutsideWindow.d.ts
diff --git a/...unityBookableCancellableWithinWindow.d.ts → ...unityBookableCancellableWithinWindow.d.ts b/...unityBookableCancellableWithinWindow.d.ts → ...unityBookableCancellableWithinWindow.d.ts
diff --git a/...ia/TestOpportunityBookableFiveSpaces.d.ts → ...ia/TestOpportunityBookableFiveSpaces.d.ts b/...ia/TestOpportunityBookableFiveSpaces.d.ts → ...ia/TestOpportunityBookableFiveSpaces.d.ts
diff --git a/...criteria/TestOpportunityBookableFree.d.ts → ...criteria/TestOpportunityBookableFree.d.ts b/...criteria/TestOpportunityBookableFree.d.ts → ...criteria/TestOpportunityBookableFree.d.ts
diff --git a/...stOpportunityBookableFreeCancellable.d.ts → ...stOpportunityBookableFreeCancellable.d.ts b/...stOpportunityBookableFreeCancellable.d.ts → ...stOpportunityBookableFreeCancellable.d.ts
diff --git a/...tunityBookableFreePrepaymentOptional.d.ts → ...tunityBookableFreePrepaymentOptional.d.ts b/...tunityBookableFreePrepaymentOptional.d.ts → ...tunityBookableFreePrepaymentOptional.d.ts
diff --git a/...tunityBookableFreePrepaymentRequired.d.ts → ...tunityBookableFreePrepaymentRequired.d.ts b/...tunityBookableFreePrepaymentRequired.d.ts → ...tunityBookableFreePrepaymentRequired.d.ts
diff --git a/...iteria/TestOpportunityBookableInPast.d.ts → ...iteria/TestOpportunityBookableInPast.d.ts b/...iteria/TestOpportunityBookableInPast.d.ts → ...iteria/TestOpportunityBookableInPast.d.ts
diff --git a/...eria/TestOpportunityBookableNoSpaces.d.ts → ...eria/TestOpportunityBookableNoSpaces.d.ts b/...eria/TestOpportunityBookableNoSpaces.d.ts → ...eria/TestOpportunityBookableNoSpaces.d.ts
diff --git a/...teria/TestOpportunityBookableNonFree.d.ts → ...teria/TestOpportunityBookableNonFree.d.ts b/...teria/TestOpportunityBookableNonFree.d.ts → ...teria/TestOpportunityBookableNonFree.d.ts
diff --git a/...pportunityBookableNonFreeCancellable.d.ts → ...pportunityBookableNonFreeCancellable.d.ts b/...pportunityBookableNonFreeCancellable.d.ts → ...pportunityBookableNonFreeCancellable.d.ts
diff --git a/...ityBookableNonFreePrepaymentOptional.d.ts → ...ityBookableNonFreePrepaymentOptional.d.ts b/...ityBookableNonFreePrepaymentOptional.d.ts → ...ityBookableNonFreePrepaymentOptional.d.ts
diff --git a/...ityBookableNonFreePrepaymentRequired.d.ts → ...ityBookableNonFreePrepaymentRequired.d.ts b/...ityBookableNonFreePrepaymentRequired.d.ts → ...ityBookableNonFreePrepaymentRequired.d.ts
diff --git a/...BookableNonFreePrepaymentUnavailable.d.ts → ...BookableNonFreePrepaymentUnavailable.d.ts b/...BookableNonFreePrepaymentUnavailable.d.ts → ...BookableNonFreePrepaymentUnavailable.d.ts
diff --git a/...stOpportunityBookableNonFreeTaxGross.d.ts → ...stOpportunityBookableNonFreeTaxGross.d.ts b/...stOpportunityBookableNonFreeTaxGross.d.ts → ...stOpportunityBookableNonFreeTaxGross.d.ts
diff --git a/...TestOpportunityBookableNonFreeTaxNet.d.ts → ...TestOpportunityBookableNonFreeTaxNet.d.ts b/...TestOpportunityBookableNonFreeTaxNet.d.ts → ...TestOpportunityBookableNonFreeTaxNet.d.ts
diff --git a/...estOpportunityBookableNotCancellable.d.ts → ...estOpportunityBookableNotCancellable.d.ts b/...estOpportunityBookableNotCancellable.d.ts → ...estOpportunityBookableNotCancellable.d.ts
diff --git a/...eria/TestOpportunityBookableOneSpace.d.ts → ...eria/TestOpportunityBookableOneSpace.d.ts b/...eria/TestOpportunityBookableOneSpace.d.ts → ...eria/TestOpportunityBookableOneSpace.d.ts
diff --git a/...kableOutsideValidFromBeforeStartDate.d.ts → ...kableOutsideValidFromBeforeStartDate.d.ts b/...kableOutsideValidFromBeforeStartDate.d.ts → ...kableOutsideValidFromBeforeStartDate.d.ts
diff --git a/...ortunityBookableSellerTermsOfService.d.ts → ...ortunityBookableSellerTermsOfService.d.ts b/...ortunityBookableSellerTermsOfService.d.ts → ...ortunityBookableSellerTermsOfService.d.ts
diff --git a/.../TestOpportunityBookableUsingPayment.d.ts → .../TestOpportunityBookableUsingPayment.d.ts b/.../TestOpportunityBookableUsingPayment.d.ts → .../TestOpportunityBookableUsingPayment.d.ts
diff --git a/...stOpportunityBookableWithNegotiation.d.ts → ...stOpportunityBookableWithNegotiation.d.ts b/...stOpportunityBookableWithNegotiation.d.ts → ...stOpportunityBookableWithNegotiation.d.ts
diff --git a/...okableWithinValidFromBeforeStartDate.d.ts → ...okableWithinValidFromBeforeStartDate.d.ts b/...okableWithinValidFromBeforeStartDate.d.ts → ...okableWithinValidFromBeforeStartDate.d.ts
diff --git a/...teria/TestOpportunityOfflineBookable.d.ts → ...teria/TestOpportunityOfflineBookable.d.ts b/...teria/TestOpportunityOfflineBookable.d.ts → ...teria/TestOpportunityOfflineBookable.d.ts
diff --git a/...iteria/TestOpportunityOnlineBookable.d.ts → ...iteria/TestOpportunityOnlineBookable.d.ts b/...iteria/TestOpportunityOnlineBookable.d.ts → ...iteria/TestOpportunityOnlineBookable.d.ts
diff --git a/...a/built-types/criteria/criteriaUtils.d.ts → ...ilt-types/src/criteria/criteriaUtils.d.ts b/...a/built-types/criteria/criteriaUtils.d.ts → ...ilt-types/src/criteria/criteriaUtils.d.ts
@@ -1,4 +1,3 @@
-export type DateTime = any;
 export type Opportunity = import('../types/Opportunity').Opportunity;
 export type Offer = import('../types/Offer').Offer;
 export type Options = import('../types/Options').Options;
@@ -76,7 +75,7 @@ export function remainingCapacityMustBeAtLeastTwo(opportunity: import("../types/
 export function mustRequireAttendeeDetails(offer: import("../types/Offer").Offer, opportunity?: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options): boolean;
 export function mustNotRequireAttendeeDetails(offer: import("../types/Offer").Offer, opportunity?: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options): boolean;
 export function mustAllowProposalAmendment(offer: import("../types/Offer").Offer, opportunity?: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options): boolean;
-export function startDateMustBe2HrsInAdvance(opportunity: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options): boolean;
+export function startDateMustBeOver2HrsInAdvance(opportunity: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options): boolean;
 export function endDateMustBeInThePast(opportunity: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options): boolean;
 export function eventStatusMustNotBeCancelledOrPostponed(opportunity: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options): boolean;
 export function mustNotBeOpenBookingInAdvanceUnavailable(offer: import("../types/Offer").Offer, opportunity?: import("../types/Opportunity").Opportunity, options?: import("../types/Options").Options): boolean;
@@ -112,3 +111,4 @@ export function extendTestDataShape(baseTestDataShape: TestDataShape, extraTestD
  * @returns {Criteria['offerConstraints'][number]}
  */
 export function createCriteriaOfferConstraint(name: string, constraint: OfferConstraint): Criteria['offerConstraints'][number];
+import { DateTime } from "luxon/src/datetime";
diff --git a/...-criteria/built-types/criteria/index.d.ts → ...teria/built-types/src/criteria/index.d.ts b/...-criteria/built-types/criteria/index.d.ts → ...teria/built-types/src/criteria/index.d.ts
diff --git a/...ureScheduledAndDoesNotRequireDetails.d.ts → ...ureScheduledAndDoesNotRequireDetails.d.ts b/...ureScheduledAndDoesNotRequireDetails.d.ts → ...ureScheduledAndDoesNotRequireDetails.d.ts
diff --git a/...alCriteriaFutureScheduledOpportunity.d.ts → ...alCriteriaFutureScheduledOpportunity.d.ts b/...alCriteriaFutureScheduledOpportunity.d.ts → ...alCriteriaFutureScheduledOpportunity.d.ts
diff --git a/...ilt-types/criteria/sharedConstraints.d.ts → ...types/src/criteria/sharedConstraints.d.ts b/...ilt-types/criteria/sharedConstraints.d.ts → ...types/src/criteria/sharedConstraints.d.ts
diff --git a/...interface-criteria/built-types/index.d.ts → ...rface-criteria/built-types/src/index.d.ts b/...interface-criteria/built-types/index.d.ts → ...rface-criteria/built-types/src/index.d.ts
diff --git a/...e-criteria/built-types/testDataShape.d.ts → ...iteria/built-types/src/testDataShape.d.ts b/...e-criteria/built-types/testDataShape.d.ts → ...iteria/built-types/src/testDataShape.d.ts
@@ -121,4 +121,10 @@ export namespace shapeConstraintRecipes {
         'schema:price': import("./types/TestDataShape").NumericNodeConstraint;
         'oa:openBookingPrepayment': import("./types/TestDataShape").OptionNodeConstraint<import("./types/TestDataShape").RequiredStatusType, "oa:RequiredStatusType">;
     };
+    function startDateMustBe2HrsInAdvance(options: import("./types/Options").Options): {
+        'schema:startDate': import("./types/TestDataShape").DateRangeNodeConstraint;
+    };
+    function eventStatusMustNotBeCancelledOrPostponed(): {
+        'schema:eventStatus': import("./types/TestDataShape").OptionNodeConstraint<import("./types/TestDataShape").EventStatusType, "schema:EventStatusType">;
+    };
 }
diff --git a/packages/test-interface-criteria/built-types/test/testShapeDataMatchesConstraints.d.ts b/packages/test-interface-criteria/built-types/test/testShapeDataMatchesConstraints.d.ts
@@ -0,0 +1 @@
+export {};
diff --git a/packages/test-interface-criteria/built-types/types/TestDataShape.d.ts b/packages/test-interface-criteria/built-types/types/TestDataShape.d.ts
@@ -45,6 +45,12 @@ export type ValueType =
   | 'schema:EventStatusType'
   | 'schema:EventAttendanceModeEnumeration';
 
+/**
+ * Specifies a value that must be one of a set of options.
+ * For example, an `eventStatus` field would be set up to only have
+ * one of the `schema:EventStatusType` options (e.g.
+ * `https://schema.org/EventCancelled`, etc)
+ */
 export interface OptionNodeConstraint<
   /** TypeScript union of the types that this option can take */
   TOptionType,
@@ -70,6 +76,10 @@ export interface OptionNodeConstraint<
   allowNull?: true;
 }
 
+/**
+ * Similar to OptionNodeConstraint, but where the value must be an
+ * array. Each item in the array must be from the same set of options.
+ */
 export interface ArrayConstraint<
   TArrayOf,
   TValueType extends ValueType
@@ -106,6 +116,7 @@ export type TestDataNodeConstraint =
 
 export type TestDataShapeOpportunityConstraints = {
   'schema:startDate'?: DateRangeNodeConstraint;
+  'schema:endDate'?: DateRangeNodeConstraint;
   /**
    * "placeholder:remainingCapacity" is a stand-in for either remainingAttendeeCapacity (sessions)
    * or remainingUses (facilities)
@@ -120,6 +131,9 @@ export type TestDataShapeOpportunityConstraints = {
   'oa:taxMode'?: OptionNodeConstraint<TaxMode, 'oa:TaxMode'>;
   'oa:isOpenBookingAllowed'?: BooleanNodeConstraint;
   'schema:eventAttendanceMode'?: OptionNodeConstraint<EventAttendanceMode, 'schema:EventAttendanceModeEnumeration'>;
+  // note that the type isn't specified yet (it's a '@type': 'Terms' object) as
+  // we don't use includes/excludes rules for this field, so it's irrelevant.
+  'schema:termsOfService'?: ArrayConstraint<unknown, 'oa:Terms'>;
 };
 
 /**
@@ -138,12 +152,20 @@ export type TestDataShape = {
      * can be null.
      */
     'oa:validFromBeforeStartDate'?: DateRangeNodeConstraint;
+    /**
+     * Refers to the date calculated as `startDate - validThroughBeforeStartDate`.
+     * For this particular DateRangeNodeConstraint, `allowNull` refers to whether `validThroughBeforeStartDate`
+     * can be null.
+     */
+    'oa:validThroughBeforeStartDate'?: DateRangeNodeConstraint;
     'oa:openBookingInAdvance'?: OptionNodeConstraint<RequiredStatusType, 'oa:RequiredStatusType'>;
     'oa:openBookingFlowRequirement'?: ArrayConstraint<OpenBookingFlowRequirement, 'oa:OpenBookingFlowRequirement'>;
+    /**
+     * Refers to the date calculated as `startDate - latestCancellationBeforeStartDate`.
+     * For this particular DateRangeNodeConstraint, `allowNull` refers to whether `latestCancellationBeforeStartDate`
+     * can be null.
+     */
     'oa:latestCancellationBeforeStartDate'?: NullNodeConstraint | DateRangeNodeConstraint;
     'oa:allowCustomerCancellationFullRefund'?: BooleanNodeConstraint;
-    // note that the type isn't specified yet (it's a '@type': 'Terms' object) as
-    // we don't use includes/excludes rules for this field, so it's irrelevant.
-    'schema:termsOfService'?: ArrayConstraint<unknown, 'oa:Terms'>;
   };
 }
diff --git a/packages/test-interface-criteria/built-types/utils/objUtils.d.ts b/packages/test-interface-criteria/built-types/utils/objUtils.d.ts
diff --git a/packages/test-interface-criteria/jest.config.js b/packages/test-interface-criteria/jest.config.js
@@ -0,0 +1,5 @@
+module.exports = {
+  testMatch: [
+    "**/test/**/*.js"
+  ]
+};