oci-sdk

library2.132.0jsnpmunverified

Oracle Cloud Infrastructure SDK for TypeScript and JavaScript (v2.132.0). This library provides full access to Oracle Cloud Infrastructure services via TypeScript/JavaScript clients. It is actively maintained by Oracle with monthly releases. Includes all OCI services as separate sub-packages (e.g., identity, objectstorage), a common authentication/config module, and support for Node.js 14-20 (TypeScript 4.1.3+). Note: no browser support; requires OCI credentials/configuration. Differentiates from other OCI SDKs with native TypeScript support and runtime-agnostic authentication.

devops storage

npm install oci-sdk

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · OCI-SDK

oci-sdk

devopsjavascriptv2.132.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

IdentityClient

✓ import { IdentityClient } from 'oci-identity'

✗ const IdentityClient = require('oci-identity').IdentityClient

ECMAScript module (ESM) import is preferred. The CJS require() works but may have different module resolution in TypeScript.

ObjectStorageClient

✓ import { ObjectStorageClient } from 'oci-objectstorage'

✗ import ObjectStorageClient from 'oci-objectstorage'

Named export only; default import does not exist.

common.ConfigFileReader

✓ import { ConfigFileReader } from 'oci-common'

ConfigFileReader is part of 'oci-common' package, not individual service packages.

Initializes OCI Identity client using default config file and lists availability domains.

import { IdentityClient } from 'oci-identity'; import { ConfigFileReader, Region } from 'oci-common'; const config = ConfigFileReader.parseDefault(); const provider = new ConfigFileAuthenticationDetailsProvider(config); const client = new IdentityClient({ authenticationDetailsProvider: provider }); client.region = Region.US_ASHBURN_1; async function main(): Promise<void> { const { items } = await client.listAvailabilityDomains({ compartmentId: provider.getTenantId() }); console.log('ADs:', items); } main().catch(console.error);

Debug

Known issues

breakingVersion 2.0.0 changed namespaces from 'oci.*' to 'oci-*' (e.g., 'oci-identity' instead of 'oci.identity')

fix

Update imports: replace 'oci.identity' with 'oci-identity' in package.json and import statements.

affects: <2.0.0

breakingAuthenticationDetailsProvider no longer accepts plain string credentials; must use ConfigFileAuthenticationDetailsProvider or similar

fix

Use 'new ConfigFileAuthenticationDetailsProvider(config)' instead of passing user/privateKey directly.

affects: >=2.0.0 <2.10.0

deprecatedRegion constant 'US_ASHBURN_1' will be deprecated in favor of 'US_ASHBURN' in future release

fix

Use Region.US_ASHBURN instead of Region.US_ASHBURN_1.

affects: >=2.100.0

gotchaSDK does not support browser environment; all HTTP calls require Node.js crypto and fs modules

fix

Do not bundle for browser; use server-side Node.js runtime.

affects: all

Errors

Common errors & fixes

Error: Missing region in request

Client region not set or provider region missing

fix

Set client.region = Region.US_ASHBURN_1 or ensure provider has region set.

TypeError: Cannot read properties of undefined (reading 'getTenantId')

AuthenticationDetailsProvider not properly initialized

fix

Use new ConfigFileAuthenticationDetailsProvider(config) after parsing config file.

Upgrade

Version history

2.132.0latest on npm

Audit

Dependencies

oci-commonrequiredCore runtime: HTTP signing, serialization, config loading. All service clients depend on it.

Agent activity

20 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/oracle/oci-typescript-sdk ↗

packageoci-sdk ↗

homepagehttps://github.com/oracle/oci-typescript-sdk#readme ↗