@deepintel-ltd/buildlink-api-contracts 0.2.25 → 0.2.27

package/contracts/tours.d.ts

@@ -0,0 +1,503 @@
+import { z } from 'zod';
+export declare const toursContract: {
+    getTourState: {
+        pathParams: z.ZodObject<{
+            roleKey: z.ZodEnum<["CLIENT", "QS", "CONTRACTOR"]>;
+        }, "strip", z.ZodTypeAny, {
+            roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+        }, {
+            roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+        }>;
+        query: z.ZodObject<{
+            tourVersion: z.ZodDefault<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            tourVersion: string;
+        }, {
+            tourVersion?: string | undefined;
+        }>;
+        summary: "Get first-run tour state for role";
+        method: "GET";
+        path: "/me/tours/:roleKey";
+        responses: {
+            200: z.ZodObject<{
+                data: z.ZodObject<{
+                    type: z.ZodLiteral<"user-tour-states">;
+                    id: z.ZodString;
+                    attributes: z.ZodObject<Omit<{
+                        id: z.ZodString;
+                        userId: z.ZodString;
+                        roleKey: z.ZodEnum<["CLIENT", "QS", "CONTRACTOR"]>;
+                        tourVersion: z.ZodString;
+                        completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        skippedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        createdAt: z.ZodString;
+                        updatedAt: z.ZodString;
+                    }, "id">, "strip", z.ZodTypeAny, {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    }, {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    }>;
+                }, "strip", z.ZodTypeAny, {
+                    id: string;
+                    type: "user-tour-states";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    };
+                }, {
+                    id: string;
+                    type: "user-tour-states";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    };
+                }>;
+                meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                links: z.ZodOptional<z.ZodObject<{
+                    self: z.ZodString;
+                    first: z.ZodOptional<z.ZodString>;
+                    last: z.ZodOptional<z.ZodString>;
+                    prev: z.ZodOptional<z.ZodString>;
+                    next: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                }, {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                }>>;
+                errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    status: z.ZodString;
+                    title: z.ZodString;
+                    detail: z.ZodOptional<z.ZodString>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }>, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                data: {
+                    id: string;
+                    type: "user-tour-states";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    };
+                };
+                meta?: Record<string, unknown> | undefined;
+                links?: {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                } | undefined;
+                errors?: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[] | undefined;
+            }, {
+                data: {
+                    id: string;
+                    type: "user-tour-states";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    };
+                };
+                meta?: Record<string, unknown> | undefined;
+                links?: {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                } | undefined;
+                errors?: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[] | undefined;
+            }>;
+            401: z.ZodObject<{
+                errors: z.ZodArray<z.ZodObject<{
+                    status: z.ZodString;
+                    title: z.ZodString;
+                    detail: z.ZodOptional<z.ZodString>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                errors: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[];
+            }, {
+                errors: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[];
+            }>;
+            404: z.ZodObject<{
+                errors: z.ZodArray<z.ZodObject<{
+                    status: z.ZodString;
+                    title: z.ZodString;
+                    detail: z.ZodOptional<z.ZodString>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                errors: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[];
+            }, {
+                errors: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[];
+            }>;
+        };
+    };
+    completeTour: {
+        summary: "Mark role tour completed or skipped";
+        method: "POST";
+        body: z.ZodObject<{
+            roleKey: z.ZodEnum<["CLIENT", "QS", "CONTRACTOR"]>;
+            tourVersion: z.ZodDefault<z.ZodString>;
+            skipped: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+            tourVersion: string;
+            skipped?: boolean | undefined;
+        }, {
+            roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+            tourVersion?: string | undefined;
+            skipped?: boolean | undefined;
+        }>;
+        path: "/me/tours/complete";
+        responses: {
+            200: z.ZodObject<{
+                data: z.ZodObject<{
+                    type: z.ZodLiteral<"user-tour-states">;
+                    id: z.ZodString;
+                    attributes: z.ZodObject<Omit<{
+                        id: z.ZodString;
+                        userId: z.ZodString;
+                        roleKey: z.ZodEnum<["CLIENT", "QS", "CONTRACTOR"]>;
+                        tourVersion: z.ZodString;
+                        completedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        skippedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        createdAt: z.ZodString;
+                        updatedAt: z.ZodString;
+                    }, "id">, "strip", z.ZodTypeAny, {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    }, {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    }>;
+                }, "strip", z.ZodTypeAny, {
+                    id: string;
+                    type: "user-tour-states";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    };
+                }, {
+                    id: string;
+                    type: "user-tour-states";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    };
+                }>;
+                meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                links: z.ZodOptional<z.ZodObject<{
+                    self: z.ZodString;
+                    first: z.ZodOptional<z.ZodString>;
+                    last: z.ZodOptional<z.ZodString>;
+                    prev: z.ZodOptional<z.ZodString>;
+                    next: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                }, {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                }>>;
+                errors: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    status: z.ZodString;
+                    title: z.ZodString;
+                    detail: z.ZodOptional<z.ZodString>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }>, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                data: {
+                    id: string;
+                    type: "user-tour-states";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    };
+                };
+                meta?: Record<string, unknown> | undefined;
+                links?: {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                } | undefined;
+                errors?: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[] | undefined;
+            }, {
+                data: {
+                    id: string;
+                    type: "user-tour-states";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        userId: string;
+                        roleKey: "CONTRACTOR" | "CLIENT" | "QS";
+                        tourVersion: string;
+                        completedAt?: string | null | undefined;
+                        skippedAt?: string | null | undefined;
+                    };
+                };
+                meta?: Record<string, unknown> | undefined;
+                links?: {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                } | undefined;
+                errors?: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[] | undefined;
+            }>;
+            401: z.ZodObject<{
+                errors: z.ZodArray<z.ZodObject<{
+                    status: z.ZodString;
+                    title: z.ZodString;
+                    detail: z.ZodOptional<z.ZodString>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                errors: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[];
+            }, {
+                errors: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[];
+            }>;
+        };
+    };
+    adoptionMetrics: {
+        summary: "Workflow adoption metrics from ValuationEvent counts";
+        method: "GET";
+        path: "/me/adoption-metrics";
+        responses: {
+            200: z.ZodObject<{
+                data: z.ZodObject<{
+                    valuationEventCount: z.ZodNumber;
+                    certificatesTouched: z.ZodNumber;
+                    note: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    valuationEventCount: number;
+                    certificatesTouched: number;
+                    note?: string | undefined;
+                }, {
+                    valuationEventCount: number;
+                    certificatesTouched: number;
+                    note?: string | undefined;
+                }>;
+            }, "strip", z.ZodTypeAny, {
+                data: {
+                    valuationEventCount: number;
+                    certificatesTouched: number;
+                    note?: string | undefined;
+                };
+            }, {
+                data: {
+                    valuationEventCount: number;
+                    certificatesTouched: number;
+                    note?: string | undefined;
+                };
+            }>;
+            401: z.ZodObject<{
+                errors: z.ZodArray<z.ZodObject<{
+                    status: z.ZodString;
+                    title: z.ZodString;
+                    detail: z.ZodOptional<z.ZodString>;
+                    meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+                }, "strip", z.ZodTypeAny, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }, {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                errors: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[];
+            }, {
+                errors: {
+                    status: string;
+                    title: string;
+                    detail?: string | undefined;
+                    meta?: Record<string, unknown> | undefined;
+                }[];
+            }>;
+        };
+    };
+};
+//# sourceMappingURL=tours.d.ts.map

package/contracts/tours.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tours.d.ts","sourceRoot":"","sources":["../../../src/contracts/tours.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAWxB,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCxB,CAAC"}

package/contracts/tours.js

@@ -0,0 +1,39 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import { JsonApiErrorResponseSchema, JsonApiResponseSchema } from '../schemas/common';
+import { AdoptionMetricsSchema, CompleteTourRequestSchema, UserTourStateResourceSchema, } from '../schemas/tours';
+const c = initContract();
+export const toursContract = c.router({
+    getTourState: {
+        method: 'GET',
+        path: '/me/tours/:roleKey',
+        pathParams: z.object({ roleKey: z.enum(['CLIENT', 'QS', 'CONTRACTOR']) }),
+        query: z.object({ tourVersion: z.string().default('v1') }),
+        responses: {
+            200: JsonApiResponseSchema(UserTourStateResourceSchema),
+            401: JsonApiErrorResponseSchema,
+            404: JsonApiErrorResponseSchema,
+        },
+        summary: 'Get first-run tour state for role',
+    },
+    completeTour: {
+        method: 'POST',
+        path: '/me/tours/complete',
+        body: CompleteTourRequestSchema,
+        responses: {
+            200: JsonApiResponseSchema(UserTourStateResourceSchema),
+            401: JsonApiErrorResponseSchema,
+        },
+        summary: 'Mark role tour completed or skipped',
+    },
+    adoptionMetrics: {
+        method: 'GET',
+        path: '/me/adoption-metrics',
+        responses: {
+            200: z.object({ data: AdoptionMetricsSchema }),
+            401: JsonApiErrorResponseSchema,
+        },
+        summary: 'Workflow adoption metrics from ValuationEvent counts',
+    },
+});
+//# sourceMappingURL=tours.js.map

package/contracts/tours.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tours.js","sourceRoot":"","sources":["../../../src/contracts/tours.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AACtF,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,2BAA2B,GAC5B,MAAM,kBAAkB,CAAC;AAE1B,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,YAAY,EAAE;QACZ,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC;QACzE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1D,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,2BAA2B,CAAC;YACvD,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,mCAAmC;KAC7C;IACD,YAAY,EAAE;QACZ,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,oBAAoB;QAC1B,IAAI,EAAE,yBAAyB;QAC/B,SAAS,EAAE;YACT,GAAG,EAAE,qBAAqB,CAAC,2BAA2B,CAAC;YACvD,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,qCAAqC;KAC/C;IACD,eAAe,EAAE;QACf,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,sBAAsB;QAC5B,SAAS,EAAE;YACT,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC;YAC9C,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,sDAAsD;KAChE;CACF,CAAC,CAAC"}