launchdarkly / api-client-typescript Goto Github PK

The version of axios in use (0.26.1) has a moderate-severity vulnerability CVE-2023-45857
.

This is fixed in version 1.6.0 and above.

Hey, thanks for publishing this client. But how is it meant to be consumed? The repo doesn't have a package.json file, which prevents it from being installed as a git dependency and I also couldn't find it on npm.

I thought maybe you intend users to vendor the api.ts file, but then I realized that it actually has some dependencies. Installing those and crossing fingers that they line up sounds very brittle.

Using the REST api over HTTPs, you can make the following request:

 const requestInfo = {
      hostname: `app.launchdarkly.com`,
      path: `/api/v2/flags/${projectKey}/${flagKey}`,
      method: 'PATCH',
      headers: {
        Authorization: LAUNCHDARKLY_ACCESS_TOKEN,
        'Content-Type': 'application/json; domain-model=launchdarkly.semanticpatch',
      },
    };
 const requestBody = {
      environmentKey,
      instructions: [{ kind: 'turnFlagOn' }],
    };
do_request(requestInfo, requestBody);

See the patchFeatureFlag REST API docs

I couldn't find this functionality exposed on the FeatureFlagsApi object in this API. Is that an accidental omission? Or did I miss it somewhere?

Hey,

I know this is auto generated client, but hopefully you would have a solution.

When i use the api-client-typescript package, and try to send a .patchFeatureFlag() with a payload example:

    "environmentKey": "environment-key-123abc",
    "instructions": [{
        "kind": "addValuesToClause",
        "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29",
        "clauseId": "10a58772-3121-400f-846b-b8a04e8944ed",
        "values": ["beta_testers"]
    }]
}

There are 2 problems:

1. type PatchOperation only supports properties: op, path and value, so there is a TS compile error.
2. Even after getting over the compile error, i've debugged and noticed that the request being sent with the following payload:

    "patch": [
        {
            "environmentKey": "environment-key-123abc",
            "instructions": [
                {
                    "kind": "addValuesToClause",
                    "ruleId": "a902ef4a-2faf-4eaf-88e1-ecc356708a29,
                    "clauseId": "10a58772-3121-400f-846b-b8a04e8944ed",
                    "values": [
                        "please-work"
                    ]
                }
            ]
        }
    ]
}

And the response from the REST API is 400 Error

    "code": "invalid_patch",
    "message": "must have at least one instruction"
}

Please advise, is there a way to use all the different patch operations via the client?

I'm using this library in a Node project but at the time of building it in my server it fails with a Javascript out of memory message.

It seems to happen as soon as I create an apiInstance

const apiInstance = new FeatureFlagsApi(config);

For now I will have to refactor and deploy code using the fetch api to interact with the LaunchDarkly API directly.

The Getting Started link in the README points to a bookmark that doesn't exist. I tried looking but couldn't find an example that this could/should point to instead, so I cannot make a PR.