gdc-sdk-front-ts 2.2.1 → 2.3.1

package/dist/gdc-common-utils-ts/src/utils/consent-claim-helpers.js

@@ -1,213 +0,0 @@
-// Copyright 2026 Antifraud Services Inc. under the Apache License, Version 2.0.
-import { ClaimConsent } from '../models/consent-rule.js';
-function splitCsv(value) {
-    return String(value || '')
-        .split(',')
-        .map((item) => item.trim())
-        .filter(Boolean);
-}
-function normalizeTokens(values) {
-    return [...new Set(values.map((value) => String(value || '').trim()).filter(Boolean))];
-}
-function normalizeInput(values) {
-    return Array.isArray(values)
-        ? normalizeTokens(values)
-        : normalizeTokens(splitCsv(values));
-}
-function normalizeScalar(value) {
-    return String(value || '').trim();
-}
-/**
- * Returns the tokenized values for a claims field stored as CSV.
- */
-export function getClaimValues(claims, claimKey) {
-    return normalizeTokens(splitCsv(claims[claimKey]));
-}
-/**
- * Replaces a claims CSV field with the provided values.
- */
-export function setClaimValues(claims, claimKey, values) {
-    const nextValues = normalizeInput(values);
-    return {
-        ...claims,
-        [claimKey]: nextValues.join(','),
-    };
-}
-/**
- * Adds one or many values into a claims CSV field while preserving uniqueness.
- */
-export function addClaimValues(claims, claimKey, values) {
-    const current = getClaimValues(claims, claimKey);
-    const additions = normalizeInput(values);
-    return setClaimValues(claims, claimKey, [...current, ...additions]);
-}
-/**
- * Removes one or many values from a claims CSV field while preserving uniqueness.
- */
-export function removeClaimValues(claims, claimKey, values) {
-    const removals = new Set(normalizeInput(values));
-    const nextValues = getClaimValues(claims, claimKey).filter((value) => !removals.has(value));
-    return setClaimValues(claims, claimKey, nextValues);
-}
-export function getActors(claims) {
-    return getClaimValues(claims, ClaimConsent.actorIdentifier);
-}
-/**
- * Returns actor identifiers as array instead of CSV.
- */
-export function getActorIdentifierList(claims) {
-    return getActors(claims);
-}
-export function setActors(claims, values) {
-    return setClaimValues(claims, ClaimConsent.actorIdentifier, values);
-}
-/**
- * Stores actor identifiers from array/string input as canonical CSV claim.
- */
-export function setActorIdentifierList(claims, values) {
-    return setActors(claims, values);
-}
-export function addActors(claims, values) {
-    return addClaimValues(claims, ClaimConsent.actorIdentifier, values);
-}
-export function removeActors(claims, values) {
-    return removeClaimValues(claims, ClaimConsent.actorIdentifier, values);
-}
-export function addActorIdentifierList(claims, values) {
-    return addActors(claims, values);
-}
-export function removeActorIdentifierList(claims, values) {
-    return removeActors(claims, values);
-}
-export function getRoles(claims) {
-    return getClaimValues(claims, ClaimConsent.actorRole);
-}
-/**
- * Returns actor roles as array instead of CSV.
- */
-export function getActorRoleList(claims) {
-    return getRoles(claims);
-}
-export function setRoles(claims, values) {
-    return setClaimValues(claims, ClaimConsent.actorRole, values);
-}
-export function setActorRoleList(claims, values) {
-    return setRoles(claims, values);
-}
-export function addRoles(claims, values) {
-    return addClaimValues(claims, ClaimConsent.actorRole, values);
-}
-export function removeRoles(claims, values) {
-    return removeClaimValues(claims, ClaimConsent.actorRole, values);
-}
-export function addActorRoleList(claims, values) {
-    return addRoles(claims, values);
-}
-export function removeActorRoleList(claims, values) {
-    return removeRoles(claims, values);
-}
-export function getPurposes(claims) {
-    return getClaimValues(claims, ClaimConsent.purpose);
-}
-export function getPurposeList(claims) {
-    return getPurposes(claims);
-}
-export function setPurposes(claims, values) {
-    return setClaimValues(claims, ClaimConsent.purpose, values);
-}
-export function setPurposeList(claims, values) {
-    return setPurposes(claims, values);
-}
-export function addPurposes(claims, values) {
-    return addClaimValues(claims, ClaimConsent.purpose, values);
-}
-export function removePurposes(claims, values) {
-    return removeClaimValues(claims, ClaimConsent.purpose, values);
-}
-export function addPurposeList(claims, values) {
-    return addPurposes(claims, values);
-}
-export function removePurposeList(claims, values) {
-    return removePurposes(claims, values);
-}
-/**
- * Consent category as array instead of CSV.
- */
-export function getCategories(claims) {
-    return getClaimValues(claims, ClaimConsent.category);
-}
-export function getCategoryList(claims) {
-    return getCategories(claims);
-}
-export function setCategories(claims, values) {
-    return setClaimValues(claims, ClaimConsent.category, values);
-}
-export function setCategoryList(claims, values) {
-    return setCategories(claims, values);
-}
-export function addCategories(claims, values) {
-    return addClaimValues(claims, ClaimConsent.category, values);
-}
-export function removeCategories(claims, values) {
-    return removeClaimValues(claims, ClaimConsent.category, values);
-}
-export function addCategoryList(claims, values) {
-    return addCategories(claims, values);
-}
-export function removeCategoryList(claims, values) {
-    return removeCategories(claims, values);
-}
-export function getSections(claims) {
-    return getClaimValues(claims, ClaimConsent.action);
-}
-export function setSections(claims, values) {
-    return setClaimValues(claims, ClaimConsent.action, values);
-}
-export function addSections(claims, values) {
-    return addClaimValues(claims, ClaimConsent.action, values);
-}
-export function removeSections(claims, values) {
-    return removeClaimValues(claims, ClaimConsent.action, values);
-}
-/**
- * Reads the canonical consent date claim.
- */
-export function getConsentDate(claims) {
-    return normalizeScalar(claims[ClaimConsent.date]);
-}
-/**
- * Sets the canonical consent date claim.
- */
-export function setConsentDate(claims, value) {
-    return {
-        ...claims,
-        [ClaimConsent.date]: normalizeScalar(value),
-    };
-}
-export function getConsentPeriodStart(claims) {
-    return normalizeScalar(claims[ClaimConsent.periodStart]);
-}
-export function setConsentPeriodStart(claims, value) {
-    return {
-        ...claims,
-        [ClaimConsent.periodStart]: normalizeScalar(value),
-    };
-}
-export function getConsentPeriodEnd(claims) {
-    return normalizeScalar(claims[ClaimConsent.periodEnd]);
-}
-export function setConsentPeriodEnd(claims, value) {
-    return {
-        ...claims,
-        [ClaimConsent.periodEnd]: normalizeScalar(value),
-    };
-}
-export function getConsentIdentifier(claims) {
-    return normalizeScalar(claims[ClaimConsent.identifier]);
-}
-export function setConsentIdentifier(claims, value) {
-    return {
-        ...claims,
-        [ClaimConsent.identifier]: normalizeScalar(value),
-    };
-}

package/dist/gdc-common-utils-ts/src/utils/consent.d.ts

@@ -1,218 +0,0 @@
-import type { ActiveConsentView, ConsentActorDescriptor, ConsentActorKind, ConsentCoverageRequest, EffectiveAccessEvaluation, NormalizedConsentTarget, ResolvedConsentActor } from '../models/consent-access.js';
-import { type ConsentRule } from '../models/consent-rule.js';
-/**
- * Legacy structured actor selector kept for backwards compatibility while the
- * SDK converges on the canonical flat consent actor identifier contract.
- */
-export type ConsentActorTargetInput = {
-    /** Canonical actor identifier fallback when the caller already has it. */
-    identifier?: string;
-    /** Preferred URL/domain alias for organization actor resolution. */
-    url?: string;
-    /** Legacy alias maintained for backwards compatibility. */
-    didWeb?: string;
-    /** Legacy alias maintained for backwards compatibility. */
-    organizationUrl?: string;
-    /** Legacy alias maintained for backwards compatibility. */
-    organizationTaxId?: string;
-    /** Legacy alias maintained for backwards compatibility. */
-    email?: string;
-    /** Legacy alias maintained for backwards compatibility. */
-    phone?: string;
-};
-/**
- * A canonical consent actor input accepted by the shared SDK helpers.
- *
- * Supported token forms:
- * - `did:...`
- * - `user@example.org`
- * - `tel:+34600111222`
- * - `ES`
- * - comma-separated lists such as `did:web:a,user@example.org,ES`
- *
- * Arrays are normalized into the same comma-separated canonical string form.
- * Legacy structured objects remain accepted for backwards compatibility.
- */
-export type ConsentActorInput = string | string[] | ConsentActorTargetInput;
-export type SubjectIdentifierInput = {
-    subjectDid?: string;
-    subjectPhone?: string;
-    subjectGivenName?: string;
-};
-export type BuildConsentClaimsSimpleInput = SubjectIdentifierInput & {
-    /**
-     * Canonical consent actor selector.
-     *
-   * Prefer passing a canonical string or string list instead of the legacy
-   * structured object. The normalized value becomes the flat
-   * `Consent.actor-identifier` claim expected by CORE GW.
-     */
-    actor: ConsentActorInput;
-    actorRole: string;
-    purpose: string;
-    actions: string[];
-    consentIdentifier?: string;
-    consentDate?: string;
-    decision?: 'permit' | 'deny';
-    attachmentContentType?: string;
-    attachmentBase64?: string;
-};
-export type BuildConsentClaimsSimpleOptions = {
-    errorPrefix?: string;
-    consentIdentifierFactory?: () => string;
-};
-export type ConsentClaimsSimpleResult = {
-    actorIdentifier: string;
-    subjectIdentifier: string;
-    consentClaims: Record<string, unknown>;
-};
-export type ConsentClaimsWithCidResult = ConsentClaimsSimpleResult & {
-    claimsCid: string;
-};
-export type ParsedConsentActorTokenKind = 'did' | 'email' | 'phone' | 'country';
-export type ParsedConsentActorToken = {
-    kind: ParsedConsentActorTokenKind;
-    value: string;
-};
-/**
- * Normalizes a phone string into a compact token form.
- *
- * @param value Raw phone-like input.
- */
-export declare function normalizePhone(value: string): string;
-/**
- * Normalizes arbitrary identifier text into a lowercase token-safe fragment.
- *
- * @param value Raw identifier text.
- */
-export declare function normalizeIdentifierToken(value: string): string;
-/**
- * Parses a single canonical consent actor token into its resolved kind/value.
- *
- * @param rawToken Raw actor token such as `did:...`, `user@example.org`,
- * `tel:+34600111222`, or `ES`.
- * @returns The normalized parsed token or `undefined` when the token cannot be resolved.
- */
-export declare function parseConsentActorToken(rawToken: string): ParsedConsentActorToken | undefined;
-/**
- * Normalizes a consent actor input into a list of canonical actor tokens.
- *
- * The output preserves input order while removing empty and duplicate tokens.
- * Legacy structured actor inputs are still supported as a compatibility layer.
- *
- * @param actor Consent actor input in canonical or legacy form.
- * @param options.errorPrefix Optional error prefix.
- * @throws When no valid actor token can be resolved from the input.
- */
-export declare function normalizeConsentActors(actor: ConsentActorInput, options?: {
-    errorPrefix?: string;
-}): string[];
-/**
- * Resolves the canonical consent actor string used in consent claims.
- *
- * The resulting value is always a comma-separated canonical string, even when
- * the caller provides an array or a legacy structured object.
- *
- * @param actor Consent actor input in canonical or legacy form.
- * @param options.errorPrefix Optional error prefix.
- */
-export declare function resolveActorIdentifier(actor: ConsentActorInput, options?: {
-    errorPrefix?: string;
-}): string;
-/**
- * Resolves the canonical subject identifier used in consent claims.
- *
- * @param input Subject identification inputs.
- * @param options.errorPrefix Optional error prefix.
- */
-export declare function resolveSubjectIdentifier(input: SubjectIdentifierInput, options?: {
-    errorPrefix?: string;
-}): string;
-/**
- * Builds a minimal consent claims object from simple business inputs.
- *
- * @param input Consent actor/subject/business data.
- * @param options.errorPrefix Optional error prefix.
- * @param options.consentIdentifierFactory Optional fallback identifier factory.
- */
-export declare function buildConsentClaimsSimple(input: BuildConsentClaimsSimpleInput, options?: BuildConsentClaimsSimpleOptions): ConsentClaimsSimpleResult;
-/**
- * Builds minimal consent claims and assigns a deterministic CID into the claims id.
- *
- * @param input Consent actor/subject/business data.
- * @param options.errorPrefix Optional error prefix.
- * @param options.consentIdentifierFactory Optional fallback identifier factory.
- */
-export declare function buildConsentClaimsSimpleWithCid(input: BuildConsentClaimsSimpleInput, options?: BuildConsentClaimsSimpleOptions): ConsentClaimsWithCidResult;
-/**
- * Normalizes a consent target token into a reusable matching descriptor.
- *
- * The helper keeps the current GW contract:
- * - the first precedence tier is intended for concrete professional email matches
- * - direct runtime selectors may still include email / `did:web` / phone
- * - organization targets are normalized to `did:web:<host>`
- * - jurisdictions resolve to ISO-like uppercase codes
- * - phone targets stay marked as extension-specific
- *
- * @param input Raw target input from a rule or runtime request.
- * @param options.actorKind Optional actor family hint.
- * @param options.preferOrganizationDid When true, base `did:web:<host>` values are treated as organization targets.
- */
-export declare function normalizeConsentTarget(input: string, options?: {
-    actorKind?: ConsentActorKind;
-    preferOrganizationDid?: boolean;
-}): NormalizedConsentTarget;
-/**
- * Resolves all actor match targets used by consent evaluation.
- *
- * Organization matching prefers explicit `organizationDid` / `organizationUrl`.
- * When those are absent but an email exists, the email domain is exposed as a
- * fallback organization target through `did:web:<domain>`.
- *
- * @param actor Runtime actor descriptor.
- */
-export declare function resolveConsentActor(actor: ConsentActorDescriptor): ResolvedConsentActor;
-/**
- * Returns `true` when a consent rule is currently active.
- *
- * A rule is active when:
- * - it matches the requested subject when one is provided
- * - `Consent.period-start` is absent or already effective
- * - `Consent.period-end` is absent or still in the future
- *
- * @param rule Consent rule to inspect.
- * @param options.subject Optional subject filter.
- * @param options.now Optional evaluation timestamp.
- */
-export declare function isConsentRuleActive(rule: ConsentRule, options?: {
-    subject?: string;
-    now?: string | Date;
-}): boolean;
-/**
- * Builds an aggregated active-consent view grouped by target kind.
- *
- * @param rules Full consent-rule set available for the subject.
- * @param options.subject Optional subject filter.
- * @param options.now Optional evaluation timestamp.
- */
-export declare function groupActiveConsentsByTarget(rules: ConsentRule[], options?: {
-    subject?: string;
-    now?: string | Date;
-}): ActiveConsentView;
-/**
- * Evaluates effective consent coverage for a runtime access request.
- *
- * Precedence implemented by the shared evaluator:
- * 1. explicit deny for a concrete email
- * 2. explicit permit for a concrete email
- * 3. organization-scoped decisions
- * 4. jurisdiction-scoped decisions
- * 5. default deny
- *
- * Resource-type evaluation is optional: when a rule does not carry an explicit
- * resource-type filter, it is treated as section-scoped wildcard coverage.
- *
- * @param rules Full consent-rule set available to the caller.
- * @param request Runtime request to evaluate.
- */
-export declare function evaluateConsentCoverage(rules: ConsentRule[], request: ConsentCoverageRequest): EffectiveAccessEvaluation;