セットアップ済みのリポジトリにオントロジー SDK を追加する

このガイドでは、オントロジー SDK なしでセットアップされたリポジトリに、オントロジー SDK を追加する方法を説明します。Foundry の Developer Console から、またはローカルで @osdk/create-app CLI を使用してリポジトリをセットアップしたことを前提としています。カスタム設定を使用している場合は、一部の手順を調整する必要がある場合があります。

必要な変更

以下の手順に沿って、アプリケーションにオントロジー SDK を追加します。

1. index.html を更新する

index.html ファイルの <head> セクション内に、以下の meta タグを追加します。

Copied!
1
2
3
4
5
6
7
8
9
10
11
<!DOCTYPE html>
<html>
  <head>
    <!-- その他の head の内容 -->
    <meta name="osdk-ontologyRid" content="%VITE_FOUNDRY_ONTOLOGY_RID%" />
    <!-- その他の head の内容 -->
  </head>
  <body>
    <!-- 本文の内容 -->
  </body>
</html>

2. 環境ファイルを更新する

プロジェクト内のすべての環境変数ファイルに、以下の環境変数を追加します。対象のファイルの例は、.env.development、.env.production、.env.code-workspaces です。

VITE_FOUNDRY_ONTOLOGY_RID=<ri.ontology.main.ontology.your-ontology-rid>

<ri.ontology.main.ontology.your-ontology-rid> を、オントロジー SDK のオントロジー RID に置き換えます。

オントロジー RID は Ontology Manager で確認できます。

3. client.ts を更新する

オントロジー RID を読み取り、クライアントオブジェクトを初期化します。

Copied!
1
2
3
4
5
6
7
- import { createPlatformClient, type PlatformClient } from "@osdk/client";
+ import { type Client, createClient } from "@osdk/client";

+ const ontologyRid = getMetaTagContent("osdk-ontologyRid");

- export const client: PlatformClient = createPlatformClient(foundryUrl, auth);
+ export const client: Client = createClient(foundryUrl, ontologyRid, auth);

4. package.json を更新する

オントロジー SDK パッケージを依存関係として追加します。

Copied!
1
2
3
4
5
6
{
  "dependencies": {
    + "<osdk-package-name>/sdk": "latest"
    // その他の依存関係
  }
}

<osdk-package-name> を、オントロジー SDK パッケージ名に置き換えます。

オントロジー SDK パッケージ名は、Developer Console > 概要 > 生成された SDK で確認できます。

5. .npmrc を更新する

オントロジー SDK パッケージのレジストリ URL を追加します。

+ <osdk-package-name>:registry=<registry-url>

<osdk-package-name> と <registry-url> を、オントロジー SDK パッケージ名とレジストリ URL に置き換えます。

• パッケージ名とレジストリ URL は、Developer Console > 概要 > 生成された SDK で確認できます。
• オントロジー SDK パッケージ名に /sdk を含めないでください。

以下は .npmrc ファイルの例です。

//hostname.palantirfoundry.com/artifacts/api/:\_authToken=${FOUNDRY_TOKEN}
@osdk-package:registry=https://hostname.palantirfoundry.com/artifacts/api/repositories/ri.artifacts.main.repository.45660bd6-de33-442e-9f48-a0c02372b906/contents/release/npm

ローカル開発環境でセットアップしたリポジトリの場合は、npm install を実行する前に、ターミナルで FOUNDRY_TOKEN 環境変数をエクスポートします。

Copied!
1
export FOUNDRY_TOKEN=<your-token-value>

npm 404 エラーのトラブルシューティング

npm install の実行時に 404 エラーが発生する場合、npm がオントロジー SDK パッケージに設定されたものとは異なるレジストリを使用している可能性があります。以下のレジストリ設定を確認し、意図しない上書きがあれば修正します。

• npm config get registry を実行して、グローバルに設定された npm レジストリを確認します。
• 設定を上書きする可能性がある、プロジェクト内または親ディレクトリ内のほかの .npmrc ファイルを確認します。

レジストリとトークンの追加の確認事項については、既存のアプリケーションにオントロジー SDK パッケージを追加するを参照してください。