gdc-common-utils-ts 1.9.0 → 1.10.0

package/README.md

@@ -142,6 +142,8 @@ The canonical API contract should live in JSDoc on exported code. The README act
   - This is the preferred first scope to teach when the backend only needs subject-scoped read access.
 - [`getOrganizationCredentialFromVpToken(...)`, `getLegalRepresentativeCredentialFromVpToken(...)`](src/utils/vp-token.ts)
   - Extract typed VC objects from a VP token when GW/SDK flows carry canonical proof only in `vp_token`.
+- [`docs/VP_TOKEN_101.md`](docs/VP_TOKEN_101.md)
+  - Step-by-step guide for building the canonical compact `vp_token` string from organization and representative VCs.
 - [`validateCommunicationResourceFhirR4(...)`](src/utils/communication-fhir-r4.ts)
   - Validates FHIR R4 `Communication` resources.
 - [`transformCommunicationClaimsToResourceFhirR4(...)`](src/utils/communication-fhir-r4.ts)

package/dist/constants/schemaorg.d.ts

@@ -139,8 +139,3 @@ export declare enum ICAOIdentityParams {
 }
 export declare const indexedPersonAttributeList: string[];
 export declare const fullPersonParamsSchemaorg: ParameterData[];
-/**
- * Canonical schema.org `Service` flat claims commonly used by GW tenant and
- * individual onboarding flows.
- */
-export declare const fullServiceParamsSchemaorg: ParameterData[];

package/dist/constants/schemaorg.js

@@ -224,35 +224,3 @@ export const fullPersonParamsSchemaorg = [
     },
     */
 ];
-/**
- * Canonical schema.org `Service` flat claims commonly used by GW tenant and
- * individual onboarding flows.
- */
-export const fullServiceParamsSchemaorg = [
-    {
-        name: ClaimsServiceSchemaorg.category,
-        type: 'token',
-        value: undefined,
-    },
-    {
-        name: ClaimsServiceSchemaorg.identifier,
-        type: 'uri',
-        value: undefined,
-        unique: true,
-    },
-    {
-        name: ClaimsServiceSchemaorg.serviceType,
-        type: 'token',
-        value: undefined,
-    },
-    {
-        name: ClaimsServiceSchemaorg.termsOfService,
-        type: 'uri',
-        value: undefined,
-    },
-    {
-        name: ClaimsServiceSchemaorg.url,
-        type: 'uri',
-        value: undefined,
-    },
-];

package/dist/constants/service-capabilities.d.ts

@@ -14,9 +14,25 @@ export type ServiceCapabilityFamilyValue = typeof ServiceCapabilityFamily[keyof
  * `.rs` and `.cruds` can evolve independently across runtimes.
  */
 export declare const ServiceCapabilityToken: {
+    readonly IndexReader: "indexing.rs";
+    readonly IndexProvider: "indexing.cruds";
+    readonly DigitalTwinReader: "digitaltwin.rs";
+    readonly DigitalTwinProvider: "digitaltwin.cruds";
+    /**
+     * @deprecated Prefer `IndexReader`.
+     */
     readonly IndexingReadSearch: "indexing.rs";
+    /**
+     * @deprecated Prefer `IndexProvider`.
+     */
     readonly IndexingCruds: "indexing.cruds";
+    /**
+     * @deprecated Prefer `DigitalTwinReader`.
+     */
     readonly DigitalTwinReadSearch: "digitaltwin.rs";
+    /**
+     * @deprecated Prefer `DigitalTwinProvider`.
+     */
     readonly DigitalTwinCruds: "digitaltwin.cruds";
 };
 export type ServiceCapabilityTokenValue = typeof ServiceCapabilityToken[keyof typeof ServiceCapabilityToken];
@@ -28,10 +44,18 @@ export type ServiceCapabilityTokenValue = typeof ServiceCapabilityToken[keyof ty
  * - `Reader` maps to read/search capability (`*.rs`)
  */
 export declare const ServiceCapability: {
-    readonly IndexingProvider: "indexing.cruds";
-    readonly IndexingReader: "indexing.rs";
+    readonly IndexProvider: "indexing.cruds";
+    readonly IndexReader: "indexing.rs";
     readonly DigitalTwinProvider: "digitaltwin.cruds";
     readonly DigitalTwinReader: "digitaltwin.rs";
+    /**
+     * @deprecated Prefer `IndexProvider`.
+     */
+    readonly IndexingProvider: "indexing.cruds";
+    /**
+     * @deprecated Prefer `IndexReader`.
+     */
+    readonly IndexingReader: "indexing.rs";
 };
 export type ServiceCapabilityValue = typeof ServiceCapability[keyof typeof ServiceCapability];
 /**

package/dist/constants/service-capabilities.js

@@ -15,9 +15,25 @@ export const ServiceCapabilityFamily = {
  * `.rs` and `.cruds` can evolve independently across runtimes.
  */
 export const ServiceCapabilityToken = {
+    IndexReader: 'indexing.rs',
+    IndexProvider: 'indexing.cruds',
+    DigitalTwinReader: 'digitaltwin.rs',
+    DigitalTwinProvider: 'digitaltwin.cruds',
+    /**
+     * @deprecated Prefer `IndexReader`.
+     */
     IndexingReadSearch: 'indexing.rs',
+    /**
+     * @deprecated Prefer `IndexProvider`.
+     */
     IndexingCruds: 'indexing.cruds',
+    /**
+     * @deprecated Prefer `DigitalTwinReader`.
+     */
     DigitalTwinReadSearch: 'digitaltwin.rs',
+    /**
+     * @deprecated Prefer `DigitalTwinProvider`.
+     */
     DigitalTwinCruds: 'digitaltwin.cruds',
 };
 /**
@@ -28,10 +44,18 @@ export const ServiceCapabilityToken = {
  * - `Reader` maps to read/search capability (`*.rs`)
  */
 export const ServiceCapability = {
-    IndexingProvider: ServiceCapabilityToken.IndexingCruds,
-    IndexingReader: ServiceCapabilityToken.IndexingReadSearch,
-    DigitalTwinProvider: ServiceCapabilityToken.DigitalTwinCruds,
-    DigitalTwinReader: ServiceCapabilityToken.DigitalTwinReadSearch,
+    IndexProvider: ServiceCapabilityToken.IndexProvider,
+    IndexReader: ServiceCapabilityToken.IndexReader,
+    DigitalTwinProvider: ServiceCapabilityToken.DigitalTwinProvider,
+    DigitalTwinReader: ServiceCapabilityToken.DigitalTwinReader,
+    /**
+     * @deprecated Prefer `IndexProvider`.
+     */
+    IndexingProvider: ServiceCapabilityToken.IndexProvider,
+    /**
+     * @deprecated Prefer `IndexReader`.
+     */
+    IndexingReader: ServiceCapabilityToken.IndexReader,
 };
 /**
  * Parses the CSV stored in `org.schema.Service.serviceType`.

package/dist/examples/organization-controller.js

@@ -26,8 +26,8 @@ export const EXAMPLE_ACTIVATE_ORGANIZATION_FROM_ICA_PROOF_INPUT = {
         [ClaimsServiceSchemaorg.identifier]: EXAMPLE_SERVICE_PUBLIC_DID,
         [ClaimsServiceSchemaorg.url]: `https://operator.example.net/acme/cds-${String(EXAMPLE_JURISDICTION).toLowerCase()}/v1/${EXAMPLE_SECTOR}`,
         [ClaimsServiceSchemaorg.serviceType]: serializeServiceCapabilityTokens([
-            ServiceCapabilityToken.IndexingCruds,
-            ServiceCapabilityToken.DigitalTwinReadSearch,
+            ServiceCapabilityToken.IndexProvider,
+            ServiceCapabilityToken.DigitalTwinReader,
         ]),
     },
 };

package/dist/models/index.d.ts

@@ -1,9 +1,3 @@
-/**
- * @fileoverview Barrel export for shared model contracts.
- *
- * @architecture 101
- * Keep this file export-only; shared business logic belongs in dedicated modules.
- */
 export * from './actor-session';
 export * from './aes';
 export * from './auth';
@@ -21,7 +15,6 @@ export * from './crypto';
 export * from './device-license';
 export * from './did';
 export * from './fhir-documents';
-export * from './fhir-related-person';
 export * from './interoperable-claims';
 export * from './indexing';
 export * from './identity-bootstrap';
@@ -41,7 +34,6 @@ export * from './operation-outcome';
 export * from './params';
 export * from './resource-document';
 export * from './relationship-access';
-export * from './related-profile';
 export * from './response';
 export * from './urlPath';
 export * from './verifiable-credential';

package/dist/models/index.js

@@ -1,10 +1,3 @@
-// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
-/**
- * @fileoverview Barrel export for shared model contracts.
- *
- * @architecture 101
- * Keep this file export-only; shared business logic belongs in dedicated modules.
- */
 export * from './actor-session.js';
 export * from './aes.js';
 export * from './auth.js';
@@ -22,7 +15,6 @@ export * from './crypto.js';
 export * from './device-license.js';
 export * from './did.js';
 export * from './fhir-documents.js';
-export * from './fhir-related-person.js';
 export * from './interoperable-claims.js';
 export * from './indexing.js';
 export * from './identity-bootstrap.js';
@@ -42,7 +34,6 @@ export * from './operation-outcome.js';
 export * from './params.js';
 export * from './resource-document.js';
 export * from './relationship-access.js';
-export * from './related-profile.js';
 export * from './response.js';
 export * from './urlPath.js';
 export * from './verifiable-credential.js';

package/dist/models/params.d.ts

@@ -95,31 +95,6 @@ export interface ParameterData extends ParamAttribute {
      */
     appliesTo?: string[];
 }
-/**
- * Shared definition for a search parameter that can also be used as an
- * indexable attribute contract.
- *
- * `name` remains the canonical flat claim key that will be stored and queried.
- * The record key in a `SearchParameterCatalog` is the public search-attribute
- * name to expose in APIs or capability statements.
- */
-export interface SearchParameterDefinition extends ParameterData {
-    /**
-     * Optional compatibility aliases accepted on read/normalization before the
-     * canonical `name` is used for indexing.
-     */
-    claimAliases?: readonly string[];
-    /**
-     * Whether this parameter is intended to be indexed for blind queries.
-     * Defaults to `true` when omitted by catalog consumers.
-     */
-    indexed?: boolean;
-}
-/**
- * Per-resource search parameter catalog keyed by the public search attribute
- * name (e.g. `identifier`, `subject`, `status`).
- */
-export type SearchParameterCatalog<TSearchName extends string = string> = Record<TSearchName, SearchParameterDefinition>;
 export interface StringSearchParameter extends ParameterData {
     type: 'string';
     value: string;

package/dist/models/params.js

@@ -1,2 +1,3 @@
 // Copyright 2025 Antifraud Services Inc. under the Apache License, Version 2.0.
+// File: crypto-ts/models/params.ts
 export {};

package/dist/utils/index.d.ts

@@ -13,7 +13,6 @@ export * from './didcomm-submit-policy';
 export * from './discovery-normalization';
 export * from './format-converter';
 export * from './fhir-cid';
-export * from './gateway-index-params';
 export * from './communication-fhir-r4';
 export * from './communication-document-reference';
 export * from './communication-identity';
@@ -28,6 +27,5 @@ export * from './normalize';
 export * from './object-convert';
 export * from './normalize-uuid';
 export * from './smart-scope';
-export * from './search-parameter-catalog';
 export * from './activation-request';
 export * from './vp-token';

package/dist/utils/index.js

@@ -13,7 +13,6 @@ export * from './didcomm-submit-policy.js';
 export * from './discovery-normalization.js';
 export * from './format-converter.js';
 export * from './fhir-cid.js';
-export * from './gateway-index-params.js';
 export * from './communication-fhir-r4.js';
 export * from './communication-document-reference.js';
 export * from './communication-identity.js';
@@ -28,6 +27,5 @@ export * from './normalize.js';
 export * from './object-convert.js';
 export * from './normalize-uuid.js';
 export * from './smart-scope.js';
-export * from './search-parameter-catalog.js';
 export * from './activation-request.js';
 export * from './vp-token.js';

package/dist/utils/vp-token.d.ts

@@ -16,20 +16,47 @@ export type VpTokenPayload = {
         '@context'?: unknown;
         type?: unknown;
         holder?: string;
-        verifiableCredential: string[];
+        verifiableCredential: Array<string | Record<string, unknown>>;
         [key: string]: unknown;
     };
     [key: string]: unknown;
 };
 export type VpCredential = Record<string, unknown>;
+export type VpCredentialInput = string | Record<string, unknown>;
 export declare function generateUuidLike(): string;
 export declare function buildEpochWindow(ttlSeconds?: number): {
     iat: number;
     exp: number;
 };
 export declare function createVP(input?: Partial<VpTokenPayload>): VpTokenPayload;
-export declare function addVC(vpPayload: VpTokenPayload, vcJwt: string): VpTokenPayload;
-export declare function addVCs(vpPayload: VpTokenPayload, vcs: string[]): VpTokenPayload;
+/**
+ * Appends one VC entry to the VP payload.
+ *
+ * Accepted input forms:
+ *
+ * - compact VC JWT/JWS string
+ * - raw JSON VC string
+ * - direct VC JSON object
+ *
+ * Storage rule:
+ *
+ * - string inputs are stored as strings
+ * - object inputs are stored as objects
+ *
+ * This keeps the builder compatible with existing compact-token flows while
+ * also supporting app/runtime code that already holds the VC as parsed JSON.
+ */
+export declare function addVC(vpPayload: VpTokenPayload, vcInput: VpCredentialInput): VpTokenPayload;
+/**
+ * Appends many VC entries to the VP payload.
+ *
+ * Each entry may be:
+ *
+ * - compact VC JWT/JWS string
+ * - raw JSON VC string
+ * - direct VC JSON object
+ */
+export declare function addVCs(vpPayload: VpTokenPayload, vcs: VpCredentialInput[]): VpTokenPayload;
 /**
  * Decodes a compact VP token payload into a JSON object.
  *
@@ -67,8 +94,19 @@ export declare function getOrganizationCredentialFromVpToken(vpToken: string): V
  * @param vpToken Compact VP token or raw JSON string.
  */
 export declare function getLegalRepresentativeCredentialFromVpToken(vpToken: string): VpCredential | undefined;
-export declare function addOrganizationCredential(vpPayload: VpTokenPayload, vc: string): VpTokenPayload;
-export declare function addLegalRepresentativeCredential(vpPayload: VpTokenPayload, vc: string): VpTokenPayload;
+/**
+ * Appends an organization activation credential after validating its VC type.
+ *
+ * Accepts compact VC strings, raw JSON VC strings, or VC JSON objects.
+ */
+export declare function addOrganizationCredential(vpPayload: VpTokenPayload, vc: VpCredentialInput): VpTokenPayload;
+/**
+ * Appends a legal-representative activation credential after validating its VC
+ * type.
+ *
+ * Accepts compact VC strings, raw JSON VC strings, or VC JSON objects.
+ */
+export declare function addLegalRepresentativeCredential(vpPayload: VpTokenPayload, vc: VpCredentialInput): VpTokenPayload;
 export declare function prepareForSignature(header: VpTokenHeader, payload: VpTokenPayload): {
     encodedHeader: string;
     encodedPayload: string;

package/dist/utils/vp-token.js

@@ -37,19 +37,52 @@ export function createVP(input) {
     };
     return base;
 }
-export function addVC(vpPayload, vcJwt) {
-    const v = String(vcJwt || '').trim();
+/**
+ * Appends one VC entry to the VP payload.
+ *
+ * Accepted input forms:
+ *
+ * - compact VC JWT/JWS string
+ * - raw JSON VC string
+ * - direct VC JSON object
+ *
+ * Storage rule:
+ *
+ * - string inputs are stored as strings
+ * - object inputs are stored as objects
+ *
+ * This keeps the builder compatible with existing compact-token flows while
+ * also supporting app/runtime code that already holds the VC as parsed JSON.
+ */
+export function addVC(vpPayload, vcInput) {
+    if (vcInput && typeof vcInput === 'object') {
+        vpPayload.vp.verifiableCredential.push({ ...vcInput });
+        return vpPayload;
+    }
+    const v = String(vcInput || '').trim();
     if (!v)
         return vpPayload;
     vpPayload.vp.verifiableCredential.push(v);
     return vpPayload;
 }
+/**
+ * Appends many VC entries to the VP payload.
+ *
+ * Each entry may be:
+ *
+ * - compact VC JWT/JWS string
+ * - raw JSON VC string
+ * - direct VC JSON object
+ */
 export function addVCs(vpPayload, vcs) {
     for (const vc of vcs || [])
         addVC(vpPayload, vc);
     return vpPayload;
 }
 function decodeVcPayload(vc) {
+    if (vc && typeof vc === 'object') {
+        return vc;
+    }
     const raw = String(vc || '').trim();
     if (!raw)
         return undefined;
@@ -173,9 +206,20 @@ function addTypedVC(vpPayload, vc, acceptedTypes, label) {
     }
     return addVC(vpPayload, vc);
 }
+/**
+ * Appends an organization activation credential after validating its VC type.
+ *
+ * Accepts compact VC strings, raw JSON VC strings, or VC JSON objects.
+ */
 export function addOrganizationCredential(vpPayload, vc) {
     return addTypedVC(vpPayload, vc, [...ORGANIZATION_ACTIVATION_VC_TYPES], 'Organization');
 }
+/**
+ * Appends a legal-representative activation credential after validating its VC
+ * type.
+ *
+ * Accepts compact VC strings, raw JSON VC strings, or VC JSON objects.
+ */
 export function addLegalRepresentativeCredential(vpPayload, vc) {
     return addTypedVC(vpPayload, vc, [...REPRESENTATIVE_ACTIVATION_VC_TYPES], 'LegalRepresentative');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gdc-common-utils-ts",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "publishConfig": {
     "access": "public"
   },