@things-factory/personalization 7.0.0

package/helps/personalization/screen-preference.md

@@ -0,0 +1,160 @@
+# PagePreference
+
+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,39 @@
+{
+  "name": "@things-factory/personalization",
+  "version": "7.0.0",
+  "main": "dist-server/index.js",
+  "browser": "dist-client/index.js",
+  "things-factory": true,
+  "license": "MIT",
+  "author": "heartyoh <heartyoh@hatiolab.com>",
+  "description": "A personalization module designed to support user preferences in the UI",
+  "publishConfig": {
+    "access": "public",
+    "@things-factory:registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hatiolab/things-factory.git",
+    "directory": "packages/personalization"
+  },
+  "scripts": {
+    "build": "npm run build:server && npm run build:client",
+    "copy:files": "copyfiles -e \"./client/**/*.{ts,js,json}\" -u 1 \"./client/**/*\" dist-client",
+    "build:client": "npm run copy:files && 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/data-grist": "^7.0.0",
+    "@operato/graphql": "^7.0.0",
+    "@operato/i18n": "^7.0.0",
+    "@operato/shell": "^7.0.0",
+    "@operato/styles": "^7.0.0",
+    "@things-factory/auth-base": "^7.0.0",
+    "@things-factory/shell": "^7.0.0"
+  },
+  "gitHead": "00f3917ca132679e3571f3f4fd16f4caf84f488e"
+}

package/server/index.ts

@@ -0,0 +1,3 @@
+export * from './service'
+
+import './routes'

package/server/routes.ts

@@ -0,0 +1,28 @@
+const debug = require('debug')('things-factory:personalization: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/index.ts

@@ -0,0 +1,30 @@
+/* EXPORT ENTITY TYPES */
+export * from './user-preference/user-preference'
+export * from './page-preference/page-preference'
+
+/* IMPORT ENTITIES AND RESOLVERS */
+import {
+  entities as UserPreferenceEntities,
+  resolvers as UserPreferenceResolvers,
+  subscribers as UserPreferenceSubscribers
+} from './user-preference'
+import { entities as PagePreferenceEntities, resolvers as PagePreferenceResolvers } from './page-preference'
+
+export const entities = [
+  /* ENTITIES */
+  ...UserPreferenceEntities,
+  ...PagePreferenceEntities
+]
+
+export const subscribers = [
+  /* SUBSCRIBERS */
+  ...UserPreferenceSubscribers
+]
+
+export const schema = {
+  resolverClasses: [
+    /* RESOLVER CLASSES */
+    ...UserPreferenceResolvers,
+    ...PagePreferenceResolvers
+  ]
+}

package/server/service/page-preference/index.ts

@@ -0,0 +1,6 @@
+import { PagePreference } from './page-preference'
+import { PagePreferenceQuery } from './page-preference-query'
+import { PagePreferenceMutation } from './page-preference-mutation'
+
+export const entities = [PagePreference]
+export const resolvers = [PagePreferenceQuery, PagePreferenceMutation]

package/server/service/page-preference/page-preference-mutation.ts

@@ -0,0 +1,101 @@
+import { Resolver, Mutation, Arg, Ctx, Directive } from 'type-graphql'
+import { In } from 'typeorm'
+
+import { ScalarObject } from '@things-factory/shell'
+
+import { PagePreference } from './page-preference'
+import { NewPagePreference, PagePreferencePatch } from './page-preference-type'
+
+@Resolver(PagePreference)
+export class PagePreferenceMutation {
+  @Directive('@transaction')
+  @Mutation(returns => PagePreference, { description: 'To create my new PagePreference' })
+  async createMyPagePreference(
+    @Arg('pagePreference') pagePreference: NewPagePreference,
+    @Ctx() context: ResolverContext
+  ): Promise<PagePreference> {
+    const { domain, user, tx } = context.state
+
+    return await tx.getRepository(PagePreference).save({
+      ...pagePreference,
+      domain,
+      creator: user,
+      updater: user
+    })
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => PagePreference, { description: 'To create or update my PagePreference' })
+  async updateMyPagePreference(
+    @Arg('page') page: string,
+    @Arg('element') element: string,
+    @Arg('preference', type => ScalarObject) preference: { [key: string]: any },
+    @Ctx() context: any
+  ): Promise<PagePreference> {
+    const { domain, user, tx } = context.state
+
+    if (!page || !element) {
+      throw 'page and element are required.'
+    }
+
+    const pagePreference = await tx.getRepository(PagePreference).findOne({
+      where: { domain: { id: domain.id }, user: { id: user.id }, page, element }
+    })
+
+    return await tx.getRepository(PagePreference).save({
+      ...pagePreference,
+      domain,
+      user,
+      page,
+      element,
+      preference,
+      creator: user,
+      updater: user
+    })
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete my PagePreference' })
+  async deleteMyPagePreference(
+    @Arg('page') page: string,
+    @Arg('element') element: string,
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, user, tx } = context.state
+
+    await tx.getRepository(PagePreference).delete({
+      domain: { id: domain.id },
+      user: { id: user.id },
+      page,
+      element
+    })
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete PagePreference' })
+  async deletePagePreference(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await tx.getRepository(PagePreference).delete({ domain: { id: domain.id }, id })
+
+    return true
+  }
+
+  @Directive('@transaction')
+  @Mutation(returns => Boolean, { description: 'To delete multiple PagePreferences' })
+  async deletePagePreferences(
+    @Arg('ids', type => [String]) ids: string[],
+    @Ctx() context: ResolverContext
+  ): Promise<boolean> {
+    const { domain, tx } = context.state
+
+    await tx.getRepository(PagePreference).delete({
+      domain: { id: domain.id },
+      id: In(ids)
+    })
+
+    return true
+  }
+}

package/server/service/page-preference/page-preference-query.ts

@@ -0,0 +1,73 @@
+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 { PagePreference } from './page-preference'
+import { PagePreferenceList } from './page-preference-type'
+
+@Resolver(PagePreference)
+export class PagePreferenceQuery {
+  @Query(returns => PagePreference!, { nullable: true, description: 'To fetch a PagePreference' })
+  async pagePreference(@Arg('id') id: string, @Ctx() context: ResolverContext): Promise<PagePreference> {
+    const { domain } = context.state
+
+    return await getRepository(PagePreference).findOne({
+      where: { domain: { id: domain.id }, id }
+    })
+  }
+
+  @Query(returns => PagePreference, { nullable: true, description: `To fetch a User's own PagePreference` })
+  async myPagePreference(
+    @Arg('page') page: string,
+    @Arg('element') element: string,
+    @Ctx() context: any
+  ): Promise<PagePreference> {
+    const { domain, user } = context.state
+
+    return await getRepository(PagePreference).findOne({
+      where: { domain: { id: domain.id }, user: { id: user.id }, page, element }
+    })
+  }
+
+  @Query(returns => [PagePreference], { nullable: true, description: `To fetch a User's own PagePreference` })
+  async myPageAllPreferences(@Arg('page') page: string, @Ctx() context: any): Promise<PagePreference[]> {
+    const { domain, user } = context.state
+
+    return await getRepository(PagePreference).find({
+      where: { domain: { id: domain.id }, user: { id: user.id }, page }
+    })
+  }
+
+  @Query(returns => PagePreferenceList, { description: 'To fetch multiple PagePreferences' })
+  async myPagePreferences(
+    @Args(type => ListParam) params: ListParam,
+    @Ctx() context: ResolverContext
+  ): Promise<PagePreferenceList> {
+    const { domain, user } = context.state
+
+    const queryBuilder = getQueryBuilderFromListParams({
+      domain,
+      params,
+      repository: await getRepository(PagePreference),
+      searchables: ['page']
+    }).andWhere({ user: { id: user.id } })
+
+    const [items, total] = await queryBuilder.getManyAndCount()
+
+    return { items, total }
+  }
+
+  @FieldResolver(type => Domain)
+  async domain(@Root() pagePreference: PagePreference): Promise<Domain> {
+    return pagePreference.domainId && (await getRepository(Domain).findOneBy({ id: pagePreference.domainId }))
+  }
+
+  @FieldResolver(type => User)
+  async updater(@Root() pagePreference: PagePreference): Promise<User> {
+    return pagePreference.updaterId && (await getRepository(User).findOneBy({ id: pagePreference.updaterId }))
+  }
+
+  @FieldResolver(type => User)
+  async creator(@Root() pagePreference: PagePreference): Promise<User> {
+    return pagePreference.creatorId && (await getRepository(User).findOneBy({ id: pagePreference.creatorId }))
+  }
+}

package/server/service/page-preference/page-preference-type.ts

@@ -0,0 +1,50 @@
+import { ObjectType, Field, InputType, Int, ID } from 'type-graphql'
+
+import { ObjectRef, ScalarObject } from '@things-factory/shell'
+
+import { PagePreference } from './page-preference'
+
+@InputType()
+export class NewPagePreference {
+  @Field(type => ObjectRef)
+  user: ObjectRef
+
+  @Field({ nullable: true })
+  page?: string
+
+  @Field({ nullable: true })
+  element?: string
+
+  @Field(type => ScalarObject, { nullable: false })
+  preference: { [key: string]: any }
+}
+
+@InputType()
+export class PagePreferencePatch {
+  @Field(type => ID, { nullable: true })
+  id?: string
+
+  @Field(type => ObjectRef)
+  user: ObjectRef
+
+  @Field({ nullable: true })
+  page?: string
+
+  @Field({ nullable: true })
+  element?: string
+
+  @Field(type => ScalarObject, { nullable: false })
+  preference: { [key: string]: any }
+
+  @Field()
+  cuFlag: string
+}
+
+@ObjectType()
+export class PagePreferenceList {
+  @Field(type => [PagePreference])
+  items: PagePreference[]
+
+  @Field(type => Int)
+  total: number
+}

package/server/service/page-preference/page-preference.ts

@@ -0,0 +1,82 @@
+import {
+  CreateDateColumn,
+  UpdateDateColumn,
+  Entity,
+  Index,
+  Column,
+  RelationId,
+  ManyToOne,
+  PrimaryGeneratedColumn
+} from 'typeorm'
+import { ObjectType, Field, ID } from 'type-graphql'
+
+import { Domain, ScalarObject } from '@things-factory/shell'
+import { User } from '@things-factory/auth-base'
+
+@Entity()
+@Index(
+  'ix_page_preference_0',
+  (pagePreference: PagePreference) => [
+    pagePreference.domain,
+    pagePreference.user,
+    pagePreference.page,
+    pagePreference.element
+  ],
+  {
+    unique: true
+  }
+)
+@ObjectType({ description: 'Entity for PagePreference' })
+export class PagePreference {
+  @PrimaryGeneratedColumn('uuid')
+  @Field(type => ID)
+  readonly id: string
+
+  @ManyToOne(type => Domain)
+  @Field(type => Domain)
+  domain?: Domain
+
+  @RelationId((pagePreference: PagePreference) => pagePreference.domain)
+  domainId?: string
+
+  @ManyToOne(type => User)
+  @Field({ nullable: false })
+  user: User
+
+  @RelationId((pagePreference: PagePreference) => pagePreference.user)
+  userId: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  page: string
+
+  @Column({ nullable: true })
+  @Field({ nullable: true })
+  element: string
+
+  @Column('simple-json', { nullable: true })
+  @Field(type => ScalarObject, { nullable: true })
+  preference?: { [key: string]: any }
+
+  @CreateDateColumn()
+  @Field({ nullable: true })
+  createdAt?: Date
+
+  @UpdateDateColumn()
+  @Field({ nullable: true })
+  updatedAt?: Date
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field(type => User, { nullable: true })
+  creator?: User
+
+  @RelationId((pagePreference: PagePreference) => pagePreference.creator)
+  creatorId?: string
+
+  @ManyToOne(type => User, { nullable: true })
+  @Field(type => User, { nullable: true })
+  updater?: User
+
+  @RelationId((pagePreference: PagePreference) => pagePreference.updater)
+  updaterId?: string
+}

package/server/service/user-preference/index.ts

@@ -0,0 +1,7 @@
+import { UserPreference } from './user-preference'
+import { UserPreferenceQuery } from './user-preference-query'
+import { UserPreferenceMutation } from './user-preference-mutation'
+
+export const entities = [UserPreference]
+export const resolvers = [UserPreferenceQuery, UserPreferenceMutation]
+export const subscribers = []