founder-schema 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +44 -16
  2. package/dist/access/access.d.ts +76 -0
  3. package/dist/access/access.d.ts.map +1 -0
  4. package/dist/access/access.js +66 -0
  5. package/dist/access/access.js.map +1 -0
  6. package/dist/access/permissions.d.ts +153 -0
  7. package/dist/access/permissions.d.ts.map +1 -0
  8. package/dist/access/permissions.js +80 -0
  9. package/dist/access/permissions.js.map +1 -0
  10. package/dist/access/roles.d.ts +71 -0
  11. package/dist/access/roles.d.ts.map +1 -0
  12. package/dist/access/roles.js +72 -0
  13. package/dist/access/roles.js.map +1 -0
  14. package/dist/chat.d.ts +4 -4
  15. package/dist/chat.d.ts.map +1 -1
  16. package/dist/chat.js +7 -2
  17. package/dist/chat.js.map +1 -1
  18. package/dist/core/common.d.ts +304 -0
  19. package/dist/core/common.d.ts.map +1 -0
  20. package/dist/core/common.js +340 -0
  21. package/dist/core/common.js.map +1 -0
  22. package/dist/core/errors.d.ts +117 -0
  23. package/dist/core/errors.d.ts.map +1 -0
  24. package/dist/core/errors.js +139 -0
  25. package/dist/core/errors.js.map +1 -0
  26. package/dist/core/limits.d.ts +122 -0
  27. package/dist/core/limits.d.ts.map +1 -0
  28. package/dist/core/limits.js +132 -0
  29. package/dist/core/limits.js.map +1 -0
  30. package/dist/core/responses.d.ts +207 -0
  31. package/dist/core/responses.d.ts.map +1 -0
  32. package/dist/core/responses.js +73 -0
  33. package/dist/core/responses.js.map +1 -0
  34. package/dist/core/validation.d.ts +146 -0
  35. package/dist/core/validation.d.ts.map +1 -0
  36. package/dist/core/validation.js +152 -0
  37. package/dist/core/validation.js.map +1 -0
  38. package/dist/domains/account/account.d.ts +42 -0
  39. package/dist/domains/account/account.d.ts.map +1 -0
  40. package/dist/domains/account/account.js +41 -0
  41. package/dist/domains/account/account.js.map +1 -0
  42. package/dist/domains/audit/audit.d.ts +169 -0
  43. package/dist/domains/audit/audit.d.ts.map +1 -0
  44. package/dist/domains/audit/audit.js +84 -0
  45. package/dist/domains/audit/audit.js.map +1 -0
  46. package/dist/domains/chat/chat.d.ts +187 -0
  47. package/dist/domains/chat/chat.d.ts.map +1 -0
  48. package/dist/domains/chat/chat.js +189 -0
  49. package/dist/domains/chat/chat.js.map +1 -0
  50. package/dist/domains/dashboard/dashboard.d.ts +48 -0
  51. package/dist/domains/dashboard/dashboard.d.ts.map +1 -0
  52. package/dist/domains/dashboard/dashboard.js +58 -0
  53. package/dist/domains/dashboard/dashboard.js.map +1 -0
  54. package/dist/domains/discover/discover.d.ts +245 -0
  55. package/dist/domains/discover/discover.d.ts.map +1 -0
  56. package/dist/domains/discover/discover.js +68 -0
  57. package/dist/domains/discover/discover.js.map +1 -0
  58. package/dist/domains/feed/feed.d.ts +1695 -0
  59. package/dist/domains/feed/feed.d.ts.map +1 -0
  60. package/dist/domains/feed/feed.js +626 -0
  61. package/dist/domains/feed/feed.js.map +1 -0
  62. package/dist/domains/media/media.d.ts +134 -0
  63. package/dist/domains/media/media.d.ts.map +1 -0
  64. package/dist/domains/media/media.js +110 -0
  65. package/dist/domains/media/media.js.map +1 -0
  66. package/dist/domains/members/members.d.ts +175 -0
  67. package/dist/domains/members/members.d.ts.map +1 -0
  68. package/dist/domains/members/members.js +106 -0
  69. package/dist/domains/members/members.js.map +1 -0
  70. package/dist/domains/moderation/moderation.d.ts +184 -0
  71. package/dist/domains/moderation/moderation.d.ts.map +1 -0
  72. package/dist/domains/moderation/moderation.js +90 -0
  73. package/dist/domains/moderation/moderation.js.map +1 -0
  74. package/dist/domains/onboarding/onboarding.d.ts +1018 -0
  75. package/dist/domains/onboarding/onboarding.d.ts.map +1 -0
  76. package/dist/domains/onboarding/onboarding.js +717 -0
  77. package/dist/domains/onboarding/onboarding.js.map +1 -0
  78. package/dist/domains/profile/founder-profile.d.ts +411 -0
  79. package/dist/domains/profile/founder-profile.d.ts.map +1 -0
  80. package/dist/domains/profile/founder-profile.js +202 -0
  81. package/dist/domains/profile/founder-profile.js.map +1 -0
  82. package/dist/domains/support/support.d.ts +305 -0
  83. package/dist/domains/support/support.d.ts.map +1 -0
  84. package/dist/domains/support/support.js +129 -0
  85. package/dist/domains/support/support.js.map +1 -0
  86. package/dist/domains/team/team.d.ts +79 -0
  87. package/dist/domains/team/team.d.ts.map +1 -0
  88. package/dist/domains/team/team.js +54 -0
  89. package/dist/domains/team/team.js.map +1 -0
  90. package/dist/domains/uploads/uploads.d.ts +101 -0
  91. package/dist/domains/uploads/uploads.d.ts.map +1 -0
  92. package/dist/domains/uploads/uploads.js +89 -0
  93. package/dist/domains/uploads/uploads.js.map +1 -0
  94. package/dist/env.d.ts +85 -0
  95. package/dist/env.d.ts.map +1 -0
  96. package/dist/env.js +150 -0
  97. package/dist/env.js.map +1 -0
  98. package/dist/index.d.ts +22 -12
  99. package/dist/index.d.ts.map +1 -1
  100. package/dist/index.js +32 -19
  101. package/dist/index.js.map +1 -1
  102. package/dist/onboarding.d.ts +58 -32
  103. package/dist/onboarding.d.ts.map +1 -1
  104. package/dist/onboarding.js +155 -32
  105. package/dist/onboarding.js.map +1 -1
  106. package/package.json +14 -2
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/core/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,iBAAiB;IACjB,gFAAgF;IAChF,gBAAgB;IAChB,yEAAyE;IACzE,kBAAkB;IAClB,2EAA2E;IAC3E,WAAW;IACX,wEAAwE;IACxE,UAAU;IACV,uEAAuE;IACvE,cAAc;IACd,2EAA2E;IAC3E,qBAAqB;IAErB,oBAAoB;IACpB,4BAA4B;IAC5B,cAAc;IACd,sDAAsD;IACtD,eAAe;IACf,qEAAqE;IACrE,eAAe;IACf,oEAAoE;IACpE,qBAAqB;IACrB,6CAA6C;IAC7C,WAAW;IAEX,mBAAmB;IACnB,mFAAmF;IACnF,uBAAuB;IACvB,gFAAgF;IAChF,mBAAmB;IACnB,uEAAuE;IACvE,WAAW;IAEX,kDAAkD;IAClD;;;;;OAKG;IACH,uBAAuB;IACvB,sCAAsC;IACtC,kBAAkB;IAClB;;;OAGG;IACH,mBAAmB;IACnB,2EAA2E;IAC3E,qBAAqB;IACrB;;;;OAIG;IACH,mBAAmB;IACnB,0FAA0F;IAC1F,mBAAmB;IACnB,mEAAmE;IACnE,wBAAwB;IACxB,sEAAsE;IACtE,sBAAsB;IACtB,wFAAwF;IACxF,eAAe;IAEf,iBAAiB;IACjB,+CAA+C;IAC/C,oBAAoB;IACpB,iEAAiE;IACjE,mBAAmB;IACnB,kDAAkD;IAClD,aAAa;IACb,oFAAoF;IACpF,qBAAqB;IACrB,qDAAqD;IACrD,gBAAgB;IAChB,gDAAgD;IAChD,mBAAmB;IAEnB,aAAa;IACb,4CAA4C;IAC5C,gBAAgB;IAEhB,oBAAoB;IACpB,qFAAqF;IACrF,mBAAmB;IAEnB,2BAA2B;IAC3B;;;OAGG;IACH,eAAe;IACf,4EAA4E;IAC5E,cAAc;IACd,8DAA8D;IAC9D,kBAAkB;IAClB,4EAA4E;IAC5E,gBAAgB;IAChB,0EAA0E;IAC1E,aAAa;IACb,oDAAoD;IACpD,yBAAyB;IACzB,qEAAqE;IACrE,oBAAoB;IAEpB,gBAAgB;IAChB,uEAAuE;IACvE,aAAa;IACb,0EAA0E;IAC1E,oBAAoB;CACZ,CAAC;AAEX,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;AAGhE,4DAA4D;AAC5D,MAAM,CAAC,MAAM,cAAc,GAAG,kBAAkB,CAAC,IAAI,CAAC","sourcesContent":["/**\n * founder-schema — Every error code the API answers with\n *\n * THE CODE IS WHAT A CLIENT ACTS ON; the `message` beside it is English for\n * logs and for a client too old to know the code. A client words each code in\n * the member's language, and a test on the web side asserts every value here\n * has a message in every locale it ships.\n *\n * Before 0.2.0 the backend kept this list to itself, and every domain refusal\n * (a closed poll, a reply to a reply, the edit window) went out as\n * `VALIDATION_ERROR` with an English sentence, so the only way for a client to\n * tell them apart was to match on the wording.\n *\n * WHEN TO USE WHICH:\n * - A request that does not match its schema: `VALIDATION_ERROR`, with every\n * problem in `error.details.issues`.\n * - A well-formed request the current STATE of things refuses: its own code\n * below. These carry no issues; the code says it all.\n *\n * ⚠ Append freely; remove deliberately. A code removed here that an older\n * server still sends fails the client's parse of the error envelope.\n *\n * @module founder-schema/core/errors\n */\n\nimport { z } from 'zod';\n\n/**\n * As a tuple, the way `GENDER_VALUES` is, so a consumer can iterate it (a\n * translation-coverage test does exactly that) and TypeScript keeps the union.\n */\nexport const API_ERROR_CODE_VALUES = [\n // ── Anything ──\n /** A bug or an outage on our side. The message says nothing more on purpose. */\n 'INTERNAL_ERROR',\n /** The request did not match its schema. `details.issues` says where. */\n 'VALIDATION_ERROR',\n /** No such thing, or not one you may see. Deliberately the same answer. */\n 'NOT_FOUND',\n /** Two writes raced for something unique; retrying usually succeeds. */\n 'CONFLICT',\n /** Too many requests from this member or address. Wait, then retry. */\n 'RATE_LIMITED',\n /** Something we depend on (the chat server) is down or not switched on. */\n 'SERVICE_UNAVAILABLE',\n\n // ── Who you are ──\n /** No credential at all. */\n 'UNAUTHORIZED',\n /** A credential that is not ours, or not readable. */\n 'INVALID_TOKEN',\n /** A credential that was ours and has expired. Refresh and retry. */\n 'TOKEN_EXPIRED',\n /** Signed out everywhere, or the account changed. Sign in again. */\n 'SESSION_INVALIDATED',\n /** Signed in, and not allowed to do this. */\n 'FORBIDDEN',\n\n // ── Onboarding ──\n /** Finish onboarding first. The client routes here instead of showing an error. */\n 'ONBOARDING_INCOMPLETE',\n /** Onboarding is already finished; there is nothing to save or finish again. */\n 'ALREADY_ONBOARDED',\n /** Under `MIN_AGE_YEARS`. Refused at the draft and again at finish. */\n 'UNDER_AGE',\n\n // ── Uploads: completing one, and attaching it ──\n /**\n * Not an upload of yours, not processed yet, already attached somewhere, or\n * for the other purpose (an avatar upload on a post). One code for all of\n * them on purpose: telling \"someone else's\" apart from \"does not exist\" would\n * let a caller probe other members' media ids.\n */\n 'UPLOAD_NOT_ATTACHABLE',\n /** Larger than `UPLOAD_MAX_BYTES`. */\n 'UPLOAD_TOO_LARGE',\n /**\n * Not one of the image types this product accepts (by the file's own bytes,\n * whatever its name or declared type), or not an image at all.\n */\n 'UPLOAD_WRONG_TYPE',\n /** Completed before the file reached storage: upload it, then complete. */\n 'UPLOAD_NOT_RECEIVED',\n /**\n * Another request is processing this upload right now (a retry or a double\n * tap). Nothing is wrong: complete again in a moment and it answers with\n * the image. 409.\n */\n 'UPLOAD_PROCESSING',\n /** A JPEG, PNG, WebP or GIF by its bytes that cannot be decoded: truncated or corrupt. */\n 'UPLOAD_UNREADABLE',\n /** More than `MEDIA_MAX_INPUT_PIXELS`; refused before decoding. */\n 'UPLOAD_TOO_MANY_PIXELS',\n /** `MEDIA_PENDING_MAX` uploads are already waiting to be attached. */\n 'UPLOAD_LIMIT_REACHED',\n /** Discarding an upload that is attached: remove it from its post or avatar instead. */\n 'UPLOAD_IN_USE',\n\n // ── The feed ──\n /** The post is older than `EDIT_WINDOW_MS`. */\n 'EDIT_WINDOW_CLOSED',\n /** A poll is never editable: people have already voted on it. */\n 'POLL_NOT_EDITABLE',\n /** The poll has closed, by the server's clock. */\n 'POLL_CLOSED',\n /** No option, several on a single-choice poll, or an option that does not exist. */\n 'POLL_CHOICE_INVALID',\n /** A reply to a reply. One level of nesting only. */\n 'REPLY_TOO_DEEP',\n /** Reporting your own post, poll or comment. */\n 'CANNOT_REPORT_OWN',\n\n // ── Chat ──\n /** Opening a conversation with yourself. */\n 'CHAT_WITH_SELF',\n\n // ── The account ──\n /** Staff suspended this account: nothing in the product works until it is lifted. */\n 'ACCOUNT_SUSPENDED',\n\n // ── Roles and the MPIN ──\n /**\n * Switching to a role this person does not hold (or no longer holds), or\n * setting an MPIN while holding no staff role at all.\n */\n 'ROLE_NOT_HELD',\n /** A staff role needs an MPIN, and none has been set yet. Set one first. */\n 'MPIN_NOT_SET',\n /** An MPIN is set once; changing it needs the current one. */\n 'MPIN_ALREADY_SET',\n /** The MPIN is wrong. `details.attemptsLeft` says how many tries remain. */\n 'MPIN_INCORRECT',\n /** Too many wrong MPINs. `details.lockedUntil` says when to try again. */\n 'MPIN_LOCKED',\n /** Changing your own roles. Someone else has to. */\n 'CANNOT_CHANGE_OWN_ROLES',\n /** Granting or revoking a role the role you act as may not touch. */\n 'ROLE_NOT_GRANTABLE',\n\n // ── Support ──\n /** The ticket holds `TICKET_MESSAGES_MAX` messages. Open a new one. */\n 'TICKET_FULL',\n /** The team keeps `SAVED_REPLIES_MAX` saved replies. Delete one first. */\n 'SAVED_REPLIES_FULL',\n] as const;\n\nexport const apiErrorCodeSchema = z.enum(API_ERROR_CODE_VALUES);\nexport type ApiErrorCode = z.infer<typeof apiErrorCodeSchema>;\n\n/** The same codes by name: `API_ERROR_CODE.POLL_CLOSED`. */\nexport const API_ERROR_CODE = apiErrorCodeSchema.enum;\n"]}
@@ -0,0 +1,122 @@
1
+ /**
2
+ * founder-schema — Every length, size and count limit, by name
3
+ *
4
+ * ONE PLACE FOR EVERY NUMBER a client and the server must agree on. Before this,
5
+ * the limits lived inline (`.max(80)`, `.max(1000)`) where nothing else could
6
+ * read them, so the web client re-typed each one for its counters and the
7
+ * backend re-typed them as Mongoose `maxlength`. Three copies of one number is
8
+ * how the image alt text came to be 280 here and 500 in the backend.
9
+ *
10
+ * The rule from 0.2.0: a schema uses one of these constants, a consumer imports
11
+ * the same constant, and nobody writes the digits again.
12
+ *
13
+ * Imports nothing, so any module here can use it without a cycle. Limits that
14
+ * already had a name in their own module (POST_MAX_BODY_CHARS, POLL_*,
15
+ * USERNAME_*, INTERESTS_*, MIN_AGE_YEARS...) stay where they are and keep their
16
+ * names; this file holds the ones that had none.
17
+ *
18
+ * ⚠️ Lowering a limit is a breaking change for stored data: a value that was
19
+ * valid when written fails the next edit. Raise freely; lower deliberately.
20
+ *
21
+ * @module founder-schema/core/limits
22
+ */
23
+ export declare const DISPLAY_NAME_MAX = 80;
24
+ export declare const HEADLINE_MAX = 120;
25
+ export declare const ABOUT_MAX = 1000;
26
+ /** Skills a member may list. Discover filters on them. */
27
+ export declare const SKILLS_MAX = 8;
28
+ /** Goals a member must pick at onboarding. The list itself caps the maximum. */
29
+ export declare const GOALS_MIN = 1;
30
+ export declare const CITY_MAX = 80;
31
+ export declare const STATE_MAX = 80;
32
+ export declare const COUNTRY_MAX = 80;
33
+ export declare const VENTURE_NAME_MAX = 120;
34
+ export declare const VENTURE_TAGLINE_MAX = 160;
35
+ /** Team size including the founder. */
36
+ export declare const TEAM_SIZE_MIN = 1;
37
+ export declare const TEAM_SIZE_MAX = 100000;
38
+ /** Earliest founding year accepted. The ceiling is "this year", read per parse. */
39
+ export declare const FOUNDED_YEAR_MIN = 1900;
40
+ /**
41
+ * Longest URL a member may TYPE. Applied by `httpUrlSchema` itself, so every
42
+ * member URL carries it: profile links, a venture website.
43
+ *
44
+ * ⚠ NOT applied to URLs the server reads from elsewhere (a link preview's
45
+ * page or image), which use `safeUrlSchema`: a 314-character CDN image URL is
46
+ * ordinary, and one of them would otherwise fail a whole feed page.
47
+ */
48
+ export declare const LINK_URL_MAX = 300;
49
+ /** Author-supplied image description. The backend's stored copy uses this too. */
50
+ export declare const MEDIA_ALT_MAX = 280;
51
+ export declare const LINK_PREVIEW_TITLE_MAX = 200;
52
+ export declare const LINK_PREVIEW_DESCRIPTION_MAX = 500;
53
+ /** The free-text note on a report. */
54
+ export declare const REPORT_NOTE_MAX = 1000;
55
+ /** A moderator's note on a decision (why it was hidden, removed or dismissed). */
56
+ export declare const MODERATION_NOTE_MAX = 500;
57
+ /** What a post, poll or comment is shown as in a staff list: its first words. */
58
+ export declare const MODERATION_EXCERPT_MAX = 160;
59
+ /** Why a member was suspended. Shown to staff, and on record in the audit log. */
60
+ export declare const SUSPENSION_REASON_MIN = 3;
61
+ export declare const SUSPENSION_REASON_MAX = 500;
62
+ /** The staff member directory's search box (a name, a handle or an email). */
63
+ export declare const MEMBER_SEARCH_MAX = 120;
64
+ export declare const TICKET_SUBJECT_MIN = 3;
65
+ export declare const TICKET_SUBJECT_MAX = 120;
66
+ /** One message in a ticket, the member's or an agent's. */
67
+ export declare const TICKET_MESSAGE_MAX = 4000;
68
+ /**
69
+ * Messages one ticket may hold. A conversation that long is a new problem, so
70
+ * the member is asked to open a new ticket rather than the thread growing
71
+ * without bound.
72
+ */
73
+ export declare const TICKET_MESSAGES_MAX = 200;
74
+ export declare const SAVED_REPLY_TITLE_MAX = 80;
75
+ export declare const SAVED_REPLY_BODY_MAX = 4000;
76
+ /** Saved replies kept in all: a team's library, not an archive. */
77
+ export declare const SAVED_REPLIES_MAX = 200;
78
+ /**
79
+ * Largest file accepted for upload: 10 MB.
80
+ *
81
+ * Enforced three times. The upload-slot body refuses a bigger `contentLength`;
82
+ * the size is SIGNED INTO the upload URL, so storage refuses a body of any other
83
+ * size; and the server checks the stored object again before processing it.
84
+ * The client checks first only to fail fast: it shrinks a photo well below this
85
+ * before uploading (see `MEDIA_SIZES`), so a member rarely meets the limit.
86
+ */
87
+ export declare const UPLOAD_MAX_BYTES: number;
88
+ /**
89
+ * Largest image, in pixels, the server will decode: 50 megapixels, one frame.
90
+ *
91
+ * Bytes do not bound memory. A 50,000 x 50,000 PNG of one colour compresses to
92
+ * a few kilobytes and decodes to ten gigabytes. The server reads the dimensions
93
+ * first and refuses anything above this before decoding (`UPLOAD_TOO_MANY_PIXELS`).
94
+ * 50 MP admits every phone camera's full-resolution photo up to 48 MP.
95
+ */
96
+ export declare const MEDIA_MAX_INPUT_PIXELS = 50000000;
97
+ /**
98
+ * Hours an upload may wait to be attached to a post or set as an avatar. After
99
+ * that the server deletes it: the composer was abandoned, or the tab closed.
100
+ */
101
+ export declare const MEDIA_UNATTACHED_TTL_HOURS = 24;
102
+ /**
103
+ * Uploads one member may have waiting (requested or processed, not yet
104
+ * attached) at once. A full post is `POST_MAX_MEDIA` (10); this leaves room for
105
+ * a retry or two without letting one account fill storage.
106
+ */
107
+ export declare const MEDIA_PENDING_MAX = 30;
108
+ /** Longest placeholder string: a base64 ThumbHash is about 30 characters. */
109
+ export declare const MEDIA_PLACEHOLDER_MAX = 100;
110
+ /** Values one Discover multi-select filter may carry (`?skill=a&skill=b`). */
111
+ export declare const DISCOVER_FILTER_VALUES_MAX = 10;
112
+ /** Discover's free-text inputs: the name search, city and country. */
113
+ export declare const DISCOVER_TEXT_MAX = 80;
114
+ /** Page size bounds for every cursor-paged list. */
115
+ export declare const PAGE_SIZE_MAX = 50;
116
+ export declare const PAGE_SIZE_DEFAULT = 20;
117
+ /**
118
+ * Members one participants lookup may name. Bounded so the lookup cannot be
119
+ * used to page through the directory.
120
+ */
121
+ export declare const CHAT_PARTICIPANTS_MAX = 100;
122
+ //# sourceMappingURL=limits.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"limits.d.ts","sourceRoot":"","sources":["../../src/core/limits.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAIH,eAAO,MAAM,gBAAgB,KAAK,CAAC;AACnC,eAAO,MAAM,YAAY,MAAM,CAAC;AAChC,eAAO,MAAM,SAAS,OAAO,CAAC;AAC9B,0DAA0D;AAC1D,eAAO,MAAM,UAAU,IAAI,CAAC;AAC5B,gFAAgF;AAChF,eAAO,MAAM,SAAS,IAAI,CAAC;AAI3B,eAAO,MAAM,QAAQ,KAAK,CAAC;AAC3B,eAAO,MAAM,SAAS,KAAK,CAAC;AAC5B,eAAO,MAAM,WAAW,KAAK,CAAC;AAI9B,eAAO,MAAM,gBAAgB,MAAM,CAAC;AACpC,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,uCAAuC;AACvC,eAAO,MAAM,aAAa,IAAI,CAAC;AAC/B,eAAO,MAAM,aAAa,SAAU,CAAC;AACrC,mFAAmF;AACnF,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAIrC;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,MAAM,CAAC;AAIhC,kFAAkF;AAClF,eAAO,MAAM,aAAa,MAAM,CAAC;AACjC,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAC1C,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAChD,sCAAsC;AACtC,eAAO,MAAM,eAAe,OAAO,CAAC;AACpC,kFAAkF;AAClF,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,iFAAiF;AACjF,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAI1C,kFAAkF;AAClF,eAAO,MAAM,qBAAqB,IAAI,CAAC;AACvC,eAAO,MAAM,qBAAqB,MAAM,CAAC;AACzC,8EAA8E;AAC9E,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAIrC,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC,eAAO,MAAM,kBAAkB,MAAM,CAAC;AACtC,2DAA2D;AAC3D,eAAO,MAAM,kBAAkB,OAAO,CAAC;AACvC;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,qBAAqB,KAAK,CAAC;AACxC,eAAO,MAAM,oBAAoB,OAAO,CAAC;AACzC,mEAAmE;AACnE,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAIrC;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,QAAmB,CAAC;AAEjD;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,WAAa,CAAC;AAEjD;;;GAGG;AACH,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAE7C;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,6EAA6E;AAC7E,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAIzC,8EAA8E;AAC9E,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAC7C,sEAAsE;AACtE,eAAO,MAAM,iBAAiB,KAAK,CAAC;AACpC,oDAAoD;AACpD,eAAO,MAAM,aAAa,KAAK,CAAC;AAChC,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAIpC;;;GAGG;AACH,eAAO,MAAM,qBAAqB,MAAM,CAAC"}
@@ -0,0 +1,132 @@
1
+ /**
2
+ * founder-schema — Every length, size and count limit, by name
3
+ *
4
+ * ONE PLACE FOR EVERY NUMBER a client and the server must agree on. Before this,
5
+ * the limits lived inline (`.max(80)`, `.max(1000)`) where nothing else could
6
+ * read them, so the web client re-typed each one for its counters and the
7
+ * backend re-typed them as Mongoose `maxlength`. Three copies of one number is
8
+ * how the image alt text came to be 280 here and 500 in the backend.
9
+ *
10
+ * The rule from 0.2.0: a schema uses one of these constants, a consumer imports
11
+ * the same constant, and nobody writes the digits again.
12
+ *
13
+ * Imports nothing, so any module here can use it without a cycle. Limits that
14
+ * already had a name in their own module (POST_MAX_BODY_CHARS, POLL_*,
15
+ * USERNAME_*, INTERESTS_*, MIN_AGE_YEARS...) stay where they are and keep their
16
+ * names; this file holds the ones that had none.
17
+ *
18
+ * ⚠️ Lowering a limit is a breaking change for stored data: a value that was
19
+ * valid when written fails the next edit. Raise freely; lower deliberately.
20
+ *
21
+ * @module founder-schema/core/limits
22
+ */
23
+ // ─── Profile ─────────────────────────────────────────────────────────────────
24
+ export const DISPLAY_NAME_MAX = 80;
25
+ export const HEADLINE_MAX = 120;
26
+ export const ABOUT_MAX = 1000;
27
+ /** Skills a member may list. Discover filters on them. */
28
+ export const SKILLS_MAX = 8;
29
+ /** Goals a member must pick at onboarding. The list itself caps the maximum. */
30
+ export const GOALS_MIN = 1;
31
+ // ─── Location ────────────────────────────────────────────────────────────────
32
+ export const CITY_MAX = 80;
33
+ export const STATE_MAX = 80;
34
+ export const COUNTRY_MAX = 80;
35
+ // ─── Venture ─────────────────────────────────────────────────────────────────
36
+ export const VENTURE_NAME_MAX = 120;
37
+ export const VENTURE_TAGLINE_MAX = 160;
38
+ /** Team size including the founder. */
39
+ export const TEAM_SIZE_MIN = 1;
40
+ export const TEAM_SIZE_MAX = 100_000;
41
+ /** Earliest founding year accepted. The ceiling is "this year", read per parse. */
42
+ export const FOUNDED_YEAR_MIN = 1900;
43
+ // ─── Links ───────────────────────────────────────────────────────────────────
44
+ /**
45
+ * Longest URL a member may TYPE. Applied by `httpUrlSchema` itself, so every
46
+ * member URL carries it: profile links, a venture website.
47
+ *
48
+ * ⚠ NOT applied to URLs the server reads from elsewhere (a link preview's
49
+ * page or image), which use `safeUrlSchema`: a 314-character CDN image URL is
50
+ * ordinary, and one of them would otherwise fail a whole feed page.
51
+ */
52
+ export const LINK_URL_MAX = 300;
53
+ // ─── Feed and moderation ─────────────────────────────────────────────────────
54
+ /** Author-supplied image description. The backend's stored copy uses this too. */
55
+ export const MEDIA_ALT_MAX = 280;
56
+ export const LINK_PREVIEW_TITLE_MAX = 200;
57
+ export const LINK_PREVIEW_DESCRIPTION_MAX = 500;
58
+ /** The free-text note on a report. */
59
+ export const REPORT_NOTE_MAX = 1000;
60
+ /** A moderator's note on a decision (why it was hidden, removed or dismissed). */
61
+ export const MODERATION_NOTE_MAX = 500;
62
+ /** What a post, poll or comment is shown as in a staff list: its first words. */
63
+ export const MODERATION_EXCERPT_MAX = 160;
64
+ // ─── Staff ───────────────────────────────────────────────────────────────────
65
+ /** Why a member was suspended. Shown to staff, and on record in the audit log. */
66
+ export const SUSPENSION_REASON_MIN = 3;
67
+ export const SUSPENSION_REASON_MAX = 500;
68
+ /** The staff member directory's search box (a name, a handle or an email). */
69
+ export const MEMBER_SEARCH_MAX = 120;
70
+ // ─── Support ─────────────────────────────────────────────────────────────────
71
+ export const TICKET_SUBJECT_MIN = 3;
72
+ export const TICKET_SUBJECT_MAX = 120;
73
+ /** One message in a ticket, the member's or an agent's. */
74
+ export const TICKET_MESSAGE_MAX = 4000;
75
+ /**
76
+ * Messages one ticket may hold. A conversation that long is a new problem, so
77
+ * the member is asked to open a new ticket rather than the thread growing
78
+ * without bound.
79
+ */
80
+ export const TICKET_MESSAGES_MAX = 200;
81
+ export const SAVED_REPLY_TITLE_MAX = 80;
82
+ export const SAVED_REPLY_BODY_MAX = 4000;
83
+ /** Saved replies kept in all: a team's library, not an archive. */
84
+ export const SAVED_REPLIES_MAX = 200;
85
+ // ─── Uploads ─────────────────────────────────────────────────────────────────
86
+ /**
87
+ * Largest file accepted for upload: 10 MB.
88
+ *
89
+ * Enforced three times. The upload-slot body refuses a bigger `contentLength`;
90
+ * the size is SIGNED INTO the upload URL, so storage refuses a body of any other
91
+ * size; and the server checks the stored object again before processing it.
92
+ * The client checks first only to fail fast: it shrinks a photo well below this
93
+ * before uploading (see `MEDIA_SIZES`), so a member rarely meets the limit.
94
+ */
95
+ export const UPLOAD_MAX_BYTES = 10 * 1024 * 1024;
96
+ /**
97
+ * Largest image, in pixels, the server will decode: 50 megapixels, one frame.
98
+ *
99
+ * Bytes do not bound memory. A 50,000 x 50,000 PNG of one colour compresses to
100
+ * a few kilobytes and decodes to ten gigabytes. The server reads the dimensions
101
+ * first and refuses anything above this before decoding (`UPLOAD_TOO_MANY_PIXELS`).
102
+ * 50 MP admits every phone camera's full-resolution photo up to 48 MP.
103
+ */
104
+ export const MEDIA_MAX_INPUT_PIXELS = 50_000_000;
105
+ /**
106
+ * Hours an upload may wait to be attached to a post or set as an avatar. After
107
+ * that the server deletes it: the composer was abandoned, or the tab closed.
108
+ */
109
+ export const MEDIA_UNATTACHED_TTL_HOURS = 24;
110
+ /**
111
+ * Uploads one member may have waiting (requested or processed, not yet
112
+ * attached) at once. A full post is `POST_MAX_MEDIA` (10); this leaves room for
113
+ * a retry or two without letting one account fill storage.
114
+ */
115
+ export const MEDIA_PENDING_MAX = 30;
116
+ /** Longest placeholder string: a base64 ThumbHash is about 30 characters. */
117
+ export const MEDIA_PLACEHOLDER_MAX = 100;
118
+ // ─── Lists and search ────────────────────────────────────────────────────────
119
+ /** Values one Discover multi-select filter may carry (`?skill=a&skill=b`). */
120
+ export const DISCOVER_FILTER_VALUES_MAX = 10;
121
+ /** Discover's free-text inputs: the name search, city and country. */
122
+ export const DISCOVER_TEXT_MAX = 80;
123
+ /** Page size bounds for every cursor-paged list. */
124
+ export const PAGE_SIZE_MAX = 50;
125
+ export const PAGE_SIZE_DEFAULT = 20;
126
+ // ─── Chat ────────────────────────────────────────────────────────────────────
127
+ /**
128
+ * Members one participants lookup may name. Bounded so the lookup cannot be
129
+ * used to page through the directory.
130
+ */
131
+ export const CHAT_PARTICIPANTS_MAX = 100;
132
+ //# sourceMappingURL=limits.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"limits.js","sourceRoot":"","sources":["../../src/core/limits.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,gFAAgF;AAEhF,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAC;AACnC,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC;AAChC,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC;AAC9B,0DAA0D;AAC1D,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC;AAC5B,gFAAgF;AAChF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC;AAE3B,gFAAgF;AAEhF,MAAM,CAAC,MAAM,QAAQ,GAAG,EAAE,CAAC;AAC3B,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAC;AAC5B,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,CAAC;AAE9B,gFAAgF;AAEhF,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AACpC,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AACvC,uCAAuC;AACvC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAC/B,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC;AACrC,mFAAmF;AACnF,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAErC,gFAAgF;AAEhF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC;AAEhC,gFAAgF;AAEhF,kFAAkF;AAClF,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,CAAC;AACjC,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAC1C,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAG,CAAC;AAChD,sCAAsC;AACtC,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC;AACpC,kFAAkF;AAClF,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AACvC,iFAAiF;AACjF,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C,gFAAgF;AAEhF,kFAAkF;AAClF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC;AACvC,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AACzC,8EAA8E;AAC9E,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAErC,gFAAgF;AAEhF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AACpC,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAG,CAAC;AACtC,2DAA2D;AAC3D,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AACvC,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACxC,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAC;AACzC,mEAAmE;AACnE,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAErC,gFAAgF;AAEhF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAC;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAE7C;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC,6EAA6E;AAC7E,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAEzC,gFAAgF;AAEhF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAC7C,sEAAsE;AACtE,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AACpC,oDAAoD;AACpD,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC;AAChC,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC","sourcesContent":["/**\n * founder-schema — Every length, size and count limit, by name\n *\n * ONE PLACE FOR EVERY NUMBER a client and the server must agree on. Before this,\n * the limits lived inline (`.max(80)`, `.max(1000)`) where nothing else could\n * read them, so the web client re-typed each one for its counters and the\n * backend re-typed them as Mongoose `maxlength`. Three copies of one number is\n * how the image alt text came to be 280 here and 500 in the backend.\n *\n * The rule from 0.2.0: a schema uses one of these constants, a consumer imports\n * the same constant, and nobody writes the digits again.\n *\n * Imports nothing, so any module here can use it without a cycle. Limits that\n * already had a name in their own module (POST_MAX_BODY_CHARS, POLL_*,\n * USERNAME_*, INTERESTS_*, MIN_AGE_YEARS...) stay where they are and keep their\n * names; this file holds the ones that had none.\n *\n * ⚠️ Lowering a limit is a breaking change for stored data: a value that was\n * valid when written fails the next edit. Raise freely; lower deliberately.\n *\n * @module founder-schema/core/limits\n */\n\n// ─── Profile ─────────────────────────────────────────────────────────────────\n\nexport const DISPLAY_NAME_MAX = 80;\nexport const HEADLINE_MAX = 120;\nexport const ABOUT_MAX = 1000;\n/** Skills a member may list. Discover filters on them. */\nexport const SKILLS_MAX = 8;\n/** Goals a member must pick at onboarding. The list itself caps the maximum. */\nexport const GOALS_MIN = 1;\n\n// ─── Location ────────────────────────────────────────────────────────────────\n\nexport const CITY_MAX = 80;\nexport const STATE_MAX = 80;\nexport const COUNTRY_MAX = 80;\n\n// ─── Venture ─────────────────────────────────────────────────────────────────\n\nexport const VENTURE_NAME_MAX = 120;\nexport const VENTURE_TAGLINE_MAX = 160;\n/** Team size including the founder. */\nexport const TEAM_SIZE_MIN = 1;\nexport const TEAM_SIZE_MAX = 100_000;\n/** Earliest founding year accepted. The ceiling is \"this year\", read per parse. */\nexport const FOUNDED_YEAR_MIN = 1900;\n\n// ─── Links ───────────────────────────────────────────────────────────────────\n\n/**\n * Longest URL a member may TYPE. Applied by `httpUrlSchema` itself, so every\n * member URL carries it: profile links, a venture website.\n *\n * ⚠ NOT applied to URLs the server reads from elsewhere (a link preview's\n * page or image), which use `safeUrlSchema`: a 314-character CDN image URL is\n * ordinary, and one of them would otherwise fail a whole feed page.\n */\nexport const LINK_URL_MAX = 300;\n\n// ─── Feed and moderation ─────────────────────────────────────────────────────\n\n/** Author-supplied image description. The backend's stored copy uses this too. */\nexport const MEDIA_ALT_MAX = 280;\nexport const LINK_PREVIEW_TITLE_MAX = 200;\nexport const LINK_PREVIEW_DESCRIPTION_MAX = 500;\n/** The free-text note on a report. */\nexport const REPORT_NOTE_MAX = 1000;\n/** A moderator's note on a decision (why it was hidden, removed or dismissed). */\nexport const MODERATION_NOTE_MAX = 500;\n/** What a post, poll or comment is shown as in a staff list: its first words. */\nexport const MODERATION_EXCERPT_MAX = 160;\n\n// ─── Staff ───────────────────────────────────────────────────────────────────\n\n/** Why a member was suspended. Shown to staff, and on record in the audit log. */\nexport const SUSPENSION_REASON_MIN = 3;\nexport const SUSPENSION_REASON_MAX = 500;\n/** The staff member directory's search box (a name, a handle or an email). */\nexport const MEMBER_SEARCH_MAX = 120;\n\n// ─── Support ─────────────────────────────────────────────────────────────────\n\nexport const TICKET_SUBJECT_MIN = 3;\nexport const TICKET_SUBJECT_MAX = 120;\n/** One message in a ticket, the member's or an agent's. */\nexport const TICKET_MESSAGE_MAX = 4000;\n/**\n * Messages one ticket may hold. A conversation that long is a new problem, so\n * the member is asked to open a new ticket rather than the thread growing\n * without bound.\n */\nexport const TICKET_MESSAGES_MAX = 200;\nexport const SAVED_REPLY_TITLE_MAX = 80;\nexport const SAVED_REPLY_BODY_MAX = 4000;\n/** Saved replies kept in all: a team's library, not an archive. */\nexport const SAVED_REPLIES_MAX = 200;\n\n// ─── Uploads ─────────────────────────────────────────────────────────────────\n\n/**\n * Largest file accepted for upload: 10 MB.\n *\n * Enforced three times. The upload-slot body refuses a bigger `contentLength`;\n * the size is SIGNED INTO the upload URL, so storage refuses a body of any other\n * size; and the server checks the stored object again before processing it.\n * The client checks first only to fail fast: it shrinks a photo well below this\n * before uploading (see `MEDIA_SIZES`), so a member rarely meets the limit.\n */\nexport const UPLOAD_MAX_BYTES = 10 * 1024 * 1024;\n\n/**\n * Largest image, in pixels, the server will decode: 50 megapixels, one frame.\n *\n * Bytes do not bound memory. A 50,000 x 50,000 PNG of one colour compresses to\n * a few kilobytes and decodes to ten gigabytes. The server reads the dimensions\n * first and refuses anything above this before decoding (`UPLOAD_TOO_MANY_PIXELS`).\n * 50 MP admits every phone camera's full-resolution photo up to 48 MP.\n */\nexport const MEDIA_MAX_INPUT_PIXELS = 50_000_000;\n\n/**\n * Hours an upload may wait to be attached to a post or set as an avatar. After\n * that the server deletes it: the composer was abandoned, or the tab closed.\n */\nexport const MEDIA_UNATTACHED_TTL_HOURS = 24;\n\n/**\n * Uploads one member may have waiting (requested or processed, not yet\n * attached) at once. A full post is `POST_MAX_MEDIA` (10); this leaves room for\n * a retry or two without letting one account fill storage.\n */\nexport const MEDIA_PENDING_MAX = 30;\n\n/** Longest placeholder string: a base64 ThumbHash is about 30 characters. */\nexport const MEDIA_PLACEHOLDER_MAX = 100;\n\n// ─── Lists and search ────────────────────────────────────────────────────────\n\n/** Values one Discover multi-select filter may carry (`?skill=a&skill=b`). */\nexport const DISCOVER_FILTER_VALUES_MAX = 10;\n/** Discover's free-text inputs: the name search, city and country. */\nexport const DISCOVER_TEXT_MAX = 80;\n/** Page size bounds for every cursor-paged list. */\nexport const PAGE_SIZE_MAX = 50;\nexport const PAGE_SIZE_DEFAULT = 20;\n\n// ─── Chat ────────────────────────────────────────────────────────────────────\n\n/**\n * Members one participants lookup may name. Bounded so the lookup cannot be\n * used to page through the directory.\n */\nexport const CHAT_PARTICIPANTS_MAX = 100;\n"]}
@@ -0,0 +1,207 @@
1
+ /**
2
+ * founder-schema — API response envelope
3
+ *
4
+ * Every Founder Circle endpoint answers in this shape. The clients read the
5
+ * failure reason at `error.message`, so a handler must never return a bare
6
+ * string body.
7
+ *
8
+ * @module founder-schema/core/responses
9
+ */
10
+ import { z } from 'zod';
11
+ /**
12
+ * What an error carries beyond its code, each field named by the code that
13
+ * sends it. Declared here, not loosely typed, because a client parses errors
14
+ * with this schema and Zod drops a key the schema does not name.
15
+ *
16
+ * `issues` is EVERY problem of a 400, each with its path, built on the server
17
+ * by `toValidationIssues`. Until 0.2.0 this was typed as a record of strings
18
+ * that nothing ever sent, while the real 400s carried only the first issue's
19
+ * message, so a client could not tell which field to mark.
20
+ */
21
+ export declare const apiErrorDetailsSchema: z.ZodObject<{
22
+ issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
23
+ location: z.ZodOptional<z.ZodEnum<{
24
+ params: "params";
25
+ body: "body";
26
+ query: "query";
27
+ }>>;
28
+ path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
29
+ code: z.ZodString;
30
+ message: z.ZodString;
31
+ minimum: z.ZodOptional<z.ZodNumber>;
32
+ maximum: z.ZodOptional<z.ZodNumber>;
33
+ origin: z.ZodOptional<z.ZodString>;
34
+ format: z.ZodOptional<z.ZodString>;
35
+ }, z.core.$strip>>>;
36
+ attemptsLeft: z.ZodOptional<z.ZodNumber>;
37
+ lockedUntil: z.ZodOptional<z.ZodISODateTime>;
38
+ }, z.core.$strip>;
39
+ export type ApiErrorDetails = z.infer<typeof apiErrorDetailsSchema>;
40
+ /**
41
+ * `code` is one of `API_ERROR_CODE_VALUES`, and it is what a client acts on.
42
+ * `message` is English, for logs and for a client that predates the code.
43
+ */
44
+ export declare const apiErrorSchema: z.ZodObject<{
45
+ code: z.ZodEnum<{
46
+ INTERNAL_ERROR: "INTERNAL_ERROR";
47
+ VALIDATION_ERROR: "VALIDATION_ERROR";
48
+ NOT_FOUND: "NOT_FOUND";
49
+ CONFLICT: "CONFLICT";
50
+ RATE_LIMITED: "RATE_LIMITED";
51
+ SERVICE_UNAVAILABLE: "SERVICE_UNAVAILABLE";
52
+ UNAUTHORIZED: "UNAUTHORIZED";
53
+ INVALID_TOKEN: "INVALID_TOKEN";
54
+ TOKEN_EXPIRED: "TOKEN_EXPIRED";
55
+ SESSION_INVALIDATED: "SESSION_INVALIDATED";
56
+ FORBIDDEN: "FORBIDDEN";
57
+ ONBOARDING_INCOMPLETE: "ONBOARDING_INCOMPLETE";
58
+ ALREADY_ONBOARDED: "ALREADY_ONBOARDED";
59
+ UNDER_AGE: "UNDER_AGE";
60
+ UPLOAD_NOT_ATTACHABLE: "UPLOAD_NOT_ATTACHABLE";
61
+ UPLOAD_TOO_LARGE: "UPLOAD_TOO_LARGE";
62
+ UPLOAD_WRONG_TYPE: "UPLOAD_WRONG_TYPE";
63
+ UPLOAD_NOT_RECEIVED: "UPLOAD_NOT_RECEIVED";
64
+ UPLOAD_PROCESSING: "UPLOAD_PROCESSING";
65
+ UPLOAD_UNREADABLE: "UPLOAD_UNREADABLE";
66
+ UPLOAD_TOO_MANY_PIXELS: "UPLOAD_TOO_MANY_PIXELS";
67
+ UPLOAD_LIMIT_REACHED: "UPLOAD_LIMIT_REACHED";
68
+ UPLOAD_IN_USE: "UPLOAD_IN_USE";
69
+ EDIT_WINDOW_CLOSED: "EDIT_WINDOW_CLOSED";
70
+ POLL_NOT_EDITABLE: "POLL_NOT_EDITABLE";
71
+ POLL_CLOSED: "POLL_CLOSED";
72
+ POLL_CHOICE_INVALID: "POLL_CHOICE_INVALID";
73
+ REPLY_TOO_DEEP: "REPLY_TOO_DEEP";
74
+ CANNOT_REPORT_OWN: "CANNOT_REPORT_OWN";
75
+ CHAT_WITH_SELF: "CHAT_WITH_SELF";
76
+ ACCOUNT_SUSPENDED: "ACCOUNT_SUSPENDED";
77
+ ROLE_NOT_HELD: "ROLE_NOT_HELD";
78
+ MPIN_NOT_SET: "MPIN_NOT_SET";
79
+ MPIN_ALREADY_SET: "MPIN_ALREADY_SET";
80
+ MPIN_INCORRECT: "MPIN_INCORRECT";
81
+ MPIN_LOCKED: "MPIN_LOCKED";
82
+ CANNOT_CHANGE_OWN_ROLES: "CANNOT_CHANGE_OWN_ROLES";
83
+ ROLE_NOT_GRANTABLE: "ROLE_NOT_GRANTABLE";
84
+ TICKET_FULL: "TICKET_FULL";
85
+ SAVED_REPLIES_FULL: "SAVED_REPLIES_FULL";
86
+ }>;
87
+ message: z.ZodString;
88
+ details: z.ZodOptional<z.ZodObject<{
89
+ issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
90
+ location: z.ZodOptional<z.ZodEnum<{
91
+ params: "params";
92
+ body: "body";
93
+ query: "query";
94
+ }>>;
95
+ path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
96
+ code: z.ZodString;
97
+ message: z.ZodString;
98
+ minimum: z.ZodOptional<z.ZodNumber>;
99
+ maximum: z.ZodOptional<z.ZodNumber>;
100
+ origin: z.ZodOptional<z.ZodString>;
101
+ format: z.ZodOptional<z.ZodString>;
102
+ }, z.core.$strip>>>;
103
+ attemptsLeft: z.ZodOptional<z.ZodNumber>;
104
+ lockedUntil: z.ZodOptional<z.ZodISODateTime>;
105
+ }, z.core.$strip>>;
106
+ }, z.core.$strip>;
107
+ export type ApiError = z.infer<typeof apiErrorSchema>;
108
+ /** Success envelope. `T` is the payload schema. */
109
+ export declare const successResponseSchema: <T extends z.ZodType>(data: T) => z.ZodObject<{
110
+ success: z.ZodLiteral<true>;
111
+ data: T;
112
+ message: z.ZodOptional<z.ZodString>;
113
+ }, z.core.$strip>;
114
+ export declare const errorResponseSchema: z.ZodObject<{
115
+ success: z.ZodLiteral<false>;
116
+ error: z.ZodObject<{
117
+ code: z.ZodEnum<{
118
+ INTERNAL_ERROR: "INTERNAL_ERROR";
119
+ VALIDATION_ERROR: "VALIDATION_ERROR";
120
+ NOT_FOUND: "NOT_FOUND";
121
+ CONFLICT: "CONFLICT";
122
+ RATE_LIMITED: "RATE_LIMITED";
123
+ SERVICE_UNAVAILABLE: "SERVICE_UNAVAILABLE";
124
+ UNAUTHORIZED: "UNAUTHORIZED";
125
+ INVALID_TOKEN: "INVALID_TOKEN";
126
+ TOKEN_EXPIRED: "TOKEN_EXPIRED";
127
+ SESSION_INVALIDATED: "SESSION_INVALIDATED";
128
+ FORBIDDEN: "FORBIDDEN";
129
+ ONBOARDING_INCOMPLETE: "ONBOARDING_INCOMPLETE";
130
+ ALREADY_ONBOARDED: "ALREADY_ONBOARDED";
131
+ UNDER_AGE: "UNDER_AGE";
132
+ UPLOAD_NOT_ATTACHABLE: "UPLOAD_NOT_ATTACHABLE";
133
+ UPLOAD_TOO_LARGE: "UPLOAD_TOO_LARGE";
134
+ UPLOAD_WRONG_TYPE: "UPLOAD_WRONG_TYPE";
135
+ UPLOAD_NOT_RECEIVED: "UPLOAD_NOT_RECEIVED";
136
+ UPLOAD_PROCESSING: "UPLOAD_PROCESSING";
137
+ UPLOAD_UNREADABLE: "UPLOAD_UNREADABLE";
138
+ UPLOAD_TOO_MANY_PIXELS: "UPLOAD_TOO_MANY_PIXELS";
139
+ UPLOAD_LIMIT_REACHED: "UPLOAD_LIMIT_REACHED";
140
+ UPLOAD_IN_USE: "UPLOAD_IN_USE";
141
+ EDIT_WINDOW_CLOSED: "EDIT_WINDOW_CLOSED";
142
+ POLL_NOT_EDITABLE: "POLL_NOT_EDITABLE";
143
+ POLL_CLOSED: "POLL_CLOSED";
144
+ POLL_CHOICE_INVALID: "POLL_CHOICE_INVALID";
145
+ REPLY_TOO_DEEP: "REPLY_TOO_DEEP";
146
+ CANNOT_REPORT_OWN: "CANNOT_REPORT_OWN";
147
+ CHAT_WITH_SELF: "CHAT_WITH_SELF";
148
+ ACCOUNT_SUSPENDED: "ACCOUNT_SUSPENDED";
149
+ ROLE_NOT_HELD: "ROLE_NOT_HELD";
150
+ MPIN_NOT_SET: "MPIN_NOT_SET";
151
+ MPIN_ALREADY_SET: "MPIN_ALREADY_SET";
152
+ MPIN_INCORRECT: "MPIN_INCORRECT";
153
+ MPIN_LOCKED: "MPIN_LOCKED";
154
+ CANNOT_CHANGE_OWN_ROLES: "CANNOT_CHANGE_OWN_ROLES";
155
+ ROLE_NOT_GRANTABLE: "ROLE_NOT_GRANTABLE";
156
+ TICKET_FULL: "TICKET_FULL";
157
+ SAVED_REPLIES_FULL: "SAVED_REPLIES_FULL";
158
+ }>;
159
+ message: z.ZodString;
160
+ details: z.ZodOptional<z.ZodObject<{
161
+ issues: z.ZodOptional<z.ZodArray<z.ZodObject<{
162
+ location: z.ZodOptional<z.ZodEnum<{
163
+ params: "params";
164
+ body: "body";
165
+ query: "query";
166
+ }>>;
167
+ path: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
168
+ code: z.ZodString;
169
+ message: z.ZodString;
170
+ minimum: z.ZodOptional<z.ZodNumber>;
171
+ maximum: z.ZodOptional<z.ZodNumber>;
172
+ origin: z.ZodOptional<z.ZodString>;
173
+ format: z.ZodOptional<z.ZodString>;
174
+ }, z.core.$strip>>>;
175
+ attemptsLeft: z.ZodOptional<z.ZodNumber>;
176
+ lockedUntil: z.ZodOptional<z.ZodISODateTime>;
177
+ }, z.core.$strip>>;
178
+ }, z.core.$strip>;
179
+ }, z.core.$strip>;
180
+ export type ErrorResponse = z.infer<typeof errorResponseSchema>;
181
+ /**
182
+ * Cursor-paginated list envelope.
183
+ *
184
+ * `nextCursor` is REQUIRED and is `null` at the end of the list. Omitting the
185
+ * key is not the same thing and does not validate: a handler must decide
186
+ * whether there is another page and say so, because "the key is missing" and
187
+ * "there are no more results" are indistinguishable to a client that has to
188
+ * choose between showing a Load more button and not showing one.
189
+ *
190
+ * An earlier version of this comment said absence and null were equivalent.
191
+ * They never were; the schema has always required the key. Corrected
192
+ * 2026-09-21, and pinned by a test.
193
+ */
194
+ export declare const paginatedSchema: <T extends z.ZodType>(item: T) => z.ZodObject<{
195
+ items: z.ZodArray<T>;
196
+ nextCursor: z.ZodNullable<z.ZodString>;
197
+ }, z.core.$strip>;
198
+ /**
199
+ * What a create, an edit or a delete answers: the id of the thing it touched.
200
+ * A client that needs the whole item reads it, so a write never ships a second
201
+ * projection of it that could drift from the read path's.
202
+ */
203
+ export declare const idResponseSchema: z.ZodObject<{
204
+ id: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
205
+ }, z.core.$strip>;
206
+ export type IdResponse = z.infer<typeof idResponseSchema>;
207
+ //# sourceMappingURL=responses.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/core/responses.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;iBAMhC,CAAC;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIzB,CAAC;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD,mDAAmD;AACnD,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC;;;;iBAK9D,CAAC;AAEL,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAG9B,CAAC;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC;;;iBAIxD,CAAC;AAEL;;;;GAIG;AACH,eAAO,MAAM,gBAAgB;;iBAAmC,CAAC;AACjE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}
@@ -0,0 +1,73 @@
1
+ /**
2
+ * founder-schema — API response envelope
3
+ *
4
+ * Every Founder Circle endpoint answers in this shape. The clients read the
5
+ * failure reason at `error.message`, so a handler must never return a bare
6
+ * string body.
7
+ *
8
+ * @module founder-schema/core/responses
9
+ */
10
+ import { z } from 'zod';
11
+ import { objectIdSchema } from './common.js';
12
+ import { apiErrorCodeSchema } from './errors.js';
13
+ import { validationIssueSchema } from './validation.js';
14
+ /**
15
+ * What an error carries beyond its code, each field named by the code that
16
+ * sends it. Declared here, not loosely typed, because a client parses errors
17
+ * with this schema and Zod drops a key the schema does not name.
18
+ *
19
+ * `issues` is EVERY problem of a 400, each with its path, built on the server
20
+ * by `toValidationIssues`. Until 0.2.0 this was typed as a record of strings
21
+ * that nothing ever sent, while the real 400s carried only the first issue's
22
+ * message, so a client could not tell which field to mark.
23
+ */
24
+ export const apiErrorDetailsSchema = z.object({
25
+ issues: z.array(validationIssueSchema).optional(),
26
+ /** `MPIN_INCORRECT`: wrong tries left before the MPIN locks. */
27
+ attemptsLeft: z.number().int().min(0).optional(),
28
+ /** `MPIN_LOCKED`: when the MPIN can be tried again. */
29
+ lockedUntil: z.iso.datetime().optional(),
30
+ });
31
+ /**
32
+ * `code` is one of `API_ERROR_CODE_VALUES`, and it is what a client acts on.
33
+ * `message` is English, for logs and for a client that predates the code.
34
+ */
35
+ export const apiErrorSchema = z.object({
36
+ code: apiErrorCodeSchema,
37
+ message: z.string(),
38
+ details: apiErrorDetailsSchema.optional(),
39
+ });
40
+ /** Success envelope. `T` is the payload schema. */
41
+ export const successResponseSchema = (data) => z.object({
42
+ success: z.literal(true),
43
+ data,
44
+ message: z.string().optional(),
45
+ });
46
+ export const errorResponseSchema = z.object({
47
+ success: z.literal(false),
48
+ error: apiErrorSchema,
49
+ });
50
+ /**
51
+ * Cursor-paginated list envelope.
52
+ *
53
+ * `nextCursor` is REQUIRED and is `null` at the end of the list. Omitting the
54
+ * key is not the same thing and does not validate: a handler must decide
55
+ * whether there is another page and say so, because "the key is missing" and
56
+ * "there are no more results" are indistinguishable to a client that has to
57
+ * choose between showing a Load more button and not showing one.
58
+ *
59
+ * An earlier version of this comment said absence and null were equivalent.
60
+ * They never were; the schema has always required the key. Corrected
61
+ * 2026-09-21, and pinned by a test.
62
+ */
63
+ export const paginatedSchema = (item) => z.object({
64
+ items: z.array(item),
65
+ nextCursor: z.string().nullable(),
66
+ });
67
+ /**
68
+ * What a create, an edit or a delete answers: the id of the thing it touched.
69
+ * A client that needs the whole item reads it, so a write never ships a second
70
+ * projection of it that could drift from the read path's.
71
+ */
72
+ export const idResponseSchema = z.object({ id: objectIdSchema });
73
+ //# sourceMappingURL=responses.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"responses.js","sourceRoot":"","sources":["../../src/core/responses.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE;IACjD,gEAAgE;IAChE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAChD,uDAAuD;IACvD,WAAW,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACzC,CAAC,CAAC;AAGH;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,IAAI,EAAE,kBAAkB;IACxB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAC1C,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;AAEL;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,cAAc,EAAE,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/core/responses\n */\n\nimport { z } from 'zod';\nimport { objectIdSchema } from './common.js';\nimport { apiErrorCodeSchema } from './errors.js';\nimport { validationIssueSchema } from './validation.js';\n\n/**\n * What an error carries beyond its code, each field named by the code that\n * sends it. Declared here, not loosely typed, because a client parses errors\n * with this schema and Zod drops a key the schema does not name.\n *\n * `issues` is EVERY problem of a 400, each with its path, built on the server\n * by `toValidationIssues`. Until 0.2.0 this was typed as a record of strings\n * that nothing ever sent, while the real 400s carried only the first issue's\n * message, so a client could not tell which field to mark.\n */\nexport const apiErrorDetailsSchema = z.object({\n issues: z.array(validationIssueSchema).optional(),\n /** `MPIN_INCORRECT`: wrong tries left before the MPIN locks. */\n attemptsLeft: z.number().int().min(0).optional(),\n /** `MPIN_LOCKED`: when the MPIN can be tried again. */\n lockedUntil: z.iso.datetime().optional(),\n});\nexport type ApiErrorDetails = z.infer<typeof apiErrorDetailsSchema>;\n\n/**\n * `code` is one of `API_ERROR_CODE_VALUES`, and it is what a client acts on.\n * `message` is English, for logs and for a client that predates the code.\n */\nexport const apiErrorSchema = z.object({\n code: apiErrorCodeSchema,\n message: z.string(),\n details: apiErrorDetailsSchema.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\n/**\n * What a create, an edit or a delete answers: the id of the thing it touched.\n * A client that needs the whole item reads it, so a write never ships a second\n * projection of it that could drift from the read path's.\n */\nexport const idResponseSchema = z.object({ id: objectIdSchema });\nexport type IdResponse = z.infer<typeof idResponseSchema>;\n"]}