gdc-common-utils-ts 1.20.2 → 1.21.0

package/dist/convert/convert-observation.js

@@ -2,20 +2,68 @@
 // File: src/utils/convert-observation.ts
 import { ObservationClaim } from '../models/interoperable-claims/observation-claims.js';
 import { codingFromValue, codingListToCsv, codingToValue, referenceListToCsv, referenceToValue } from './convert-shared.js';
-export function observationFlatToFhirR4(claims) {
+/**
+ * Converts flat editable Observation claims into a FHIR R4 Observation.
+ *
+ * Naming convention:
+ * - place the concrete FHIR version suffix at the end of the helper name
+ * - prefer `observationFromFlatToFhirR4` / `observationToFlatFhirR4`
+ * - avoid `observationFhirR4ToFlat`
+ */
+export function observationFromFlatToFhirR4(claims) {
     const subject = claims[ObservationClaim.Subject] ?? claims[ObservationClaim.Patient];
+    const codeToken = claims[ObservationClaim.Code]
+        ?? codingToValue({
+            system: claims[ObservationClaim.CodeSystem],
+            code: claims[ObservationClaim.CodeValue],
+        });
+    const valueConceptToken = claims[ObservationClaim.ValueConcept]
+        ?? codingToValue({
+            system: claims[ObservationClaim.ValueConceptSystem],
+            code: claims[ObservationClaim.ValueConceptValue],
+        });
+    const valueQuantityCoding = codingFromValue(claims[ObservationClaim.ValueQuantityUnit])?.[0];
     return {
         resourceType: 'Observation',
         identifier: claims[ObservationClaim.Identifier] ? [{ value: claims[ObservationClaim.Identifier] }] : undefined,
         status: claims[ObservationClaim.Status],
         category: claims[ObservationClaim.Category] ? claims[ObservationClaim.Category].split(',').map((value) => ({ coding: codingFromValue(value.trim()) })) : undefined,
-        code: claims[ObservationClaim.Code] ? { coding: codingFromValue(claims[ObservationClaim.Code]) } : undefined,
+        code: codeToken
+            ? {
+                coding: codingFromValue(codeToken),
+                ...(claims[ObservationClaim.CodeText] || claims[ObservationClaim.CodeDisplay]
+                    ? { text: claims[ObservationClaim.CodeText] ?? claims[ObservationClaim.CodeDisplay] }
+                    : {}),
+            }
+            : undefined,
         subject: subject ? { reference: subject } : undefined,
         effectiveDateTime: claims[ObservationClaim.EffectiveDateTime] ?? claims[ObservationClaim.Date],
         issued: claims[ObservationClaim.EffectiveDateTime] ? undefined : claims[ObservationClaim.Date],
         performer: claims[ObservationClaim.Performer] ? claims[ObservationClaim.Performer].split(',').map((reference) => ({ reference: reference.trim() })) : undefined,
-        valueCodeableConcept: claims[ObservationClaim.ValueConcept] ? { coding: codingFromValue(claims[ObservationClaim.ValueConcept]) } : undefined,
+        valueCodeableConcept: valueConceptToken
+            ? {
+                coding: codingFromValue(valueConceptToken),
+                ...(claims[ObservationClaim.ValueConceptText] || claims[ObservationClaim.ValueConceptDisplay]
+                    ? { text: claims[ObservationClaim.ValueConceptText] ?? claims[ObservationClaim.ValueConceptDisplay] }
+                    : {}),
+            }
+            : undefined,
         valueDateTime: claims[ObservationClaim.ValueDate],
+        valueQuantity: claims[ObservationClaim.ValueQuantityNumber]
+            ? {
+                value: Number(claims[ObservationClaim.ValueQuantityNumber]),
+                ...(claims[ObservationClaim.ValueQuantityComparator]
+                    ? { comparator: claims[ObservationClaim.ValueQuantityComparator] }
+                    : {}),
+                ...(claims[ObservationClaim.ValueQuantityUnit]
+                    ? {
+                        unit: claims[ObservationClaim.ValueQuantityUnit],
+                        ...(valueQuantityCoding?.system ? { system: valueQuantityCoding.system } : {}),
+                        ...(valueQuantityCoding?.code ? { code: valueQuantityCoding.code } : {}),
+                    }
+                    : {}),
+            }
+            : undefined,
         valueString: claims[ObservationClaim.ValueString],
         note: claims[ObservationClaim.Note] ? [{ text: claims[ObservationClaim.Note] }] : undefined,
         basedOn: claims[ObservationClaim.BasedOn] ? claims[ObservationClaim.BasedOn].split(',').map((reference) => ({ reference: reference.trim() })) : undefined,
@@ -25,16 +73,27 @@ export function observationFlatToFhirR4(claims) {
         hasMember: claims[ObservationClaim.HasMember] ? claims[ObservationClaim.HasMember].split(',').map((reference) => ({ reference: reference.trim() })) : undefined,
         method: claims[ObservationClaim.Method] ? { coding: codingFromValue(claims[ObservationClaim.Method]) } : undefined,
         specimen: claims[ObservationClaim.Specimen] ? { reference: claims[ObservationClaim.Specimen] } : undefined,
-        component: claims[ObservationClaim.ComponentCode] ? [{ code: { coding: codingFromValue(claims[ObservationClaim.ComponentCode]) } }] : undefined,
     };
 }
-export function observationFhirR4ToFlat(resource) {
+/**
+ * Converts a FHIR R4 Observation into the flat editable claims contract.
+ *
+ * `Observation.category` stays in `Observation.category`.
+ * Coded result values belong in `Observation.value-concept-*`.
+ */
+export function observationToFlatFhirR4(resource) {
     const valueCodeableConcept = resource.valueCodeableConcept;
-    const component = Array.isArray(resource.component) ? resource.component[0] : undefined;
+    const codeCoding = resource.code?.coding?.[0];
+    const valueConceptCoding = valueCodeableConcept?.coding?.[0];
+    const valueQuantity = resource.valueQuantity;
     return {
         [ObservationClaim.BasedOn]: referenceListToCsv(resource.basedOn),
         [ObservationClaim.Category]: codingListToCsv(resource.category?.flatMap((item) => item.coding || [])),
-        [ObservationClaim.Code]: codingToValue(resource.code?.coding?.[0]),
+        [ObservationClaim.Code]: codingToValue(codeCoding),
+        [ObservationClaim.CodeSystem]: codeCoding?.system,
+        [ObservationClaim.CodeValue]: codeCoding?.code,
+        [ObservationClaim.CodeText]: resource.code?.text,
+        [ObservationClaim.CodeDisplay]: codeCoding?.display,
         [ObservationClaim.Date]: resource.effectiveDateTime || resource.issued,
         [ObservationClaim.Device]: referenceToValue(resource.device),
         [ObservationClaim.Encounter]: referenceToValue(resource.encounter),
@@ -47,11 +106,23 @@ export function observationFhirR4ToFlat(resource) {
         [ObservationClaim.Specimen]: referenceToValue(resource.specimen),
         [ObservationClaim.Status]: resource.status,
         [ObservationClaim.Subject]: referenceToValue(resource.subject),
-        [ObservationClaim.ValueConcept]: codingToValue(valueCodeableConcept?.coding?.[0]),
+        [ObservationClaim.ValueConcept]: codingToValue(valueConceptCoding),
+        [ObservationClaim.ValueConceptSystem]: valueConceptCoding?.system,
+        [ObservationClaim.ValueConceptValue]: valueConceptCoding?.code,
+        [ObservationClaim.ValueConceptText]: valueCodeableConcept?.text,
+        [ObservationClaim.ValueConceptDisplay]: valueConceptCoding?.display,
         [ObservationClaim.ValueDate]: resource.valueDateTime,
+        [ObservationClaim.ValueQuantityComparator]: valueQuantity?.comparator,
+        [ObservationClaim.ValueQuantityNumber]: valueQuantity?.value !== undefined ? String(valueQuantity.value) : undefined,
+        [ObservationClaim.ValueQuantityUnit]: codingToValue(valueQuantity?.system || valueQuantity?.code
+            ? { system: valueQuantity?.system, code: valueQuantity?.code }
+            : undefined) || valueQuantity?.unit,
         [ObservationClaim.ValueString]: resource.valueString,
-        [ObservationClaim.ComponentCode]: codingToValue(component?.code?.coding?.[0]),
         [ObservationClaim.Note]: resource.note?.[0]?.text,
         [ObservationClaim.EffectiveDateTime]: resource.effectiveDateTime,
     };
 }
+/** @deprecated Prefer `observationFromFlatToFhirR4`. */
+export const observationFlatToFhirR4 = observationFromFlatToFhirR4;
+/** @deprecated Prefer `observationToFlatFhirR4`. */
+export const observationFhirR4ToFlat = observationToFlatFhirR4;

package/dist/examples/index.d.ts

@@ -16,3 +16,4 @@ export * from './contract-examples';
 export * from './communication-attached-bundle-session';
 export * from './communication-bundle-document-request';
 export * from './ips-bundle';
+export * from './vital-signs';

package/dist/examples/index.js

@@ -16,3 +16,4 @@ export * from './contract-examples.js';
 export * from './communication-attached-bundle-session.js';
 export * from './communication-bundle-document-request.js';
 export * from './ips-bundle.js';
+export * from './vital-signs.js';

package/dist/examples/license.d.ts

@@ -25,8 +25,169 @@ export declare const EXAMPLE_LICENSE_ACTIVE_RECORD: Readonly<{
         readonly "org.schema.Person.hasOccupation.identifier.value": "ISCO-08|2211";
     };
 }>;
+export declare const EXAMPLE_LICENSE_AVAILABLE_RECORD: Readonly<{
+    readonly id: "8a8a5e1b-0d8e-4a7c-8c39-3b8034440009";
+    readonly status: "available";
+    readonly subjectId: "urn:uuid:subject-license-available-001";
+    readonly claims: {
+        readonly "org.schema.IndividualProduct.serialNumber": "8a8a5e1b-0d8e-4a7c-8c39-3b8034440009";
+        readonly '@context': "org.schema";
+        readonly "org.schema.IndividualProduct.category": "professional";
+        readonly "org.schema.IndividualProduct.additionalType": "mobile";
+        readonly "org.schema.Person.email": "controller@acme.org";
+        readonly "org.schema.Person.hasOccupation.identifier.value": "ISCO-08|2211";
+    };
+}>;
+export declare const EXAMPLE_LICENSE_LIST_RESPONSE_BODY: Readonly<{
+    readonly data: readonly [{
+        readonly meta: {
+            readonly status: "active";
+            readonly subjectId: "urn:uuid:employee-controller-active-001";
+            readonly claims: {
+                readonly '@context': "org.schema";
+                readonly "org.schema.IndividualProduct.serialNumber": "8a8a5e1b-0d8e-4a7c-8c39-3b8034440001";
+                readonly "org.schema.IndividualProduct.category": "professional";
+                readonly "org.schema.IndividualProduct.additionalType": "mobile";
+                readonly "org.schema.Person.email": "controller@acme.org";
+                readonly "org.schema.Person.hasOccupation.identifier.value": "ISCO-08|2211";
+            };
+        };
+    }, {
+        readonly meta: {
+            readonly status: "available";
+            readonly subjectId: "urn:uuid:subject-license-available-001";
+            readonly claims: {
+                readonly "org.schema.IndividualProduct.serialNumber": "8a8a5e1b-0d8e-4a7c-8c39-3b8034440009";
+                readonly '@context': "org.schema";
+                readonly "org.schema.IndividualProduct.category": "professional";
+                readonly "org.schema.IndividualProduct.additionalType": "mobile";
+                readonly "org.schema.Person.email": "controller@acme.org";
+                readonly "org.schema.Person.hasOccupation.identifier.value": "ISCO-08|2211";
+            };
+        };
+    }];
+}>;
 export declare function buildExampleLicenseIssueClaims(): Readonly<Record<string, unknown>>;
 export declare function buildExampleLicensePurchaseClaims(): Readonly<Record<string, unknown>>;
 export declare const EXAMPLE_LICENSE_PURCHASE_CLAIMS: Readonly<Record<string, unknown>>;
 export declare const EXAMPLE_LICENSE_ISSUE_CLAIMS: Readonly<Record<string, unknown>>;
 export declare const EXAMPLE_LICENSE_PURCHASE_EXPECTED_SERIAL_NUMBER: string;
+/**
+ * Shared high-level preview used by SDK/runtime tests when an onboarding start
+ * flow returns an `Offer`.
+ */
+export declare const EXAMPLE_LICENSE_OFFER_PREVIEW: Readonly<Readonly<{
+    offerId?: string;
+    amount?: string;
+    currency?: string;
+    seats?: number;
+    planName?: string;
+    sku?: string;
+    paymentMethod?: string;
+    checkoutUrl?: string;
+}>>;
+/**
+ * Shared high-level summary used by SDK/runtime tests when an order is
+ * confirmed and GW returns payment/activation fields.
+ */
+export declare const EXAMPLE_LICENSE_ORDER_SUMMARY: Readonly<Readonly<{
+    acceptedOfferId?: string;
+    paymentUrl?: string;
+    invoiceId?: string;
+    paymentMethod?: string;
+    activationCode?: string;
+    amount?: string;
+    currency?: string;
+    seats?: number;
+}>>;
+/**
+ * Shared operational defaults reused by runtime tests that need stored
+ * `DeviceLicense` examples instead of higher-level Offer/Order claims.
+ */
+export declare const EXAMPLE_LICENSE_RUNTIME_DEFAULTS: Readonly<{
+    readonly plan: "default";
+    readonly renewalCycle: "12m";
+    readonly reactivationEnabled: true;
+}>;
+export declare const EXAMPLE_LICENSE_OFFER_RESPONSE_BODY: Readonly<{
+    readonly data: readonly [{
+        readonly meta: {
+            readonly claims: {
+                readonly "org.schema.Offer.identifier": "urn:offer:family-003";
+                readonly "org.schema.Offer.price": "9.99";
+                readonly "org.schema.Offer.priceCurrency": "EUR";
+                readonly "org.schema.Offer.eligibleQuantity.value": 2;
+                readonly "org.schema.Offer.itemOffered.name": "Family starter";
+                readonly "org.schema.Offer.itemOffered.sku": "FAM-START";
+                readonly "org.schema.Offer.acceptedPaymentMethod": "invoice";
+                readonly "org.schema.Offer.checkoutPageURLTemplate": "https://pay.example/offer-001";
+            };
+        };
+    }];
+}>;
+export declare const EXAMPLE_LICENSE_ORDER_RESPONSE_BODY: Readonly<{
+    readonly body: {
+        readonly data: readonly [{
+            readonly resource: {
+                readonly meta: {
+                    readonly claims: {
+                        readonly "org.schema.Order.acceptedOffer.identifier": "urn:offer:family-003";
+                        readonly "org.schema.Order.paymentUrl": "https://pay.example/invoice-001";
+                        readonly "org.schema.Order.partOfInvoice": "invoice-001";
+                        readonly "org.schema.Order.paymentMethod": "invoice";
+                        readonly "org.schema.Offer.price": "9.99";
+                        readonly "org.schema.Offer.priceCurrency": "EUR";
+                        readonly "org.schema.Offer.eligibleQuantity.value": string;
+                        readonly "org.schema.IndividualProduct.serialNumber": "ACT-001";
+                    };
+                };
+            };
+        }];
+    };
+}>;
+export declare const EXAMPLE_LICENSE_OFFER_LIST_RESPONSE_BODY: Readonly<{
+    readonly data: readonly [{
+        readonly resource: {
+            readonly total: 1;
+            readonly data: readonly [{
+                readonly id: "urn:offer:family-003";
+                readonly meta: {
+                    readonly status: "active";
+                    readonly claims: {
+                        readonly "org.schema.Offer.identifier": "urn:offer:family-003";
+                        readonly "org.schema.Offer.price": "9.99";
+                        readonly "org.schema.Offer.priceCurrency": "EUR";
+                        readonly "org.schema.Offer.eligibleQuantity.value": 2;
+                        readonly "org.schema.Offer.itemOffered.name": "Family starter";
+                        readonly "org.schema.Offer.itemOffered.sku": "FAM-START";
+                        readonly "org.schema.Offer.acceptedPaymentMethod": "invoice";
+                        readonly "org.schema.Offer.checkoutPageURLTemplate": "https://pay.example/offer-001";
+                    };
+                };
+            }];
+        };
+    }];
+}>;
+export declare const EXAMPLE_LICENSE_ORDER_LIST_RESPONSE_BODY: Readonly<{
+    readonly data: readonly [{
+        readonly resource: {
+            readonly total: 1;
+            readonly data: readonly [{
+                readonly id: "urn:offer:family-003";
+                readonly meta: {
+                    readonly status: "active";
+                    readonly claims: {
+                        readonly "org.schema.Order.acceptedOffer.identifier": "urn:offer:family-003";
+                        readonly "org.schema.Order.paymentUrl": "https://pay.example/invoice-001";
+                        readonly "org.schema.Order.partOfInvoice": "invoice-001";
+                        readonly "org.schema.Order.paymentMethod": "invoice";
+                        readonly "org.schema.Offer.price": "9.99";
+                        readonly "org.schema.Offer.priceCurrency": "EUR";
+                        readonly "org.schema.Offer.eligibleQuantity.value": string;
+                        readonly "org.schema.IndividualProduct.serialNumber": "ACT-001";
+                    };
+                };
+            }];
+        };
+    }];
+}>;

package/dist/examples/license.js

@@ -1,10 +1,11 @@
 import { DeviceAppTypes, DeviceUserClasses } from '../constants/device.js';
-import { ClaimsIndividualProductSchemaorg, ClaimsOfferSchemaorg, ClaimsPersonSchemaorg, } from '../constants/schemaorg.js';
-import { buildLicenseIssueClaims, buildLicensePurchaseClaims, LicenseCategories, LicenseStatuses, } from '../utils/license.js';
-import { EXAMPLE_EMAIL_CONTROLLER_ORG, EXAMPLE_EMPLOYEE_ACTIVATION_CODE, EXAMPLE_HEALTHCARE_ACTOR_ROLE_GENERALIST_MEDICAL_PRACTITIONER, } from './shared.js';
+import { ClaimsOrderSchemaorg, ClaimsIndividualProductSchemaorg, ClaimsOfferSchemaorg, ClaimsPersonSchemaorg, } from '../constants/schemaorg.js';
+import { buildLicenseIssueClaims, buildLicensePurchaseClaims, LicenseClaimContext, LicenseCategories, LicenseStatuses, } from '../utils/license.js';
+import { createLicenseOfferOrderEditor } from '../utils/license-offer-order.js';
+import { EXAMPLE_LICENSE_ACCEPTED_OFFER_ID, EXAMPLE_LICENSE_AMOUNT, EXAMPLE_LICENSE_CHECKOUT_URL, EXAMPLE_LICENSE_CURRENCY, EXAMPLE_EMAIL_CONTROLLER_ORG, EXAMPLE_EMPLOYEE_ACTIVATION_CODE, EXAMPLE_HEALTHCARE_ACTOR_ROLE_GENERALIST_MEDICAL_PRACTITIONER, EXAMPLE_LICENSE_INVOICE_ID, EXAMPLE_LICENSE_OFFER_ID, EXAMPLE_LICENSE_PLAN_DEFAULT, EXAMPLE_LICENSE_PAYMENT_METHOD_INVOICE, EXAMPLE_LICENSE_PAYMENT_URL, EXAMPLE_LICENSE_RENEWAL_CYCLE_YEARLY, EXAMPLE_LICENSE_PLAN_NAME, EXAMPLE_LICENSE_SEAT_UUID_ACTIVE, EXAMPLE_LICENSE_SEAT_UUID_AVAILABLE, EXAMPLE_LICENSE_SEAT_UUID_SECONDARY, EXAMPLE_LICENSE_SKU, EXAMPLE_LICENSE_SUBJECT_ID_ACTIVE, EXAMPLE_LICENSE_SUBJECT_ID_AVAILABLE, } from './shared.js';
 export const EXAMPLE_LICENSE_SEAT_UUIDS = Object.freeze([
-    '8a8a5e1b-0d8e-4a7c-8c39-3b8034440001',
-    '8a8a5e1b-0d8e-4a7c-8c39-3b8034440002',
+    EXAMPLE_LICENSE_SEAT_UUID_ACTIVE,
+    EXAMPLE_LICENSE_SEAT_UUID_SECONDARY,
 ]);
 export const EXAMPLE_LICENSE_ISSUE_INPUT = Object.freeze({
     email: EXAMPLE_EMAIL_CONTROLLER_ORG,
@@ -22,9 +23,9 @@ export const EXAMPLE_LICENSE_ACTIVE_RECORD = Object.freeze({
     id: EXAMPLE_LICENSE_SEAT_UUIDS[0],
     status: LicenseStatuses.Active,
     activationCode: EXAMPLE_EMPLOYEE_ACTIVATION_CODE,
-    subjectId: 'urn:uuid:employee-controller-active-001',
+    subjectId: EXAMPLE_LICENSE_SUBJECT_ID_ACTIVE,
     claims: {
-        '@context': 'org.schema',
+        '@context': LicenseClaimContext.SchemaOrg,
         [ClaimsIndividualProductSchemaorg.serialNumber]: EXAMPLE_LICENSE_SEAT_UUIDS[0],
         [ClaimsIndividualProductSchemaorg.category]: LicenseCategories.Professional,
         [ClaimsIndividualProductSchemaorg.additionalType]: DeviceAppTypes.Mobile,
@@ -32,6 +33,33 @@ export const EXAMPLE_LICENSE_ACTIVE_RECORD = Object.freeze({
         [ClaimsPersonSchemaorg.hasOccupationalRoleValue]: EXAMPLE_HEALTHCARE_ACTOR_ROLE_GENERALIST_MEDICAL_PRACTITIONER,
     },
 });
+export const EXAMPLE_LICENSE_AVAILABLE_RECORD = Object.freeze({
+    id: EXAMPLE_LICENSE_SEAT_UUID_AVAILABLE,
+    status: LicenseStatuses.Available,
+    subjectId: EXAMPLE_LICENSE_SUBJECT_ID_AVAILABLE,
+    claims: {
+        ...EXAMPLE_LICENSE_ACTIVE_RECORD.claims,
+        [ClaimsIndividualProductSchemaorg.serialNumber]: EXAMPLE_LICENSE_SEAT_UUID_AVAILABLE,
+    },
+});
+export const EXAMPLE_LICENSE_LIST_RESPONSE_BODY = Object.freeze({
+    data: [
+        {
+            meta: {
+                status: EXAMPLE_LICENSE_ACTIVE_RECORD.status,
+                subjectId: EXAMPLE_LICENSE_ACTIVE_RECORD.subjectId,
+                claims: EXAMPLE_LICENSE_ACTIVE_RECORD.claims,
+            },
+        },
+        {
+            meta: {
+                status: EXAMPLE_LICENSE_AVAILABLE_RECORD.status,
+                subjectId: EXAMPLE_LICENSE_AVAILABLE_RECORD.subjectId,
+                claims: EXAMPLE_LICENSE_AVAILABLE_RECORD.claims,
+            },
+        },
+    ],
+});
 export function buildExampleLicenseIssueClaims() {
     return Object.freeze(buildLicenseIssueClaims(EXAMPLE_LICENSE_ISSUE_INPUT));
 }
@@ -41,3 +69,104 @@ export function buildExampleLicensePurchaseClaims() {
 export const EXAMPLE_LICENSE_PURCHASE_CLAIMS = buildExampleLicensePurchaseClaims();
 export const EXAMPLE_LICENSE_ISSUE_CLAIMS = buildExampleLicenseIssueClaims();
 export const EXAMPLE_LICENSE_PURCHASE_EXPECTED_SERIAL_NUMBER = EXAMPLE_LICENSE_PURCHASE_CLAIMS[ClaimsOfferSchemaorg.serialNumber];
+/**
+ * Shared high-level preview used by SDK/runtime tests when an onboarding start
+ * flow returns an `Offer`.
+ */
+export const EXAMPLE_LICENSE_OFFER_PREVIEW = Object.freeze(createLicenseOfferOrderEditor()
+    .setOfferId(EXAMPLE_LICENSE_OFFER_ID)
+    .setAmount(EXAMPLE_LICENSE_AMOUNT)
+    .setCurrency(EXAMPLE_LICENSE_CURRENCY)
+    .setSeats(EXAMPLE_LICENSE_SEAT_UUIDS.length)
+    .setPlanName(EXAMPLE_LICENSE_PLAN_NAME)
+    .setSku(EXAMPLE_LICENSE_SKU)
+    .setPaymentMethod(EXAMPLE_LICENSE_PAYMENT_METHOD_INVOICE)
+    .setCheckoutUrl(EXAMPLE_LICENSE_CHECKOUT_URL)
+    .getOfferPreview());
+/**
+ * Shared high-level summary used by SDK/runtime tests when an order is
+ * confirmed and GW returns payment/activation fields.
+ */
+export const EXAMPLE_LICENSE_ORDER_SUMMARY = Object.freeze(createLicenseOfferOrderEditor()
+    .setAcceptedOfferId(EXAMPLE_LICENSE_ACCEPTED_OFFER_ID)
+    .setAmount(EXAMPLE_LICENSE_AMOUNT)
+    .setCurrency(EXAMPLE_LICENSE_CURRENCY)
+    .setSeats(EXAMPLE_LICENSE_SEAT_UUIDS.length + 1)
+    .setPaymentMethod(EXAMPLE_LICENSE_PAYMENT_METHOD_INVOICE)
+    .setPaymentUrl(EXAMPLE_LICENSE_PAYMENT_URL)
+    .setInvoiceId(EXAMPLE_LICENSE_INVOICE_ID)
+    .setActivationCode(EXAMPLE_EMPLOYEE_ACTIVATION_CODE)
+    .getOrderSummary());
+/**
+ * Shared operational defaults reused by runtime tests that need stored
+ * `DeviceLicense` examples instead of higher-level Offer/Order claims.
+ */
+export const EXAMPLE_LICENSE_RUNTIME_DEFAULTS = Object.freeze({
+    plan: EXAMPLE_LICENSE_PLAN_DEFAULT,
+    renewalCycle: EXAMPLE_LICENSE_RENEWAL_CYCLE_YEARLY,
+    reactivationEnabled: true,
+});
+export const EXAMPLE_LICENSE_OFFER_RESPONSE_BODY = Object.freeze({
+    data: [{
+            meta: {
+                claims: {
+                    [ClaimsOfferSchemaorg.identifier]: EXAMPLE_LICENSE_OFFER_ID,
+                    [ClaimsOfferSchemaorg.price]: EXAMPLE_LICENSE_AMOUNT,
+                    [ClaimsOfferSchemaorg.priceCurrency]: EXAMPLE_LICENSE_CURRENCY,
+                    [ClaimsOfferSchemaorg.eligibleQuantityValue]: EXAMPLE_LICENSE_SEAT_UUIDS.length,
+                    [ClaimsOfferSchemaorg.itemOfferedName]: EXAMPLE_LICENSE_PLAN_NAME,
+                    [ClaimsOfferSchemaorg.itemOfferedSku]: EXAMPLE_LICENSE_SKU,
+                    [ClaimsOfferSchemaorg.acceptedPaymentMethod]: EXAMPLE_LICENSE_PAYMENT_METHOD_INVOICE,
+                    [ClaimsOfferSchemaorg.checkoutPageURLTemplate]: EXAMPLE_LICENSE_CHECKOUT_URL,
+                },
+            },
+        }],
+});
+export const EXAMPLE_LICENSE_ORDER_RESPONSE_BODY = Object.freeze({
+    body: {
+        data: [{
+                resource: {
+                    meta: {
+                        claims: {
+                            [ClaimsOrderSchemaorg.acceptedOfferIdentifier]: EXAMPLE_LICENSE_ACCEPTED_OFFER_ID,
+                            [ClaimsOrderSchemaorg.paymentUrl]: EXAMPLE_LICENSE_PAYMENT_URL,
+                            [ClaimsOrderSchemaorg.partOfInvoice]: EXAMPLE_LICENSE_INVOICE_ID,
+                            [ClaimsOrderSchemaorg.paymentMethod]: EXAMPLE_LICENSE_PAYMENT_METHOD_INVOICE,
+                            [ClaimsOfferSchemaorg.price]: EXAMPLE_LICENSE_AMOUNT,
+                            [ClaimsOfferSchemaorg.priceCurrency]: EXAMPLE_LICENSE_CURRENCY,
+                            [ClaimsOfferSchemaorg.eligibleQuantityValue]: String(EXAMPLE_LICENSE_SEAT_UUIDS.length + 1),
+                            [ClaimsIndividualProductSchemaorg.serialNumber]: EXAMPLE_EMPLOYEE_ACTIVATION_CODE,
+                        },
+                    },
+                },
+            }],
+    },
+});
+export const EXAMPLE_LICENSE_OFFER_LIST_RESPONSE_BODY = Object.freeze({
+    data: [{
+            resource: {
+                total: 1,
+                data: [{
+                        id: EXAMPLE_LICENSE_OFFER_ID,
+                        meta: {
+                            status: 'active',
+                            claims: EXAMPLE_LICENSE_OFFER_RESPONSE_BODY.data[0].meta.claims,
+                        },
+                    }],
+            },
+        }],
+});
+export const EXAMPLE_LICENSE_ORDER_LIST_RESPONSE_BODY = Object.freeze({
+    data: [{
+            resource: {
+                total: 1,
+                data: [{
+                        id: EXAMPLE_LICENSE_ACCEPTED_OFFER_ID,
+                        meta: {
+                            status: 'active',
+                            claims: EXAMPLE_LICENSE_ORDER_RESPONSE_BODY.body.data[0].resource.meta.claims,
+                        },
+                    }],
+            },
+        }],
+});

package/dist/examples/lifecycle.d.ts

@@ -10,6 +10,8 @@ export declare const EXAMPLE_LIFECYCLE_OPERATIONS: {
     readonly disable: "disable";
     readonly delete: "delete";
 };
+export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_REQUEST_TYPE: "Family-disable-request-v1.0";
+export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_REQUEST_TYPE: "Family-purge-request-v1.0";
 /**
  * Shared placeholder values used by copy/paste examples.
  *
@@ -179,6 +181,27 @@ export declare const EXAMPLE_INDIVIDUAL_DISABLE_MESSAGE: {
         readonly erasesPersonalDataImmediately: false;
     };
 };
+export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_ENTRY: Readonly<{
+    type: string;
+    request: {
+        method: "POST";
+    };
+    meta: {
+        claims: import("..").IndividualOrganizationLifecycleClaims;
+    };
+    resource: {
+        id?: string;
+        meta: {
+            claims: import("..").IndividualOrganizationLifecycleClaims;
+        };
+    };
+}>;
+export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_PAYLOAD: Readonly<{
+    thid: string;
+    body: {
+        data: import("..").IndividualOrganizationLifecycleDataEntry[];
+    };
+}>;
 export declare const EXAMPLE_INDIVIDUAL_DELETE_MESSAGE: {
     readonly operation: "delete";
     readonly resourceType: "IndividualOrganization";
@@ -199,6 +222,27 @@ export declare const EXAMPLE_INDIVIDUAL_DELETE_MESSAGE: {
         readonly keepsMinimumAuditTrailRequiredByLaw: true;
     };
 };
+export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_ENTRY: Readonly<{
+    type: string;
+    request: {
+        method: "POST";
+    };
+    meta: {
+        claims: import("..").IndividualOrganizationLifecycleClaims;
+    };
+    resource: {
+        id?: string;
+        meta: {
+            claims: import("..").IndividualOrganizationLifecycleClaims;
+        };
+    };
+}>;
+export declare const EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_PAYLOAD: Readonly<{
+    thid: string;
+    body: {
+        data: import("..").IndividualOrganizationLifecycleDataEntry[];
+    };
+}>;
 export declare const EXAMPLE_CONSENT_ENABLE_MESSAGE: {
     readonly operation: "enable";
     readonly resourceType: "Consent";

package/dist/examples/lifecycle.js

@@ -1,6 +1,7 @@
 // Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
 import { ClaimsOrganizationSchemaorg, ClaimsPersonSchemaorg, } from '../constants/schemaorg.js';
 import { ClaimConsent } from '../models/consent-rule.js';
+import { IndividualOrganizationLifecycleDraft, IndividualOrganizationLifecycleOperations, } from '../utils/individual-organization-lifecycle.js';
 import { EXAMPLE_EMAIL_CONTROLLER_INDIVIDUAL, EXAMPLE_EMAIL_CONTROLLER_ORG, EXAMPLE_CLINICAL_SECTION_ALLERGIES, EXAMPLE_CONSENT_PURPOSE_TREATMENT, EXAMPLE_HEALTHCARE_ACTOR_ROLE_PHYSICIAN, EXAMPLE_JURISDICTION, EXAMPLE_SECTOR, EXAMPLE_TENANT_IDENTIFIER, } from './shared.js';
 /**
  * Canonical lifecycle naming for `v1`.
@@ -14,6 +15,8 @@ export const EXAMPLE_LIFECYCLE_OPERATIONS = {
     disable: 'disable',
     delete: 'delete',
 };
+export const EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_REQUEST_TYPE = 'Family-disable-request-v1.0';
+export const EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_REQUEST_TYPE = 'Family-purge-request-v1.0';
 /**
  * Shared placeholder values used by copy/paste examples.
  *
@@ -183,6 +186,17 @@ export const EXAMPLE_INDIVIDUAL_DISABLE_MESSAGE = {
         erasesPersonalDataImmediately: false,
     },
 };
+export const EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_ENTRY = new IndividualOrganizationLifecycleDraft()
+    .setClaims(EXAMPLE_INDIVIDUAL_DISABLE_MESSAGE.claims)
+    .setOperation(IndividualOrganizationLifecycleOperations.Disable)
+    .setRequestType(EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_REQUEST_TYPE)
+    .buildCurrentGwDataEntry();
+export const EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_PAYLOAD = new IndividualOrganizationLifecycleDraft()
+    .setClaims(EXAMPLE_INDIVIDUAL_DISABLE_MESSAGE.claims)
+    .setOperation(IndividualOrganizationLifecycleOperations.Disable)
+    .setRequestType(EXAMPLE_INDIVIDUAL_ORGANIZATION_DISABLE_REQUEST_TYPE)
+    .setThreadId('individual-organization-disable-example-001')
+    .buildCurrentGwPayload();
 export const EXAMPLE_INDIVIDUAL_DELETE_MESSAGE = {
     operation: EXAMPLE_LIFECYCLE_OPERATIONS.delete,
     resourceType: 'IndividualOrganization',
@@ -203,6 +217,17 @@ export const EXAMPLE_INDIVIDUAL_DELETE_MESSAGE = {
         keepsMinimumAuditTrailRequiredByLaw: true,
     },
 };
+export const EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_ENTRY = new IndividualOrganizationLifecycleDraft()
+    .setClaims(EXAMPLE_INDIVIDUAL_DISABLE_MESSAGE.claims)
+    .setOperation(IndividualOrganizationLifecycleOperations.Purge)
+    .setRequestType(EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_REQUEST_TYPE)
+    .buildCurrentGwDataEntry();
+export const EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_PAYLOAD = new IndividualOrganizationLifecycleDraft()
+    .setClaims(EXAMPLE_INDIVIDUAL_DISABLE_MESSAGE.claims)
+    .setOperation(IndividualOrganizationLifecycleOperations.Purge)
+    .setRequestType(EXAMPLE_INDIVIDUAL_ORGANIZATION_PURGE_REQUEST_TYPE)
+    .setThreadId('individual-organization-purge-example-001')
+    .buildCurrentGwPayload();
 export const EXAMPLE_CONSENT_ENABLE_MESSAGE = {
     operation: EXAMPLE_LIFECYCLE_OPERATIONS.enable,
     resourceType: 'Consent',