@nabla/connect-protocol 0.2.0 → 0.3.0

package/dist/commands.d.ts

@@ -2,13 +2,15 @@ import type { NablaConnectCommandExportNoteEvent, NablaConnectCommandStartNoteGe
 import type { NablaConnectSessionHelloMessage } from "./session.js";
 import type { NablaConnectProtocolVersion } from "./version.js";
 /**
- * `sessionId` and `requestId` are non-empty strings of at most
+ * `clientId`, `sessionId` and `requestId` are non-empty strings of at most
  * `NablaConnectBoundedIdMaxLength` characters. `expectedRevision` is a positive
  * integer: the revision of the snapshot the host acted on.
  */
 export type NablaConnectCommandBase = {
     /** The version pinned by the session handshake. */
     version: NablaConnectProtocolVersion;
+    /** The `clientId` of the `session:hello`. The iframe ignores another one. */
+    clientId: string;
     sessionId: string;
     requestId: string;
     expectedRevision: number;

package/dist/export.d.ts

@@ -1,7 +1,40 @@
 import type { NablaConnectExportNoteEvent, NablaConnectExportPatientInstructionsEvent } from "./events.js";
+export type NablaConnectIcd10Entry = {
+    system: "http://hl7.org/fhir/sid/icd-10-cm";
+    code: string;
+    display: string;
+    isHcc: boolean;
+    isMcc: boolean;
+};
+export type NablaConnectSnomedEntry = {
+    system: "http://snomed.info/sct";
+    code: string;
+    display: string;
+};
+/**
+ * A subsection of a note section, with its normalized codes. `title` is `null` for a
+ * subsection without a title. The code lists are empty when no codes are available at
+ * export time.
+ */
+export type NablaConnectNoteSubsection = {
+    title: string | null;
+    text: string;
+    icd10Codes: NablaConnectIcd10Entry[];
+    snomedCodes: NablaConnectSnomedEntry[];
+};
+/** The content of a note section, discriminated by `type`. */
+export type NablaConnectNoteSectionContent = {
+    type: "TEXT";
+    text: string;
+} | {
+    type: "SUBSECTIONS";
+    subsections: NablaConnectNoteSubsection[];
+};
 export type NablaConnectExportableNoteSection = {
     category: string | null;
+    /** @deprecated The `NOTE_EXPORT` callback deprecates it: read `structuredContent`. */
     content: string;
+    structuredContent: NablaConnectNoteSectionContent;
     title: string;
 };
 export type NablaConnectExportableNote = {
@@ -9,13 +42,7 @@ export type NablaConnectExportableNote = {
     freeText: string | null;
 };
 export type NablaConnectVisitDiagnosisSystem = "http://hl7.org/fhir/sid/icd-10-cm";
-export type NablaConnectVisitDiagnosis = {
-    system: NablaConnectVisitDiagnosisSystem;
-    code: string;
-    display: string;
-    isHcc: boolean;
-    isMcc: boolean;
-};
+export type NablaConnectVisitDiagnosis = NablaConnectIcd10Entry;
 export type NablaConnectExportTranscriptItem = {
     text: string;
     speakerType: string;

package/dist/session.d.ts

@@ -7,11 +7,15 @@ import type { NablaConnectProtocolVersion } from "./version.js";
  *
  * Setup messages are not versioned and only ever gain fields. `supportedVersions` is
  * bounded by `NablaConnectSupportedVersionsMaxLength`.
+ *
+ * `clientId` is the client the document was loaded for, read from its URL, or `null` for a
+ * document that was loaded for none. It is a bounded id.
  */
 export type NablaConnectSessionAvailableMessage = {
     event: NablaConnectSessionAvailableEvent;
     data: {
         supportedVersions: number[];
+        clientId: string | null;
     };
 };
 /**
@@ -21,24 +25,32 @@ export type NablaConnectSessionAvailableMessage = {
  *
  * `sdkVersion` is the semver of the SDK, bounded by `NablaConnectSdkVersionMaxLength`.
  * The iframe logs it. It is not clinical data.
+ *
+ * `clientId` is a bounded id that identifies the SDK client. The iframe only answers the
+ * client its document was loaded for, and ignores a message with another or no `clientId`.
  */
 export type NablaConnectSessionHelloMessage = {
     event: NablaConnectSessionHelloEvent;
     data: {
         supportedVersions: number[];
         sdkVersion: string;
+        clientId: string;
     };
 };
 /**
  * The iframe pinned the highest version both sides support. Every later message of the
  * session carries and is validated against it, and the first `stateChanged` follows.
  * A repeated `session:hello` in the same session gets the same message back.
+ *
+ * `clientId` echoes the one of the `session:hello` it answers. The iframe posts to a window
+ * its host shares with other clients, so each client tells its own messages by it.
  */
 export type NablaConnectSessionReadyMessage = {
     event: NablaConnectSessionReadyEvent;
     data: {
         version: NablaConnectProtocolVersion;
         sessionId: string;
+        clientId: string;
     };
 };
 export type NablaConnectSessionRejectionReason = "UNSUPPORTED_VERSION";
@@ -47,11 +59,13 @@ export type NablaConnectSessionRejectionReason = "UNSUPPORTED_VERSION";
  * offer. The host gets no session. `supportedVersions` is what the iframe speaks. If they
  * are all newer than the SDK's, the SDK is too old and the integrator upgrades
  * `@nabla/connect-sdk`. If they are all older, the iframe is behind the SDK.
+ * `clientId` echoes the one of the `session:hello` it answers.
  */
 export type NablaConnectSessionRejectedMessage = {
     event: NablaConnectSessionRejectedEvent;
     data: {
         reason: NablaConnectSessionRejectionReason;
         supportedVersions: number[];
+        clientId: string;
     };
 };

package/dist/version.d.ts

@@ -7,7 +7,7 @@
  */
 export type NablaConnectProtocolVersion = 1;
 /**
- * Ids (`sessionId`, `requestId`) are non-empty strings of at most this many characters.
+ * Ids (`clientId`, `sessionId`, `requestId`) are non-empty strings of at most this many characters.
  * Types cannot express the bound: consumers must enforce it.
  */
 export type NablaConnectBoundedIdMaxLength = 64;
@@ -18,3 +18,8 @@ export type NablaConnectBoundedIdMaxLength = 64;
 export type NablaConnectSupportedVersionsMaxLength = 16;
 /** `sdkVersion` is a non-empty string of at most this many characters. */
 export type NablaConnectSdkVersionMaxLength = 64;
+/**
+ * The query parameter of the iframe URL that carries the `clientId` the document is loaded
+ * for. The SDK sets it. The iframe only answers the client it names.
+ */
+export type NablaConnectClientIdParam = "nablaConnectClientId";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nabla/connect-protocol",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "UNLICENSED",
   "description": "Wire-protocol types for the Nabla Connect iframe postMessage API. Types only, no runtime.",
   "type": "module",