gdc-sdk-front-ts 0.6.7 → 0.8.0

package/README.md

@@ -86,7 +86,7 @@ Main references:
 
 Use:
 
-- `EmployeeBundleSession` for employee create/search payloads
+- `BundleEditor` plus `EmployeeEntryEditor` for employee create/search/disable/purge payloads
 - `CommunicationAttachedBundleSession` for `Communication`-carried bundles
 - `createConsentAccessEditor(...)` for consent editing inside a communication bundle
 
@@ -114,24 +114,31 @@ Those actor families should start from their own business flow:
 
 ### Create
 
-Use `EmployeeBundleSession` to prepare one employee create bundle. The browser
+Use `BundleEditor` plus one employee entry editor to prepare one employee create bundle. The browser
 does not send it directly to GW CORE.
 The portal backend wraps it into its own request/envelope, then applies KMS,
 DIDComm, submit, and poll.
 
 ```ts
-import { EmployeeBundleSession } from 'gdc-sdk-core-ts';
+import { BundleEditor } from 'gdc-sdk-core-ts';
 import {
   EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE,
   EXAMPLE_PROVIDER_ORGANIZATION_DID,
 } from 'gdc-common-utils-ts/examples';
 import { ClaimsPersonSchemaorg } from 'gdc-common-utils-ts/constants/schemaorg';
+import {
+  EmployeeBundleOperations,
+  EmployeeResourceTypes,
+} from 'gdc-common-utils-ts/utils/employee';
 
 // This editor lives only in frontend memory.
 // It helps the UI build the canonical employee payload before sending it to
 // the portal backend.
-const bundleEditor = new EmployeeBundleSession()
-  .setIdentifier(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier)
+const employeeEntry = new BundleEditor()
+  .setBundleOperation(EmployeeBundleOperations.create)
+  .setAllowedResourceType(EmployeeResourceTypes.employee)
+  .newEntry()
+  .asEmployee()
   .setEmail(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.email)
   .setRole(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.role)
   .addClaim(ClaimsPersonSchemaorg.memberOf, EXAMPLE_PROVIDER_ORGANIZATION_DID);
@@ -139,13 +146,58 @@ const bundleEditor = new EmployeeBundleSession()
 // `employeeCreateBatchBundle` is the canonical one-entry employee `_batch` bundle.
 // Your Vite frontend normally sends this bundle to its own backend, not
 // directly to GW CORE.
-const employeeCreateBatchBundle = bundleEditor.toBundleBatch({
-  method: 'POST',
-  resourceId: EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier,
-});
+const generatedEmployeeIdentifier = employeeEntry.getIdentifier();
+const employeeCreateBatchBundle = employeeEntry.doneEntry().build();
 console.log(employeeCreateBatchBundle);
 ```
 
+If the frontend does not provide an employee identifier up front, the create
+flow can generate one and keep it in the same editor:
+
+```ts
+import { EmployeeBundleOperations } from 'gdc-common-utils-ts/utils/employee';
+
+const employeeEntry = new BundleEditor()
+  .setBundleOperation(EmployeeBundleOperations.create)
+  .setAllowedResourceType(EmployeeResourceTypes.employee)
+  .newEntry()
+  .asEmployee()
+  .setEmail(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.email)
+  .setRole(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.role);
+
+const generatedEmployeeIdentifier = employeeEntry.getIdentifier();
+const employeeCreateBatchBundle = employeeEntry.doneEntry().build();
+```
+
+If a frontend needs explicit claim-level control instead of only `setEmail()` /
+`setRole()`, the same editor also exposes generic claim methods:
+
+```ts
+import { BundleEditor } from 'gdc-sdk-core-ts';
+import {
+  EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE,
+  EXAMPLE_PROVIDER_ORGANIZATION_DID,
+} from 'gdc-common-utils-ts/examples';
+import { ClaimsPersonSchemaorg } from 'gdc-common-utils-ts/constants/schemaorg';
+import {
+  EmployeeBundleOperations,
+  EmployeeResourceTypes,
+} from 'gdc-common-utils-ts/utils/employee';
+
+const employeeEntry = new BundleEditor()
+  .setBundleOperation(EmployeeBundleOperations.create)
+  .setAllowedResourceType(EmployeeResourceTypes.employee)
+  .newEntry(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier)
+  .asEmployee()
+  .setClaim(ClaimsPersonSchemaorg.email, EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.email)
+  .setClaim(ClaimsPersonSchemaorg.hasOccupationalRoleValue, EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.role)
+  .addClaim(ClaimsPersonSchemaorg.memberOf, EXAMPLE_PROVIDER_ORGANIZATION_DID);
+
+console.log(employeeEntry.getClaim(ClaimsPersonSchemaorg.email));
+
+const employeeCreateBatchBundle = employeeEntry.doneEntry().build();
+```
+
 ### Search
 
 Search is a different operation and should be built separately.
@@ -153,13 +205,22 @@ Search is a different operation and should be built separately.
 `email + role` is the recommended exact operational lookup.
 
 ```ts
-import { EmployeeBundleSession } from 'gdc-sdk-core-ts';
+import { BundleEditor } from 'gdc-sdk-core-ts';
 import { EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE } from 'gdc-common-utils-ts/examples';
-
-const employeeSearchBundle = new EmployeeBundleSession()
+import {
+  EmployeeBundleOperations,
+  EmployeeResourceTypes,
+} from 'gdc-common-utils-ts/utils/employee';
+
+const employeeSearchBundle = new BundleEditor()
+  .setBundleOperation(EmployeeBundleOperations.search)
+  .setAllowedResourceType(EmployeeResourceTypes.employee)
+  .newEntry()
+  .asEmployee()
   .setEmail(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.email)
   .setRole(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.role)
-  .toBundleSearch();
+  .doneEntry()
+  .build();
 
 console.log(employeeSearchBundle);
 ```
@@ -177,15 +238,20 @@ Disable is a lifecycle operation. Today the shared employee editor still
 produces the canonical `_batch` bundle with inner `request.method = DELETE`.
 
 ```ts
-import { EmployeeBundleSession } from 'gdc-sdk-core-ts';
+import { BundleEditor } from 'gdc-sdk-core-ts';
 import { EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE } from 'gdc-common-utils-ts/examples';
-
-const employeeDisableBatchBundle = new EmployeeBundleSession()
-  .setIdentifier(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier)
-  .toBundleBatch({
-    method: 'DELETE',
-    resourceId: EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier,
-  });
+import {
+  EmployeeBundleOperations,
+  EmployeeResourceTypes,
+} from 'gdc-common-utils-ts/utils/employee';
+
+const employeeDisableBatchBundle = new BundleEditor()
+  .setBundleOperation(EmployeeBundleOperations.disable)
+  .setAllowedResourceType(EmployeeResourceTypes.employee)
+  .newEntry(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier)
+  .asEmployee()
+  .doneEntry()
+  .build();
 
 console.log(employeeDisableBatchBundle);
 ```
@@ -202,12 +268,13 @@ Current GW CORE contract vs preferred target:
 Conceptual `PATCH` example for state change:
 
 ```ts
-const employeeDisablePatchBatchBundle = new EmployeeBundleSession()
-  .setIdentifier(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier)
-  .toBundleBatch({
-    method: 'PATCH',
-    resourceId: EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier,
-  });
+import { EmployeeBundleOperations } from 'gdc-common-utils-ts/utils/employee';
+
+const employeeDisablePatchBatchBundle = new BundleEditor()
+  .setBundleOperation(EmployeeBundleOperations.disable)
+  .setAllowedResourceType(EmployeeResourceTypes.employee)
+  .newEntry(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier)
+  .asEmployee();
 ```
 
 Business meaning:
@@ -219,19 +286,28 @@ Business meaning:
 
 ### Purge
 
-Purge is not the same contract as create/disable. The portal backend or runtime
-calls the explicit `Employee/_purge` flow and normally identifies the employee
-with `identifier`.
+Purge is not the same route as create/disable, but the frontend should still
+prepare a `Bundle` for it. The portal backend or runtime later submits that
+bundle to the explicit `Employee/_purge` flow. The canonical purge selector is
+the employee `identifier`.
 
 ```ts
-import { EmployeeBundleSession } from 'gdc-sdk-core-ts';
+import { BundleEditor } from 'gdc-sdk-core-ts';
 import { EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE } from 'gdc-common-utils-ts/examples';
-
-const employeePurgeSelector = new EmployeeBundleSession()
-  .setIdentifier(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier)
-  .toClaims();
-
-console.log(employeePurgeSelector);
+import {
+  EmployeeBundleOperations,
+  EmployeeResourceTypes,
+} from 'gdc-common-utils-ts/utils/employee';
+
+const employeePurgeBundle = new BundleEditor()
+  .setBundleOperation(EmployeeBundleOperations.purge)
+  .setAllowedResourceType(EmployeeResourceTypes.employee)
+  .newEntry(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.identifier)
+  .asEmployee()
+  .doneEntry()
+  .build();
+
+console.log(employeePurgeBundle);
 ```
 
 Primary references for those employee flows:
@@ -276,11 +352,15 @@ Minimal confidential-app example:
 
 ```ts
 import { ClientSDK } from 'gdc-sdk-front-ts';
-import { EmployeeBundleSession } from 'gdc-sdk-core-ts';
+import { BundleEditor } from 'gdc-sdk-core-ts';
 import {
   EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE,
   EXAMPLE_PROFILE_SESSION_INPUT,
 } from 'gdc-common-utils-ts/examples';
+import {
+  EmployeeBundleOperations,
+  EmployeeResourceTypes,
+} from 'gdc-common-utils-ts/utils/employee';
 
 const appId = frontendAppConfig.appId;
 const client = new ClientSDK({ appId });
@@ -290,11 +370,16 @@ const client = new ClientSDK({ appId });
 // can later expose organization-controller/professional capabilities.
 const session = await client.initializeSession(EXAMPLE_PROFILE_SESSION_INPUT);
 
-// The shared editor from sdk-core is still used to model the employee bundle.
-const employeeSearchBundle = new EmployeeBundleSession()
+// The shared bundle editor from sdk-core is still used to model the employee bundle.
+const employeeSearchBundle = new BundleEditor()
+  .setBundleOperation(EmployeeBundleOperations.search)
+  .setAllowedResourceType(EmployeeResourceTypes.employee)
+  .newEntry()
+  .asEmployee()
   .setEmail(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.email)
   .setRole(EXAMPLE_EMPLOYEE_DOCTOR_ACTIVE.role)
-  .toBundleSearch();
+  .doneEntry()
+  .build();
 
 console.log(session, employeeSearchBundle);
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdc-sdk-front-ts",
-  "version": "0.6.7",
+  "version": "0.8.0",
   "description": "Next-generation frontend runtime package for the GDC SDK family",
   "license": "Apache-2.0",
   "author": "Antifraud Services Inc.",
@@ -17,8 +17,8 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.28.4",
-    "gdc-common-utils-ts": "^1.14.15",
-    "gdc-sdk-core-ts": "^0.6.14"
+    "gdc-common-utils-ts": "^1.16.0",
+    "gdc-sdk-core-ts": "^0.8.0"
   },
   "devDependencies": {
     "@types/node": "^20.14.10",