@things-factory/figure-service 10.1.159 → 10.1.161

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/figure-service",
-  "version": "10.1.159",
+  "version": "10.1.161",
   "publishConfig": {
     "access": "public",
     "@things-factory:registry": "https://registry.npmjs.org"
@@ -38,5 +38,5 @@
     "jszip": "^3.10.1",
     "koa-router": "^7.4.0"
   },
-  "gitHead": "fc15cdcb18e562ca1e723a1e1bf042f9582cbbfb"
+  "gitHead": "d32fe0614ea40572787acd94e307cc18a681ab38"
 }

package/server/service/figure/figure-namespace-db.test.ts

@@ -130,6 +130,35 @@ describe('the namespace a figure is created under', () => {
   })
 })
 
+describe('the namespace setting, as the setting screen reads and writes it', () => {
+  const resolver = () => new (loadCompiled('service/figure/figure-namespace-resolver').FigureNamespaceResolver)()
+
+  it('reads the subdomain when nothing is written, and is not fixed before a figure is made', async () => {
+    const { domain, context } = await domainWith(null)
+    expect(await resolver().figureNamespace(context)).toEqual({ namespace: domain.subdomain, written: '', subdomain: domain.subdomain, fixed: false })
+  })
+
+  it('writes a namespace, and empty goes back to the subdomain; a new figure takes what it says', async () => {
+    const { domain, context } = await domainWith(null)
+    expect(await resolver().setFigureNamespace('  hatiolab.com ', context)).toMatchObject({ namespace: 'hatiolab.com', written: 'hatiolab.com', fixed: false })
+    expect(await resolver().setFigureNamespace('', context)).toMatchObject({ namespace: domain.subdomain, written: '', fixed: false })
+    await resolver().setFigureNamespace('hatiolab.com', context)
+    const figure = await new FigureMutation().saveFigure(releasable(), context, undefined, undefined, creationId(), undefined, 'conveyor')
+    expect(figure.namespace).toBe('hatiolab.com')
+    expect(await resolver().figureNamespace(context)).toMatchObject({ namespace: 'hatiolab.com', fixed: true })
+  })
+
+  it('refuses what is not a namespace, and another namespace once figures carry one; the setting is left as it was', async () => {
+    const { context } = await domainWith('hatiolab.com')
+    await expect(resolver().setFigureNamespace('Hatiolab.COM', context)).rejects.toMatchObject({ code: 'figure-namespace-invalid' })
+    await new FigureMutation().saveFigure(releasable(), context, undefined, undefined, creationId(), undefined, 'conveyor')
+    await expect(resolver().setFigureNamespace('other.com', context)).rejects.toMatchObject({ code: 'figure-namespace-changed' })
+    expect(await resolver().figureNamespace(context)).toMatchObject({ namespace: 'hatiolab.com', written: 'hatiolab.com', fixed: true })
+    /* The same one again is not a change. */
+    await expect(resolver().setFigureNamespace('hatiolab.com', context)).resolves.toMatchObject({ namespace: 'hatiolab.com' })
+  })
+})
+
 describe('figureBlueprints answers each full name, an item or a refusal', () => {
   it('gives released figures by full name and refuses the rest by cause, none taking another away', async () => {
     const { context } = await domainWith('hatiolab.com')

package/server/service/figure/figure-namespace-resolver.ts

@@ -0,0 +1,41 @@
+import { Arg, Ctx, Directive, Field, Mutation, ObjectType, Query, Resolver, UseMiddleware } from 'type-graphql'
+
+import { getDataSource, SpeakRefusals } from '@things-factory/shell'
+
+import { figureNamespaceStateOf, setFigureNamespace } from './figure-namespace.js'
+
+@ObjectType({ description: "A domain's figure namespace, as the setting screen shows it (ADR-0114)." })
+export class FigureNamespace {
+  @Field({ nullable: true, description: 'The namespace new figures are created under; null when neither the setting nor the subdomain is one.' })
+  namespace?: string
+
+  @Field({ description: 'The figure-namespace setting as written; empty when the subdomain is used.' })
+  written: string
+
+  @Field({ description: "The domain's subdomain, used when the setting is empty." })
+  subdomain: string
+
+  @Field({ description: "True once the domain's figures carry the namespace: it cannot be set any more." })
+  fixed: boolean
+}
+
+@Resolver()
+@UseMiddleware(SpeakRefusals)
+export class FigureNamespaceResolver {
+  @Directive('@privilege(category: "figure", privilege: "query", domainOwnerGranted: true)')
+  @Query(returns => FigureNamespace, { description: "The domain's figure namespace and whether it can still be set." })
+  async figureNamespace(@Ctx() context: ResolverContext): Promise<FigureNamespace> {
+    const { domain, tx } = context.state
+    return (await figureNamespaceStateOf(tx ?? getDataSource().manager, domain)) as FigureNamespace
+  }
+
+  @Directive('@transaction')
+  @Directive('@privilege(category: "setting", privilege: "mutation", domainOwnerGranted: true)')
+  @Mutation(returns => FigureNamespace, {
+    description: "Sets the domain's figure namespace. Empty takes the subdomain. Refused when it is not a namespace, or when the domain's figures already carry another."
+  })
+  async setFigureNamespace(@Arg('namespace') namespace: string, @Ctx() context: ResolverContext): Promise<FigureNamespace> {
+    const { domain, tx } = context.state
+    return (await setFigureNamespace(tx, domain, namespace)) as FigureNamespace
+  }
+}

package/server/service/figure/figure-namespace.ts

@@ -1,4 +1,4 @@
-import { EntityManager, Not } from 'typeorm'
+import { EntityManager, IsNull, Not } from 'typeorm'
 
 import { isFigureNamespace } from '@hatiolab/figure-model'
 import { Domain, Refusal } from '@things-factory/shell'
@@ -19,11 +19,7 @@ export const FIGURE_NAMESPACE_SETTING = 'figure-namespace'
  * from the namespace this domain's figures already carry is refused, so editing the setting cannot rename anything.
  */
 export async function namespaceForNewFigure(tx: EntityManager, domain: Domain): Promise<string> {
-  const setting = await tx.getRepository(Setting).findOne({
-    where: { domain: { id: domain.id }, name: FIGURE_NAMESPACE_SETTING }
-  })
-  const written = setting?.value?.trim() ?? ''
-  const namespace = written || (domain.subdomain ?? '').trim()
+  const namespace = await chosenNamespace(tx, domain)
   if (!isFigureNamespace(namespace)) {
     throw new Refusal(
       'figure-namespace-missing',
@@ -60,3 +56,60 @@ export function namespaceOf(figure: Figure): string {
   }
   return figure.namespace
 }
+
+/** What the setting says, or the subdomain when it says nothing: the namespace new figures are created under. */
+async function chosenNamespace(tx: EntityManager, domain: Domain): Promise<string> {
+  return (await writtenNamespace(tx, domain)) || (domain.subdomain ?? '').trim()
+}
+
+async function writtenNamespace(tx: EntityManager, domain: Domain): Promise<string> {
+  const setting = await tx.getRepository(Setting).findOne({
+    where: { domain: { id: domain.id }, name: FIGURE_NAMESPACE_SETTING }
+  })
+  return setting?.value?.trim() ?? ''
+}
+
+/** A domain's figure namespace as the setting screen shows it. */
+export interface FigureNamespaceState {
+  /** What new figures get, or null when neither the setting nor the subdomain is a namespace. */
+  namespace: string | null
+  /** The setting as written; empty when the subdomain is used. */
+  written: string
+  subdomain: string
+  /** The domain's figures already carry the namespace, so it cannot be set any more. */
+  fixed: boolean
+}
+
+export async function figureNamespaceStateOf(tx: EntityManager, domain: Domain): Promise<FigureNamespaceState> {
+  const written = await writtenNamespace(tx, domain)
+  const subdomain = (domain.subdomain ?? '').trim()
+  const carried = await tx.getRepository(Figure).findOne({ where: { domain: { id: domain.id }, namespace: Not(IsNull()) } })
+  const chosen = written || subdomain
+  return {
+    namespace: carried?.namespace ?? (isFigureNamespace(chosen) ? chosen : null),
+    written,
+    subdomain,
+    fixed: !!carried?.namespace
+  }
+}
+
+/**
+ * Writes the domain's figure namespace (ADR-0114). Empty takes the subdomain. Refused when the value, or the subdomain
+ * it falls back to, is not a namespace, and when the domain's figures already carry another one.
+ */
+export async function setFigureNamespace(tx: EntityManager, domain: Domain, value: string): Promise<FigureNamespaceState> {
+  const written = value.trim()
+  const namespace = written || (domain.subdomain ?? '').trim()
+  if (!isFigureNamespace(namespace)) {
+    throw new Refusal(
+      'figure-namespace-invalid',
+      { value: namespace },
+      '{value} is not a figure namespace. use lower-case letters, digits, dots and hyphens, for example hatiolab.com.'
+    )
+  }
+  await assertNamespaceUnchanged(tx, domain, namespace)
+  const repository = tx.getRepository(Setting)
+  const setting = await repository.findOne({ where: { domain: { id: domain.id }, name: FIGURE_NAMESPACE_SETTING } })
+  await repository.save({ ...setting, domain, name: FIGURE_NAMESPACE_SETTING, category: 'figure', value: written })
+  return figureNamespaceStateOf(tx, domain)
+}

package/server/service/figure/index.ts

@@ -4,8 +4,9 @@ import { FigureReplacedDraft } from './figure-replaced-draft.js'
 import { FigureProposalRecord } from './figure-proposal-record.js'
 import { FigureQuery } from './figure-query.js'
 import { FigureMutation } from './figure-mutation.js'
+import { FigureNamespaceResolver } from './figure-namespace-resolver.js'
 import { FigureHistoryEntitySubscriber } from './event-subscriber.js'
 
 export const entities = [Figure, FigureHistory, FigureReplacedDraft, FigureProposalRecord]
-export const resolvers = [FigureQuery, FigureMutation]
+export const resolvers = [FigureQuery, FigureMutation, FigureNamespaceResolver]
 export const subscribers = [FigureHistoryEntitySubscriber]

package/translations/en.json

@@ -100,6 +100,7 @@
   "figure.gate.origin-off-centre.how": "Keep it when the figure is fastened there, as a door at its hinge. Move the origin to the middle to place it by its room.",
   "error.figure-namespace-missing": "this domain has no valid figure namespace ({value}). set {setting} first, for example hatiolab.com.",
   "error.figure-namespace-changed": "the figure namespace of this domain is {namespace} and cannot change. set {setting} back to {namespace}.",
+  "error.figure-namespace-invalid": "{value} is not a figure namespace. use lower-case letters, digits, dots and hyphens, for example hatiolab.com.",
   "error.figure-type-malformed": "{type} is not a figure type. use lower-case letters, digits and single hyphens, {min} to {max} characters, starting with a letter.",
   "error.figure-name-malformed": "{type} is not a full figure name of the form namespace/type.",
   "error.figure-not-released": "no release is published here.",

package/translations/es.json

@@ -100,6 +100,7 @@
   "figure.gate.origin-off-centre.how": "Manténgalo si la figura se fija en ese punto, como una puerta por su bisagra. Mueva el origen al centro para colocarla por su espacio.",
   "error.figure-namespace-missing": "este dominio no tiene un namespace de figura válido ({value}). Defina primero {setting}, por ejemplo hatiolab.com.",
   "error.figure-namespace-changed": "el namespace de figura de este dominio es {namespace} y no se puede cambiar. Restablezca {setting} a {namespace}.",
+  "error.figure-namespace-invalid": "{value} no es un namespace de Figure. Use minúsculas, dígitos, puntos y guiones, por ejemplo hatiolab.com.",
   "error.figure-type-malformed": "{type} no es un tipo de figura. Use letras minúsculas, dígitos y guiones simples, de {min} a {max} caracteres, empezando por una letra.",
   "error.figure-name-malformed": "{type} no es un nombre completo de figura con el formato namespace/type.",
   "error.figure-not-released": "aquí no hay ninguna publicación.",

package/translations/ja.json

@@ -100,6 +100,7 @@
   "figure.gate.origin-off-centre.how": "ドアの蝶番のように、Figure をそこで取り付ける場合はそのままにしてください。空間の中央で配置するには、原点を中央に移動してください。",
   "error.figure-namespace-missing": "このドメインには有効な Figure namespace がありません({value})。先に {setting} を設定してください。例: hatiolab.com。",
   "error.figure-namespace-changed": "このドメインの Figure namespace は {namespace} で、変更できません。{setting} を {namespace} に戻してください。",
+  "error.figure-namespace-invalid": "Figure namespace の形式ではありません({value})。英小文字・数字・ドット・ハイフンで入力してください。例: hatiolab.com",
   "error.figure-type-malformed": "{type} は Figure type ではありません。英小文字で始め、英小文字・数字・単一のハイフンのみを使って {min}〜{max} 文字で指定してください。",
   "error.figure-name-malformed": "{type} は namespace/type 形式の正式な Figure 名ではありません。",
   "error.figure-not-released": "ここではリリースが公開されていません。",

package/translations/ko.json

@@ -100,6 +100,7 @@
   "figure.gate.origin-off-centre.how": "문의 경첩처럼 붙이는 자리라면 그대로 둡니다. 공간 가운데로 놓이게 하려면 원점을 가운데로 옮깁니다.",
   "error.figure-namespace-missing": "이 도메인에 Figure namespace 가 없거나 형식이 맞지 않습니다({value}). 설정 {setting} 에 예를 들어 hatiolab.com 을 먼저 넣어 주세요.",
   "error.figure-namespace-changed": "이 도메인의 Figure namespace 는 {namespace} 이며 바꿀 수 없습니다. 설정 {setting} 을 {namespace} 로 되돌려 주세요.",
+  "error.figure-namespace-invalid": "Figure namespace 형식이 아닙니다({value}). 영문 소문자·숫자·점·하이픈으로 적어 주세요. 예: hatiolab.com",
   "error.figure-type-malformed": "{type} 은 Figure type 이 아닙니다. 소문자로 시작하고 소문자·숫자·하이픈 하나씩만 써서 {min}~{max}자로 정해 주세요.",
   "error.figure-name-malformed": "{type} 은 namespace/type 형식의 정식 이름이 아닙니다.",
   "error.figure-not-released": "이 도메인에 발행판이 없습니다.",

package/translations/ms.json

@@ -100,6 +100,7 @@
   "figure.gate.origin-off-centre.how": "Kekalkan jika figure dilekatkan di situ, seperti pintu pada engselnya. Alihkan titik asal ke tengah untuk meletakkannya mengikut ruangnya.",
   "error.figure-namespace-missing": "domain ini tiada namespace figure yang sah ({value}). tetapkan {setting} dahulu, contohnya hatiolab.com.",
   "error.figure-namespace-changed": "namespace figure domain ini ialah {namespace} dan tidak boleh diubah. tetapkan {setting} kembali kepada {namespace}.",
+  "error.figure-namespace-invalid": "{value} bukan namespace Figure. Gunakan huruf kecil, digit, titik dan sempang, contohnya hatiolab.com.",
   "error.figure-type-malformed": "{type} bukan jenis figure. gunakan huruf kecil, digit dan tanda sempang tunggal, {min} hingga {max} aksara, bermula dengan huruf.",
   "error.figure-name-malformed": "{type} bukan nama figure penuh dalam bentuk namespace/type.",
   "error.figure-not-released": "tiada terbitan diterbitkan di sini.",

package/translations/zh.json

@@ -100,6 +100,7 @@
   "figure.gate.origin-off-centre.how": "如果图形固定在该处（如门的铰链），请保持不变。若要按空间放置，请将原点移到中心。",
   "error.figure-namespace-missing": "此域没有有效的图形 namespace（{value}）。请先设置 {setting}，例如 hatiolab.com。",
   "error.figure-namespace-changed": "此域的图形 namespace 为 {namespace}，不能更改。请将 {setting} 改回 {namespace}。",
+  "error.figure-namespace-invalid": "不是 Figure namespace 的格式({value})。请使用小写字母、数字、点和连字符,例如 hatiolab.com。",
   "error.figure-type-malformed": "{type} 不是图形类型。请使用小写字母、数字和单个连字符，长度 {min} 到 {max} 个字符，并以字母开头。",
   "error.figure-name-malformed": "{type} 不是 namespace/type 形式的完整图形名称。",
   "error.figure-not-released": "此处没有已发布的版本。",