@nebius/js-sdk 0.1.3 → 0.1.4

package/README.md

@@ -4,8 +4,8 @@ This repository contains the Nebius SDK for interacting with Nebius AI services
 
 ## Quick links
 
-- API reference (generated by TypeDoc): TODO
-- Generated TypeScript sources from protos: `src/api/`
+- [API reference, generated by TypeDoc](https://nebius.github.io/js-sdk/documents/SERVICES.html)
+- Generated TypeScript sources from protos: `src/api/` (not committed, one has to generate themselves)
 
 ## Installation
 
@@ -53,7 +53,7 @@ This section collects practical how-to recipes. They show common initialization
 
 ### Initialize the SDK
 
-The [`SDK`](docs/api/sdk/classes/SDK.md) is the base.
+The [`SDK`](https://nebius.github.io/js-sdk/classes/sdk.SDK.html) is the base.
 
 Here is the simplest way to initialize it:
 
@@ -101,9 +101,9 @@ const sdk = new SDK({
 });
 ```
 
-or use a [credentials file reader](docs/api/runtime/service_account/credentials_file/README.md)
+or use a [credentials file reader](https://nebius.github.io/js-sdk/classes/runtime_service_account_credentials_file.CredentialsFileReader.html)
 
-Refer to TypeDoc for all the constructor options: [SDK class](docs/api/sdk/classes/SDK.md) and [Config class](docs/api/runtime/cli_config/classes/Config.md).
+Refer to TypeDoc for all the constructor options: [SDK class](https://nebius.github.io/js-sdk/classes/sdk.SDK.html) and [Config class](https://nebius.github.io/js-sdk/classes/runtime_cli_config.Config.html).
 
 ### Test credentials and SDK lifecycle
 
@@ -124,7 +124,7 @@ await sdk.close();
 
 ### Calling services and operations
 
-Generated service clients take the `sdk` instance as the first parameter. Many RPCs return an [`Operation`](docs/api/runtime/operation/classes/Operation.md) object — use `.result` to access a helper that exposes `.wait()` and `.resourceId()`.
+Generated service clients take the `sdk` instance as the first parameter. Many RPCs return an [`Operation`](https://nebius.github.io/js-sdk/classes/runtime_operation.Operation.html) object — use `.result` to access a helper that exposes `.wait()` and `.resourceId()`.
 
 ```ts
 import { SDK } from './src/sdk';
@@ -158,11 +158,11 @@ Some methods may include `parentId` in the requests, for certain methods this fi
 - Methods `list` and `getByName` with an empty `parentId`
 - All other methods, except `update`, with an empty `metadata.parentId`
 
-The `parentId` will only be set if it was preset at the initialization, either from the [CLI `Config`](docs/api/runtime/cli_config/classes/Config.md) or from the `parentId` attribute from the [SDK](docs/api/sdk/classes/SDK.md).
+The `parentId` will only be set if it was preset at the initialization, either from the [CLI `Config`](https://nebius.github.io/js-sdk/classes/runtime_cli_config.Config.html) or from the `parentId` attribute from the [SDK](https://nebius.github.io/js-sdk/classes/sdk.SDK.html).
 
 ### Error handling and request metadata
 
-RPC errors are surfaced as normal thrown errors. The runtime [`Request`](docs/api/runtime/request/classes/Request.md) and [`Operation`](docs/api/runtime/operation/classes/Operation.md) helpers expose metadata and status information, as well as request and trace IDs.
+RPC errors are surfaced as normal thrown errors. The runtime [`Request`](https://nebius.github.io/js-sdk/classes/runtime_request.Request.html) and [`Operation`](https://nebius.github.io/js-sdk/classes/runtime_operation.Operation.html) helpers expose metadata and status information, as well as request and trace IDs.
 
 #### Retrieve request id / trace id
 
@@ -178,7 +178,7 @@ console.log({ requestId, traceId });
 
 #### Token renewal options
 
-When using renewable bearers (service accounts or other long-lived credentials), the SDK can perform token renewal on-demand for a specific request and surface renewal errors to that call. In TypeScript you express these hints by passing `authorizationOptions` on the gRPC call options object. See the runtime token docs for general behaviour: [runtime token docs](docs/api/runtime/token/README.md) and the authorization options interface: [AuthorizationOptions](docs/api/runtime/authorization/provider/interfaces/AuthorizationOptions.md).
+When using renewable bearers (service accounts or other long-lived credentials), the SDK can perform token renewal on-demand for a specific request and surface renewal errors to that call. In TypeScript you express these hints by passing `authorizationOptions` on the gRPC call options object. See the runtime token docs for general behaviour: [runtime token docs](https://nebius.github.io/js-sdk/classes/runtime_token.Token.html) and the authorization options interface: [AuthorizationOptions](https://nebius.github.io/js-sdk/interfaces/runtime_authorization_provider.AuthorizationOptions.html).
 
 Preferred TypeScript pattern — pass `authorizationOptions` in the call options:
 
@@ -213,11 +213,11 @@ const listResp = await opService.list({ resourceId: '...' } as any);
 // listResp.operations contains OperationWrapper elements; call opService.get(opId) to fetch real Operation
 ```
 
-See [OperationService](docs/api/api/nebius/common/v1/classes/OperationService.md) and the service `getOperationService()` docs (for example: [BucketService](docs/api/api/nebius/storage/v1/classes/BucketService.md)).
+See [OperationService](https://nebius.github.io/js-sdk/classes/api_nebius_common_v1.OperationService.html) and the service `getOperationService()` docs (for example: [BucketService](https://nebius.github.io/js-sdk/classes/api_nebius_storage_v1.BucketService.html#getoperationservice)).
 
 ### Update / reset-mask helpers
 
-When performing partial updates, the generated types and helpers follow the usual pattern: construct an update request and provide update masks where required. See the generated service docs (for example [BucketService](docs/api/api/nebius/storage/v1/classes/BucketService.md)) for the exact request shapes and helper methods.
+When performing partial updates, the generated types and helpers follow the usual pattern: construct an update request and provide update masks where required. See the generated service docs (for example [BucketService](https://nebius.github.io/js-sdk/classes/api_nebius_storage_v1.BucketService.html)) for the exact request shapes and helper methods.
 
 #### Updating with manually set `X-ResetMask`
 
@@ -237,7 +237,7 @@ const op = await bucketSvc.update(updateReq, undefined as any, md);
 await op.wait();
 ```
 
-See [ensureResetMaskInMetadata](docs/api/runtime/resetmask/functions/ensureResetMaskInMetadata.md) and [resetMaskFromMessage](docs/api/runtime/resetmask/functions/resetMaskFromMessage.md) for details on how the mask is derived.
+See [ensureResetMaskInMetadata](https://nebius.github.io/js-sdk/functions/runtime_resetmask.ensureResetMaskInMetadata.html) and [resetMaskFromMessage](https://nebius.github.io/js-sdk/functions/runtime_resetmask.resetMaskFromMessage.html) for details on how the mask is derived.
 
 ### Timeouts, retries and long-running operations
 
@@ -303,28 +303,18 @@ Notes:
 
 ### Where to look for types and detailed API
 
-- SDK overview and constructor options: [docs/api/sdk/README.md](docs/api/sdk/README.md) and [SDK class](docs/api/sdk/classes/SDK.md).
-- CLI config reader: [CLI config docs](docs/api/runtime/cli_config/README.md) and [Config class](docs/api/runtime/cli_config/classes/Config.md).
-- Token/bearer implementations: [runtime token docs](docs/api/runtime/token/README.md) and specific classes like `StaticBearer`, `EnvBearer`, `FileBearer`, `ServiceAccountBearer` under `docs/api/runtime/token/`.
-
-If you want runnable examples in the repo, I can add a small `examples/` folder with one or two canonical scripts (auth via token, auth via service account) and ensure they typecheck with the project; tell me if you'd like that.
+- SDK overview and constructor options: [SDK class](https://nebius.github.io/js-sdk/classes/sdk.SDK.html).
+- CLI config reader: [Config class](https://nebius.github.io/js-sdk/classes/runtime_cli_config.Config.html).
+- Token/bearer implementations: [Token](https://nebius.github.io/js-sdk/classes/runtime_token.Token.html) and specific classes like [`StaticBearer`](https://nebius.github.io/js-sdk/classes/runtime_token_static.StaticBearer.html), [`EnvBearer`](https://nebius.github.io/js-sdk/classes/runtime_token_static.EnvBearer.html), [`FileBearer`](https://nebius.github.io/js-sdk/classes/runtime_token_file.FileBearer.html), [`ServiceAccountBearer`](https://nebius.github.io/js-sdk/classes/runtime_token_service_account.ServiceAccountBearer.html).
 
 ## API reference / types
 
-Type definitions and the full API reference are generated by TypeDoc and written to `docs/api`.
-
-Useful docs (open the MD files in `docs/api` or browse in GitHub):
-
-- SDK overview: [docs/api/sdk/README.md](docs/api/sdk/README.md) — includes the `SDK` class docs ([SDK class](docs/api/sdk/classes/SDK.md)).
-- CLI-style config reader: [docs/api/runtime/cli_config/README.md](docs/api/runtime/cli_config/README.md) and the `Config` class ([Config class](docs/api/runtime/cli_config/classes/Config.md)).
-- Token and bearer helpers: [docs/api/runtime/token/README.md](docs/api/runtime/token/README.md) and token classes like [StaticBearer](docs/api/runtime/token/static/classes/StaticBearer.md), [EnvBearer](docs/api/runtime/token/static/classes/EnvBearer.md) and [FileBearer](docs/api/runtime/token/file/classes/FileBearer.md).
-
-When editing or consuming the SDK in TypeScript, prefer the generated types in `src/generated/` and the docs in [docs/api](docs/api/).
+Type definitions and the full API reference are generated by TypeDoc and written to `docs/api`. [List of all available services](https://nebius.github.io/js-sdk/documents/SERVICES.html).
 
 ## Notes & tips
 
 - Generated code in `src/api/` is ignored by the linters. Do not edit generated files by hand.
-- If you need type-level documentation, open [docs/api/index.html](docs/api/index.html) (TypeDoc output) in a browser.
+- If you need type-level documentation, [see API reference](https://nebius.github.io/js-sdk/modules/api_nebius.html).
 - For CI and automated docs publishing, the project includes `typedoc` config and build scripts under `package.json`.
 
 ### Contributing

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebius/js-sdk",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Nebius AI SDK",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",