# Client DDB TypeScript / JavaScript

Documentation complète du package TypeScript ddb-js, qui simplifie l'accès à l'API DDB à l'aide de TypeScript.

Remarque pour les utilisateurs externes - De nombreux liens de la section suivante se réfèrent aux applications internes. Veuillez parler à votre équipe de projet pour obtenir un soutien.

# Conditions préalables

Vous aurez besoin du logiciel ci-dessous installé sur votre environnement

Nœud js v16.x
npm v8.x +

Voir comment télécharger ces packages ici (opens new window)

# Authentifiez le registre Azure NPM

ddb-js Les packages sont hébergés sur le registre (privé) des packages NPM Azure. Pour l'installer, vous devez vous authentifier, voir ci-dessous les options ci-dessous.

# les fenêtres

Pour utiliser les packages NPM, obtenez NPM (qui est livré avec Node.js) et l'assistance vsts-npm-auth.

Étape 1

Installez les conditions préalables

Étape 2

Exécuter cette commande

npm install -g vsts-npm-auth --registry https://registry.npmjs.com --always-auth false

Étape 3

Ajoutez un .npmrc à votre projet, dans le même répertoire que votre package.json

@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true

Ensuite, exécutez VSTS-NPM-AUTH pour obtenir un jeton Azure Artefacts ajouté à votre fichier .npmrc au niveau de l'utilisateur.

vsts-npm-auth -config .npmrc

Remarque: vous n'avez pas besoin de le faire à chaque fois. NPM vous donnera une erreur non autorisée 401 lorsque vous devez l'exécuter à nouveau. Vous avez des problèmes? Voir les instructions pour utiliser un jeton d'accès personnel pour authentifier .

# Autres

Étape 1

Installez les conditions préalables

Étape 2

Ajoutez un .npmrc à votre projet, dans le même répertoire que votre package.json

@ddb:registry=https://pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/
always-auth=true

Étape 3

Copiez le code ci-dessous sur votre utilisateur .npmrc (~ / .npmrc).

; begin auth token
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/:username=ovearup
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/registry/:email=[EMAIL]
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/:username=ovearup
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/:_password=[BASE64_ENCODED_PERSONAL_ACCESS_TOKEN]
//pkgs.dev.azure.com/ovearup/_packaging/ddb/npm/:email=[EMAIL]
; end auth token

Étape 4

Générer un Jeton d'accès personnel (opens new window) avec des lunettes de lecture et d'écriture d'emballage.

Étape 5

Base64 Encode le jeton d'accès personnel à partir de l'étape 4.

Une méthode sûre et sécurisée de base64 codant une chaîne est de:

À partir d'une commande de commande / shell run:

node -e "require('readline') .createInterface({input:process.stdin,output:process.stdout,historySize:0}) .question('PAT> ',p => { b64=Buffer.from(p.trim()).toString('base64');console.log(b64);process.exit(); })"

Collez votre valeur de jeton d'accès personnel et appuyez sur Entrée / retour Copiez la valeur codée Base64

Étape 6

Remplacez les deux valeurs BASE64_ENCODED_PERSONAL_ACCESS_TOKEN dans votre fichier .npmrc utilisateur par votre jeton d'accès personnel à partir de l'étape 5.

Remplacez les deux valeurs [e-mail] dans votre fichier .npmrc utilisateur par votre e-mail.

# Installation

Après l'authentification, comme décrit ci-dessus, les packages @ddb peuvent être installés via NPM. Tous les microservices peuvent être installés séparément

npm install @ddb/comments-service
npm install @ddb/environment-context-service
npm install @ddb/parameter-metadata-service
npm install @ddb/parameter-service
npm install @ddb/qa-service
npm install @ddb/reference-data-service
npm install @ddb/user-service

# Guide étape par étape

# Configuration

Cet exmaple est pour @ ddb / commentaires de commentaires

import { CommentsApi, Configuration, Environment } from "@ddb/comments-service";

// created a new configuration class
const config = new Configuration()

// specify the required environment, the default is production if the basepath isnt set
config.basePath = Environment.sandbox

// pass in the access token, note only pass in the accessToken, it will prefix with 'Bearer'
config.accessToken = 'token'

// Initialise the new class, with the config
const commentsAPI = new CommentsApi(config)

# Utilisation de l'API

Toutes les méthodes sont initiées sur la classe, et l'exemple de la façon de les appeler est ci-dessous

const comments = await commentsAPI.getComments()

Reportez-vous aux interfaces TypeScript pour comprendre les paramètres, requis dans la demande, ainsi que les réponses de la fonction.

Remarque: si vous avez installé Intellisense, vous serez dirigé

# Informations sur les développeurs

Le référentiel est situé ici (opens new window) . Voir comment contribuer (opens new window) .

← Présentation des SDK Client DDB Python →