@things-factory/reference-app 4.0.1 → 4.0.5

package/dist-client/helps/module/notification.md

@@ -1,161 +0,0 @@
-# module - Notification
-
-- 사용자에게 알림을 전달하는 기능
-- 백그라운드 알림 (Push notification)
-  - 사용자가 어플리케이션을 사용하는 중이 아니더라도 알림을 전달
-  - 웹푸시 기능을 사용하며, Firebase Cloud Messaging (FCM)을 사용한다.
-- 클라이언트 알림 (In-app messaging)
-  - 사용자가 어플리케이션을 사용하는 중에 알림을 전달
-  - 웹푸시 기능을 사용할 수 없거나, 백그라운드 알림 기능 사용을 원하지 않을 때, 웹소켓을 사용하여 어플리케이션 사용 중에만 알림을 전달한다.
-- 오류 알림
-  - 사용자가 어플리케이션 조작 중에 발생하는 오류 등을 유지
-
-## terminology
-
-- notification
-  - 코드 상의 notification 용어는 주로 알림과 관련한 데이타 형식을 의미한다.
-- notify
-  - 사용자에게 알림을 전달하는 행위를 의미한다.
-
-## techonologies
-
-- web push notification
-- fcm
-- service worker
-
-## middlewares
-
-- notification-middleware
-  - koa-context의 state에 notify 라는 함수를 전달한다.
-  - 코드 내에서는 notify함수를 사용해서 알림을 전달할 수 있다.
-  - notify 기능의 표준화를 위해서 제공된다.
-- directive-notification
-  - resolver 수행 이후에 자동으로 해당 도메인의 사용자들에게 알림을 전달한다.
-  - TODO more descriptions about directive notification
-
-## security
-
-- 매우 강력한 보안 기준을 만족해야 pubsub 채널에 조인할 수 있다.
-- websocket은 tenancy 인증을 완료한 사용자로부터의 연결 요청만을 허가한다.
-- 해당 tenancy(domain)의 jwt-authentication을 가지고 있어야만 pubsub 그룹에 조인할 수 있다.
-
-## common elements
-
-### notification-setting-let
-
-![notification-setting-let](./notification-images/element-notification-setting-let.png)
-
-### notification-badge
-
-![notification-badge](./notification-images/element-notification-badge.png)
-
-### notification-list
-
-![notification-list](./notification-images/element-notification-list.png)
-
-## usages
-
-### configuration
-
-- config.(development|production).js
-
-```
-  notification: {
-    fcm: {
-      serviceAccount: {
-        project_id: "----",
-        private_key: "-----BEGIN PRIVATE KEY-----\nMIIEvQIB-----END PRIVATE KEY-----\n",
-        client_email: "-----"
-      },
-      appConfig: {
-        apiKey: '-----',
-        projectId: '-----',
-        messagingSenderId: '-----',
-        appId: '-----'
-      }
-    },
-    serverKey: '-----',
-    vapidKey: {
-      subject: 'mailto:abc@def.xyz',
-      publicKey: '-----',
-      privateKey: '-----'
-    }
-  }
-```
-
-- you can get serviceAccount configuration from firebase console
-
-![get service account config](./notification-images/config-service-account.png)
-
-- you can get app configuration from firebase console
-
-![get app config menu](./notification-images/config-app-1.png)
-![get app config](./notification-images/config-app-2.png)
-
-- you can get serverKey from firebase console
-
-![get server key config](./notification-images/config-server-key.png)
-
-- you can get vapidKey from firebase console
-
-![get vapidkey menu](./notification-images/config-vapidkey-1.png)
-![get vapid public key](./notification-images/config-vapidkey-2-get-public-key.png)
-![get vapid private key](./notification-images/config-vapidkey-3-get-private-key.png)
-
-## test
-
-### test on chrome dev
-
-- push test on chrome samples (outside url)
-
-```
-{
-  "notification": {
-    "title":"Congratulations on your performance",
-    "body": "Daily Acheivement",
-    "image": "https://d2mvzyuse3lwjc.cloudfront.net/doc/en/UserGuide/images/Pie_Of_Pie_Chart/Pie_Of_Pie_Chart.png?v=83478",
-    "url": "https://github.com/klaude416/wms-notebook/blob/master/step5_shipping.ipynb"
-  }
-}
-```
-
-- inside url sample
-
-```
-{
-  "notification": {
-    "title":"Congratulations on your performance",
-    "body": "Daily Acheivement",
-    "image": "https://d2mvzyuse3lwjc.cloudfront.net/doc/en/UserGuide/images/Pie_Of_Pie_Chart/Pie_Of_Pie_Chart.png?v=83478",
-    "url": "http://board.localhost:3000/system"
-  }
-}
-```
-
-- sample with actions
-
-```
-{
-  "notification": {
-    "title":"Congratulations on your performance",
-    "body": "Daily Acheivement",
-    "image": "https://d2mvzyuse3lwjc.cloudfront.net/doc/en/UserGuide/images/Pie_Of_Pie_Chart/Pie_Of_Pie_Chart.png?v=83478",
-    "url": "https://github.com/klaude416/wms-notebook/blob/master/step5_shipping.ipynb",
-    "actions": [{
-      "action": "save", "title": "save"
-    }, {
-      "action": "delete", "title": "delete"
-    }]
-  }
-}
-```
-
-![push test on chrome](./notification-images/push-test-on-chrome-1.png)
-![push test on chrome result](./notification-images/push-test-on-chrome-2.png)
-
-### test on firebase
-
-![push test on firebase](./notification-images/push-test-on-firebase-1.png)
-![push test on firebase](./notification-images/push-test-on-firebase-2.png)
-![push test on firebase](./notification-images/push-test-on-firebase-3.png)
-![push test on firebase result](./notification-images/push-test-on-firebase-4.png)

package/dist-client/helps/oauth2-client/code-verifier.md

@@ -1,5 +0,0 @@
-# code verifier
-
-A random, 43-128 character string used to connect the authorization request to the token request.
-
-Uses the following characters: [A-Z]/[a-z]/[0-9]/"-"/"."/"\_"/"~".

package/dist-client/helps/oauth2-client/credentials.md

@@ -1,160 +0,0 @@
-# An h1 header
-
-Paragraphs are separated by a blank line.
-
-2nd paragraph. _Italic_, **bold**, and `monospace`. Itemized lists
-look like:
-
-- this one
-- that one
-- the other one
-
-Note that --- not considering the asterisk --- the actual text
-content starts at 4-columns in.
-
-> Block quotes are
-> written like so.
->
-> They can span multiple paragraphs,
-> if you like.
-
-Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., "it's all
-in chapters 12--14"). Three dots ... will be converted to an ellipsis.
-Unicode is supported. ☺
-
-## An h2 header
-
-Here's a numbered list:
-
-1. first item
-2. second item
-3. third item
-
-Note again how the actual text starts at 4 columns in (4 characters
-from the left side). Here's a code sample:
-
-# Let me re-iterate ...
-
-for i in 1 .. 10 { do-something(i) }
-
-As you probably guessed, indented 4 spaces. By the way, instead of
-indenting the block, you can use delimited blocks, if you like:
-
-```
-define foobar() {
-print "Welcome to flavor country!";
-}
-```
-
-(which makes copying & pasting easier). You can optionally mark the
-delimited block for Pandoc to syntax highlight it:
-
-```python
-import time
-# Quick, count to ten!
-for i in range(10):
-# (but not *too* quick)
-time.sleep(0.5)
-print(i)
-```
-
-### An h3 header
-
-Now a nested list:
-
-1. First, get these ingredients:
-
-- carrots
-- celery
-- lentils
-
-2. Boil some water.
-
-3. Dump everything in the pot and follow
-   this algorithm:
-
-find wooden spoon
-uncover pot
-stir
-cover pot
-balance wooden spoon precariously on pot handle
-wait 10 minutes
-goto first step (or shut off burner when done)
-
-Do not bump wooden spoon or it will fall.
-
-Notice again how text always lines up on 4-space indents (including
-that last line which continues item 3 above).
-
-Here's a link to [a website](http://foo.bar), to a [local
-doc](local-doc.html), and to a [section heading in the current
-doc](#an-h2-header). Here's a footnote [^1].
-
-[^1]: Some footnote text.
-
-Tables can look like this:
-
-Name Size Material Color
-
----
-
-All Business 9 leather brown
-Roundabout 10 hemp canvas natural
-Cinderella 11 glass transparent
-
-Table: Shoes sizes, materials, and colors.
-
-(The above is the caption for the table.) Pandoc also supports
-multi-line tables:
-
----
-
-Keyword Text
-
----
-
-red Sunsets, apples, and
-other red or reddish
-things.
-
-green Leaves, grass, frogs
-and other things it's
-not easy being.
-
----
-
-A horizontal rule follows.
-
----
-
-Here's a definition list:
-
-apples
-: Good for making applesauce.
-
-oranges
-: Citrus!
-
-tomatoes
-: There's no "e" in tomatoe.
-
-Again, text is indented 4 spaces. (Put a blank line between each
-term and its definition to spread things out more.)
-
-Here's a "line block" (note how whitespace is honored):
-
-| Line one
-| Line too
-| Line tree
-
-and images can be specified like so:
-
-![example image](example-image.jpg 'An exemplary image')
-
-Inline math equation: $\omega = d\phi / dt$. Display
-math should get its own line like so:
-
-$$I = \int \rho R^{2} dV$$
-
-And note that you can backslash-escape any punctuation characters
-which you wish to be displayed literally, ex.: \`foo\`, \*bar\*, etc.

package/dist-client/helps/oauth2-client/grant-type.md

@@ -1,33 +0,0 @@
-# Oauth2 Grant Type
-
-The OAuth framework specifies several grant types for different use cases, as well as a framework for creating new grant types.
-
-The most common OAuth grant types are listed below.
-
-- Authorization Code
-- Implicit Grant
-- Resource Owner Password Credentials Grant
-- Client Credentials
-- JWT as Authorization Grant
-
-[from oauth.net](https://oauth.net/2/grant-types/)
-
-## Authorization Code Grant
-
-The authorization code grant type is used to obtain both access tokens and refresh tokens and is optimized for confidential clients. Since this is a redirection-based flow, the client must be capable of interacting with the resource owner's user-agent (typically a web browser) and capable of receiving incoming requests (via redirection) from the authorization server.
-
-## Implicit Grant
-
-The implicit grant type is used to obtain access tokens (it does not support the issuance of refresh tokens) and is optimized for public clients known to operate a particular redirection URI. These clients are typically implemented in a browser using a scripting language such as JavaScript.
-
-## Resource Owner Password Credentials Grant
-
-The resource owner password credentials grant type is suitable in cases where the resource owner has a trust relationship with the client, such as the device operating system or a highly privileged application. The authorization server should take special care when enabling this grant type and only allow it when other flows are not viable.
-
-## Client Credentials Grant
-
-The client can request an access token using only its client credentials (or other supported means of authentication) when the client is requesting access to the protected resources under its control, or those of another resource owner that have been previously arranged with the authorization server (the method of which is beyond the scope of this specification).
-
-## JWT as Authorization Grant
-
-A JSON Web Token (JWT) Bearer Token can be used to request an access token when a client wishes to utilize an existing trust relationship, expressed through the semantics of (and digital signature or Message Authentication Code calculated over) the JWT, without a direct user approval step at the authorization server.

package/dist-client/helps/scene/component/analog-clock.ko.md

@@ -1,6 +0,0 @@
-# clock[ko]
-![컴포넌트-아날로그시계][clock-analog-01]  
-아날로그 시계
-
-
-[clock-analog-01]: ../images/clock-analog-01.png

package/dist-client/helps/scene/component/analog-clock.md

@@ -1,8 +0,0 @@
-# clock[en]
-
-![Component-Analog clock][clock-analog-01] 
-
-Analog clock
-
-
-[clock-analog-01]: ../images/clock-analog-01.png

package/dist-client/helps/scene/component/analog-clock.zh.md

@@ -1,6 +0,0 @@
-# clock[zh]
-![组件-模拟时钟][clock-analog-01]  
-模拟时钟
-
-
-[clock-analog-01]: ../images/clock-analog-01.png

package/dist-client/helps/scene/component/arrow.ko.md

@@ -1,9 +0,0 @@
-# Single Arrow
-
-![Single-Arrow][Single-Arrow-01]
-
-한쪽 끝자락에 화살표 모양이 있는 직선
-
-- Category : Line
-
-[Single-Arrow-01]: ../images/single-arrow-01.png

package/dist-client/helps/scene/component/arrow.md

@@ -1,9 +0,0 @@
-# Single Arrow
-
-![Single-Arrow][Single-Arrow-01]
-
-A straight line with an arrow on one end.
-
-- Category : Line
-
-[Single-Arrow-01]: ../images/single-arrow-01.png

package/dist-client/helps/scene/component/arrow.zh.md

@@ -1,9 +0,0 @@
-# 直线
-
-![Single-Arrow][Single-Arrow-01]
-
-一端有箭头的直线。
-
-- 类型：线
-
-[Single-Arrow-01]: ../images/single-arrow-01.png

package/dist-client/helps/scene/component/audio.ko.md

@@ -1 +0,0 @@
-[ko]

package/dist-client/helps/scene/component/audio.md

@@ -1 +0,0 @@
-[en]

package/dist-client/helps/scene/component/audio.zh.md

@@ -1 +0,0 @@
-[zh]

package/dist-client/helps/scene/component/both-arrow.ko.md

@@ -1,9 +0,0 @@
-# Both Arrow
-
-![Both-Arrow][Both-Arrow-01]
-
-양쪽 끝자락에 화살표 모양이 있는 직선
-
-- Category : Line
-
-[Both-Arrow-01]: ../images/both-arrow-01.png

package/dist-client/helps/scene/component/both-arrow.md

@@ -1,9 +0,0 @@
-# Both Arrow
-
-![Both-Arrow][Both-Arrow-01]
-
-A straight line with an arrow on both ends.
-
-- Category : Line
-
-[Both-Arrow-01]: ../images/both-arrow-01.png

package/dist-client/helps/scene/component/both-arrow.zh.md

@@ -1,9 +0,0 @@
-# 两箭线
-
-![Both-Arrow][Both-Arrow-01]
-
-两端有箭头的直线。
-
-- 类型：线
-
-[Both-Arrow-01]: ../images/both-arrow-01.png