entityManager.ts 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  1. import ApiRequestService from "./apiRequestService";
  2. import {Repository, useRepo} from "pinia-orm";
  3. import Url from "~/services/utils/url";
  4. import ModelNormalizer from "./serializer/normalizer/modelNormalizer";
  5. import HydraDenormalizer from "./serializer/denormalizer/hydraDenormalizer";
  6. import ApiModel from "~/models/ApiModel";
  7. import ApiResource from "~/models/ApiResource";
  8. import {MyProfile} from "~/models/Access/MyProfile";
  9. import {v4 as uuid4} from 'uuid';
  10. import {AssociativeArray, Collection} from "~/types/data.d";
  11. import {useCloneDeep} from "#imports";
  12. import models from "~/models/models";
  13. import {useAccessProfileStore} from "~/stores/accessProfile";
  14. /**
  15. * Entity manager: make operations on the models defined with the Pinia-Orm library
  16. *
  17. * @see https://pinia-orm.codedredd.de/
  18. */
  19. class EntityManager {
  20. private CLONE_PREFIX = '_clone_'
  21. private apiRequestService: ApiRequestService
  22. public constructor(
  23. apiRequestService: ApiRequestService
  24. ) {
  25. this.apiRequestService = apiRequestService
  26. }
  27. /**
  28. * Return the repository for the model
  29. *
  30. * @param model
  31. */
  32. public getRepository(model: typeof ApiResource): Repository<ApiResource> {
  33. return useRepo(model)
  34. }
  35. // noinspection JSMethodCanBeStatic
  36. public cast(model: typeof ApiResource, entity: ApiResource): ApiResource {
  37. return new model(entity)
  38. }
  39. /**
  40. * Return the model class with the given entity name
  41. *
  42. * @param entityName
  43. */
  44. public getModelFor(entityName: string): typeof ApiResource{
  45. return models[entityName]
  46. }
  47. /**
  48. * Create a new instance of the given model
  49. *
  50. * @param model
  51. * @param properties
  52. */
  53. public newInstance(model: typeof ApiResource, properties: object = {}): ApiResource {
  54. const repository = this.getRepository(model)
  55. let entity = repository.make(properties)
  56. entity.setModel(model)
  57. // @ts-ignore
  58. if (!properties.hasOwnProperty('id') || !properties.id) {
  59. // Object has no id yet, we give him a temporary one
  60. entity.id = 'tmp' + uuid4()
  61. }
  62. entity = repository.save(entity)
  63. this.saveInitialState(model, entity)
  64. return entity
  65. }
  66. /**
  67. * Save the entity into the store
  68. *
  69. * @param model
  70. * @param entity
  71. */
  72. public save(model: typeof ApiResource, entity: ApiResource): ApiResource {
  73. return this.getRepository(model).save(entity)
  74. }
  75. /**
  76. * Find the entity into the store
  77. *
  78. * @param model
  79. * @param id
  80. */
  81. // @ts-ignore
  82. public find<T extends ApiResource>(model: typeof T, id: number): T {
  83. const repository = this.getRepository(model)
  84. return repository.find(id) as T
  85. }
  86. /**
  87. * Fetch an Entity / ApiResource by its id, save it to the store and returns it
  88. *
  89. * @param model Model of the object to fetch
  90. * @param id Id of the object to fetch
  91. * @param forceRefresh Force a new get request to the api ;
  92. * current object in store will be overwritten if it exists
  93. */
  94. public async fetch(model: typeof ApiResource, id: number, forceRefresh: boolean = false): Promise<ApiResource> {
  95. const repository = this.getRepository(model)
  96. // If the entity is already in the store and forceRefresh is false, return the object in store
  97. if (!forceRefresh) {
  98. const item = repository.find(id)
  99. if (item && typeof item !== 'undefined') {
  100. return item
  101. }
  102. }
  103. // Else, get the object from the API
  104. const url = Url.join('api', model.entity, String(id))
  105. const response = await this.apiRequestService.get(url)
  106. // deserialize the response
  107. const attributes = HydraDenormalizer.denormalize(response).data as object
  108. return this.newInstance(model, attributes)
  109. }
  110. /**
  111. * Fetch a collection of entity
  112. * The content of `query` is converted into a query-string in the request URL
  113. *
  114. * @param model
  115. * @param query
  116. * @param parent
  117. */
  118. public async fetchCollection(model: typeof ApiResource, parent: ApiResource | null, query: AssociativeArray = []): Promise<Collection> {
  119. let url
  120. if (parent !== null) {
  121. url = Url.join('api', parent.entity, '' + parent.id, model.entity)
  122. } else {
  123. url = Url.join('api', model.entity)
  124. }
  125. const response = await this.apiRequestService.get(url, query)
  126. // deserialize the response
  127. const apiCollection = HydraDenormalizer.denormalize(response)
  128. const items = apiCollection.data.map((attributes: object) => {
  129. return this.newInstance(model, attributes)
  130. })
  131. return {
  132. items,
  133. totalItems: apiCollection.metadata.totalItems,
  134. pagination: {
  135. first: apiCollection.metadata.firstPage || 1,
  136. last: apiCollection.metadata.lastPage || 1,
  137. next: apiCollection.metadata.nextPage || undefined,
  138. previous: apiCollection.metadata.previousPage || undefined,
  139. }
  140. }
  141. }
  142. private async saveResponseAsEntity(model: typeof ApiModel, response: Response) {
  143. const repository = this.getRepository(model)
  144. const hydraResponse = await HydraDenormalizer.denormalize(response)
  145. const returnedEntity = this.newInstance(model, hydraResponse.data)
  146. this.saveInitialState(model, returnedEntity)
  147. // Save data into the store
  148. repository.save(returnedEntity)
  149. return returnedEntity
  150. }
  151. /**
  152. * Persist the entity as it is in the store into the data source via the API
  153. *
  154. * @param model
  155. * @param entity
  156. */
  157. public async persist(model: typeof ApiModel, entity: ApiModel) {
  158. // Recast in case class definition has been "lost"
  159. entity = this.cast(model, entity)
  160. let url = Url.join('api', model.entity)
  161. let response
  162. const data = ModelNormalizer.normalize(entity)
  163. if (!entity.isNew()) {
  164. url = Url.join(url, String(entity.id))
  165. response = await this.apiRequestService.put(url, data)
  166. } else {
  167. delete data.id
  168. response = await this.apiRequestService.post(url, data)
  169. }
  170. return this.saveResponseAsEntity(model, response)
  171. }
  172. /**
  173. * Send an update request (PUT) to the API with the given data on an existing entity
  174. *
  175. * @param model
  176. * @param id
  177. * @param data
  178. */
  179. public async patch(model: typeof ApiModel, id: number, data: AssociativeArray) {
  180. let url = Url.join('api', model.entity, ''+id)
  181. const body = JSON.stringify(data)
  182. const response = await this.apiRequestService.put(url, body)
  183. return this.saveResponseAsEntity(model, response)
  184. }
  185. /**
  186. * Delete the entity from the datasource via the API
  187. *
  188. * @param model
  189. * @param entity
  190. */
  191. public async delete(model: typeof ApiModel, entity: ApiResource) {
  192. const repository = this.getRepository(model)
  193. // If object has been persisted to the datasource, send a delete request
  194. if (!entity.isNew()) {
  195. const url = Url.join('api', model.entity, String(entity.id))
  196. await this.apiRequestService.delete(url)
  197. }
  198. // reactiveUpdate the store
  199. repository.destroy(entity.id)
  200. }
  201. /**
  202. * Reset the entity to its initial state (i.e. the state it had when it was fetched from the API)
  203. *
  204. * @param model
  205. * @param entity
  206. */
  207. public reset(model: typeof ApiResource, entity: ApiResource) {
  208. const initialEntity = this.getInitialStateOf(model, entity.id)
  209. if (initialEntity === null) {
  210. throw new Error('no initial state recorded for this object - abort [' + model.entity + '/' + entity.id + ']')
  211. }
  212. const repository = this.getRepository(model)
  213. repository.save(initialEntity)
  214. return initialEntity
  215. }
  216. /**
  217. * Re-fetch the user profile and update the store
  218. */
  219. public async refreshProfile() {
  220. const response = await this.apiRequestService.get('api/my_profile')
  221. // deserialize the response
  222. const hydraResponse = await HydraDenormalizer.denormalize(response)
  223. const profileData = hydraResponse.data
  224. // On n'aura jamais 2 profils stockés, et on a besoin d'un id pour retrouver le profil dans le store :
  225. profileData['id'] = 1
  226. const profile = this.newInstance(MyProfile, hydraResponse.data)
  227. // On met à jour le store accessProfile
  228. // TODO: sortir le use du service, ça devrait être dans un composable
  229. const accessProfileStore = useAccessProfileStore()
  230. accessProfileStore.setProfile(profile)
  231. }
  232. /**
  233. * Delete all records in the repository of the model
  234. *
  235. * @param model
  236. */
  237. public async flush(model: typeof ApiModel) {
  238. const repository = this.getRepository(model)
  239. repository.flush()
  240. }
  241. /**
  242. * Is the entity a new one, or does it already exist in the data source (=API)
  243. *
  244. * @param model
  245. * @param id
  246. */
  247. public isNewEntity(model: typeof ApiModel, id: number | string): boolean {
  248. const repository = this.getRepository(model)
  249. const item = repository.find(id)
  250. if (!item || typeof item === 'undefined') {
  251. console.error(model.entity + '/' + id, ' does not exist!')
  252. return false
  253. }
  254. return item.isNew()
  255. }
  256. /**
  257. * Save the state of the entity in the store, so this state could be be restored later
  258. *
  259. * @param model
  260. * @param entity
  261. * @private
  262. */
  263. private saveInitialState(model: typeof ApiResource, entity: ApiResource) {
  264. const repository = this.getRepository(model)
  265. // Clone and prefix id
  266. const clone = useCloneDeep(entity)
  267. clone.id = this.CLONE_PREFIX + clone.id
  268. repository.save(clone)
  269. }
  270. /**
  271. * Return the saved state of the entity from the store
  272. *
  273. * @param model
  274. * @param id
  275. * @private
  276. */
  277. private getInitialStateOf(model: typeof ApiResource, id: string | number): ApiResource | null {
  278. const repository = this.getRepository(model)
  279. // Find the clone by id
  280. const entity = repository.find(this.CLONE_PREFIX + id)
  281. if (entity === null) {
  282. return null
  283. }
  284. // Restore the initial id
  285. entity.id = id
  286. return entity
  287. }
  288. }
  289. export default EntityManager