{"id":41665,"library":"oci-sdk","title":"OCI SDK for TypeScript and JavaScript","description":"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.","status":"active","version":"2.132.0","language":"javascript","source_language":"en","source_url":"https://github.com/oracle/oci-typescript-sdk","tags":["javascript","typescript"],"install":[{"cmd":"npm install oci-sdk","lang":"bash","label":"npm"},{"cmd":"yarn add oci-sdk","lang":"bash","label":"yarn"},{"cmd":"pnpm add oci-sdk","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core runtime: HTTP signing, serialization, config loading. All service clients depend on it.","package":"oci-common","optional":false}],"imports":[{"note":"ECMAScript module (ESM) import is preferred. The CJS require() works but may have different module resolution in TypeScript.","wrong":"const IdentityClient = require('oci-identity').IdentityClient","symbol":"IdentityClient","correct":"import { IdentityClient } from 'oci-identity'"},{"note":"Named export only; default import does not exist.","wrong":"import ObjectStorageClient from 'oci-objectstorage'","symbol":"ObjectStorageClient","correct":"import { ObjectStorageClient } from 'oci-objectstorage'"},{"note":"ConfigFileReader is part of 'oci-common' package, not individual service packages.","wrong":"","symbol":"common.ConfigFileReader","correct":"import { ConfigFileReader } from 'oci-common'"}],"quickstart":{"code":"import { IdentityClient } from 'oci-identity';\nimport { ConfigFileReader, Region } from 'oci-common';\n\nconst config = ConfigFileReader.parseDefault();\nconst provider = new ConfigFileAuthenticationDetailsProvider(config);\nconst client = new IdentityClient({ authenticationDetailsProvider: provider });\nclient.region = Region.US_ASHBURN_1;\n\nasync function main(): Promise<void> {\n  const { items } = await client.listAvailabilityDomains({\n    compartmentId: provider.getTenantId()\n  });\n  console.log('ADs:', items);\n}\nmain().catch(console.error);","lang":"typescript","description":"Initializes OCI Identity client using default config file and lists availability domains."},"warnings":[{"fix":"Update imports: replace 'oci.identity' with 'oci-identity' in package.json and import statements.","message":"Version 2.0.0 changed namespaces from 'oci.*' to 'oci-*' (e.g., 'oci-identity' instead of 'oci.identity')","severity":"breaking","affected_versions":"<2.0.0"},{"fix":"Use 'new ConfigFileAuthenticationDetailsProvider(config)' instead of passing user/privateKey directly.","message":"AuthenticationDetailsProvider no longer accepts plain string credentials; must use ConfigFileAuthenticationDetailsProvider or similar","severity":"breaking","affected_versions":">=2.0.0 <2.10.0"},{"fix":"Use Region.US_ASHBURN instead of Region.US_ASHBURN_1.","message":"Region constant 'US_ASHBURN_1' will be deprecated in favor of 'US_ASHBURN' in future release","severity":"deprecated","affected_versions":">=2.100.0"},{"fix":"Do not bundle for browser; use server-side Node.js runtime.","message":"SDK does not support browser environment; all HTTP calls require Node.js crypto and fs modules","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"search_vec":"'-20':59 '14':58 '4.1.3':61 'access':20 'activ':31 'agnost':81 'authent':82 'authentication/config':52 'browser':64 'client':28 'cloud':8,23 'common':51 'credentials/configuration':68 'differenti':69 'e.g':47 'full':19 'ident':48 'includ':38 'infrastructur':9,24 'javascript':6,14,83 'librari':17 'maintain':32 'modul':53 'month':36 'nativ':75 'node.js':57 'note':62 'objectstorag':49 'oci':1,40,67,72 'oracl':7,22,34 'packag':46 'provid':18 'releas':37 'requir':66 'runtim':80 'runtime-agnost':79 'sdk':2,10 'sdks':73 'separ':43 'servic':25,41 'sub':45 'sub-packag':44 'support':55,65,77 'typescript':4,12,60,76,84 'typescript/javascript':27 'v2.132.0':15 'via':26","created_at":"2026-06-04T18:53:30.639334+00:00","updated_at":"2026-06-04T18:53:30.639334+00:00","problems":[{"fix":"Set client.region = Region.US_ASHBURN_1 or ensure provider has region set.","cause":"Client region not set or provider region missing","error":"Error: Missing region in request"},{"fix":"Use new ConfigFileAuthenticationDetailsProvider(config) after parsing config file.","cause":"AuthenticationDetailsProvider not properly initialized","error":"TypeError: Cannot read properties of undefined (reading 'getTenantId')"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/oracle/oci-typescript-sdk#readme","github":"https://github.com/oracle/oci-typescript-sdk","docs":null,"changelog":null,"pypi":null,"npm":"oci-sdk","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops","storage"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}