@corva/chat-core 0.0.1

package/README.md

@@ -0,0 +1,51 @@
+# @corva/chat-core
+
+Platform-agnostic core of Corva Team Chat, shared by
+[corva-web-frontend](https://github.com/corva-ai/corva-web-frontend) and
+[corva-react-native-app](https://github.com/corva-ai/corva-react-native-app).
+
+It holds everything that is not UI: the Revolt/Stoat API and socket client, chat stores, and the
+`$$CORVA::` message wire format. Each app renders its own UI on top of it.
+
+## Rules
+
+- **No platform globals.** The type environment is `es2022` only, with no DOM or Node types. The only
+  globals allowed are the timers and `console` declared in `src/platform.d.ts`. `fetch`, `WebSocket`,
+  storage, notifications and app-state events are injected by the host app through adapters.
+- **No React.** Stores use `zustand/vanilla`; each app wraps them in its own hooks.
+- **No UI dependencies** (`@corva/ui`, MUI, React Native).
+
+Lint and typecheck enforce these rules.
+
+## Development
+
+```sh
+nvm use
+yarn install
+yarn test        # vitest, node environment
+yarn lint        # eslint + prettier
+yarn typecheck
+yarn build       # tsup → dist/ (ESM + .d.ts)
+```
+
+### Trying a local build in an app
+
+```sh
+yarn build && npx yalc publish      # in this repo
+npx yalc add @corva/chat-core       # in the consuming app
+```
+
+## Publishing
+
+```sh
+npm version patch   # or minor / major
+npm publish         # prepublishOnly runs lint, typecheck, tests, build and package checks
+git push --follow-tags
+```
+
+Canary build for testing a branch in an app:
+
+```sh
+npm version 0.0.0-$(git rev-parse --short HEAD) --no-git-tag-version
+npm publish --tag canary && git checkout package.json
+```

package/dist/index.d.ts

@@ -0,0 +1,109 @@
+declare const CORVA_SYS_PREFIX = "$$CORVA::";
+declare const CORVA_MESSAGE_TYPES: {
+    readonly ALERT: "alert";
+    readonly FEED: "feed";
+    readonly ASK_CORVA: "ask";
+    readonly FORWARD: "fwd";
+    readonly APP_COMMENT: "cmt";
+};
+interface ForwardWirePayload {
+    cid: string;
+    mid: string;
+    cn: string;
+    priv: boolean;
+    n?: string;
+    ts?: string;
+}
+type CorvaSystemMessage = {
+    t: typeof CORVA_MESSAGE_TYPES.ALERT;
+    v: number;
+    d: AlertWirePayload;
+} | {
+    t: typeof CORVA_MESSAGE_TYPES.FEED;
+    v: number;
+    d: FeedWirePayload;
+} | {
+    t: typeof CORVA_MESSAGE_TYPES.ASK_CORVA;
+    v: number;
+    d: AskCorvaWirePayload;
+} | {
+    t: typeof CORVA_MESSAGE_TYPES.FORWARD;
+    v: number;
+    d: ForwardWirePayload;
+} | {
+    t: typeof CORVA_MESSAGE_TYPES.APP_COMMENT;
+    v: number;
+    d: AppCommentWirePayload;
+};
+type WireSeverity = 'c' | 'w' | 'i';
+interface AlertWirePayload {
+    id: string;
+    defId?: string;
+    sev: WireSeverity;
+    ttl: string;
+    dsc: string;
+    trunc?: boolean;
+    app?: string;
+    assetId?: string;
+    assetName?: string;
+}
+interface FeedWirePayload {
+    id: string;
+    ft: string;
+    ttl: string;
+    dsc?: string;
+    assetId?: string;
+    usr?: string;
+}
+interface AskCorvaWirePayload {
+    id: string;
+    a: string;
+    aRef?: string;
+    cId?: number;
+    trunc?: boolean;
+    assetId?: number;
+    agentName?: string;
+}
+/**
+ * One attachment on the wire. Keys are single letters like every other field in these payloads:
+ * they ride inside the message body, which is truncated at MAX_COMMENT_BODY_LENGTH.
+ */
+interface AttachmentWirePayload {
+    /** Attachment URL. */
+    u: string;
+    /** Original file name, with extension — lets the reader tell media apart from documents. */
+    n?: string;
+    /** File size in bytes. */
+    s?: number;
+}
+interface AppCommentWirePayload {
+    body: string;
+    app?: string;
+    usrId?: number;
+    autId?: number;
+    at?: string;
+    att?: string;
+    atts?: AttachmentWirePayload[];
+    actId?: string;
+    appId?: string;
+    dashId?: string;
+    appUrl?: string;
+    meta?: {
+        hd?: number;
+        bd?: number;
+        cd?: number;
+    };
+    snpId?: string;
+    trunc?: boolean;
+}
+
+/**
+ * Builds the wire-format content string for an AskCorva response.
+ */
+declare function buildAskCorvaMessageContent(requestId: string, answer: string, answerRef?: string, isTruncated?: boolean, assetId?: number, agentName?: string, companyId?: number): string;
+/**
+ * Builds the wire-format content string for a forwarded message.
+ */
+declare function buildForwardMessageContent(sourceChannelId: string, messageId: string, channelName: string, isPrivate: boolean, note?: string, ts?: string): string;
+
+export { type AlertWirePayload, type AppCommentWirePayload, type AskCorvaWirePayload, type AttachmentWirePayload, CORVA_MESSAGE_TYPES, CORVA_SYS_PREFIX, type CorvaSystemMessage, type FeedWirePayload, type ForwardWirePayload, type WireSeverity, buildAskCorvaMessageContent, buildForwardMessageContent };

package/dist/index.js

@@ -0,0 +1,38 @@
+// src/wire/corvaSystemMessage.ts
+var CORVA_SYS_PREFIX = "$$CORVA::";
+var CORVA_MESSAGE_TYPES = {
+  ALERT: "alert",
+  FEED: "feed",
+  ASK_CORVA: "ask",
+  FORWARD: "fwd",
+  APP_COMMENT: "cmt"
+};
+
+// src/wire/buildMessageContent.ts
+function buildAskCorvaMessageContent(requestId, answer, answerRef, isTruncated, assetId, agentName, companyId) {
+  const payload = {
+    id: requestId,
+    a: answerRef ? "" : answer,
+    ...answerRef && { aRef: answerRef },
+    ...answerRef && companyId && { cId: companyId },
+    ...isTruncated && { trunc: true },
+    ...assetId && { assetId },
+    ...agentName && { agentName }
+  };
+  return `${CORVA_SYS_PREFIX}${JSON.stringify({ t: CORVA_MESSAGE_TYPES.ASK_CORVA, v: 1, d: payload })}`;
+}
+function buildForwardMessageContent(sourceChannelId, messageId, channelName, isPrivate, note, ts) {
+  const payload = {
+    cid: sourceChannelId,
+    mid: messageId,
+    cn: channelName,
+    priv: isPrivate,
+    ...note?.trim() && { n: note.trim() },
+    ...ts && { ts }
+  };
+  return `${CORVA_SYS_PREFIX}${JSON.stringify({ t: CORVA_MESSAGE_TYPES.FORWARD, v: 1, d: payload })}`;
+}
+
+export { CORVA_MESSAGE_TYPES, CORVA_SYS_PREFIX, buildAskCorvaMessageContent, buildForwardMessageContent };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/wire/corvaSystemMessage.ts","../src/wire/buildMessageContent.ts"],"names":[],"mappings":";AAAO,IAAM,gBAAA,GAAmB;AAEzB,IAAM,mBAAA,GAAsB;AAAA,EACjC,KAAA,EAAO,OAAA;AAAA,EACP,IAAA,EAAM,MAAA;AAAA,EACN,SAAA,EAAW,KAAA;AAAA,EACX,OAAA,EAAS,KAAA;AAAA,EACT,WAAA,EAAa;AACf;;;ACFO,SAAS,4BACd,SAAA,EACA,MAAA,EACA,WACA,WAAA,EACA,OAAA,EACA,WACA,SAAA,EACQ;AACR,EAAA,MAAM,OAAA,GAA+B;AAAA,IACnC,EAAA,EAAI,SAAA;AAAA,IACJ,CAAA,EAAG,YAAY,EAAA,GAAK,MAAA;AAAA,IACpB,GAAI,SAAA,IAAa,EAAE,IAAA,EAAM,SAAA,EAAU;AAAA,IACnC,GAAI,SAAA,IAAa,SAAA,IAAa,EAAE,KAAK,SAAA,EAAU;AAAA,IAC/C,GAAI,WAAA,IAAe,EAAE,KAAA,EAAO,IAAA,EAAK;AAAA,IACjC,GAAI,OAAA,IAAW,EAAE,OAAA,EAAQ;AAAA,IACzB,GAAI,SAAA,IAAa,EAAE,SAAA;AAAU,GAC/B;AACA,EAAA,OAAO,CAAA,EAAG,gBAAgB,CAAA,EAAG,IAAA,CAAK,UAAU,EAAE,CAAA,EAAG,mBAAA,CAAoB,SAAA,EAAW,CAAA,EAAG,CAAA,EAAG,CAAA,EAAG,OAAA,EAAS,CAAC,CAAA,CAAA;AACrG;AAKO,SAAS,2BACd,eAAA,EACA,SAAA,EACA,WAAA,EACA,SAAA,EACA,MACA,EAAA,EACQ;AACR,EAAA,MAAM,OAAA,GAA8B;AAAA,IAClC,GAAA,EAAK,eAAA;AAAA,IACL,GAAA,EAAK,SAAA;AAAA,IACL,EAAA,EAAI,WAAA;AAAA,IACJ,IAAA,EAAM,SAAA;AAAA,IACN,GAAI,MAAM,IAAA,EAAK,IAAK,EAAE,CAAA,EAAG,IAAA,CAAK,MAAK,EAAE;AAAA,IACrC,GAAI,EAAA,IAAM,EAAE,EAAA;AAAG,GACjB;AACA,EAAA,OAAO,CAAA,EAAG,gBAAgB,CAAA,EAAG,IAAA,CAAK,UAAU,EAAE,CAAA,EAAG,mBAAA,CAAoB,OAAA,EAAS,CAAA,EAAG,CAAA,EAAG,CAAA,EAAG,OAAA,EAAS,CAAC,CAAA,CAAA;AACnG","file":"index.js","sourcesContent":["export const CORVA_SYS_PREFIX = '$$CORVA::';\n\nexport const CORVA_MESSAGE_TYPES = {\n  ALERT: 'alert',\n  FEED: 'feed',\n  ASK_CORVA: 'ask',\n  FORWARD: 'fwd',\n  APP_COMMENT: 'cmt',\n} as const;\n\nexport interface ForwardWirePayload {\n  cid: string;\n  mid: string;\n  cn: string;\n  priv: boolean;\n  n?: string;\n  ts?: string; // ISO timestamp of the original message\n}\n\nexport type CorvaSystemMessage =\n  | { t: typeof CORVA_MESSAGE_TYPES.ALERT; v: number; d: AlertWirePayload }\n  | { t: typeof CORVA_MESSAGE_TYPES.FEED; v: number; d: FeedWirePayload }\n  | { t: typeof CORVA_MESSAGE_TYPES.ASK_CORVA; v: number; d: AskCorvaWirePayload }\n  | { t: typeof CORVA_MESSAGE_TYPES.FORWARD; v: number; d: ForwardWirePayload }\n  | { t: typeof CORVA_MESSAGE_TYPES.APP_COMMENT; v: number; d: AppCommentWirePayload };\n\nexport type WireSeverity = 'c' | 'w' | 'i';\n\nexport interface AlertWirePayload {\n  id: string;\n  defId?: string;\n  sev: WireSeverity;\n  ttl: string;\n  dsc: string;\n  trunc?: boolean;\n  app?: string;\n  assetId?: string;\n  assetName?: string;\n}\n\nexport interface FeedWirePayload {\n  id: string;\n  ft: string;\n  ttl: string;\n  dsc?: string;\n  assetId?: string;\n  usr?: string;\n}\n\nexport interface AskCorvaWirePayload {\n  id: string;\n  a: string;\n  aRef?: string; // conversationId — fetch full answer from AskCorva backend when `a` is empty\n  cId?: number; // sharer's company_id — askcorva.history records live under it, not the viewer's\n  trunc?: boolean;\n  assetId?: number;\n  agentName?: string; // human-readable agent display name\n}\n\n/**\n * One attachment on the wire. Keys are single letters like every other field in these payloads:\n * they ride inside the message body, which is truncated at MAX_COMMENT_BODY_LENGTH.\n */\nexport interface AttachmentWirePayload {\n  /** Attachment URL. */\n  u: string;\n  /** Original file name, with extension — lets the reader tell media apart from documents. */\n  n?: string;\n  /** File size in bytes. */\n  s?: number;\n}\n\nexport interface AppCommentWirePayload {\n  body: string;\n  app?: string; // app display name\n  usrId?: number; // forwarder corva user ID\n  autId?: number; // comment author corva user ID\n  at?: string; // activity type (e.g. \"dvd_comment\")\n  att?: string; // first attachment URL — kept so pre-multi-attachment clients still render one file\n  atts?: AttachmentWirePayload[];\n  actId?: string; // activity ID for lazy-fetching full content\n  appId?: string; // app definition ID for icon/info fetching\n  dashId?: string; // dashboard ID for deep linking\n  appUrl?: string; // full app URL with asset context\n  meta?: { hd?: number; bd?: number; cd?: number }; // raw depth values in ft for viewer-side unit conversion\n  snpId?: string; // settings snapshot ID — replaces dashboard-based settings fetching\n  trunc?: boolean; // body was truncated, fetch full content from activity API\n}\n","import type { AskCorvaWirePayload, ForwardWirePayload } from './corvaSystemMessage';\nimport { CORVA_SYS_PREFIX, CORVA_MESSAGE_TYPES } from './corvaSystemMessage';\n\n/**\n * Builds the wire-format content string for an AskCorva response.\n */\nexport function buildAskCorvaMessageContent(\n  requestId: string,\n  answer: string,\n  answerRef?: string,\n  isTruncated?: boolean,\n  assetId?: number,\n  agentName?: string,\n  companyId?: number\n): string {\n  const payload: AskCorvaWirePayload = {\n    id: requestId,\n    a: answerRef ? '' : answer,\n    ...(answerRef && { aRef: answerRef }),\n    ...(answerRef && companyId && { cId: companyId }),\n    ...(isTruncated && { trunc: true }),\n    ...(assetId && { assetId }),\n    ...(agentName && { agentName }),\n  };\n  return `${CORVA_SYS_PREFIX}${JSON.stringify({ t: CORVA_MESSAGE_TYPES.ASK_CORVA, v: 1, d: payload })}`;\n}\n\n/**\n * Builds the wire-format content string for a forwarded message.\n */\nexport function buildForwardMessageContent(\n  sourceChannelId: string,\n  messageId: string,\n  channelName: string,\n  isPrivate: boolean,\n  note?: string,\n  ts?: string\n): string {\n  const payload: ForwardWirePayload = {\n    cid: sourceChannelId,\n    mid: messageId,\n    cn: channelName,\n    priv: isPrivate,\n    ...(note?.trim() && { n: note.trim() }),\n    ...(ts && { ts }),\n  };\n  return `${CORVA_SYS_PREFIX}${JSON.stringify({ t: CORVA_MESSAGE_TYPES.FORWARD, v: 1, d: payload })}`;\n}\n"]}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@corva/chat-core",
+  "version": "0.0.1",
+  "description": "Platform-agnostic core of Corva Team Chat, shared by the web and mobile apps",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/corva-ai/corva-chat-core.git"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": "^24"
+  },
+  "packageManager": "yarn@1.22.22",
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.test.json",
+    "lint": "eslint . && prettier --check .",
+    "format": "prettier --write .",
+    "check-package": "publint --strict --pack npm && attw --pack . --profile esm-only",
+    "prepublishOnly": "yarn lint && yarn typecheck && yarn test && yarn build && yarn check-package"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "0.18.5",
+    "@eslint/js": "10.0.1",
+    "@types/node": "24.13.6",
+    "eslint": "10.11.0",
+    "prettier": "3.9.9",
+    "publint": "0.3.24",
+    "tsup": "8.5.1",
+    "typescript": "5.9.3",
+    "typescript-eslint": "8.70.1",
+    "vite": "8.3.1",
+    "vitest": "5.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}