既存のアプリケーションにオントロジー SDK パッケージを追加する

このページでは、既存のアプリケーションにオントロジー SDK パッケージを追加するプロセスを説明します。既存のアプリケーションがない場合は、新しいオントロジー SDK アプリケーションのブートストラップのドキュメントをご覧ください。

1: 前提条件

Developer Console アプリケーションを作成する

新しい Developer Console アプリケーションを作成するページに記載されている手順に従います。

ユーザーのトークンを設定する

ユーザーのローカル環境でトークンをエクスポートします。以下はサンプルのパーソナルアクセストークンを使用した例ですが、Developer Consoleでより長い有効期間のものを生成することもできます。このトークンはユーザーのパーソナルアクセストークンであるため、ソースコントロールにチェックインすべきではありません。

Copied!1
2
# FOUNDRY_TOKENに<GETTING-STARTEDページから取得したトークン>を設定する
export FOUNDRY_TOKEN=<YOUR-TOKEN-FROM-GETTING-STARTED-PAGE>

Node バージョンの確認

Typescript SDK は、Node 18 以降が必要です。使用中の Node のバージョンを確認するには、以下のコマンドを使用してください。

Copied!1
2
# Node.js のバージョンを表示する
node --version

2: 既存のプロジェクトにオントロジー SDK を追加する

NPM レジストリを設定する

リポジトリやユーザーの .npmrc ファイルに以下のコードを追加し、< > をアプリケーション固有の値に置き換えてください：

//<オーバービューページからのレジストリURL>:_authToken=${FOUNDRY_TOKEN}
// レジストリURLからの認証トークンを設定します
<PACKAGE-NAME>:registry=https://<REGISTRY-URL-FROM-OVERVIEW-PAGE>
// パッケージ名にレジストリURLを設定します

オプション: 証明書の設定

ネットワークトラフィックに証明書が必要なユーザーの組織では、証明書が保存されている場所を Node に指示する必要があるかもしれません。

Copied!1
2
# 以下のコードで、独自の証明書ファイルのパスを指定して環境変数に設定します
export NODE_EXTRA_CA_CERTS="/path/to/my.crt"

SDK の最新版をインストール

以下のコマンドを実行して、ユーザーの SDK パッケージをインストールします：

Copied!1
2
3
4
5
6
7
8
npm install <PACKAGE-NAME>@latest
# 指定したパッケージの最新バージョンをインストール

npm install @osdk/client@latest
# @osdk/client パッケージの最新バージョンをインストール

npm install @osdk/oauth@latest
# @osdk/oauth パッケージの最新バージョンをインストール

開発を開始するために Foundry クライアントを初期化する

以下のコードをアプリケーションに追加し、< > をパッケージの詳細に置き換えてください：

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import { createPublicOauthClient } from "@osdk/oauth";
import { createClient } from "@osdk/client";
import { <ANY-OBJECT-NAME> } from "<PACKAGE-NAME>";
import React, { useEffect } from "react";

const auth = createPublicOauthClient("<YOUR-CLIENT-ID>", "<YOUR-FOUNDRY-URL>", "<YOUR-REDIRECT-URL>");
const client: Client = createClient("<YOUR-FOUNDRY-URL>", "<YOUR-ONTOLOGY-RID>", auth);

export default function SimpleReactComponent() {
    useEffect(() => {
        if (auth.getTokenOrUndefined()) {
            auth.refresh().catch(() =>
            /**
               トークンを更新できない場合（たとえば、ユーザーがログインしていない場合）には、Foundryのログインフローを開始します。
               ログインが完了すると、ユーザーはhttp://localhost:8080/auth/callbackにリダイレクトされます。
            **/
            auth.signIn())
        } else {
            client(<ANY-OBJECT-NAME>).fetchPage({ $pageSize: 10 }).then((object) => {
                console.log(object.data);
            });
        }
    }, []);
};