@fmsim/fmsim 0.0.98 → 0.0.99

package/dist-app/helps/board-modeller/styles/line-style.zh.md

@@ -0,0 +1,19 @@
+# 线型
+
+  - 厚度：设置线的厚度。
+  - 颜色：设置线的颜色。
+  - 线的样式：设置线的样式。（直线、虚线等）
+  - 线端的样式：设置线端的样式。（square：方形线端，round：圆形线端）
+  - 连接样式：设置线与线相连接的点的样式。  
+    (锐角相交 : ![miter][miter], 弧形 : ![round][round], 斜角相交 : ![bevel][bevel])
+  - 开始形状：设置线的开始形状。
+  - 开始大小：设置线的开始大小。
+  - 结束形状：设置线的结束形状。
+  - 结束大小：设置线的结束大小。
+
+
+[miter]: ../images/join-type-miter.png
+
+[round]: ../images/join-type-round.png
+
+[bevel]: ../images/join-type-bevel.png

package/dist-app/helps/board-modeller/styles/opacity.ko.md

@@ -0,0 +1,3 @@
+# 투명도
+
+컴포넌트의 투명한 정도를 설정한다. (0 ~ 1, 0 : 안보임, 1 : 보임)

package/dist-app/helps/board-modeller/styles/opacity.md

@@ -0,0 +1,3 @@
+# Opacity
+
+- Set the transparency of component. (0 ~ 1, 0: Invisible, 1: Visible)

package/dist-app/helps/board-modeller/styles/opacity.zh.md

@@ -0,0 +1,3 @@
+# 透明度
+
+设置组件的透明度。（0~1, 0: 透明, 1: 不透明）

package/dist-app/helps/board-modeller/styles/text-style.ko.md

@@ -0,0 +1,8 @@
+# 텍스트 스타일
+
+  - 폰트 : 컴포넌트 텍스트의 폰트를 설정한다.  
+  - 크기 : 컴포넌트 텍스트의 크기를 설정한다.  
+  - 줄간격 : 컴포넌트 텍스트의 줄사이 간격을 설정한다.  
+  - 색상 : 컴포넌트 텍스트의 색상을 설정한다.
+  - 굵기 : 컴포넌트 텍스트를 굵게 설정한다.
+  - 기울기 : 컴포넌트 텍스트를 기울임꼴로 설정한다.

package/dist-app/helps/board-modeller/styles/text-style.md

@@ -0,0 +1,8 @@
+# Text Style
+
+  - Font: Set the font of component text.
+  - Font size: Set the size of component text.
+  - Line spacing: Set the line spacing of component text.
+  - Color: Set the color of component text.
+  - Bold: Set the text of component bold.
+  - Italic: Set the text of component italic.

package/dist-app/helps/board-modeller/styles/text-style.zh.md

@@ -0,0 +1,8 @@
+# 文本样式
+
+  - 字体：设置组件文本的字体。
+  - 字体大小：设置组件文本的大小。
+  - 行间隔：设置组件文本的行间隔。
+  - 颜色：设置组件文本的颜色。
+  - 粗体：加粗组件文本。
+  - 斜体：加斜组件文本。

package/dist-app/helps/board-service/board-template.md

@@ -0,0 +1,160 @@
+# BoardTemplate
+
+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-app/helps/codelingua/codelingua.md

@@ -0,0 +1,160 @@
+# Codelingua
+
+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-app/helps/components/oops-progress.md

@@ -0,0 +1,73 @@
+# OOPS Progress 컴포넌트
+
+긴 시간 진행되는 작업의 진행 상황을 표현해주기 위해 서버에 진행율을 Subscribe하는 클라이언트 컴포넌트이다.
+이 컴포넌트는 자체적으로 시각적 요소를 포함하지 않지만, 시각적 표현을 위해서 자식 노드(Light DOM)를 포함할 수는 있다.
+
+## properties
+
+- tag: String 서브스크립션 태그이며, 서버의 'publishProgress'의 tag와 일치시키도록 한다.
+- subscription: String (readonly) 이 속성이 값을 가지고 있으면, 서브스크립션 중임을 의미한다.
+
+## methods
+
+- startSubscribe() 진행율 구독을 시작한다.
+- stopSubscribe() 진행율 구독을 종료한다.(서버쪽 작업의 종료를 의미하지 않으며, 클라이언트에서 구독을 종료한다는 의미임.)
+
+## event
+
+- progress(event) 서버로부터 진행율이 Subscribe 되었을 때 발생한다.
+  - event.detail : progress 값을 갖는다.
+- finish(event) 진행율이 100% 도달하면 발생한다.
+
+## 예시
+
+### 클라이언트 사이드
+
+```
+  <oops-progress
+    .tag='progress-pending-job'
+    @progress=${e => {
+      this.progress = e.detail
+    }}
+    @finish=${() => {
+      console.log('complete')
+    }}
+    ?hidden=${progress < 0 || progress > 100}
+  >
+    <div>
+      <mwc-linear-progress .progress=${progress / 100}></mwc-linear-progress>
+      <span>Progress : ${progress} % (${message})</span>
+    </div>
+  </oops-progress>
+
+```
+
+### 서버사이드
+
+```
+import { sleep } from '@things-factory/utils'
+
+...
+
+@Mutation(returns => String, { description: 'To reference of pending job progress' })
+async referencePendingJob(
+  @Root() _,
+  @Ctx() context: any
+) : Promise<string> {
+
+  const { domain } = context.state
+
+  for(var i = 0;i <= 100;i++) {
+    await sleep(100)
+
+    publishProgress({
+      domain,
+      tag: 'progress-pending-job',
+      progress: i,
+      message: `${i * 10} / 1000`
+    })
+  }
+
+  return 'success'
+}
+```

package/dist-app/helps/config/SECRET.md

@@ -0,0 +1,13 @@
+# SECRET
+
+모든 어플리케이션은 아래 샘플과 같이 독자적인 SECRET 키를 지정하여야 한다.
+이 설정은 인증을 위한 jwt key 생성시 암호화를 위한 SEED로 사용된다.
+따라서, 새로 디플로이된 곳에 독자적인 SECRET 키를 새로 지정하지 않으면, (이미 알려져있을 수 있는) 디폴트 값이 사용되므로 보안에 취약해질 수 있다.
+
+## default
+
+```
+module.exports = {
+  SECRET: '0xD58F835B69D207A76CC5F84a70a1D0d4C79dAC95',
+}
+```

package/dist-app/helps/config/accessTokenCookieKey.md

@@ -0,0 +1,11 @@
+# accessTokenCookieKey
+
+브라우저에서 쿠키를 활용해서 세션키를 저장하는 경우, 세션키로 활용될 고유한 쿠키의 키를 지정할 수 있다.
+
+## default
+
+```
+module.exports = {
+  accessTokenCookieKey: 'access_token',
+}
+```

package/dist-app/helps/config/applianceJwtExpiresIn.md

@@ -0,0 +1,26 @@
+# applianceJwtExpiresIn
+
+단말장치의 액세스토큰의 사용 유효기간을 설정한다.
+
+- 설정값은 다음과 같은 여러 형태로 가능합니다.[참조](https://github.com/vercel/ms)
+
+```
+2 days  // 2일
+1d      // 하루
+10h     // 10시간
+2.5 hrs // 2.5시간
+2h      // 2시간
+1m      // 1분
+5s      // 5초
+1y      // 1년
+10y     // 10년
+100     // 100 미리초
+```
+
+## default
+
+```
+module.exports = {
+  applianceJwtExpiresIn: '1y',
+}
+```

package/dist-app/helps/config/attachmentPath.md

@@ -0,0 +1,17 @@
+# attachmentPath
+
+첨부파일의 URL의 기본 path 정보.
+
+예를 들어, 첨부파일의 id가 'abcde12345' 이고, attachmentPath설정이 'attachments' 이면, 브라우저에서 첨부파일을 조회하기 위한 URL은 다음과 같다.
+
+```
+https://server-ip:port/attachments/abcde12345
+```
+
+## default
+
+```
+module.exports = {
+  attachmentPath: 'attachment',
+}
+```

package/dist-app/helps/config/disableUserSignupProcess.md

@@ -0,0 +1,22 @@
+# disableUserSignupProcess
+
+- 이 설정이 true이면, 사용자가 어플리케이션에 접속해서 사용자 등록을 신청할 수 있으며, 이메일을 통해서 사용자를 검증하고 계정을 활성화할 수 있다.
+- 이 설정이 false이면, 사용자가 직접 사용자 등록 신청을 할 수 없으며, 시스템의 관리자가 신규 사용자 계정을 등록해 줄 수 있다. 이 때에 사용되는 기본 패스워드는 password 설정의 defaultPassword 항목에 설정할 수 있다.
+- 이 설정은 사용자 등록, 계정이 잠김 경우 재 활성화 요청, 패스워드를 기억하지 못하는 경우 이메일을 통한 패스워드 재 설정 등 모든 프로세스에 영향을 미친다.
+
+## default
+
+```
+module.exports = {
+  password: {
+    ...,
+    defaultPassword: false
+  },
+  /*
+    Only When 'disableUserSignupProcess' is set to false,
+    a user-initiated user registration process is provided.
+    When this value is true, the 'defaultPassword' for the password must be configured.
+  */
+  disableUserSignupProcess: false,
+}
+```

package/dist-app/helps/config/googleFontAPIKey.md

@@ -0,0 +1,15 @@
+# athena
+
+구글 폰트 API 키 설정
+
+구글 폰트 API는 폰트 추가시에 폰트 이름 리스트를 보여줄 수 있는데, 이 폰트 이름 리스트를 가져오기 위해서 사용된다.
+
+이 키가 설정되지 않으면, 폰트 이름 리스트를 볼 수는 없으나, 직접 폰트 이름을 직접 입력해서 추가 기능은 가능하다.
+
+## default
+
+```
+module.exports = {
+  googleFontAPIKey: ''
+}
+```

package/dist-app/helps/config/i18n.md

@@ -0,0 +1,44 @@
+# i18n
+
+- languages
+  - 다국어 환경에서 사용하고자 하는 언어팩들을 설정할 수 있다.
+- defaultLanguage
+  - 사용자의 기본 언어 설정을 지정한다.
+  - 사용자가 특별히 선호하는 언어를 지정하지 않은 경우에 이 기본 언어 설정이 사용된다.
+- disableUserFavoredLanguage
+  - 사용자가 선호하는 언어를 선택할 수 없도록 설정할 수 있다.
+  - 이 설정을 true로 하게되면, 사용자 프로필 메뉴에서 언어선택 기능이 보이지 않게된다.
+  - 모든 사용자들이 특정 언어만을 사용하도록 강제하고자 할 때 사용할 수 있다.
+
+## default
+
+```
+module.exports = {
+  i18n: {
+    languages: [
+      {
+        code: 'en-US',
+        display: 'English'
+      },
+      {
+        code: 'ko-KR',
+        display: '한국어'
+      },
+      {
+        code: 'zh-CN',
+        display: '中文'
+      },
+      {
+        code: 'ja-JP',
+        display: 'にほんご'
+      },
+      {
+        code: 'ms-MY',
+        display: 'Bahasa Malaysia'
+      }
+    ],
+    defaultLanguage: 'en-US',
+    disableUserFavoredLanguage: false
+  }
+}
+```

package/dist-app/helps/config/openai.md

@@ -0,0 +1,14 @@
+# openai
+
+OpenAI 접속 정보 설정
+
+## 예시
+
+```
+module.exports = {
+  openai: {
+    organization: 'org-XXXXXXXXXXXXXXXX',
+    apiKey: 'sk-YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'
+  }
+}
+```

package/dist-app/helps/config/password.md

@@ -0,0 +1,65 @@
+# password
+
+패스워드 설정 규칙을 유연하게 정의하고 이러한 규칙을 기반으로 패스워드를 유효성 검사할 수 있습니다.
+
+패스워드 규칙은 대/소문자, 숫자, 특수문자 및 길이와 같은 다양한 요소들을 조절할 수 있어 보안 정책에 맞게 패스워드 규칙을 커스터마이징할 수 있습니다.
+
+- `lowerCase` (기본값: `true`):
+
+  - 소문자를 포함하는지 여부를 나타내는 부울 값입니다. 설정된 경우, 패스워드는 최소한 하나의 소문자를 포함해야 합니다.
+
+- `upperCase` (기본값: `true`):
+
+  - 대문자를 포함하는지 여부를 나타내는 부울 값입니다. 설정된 경우, 패스워드는 최소한 하나의 대문자를 포함해야 합니다.
+
+- `digit` (기본값: `true`):
+
+  - 숫자를 포함하는지 여부를 나타내는 부울 값입니다. 설정된 경우, 패스워드는 최소한 하나의 숫자를 포함해야 합니다.
+
+- `specialCharacter` (기본값: `true`):
+
+  - 특수 문자를 포함하는지 여부를 나타내는 부울 값입니다. 설정된 경우, 패스워드는 최소한 하나의 특수 문자(!@#$%^&\*())를 포함해야 합니다.
+
+- `allowRepeat` (기본값: `false`):
+
+  - 문자 반복을 허용하는지 여부를 나타내는 부울 값입니다. 설정된 경우, 패스워드에 문자가 두 번 이상 연속으로 반복되지 않아야 합니다.
+
+- `useTightPattern` (기본값: `true`):
+
+  - 엄격한 패스워드 패턴을 사용할지 여부를 나타내는 부울 값입니다. 설정된 경우, 패스워드는 길이와 각 요소 (소문자, 대문자, 숫자, 특수 문자)에 대한 요구 사항을 엄격하게 따라야 합니다.
+
+- `useLoosePattern` (기본값: `false`):
+
+  - 느슨한 패스워드 패턴을 사용할지 여부를 나타내는 부울 값입니다. 설정된 경우, 패스워드의 길이만 엄격하게 체크하고 다른 요소에 대한 요구 사항은 무시합니다.
+
+- `tightCharacterLength` (기본값: `8`):
+
+  - 엄격한 패스워드 패턴을 사용할 경우, 패스워드의 최소 길이를 나타냅니다.
+
+- `looseCharacterLength` (기본값: `15`):
+
+  - 느슨한 패스워드 패턴을 사용할 경우, 패스워드의 최소 길이를 나타냅니다.
+
+- `defaultPassword` (기본값: false):
+  - 관리자가 사용자를 등록하는 경우, 새로운 사용자에게 설정되는 기본 패스워드이다.
+  - 이 값이 false 이면, 관리자가 사용자를 등록하는 기능은 사용할 수 없다.
+
+## default
+
+```
+module.exports = {
+  password: {
+    lowerCase: true,
+    upperCase: false,
+    digit: true,
+    specialCharacter: true,
+    allowRepeat: true,
+    useTightPattern: true,
+    useLoosePattern: false,
+    tightCharacterLength: 8,
+    looseCharacterLength: 15,
+    history: 2,
+    defaultPassword: false
+  },
+}
+```