@devrev/typescript-sdk 1.0.2

package/.eslintignore

@@ -0,0 +1,2 @@
+./src/auto-generated/**/*
+node_modules/**/*

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,27 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  push:
+    branches:
+      - main
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    if: contains(github.event.head_commit.message, 'publish sdk')
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+          scope: '@devrev'
+      - run: npm install
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/.prettierignore

@@ -0,0 +1,4 @@
+# Add files here to ignore them from prettier formatting
+
+/dist
+

package/.prettierrc

@@ -0,0 +1,15 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "jsxSingleQuote": false,
+  "arrowParens": "always",
+  "proseWrap": "never",
+  "htmlWhitespaceSensitivity": "strict",
+  "endOfLine": "lf",
+  "organizeImportsSkipDestructiveCodeActions": true
+}

package/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "firsttris.vscode-jest-runner",
+    "pmneo.tsimporter"
+  ]
+}

package/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug TypeScript in Node.js",
+      "preLaunchTask": "npm: start",
+      "program": "${workspaceFolder}/src/main.ts",
+      "protocol": "inspector",
+      "outFiles": ["${workspaceFolder}/dist/**/*.js"],
+      "sourceMaps": true,
+      "smartStep": true,
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,31 @@
+{
+  "[javascript]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[javascriptreact]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "vscode.typescript-language-features"
+  },
+  "[typescriptreact]": {
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true,
+    "source.fixAll": true,
+    "source.organizeImports": true,
+    "source.sortMembers": true
+  }
+}

package/README.md

@@ -0,0 +1,69 @@
+### 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
+```
+
+Example Usage of the Public SDK
+
+```
+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);
+})();
+```
+
+# Run tests:
+
+```
+npm test
+```
+
+Check package.json for more options
+
+#To setup the client:
+
+```
+import * as sdk from '../auto-generated/public-devrev-sdk';
+import * as client from "../client_setup";
+
+const devrevSDK = client.setup()
+const betaSDK = client.setupBeta()
+```
+
+Examples how to create a work item can be found in tests/works.ts
+
+# Create a new test:
+
+[Jest Documentation](https://jestjs.io/docs/expect)
+
+- 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
+
+**Example test pipeline for works.ts:**
+
+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)
+
+-- test readme change

package/USER_README.md

@@ -0,0 +1,16 @@
+# Authorization
+
+Setup an env variable "SDK_TOKEN" It will be used as an auth token by default, You can also pass in the url and token in client.setup()
+
+# Example Usage of the Public SDK
+
+```
+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);
+})();
+```

package/nodemon.json

@@ -0,0 +1,5 @@
+{
+  "execMap": {
+    "ts": "ts-node"
+  }
+}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@devrev/typescript-sdk",
+  "version": "1.0.2",
+  "description": "## SDK Generation",
+  "main": "./dist/index.js",
+  "scripts": {
+    "lint": "eslint --ignore-path .gitignore .",
+    "lint:fix": "eslint --fix --ignore-path .gitignore .",
+    "build": "rimraf ./dist && tsc",
+    "build:watch": "tsc --watch",
+    "start": "ts-node ./src/main.ts",
+    "start:watch": "nodemon ./src/main.ts",
+    "start:production": "node dist/main.js",
+    "start:works": "nodemon ./src/works.ts",
+    "start:parts": "nodemon ./src/parts.ts",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "keywords": [],
+  "author": "devrev",
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/core": "^7.20.12",
+    "@babel/preset-env": "^7.21.4",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.13.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "babel-jest": "^29.4.2",
+    "eslint": "^8.33.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "nodemon": "^2.0.20",
+    "prettier": "^2.8.3",
+    "prettier-plugin-organize-imports": "^3.2.2",
+    "rimraf": "^4.1.2",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@types/yargs": "^17.0.22",
+    "axios": "^1.3.6",
+    "dotenv": "^16.0.3",
+    "yargs": "^17.6.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/devrev/devrev-sdk-typescript.git"
+  },
+  "bugs": {
+    "url": "https://github.com/devrev/devrev-sdk-typescript/issues"
+  },
+  "homepage": "https://github.com/devrev/devrev-sdk-typescript#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  }
+}