Merge pull request #109 from badgateway/update-link-hints

Update link-hints to latest draft

Author: evert

README.md

@@ -9,13 +9,13 @@ It exports the following interfaces:
 1. `HalLink`, representing an individual [HAL Link][1]
 2. `HalResource`, representing a single [HAL document][2], with at least a
    `_links` property and optionally `_embedded` property and `_templates` properties.
-3. `LinkHints`, an extension to links, as defined in [draft-nottingham-link-hint][3].
+3. `LinkHints`, an extension to links, as defined in [draft-ietf-httpapi-link-hint][3].
 4. `HalFormsTemplate`, A [HAL Forms][4] template object.
 5. `HalFormsProperty` A single property from a HAL Form.
 
 [1]: https://tools.ietf.org/html/draft-kelly-json-hal-00#section-5
 [2]: https://tools.ietf.org/html/draft-kelly-json-hal-00#section-4
-[3]: https://tools.ietf.org/html/draft-nottingham-link-hint
+[3]: https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-link-hint
 [4]: http://rwcbook.github.io/hal-forms/
 
 # Usage

changelog.md

@@ -1,18 +1,25 @@
 ChangeLog
 =========
 
+2.0.0 (????-??-??)
+------------------
+
+* Update link-hint to latest draft. The types changed in a few different
+  places, so if you used link-hints, this is likely a BC break for you.
+
+
 1.9.0 (2023-01-08)
 ------------------
 
-* `placeholder` from HAL Forms was incorrectly cased as `placeHolder`.
-  This is fixed but could be a BC break. (@dayre)
+* `placeholder` from HAL Forms was incorrectly cased as `placeHolder`. This is
+  fixed but could be a BC break. (@dayre)
 
 
 1.8.0 (2022-06-26)
 ------------------
 
-* Add `name`, `deprecation` and `profile` properties to HAL Links. These
-  were part of the base spec and should always have been there.
+* Add `name`, `deprecation` and `profile` properties to HAL Links. These were
+  part of the base spec and should always have been there.
 
 
 1.7.7 (2022-05-04)
@@ -21,6 +28,7 @@ ChangeLog
 * Fix a second BC breaking change. `_links` should not be omitted. If `_links`
   may be omitted this change might be re-introduce in a major version.
 
+
 1.7.6 (2022-05-04)
 ------------------
 
@@ -56,19 +64,16 @@ ChangeLog
 ------------------
 
 * Added type: range
-* Now exporting:
-  * `HalFormsSimpleProperty`
-  * `HalFormsRangeProperty`
-  * `HalFormsOptionsInline`
-  * `HalFormsOptionsLink`
+* Now exporting: * `HalFormsSimpleProperty` * `HalFormsRangeProperty` *
+  `HalFormsOptionsInline` * `HalFormsOptionsLink`
 
 
 1.7.0 (2021-02-20)
 ------------------
 
 * Updated to HAL Forms 2021-02-20, which adds support for the 'options'
-  property. This property can be used to generate lists of possible values
-  in form fields, including values from external HTTP sources.
+  property. This property can be used to generate lists of possible values in
+  form fields, including values from external HTTP sources.
 
 
 1.6.1 (2021-01-03)
@@ -89,7 +94,7 @@ ChangeLog
 
 
 1.5.0 (2020-12-30)
------------------
+------------------
 
 * Update to HAL-Forms 2020-12-29, which adds support for a `textarea` type, and
   `cols` and `rows` fields on form fields.
@@ -141,6 +146,7 @@ ChangeLog
 
 * Forgot to build files before publishing.
 
+
 0.1.1 (2019-09-30)
 ------------------
 

src/link-hints.ts

@@ -1,5 +1,3 @@
-import { HalLink } from './hal';
-
 /**
  * Link hints.
  *
@@ -17,25 +15,13 @@ export interface LinkHints {
    * List of supported formats (used in for example GET responses
    * or PUT requests
    */
-  formats?: LinkHintFormats;
-
-  /**
-   * List of links that exists at the context of the hint.
-   *
-   * This allows to specify links that exists at the target
-   * resource. For example, you might add an 'edit-form' link
-   * on a link, allowing clients to render an edit button
-   * for a target.
-   */
-  links?: {
-    [rel: string]: HalLink;
-  };
+  formats?: string[];
 
   /**
    * A list of media-types the target resource supports for
    * POST request bodies
    */
-  'accept-post'?: LinkHintFormats;
+  'accept-post'?: string[];
 
   /**
    * Array of media-types that the target resource supports for
@@ -69,9 +55,14 @@ export interface LinkHints {
 
   /**
    * A list of authentication schemes that are required at the target
-   * resource
+   * resource, for example 'Basic', 'Digest', 'Bearer'.
    */
-  'auth-schemes'?: LinkHintAuthScheme[];
+  'auth-schemes'?: string[];
+
+  /**
+   * A list of authentication realms available at the target
+   */
+  'auth-realms'?: string[];
 
   /**
    * A status for the resource.
@@ -82,41 +73,3 @@ export interface LinkHints {
   status?: 'deprecated' | 'gone';
 
 }
-
-/**
- * A supported format, indexed by media type
- */
-interface LinkHintFormats {
-
-  [mediaType: string]: {
-    /**
-     * Relevant links to the format.
-     *
-     * Mainly this could contain a 'profile' or 'describedby'
-     * link. These both describe a schema for the format
-     */
-    links?: {
-      [rel: string]: HalLink;
-    };
-
-    /**
-     * If set to true, it indicates that this format is
-     * deprecated
-     */
-    deprecated?: boolean;
-  };
-}
-
-interface LinkHintAuthScheme {
-  /**
-   * A registered authenticaiton scheme such as 'Basic', 'Digest' or 'Bearer'.
-   */
-  scheme: string;
-
-  /**
-   * Realm information from the authentation scheme, similar to the "realm"
-   * attribute on the WWW-Authentication header.
-   */
-  realm?: string;
-
-}