@bifold/oca 2.4.6 → 2.5.0

package/src/__tests__/remote.test.ts

@@ -1,180 +0,0 @@
-import axios from 'axios'
-import fs from 'fs'
-import { readFile, writeFile, exists, mkdir, unlink } from 'react-native-fs'
-
-import { ocaCacheDataFileName, defaultBundleIndexFileName } from '../constants'
-import { RemoteOCABundleResolver } from '../legacy/resolver/remote-oca'
-
-const bundleFileName = 'bundle.json'
-const ocaPath = `${__dirname}/fixtures/${ocaCacheDataFileName}`
-const ocaAsString = fs.readFileSync(ocaPath, 'utf8')
-const indexPath = `${__dirname}/fixtures/${defaultBundleIndexFileName}`
-const indexAsString = fs.readFileSync(indexPath, 'utf8')
-const bundlePath = `${__dirname}/fixtures/${bundleFileName}`
-const bundleAsString = fs.readFileSync(bundlePath, 'utf8')
-
-const initialEtag = '3379dc5c38ac34ab'
-const changedEtag = '4c0afc9bfdb3bf6b'
-const keysToUpdated = [
-  '79e343ab4362d93974cdf78b00a916a5b3659178dfd170fcff90f1b5f10ceb72',
-  '29bf8f8729f235450980d0b273f9ca49b7ab73b7358467bf52b311bf40464bb0',
-]
-// Testing person credential as an example
-const personSha = '9187f651eab59811d8ec1c1257628c08f6daa1eb520bf379f022425f3a9701cf'
-const qualifiedCredDefId = 'did:indy:candy:RGjWbW1eycP7FrMf4QJvX8/anoncreds/v0/CLAIM_DEF/13/Person'
-const qualifiedSchemaId = 'did:indy:candy:RGjWbW1eycP7FrMf4QJvX8/anoncreds/v0/SCHEMA/Person/1.0'
-
-const getMock = jest.fn().mockImplementation((url) => {
-  const fileName = url.split('/').pop()
-  switch (fileName) {
-    case 'ocabundles.json':
-      return Promise.resolve({
-        status: 200,
-        data: JSON.parse(indexAsString),
-        headers: { etag: initialEtag },
-      })
-    case 'OCABundle.json':
-      return Promise.resolve({
-        status: 200,
-        data: JSON.parse(bundleAsString),
-      })
-    default:
-      return Promise.reject(new Error('Not Found'))
-  }
-})
-
-jest.mock('axios', () => ({
-  create: jest.fn().mockReturnValue({
-    get: jest.fn(),
-  }),
-}))
-
-jest.useFakeTimers({ legacyFakeTimers: true })
-
-jest.mock('react-native-fs', () => ({
-  exists: jest.fn().mockResolvedValue(true),
-  mkdir: jest.fn().mockResolvedValue(true),
-  readFile: jest.fn().mockImplementation((filePath) => {
-    const fileName = filePath.split('/').pop()
-    switch (fileName) {
-      case ocaCacheDataFileName: {
-        return Promise.resolve(ocaAsString)
-      }
-      case defaultBundleIndexFileName:
-        return Promise.resolve(indexAsString)
-      case personSha:
-        return Promise.resolve(bundleAsString)
-      default:
-        return Promise.resolve('{}')
-    }
-  }),
-  writeFile: jest.fn().mockResolvedValue(true),
-  unlink: jest.fn().mockResolvedValue(true),
-}))
-
-describe('RemoteOCABundleResolver', () => {
-  let resolver: RemoteOCABundleResolver
-
-  beforeEach(() => {
-    resolver = new RemoteOCABundleResolver('http://example.com')
-    // resolver.log = new MiniLogger()
-
-    jest.clearAllMocks()
-    // @ts-expect-error some weird type
-    axios.create().get.mockImplementation(getMock)
-  })
-
-  it('should be created', async () => {
-    expect(resolver).toBeTruthy()
-    expect(resolver).toBeInstanceOf(RemoteOCABundleResolver)
-    expect(resolver).toHaveProperty('indexFileName', defaultBundleIndexFileName)
-    expect(resolver).toHaveProperty('cacheDataFileName', ocaCacheDataFileName)
-    expect(resolver['axiosInstance']).not.toBeNull()
-    expect(axios.create().get).toHaveBeenCalledTimes(0)
-    expect(resolver.indexFileEtag).toEqual('')
-    expect(resolver['indexFile']).toMatchSnapshot()
-  })
-
-  it('should update demand', async () => {
-    await resolver.checkForUpdates()
-
-    expect(axios.create().get).toHaveBeenCalledTimes(16) // 1 index + 15 bundles
-    expect(writeFile).toHaveBeenCalledTimes(17) // 1 index + 15 bundles + 1 cache
-    expect(readFile).toHaveBeenCalledTimes(1) // 1 cache
-    expect(unlink).toHaveBeenCalledTimes(0) // 0 deletes
-    expect(exists).toHaveBeenCalledTimes(3) // 1 index + 1 cache + 1 directory
-    expect(mkdir).toHaveBeenCalledTimes(0) // mock always return true
-    expect(resolver.indexFileEtag).toEqual(initialEtag)
-    expect(resolver['indexFile']).toMatchSnapshot()
-  })
-
-  it.skip('should check index periodically', async () => {
-    await resolver.checkForUpdates()
-    await resolver.checkForUpdates()
-    await resolver.checkForUpdates()
-
-    expect(axios.create().get).toHaveBeenCalledTimes(18) // 3 index + 15 bundles
-    expect(writeFile).toHaveBeenCalledTimes(17) // 1 index + 15 bundles + 1 cache
-    expect(readFile).toHaveBeenCalledTimes(1)
-    expect(unlink).toHaveBeenCalledTimes(0)
-    expect(exists).toHaveBeenCalledTimes(5)
-    expect(mkdir).toHaveBeenCalledTimes(0)
-  })
-
-  it('should check fetch updated bundles', async () => {
-    await resolver.checkForUpdates()
-
-    expect(axios.create().get).toHaveBeenCalledTimes(16) // 1 index + 15 bundles
-    expect(resolver.indexFileEtag).toEqual(initialEtag)
-
-    const newIndexAsJSON = JSON.parse(indexAsString)
-    for (const key of Object.keys(newIndexAsJSON)) {
-      if (keysToUpdated.includes(newIndexAsJSON[key].sha256)) {
-        newIndexAsJSON[key].sha256 = newIndexAsJSON[key].sha256.slice(0, 7)
-      }
-    }
-
-    // @ts-expect-error some weird type
-    axios.create().get.mockImplementation((url) => {
-      const fileName = url.split('/').pop()
-      switch (fileName) {
-        case 'ocabundles.json':
-          return Promise.resolve({
-            status: 200,
-            data: newIndexAsJSON,
-            headers: { etag: changedEtag },
-          })
-        case 'OCABundle.json':
-          return Promise.resolve({
-            status: 200,
-            data: JSON.parse(bundleAsString),
-          })
-        default:
-          return Promise.reject(new Error('Not Found'))
-      }
-    })
-
-    await resolver.checkForUpdates()
-
-    expect(axios.create().get).toHaveBeenCalledTimes(19) // 2 index + 17 bundles
-    expect(writeFile).toHaveBeenCalledTimes(21) // 2 index + 17 bundles + 2 cache
-    expect(readFile).toHaveBeenCalledTimes(1)
-    expect(unlink).toHaveBeenCalledTimes(2) // 2 deletes
-    expect(exists).toHaveBeenCalledTimes(4) // 2 index + 1 cache + 1 directory
-    expect(mkdir).toHaveBeenCalledTimes(0)
-    expect(resolver.indexFileEtag).toEqual(changedEtag)
-    expect(resolver['indexFile']).toMatchSnapshot()
-  })
-
-  it('should check unqualified cred def id as key if given qualified cred def id', async () => {
-    await resolver.checkForUpdates()
-    const bundle = await resolver.resolve({ identifiers: { credentialDefinitionId: qualifiedCredDefId } })
-    expect(bundle).toBeDefined()
-  })
-
-  it('should check unqualified schema id as key if given qualified schema id', async () => {
-    await resolver.checkForUpdates()
-    const bundle = await resolver.resolve({ identifiers: { schemaId: qualifiedSchemaId } })
-    expect(bundle).toBeDefined()
-  })
-})

package/src/constants.ts

@@ -1,7 +0,0 @@
-export const ocaBundleStorageDirectory = 'oca'
-
-export const ocaCacheDataFileName = 'oca.json'
-
-export const defaultBundleIndexFileName = 'ocabundles.json'
-
-export const defaultBundleLanguage = 'en'

package/src/formatters/credential/CredentialFormatter.ts

@@ -1,20 +0,0 @@
-import { CredentialExchangeRecord } from '@credo-ts/core'
-
-import { OverlayBundle } from '../../types'
-
-import LocalizedCredential from './LocalizedCredential'
-
-export default class CredentialFormatter {
-  #credentials!: Record<string, LocalizedCredential>
-
-  constructor(bundle: OverlayBundle, record: CredentialExchangeRecord) {
-    this.#credentials = bundle.languages.reduce((credentials, language) => {
-      credentials[language] = new LocalizedCredential(bundle, record, language)
-      return credentials
-    }, {} as Record<string, LocalizedCredential>)
-  }
-
-  localizedCredential(language: string): LocalizedCredential | undefined {
-    return this.#credentials[language]
-  }
-}

package/src/formatters/credential/DisplayAttribute.ts

@@ -1,29 +0,0 @@
-import { CredentialPreviewAttribute, CredentialPreviewAttributeOptions } from '@credo-ts/core'
-
-import { IOverlayBundleAttribute as OverlayBundleAttributeOptions } from '../../interfaces/overlay'
-
-export default class DisplayAttribute extends CredentialPreviewAttribute {
-  characterEncoding: string | undefined
-  standard: string | undefined
-  format: string | undefined
-  information: string | undefined
-  label: string | undefined
-
-  constructor(
-    options: CredentialPreviewAttributeOptions,
-    overlayOptions: OverlayBundleAttributeOptions,
-    language: string
-  ) {
-    super(options)
-
-    this.characterEncoding = overlayOptions.characterEncoding
-    this.standard = overlayOptions.standard
-    this.format = overlayOptions.format
-    this.information = overlayOptions.information?.[language]
-    this.label = overlayOptions.label?.[language]
-  }
-
-  toJSON(): Record<string, unknown> {
-    return { ...super.toJSON(), format: this.format, information: this.information, label: this.label }
-  }
-}

package/src/formatters/credential/LocalizedCredential.ts

@@ -1,53 +0,0 @@
-import { CredentialExchangeRecord, CredentialPreviewAttribute } from '@credo-ts/core'
-
-import { OverlayBundle } from '../../types'
-
-import DisplayAttribute from './DisplayAttribute'
-
-export default class LocalizedCredential {
-  #bundle!: OverlayBundle
-
-  issuer: string
-  name: string
-  attributes!: DisplayAttribute[]
-
-  constructor(bundle: OverlayBundle, record: CredentialExchangeRecord, language: string) {
-    if (!language) {
-      throw new Error('language is required')
-    }
-
-    this.#bundle = bundle
-
-    this.issuer = bundle.metadata.issuer?.[language]
-    this.name = bundle.metadata.name?.[language]
-
-    // If no record attributes are present then grab default attributes from the bundle
-    const credentialAttributes = record.credentialAttributes?.length
-      ? record.credentialAttributes
-      : bundle.attributes.map((attribute) => {
-          return new CredentialPreviewAttribute({ ...attribute, value: '' })
-        })
-
-    this.attributes =
-      credentialAttributes
-        ?.filter((attribute) => bundle.getAttribute(attribute.name))
-        .map((attribute) => new DisplayAttribute(attribute, { name: attribute.name, type: '' }, language)) ?? []
-  }
-
-  get primaryAttribute(): DisplayAttribute | undefined {
-    const name = this.#bundle.branding?.primaryAttribute
-    return this.getAttribute(name)
-  }
-
-  get secondaryAttribute(): DisplayAttribute | undefined {
-    const name = this.#bundle.branding?.secondaryAttribute
-    return this.getAttribute(name)
-  }
-
-  getAttribute(attributeName?: string): DisplayAttribute | undefined {
-    if (!attributeName) {
-      return undefined
-    }
-    return this.attributes.find((attribute) => attribute.name === attributeName)
-  }
-}

package/src/formatters/credential/index.ts

@@ -1,5 +0,0 @@
-import CredentialFormatter from './CredentialFormatter'
-import DisplayAttribute from './DisplayAttribute'
-import LocalizedCredential from './LocalizedCredential'
-
-export { CredentialFormatter, DisplayAttribute, LocalizedCredential }

package/src/formatters/index.ts

@@ -1,5 +0,0 @@
-import CredentialFormatter from './credential/CredentialFormatter'
-import DisplayAttribute from './credential/DisplayAttribute'
-import LocalizedCredential from './credential/LocalizedCredential'
-
-export { CredentialFormatter, DisplayAttribute, LocalizedCredential }

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './formatters'
-export * from './interfaces'
-export * from './types'
-export * from './utils'
-export * as legacy from './legacy'

package/src/interfaces/data/base/BaseOverlayData.interface.ts

@@ -1,5 +0,0 @@
-export default interface IBaseOverlayData {
-  type: string
-  capture_base: string
-  digest?: string
-}

package/src/interfaces/data/branding/BrandingOverlayData.interface.ts

@@ -1,13 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-
-export default interface IBrandingOverlayData extends IBaseOverlayData {
-  logo?: string
-  background_image?: string
-  background_image_slice?: string
-  primary_background_color?: string
-  secondary_background_color?: string
-  primary_attribute?: string
-  secondary_attribute?: string
-  issued_date_attribute?: string
-  expiry_date_attribute?: string
-}

package/src/interfaces/data/branding/LegacyBrandingOverlayData.interface.ts

@@ -1,16 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-
-export default interface ILegacyBrandingOverlayData extends IBaseOverlayData {
-  background_color?: string
-  image_source?: string
-  header?: {
-    color?: string
-    background_color?: string
-    image_source?: string
-    hide_issuer?: boolean
-  }
-  footer?: {
-    color?: string
-    background_color?: string
-  }
-}

package/src/interfaces/data/bundle/OverlayBundleData.interface.ts

@@ -1,7 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-import ICaptureBaseData from '../capture-base/CaptureBaseData.interface'
-
-export default interface IOverlayBundleData {
-  capture_base: ICaptureBaseData
-  overlays: IBaseOverlayData[]
-}

package/src/interfaces/data/capture-base/CaptureBaseData.interface.ts

@@ -1,7 +0,0 @@
-export default interface ICaptureBaseData {
-  type: string
-  classification: string
-  attributes: Record<string, string>
-  flagged_attributes: string[]
-  digest?: string
-}

package/src/interfaces/data/index.ts

@@ -1,25 +0,0 @@
-import IBaseOverlayData from './base/BaseOverlayData.interface'
-import IBrandingOverlayData from './branding/BrandingOverlayData.interface'
-import ILegacyBrandingOverlayData from './branding/LegacyBrandingOverlayData.interface'
-import IOverlayBundleData from './bundle/OverlayBundleData.interface'
-import ICaptureBaseData from './capture-base/CaptureBaseData.interface'
-import ICharacterEncodingOverlayData from './semantic/CharacterEncodingOverlayData.interface'
-import IFormatOverlayData from './semantic/FormatOverlayData.interface'
-import IInformationOverlayData from './semantic/InformationOverlayData.interface'
-import ILabelOverlayData from './semantic/LabelOverlayData.interface'
-import IMetaOverlayData from './semantic/MetaOverlayData.interface'
-import IStandardOverlayData from './semantic/StandardOverlayData.interface'
-
-export {
-  IBaseOverlayData,
-  ICaptureBaseData,
-  IOverlayBundleData,
-  IBrandingOverlayData,
-  ILegacyBrandingOverlayData,
-  ICharacterEncodingOverlayData,
-  IFormatOverlayData,
-  IInformationOverlayData,
-  ILabelOverlayData,
-  IMetaOverlayData,
-  IStandardOverlayData,
-}

package/src/interfaces/data/semantic/CharacterEncodingOverlayData.interface.ts

@@ -1,8 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-
-export default interface ICharacterEncodingOverlayData extends IBaseOverlayData {
-  default_character_encoding: string
-  // DEPRECATED - Use attribute_character_encoding instead
-  attr_character_encoding: Record<string, string>
-  attribute_character_encoding: Record<string, string>
-}

package/src/interfaces/data/semantic/FormatOverlayData.interface.ts

@@ -1,5 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-
-export default interface IFormatOverlayData extends IBaseOverlayData {
-  attribute_formats: Record<string, string>
-}

package/src/interfaces/data/semantic/InformationOverlayData.interface.ts

@@ -1,6 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-
-export default interface IInformationOverlayData extends IBaseOverlayData {
-  language: string
-  attribute_information: Record<string, string>
-}

package/src/interfaces/data/semantic/LabelOverlayData.interface.ts

@@ -1,8 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-
-export default interface ILabelOverlayData extends IBaseOverlayData {
-  language: string
-  attribute_labels: Record<string, string>
-  attribute_categories: string[]
-  category_labels: Record<string, string>
-}

package/src/interfaces/data/semantic/MetaOverlayData.interface.ts

@@ -1,13 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-
-export default interface IMetaOverlayData extends IBaseOverlayData {
-  language: string
-  name: string
-  description: string
-  credential_help_text: string
-  credential_support_url: string
-  issuer: string
-  issuer_description: string
-  issuer_url: string
-  watermark?: string
-}

package/src/interfaces/data/semantic/StandardOverlayData.interface.ts

@@ -1,7 +0,0 @@
-import IBaseOverlayData from '../base/BaseOverlayData.interface'
-
-export default interface IStandardOverlayData extends IBaseOverlayData {
-  // DEPRECATED - Use attribute_standards instead
-  attr_standards: Record<string, string>
-  attribute_standards: Record<string, string>
-}

package/src/interfaces/index.ts

@@ -1,2 +0,0 @@
-export * from './data'
-export * from './overlay'

package/src/interfaces/overlay/OverlayBundleAttribute.interface.ts

@@ -1,9 +0,0 @@
-export default interface IOverlayBundleAttribute {
-  name: string
-  type: string
-  information?: Record<string, string>
-  label?: Record<string, string>
-  format?: string
-  characterEncoding?: string
-  standard?: string
-}

package/src/interfaces/overlay/OverlayBundleMetadata.interface.ts

@@ -1,9 +0,0 @@
-export default interface IOverlayBundleMetadata {
-  name: Record<string, string>
-  description: Record<string, string>
-  credentialHelpText?: Record<string, string>
-  credentialSupportUrl?: Record<string, string>
-  issuer: Record<string, string>
-  issuerDescription?: Record<string, string>
-  issuerUrl?: Record<string, string>
-}

package/src/interfaces/overlay/index.ts

@@ -1,4 +0,0 @@
-import IOverlayBundleAttribute from './OverlayBundleAttribute.interface'
-import IOverlayBundleMetadata from './OverlayBundleMetadata.interface'
-
-export { IOverlayBundleAttribute, IOverlayBundleMetadata }

package/src/legacy/index.ts

@@ -1,3 +0,0 @@
-export * from './resolver/oca'
-export * from './resolver/record'
-export * from './resolver/remote-oca'