API for fetching, translating and inserting variables into templates

[michaelfarrell76]

Related Issues

• Types: Adds new transcend API spec for fetching policies with dynamic variables airgap.js-types#141
• Types: Exposes transcend.getActiveLocale() airgap.js-types#142

This pull request implements the following APIs:

/**
 * Input for fetching a policy from Transcend and inserting template variables
 */
export type GetTranscendPolicies = {
  /** The language to fetch policy for - defaults to currently selected language key */
  locale?: LanguageKey;
  /** Template variables to dynamically inject into the policy */
  variables?: ObjByString;
  /**
   * The UUID of the policies defined in Transcend to fetch
   *
   * This can be pulled from the URL
   * @see https://app.transcend.io/privacy-center/policies
   */
  policyIds?: string[];
  /**
   * The titles of the policies defined in Transcend to fetch
   *
   * This can be pulled from the URL
   * @see https://app.transcend.io/privacy-center/policies
   */
  policyTitles?: string[];
};

/**
 * The returning Transcend policy
 */
export type TranscendPolicy = {
  /** The policy UUID */
  id: string;
  /** The policy title */
  title: string;
  /** The policy content */
  content: string;
};

type ConsentManageApi = { 
  ...
  /** Get the current active language */
  getTranscendPolicies: (
    input?: GetTranscendPolicies,
  ) => Promise<TranscendPolicy[]>;
  /** Callback that sets any dynamic variables that should be exposed to the consent UI messages */
  setTranscendUiVariables: (variables: ObjByString) => Promise<void>;
  /** Get the current value of Transcend UI variables */
  getTranscendUiVariables: () => ObjByString;
    /** Get the currently active locale */
  getActiveLocale: () => ConsentManagerLanguageKey;
}

This adds the usage of "global variables" that can be templated into any of the messages that are shown in a consent banner. Policies can also be fetched from the Transcend privacy center CDN and inserted into the dom.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
consent-manager-ui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 2, 2024 3:53am