jansathi-community-schema 0.1.0

package/dist/social.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Social graph wire shapes — follows and connections.
+ *
+ * Two distinct relationships:
+ *
+ *   Follow      — one-way, no acceptance required (Twitter / Instagram).
+ *                 The follower starts seeing the followee's posts in their
+ *                 feed regardless of geo scope. Followee is notified.
+ *
+ *   Connection  — mutual handshake (LinkedIn). Requester sends, recipient
+ *                 accepts / declines. ACCEPTED connections bypass the
+ *                 visibility-level cascade entirely: connected users
+ *                 always see each other's posts no matter the level.
+ *                 This is the "friend posts always visible" rule.
+ *
+ * The two surfaces don't overlap: a user can follow someone they're
+ * not connected with, and they can be connected without following.
+ *
+ * @module community-schema/social
+ */
+import { z } from 'zod';
+/**
+ * The viewer's state w.r.t. a target user. Returned inline on profile
+ * reads so the UI can render Follow / Connect buttons without a second
+ * request.
+ */
+export declare const viewerSocialStateSchema: z.ZodObject<{
+    following: z.ZodBoolean;
+    connectionStatus: z.ZodNullable<z.ZodEnum<{
+        pending: "pending";
+        accepted: "accepted";
+        declined: "declined";
+        blocked: "blocked";
+    }>>;
+    pendingDirection: z.ZodNullable<z.ZodEnum<{
+        sent: "sent";
+        received: "received";
+    }>>;
+}, z.core.$strip>;
+export type ViewerSocialState = z.infer<typeof viewerSocialStateSchema>;
+/**
+ * Response when the viewer toggles follow on a target user. The endpoint
+ * is `POST /api/v1/community/users/:id/follow` and is idempotent —
+ * calling twice removes the follow.
+ */
+export declare const toggleFollowResponseSchema: z.ZodObject<{
+    targetUserId: z.ZodString;
+    following: z.ZodBoolean;
+    followerCount: z.ZodNumber;
+}, z.core.$strip>;
+export type ToggleFollowResponse = z.infer<typeof toggleFollowResponseSchema>;
+/**
+ * Send a connection request. The endpoint is
+ * `POST /api/v1/community/users/:id/connect`. The body is empty — the
+ * relationship is identified by the path id + the authenticated caller.
+ */
+export declare const sendConnectionRequestResponseSchema: z.ZodObject<{
+    targetUserId: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        accepted: "accepted";
+        declined: "declined";
+        blocked: "blocked";
+    }>;
+}, z.core.$strip>;
+export type SendConnectionRequestResponse = z.infer<typeof sendConnectionRequestResponseSchema>;
+/**
+ * Body for `POST /api/v1/community/connections/:id/decision` (accept /
+ * decline / block / unblock on an existing connection record).
+ */
+export declare const connectionDecisionBodySchema: z.ZodObject<{
+    decision: z.ZodEnum<{
+        accept: "accept";
+        decline: "decline";
+        block: "block";
+        unblock: "unblock";
+        remove: "remove";
+    }>;
+}, z.core.$strip>;
+export type ConnectionDecisionBody = z.infer<typeof connectionDecisionBodySchema>;
+export declare const connectionRecordWireSchema: z.ZodObject<{
+    _id: z.ZodString;
+    otherUserId: z.ZodString;
+    status: z.ZodEnum<{
+        pending: "pending";
+        accepted: "accepted";
+        declined: "declined";
+        blocked: "blocked";
+    }>;
+    requestedByUserId: z.ZodString;
+    createdAt: z.ZodString;
+    acceptedAt: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type ConnectionRecordWire = z.infer<typeof connectionRecordWireSchema>;
+//# sourceMappingURL=social.d.ts.map

package/dist/social.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"social.d.ts","sourceRoot":"","sources":["../src/social.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;;iBAgBlC,CAAC;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;;GAIG;AACH,eAAO,MAAM,0BAA0B;;;;iBAIrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAI9E;;;;GAIG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;iBAK9C,CAAC;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,mCAAmC,CAC3C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;iBAEvC,CAAC;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,4BAA4B,CACpC,CAAC;AAEF,eAAO,MAAM,0BAA0B;;;;;;;;;;;;iBASrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}

package/dist/social.js

@@ -0,0 +1,85 @@
+/**
+ * Social graph wire shapes — follows and connections.
+ *
+ * Two distinct relationships:
+ *
+ *   Follow      — one-way, no acceptance required (Twitter / Instagram).
+ *                 The follower starts seeing the followee's posts in their
+ *                 feed regardless of geo scope. Followee is notified.
+ *
+ *   Connection  — mutual handshake (LinkedIn). Requester sends, recipient
+ *                 accepts / declines. ACCEPTED connections bypass the
+ *                 visibility-level cascade entirely: connected users
+ *                 always see each other's posts no matter the level.
+ *                 This is the "friend posts always visible" rule.
+ *
+ * The two surfaces don't overlap: a user can follow someone they're
+ * not connected with, and they can be connected without following.
+ *
+ * @module community-schema/social
+ */
+import { z } from 'zod';
+import { connectionStatusSchema } from './enums.js';
+// ─── Follow ─────────────────────────────────────────────────────────────────
+/**
+ * The viewer's state w.r.t. a target user. Returned inline on profile
+ * reads so the UI can render Follow / Connect buttons without a second
+ * request.
+ */
+export const viewerSocialStateSchema = z.object({
+    /** True when the viewer is following the target. */
+    following: z.boolean(),
+    /** Connection status from the viewer's perspective:
+     *   - null         → no connection record exists
+     *   - 'pending'    → there is a pending request between them
+     *   - 'accepted'   → they're connected
+     *   - 'declined'   → previous request was declined
+     *   - 'blocked'    → either side blocked the other
+     */
+    connectionStatus: connectionStatusSchema.nullable(),
+    /** When connectionStatus === 'pending', identifies who has the action:
+     *   - 'sent'     → viewer sent the request; awaiting target's accept
+     *   - 'received' → target sent the request; viewer must accept / decline
+     *  Null in all other states. */
+    pendingDirection: z.enum(['sent', 'received']).nullable(),
+});
+/**
+ * Response when the viewer toggles follow on a target user. The endpoint
+ * is `POST /api/v1/community/users/:id/follow` and is idempotent —
+ * calling twice removes the follow.
+ */
+export const toggleFollowResponseSchema = z.object({
+    targetUserId: z.string(),
+    following: z.boolean(),
+    followerCount: z.number().int().nonnegative(),
+});
+// ─── Connection ────────────────────────────────────────────────────────────
+/**
+ * Send a connection request. The endpoint is
+ * `POST /api/v1/community/users/:id/connect`. The body is empty — the
+ * relationship is identified by the path id + the authenticated caller.
+ */
+export const sendConnectionRequestResponseSchema = z.object({
+    targetUserId: z.string(),
+    /** The status after the call. For a fresh request → 'pending'. For a
+     *  reciprocal request that auto-accepts → 'accepted'. */
+    status: connectionStatusSchema,
+});
+/**
+ * Body for `POST /api/v1/community/connections/:id/decision` (accept /
+ * decline / block / unblock on an existing connection record).
+ */
+export const connectionDecisionBodySchema = z.object({
+    decision: z.enum(['accept', 'decline', 'block', 'unblock', 'remove']),
+});
+export const connectionRecordWireSchema = z.object({
+    _id: z.string(),
+    /** The "other" user from the viewer's perspective. */
+    otherUserId: z.string(),
+    status: connectionStatusSchema,
+    /** Who initiated the request. Always the same regardless of viewer. */
+    requestedByUserId: z.string(),
+    createdAt: z.string().datetime(),
+    acceptedAt: z.string().datetime().nullable(),
+});
+//# sourceMappingURL=social.js.map

package/dist/social.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"social.js","sourceRoot":"","sources":["../src/social.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AAEpD,+EAA+E;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,oDAAoD;IACpD,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB;;;;;;OAMG;IACH,gBAAgB,EAAE,sBAAsB,CAAC,QAAQ,EAAE;IACnD;;;oCAGgC;IAChC,gBAAgB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC1D,CAAC,CAAC;AAGH;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE;CAC9C,CAAC,CAAC;AAGH,8EAA8E;AAE9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1D,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB;6DACyD;IACzD,MAAM,EAAE,sBAAsB;CAC/B,CAAC,CAAC;AAKH;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;CACtE,CAAC,CAAC;AAKH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,sDAAsD;IACtD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,MAAM,EAAE,sBAAsB;IAC9B,uEAAuE;IACvE,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC","sourcesContent":["/**\n * Social graph wire shapes — follows and connections.\n *\n * Two distinct relationships:\n *\n *   Follow      — one-way, no acceptance required (Twitter / Instagram).\n *                 The follower starts seeing the followee's posts in their\n *                 feed regardless of geo scope. Followee is notified.\n *\n *   Connection  — mutual handshake (LinkedIn). Requester sends, recipient\n *                 accepts / declines. ACCEPTED connections bypass the\n *                 visibility-level cascade entirely: connected users\n *                 always see each other's posts no matter the level.\n *                 This is the \"friend posts always visible\" rule.\n *\n * The two surfaces don't overlap: a user can follow someone they're\n * not connected with, and they can be connected without following.\n *\n * @module community-schema/social\n */\n\nimport { z } from 'zod';\nimport { connectionStatusSchema } from './enums.js';\n\n// ─── Follow ─────────────────────────────────────────────────────────────────\n\n/**\n * The viewer's state w.r.t. a target user. Returned inline on profile\n * reads so the UI can render Follow / Connect buttons without a second\n * request.\n */\nexport const viewerSocialStateSchema = z.object({\n  /** True when the viewer is following the target. */\n  following: z.boolean(),\n  /** Connection status from the viewer's perspective:\n   *   - null         → no connection record exists\n   *   - 'pending'    → there is a pending request between them\n   *   - 'accepted'   → they're connected\n   *   - 'declined'   → previous request was declined\n   *   - 'blocked'    → either side blocked the other\n   */\n  connectionStatus: connectionStatusSchema.nullable(),\n  /** When connectionStatus === 'pending', identifies who has the action:\n   *   - 'sent'     → viewer sent the request; awaiting target's accept\n   *   - 'received' → target sent the request; viewer must accept / decline\n   *  Null in all other states. */\n  pendingDirection: z.enum(['sent', 'received']).nullable(),\n});\nexport type ViewerSocialState = z.infer<typeof viewerSocialStateSchema>;\n\n/**\n * Response when the viewer toggles follow on a target user. The endpoint\n * is `POST /api/v1/community/users/:id/follow` and is idempotent —\n * calling twice removes the follow.\n */\nexport const toggleFollowResponseSchema = z.object({\n  targetUserId: z.string(),\n  following: z.boolean(),\n  followerCount: z.number().int().nonnegative(),\n});\nexport type ToggleFollowResponse = z.infer<typeof toggleFollowResponseSchema>;\n\n// ─── Connection ────────────────────────────────────────────────────────────\n\n/**\n * Send a connection request. The endpoint is\n * `POST /api/v1/community/users/:id/connect`. The body is empty — the\n * relationship is identified by the path id + the authenticated caller.\n */\nexport const sendConnectionRequestResponseSchema = z.object({\n  targetUserId: z.string(),\n  /** The status after the call. For a fresh request → 'pending'. For a\n   *  reciprocal request that auto-accepts → 'accepted'. */\n  status: connectionStatusSchema,\n});\nexport type SendConnectionRequestResponse = z.infer<\n  typeof sendConnectionRequestResponseSchema\n>;\n\n/**\n * Body for `POST /api/v1/community/connections/:id/decision` (accept /\n * decline / block / unblock on an existing connection record).\n */\nexport const connectionDecisionBodySchema = z.object({\n  decision: z.enum(['accept', 'decline', 'block', 'unblock', 'remove']),\n});\nexport type ConnectionDecisionBody = z.infer<\n  typeof connectionDecisionBodySchema\n>;\n\nexport const connectionRecordWireSchema = z.object({\n  _id: z.string(),\n  /** The \"other\" user from the viewer's perspective. */\n  otherUserId: z.string(),\n  status: connectionStatusSchema,\n  /** Who initiated the request. Always the same regardless of viewer. */\n  requestedByUserId: z.string(),\n  createdAt: z.string().datetime(),\n  acceptedAt: z.string().datetime().nullable(),\n});\nexport type ConnectionRecordWire = z.infer<typeof connectionRecordWireSchema>;\n"]}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "jansathi-community-schema",
+  "version": "0.1.0",
+  "description": "Shared Zod schemas + TypeScript types for the Jansathi hyperlocal community feature (feed, posts, engagement, social graph, groups).",
+  "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",
+    "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",
+    "community",
+    "social",
+    "feed",
+    "hyperlocal",
+    "typescript"
+  ],
+  "author": "Hari",
+  "license": "MIT",
+  "peerDependencies": {
+    "zod": "^3.25.0 || ^4.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.5",
+    "@types/node": "^24.10.1",
+    "typescript": "^5.9.3",
+    "zod": "^4.1.13"
+  }
+}