Introducción

En este tema se describe cómo instalar y configurar el SDK para TypeScript y JavaScript.

Para utilizar el SDK para TypeScript y JavaScript de Oracle Cloud Infrastructure en el proyecto, importe cualquier servicio desde ./oci-typescript-sdk/index.ts. Por ejemplo:

// Container Engine

export import containerengine = require("oci-containerengine");

// Core

export import core = require("oci-core");

// Database

export import database = require("oci-database");

Descarga del SDK de GitHub

Puede descargar el SDK para TypeScript y JavaScript como archivo zip desde GitHub. Contiene el SDK, todas sus dependencias, documentación y ejemplos.

Instalación con yum

Si utiliza Oracle Linux 7 u 8, puede utilizar yum para instalar el SDK de OCI para TypeScript y JavaScript.

Para Oracle Linux 8:

sudo yum module enable nodejs:14 # for node 16 run: sudo yum module enable nodejs:16
sudo yum install oci-typescript-sdk

Para Oracle Linux 7:

Se debe activar el sistema OS Management para la instancia informática. Consulte la documentación de OS Management para obtener más información.

OS Management debe agregar la versión de nodo 14 o 16 en la lista de orígenes de software. Consulte la documentación sobre orígenes de software para obtener más información sobre cómo agregar Nodejs 14 o 16 al origen de software.

Después de agregar el origen de software, ejecute:

sudo yum --disablerepo ol7_developer_epel-x86_64 install nodejs 
sudo yum install oci-typescript-sdk

El paquete de yum oci-typescript-sdk solo funcionará para la versión de nodo 14 o 16. El paquete oci-sdk se instalará en la carpeta global node_modules. Para utilizar el paquete oci-sdk en un proyecto, enlace el paquete global oci-sdk al proyecto local.

Por ejemplo:

# Assuming you are in your project's top level directory
npm link oci-sdk
# You should now see oci-sdk package in your local project's node_modules folder

Como el paquete oci-sdk está instalado globalmente, debe actualizar las sentencias de importación para los subpaquetes de oci-sdk al ejecutar los ejemplos de oci-typescript-sdk en GitHub. Por ejemplo:

import * as identity from "oci-identity"; // Change needed
import * as oci from "oci-sdk"; // No change needed

import * as identity from "oci-sdk/node_modules/oci-identity"; //Changed
import * as oci from "oci-sdk"; // No change

Uso del SDK para TypeScript y JavaScript con NPM

NPM.

Configuración del SDK

Los servicios de SDK necesitan dos tipos de configuración: credenciales y valores HTTP del cliente.

Configuración de credenciales

En primer lugar, debe configurar sus credenciales y el archivo de configuración. Para obtener instrucciones, consulte Archivo de configuración de SDK y CLI.

La ubicación de configuración por defecto es "~/.oci/config" y se utiliza el perfil "DEFAULT". Puede utilizar ConfigFileAuthenticationDetailsProvider con o sin especificar la ubicación de configuración y el nombre de perfil:

// TypeScript
import common = require("oci-common");
// Using default configuration
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider();
// Using personal configuration
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const provider: common.ConfigFileAuthenticationDetailsProvider = new common.ConfigFileAuthenticationDetailsProvider(
  configurationFilePath,
  configProfile
);

// JavaScript
const common = require("oci-common");
// Using default configurations
const provider = new common.ConfigFileAuthenticationDetailsProvider();
// Using personal configuration
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const provider = new common.ConfigFileAuthenticationDetailsProvider(
  configurationFilePath,
  configProfile
);

Configuración de opciones personalizadas

En el archivo de configuración, puede insertar pares de clave-valor personalizados que defina y, a continuación, hacer referencia a ellos según sea necesario. Por ejemplo, puede especificar un ID de compartimento de uso frecuente en el archivo de configuración:

[DEFAULT]
user=ocid1.user.oc1..<your_unique_id>
fingerprint=<your_fingerprint>
key_file=~/.oci/oci_api_key.pem
tenancy=ocid1.tenancy.oc1..<your_unique_id>
customCompartmentId=ocid1.compartment.oc1..<your_unique_id>

A continuación, puede recuperar el valor:

// TypeScript
import common = require("oci-common");
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const config = common.ConfigFileReader.parseDefault(configurationFilePath);
const profile = config.accumulator.configurationsByProfile.get(configProfile);
customCompartmentId = profile.get("customCompartmentId") || "";


// JavaScript
import common = require("oci-common");
const configurationFilePath = "~/your_config_location";
const configProfile = "your_profile_name";
const config = common.ConfigFileReader.parseDefault(configurationFilePath);
const profile = config.accumulator.configurationsByProfile.get(configProfile);
customCompartmentId = profile.get("customCompartmentId") || "";