@suitegeezus/suitecloud-stacker 25.2.127

package/index.d.ts

@@ -0,0 +1,284 @@
+/**
+ * @file sdf/index.d.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+
+declare enum ProjectFolder {
+    DIST = 'dist',
+    IMPORT = 'src',
+}
+
+type AccountCustomizationRoots =
+    'FileCabinet'
+    | 'SuiteScripts'
+    | 'Objects'
+    | 'Translations'
+    | 'AccountConfiguration'
+    | 'Templates'
+    | 'Web Site Hosting Files';
+
+type SdfObjectTypes = 'addressForm'
+    | 'advancedpdftemplate'
+    | 'bundleinstallationscript'
+    | 'center'
+    | 'centercategory'
+    | 'centerlink'
+    | 'centertab'
+    | 'clientscript'
+    | 'crmcustomfield'
+    | 'csvimport'
+    | 'customlist'
+    | 'customrecordtype'
+    | 'customsegment'
+    | 'customtransactiontype'
+    | 'dataset'
+    | 'emailcaptureplugin'
+    | 'emailtemplate'
+    | 'entitycustomfield'
+    | 'entryForm'
+    | 'financiallayout'
+    | 'integration'
+    | 'itemcustomfield'
+    | 'itemnumbercustomfield'
+    | 'kpiscorecard'
+    | 'mapreducescript'
+    | 'massupdatescript'
+    | 'othercustomfield'
+    | 'plugintype'
+    | 'plugintypeimpl'
+    | 'portlet'
+    | 'publisheddashboard'
+    | 'reportdefinition'
+    | 'restlet'
+    | 'role'
+    | 'savedsearch'
+    | 'scheduledscript'
+    | 'sublist'
+    | 'subtab'
+    | 'suitelet'
+    | 'transactionForm'
+    | 'transactionbodycustomfield'
+    | 'transactioncolumncustomfield'
+    | 'translationcollection'
+    | 'usereventscript'
+    | 'workbook'
+    | 'workflow'
+    | 'workflowactionscript'
+
+
+type NativeProjectJsonContents = {
+    defaultAuthId: string;
+    defaultProjectFolder?: string;
+}
+
+type ProjectJsonContents = Partial<NativeProjectJsonContents> & Partial<{
+    certificateid: string;
+    privatekeypath: string;
+}>;
+
+interface BasicBeforeExecutingOptions {
+    command: unknown;
+    isProd?: boolean;
+    readonly authId?: string;
+    executionPath?: string;
+    projectFolder?: string; // the relative path
+    projectPath: string;     //"/Users/geraldgillespie/code/myproject/src/FileCabinet/SuiteScripts/Apps/billingItemShip",
+    arguments: {
+        authid?: string;
+        runhooks?: 'pre'|'post'|'all'|'none'|'quiet';
+        debug?: string;
+        name?: string;
+        customflag?: boolean;
+        customoptions?: string[];
+        noconfig?: boolean;
+        readonly interactive?: boolean;
+    };
+}
+
+interface BasicOnCompletedOptions {
+    _status: 'SUCCESS' | 'ERROR' | string;
+    _data: unknown;
+    /** @description - this is usually an object of key value pairs.
+     * The values are often strings,
+     * but sometimes the values are quoted strings (i.e. JSON strings). An example is file:import has "paths" key whihch is a list of quoted strings
+     */
+    _commandParameters?: unknown;
+    _actionExecuted?: unknown;
+}
+
+interface AccountMangementOnCompletedOptions extends BasicOnCompletedOptions {
+    "_data": Record<string /* "5854873-LYMI-PROD" */, {
+        "accountInfo": {
+            "companyId": string; // "5854873",
+            "companyName": string; // "Lymi Inc. - The Reformation (PRODUCTION)",
+            "roleId": string; //  "3",
+            "roleName": string; // "Administrator",
+            "entityId": string; // "21585"
+        },
+        "token": {
+            "accessToken": string; //  "eyJraWQiOiJjLjU4NTQ4NzMuMjAyNS0wMy0wN
+            "expirationDate": string; //  "2025-03-08T13:34.3861Z"
+        },
+        "domain"?: string;
+        "hostInfo"?: {
+            "hostName": string; //  "5854873.app.netsuite.com",
+            "clientId": string; // "6da57bf05a6247fc876c6
+        },
+        "certificateInfo": {
+            "privateKeyPath"?: string; // "/Users/geraldgillespie/.keys/sdfgg.pem",
+            "certificateId": string; // "yyHF3-KhYaEB5fUY
+            "privateKey"?: string;
+        }
+    }>;
+    _commandParameters: {},
+    _actionExecuted: "list"
+}
+
+interface AccountSetupBeforeExecutingOptions extends BasicBeforeExecutingOptions {
+    command: "account:setup:ci";
+    projectPath: string; // "/Users/geraldgillespie/code/nsaccounts";
+    arguments: {
+        account: string; //"5390900_SB2",
+        authid: string; //"5390900-OPTIMASUAT",
+        certificateid: string; // "g0EVzozmKsf5-8iqeT2An48gmRKnJ7pA3uti42eOYbI",
+        privatekeypath: string; //  "/Users/geraldgillespie/.keys/sdfgg25_rsa.private.pem",
+        domain: string; // "5390900-sb2.app.netsuite.com"
+    }
+}
+
+interface FileImportBeforeExecutingOptions extends BasicBeforeExecutingOptions {
+    command: 'file:import';
+    arguments: {
+        /** @description - Always begin with a discrete path such as `/SuiteScripts` */
+        paths: Array<`/SuiteScripts/${string}` | string>;
+        excludeproperties: boolean;
+        readonly authid: string; // CUST-PROD
+        calledfromcomparefiles?: boolean;
+        calledfromupdate?: boolean;
+        readonly interactive?: boolean;
+    } & BasicBeforeExecutingOptions['arguments']
+}
+
+interface FileUploadBeforeExecutingOptions extends BasicBeforeExecutingOptions {
+    command: 'file:import';
+    _isProd?: boolean;
+    arguments: {
+        /** @description - Always begin with a discrete path such as `/SuiteScripts` */
+        paths: Array<`/SuiteScripts/${string}` | string>;
+        readonly authid: string; // CUST-PROD
+        readonly interactive?: boolean;
+    } & BasicBeforeExecutingOptions['arguments']
+}
+
+interface ObjectImportOptions extends BasicBeforeExecutingOptions {
+    command: "object:import",
+    projectPath: string; // "/Users/geraldgillespie/code/netsuite/src/FileCabinet/SuiteScripts/billingItemShip",
+    arguments: {
+        scriptid: string[];//  ["customscript_gl_pymnt_usc1"]
+        type: "customglplugin" | string;
+        destinationfolder: "/Objects",
+        readonly authid: string; // "LYMI-SB1"
+        readonly interactive?: boolean;
+    } & BasicBeforeExecutingOptions['arguments']
+}
+
+interface ObjectImportOnCompletedOptions extends BasicOnCompletedOptions {
+    "_status": "SUCCESS" | string,
+    "_data": {
+        "failedImports": [],
+        "successfulImports": [{
+            "customObject": {
+                "id": string; // "customscript_gl_pymnt_usc1",
+                "type": 'customglplugin' | string,
+                "result": { "code": "SUCCESS" | string };
+            },
+            "referencedFileImportResult": { "successfulImports": [], "failedImports": [] }
+        }],
+        "errorImports": []
+    },
+    "_commandParameters": {
+        type: 'customglplugin' | string;
+        destinationfolder: string; // "\"/Objects\"",
+        authid: string; // "AVID-SB1",
+        project: string; // "\"/Users/geraldgillespie/code/nsaccounts/6403833\"",
+        scriptid: string; // "customscript_gl_pymnt_usc1"
+    },
+    "_commandFlags": Array<'excludefiles' | string>
+}
+
+interface ObjectListOptions extends BasicBeforeExecutingOptions {
+    command: "object:list",
+    projectPath: string; // "/Users/geraldgillespie/code/netsuite/src/FileCabinet/SuiteScripts/billingItemShip",
+    arguments: {
+        scriptid: string;
+        type?: string[] // ALL is implied when missing
+        readonly authid: string;
+    }
+}
+
+interface ObjectListOnCompletedOptions extends BasicOnCompletedOptions {
+    _status: "SUCCESS",
+    _data: [
+        {
+            scriptId: string;
+            type: SdfObjectTypes | string;
+        }
+    ],
+    _commandParameters: {
+        scriptid?: string;
+        authid: string;
+        type?: string[];
+    }
+}
+
+interface SdfCommandBeforeExecutingGeneric<O extends Record<string,any>> {
+    /**
+     * @description
+     */
+    (options: O): O | Promise<O>;
+}
+
+/**
+ * @description - Command
+ * @see https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_155931221634.html#subsect_156380094347
+ * Some things that an SDF command should do are:
+ * - Stack trace is difficult w/ SDF so all error messages should begin with the `_origin` name of the handler
+ * - any fatal errors should be trapped and rethrown.
+ * - Error handlers should detect their own `_origin` and conditionally handle the error message
+ * - use safeCommands.onErrorHelper
+ */
+interface SdfCommand<
+    F = undefined,
+    B = SdfCommandBeforeExecutingGeneric<any>,
+    C = Function,
+    E = Function
+> {
+    beforeExecuting?: B extends Function ? B : never;
+    onCompleted?: C extends Function ? C : never;
+    onError?: E extends Function ? E : never;
+    projectFolder?: F extends ProjectFolder | string ? `${F}` : undefined;
+    /** @description - non native but added for detection */
+    readonly stacked?: true;
+    isStackable?: boolean;
+    _origin?: string;
+}
+
+/**
+ * @example {
+ *   command: 'file:import',
+ *   projectPath: '/Users/geraldgillespie/code/nsaccounts',
+ *   arguments: {
+ *     paths: [ '/SuiteScripts/sullivansoftware1.js' ],
+ *     excludeproperties: true,
+ *     authid: 'td2954232'
+ *   }
+ * }
+ */
+
+type StackableHook<F, B, C, E> = {
+    (options?: Record<string, any>, ...args: any[]): SdfCommand<F, B, C, E>;
+}
+
+export type FileImportCommand = SdfCommand<ProjectFolder.IMPORT, SdfCommandBeforeExecutingGeneric<FileImportBeforeExecutingOptions>>;
+
+export type FileUploadCommand = SdfCommand<ProjectFolder.DIST, SdfCommandBeforeExecutingGeneric<any>>;

package/lib/MakeJestTestsFromDeploy.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @file sdf/lib/MakeJestTestsFromDeploy.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+/**
+ * @deprecated -  Sometimes a deploy.xml will use wildcards.  This only works when no wild cards are used.
+ * The superior operation to this is to do a `dryrun` that will give you the specific js files that will attempt to deploy
+ * regardless of wildcards. Then you only need to test those files
+ * @description - assumes no wildcards in a deploy.xml
+ * @param {string[]} deployFiles
+ * @returns {Promise<string[]>}
+ */
+export declare const getEveryJsTestFromTheDeployXml: (deployFiles: string[]) => Promise<string[]>;

package/lib/MakeJestTestsFromDeploy.js

@@ -0,0 +1,60 @@
+"use strict";
+/**
+ * @file sdf/lib/MakeJestTestsFromDeploy.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEveryJsTestFromTheDeployXml = void 0;
+const fs = require("node:fs/promises");
+const path = require("node:path");
+const promptHelpers_1 = require("./promptHelpers");
+/**
+ * @deprecated -  Sometimes a deploy.xml will use wildcards.  This only works when no wild cards are used.
+ * The superior operation to this is to do a `dryrun` that will give you the specific js files that will attempt to deploy
+ * regardless of wildcards. Then you only need to test those files
+ * @description - assumes no wildcards in a deploy.xml
+ * @param {string[]} deployFiles
+ * @returns {Promise<string[]>}
+ */
+const getEveryJsTestFromTheDeployXml = async (deployFiles) => {
+    const fileGroups = await Promise.all(deployFiles.map(async (file) => {
+        const contents = await fs.readFile(file, 'utf8');
+        const listWitHoles = await Promise.all(contents.split('\n').map(
+        /**
+         * @example `<path>~/FileCabinet/SuiteScripts/Apps/glplugins/acs_gl_adjust_discount_tax.js</path>`
+         * @param line
+         * @returns {[*]|*[]}
+         */
+        async (line) => {
+            if (!/FileCabinet.Suite/.test(line))
+                return;
+            const newRoot = process.cwd().replace(/^(.*)\bFileCabinet.*$/, '$1');
+            const [jsMaybe] = line.split(/<.?path>/).map((s) => s.trim()).filter(Boolean).map(
+            // remove the beginning
+            (s) => s.replace(/^.*\b(FileCabinet.*)$/, '$1'));
+            if (!/\.js$/.test(jsMaybe))
+                return;
+            // add the newRoot
+            const fullPath = path.join(newRoot, jsMaybe);
+            // convert to a test path
+            const testPath = path.join(
+            // strip off the file
+            path.dirname(fullPath), 
+            // add __tests__
+            '__tests__', 
+            // mutate the file name
+            path.basename(fullPath).replace('.js', '.test.js'));
+            // check if the test file is readable
+            return await fs.access(testPath, fs.constants.R_OK)
+                .then(() => testPath)
+                .catch(() => {
+                process.stdout.write((0, promptHelpers_1.goColor)('\n', testPath, ' not readable'));
+                return;
+            });
+        }));
+        return listWitHoles.filter(Boolean);
+    }));
+    return fileGroups.flat();
+};
+exports.getEveryJsTestFromTheDeployXml = getEveryJsTestFromTheDeployXml;
+//# sourceMappingURL=MakeJestTestsFromDeploy.js.map

package/lib/addGitKeep.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @file sdf/lib/addGitKeeps.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+export declare const add: (projectFolder: string) => Promise<void>;

package/lib/addGitKeep.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * @file sdf/lib/addGitKeeps.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.add = void 0;
+const fs = require("node:fs/promises");
+const path = require("node:path");
+const promptHelpers_1 = require("./promptHelpers");
+async function addTouchToEmptyDirs(dir, fileName) {
+    try {
+        // Read directory entries with file type info.
+        const entries = await fs.readdir(dir, { withFileTypes: true });
+        // If the directory is empty, create a .gitKeep file.
+        if (entries.length === 0) {
+            const touchFile = path.join(dir, fileName);
+            await fs.writeFile(touchFile, '');
+            console.log((0, promptHelpers_1.goColor)('INFO', `Created: `), (0, promptHelpers_1.goColor)('SUBTLE', `${touchFile}`));
+        }
+        else {
+            // Recursively process subdirectories.
+            for (const entry of entries) {
+                if (entry.isDirectory()) {
+                    const fullPath = path.join(dir, entry.name);
+                    await addTouchToEmptyDirs(fullPath, fileName);
+                }
+            }
+        }
+    }
+    catch (error) {
+        console.error((0, promptHelpers_1.goColor)('BAD', `Error processing directory ${dir}:`), (0, promptHelpers_1.goColor)('SUBTLE', error));
+    }
+}
+const add = async (projectFolder) => {
+    // go through every directory and if it is empty then add a `.gitKeep`
+    return addTouchToEmptyDirs(projectFolder, '.gitKeep');
+};
+exports.add = add;
+//# sourceMappingURL=addGitKeep.js.map

package/lib/addSdfObjectDirs.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @file sdf/lib/addSdfObjectDirs.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+export declare const add: (objectFolder: string) => Promise<void>;

package/lib/addSdfObjectDirs.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * @file sdf/lib/addSdfObjectDirs.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.add = void 0;
+const fs = require("node:fs/promises");
+const path = require("node:path");
+const add = async (objectFolder) => {
+    await Promise.all(['customglplugin', 'transactioncolumncustomfield'].map(async (type) => {
+        await fs.mkdir(path.join(objectFolder, type));
+    }));
+};
+exports.add = add;
+//# sourceMappingURL=addSdfObjectDirs.js.map

package/lib/callCli.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @file sdf/lib/callCli.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+import { ChildProcess } from "node:child_process";
+declare const callCli: (incomingArguments: string[]) => ChildProcess;
+export = callCli;

package/lib/callCli.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * @file sdf/lib/callCli.ts
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+const child_process = require("node:child_process");
+const sdfExec = process.env['SUITECLOUD_EXE'] || 'sdf';
+const callCli = (incomingArguments) => {
+    console.log('spawning native', incomingArguments);
+    console.log('SDFBEGINSDFBEGINSDFBEGINSDFBEGINSDFBEGINSDFBEGINSDFBEGINSDFBEGINSDFBEGINSDFBEGINSDFBEGIN\n');
+    const nativeProcess = child_process.spawn(sdfExec, [
+        ...incomingArguments,
+    ], {
+        cwd: process.cwd(),
+        stdio: 'inherit' // ,'pipe','inherit','pipe']
+    });
+    nativeProcess.on('close', (code) => {
+        if (code)
+            console.error('error', code);
+        else
+            console.log('success');
+    });
+    return nativeProcess;
+};
+module.exports = callCli;
+//# sourceMappingURL=callCli.js.map

package/lib/compileHelper.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @file /Users/geraldgillespie/code/nsaccounts/sdf/lib/compileHelper
+ * @author Gerald Gillespie <gerald.gillespie@fullscript.com>
+ */
+/**
+ * @description
+ * @returns {string|void}
+ */
+export declare const hasTsConfig: () => Promise<string | void>;
+/**
+ * @description - Trigger a compile of TypeScript according to the local config file
+ * @param configFile
+ */
+export declare const compileTsConfig: (configFile?: string) => Promise<number>;
+/**
+ * @param path
+ * @returns {string} - contents
+ */
+export declare const previewFile: (path: string) => Promise<string>;
+/**
+ * @description - takes a list of files and create a TS config.  JS files becomes TS only if they exist.
+ * - relative paths will be used
+ * @param {string[]} jsPaths - could be a list of paths from deploy.xml or not.
+ * @param {string} [rootConfigFile='tsconfig.ss21.json'] - defaults to tsconfig.ss21.json
+ * @returns {{config:string; files: string[]}} - path of the new tsconfig file
+ */
+export declare const generateTsConfigFromList: (jsPaths: string[], overwriteConfig: boolean, rootConfigFile?: string) => Promise<{
+    config: string | null;
+    files: string[];
+}>;
+/**
+ * @description
+ */
+export declare const makeJestConfig: () => Promise<void>;
+/**
+ * @description
+ */
+export declare const getAllTestFiles: () => Promise<string[]>;
+/**
+ * @description - we might be running tests OR we might be testing files
+ * @param {string[]} jsFilesToTest - Get the list of files from a dryrun
+ * @param {boolean} allowMissing - whether to require tests or not
+ */
+export declare const runJestTest: (jsFilesToTest: string[], allowMissing?: boolean) => Promise<number>;