@speleotica/frcsdata 4.3.1 → 5.0.0-beta.2

package/src/survey/FrcsSurveyFile.ts

@@ -0,0 +1,217 @@
+import { ParseIssue } from '../ParseIssue'
+import { SourceLoc } from '../SourceLoc'
+import { Unit, Length, Angle, UnitizedNumber } from '@speleotica/unitized'
+
+type Invalid<T> = {
+  INVALID: T
+  /**
+   * An array of indexes of issues in {@link InvalidFrcsSurveyFile['issues']} within the
+   * `INVALID` node
+   */
+  issues?: number[]
+}
+
+// eslint-disable-next-line @typescript-eslint/ban-types
+type Prettify<T> = { [K in keyof T]: T[K] } & {}
+
+type Replace<T, U> = Prettify<Omit<T, keyof U> & U>
+
+export type FrcsSurveyFile = {
+  cave?: string
+  columns?: FrcsShotColumnConfig
+  location?: string
+  comment?: string
+  trips: FrcsTrip[]
+  locs?: {
+    cave?: SourceLoc
+    location?: SourceLoc
+    comment?: SourceLoc
+  }
+  issues?: ParseIssue[]
+}
+
+export type FrcsShotColumnConfig = {
+  toStation: number
+  fromStation: number
+  distance: number
+  distanceFeet: number
+  distanceInches: number
+  kind: number
+  exclude: number
+  frontsightAzimuth: number
+  backsightAzimuth: number
+  frontsightInclination: number
+  backsightInclination: number
+  left: number
+  right: number
+  up: number
+  down: number
+}
+
+export type InvalidFrcsSurveyFile = {
+  INVALID: Replace<
+    FrcsSurveyFile,
+    {
+      trips: (FrcsTrip | InvalidFrcsTrip)[]
+    }
+  >
+  issues: ParseIssue[]
+}
+
+export type FrcsUnits = {
+  distanceUnit: Unit<Length>
+  azimuthUnit: Unit<Angle>
+  inclinationUnit: Unit<Angle>
+  backsightAzimuthCorrected?: boolean
+  backsightInclinationCorrected?: boolean
+  hasBacksightAzimuth?: boolean
+  hasBacksightInclination?: boolean
+  loc?: SourceLoc
+  locs?: {
+    distanceUnit?: SourceLoc
+    azimuthUnit?: SourceLoc
+    inclinationUnit?: SourceLoc
+    backsightAzimuthCorrected?: SourceLoc
+    backsightInclinationCorrected?: SourceLoc
+    hasBacksightAzimuth?: SourceLoc
+    hasBacksightInclination?: SourceLoc
+  }
+}
+
+export type InvalidFrcsUnits = Invalid<Partial<FrcsUnits>>
+
+export type FrcsTripHeader = {
+  name: string
+  comment?: string
+  section?: string
+  date?: Date
+  team?: string[]
+  loc?: SourceLoc
+  locs?: {
+    name: SourceLoc
+    comment?: SourceLoc
+    section?: SourceLoc
+    date?: SourceLoc
+    team?: SourceLoc[]
+  }
+}
+
+export type InvalidFrcsTripHeader = Invalid<Partial<FrcsTripHeader>>
+
+export type FrcsTrip = {
+  tripNumber: number
+  header: FrcsTripHeader
+  units: FrcsUnits
+  shots: FrcsShot[]
+  loc?: SourceLoc
+}
+
+export type InvalidFrcsTrip = Invalid<
+  Replace<
+    FrcsTrip,
+    {
+      tripNumber?: number
+      header: FrcsTripHeader | InvalidFrcsTripHeader
+      units: FrcsUnits | InvalidFrcsUnits
+      shots: (FrcsShot | InvalidFrcsShot)[]
+    }
+  >
+>
+
+export type FrcsShotBase = {
+  /**
+   * Name of from station
+   */
+  from: string
+  /**
+   * Name of to station
+   */
+  to?: string
+  specialKind?: 'horizontal' | 'diagonal'
+  distance: UnitizedNumber<Length>
+  horizontalDistance?: UnitizedNumber<Length>
+  verticalDistance?: UnitizedNumber<Length>
+  frontsightAzimuth?: UnitizedNumber<Angle>
+  frontsightInclination?: UnitizedNumber<Angle>
+  backsightAzimuth?: UnitizedNumber<Angle>
+  backsightInclination?: UnitizedNumber<Angle>
+  /**
+   * LRUDs at from station
+   */
+  fromLruds?: {
+    left?: UnitizedNumber<Length>
+    right?: UnitizedNumber<Length>
+    up?: UnitizedNumber<Length>
+    down?: UnitizedNumber<Length>
+  }
+  /**
+   * LRUDs at to station
+   */
+  toLruds?: {
+    left?: UnitizedNumber<Length>
+    right?: UnitizedNumber<Length>
+    up?: UnitizedNumber<Length>
+    down?: UnitizedNumber<Length>
+  }
+  excludeDistance?: boolean
+  isSplay?: boolean
+  comment?: string
+  loc?: SourceLoc
+  locs?: {
+    comment?: SourceLoc
+  }
+}
+
+export type FrcsShot = FrcsShotBase & {
+  /**
+   * In the edge case that the surveyors changed measurement units or
+   * corrected/uncorrected backsights in the middle of a trip, the measurements
+   * will be normalized to the initial trip settings, and this field will contain
+   * the actual values recorded, verbatim.  The first shot of the group with
+   * changed units will include the changed units.
+   */
+  recorded?: FrcsShotBase & { units?: FrcsUnits }
+}
+
+export type InvalidFrcsShot = Invalid<
+  Partial<
+    Replace<
+      FrcsShot,
+      {
+        recorded?:
+          | FrcsShot['recorded']
+          | Invalid<Partial<FrcsShotBase> & { units?: InvalidFrcsUnits }>
+      }
+    >
+  >
+>
+
+export const defaultFrcsShotColumnConfig: FrcsShotColumnConfig = {
+  toStation: 5,
+  fromStation: 5,
+  distance: 6,
+  distanceFeet: 4,
+  distanceInches: 3,
+  kind: 1,
+  exclude: 1,
+  frontsightAzimuth: 6,
+  backsightAzimuth: 6,
+  frontsightInclination: 5,
+  backsightInclination: 5,
+  left: 3,
+  right: 3,
+  up: 3,
+  down: 3,
+}
+
+export type ParseFrcsSurveyFileOptions = {
+  columns?: FrcsShotColumnConfig
+  outputColumns?: boolean
+  normalizeNames?: boolean
+  suppressWarnings?:
+    | boolean
+    | {
+        missingTripTeam?: boolean
+        missingTripDate?: boolean
+      }
+}

package/src/survey/FrcsSurveyFileJson.ts

@@ -0,0 +1,46 @@
+import {
+  FrcsSurveyFile,
+  InvalidFrcsSurveyFile,
+  ParseFrcsSurveyFileOptions,
+} from './FrcsSurveyFile'
+
+import { Unit, Length, Angle, UnitizedNumber } from '@speleotica/unitized'
+import { ParseIssue } from '../ParseIssue'
+import { SourceLoc } from '../SourceLoc'
+
+export type JsonLengthUnit = 'm' | 'km' | 'cm' | 'ft' | 'mi' | 'yd' | 'in'
+export type JsonAngleUnit = 'rad' | 'deg' | 'grad' | 'mil' | '%'
+
+export type JsonLength = [number, JsonLengthUnit]
+export type JsonAngle = [number, JsonAngleUnit]
+
+export type DeepMapJson<T> = T extends
+  | string
+  | number
+  | boolean
+  | undefined
+  | ParseIssue
+  | SourceLoc
+  ? T
+  : T extends Date
+  ? string
+  : T extends readonly (infer E)[]
+  ? DeepMapJson<E>[]
+  : T extends Unit<Length>
+  ? JsonLengthUnit
+  : T extends Unit<Angle>
+  ? JsonAngleUnit
+  : T extends UnitizedNumber<Length>
+  ? JsonLength
+  : T extends UnitizedNumber<Angle>
+  ? JsonAngle
+  : {
+      [K in keyof T]: DeepMapJson<T[K]>
+    }
+
+export type FrcsSurveyFileJson = DeepMapJson<FrcsSurveyFile>
+
+export type InvalidFrcsSurveyFileJson = DeepMapJson<InvalidFrcsSurveyFile>
+
+export type ParseFrcsSurveyFileOptionsJson =
+  DeepMapJson<ParseFrcsSurveyFileOptions>

package/src/survey/ZodFrcsSurveyFileJson.ts

@@ -0,0 +1,260 @@
+import { Angle, Length, Unit, UnitizedNumber } from '@speleotica/unitized'
+import z from 'zod'
+import type { DeepMapJson } from './FrcsSurveyFileJson'
+import type { SourceLoc } from '../SourceLoc'
+import type {
+  FrcsShot,
+  FrcsSurveyFile,
+  FrcsTrip,
+  FrcsTripHeader,
+  FrcsUnits,
+  InvalidFrcsShot,
+  InvalidFrcsSurveyFile,
+  InvalidFrcsTrip,
+  InvalidFrcsTripHeader,
+  InvalidFrcsUnits,
+  ParseFrcsSurveyFileOptions,
+} from './FrcsSurveyFile'
+import { ParseIssue } from '../ParseIssue'
+
+type DeepMapJsonSchema<T> = z.ZodType<DeepMapJson<T>>
+
+const ZodLengthUnit = z.enum(['m', 'km', 'cm', 'ft', 'in', 'yd', 'mi'])
+
+ZodLengthUnit satisfies DeepMapJsonSchema<Unit<Length>>
+
+const ZodAngleUnit = z.enum(['deg', 'rad', 'grad', 'mil', '%'])
+
+ZodAngleUnit satisfies DeepMapJsonSchema<Unit<Angle>>
+
+const ZodLength = z.tuple([z.number(), ZodLengthUnit])
+
+ZodLength satisfies DeepMapJsonSchema<UnitizedNumber<Length>>
+
+const ZodAngle = z.tuple([z.number(), ZodAngleUnit])
+
+ZodAngle satisfies DeepMapJsonSchema<UnitizedNumber<Angle>>
+
+const ZodSourceLoc = z.strictObject({
+  start: z.strictObject({
+    index: z.number(),
+    line: z.number(),
+    column: z.number(),
+  }),
+  end: z.strictObject({
+    index: z.number(),
+    line: z.number(),
+    column: z.number(),
+  }),
+})
+
+ZodSourceLoc satisfies DeepMapJsonSchema<SourceLoc>
+
+const ZodFrcsShotBase = z.strictObject({
+  from: z.string(),
+  to: z.string().optional(),
+  specialKind: z.enum(['horizontal', 'diagonal']).optional(),
+  distance: ZodLength,
+  horizontalDistance: ZodLength.optional(),
+  verticalDistance: ZodLength.optional(),
+  frontsightAzimuth: ZodAngle.optional(),
+  frontsightInclination: ZodAngle.optional(),
+  backsightAzimuth: ZodAngle.optional(),
+  backsightInclination: ZodAngle.optional(),
+  /**
+   * LRUDs at from station
+   */
+  fromLruds: z
+    .strictObject({
+      left: ZodLength.optional(),
+      right: ZodLength.optional(),
+      up: ZodLength.optional(),
+      down: ZodLength.optional(),
+    })
+    .optional(),
+  /**
+   * LRUDs at to station
+   */
+  toLruds: z
+    .strictObject({
+      left: ZodLength.optional(),
+      right: ZodLength.optional(),
+      up: ZodLength.optional(),
+      down: ZodLength.optional(),
+    })
+    .optional(),
+
+  excludeDistance: z
+    .boolean()
+    .optional()
+    .transform((b) => (b === false ? undefined : b)),
+  isSplay: z.boolean().optional(),
+  comment: z.string().optional(),
+  loc: ZodSourceLoc.optional(),
+  locs: z
+    .strictObject({
+      comment: ZodSourceLoc.optional(),
+    })
+    .optional(),
+})
+
+const ZodFrcsUnits = z.strictObject({
+  distanceUnit: ZodLengthUnit,
+  azimuthUnit: ZodAngleUnit,
+  inclinationUnit: ZodAngleUnit,
+  backsightAzimuthCorrected: z.boolean().optional(),
+  backsightInclinationCorrected: z.boolean().optional(),
+  hasBacksightAzimuth: z.boolean().optional(),
+  hasBacksightInclination: z.boolean().optional(),
+  loc: ZodSourceLoc.optional(),
+  locs: z
+    .strictObject({
+      distanceUnit: ZodSourceLoc.optional(),
+      azimuthUnit: ZodSourceLoc.optional(),
+      inclinationUnit: ZodSourceLoc.optional(),
+      backsightAzimuthCorrected: ZodSourceLoc.optional(),
+      backsightInclinationCorrected: ZodSourceLoc.optional(),
+      hasBacksightAzimuth: ZodSourceLoc.optional(),
+      hasBacksightInclination: ZodSourceLoc.optional(),
+    })
+    .optional(),
+})
+
+ZodFrcsUnits satisfies DeepMapJsonSchema<FrcsUnits>
+
+const ZodFrcsShot = ZodFrcsShotBase.extend({
+  recorded: ZodFrcsShotBase.extend({
+    units: ZodFrcsUnits.optional(),
+  }).optional(),
+})
+
+ZodFrcsShot satisfies DeepMapJsonSchema<FrcsShot>
+
+const ZodFrcsTripHeader = z.strictObject({
+  name: z.string(),
+  comment: z.string().optional(),
+  section: z.string().optional(),
+  date: z
+    .string()
+    .regex(/\d{4}-\d{2}-\d{2}/, 'must be in yyyy-mm-dd format')
+    .optional(),
+  team: z.array(z.string()).optional(),
+  loc: ZodSourceLoc.optional(),
+  locs: z
+    .strictObject({
+      name: ZodSourceLoc,
+      comment: ZodSourceLoc.optional(),
+      section: ZodSourceLoc.optional(),
+      date: ZodSourceLoc.optional(),
+      team: z.array(ZodSourceLoc).optional(),
+    })
+    .optional(),
+})
+
+ZodFrcsTripHeader satisfies DeepMapJsonSchema<FrcsTripHeader>
+
+const ZodFrcsTrip = z.strictObject({
+  tripNumber: z.number().int().min(1),
+  header: ZodFrcsTripHeader,
+  units: ZodFrcsUnits,
+  shots: z.array(ZodFrcsShot),
+  loc: ZodSourceLoc.optional(),
+})
+
+ZodFrcsTrip satisfies DeepMapJsonSchema<FrcsTrip>
+
+export const ZodFrcsShotColumnConfigJson = z.strictObject({
+  toStation: z.number(),
+  fromStation: z.number(),
+  distance: z.number(),
+  distanceFeet: z.number(),
+  distanceInches: z.number(),
+  kind: z.number(),
+  exclude: z.number(),
+  frontsightAzimuth: z.number(),
+  backsightAzimuth: z.number(),
+  frontsightInclination: z.number(),
+  backsightInclination: z.number(),
+  left: z.number(),
+  right: z.number(),
+  up: z.number(),
+  down: z.number(),
+})
+
+export const ZodFrcsSurveyFileJson = z.strictObject({
+  cave: z.string().optional(),
+  columns: ZodFrcsShotColumnConfigJson.optional(),
+  location: z.string().optional(),
+  comment: z.string().optional(),
+  trips: z.array(ZodFrcsTrip),
+  locs: z
+    .strictObject({
+      cave: ZodSourceLoc.optional(),
+      location: ZodSourceLoc.optional(),
+      comment: ZodSourceLoc.optional(),
+    })
+    .optional(),
+  issues: z.array(ParseIssue).optional(),
+})
+
+ZodFrcsSurveyFileJson satisfies DeepMapJsonSchema<FrcsSurveyFile>
+
+function Invalid<T extends z.ZodTypeAny>(schema: T) {
+  return z.strictObject({
+    INVALID: schema,
+    issues: z.array(z.number()).optional(),
+  })
+}
+
+const ZodInvalidFrcsShot = Invalid(ZodFrcsShot.partial())
+
+ZodInvalidFrcsShot satisfies DeepMapJsonSchema<InvalidFrcsShot>
+
+const ZodInvalidFrcsUnits = Invalid(ZodFrcsUnits.partial())
+
+ZodInvalidFrcsUnits satisfies DeepMapJsonSchema<InvalidFrcsUnits>
+
+const ZodInvalidFrcsTripHeader = Invalid(ZodFrcsTripHeader.partial())
+
+ZodInvalidFrcsTripHeader satisfies DeepMapJsonSchema<InvalidFrcsTripHeader>
+
+const ZodInvalidFrcsTrip = Invalid(
+  z.strictObject({
+    tripNumber: z.number().int().min(1).optional(),
+    header: z.union([ZodInvalidFrcsTripHeader, ZodFrcsTripHeader]),
+    units: z.union([ZodInvalidFrcsUnits, ZodFrcsUnits]),
+    shots: z.array(z.union([ZodInvalidFrcsShot, ZodFrcsShot])),
+  })
+)
+
+ZodInvalidFrcsTrip satisfies DeepMapJsonSchema<InvalidFrcsTrip>
+
+export const ZodInvalidFrcsSurveyFileJson = z.strictObject({
+  INVALID: ZodFrcsSurveyFileJson.extend({
+    trips: z.array(z.union([ZodInvalidFrcsTrip, ZodFrcsTrip])),
+  }),
+  issues: z.array(ParseIssue),
+})
+
+ZodInvalidFrcsSurveyFileJson satisfies DeepMapJsonSchema<InvalidFrcsSurveyFile>
+
+export const ZodValidOrInvalidFrcsSurveyFileJson = z.union([
+  ZodInvalidFrcsSurveyFileJson,
+  ZodFrcsSurveyFileJson,
+])
+
+export const ZodParseFrcsSurveyFileOptionsJson = z.object({
+  columns: ZodFrcsShotColumnConfigJson.optional(),
+  outputColumns: z.boolean().optional(),
+  normalizeNames: z.boolean().optional(),
+  suppressWarnings: z
+    .union([
+      z.boolean(),
+      z
+        .object({ missingTripTeam: z.boolean(), missingTripDate: z.boolean() })
+        .partial(),
+    ])
+    .optional(),
+})
+
+ZodParseFrcsSurveyFileOptionsJson satisfies DeepMapJsonSchema<ParseFrcsSurveyFileOptions>