feat: add RESTlet support

- Adds the ability to use a RESTlet URL in place of the REST api by extending the `client.request()` method

Author: steven-t-h

restlet-demo.js

@@ -0,0 +1,32 @@
+/**
+ * @NAPIVersion 2.0
+ * @NScriptType Restlet
+ */
+
+/*
+This file was generated via the
+headintheclouds [typings-suitescript-2.0[(https://github.com/headintheclouddev/typings-suitescript-2.0) project.
+
+It can be deployed as a restlet and will return a successful response to any GET request.
+ */
+
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+define(["N/log"], function (log_1) {
+    var exports = {};
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.get = void 0;
+    log_1 = __importDefault(log_1);
+    var get = function (requestParams) {
+        log_1.default.debug({
+            title: 'GET Request',
+            details: requestParams,
+        });
+        return {
+            success: true,
+        };
+    };
+    exports.get = get;
+    return exports;
+});

src/client.ts

@@ -70,17 +70,20 @@ export default class NetsuiteApiClient {
    * @returns
    */
   public async request(opts: NetsuiteRequestOptions) {
-    const { path = "*", method = "GET", body = "", heads = {} } = opts;
+    const { path = "*", method = "GET", body = "", heads = {}, restletUrl } = opts;
     const cleanPath = removeLeadingSlash(path);
     // Set up the Request URI
-    let uri;
-    if (this.base_url) {
-        uri = `${this.base_url}/services/rest/${cleanPath}`
-    } else {
-      // as suggested by dylbarne in #15: sanitize url to enhance overall usability
-      uri = `https://${this.realm
+
+    // as suggested by dylbarne in #15: sanitize url to enhance overall usability
+    let uri = `https://${this.realm
         .toLowerCase()
         .replace("_", "-")}.suitetalk.api.netsuite.com/services/rest/${cleanPath}`;
+    if (this.base_url) {
+        uri = `${this.base_url}/services/rest/${cleanPath}`
+    }
+    // if restletUrl is provided, use it instead of the default uri
+    if (restletUrl) {
+      uri = restletUrl;
     }
 
     const options = {

src/types.ts

@@ -1,3 +1,6 @@
+import type {Buffer} from "node:buffer";
+import type {Readable} from "node:stream";
+
 export type NetsuiteOptions = {
   consumer_key: string;
   consumer_secret_key: string;
@@ -7,13 +10,25 @@ export type NetsuiteOptions = {
   base_url?: string;
 };
 
-export type NetsuiteRequestOptions = {
-  path?: string;
-  method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options';
-  body?: any;
-  heads?: any;
+type BaseRequestOptions = {
+    /**
+     * The HTTP method to use
+     */
+    method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options';
+    /**
+     * The body of the request
+     */
+    body?: string;
+    /**
+     * Additional headers to send with the request
+     */
+    heads?: any;
 };
 
+export type NetsuiteRequestOptions =
+    | (BaseRequestOptions & { path?: string; restletUrl?: never })
+    | (BaseRequestOptions & { path?: never; restletUrl?: string });
+
 export type NetsuiteResponse = {
   statusCode: number;
   headers: NodeJS.Dict<string | string[]>;

test/basic.test.ts

@@ -1,5 +1,5 @@
 import "dotenv/config";
-import NetsuiteApiClient from "../src/client";
+import NetsuiteApiClient from "../src/client.js";
 import { beforeAll, describe, expect, it } from "vitest";
 
 let client: NetsuiteApiClient;

test/query.test.ts

@@ -1,5 +1,5 @@
 import "dotenv/config";
-import NetsuiteApiClient from "../src/client";
+import NetsuiteApiClient from "../src/client.js";
 import { beforeAll, describe, expect, it } from "vitest";
 
 let client: NetsuiteApiClient;

test/request.test.ts

@@ -1,5 +1,5 @@
 import "dotenv/config";
-import NetsuiteApiClient from "../src/client";
+import NetsuiteApiClient from "../src/client.js";
 import { describe, expect, test, beforeAll, afterAll, it } from "vitest";
 
 describe("Test request method", () => {
@@ -13,7 +13,8 @@ describe("Test request method", () => {
       process.env.token == undefined ||
       process.env.token_secret == undefined ||
       process.env.realm == undefined ||
-      process.env.base_url == undefined
+      process.env.base_url == undefined ||
+      process.env.restlet_url == undefined
     ) {
       throw new Error("Please create a `.env` file based on `.env.sample`");
     }
@@ -45,6 +46,18 @@ describe("Test request method", () => {
     expect(response.statusCode).toEqual(204);
   });
 
+  // it('should make a RESTlet request', async () => {
+  //   expect.assertions(1);
+  //   const response = await client.request({
+  //     method: 'GET',
+  //     restletUrl: process.env.restlet_url,
+  //     heads: {
+  //       'Content-Type': 'application/json'
+  //     }
+  //   })
+  //   expect(response.statusCode).toEqual(200);
+  // })
+
   it("should make GET request - GET Customers", async () => {
     expect.assertions(4);
     const response = await client.request({
@@ -131,6 +144,8 @@ describe("Test request method", () => {
         path: "record/v1/bad-path",
       })
     ).rejects.toThrowError("Record type 'bad-path' does not exist");
+  }, {
+    timeout: 10000,
   });
 
   it("should reject with meaningful error if bad object", async () => {