## Modules

<dl>
<dt><a href="#module_@bb-cli/lib-package">@bb-cli/lib-package</a> : <code>object</code></dt>
<dd><p>Packaging methods for creating provisioned packages for CXP</p>
</dd>
</dl>

## Functions

<dl>
<dt><a href="#extractInnerPackage">extractInnerPackage(extractTo)</a> ⇒ <code><a href="#CXPItem">Array.&lt;CXPItem&gt;</a></code></dt>
<dd></dd>
<dt><a href="#isUnzippedFile">isUnzippedFile(item)</a> ⇒ <code>Boolean</code></dt>
<dd></dd>
<dt><a href="#readInnerZips">readInnerZips(unzipped)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
<dd></dd>
<dt><a href="#readManifestCatalogItems">readManifestCatalogItems(manifestFile)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
<dd></dd>
<dt><a href="#filterCatalogZips">filterCatalogZips(extractTo, unzipped)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
<dd></dd>
</dl>

## Typedefs

<dl>
<dt><a href="#CxpStaticsPackage">CxpStaticsPackage</a> : <code>Object</code></dt>
<dd><p>An object that describes a CXP statics package.</p>
</dd>
<dt><a href="#CxpStaticsDir">CxpStaticsDir</a> : <code>Object</code></dt>
<dd><p>An object that describes a CXP statics directory.</p>
</dd>
<dt><a href="#ProvisionPackage">ProvisionPackage</a> : <code>Object</code></dt>
<dd><p>An object that describes a provisioned package.</p>
</dd>
<dt><a href="#ProvisionItem">ProvisionItem</a> : <code>Object</code></dt>
<dd><p>A object that describes a CXPItem that has been packaged.</p>
</dd>
<dt><a href="#CXPItem">CXPItem</a> : <code>Object</code></dt>
<dd><p>An object that describes a catalog item in CXP Manager.</p>
</dd>
</dl>

<a name="module_@bb-cli/lib-package"></a>

## @bb-cli/lib-package : <code>object</code>
Packaging methods for creating provisioned packages for CXP

**Example**  
Basic Example

```javascript
import { packageCxpStatics, packageCxpStaticsDir } from '@bb-cli/bb-package';
```
<a name="extractInnerPackage"></a>

## extractInnerPackage(extractTo) ⇒ <code>[Array.&lt;CXPItem&gt;](#CXPItem)</code>
**Kind**: global function  

| Param | Type |
| --- | --- |
| extractTo | <code>string</code> | 

<a name="isUnzippedFile"></a>

## isUnzippedFile(item) ⇒ <code>Boolean</code>
**Kind**: global function  

| Param | Type |
| --- | --- |
| item | <code>[UnzipItem](#UnzipItem)</code> | 

<a name="readInnerZips"></a>

## readInnerZips(unzipped) ⇒ <code>Array.&lt;string&gt;</code>
**Kind**: global function  
**Returns**: <code>Array.&lt;string&gt;</code> - zip files  

| Param | Type |
| --- | --- |
| unzipped | <code>[Array.&lt;UnzipItem&gt;](#UnzipItem)</code> | 

<a name="readManifestCatalogItems"></a>

## readManifestCatalogItems(manifestFile) ⇒ <code>Array.&lt;string&gt;</code>
**Kind**: global function  
**Returns**: <code>Array.&lt;string&gt;</code> - zip files  

| Param | Type | Description |
| --- | --- | --- |
| manifestFile | <code>string</code> | Absolute path to manifest file |

<a name="filterCatalogZips"></a>

## filterCatalogZips(extractTo, unzipped) ⇒ <code>Array.&lt;string&gt;</code>
**Kind**: global function  
**Returns**: <code>Array.&lt;string&gt;</code> - zip files  

| Param | Type | Description |
| --- | --- | --- |
| extractTo | <code>String</code> | Abolute path to dir that was unzipped into |
| unzipped | <code>[Array.&lt;UnzipItem&gt;](#UnzipItem)</code> |  |

<a name="CxpStaticsPackage"></a>

## CxpStaticsPackage : <code>Object</code>
An object that describes a CXP statics package.

**Kind**: global typedef  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| filename | <code>string</code> | The filename of the package. |
| files | <code>Array.&lt;string&gt;</code> | The files in the package. |

<a name="CxpStaticsDir"></a>

## CxpStaticsDir : <code>Object</code>
An object that describes a CXP statics directory.

**Kind**: global typedef  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| dir | <code>string</code> | The directory. |
| files | <code>Array.&lt;string&gt;</code> | The files in the directory. |

<a name="ProvisionPackage"></a>

## ProvisionPackage : <code>Object</code>
An object that describes a provisioned package.

**Kind**: global typedef  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| filename | <code>string</code> | The filename of the provisioned package. |
| cxpItems | <code>[Array.&lt;ProvisionItem&gt;](#ProvisionItem)</code> | The CXP items in the package. |

<a name="ProvisionItem"></a>

## ProvisionItem : <code>Object</code>
A object that describes a CXPItem that has been packaged.

**Kind**: global typedef  
**Extends:** <code>[CXPItem](#CXPItem)</code>  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| zip | <code>string</code> | The path to the zipped dist. |

<a name="CXPItem"></a>

## CXPItem : <code>Object</code>
An object that describes a catalog item in CXP Manager.

**Kind**: global typedef  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | The CXP item name. |
| type | <code>string</code> | The CXP item type. |
| version | <code>string</code> | The CXP item version. |
| srcDir | <code>string</code> | The path to the item's source on the file system. |

<a name="UnzipItem"></a>

## ~UnzipItem : <code>Object</code>
**Kind**: inner typedef  
**Properties**

| Name | Type | Description |
| --- | --- | --- |
| deflated | <code>String</code> | Optional name of the unzipped file (not set for directories) |