@api-client/core 0.20.8 → 0.20.10

package/tests/fixtures/modeling/runtime/domains.ts

@@ -0,0 +1,270 @@
+import { DataDomain } from '../../../../src/modeling/DataDomain.js'
+import type { DomainEntity } from '../../../../src/modeling/DomainEntity.js'
+import type { DomainModel } from '../../../../src/modeling/DomainModel.js'
+import { SemanticType } from '../../../../src/modeling/Semantics.js'
+
+/**
+ * Creates the simplest data domain with a single entity user.
+ */
+export function userOnlyDomain(): { domain: DataDomain; model: DomainModel; user: DomainEntity } {
+  const domain = new DataDomain({ info: { name: 'Testing Domain', version: '1.0.0' } })
+  const model = domain.addModel({ info: { name: 'Container model' } })
+  const user = model.addEntity({ info: { name: 'user' } })
+  user.addProperty({ info: { name: 'id' }, primary: true })
+  user.addProperty({ info: { name: 'username' }, semantics: [{ id: SemanticType.Username }] })
+  user.addProperty({ info: { name: 'password' }, semantics: [{ id: SemanticType.Password }] })
+  user.addProperty({ info: { name: 'email' }, semantics: [{ id: SemanticType.Email }] })
+  user.addProperty({
+    info: { name: 'role' },
+    semantics: [{ id: SemanticType.UserRole }],
+    schema: {
+      enum: ['admin', 'member', 'guest'],
+    },
+  })
+  return { domain, model, user }
+}
+
+/**
+ * Returns a domain that has 1:1 association between user and config.
+ */
+export function singletonDomain(): {
+  domain: DataDomain
+  model: DomainModel
+  user: DomainEntity
+  config: DomainEntity
+} {
+  const { domain, model, user } = userOnlyDomain()
+  const config = model.addEntity({ info: { name: 'config' } })
+  config.addProperty({ info: { name: 'id' }, primary: true })
+  // user has 1 config
+  user.addAssociation({
+    info: { name: 'config' },
+    targets: [{ key: config.key }],
+    multiple: false,
+    required: false,
+  })
+  config.addAssociation({
+    info: { name: 'owner' },
+    targets: [{ key: user.key }],
+    multiple: false,
+    required: true,
+    semantics: [{ id: SemanticType.ResourceOwnerIdentifier }],
+  })
+  return { domain, model, user, config }
+}
+
+/**
+ * Returns a blog domain with four entities: user, blog, post, comment.
+ */
+export function blogDomain(): {
+  domain: DataDomain
+  user: DomainEntity
+  blog: DomainEntity
+  post: DomainEntity
+  comment: DomainEntity
+} {
+  const domain = new DataDomain({ info: { version: '1.0.0' } })
+  const model = domain.addModel({ info: { name: 'Container Model' } })
+
+  const user = model.addEntity({ info: { name: 'user' }, semantics: [{ id: SemanticType.User }] })
+  user.addProperty({
+    info: { name: 'id' },
+    type: 'string',
+    primary: true,
+    required: true,
+    schema: { defaultValue: { type: 'function', value: 'random' } },
+  })
+  user.addProperty({
+    info: { name: 'name' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Username }],
+  })
+  user.addProperty({
+    info: { name: 'password' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Password }],
+  })
+  user.addProperty({
+    info: { name: 'role' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.UserRole }],
+    schema: {
+      defaultValue: { type: 'literal', value: 'user' },
+      enum: ['user', 'admin', 'moderator'],
+    },
+  })
+
+  const blog = model.addEntity({ info: { name: 'blog' } })
+  blog.addProperty({
+    info: { name: 'id' },
+    type: 'string',
+    primary: true,
+    required: true,
+    schema: { defaultValue: { type: 'function', value: 'random' } },
+  })
+  blog.addProperty({
+    info: { name: 'title' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Title }],
+  })
+  blog.addProperty({
+    info: { name: 'content' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Description }, { id: SemanticType.Markdown }],
+  })
+  blog.addProperty({
+    info: { name: 'status' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Status }],
+    schema: {
+      defaultValue: { type: 'literal', value: 'draft' },
+      enum: ['draft', 'published'],
+    },
+  })
+  blog.addProperty({
+    info: { name: 'created_at' },
+    type: 'datetime',
+    readOnly: true,
+    schema: { defaultValue: { type: 'function', value: 'now' } },
+  })
+  blog.addProperty({
+    info: { name: 'updated_at' },
+    type: 'datetime',
+    readOnly: true,
+    schema: { defaultValue: { type: 'function', value: 'now' } },
+  })
+  blog.addAssociation({
+    info: { name: 'author' },
+    targets: [{ key: user.key }],
+    multiple: false,
+    required: true,
+    semantics: [{ id: SemanticType.ResourceOwnerIdentifier }],
+  })
+  user.addAssociation({
+    info: { name: 'blogs' },
+    targets: [{ key: blog.key }],
+    multiple: true,
+    required: false,
+    onDelete: 'cascade',
+  })
+
+  const post = model.addEntity({ info: { name: 'posts' } })
+  post.addProperty({
+    info: { name: 'id' },
+    type: 'string',
+    primary: true,
+    required: true,
+    schema: { defaultValue: { type: 'function', value: 'random' } },
+  })
+  post.addProperty({
+    info: { name: 'title' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Title }],
+  })
+  post.addProperty({
+    info: { name: 'content' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Description }, { id: SemanticType.Markdown }],
+  })
+  post.addProperty({
+    info: { name: 'status' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Status }],
+    schema: {
+      defaultValue: { type: 'literal', value: 'draft' },
+      enum: ['draft', 'published'],
+    },
+  })
+  post.addProperty({
+    info: { name: 'created_at' },
+    type: 'datetime',
+    readOnly: true,
+    schema: { defaultValue: { type: 'function', value: 'now' } },
+  })
+  post.addProperty({
+    info: { name: 'updated_at' },
+    type: 'datetime',
+    readOnly: true,
+    schema: { defaultValue: { type: 'function', value: 'now' } },
+  })
+  post.addAssociation({
+    info: { name: 'author' },
+    targets: [{ key: user.key }],
+    multiple: false,
+    required: true,
+    semantics: [{ id: SemanticType.ResourceOwnerIdentifier }],
+  })
+  post.addAssociation({
+    info: { name: 'blog' },
+    targets: [{ key: blog.key }],
+    multiple: false,
+    required: true,
+  })
+  user.addAssociation({
+    info: { name: 'posts' },
+    targets: [{ key: post.key }],
+    multiple: true,
+    required: false,
+    onDelete: 'cascade',
+  })
+  blog.addAssociation({
+    info: { name: 'posts' },
+    targets: [{ key: post.key }],
+    multiple: true,
+    required: false,
+    onDelete: 'cascade',
+  })
+
+  const comment = model.addEntity({ info: { name: 'comment' } })
+  comment.addProperty({
+    info: { name: 'id' },
+    type: 'string',
+    primary: true,
+    required: true,
+    schema: { defaultValue: { type: 'function', value: 'random' } },
+  })
+  comment.addProperty({
+    info: { name: 'content' },
+    type: 'string',
+    required: true,
+    semantics: [{ id: SemanticType.Markdown }],
+  })
+  comment.addAssociation({
+    info: { name: 'author' },
+    targets: [{ key: user.key }],
+    multiple: false,
+    required: true,
+    semantics: [{ id: SemanticType.ResourceOwnerIdentifier }],
+  })
+  comment.addAssociation({
+    info: { name: 'post' },
+    targets: [{ key: post.key }],
+    multiple: false,
+    required: true,
+  })
+  user.addAssociation({
+    info: { name: 'comments' },
+    targets: [{ key: comment.key }],
+    multiple: true,
+    required: false,
+    onDelete: 'cascade',
+  })
+  post.addAssociation({
+    info: { name: 'comments' },
+    targets: [{ key: comment.key }],
+    multiple: true,
+    required: false,
+    onDelete: 'cascade',
+  })
+
+  return { domain, user, blog, post, comment }
+}