gdc-common-utils-ts 2.9.17 → 2.9.18

package/README.md

@@ -494,7 +494,9 @@ The canonical API contract should live in JSDoc on exported code. The README act
   - Jurisdiction is mandatory so `BN`, `EIN`, `TAX` and subnational identifier
     schemes cannot collide; `roleType` remains protected while only the compact
     `roleValue` is serialized.
-- [`buildSmartCompositionReadScope(...)`](src/utils/smart-scope.ts)
+- [`buildScopeSmartCompositionAccess(...)`](src/utils/smart-scope.ts), with
+  `buildSmartCompositionReadScope(...)` retained as a deprecated compatibility
+  alias
   - Builds the current CORE GW pinned SMART root scope for `organization/Composition...` token requests.
   - This is the preferred first scope to teach when the backend only needs subject-scoped read access.
 - [`getOrganizationCredentialFromVpToken(...)`, `getLegalRepresentativeCredentialFromVpToken(...)`, `getServiceControllerCredentialFromVpToken(...)`](src/utils/vp-token.ts)

package/dist/utils/smart-scope.d.ts

@@ -1,6 +1,6 @@
 import type { ConsentActorDescriptor, EffectiveAccessEvaluation } from '../models/consent-access.js';
 import type { ConsentRule } from '../models/consent-rule.js';
-export type SmartCompositionReadScopeOptions = {
+export type ScopeSmartCompositionAccessOptions = {
     /**
      * Subject DID pinned by the current CORE GW root scope contract.
      */
@@ -12,12 +12,14 @@ export type SmartCompositionReadScopeOptions = {
      */
     sections?: string | string[];
     /**
-     * Read verb suffix used in the current GW SMART root scope contract.
+     * Access suffix used in the current GW SMART root scope contract.
      *
      * Defaults to `rs`.
      */
     accessVerb?: 'r' | 'rs' | 'cruds';
 };
+/** @deprecated Use {@link ScopeSmartCompositionAccessOptions}. */
+export type SmartCompositionReadScopeOptions = ScopeSmartCompositionAccessOptions;
 /**
  * Builds the gateway-pinned SMART root scope required by the current CORE GW
  * token contract:
@@ -27,6 +29,11 @@ export type SmartCompositionReadScopeOptions = {
  * This is intentionally a gateway-contract helper, not a generic SMART/FHIR
  * scope builder.
  */
+export declare function buildScopeSmartCompositionAccess(options: ScopeSmartCompositionAccessOptions): string;
+/**
+ * @deprecated Use {@link buildScopeSmartCompositionAccess}. The historical
+ * name incorrectly described a helper that also supports `cruds` access.
+ */
 export declare function buildSmartCompositionReadScope(options: SmartCompositionReadScopeOptions): string;
 export type DeriveGrantedSmartScopesInput = Readonly<{
     /** Requested SMART root scopes. Every scope must pin the same subject. */

package/dist/utils/smart-scope.js

@@ -9,10 +9,10 @@ import { evaluateConsentCoverage } from './consent.js';
  * This is intentionally a gateway-contract helper, not a generic SMART/FHIR
  * scope builder.
  */
-export function buildSmartCompositionReadScope(options) {
+export function buildScopeSmartCompositionAccess(options) {
     const subjectDid = String(options.subjectDid || '').trim();
     if (!subjectDid) {
-        throw new Error('buildSmartCompositionReadScope requires subjectDid.');
+        throw new Error('buildScopeSmartCompositionAccess requires subjectDid.');
     }
     const sections = Array.isArray(options.sections)
         ? options.sections
@@ -28,6 +28,13 @@ export function buildSmartCompositionReadScope(options) {
     }
     return `organization/Composition.${options.accessVerb || 'rs'}?${query.toString()}`;
 }
+/**
+ * @deprecated Use {@link buildScopeSmartCompositionAccess}. The historical
+ * name incorrectly described a helper that also supports `cruds` access.
+ */
+export function buildSmartCompositionReadScope(options) {
+    return buildScopeSmartCompositionAccess(options);
+}
 /**
  * Derives the exact read-only SMART scopes covered by active Consent rules.
  *
@@ -101,7 +108,7 @@ export function deriveGrantedSmartScopes(rules, input) {
             deniedScopes.push(parsed.raw);
             continue;
         }
-        grantedScopes.push(buildSmartCompositionReadScope({
+        grantedScopes.push(buildScopeSmartCompositionAccess({
             subjectDid: subject,
             sections: scopeGrantedSections,
             accessVerb: parsed.accessVerb,

package/package.json

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