n_a_types 3.0.28 → 3.1.0

package/index.ts

@@ -1 +1,311 @@
-export * as V3 from './V3'
+import z from "zod";
+
+export type ZodSatisfies<T> = z.ZodObject<{
+    [K in keyof T]: K extends keyof T ? z.ZodType<T[K]> : never;
+}>;
+
+export type ApiError = { error: string } | { message: string };
+
+export const API_VERSION = 3;
+
+const coordSchema = z.object({ x: z.number(), y: z.number() })
+export type Coord = z.infer<typeof coordSchema>
+
+import { GeoJSONFeatureSchema, GeoJSONMultiPolygonSchema, type GeoJSONFeature } from "zod-geojson";
+export type GeojsonFeaturePolygon = GeoJSONFeature;
+
+export const climbTypeSchema = z.enum(['TRAD', 'SPORT', 'BOULDER', 'ICE', 'TOPROPE'])
+export type ClimbType = z.infer<typeof climbTypeSchema>;
+
+export const starRatingSchema = z.enum(['ONE', 'TWO', 'THREE', 'FOUR'])
+export type StarRating = z.infer<typeof starRatingSchema>;
+
+export const climbLogAttemptTypeSchema = z.enum(['FLASH', 'REDPOINT', 'ONSIGHT', 'ATTEMPT'])
+export type ClimbLogAttemptType = z.infer<typeof climbLogAttemptTypeSchema>;
+
+export const mapInfoAreaTypeSchema = z.enum(['PRIVATE_LAND', 'PUBLIC_LAND', 'OTHER_ACCESS_CONCERN'])
+export type MapInfoAreaType = z.infer<typeof mapInfoAreaTypeSchema>;
+
+export const gradeFeedbackTagEnum = z.enum(['SOFT', 'SOLID', 'SANDBAG']);
+export type GradeFeedbackTag = z.infer<typeof gradeFeedbackTagEnum>;
+
+
+export const latLongSchema = z.object({ latitude: z.number(), longitude: z.number() });
+export type LatLong = z.infer<typeof latLongSchema>;
+export type TrailPolyline = LatLong[];
+const areaSwipeDirectionSchema = z.enum(['LEFT_TO_RIGHT', 'RIGHT_TO_LEFT']);
+export type AreaSwipeDirection = z.infer<typeof areaSwipeDirectionSchema>;
+
+export const imageSchema = z.object({
+    s3URL: z.string(),
+    s3Key: z.string(),
+    guidebookId: z.number().nullable(),
+    description: z.string().nullable(),
+    naturalHeight: z.number(),
+    naturalWidth: z.number(),
+    blurhash: z.string().nullable(),
+    climbId: z.number().nullable(),
+})
+export type Image = z.infer<typeof imageSchema>
+
+export const climbPathSchema = z.object({
+    id: z.number(),
+    climbId: z.number().nullable(),
+    climbImageGroupId: z.number().nullable(),
+    climbVariation: z.number(),
+    climbTopoImageSVGPathCoords: z.array(coordSchema),
+})
+
+export const climbImageGroupClimbPathSchema = climbPathSchema.extend({
+    climb: z.object({
+        id: z.number(),
+        areaClimbNumber: z.number(),
+        climbType: climbTypeSchema.nullable(),
+        grade: z.string().nullable(),
+    }).nullable(),
+});
+
+export const climbImageGroupSchema = z.object({
+    climbPaths: z.array(climbImageGroupClimbPathSchema),
+    climbs: z.array(z.object({
+        id: z.number(),
+        areaClimbNumber: z.number(),
+    })),
+    id: z.number(),
+    image: z.string(),
+    areaId: z.number().nullable(),
+    areaName: z.string(),
+    sortOrder: z.number(),
+    anchors: z.array(coordSchema),
+    imageNew: imageSchema,
+    imageS3Key: z.string(),
+})
+export type ClimbImageGroup = z.infer<typeof climbImageGroupSchema>
+
+
+const poiSchema = z.object({
+    id: z.string(),
+    image: z.string().nullable(),
+    description: z.string(),
+    latitude: z.number(),
+    longitude: z.number(),
+    guidebookId: z.number().nullable(),
+})
+export type POI = z.infer<typeof poiSchema>
+
+
+const guidebookProductDataSchema = z.object({
+    guidebooks: z.array(z.object({
+        additionalImages: z.array(imageSchema),
+        digitalVersionPublished: z.boolean(),
+        id: z.number(),
+        title: z.string(),
+        author: z.string(),
+        coverImage: z.string(),
+        description: z.string(),
+        isFreeSampleGuidebook: z.boolean(),
+        version: z.number(),
+        heroImage: z.string(),
+        state: z.string(),
+        accessTrailPolylines: z.array(z.array(latLongSchema)),
+        digitalGuidePrice: z.number(),
+        coverImageNew: imageSchema.nullable(),
+        heroImageNew: imageSchema.nullable(),
+        coverImageS3Key: z.string().nullable(),
+        heroImageS3Key: z.string().nullable(),
+        latitude: z.number().nullable(),
+        longitude: z.number().nullable(),
+        swipeDirection: areaSwipeDirectionSchema,
+        longDescription: z.string().nullable(),
+    })),
+    apiVersion: z.number(),
+})
+export type GuidebookProductData = z.infer<typeof guidebookProductDataSchema>
+
+
+export const climbMapGroupSchema = z.object({
+    id: z.string(),
+    areaId: z.number(),
+    climbs: z.array(z.object({ id: z.number() })),
+    geojsonMultiPolygon: GeoJSONMultiPolygonSchema.nullable(),
+});
+export type ClimbMapGroup = z.infer<typeof climbMapGroupSchema>
+
+
+const climbLogPrimaryCIGSchema = z.object({
+    climbPaths: z.array(climbPathSchema),
+    id: z.number(),
+    image: z.string(),
+    areaId: z.number().nullable(),
+    areaName: z.string(),
+    sortOrder: z.number(),
+    anchors: z.array(coordSchema),
+    imageNew: imageSchema,
+    imageS3Key: z.string(),
+})
+
+export const climbLogSchema = z.object({
+    id: z.string(),
+    attemptDate: z.string(),
+    createdAt: z.string(),
+    attemptType: climbLogAttemptTypeSchema,
+    userId: z.string(),
+    climbId: z.number(),
+    climbLogBodyText: z.string().nullable(),
+    climb: z.object({
+        id: z.number(),
+        climbName: z.string(),
+        grade: z.string().nullable(),
+        primaryClimbImageGroup: climbLogPrimaryCIGSchema.nullable(),
+    }),
+    userStarRating: z.number().nullable(),
+    numberOfAttempts: z.number().nullable(),
+    locationString: z.string(),
+    User: z.object({ publicDisplayName: z.string().nullable() }),
+    isPrivate: z.boolean(),
+    notes: z.string().nullable(),
+})
+export type ClimbLog = z.infer<typeof climbLogSchema>
+
+
+const climbSchema = z.object({
+    primaryClimbImageGroup: climbLogPrimaryCIGSchema.nullable(),
+    primaryClimbImageGroupid: z.number().nullable(),
+    climbImageGroups: z.array(climbLogPrimaryCIGSchema),
+    id: z.number(),
+    climbName: z.string(),
+    areaClimbNumber: z.number(),
+    description: z.string().nullable(),
+    firstAscent: z.string().nullable(),
+    height: z.string().nullable(),
+    areaId: z.number().nullable(),
+    starRating: starRatingSchema.nullable(),
+    areaName: z.string(),
+    climbType: climbTypeSchema.nullable(),
+    grade: z.string().nullable(),
+    beta: z.string().nullable(),
+    extras: z.string().nullable(),
+    descent: z.string().nullable(),
+    approach: z.string().nullable(),
+    pitches: z.string().nullable(),
+    variations: z.string().nullable(),
+    protection: z.string().nullable(),
+    guidebookId: z.number().nullable(),
+    topo3DUrl: z.string().nullable(),
+    overviewImageURL: z.string().nullable(),
+    additionalImages: z.array(imageSchema),
+    latitude: z.number().nullable(),
+    longitude: z.number().nullable(),
+    climbMapGroupId: z.string().nullable(),
+})
+export type Climb = z.infer<typeof climbSchema>
+
+
+const climbFeedbackSchema = z.object({
+    climbId: z.number(),
+    userId: z.string(),
+    userStarRating: z.number().or(z.null()),
+    gradeFeedbackTag: gradeFeedbackTagEnum.nullable()
+})
+export type ClimbFeedback = z.infer<typeof climbFeedbackSchema>
+
+
+export const ClimbFeedbackInputSchema = z.object({
+    climbId: z.number(),
+    userId: z.string(),
+    userStarRating: z.number().min(0).max(4).nullable(),
+    gradeFeedbackTag: gradeFeedbackTagEnum.nullable()
+})
+export type ClimbFeedbackInput = z.infer<typeof ClimbFeedbackInputSchema>
+
+
+export const climbFeedbackAggregateDataSchema = z.object({
+    climbId: z.number(),
+    tags: z.record(gradeFeedbackTagEnum, z.number()),
+    averageUserStarRating: z.object({
+        rating: z.number().nullable(),
+        count: z.number(),
+    }),
+});
+export type ClimbFeedbackAggregateData = z.infer<typeof climbFeedbackAggregateDataSchema>;
+
+
+const areaSchema = z.object({
+    climbImageGroups: z.array(climbImageGroupSchema),
+    climbMapGroups: z.array(climbMapGroupSchema),
+    climbs: z.array(climbSchema),
+    areaName: z.string(),
+    sectionAreaNumber: z.number(),
+    sectionName: z.string(),
+    id: z.number(),
+    sectionId: z.number().nullable(),
+    guidebookId: z.number(),
+    pano: z.string(),
+    panoNew: imageSchema.nullable(),
+    latitude: z.number().nullable(),
+    longitude: z.number().nullable(),
+    overview: z.string().nullable(),
+    directions: z.string().nullable(),
+    approach: z.string().nullable(),
+    aspect: z.string().nullable(),
+    swipeDirection: areaSwipeDirectionSchema,
+    accessClosureDescription: z.string().nullable(),
+    imageS3Key: z.string().nullable(),
+    geojsonFeaturePolygon: GeoJSONFeatureSchema.nullable(),
+})
+export type Area = z.infer<typeof areaSchema>
+
+
+const sectionSchema = z.object({
+    areas: z.array(areaSchema),
+    sectionName: z.string(),
+    guidebookId: z.number().nullable(),
+    bookSectionNumber: z.number(),
+    swipeDirection: areaSwipeDirectionSchema,
+    id: z.number(),
+});
+export type Section = z.infer<typeof sectionSchema>
+
+
+const mapInfoAreaSchema = z.object({
+    id: z.string(),
+    mapLabel: z.string(),
+    infoSheetTitle: z.string(),
+    infoSheetBody: z.string(),
+    infoExternalWebLink: z.string().nullable(),
+    guidebookId: z.number().nullable(),
+    mapInfoAreaType: mapInfoAreaTypeSchema,
+    boundaryPolyline: z.array(latLongSchema),
+});
+export type MapInfoArea = z.infer<typeof mapInfoAreaSchema>
+
+
+const guidebookSchema = z.object({
+    digitalVersionPublished: z.boolean(),
+    apiVersion: z.number(),
+    images: z.array(z.string()),
+    sections: z.array(sectionSchema),
+    id: z.number(),
+    title: z.string(),
+    author: z.string(),
+    coverImage: z.string(),
+    coverImageNew: imageSchema.nullable(),
+    description: z.string(),
+    isFreeSampleGuidebook: z.boolean(),
+    latitude: z.number().nullable(),
+    longitude: z.number().nullable(),
+    version: z.number(),
+    heroImage: z.string(),
+    heroImageNew: imageSchema.nullable(),
+    state: z.string(),
+    additionalImages: z.array(imageSchema),
+    accessTrailPolylines: z.array(z.array(latLongSchema)),
+    parkingInfo: z.array(poiSchema),
+    digitalGuidePrice: z.number(),
+    coverImageS3Key: z.string().nullable(),
+    heroImageS3Key: z.string().nullable(),
+    swipeDirection: areaSwipeDirectionSchema,
+    longDescription: z.string().nullable(),
+    mapInfoAreas: z.array(mapInfoAreaSchema),
+})
+export type Guidebook = z.infer<typeof guidebookSchema>

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "n_a_types",
-  "version": "3.0.28",
+  "version": "3.1.0",
   "description": "types",
   "main": "index.ts",
   "author": "",
-  "license": "ISC"
-}
+  "license": "ISC",
+  "dependencies": {
+    "zod": "^4.3.6"
+  }
+}

package/V3.ts

@@ -1,284 +0,0 @@
-export const API_VERSION = 3;
-export type Coord = { x: number, y: number };
-export type LatLong = { latitude: number, longitude: number };
-export type TrailPolyline = LatLong[];
-export type ClimbType = 'TRAD' | 'SPORT' | 'BOULDER' | 'ICE' | 'TOPROPE';
-export type StarRating = "ONE" | "TWO" | "THREE" | "FOUR";
-export type AreaSwipeDirection = 'LEFT_TO_RIGHT' | 'RIGHT_TO_LEFT';
-import type { GeoJSONFeature, GeoJSONMultiPolygon } from "zod-geojson";
-export type GeojsonFeaturePolygon = GeoJSONFeature;
-export type ClimbLogAttemptType = 'FLASH' | 'REDPOINT' | 'ONSIGHT' | 'ATTEMPT';
-export type GradeFeedbackTag = 'SOFT' | 'SOLID' | 'SANDBAG';
-export type MapInfoAreaType = 'PRIVATE_LAND' | 'PUBLIC_LAND' | 'OTHER_ACCESS_CONCERN'
-
-///GUIDEBOOK FETCH
-export type Guidebook = {
-    digitalVersionPublished: boolean,
-    apiVersion: number,
-    images: string[],
-    sections: Section[];
-    id: number;
-    title: string;
-    author: string;
-    coverImage: string;
-    coverImageNew: Image | null;
-    description: string;
-    isFreeSampleGuidebook: boolean;
-    latitude: number | null;
-    longitude: number | null;
-    version: number;
-    heroImage: string;
-    heroImageNew: Image | null;
-    state: string;
-    additionalImages: Image[];
-    accessTrailPolylines: TrailPolyline[];
-    parkingInfo: POI[];
-    digitalGuidePrice: number;
-    coverImageS3Key: string | null;
-    heroImageS3Key: string | null;
-    swipeDirection: AreaSwipeDirection;
-    longDescription: string | null;
-    mapInfoAreas: {
-        id: string;
-        mapLabel: string;
-        infoSheetTitle: string;
-        infoSheetBody: string;
-        infoExternalWebLink: string | null;
-        guidebookId: number | null;
-        mapInfoAreaType: MapInfoAreaType
-        boundaryPolyline: LatLong[];
-    }[]
-}
-
-export type Section = {
-    areas: Area[];
-    sectionName: string;
-    guidebookId: number | null;
-    bookSectionNumber: number;
-    swipeDirection: AreaSwipeDirection;
-    id: number;
-}
-
-export type Area = {
-    climbImageGroups: ClimbImageGroup[];
-    climbMapGroups: ClimbMapGroup[];
-    climbs: Climb[];
-    areaName: string;
-    sectionAreaNumber: number;
-    sectionName: string;
-    id: number;
-    sectionId: number | null;
-    guidebookId: number;
-    pano: string;
-    panoNew: Image | null;
-    latitude: number | null;
-    longitude: number | null;
-    overview: string | null;
-    directions: string | null;
-    approach: string | null;
-    aspect: string | null;
-    swipeDirection: AreaSwipeDirection;
-    accessClosureDescription: string | null;
-    imageS3Key: string | null;
-    geojsonFeaturePolygon: GeojsonFeaturePolygon | null;
-}
-
-export type ClimbImageGroup = {
-    climbPaths: ({
-        climb: {
-            id: number;
-            areaClimbNumber: number;
-            climbType: ClimbType | null;
-            grade: string | null;
-        } | null;
-        id: number;
-        climbId: number | null;
-        climbImageGroupId: number | null;
-        climbVariation: number;
-        climbTopoImageSVGPathCoords: Coord[];
-    })[];
-    climbs: {
-        id: number;
-        areaClimbNumber: number;
-    }[];
-    id: number;
-    image: string;
-    areaId: number | null;
-    areaName: string;
-    sortOrder: number;
-    anchors: Coord[];
-    imageNew: Image;
-    imageS3Key: string;
-}
-
-export type Climb = {
-    primaryClimbImageGroup: ({
-        climbPaths: {
-            id: number;
-            climbId: number | null;
-            climbImageGroupId: number | null;
-            climbVariation: number;
-            climbTopoImageSVGPathCoords: Coord[];
-        }[];
-        id: number;
-        image: string;
-        areaId: number | null;
-        areaName: string;
-        sortOrder: number;
-        anchors: Coord[];
-        imageNew: Image;
-        imageS3Key: string;
-    }) | null,
-    primaryClimbImageGroupid: number | null,
-    climbImageGroups: ({
-        climbPaths: {
-            id: number;
-            climbId: number | null;
-            climbImageGroupId: number | null;
-            climbVariation: number;
-            climbTopoImageSVGPathCoords: Coord[];
-        }[];
-        id: number;
-        image: string;
-        areaId: number | null;
-        areaName: string;
-        sortOrder: number;
-        anchors: Coord[];
-        imageS3Key: string;
-        imageNew: Image;
-    })[];
-    id: number;
-    climbName: string;
-    areaClimbNumber: number;
-    description: string | null;
-    firstAscent: string | null;
-    height: string | null;
-    areaId: number | null;
-    starRating: StarRating | null;
-    areaName: string;
-    climbType: ClimbType | null;
-    grade: string | null;
-    beta: string | null;
-    extras: string | null;
-    descent: string | null;
-    approach: string | null;
-    pitches: string | null;
-    variations: string | null;
-    protection: string | null;
-    guidebookId: number | null;
-    topo3DUrl: string | null;
-    overviewImageURL: string | null;
-    additionalImages: Image[];
-    latitude: number | null,
-    longitude: number | null,
-    climbMapGroupId: string | null
-}
-
-export type Image = {
-    s3Key: string;
-    s3URL: string;
-    description: string | null;
-    naturalWidth: number;
-    naturalHeight: number;
-    blurhash: string | null;
-    climbId: number | null;
-    guidebookId: number | null;
-
-}
-
-export type POI = {
-    id: string;
-    image: string | null;
-    description: string;
-    latitude: number;
-    longitude: number;
-    guidebookId: number | null;
-}
-
-///PRODUCT DATA FETCH
-export type GuidebookProductData = {
-    guidebooks: {
-        additionalImages: Image[],
-        digitalVersionPublished: boolean,
-        id: number;
-        title: string;
-        author: string;
-        coverImage: string;
-        description: string;
-        isFreeSampleGuidebook: boolean;
-        version: number;
-        heroImage: string;
-        state: string;
-        accessTrailPolylines: TrailPolyline[];
-        digitalGuidePrice: number;
-        coverImageNew: Image | null;
-        heroImageNew: Image | null;
-        coverImageS3Key: string | null;
-        heroImageS3Key: string | null;
-        latitude: number | null;
-        longitude: number | null;
-        swipeDirection: AreaSwipeDirection;
-        longDescription: string | null
-    }[], apiVersion: number;
-}
-
-export type ClimbMapGroup = {
-    id: string,
-    areaId: number,
-    climbs: { id: number }[],
-    geojsonMultiPolygon: GeoJSONMultiPolygon | null
-}
-
-export type ClimbLog = {
-    id: string;
-    attemptDate: string;
-    createdAt: string;
-    attemptType: ClimbLogAttemptType;
-    userId: string;
-    climbId: number;
-    climbLogBodyText: string | null;
-    climb: {
-        id: number;
-        climbName: string;
-        grade: string | null;
-        primaryClimbImageGroup: ({
-            climbPaths: {
-                id: number;
-                climbId: number | null;
-                climbImageGroupId: number | null;
-                climbVariation: number;
-                climbTopoImageSVGPathCoords: Coord[];
-            }[];
-            id: number;
-            image: string;
-            areaId: number | null;
-            areaName: string;
-            sortOrder: number;
-            anchors: Coord[];
-            imageNew: Image;
-            imageS3Key: string;
-        }) | null
-    };
-    userStarRating: number | null;
-    numberOfAttempts: number | null;
-    locationString: string;
-    User: { publicDisplayName: string | null };
-    isPrivate: boolean;
-    notes: string | null;
-}
-
-export type ClimbFeedback = {
-    climbId: number;
-    userId: string;
-    userStarRating: number | null;
-    gradeFeedbackTag: GradeFeedbackTag | null;
-}
-
-export type ClimbFeedbackAggregateData = {
-    climbId: number,
-    tags: Record<GradeFeedbackTag, number>,
-    averageUserStarRating: {
-        rating: number | null,
-        count: number
-    }
-}