ketting 7.0.1 → 7.3.0

package/src/state/collection-json.ts

@@ -45,55 +45,55 @@ export const factory: StateFactory = async (client, uri, response): Promise<CjSt
 };
 
 type CjDocument = {
-  collection: CjCollection,
+  collection: CjCollection;
 };
 
 type CjCollection = {
-  version?: string,
-  href?: string,
-  links?: CjLink[],
-  items?: CjItem[],
-  queries?: CjQuery[],
-  template?: CjTemplate,
-  error?: CjError
+  version?: string;
+  href?: string;
+  links?: CjLink[];
+  items?: CjItem[];
+  queries?: CjQuery[];
+  template?: CjTemplate;
+  error?: CjError;
 };
 
 type CjError = {
-  title?: string,
-  code?: string,
-  message?: string,
+  title?: string;
+  code?: string;
+  message?: string;
 };
 
 type CjTemplate = {
-  data?: CjProperty[]
+  data?: CjProperty[];
 };
 
 type CjItem = {
-  href?: string,
-  data?: CjProperty[],
-  links?: CjLink[],
+  href?: string;
+  data?: CjProperty[];
+  links?: CjLink[];
 };
 
 type CjProperty = {
-  name: string,
-  value?: string,
-  prompt?: string
+  name: string;
+  value?: string;
+  prompt?: string;
 };
 
 type CjQuery = {
-  href: string,
-  rel: string,
-  name?: string,
-  prompt?: string,
-  data?: CjProperty[]
+  href: string;
+  rel: string;
+  name?: string;
+  prompt?: string;
+  data?: CjProperty[];
 };
 
 type CjLink = {
-  href: string,
-  rel: string,
-  name?: string,
-  render?: 'image' | 'link',
-  prompt?: string
+  href: string;
+  rel: string;
+  name?: string;
+  render?: 'image' | 'link';
+  prompt?: string;
 };
 
 

package/src/state/hal.ts

@@ -204,7 +204,7 @@ function parseHalLink(context: string, rel: string, links: hal.HalLink[]): Link[
  */
 function parseHalEmbedded(client: Client, context: string, body: hal.HalResource, headers: Headers): HalState<any>[] {
 
-  if (body._embedded === undefined) {
+  if (body._embedded === undefined || !body._embedded) {
     return [];
   }
 
@@ -222,10 +222,14 @@ function parseHalEmbedded(client: Client, context: string, body: hal.HalResource
     }
     for (const embeddedItem of embeddedList) {
 
-      if (embeddedItem._links === undefined || embeddedItem._links.self === undefined || Array.isArray(embeddedItem._links.self)) {
-        // Skip any embedded without a self link.
+      if (embeddedItem._links?.self?.href === undefined) {
+        // eslint-disable-next-line no-console
+        console.warn('An item in _embedded was ignored. Each item must have a single "self" link');
         continue;
       }
+
+      const embeddedSelf = resolve(context, embeddedItem._links.self.href);
+
       // Remove _links and _embedded from body
       const {
         _embedded,
@@ -235,16 +239,16 @@ function parseHalEmbedded(client: Client, context: string, body: hal.HalResource
 
       result.push(new HalState({
         client,
-        uri: resolve(context, embeddedItem._links.self.href),
+        uri: embeddedSelf,
         data: newBody,
         headers: new Headers({
           'Content-Type': headers.get('Content-Type')!,
         }),
-        links: new Links(context, parseHalLinks(context, embeddedItem)),
+        links: new Links(embeddedSelf, parseHalLinks(context, embeddedItem)),
         // Parsing nested embedded items. Note that we assume that the base url is relative to
         // the outermost parent, not relative to the embedded item. HAL is not clear on this.
-        embedded: parseHalEmbedded(client, context, embeddedItem, headers),
-        actions: parseHalForms(context, embeddedItem)
+        embedded: parseHalEmbedded(client, embeddedSelf, embeddedItem, headers),
+        actions: parseHalForms(embeddedSelf, embeddedItem)
       }));
     }
   }
@@ -284,6 +288,7 @@ function parseHalField(halField: hal.HalFormsProperty): Field {
         const baseField = {
           name: halField.name,
           type: 'select' as const,
+          label: halField.prompt,
           required: halField.required || false,
           readOnly: halField.readOnly || false,
           multiple: halField.options.multiple as any,

package/src/state/interface.ts

@@ -15,12 +15,12 @@ export type State<T = any> = {
    *
    * In the case of a JSON response, this will be deserialized
    */
-  data: T
+  data: T;
 
   /**
    * All links associated with the resource.
    */
-  links: Links,
+  links: Links;
 
   /**
    * The full list of HTTP headers that were sent with the response.

package/src/state/jsonapi.ts

@@ -36,9 +36,9 @@ type JsonApiLink = string | { href: string };
  * or on resource objects.
  */
 type JsonApiLinksObject = {
-  self?: JsonApiLink,
-  profile?: JsonApiLink,
-  [rel: string]: JsonApiLink | JsonApiLink[] | undefined
+  self?: JsonApiLink;
+  profile?: JsonApiLink;
+  [rel: string]: JsonApiLink | JsonApiLink[] | undefined;
 };
 
 /**
@@ -46,9 +46,9 @@ type JsonApiLinksObject = {
  * we care about.
  */
 type JsonApiResource = {
-  type: string,
-  id: string,
-  links?: JsonApiLinksObject,
+  type: string;
+  id: string;
+  links?: JsonApiLinksObject;
 };
 
 
@@ -58,9 +58,9 @@ type JsonApiResource = {
  * untyped.
  */
 type JsonApiTopLevelObject = {
-  links?: JsonApiLinksObject,
-  data: JsonApiResource | JsonApiResource[] | null,
-  [s: string]: any
+  links?: JsonApiLinksObject;
+  data: JsonApiResource | JsonApiResource[] | null;
+  [s: string]: any;
 };
 
 /**

package/src/state/siren.ts

@@ -66,14 +66,14 @@ type SirenProperties = Record<string, any> | undefined;
 
 type SirenEntity<T extends SirenProperties> = {
 
-  class?: string[],
+  class?: string[];
 
-  properties: T
-  entities?: (SirenLink | SirenSubEntity)[],
+  properties: T;
+  entities?: (SirenLink | SirenSubEntity)[];
 
-  links?: SirenLink[],
-  actions?: SirenAction[],
-  title?: string,
+  links?: SirenLink[];
+  actions?: SirenAction[];
+  title?: string;
 
 };
 
@@ -81,30 +81,30 @@ type SirenSubEntity = SirenEntity<any> & { rel: string[] };
 
 type SirenLink = {
 
-  class?: string[],
-  rel: string[],
-  href: string,
-  type?: string,
-  title?: string,
+  class?: string[];
+  rel: string[];
+  href: string;
+  type?: string;
+  title?: string;
 
 };
 
 type SirenAction = {
-  name: string,
-  class?: string[],
-  method?: string,
-  href: string,
-  title?: string,
-  type?: string,
-  fields?: SirenField[],
+  name: string;
+  class?: string[];
+  method?: string;
+  href: string;
+  title?: string;
+  type?: string;
+  fields?: SirenField[];
 };
 
 type SirenField = {
-  name: string,
-  class?: string[],
-  type?: 'hidden' | 'text' | 'search' | 'tel' | 'url' | 'email' | 'password' | 'datetime' | 'date' | 'month' | 'week' | 'time' | 'datetime-local' | 'number' | 'range' | 'color' | 'checkbox' | 'radio' | 'file'
-  value?: string,
-  title?: string
+  name: string;
+  class?: string[];
+  type?: 'hidden' | 'text' | 'search' | 'tel' | 'url' | 'email' | 'password' | 'datetime' | 'date' | 'month' | 'week' | 'time' | 'datetime-local' | 'number' | 'range' | 'color' | 'checkbox' | 'radio' | 'file';
+  value?: string;
+  title?: string;
 };
 
 function parseSirenLinks(contextUri: string, body: SirenEntity<any>): Link[] {

package/src/types.ts

@@ -29,7 +29,7 @@ export type RequestOptions<T = any> = {
    *
    * If this is not set, we'll fall back to 'headers'
    */
-  getContentHeaders?: () => HttpHeaders | Headers,
+  getContentHeaders?: () => HttpHeaders | Headers;
 
   /**
    * Full list of HTTP headers.

package/src/util/html.ts

@@ -3,17 +3,17 @@ import { Link } from '../link';
 import { resolve } from './uri';
 
 export type HtmlForm = {
-  action: string,
-  method: string | null,
-  enctype: string | null,
-  rel: string | null,
-  id: string | null,
+  action: string;
+  method: string | null;
+  enctype: string | null;
+  rel: string | null;
+  id: string | null;
 }
 
 type ParseHtmlResult = {
 
-  links: Link[],
-  forms: HtmlForm[],
+  links: Link[];
+  forms: HtmlForm[];
 
 }
 
@@ -56,16 +56,16 @@ function parseLink(contextUri: string, node: sax.Tag): Link[] {
     return [];
   }
 
-  const rels = <string> node.attributes.REL;
+  const rels = node.attributes.REL as string;
 
   const links: Link[] = [];
   for (const rel of rels.split(' ')) {
 
-    const type = <string>node.attributes.TYPE;
+    const type = node.attributes.TYPE as string;
     const link: Link = {
       rel,
       context: contextUri,
-      href: <string> node.attributes.HREF,
+      href: node.attributes.HREF as string,
     };
     if (type) link.type = type;
     links.push(link);

package/src/util/html.web.ts

@@ -2,17 +2,17 @@ import { Link } from '../link';
 import { resolve } from './uri';
 
 export type HtmlForm = {
-  action: string,
-  method: string | null,
-  enctype: string | null,
-  rel: string | null,
-  id: string | null,
+  action: string;
+  method: string | null;
+  enctype: string | null;
+  rel: string | null;
+  id: string | null;
 }
 
 type ParseHtmlResult = {
 
-  links: Link[],
-  forms: HtmlForm[],
+  links: Link[];
+  forms: HtmlForm[];
 
 }
 export function parseHtml(contextUri: string, body: string): ParseHtmlResult {

package/src/util/uri.ts

@@ -2,7 +2,7 @@ import { parse as p, resolve as r } from 'url';
 import { Link } from '../link';
 
 type UrlParts = {
-  host?: string|null,
+  host?: string|null;
 };
 
 /**

package/src/util/uri.web.ts

@@ -1,7 +1,7 @@
 import { Link } from '../link';
 
 type UrlParts = {
-  host?: string,
+  host?: string;
 };
 
 /**
@@ -32,7 +32,7 @@ export function resolve(base: string|Link, relative?: string): string {
 
   const doc     = document;
   const oldBase = doc.getElementsByTagName('base')[0];
-  const oldHref = oldBase && oldBase.href;
+  const oldHref = oldBase?.href;
   const docHead = doc.head || doc.getElementsByTagName('head')[0];
   const ourBase = oldBase || docHead.appendChild(doc.createElement('base'));
   const resolver = doc.createElement('a');