@operato/scene-grist 7.0.0 → 7.3.6

package/schema.graphql

@@ -29,7 +29,7 @@ type AppBinding {
   email: EmailAddress!
   id: ID!
   locale: String
-  name: String!
+  name: String
   owner: Boolean
   reference: String
   refreshToken: String
@@ -133,7 +133,7 @@ type ApprovalLine {
   createdAt: DateTimeISO
   creator: User
   description: String
-  domain: Domain
+  domain: Domain!
   id: ID!
   model: [ApprovalLineItem!]
   name: String
@@ -283,11 +283,10 @@ type AuthProvider {
   clientSecret: String
   createdAt: DateTimeISO
   creator: User
-  domain: Domain
+  domain: Domain!
   id: ID!
   params: Object
   privateKey: String
-  state: String
   tenantId: String
   type: String
   updatedAt: DateTimeISO
@@ -305,6 +304,7 @@ type AuthProviderParameterSpec {
   name: String!
   placeholder: String
   property: Object
+  styles: Object
   type: String!
 }
 
@@ -411,7 +411,7 @@ type BoardTemplate {
   createdAt: DateTimeISO
   creator: User
   description: String
-  domain: Domain
+  domain: Domain!
   id: ID!
   mine: Boolean!
   model: String
@@ -462,7 +462,7 @@ type CommonCode {
   creator: User
   description: String
   details: [CommonCodeDetail!]!
-  domain: Domain
+  domain: Domain!
   id: ID!
   name: String!
   updatedAt: DateTimeISO
@@ -475,7 +475,7 @@ type CommonCodeDetail {
   createdAt: DateTimeISO
   creator: User
   description: String
-  domain: Domain
+  domain: Domain!
   id: ID!
   labels: Object
   name: String!
@@ -548,7 +548,7 @@ input ConnectionPatch {
 
 type ConnectionState {
   description: String
-  domain: Domain
+  domain: Domain!
   edge: Appliance
   id: String
   name: String
@@ -578,7 +578,7 @@ type Contact {
   creator: User
   deletedAt: DateTimeISO
   department: String
-  domain: Domain
+  domain: Domain!
   email: EmailAddress
   id: ID!
   items: [ContactItem!]
@@ -649,7 +649,7 @@ type Department {
   creator: User
   deletedAt: DateTimeISO
   description: String
-  domain: Domain
+  domain: Domain!
   extension: String
   id: ID!
   manager: Employee
@@ -756,7 +756,7 @@ type Employee {
   creator: User
   deletedAt: DateTimeISO
   department: Department
-  domain: Domain
+  domain: Domain!
   email: EmailAddress
   extension: String
   hiredOn: String
@@ -822,7 +822,7 @@ type Entity {
   dataProp: String
   delStrategy: String
   description: String
-  domain: Domain
+  domain: Domain!
   extEntity: Boolean
   fixedColumns: Float
   id: ID!
@@ -847,7 +847,7 @@ type EntityColumn {
   creator: User
   defVal: String
   description: String
-  domain: Domain
+  domain: Domain!
   entity: Entity!
   formEditor: String
   formFormat: String
@@ -1020,7 +1020,7 @@ type Font {
   active: Boolean!
   createdAt: DateTimeISO
   creator: User
-  domain: Domain
+  domain: Domain!
   files: [Attachment!]
   id: ID!
   name: String!
@@ -1143,14 +1143,14 @@ type LoginHistoryList {
 type Menu {
   buttons: [MenuButton!]!
   category: String
-  children: [Menu!]!
+  children(permittedOnly: Boolean! = false): [Menu!]!
   columns: [MenuColumn!]!
   createdAt: DateTimeISO
   creator: User
   description: String
   detailFormId: String
   detailLayout: String
-  domain: Domain
+  domain: Domain!
   fixedColumns: Float
   gridSaveUrl: String
   hiddenFlag: Boolean
@@ -1162,6 +1162,7 @@ type Menu {
   name: String
   pagination: Boolean
   parent: Menu
+  privilege: PrivilegeObject
   rank: Float
   resourceId: String
   resourceName: String
@@ -1183,7 +1184,7 @@ type MenuButton {
   auth: String
   createdAt: DateTimeISO
   creator: User
-  domain: Domain
+  domain: Domain!
   icon: String
   id: ID!
   logic: String
@@ -1218,7 +1219,7 @@ type MenuColumn {
   creator: User
   defVal: String
   description: String
-  domain: Domain
+  domain: Domain!
   extField: Boolean
   formEditor: String
   formFormat: String
@@ -1307,7 +1308,7 @@ type MenuDetail {
   creator: User
   customView: String
   dataProp: String
-  domain: Domain
+  domain: Domain!
   entityId: String
   id: ID!
   masterField: String
@@ -1324,7 +1325,7 @@ type MenuDetail {
 type MenuDetailButton {
   createdAt: DateTimeISO
   creator: User
-  domain: Domain
+  domain: Domain!
   icon: String
   id: ID!
   logic: String
@@ -1358,7 +1359,7 @@ type MenuDetailColumn {
   creator: User
   defVal: String
   description: String
-  domain: Domain
+  domain: Domain!
   extField: Boolean
   formEditor: String
   formFormat: String
@@ -1483,6 +1484,7 @@ input MenuPatch {
   name: String
   pagination: Boolean
   parent: ObjectRef
+  privilege: PrivilegeInput
   rank: Int
   resourceId: String
   resourceName: String
@@ -1504,6 +1506,9 @@ type Mutation {
   attachContact(contactId: String!, id: String!): Employee!
   cancelInvitation(email: EmailAddress!, reference: String!, type: String!): Boolean!
 
+  """To clear translations cache"""
+  clearTranslationsCache: Boolean!
+
   """To clone a Board from existing Board"""
   cloneBoard(id: String!, patch: BoardPatch!, targetGroupId: String, targetSubdomain: String!): Board!
 
@@ -1593,6 +1598,9 @@ type Mutation {
   """To create new ApprovalLine for current user"""
   createMyApprovalLine(approvalLine: NewApprovalLine!): ApprovalLine!
 
+  """To create my new PagePreference"""
+  createMyPagePreference(pagePreference: NewPagePreference!): PagePreference!
+
   """To create new Notification"""
   createNotification(notification: NewNotification!): Notification!
 
@@ -1634,6 +1642,9 @@ type Mutation {
 
   """To create new user"""
   createUser(user: NewUser!): User!
+
+  """To create new UserPreference"""
+  createUserPreference(preference: NewUserPreference!): UserPreference!
   deleteAppBinding(id: String!): Boolean!
 
   """To delete appliance"""
@@ -1648,7 +1659,7 @@ type Mutation {
   """To delete multiple ApprovalLines"""
   deleteApprovalLines(ids: [String!]!): Boolean!
   deleteAttachment(id: String!): Boolean!
-  deleteAttachmentsByRef(refBys: [String!]!): Boolean!
+  deleteAttachmentsByRef(refBys: [String!]!, refType: String): Boolean!
 
   """To delete AttributeSet"""
   deleteAttributeSet(id: String!): Boolean!
@@ -1774,6 +1785,12 @@ type Mutation {
   """To delete multiple ApprovalLines for current user"""
   deleteMyApprovalLines(ids: [String!]!): Boolean!
 
+  """To delete my PagePreference"""
+  deleteMyPagePreference(element: String!, page: String!): Boolean!
+
+  """To delete my preference"""
+  deleteMyUserPreference(element: String!, key: String!): Boolean!
+
   """To delete Notification"""
   deleteNotification(id: String!): Boolean!
 
@@ -1792,6 +1809,12 @@ type Mutation {
   """To delete multiple Oauth2Clients"""
   deleteOauth2Clients(ids: [String!]!): Boolean!
 
+  """To delete PagePreference"""
+  deletePagePreference(id: String!): Boolean!
+
+  """To delete multiple PagePreferences"""
+  deletePagePreferences(ids: [String!]!): Boolean!
+
   """To delete multiple partnerSettings"""
   deletePartnerSettings(ids: [String!]!): Boolean!
 
@@ -1855,6 +1878,12 @@ type Mutation {
   """To delete a user"""
   deleteUser(email: EmailAddress!): Boolean!
 
+  """To delete UserPreference"""
+  deleteUserPreference(id: String!): Boolean!
+
+  """To delete multiple UserPreferences"""
+  deleteUserPreferences(ids: [String!]!): Boolean!
+
   """To delete some users"""
   deleteUsers(emails: [String!]!): Boolean!
 
@@ -1990,7 +2019,7 @@ type Mutation {
   """
   To run new scenario instance and will return the result after the scenario stop.
   """
-  runScenario(instanceName: String, scenarioName: String!, variables: Object): ScenarioInstance!
+  runScenario(instanceName: String, scenarioName: String!, variables: Object): ScenarioInstanceRunResult!
   sendInvitation(email: EmailAddress!, reference: String!, type: String!): Invitation!
   singleUpload(file: Upload!): Attachment!
 
@@ -2172,6 +2201,12 @@ type Mutation {
   """To modify ApprovalLine information for current user"""
   updateMyApprovalLine(id: String!, patch: ApprovalLinePatch!): ApprovalLine!
 
+  """To create or update my PagePreference"""
+  updateMyPagePreference(element: String!, page: String!, preference: Object!): PagePreference!
+
+  """To create or update my preference"""
+  updateMyUserPreference(key: String!, preference: Object!): UserPreference!
+
   """To modify Notification information"""
   updateNotification(id: String!, patch: NotificationPatch!): Notification!
 
@@ -2226,6 +2261,9 @@ type Mutation {
   """To modify user information"""
   updateUser(email: EmailAddress!, patch: UserPatch!): User!
 
+  """To modify UserPreference information"""
+  updateUserPreference(id: String!, patch: UserPreferencePatch!): UserPreference!
+
   """To update roles for a user"""
   updateUserRoles(availableRoles: [ObjectRef!]!, selectedRoles: [ObjectRef!]!, userId: String!): User!
 }
@@ -2457,6 +2495,7 @@ input NewMenu {
   name: String!
   pagination: Boolean
   parent: ObjectRef
+  privilege: PrivilegeInput
   rank: Int
   resourceId: String
   resourceName: String
@@ -2624,6 +2663,13 @@ input NewOauth2Client {
   webhook: String
 }
 
+input NewPagePreference {
+  element: String
+  page: String
+  preference: Object!
+  user: ObjectRef!
+}
+
 input NewPayloadLog {
   description: String
   name: String!
@@ -2673,6 +2719,7 @@ input NewScenario {
   privilege: PrivilegeInput
   schedule: String
   timezone: String
+  ttl: Float
   type: String
 }
 
@@ -2684,12 +2731,34 @@ input NewSetting {
 }
 
 input NewStateRegister {
+  """Description of the state register"""
   description: String
+
+  """Group name for the state register"""
+  group: String
+
+  """Name of the state register"""
   name: String!
+
+  """Number of decimal places if the state is a number type"""
+  place: String
+
+  """
+  Reference to an external entity or data, used as a flexible foreign key
+  """
   refBy: String
+
+  """Current state value"""
   state: Object
+
+  """Time to live for the state value in seconds"""
   ttl: Int
+
+  """Type of the state"""
   type: String
+
+  """Unit of the state value"""
+  unit: String
 }
 
 input NewTerminology {
@@ -2726,12 +2795,18 @@ input NewUserByDomainWizardInput {
   roles: [NewRole!]!
 }
 
+input NewUserPreference {
+  key: String!
+  preference: Object!
+  user: ObjectRef!
+}
+
 """Entity for Notification"""
 type Notification {
   body: String
   createdAt: DateTimeISO
   creator: User
-  domain: Domain
+  domain: Domain!
   id: ID!
   image: String
   owner: User
@@ -2765,7 +2840,7 @@ type NotificationRule {
   creator: User
   deletedAt: DateTimeISO
   description: String
-  domain: Domain
+  domain: Domain!
   id: ID!
   name: String
 
@@ -2822,7 +2897,7 @@ type Oauth2Client {
   createdAt: DateTimeISO
   creator: User
   description: String
-  domain: Domain
+  domain: Domain!
   expires: DateTimeISO
   grantType: String
   icon: String
@@ -2949,18 +3024,37 @@ enum OrgMemberTargetType {
   Role
 }
 
+"""Entity for PagePreference"""
+type PagePreference {
+  createdAt: DateTimeISO
+  creator: User
+  domain: Domain!
+  element: String
+  id: ID!
+  page: String
+  preference: Object
+  updatedAt: DateTimeISO
+  updater: User
+  user: User!
+}
+
+type PagePreferenceList {
+  items: [PagePreference!]!
+  total: Int!
+}
+
 input Pagination {
   limit: Int
   page: Int
 }
 
 type Partner {
-  approvedAt: DateTimeISO!
+  approvedAt: DateTimeISO
   approver: User
   domain: Domain!
   id: ID!
   partnerDomain: Domain!
-  requestedAt: DateTimeISO!
+  requestedAt: DateTimeISO
   requester: User
 }
 
@@ -2975,7 +3069,7 @@ type PartnerSetting {
   createdAt: DateTimeISO
   creator: User
   description: String
-  domain: Domain
+  domain: Domain!
   id: ID!
   name: String
   partnerDomain: Domain
@@ -3004,7 +3098,7 @@ input PartnerSettingPatch {
 type PayloadLog {
   createdAt: DateTimeISO
   creator: User
-  domain: Domain
+  domain: Domain!
   endpoint: String!
   id: ID!
   name: String!
@@ -3170,6 +3264,7 @@ type PropertySpec {
   name: String!
   placeholder: String
   property: Object
+  styles: Object
   type: String!
 }
 
@@ -3425,12 +3520,30 @@ type Query {
   myFavorites: [Favorite!]!
   myLoginHistories(limit: Float!): [LoginHistory!]!
 
+  """To fetch my own Menus"""
+  myMenus(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): MenuList!
+
   """To fetch my notifications"""
   myNotifications(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): NotificationList!
 
+  """To fetch a User's own PagePreference"""
+  myPageAllPreferences(page: String!): [PagePreference!]
+
+  """To fetch a User's own PagePreference"""
+  myPagePreference(element: String!, page: String!): PagePreference
+
+  """To fetch multiple PagePreferences"""
+  myPagePreferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PagePreferenceList!
+
   """To fetch roles of current user"""
   myRoles: [Role!]!
 
+  """To fetch a User's own UserPreference"""
+  myUserPreference(element: String!, key: String!): UserPreference
+
+  """To fetch multiple UserPreferences"""
+  myUserPreferences(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): UserPreferenceList!
+
   """To fetch a Notification"""
   notification(id: String!): Notification
 
@@ -3449,6 +3562,9 @@ type Query {
   """To fetch multiple Oauth2Clients"""
   oauth2Clients(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): Oauth2ClientList!
 
+  """To fetch a PagePreference"""
+  pagePreference(id: String!): PagePreference
+
   """To fetch specific domain's CommonCodes by given name"""
   partnerCommonCode(name: String!, partnerDomainId: String!): CommonCode!
 
@@ -3474,6 +3590,9 @@ type Query {
   """To fetch multiple PlayGroups"""
   playGroups(filters: [Filter!], inherited: InheritedValueType, pagination: Pagination, sortings: [Sorting!]): PlayGroupList!
 
+  """To fetch a UserPreference"""
+  preference(id: String!): UserPreference
+
   """To fetch a PrinterDevice"""
   printerDevice(id: String!): PrinterDevice!
 
@@ -3579,7 +3698,7 @@ type Role {
   description: String
   domain: Domain!
   id: ID!
-  name: String!
+  name: String
   privileges: [Privilege!]
   updatedAt: DateTimeISO
   updater: User
@@ -3615,7 +3734,7 @@ type Scenario {
   createdAt: DateTimeISO
   creator: User
   description: String
-  domain: Domain
+  domain: Domain!
   id: ID!
   instances: [ScenarioInstance!]
   name: String!
@@ -3629,6 +3748,7 @@ type Scenario {
   state: String
   steps: [Step!]
   timezone: String
+  ttl: Float
   type: String
   updatedAt: DateTimeISO
   updater: User
@@ -3661,6 +3781,17 @@ type ScenarioInstanceProgress {
   steps: Int!
 }
 
+type ScenarioInstanceRunResult {
+  data: Object
+  instanceName: String
+  message: String
+  result: Object
+  scenarioName: String
+  state: String
+  timestamp: DateTimeISO
+  variables: Object
+}
+
 type ScenarioInstanceState {
   data: Object
   domain: Domain
@@ -3697,6 +3828,7 @@ input ScenarioPatch {
   schedule: String
   steps: [StepPatch!]
   timezone: String
+  ttl: Float
   type: String
 }
 
@@ -3711,7 +3843,7 @@ type Setting {
   createdAt: DateTimeISO
   creator: User
   description: String
-  domain: Domain
+  domain: Domain!
   id: ID!
   name: String!
   updatedAt: DateTimeISO
@@ -3745,36 +3877,113 @@ input Sorting {
 
 """Entity for StateRegister"""
 type StateRegister {
+  """Creation time of the state register"""
   createdAt: DateTimeISO
+
+  """User who created the state register"""
   creator: User
+
+  """ID of the user who created the state register"""
+  creatorId: String
+
+  """Description of the state register"""
   description: String
-  domain: Domain
+
+  """Associated domain for the state register"""
+  domain: Domain!
+
+  """ID of the associated domain"""
+  domainId: String!
+
+  """Group name for the state register"""
+  group: String
   id: ID!
+
+  """Name of the state register"""
   name: String
+
+  """Number of decimal places if the state is a number type"""
+  place: String
+
+  """
+  Reference to an external entity or data, used as a flexible foreign key
+  """
   refBy: String
+
+  """Current state value"""
   state: Object
+
+  """Time to live for the state value in seconds"""
   ttl: Int
+
+  """Type of the state"""
   type: String
+
+  """Unit of the state value"""
+  unit: String
+
+  """Last update time of the state register"""
   updatedAt: DateTimeISO
+
+  """User who last updated the state register"""
   updater: User
+
+  """ID of the user who last updated the state register"""
+  updaterId: String
+
+  """User who wrote the state"""
   writer: User
+
+  """ID of the user who wrote the state"""
+  writerId: String
+
+  """Time when the state was recorded"""
   wroteAt: DateTimeISO
 }
 
 type StateRegisterList {
+  """List of state registers"""
   items: [StateRegister!]!
+
+  """Total number of state registers"""
   total: Int!
 }
 
 input StateRegisterPatch {
+  """Flag indicating create/update operations"""
   cuFlag: String
+
+  """Description of the state register"""
   description: String
+
+  """Group name for the state register"""
+  group: String
+
+  """ID of the state register"""
   id: ID
+
+  """Name of the state register"""
   name: String
+
+  """Number of decimal places if the state is a number type"""
+  place: String
+
+  """
+  Reference to an external entity or data, used as a flexible foreign key
+  """
   refBy: String
+
+  """Current state value"""
   state: Object
+
+  """Time to live for the state value in seconds"""
   ttl: Int
+
+  """Type of the state"""
   type: String
+
+  """Unit of the state value"""
+  unit: String
 }
 
 type Step {
@@ -3848,13 +4057,15 @@ type TaskTypeList {
 type Terminology {
   category: String!
   createdAt: DateTimeISO
+  creator: User
   description: String
   display: String!
-  domain: Domain
+  domain: Domain!
   id: ID!
   locale: String!
   name: String!
   updatedAt: DateTimeISO
+  updater: User
 }
 
 type TerminologyList {
@@ -3863,12 +4074,12 @@ type TerminologyList {
 }
 
 input TerminologyPatch {
-  category: String!
+  category: String
   cuFlag: String
   description: String
-  display: String!
+  display: String
   id: ID
-  locale: String!
+  locale: String
   name: String
 }
 
@@ -3879,7 +4090,7 @@ type Theme {
   creator: User
   deletedAt: DateTimeISO
   description: String
-  domain: Domain
+  domain: Domain!
   id: ID!
   name: String
   type: String
@@ -3919,7 +4130,7 @@ type User {
   email: EmailAddress!
   id: ID!
   locale: String
-  name: String!
+  name: String
   owner: Boolean
   reference: String
   roles: [Role!]!
@@ -3949,6 +4160,32 @@ input UserPatch {
   userType: String
 }
 
+"""Entity for UserPreference"""
+type UserPreference {
+  createdAt: DateTimeISO
+  creator: User
+  domain: Domain
+  id: ID!
+  key: String
+  preference: Object
+  updatedAt: DateTimeISO
+  updater: User
+  user: User!
+}
+
+type UserPreferenceList {
+  items: [UserPreference!]!
+  total: Int!
+}
+
+input UserPreferencePatch {
+  cuFlag: String
+  id: ID
+  key: String!
+  preference: Object!
+  user: ObjectRef!
+}
+
 type UserRole {
   assigned: Boolean
   description: String
@@ -3960,7 +4197,7 @@ type UserRole {
 type UsersAuthProviders {
   authProvider: AuthProvider
   createdAt: DateTimeISO
-  domain: Domain
+  domain: Domain!
   id: ID!
   ssoId: String
   updatedAt: DateTimeISO