ketting 7.0.1 → 7.3.0

package/src/client.ts

@@ -38,16 +38,16 @@ export default class Client {
    * headers. Higher means higher priority.
    */
   contentTypeMap: {
-    [mimeType: string]: [StateFactory<any>, string],
+    [mimeType: string]: [StateFactory<any>, string];
   } = {
-    'application/prs.hal-forms+json': [halStateFactory, '1.0'],
-    'application/hal+json': [halStateFactory, '0.9'],
-    'application/vnd.api+json': [jsonApiStateFactory, '0.8'],
-    'application/vnd.siren+json': [sirenStateFactory, '0.8'],
-    'application/vnd.collection+json': [cjStateFactory, '0.8'],
-    'application/json': [halStateFactory, '0.7'],
-    'text/html': [htmlStateFactory, '0.6'],
-  }
+      'application/prs.hal-forms+json': [halStateFactory, '1.0'],
+      'application/hal+json': [halStateFactory, '0.9'],
+      'application/vnd.api+json': [jsonApiStateFactory, '0.8'],
+      'application/vnd.siren+json': [sirenStateFactory, '0.8'],
+      'application/vnd.collection+json': [cjStateFactory, '0.8'],
+      'application/json': [halStateFactory, '0.7'],
+      'text/html': [htmlStateFactory, '0.6'],
+    };
 
   /**
    * The cache for 'State' objects
@@ -141,6 +141,83 @@ export default class Client {
   clearCache() {
 
     this.cache.clear();
+    this.cacheDependencies = new Map();
+
+  }
+
+  /**
+   * Caches a State object
+   *
+   * This function will also emit 'update' events to resources, and store all
+   * embedded states.
+   */
+  cacheState(state: State) {
+
+    this.cache.store(state);
+    const resource = this.resources.get(state.uri);
+    if (resource) {
+      // We have a resource for this object, notify it as well.
+      resource.emit('update', state);
+    }
+
+    for(const embeddedState of state.getEmbedded()) {
+      // Recursion. MADNESS
+      this.cacheState(embeddedState);
+    }
+
+  }
+
+  /**
+   * cacheDependencies contains all cache relationships between
+   * resources.
+   *
+   * This lets a user (for example) let a resource automatically
+   * expire, if another one expires.
+   *
+   * A server can populate this list using the `inv-by' link.
+   */
+  public cacheDependencies: Map<string, Set<string>> = new Map();
+
+  /**
+   * Helper function for clearing the cache for a resource.
+   *
+   * This function will also emit the 'stale' event for resources that have
+   * subscribers, and handle any dependent resource caches.
+   *
+   * If any resources are specified in deletedUris, those will not
+   * receive 'stale' events, but 'delete' events instead.
+   */
+  clearResourceCache(staleUris: string[], deletedUris: string[]) {
+
+    let stale = new Set<string>();
+    const deleted = new Set<string>();
+    for(const uri of staleUris) {
+      stale.add(resolve(this.bookmarkUri, uri));
+    }
+    for(const uri of deletedUris) {
+      stale.add(resolve(this.bookmarkUri, uri));
+      deleted.add(resolve(this.bookmarkUri, uri));
+    }
+
+    stale = expandCacheDependencies(
+      new Set([...stale, ...deleted]),
+      this.cacheDependencies
+    );
+
+    for(const uri of stale) {
+      this.cache.delete(uri);
+
+      const resource = this.resources.get(uri);
+      if (resource) {
+        if (deleted.has(uri)) {
+          resource.emit('delete');
+        } else {
+          resource.emit('stale');
+        }
+
+      }
+
+    }
 
   }
 
@@ -151,48 +228,56 @@ export default class Client {
 
     const contentType = parseContentType(response.headers.get('Content-Type')!);
 
-    let state: State;
-
-    if (!contentType) {
+    if (!contentType || response.status === 204) {
       return binaryStateFactory(this, uri, response);
     }
 
     if (contentType in this.contentTypeMap) {
-      state = await this.contentTypeMap[contentType][0](this, uri, response);
+      return this.contentTypeMap[contentType][0](this, uri, response);
     } else if (contentType.startsWith('text/')) {
       // Default to TextState for any format starting with text/
-      state = await textStateFactory(this, uri, response);
+      return textStateFactory(this, uri, response);
     } else if (contentType.match(/^application\/[A-Za-z-.]+\+json/)) {
       // Default to HalState for any format containing a pattern like application/*+json
-      state = await halStateFactory(this, uri, response);
+      return halStateFactory(this, uri, response);
     } else {
-      state = await binaryStateFactory(this, uri, response);
+      return binaryStateFactory(this, uri, response);
     }
 
-    return state;
-
   }
 
-  /**
-   * Caches a State object
-   *
-   * This function will also emit 'update' events to resources, and store all
-   * embedded states.
-   */
-  cacheState(state: State) {
 
-    this.cache.store(state);
-    const resource = this.resources.get(state.uri);
-    if (resource) {
-      // We have a resource for this object, notify it as well.
-      resource.emit('update', state);
-    }
+}
 
-    for(const embeddedState of state.getEmbedded()) {
-      // Recursion. MADNESS
-      this.cacheState(embeddedState);
+
+
+/**
+ * Find all dependencies for a given resource.
+ *
+ * For example, if
+ *   * if resourceA depends on resourceB
+ *   * and resourceB depends on resourceC
+ *
+ * Then if 'resourceC' expires, so should 'resourceA' and 'resourceB'.
+ *
+ * This function helps us find these dependencies recursively and guarding
+ * against recursive loops.
+ */
+function expandCacheDependencies(uris: Set<string>, dependencies: Map<string, Set<string>>, output?: Set<string>): Set<string> {
+
+  if (!output) output = new Set();
+
+  for(const uri of uris) {
+
+    if (!output.has(uri)) {
+      output.add(uri);
+      if (dependencies.has(uri)) {
+        expandCacheDependencies(dependencies.get(uri)!, dependencies, output);
+      }
     }
 
   }
 
+  return output;
+
 }

package/src/field.ts

@@ -30,7 +30,7 @@ interface BaseField<T> {
    *
    * This is similar to the HTML5 "type" attribute on forms.
    */
-  type: string,
+  type: string;
 
   /**
    * The current (pre-filed) value on the form.
@@ -81,15 +81,15 @@ interface BooleanField extends BaseField<boolean> {
  * special features.
  */
 interface BasicStringField extends BaseField<string> {
-  type: 'color' | 'email' | 'password' | 'search' | 'tel' | 'url',
+  type: 'color' | 'email' | 'password' | 'search' | 'tel' | 'url';
 }
 
 interface RangeStringField extends RangeField<string> {
-  type: 'date' | 'month' | 'time' | 'week',
+  type: 'date' | 'month' | 'time' | 'week';
 }
 
 interface DateTimeField extends RangeField<Date> {
-  type: 'datetime' | 'datetime-local',
+  type: 'datetime' | 'datetime-local';
 }
 
 interface HiddenField extends BaseField<string | number | null | boolean> {
@@ -115,7 +115,7 @@ export type OptionsDataSource = {
    *
    * If specified as a plain array, use array values as labels and values.
    */
-  options: Record<string, string> | string[]
+  options: Record<string, string> | string[];
 } | {
   /**
    * If dataSource is specified, we'll grab the list of options from a
@@ -147,7 +147,7 @@ export type OptionsDataSource = {
      * This is ignored if it doesn't apply for the media type.
      */
     valueField?: string;
-  }
+  };
 } | {
   /**
    * If 'linkSource' is specified, we assume that the value will be a URI.
@@ -158,7 +158,7 @@ export type OptionsDataSource = {
   linkSource: {
     href: string;
     rel: string;
-  }
+  };
 }
 
 /**
@@ -181,10 +181,10 @@ type SelectFieldMulti = BaseField<string> & {
 
 
 interface TextField extends BaseField<string> {
-  type: 'text',
+  type: 'text';
   minLength?: number;
   maxLength?: number;
-  pattern?: RegExp,
+  pattern?: RegExp;
 }
 
 interface TextAreaField extends BaseField<string> {

package/src/http/error.ts

@@ -28,12 +28,12 @@ export class HttpError extends Error {
 export class Problem extends HttpError {
 
   body: {
-    type: string
-    title?: string
-    status: number
-    detail?: string
-    instance?: string
-    [x: string]: any
+    type: string;
+    title?: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+    [x: string]: any;
   };
 
   constructor(response: Response, problemBody: Record<string, any>) {
@@ -65,7 +65,7 @@ export class Problem extends HttpError {
 export default async function problemFactory(response: Response): Promise<HttpError | Problem> {
 
   const contentType = response.headers.get('Content-Type');
-  if (contentType && contentType.match(/^application\/problem\+json/i)) {
+  if (contentType?.match(/^application\/problem\+json/i)) {
     const problemBody = await response.json();
     return new Problem(response, problemBody);
   } else {

package/src/http/fetch-polyfill.ts

@@ -6,7 +6,7 @@ import {
 } from 'node-fetch';
 
 // Registering Fetch as a glboal polyfill
-(<any> global).fetch = nodeFetch;
-(<any> global).Request = Request;
-(<any> global).Headers = Headers;
-(<any> global).Response = Response;
+(global as any).fetch = nodeFetch;
+(global as any).Request = Request;
+(global as any).Headers = Headers;
+(global as any).Response = Response;

package/src/http/fetcher.ts

@@ -15,7 +15,7 @@ export class Fetcher {
 
   middlewares: [RegExp, FetchMiddleware][] = [];
 
-  advertiseKetting: boolean = true
+  advertiseKetting: boolean = true;
 
   /**
    * A wrapper for MDN fetch()
@@ -49,10 +49,10 @@ export class Fetcher {
    */
   getMiddlewaresByOrigin(origin: string): FetchMiddleware[] {
 
-    return this.middlewares.filter( ([regex, middleware]) => {
+    return this.middlewares.filter( ([regex]) => {
       return regex.test(origin);
 
-    }).map( ([regex, middleware]) => {
+    }).map( ([, middleware]) => {
       return middleware;
     });
 

package/src/index.ts

@@ -15,11 +15,9 @@ export {
   isState,
 } from './state';
 
-export {
-  ForeverCache,
-  NeverCache,
-  ShortCache,
-} from './cache';
+export { ForeverCache } from './cache/forever';
+export { ShortCache } from './cache/short';
+export { NeverCache } from './cache/never';
 
 export { default as basicAuth } from './http/basic-auth';
 export { default as bearerAuth } from './http/bearer-auth';

package/src/link.ts

@@ -5,7 +5,7 @@ export type Link = {
   /**
    * Target URI
    */
-  href: string,
+  href: string;
 
   /**
    * Context URI.
@@ -17,17 +17,17 @@ export type Link = {
   /**
    * Relation type
    */
-  rel: string,
+  rel: string;
 
   /**
    * Link title
    */
-  title?: string,
+  title?: string;
 
   /**
    * Content type hint of the target resource
    */
-  type?: string,
+  type?: string;
 
   /**
    * Anchor.
@@ -35,22 +35,22 @@ export type Link = {
    * This describes where the link is linked from, from for example
    * a fragment in the current document
    */
-  anchor?: string,
+  anchor?: string;
 
   /**
    * Language of the target resource
    */
-  hreflang?: string,
+  hreflang?: string;
 
   /**
    * HTML5 media attribute
    */
-  media?: string,
+  media?: string;
 
   /**
    * If templated is set to true, the href is a templated URI.
    */
-  templated?: boolean,
+  templated?: boolean;
 
   /**
    * Link hints, as defined in draft-nottingham-link-hint
@@ -67,7 +67,7 @@ type NewLink = Omit<Link, 'context'>;
  */
 export class Links {
 
-  private store: Map<string, Link[]>
+  private store: Map<string, Link[]>;
 
   constructor(public defaultContext: string, links?: Link[] | Links) {
 
@@ -221,5 +221,5 @@ export class LinkNotFound extends Error {}
  * A key->value map of variables to place in a templated link
  */
 export type LinkVariables = {
-  [key: string]: string | number
+  [key: string]: string | number;
 };

package/src/middlewares/accept-header.ts

@@ -13,7 +13,7 @@ export default function(client: Client): FetchMiddleware {
 
     if (!request.headers.has('Accept')) {
       const acceptHeader = Object.entries(client.contentTypeMap).map(
-        ([contentType, [stateFactory, q]]) => contentType + ';q=' + q
+        ([contentType, [, q]]) => contentType + ';q=' + q
       ).join(', ');
       request.headers.set('Accept', acceptHeader);
     }

package/src/middlewares/cache.ts

@@ -29,6 +29,22 @@ export default function(client: Client): FetchMiddleware {
     }
 
     const response = await next(request);
+
+    // If the response had a Link: rel=inv-by header, it means that when the
+    // target uri's cache expires, the uri of this resource should also
+    // expire.
+    if (response.headers.has('Link')) {
+      for (const httpLink of LinkHeader.parse(response.headers.get('Link')!).rel('inv-by')) {
+        const uri = resolve(request.url, httpLink.uri);
+        if (client.cacheDependencies.has(uri)) {
+          client.cacheDependencies.get(uri)!.add(request.url);
+        } else {
+          client.cacheDependencies.set(uri, new Set([request.url]));
+        }
+      }
+    }
+
+
     if (isSafeMethod(request.method)) {
       return response;
     }
@@ -39,10 +55,13 @@ export default function(client: Client): FetchMiddleware {
     }
 
     // We just processed an unsafe method, lets notify all subsystems.
-    const expireUris = [];
-    if (!noStaleEvent && request.method !== 'DELETE') {
-      // Sorry for the double negative
-      expireUris.push(request.url);
+    const stale = [];
+    const deleted = [];
+
+    if (request.method === 'DELETE') {
+      deleted.push(request.url);
+    } else if (!noStaleEvent) {
+      stale.push(request.url);
     }
 
     // If the response had a Link: rel=invalidate header, we want to
@@ -50,17 +69,22 @@ export default function(client: Client): FetchMiddleware {
     if (response.headers.has('Link')) {
       for (const httpLink of LinkHeader.parse(response.headers.get('Link')!).rel('invalidates')) {
         const uri = resolve(request.url, httpLink.uri);
-        expireUris.push(uri);
+        stale.push(uri);
       }
     }
 
     // Location headers should also expire
     if (response.headers.has('Location')) {
-      expireUris.push(
+      stale.push(
         resolve(request.url, response.headers.get('Location')!)
       );
     }
-    // Content-Location headers should also expire
+
+    client.clearResourceCache(stale, deleted);
+
+    // If the response had a 'Content-Location' header, it means that the
+    // response body is the _new_ state for the url in the content-location
+    // header, so we store it!
     if (response.headers.has('Content-Location')) {
       const cl = resolve(request.url, response.headers.get('Content-Location')!);
       const clState = await client.getStateForResponse(
@@ -70,23 +94,6 @@ export default function(client: Client): FetchMiddleware {
       client.cacheState(clState);
     }
 
-    for (const uri of expireUris) {
-      client.cache.delete(request.url);
-
-      const resource = client.resources.get(uri);
-      if (resource) {
-        // We have a resource for this object, notify it as well.
-        resource.emit('stale');
-      }
-    }
-    if (request.method === 'DELETE') {
-      client.cache.delete(request.url);
-      const resource = client.resources.get(request.url);
-      if (resource) {
-        resource.emit('delete');
-      }
-    }
-
     return response;
 
   };

package/src/middlewares/warning.ts

@@ -27,6 +27,7 @@ export default function(): FetchMiddleware {
         }
       }
 
+      /* eslint-disable-next-line no-console */
       console.warn(msg);
 
     }

package/src/resource.ts

@@ -197,7 +197,7 @@ export class Resource<T = any> extends EventEmitter {
     switch (response.status) {
       case 201:
         if (response.headers.has('location')) {
-          return this.go(<string> response.headers.get('location'));
+          return this.go(response.headers.get('location')!);
         }
         throw new Error('Could not follow after a 201 request, because the server did not reply with a Location header. If you sent a Location header, check if your service is returning "Access-Control-Expose-Headers: Location".');
       case 204 :
@@ -216,7 +216,7 @@ export class Resource<T = any> extends EventEmitter {
    *
    * If the server responds with 200 Status code this will return a State object
    */
-  async patch(options: PatchRequestOptions): Promise<void | State<T>> {
+  async patch(options: PatchRequestOptions): Promise<undefined | State<T>> {
 
     const response = await this.fetchOrThrow(
       optionsToRequestInit('PATCH', options)
@@ -307,7 +307,7 @@ export class Resource<T = any> extends EventEmitter {
    */
   clearCache(): void {
 
-    this.client.cache.delete(this.uri);
+    this.client.clearResourceCache([this.uri],[]);
 
   }
 
@@ -385,7 +385,7 @@ export declare interface Resource<T = any> {
    * It will also trigger when calling 'PUT' with a full state object,
    * and when updateCache() was used.
    */
-  on(event: 'update', listener: (state: State) => void) : this
+  on(event: 'update', listener: (state: State) => void) : this;
 
   /**
    * Subscribe to the 'stale' event.
@@ -408,7 +408,7 @@ export declare interface Resource<T = any> {
    * Subscribe to the 'update' event and unsubscribe after it was
    * emitted the first time.
    */
-  once(event: 'update', listener: (state: State) => void) : this
+  once(event: 'update', listener: (state: State) => void) : this;
 
   /**
    * Subscribe to the 'stale' event and unsubscribe after it was
@@ -425,7 +425,7 @@ export declare interface Resource<T = any> {
   /**
    * Unsubscribe from the 'update' event
    */
-  off(event: 'update', listener: (state: State) => void) : this
+  off(event: 'update', listener: (state: State) => void) : this;
 
   /**
    * Unsubscribe from the 'stale' event
@@ -440,7 +440,7 @@ export declare interface Resource<T = any> {
   /**
    * Emit an 'update' event.
    */
-  emit(event: 'update', state: State) : boolean
+  emit(event: 'update', state: State) : boolean;
 
   /**
    * Emit a 'stale' event.
@@ -457,7 +457,7 @@ export declare interface Resource<T = any> {
 export default Resource;
 
 type StrictRequestInit = RequestInit & {
-  headers: Headers,
+  headers: Headers;
 };
 
 /**

package/src/state/base-state.ts

@@ -9,7 +9,7 @@ import { entityHeaderNames } from '../http/util';
 
 type HeadStateInit = {
 
-  client: Client,
+  client: Client;
   uri: string;
   links: Links;
 
@@ -20,7 +20,7 @@ type HeadStateInit = {
 }
 
 type StateInit<T> = {
-  client: Client,
+  client: Client;
   uri: string;
   data: T;
   headers: Headers;
@@ -84,6 +84,7 @@ export class BaseHeadState implements HeadState {
       href = resolve(link);
     }
     if (link.hints?.status === 'deprecated') {
+      /* eslint-disable-next-line no-console */
       console.warn(`[ketting] The ${link.rel} link on ${this.uri} is marked deprecated.`, link);
     }
 
@@ -102,6 +103,7 @@ export class BaseHeadState implements HeadState {
     return this.links.getMany(rel).map( link => {
 
       if (link.hints?.status === 'deprecated') {
+        /* eslint-disable-next-line no-console */
         console.warn(`[ketting] The ${link.rel} link on ${this.uri} is marked deprecated.`, link);
       }
       const href = resolve(link);
@@ -171,7 +173,7 @@ export class BaseState<T> extends BaseHeadState implements State<T> {
     }
     for(const action of this.actionInfo) {
       if (action.name === name) {
-        return new SimpleAction(this.client, this.actionInfo[0]);
+        return new SimpleAction(this.client, action);
       }
     }
     throw new ActionNotFound('This State defines no action');