ターボモジュールの作成

[project-root]/
  ├─ kepler/
  │  ├─ turbo-modules/
  │  │  ├─ generated/
  │  │  │  ├─ (C++ specifications)
  │  │  │
  │  │  ├─ (C++ implementations)
  │  │
  │  ├─ AutoLinkInit.cpp (autolink setup)
  │
  ├─ src/
  │  ├─ turbo-modules/
  │  │  ├─ (TypeScript interface files)
  │  │
  │  ├─ App.tsx (only for in-app Turbo Modules)
  │
  ├─ tst/
  │  ├─ (JS test files)
  │
  ├─ .eslintrc
  ├─ .prettierrc
  ├─ babel.config.js
  ├─ CMakeLists.txt
  ├─ jest.config.json
  ├─ metro.config.js
  ├─ package.json
  ├─ react-native.config.js
  ├─ tsconfig.json
  ├─ tsconfig-build.json

vega project list-templates

vega project generate -t idl-turbo-module -n <キャメルケースのプロジェクト名> --idlPackage <IDLパッケージの逆引きDNS名>

vega project generate -t idl-turbo-module -n TestIdlTm --idlPackage com.amazon.kepler.i18n.text.message_format_classic

vega project generate -t basic-turbo-module -n <キャメルケースのプロジェクト名> --idlPackage <IDLパッケージの逆引きDNS名>

npm install --save @amazon-devices/keplerscript-turbomodule-api

import type {KeplerTurboModule} from '@amazon-devices/keplerscript-turbomodule-api';
import {TurboModuleRegistry} from '@amazon-devices/keplerscript-turbomodule-api';

export interface Pinger extends KeplerTurboModule {
  ping: () => number;
}

export default TurboModuleRegistry.getEnforcing<Pinger>('Pinger');

npx keplerscript-turbomodule-api codegen src/turbo-modules/<NativePinger.ts> \
    -o kepler/turbo-modules/ \
    --new \
    --namespace PingerTurboModule

// kepler/turbo-modules/Pinger.cpp

double Pinger::ping() {
    return 0;
}

// kepler/turbo-modules/Pinger.h

// IDLフレームワークヘッダー（APMF）をインポートします。
#include <apmf/apmf_base.h>
#include <apmf/ptr.h>
#include <apmf/process.h>

...
class Pinger: public com::amazon::kepler::turbomodule::KeplerTurboModule {
public:
    ...
    // メンバー変数を追加します
    apmf::Ptr<apmf::iface::com::amazon::apmf::IStandard> component;
    ...
}

// kepler/turbo-modules/Pinger.cpp

// 使用するIDLパッケージをインポートします。
// IHello.hは一例であり、存在しない可能性が高いことに注意してください。
#include <apmf/iface/com/amazon/kepler/foo/IHello.h>
using apmf::iface::com::amazon::kepler::foo::IHello;

...
Pinger::Pinger() {
    // コンストラクターで「コンポーネント」を初期化します
    auto const process = apmf::GetProcessObject();
    this->component = process->getComponent("/com.amazondeveloper.kepler.foo");
}

...
//「コンポーネント」を使用してAPIにアクセスできます。
// 以下の呼び出しはいつでも利用できるとは限らないため、あくまでも一例であることに注意してください。
auto const hello = this->component.TryQueryInterface<IHello>();
return hello->getHelloString();

...

import PingerModule from './NativePinger';

class Pinger {
  // これはネイティブモジュールに転送するだけですが、さらに複雑な操作もできます。
  // または、ネイティブモジュールを必要としないJS専用のユーティリティ関数を入力することもできます。
  ping(): number {
    return PingerModule.ping();
  }
}

export default new Pinger();

// テストファイルでは、
jest.mock('<path-to-NativePinger.ts>');

#include <kepler/turbomodule/KeplerTurboModuleRegistration.h>

// モジュール実装用のヘッダーファイル
#include "turbo-modules/Pinger.h"

extern "C" {
__attribute__((visibility("default"))) void
    autoLinkKeplerTurboModulesV1() noexcept {
        KEPLER_REGISTER_TURBO_MODULE(
            PingerTurboModule, /* 名前空間 */
            Pinger /* クラス名 */
        );

        // パッケージに複数のターボモジュールが含まれている場合は、ここで登録を続けてください。
    }
}

KEPLER_REGISTER_TURBO_MODULE(
    "myName", /* TurboModuleRegistryの文字列 */
    PingerTurboModule, /* 名前空間 */
    PingerModule /* クラス名 */
);

module.exports = {
  dependency: {
    platforms: {
      kepler: {
        autolink: {
          "com.companyname.pinger": { // この名前はメタデータの自動リンクにのみ使用されます。
                                      // 命名の競合を避けるため、リバースDNSの使用をお勧めします。
            "libraryName": "libPinger.so", // これはCMakeListsのライブラリ名に由来します。
            "provider": "application",
            "linkDynamic": true, 
            "turbomodules": ["Pinger"] // これはTurboModuleRegistryに由来します
                                       //ターボモジュールが複数ある場合は、このリストを展開してください。
          }
        },
      },
    },
  },
};

{
  ...
  "kepler": {
    "keplerInitializationSharedLibrary": "com.companyname.pinger",
    "autolink": {
      "com.companyname.pinger": {
        "libraryName": "libPinger.so",
        "provider": "application",
        "linkDynamic": true,
        "turbomodules": ["Pinger"]
      }
    }
    ...
  }
}

cmake_minimum_required(VERSION 3.19)
set (CMAKE_POSITION_INDEPENDENT_CODE ON)
project(pinger-module # これはライブラリ名です
  VERSION 1.0
  LANGUAGES CXX C)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)
# その他のヘッダーファイルをここに追加
set(HEADERS
  kepler/turbo-modules/generated/PingerSpec.h
  kepler/turbo-modules/Pinger.h
)
# その他のソースファイルをここに追加
set(SOURCES
    kepler/turbo-modules/generated/PingerSpec.cpp
    kepler/turbo-modules/Pinger.cpp
    kepler/AutoLinkInit.cpp
)
find_package(turbomoduleAPI CONFIG REQUIRED)
kepler_add_turbo_module_library(pinger-module ${HEADERS} ${SOURCES})

# IDL用
#     <idlPackage> #  com.amazon.kepler.i18n.text.message_format_classicなど
#     # IDLパッケージをここに追加
#
# kepler_add_idl_import_library(
#     idl_pkg
#     PACKAGES
#     <idlPackage> #  com.amazon.kepler.i18n.text.message_format_classicなど
#     # IDLパッケージをここに追加
# )
#
# target_link_libraries(pinger-module PRIVATE idl_pkg)
install(TARGETS pinger-module)

npm install --save <path-to-pinger.tgz / path-to-Pinger-package / ‘@amazon-devices/pinger’>

npm pack

import Pinger from ‘<path-to-Pinger.ts>’;
Pinger.ping();

npm install --save <path-to-pinger.tgz / path-to-Pinger-package / ‘@amazon-devices/pinger’>

// ターボモジュールがデフォルトのエクスポートの場合
import Pinger from ‘pinger’;
// ターボモジュールが名前付きエクスポートの場合
import { Pinger } from ‘pinger’;
Pinger.ping()

jest.mock(‘@amazon-devices/pinger/dist/turbo-modules/NativePinger’);