Class OmniScriptLwcCompiler

Compiler that transforms activated OmniScripts into LWC components that can easily be deployed or written to the disk.

Index

Constructors

Properties

compiler compilerApiVersion compilerInitialization lwcCompilerResource namespaceService salesforceService

Methods

compile compileToPackage compileToToolingRecord getCompiler getLwcName initializeCompiler

Constructors

constructor

new OmniScriptLwcCompiler(
salesforceService: SalesforceService,
namespaceService: VlocityNamespaceService,
): OmniScriptLwcCompiler
Parameters
- salesforceService: SalesforceService
- namespaceService: VlocityNamespaceService
Returns OmniScriptLwcCompiler
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:71

Properties

`Private`compiler

compiler: OmniCompiler

`Private`compilerApiVersion

compilerApiVersion: string

`Private`compilerInitialization

compilerInitialization: Promise<OmniCompiler> | undefined

`Private` `Readonly`lwcCompilerResource

lwcCompilerResource: "OmniscriptLwcCompiler" = 'OmniscriptLwcCompiler'

`Private` `Readonly`namespaceService

namespaceService: VlocityNamespaceService

`Private` `Readonly`salesforceService

salesforceService: SalesforceService

Methods

compile

compile(
scriptDefinition: OmniScriptDefinition,
options?: OmniCompilerOptions,
): Promise<{ name: string; resources: CompiledResource[] }>
Compiles an OmniScript into LWC components
Parameters
- scriptDefinition: OmniScriptDefinition
  Definition of the OmniScript to compile
- Optionaloptions: OmniCompilerOptions
  Options to control the compilation
Returns Promise<{ name: string; resources: CompiledResource[] }>
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:145

compileToPackage

compileToPackage(
scriptDefinition: OmniScriptDefinition,
options?: OmniCompilerOptions,
): Promise<SalesforcePackage>
Compile and package an OmniScript into a deployable Metadata package
Parameters
- scriptDefinition: OmniScriptDefinition
  Definition of the OmniScript to compile
- Optionaloptions: OmniCompilerOptions
  Options to control the compilation and bundling
Returns Promise<SalesforcePackage>
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:220

compileToToolingRecord

compileToToolingRecord(
    scriptDefinition: OmniScriptDefinition,
    options?: OmniCompilerOptions,
): Promise<
    {
        FullName: string;
        Metadata: {
            apiVersion: any;
            capabilities: { capability: never[] };
            description: any;
            isExposed: any;
            lwcResources: { lwcResource: { filePath: string; source: string }[] };
            masterLabel: any;
            runtimeNamespace: any;
            targetConfigs: string;
            targets: any;
        };
    },
>
Compile an OmniScript into a deployable Salesforce Tooling record
Parameters
- scriptDefinition: OmniScriptDefinition
  Definition of the OmniScript to compile
- Optionaloptions: OmniCompilerOptions
  Options to control the compilation
Returns Promise<
    {
        FullName: string;
        Metadata: {
            apiVersion: any;
            capabilities: { capability: never[] };
            description: any;
            isExposed: any;
            lwcResources: { lwcResource: { filePath: string; source: string }[] };
            masterLabel: any;
            runtimeNamespace: any;
            targetConfigs: string;
            targets: any;
        };
    },
>
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:177

`Private`getCompiler

getCompiler(): Promise<OmniCompiler>
Get the OmniScript LWC compiler from the target org; the compiler is fetched and initialized once on first use -- not at construction as fetching requires org access and loading the compiler is expensive -- and concurrent callers await the same initialization.

Returns Promise<OmniCompiler>
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:81

`Private`getLwcName

getLwcName(script: OmniScriptSpecification): string
Generated the LWC component name from the OmniScript definition
Parameters
- script: OmniScriptSpecification
  Definition of the OmniScript for which to generate the name
Returns string
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:240

`Private`initializeCompiler

initializeCompiler(): Promise<OmniCompiler>
Returns Promise<OmniCompiler>
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:89