urlBuilder.ts 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  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. url = UrlBuilder.getDefaultUrl( args.url, args.baseUrl)
  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. case QUERY_TYPE.FILE:
  39. url = UrlBuilder.getFileUrl(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 qui ira concaténer la base URL avec l'url
  50. * @param url
  51. * @param baseUrl
  52. * @private
  53. */
  54. private static getDefaultUrl (url?: string, baseUrl: string|null = null): string {
  55. if (!url) {
  56. throw new Error('no url')
  57. }
  58. return baseUrl ? UrlBuilder.concat(baseUrl, url) : url
  59. }
  60. /**
  61. * Construction d'une URL Type Enum qui ira concaténer le type enum passé en paramètre avec la ROOT Url définie
  62. * @param {string} enumType
  63. * @return {string}
  64. */
  65. private static getEnumUrl (enumType?: string): string {
  66. if (typeof enumType === 'undefined') {
  67. throw new Error('enumType must be defined')
  68. }
  69. return UrlBuilder.concat(UrlBuilder.ROOT, 'enum', enumType)
  70. }
  71. /**
  72. * Construction d'une URL Type Model qui ira concaténer le nom de l'entité du model passé en paramètre
  73. * avec la ROOT Url définie (possibilité de récursivité si le root model est défini)
  74. *
  75. * @param {Model} model roles à tester
  76. * @param {Model} rootModel roles à tester
  77. * @param {number} rootId roles à tester
  78. * @return {string}
  79. */
  80. private static getModelUrl (model?: typeof Model, rootModel?: typeof Model, rootId?: number): string {
  81. if (typeof model === 'undefined') {
  82. throw new Error('model must be defined')
  83. }
  84. const entity = repositoryHelper.getEntity(model)
  85. if (typeof rootModel !== 'undefined') {
  86. if (typeof rootId === 'undefined') {
  87. throw new Error('Root ID must be defined')
  88. }
  89. const rootUrl = UrlBuilder.getModelUrl(rootModel) as string
  90. return String(`${rootUrl}/${rootId}/${entity}`).toString()
  91. }
  92. return UrlBuilder.concat(UrlBuilder.ROOT, entity)
  93. }
  94. /**
  95. * 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
  96. * @param {number} id
  97. * @param {ImageArgs} imgArgs
  98. * @param {string} baseUrl
  99. * @return {string}
  100. */
  101. private static getImageUrl (imgArgs: ImageArgs, baseUrl: string = ''): string {
  102. const downloadUrl = `files/${imgArgs.id}/download/${imgArgs.height}x${imgArgs.width}`
  103. return UrlBuilder.concat(baseUrl, UrlBuilder.ROOT, downloadUrl)
  104. }
  105. /**
  106. * Construction d'une URL qui ira concaténer la base URL avec le Root et l'uri files
  107. * @param baseUrl
  108. * @private
  109. */
  110. private static getFileUrl (baseUrl: string = ''): string {
  111. return UrlBuilder.concat(baseUrl, UrlBuilder.ROOT, 'files')
  112. }
  113. /**
  114. * Concatenate a base url and a tail
  115. * @param base
  116. * @param tails
  117. * @private
  118. */
  119. public static concat (base: string, ...tails: string[]): string {
  120. let url = base
  121. tails.forEach((tail: string) => {
  122. url = url.replace(/^|\/$/g, '') + '/' + tail.replace(/^\/?|$/g, '')
  123. })
  124. return url
  125. }
  126. }
  127. export default UrlBuilder