adobe / aemcs-api-client-lib

Apache License 2.0
1 stars 11 forks source link

NPM package is not published #1

Open easingthemes opened 3 years ago

easingthemes commented 3 years ago

Expected Behaviour

NPM package is published

Actual Behaviour

NPM package is not published

According to https://experienceleague.adobe.com/docs/experience-manager-cloud-service/implementing/developing/generating-access-tokens-for-server-side-apis.html?lang=en#developer-flow

We can install this package from npm:

const exchange = require("@adobe/aemcs-api-client-lib");

What are the plans for publishing this as an npm package?

ieb commented 3 years ago

We restructured the repo after d8178a0182b257809d7a9685eba858e03b9c6b0e so that its now possible to reference the library in package.json using the github url, see https://docs.npmjs.com/cli/v6/configuring-npm/package-json#git-urls-as-dependencies for documentation.

For this repo it would be something like...

{
  "name": "foo",
  "version": "0.0.0",
  "dependencies": {
    "@adobe/aemcs-api-client-lib": "git+https://github.com/adobe/aemcs-api-client-lib.git#main",
...
...
  }
}

We will look into publishing as soon as possible.

Does this work for you while we do ?

easingthemes commented 3 years ago

Thanks, this helps for now.

codepoetIn commented 1 year ago

I would like to integrate this library into our Angular application to enable communication with AEM. As a prerequisite, I need to generate an access token using this library. Do you have any suggestions?

MrDesjardins commented 9 months ago

We restructured the repo after d8178a0 so that its now possible to reference the library in package.json using the github url, see https://docs.npmjs.com/cli/v6/configuring-npm/package-json#git-urls-as-dependencies for documentation.

For this repo it would be something like...

{
  "name": "foo",
  "version": "0.0.0",
  "dependencies": {
    "@adobe/aemcs-api-client-lib": "git+https://github.com/adobe/aemcs-api-client-lib.git#main",
...
...
  }
}

We will look into publishing as soon as possible.

Does this work for you while we do ?

I recommend adding the instruction into the readme.md file.

It is a normal question that people who must use AEM API will come up. Installing a NPM from a Git url is not as intuitive than a more conventional NPM package. Adding the information into the readme.me will avoid people to be confuse and on your side diminish support, like having to answer this post.

loliver commented 3 months ago

Bumping this, our GHA runners don't have access to GitHub via npm so the workaround won't work for my use case. I've forked and published to our internal Artifactory in the meantime, but do not consider that a long term solution.