use typescript to generate .d.ts files

index.d.ts

@@ -0,0 +1,4 @@
+import * as helpers from './utils/helpers.js';
+import * as netsuite from './utils/netsuite.js';
+import * as sftp from './utils/sftp.js';
+export { helpers, netsuite, sftp };

package.json

@@ -4,16 +4,18 @@
   "version": "0.3.0",
   "description": "Utilities to be used in Pipedream as NPM dependencies",
   "main": "index.js",
+  "types": "index.d.ts",
   "files": [
     "utils",
     "!utils/*.test.js"
   ],
   "scripts": {
     "test": "node --test",
     "lint": "npx eslint .",
-    "type-check": "tsc",
+    "type-check": "tsc --noEmit",
     "format": "prettier --write \"**/*.js\"",
-    "format-check": "prettier --check \"**/*.js\""
+    "format-check": "prettier --check \"**/*.js\"",
+    "generate-types": "tsc --allowJs --declaration --emitDeclarationOnly --outDir ."
   },
   "repository": {
     "type": "git",

tsconfig.json

@@ -5,7 +5,6 @@
     "baseUrl": ".",
     "allowJs": true,
     "checkJs": true,
-    "noEmit": true,
     "strict": false,
 
     "lib": ["ES2021", "DOM"],
@@ -14,4 +13,3 @@
   "include": ["**/*.js"],
   "exclude": ["node_modules"]
 }
-

utils/helpers.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Returns a Date object with the end_of_month.beginning_of_day from a Date Time
+ * @param {Date | string} date
+ * @return {Date}
+ */
+export function lastDay(date: Date | string): Date;
+/**
+ * Normalize strings
+ * @param {string | undefined} v
+ * @returns {string}
+ */
+export function normalizeString(v: string | undefined): string;
+/**
+ * Check if string starts with a prefix
+ * @param {string} val
+ * @param {string} prefix
+ * @returns {boolean}
+ */
+export function startsWith(val: string, prefix: string): boolean;

utils/helpers.test.d.ts

@@ -0,0 +1 @@
+export {};

utils/netsuite.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Represents the NetSuite OAuth configuration.
+ * @typedef {import('netsuite-api-client').NetsuiteOptions} Config
+ */
+/**
+ * Options for a NetSuite request. See https://github.com/julbrs/netsuite-api-client/blob/main/src/types.ts
+ * @typedef {import('netsuite-api-client').NetsuiteRequestOptions} Options - Request options
+ */
+/**
+ * Gets the portion of the URL starting with '/record'. Used to obtain a GET query path from the "location" response
+ * header on a NetSuite POST request.
+ * @param {string | string[]} url
+ * @returns {string}
+ */
+export function getRecordPath(url: string | string[]): string;
+/**
+ * Send a request to NetSuite
+ * @param {Options} options - Request options
+ * @param {Config} config - NetSuite configuration
+ * @returns {Promise<import('netsuite-api-client').NetsuiteResponse>}
+ */
+export function request(options: Options, config: Config): Promise<import("netsuite-api-client").NetsuiteResponse>;
+/**
+ * Run a SuiteQL query to get a specific (single) NetSuite record.
+ * @param {string} query - SuiteQL Query
+ * @param {Config} config - NetSuite configuration
+ * @returns {Promise<any>}
+ */
+export function queryRecord(query: string, config: Config): Promise<any>;
+/**
+ * Run a SuiteQL query against NetSuite records.
+ * @param {string} query - SuiteQL Query
+ * @param {Config} config - NetSuite configuration
+ * @param {?Number} timeout - The timeout in seconds
+ * @param {Number} timeoutRecords - The maximum number of records to return before timing out
+ * @returns {Promise<Array>}
+ */
+export function queryRecords(query: string, config: Config, timeout?: number | null, timeoutRecords?: number): Promise<any[]>;
+/**
+ * Represents the NetSuite OAuth configuration.
+ */
+export type Config = import("netsuite-api-client").NetsuiteOptions;
+/**
+ * - Request options
+ */
+export type Options = import("netsuite-api-client").NetsuiteRequestOptions;

utils/netsuite.test.d.ts

@@ -0,0 +1 @@
+export {};

utils/sftp.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @typedef {Object} SftpConfig
+ * @property {string} host
+ * @property {string} username
+ * @property {string} privateKey
+ */
+/**
+ * @typedef {Object} SftpResponse
+ * @property {string} message
+ * @property {string} error
+ * @property {boolean} successful
+ */
+/**
+ * Moves a file by its path to a new destination on an SFTP host. Returns an error or success message.
+ * @param {string} filePath - The path to the local file to upload
+ * @param {string} dest - The path to the destination file on the remote server including the new name
+ * @param {SftpConfig} sftpConfig - SFTP authentication details
+ * @returns {Promise<SftpResponse>} - { message: string, error: string, successful: boolean }
+ */
+export function renameSftpFile(filePath: string, dest: string, sftpConfig: SftpConfig): Promise<SftpResponse>;
+export type SftpConfig = {
+    host: string;
+    username: string;
+    privateKey: string;
+};
+export type SftpResponse = {
+    message: string;
+    error: string;
+    successful: boolean;
+};