urlBuilder.ts 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  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 (getDefaultUrl, 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. url = UrlBuilder.getDefaultUrl(args.url)
  22. break;
  23. case QUERY_TYPE.ENUM:
  24. url = UrlBuilder.getEnumUrl(args.enumType)
  25. break;
  26. case QUERY_TYPE.MODEL:
  27. url = UrlBuilder.getModelUrl(args.model, args.rootModel, args.rootId)
  28. break;
  29. case QUERY_TYPE.IMAGE:
  30. if (!TypesTesting.isDataProviderArgs(args)) {
  31. throw new Error('*args* is not a dataProviderArgs')
  32. }
  33. if (!args.imgArgs) {
  34. throw new Error('*args* has no imgArgs')
  35. }
  36. url = UrlBuilder.getImageUrl(args.imgArgs, args.baseUrl)
  37. break;
  38. default:
  39. throw new Error('url, model, image or enum must be defined')
  40. break;
  41. }
  42. const options = UrlOptionsBuilder.build(args)
  43. return options.length > 0 ? `${url}?${UrlOptionsBuilder.build(args).join('&')}` : url
  44. }
  45. /**
  46. * Construction d'une URL "traditionnelle" qui ira concaténer l'url passée en paramètre avec la ROOT Url définie
  47. * @param {string} url
  48. * @return {string}
  49. */
  50. private static getDefaultUrl (url?: string): string {
  51. if (typeof url === 'undefined') {
  52. throw new TypeError('url must be defined')
  53. }
  54. return UrlBuilder.concat(url)
  55. }
  56. /**
  57. * Construction d'une URL Type Enum qui ira concaténer le type enum passé en paramètre avec la ROOT Url définie
  58. * @param {string} enumType
  59. * @return {string}
  60. */
  61. private static getEnumUrl (enumType?: string): string {
  62. if (typeof enumType === 'undefined') {
  63. throw new TypeError('enumType must be defined')
  64. }
  65. return UrlBuilder.concat(UrlBuilder.ROOT, 'enum', enumType)
  66. }
  67. /**
  68. * Construction d'une URL Type Model qui ira concaténer le nom de l'entité du model passé en paramètre
  69. * avec la ROOT Url définie (possibilité de récursivité si le root model est défini)
  70. *
  71. * @param {Model} model roles à tester
  72. * @param {Model} rootModel roles à tester
  73. * @param {number} rootId roles à tester
  74. * @return {string}
  75. */
  76. private static getModelUrl (model?: typeof Model, rootModel?: typeof Model, rootId?: number): string {
  77. if (typeof model === 'undefined') {
  78. throw new TypeError('model must be defined')
  79. }
  80. const entity = repositoryHelper.getEntity(model)
  81. if (typeof rootModel !== 'undefined') {
  82. if (typeof rootId === 'undefined') {
  83. throw new TypeError('Root ID must be defined')
  84. }
  85. const rootUrl = UrlBuilder.getModelUrl(rootModel) as string
  86. return String(`${rootUrl}/${rootId}/${entity}`).toString()
  87. }
  88. return UrlBuilder.concat(UrlBuilder.ROOT, entity)
  89. }
  90. /**
  91. * 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
  92. * @param {number} id
  93. * @param {ImageArgs} imgArgs
  94. * @param {string} baseUrl
  95. * @return {string}
  96. */
  97. private static getImageUrl (imgArgs: ImageArgs, baseUrl: string = ''): string {
  98. const downloadUrl = `files/${imgArgs.id}/download/${imgArgs.height}x${imgArgs.width}`
  99. return UrlBuilder.concat(baseUrl, UrlBuilder.ROOT, downloadUrl)
  100. }
  101. /**
  102. * Concatenate a base url and a tail
  103. * @param base
  104. * @param tails
  105. * @private
  106. */
  107. public static concat (base: string, ...tails: string[]): string {
  108. let url = base
  109. tails.forEach((tail: string) => {
  110. url = url.replace(/^|\/$/g, '') + '/' + tail.replace(/^\/?|$/g, '')
  111. })
  112. return url
  113. }
  114. }
  115. export default UrlBuilder