founder-schema 0.1.0 → 0.2.0

package/dist/limits.d.ts

@@ -0,0 +1,76 @@
+/**
+ * founder-schema — Every length, size and count limit, by name
+ *
+ * ONE PLACE FOR EVERY NUMBER a client and the server must agree on. Before this,
+ * the limits lived inline (`.max(80)`, `.max(1000)`) where nothing else could
+ * read them, so the web client re-typed each one for its counters and the
+ * backend re-typed them as Mongoose `maxlength`. Three copies of one number is
+ * how the image alt text came to be 280 here and 500 in the backend.
+ *
+ * The rule from 0.2.0: a schema uses one of these constants, a consumer imports
+ * the same constant, and nobody writes the digits again.
+ *
+ * Imports nothing, so any module here can use it without a cycle. Limits that
+ * already had a name in their own module (POST_MAX_BODY_CHARS, POLL_*,
+ * USERNAME_*, INTERESTS_*, MIN_AGE_YEARS...) stay where they are and keep their
+ * names; this file holds the ones that had none.
+ *
+ * ⚠️ Lowering a limit is a breaking change for stored data: a value that was
+ * valid when written fails the next edit. Raise freely; lower deliberately.
+ *
+ * @module founder-schema/limits
+ */
+export declare const DISPLAY_NAME_MAX = 80;
+export declare const HEADLINE_MAX = 120;
+export declare const ABOUT_MAX = 1000;
+/** Skills a member may list. Discover filters on them. */
+export declare const SKILLS_MAX = 8;
+/** Goals a member must pick at onboarding. The list itself caps the maximum. */
+export declare const GOALS_MIN = 1;
+export declare const CITY_MAX = 80;
+export declare const STATE_MAX = 80;
+export declare const COUNTRY_MAX = 80;
+export declare const VENTURE_NAME_MAX = 120;
+export declare const VENTURE_TAGLINE_MAX = 160;
+/** Team size including the founder. */
+export declare const TEAM_SIZE_MIN = 1;
+export declare const TEAM_SIZE_MAX = 100000;
+/** Earliest founding year accepted. The ceiling is "this year", read per parse. */
+export declare const FOUNDED_YEAR_MIN = 1900;
+/**
+ * Longest URL a member may TYPE. Applied by `httpUrlSchema` itself, so every
+ * member URL carries it: profile links, a venture website.
+ *
+ * ⚠ NOT applied to URLs the server reads from elsewhere (a link preview's
+ * page or image), which use `safeUrlSchema`: a 314-character CDN image URL is
+ * ordinary, and one of them would otherwise fail a whole feed page.
+ */
+export declare const LINK_URL_MAX = 300;
+/** Author-supplied image description. The backend's stored copy uses this too. */
+export declare const MEDIA_ALT_MAX = 280;
+export declare const LINK_PREVIEW_TITLE_MAX = 200;
+export declare const LINK_PREVIEW_DESCRIPTION_MAX = 500;
+/** The free-text note on a report. */
+export declare const REPORT_NOTE_MAX = 1000;
+/**
+ * Largest file accepted for upload: 10 MB.
+ *
+ * Checked on BOTH sides and for different reasons. The server refuses a bigger
+ * object when it is attached. The client checks before uploading, because a
+ * presigned PUT caps the content type but not the size, so a member on a phone
+ * connection would otherwise watch a 40 MB upload finish and then fail.
+ */
+export declare const UPLOAD_MAX_BYTES: number;
+/** Values one Discover multi-select filter may carry (`?skill=a&skill=b`). */
+export declare const DISCOVER_FILTER_VALUES_MAX = 10;
+/** Discover's free-text inputs: the name search, city and country. */
+export declare const DISCOVER_TEXT_MAX = 80;
+/** Page size bounds for every cursor-paged list. */
+export declare const PAGE_SIZE_MAX = 50;
+export declare const PAGE_SIZE_DEFAULT = 20;
+/**
+ * Members one participants lookup may name. Bounded so the lookup cannot be
+ * used to page through the directory.
+ */
+export declare const CHAT_PARTICIPANTS_MAX = 100;
+//# sourceMappingURL=limits.d.ts.map

package/dist/limits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"limits.d.ts","sourceRoot":"","sources":["../src/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;AAIpC;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,QAAmB,CAAC;AAIjD,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"}

package/dist/limits.js

@@ -0,0 +1,84 @@
+/**
+ * founder-schema — Every length, size and count limit, by name
+ *
+ * ONE PLACE FOR EVERY NUMBER a client and the server must agree on. Before this,
+ * the limits lived inline (`.max(80)`, `.max(1000)`) where nothing else could
+ * read them, so the web client re-typed each one for its counters and the
+ * backend re-typed them as Mongoose `maxlength`. Three copies of one number is
+ * how the image alt text came to be 280 here and 500 in the backend.
+ *
+ * The rule from 0.2.0: a schema uses one of these constants, a consumer imports
+ * the same constant, and nobody writes the digits again.
+ *
+ * Imports nothing, so any module here can use it without a cycle. Limits that
+ * already had a name in their own module (POST_MAX_BODY_CHARS, POLL_*,
+ * USERNAME_*, INTERESTS_*, MIN_AGE_YEARS...) stay where they are and keep their
+ * names; this file holds the ones that had none.
+ *
+ * ⚠️ Lowering a limit is a breaking change for stored data: a value that was
+ * valid when written fails the next edit. Raise freely; lower deliberately.
+ *
+ * @module founder-schema/limits
+ */
+// ─── Profile ─────────────────────────────────────────────────────────────────
+export const DISPLAY_NAME_MAX = 80;
+export const HEADLINE_MAX = 120;
+export const ABOUT_MAX = 1000;
+/** Skills a member may list. Discover filters on them. */
+export const SKILLS_MAX = 8;
+/** Goals a member must pick at onboarding. The list itself caps the maximum. */
+export const GOALS_MIN = 1;
+// ─── Location ────────────────────────────────────────────────────────────────
+export const CITY_MAX = 80;
+export const STATE_MAX = 80;
+export const COUNTRY_MAX = 80;
+// ─── Venture ─────────────────────────────────────────────────────────────────
+export const VENTURE_NAME_MAX = 120;
+export const VENTURE_TAGLINE_MAX = 160;
+/** Team size including the founder. */
+export const TEAM_SIZE_MIN = 1;
+export const TEAM_SIZE_MAX = 100_000;
+/** Earliest founding year accepted. The ceiling is "this year", read per parse. */
+export const FOUNDED_YEAR_MIN = 1900;
+// ─── Links ───────────────────────────────────────────────────────────────────
+/**
+ * Longest URL a member may TYPE. Applied by `httpUrlSchema` itself, so every
+ * member URL carries it: profile links, a venture website.
+ *
+ * ⚠ NOT applied to URLs the server reads from elsewhere (a link preview's
+ * page or image), which use `safeUrlSchema`: a 314-character CDN image URL is
+ * ordinary, and one of them would otherwise fail a whole feed page.
+ */
+export const LINK_URL_MAX = 300;
+// ─── Feed and moderation ─────────────────────────────────────────────────────
+/** Author-supplied image description. The backend's stored copy uses this too. */
+export const MEDIA_ALT_MAX = 280;
+export const LINK_PREVIEW_TITLE_MAX = 200;
+export const LINK_PREVIEW_DESCRIPTION_MAX = 500;
+/** The free-text note on a report. */
+export const REPORT_NOTE_MAX = 1000;
+// ─── Uploads ─────────────────────────────────────────────────────────────────
+/**
+ * Largest file accepted for upload: 10 MB.
+ *
+ * Checked on BOTH sides and for different reasons. The server refuses a bigger
+ * object when it is attached. The client checks before uploading, because a
+ * presigned PUT caps the content type but not the size, so a member on a phone
+ * connection would otherwise watch a 40 MB upload finish and then fail.
+ */
+export const UPLOAD_MAX_BYTES = 10 * 1024 * 1024;
+// ─── Lists and search ────────────────────────────────────────────────────────
+/** Values one Discover multi-select filter may carry (`?skill=a&skill=b`). */
+export const DISCOVER_FILTER_VALUES_MAX = 10;
+/** Discover's free-text inputs: the name search, city and country. */
+export const DISCOVER_TEXT_MAX = 80;
+/** Page size bounds for every cursor-paged list. */
+export const PAGE_SIZE_MAX = 50;
+export const PAGE_SIZE_DEFAULT = 20;
+// ─── Chat ────────────────────────────────────────────────────────────────────
+/**
+ * Members one participants lookup may name. Bounded so the lookup cannot be
+ * used to page through the directory.
+ */
+export const CHAT_PARTICIPANTS_MAX = 100;
+//# sourceMappingURL=limits.js.map

package/dist/limits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limits.js","sourceRoot":"","sources":["../src/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;AAEpC,gFAAgF;AAEhF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjD,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/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\n// ─── Uploads ─────────────────────────────────────────────────────────────────\n\n/**\n * Largest file accepted for upload: 10 MB.\n *\n * Checked on BOTH sides and for different reasons. The server refuses a bigger\n * object when it is attached. The client checks before uploading, because a\n * presigned PUT caps the content type but not the size, so a member on a phone\n * connection would otherwise watch a 40 MB upload finish and then fail.\n */\nexport const UPLOAD_MAX_BYTES = 10 * 1024 * 1024;\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"]}