Inject token key option (#85)

.changeset/purple-foxes-approve.md

@@ -0,0 +1,6 @@
+---
+"@dandori/libs": patch
+"@dandori/ui": patch
+---
+
+add inject api key option

package.json

@@ -39,7 +39,7 @@
     "prettier": "3.1.0",
     "tsup": "^8.0.1",
     "tsx": "^4.6.2",
-    "turbo": "^1.11.0",
+    "turbo": "^1.11.1",
     "typescript": "5.3.3",
     "vitest": "^0.34.6"
   },

packages/libs/src/__tests__/checkApiKey.test.ts

@@ -0,0 +1,40 @@
+import { describe, it, expect } from "vitest";
+import { checkApiKey } from "../index";
+
+describe("checkApiKey", () => {
+  const keyName = "keyName";
+  const targetKey = "targetKey";
+  const alternativeKey = "alternativeKey";
+
+  describe("with targetKey", () => {
+    describe("with alternativeKey", () => {
+      it("returns targetKey", () => {
+        expect(checkApiKey(keyName, targetKey, alternativeKey)).toBe(targetKey);
+      });
+    });
+
+    describe("without alternativeKey", () => {
+      it("returns targetKey", () => {
+        expect(checkApiKey(keyName, targetKey, undefined)).toBe(targetKey);
+      });
+    });
+  });
+
+  describe("without targetKey", () => {
+    describe("with alternativeKey", () => {
+      it("returns alternativeKey", () => {
+        expect(checkApiKey(keyName, undefined, alternativeKey)).toBe(
+          alternativeKey,
+        );
+      });
+    });
+
+    describe("without alternativeKey", () => {
+      it("throw error", () => {
+        expect(() => checkApiKey(keyName, undefined, undefined)).toThrow(
+          `Please set ${keyName}.`,
+        );
+      });
+    });
+  });
+});

packages/libs/src/checkApiKey.ts

@@ -0,0 +1,13 @@
+export function checkApiKey(
+  keyName: string,
+  targetKey?: string,
+  alternativeKey?: string,
+): string {
+  if (targetKey) {
+    return targetKey;
+  }
+  if (alternativeKey) {
+    return alternativeKey;
+  }
+  throw new Error(`Please set ${keyName}.`);
+}

packages/libs/src/index.ts

@@ -2,3 +2,4 @@ export * from "./loadFile";
 export * from "./loadEnvFile";
 export * from "./logger";
 export * from "./runPromisesSequentially";
+export * from "./checkApiKey";

packages/ui/README.md

@@ -67,6 +67,7 @@ The tasks which are generated by `generateDandoriTasks` of `@dandori/core`.
 interface GenerateDandoriMiroCardsOptions {
   boardId: string;
   isAppCard?: boolean;
+  apiKey?: string;
 }
 ```
 
@@ -84,6 +85,12 @@ For example, if the url is `https://miro.com/app/board/1234567890/`, the board i
 
 If you set `true` , the cards are created as [App cards](https://developers.miro.com/docs/app-card).
 
+* apiKey
+
+The api key of miro. You can also set `MIRO_API_KEY` environment variable instead of this option.
+
+```ts
+
 ### generateDandoriNotionTasks
 
 ```ts
@@ -109,6 +116,7 @@ The tasks which are generated by `generateDandoriTasks` of `@dandori/core`.
 interface GenerateDandoriNotionPagesOptions {
   databaseId: string;
   databasePropertiesMap?: DatabasePropertiesMap;
+  apuKey?: string;
 }
 ```
 
@@ -169,4 +177,8 @@ This is an example. In this case, the output is like belows.
 
 <img src="../../media/notion_example.png" alt="notion output example" width="426">
 
-For more details about database properties, please see [Notion API](https://developers.notion.com/reference/page#page-property-value).
+For more details about database properties, please see [Notion API](https://developers.notion.com/reference/page#page-property-value).
+
+* apiKey
+
+The api key of miro. You can also set `NOTION_API_KEY` environment variable instead of this option.

packages/ui/src/__tests__/miro.test.ts

@@ -30,6 +30,7 @@ vi.mock("@dandori/libs", () => {
     runPromisesSequentially: vi.fn((runPromises, _runningLogPrefix) =>
       Promise.all(runPromises.map((runPromise: () => any) => runPromise())),
     ),
+    checkApiKey: vi.fn(),
   };
 });
 

packages/ui/src/__tests__/notion.test.ts

@@ -38,6 +38,7 @@ vi.mock("@dandori/libs", () => {
     runPromisesSequentially: vi.fn((runPromises, _runningLogPrefix) =>
       Promise.all(runPromises.map((runPromise: () => any) => runPromise())),
     ),
+    checkApiKey: vi.fn(),
   };
 });
 

packages/ui/src/miro.ts

@@ -2,11 +2,17 @@ import { MiroApi } from "@mirohq/miro-api";
 import { DandoriTask } from "@dandori/core";
 import FlatToNested from "flat-to-nested";
 import TreeModel from "tree-model";
-import { getLogger, getLogLevel, runPromisesSequentially } from "@dandori/libs";
+import {
+  checkApiKey,
+  getLogger,
+  getLogLevel,
+  runPromisesSequentially,
+} from "@dandori/libs";
 
 export type GenerateDandoriMiroCardsOptions = {
   boardId: Parameters<MiroApi["getBoard"]>[0];
   isAppCard?: boolean;
+  apiKey?: string;
 };
 
 // miro settings
@@ -53,14 +59,15 @@ export async function generateDandoriMiroCards(
   tasks: DandoriTask[],
   options: GenerateDandoriMiroCardsOptions,
 ): Promise<void> {
-  const logger = getLogger();
-  const miroApi = new MiroApi(
+  const key = checkApiKey(
+    "miro api key",
     process.env.MIRO_API_KEY,
-    undefined,
-    (...thing) => {
-      logger[getLogLevel()](thing);
-    },
+    options.apiKey,
   );
+  const logger = getLogger();
+  const miroApi = new MiroApi(key, undefined, (...thing) => {
+    logger[getLogLevel()](thing);
+  });
   const miroBoard = await miroApi.getBoard(options.boardId);
   const taskFlat: (DandoriTask & { [taskParentPropName]?: string })[] = tasks
     .map((task) =>

packages/ui/src/notion.ts

@@ -5,7 +5,12 @@ import {
   DandoriTaskStatus,
 } from "@dandori/core";
 import { Client, LogLevel } from "@notionhq/client";
-import { getLogger, getLogLevel, runPromisesSequentially } from "@dandori/libs";
+import {
+  checkApiKey,
+  getLogger,
+  getLogLevel,
+  runPromisesSequentially,
+} from "@dandori/libs";
 
 type SupportNotionTaskOptionalProperty = Exclude<
   DandoriTaskOptionalProperty,
@@ -56,6 +61,7 @@ export type DatabasePropertiesMap =
 export type GenerateDandoriNotionPagesOptions = {
   databaseId: string;
   databasePropertiesMap?: DatabasePropertiesMap;
+  apiKey?: string;
 };
 
 const hasStatusProperty = (
@@ -145,9 +151,14 @@ export async function generateDandoriNotionPages(
   tasks: DandoriTask[],
   options: GenerateDandoriNotionPagesOptions,
 ): Promise<void> {
+  const key = checkApiKey(
+    "notion api key",
+    process.env.NOTION_API_KEY,
+    options.apiKey,
+  );
   const logger = getLogger();
   const client = new Client({
-    auth: process.env.NOTION_API_KEY,
+    auth: key,
     logLevel: getNotionLogLevel(),
     logger: (
       level: LogLevel,