Skip to main content

validateCollectionDefinition

8.0.0 engine API transition

This method is a candidate for removal from production governors and engine exports at 8.0.0. Its 7.x route has not been removed. Final removal and standalone package-export decisions require the per-method review and external-integrator confirmation described in the transition index.

Source-local contract​

The declaration below is copied from the pinned source revision; referenced types are defined there. It is an implementation signature, not a package import example.

export function validateCollectionDefinition({
  checkCategory = true,
  collectionDefinition,
  checkCollectionIds,
  checkGender = true,
  referenceCategory,
  referenceGender,
  event,
}: ValidateCollectionDefinitionArgs);

Engine effects​

State writes: not yet assessed. Notices: not yet assessed. Governor query/mutate placement is not proof of purity; review the implementation and engine path before deciding exposure.

Consumer evidence​

The refreshed source-name scan found no name mentions in the scanned product source files. This does not establish external-integrator non-use. The manifest records repository revisions and scan exclusions. External-integrator confirmation is pending.

Availability and ownership​

  • Production governor declarations: queryGovernor, tieFormatGovernor.
  • Standalone package API after 8.0.0: decision pending; this page does not establish a supported import.
  • Implementation: src/validators/validateCollectionDefinition.ts — validateCollectionDefinition. Source paths and aliases are not package import paths.
  • Replacement workflow: not yet established; no supported replacement is promised.
  • Test-only adapters: may exercise this implementation independently of production engine exports; this is not evidence of product use.

Preserved 7.x reference​

The passages below preserve the existing governor documentation. Engine examples describe 7.x availability, not an 8.x replacement. Source contracts take precedence where an explicitly noted correction applies.

From governors/tie-format-governor.md​

Validates that a collectionDefinition is properly formed and compatible with event/category constraints.

const { valid } = engine.validateCollectionDefinition({
  collectionDefinition, // required
  checkCollectionIds, // optional boolean - check that collectionIds are present
  referenceCategory, // optional - category for comparison if eventId is not provided
  referenceGender, // optional - expected gender if eventId is not provided
  checkCategory, // optional boolean - defaults to true
  checkGender, // optional boolean - defaults to true
  eventId, // required only for checking gender
});

Returns:

{
  valid: boolean;
  error?: ErrorType;
}

Validation checks:

  • Collection structure is valid (has required fields)
  • CollectionIds are present (if checkCollectionIds: true)
  • Gender compatibility with event/category (if checkGender: true)
  • Category compatibility (if checkCategory: true)
  • MatchUp formats are valid
  • Scoring values are properly configured