@silkwebdev/gaffer-types 1.0.5

package/README

@@ -0,0 +1 @@
+Shared types and Zod schemas

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./project-type/project-type.schema.js";
+export * from "./quote/quote-status.schema.js";
+export * from "./quote/quote.schema.js";
+export * from "./testimonial/create-testimonial.schema.js";
+export * from "./testimonial/get-testimonials.schema.js";
+export * from "./testimonial/testimonial.schema.js";
+export * from "./version/version.schema.js";

package/dist/index.js

@@ -0,0 +1,7 @@
+export * from "./project-type/project-type.schema.js";
+export * from "./quote/quote-status.schema.js";
+export * from "./quote/quote.schema.js";
+export * from "./testimonial/create-testimonial.schema.js";
+export * from "./testimonial/get-testimonials.schema.js";
+export * from "./testimonial/testimonial.schema.js";
+export * from "./version/version.schema.js";

package/dist/project-type/project-type.schema.d.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+export declare const ProjectTypeEnum: z.ZodEnum<{
+    EXTENSION: "EXTENSION";
+    RENOVATION: "RENOVATION";
+    CONVERSION: "CONVERSION";
+    NEW_BUILD: "NEW_BUILD";
+    LANDSCAPING: "LANDSCAPING";
+}>;
+export type ProjectType = z.infer<typeof ProjectTypeEnum>;
+export declare const ProjectTypeOptions: ("EXTENSION" | "RENOVATION" | "CONVERSION" | "NEW_BUILD" | "LANDSCAPING")[];

package/dist/project-type/project-type.schema.js

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export const ProjectTypeEnum = z.enum([
+    "EXTENSION",
+    "RENOVATION",
+    "CONVERSION",
+    "NEW_BUILD",
+    "LANDSCAPING",
+]);
+export const ProjectTypeOptions = ProjectTypeEnum.options;

package/dist/quote/quote-status.schema.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+export declare const QuoteStatusEnum: z.ZodEnum<{
+    PROPOSED: "PROPOSED";
+    ACCEPTED: "ACCEPTED";
+    REJECTED: "REJECTED";
+    ONGOING: "ONGOING";
+    COMPLETED: "COMPLETED";
+    SNAGGING: "SNAGGING";
+    ARCHIVED: "ARCHIVED";
+}>;
+export declare const QuoteStatusSchema: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>, z.ZodEnum<{
+    PROPOSED: "PROPOSED";
+    ACCEPTED: "ACCEPTED";
+    REJECTED: "REJECTED";
+    ONGOING: "ONGOING";
+    COMPLETED: "COMPLETED";
+    SNAGGING: "SNAGGING";
+    ARCHIVED: "ARCHIVED";
+}>>;
+export type QuoteStatus = z.infer<typeof QuoteStatusSchema>;
+export declare const QuoteStatusOptions: ("PROPOSED" | "ACCEPTED" | "REJECTED" | "ONGOING" | "COMPLETED" | "SNAGGING" | "ARCHIVED")[];

package/dist/quote/quote-status.schema.js

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export const QuoteStatusEnum = z.enum([
+    "PROPOSED",
+    "ACCEPTED",
+    "REJECTED",
+    "ONGOING",
+    "COMPLETED",
+    "SNAGGING",
+    "ARCHIVED",
+]);
+export const QuoteStatusSchema = z
+    .string()
+    .transform((v) => v.toUpperCase())
+    .pipe(QuoteStatusEnum);
+export const QuoteStatusOptions = QuoteStatusEnum.options;

package/dist/quote/quote.schema.d.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+export declare const QuoteSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    version: z.ZodString;
+    isLatest: z.ZodBoolean;
+    subtotal: z.ZodString;
+    vat: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<5>, z.ZodLiteral<20>]>;
+    total: z.ZodString;
+    status: z.ZodEnum<{
+        PROPOSED: "PROPOSED";
+        ACCEPTED: "ACCEPTED";
+        REJECTED: "REJECTED";
+        ONGOING: "ONGOING";
+        COMPLETED: "COMPLETED";
+        SNAGGING: "SNAGGING";
+        ARCHIVED: "ARCHIVED";
+    }>;
+    notes: z.ZodString;
+    createdAt: z.ZodISODateTime;
+    estimatedStart: z.ZodOptional<z.ZodISODateTime>;
+    projectedEnd: z.ZodOptional<z.ZodISODateTime>;
+}, z.core.$strip>;
+export type Quote = z.infer<typeof QuoteSchema>;

package/dist/quote/quote.schema.js

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import { VersionSchema } from "../version/version.schema.js";
+import { QuoteStatusEnum } from "./quote-status.schema.js";
+export const QuoteSchema = z.object({
+    id: z.uuid(),
+    version: VersionSchema,
+    isLatest: z.boolean(),
+    subtotal: z.string(),
+    vat: z.union([z.literal(0), z.literal(5), z.literal(20)]),
+    total: z.string(),
+    status: QuoteStatusEnum,
+    notes: z.string(),
+    createdAt: z.iso.datetime(),
+    estimatedStart: z.iso.datetime().optional(),
+    projectedEnd: z.iso.datetime().optional(),
+});

package/dist/testimonial/create-testimonial.schema.d.ts

@@ -0,0 +1,98 @@
+import { z } from "zod";
+export declare const BaseCreateTestimonialSchema: z.ZodObject<{
+    displayName: z.ZodString;
+    location: z.ZodOptional<z.ZodString>;
+    projectTypes: z.ZodArray<z.ZodEnum<{
+        EXTENSION: "EXTENSION";
+        RENOVATION: "RENOVATION";
+        CONVERSION: "CONVERSION";
+        NEW_BUILD: "NEW_BUILD";
+        LANDSCAPING: "LANDSCAPING";
+    }>>;
+    body: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+export declare const CreateTestimonialInputSchema: z.ZodObject<{
+    displayName: z.ZodString;
+    location: z.ZodOptional<z.ZodString>;
+    projectTypes: z.ZodArray<z.ZodEnum<{
+        EXTENSION: "EXTENSION";
+        RENOVATION: "RENOVATION";
+        CONVERSION: "CONVERSION";
+        NEW_BUILD: "NEW_BUILD";
+        LANDSCAPING: "LANDSCAPING";
+    }>>;
+    body: z.ZodArray<z.ZodString>;
+    excerpt: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export declare const CreateTestimonialAdminSchema: z.ZodPipe<z.ZodObject<{
+    displayName: z.ZodString;
+    location: z.ZodOptional<z.ZodString>;
+    projectTypes: z.ZodArray<z.ZodEnum<{
+        EXTENSION: "EXTENSION";
+        RENOVATION: "RENOVATION";
+        CONVERSION: "CONVERSION";
+        NEW_BUILD: "NEW_BUILD";
+        LANDSCAPING: "LANDSCAPING";
+    }>>;
+    body: z.ZodArray<z.ZodString>;
+    excerpt: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodTransform<{
+    excerpt: string;
+    displayName: string;
+    projectTypes: ("EXTENSION" | "RENOVATION" | "CONVERSION" | "NEW_BUILD" | "LANDSCAPING")[];
+    body: string[];
+    location?: string | undefined;
+}, {
+    displayName: string;
+    projectTypes: ("EXTENSION" | "RENOVATION" | "CONVERSION" | "NEW_BUILD" | "LANDSCAPING")[];
+    body: string[];
+    location?: string | undefined;
+    excerpt?: string | undefined;
+}>>;
+export declare const CreateTestimonialUserSchema: z.ZodPipe<z.ZodObject<{
+    displayName: z.ZodString;
+    location: z.ZodOptional<z.ZodString>;
+    projectTypes: z.ZodArray<z.ZodEnum<{
+        EXTENSION: "EXTENSION";
+        RENOVATION: "RENOVATION";
+        CONVERSION: "CONVERSION";
+        NEW_BUILD: "NEW_BUILD";
+        LANDSCAPING: "LANDSCAPING";
+    }>>;
+    body: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodTransform<{
+    excerpt: string;
+    displayName: string;
+    projectTypes: ("EXTENSION" | "RENOVATION" | "CONVERSION" | "NEW_BUILD" | "LANDSCAPING")[];
+    body: string[];
+    location?: string | undefined;
+}, {
+    displayName: string;
+    projectTypes: ("EXTENSION" | "RENOVATION" | "CONVERSION" | "NEW_BUILD" | "LANDSCAPING")[];
+    body: string[];
+    location?: string | undefined;
+}>>;
+export declare const CreateTestimonialResponseSchema: z.ZodObject<{
+    testimonial: z.ZodObject<{
+        id: z.ZodNumber;
+        displayName: z.ZodString;
+        location: z.ZodNullable<z.ZodString>;
+        projectTypes: z.ZodArray<z.ZodEnum<{
+            EXTENSION: "EXTENSION";
+            RENOVATION: "RENOVATION";
+            CONVERSION: "CONVERSION";
+            NEW_BUILD: "NEW_BUILD";
+            LANDSCAPING: "LANDSCAPING";
+        }>>;
+        excerpt: z.ZodString;
+        body: z.ZodArray<z.ZodString>;
+        approved: z.ZodNullable<z.ZodBoolean>;
+        hidden: z.ZodNullable<z.ZodBoolean>;
+        imagePublicId: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type BaseCreateTestimonial = z.infer<typeof BaseCreateTestimonialSchema>;
+export type CreateTestimonialInput = z.infer<typeof CreateTestimonialInputSchema>;
+export type CreateTestimonialAdmin = z.infer<typeof CreateTestimonialAdminSchema>;
+export type CreateTestimonialUser = z.infer<typeof CreateTestimonialUserSchema>;
+export type CreateTestimonialResponse = z.infer<typeof CreateTestimonialResponseSchema>;

package/dist/testimonial/create-testimonial.schema.js

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import { ProjectTypeEnum } from "../project-type/project-type.schema.js";
+import { TestimonialSchema } from "./testimonial.schema.js";
+export const BaseCreateTestimonialSchema = z
+    .object({
+    displayName: z.string(),
+    location: z.string().optional(),
+    projectTypes: z.array(ProjectTypeEnum),
+    body: z.array(z.string().min(1)),
+})
+    .strict();
+export const CreateTestimonialInputSchema = BaseCreateTestimonialSchema.extend({
+    excerpt: z.string().optional(),
+});
+export const CreateTestimonialAdminSchema = CreateTestimonialInputSchema.transform((data) => ({
+    ...data,
+    excerpt: data.excerpt ?? data.body.join(" ").slice(0, 150),
+}));
+export const CreateTestimonialUserSchema = BaseCreateTestimonialSchema.transform((data) => ({
+    ...data,
+    excerpt: data.body.join(" ").slice(0, 150),
+}));
+export const CreateTestimonialResponseSchema = z.object({
+    testimonial: TestimonialSchema,
+});

package/dist/testimonial/get-testimonials.schema.d.ts

@@ -0,0 +1,22 @@
+import { z } from "zod";
+export declare const GetTestimonialsResponseSchema: z.ZodObject<{
+    count: z.ZodNumber;
+    testimonials: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        displayName: z.ZodString;
+        location: z.ZodNullable<z.ZodString>;
+        projectTypes: z.ZodArray<z.ZodEnum<{
+            EXTENSION: "EXTENSION";
+            RENOVATION: "RENOVATION";
+            CONVERSION: "CONVERSION";
+            NEW_BUILD: "NEW_BUILD";
+            LANDSCAPING: "LANDSCAPING";
+        }>>;
+        excerpt: z.ZodString;
+        body: z.ZodArray<z.ZodString>;
+        approved: z.ZodNullable<z.ZodBoolean>;
+        hidden: z.ZodNullable<z.ZodBoolean>;
+        imagePublicId: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type GetTestimonialsResponse = z.infer<typeof GetTestimonialsResponseSchema>;

package/dist/testimonial/get-testimonials.schema.js

@@ -0,0 +1,6 @@
+import { z } from "zod";
+import { TestimonialSchema } from "./testimonial.schema.js";
+export const GetTestimonialsResponseSchema = z.object({
+    count: z.number(),
+    testimonials: z.array(TestimonialSchema),
+});

package/dist/testimonial/testimonial.schema.d.ts

@@ -0,0 +1,19 @@
+import { z } from "zod";
+export declare const TestimonialSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    displayName: z.ZodString;
+    location: z.ZodNullable<z.ZodString>;
+    projectTypes: z.ZodArray<z.ZodEnum<{
+        EXTENSION: "EXTENSION";
+        RENOVATION: "RENOVATION";
+        CONVERSION: "CONVERSION";
+        NEW_BUILD: "NEW_BUILD";
+        LANDSCAPING: "LANDSCAPING";
+    }>>;
+    excerpt: z.ZodString;
+    body: z.ZodArray<z.ZodString>;
+    approved: z.ZodNullable<z.ZodBoolean>;
+    hidden: z.ZodNullable<z.ZodBoolean>;
+    imagePublicId: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type Testimonial = z.infer<typeof TestimonialSchema>;

package/dist/testimonial/testimonial.schema.js

@@ -0,0 +1,13 @@
+import { z } from "zod";
+import { ProjectTypeEnum } from "../project-type/project-type.schema.js";
+export const TestimonialSchema = z.object({
+    id: z.number(),
+    displayName: z.string(),
+    location: z.string().nullable(),
+    projectTypes: z.array(ProjectTypeEnum),
+    excerpt: z.string(),
+    body: z.array(z.string()),
+    approved: z.boolean().nullable(),
+    hidden: z.boolean().nullable(),
+    imagePublicId: z.string().nullable(),
+});

package/dist/version/version.schema.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+export declare const VersionSchema: z.ZodString;
+export type Version = z.infer<typeof VersionSchema>;

package/dist/version/version.schema.js

@@ -0,0 +1,2 @@
+import { z } from "zod";
+export const VersionSchema = z.string().regex(/^v0$|^v[1-9][0-9]{0,2}$/);

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@silkwebdev/gaffer-types",
+  "version": "1.0.5",
+  "description": "Shared types and Zod schemas",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SilkWebDev/gaffer-types.git"
+  },
+  "keywords": [],
+  "author": "James J. Kerr",
+  "license": "ISC",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/SilkWebDev/gaffer-types/issues"
+  },
+  "homepage": "https://github.com/SilkWebDev/gaffer-types#readme",
+  "dependencies": {
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "typescript": "^6.0.2"
+  }
+}