crownpeak-dxm-accessapi-helper v1.1.0

Crownpeak Digital Experience Management (DXM) Access API Helper for Node

Crownpeak Digital Experience Management (DXM) Access API Helper for Node has been constructed to assist in developing client-side applications that leverage DXM for content management purposes.

Usage

Installation instructions:

npm i crownpeak-dxm-accessapi-helper --save-dev

or 

yarn add crownpeak-dxm-accessapi-helper

In your application, make a reference to the API class:

const CrownpeakApi = require('crownpeak-dxm-accessapi-helper');
const crownpeak = new CrownpeakApi();

See https://developer.crownpeak.com/Documentation/AccessAPI/index.html for a full guide to using the Crownpeak DXM Access API.

Logging in

Before you are able to call any functions within the Access API, you must first login to your CMS instance.

crownpeak.login(
    "username",
    "password",
    "cms.crownpeak.net",
    "cms-instance",
    "api-key"
);

Asset functions

Example

Some functions take simple parameters, such as an asset id, whereas others require a Request object to be created. For example, to create an asset, use the CreateRequest class:

const request = new crownpeak.Asset.CreateRequest(
    name, 
    destinationFolderId,
    modelId,
    type, // 2 for a file, or 4 for a folder, see crownpeak.Util.AssetType
    devTemplateLanguage,
    templateId,
    workflowId,
    subtype // see crownpeak.Util.AssetSubType
);

Once created, pass this request to the appropriate function:

let response = await crownpeak.Asset.create(request);

The response will contain a number of standard properties, plus one or more others that are specific to the type of request that was made. The standard properties are:

{
    "resultCode": "conWS_Success", // See crownpeak.Util.ResponseMessages
    "errorMessage": "",
    "internalCode": 0,
    "isSuccessful": true
}

You should test the isSuccessful property before attempting to read other properties.

For asset functions, commonly an asset will also be returned, for example:

{
    "asset": {
        "id": 12345,
        "label": "My Test Asset",
        "type": 2,
        "folder_id": 1234,
        // [...]
    }
}

Attach a file to an asset

To attach a digital file to a templated asset, use the attach function:

const request = new crownpeak.AccessAsset.AttachRequest(
    assetId,
    bytes, // Base64-encoded string containing the file contents
    originalFilename
);
let response = await crownpeak.Asset.attach(request);

Branch

To branch an asset, use the branch function:

let response = await crownpeak.Asset.branch(assetId);

Create

To create an asset, use the create function, passing in an instance of the Asset.CreateRequest class:

const request = new crownpeak.Asset.CreateRequest(
    name, 
    destinationFolderId,
    modelId,
    type, // 2 for a file, or 4 for a folder, see crownpeak.Util.AssetType
    devTemplateLanguage,
    templateId,
    workflowId,
    subtype
);
let response = await crownpeak.Asset.create(request);

Create a folder with a model

To create a folder with a model, use the createFolderWithModel function, passing in an instance of the Asset.CreateFolderWithModelRequest class:

const request = new crownpeak.Asset.CreateFolderWithModelRequest(
    name, 
    destinationFolderId,
    modelId
);
let response = await crownpeak.Asset.createFolderWithModel(request);

Create a library reference

To create a library reference, use the createLibraryReference function, passing in an instance of the Asset.CreateLibraryReferenceRequest class:

const request = new crownpeak.Asset.CreateLibraryReferenceRequest(
    name, 
    destinationFolderId,
    libraryId
);
let response = await crownpeak.Asset.createLibraryReference(request);

Create a project

To create a project, use the createProject function, passing in an instance of the Asset.CreateProjectRequest class:

const request = new crownpeak.Asset.CreateProjectRequest(
    name, 
    destinationFolderId,
    libraryName,              // optional
    installComponentLibrary,
    componentLibraryVersion,  // "2.1"
    rebuildSite
);
let response = await crownpeak.Asset.createProject(request);

Create a site root

To create a project, use the createSiteRoot function, passing in an instance of the Asset.CreateSiteRootRequest class:

const request = new crownpeak.Asset.CreateSiteRootRequest(
    name, 
    destinationFolderId,
    installCL,
    rebuildCL,
    versionCL            // "2.1"
);
let response = await crownpeak.Asset.createSiteRoot(request);

Note that a site root cannot be created as a descendant of another site root.

Download an asset as a Buffer

To download an asset into a Buffer, use the downloadAsBuffer function, passing in an instance of the Asset.DownloadPrepareRequest class:

const request = new crownpeak.Asset.DownloadPrepareRequest(
    assetIds // array of ints
);
let response = await crownpeak.Asset.downloadAsBuffer(request);

Download an asset as a string

To download an asset into a string, use the downloadAsString function, passing in an instance of the Asset.DownloadPrepareRequest class:

const request = new crownpeak.Asset.DownloadPrepareRequest(
    assetIds // array of ints
);
let response = await crownpeak.Asset.downloadAsString(request);

Download a file attached to an asset as a Buffer

To download a file attached to an asset into a Buffer, use the downloadAttachmentAsBuffer function, passing in a string containing the attachment path, which can be found in the previewUrl property of attachments returned from calls to AssetProperties.attachments:

let response = await crownpeak.Asset.downloadAttachmentAsBuffer(path);

Download a file attached to an asset as a string

To download a file attached to an asset into a string, use the downloadAttachmentAsString function, passing in a string containing the attachment path, which can be found in the previewUrl property of attachments returned from calls to AssetProperties.attachments:

let response = await crownpeak.Asset.downloadAttachmentAsString(path, optionalEncoding);

Delete

To delete an asset, use the delete function:

let response = await crownpeak.Asset.delete(assetId);

Execute a workflow command

To execute a workflow command on an asset, use the executeWorkflowCommand function, passing in an instance of the Asset.ExecuteWorkflowCommandRequest class:

const request = new crownpeak.Asset.ExecuteWorkflowCommandRequest(
    assetId,
    commandId,
    skipDependencies
);
let response = await crownpeak.Asset.executeWorkflowCommand(request);

Exists

To test if an asset exists, use the exists function:

let response = await crownpeak.Asset.exists(assetIdOrPath);

Fields

To retrieve the fields and values for an asset, use the fields function:

let response = await crownpeak.Asset.fields(assetId);

Log

To store a message on the Audit log, use the log function:

let response = await crownpeak.Asset.log(log, optionalAssetId);

If an asset id is provided, the log entry will be created against that specific asset.

Move

To move an asset to a different parent folder, use the move function, passing in an instance of the Asset.MoveRequest class:

const request = new crownpeak.Asset.MoveRequest(
    assetId,
    destinationFolderId
);
let response = await crownpeak.Asset.move(request);

Paged list of children

To fetch the child assets contained within a folder, use the paged function, passing in an instance of the Asset.PagedRequest class:

const request = new crownpeak.Asset.PagedRequest(
    assetId,
    assetIdToFindPage, // Leave blank if you're not looking for a particular asset
    currentPage,       // 0-based page index
    ignoreFilter,
    ignoreSort,
    orderType,         // See crownpeak.Util.OrderType
    number,            // the number of records to fetch on each page
    saveSort,          // TODO
    sortColumn,        // The column name to sort by
    visibilityType,    // See crownpeak.Util.VisibilityType
    filter             // A filter object to be used - optional
);
let response = await crownpeak.Asset.paged(request);

Publish

To publish an asset that is not in workflow, use the publish function, passing in an instance of the Asset.PublishRequest class:

const request = new crownpeak.Asset.PublishRequest(
    assetIds, // array of ints
    skipDependencies
);
let response = await crownpeak.Asset.publish(request);

Publish refresh

To refresh the publishing for a folder, use the publishRefresh function, passing in an instance of the Asset.PublishRefreshRequest class:

const request = new crownpeak.Asset.PublishRefreshRequest(
    assetIds,           // array of ints
    publishingServerId, // the id of the publishing package to refresh
    skipDependencies
);
let response = await crownpeak.Asset.publishRefresh(request);

Read

To read information about an asset, use the read function:

let response = await crownpeak.Asset.read(assetId);

Rename

To rename an asset, use the rename function, passing in an instance of the Asset.RenameRequest class:

const request = new crownpeak.Asset.RenameRequest(
    assetId,
    newName
);
let response = await crownpeak.Asset.rename(request);

Route

To route an asset to a particular workflow state, use the route function, passing in an instance of the Asset.RouteRequest class:

const request = new crownpeak.Asset.RouteRequest(
    assetId,
    stateId // the id of the state required, found in /System/States
);
let response = await crownpeak.Asset.route(request);

Undelete

To undelete an asset, use the undelete function:

let response = await crownpeak.Asset.undelete(assetId);

Update

To update the fields and values for an asset, use the update function, passing in an instance of the Asset.UpdateRequest class:

const request = new crownpeak.Asset.UpdateRequest(
    assetId,
    fields,         // json object containing fields and values
    fieldsToDelete, // array of strings containing field names
    runPostInput,
    runPostSave
);
let response = await crownpeak.Asset.update(request);

Upload

To upload a binary file to a new digital asset, use the upload function, passing in an instance of the Asset.UploadRequest class:

const request = new crownpeak.Asset.UploadRequest(
    bytes, // Base64-encoded string containing the file contents
    destinationFolderId,
    modelId,
    name,
    workflowId
);
let response = await crownpeak.Asset.upload(request);

Asset Properties functions

Example

All asset properties functions take simple parameters or none at all.

let response = await crownpeak.AssetProperties.setWorkflow([123], 0);

The response will contain a number of standard properties, plus one or more others that are specific to the type of request that was made. The standard properties are:

{
    "resultCode": "conWS_Success", // See crownpeak.Util.ResponseMessages
    "errorMessage": "",
    "internalCode": 0,
    "isSuccessful": true
}

You should test the isSuccessful property before attempting to read other properties.

Attachments

To get the attachments for an asset, use the attachments function:

let response = await crownpeak.AssetProperties.attachments(
    asset_id,     // the asset id to fetch the attachments for
);

Set Template

To set the template details for one or more assets, use the setTemplate function:

let response = await crownpeak.AssetProperties.setTemplate(
    [asset_ids ...],     // array of asset ids to set the template for
    templateId,          // the template id to set for the assets
    isDeveloperTemplate // true if this is a DeveloperCS template, or false if not
);

Set Workflow

To set the workflow details for one or more assets, use the setWorkflow function:

let response = await crownpeak.AssetProperties.setWorkflow(
    [asset_ids ...],     // array of asset ids to set the workflow for
    workflowId           // the workflow id to set for the assets
);

Report functions

Example

All report functions take simple parameters or none at all.

let response = await crownpeak.Report.siteSummary();

The response will contain a number of standard properties, plus one or more others that are specific to the type of request that was made. The standard properties are:

{
    "resultCode": "conWS_Success", // See crownpeak.Util.ResponseMessages
    "errorMessage": "",
    "internalCode": 0,
    "isSuccessful": true
}

You should test the isSuccessful property before attempting to read other properties.

For report functions, commonly a reportData object will also be returned, for example:

{
    "reportData": {
        // [...]
    }
}

Site Summary

To read a site summary report from the CMS, use the siteSummary function:

let response = await crownpeak.Report.siteSummary();

Tools functions

Example

All tools functions take simple parameters.

let response = await crownpeak.Tools.recompileLibrary(1234);

The response will contain a number of standard properties, plus one or more others that are specific to the type of request that was made. The standard properties are:

{
    "resultCode": "conWS_Success", // See crownpeak.Util.ResponseMessages
    "errorMessage": "",
    "internalCode": 0,
    "isSuccessful": true
}

You should test the isSuccessful property before attempting to read other properties.

#### Recompile Library

To recompile a Library folder, use the ```recompileLibrary``` function:

```javascript
let response = await crownpeak.Tools.recompileLibrary(folderId);

Recompile Project

To recompile a Project, use the recompileProject function:

let response = await crownpeak.Tools.recompileProject(projectId);

Recompile Templates

To recompile the templates in a folder, use the recompileTemplates function:

let response = await crownpeak.Tools.recompileTemplates(folderId);

User functions

Example

The listUsers function takes no paraneters, but the createUser function requires a Request object to be created.

let response = await crownpeak.User.listUsers();

The response will contain a number of standard properties, plus one or more others that are specific to the type of request that was made. The standard properties are:

{
    "resultCode": "conWS_Success", // See crownpeak.Util.ResponseMessages
    "errorMessage": "",
    "internalCode": 0,
    "isSuccessful": true
}

You should test the isSuccessful property before attempting to read other properties.

For user functions, commonly a users array will also be returned, for example:

{
    "users": [
        {
            "id": 123,
            "username": "test-user@test.com",
            "fname": "Test",
            "lname": "User",
            "fullName": "Test User",
            "email": "test-user@test.com",
            // [...]
        },
        // [...]
    ]
}

Create

To create a user, use the createUser function, passing in an instance of the User.UserCreateRequest class:

const request = new crownpeak.User.UserCreateRequest(
    username, 
    emailAddress,
    firstName,
    lastName,
    password // defaults to null, which will auto-generate a new password for the new user
);
let response = await crownpeak.User.createUser(request);

Get list

To read all users contained within the CMS, use the listUsers function:

let response = await crownpeak.User.listUsers();

Workflow functions

Example

All workflow functions take simple parameters or none at all.

let response = await crownpeak.Workflow.read(workflowId);

The response will contain a number of standard properties, plus one or more others that are specific to the type of request that was made. The standard properties are:

{
    "resultCode": "conWS_Success", // See crownpeak.Util.ResponseMessages
    "errorMessage": "",
    "internalCode": 0,
    "isSuccessful": true
}

You should test the isSuccessful property before attempting to read other properties.

For workflow functions, commonly a workflow object will also be returned, for example:

{
    "workflow": {
        "id": 12345,
        "name": "My Test Asset",
        // [...]
    }
}

Get list

To read all workflows contained within the CMS, use the getList function:

let response = await crownpeak.Workflow.getList();

Read

To read a single workflow, use the read function:

let response = await crownpeak.Workflow.read(workflowId);

Version History

Credit

Thanks to:

• David Greenberg for the original version of the helper;
• Richard Lund for the refactoring;
• Paul Taylor for a few edits ;)
• Marcus Edwards for the AssetProperties work and tidying up
• Brad Thompson for refactoring to use node-fetch and sorting out all the failing unit tests

License

MIT License

Copyright (c) 2023 Crownpeak Technology, inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.