Merge pull request #204 from yandex-cloud/alpha

Beta 3.0

Author: DavyJohnes

.commitlintrc.json

@@ -1,5 +1,3 @@
 {
-  "extends": [
-    "@commitlint/config-conventional"
-  ]
+  "extends": ["@commitlint/config-conventional"]
 }

.eslintignore

@@ -11,12 +11,7 @@
     "plugin:@typescript-eslint/recommended"
   ],
   "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "@typescript-eslint",
-    "unicorn",
-    "import",
-    "prefer-arrow-functions"
-  ],
+  "plugins": ["@typescript-eslint", "unicorn", "import", "prefer-arrow-functions"],
   "parserOptions": {
     "project": "tsconfig.eslint.json"
   },
@@ -31,8 +26,8 @@
     "import/prefer-default-export": "off",
     "comma-dangle": ["error", "always-multiline"],
     "indent": "off",
-    "@typescript-eslint/indent": ["error", 4],
     "max-len": ["error", 140],
+    "@typescript-eslint/indent": ["error", 4],
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/prefer-optional-chain": "error",
     "prefer-arrow-functions/prefer-arrow-functions": ["error"],
@@ -42,14 +37,21 @@
     "no-plusplus": "off",
     "unicorn/import-style": "off",
     "@typescript-eslint/no-var-requires": "off",
-    "no-underscore-dangle": ["error", {
-      "allowAfterThis": true,
-      "allowAfterSuper": false
-    }],
+    "no-underscore-dangle": [
+      "error",
+      {
+        "allowAfterThis": true,
+        "allowAfterSuper": false
+      }
+    ],
     "unicorn/no-null": "off",
-    "import/no-extraneous-dependencies": ["error", {
-      "devDependencies": true
-    }],
-    "import/no-cycle": "off"
+    "import/no-extraneous-dependencies": [
+      "error",
+      {
+        "devDependencies": true
+      }
+    ],
+    "import/no-cycle": "off",
+    "@typescript-eslint/no-explicit-any": 1
   }
 }

.eslintrc.json

@@ -5,6 +5,10 @@ inputs:
     description: 'Whether to configure the token or SSH key with the local git config'
     required: false
     default: 'true'
+  submodules:
+    description: 'Whether to checkout submodules along with specified repo'
+    required: false
+    default: 'false'
 runs:
   using: 'composite'
   steps:

.github/actions/checkout-and-install-node/action.yml

@@ -9,25 +9,27 @@ jobs:
   tests:
     runs-on: ubuntu-24.04
     steps:
-      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@d6b5322d8dbc130126ec1fa00bc0f2d6cc2f53db
+      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@7992e39cce119c931dab92f6879013efff123009
+        with:
+          submodules: recursive
       - run: npm run test
   check-endpoints:
     runs-on: ubuntu-24.04
     # Currently, the check-endpoints script fails on the master branch.
     # So we need to continue on error.
     continue-on-error: true
     steps:
-      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@d6b5322d8dbc130126ec1fa00bc0f2d6cc2f53db
+      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@7992e39cce119c931dab92f6879013efff123009
         with:
           submodules: recursive
       - run: npm run check-endpoints
   lint:
     runs-on: ubuntu-24.04
     steps:
-      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@d6b5322d8dbc130126ec1fa00bc0f2d6cc2f53db
+      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@7992e39cce119c931dab92f6879013efff123009
       - run: npm run lint
   build:
     runs-on: ubuntu-24.04
     steps:
-      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@d6b5322d8dbc130126ec1fa00bc0f2d6cc2f53db
+      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@7992e39cce119c931dab92f6879013efff123009
       - run: npm run build

.github/workflows/pr-checks.yml

@@ -11,7 +11,7 @@ jobs:
     name: Release
     runs-on: ubuntu-24.04
     steps:
-      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@d6b5322d8dbc130126ec1fa00bc0f2d6cc2f53db
+      - uses: yandex-cloud/nodejs-sdk/.github/actions/checkout-and-install-node@7992e39cce119c931dab92f6879013efff123009
         with:
           persist-credentials: false
       - env:

.github/workflows/release.yml

@@ -1,3 +1,5 @@
 .idea
 node_modules
 dist
+.env
+.vscode

.gitignore

@@ -0,0 +1 @@
+**/generated/**

.prettierignore

@@ -0,0 +1,21 @@
+module.exports = {
+    tabWidth: 4,
+    printWidth: 100,
+    singleQuote: true,
+    trailingComma: 'all',
+    bracketSpacing: true,
+    overrides: [
+        {
+            files: ['*.js', '*.jsx', '*.ts', '*.tsx'],
+            options: {
+                parser: 'typescript',
+            },
+        },
+        {
+            files: ['*.md', '*.json', '*.yaml', '*.yml'],
+            options: {
+                tabWidth: 2,
+            },
+        },
+    ],
+};

.prettierrc.js

@@ -6,7 +6,7 @@
 Need to automate your infrastructure or use services provided by Yandex.Cloud? We've got you covered.
 
 ## Requirements
-- nodejs >= 12
+- nodejs >= 22.15
 
 ## Installation
 `npm install @yandex-cloud/nodejs-sdk`
@@ -22,18 +22,17 @@ running in Yandex.Cloud)
 ### OAuth Token
 
 ```typescript
-import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';
-
-const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;
+import { Session } from '@yandex-cloud/nodejs-sdk';
+import { cloudService } from '@yandex-cloud/nodejs-sdk/resourcemanager-v1';
 
 // Initialize SDK with your token
 const session = new Session({ oauthToken: 'YOUR_TOKEN' });
 
 // Create service client
-const cloudService = session.client(serviceClients.CloudServiceClient);
+const cloudServiceClient = session.client(cloudService.CloudServiceClient);
 
 // Issue request (returns Promise)
-const response = await cloudService.list(ListCloudsRequest.fromPartial({
+const response = await cloudServiceClient.list(cloudService.ListCloudsRequest.fromPartial({
     pageSize: 100,
 }));
 ```
@@ -43,37 +42,35 @@ const response = await cloudService.list(ListCloudsRequest.fromPartial({
 Don't forget to assign Service Account for your Instance or Function.
 
 ```typescript
-import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';
-
-const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;
+import { Session} from '@yandex-cloud/nodejs-sdk';
+import { cloudService } from '@yandex-cloud/nodejs-sdk/resourcemanager-v1';
 
 // Initialize SDK with your token
 const session = new Session();
 
 // Create service client
-const cloudService = session.client(serviceClients.CloudServiceClient);
+const cloudServiceClient = session.client(cloudService.CloudServiceClient);
 
 // Issue request (returns Promise)
-const response = await cloudService.list(ListCloudsRequest.fromPartial({
+const response = await cloudServiceClient.list(cloudService.ListCloudsRequest.fromPartial({
     pageSize: 100,
 }));
 ```
 
 ### IAM Token
 
 ```typescript
-import { Session, cloudApi, serviceClients } from '@yandex-cloud/nodejs-sdk';
-
-const { resourcemanager: { cloud_service: { ListCloudsRequest } } } = cloudApi;
+import { Session } from '@yandex-cloud/nodejs-sdk';
+import { cloudService } from '@yandex-cloud/nodejs-sdk/resourcemanager-v1';
 
 // Initialize SDK with your token
 const session = new Session({ iamToken: 'YOUR_TOKEN' });
 
 // Create service client
-const cloudService = session.client(serviceClients.CloudServiceClient);
+const cloudServiceClient = session.client(cloudService.CloudServiceClient);
 
 // Issue request (returns Promise)
-const response = await cloudService.list(ListCloudsRequest.fromPartial({
+const response = await cloudServiceClient.list(cloudService.ListCloudsRequest.fromPartial({
     pageSize: 100,
 }));
 ```
@@ -87,46 +84,4 @@ npm i
 YC_OAUTH_TOKEN=... YC_FOLDER_ID=... npm run start path/to/example.ts
 ```
 
-## Services
-
-* AI Translate;
-* AI Vision.
-* Application Load Balancer
-* Billing
-* Cloud CDN
-* Certificate Manager
-* Compute Cloud
-* Container Registry
-* Data Proc
-* DataSphere
-* Data Transfer
-* DNS
-* Identity and Access Management (IAM)
-* IoT Core
-* Managed Service for Kubernetes
-* Key Management Service (KMS)
-* Load Balancer
-* Lockbox
-* Logging
-* Managed DataBase
-  * ClickHouse
-  * ElasticSearch
-  * Greenplum
-  * Kafka
-  * MongoDB
-  * MySQL
-  * PostgreSQL
-  * Redis
-  * MS SQL Server
-* Organization Manager
-* Resource Manager
-* Serverless
-  * Functions
-  * API Gateway
-  * Containers
-  * Triggers
-  * MDB Proxy
-* Virtual Private Cloud (VPC)
-* Yandex Database (YDB)
-
-If you need generated client for other Yandex.Cloud services, just open an issue.
+P.S If you need generated client for other Yandex.Cloud services, just open an issue.