gdc-common-utils-ts 1.16.0 → 1.18.1

package/README.md

@@ -3,8 +3,8 @@
 Employee shared examples live in `src/examples/employee.ts`.
 Employee pure helper functions live in `src/utils/employee.ts`.
 
-The canonical employee contract note lives in
-`gdc-sdk-core-ts/docs/EMPLOYEES_101.md`.
+The canonical employee editor note lives in
+[`docs/101-EMPLOYEE_ENTRY_EDITOR.md`](docs/101-EMPLOYEE_ENTRY_EDITOR.md).
 
 Shared TypeScript utilities for GDC client and connector code. This package provides low-level primitives for cryptography, DID/DIDComm-related helpers, and the shared models and interfaces used across SDKs.
 
@@ -30,12 +30,31 @@ boundaries used in `gdc-common-utils-ts`.
 - `resource.meta.claims` is the canonical project-specific claims container and must be preserved across conversions/transports.
 - `resource.meta.claims` is not part of base FHIR; it is a claims-first extension carried by FHIR-like resources in GDC contracts.
 
+## 101 Test Convention
+
+Every `101` test in this repo is expected to be a didactic executable tutorial,
+not only a behavior check.
+
+Required shape for `101` tests:
+
+- start with a short `Teaching goal` comment block
+- explain the main app/business flow, not only internal plumbing
+- use explicit `Step 1.`, `Step 2.`, ... comments for the happy path
+- make clear what the user/app already has, what is shown, what is edited,
+  what is saved, and what is reloaded
+- if a low-level helper path is shown, mark it explicitly as an escape hatch
+  and not the primary `101` path
+
+The goal is that a developer can read the test top-to-bottom as tutorial
+material without needing chat history or private repo context.
+
 If you need the canonical explanation of how DIDComm envelope, batch body,
 entry types, FHIR-like resources, and `resource.meta.claims` fit together,
 read first:
 
 - [`docs/101-COMMUNICATION_LAYERING.md`](docs/101-COMMUNICATION_LAYERING.md)
 - [`docs/101-BUNDLE_EDITOR_READER.md`](docs/101-BUNDLE_EDITOR_READER.md)
+- [`docs/101-CONSENT_PERMISSION_TEMPLATES.md`](docs/101-CONSENT_PERMISSION_TEMPLATES.md)
 
 ## Install
 
@@ -161,6 +180,10 @@ import { JweObject, JwtCompactParts } from 'gdc-common-utils-ts/models';
     `internet-first` discovery seeding by `jurisdiction + version + networkType`
 - [docs/consent-access-matrix-task.md](docs/consent-access-matrix-task.md)
   - next-step design/task document for active consent aggregation, explicit deny precedence, controller views, permission-request communications, and SMART access evaluation
+- [docs/101-CONSENT_PERMISSION_TEMPLATES.md](docs/101-CONSENT_PERMISSION_TEMPLATES.md)
+  - canonical design note for role/relationship permission templates, front
+    pickers, actor/target/purpose classification, and consent import/export
+    planning
 - [docs/101-IPS_BUNDLE.md](docs/101-IPS_BUNDLE.md)
   - canonical 101 for requesting IPS, editing IPS-style bundles in `Communication.content-attachment-data`, and reading resources by section
 
@@ -208,13 +231,14 @@ import { HostNetworkTypes } from 'gdc-common-utils-ts/constants/network';
 
 const hostContext = {
   participantId: 'host',
+  hostCoverageScope: 'EU',
   jurisdiction: 'ES',
   version: 'v1',
   hostNetwork: HostNetworkTypes.Test,
 };
 
 const discoveryPath = buildGwDspaceVersionWellKnownPath(hostContext);
-const metadata = buildDspaceVersionMetadata('/host/cds-ES/v1/test/dsp');
+const metadata = buildDspaceVersionMetadata('/host/cds-EU/v1/test/dsp');
 const catalogPath = buildGwCatalogArtifactPath(hostContext);
 const catalogUrl = deriveGwCatalogArtifactUrlFromDspaceVersion(
   `https://host.example.org${discoveryPath}`,

package/dist/claims/claims-helpers-communication.d.ts

@@ -9,6 +9,8 @@ export declare function getCommunicationCategoryList(claims: CommunicationIntero
 export declare function setCommunicationCategory(claims: CommunicationInteroperableClaims, value: string | readonly string[]): CommunicationInteroperableClaims;
 export declare function addCommunicationCategoryList(claims: CommunicationInteroperableClaims, value: string | readonly string[]): CommunicationInteroperableClaims;
 export declare function removeCommunicationCategoryList(claims: CommunicationInteroperableClaims, value: string | readonly string[]): CommunicationInteroperableClaims;
+export declare function getCommunicationTopic(claims: CommunicationInteroperableClaims): string;
+export declare function setCommunicationTopic(claims: CommunicationInteroperableClaims, value: unknown): CommunicationInteroperableClaims;
 export declare function getCommunicationText(claims: CommunicationInteroperableClaims): string;
 export declare function setCommunicationText(claims: CommunicationInteroperableClaims, value: unknown): CommunicationInteroperableClaims;
 export declare function getCommunicationContentAttachmentData(claims: CommunicationInteroperableClaims): string;

package/dist/claims/claims-helpers-communication.js

@@ -37,6 +37,12 @@ export function addCommunicationCategoryList(claims, value) {
 export function removeCommunicationCategoryList(claims, value) {
     return removeClaimValues(claims, CommunicationClaim.Category, value);
 }
+export function getCommunicationTopic(claims) {
+    return getCommunicationScalar(claims, CommunicationClaim.Topic);
+}
+export function setCommunicationTopic(claims, value) {
+    return setCommunicationScalar(claims, CommunicationClaim.Topic, value);
+}
 export function getCommunicationText(claims) {
     return getCommunicationScalar(claims, CommunicationClaim.Text);
 }