private-view/private-value-element API

Source-derived exports, parameter and result types, public methods and source links.

This reference is generated from the checked-out TypeScript exports. Types and signatures describe the package contract; source presence does not establish deployment or service availability. Error expressions below are direct throws, not an exhaustive list of failures from dependencies.

Source module. See the reference index for package import boundaries and verification scope.

configureTsnPrivateValueResolver

Import from @trustlink/tsn-sdk/private-view. Implementation, line 11.

configureTsnPrivateValueResolver(next: TsnPrivateValueResolver): void

TsnPrivateField

Import from @trustlink/tsn-sdk/private-view. Implementation, line 3.

export type TsnPrivateField = "settlementWallet";

TsnPrivateValueElement

Import from @trustlink/tsn-sdk/private-view. Implementation, line 15.

new TsnPrivateValueElement(): TsnPrivateValueElement

TsnPrivateValueElement.tin

Source, line 60.

tin: string

TsnPrivateValueElement.field

Source, line 61.

field: "settlementWallet"

TsnPrivateValueElement.fallback

Source, line 62.

fallback: string

TsnPrivateValueElement.connectedCallback

Invoked when the component is added to the document’s DOM.

In connectedCallback() you should setup tasks that should only occur when the element is connected to the document. The most common of these is adding event listeners to nodes external to the element, like a keydown event handler added to the window.

connectedCallback() {
  super.connectedCallback();
  addEventListener('keydown', this._handleKeydown);
}

Typically, anything done in connectedCallback() should be undone when the element is disconnected, in disconnectedCallback().

Source, line 71.

connectedCallback(): void

TsnPrivateValueElement.disconnectedCallback

Invoked when the component is removed from the document’s DOM.

This callback is the main signal to the element that it may no longer be used. disconnectedCallback() should ensure that nothing is holding a reference to the element (such as event listeners added to nodes external to the element), so that it is free to be garbage collected.

disconnectedCallback() {
  super.disconnectedCallback();
  window.removeEventListener('keydown', this._handleKeydown);
}

An element may be re-connected after being disconnected.

Source, line 94.

disconnectedCallback(): void

TsnPrivateValueElement.render

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html’s ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Source, line 186.

render(): TemplateResult<1>

TsnPrivateValueElement.properties (static)

User-supplied object that maps property names to PropertyDeclaration objects containing options for configuring reactive properties. When a reactive property is set the element will update and render.

By default properties are public fields, and as such, they should be considered as primarily settable by element users, either via attribute or the property itself.

Generally, properties that are changed by the element should be private or protected fields and should use the state: true option. Properties marked as state do not reflect from the corresponding attribute

However, sometimes element code does need to set a public property. This should typically only be done in response to user interaction, and an event should be fired informing the user; for example, a checkbox sets its checked property when clicked and fires a changed event. Mutating public properties should typically not be done for non-primitive (object or array) properties. In other cases when an element needs to manage state, a private property set with the state: true option should be used. When needed, state properties can be initialized via public properties to facilitate complex interactions.

Source, line 16.

properties: { tin: { type: StringConstructor; }; field: { type: StringConstructor; }; fallback: { type: StringConstructor; }; ready: { state: boolean; }; loading: { state: boolean; }; copyStatus: { state: boolean; }; }

TsnPrivateValueElement.shadowRootOptions (static)

Options used when calling attachShadow. Set this property to customize the options for the shadowRoot; for example, to create a closed shadowRoot: {mode: 'closed'}.

Note, these options are used in createRenderRoot. If this method is customized, options should be respected if possible.

Source, line 25.

shadowRootOptions: ShadowRootInit

TsnPrivateValueElement.styles (static)

Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn’t support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include ‘unsafe-inline’ or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page’s HTML, before loading application code:

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

Source, line 27.

styles: CSSResult

Direct failure expressions:

new Error("Private value is unavailable")

TsnPrivateValueResolver

Import from @trustlink/tsn-sdk/private-view. Implementation, line 4.

export type TsnPrivateValueResolver = (request: {
  tin: string;
  field: TsnPrivateField;
}) => Promise<string | null>;