EmbeddedCollectionType --> EmbeddedCollectionMeta

Author: usu

src/EmbeddedCollection.ts

@@ -1,5 +1,5 @@
 // import LoadingStoreCollection from './LoadingStoreCollection'
-import { EmbeddedCollectionType } from './interfaces/Resource'
+import { EmbeddedCollectionMeta } from './interfaces/EmbeddedCollection'
 import { Link } from './interfaces/StoreData'
 
 /**
@@ -9,9 +9,9 @@ import { Link } from './interfaces/StoreData'
  * URI, we need to reload the whole entity containing the embedded collection. Some extra info about the
  * containing entity must therefore be passed to the constrcutor.
  */
-class EmbeddedCollection implements EmbeddedCollectionType {
+class EmbeddedCollection implements EmbeddedCollectionMeta {
   public _meta: {
-    load: Promise<EmbeddedCollectionType>,
+    load: Promise<EmbeddedCollectionMeta>,
     reload: {
       uri: string,
       property: string
@@ -30,7 +30,7 @@ class EmbeddedCollection implements EmbeddedCollectionType {
    * @param config          dependency injection of config object
    * @param loadParent      a promise that will resolve when the parent entity has finished (re-)loading
    */
-  constructor (items: Array<Link>, reloadUri: string, reloadProperty: string, loadCollection: Promise<EmbeddedCollectionType> | null = null) {
+  constructor (items: Array<Link>, reloadUri: string, reloadProperty: string, loadCollection: Promise<EmbeddedCollectionMeta> | null = null) {
     this._storeData = {
       items
     }

src/index.ts

@@ -9,11 +9,11 @@ import ServerException from './ServerException'
 import { ExternalConfig } from './interfaces/Config'
 import { Store } from 'vuex/types'
 import { AxiosInstance, AxiosError } from 'axios'
-import Resource, { EmbeddedCollectionType } from './interfaces/Resource'
+import Resource from './interfaces/Resource'
 import StoreData, { Link } from './interfaces/StoreData'
 import ApiActions from './interfaces/ApiActions'
-import EmbeddedCollection from './EmbeddedCollection'
-import EmbeddedCollectionInterface from './interfaces/EmbeddedCollection'
+import EmbeddedCollectionClass from './EmbeddedCollection'
+import EmbeddedCollection, { EmbeddedCollectionMeta } from './interfaces/EmbeddedCollection'
 
 /**
  * Defines the API store methods available in all Vue components. The methods can be called as follows:
@@ -85,10 +85,10 @@ function HalJsonVuex (store: Store<Record<string, State>>, axios: AxiosInstance,
    * @returns Promise   Resolves when the GET request has completed and the updated entity is available
    *                    in the Vuex store.
    */
-  async function reload (uriOrEntity: string | Resource | StoreData | EmbeddedCollectionType): Promise<Resource | EmbeddedCollectionInterface> {
-    if (isEmbeddedCollectionType(uriOrEntity)) { // = type guard for Embedded Collection
+  async function reload (uriOrEntity: string | Resource | StoreData | EmbeddedCollectionMeta): Promise<Resource | EmbeddedCollection> {
+    if (isEmbeddedCollection(uriOrEntity)) { // = type guard for Embedded Collection
       return get(uriOrEntity._meta.reload.uri, true)._meta.load // load parent resource
-        .then(parent => parent[uriOrEntity._meta.reload.property]() as EmbeddedCollectionInterface) // ... and unwrap reload property after loading has finished
+        .then(parent => parent[uriOrEntity._meta.reload.property]() as EmbeddedCollection) // ... and unwrap reload property after loading has finished
     } else {
       return get(uriOrEntity, true)._meta.load
     }
@@ -141,18 +141,18 @@ function HalJsonVuex (store: Store<Record<string, State>>, axios: AxiosInstance,
   }
 
   /**
-   * Type guard for EmbeddedCollectionType
+   * Type guard for EmbeddedCollectionMeta
    * @param uriOrEntity
    */
-  function isEmbeddedCollectionType (uriOrEntity: string | Resource | EmbeddedCollectionType | StoreData | null): uriOrEntity is EmbeddedCollectionType {
+  function isEmbeddedCollection (uriOrEntity: string | Resource | EmbeddedCollectionMeta | StoreData | null): uriOrEntity is EmbeddedCollectionMeta {
     if (uriOrEntity === null) return false
 
     if (typeof uriOrEntity === 'string') return false
 
     // found an actual EmbeddedCollection instance
-    if (uriOrEntity instanceof EmbeddedCollection) return true
+    if (uriOrEntity instanceof EmbeddedCollectionClass) return true
 
-    // found an object that looks like an EmbeddedCollectionType
+    // found an object that looks like an EmbeddedCollectionMeta
     return 'reload' in uriOrEntity._meta
   }
 

src/interfaces/ApiActions.ts

@@ -1,10 +1,10 @@
 import EmbeddedCollection from './EmbeddedCollection'
-import Resource, { EmbeddedCollectionType } from './Resource'
+import Resource, { EmbeddedCollectionMeta } from './Resource'
 import StoreData from './StoreData'
 
 interface ApiActions {
     get: (uriOrEntity: string | Resource | StoreData, forceReload?: boolean) => Resource
-    reload: (uriOrEntity: string | Resource | StoreData | EmbeddedCollectionType) => Promise<Resource | EmbeddedCollection>
+    reload: (uriOrEntity: string | Resource | StoreData | EmbeddedCollectionMeta) => Promise<Resource | EmbeddedCollection>
     post: (uriOrEntity: string | Resource, data: unknown) =>Promise<Resource>
     patch: (uriOrEntity: string | Resource, data: unknown) => Promise<Resource>
     del: (uriOrEntity: string | Resource) => Promise<string | void>

src/interfaces/EmbeddedCollection.ts

@@ -1,16 +1,19 @@
 import Collection from './Collection'
 
-/**
- * Subtype for an embeddeed collection with no self link (no standalone store entry, exists only with its parent)
- */
- type EmbeddedCollection = Collection & {
+type EmbeddedCollectionMeta = {
     _meta: {
+        load?: Promise<EmbeddedCollectionMeta>
         reload: {
             uri: string
             property: string
         }
     }
 }
 
-export { EmbeddedCollection }
+/**
+ * Subtype for an embedded collection with no self link (no standalone store entry, exists only with its parent)
+ */
+ type EmbeddedCollection = Collection & EmbeddedCollectionMeta
+
+export { EmbeddedCollection, EmbeddedCollectionMeta }
 export default EmbeddedCollection

src/interfaces/Resource.ts

@@ -20,18 +20,5 @@ type Resource = {
     $del: () => Promise<string | void>
 }
 
-/**
- * Subtype for an embeddeed collection with no self link (no standalone store entry, exists only with its parent)
- */
-type EmbeddedCollectionType = {
-    _meta: {
-        load?: Promise<EmbeddedCollectionType>
-        reload: {
-            uri: string
-            property: string
-        }
-    }
-}
-
-export { Resource, EmbeddedCollectionType }
+export { Resource }
 export default Resource

src/interfaces/StoreData.ts

@@ -31,10 +31,6 @@ type StoreDataCollection = StoreDataMeta & {
 
 type StoreData = StoreDataEntity | StoreDataCollection
 
-type Collection = {
-    items: Array<Link>
-}
-
-export { StoreData, Link, TemplatedLink, Collection, StoreDataEntity, StoreDataCollection }
+export { StoreData, Link, TemplatedLink, StoreDataEntity, StoreDataCollection }
 
 export default StoreData