IBM / ibm-cos-sdk-js

ibm-cos-sdk-js
Apache License 2.0
38 stars 19 forks source link

missing type definitions for ibm specific fields #34

Closed hiro5id closed 5 years ago

hiro5id commented 5 years ago

When I import this package using import AWS = require('ibm-cos-sdk'); then typescript complains about some of the extra IBM specific parameters I have to pass it. For example:

In:

new AWS.S3({
      endpoint: '<endpoint>',
      apiKeyId: '<key>',
      ibmAuthEndpoint: '<auth>',
      serviceInstanceId: '<service-instance>',
    }

The fields apiKeyId, ibmAuthEndpoint and serviceInstanceId do not exist in type 'ClientConfiguration'.

So I have to import it like this for it to work : const AWS = require('ibm-cos-sdk'); but then I lose types.

Perhaps the ServiceConfigurationOptions interface needs to be updated to include these new fields.

runnerpaul commented 5 years ago

@hiro5id I'll look into this.

Are you using release 1.3.2?

hiro5id commented 5 years ago

Yes, 1.3.2

hiro5id commented 5 years ago

I have created a pull request : https://github.com/IBM/ibm-cos-sdk-js/pull/35

stephenskinner commented 5 years ago

Hi @hiro5id , I've created an internal issue and will get this fixed in the next release. Thanks for the PR.

virkt25 commented 5 years ago

@stephenskinner Can we get this PR merged? Would resolve some issues for me as well. Thanks :)

stephenskinner commented 5 years ago

Hi @hiro5id, @virkt25, This is fixed in our upcoming 1.4.1 node sdk release. Thanks for the PR, unfortunately we can't merge the PR due to the build release process in place.