Merge pull request #71 from akashic-games/add-renderer-candidate

feat: add RendererCandidate

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.14.0
+* `RendererCandidate` を追加
+* `RendererRequirement#rendererCandidates` の型を `(string | RendererCandidate)[]` に変更
+
 ## 1.13.0
 * `CompositeOperationString` に `"difference"` と `"saturation"` を追加
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akashic/pdi-types",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "Interface definition for Akashic Platform Dependent Implementation (PDI) Layer",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

src/index.ts

@@ -40,5 +40,6 @@ export * from "./platform/OperationPluginViewInfo";
 export * from "./platform/Platform";
 export * from "./platform/PlatformEventHandler";
 export * from "./platform/PlatformPointEvent";
+export * from "./platform/RendererCandidate";
 export * from "./platform/RendererRequirement";
 export * from "./platform/ResourceFactory";

src/platform/RendererCandidate.ts

@@ -0,0 +1,6 @@
+export interface RendererCandidate {
+	type: string;
+
+	// Renderer の実装に依存するためここでは詳細は定義しない
+	options?: unknown;
+}

src/platform/RendererRequirement.ts

@@ -1,3 +1,5 @@
+import type { RendererCandidate } from "./RendererCandidate";
+
 /**
  * Rendererへの要求事項。
  */
@@ -16,5 +18,5 @@ export interface RendererRequirement {
 	 * Rendererのタイプ。
 	 * 優先度の高いものから順に指定される。
 	 */
-	rendererCandidates?: string[];
+	rendererCandidates?: (string | RendererCandidate)[];
 }