urlBuilder.ts 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. import {Model} from '@vuex-orm/core'
  2. import {ImageArgs, UrlArgs} from '~/types/interfaces'
  3. import {QUERY_TYPE} from '~/types/enums'
  4. import {repositoryHelper} from '~/services/store/repository'
  5. import TypesTesting from "~/services/utils/typesTesting";
  6. import UrlOptionsBuilder from "~/services/connection/urlOptionsBuilder";
  7. /**
  8. * Classe permettant de construire une URL pour l'interrogation d'une API externe
  9. */
  10. class UrlBuilder {
  11. static ROOT = '/api/'
  12. /**
  13. * Main méthode qui appellera les méthode privées correspondantes (getEnumUrl, getModelUrl, getImageUrl)
  14. * @param {UrlArgs} args
  15. * @return {string}
  16. */
  17. public static build (args: UrlArgs): string {
  18. let url: string = ''
  19. switch (args.type) {
  20. case QUERY_TYPE.DEFAULT:
  21. if (!args.url) {
  22. throw new Error('*args* has no url')
  23. }
  24. url = args.url
  25. break;
  26. case QUERY_TYPE.ENUM:
  27. url = UrlBuilder.getEnumUrl(args.enumType)
  28. break;
  29. case QUERY_TYPE.MODEL:
  30. url = UrlBuilder.getModelUrl(args.model, args.rootModel, args.rootId)
  31. break;
  32. case QUERY_TYPE.IMAGE:
  33. if (!TypesTesting.isDataProviderArgs(args)) {
  34. throw new Error('*args* is not a dataProviderArgs')
  35. }
  36. if (!args.imgArgs) {
  37. throw new Error('*args* has no imgArgs')
  38. }
  39. url = UrlBuilder.getImageUrl(args.imgArgs, args.baseUrl)
  40. break;
  41. default:
  42. throw new Error('url, model, image or enum must be defined')
  43. break;
  44. }
  45. const options = UrlOptionsBuilder.build(args)
  46. return options.length > 0 ? `${url}?${UrlOptionsBuilder.build(args).join('&')}` : url
  47. }
  48. /**
  49. * Construction d'une URL Type Enum qui ira concaténer le type enum passé en paramètre avec la ROOT Url définie
  50. * @param {string} enumType
  51. * @return {string}
  52. */
  53. private static getEnumUrl (enumType?: string): string {
  54. if (typeof enumType === 'undefined') {
  55. throw new TypeError('enumType must be defined')
  56. }
  57. return UrlBuilder.concat(UrlBuilder.ROOT, 'enum', enumType)
  58. }
  59. /**
  60. * Construction d'une URL Type Model qui ira concaténer le nom de l'entité du model passé en paramètre
  61. * avec la ROOT Url définie (possibilité de récursivité si le root model est défini)
  62. *
  63. * @param {Model} model roles à tester
  64. * @param {Model} rootModel roles à tester
  65. * @param {number} rootId roles à tester
  66. * @return {string}
  67. */
  68. private static getModelUrl (model?: typeof Model, rootModel?: typeof Model, rootId?: number): string {
  69. if (typeof model === 'undefined') {
  70. throw new TypeError('model must be defined')
  71. }
  72. const entity = repositoryHelper.getEntity(model)
  73. if (typeof rootModel !== 'undefined') {
  74. if (typeof rootId === 'undefined') {
  75. throw new TypeError('Root ID must be defined')
  76. }
  77. const rootUrl = UrlBuilder.getModelUrl(rootModel) as string
  78. return String(`${rootUrl}/${rootId}/${entity}`).toString()
  79. }
  80. return UrlBuilder.concat(UrlBuilder.ROOT, entity)
  81. }
  82. /**
  83. * Construction d'une URL "image" qui ira concaténer l'id de l'image à downloeader passé en paramètre avec la ROOT Url définie
  84. * @param {number} id
  85. * @param {ImageArgs} imgArgs
  86. * @param {string} baseUrl
  87. * @return {string}
  88. */
  89. private static getImageUrl (imgArgs: ImageArgs, baseUrl: string = ''): string {
  90. const downloadUrl = `files/${imgArgs.id}/download/${imgArgs.height}x${imgArgs.width}`
  91. return UrlBuilder.concat(baseUrl, UrlBuilder.ROOT, downloadUrl)
  92. }
  93. /**
  94. * Concatenate a base url and a tail
  95. * @param base
  96. * @param tails
  97. * @private
  98. */
  99. public static concat (base: string, ...tails: string[]): string {
  100. let url = base
  101. tails.forEach((tail: string) => {
  102. url = url.replace(/^|\/$/g, '') + '/' + tail.replace(/^\/?|$/g, '')
  103. })
  104. return url
  105. }
  106. }
  107. export default UrlBuilder