fix(syndesi): try to keep type declaration for resource metadata

Author: dherges

libs/syndesi/src/lib/call.ts

@@ -1,7 +1,7 @@
 import { HttpClient, HttpResponse } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
-import { Resource } from './resource.interfaces';
+import { Resource, ResourceMetadata } from './resource.interfaces';
 import { expand, UriParams } from './uri';
 
 const toNextCall = <S, T>(call: Call<S>) => {
@@ -15,7 +15,7 @@ const toNextCall = <S, T>(call: Call<S>) => {
 };
 
 /**
- * A `Call` is a single HTTP interaction
+ * A `Call` is a single HTTP interaction for exchanging a resource between client and server.
  *
  * ### How To Use
  *
@@ -45,6 +45,7 @@ export class Call<T> {
   private _method: string;
   private _options = {};
 
+  // TODO: public resource: T & ResourceMetadata
   constructor(
     http: HttpClient | Call<any>,
     public resource: Resource<T>,

libs/syndesi/src/lib/embedded.functions.ts

@@ -8,7 +8,7 @@ export function hasEmbedded<T>(value: any): value is ResourceWithEmbedded<T> {
 export interface EmbeddedOpts<T> {
   guard?: (value: any) => value is T;
   shouldThrow?: boolean;
-};
+}
 
 /**
  * Return the embedded resource identified by relation `rel` from parent `res`.

libs/syndesi/src/lib/link.functions.ts

@@ -14,8 +14,17 @@ export function isLinks(value: any): value is Link[] {
 
 export interface LinkOpts {
   shouldThrow?: boolean;
-};
+}
 
+/**
+ * Return the link identified by relation `rel` from resource `res`.
+ *
+ * @param rel Relation name
+ * @param res Parent resource
+ * @param opts Set `shouldThrow`, if you want an error instead of an `undefined` return value
+ * @return An object of type `Link` or an `undefined` value
+ * @stable
+ */
 export function link(rel: string, res: any, opts?: LinkOpts): Link {
   if (hasLinks(res)) {
     const linkForRel = res._links[rel];
@@ -30,6 +39,15 @@ export function link(rel: string, res: any, opts?: LinkOpts): Link {
   }
 }
 
+/**
+ * Return an array of links identified by relation `rel` from resource `res`.
+ *
+ * @param rel Relation name
+ * @param res Parent resource
+ * @param opts Set `shouldThrow`, if you want an error instead of an `undefined` return value
+ * @return Array of `Link` or an `undefined` value
+ * @stable
+ */
 export function links(rel: string, res: any, opts?: LinkOpts): Link[] {
   if (hasLinks(res)) {
     const linkForRel = res._links[rel];

libs/syndesi/src/lib/resource.interfaces.ts

@@ -57,7 +57,9 @@ export interface Link {
  *
  * @stable
  */
-export type Resource<T> = T & {
+export type Resource<T> = T & ResourceMetadata;
+
+export interface ResourceMetadata {
   _links: {
     self: Link;
     [key: string]: Link | Link[];