founder-schema 0.1.0

package/dist/responses/common.js

@@ -0,0 +1,44 @@
+/**
+ * founder-schema — API response envelope
+ *
+ * Every Founder Circle endpoint answers in this shape. The clients read the
+ * failure reason at `error.message`, so a handler must never return a bare
+ * string body.
+ *
+ * @module founder-schema/responses/common
+ */
+import { z } from 'zod';
+export const apiErrorSchema = z.object({
+    code: z.string(),
+    message: z.string(),
+    /** Field-level problems, keyed by the path the client rendered. */
+    details: z.record(z.string(), z.array(z.string())).optional(),
+});
+/** Success envelope. `T` is the payload schema. */
+export const successResponseSchema = (data) => z.object({
+    success: z.literal(true),
+    data,
+    message: z.string().optional(),
+});
+export const errorResponseSchema = z.object({
+    success: z.literal(false),
+    error: apiErrorSchema,
+});
+/**
+ * Cursor-paginated list envelope.
+ *
+ * `nextCursor` is REQUIRED and is `null` at the end of the list. Omitting the
+ * key is not the same thing and does not validate: a handler must decide
+ * whether there is another page and say so, because "the key is missing" and
+ * "there are no more results" are indistinguishable to a client that has to
+ * choose between showing a Load more button and not showing one.
+ *
+ * An earlier version of this comment said absence and null were equivalent.
+ * They never were; the schema has always required the key. Corrected
+ * 2026-09-21, and pinned by a test.
+ */
+export const paginatedSchema = (item) => z.object({
+    items: z.array(item),
+    nextCursor: z.string().nullable(),
+});
+//# sourceMappingURL=common.js.map

package/dist/responses/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/responses/common.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,mEAAmE;IACnE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC9D,CAAC,CAAC;AAGH,mDAAmD;AACnD,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAsB,IAAO,EAAE,EAAE,CACpE,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACxB,IAAI;IACJ,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IACzB,KAAK,EAAE,cAAc;CACtB,CAAC,CAAC;AAGH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAsB,IAAO,EAAE,EAAE,CAC9D,CAAC,CAAC,MAAM,CAAC;IACP,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;IACpB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC","sourcesContent":["/**\n * founder-schema — API response envelope\n *\n * Every Founder Circle endpoint answers in this shape. The clients read the\n * failure reason at `error.message`, so a handler must never return a bare\n * string body.\n *\n * @module founder-schema/responses/common\n */\n\nimport { z } from 'zod';\n\nexport const apiErrorSchema = z.object({\n  code: z.string(),\n  message: z.string(),\n  /** Field-level problems, keyed by the path the client rendered. */\n  details: z.record(z.string(), z.array(z.string())).optional(),\n});\nexport type ApiError = z.infer<typeof apiErrorSchema>;\n\n/** Success envelope. `T` is the payload schema. */\nexport const successResponseSchema = <T extends z.ZodType>(data: T) =>\n  z.object({\n    success: z.literal(true),\n    data,\n    message: z.string().optional(),\n  });\n\nexport const errorResponseSchema = z.object({\n  success: z.literal(false),\n  error: apiErrorSchema,\n});\nexport type ErrorResponse = z.infer<typeof errorResponseSchema>;\n\n/**\n * Cursor-paginated list envelope.\n *\n * `nextCursor` is REQUIRED and is `null` at the end of the list. Omitting the\n * key is not the same thing and does not validate: a handler must decide\n * whether there is another page and say so, because \"the key is missing\" and\n * \"there are no more results\" are indistinguishable to a client that has to\n * choose between showing a Load more button and not showing one.\n *\n * An earlier version of this comment said absence and null were equivalent.\n * They never were; the schema has always required the key. Corrected\n * 2026-09-21, and pinned by a test.\n */\nexport const paginatedSchema = <T extends z.ZodType>(item: T) =>\n  z.object({\n    items: z.array(item),\n    nextCursor: z.string().nullable(),\n  });\n"]}

package/dist/responses/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * founder-schema — response barrel
+ *
+ * @module founder-schema/responses
+ */
+export { type ApiError, apiErrorSchema, type ErrorResponse, errorResponseSchema, paginatedSchema, successResponseSchema, } from './common.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/responses/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACL,KAAK,QAAQ,EACb,cAAc,EACd,KAAK,aAAa,EAClB,mBAAmB,EACnB,eAAe,EACf,qBAAqB,GACtB,MAAM,aAAa,CAAC"}

package/dist/responses/index.js

@@ -0,0 +1,7 @@
+/**
+ * founder-schema — response barrel
+ *
+ * @module founder-schema/responses
+ */
+export { apiErrorSchema, errorResponseSchema, paginatedSchema, successResponseSchema, } from './common.js';
+//# sourceMappingURL=index.js.map

package/dist/responses/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAEL,cAAc,EAEd,mBAAmB,EACnB,eAAe,EACf,qBAAqB,GACtB,MAAM,aAAa,CAAC","sourcesContent":["/**\n * founder-schema — response barrel\n *\n * @module founder-schema/responses\n */\n\nexport {\n  type ApiError,\n  apiErrorSchema,\n  type ErrorResponse,\n  errorResponseSchema,\n  paginatedSchema,\n  successResponseSchema,\n} from './common.js';\n"]}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "founder-schema",
+  "version": "0.1.0",
+  "description": "Shared Zod schemas for Founder Circle — single source of truth for API contracts, validation, and TypeScript types (backend + web client + app client).",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "type-check": "tsc --noEmit && tsc --noEmit -p tsconfig.test.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome lint .",
+    "format": "biome format --write .",
+    "check": "npm run type-check && biome check --write .",
+    "check:staged": "biome check --staged --write --no-errors-on-unmatched",
+    "prepublishOnly": "npm run build && npm run check"
+  },
+  "keywords": [
+    "zod",
+    "schema",
+    "founders",
+    "networking",
+    "typescript"
+  ],
+  "author": "Hari",
+  "license": "MIT",
+  "peerDependencies": {
+    "zod": "^4.4.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.2",
+    "@types/node": "^24.10.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.11",
+    "zod": "^4.4.3"
+  }
+}