@devrev/typescript-sdk 1.0.3 → 1.1.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 DevRev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,69 +1,52 @@
-### devrev-sdk-typescript
-
-## SDK Generation
-
-`sync_api_contract.sh` is the script which fetches the latest OpenAPI specs from the gateway repo, and generates the i) Public SDK for Public APIs 2) Beta SDK for Beta APIs 3) Internal SDK for internal APIs.
-
-Code in this repo [specially those exposed via the SDK] must comply with the style guideline below: https://google.github.io/styleguide/tsguide.html
-
 # Authorization
 
-Setup an env variable "DEVREV_SDK_TOKEN" It will be used as an auth token by default, You can also pass in the url and token in client.setup()
-
-To run main.ts, do:
-
-```
-npm run start:watch
-```
+Setup an env variable `DEVREV_TOKEN` It will be used as an auth token by default, You can also pass in the url and token in `client.setup()` as a param (see below). It is also required to run tests.
 
-Example Usage of the Public SDK
+# Installation
 
 ```
-const devrevSDK = client.setup();
-(async () => {
-    const response = await devrevSDK.worksGet({
-        id: 'don:core:dvrv-us-1:devo/1DYPnPy0f:issue/8',
-    });
-
-    console.info(response.data.work.title);
-})();
+npm install @devrev/typescript-sdk
 ```
+The version can be found in package.json. The SDK is currently beta.
+Make sure that your project's **package.json** contains `"type":"module"` setting.
 
-# Run tests:
+# Example Usage of the Beta SDK
 
 ```
-npm test
-```
+import {client, betaSDK} from "@devrev/typescript-sdk";
 
-Check package.json for more options
+const devrevInternalSDK = client.setupBeta({ endpoint: "https://api.devrev.ai",
+token: process.env.DEVREV_TOKEN });
 
-#To setup the client:
+async function test(){
+    const response = await devrevBetaSDK.worksCreate({title:"New work item!",
+    applies_to_part: "PROD-1",
+    owned_by:["DEVU-1"],
+    type: betaSDK.WorkType.Issue})
+    console.log(response)
+}
 
-```
-import * as sdk from '../auto-generated/public-devrev-sdk';
-import * as client from "../client_setup";
+test()
 
-const devrevSDK = client.setup()
-const betaSDK = client.setupBeta()
 ```
 
-Examples how to create a work item can be found in tests/works.ts
+# Example Usage of the Public SDK
 
-# Create a new test:
+```
+import {client, publicSDK} from "@devrev/typescript-sdk";
 
-[Jest Documentation](https://jestjs.io/docs/expect)
+const devrevSDK = client.setup({ endpoint: "https://api.devrev.ai", token: process.env.DEVREV_TOKEN });
 
-- Add a new test file in src/tests/ directory that contains the necessary functions for your tests.
-- To the file src/tests/test.ts add the test itself
+async function test(){
+    const response = await devrevSDK.worksCreate({title:"New work item!", applies_to_part: "PROD-1", owned_by:["DEVU-16"], type: publicSDK.WorkType.Issue})
+    console.log(response.status)
+}
 
-**Example test pipeline for works.ts:**
+test()
+```
 
-1. Prepare the environment (get the user, create a part and a tag) in init()
-2. For /works.create endpoint in worksCreateGet create a work item, try getting it.
-   - Assert the correctness of both calls by expect():
-     - We check that responses have status 200 or 201, and that the data persists if compared to hard-coded and getResponse.
-3. Repeat for other API endpoints
-4. To check the correctness of /works.delete try deleting a work item twice and expect an error (await expect(works.works_delete_get(id)).rejects.toThrow())
-5. Cleanup the environment (delete the created part and tag)
+# Execute tests in the repo
+```
+npm test
+```
 
--- test readme change