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

package/contracts/material-index.d.ts

@@ -0,0 +1,560 @@
+import { z } from 'zod';
+export declare const materialIndexContract: {
+    importRates: {
+        summary: "Admin CSV-shaped import of material rate index rows";
+        method: "POST";
+        body: z.ZodObject<{
+            projectId: z.ZodOptional<z.ZodString>;
+            rows: z.ZodArray<z.ZodObject<{
+                materialKey: z.ZodString;
+                name: z.ZodString;
+                unit: z.ZodString;
+                priceNgn: z.ZodNumber;
+                asOfDate: z.ZodString;
+                source: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                name: string;
+                unit: string;
+                materialKey: string;
+                priceNgn: number;
+                asOfDate: string;
+                source?: string | undefined;
+            }, {
+                name: string;
+                unit: string;
+                materialKey: string;
+                priceNgn: number;
+                asOfDate: string;
+                source?: string | undefined;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            rows: {
+                name: string;
+                unit: string;
+                materialKey: string;
+                priceNgn: number;
+                asOfDate: string;
+                source?: string | undefined;
+            }[];
+            projectId?: string | undefined;
+        }, {
+            rows: {
+                name: string;
+                unit: string;
+                materialKey: string;
+                priceNgn: number;
+                asOfDate: string;
+                source?: string | undefined;
+            }[];
+            projectId?: string | undefined;
+        }>;
+        path: "/admin/material-rates/import";
+        responses: {
+            201: z.ZodObject<{
+                data: z.ZodArray<z.ZodObject<{
+                    type: z.ZodLiteral<"material-rate-indexes">;
+                    id: z.ZodString;
+                    attributes: z.ZodObject<Omit<{
+                        id: z.ZodString;
+                        companyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        projectId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        materialKey: z.ZodString;
+                        name: z.ZodString;
+                        unit: z.ZodString;
+                        priceNgn: z.ZodNumber;
+                        asOfDate: z.ZodString;
+                        source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                        createdAt: z.ZodString;
+                        updatedAt: z.ZodString;
+                    }, "id">, "strip", z.ZodTypeAny, {
+                        createdAt: string;
+                        updatedAt: string;
+                        name: string;
+                        unit: string;
+                        materialKey: string;
+                        priceNgn: number;
+                        asOfDate: string;
+                        companyId?: string | null | undefined;
+                        projectId?: string | null | undefined;
+                        source?: string | null | undefined;
+                    }, {
+                        createdAt: string;
+                        updatedAt: string;
+                        name: string;
+                        unit: string;
+                        materialKey: string;
+                        priceNgn: number;
+                        asOfDate: string;
+                        companyId?: string | null | undefined;
+                        projectId?: string | null | undefined;
+                        source?: string | null | undefined;
+                    }>;
+                }, "strip", z.ZodTypeAny, {
+                    id: string;
+                    type: "material-rate-indexes";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        name: string;
+                        unit: string;
+                        materialKey: string;
+                        priceNgn: number;
+                        asOfDate: string;
+                        companyId?: string | null | undefined;
+                        projectId?: string | null | undefined;
+                        source?: string | null | undefined;
+                    };
+                }, {
+                    id: string;
+                    type: "material-rate-indexes";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        name: string;
+                        unit: string;
+                        materialKey: string;
+                        priceNgn: number;
+                        asOfDate: string;
+                        companyId?: string | null | undefined;
+                        projectId?: string | null | undefined;
+                        source?: string | null | undefined;
+                    };
+                }>, "many">;
+                meta: z.ZodOptional<z.ZodObject<{
+                    total: z.ZodOptional<z.ZodNumber>;
+                    page: z.ZodOptional<z.ZodNumber>;
+                    size: z.ZodOptional<z.ZodNumber>;
+                    pages: z.ZodOptional<z.ZodNumber>;
+                    hasNextPage: z.ZodOptional<z.ZodBoolean>;
+                    hasPreviousPage: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    page?: number | undefined;
+                    total?: number | undefined;
+                    size?: number | undefined;
+                    pages?: number | undefined;
+                    hasNextPage?: boolean | undefined;
+                    hasPreviousPage?: boolean | undefined;
+                }, {
+                    page?: number | undefined;
+                    total?: number | undefined;
+                    size?: number | undefined;
+                    pages?: number | undefined;
+                    hasNextPage?: boolean | undefined;
+                    hasPreviousPage?: boolean | undefined;
+                }>>;
+                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;
+                }>>;
+            }, "strip", z.ZodTypeAny, {
+                data: {
+                    id: string;
+                    type: "material-rate-indexes";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        name: string;
+                        unit: string;
+                        materialKey: string;
+                        priceNgn: number;
+                        asOfDate: string;
+                        companyId?: string | null | undefined;
+                        projectId?: string | null | undefined;
+                        source?: string | null | undefined;
+                    };
+                }[];
+                meta?: {
+                    page?: number | undefined;
+                    total?: number | undefined;
+                    size?: number | undefined;
+                    pages?: number | undefined;
+                    hasNextPage?: boolean | undefined;
+                    hasPreviousPage?: boolean | undefined;
+                } | undefined;
+                links?: {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                } | undefined;
+            }, {
+                data: {
+                    id: string;
+                    type: "material-rate-indexes";
+                    attributes: {
+                        createdAt: string;
+                        updatedAt: string;
+                        name: string;
+                        unit: string;
+                        materialKey: string;
+                        priceNgn: number;
+                        asOfDate: string;
+                        companyId?: string | null | undefined;
+                        projectId?: string | null | undefined;
+                        source?: string | null | undefined;
+                    };
+                }[];
+                meta?: {
+                    page?: number | undefined;
+                    total?: number | undefined;
+                    size?: number | undefined;
+                    pages?: number | undefined;
+                    hasNextPage?: boolean | undefined;
+                    hasPreviousPage?: boolean | undefined;
+                } | undefined;
+                links?: {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                } | undefined;
+            }>;
+            400: 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;
+                }[];
+            }>;
+            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;
+                }[];
+            }>;
+            403: 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;
+                }[];
+            }>;
+        };
+    };
+    listAlerts: {
+        pathParams: z.ZodObject<{
+            projectId: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            projectId: string;
+        }, {
+            projectId: string;
+        }>;
+        summary: "BOQ lines where index variance exceeds contingency";
+        method: "GET";
+        path: "/projects/:projectId/material-rate-alerts";
+        responses: {
+            200: z.ZodObject<{
+                data: z.ZodArray<z.ZodObject<{
+                    type: z.ZodLiteral<"material-rate-alerts">;
+                    id: z.ZodString;
+                    attributes: z.ZodObject<{
+                        boqLineId: z.ZodString;
+                        itemCode: z.ZodString;
+                        materialKey: z.ZodString;
+                        boqRate: z.ZodNumber;
+                        indexRate: z.ZodNumber;
+                        variancePct: z.ZodNumber;
+                        contingencyPct: z.ZodNumber;
+                    }, "strip", z.ZodTypeAny, {
+                        itemCode: string;
+                        materialKey: string;
+                        boqLineId: string;
+                        boqRate: number;
+                        indexRate: number;
+                        variancePct: number;
+                        contingencyPct: number;
+                    }, {
+                        itemCode: string;
+                        materialKey: string;
+                        boqLineId: string;
+                        boqRate: number;
+                        indexRate: number;
+                        variancePct: number;
+                        contingencyPct: number;
+                    }>;
+                }, "strip", z.ZodTypeAny, {
+                    id: string;
+                    type: "material-rate-alerts";
+                    attributes: {
+                        itemCode: string;
+                        materialKey: string;
+                        boqLineId: string;
+                        boqRate: number;
+                        indexRate: number;
+                        variancePct: number;
+                        contingencyPct: number;
+                    };
+                }, {
+                    id: string;
+                    type: "material-rate-alerts";
+                    attributes: {
+                        itemCode: string;
+                        materialKey: string;
+                        boqLineId: string;
+                        boqRate: number;
+                        indexRate: number;
+                        variancePct: number;
+                        contingencyPct: number;
+                    };
+                }>, "many">;
+                meta: z.ZodOptional<z.ZodObject<{
+                    total: z.ZodOptional<z.ZodNumber>;
+                    page: z.ZodOptional<z.ZodNumber>;
+                    size: z.ZodOptional<z.ZodNumber>;
+                    pages: z.ZodOptional<z.ZodNumber>;
+                    hasNextPage: z.ZodOptional<z.ZodBoolean>;
+                    hasPreviousPage: z.ZodOptional<z.ZodBoolean>;
+                }, "strip", z.ZodTypeAny, {
+                    page?: number | undefined;
+                    total?: number | undefined;
+                    size?: number | undefined;
+                    pages?: number | undefined;
+                    hasNextPage?: boolean | undefined;
+                    hasPreviousPage?: boolean | undefined;
+                }, {
+                    page?: number | undefined;
+                    total?: number | undefined;
+                    size?: number | undefined;
+                    pages?: number | undefined;
+                    hasNextPage?: boolean | undefined;
+                    hasPreviousPage?: boolean | undefined;
+                }>>;
+                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;
+                }>>;
+            }, "strip", z.ZodTypeAny, {
+                data: {
+                    id: string;
+                    type: "material-rate-alerts";
+                    attributes: {
+                        itemCode: string;
+                        materialKey: string;
+                        boqLineId: string;
+                        boqRate: number;
+                        indexRate: number;
+                        variancePct: number;
+                        contingencyPct: number;
+                    };
+                }[];
+                meta?: {
+                    page?: number | undefined;
+                    total?: number | undefined;
+                    size?: number | undefined;
+                    pages?: number | undefined;
+                    hasNextPage?: boolean | undefined;
+                    hasPreviousPage?: boolean | undefined;
+                } | undefined;
+                links?: {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | undefined;
+                } | undefined;
+            }, {
+                data: {
+                    id: string;
+                    type: "material-rate-alerts";
+                    attributes: {
+                        itemCode: string;
+                        materialKey: string;
+                        boqLineId: string;
+                        boqRate: number;
+                        indexRate: number;
+                        variancePct: number;
+                        contingencyPct: number;
+                    };
+                }[];
+                meta?: {
+                    page?: number | undefined;
+                    total?: number | undefined;
+                    size?: number | undefined;
+                    pages?: number | undefined;
+                    hasNextPage?: boolean | undefined;
+                    hasPreviousPage?: boolean | undefined;
+                } | undefined;
+                links?: {
+                    self: string;
+                    first?: string | undefined;
+                    last?: string | undefined;
+                    prev?: string | undefined;
+                    next?: string | 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;
+                }[];
+            }>;
+            403: 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=material-index.d.ts.map

package/contracts/material-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"material-index.d.ts","sourceRoot":"","sources":["../../../src/contracts/material-index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAexB,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwBhC,CAAC"}

package/contracts/material-index.js

@@ -0,0 +1,31 @@
+import { initContract } from '@ts-rest/core';
+import { z } from 'zod';
+import { CuidSchema, JsonApiCollectionResponseSchema, JsonApiErrorResponseSchema, } from '../schemas/common';
+import { ImportMaterialRatesRequestSchema, MaterialRateAlertResourceSchema, MaterialRateIndexResourceSchema, } from '../schemas/material-index';
+const c = initContract();
+export const materialIndexContract = c.router({
+    importRates: {
+        method: 'POST',
+        path: '/admin/material-rates/import',
+        body: ImportMaterialRatesRequestSchema,
+        responses: {
+            201: JsonApiCollectionResponseSchema(MaterialRateIndexResourceSchema),
+            400: JsonApiErrorResponseSchema,
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+        },
+        summary: 'Admin CSV-shaped import of material rate index rows',
+    },
+    listAlerts: {
+        method: 'GET',
+        path: '/projects/:projectId/material-rate-alerts',
+        pathParams: z.object({ projectId: CuidSchema }),
+        responses: {
+            200: JsonApiCollectionResponseSchema(MaterialRateAlertResourceSchema),
+            401: JsonApiErrorResponseSchema,
+            403: JsonApiErrorResponseSchema,
+        },
+        summary: 'BOQ lines where index variance exceeds contingency',
+    },
+});
+//# sourceMappingURL=material-index.js.map

package/contracts/material-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"material-index.js","sourceRoot":"","sources":["../../../src/contracts/material-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,UAAU,EACV,+BAA+B,EAC/B,0BAA0B,GAC3B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,gCAAgC,EAChC,+BAA+B,EAC/B,+BAA+B,GAChC,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;AAEzB,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,WAAW,EAAE;QACX,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,8BAA8B;QACpC,IAAI,EAAE,gCAAgC;QACtC,SAAS,EAAE;YACT,GAAG,EAAE,+BAA+B,CAAC,+BAA+B,CAAC;YACrE,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,qDAAqD;KAC/D;IACD,UAAU,EAAE;QACV,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,2CAA2C;QACjD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;QAC/C,SAAS,EAAE;YACT,GAAG,EAAE,+BAA+B,CAAC,+BAA+B,CAAC;YACrE,GAAG,EAAE,0BAA0B;YAC/B,GAAG,EAAE,0BAA0B;SAChC;QACD,OAAO,EAAE,oDAAoD;KAC9D;CACF,CAAC,CAAC"}