oci-waas

library2.132.0jsnpmunverified

Oracle Cloud Infrastructure (OCI) WAAS (Web Application Acceleration and Security) SDK for Node.js (version 2.132.0). This package is part of the official OCI TypeScript SDK, released approximately every 2 weeks. It provides programmatic access to manage OCI WAAS resources such as Web Application Firewall (WAF), edge policies, and certificate management. Compared to using the OCI CLI or REST API directly, this SDK offers type safety (TypeScript declarations included), automatic request signing, and retry handling. The latest version supports all WAAS API operations as of 2025. It is designed for Node.js environments and uses native ESM modules.

security devops

npm install oci-waas

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · OCI-WAAS

oci-waas

securityjavascriptv2.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.

WaasClient

✓ import { WaasClient } from 'oci-waas';

✗ const WaasClient = require('oci-waas').WaasClient;

ESM-only; CJS require is not supported. Use import statement.

models

✓ import * as models from 'oci-waas/lib/models';

✗ const models = require('oci-waas').models;

Models are exported from a subpath; they are not directly on the main export.

CreateCertificateDetails

✓ import { CreateCertificateDetails } from 'oci-waas/lib/models';

✗ import { CreateCertificateDetails } from 'oci-waas';

Type interfaces are not re-exported from the main module; must import from the models subpath.

Shows how to create a WaasClient, list edge subnets, and use typed request models.

import { WaasClient } from 'oci-waas'; import * as models from 'oci-waas/lib/models'; import { common } from 'oci-common'; const provider = new common.ConfigFileAuthenticationDetailsProvider(); const client = new WaasClient({ authenticationDetailsProvider: provider }); async function listEdgeSubnets() { const request: models.ListEdgeSubnetsRequest = {}; const response = await client.listEdgeSubnets(request); console.log(response.items); } listEdgeSubnets().catch(console.error);

Debug

Known issues

breakingIn v2.x, the SDK migrated to ESM-only. CommonJS require() will throw an error.

fix

Use ES module imports (import) and ensure package.json includes "type": "module".

affects: >=2.0.0

deprecatedThe method `getWaasPolicy` is deprecated in favor of `getPolicy`.

fix

Use `client.getPolicy(request)` instead.

affects: >=2.100.0

gotchaAuthentication via instance principals requires explicit OCI_REGION environment variable.

fix

Set OCI_REGION environment variable or pass region in the client configuration.

affects: *

Errors

Common errors & fixes

Cannot find module 'oci-waas'

Package not installed or ESM-only import used in CJS project.

fix

Run npm install oci-waas oci-common && ensure package.json has 'type': 'module'.

TypeError: client.listEdgeSubnets is not a function

Client method called before proper authentication setup.

fix

Ensure authenticationDetailsProvider is correctly configured and passed to WaasClient constructor.

Property 'items' does not exist on type 'WaasClient.listEdgeSubnetsResponse'.

Missing or incorrect TypeScript type definitions.

fix

Update oci-waas to latest version: npm install oci-waas@latest.

Upgrade

Version history

2.132.0latest on npm

Audit

Dependencies

oci-commonrequiredCore SDK module providing authentication, HTTP handling, and common utilities

Agent activity

19 hits · last 30 days

node

OpenAI (training)

Resources

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

packageoci-waas ↗

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