@acoustic-content-sdk/tooling-contributions

Tooling functions to implement support for feature modules.

Usage no npm install needed!

<script type="module">
  import acousticContentSdkToolingContributions from 'https://cdn.skypack.dev/@acoustic-content-sdk/tooling-contributions';
</script>

README

npm

Tooling functions to implement support for feature modules.

API Documentation

Home > @acoustic-content-sdk/tooling-contributions

tooling-contributions package

Tooling functions to implement support for feature modules.

Enumerations

Enumeration Description
ArtifactMode Artifact modes, the values need to match the option selections for the Page Contribution type 354743b2-f89a-482b-b447-2b5a2367c8bd

Functions

Function Description
createNgDriverArtifacts(aHost, aReadDir, aSchema) Generates the content items that describe a driver based on an Angular build output
createPackageArtifacts(aHost, aSchema, aLogSvc) Generates the content items that describe a driver based on an Angular build output

Interfaces

Interface Description
CreateNgDriverArtifactsSchema
CreatePackageFromArtifactsSchema

Variables

Variable Description
VERSION Version and build number of the package

Home > @acoustic-content-sdk/tooling-contributions > ArtifactMode

ArtifactMode enum

Artifact modes, the values need to match the option selections for the Page Contribution type 354743b2-f89a-482b-b447-2b5a2367c8bd

Signature:

export declare enum ArtifactMode

Enumeration Members

Member Value Description
ALWAYS "always"
LIVE "live"
PREVIEW "preview"

Home > @acoustic-content-sdk/tooling-contributions > createNgDriverArtifacts

createNgDriverArtifacts() function

Generates the content items that describe a driver based on an Angular build output

Signature:

export declare function createNgDriverArtifacts(aHost: ReadTextFile, aReadDir: ReadDirectory, aSchema?: CreateNgDriverArtifactsSchema): Observable<FileDescriptor<Artifact | Buffer>>;

Parameters

Parameter Type Description
aHost ReadTextFile callback to read a text file
aReadDir ReadDirectory
aSchema CreateNgDriverArtifactsSchema configuration

Returns:

Observable<FileDescriptor<Artifact | Buffer>>

the sequence of artifacts

Home > @acoustic-content-sdk/tooling-contributions > createPackageArtifacts

createPackageArtifacts() function

Generates the content items that describe a driver based on an Angular build output

Signature:

export declare function createPackageArtifacts(aHost: ReadTextFile, aSchema?: CreatePackageFromArtifactsSchema, aLogSvc?: LoggerService): Observable<FileDescriptor<any>>;

Parameters

Parameter Type Description
aHost ReadTextFile callback to read a text file
aSchema CreatePackageFromArtifactsSchema configuration
aLogSvc LoggerService

Returns:

Observable<FileDescriptor<any>>

the sequence of artifacts

Home > @acoustic-content-sdk/tooling-contributions > CreateNgDriverArtifactsSchema

CreateNgDriverArtifactsSchema interface

Signature:

export interface CreateNgDriverArtifactsSchema

Properties

Property Type Description
configuration string The name of the configuration to use
mode string mode
project string The name of the project.
tag string a comma separated list of tags

Home > @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema

CreatePackageFromArtifactsSchema interface

Signature:

export interface CreatePackageFromArtifactsSchema

Properties

Property Type Description
data string Location of the data directory, defaults to 'data'. The package artifacts will be created in the parent folder of the data folder
files$ Observable<FileDescriptor<any>> optionally the explicit list of files to include
license string optinally the license, defaults to MIT
tag string a comma separated list of tags

Home > @acoustic-content-sdk/tooling-contributions > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/tooling-contributions > CreateNgDriverArtifactsSchema > configuration

CreateNgDriverArtifactsSchema.configuration property

The name of the configuration to use

Signature:

configuration?: string;

Home > @acoustic-content-sdk/tooling-contributions > CreateNgDriverArtifactsSchema > mode

CreateNgDriverArtifactsSchema.mode property

mode

Signature:

mode?: string;

Home > @acoustic-content-sdk/tooling-contributions > CreateNgDriverArtifactsSchema > project

CreateNgDriverArtifactsSchema.project property

The name of the project.

Signature:

project?: string;

Home > @acoustic-content-sdk/tooling-contributions > CreateNgDriverArtifactsSchema > tag

CreateNgDriverArtifactsSchema.tag property

a comma separated list of tags

Signature:

tag?: string;

Home > @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema > data

CreatePackageFromArtifactsSchema.data property

Location of the data directory, defaults to 'data'. The package artifacts will be created in the parent folder of the data folder

Signature:

data?: string;

Home > @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema > files$

CreatePackageFromArtifactsSchema.files$ property

optionally the explicit list of files to include

Signature:

files$?: Observable<FileDescriptor<any>>;

Home > @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema > license

CreatePackageFromArtifactsSchema.license property

optinally the license, defaults to MIT

Signature:

license?: string;

Home > @acoustic-content-sdk/tooling-contributions > CreatePackageFromArtifactsSchema > tag

CreatePackageFromArtifactsSchema.tag property

a comma separated list of tags

Signature:

tag?: string;