Merge branch 'release/2021.2.0'

.github/workflows/test.yaml

@@ -12,33 +12,25 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ['12', '14', '15', '16']
+        node: ['16']
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node }}
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - uses: actions/cache@v2
-        id: yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-      - run: yarn install
-      - run: yarn bootstrap
-      - run: yarn build
-      - run: yarn lint
-      - run: yarn test
+          cache: npm
+      - run: npm --version
+      - run: npm install
+      - run: npm run build -w packages/e2ee
+      - run: npm run build -w packages/sdk
+      - run: npm run lint -w packages/e2ee
+      - run: npm run lint -w packages/sdk
+      - run: npm run test -w packages/sdk
       - name: Slack Notification
         if: failure()
-        uses: rtCamp/action-slack-notify@v2.1.0
+        uses: rtCamp/action-slack-notify@v2
         env:
-          SLACK_CHANNEL: sora-demo
+          SLACK_CHANNEL: sora-devtools
           SLACK_COLOR: danger
           SLACK_TITLE: Failure test
           SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

.gitignore

@@ -3,3 +3,4 @@ npm-debug.log
 wasm.wasm
 packages/e2ee/dist
 packages/e2ee/_worker
+apidoc/

CHANGES.md

@@ -9,6 +9,32 @@
 - FIX
     - バグ修正
 
+## 2021.2.0
+- [UPDATE] simulcast 時の transceiver 判定条件に offer.mids.video での分岐を追加する
+    - @yuitowest
+- [UPDATE] 複数パッケージの管理を lerna から npm workspace に変更する
+    - @yuitowest
+- [ADD] DataChannel メッセージング機能を追加する
+    - sendrecv オブジェクトのオプションに datachannels を追加する
+    - sendrecv オブジェクトに sendMessage API を追加する
+    - sendrecv オブジェクトに datachannels プロパティを追加する
+    - on callback に "message" を追加する
+    - on callback に "datachannel" を追加する
+    - @yuitowest
+- [CHANGE] 複数 Signaling URL への接続に対応する
+    - Connection オブジェクト第一引数の type を `string` から `string | string[]` に変更する
+    - Connection オブジェクト signalingUrl プロパティの戻り値の type を `string` から `string | string[]` に変更する
+    - SendRecv オブジェクト signalingUrl プロパティの戻り値の type を `string` から `string | string[]` に変更する
+    - Connection オブジェクトに signalingUrlCandidates プロパティを追加する
+    - SendRecv オブジェクト に signalingUrlCandidates プロパティを追加する
+    - SendRecv オブジェクト に connectedSignalingUrl プロパティを追加する
+    - SendRecv オブジェクト に signalingCandidateTimeout オプションを追加する
+    - @yuitowest
+- [UPDATE] type redirect 対応を追加する
+    - @yuitowest
+- [CHANGE] spotlight_legacy 対応を削除する
+    - ConnectionOptions の spotlight オプションの型を boolean のみに変更する
+
 ## 2021.1.7
 - [ADD] SoraCloseEvent 関連の type を export する
     - @yuitowest
@@ -66,6 +92,7 @@
 ## 2021.1.1
 
 - [FIX] 接続処理が途中で失敗した場合の timeline ログに connected のログが出力されていた問題を修正する
+    - @yuitowest
 
 ## 2021.1.0
 

DEVELOPMENT.md

@@ -4,31 +4,39 @@
 
 ## 開発環境
 
+- Node.js
+    - v16.13.0 以上
 - npm
-    - v6.9.0 以上
-- yarn
-    - v1.16.0 以上
-- yarn install
+    - v8.1.0 以上
+- npm install
     - これで事前に利用するライブラリをインストールする
 
 ## 開発準備
 
-- `yarn install` を実行
-- `yarn bootstrap` を実行して packages 以下の各パッケージで依存関係をインストール
-- `yarn start` でローカルサーバを起動する
+**lerna でパッケージ管理していた時代に yarn install した状態の場合はトップディレクトリと packages 以下のすべての node_modules を削除すること**
+
+- `npm install` を実行
+- `npm run start` でローカルサーバを起動する
 
 ## 開発
 sora-js-sdk のトップディレクトリでコマンドを実行することによりビルドやフォーマットを行う
-- `yarn build` packages 以下をビルドする
-- `yarn lint` packages 以下のコードに lint を実行する
-- `yarn fmt` packages 以下のコードに formatter を実行する
-- `yarn test` packages 以下のテストを実行する
+
+- `npm run build` packages 以下をビルドする
+- `npm run lint` packages 以下のコードに lint を実行する
+- `npm run fmt` packages 以下のコードに formatter を実行する
+- `npm run test` packages 以下のテストを実行する
 
 ## パッケージ更新
 sora-js-sdk の package 更新
-- `yarn upgrade` を実行する
+- `npx ncu -u` を実行する
+- `npm update` を実行する
 
 sora-js-sdk/packages の package 更新
-- `yarn packages:upgrade` を実行する
-- `yarn test` を実行する
-- `yarn build` を実行する
+- `npx --workspaces ncu -u` を実行する
+- `npm update` を実行する
+- `npm run build` を実行する
+- `npm run lint` を実行する
+- `npm run test` を実行する
+
+## ドキュメント作成
+- `npm run doc` を実行する

RELEASE.md

@@ -4,32 +4,35 @@
 
 ## リリース環境
 
+- Node.js
+    - v16.13.0 以上
 - npm
-    - v6.9.0 以上
-- yarn
-    - v1.16.0 以上
-- yarn install
+    - v8.1.0 以上
+- npm install
     - これで事前に利用するライブラリをインストールする
 
 
-
 ## リリース手順
 
 - git flow release start <tag> で開始する
 - CHANGES.md にタグを打つバージョンで書き込む
-- yarn lint を実行する
-- yarn test を実行する
-- yarn release:minor を実行する
-    - minor バージョンが更新されていることを確認する
-    - 差分をコミットする
+- npm run lint を実行する
+- npm run test を実行する
+- npm run release:minor を実行する
+    - Next version を確認する
+    - コミットメッセージを<tag>にして差分をコミットする(例. git commit -m "2020.2.0")
 - git flow release finish <tag> で終了する
-- git push -u origin develop master --tags
+- git push -u origin develop master
+- git push origin <tag>
+- npm publish を実行する
 
 ## canary リリース手順
 
-- yarn lint を実行する
-- yarn test を実行する
-- yarn release:canary を実行する
-    - canary バージョンが更新されていることを確認する
+- npm run lint を実行する
+- npm run test を実行する
+- npm run release:canary を実行する
+    - Next version を確認する
     - コミットメッセージをバージョンにして差分をコミットする(例. git commit -m "2020.1.0-canary.0")
-- git push -u origin develop --tags
+- git push -u origin develop master
+- git push origin <tag>
+- npm publish --tag canary を実行する

TYPEDOC.md

@@ -0,0 +1,34 @@
+# Sora JavaScript SDK API Document
+
+Sora JavaScript SDK は[株式会社時雨堂](https://shiguredo.jp/)が開発、販売している [WebRTC SFU Sora](https://sora.shiguredo.jp) をブラウザから扱うための SDK です。
+
+## About Shiguredo's open source software
+
+We will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.
+
+Please read https://github.com/shiguredo/oss before use.
+
+## 時雨堂のオープンソースソフトウェアについて
+
+利用前に https://github.com/shiguredo/oss をお読みください。
+
+## ライセンス
+
+Apache License 2.0
+
+```
+Copyright 2017-2021, Yuki Ito (Original Author)
+Copyright 2017-2021, Shiguredo Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```