NFT (NetSuite Fasttrack Toolkit) for SuiteScript 2.0

This is all the goodness (and more) of NFT re-imagined for SuiteScript 2.x

This initial preview includes:

• lodash
• momentjs
• nsdal
• logging

Getting Started

First, as usual run:

npm install
typings install # if using typescript

There is a intro/guide here

These instructions are a work in progress. In the steps below replace the #.#.# with the actual version number you see after building the lib.

1. Clone this repository
2. run gulp declarations
3. Copy (or symlink) the /N folder to your project root. This provides the TypeScript declarations for NetSuite built in modules.
4. Symlink the declarations/ folder to local name NFT-SS2-#.#.#. This provides the TypeScript declarations for our custom code.

Deploy core library to NS

• Run gulp which should create a file like dist/NFT-SS2-#.#.#.zip.
• Use the NetSuite file cabinet advanced add to upload the dist/NFT-SS2-#.#.#.zip file to your SuiteScripts folder. Choose to 'extract' all files.

Note: the /N folder is not deployed to NetSuite - it's only used by TypeScript at compile time.

Use

Extract the zip file created above into your project folder such that it has the same relative path structure as in your NetSuite file cabinet. This is to support SuiteScript 2.0 requiring relative paths for custom modules.

If you typically just put your SuiteScripts under the SuiteScripts/ folder directly then simply extract the zip directly into your project folder. The library uses EC_ as a file prefix in the root to help prevent name collisions. It also creates a DataAccess folder, so make sure you don't already have a folder named as such.

NOTE: NetSuite Limitation NetSuite SuiteScript 2.0 appears to have a defect where you can't create a complete sample like shown below with complex custom libraries. To get around this create your script as an empty shell first - then upload the full txt to the file cabinet.

For example, upload something like this as a 'skeleton' Suitelet:

/**
 * Test file for SuiteScript 2.0
 * @NApiVersion 2.x
 * @NScriptType Suitelet
 */
 define([], function () {
     return {
         onRequest: function (req, resp) {
         }
     };
 });

.. then after you create the script record you can upload the full example (replacing the file in the file cabinet)

Reference the NFT modules using relative path names. Here is a complete Suitelet example (TypeScript)

Example.ts

/**
 * Test file for SuiteScript 2.0
 * @NApiVersion 2.x
 * @NScriptType Suitelet
 */
/* these two lines bring lodash into scope for compile time, and add it as a silent dependency of this
 module (in the correct path of ./lodash assuming lodash is installed in the same folder as this script)
 */
///<amd-dependency path="./lodash" name="_" />
///<amd-dependency path="./moment" name="moment" />

import * as LogManager from './NFT-SS2-0.1.0/EC_Logger'
import * as customer from "./NFT-SS2-0.1.0/DataAccess/CustomerBase"
import * as nsdal from "./NFT-SS2-0.1.0/DataAccess/EC_nsdal"

var log = LogManager.DefaultLogger


/**
 * define the nsdal custom record for this client including a couple custom fields
 */
class Customer extends customer.Base {
   @nsdal.FieldType.multiselect
   custentity_multiselect:number[]

   @nsdal.FieldType.datetime
   custentity_shawn_date : moment.Moment
}


export = {

   onRequest: (req, resp) => {

      log.debug('hello world')

      // turn on debug logging for just the nsdal logger
      nsdal.log.setLevel(LogManager.logLevel.debug)

      // load customer internal id 1542
      var c = new Customer(1542)

      // strongly typed field access
      c.companyname = 'a new company name'
      c.custentity_multiselect = [1, 2]
      c.custentity_shawn_date = moment()

      // persist our changes
      c.save();

      // just log a couple properties from our customer object
      log.debug('customer', _.pick(c,['custentity_shawn_date', 'companyname']))

   }
}

AutoLogging

Automatically log entry and exit of methods with rich options by adding a line like this to the end of your script:

LogManager.autoLogMethodEntryExit({target:EC,method:/\w/})

The above line will automatically log all methods defined on the EC object

Compile this with tsc or your favorite IDE (we use Webstorm.) then deploy the resulting .js file to your file cabinet alongside the unzipped NFT.

Contributing

NFT-SS2 is written in typescript, so you'll need the type definitions - run this command:

typings install

Note you need typings version 1.0.4+ We need help defining records and fields for NetSuite - see any of the files under DataAccess/ as a guide.

TypeScript

This is written with TS and is most powerful when consumed by TS. However, it can be used by javascript clients as well.

NetSuite Modules Declarations

The NetSuite bult in modules are declared under the N/ folder, to mimic how they are referenced in the documentation/code.

NSDAL

Define record types under the DataAccess/ folder.

Attributions

• portions of the NetSuite typescript definitions (N/*.d.ts) were based on the netsuite-types project and modified for use here.