gdc-common-utils-ts 1.5.1 → 1.7.0

package/dist/examples/contract-examples.js

@@ -7,8 +7,10 @@
  * breaking while the examples are reorganized by flow/case of use.
  */
 export * from './shared.js';
+export * from './ica-activation-proof.js';
 export * from './organization-controller.js';
 export * from './individual-controller.js';
 export * from './professional.js';
 export * from './related-person.js';
 export * from './frontend-session.js';
+export * from './lifecycle.js';

package/dist/examples/frontend-session.d.ts

@@ -1,7 +1,3 @@
-/**
- * Examples for frontend session/profile bootstrap flows.
- */
-export declare const EXAMPLE_PROFILE_PROVIDER_DID = "did:web:provider.example.org";
 export declare const EXAMPLE_PROFILE_SESSION_INPUT: {
     readonly profileId: " profile-1 ";
     readonly email: " user@example.com ";

package/dist/examples/frontend-session.js

@@ -1,18 +1,24 @@
 // Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
 /**
  * Examples for frontend session/profile bootstrap flows.
+ *
+ * Note:
+ *
+ * - profile/provider identifiers in this file are synthetic fixtures imported
+ *   from `./shared`
+ * - do not inline DID/email/profile literals directly in frontend examples
  */
-export const EXAMPLE_PROFILE_PROVIDER_DID = 'did:web:provider.example.org';
+import { EXAMPLE_PROFILE_EMAIL, EXAMPLE_PROFILE_ID, EXAMPLE_PROFILE_ORGANIZATION_DID, } from './shared.js';
 export const EXAMPLE_PROFILE_SESSION_INPUT = {
-    profileId: ' profile-1 ',
-    email: ' user@example.com ',
+    profileId: ` ${EXAMPLE_PROFILE_ID} `,
+    email: ` ${EXAMPLE_PROFILE_EMAIL} `,
     role: ' controller ',
-    providerDid: ' did:web:org.example ',
+    providerDid: ` ${EXAMPLE_PROFILE_ORGANIZATION_DID} `,
     appType: 'Family',
 };
 export const EXAMPLE_PROFILE_REGISTRY_ENTRY = {
-    id: 'profile-1',
-    email: 'user@example.com',
+    id: EXAMPLE_PROFILE_ID,
+    email: EXAMPLE_PROFILE_EMAIL,
     role: 'controller',
-    providerDid: 'did:web:org.example',
+    providerDid: EXAMPLE_PROFILE_ORGANIZATION_DID,
 };

package/dist/examples/ica-activation-proof.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Shared synthetic ICA activation-proof fixtures reused by docs/tests.
+ *
+ * Contract note:
+ * - issuer/holder/audience DIDs, VC subtype names, and representative binding
+ *   fields must be imported from this module instead of re-hardcoded inline
+ * - the representative `hasCredential.material` shape below reflects the
+ *   current `activation-policy` helper contract; if ICA finalizes a different
+ *   VC shape, update this module first and then the dependent helpers/tests
+ */
+export declare const EXAMPLE_ICA_VP_ISSUER_DID: "did:web:controller.example.org";
+export declare const EXAMPLE_ICA_VP_AUDIENCE_DID: "did:web:host.example.com";
+export declare const EXAMPLE_ICA_VP_HOLDER_DID: "did:web:controller.example.org";
+export declare const EXAMPLE_ICA_ORGANIZATION_DID: "did:web:org.example.org";
+export declare const EXAMPLE_ICA_REPRESENTATIVE_DID: "did:web:rep.example.org";
+export declare const EXAMPLE_ICA_ORGANIZATION_TAX_ID: "ESB00112233";
+export declare const EXAMPLE_ICA_REPRESENTATIVE_ROLE_CODE: "RESPRSN";
+export declare const EXAMPLE_ICA_REPRESENTATIVE_BINDING_MATERIAL: "controller-sig-kid";
+export declare const EXAMPLE_ICA_ORGANIZATION_CREDENTIAL: Readonly<{
+    '@context': string[];
+    type: ("VerifiableCredential" | "OrganizationCredential")[];
+    credentialSubject: {
+        id: "did:web:org.example.org";
+        taxID: "ESB00112233";
+    };
+}>;
+export declare const EXAMPLE_ICA_LEGAL_REPRESENTATIVE_CREDENTIAL: Readonly<{
+    '@context': string[];
+    type: ("VerifiableCredential" | "LegalRepresentativeCredential")[];
+    credentialSubject: {
+        id: "did:web:rep.example.org";
+        memberOf: {
+            taxID: "ESB00112233";
+        };
+        hasOccupation: {
+            identifier: {
+                value: "RESPRSN";
+            };
+        };
+        hasCredential: {
+            material: "controller-sig-kid";
+        };
+    };
+}>;
+export declare const EXAMPLE_ICA_ACTIVATION_VP_PAYLOAD: Readonly<{
+    iss: "did:web:controller.example.org";
+    sub: "did:web:controller.example.org";
+    aud: "did:web:host.example.com";
+    vp: {
+        '@context': "https://www.w3.org/2018/credentials/v1"[];
+        type: "VerifiablePresentation"[];
+        holder: "did:web:controller.example.org";
+        verifiableCredential: string[];
+    };
+}>;

package/dist/examples/ica-activation-proof.js

@@ -0,0 +1,67 @@
+// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
+// Always create JSDoc, do not use strings inline in keys nor values, use types instead, and reuse the data test examples.
+import { ActivationCredentialTypes, W3cCredentialContexts, W3cCredentialTypes, } from '../constants/verifiable-credentials.js';
+/**
+ * Shared synthetic ICA activation-proof fixtures reused by docs/tests.
+ *
+ * Contract note:
+ * - issuer/holder/audience DIDs, VC subtype names, and representative binding
+ *   fields must be imported from this module instead of re-hardcoded inline
+ * - the representative `hasCredential.material` shape below reflects the
+ *   current `activation-policy` helper contract; if ICA finalizes a different
+ *   VC shape, update this module first and then the dependent helpers/tests
+ */
+export const EXAMPLE_ICA_VP_ISSUER_DID = 'did:web:controller.example.org';
+export const EXAMPLE_ICA_VP_AUDIENCE_DID = 'did:web:host.example.com';
+export const EXAMPLE_ICA_VP_HOLDER_DID = EXAMPLE_ICA_VP_ISSUER_DID;
+export const EXAMPLE_ICA_ORGANIZATION_DID = 'did:web:org.example.org';
+export const EXAMPLE_ICA_REPRESENTATIVE_DID = 'did:web:rep.example.org';
+export const EXAMPLE_ICA_ORGANIZATION_TAX_ID = 'ESB00112233';
+export const EXAMPLE_ICA_REPRESENTATIVE_ROLE_CODE = 'RESPRSN';
+export const EXAMPLE_ICA_REPRESENTATIVE_BINDING_MATERIAL = 'controller-sig-kid';
+export const EXAMPLE_ICA_ORGANIZATION_CREDENTIAL = Object.freeze({
+    '@context': [W3cCredentialContexts.V2, 'https://schema.org'],
+    type: [
+        W3cCredentialTypes.VerifiableCredential,
+        ActivationCredentialTypes.OrganizationCredential,
+    ],
+    credentialSubject: {
+        id: EXAMPLE_ICA_ORGANIZATION_DID,
+        taxID: EXAMPLE_ICA_ORGANIZATION_TAX_ID,
+    },
+});
+export const EXAMPLE_ICA_LEGAL_REPRESENTATIVE_CREDENTIAL = Object.freeze({
+    '@context': [W3cCredentialContexts.V2, 'https://schema.org'],
+    type: [
+        W3cCredentialTypes.VerifiableCredential,
+        ActivationCredentialTypes.LegalRepresentativeCredential,
+    ],
+    credentialSubject: {
+        id: EXAMPLE_ICA_REPRESENTATIVE_DID,
+        memberOf: {
+            taxID: EXAMPLE_ICA_ORGANIZATION_TAX_ID,
+        },
+        hasOccupation: {
+            identifier: {
+                value: EXAMPLE_ICA_REPRESENTATIVE_ROLE_CODE,
+            },
+        },
+        hasCredential: {
+            material: EXAMPLE_ICA_REPRESENTATIVE_BINDING_MATERIAL,
+        },
+    },
+});
+export const EXAMPLE_ICA_ACTIVATION_VP_PAYLOAD = Object.freeze({
+    iss: EXAMPLE_ICA_VP_ISSUER_DID,
+    sub: EXAMPLE_ICA_VP_ISSUER_DID,
+    aud: EXAMPLE_ICA_VP_AUDIENCE_DID,
+    vp: {
+        '@context': [W3cCredentialContexts.V1],
+        type: [W3cCredentialTypes.VerifiablePresentation],
+        holder: EXAMPLE_ICA_VP_HOLDER_DID,
+        verifiableCredential: [
+            JSON.stringify(EXAMPLE_ICA_ORGANIZATION_CREDENTIAL),
+            JSON.stringify(EXAMPLE_ICA_LEGAL_REPRESENTATIVE_CREDENTIAL),
+        ],
+    },
+});

package/dist/examples/index.d.ts

@@ -1,9 +1,12 @@
 export * from './shared';
+export * from './ica-activation-proof';
 export * from './organization-controller';
 export * from './individual-controller';
 export * from './professional';
 export * from './related-person';
 export * from './consent-access';
+export * from './relationship-access';
 export * from './frontend-session';
+export * from './lifecycle';
 export * from './api-flow-examples';
 export * from './contract-examples';

package/dist/examples/index.js

@@ -1,9 +1,12 @@
 export * from './shared.js';
+export * from './ica-activation-proof.js';
 export * from './organization-controller.js';
 export * from './individual-controller.js';
 export * from './professional.js';
 export * from './related-person.js';
 export * from './consent-access.js';
+export * from './relationship-access.js';
 export * from './frontend-session.js';
+export * from './lifecycle.js';
 export * from './api-flow-examples.js';
 export * from './contract-examples.js';

package/dist/examples/individual-controller.d.ts

@@ -13,6 +13,7 @@
  * - legal organization controller/representative examples belong instead to
  *   organization activation and VC/member semantics, not to `owner.*` claims
  */
+import type { ExampleClinicalBundleSearchInput, ExampleLatestIpsSearchInput } from './shared';
 export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_START_INPUT: {
     readonly alternateName: "ana";
     readonly controllerEmail: "ana.parent@example.org";
@@ -65,7 +66,7 @@ export declare const EXAMPLE_LIVE_CONSENT_GRANT_INPUT: {
     };
     readonly actorRole: "ISCO-08|2211";
     readonly purpose: "TREAT";
-    readonly actions: readonly ["LOINC|48765-2"];
+    readonly actions: readonly [string];
 };
 export declare const EXAMPLE_CONSENT_GRANT_RESPONSE: {
     readonly submit: {
@@ -95,17 +96,5 @@ export declare const EXAMPLE_DIGITAL_TWIN_COMPOSITION_INPUT: {
     };
     readonly format: "api";
 };
-export declare const EXAMPLE_CLINICAL_BUNDLE_SEARCH_INPUT: {
-    readonly subject: "did:web:api.acme.org:individual:123";
-    readonly section: readonly ["LOINC|60591-5", "LOINC|48765-2"];
-    readonly includedTypes: readonly ["Composition", "DocumentReference"];
-    readonly date: {
-        readonly start: "2026-01-01";
-        readonly end: "2026-12-31";
-    };
-    readonly code: "LOINC|11450-4";
-    readonly author: "did:web:api.acme.org:professional:1";
-};
-export declare const EXAMPLE_LATEST_IPS_SEARCH_INPUT: {
-    readonly subject: "did:web:api.acme.org:individual:123";
-};
+export declare const EXAMPLE_CLINICAL_BUNDLE_SEARCH_INPUT: ExampleClinicalBundleSearchInput;
+export declare const EXAMPLE_LATEST_IPS_SEARCH_INPUT: ExampleLatestIpsSearchInput;

package/dist/examples/individual-controller.js

@@ -1,22 +1,8 @@
 // Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
-/**
- * Examples for individual-controller and subject-index bootstrap flows.
- *
- * CORE canonical examples in this file avoid phone-specific subject/controller
- * fields unless the flow truly requires them. Telephone-driven notification or
- * consent targeting is treated as an extension concern (for example UNID GW),
- * not a CORE GW contract requirement.
- *
- * Semantic split:
- *
- * - these examples model the human controller as owner of the individual
- *   subject-index organization
- * - legal organization controller/representative examples belong instead to
- *   organization activation and VC/member semantics, not to `owner.*` claims
- */
+import { EXAMPLE_API_ORGANIZATION_DID, EXAMPLE_CLINICAL_CODE_PROBLEM, EXAMPLE_CLINICAL_DATE_RANGE, EXAMPLE_CLINICAL_SECTION_ALLERGIES, EXAMPLE_CLINICAL_SECTION_PATIENT_SUMMARY, EXAMPLE_CONSENT_PURPOSE_TREATMENT, EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL, EXAMPLE_GENERIC_SUBJECT_DID, EXAMPLE_HEALTHCARE_ACTOR_ROLE_PHYSICIAN, EXAMPLE_HEALTHCARE_JURISDICTION, EXAMPLE_HEALTHCARE_ROLE_PHYSICIAN_TEXT, EXAMPLE_PRACTITIONER_DID, EXAMPLE_PROFESSIONAL_DID, EXAMPLE_SUBJECT_DID, } from './shared.js';
 export const EXAMPLE_INDIVIDUAL_ORGANIZATION_START_INPUT = {
     alternateName: 'ana',
-    controllerEmail: 'ana.parent@example.org',
+    controllerEmail: EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL,
     timeoutSeconds: 7,
     intervalSeconds: 2,
 };
@@ -36,18 +22,18 @@ export const EXAMPLE_INDIVIDUAL_ORGANIZATION_ORDER_RESPONSE = {
     poll: { status: 200, body: {}, attempts: 1 },
 };
 export const EXAMPLE_CONSENT_GRANT_INPUT = {
-    actor: 'did:web:practitioner.example,ES',
-    actorRole: 'physician',
-    purpose: 'TREAT',
+    actor: `${EXAMPLE_PRACTITIONER_DID},${EXAMPLE_HEALTHCARE_JURISDICTION}`,
+    actorRole: EXAMPLE_HEALTHCARE_ROLE_PHYSICIAN_TEXT,
+    purpose: EXAMPLE_CONSENT_PURPOSE_TREATMENT,
     actions: ['read'],
-    subjectDid: 'did:web:subject.example',
+    subjectDid: EXAMPLE_GENERIC_SUBJECT_DID,
 };
 export const EXAMPLE_LIVE_CONSENT_GRANT_INPUT = {
-    subjectDid: 'did:web:api.acme.org:individual:123',
-    actor: { identifier: 'did:web:api.acme.org' },
-    actorRole: 'ISCO-08|2211',
-    purpose: 'TREAT',
-    actions: ['LOINC|48765-2'],
+    subjectDid: EXAMPLE_SUBJECT_DID,
+    actor: { identifier: EXAMPLE_API_ORGANIZATION_DID },
+    actorRole: EXAMPLE_HEALTHCARE_ACTOR_ROLE_PHYSICIAN,
+    purpose: EXAMPLE_CONSENT_PURPOSE_TREATMENT,
+    actions: [EXAMPLE_CLINICAL_SECTION_ALLERGIES],
 };
 export const EXAMPLE_CONSENT_GRANT_RESPONSE = {
     submit: { status: 202, body: {} },
@@ -73,13 +59,13 @@ export const EXAMPLE_DIGITAL_TWIN_COMPOSITION_INPUT = {
     format: 'api',
 };
 export const EXAMPLE_CLINICAL_BUNDLE_SEARCH_INPUT = {
-    subject: 'did:web:api.acme.org:individual:123',
-    section: ['LOINC|60591-5', 'LOINC|48765-2'],
+    subject: EXAMPLE_SUBJECT_DID,
+    section: [EXAMPLE_CLINICAL_SECTION_PATIENT_SUMMARY, EXAMPLE_CLINICAL_SECTION_ALLERGIES],
     includedTypes: ['Composition', 'DocumentReference'],
-    date: { start: '2026-01-01', end: '2026-12-31' },
-    code: 'LOINC|11450-4',
-    author: 'did:web:api.acme.org:professional:1',
+    date: EXAMPLE_CLINICAL_DATE_RANGE,
+    code: EXAMPLE_CLINICAL_CODE_PROBLEM,
+    author: EXAMPLE_PROFESSIONAL_DID,
 };
 export const EXAMPLE_LATEST_IPS_SEARCH_INPUT = {
-    subject: 'did:web:api.acme.org:individual:123',
+    subject: EXAMPLE_SUBJECT_DID,
 };