TypeScript Definitions

CdnClientOptions

export type CdnClientOptions = {
  /**
   * Project metafile URL.
   */
  metafile: string;
};

CdnLocale

export type CdnLocale = {
  /**
   * Locale code.
   */
  locale: string;

  /**
   * Boolean indicating if this is the base locale.
   */
  isBaseLocale: boolean;

  /**
   * Language code.
   */
  language: string;

  /**
   * Region code.
   */
  region?: string;

  /**
   * Script code.
   */
  script?: string;

  /**
   * Boolean indicating if the locale is right-to-left.
   */
  isRtl: boolean;

  /**
   * Locale name.
   */
  name: string;

  /**
   * Localized locale name.
   */
  localizedName: string;
};

CdnLocalesOptions

export type CdnLocalesOptions = {
  /**
   * Exclude the base locale from the list of locales.
   */
  excludeBaseLocale?: boolean;
};

CdnFetchOptions

export type CdnFetchOptions = {
  /**
   * Select single or multiple files to fetch from the CDN.
   *
   * Default: all files in the metafile.
   */
  files?: (CdnFile | string)[] | CdnFile | string;

  /**
   * Select single or multiple locales to fetch from the CDN.
   *
   * Default: all locales in the metafile.
   */
  locales?: string[] | string;

  /**
   * Exclude the base locale from the list of locales to fetch.
   */
  excludeBaseLocale?: boolean;
};

CdnResponse

export type CdnResponse =
  /**
   * Map of file IDs with locales map as value.
   */
  | {
      [fileId: string]: {
        /**
         * Map of locales with file content as value.
         */
        [locale: string]: object | string;
      };
    }
  /**
   * Map of locales with file content as value.
   */
  | {
      [locale: string]: object | string;
    }
  /**
   * File content.
   */
  | object
  /**
   * File content as string for non-JSON files.
   */
  | string;

CdnFile

export type CdnFile = {
  /**
   * File ID.
   */
  id: string;

  /**
   * File name.
   */
  file: string;

  /**
   * File path.
   */
  path: string;

  /**
   * File library.
   */
  library: string;

  /**
   * File module.
   */
  module: string;

  /**
   * File build type.
   */
  buildType: string;

  /**
   * File product flavors.
   */
  productFlavors: string[];

  /**
   * File locales.
   */
  locales: CdnFileLocale[];
};

CdnFileLocale

export type CdnFileLocale = {
  /**
   * Locale code.
   */
  locale: string;

  /**
   * Boolean indicating if this is the base locale.
   */
  isBaseLocale: boolean;

  /**
   * File URI.
   */
  uri: string;
};