Class OmniScriptLwcCompiler

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

Hierarchy

OmniScriptLwcCompiler

Index

Constructors

constructor

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

Properties

`Private` compiler

compiler: OmniCompiler

`Private` compilerApiVersion

compilerApiVersion: string

`Private` `Readonly` lwcCompilerResource

lwcCompilerResource: "OmniscriptLwcCompiler" = 'OmniscriptLwcCompiler'

`Private` `Readonly` namespaceService

namespaceService: VlocityNamespaceService

`Private` `Readonly` salesforceService

salesforceService: SalesforceService

Methods

compile

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

compileToPackage

compileToPackage(scriptDefinition, options?): Promise<SalesforcePackage>
Compile and package an OmniScript into a deployable Metadata package
Parameters
- scriptDefinition: OmniScriptDefinition
  
  Definition of the OmniScript to compile
- Optional options: {
  apiVersion?: string;
  lwcName?: string;
  }
  
  Options to control the compilation and bundling
  - Optional apiVersion?: string
  - Optional lwcName?: string
Returns Promise<SalesforcePackage>
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:154

compileToToolingRecord

compileToToolingRecord(scriptDefinition, options?): 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
- Optional options: {
  lwcName?: string;
  }
  
  Options to control the compilation
  - Optional lwcName?: string
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:109

`Private` getCompiler

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

`Private` getLwcName

getLwcName(script): string
Generated the LWC component name from the OmniScript definition
Parameters
- script: OmniScriptSpecification
Returns string
- Defined in packages/omniscript/src/omniScriptLwcCompiler.ts:174

Class OmniScriptLwcCompiler

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

salesforceService: SalesforceService

namespaceService: VlocityNamespaceService

Returns OmniScriptLwcCompiler

Properties

Private compiler

Private compilerApiVersion

Private Readonly lwcCompilerResource

Private Readonly namespaceService

Private Readonly salesforceService

Methods

compile

Parameters

scriptDefinition: OmniScriptDefinition

Optional options: { lwcName?: string; }

Optional lwcName?: string

Returns Promise<{ name: string; resources: CompiledResource[]; }>

compileToPackage

Parameters

scriptDefinition: OmniScriptDefinition

Optional options: { apiVersion?: string; lwcName?: string; }

Optional apiVersion?: string

Optional lwcName?: string

Returns Promise<SalesforcePackage>

compileToToolingRecord

Parameters

scriptDefinition: OmniScriptDefinition

Optional options: { lwcName?: string; }

Optional lwcName?: string

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; }; }>

Private getCompiler

Returns Promise<OmniCompiler>

Private getLwcName

Parameters

script: OmniScriptSpecification

Returns string

Settings

Member Visibility

Theme

On This Page

`Private` compiler

`Private` compilerApiVersion

`Private` `Readonly` lwcCompilerResource

`Private` `Readonly` namespaceService

`Private` `Readonly` salesforceService

`Optional` options: {
lwcName?: string;
}

`Optional` lwcName?: string

Returns Promise<{
name: string;
resources: CompiledResource[];
}>

`Optional` options: {
apiVersion?: string;
lwcName?: string;
}

`Optional` apiVersion?: string

`Optional` lwcName?: string

`Optional` options: {
lwcName?: string;
}

`Optional` lwcName?: string

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;
};
}>

`Private` getCompiler

`Private` getLwcName