Merge pull request #1 from freee/release-1.0.0

release 1.0.0

Author: Shuhei-Kotegawa

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.idea

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "semi": false
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 freee K.K.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,3 @@
+## 概要
+
+## 動作確認方法

README.md

@@ -1 +1,63 @@
-# firebase-sdk-js
+# freee 会計 API SDK for firebase in Javascript （β版）
+
+freee アプリストアのアプリを firebase 上で開発するための SDK です。
+
+## できること
+
+- freee ログイン -> 認可 -> リダイレクト -> firebase にアカウント情報保存 -> firebase ログインの一連の処理
+- freee の API をトークンを意識せず呼び出すことが可能
+- freee アクセストークン・リフレッシュトークンの暗号化・復号処理
+
+## このSDKについて
+
+本 SDK は主要な機能が含まれていますが、β版のステータスとなっており、制限およびバグがある可能性があります。また、このステータスの記載が更新されるまでは、API やインターフェイスに変更が入る可能性がありますので、ご利用の際はご留意ください。
+
+## 目次
+
+- [チュートリアル](#チュートリアル)
+  - [前提条件](#前提条件)
+  - [freee アプリストアへのアプリケーション登録](#freee-アプリストアへのアプリケーション登録)
+  - [サンプルアプリ](#サンプルアプリ)
+  - [SDK の導入方法](#SDK-の導入方法)
+- [ライセンス](#ライセンス)
+
+## チュートリアル
+
+本 SDK を利用する手順について記載します。
+
+### 前提条件
+
+本 SDK を利用する前に下記をご確認ください。
+
+- freee 本体のアカウントを持っていること
+- firebase のアカウントを持っていること
+
+freee 本体のアカウントは、後述する [freee アプリストアへのアプリケーション登録](#freee-アプリストアへのアプリケーション登録) で必要になります。
+
+freee API に関しては、[チュートリアルガイド](https://app.secure.freee.co.jp/developers/tutorials/1-freee%20API%E3%82%92%E5%A7%8B%E3%82%81%E3%82%8B#freee%20API%E3%82%92%E5%A7%8B%E3%82%81%E3%82%8B) をご参照ください。
+
+firebase の基礎知識については、Google が提供する[firebase のドキュメント](https://firebase.google.com/docs) をご参照ください。
+
+### freee アプリストアへのアプリケーション登録
+
+本 SDK で利用する `ClientId` および `ClientSecret` を取得するため、freee アプリストアの開発者ページでアプリケーションを登録します。
+
+こちらの [チュートリアル | freee アプリストア](https://app.secure.freee.co.jp/developers/tutorials/2-%E3%82%A2%E3%83%97%E3%83%AA%E3%82%B1%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B) を参考に、アプリケーションを登録して下さい。
+
+### サンプルアプリ
+
+#### WebApp のサンプル
+
+こちらの[サンプルアプリのリポジトリ](https://github.com/freee/freee-app-template-firebase)の README にしたがって、セットアップを行なってください。
+
+### SDK の導入方法
+
+該当のプロジェクトディレクトリで以下のコマンドを実行してください。
+
+`npm install freee-firebase-sdk`
+
+## ライセンス
+
+ライセンスについては下記をご参照ください。
+
+[MIT License](./LICENSE)

jest.config.js

@@ -0,0 +1,17 @@
+module.exports = {
+    "roots": [
+        `${__dirname}/src`
+    ],
+    "transform": {
+        "^.+\\.tsx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+    "moduleFileExtensions": [
+        "ts",
+        "tsx",
+        "js",
+        "jsx",
+        "json",
+        "node"
+    ],
+}

lib/index.d.ts

@@ -0,0 +1,69 @@
+import { AxiosPromise } from 'axios';
+import * as express from 'express';
+import * as admin from 'firebase-admin';
+import { ParamJSON, SDKConfig } from '../src/sdk/const/types';
+
+declare module 'freee-firebase-sdk' {
+  /**
+   * Freee Server SDK
+   */
+  export class FreeeServerSDK {
+    constructor(config: SDKConfig, serviceAccount: { [key: string]: string })
+
+    /**
+     * get firebase admin instance
+     */
+    firebaseApp(): admin.app.App
+
+    /**
+     * get freee api client instance
+     */
+    api(): FreeeAPIClient
+
+    /**
+     * get auth client instance
+     */
+    auth(): FreeeFirebaseAuthClient
+  }
+
+  class FreeeAPIClient {
+    get<T = any>(
+      url: string,
+      params: ParamJSON,
+      userId: string
+    ): AxiosPromise<T>
+    post<T = any>(url: string, data: ParamJSON, userId: string): AxiosPromise<T>
+    put<T = any>(url: string, data: ParamJSON, userId: string): AxiosPromise<T>
+    delete(url: string, data: ParamJSON, userId: string): AxiosPromise
+  }
+
+  class FreeeFirebaseAuthClient {
+    /**
+     * Redirect url to authorize
+     */
+    redirect(res: express.Response): void
+    /**
+     * Get token with authorized code from freee, save it to firebase and login firebase
+     */
+    callback(code: string, res: express.Response): void
+    /**
+     * path for redirect on freee authorization
+     */
+    getRedirectPath(): string
+    /**
+     * path for callback on freee authorization
+     */
+    getCallbackPath(): string
+    /**
+     * path for callback on freee authorization
+     */
+    getCompaniesPath(): string
+
+    /**
+     * Create crypto key to bucket for it by specified date
+     *
+     * {@link SDKConfig#firebase#cryptoKeyBucket} must be specified
+     */
+    createCryptoKey(date: Date): Promise<void>
+  }
+}