NS-SDK

A comprehensive NetSuite SuiteScript Development SDK providing libraries for search conversion, error handling, OAuth authentication, record operations, and more.

Features

- SuiteQLHelper - Convert NetSuite Saved Searches to SuiteQL queries automatically
- Currency - Precision currency handling with integer-based arithmetic
- searchHelper - Utilities for working with N/search API
- recordHelper - Record operation helpers
- errorHelper - Standardized error handling and logging
- oauth1.0 - OAuth 1.0 authentication utilities
- Third-party libraries - Moment.js and PapaParse for date/time and CSV handling

Installation

$3

1. Enable SDF for your NetSuite Account
- NetSuite SDF Setup Guide

2. Install SDF CLI locally
- SDF CLI Installation Guide

$3

1. Clone this repository
2. Deploy the src folder to NetSuite using SDF
3. Add the following to your script headers for shorthand library access:
``javascript
/**
* @NAmdConfig /SuiteScripts/NS-SDK/ns-sdk-amd.json
*/
`

Quick Start

$3

`javascript
define(['N/query', 'SuiteQLHelper'], function(query, SuiteQLHelper) {
// Convert a saved search to SuiteQL
const result = SuiteQLHelper.convertSearchToSuiteQL({ id: 2413 });
const sqlQuery = result.sql;

// Run the query
const results = query.runSuiteQL({ query: sqlQuery }).asMappedResults();
});
`

$3

`javascript
define(['Currency'], function(Currency) {
const amount = new Currency(100.50);
const tax = amount.multiply(0.08);
const total = amount.add(tax);

// Works directly with NetSuite fields
record.setValue('amount', total); // Sets 108.54
});
`

$3

`javascript
define(['N/search', 'searchHelper'], function(search, searchHelper) {
const mySearch = search.create({
type: search.Type.TRANSACTION,
filters: [['type', 'anyof', 'SalesOrd']],
columns: ['tranid', 'trandate', 'amount']
});

// Get all results as JSON
const results = searchHelper.getAllResults(mySearch, true, true);
});
`

Library Documentation

- Currency.js - Precision currency calculations
- Currency Code Review - Implementation analysis
- searchHelper.js - Search utilities
- errorHelper.js - Error handling
- SuiteQL Conversion Guide - Detailed conversion documentation
- Project Guide - Comprehensive project documentation

Development

$3

`bash
npm test # Run all tests
npm run test:watch # Run tests in watch mode
npm run test:coverage # Generate coverage report
`

$3

`bash
npm run lint # Check for linting errors
npm run lint:fix # Fix linting errors automatically
`

VS Code Snippets

This project includes VS Code snippets for NetSuite script boilerplate. The snippets are automatically available when you open this project in VS Code.

Available snippets:
- ue-before - User Event Before Submit
- ue-after - User Event After Submit
- mr-getinput - Map/Reduce Get Input Stage
- mr-map - Map/Reduce Map Stage
- mr-reduce - Map/Reduce Reduce Stage
- mr-summarize - Map/Reduce Summarize Stage
- And more...

Project Structure

`
ns-sdk/
├── src/FileCabinet/SuiteScripts/NS-SDK/
│ ├── lib/ # Core libraries
│ │ ├── SuiteQLHelper.js # Search to SuiteQL converter
│ │ ├── Currency.js # Precision currency handling
│ │ ├── searchHelper.js # Search utilities
│ │ ├── recordHelper.js # Record operations
│ │ ├── errorHelper.js # Error handling
│ │ ├── oauth1.0.js # OAuth utilities
│ │ ├── moment.min.js # Date/time library
│ │ └── papaparse.min.js # CSV parsing
│ └── ns-sdk-amd.json # AMD module config
├── test/ # Unit tests
├── docs/ # Documentation
├── .vscode/ # VS Code snippets
└── .claude/ # AI assistant documentation
``

Contributing

This is an internal development SDK for DKODEMONKEY LLC. For issues or questions, please contact the development team.

License

MIT

Author

DKODEMONKEY LLC