traverson / halfred Goto Github PK

I'd really love to be able to extend Resource by adding my own methods to the prototype.

(Related request, though not one I need: Might be nice to be able to provide your own Resource class to the parser.)

Describe the bug
When trying to parse a Resource returned from a remote API with null embedded resources, halfred reports an error: TypeError: "embeddedElement is null"

It looks like the problem could be solved by adding an if statement in line 73 of parser.js. I can send the PR if needed.

I understand that having a null value for an embedded resource could not be the best option for a HAL API, but I couldn't find any good argument against having null values. (for example, some uninitialized embed that will be populated later).

To Reproduce
Just parsing a Resource with null values will raise the Error:

{
    "_embedded": {
        "embed": null
    }
}

Expected behavior
The parsing process should accomplish without errors.
When querying for the value of "embed", it should return null.

Node.js (please complete the following information):

• OS: Ubuntu 18
• Node.js version: 10.14.1
• Halfred Version: 1.1.0

Hi,

I'm using traverson with traverson-hal which uses halfred under the hood. My problem is that halfred sends a lot of debugging log the console and there is no way to turn it off. I created an issue for this request in the traverson-hal repo as well: (traverson/traverson-hal#30).

Cheers,

LEo

I am wondering if Resource should be used on top of traverson responses.
Let's say root URL returns something like this:

{
    myItems: {
        href: "http://localhost:8080/api/data/myItems"
    },
}

We want to display myItems (which is an array of object) on front-end.
So we could write a helper method which would:

1. fetch "root" API object
2. look for requested resource ("myItems")
3. return array of objects under that resource

Example implementation:

export const api = traverson
  .from('http://localhost:8080/api/data') // root URL
  .jsonHal();

export function fetchRelation(...args) {
  return api.newRequest()
    .follow(args)
    .getResource().result;
}

export function fetchRelationWithEmbeddedResources(...args) {
  return fetchRelation(...args)
    .then(halfred.parse)
    .then(x => x.allEmbeddedResources());
}

Example usage:
fetchRelationWithEmbeddedResources('myItems')

(notice I am using traverson-promise plugin)

Am I missing something here?

The devDependency grunt-cli was updated from 1.3.1 to 1.3.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

grunt-cli is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

The devDependency husky was updated from 1.2.0 to 1.2.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

husky is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

May I ask question in Github issues? Because I find the tag traverson doesn't exist in stackoverflow. And no much resource can be googled with keyword "traverson hal typescript".

This is the response body in hal json returned from Spring Data REST backend. There is a root level property page besides _embedded and _links.

{
  "_embedded" : {
    "users" : [ {
      "username" : "apple",
      "lastLoginTime" : "2021-09-22T13:32:55.76",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/users/60857057c116924b2a7affc8"
        },
        "user" : {
          "href" : "http://localhost:8080/users/60857057c116924b2a7affc8"
        }
      }
    }, {
      "username" : "banana",
      "lastLoginTime" : "2021-09-22T13:43:51.145",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/users/6085726fc116924b2a7affc9"
        },
        "user" : {
          "href" : "http://localhost:8080/users/6085726fc116924b2a7affc9"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "http://localhost:8080/users?page=0&size=2"
    },
    "self" : {
      "href" : "http://localhost:8080/users?page=0&size=2"
    },
    "next" : {
      "href" : "http://localhost:8080/users?page=1&size=2"
    },
    "last" : {
      "href" : "http://localhost:8080/users?page=86&size=2"
    },
    "profile" : {
      "href" : "http://localhost:8080/profile/users"
    },
    "search" : {
      "href" : "http://localhost:8080/users/search"
    }
  },
  "page" : {
    "size" : 2,
    "totalElements" : 173,
    "totalPages" : 87,
    "number" : 0
  }
}

Traverson code.

traverson
  .from('http://localhost:8080/users')
  .jsonHal()
  .getResource((error, doc) => {
    if (error) {
      console.error(error);
    } else {
      let resource = halfred.parse(doc);  // type of halfred.Resource
      console.info('resource=', resource);
      console.info('page=', resource.page);  // error Property 'page' does not exist on type 'Resource'
      let users = resource.embeddedArray('users');  // type of Resource[]
      let user0 = users[0];  // type of halfred.Resource
      console.info('user0.username=', user0.username);  // error Property 'username' does not exist on type 'Resource'
    }
  });

data class

// User.ts
export default class User {
  constructor(readonly username: string, readonly lastLoginTime: date);
}

Question 1
resource.embeddedArray('users') returns an array of Resource. Should I convert to a data class User or keep using the type Resource? How to convert Resource to class User in Typescript?

Question 2
If I keep using the type Resource and access some data such as username, even though the username value is logged to console, I get IDE error "Property 'username' does not exist on type 'Resource'". Can anyone give me some advice?

It would be great if some traverson hal typescript example can be provided.

☝️ Important announcement: Greenkeeper will be saying goodbye 👋 and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io

The devDependency grunt was updated from 1.0.4 to 1.1.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

grunt is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

once we iron out any remaining kinks in the release process, we should release a major version that officially drops support for bower and any versions of node that are no longer officially supported. is there anything else that we think is worth dropping/changing at the same time?