Add docs (#68)

.changeset/polite-months-sniff.md

@@ -0,0 +1,6 @@
+---
+"@dandori/cli": patch
+"@dandori/ui": patch
+---
+
+change command and types

package.json

@@ -25,7 +25,7 @@
   "license": "MIT",
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.8",
-    "@changesets/cli": "^2.26.2",
+    "@changesets/cli": "^2.27.1",
     "@types/node": "18.18.13",
     "@typescript-eslint/eslint-plugin": "6.12.0",
     "@typescript-eslint/parser": "6.12.0",
@@ -39,7 +39,7 @@
     "lint-staged": "^15.1.0",
     "prettier": "3.1.0",
     "tsup": "^8.0.1",
-    "tsx": "^4.2.0",
+    "tsx": "^4.6.0",
     "turbo": "^1.10.16",
     "typescript": "5.3.2",
     "vitest": "^0.34.6"

packages/cli/README.md

@@ -2,17 +2,10 @@
 
 This repository is responsible for executing `@dandori/*` packages.
 
-## Installation
-
-```bash
-# It isn't necessary to install this package if you use the command like `npx` .
-npm install @dandori/cli
-yarn add @dandori/cli
-pnpm add @dandori/cli
-```
-
 ## Usage
 
+This is an example of using Miro.
+
 First, please create `.env` file and set environment variables like below.
 
 ```text
@@ -32,15 +25,48 @@ Today's My Tasks
 Finally, please execute the following command.
 
 ```bash
-npx -p @dandori/cli dandori-miro your_tasks.txt -b your_miro_board_id
-yarn dlx -p @dandori/cli dandori-miro your_tasks.txt -b your_miro_board_id
-pnpm --package=@dandori/cli dlx dandori-miro your_tasks.txt -b your_miro_board_id
+npx --package=@dandori/cli -- miro your_tasks.txt -b your_miro_board_id
+yarn dlx -p @dandori/cli miro your_tasks.txt -b your_miro_board_id
+pnpm --package=@dandori/cli dlx miro your_tasks.txt -b your_miro_board_id
 ```
 
 ## Requirements
 
 * Please see [@dandori/core](../core/README.md) and [@dandori/ui](../ui/README.md) before using `@dandori/cli`.
 
+## Commands
+
+### core
+
+This command is to execute `generateDandoriTasks` of `@dandori/core`.
+
+```bash
+% pnpm --package=@dandori/cli dlx core -h
+Options:
+  -V, --version                                    output the version number
+  -e, --env-file <env-file>                        env file path
+  -m, --model <model>                              Chat GPT model which supports function_calling
+  -o, --optional-task-props <optional-task-props>  optional output task props which delimiter is a comma
+  -h, --help                                       display help for command
+```
+
+### miro
+
+This command is to execute `generateDandoriMiroCards` of `@dandori/ui`.
+
+```bash
+% pnpm --package=@dandori/cli dlx miro -h
+
+Options:
+  -V, --version                                    output the version number
+  -e, --env-file <env-file>                        env file path
+  -m, --model <model>                              Chat GPT model which supports function_calling
+  -o, --optional-task-props <optional-task-props>  optional output task props which delimiter is a comma
+  -a, --app-card
+  -b, --board-id <board-id>
+  -h, --help                                       display help for command
+```
+
 ## Supported External APIs
 
 * [Miro](https://miro.com/)

packages/cli/package.json

@@ -24,8 +24,8 @@
     "dev:miro": "tsx src/miro/cli.ts"
   },
   "bin": {
-    "dandori": "./dist/core/cli.js",
-    "dandori-miro": "./dist/miro/cli.js"
+    "core": "./dist/core/cli.js",
+    "miro": "./dist/miro/cli.js"
   },
   "keywords": [],
   "author": "Hiroki Miyaji",

packages/core/package.json

@@ -27,6 +27,6 @@
   "license": "MIT",
   "dependencies": {
     "@dandori/libs": "workspace:*",
-    "openai": "^4.19.1"
+    "openai": "^4.20.1"
   }
 }

packages/ui/README.md

@@ -38,4 +38,135 @@ await generateDandoriMiroCards(tasks, {
 ## Supported External APIs
 
 * [Miro](https://miro.com/)
-* [Notion](https://www.notion.so/)
+* [Notion](https://www.notion.so/)
+
+## API
+
+### generateDandoriMiroCards
+
+```ts
+async function generateDandoriMiroCards(
+  tasks: DandoriTask[],
+  options?: GenerateDandoriMiroCardsOptions,
+): Promise<void> {}
+```
+
+`generateDandoriMiroCards` creates miro cards from `generateDandoriTasks` result.
+
+<img src="../../media/miro_example.png" alt="miro output example" width="422">
+
+#### Parameters
+
+##### tasks
+
+The tasks which are generated by `generateDandoriTasks` of `@dandori/core`.
+
+##### options
+
+```ts
+interface GenerateDandoriMiroCardsOptions {
+  boardId: string;
+  isAppCard?: boolean;
+}
+```
+
+* boardId
+
+The existing board id of miro.
+
+You can get the board id from the miro url of the board.
+
+For example, if the url is `https://miro.com/app/board/1234567890/`, the board id is `1234567890`.
+
+* isAppCard
+
+**default is `false`**
+
+If you set `true` , the cards are created as [App cards](https://developers.miro.com/docs/app-card).
+
+### generateDandoriNotionTasks
+
+```ts
+async function generateDandoriNotionPages(
+  tasks: DandoriTask[],
+  options?: GenerateDandoriNotionPagesOptions,
+): Promise<void> {}
+```
+
+`generateDandoriNotionTasks` creates notion pages from `generateDandoriTasks` result.
+
+<img src="../../media/notion_example.png" alt="notion output example" width="426">
+
+#### Parameters
+
+##### tasks
+
+The tasks which are generated by `generateDandoriTasks` of `@dandori/core`.
+
+##### options
+
+```ts
+interface GenerateDandoriNotionPagesOptions {
+  databaseId: string;
+  databasePropertiesMap?: DatabasePropertiesMap;
+}
+```
+
+* databaseId
+
+The existing database id of notion.
+
+You can get the database id from the notion url of the database.
+
+For example, if the url is `https://www.notion.so/myworkspace/1234567890?v=123`, the database id is `1234567890`.
+
+* databasePropertiesMap
+
+**default is `{ name: 'Name' }`**
+
+The map which key is defined by dandori and value is your notion database properties.
+
+You can set the key like belows.
+
+```ts
+const databasePropertiesMap = {
+  name: "",
+  deadline: "",
+  description: "",
+  status: "",
+  "status.todo": "",
+  "status.doing": "",
+  "status.done": "",
+};
+```
+
+```ts
+import generateDandoriTasks from '@dandori/core';
+import { generateDandoriNotionPages } from "@dandori/ui";
+
+const text = `
+Today's My Tasks
+* Send Email to John
+* Send Email to Mary
+* Report to Boss after sending emails
+`;
+
+const databasePropertiesMap = {
+  status: "Status",
+  "status.todo": "ToDo",
+  "status.doing": "Doing",
+  "status.done": "Done 🙌",
+};
+
+const tasks = await generateDandoriTasks(text);
+await generateDandoriNotionPages(tasks, {
+  databaseId: '1234567890',
+  databasePropertiesMap,
+});
+```
+
+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).

packages/ui/src/notion.ts

@@ -53,7 +53,7 @@ export type DatabasePropertiesMap =
   | BaseDatabasePropertiesMap
   | DatabasePropertiesMapWithStatus;
 
-export type GenerateDandoriNotionDatabaseItemsOptions = {
+export type GenerateDandoriNotionPagesOptions = {
   databaseId: string;
   databasePropertiesMap?: DatabasePropertiesMap;
 };
@@ -66,7 +66,7 @@ const hasStatusProperty = (
 
 const createPageParams = (
   task: DandoriTask,
-  options: GenerateDandoriNotionDatabaseItemsOptions,
+  options: GenerateDandoriNotionPagesOptions,
 ): Parameters<InstanceType<typeof Client>["pages"]["create"]>[0] => {
   const propsMap = options.databasePropertiesMap ?? {};
   const { deadline, description, status, name } = task;
@@ -143,7 +143,7 @@ const getNotionLogLevel = () => {
 
 export async function generateDandoriNotionPages(
   tasks: DandoriTask[],
-  options: GenerateDandoriNotionDatabaseItemsOptions,
+  options: GenerateDandoriNotionPagesOptions,
 ): Promise<void> {
   const logger = getLogger();
   const client = new Client({