@things-factory/board-service 7.0.0-alpha.8 → 7.0.0

package/openapi/unstable/board-print.yaml

@@ -0,0 +1,136 @@
+paths:
+  /print/:
+    get:
+      summary: Direct print using query parameters
+      tags:
+        - board-print
+      parameters:
+        - name: printerId
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Printer ID
+        - name: data
+          in: query
+          required: true
+          schema:
+            type: string
+          description: GRF string to print
+      responses:
+        '200':
+          description: Successful print
+          content:
+            text/plain:
+              schema:
+                type: string
+    post:
+      summary: Direct print using request body
+      tags:
+        - board-print
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                printerId:
+                  type: string
+                  description: Printer ID
+                data:
+                  type: string
+                  description: GRF string to print
+      responses:
+        '200':
+          description: Successful print
+          content:
+            text/plain:
+              schema:
+                type: string
+  /print-label/{id}:
+    get:
+      summary: Print label for released version board
+      tags:
+        - board-print
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Label ID
+        - name: orientation
+          in: query
+          required: false
+          schema:
+            type: string
+          description: Orientation of the label
+        - name: mirror
+          in: query
+          required: false
+          schema:
+            type: boolean
+          description: Whether to mirror the label
+        - name: upsideDown
+          in: query
+          required: false
+          schema:
+            type: boolean
+          description: Whether to print the label upside down
+        - name: printerId
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Printer ID
+      responses:
+        '200':
+          description: Successful print
+          content:
+            text/plain:
+              schema:
+                type: string
+  /print-label-draft/{id}:
+    get:
+      summary: Print label for draft version board
+      tags:
+        - board-print
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Label ID
+        - name: orientation
+          in: query
+          required: false
+          schema:
+            type: string
+          description: Orientation of the label
+        - name: mirror
+          in: query
+          required: false
+          schema:
+            type: boolean
+          description: Whether to mirror the label
+        - name: upsideDown
+          in: query
+          required: false
+          schema:
+            type: boolean
+          description: Whether to print the label upside down
+        - name: printerId
+          in: query
+          required: true
+          schema:
+            type: string
+          description: Printer ID
+      responses:
+        '200':
+          description: Successful print
+          content:
+            text/plain:
+              schema:
+                type: string

package/openapi/unstable/headless.yaml

@@ -0,0 +1,324 @@
+paths:
+  /headless-full/{id}:
+    get:
+      summary: Render full headless board by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board ID
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful render
+          content:
+            text/html:
+              schema:
+                type: string
+
+  /headless-full-by-name/{name}:
+    get:
+      summary: Render full headless board by name
+      tags:
+        - board-headless
+      parameters:
+        - name: name
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board name
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful render
+          content:
+            text/html:
+              schema:
+                type: string
+
+  /headless/{id}:
+    get:
+      summary: Render headless board by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board ID
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful render
+          content:
+            text/html:
+              schema:
+                type: string
+
+  /headless-by-name/{name}:
+    get:
+      summary: Render headless board by name
+      tags:
+        - board-headless
+      parameters:
+        - name: name
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board name
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful render
+          content:
+            text/html:
+              schema:
+                type: string
+
+  /headless-player/{id}:
+    get:
+      summary: Render headless board player by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board ID
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful render
+          content:
+            text/html:
+              schema:
+                type: string
+
+  /headless-player-by-name/{name}:
+    get:
+      summary: Render headless board player by name
+      tags:
+        - board-headless
+      parameters:
+        - name: name
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board name
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful render
+          content:
+            text/html:
+              schema:
+                type: string
+
+  /thumbnail/{id}:
+    get:
+      summary: Get board thumbnail by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board ID
+      responses:
+        '200':
+          description: Successful thumbnail retrieval
+          content:
+            image/png:
+              schema:
+                type: string
+        '404':
+          description: Thumbnail not found
+
+  /board-template-thumbnail/{id}:
+    get:
+      summary: Get board template thumbnail by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board template ID
+      responses:
+        '200':
+          description: Successful thumbnail retrieval
+          content:
+            image/png:
+              schema:
+                type: string
+        '404':
+          description: Thumbnail not found
+
+  /screenshot/{id}:
+    get:
+      summary: Get screenshot of board by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board ID
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful screenshot retrieval
+          content:
+            image/png:
+              schema:
+                type: string
+
+  /board/pdf/{id}:
+    get:
+      summary: Get PDF of board by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board ID
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful PDF retrieval
+          content:
+            application/pdf:
+              schema:
+                type: string
+
+  /label-command/{id}:
+    get:
+      summary: Get label command for released version board by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board ID
+        - name: orientation
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: mirror
+          in: query
+          required: false
+          schema:
+            type: boolean
+        - name: upsideDown
+          in: query
+          required: false
+          schema:
+            type: boolean
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful label command retrieval
+          content:
+            text/plain:
+              schema:
+                type: string
+
+  /label-command-draft/{id}:
+    get:
+      summary: Get label command for draft version board by ID
+      tags:
+        - board-headless
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+          description: Board ID
+        - name: orientation
+          in: query
+          required: false
+          schema:
+            type: string
+        - name: mirror
+          in: query
+          required: false
+          schema:
+            type: boolean
+        - name: upsideDown
+          in: query
+          required: false
+          schema:
+            type: boolean
+        - name: access_token
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successful label command retrieval
+          content:
+            text/plain:
+              schema:
+                type: string

package/openapi/unstable.yaml

@@ -0,0 +1,43 @@
+openapi: 3.0.0
+info:
+  description: >
+    For the latest release information please check our [release notes](https://developer.myoperato.com/release_notes).
+    The Board Service API exposes board-services endpoint and related functions.
+  version: unstable
+  title: Board Service
+  termsOfService: https://myoperato.com/terms/
+  contact:
+    email: heartyoh@hatiolab.com
+  license:
+    name: MIT
+    url: http://mit-license.org/
+tags:
+  - name: board-print
+    description: API to service based on board
+  - name: board-headless
+    description: API to service based on headless
+schemes:
+  - https
+  - http
+servers:
+  - url: /api/unstable/
+
+components:
+  securitySchemes:
+    basicAuth:
+      type: http
+      scheme: basic
+    bearerAuth:
+      type: http
+      scheme: bearer
+
+security:
+  - basicAuth: []
+  - bearerAuth: []
+responses:
+  UnauthorizedError:
+    description: Unauthorized
+
+externalDocs:
+  description: Find out about our release notes
+  url: https://developer.myoperato.com/release_notes

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@things-factory/board-service",
-  "version": "7.0.0-alpha.8",
+  "version": "7.0.0",
   "main": "dist-server/index.js",
-  "browser": "client/index.js",
   "things-factory": true,
   "author": "",
   "description": "A service to run dashboard in background using headless chrome",
@@ -24,11 +23,11 @@
     "migration:create": "node ../../node_modules/typeorm/cli.js migration:create -d ./server/migrations"
   },
   "dependencies": {
-    "@things-factory/auth-base": "^7.0.0-alpha.8",
-    "@things-factory/env": "^7.0.0-alpha.0",
-    "@things-factory/fav-base": "^7.0.0-alpha.8",
-    "@things-factory/font-base": "^7.0.0-alpha.8",
-    "@things-factory/integration-base": "^7.0.0-alpha.8",
+    "@things-factory/auth-base": "^7.0.0",
+    "@things-factory/env": "^7.0.0",
+    "@things-factory/fav-base": "^7.0.0",
+    "@things-factory/font-base": "^7.0.0",
+    "@things-factory/integration-base": "^7.0.0",
     "@things-factory/operato-license-checker": "^4.0.4",
     "content-disposition": "^0.5.3",
     "generic-pool": "^3.8.2"
@@ -37,5 +36,5 @@
     "@thiagoelg/node-printer": "0.6.2",
     "puppeteer": "^22.3.0"
   },
-  "gitHead": "b4981ea2721e7eaf4dbd618b6c77316ebc000ee5"
+  "gitHead": "00f3917ca132679e3571f3f4fd16f4caf84f488e"
 }

package/server/controllers/fonts.ts

@@ -31,7 +31,7 @@ export const fonts = async (domain?: Domain) => {
   var customFontCSS: string = ''
 
   for (const font of customFonts) {
-    var files: Attachment = domain
+    var files: Attachment[] = domain
       ? await getRepository(Attachment).findBy({
           domain: { id: domain.id },
           refBy: font.id

package/server/service/board/board-query.ts

@@ -68,7 +68,10 @@ export class BoardQuery {
   }
 
   @Query(returns => BoardList, { description: 'To fetch Boards created by me' })
-  async boardsCreatedByMe(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<BoardList> {
+  async boardsCreatedByMe(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<BoardList> {
     const { domain, user } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({
@@ -110,7 +113,7 @@ export class BoardQuery {
 
   @Query(returns => BoardList, { description: 'To fetch multiple Boards' })
   @Directive('@privilege(category: "board", privilege: "query", domainOwnerGranted: true)')
-  async boards(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<BoardList> {
+  async boards(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<BoardList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/board-favorite/board-favorite-query.ts

@@ -13,7 +13,10 @@ const DATABASE_TYPE = ORMCONFIG.type
 @Resolver(BoardFavorite)
 export class BoardFavoriteQuery {
   @Query(returns => BoardFavoriteList, { description: 'To fetch multiple BoardFavorites' })
-  async favoriteBoards(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<BoardFavoriteList> {
+  async favoriteBoards(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<BoardFavoriteList> {
     const { user } = context.state
 
     const queryBuilder = getRepository(Board).createQueryBuilder()

package/server/service/board-template/board-template-query.ts

@@ -42,7 +42,7 @@ export class BoardTemplateQuery {
 
   @Query(returns => BoardTemplateList, { description: 'To fetch BoardTemplates created by me' })
   async boardTemplatesCreatedByMe(
-    @Args() params: ListParam,
+    @Args(type => ListParam) params: ListParam,
     @Ctx() context: ResolverContext
   ): Promise<BoardTemplateList> {
     const { user } = context.state
@@ -61,7 +61,10 @@ export class BoardTemplateQuery {
 
   @Query(returns => BoardTemplateList, { description: 'To fetch multiple BoardTemplates' })
   @Directive('@privilege(category: "board-template", privilege: "query", domainOwnerGranted: true)')
-  async boardTemplates(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<BoardTemplateList> {
+  async boardTemplates(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<BoardTemplateList> {
     const { domain, user } = context.state
     /* 
       리스트에 포함되는 보드템플릿들 

package/server/service/board-template/board-template.ts

@@ -38,7 +38,7 @@ export class BoardTemplate {
   readonly id: string
 
   @ManyToOne(type => Domain)
-  @Field({ nullable: true })
+  @Field(type => Domain)
   domain?: Domain
 
   @RelationId((boardTemplate: BoardTemplate) => boardTemplate.domain)
@@ -66,8 +66,8 @@ export class BoardTemplate {
       DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
         ? 'longtext'
         : DATABASE_TYPE == 'oracle'
-        ? 'clob'
-        : 'varchar'
+          ? 'clob'
+          : 'varchar'
   })
   @Field({ nullable: true })
   model?: string
@@ -78,8 +78,8 @@ export class BoardTemplate {
       DATABASE_TYPE == 'mysql' || DATABASE_TYPE == 'mariadb'
         ? 'longtext'
         : DATABASE_TYPE == 'oracle'
-        ? 'clob'
-        : 'varchar'
+          ? 'clob'
+          : 'varchar'
   })
   @Field({ nullable: true })
   thumbnail?: string

package/server/service/group/group-query.ts

@@ -19,7 +19,7 @@ export class GroupQuery {
   }
 
   @Query(returns => GroupList, { description: 'To fetch multiple Groups' })
-  async groups(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<GroupList> {
+  async groups(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<GroupList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/play-group/play-group-query.ts

@@ -28,7 +28,10 @@ export class PlayGroupQuery {
   }
 
   @Query(returns => PlayGroupList, { description: 'To fetch multiple PlayGroups' })
-  async playGroups(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<PlayGroupList> {
+  async playGroups(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<PlayGroupList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/theme/theme-query.ts

@@ -16,7 +16,7 @@ export class ThemeQuery {
   }
 
   @Query(returns => ThemeList, { description: 'To fetch multiple Themes' })
-  async themes(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<ThemeList> {
+  async themes(@Args(type => ListParam) params: ListParam, @Ctx() context: ResolverContext): Promise<ThemeList> {
     const { domain } = context.state
 
     const queryBuilder = getQueryBuilderFromListParams({

package/server/service/theme/theme.ts

@@ -43,7 +43,7 @@ export class Theme {
   readonly id: string
 
   @ManyToOne(type => Domain)
-  @Field({ nullable: true })
+  @Field(type => Domain)
   domain?: Domain
 
   @RelationId((theme: Theme) => theme.domain)

package/views/internal-board-full-feature-view.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />
@@ -27,6 +27,7 @@
     </style>
 
     <link href="/node_modules/@material-design-icons/font/index.css" rel="stylesheet" />
+    <link href="/node_modules/material-symbols/index.css" rel="stylesheet" />
 
     <script src="https://ajax.googleapis.com/ajax/libs/webfont/1.6.26/webfont.js"></script>
 

package/views/internal-board-player-view.html

@@ -27,6 +27,7 @@
     </style>
 
     <link href="/node_modules/@material-design-icons/font/index.css" rel="stylesheet" />
+    <link href="/node_modules/material-symbols/index.css" rel="stylesheet" />
 
     <script src="https://ajax.googleapis.com/ajax/libs/webfont/1.6.26/webfont.js"></script>