urlBuilder.ts 4.1 KB

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