Introduction

Cette rubrique décrit l'installation et la configuration du kit SDK pour TypeScript et JavaScript.

Afin d'utiliser le kit SDK Oracle Cloud Infrastructure pour TypeScript et JavaScript dans votre projet, importez n'importe quel service à partir de ./oci-typescript-sdk/index.ts. Par exemple :

// Container Engine

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

// Core

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

// Database

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

Téléchargement du kit SDK à partir de GitHub

Vous pouvez télécharger le kit SDK pour TypeScript et JavaScript en tant qu'archive ZIP à partir de GitHub. Il contient le kit SDK, toutes ses dépendances, la documentation et des exemples.

Installation à l'aide de YUM

Si vous utilisez Oracle Linux 7 ou 8, vous pouvez vous servir de YUM afin d'installer le kit SDK OCI pour TypeScript et JavaScript.

Pour 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

Pour Oracle Linux 7 :

Vous devez activer le système OS Management pour l'instance de calcul. Pour plus d'informations, reportez-vous à la documentation OS Management.

OS Management doit ajouter Node.js version 14 ou 16 dans la liste des sources logicielles. Pour plus d'informations sur l'ajout de Node.js 14 ou 16 à la source logicielle, reportez-vous à la documentation relative aux sources logicielles.

Une fois la source logicielle ajoutée, exécutez la commande suivante :

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

Le package YUM oci-typescript-sdk fonctionne uniquement pour Node.js version 14 ou 16. Le package oci-sdk est installé dans le dossier global node_modules. Pour utiliser le package oci-sdk dans un projet, liez le package global oci-sdk à votre projet local.

Par exemple :

# 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

Etant donné que le package oci-sdk est installé globalement, vous devez mettre à jour les instructions d'import des sous-packages d'oci-sdk lors de l'exécution des exemples oci-typescript-sdk sur GitHub. Par exemple :

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

Utilisation du kit SDK pour TypeScript et JavaScript avec NPM

NPM.

Configuration du kit SDK

Les services de kit SDK ont besoin de deux types de configuration : les informations d'identification et les paramètres HTTP côté client.

Configuration des informations d'identification

Vous devez tout d'abord configurer vos informations d'identification ainsi que le fichier de configuration. Pour obtenir des instructions, reportez-vous à Fichier de configuration du kit SDK et de l'interface de ligne de commande.

L'emplacement de configuration par défaut est "~/.oci/config" et le profil "DEFAULT" est utilisé. Vous pouvez utiliser ConfigFileAuthenticationDetailsProvider en indiquant ou non l'emplacement de configuration et le nom de profil :

// 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
);

Configuration des options personnalisées

Dans le fichier de configuration, vous pouvez insérer des paires clé-valeur personnalisées que vous définissez, puis les référencer si nécessaire. Par exemple, vous pouvez spécifier un ID de compartiment fréquemment utilisé dans le fichier de configuration :

[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>

Vous pouvez ensuite en extraire la valeur :

// 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") || "";