gdc-sdk-front-ts 2.1.2 → 2.3.0

package/dist/gdc-common-utils-ts/src/examples/lifecycle.d.ts

@@ -1,505 +0,0 @@
-/**
- * Canonical lifecycle naming for `v1`.
- *
- * SDKs, Swagger examples, portal payload builders, and GW adapters should use
- * these semantic operation names instead of mixing `revoke`, `suspend`,
- * `deactivate`, or product-specific labels at the API contract layer.
- */
-export declare const EXAMPLE_LIFECYCLE_OPERATIONS: {
-    readonly enable: "enable";
-    readonly disable: "disable";
-    readonly delete: "delete";
-};
-/**
- * Shared placeholder values used by copy/paste examples.
- *
- * These are intentionally synthetic and stable. Repositories should override
- * them at runtime with environment variables, UI form values, or test fixtures
- * rather than committing personal data.
- *
- * Keep all repeated actor/section/code fixtures imported from `./shared`.
- */
-export declare const EXAMPLE_LIFECYCLE_PLACEHOLDERS: {
-    readonly tenantId: "acme-id";
-    readonly jurisdiction: "ES";
-    readonly sector: "health-care";
-    readonly tenantTaxId: "{{tenantTaxId}}";
-    readonly tenantDid: "{{tenantDid}}";
-    readonly employeeIdentifier: "{{employeeIdentifier}}";
-    readonly employeeEmail: "{{employeeEmail}}";
-    readonly employeeRole: "{{employeeRole}}";
-    readonly individualIdentifier: "{{individualIdentifier}}";
-    readonly individualAlternateName: "{{individualAlternateName}}";
-    readonly individualSubjectDid: "{{individualSubjectDid}}";
-    readonly consentIdentifier: "{{consentIdentifier}}";
-    readonly consentActorIdentifier: "{{consentActorIdentifier}}";
-    readonly deleteReason: "{{deleteReason}}";
-    readonly icaCredentialStatus: "{{icaCredentialStatus}}";
-};
-/**
- * Canonical semantic lifecycle message examples.
- *
- * These examples are transport-neutral. GW Swagger, Node SDK, Front SDK, and
- * backend adapters may embed them inside route-specific envelopes, but they
- * must not fork the claim content or lifecycle naming.
- */
-export declare const EXAMPLE_EMPLOYEE_ENABLE_MESSAGE: {
-    readonly operation: "enable";
-    readonly resourceType: "Employee";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Person.identifier": "{{employeeIdentifier}}";
-        readonly "org.schema.Person.email": "{{employeeEmail}}";
-        readonly "org.schema.Person.hasOccupation.identifier.value": "{{employeeRole}}";
-    };
-};
-export declare const EXAMPLE_EMPLOYEE_DISABLE_MESSAGE: {
-    readonly operation: "disable";
-    readonly resourceType: "Employee";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Person.identifier": "{{employeeIdentifier}}";
-        readonly "org.schema.Person.email": "{{employeeEmail}}";
-        readonly "org.schema.Person.hasOccupation.identifier.value": "{{employeeRole}}";
-    };
-    readonly expectedSemantics: {
-        readonly keepsAuditTrail: true;
-        readonly releasesLicenseSeat: false;
-        readonly requiresIcaCredentialStatusUpdate: true;
-    };
-};
-export declare const EXAMPLE_EMPLOYEE_DELETE_MESSAGE: {
-    readonly operation: "delete";
-    readonly resourceType: "Employee";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Person.identifier": "{{employeeIdentifier}}";
-        readonly "org.schema.Person.email": "{{employeeEmail}}";
-        readonly "org.schema.Person.hasOccupation.identifier.value": "{{employeeRole}}";
-    };
-    readonly deleteReason: "{{deleteReason}}";
-};
-export declare const EXAMPLE_TENANT_ENABLE_MESSAGE: {
-    readonly operation: "enable";
-    readonly resourceType: "Organization";
-    readonly routeContext: {
-        readonly tenantId: "host";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Organization.identifier.value": "{{tenantTaxId}}";
-        readonly "org.schema.Organization.taxID": "{{tenantTaxId}}";
-        readonly "org.schema.Organization.identifier": "{{tenantDid}}";
-    };
-};
-export declare const EXAMPLE_TENANT_DISABLE_MESSAGE: {
-    readonly operation: "disable";
-    readonly resourceType: "Organization";
-    readonly routeContext: {
-        readonly tenantId: "host";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Organization.identifier.value": "{{tenantTaxId}}";
-        readonly "org.schema.Organization.taxID": "{{tenantTaxId}}";
-        readonly "org.schema.Organization.identifier": "{{tenantDid}}";
-    };
-    readonly expectedSemantics: {
-        readonly keepsAuditTrail: true;
-        readonly purgeAllowedByDefault: false;
-        readonly requiresIcaCredentialStatusUpdate: true;
-    };
-};
-export declare const EXAMPLE_TENANT_DELETE_MESSAGE: {
-    readonly operation: "delete";
-    readonly resourceType: "Organization";
-    readonly routeContext: {
-        readonly tenantId: "host";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Organization.identifier.value": "{{tenantTaxId}}";
-        readonly "org.schema.Organization.taxID": "{{tenantTaxId}}";
-        readonly "org.schema.Organization.identifier": "{{tenantDid}}";
-    };
-    readonly deleteReason: "{{deleteReason}}";
-};
-export declare const EXAMPLE_INDIVIDUAL_ENABLE_MESSAGE: {
-    readonly operation: "enable";
-    readonly resourceType: "IndividualOrganization";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Organization.identifier": "{{individualIdentifier}}";
-        readonly "org.schema.Organization.alternateName": "{{individualAlternateName}}";
-        readonly "org.schema.Organization.owner.email": "ana.parent@example.org";
-    };
-};
-export declare const EXAMPLE_INDIVIDUAL_DISABLE_MESSAGE: {
-    readonly operation: "disable";
-    readonly resourceType: "IndividualOrganization";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Organization.identifier": "{{individualIdentifier}}";
-        readonly "org.schema.Organization.alternateName": "{{individualAlternateName}}";
-        readonly "org.schema.Organization.owner.email": "ana.parent@example.org";
-    };
-    readonly expectedSemantics: {
-        readonly keepsAuditTrail: true;
-        readonly erasesPersonalDataImmediately: false;
-    };
-};
-export declare const EXAMPLE_INDIVIDUAL_DELETE_MESSAGE: {
-    readonly operation: "delete";
-    readonly resourceType: "IndividualOrganization";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.schema";
-        readonly "org.schema.Organization.identifier": "{{individualIdentifier}}";
-        readonly "org.schema.Organization.alternateName": "{{individualAlternateName}}";
-        readonly "org.schema.Organization.owner.email": "ana.parent@example.org";
-    };
-    readonly deleteReason: "right-to-be-forgotten";
-    readonly expectedSemantics: {
-        readonly invokesPrivacyWorkflow: true;
-        readonly keepsMinimumAuditTrailRequiredByLaw: true;
-    };
-};
-export declare const EXAMPLE_CONSENT_ENABLE_MESSAGE: {
-    readonly operation: "enable";
-    readonly resourceType: "Consent";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.hl7.fhir.api";
-        readonly "Consent.identifier": "{{consentIdentifier}}";
-        readonly "Consent.subject": "{{individualSubjectDid}}";
-        readonly "Consent.actor-identifier": "{{consentActorIdentifier}}";
-        readonly "Consent.actor-role": "ISCO-08|2211";
-        readonly "Consent.purpose": "TREAT";
-        readonly "Consent.action": string;
-        readonly "Consent.decision": "permit";
-    };
-};
-export declare const EXAMPLE_CONSENT_DISABLE_MESSAGE: {
-    readonly operation: "disable";
-    readonly resourceType: "Consent";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.hl7.fhir.api";
-        readonly "Consent.identifier": "{{consentIdentifier}}";
-        readonly "Consent.subject": "{{individualSubjectDid}}";
-        readonly "Consent.actor-identifier": "{{consentActorIdentifier}}";
-        readonly "Consent.actor-role": "ISCO-08|2211";
-        readonly "Consent.purpose": "TREAT";
-        readonly "Consent.action": string;
-        readonly "Consent.decision": "permit";
-    };
-};
-export declare const EXAMPLE_CONSENT_DELETE_MESSAGE: {
-    readonly operation: "delete";
-    readonly resourceType: "Consent";
-    readonly routeContext: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-    };
-    readonly claims: {
-        readonly '@context': "org.hl7.fhir.api";
-        readonly "Consent.identifier": "{{consentIdentifier}}";
-        readonly "Consent.subject": "{{individualSubjectDid}}";
-        readonly "Consent.actor-identifier": "{{consentActorIdentifier}}";
-    };
-    readonly deleteReason: "{{deleteReason}}";
-};
-/**
- * A compact reference object that documentation generators and SDK tutorials can
- * render without having to cherry-pick individual exports by hand.
- */
-export declare const EXAMPLE_LIFECYCLE_REFERENCE: {
-    readonly placeholders: {
-        readonly tenantId: "acme-id";
-        readonly jurisdiction: "ES";
-        readonly sector: "health-care";
-        readonly tenantTaxId: "{{tenantTaxId}}";
-        readonly tenantDid: "{{tenantDid}}";
-        readonly employeeIdentifier: "{{employeeIdentifier}}";
-        readonly employeeEmail: "{{employeeEmail}}";
-        readonly employeeRole: "{{employeeRole}}";
-        readonly individualIdentifier: "{{individualIdentifier}}";
-        readonly individualAlternateName: "{{individualAlternateName}}";
-        readonly individualSubjectDid: "{{individualSubjectDid}}";
-        readonly consentIdentifier: "{{consentIdentifier}}";
-        readonly consentActorIdentifier: "{{consentActorIdentifier}}";
-        readonly deleteReason: "{{deleteReason}}";
-        readonly icaCredentialStatus: "{{icaCredentialStatus}}";
-    };
-    readonly operations: {
-        readonly enable: "enable";
-        readonly disable: "disable";
-        readonly delete: "delete";
-    };
-    readonly employee: {
-        readonly enable: {
-            readonly operation: "enable";
-            readonly resourceType: "Employee";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Person.identifier": "{{employeeIdentifier}}";
-                readonly "org.schema.Person.email": "{{employeeEmail}}";
-                readonly "org.schema.Person.hasOccupation.identifier.value": "{{employeeRole}}";
-            };
-        };
-        readonly disable: {
-            readonly operation: "disable";
-            readonly resourceType: "Employee";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Person.identifier": "{{employeeIdentifier}}";
-                readonly "org.schema.Person.email": "{{employeeEmail}}";
-                readonly "org.schema.Person.hasOccupation.identifier.value": "{{employeeRole}}";
-            };
-            readonly expectedSemantics: {
-                readonly keepsAuditTrail: true;
-                readonly releasesLicenseSeat: false;
-                readonly requiresIcaCredentialStatusUpdate: true;
-            };
-        };
-        readonly delete: {
-            readonly operation: "delete";
-            readonly resourceType: "Employee";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Person.identifier": "{{employeeIdentifier}}";
-                readonly "org.schema.Person.email": "{{employeeEmail}}";
-                readonly "org.schema.Person.hasOccupation.identifier.value": "{{employeeRole}}";
-            };
-            readonly deleteReason: "{{deleteReason}}";
-        };
-    };
-    readonly tenant: {
-        readonly enable: {
-            readonly operation: "enable";
-            readonly resourceType: "Organization";
-            readonly routeContext: {
-                readonly tenantId: "host";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Organization.identifier.value": "{{tenantTaxId}}";
-                readonly "org.schema.Organization.taxID": "{{tenantTaxId}}";
-                readonly "org.schema.Organization.identifier": "{{tenantDid}}";
-            };
-        };
-        readonly disable: {
-            readonly operation: "disable";
-            readonly resourceType: "Organization";
-            readonly routeContext: {
-                readonly tenantId: "host";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Organization.identifier.value": "{{tenantTaxId}}";
-                readonly "org.schema.Organization.taxID": "{{tenantTaxId}}";
-                readonly "org.schema.Organization.identifier": "{{tenantDid}}";
-            };
-            readonly expectedSemantics: {
-                readonly keepsAuditTrail: true;
-                readonly purgeAllowedByDefault: false;
-                readonly requiresIcaCredentialStatusUpdate: true;
-            };
-        };
-        readonly delete: {
-            readonly operation: "delete";
-            readonly resourceType: "Organization";
-            readonly routeContext: {
-                readonly tenantId: "host";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Organization.identifier.value": "{{tenantTaxId}}";
-                readonly "org.schema.Organization.taxID": "{{tenantTaxId}}";
-                readonly "org.schema.Organization.identifier": "{{tenantDid}}";
-            };
-            readonly deleteReason: "{{deleteReason}}";
-        };
-    };
-    readonly individual: {
-        readonly enable: {
-            readonly operation: "enable";
-            readonly resourceType: "IndividualOrganization";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Organization.identifier": "{{individualIdentifier}}";
-                readonly "org.schema.Organization.alternateName": "{{individualAlternateName}}";
-                readonly "org.schema.Organization.owner.email": "ana.parent@example.org";
-            };
-        };
-        readonly disable: {
-            readonly operation: "disable";
-            readonly resourceType: "IndividualOrganization";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Organization.identifier": "{{individualIdentifier}}";
-                readonly "org.schema.Organization.alternateName": "{{individualAlternateName}}";
-                readonly "org.schema.Organization.owner.email": "ana.parent@example.org";
-            };
-            readonly expectedSemantics: {
-                readonly keepsAuditTrail: true;
-                readonly erasesPersonalDataImmediately: false;
-            };
-        };
-        readonly delete: {
-            readonly operation: "delete";
-            readonly resourceType: "IndividualOrganization";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.schema";
-                readonly "org.schema.Organization.identifier": "{{individualIdentifier}}";
-                readonly "org.schema.Organization.alternateName": "{{individualAlternateName}}";
-                readonly "org.schema.Organization.owner.email": "ana.parent@example.org";
-            };
-            readonly deleteReason: "right-to-be-forgotten";
-            readonly expectedSemantics: {
-                readonly invokesPrivacyWorkflow: true;
-                readonly keepsMinimumAuditTrailRequiredByLaw: true;
-            };
-        };
-    };
-    readonly consent: {
-        readonly enable: {
-            readonly operation: "enable";
-            readonly resourceType: "Consent";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.hl7.fhir.api";
-                readonly "Consent.identifier": "{{consentIdentifier}}";
-                readonly "Consent.subject": "{{individualSubjectDid}}";
-                readonly "Consent.actor-identifier": "{{consentActorIdentifier}}";
-                readonly "Consent.actor-role": "ISCO-08|2211";
-                readonly "Consent.purpose": "TREAT";
-                readonly "Consent.action": string;
-                readonly "Consent.decision": "permit";
-            };
-        };
-        readonly disable: {
-            readonly operation: "disable";
-            readonly resourceType: "Consent";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.hl7.fhir.api";
-                readonly "Consent.identifier": "{{consentIdentifier}}";
-                readonly "Consent.subject": "{{individualSubjectDid}}";
-                readonly "Consent.actor-identifier": "{{consentActorIdentifier}}";
-                readonly "Consent.actor-role": "ISCO-08|2211";
-                readonly "Consent.purpose": "TREAT";
-                readonly "Consent.action": string;
-                readonly "Consent.decision": "permit";
-            };
-        };
-        readonly delete: {
-            readonly operation: "delete";
-            readonly resourceType: "Consent";
-            readonly routeContext: {
-                readonly tenantId: "acme-id";
-                readonly jurisdiction: "ES";
-                readonly sector: "health-care";
-            };
-            readonly claims: {
-                readonly '@context': "org.hl7.fhir.api";
-                readonly "Consent.identifier": "{{consentIdentifier}}";
-                readonly "Consent.subject": "{{individualSubjectDid}}";
-                readonly "Consent.actor-identifier": "{{consentActorIdentifier}}";
-            };
-            readonly deleteReason: "{{deleteReason}}";
-        };
-    };
-    readonly exampleActors: {
-        readonly organizationControllerEmail: "controller@acme.org";
-        readonly individualControllerEmail: "ana.parent@example.org";
-    };
-};