@things-factory/contact 6.0.0-zeta.26

package/helps/contact/contact.md

@@ -0,0 +1,160 @@
+# Contact
+
+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/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@things-factory/contact",
+  "version": "6.0.0-zeta.26",
+  "main": "dist-server/index.js",
+  "browser": "dist-client/index.js",
+  "things-factory": true,
+  "license": "MIT",
+  "author": "heartyoh <heartyoh@hatiolab.com>",
+  "description": "Module that provide services for maintaining contact information",
+  "publishConfig": {
+    "access": "public",
+    "@things-factory:registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hatiolab/things-factory.git",
+    "directory": "packages/contact"
+  },
+  "scripts": {
+    "build": "npm run build:server && npm run build:client",
+    "build:client": "npx tsc --p ./client/tsconfig.json",
+    "build:server": "npx tsc --p ./server/tsconfig.json",
+    "clean:client": "npx rimraf dist-client",
+    "clean:server": "npx rimraf dist-server",
+    "clean": "npm run clean:server && npm run clean:client",
+    "migration:create": "node ../../node_modules/typeorm/cli.js migration:create -d ./server/migrations"
+  },
+  "dependencies": {
+    "@operato/contact": "^1.0.0",
+    "@operato/graphql": "^1.0.0",
+    "@operato/shell": "^1.0.0",
+    "@things-factory/attachment-base": "^6.0.0-zeta.20",
+    "@things-factory/auth-base": "^6.0.0-zeta.20",
+    "@things-factory/shell": "^6.0.0-zeta.20"
+  },
+  "gitHead": "9ab942f1cb40dbe717e01b1b57bbacc8501a65ca"
+}

package/server/index.ts

@@ -0,0 +1,4 @@
+export * from './migrations'
+export * from './middlewares'
+
+import './routes'

package/server/middlewares/index.ts

@@ -0,0 +1,3 @@
+export function initMiddlewares(app) {
+  /* can add middlewares into app */
+}

package/server/migrations/index.ts

@@ -0,0 +1,9 @@
+const glob = require('glob')
+const path = require('path')
+
+export var migrations = []
+
+glob.sync(path.resolve(__dirname, '.', '**', '*.js')).forEach(function(file) {
+  if (file.indexOf('index.js') !== -1) return
+  migrations = migrations.concat(Object.values(require(path.resolve(file))) || [])
+})

package/server/routes.ts

@@ -0,0 +1,28 @@
+const debug = require('debug')('things-factory:contact:routes')
+
+process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRouter) => {
+  /*
+   * can add global public routes to application (auth not required, tenancy not required)
+   *
+   * ex) routes.get('/path', async(context, next) => {})
+   * ex) routes.post('/path', async(context, next) => {})
+   */
+})
+
+process.on('bootstrap-module-global-private-route' as any, (app, globalPrivateRouter) => {
+  /*
+   * can add global private routes to application (auth required, tenancy not required)
+   */
+})
+
+process.on('bootstrap-module-domain-public-route' as any, (app, domainPublicRouter) => {
+  /*
+   * can add domain public routes to application (auth not required, tenancy required)
+   */
+})
+
+process.on('bootstrap-module-domain-private-route' as any, (app, domainPrivateRouter) => {
+  /*
+   * can add domain private routes to application (auth required, tenancy required)
+   */
+})

package/server/service/contact/contact-item.ts

@@ -0,0 +1,31 @@
+import { Column, Entity, PrimaryGeneratedColumn, ManyToOne, RelationId } from 'typeorm'
+import { ObjectType, Field, Int, ID, registerEnumType } from 'type-graphql'
+
+import { Contact, ContactField } from './contact'
+
+@Entity()
+@ObjectType({ description: 'Entity for ContactItem' })
+export class ContactItem {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+
+  @Column()
+  @Field()
+  label: string
+
+  @Column()
+  @Field()
+  type: ContactField
+
+  @Column()
+  @Field()
+  value: string
+
+  @ManyToOne(type => Contact, contact => contact.items)
+  @Field()
+  contact: Contact
+
+  @RelationId((item: ContactItem) => item.contact)
+  contactId: string
+}

package/server/service/contact/contact-mutation.ts

@@ -0,0 +1,195 @@
+import { Resolver, Mutation, Arg, Ctx, Directive } from 'type-graphql'
+import { In } from 'typeorm'
+
+import { createAttachment, deleteAttachmentsByRef } from '@things-factory/attachment-base'
+
+import { Contact } from './contact'
+import { NewContact, ContactPatch } from './contact-type'
+
+@Resolver(Contact)
+export class ContactMutation {
+  @Directive('@transaction')
+  @Mutation(returns => Contact, { description: 'To create new Contact' })
+  async createContact(@Arg('contact') contact: NewContact, @Ctx() context: ResolverContext): Promise<Contact> {
+    const { domain, user, tx } = context.state
+
+    const result = await tx.getRepository(Contact).save({
+      ...contact,
+      domain,
+      creator: user,
+      updater: user
+    })
+
+    if (contact.thumbnail) {
+      await createAttachment(
+        null,
+        {
+          attachment: {
+            file: contact.thumbnail,
+            refType: Contact.name,
+            refBy: result.id
+          }
+        },
+        context
+      )
+    }
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Contact, { description: 'To modify Contact information' })
+  async updateContact(
+    @Arg('id') id: string,
+    @Arg('patch') patch: ContactPatch,
+    @Ctx() context: ResolverContext
+  ): Promise<Contact> {
+    const { domain, user, tx } = context.state
+
+    const repository = tx.getRepository(Contact)
+    const contact = await repository.findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+
+    const result = await repository.save({
+      ...contact,
+      ...patch,
+      updater: user
+    })
+
+    if (patch.thumbnail) {
+      await deleteAttachmentsByRef(null, { refBys: [result.id] }, context)
+      await createAttachment(
+        null,
+        {
+          attachment: {
+            file: patch.thumbnail,
+            refType: Contact.name,
+            refBy: result.id
+          }
+        },
+        context
+      )
+    }
+
+    return result
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => [Contact], { description: "To modify multiple Contacts' information" })
+  async updateMultipleContact(
+    @Arg('patches', type => [ContactPatch]) patches: ContactPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<Contact[]> {
+    const { domain, user, tx } = context.state
+
+    let results = []
+    const _createRecords = patches.filter((patch: any) => patch.cuFlag.toUpperCase() === '+')
+    const _updateRecords = patches.filter((patch: any) => patch.cuFlag.toUpperCase() === 'M')
+    const contactRepo = tx.getRepository(Contact)
+
+    if (_createRecords.length > 0) {
+      for (let i = 0; i < _createRecords.length; i++) {
+        const newRecord = _createRecords[i]
+
+        const result = await contactRepo.save({
+          ...newRecord,
+          domain,
+          creator: user,
+          updater: user
+        })
+
+        if (newRecord.thumbnail) {
+          await createAttachment(
+            null,
+            {
+              attachment: {
+                file: newRecord.thumbnail,
+                refType: Contact.name,
+                refBy: result.id
+              }
+            },
+            context
+          )
+        }
+
+        results.push({ ...result, cuFlag: '+' })
+      }
+    }
+
+    if (_updateRecords.length > 0) {
+      for (let i = 0; i < _updateRecords.length; i++) {
+        const updateRecord = _updateRecords[i]
+        const contact = await contactRepo.findOneBy({ id: updateRecord.id })
+
+        const result = await contactRepo.save({
+          ...contact,
+          ...updateRecord,
+          updater: user
+        })
+
+        if (updateRecord.thumbnail) {
+          await deleteAttachmentsByRef(null, { refBys: [result.id] }, context)
+          await createAttachment(
+            null,
+            {
+              attachment: {
+                file: updateRecord.thumbnail,
+                refType: Contact.name,
+                refBy: result.id
+              }
+            },
+            context
+          )
+        }
+
+        results.push({ ...result, cuFlag: 'M' })
+      }
+    }
+
+    return results
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete Contact' })
+  async deleteContact(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await tx.getRepository(Contact).delete({ domain: { id: domain.id }, id })
+    await deleteAttachmentsByRef(null, { refBys: [id] }, context)
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete multiple Contacts' })
+  async deleteContacts(@Arg('ids', type => [String]) ids: string[], @Ctx() context: ResolverContext): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await tx.getRepository(Contact).delete({
+      domain: { id: domain.id },
+      id: In(ids)
+    })
+
+    await deleteAttachmentsByRef(null, { refBys: ids }, context)
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To import multiple Contacts' })
+  async importContacts(
+    @Arg('contacts', type => [ContactPatch]) contacts: ContactPatch[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await Promise.all(
+      contacts.map(async (contact: ContactPatch) => {
+        const createdContact: Contact = await tx.getRepository(Contact).save({ domain, ...contact })
+      })
+    )
+
+    return true
+  }
+}

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

@@ -0,0 +1,59 @@
+import { Resolver, Query, FieldResolver, Root, Args, Arg, Ctx, Directive } from 'type-graphql'
+import { Domain, getQueryBuilderFromListParams, getRepository, ListParam } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
+import { Contact } from './contact'
+import { ContactItem } from './contact-item'
+import { ContactList } from './contact-type'
+
+@Resolver(Contact)
+export class ContactQuery {
+  @Query(returns => Contact!, { nullable: true, description: 'To fetch a Contact' })
+  async contact(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<Contact> {
+    const { domain } = context.state
+
+    return await getRepository(Contact).findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+  }
+
+  @Query(returns => ContactList, { description: 'To fetch multiple Contacts' })
+  async contacts(@Args() params: ListParam, @Ctx() context: ResolverContext): Promise<ContactList> {
+    const { domain } = context.state
+
+    const queryBuilder = getQueryBuilderFromListParams({
+      domain,
+      params,
+      repository: await getRepository(ContactItem),
+      searchables: ['value']
+    })
+
+    /**
+     * Contact의 domain이 해당되는 범위에서 ContactItem의 value를 검색한다.
+     * 그런 후에 distinct 한 contact 들을 리턴한다.
+     */
+
+    const [items, total] = await queryBuilder.getManyAndCount()
+
+    return { items, total }
+  }
+
+  @FieldResolver(type => [ContactItem])
+  async items(@Root() contact: Contact): Promise<ContactItem[]> {
+    return await getRepository(ContactItem).findBy({ contact: { id: contact.id } })
+  }
+
+  @FieldResolver(type => Domain)
+  async domain(@Root() contact: Contact): Promise<Domain> {
+    return await getRepository(Domain).findOneBy({ id: contact.domainId })
+  }
+
+  @FieldResolver(type => User)
+  async updater(@Root() contact: Contact): Promise<User> {
+    return await getRepository(User).findOneBy({ id: contact.updaterId })
+  }
+
+  @FieldResolver(type => User)
+  async creator(@Root() contact: Contact): Promise<User> {
+    return await getRepository(User).findOneBy({ id: contact.creatorId })
+  }
+}

package/server/service/contact/contact-type.ts

@@ -0,0 +1,35 @@
+import type { FileUpload } from 'graphql-upload/GraphQLUpload.js'
+import GraphQLUpload from 'graphql-upload/GraphQLUpload.js'
+import { ObjectType, Field, InputType, Int, ID, registerEnumType } from 'type-graphql'
+
+import { ObjectRef, ScalarObject } from '@things-factory/shell'
+
+import { Contact } from './contact'
+import { ContactItem } from './contact-item'
+
+@InputType()
+export class NewContact {
+  @Field(type => GraphQLUpload, { nullable: true })
+  thumbnail?: FileUpload
+}
+
+@InputType()
+export class ContactPatch {
+  @Field(type => ID, { nullable: true })
+  id?: string
+
+  @Field(type => GraphQLUpload, { nullable: true })
+  thumbnail?: FileUpload
+
+  @Field({ nullable: true })
+  cuFlag?: string
+}
+
+@ObjectType()
+export class ContactList {
+  @Field(type => [Contact])
+  items: Contact[]
+
+  @Field(type => Int)
+  total: number
+}

package/server/service/contact/contact.ts

@@ -0,0 +1,89 @@
+import {
+  CreateDateColumn,
+  UpdateDateColumn,
+  DeleteDateColumn,
+  Entity,
+  Index,
+  Column,
+  RelationId,
+  ManyToOne,
+  OneToMany,
+  PrimaryGeneratedColumn
+} from 'typeorm'
+import { ObjectType, Field, Int, ID, registerEnumType } from 'type-graphql'
+
+import { Domain } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
+
+import { ContactItem } from './contact-item'
+
+export enum ContactField {
+  Name = 'name',
+  JobTitle = 'job-title',
+  Phone = 'phone',
+  Address = 'address',
+  Email = 'email',
+  Birthday = 'birthday',
+  Profile = 'profile',
+  Picture = 'picture',
+  Department = 'department',
+  Company = 'company',
+  Homepage = 'homepage'
+}
+
+registerEnumType(ContactField, {
+  name: 'ContactField',
+  description: 'field enumeration of a contact'
+})
+
+@Entity()
+@ObjectType({ description: 'Entity for Contact' })
+export class Contact {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+
+  @ManyToOne(type => Domain)
+  @Field({ nullable: true })
+  domain?: Domain
+
+  @RelationId((contact: Contact) => contact.domain)
+  domainId?: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  note?: string
+
+  @OneToMany(type => ContactItem, contactItem => contactItem.contact)
+  @Field(type => [ContactItem])
+  items?: ContactItem[]
+
+  @CreateDateColumn()
+  @Field({ nullable: true })
+  createdAt?: Date
+
+  @UpdateDateColumn()
+  @Field({ nullable: true })
+  updatedAt?: Date
+
+  @DeleteDateColumn()
+  @Field({ nullable: true })
+  deletedAt?: Date
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field({ nullable: true })
+  creator?: User
+
+  @RelationId((contact: Contact) => contact.creator)
+  creatorId?: string
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field({ nullable: true })
+  updater?: User
+
+  @RelationId((contact: Contact) => contact.updater)
+  updaterId?: string
+
+  @Field(type => String, { nullable: true })
+  thumbnail?: string
+}

package/server/service/contact/index.ts

@@ -0,0 +1,7 @@
+import { Contact } from './contact'
+import { ContactItem } from './contact-item'
+import { ContactQuery } from './contact-query'
+import { ContactMutation } from './contact-mutation'
+
+export const entities = [Contact, ContactItem]
+export const resolvers = [ContactQuery, ContactMutation]

package/server/service/index.ts

@@ -0,0 +1,22 @@
+/* EXPORT ENTITY TYPES */
+export * from './contact/contact-item'
+export * from './contact/contact'
+
+/* IMPORT ENTITIES AND RESOLVERS */
+import { entities as ContactEntities, resolvers as ContactResolvers } from './contact'
+
+export const entities = [
+  /* ENTITIES */
+  ...ContactEntities
+]
+
+export const subscribers = [
+  /* SUBSCRIBERS */
+]
+
+export const schema = {
+  resolverClasses: [
+    /* RESOLVER CLASSES */
+    ...ContactResolvers
+  ]
+}