Class ElementStore

constructor

• new ElementStore(main: MainStore): ElementStore

  Parameters

  • main: MainStore

  Returns ElementStore

elements

elementSchemas

elementsTypeDataV1

elementTemplates

elementTemplatesV1

main

privileges

socketEventIds

syncProgress

workRecordActions

Staticlisteners

addPrivilegesData

• addPrivilegesData(
      type: string,
      organization: string,
      privileges: ElementPrivileges,
  ): void

  Parameters

  • type: string
  • organization: string
  • privileges: ElementPrivileges

  Returns void

addSchema

• addSchema(
      schema: Required<Pick<ElementSchema, "properties" | "id" | "scope">>,
      options?: { stage?: Stage },
  ): Promise<ElementSchema>

  Parameters

  • schema: Required<Pick<ElementSchema, "properties" | "id" | "scope">>
  • Optionaloptions: { stage?: Stage }

  Returns Promise<ElementSchema>

addTemplateV1Data

• addTemplateV1Data(
      type: string,
      organization: string,
      template: ElementTemplateV1,
  ): void

  Parameters

  • type: string
  • organization: string
  • template: ElementTemplateV1

  Returns void

addTypeData

• addTypeData(type: string, typeData: AttributeDefinitions): void

  Parameters

  • type: string
  • typeData: AttributeDefinitions

  Returns void

addWorkRecordActions

• addWorkRecordActions(type: string, actions: string[]): void

  Parameters

  • type: string
  • actions: string[]

  Returns void

applyPatchToElement

• applyPatchToElement(element: Element, operations: Operation[]): void

  Parameters

  • element: Element
  • operations: Operation[]

  Returns void

batchMetadata

• batchMetadata(
      elements: Element[],
      attributes: string[],
  ): Promise<undefined | BatchMetadata<string>>

  Parameters

  • elements: Element[]
  • attributes: string[]

  Returns Promise<undefined | BatchMetadata<string>>

batchUpdateElements

• batchUpdateElements(
      elements: Element[],
      changes?: ElementFormData,
  ): Promise<undefined | ApiOkResponse<void>>

  Parameters

  • elements: Element[]
  • Optionalchanges: ElementFormData

  Returns Promise<undefined | ApiOkResponse<void>>

computeElementDataHash

• computeElementDataHash(data: ElementData): string

  Parameters

  • data: ElementData

  Returns string

create

• create(
      type: string,
      data: ElementAttributeData,
      organization: string,
      options?: { parent?: Element; shouldLoad?: boolean },
  ): Promise<undefined | Element>

  Parameters

  • type: string
  • data: ElementAttributeData
  • organization: string
  • Optionaloptions: { parent?: Element; shouldLoad?: boolean }

  Returns Promise<undefined | Element>

createBatchElements

• createBatchElements(
      elements: (__type<GConstructor<Element>> & Element)[],
  ): Promise<BatchCreateResponse>

  Parameters

  • elements: (__type<GConstructor<Element>> & Element)[]

  Returns Promise<BatchCreateResponse>

createTicket

• createTicket(
      data: ElementAttributeData,
      organization: string,
  ): Promise<undefined | Element>

  Parameters

  • data: ElementAttributeData
  • organization: string

  Returns Promise<undefined | Element>

dehydrateElement

• dehydrateElement(element: Element): undefined | DehydratedElement

  Parameters

  • element: Element

  Returns undefined | DehydratedElement

get

• get<T extends Element>(
      hash: string,
      type: string,
      queryParams?: ElementGetQueryParams,
  ): Promise<null | T>

  Type Parameters

  • T extends Element

  Parameters

  • hash: string
  • type: string
  • OptionalqueryParams: ElementGetQueryParams

  Returns Promise<null | T>

getAttributeType

• getAttributeType(type: string, attributeKey: string): undefined | AttributeType

  Parameters

  • type: string
  • attributeKey: string

  Returns undefined | AttributeType

getElementFromHash

• getElementFromHash(hash: string): Promise<Element>

  Parameters

  • hash: string

  Returns Promise<Element>

getElementFromQR

• getElementFromQR(url: string): Promise<Element>

  Parameters

  • url: string

  Returns Promise<Element>

getElementPrivileges

• getElementPrivileges(
      type: string,
      organization: string,
  ): Promise<undefined | ElementPrivileges>

  Parameters

  • type: string
  • organization: string

  Returns Promise<undefined | ElementPrivileges>

getElementSchema

• getElementSchema(
      type: string,
      options?: { cache?: false; stage?: Stage; useStoreCache?: boolean },
  ): Promise<undefined | ElementSchema>

  Parameters

  • type: string
  • Optionaloptions: { cache?: false; stage?: Stage; useStoreCache?: boolean }

  Returns Promise<undefined | ElementSchema>

getElementTemplateV1

• getElementTemplateV1(
      type: string,
      organization: string,
  ): Promise<undefined | ElementTemplateV1>

  Parameters

  • type: string
  • organization: string

  Returns Promise<undefined | ElementTemplateV1>

getElementTypeData

• getElementTypeData(type: string): Promise<undefined | AttributeDefinitions>

  Parameters

  • type: string

  Returns Promise<undefined | AttributeDefinitions>

getFilesWithUniqNames

• getFilesWithUniqNames(
      attributeValue: AttributeFileData,
  ): { conflictHashes: string[]; localFiles: LocalFile<PlatformFile>[] }

  Parameters

  • attributeValue: AttributeFileData

  Returns { conflictHashes: string[]; localFiles: LocalFile<PlatformFile>[] }

getLocalFiles

• getLocalFiles(data: ElementAttributeData): PreparedFiles<PlatformFile>[]

  Parameters

  • data: ElementAttributeData

  Returns PreparedFiles<PlatformFile>[]

getModelForElementType

• getModelForElementType(type?: string): typeof Element

  Parameters

  • Optionaltype: string

  Returns typeof Element

getTemplate

• getTemplate(
      type: string,
      templateId?: string,
      options?: { cache?: false; stage?: Stage; useStoreCache?: boolean },
  ): Promise<undefined | Template>

  Parameters

  • type: string
  • templateId: string = DEFAULT_TEMPLATE_ID
  • Optionaloptions: { cache?: false; stage?: Stage; useStoreCache?: boolean }

  Returns Promise<undefined | Template>

instantiateElement

• instantiateElement(
      hash: string,
      data?: ElementData,
      shouldLoad?: boolean,
      paramOptions?: Partial<InstantiateElementOptions>,
  ): undefined | Element

  Parameters

  • hash: string
  • Optionaldata: ElementData
  • shouldLoad: boolean = false
  • paramOptions: Partial<InstantiateElementOptions> = {}

  Returns undefined | Element

instantiateElementValue

• instantiateElementValue(value: AttributeValue): Element[]

  Parameters

  • value: AttributeValue

  Returns Element[]

instantiateElementWithChildren

• instantiateElementWithChildren(elementRaw: ElementRaw): Element

  Parameters

  • elementRaw: ElementRaw

  Returns Element

instantiateLocalElement

• instantiateLocalElement(
      type: string,
      organization: string,
      data?: Omit<ElementData, "organization" | "hash" | "_type">,
      parent?: Element,
  ): __type<GConstructor<Element>> & Element

  Parameters

  • type: string
  • organization: string
  • Optionaldata: Omit<ElementData, "organization" | "hash" | "_type">
  • Optionalparent: Element

  Returns __type<GConstructor<Element>> & Element

loadAndPersistBatchElements

• loadAndPersistBatchElements(
      hashes: string[],
      projection?: string[],
      paramOptions?: { setToMemory?: boolean },
  ): Promise<Element[]>

  Parameters

  • hashes: string[]
  • projection: string[] = []
  • OptionalparamOptions: { setToMemory?: boolean }

  Returns Promise<Element[]>

loadElementTypes

• loadElementTypes(right?: "read" | "update" | "create"): Promise<string[]>

  Parameters

  • Optionalright: "read" | "update" | "create"

  Returns Promise<string[]>

onConnectionChange

• onConnectionChange(): Promise<void>

  Returns Promise<void>

onElementsChange

• onElementsChange(change: IObjectDidChange): Promise<void>

  Parameters

  • change: IObjectDidChange

  Returns Promise<void>

prepareOperations

• prepareOperations(
      type: string,
      data: ElementAttributeData,
      oldData?: ElementAttributeData,
  ): Operation[]

  Parameters

  • type: string
  • data: ElementAttributeData
  • oldData: ElementAttributeData = {}

  Returns Operation[]

rehydrateElement

• rehydrateElement(hash: string): Promise<undefined | Element>

  Parameters

  • hash: string

  Returns Promise<undefined | Element>

rehydrateElements

• rehydrateElements(): Promise<void>

  Returns Promise<void>

removeElement

• removeElement(hash: string): undefined | Promise<void>

  Parameters

  • hash: string

  Returns undefined | Promise<void>

saveElementToStorage

• saveElementToStorage(originalElement: Element): undefined | Promise<void>

  Parameters

  • originalElement: Element

  Returns undefined | Promise<void>

saveSchema

• saveSchema(
      type: string,
      schema: ElementSchema,
      options?: { stage?: Stage },
  ): Promise<ElementSchema & { children?: ElementSchema[] }>

  Parameters

  • type: string
  • schema: ElementSchema
  • Optionaloptions: { stage?: Stage }

  Returns Promise<ElementSchema & { children?: ElementSchema[] }>

saveTemplate

• saveTemplate(
      schemaId: `${string}/${string}`,
      templateId?: string,
      data?: Partial<Template>,
      options?: { stage?: Stage },
  ): Promise<Template>

  Parameters

  • schemaId: `${string}/${string}`
  • OptionaltemplateId: string
  • Optionaldata: Partial<Template>
  • Optionaloptions: { stage?: Stage }

  Returns Promise<Template>

search

• search(
      query: string,
      options?: ElementSearchOptions,
  ): Promise<undefined | GetElementSearch>

  Parameters

  • query: string
  • Optionaloptions: ElementSearchOptions

  Returns Promise<undefined | GetElementSearch>

setSchema

• setSchema(schemaId: `${string}/${string}`, schema: ElementSchema): void

  Parameters

  • schemaId: `${string}/${string}`
  • schema: ElementSchema

  Returns void

setTemplate

• setTemplate(
      schemaId: `${string}/${string}`,
      template: Template,
      templateId?: string,
  ): void

  Parameters

  • schemaId: `${string}/${string}`
  • template: Template
  • templateId: string = DEFAULT_TEMPLATE_ID

  Returns void

subscribeToElementUpdates

• subscribeToElementUpdates(element: Element): undefined | () => void

  Parameters

  • element: Element

  Returns undefined | () => void

syncLocalElements

• syncLocalElements(): Promise<void>

  Returns Promise<void>

uploadFiles

• uploadFiles(
      type: string,
      hash: string,
      files: PreparedFiles<PlatformFile>[],
      workRecordHash?: string,
  ): Promise<undefined | ApiOkResponse<FileBatchResponse>>

  Parameters

  • type: string
  • hash: string
  • files: PreparedFiles<PlatformFile>[]
  • OptionalworkRecordHash: string

  Returns Promise<undefined | ApiOkResponse<FileBatchResponse>>

StaticareAllConditionsMet

• areAllConditionsMet(
      conditions:
          | undefined
          | { items: ViewConfigCondition[]; logicalOperator: "every"
          | "some" },
      element: Element,
  ): boolean

  Parameters

  • conditions: undefined | { items: ViewConfigCondition[]; logicalOperator: "every" | "some" }
  • element: Element

  Returns boolean

StaticgetSolvedAttrVisibility

• getSolvedAttrVisibility(
      attributeDefinition:
          | AttributeDefinition
          | { visibility: ConditionalViewConfig },
      element: Element,
  ): boolean

  Parameters

  • attributeDefinition: AttributeDefinition | { visibility: ConditionalViewConfig }
  • element: Element

  Returns boolean

StaticgetSolvedGroupCollapse

• getSolvedGroupCollapse(group: AttributeGroup, element: Element): boolean

  Parameters

  • group: AttributeGroup
  • element: Element

  Returns boolean

StaticgetSolvedGroupVisibility

• getSolvedGroupVisibility(group: AttributeGroup, element: Element): boolean

  Parameters

  • group: AttributeGroup
  • element: Element

  Returns boolean