{"id":48823,"library":"oci-filestorage","title":"OCI File Storage SDK for Node.js","description":"Official Oracle Cloud Infrastructure SDK for managing File Storage service resources (file systems, mount targets, exports, snapshots) in Node.js. Current stable version 2.132.0. Released as part of the OCI TypeScript SDK monorepo with frequent updates aligning to OCI API changes. Key differentiator: full type safety with generated TypeScript definitions, supports both ESM and CJS, and requires OCI authentication via API keys or instance principals. Compared to REST API calls, this SDK handles signing, retries, and serialization automatically.","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-filestorage","lang":"bash","label":"npm"},{"cmd":"yarn add oci-filestorage","lang":"bash","label":"yarn"},{"cmd":"pnpm add oci-filestorage","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Provides authentication, HTTP signing, and common utilities for all OCI service SDKs","package":"oci-common","optional":false}],"imports":[{"note":"SDK ships with TypeScript definitions; ESM-style import is recommended but CJS require also works.","wrong":"const { FilestorageClient } = require('oci-filestorage')","symbol":"FilestorageClient","correct":"import { FilestorageClient } from 'oci-filestorage'"},{"note":"The 'models' module is a namespace export, not a default export.","wrong":"import models from 'oci-filestorage'","symbol":"models","correct":"import * as models from 'oci-filestorage'"},{"note":"Model types are exported from a subpath 'lib/model'. Direct top-level export may not include all model types.","wrong":"import { CreateFileSystemDetails } from 'oci-filestorage'","symbol":"CreateFileSystemDetails","correct":"import { CreateFileSystemDetails } from 'oci-filestorage/lib/model'"}],"quickstart":{"code":"import { FilestorageClient } from 'oci-filestorage';\nimport { common } from 'oci-common';\n\nconst provider = new common.ConfigFileAuthenticationDetailsProvider();\n\nasync function listFileSystems(compartmentId: string) {\n  const client = new FilestorageClient({ authenticationDetailsProvider: provider });\n  const request = { compartmentId };\n  try {\n    const response = await client.listFileSystems(request);\n    console.log('File systems:', response.items);\n  } catch (error) {\n    console.error('Error listing file systems:', error);\n  }\n}\n\nconst compartmentId = process.env.COMPARTMENT_ID ?? '';\nlistFileSystems(compartmentId);","lang":"typescript","description":"Creates an OCI File Storage client using config file authentication and lists all file systems in a compartment."},"warnings":[{"fix":"Set region in the config file or pass it in the client constructor options.","message":"In version 2.x, region is required in the client configuration if not set in the config file.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Import ConfigFileAuthenticationDetailsProvider from 'oci-common' as shown in quickstart.","message":"The 'oci-common' package previously included authentication providers from the SDK; these are now available via 'oci-common' as exported classes.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Configure firewall to allow outbound HTTPS to OCI API endpoints for your region.","message":"Firewall rules: The SDK makes outbound HTTPS calls to OCI endpoints. Ensure network firewall allows traffic to *.oraclecloud.com.","severity":"gotcha","affected_versions":"all"},{"fix":"Use environment variables, OCI Vault, or config files for credentials.","message":"Sensitive data exposure: Hard-coding API credentials in code can lead to compromise.","severity":"gotcha","affected_versions":"all"},{"fix":"Import from 'oci-common/lib/region' if needed explicitly.","message":"The 'oci-common' package formerly included 'Region' and 'Realm' classes directly; they are now in a separate submodule.","severity":"deprecated","affected_versions":">=2.0.0"}],"env_vars":null,"search_vec":"'2.132.0':29 'align':42 'api':45,66,74 'authent':64 'automat':83 'call':75 'chang':46 'cjs':60 'cloud':9 'compar':71 'current':26 'definit':55 'differenti':48 'esm':58 'export':22 'file':2,14,18 'frequent':40 'full':49 'generat':53 'handl':78 'infrastructur':10 'instanc':69 'javascript':84 'key':47,67 'manag':13 'monorepo':38 'mount':20 'node.js':6,25 'oci':1,35,44,63 'offici':7 'oracl':8 'part':32 'princip':70 'releas':30 'requir':62 'resourc':17 'rest':73 'retri':80 'safeti':51 'sdk':4,11,37,77 'serial':82 'servic':16 'sign':79 'snapshot':23 'stabl':27 'storag':3,15 'support':56 'system':19 'target':21 'type':50 'typescript':36,54,85 'updat':41 'version':28 'via':65","created_at":"2026-06-07T16:58:39.388675+00:00","updated_at":"2026-06-07T16:58:39.388675+00:00","problems":[{"fix":"Set region in the config file under DEFAULT profile, or pass region option to FilestorageClient constructor.","cause":"Region not specified in client configuration or config file.","error":"Error: Missing region in request"},{"fix":"Ensure ~/.oci/config exists with correct user, fingerprint, tenancy, key_file.","cause":"Invalid or missing API key or config file.","error":"Error: Authentication failed. Check your credentials."},{"fix":"Import model types from 'oci-filestorage/lib/model' instead of top-level.","cause":"Incorrect import path for model types; some types are not exported at top level.","error":"TypeError: Cannot read properties of undefined (reading 'someProperty')"},{"fix":"Check network/firewall settings; allow outbound to *.oraclecloud.com.","cause":"Network connectivity issue or firewall blocking outbound HTTPS to OCI.","error":"Error: connect ECONNREFUSED <OCI endpoint>"}],"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-filestorage","openapi_spec":null,"status_page":null,"smithery":null,"categories":["storage"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}