Class ArtifactStateService

constructor

• new ArtifactStateService(
      artifactPermissionService: ArtifactPermissionService,
  ): ArtifactStateService

  Parameters

  • artifactPermissionService: ArtifactPermissionService

  Returns ArtifactStateService

ReadonlyActiveArtifact$

ReadonlyActiveArtifactId$

ReadonlyActiveVersionNumber$

ReadonlyIsPanelOpen$

ReadonlyPanelMode$

activeArtifact$

• get activeArtifact$(): Observable<MJArtifactEntity | null>

  Returns Observable<MJArtifactEntity | null>

  Deprecated

  Use ActiveArtifact$.

activeArtifactId$

• get activeArtifactId$(): Observable<string | null>

  Returns Observable<string | null>

  Deprecated

  Use ActiveArtifactId$.

activeVersionNumber$

• get activeVersionNumber$(): Observable<number | null>

  Returns Observable<number | null>

  Deprecated

  Use ActiveVersionNumber$.

isPanelOpen$

• get isPanelOpen$(): Observable<boolean>

  Returns Observable<boolean>

  Deprecated

  Use IsPanelOpen$.

panelMode$

• get panelMode$(): Observable<"view" | "edit">

  Returns Observable<"view" | "edit">

  Deprecated

  Use PanelMode$.

Provider

• get Provider(): IMetadataProvider

  The metadata provider this service uses. When unset, falls back to Metadata.Provider. Setting it propagates to the dependent artifact-permission service.

  Returns IMetadataProvider

• set Provider(value: IMetadataProvider | null): void

  Parameters

  • value: IMetadataProvider | null

  Returns void

addToCollection

• addToCollection(
      artifactId: string,
      collectionId: string,
      currentUser: UserInfo,
      versionId?: string,
  ): Promise<void>

  Parameters

  • artifactId: string
  • collectionId: string
  • currentUser: UserInfo
  • OptionalversionId: string

  Returns Promise<void>

  Deprecated

  Use AddToCollection.

AddToCollection

• AddToCollection(
      artifactId: string,
      collectionId: string,
      currentUser: UserInfo,
      versionId?: string,
  ): Promise<void>

  Adds an artifact version to a collection

  Parameters

  • artifactId: string

    The artifact ID (for permission checking)

  • collectionId: string

    The collection ID

  • currentUser: UserInfo

    The current user context

  • OptionalversionId: string

    Optional specific version ID. If not provided, uses latest version

  Returns Promise<void>

cacheArtifact

• cacheArtifact(artifact: MJArtifactEntity): void

  Parameters

  • artifact: MJArtifactEntity

  Returns void

  Deprecated

  Use CacheArtifact.

CacheArtifact

• CacheArtifact(artifact: MJArtifactEntity): void

  Caches an artifact in memory

  Parameters

  • artifact: MJArtifactEntity

    The artifact to cache

  Returns void

canEditArtifact

• canEditArtifact(artifactId: string, currentUser: UserInfo): Promise<boolean>

  Parameters

  • artifactId: string
  • currentUser: UserInfo

  Returns Promise<boolean>

  Deprecated

  Use CanEditArtifact.

CanEditArtifact

• CanEditArtifact(artifactId: string, currentUser: UserInfo): Promise<boolean>

  Check if current user can edit an artifact

  Parameters

  • artifactId: string

    The artifact ID

  • currentUser: UserInfo

    The current user context

  Returns Promise<boolean>

  True if user has edit permission

canReadArtifact

• canReadArtifact(artifactId: string, currentUser: UserInfo): Promise<boolean>

  Parameters

  • artifactId: string
  • currentUser: UserInfo

  Returns Promise<boolean>

  Deprecated

  Use CanReadArtifact.

CanReadArtifact

• CanReadArtifact(artifactId: string, currentUser: UserInfo): Promise<boolean>

  Check if current user can read an artifact

  Parameters

  • artifactId: string

    The artifact ID

  • currentUser: UserInfo

    The current user context

  Returns Promise<boolean>

  True if user has read permission

canShareArtifact

• canShareArtifact(artifactId: string, currentUser: UserInfo): Promise<boolean>

  Parameters

  • artifactId: string
  • currentUser: UserInfo

  Returns Promise<boolean>

  Deprecated

  Use CanShareArtifact.

CanShareArtifact

• CanShareArtifact(artifactId: string, currentUser: UserInfo): Promise<boolean>

  Check if current user can share an artifact

  Parameters

  • artifactId: string

    The artifact ID

  • currentUser: UserInfo

    The current user context

  Returns Promise<boolean>

  True if user has share permission

clearCache

• clearCache(): void

  Returns void

  Deprecated

  Use ClearCache.

ClearCache

• ClearCache(): void

  Clears all cached artifacts

  Returns void

closeArtifact

• closeArtifact(): void

  Returns void

  Deprecated

  Use CloseArtifact.

CloseArtifact

• CloseArtifact(): void

  Closes the artifact panel

  Returns void

createArtifact

• createArtifact(
      data: Partial<MJArtifactEntity>,
      currentUser: UserInfo,
  ): Promise<MJArtifactEntity>

  Parameters

  • data: Partial<MJArtifactEntity>
  • currentUser: UserInfo

  Returns Promise<MJArtifactEntity>

  Deprecated

  Use CreateArtifact.

CreateArtifact

• CreateArtifact(
      data: Partial<MJArtifactEntity>,
      currentUser: UserInfo,
  ): Promise<MJArtifactEntity>

  Creates a new artifact

  Parameters

  • data: Partial<MJArtifactEntity>

    Artifact data

  • currentUser: UserInfo

    The current user context

  Returns Promise<MJArtifactEntity>

  The created artifact

deleteArtifact

• deleteArtifact(id: string, currentUser: UserInfo): Promise<boolean>

  Parameters

  • id: string
  • currentUser: UserInfo

  Returns Promise<boolean>

  Deprecated

  Use DeleteArtifact.

DeleteArtifact

• DeleteArtifact(id: string, currentUser: UserInfo): Promise<boolean>

  Deletes an artifact

  Parameters

  • id: string

    The artifact ID

  • currentUser: UserInfo

    The current user context

  Returns Promise<boolean>

  True if successful

loadArtifact

• loadArtifact(
      id: string,
      currentUser: UserInfo,
  ): Promise<MJArtifactEntity | null>

  Parameters

  • id: string
  • currentUser: UserInfo

  Returns Promise<MJArtifactEntity | null>

  Deprecated

  Use LoadArtifact.

LoadArtifact

• LoadArtifact(
      id: string,
      currentUser: UserInfo,
  ): Promise<MJArtifactEntity | null>

  Loads a single artifact by ID

  Parameters

  • id: string

    The artifact ID

  • currentUser: UserInfo

    The current user context

  Returns Promise<MJArtifactEntity | null>

  The artifact entity or null

loadArtifactsForCollection

• loadArtifactsForCollection(
      collectionId: string,
      currentUser: UserInfo,
  ): Promise<MJArtifactEntity[]>

  Parameters

  • collectionId: string
  • currentUser: UserInfo

  Returns Promise<MJArtifactEntity[]>

  Deprecated

  Use LoadArtifactsForCollection.

LoadArtifactsForCollection

• LoadArtifactsForCollection(
      collectionId: string,
      currentUser: UserInfo,
  ): Promise<MJArtifactEntity[]>

  Loads artifacts for a collection

  Parameters

  • collectionId: string

    The collection ID

  • currentUser: UserInfo

    The current user context

  Returns Promise<MJArtifactEntity[]>

  Array of artifacts

loadArtifactVersionsForCollection

• loadArtifactVersionsForCollection(
      collectionId: string,
      currentUser: UserInfo,
      bypassCache?: boolean,
  ): Promise<
      { artifact: MJArtifactEntity; version: MJArtifactVersionEntity }[],
  >

  Parameters

  • collectionId: string
  • currentUser: UserInfo
  • bypassCache: boolean = false

  Returns Promise<{ artifact: MJArtifactEntity; version: MJArtifactVersionEntity }[]>

  Deprecated

  Use LoadArtifactVersionsForCollection.

LoadArtifactVersionsForCollection

• LoadArtifactVersionsForCollection(
      collectionId: string,
      currentUser: UserInfo,
      bypassCache?: boolean,
  ): Promise<
      { artifact: MJArtifactEntity; version: MJArtifactVersionEntity }[],
  >

  Loads artifact VERSIONS for a collection (all versions, not deduplicated by artifact ID) This method returns each version as a separate item with its parent artifact metadata

  Parameters

  • collectionId: string

    The collection ID

  • currentUser: UserInfo

    The current user context

  • bypassCache: boolean = false

  Returns Promise<{ artifact: MJArtifactEntity; version: MJArtifactVersionEntity }[]>

  Array of objects containing version and parent artifact info

openArtifact

• openArtifact(id: string, versionNumber?: number): void

  Parameters

  • id: string
  • OptionalversionNumber: number

  Returns void

  Deprecated

  Use OpenArtifact.

OpenArtifact

• OpenArtifact(id: string, versionNumber?: number): void

  Opens an artifact in the panel

  Parameters

  • id: string

    The artifact ID

  • OptionalversionNumber: number

    Optional specific version number

  Returns void

openArtifactByVersionId

• openArtifactByVersionId(versionId: string): Promise<void>

  Parameters

  • versionId: string

  Returns Promise<void>

  Deprecated

  Use OpenArtifactByVersionId.

OpenArtifactByVersionId

• OpenArtifactByVersionId(versionId: string): Promise<void>

  Opens an artifact by version ID

  Parameters

  • versionId: string

    The artifact version ID

  Returns Promise<void>

removeCachedArtifact

• removeCachedArtifact(id: string): void

  Parameters

  • id: string

  Returns void

  Deprecated

  Use RemoveCachedArtifact.

RemoveCachedArtifact

• RemoveCachedArtifact(id: string): void

  Removes an artifact from cache

  Parameters

  • id: string

    The artifact ID

  Returns void

removeFromCollection

• removeFromCollection(
      artifactId: string,
      collectionId: string,
      currentUser: UserInfo,
  ): Promise<void>

  Parameters

  • artifactId: string
  • collectionId: string
  • currentUser: UserInfo

  Returns Promise<void>

  Deprecated

  Use RemoveFromCollection.

RemoveFromCollection

• RemoveFromCollection(
      artifactId: string,
      collectionId: string,
      currentUser: UserInfo,
  ): Promise<void>

  Removes all versions of an artifact from a collection

  Parameters

  • artifactId: string

    The artifact ID

  • collectionId: string

    The collection ID

  • currentUser: UserInfo

    The current user context

  Returns Promise<void>

setPanelMode

• setPanelMode(mode: "view" | "edit"): void

  Parameters

  • mode: "view" | "edit"

  Returns void

  Deprecated

  Use SetPanelMode.

SetPanelMode

• SetPanelMode(mode: "view" | "edit"): void

  Sets the panel mode

  Parameters

  • mode: "view" | "edit"

    The mode ('view' or 'edit')

  Returns void

togglePanel

• togglePanel(): void

  Returns void

  Deprecated

  Use TogglePanel.

TogglePanel

• TogglePanel(): void

  Toggles the panel open/closed state

  Returns void

updateArtifact

• updateArtifact(
      id: string,
      updates: Partial<MJArtifactEntity>,
      currentUser: UserInfo,
  ): Promise<boolean>

  Parameters

  • id: string
  • updates: Partial<MJArtifactEntity>
  • currentUser: UserInfo

  Returns Promise<boolean>

  Deprecated

  Use UpdateArtifact.

UpdateArtifact

• UpdateArtifact(
      id: string,
      updates: Partial<MJArtifactEntity>,
      currentUser: UserInfo,
  ): Promise<boolean>

  Updates an artifact

  Parameters

  • id: string

    The artifact ID

  • updates: Partial<MJArtifactEntity>

    The fields to update

  • currentUser: UserInfo

    The current user context

  Returns Promise<boolean>

  True if successful