@bb-cli/lib-package

Libraries for packaging cxp items

Usage no npm install needed!

<script type="module">
  import bbCliLibPackage from 'https://cdn.skypack.dev/@bb-cli/lib-package';
</script>

README

Modules

@bb-cli/lib-package : object

Packaging methods for creating provisioned packages for CXP

Functions

extractInnerPackage(extractTo) ⇒ Array.<CXPItem>
isUnzippedFile(item) ⇒ Boolean
readInnerZips(unzipped) ⇒ Array.<string>
readManifestCatalogItems(manifestFile) ⇒ Array.<string>
filterCatalogZips(extractTo, unzipped) ⇒ Array.<string>

Typedefs

CxpStaticsPackage : Object

An object that describes a CXP statics package.

CxpStaticsDir : Object

An object that describes a CXP statics directory.

ProvisionPackage : Object

An object that describes a provisioned package.

ProvisionItem : Object

A object that describes a CXPItem that has been packaged.

CXPItem : Object

An object that describes a catalog item in CXP Manager.

@bb-cli/lib-package : object

Packaging methods for creating provisioned packages for CXP

Example
Basic Example

import { packageCxpStatics, packageCxpStaticsDir } from '@bb-cli/bb-package';

extractInnerPackage(extractTo) ⇒ Array.<CXPItem>

Kind: global function

Param Type
extractTo string

isUnzippedFile(item) ⇒ Boolean

Kind: global function

Param Type
item UnzipItem

readInnerZips(unzipped) ⇒ Array.<string>

Kind: global function
Returns: Array.<string> - zip files

Param Type
unzipped Array.<UnzipItem>

readManifestCatalogItems(manifestFile) ⇒ Array.<string>

Kind: global function
Returns: Array.<string> - zip files

Param Type Description
manifestFile string Absolute path to manifest file

filterCatalogZips(extractTo, unzipped) ⇒ Array.<string>

Kind: global function
Returns: Array.<string> - zip files

Param Type Description
extractTo String Abolute path to dir that was unzipped into
unzipped Array.<UnzipItem>

CxpStaticsPackage : Object

An object that describes a CXP statics package.

Kind: global typedef
Properties

Name Type Description
filename string The filename of the package.
files Array.<string> The files in the package.

CxpStaticsDir : Object

An object that describes a CXP statics directory.

Kind: global typedef
Properties

Name Type Description
dir string The directory.
files Array.<string> The files in the directory.

ProvisionPackage : Object

An object that describes a provisioned package.

Kind: global typedef
Properties

Name Type Description
filename string The filename of the provisioned package.
cxpItems Array.<ProvisionItem> The CXP items in the package.

ProvisionItem : Object

A object that describes a CXPItem that has been packaged.

Kind: global typedef
Extends: CXPItem
Properties

Name Type Description
zip string The path to the zipped dist.

CXPItem : Object

An object that describes a catalog item in CXP Manager.

Kind: global typedef
Properties

Name Type Description
name string The CXP item name.
type string The CXP item type.
version string The CXP item version.
srcDir string The path to the item's source on the file system.

~UnzipItem : Object

Kind: inner typedef
Properties

Name Type Description
deflated String Optional name of the unzipped file (not set for directories)