nodejs / webcrypto

This repository has been archived. The WebCrypto API has been implemented in recent versions of Node.js and does not require additional packages.
69 stars 20 forks source link

How to install this package? #47

Open Jack-Works opened 4 years ago

Jack-Works commented 4 years ago

It seems like this package doesn't publish on the npm. When I try to install via git, yarn add git://github.com/nodejs/webcrypto --ignore-scripts -D, it reports error Can't add undefined: invalid package version undefined.

ljharb commented 4 years ago

It’s set to private true and lacks a version; i don’t think the prototype is meant to be consumed.

Jack-Works commented 4 years ago

Oh I use it to replace @trust/webcrypto(stop maintenance) in our test environment

panva commented 4 years ago

This is still just a PoC in progress.

SmartLayer commented 4 years ago

Oh I use it to replace @trust/webcrypto(stop maintenance) in our test environment

As I filed issue #49 this wouldn't work as a drop-in replacement unless you change the code that uses the library as well, since @trust/webcrypto exposes crypto object directly and yours through .crypto, right?

tniessen commented 4 years ago

Sorry, I wasn't particularly active on GitHub recently. This project is a protoype and so far, I have been the only person working on it. Less recently, due to a perceived lack of interest, and the realization that this likely never be a competitive implementation. Oh, and also because some things are really difficult to implement. WebCrypto doesn't do things the Node.js way, and Node.js doesn't do things the WebCrypto way.

Jack-Works commented 4 years ago

WebCrypto doesn't do things the Node.js way, and Node.js doesn't do things the WebCrypto way.

This is like the jsdom library. It's useful for testing. ✨ (I use it to test web app)

SmartLayer commented 4 years ago

Sorry, I wasn't particularly active on GitHub recently. This project is a protoype and so far, I have been the only person working on it. Less recently, due to a perceived lack of interest, and the realization that this likely never be a competitive implementation. Oh, and also because some things are really difficult to implement. WebCrypto doesn't do things the Node.js way, and Node.js doesn't do things the WebCrypto way.

Would you be so kind to rename the repository? The reason is that I came here first because I thought this is the repo of the code that gets installed through 'npm install webcrypto'.

Something like tniessen-WebCrypto would be a good name (or move it away from github.com/nodejs and into a more personal namespace like github.com/tniessen - if that exists). Really appreciated!

tniessen commented 4 years ago

Would you be so kind to rename the repository?

If we were to publish this, it would likely be under the name @nodejs/webcrypto, so I think the repository name is perfectly reasonable.

panva commented 4 years ago
npm docs webcrypto

this lands you on https://github.com/daviddias/webcrypto#readme, not here. The npm website also has those links displayed.

I agree with @tniessen the repo name is fine.

ryzokuken commented 4 years ago

Would you be so kind to rename the repository? The reason is that I came here first because I thought this is the repo of the code that gets installed through 'npm install webcrypto'.

For that, you need to check npm, not GitHub.

SmartLayer commented 4 years ago

If we were to publish this, it would likely be under the name @nodejs/webcrypto, so I think the repository name is perfectly reasonable.

Without going against your decision (it's yours) I am just curious whether or not github.com/nodejs has anything to do with nodejs.org, and if they belong to the same entity, why the future name of this package is not just 'webcrypto' like most other packages using nodejs?

On pavn's note, yes I learned the hard way that one should look at npm website to find the github repo of a npm package. I have been using google for this purpose a few years without realising I was doing it wrong!

tniessen commented 4 years ago

I am just curious whether or not github.com/nodejs has anything to do with nodejs.org, and if they belong to the same entity

https://github.com/nodejs is the GitHub organization of the Node.js project. The official website of the Node.js project is https://nodejs.org (the code behind the website is in https://github.com/nodejs/nodejs.org). So yes, both the GitHub organization "nodejs" and the domain "nodejs.org" belong to the Node.js project, which is now part of the OpenJS Foundation (formerly Node.js Foundation).

and if they belong to the same entity, why the future name of this package is not just 'webcrypto' like most other packages using nodejs?

For two reasons: First, the name "webcrypto" is already taken, the package already exists. We cannot simply remove a third-party package from npm. Second, unlike modules such as "fs" and "crypto", this is not a part of Node.js core, it is not a built-in module. Instead, it needs to be installed via npm, and we are leaning towards adding the namespace @nodejs to npm packages.

geeeger commented 4 years ago

Oh I use it to replace @trust/webcrypto(stop maintenance) in our test environment

try @peculiar/webcrypto ? it might be help