biome-plugin-suitescript 0.1.1 → 0.3.0

package/dist/lib/options.js

@@ -0,0 +1,35 @@
+const unquote = (text) => text.replace(/^['"]|['"]$/g, "");
+/** The arguments of a call. */
+export function callArguments(call) {
+    return call.arguments?.children()[0]?.children() ?? [];
+}
+/** The members of an object literal (properties, methods and spreads). */
+export function objectMembers(object) {
+    return object.children()[0]?.children() ?? [];
+}
+/** The object literal passed as argument `index`, if it is one. */
+export function optionsObject(call, index = 0) {
+    const argument = callArguments(call)[index];
+    return argument?.kind === "JS_OBJECT_EXPRESSION" ? argument : undefined;
+}
+/** The value node of property `key` in an object literal. */
+export function propertyValue(object, key) {
+    for (const member of objectMembers(object)) {
+        if (member.kind !== "JS_PROPERTY_OBJECT_MEMBER")
+            continue;
+        const [name, value] = member.children();
+        if (name && unquote(name.text) === key)
+            return value;
+    }
+    return undefined;
+}
+/** Whether an object literal contains a spread, so its keys are not all known. */
+export function hasSpread(object) {
+    return objectMembers(object).some((m) => m.kind === "JS_SPREAD");
+}
+/** The text of a string literal without its quotes, or undefined for anything else. */
+export function stringValue(node) {
+    return node?.kind === "JS_STRING_LITERAL_EXPRESSION"
+        ? unquote(node.text)
+        : undefined;
+}

package/dist/lib/required-options.js

@@ -0,0 +1,14 @@
+import { hasSpread, objectMembers, optionsObject } from "./options.js";
+/** Names of the properties an options object literal defines, or undefined if a spread hides some. */
+export function definedOptions(call) {
+    const options = optionsObject(call);
+    if (!options || hasSpread(options))
+        return undefined;
+    const names = new Set();
+    for (const member of objectMembers(options)) {
+        const name = member.children()[0]?.text.replace(/^['"]|['"]$/g, "");
+        if (name)
+            names.add(name);
+    }
+    return names;
+}

package/dist/lib/script-side.js

@@ -0,0 +1,83 @@
+import { esExportNames } from "./biome-modules.js";
+import { parseDefine } from "./define.js";
+import { amdReturnedNames } from "./entry-points.js";
+import { inferScriptType } from "./inference.js";
+import { sideOf } from "./module-script-types.js";
+/**
+ * Script types the module containing `node` (a define() call or an ES module)
+ * could be, judged from the entry points it returns. Undefined for libraries
+ * and for entry points that cannot be analysed.
+ */
+export function inferredTypes(node) {
+    for (const candidate of [node, ...node.ancestors()]) {
+        let names;
+        if (candidate.kind === "JS_CALL_EXPRESSION") {
+            const def = parseDefine(candidate);
+            if (!def)
+                continue;
+            names = amdReturnedNames(def);
+        }
+        else if (candidate.kind === "JS_MODULE") {
+            names = esExportNames(candidate);
+        }
+        else {
+            continue;
+        }
+        return (names && inferScriptType(names))?.types;
+    }
+    return undefined;
+}
+/** Whether that module is a client or server script. Undefined when unknown or mixed. */
+export function scriptSide(node) {
+    const types = inferredTypes(node);
+    return types && sideOf(types);
+}
+const FUNCTION_KINDS = [
+    "JS_FUNCTION_DECLARATION",
+    "JS_FUNCTION_EXPRESSION",
+    "JS_ARROW_FUNCTION_EXPRESSION",
+    "JS_METHOD_OBJECT_MEMBER",
+];
+const unquote = (text) => text.replace(/^['"]|['"]$/g, "");
+/** The name a function is bound to: its declaration, variable, object key or `o.name =` target. */
+export function functionName(fn) {
+    if (fn.kind === "JS_FUNCTION_DECLARATION")
+        return fn.children().find((c) => c.kind === "JS_IDENTIFIER_BINDING")?.text;
+    if (fn.kind === "JS_METHOD_OBJECT_MEMBER") {
+        const name = fn.children()[0]?.text;
+        return name ? unquote(name) : undefined;
+    }
+    const parent = fn.parent;
+    if (parent?.kind === "JS_PROPERTY_OBJECT_MEMBER") {
+        const name = parent.children()[0]?.text;
+        return name ? unquote(name) : undefined;
+    }
+    if (parent?.kind === "JS_INITIALIZER_CLAUSE")
+        return parent.parent
+            ?.children()
+            .find((c) => c.kind === "JS_IDENTIFIER_BINDING")?.text;
+    if (parent?.kind === "JS_ASSIGNMENT_EXPRESSION") {
+        const target = parent.children()[0];
+        if (target?.kind === "JS_STATIC_MEMBER_ASSIGNMENT")
+            return target.children()[1]?.text;
+    }
+    return undefined;
+}
+/** Names of the functions enclosing `node`, innermost first. */
+export function enclosingFunctionNames(node) {
+    return node
+        .ancestors()
+        .filter((a) => FUNCTION_KINDS.includes(a.kind))
+        .map(functionName)
+        .filter((n) => !!n);
+}
+export function isFunction(node) {
+    return FUNCTION_KINDS.includes(node.kind);
+}
+/** Every node below `node`, depth first. */
+export function* descendants(node) {
+    for (const child of node.children()) {
+        yield child;
+        yield* descendants(child);
+    }
+}

package/dist/lib/script-types.js

@@ -33,30 +33,29 @@ export const SCRIPT_TYPES = [
         ],
         name: "ClientScript",
     },
+    {
+        entryPoints: [],
+        name: "ConsolidatedRateAdjustorPlugin",
+    },
     {
         entryPoints: ["customizeGlImpact"],
         name: "CustomGLPlugin",
     },
+    {
+        entryPoints: [],
+        name: "CustomTool",
+    },
     {
         entryPoints: ["createDataset"],
         name: "DatasetBuilderPlugin",
     },
     {
-        entryPoints: [
-            "getConfigurationIFrameUrl",
-            "getAccounts",
-            "getTransactionData",
-        ],
-        name: "FiConnectivityPlugin",
+        entryPoints: [],
+        name: "EmailCapturePlugin",
     },
     {
-        entryPoints: [
-            "parseData",
-            "getStandardTransactionCodes",
-            "getExpenseCodes",
-            "getConfigurationPageUrl",
-        ],
-        name: "FiParserPlugin",
+        entryPoints: ["handle"],
+        name: "EventSubscriber",
     },
     {
         entryPoints: ["getInputData", "map", "reduce", "summarize"],
@@ -66,6 +65,10 @@ export const SCRIPT_TYPES = [
         entryPoints: ["each"],
         name: "MassUpdateScript",
     },
+    {
+        entryPoints: [],
+        name: "PaymentGatewayPlugin",
+    },
     {
         entryPoints: [],
         name: "PluginTypeImpl",
@@ -74,6 +77,10 @@ export const SCRIPT_TYPES = [
         entryPoints: ["render"],
         name: "Portlet",
     },
+    {
+        entryPoints: [],
+        name: "PromotionsPlugin",
+    },
     {
         entryPoints: ["delete", "get", "post", "put"],
         name: "Restlet",
@@ -86,17 +93,33 @@ export const SCRIPT_TYPES = [
         entryPoints: ["run"],
         name: "SDFInstallationScript",
     },
+    {
+        entryPoints: [],
+        name: "ShippingPartnersPlugin",
+    },
+    {
+        entryPoints: ["run"],
+        name: "SpaClientScript",
+    },
+    {
+        entryPoints: ["initializeSpa"],
+        name: "SpaServerScript",
+    },
     {
         entryPoints: ["onRequest"],
         name: "Suitelet",
     },
+    {
+        entryPoints: [],
+        name: "TaxCalculationPlugin",
+    },
     {
         entryPoints: ["afterSubmit", "beforeLoad", "beforeSubmit"],
         name: "UserEventScript",
     },
     {
         entryPoints: ["createWorkbook"],
-        name: "WorkbookBbuilderPlugin",
+        name: "WorkbookBuilderPlugin",
     },
     {
         entryPoints: ["onAction"],

package/dist/lib/suiteql.js

@@ -0,0 +1,16 @@
+import { optionsObject, propertyValue } from "./options.js";
+import { isStaticString } from "./suitescript.js";
+/** Matches query.runSuiteQL, runSuiteQLPaged and their .promise forms. */
+export const SUITEQL = /(^|\.)runSuiteQL(Paged)?(\.promise)?$/;
+/** The query argument of a runSuiteQL call, from an options object or a bare argument. */
+export function suiteqlQuery(call) {
+    const options = optionsObject(call);
+    return options
+        ? propertyValue(options, "query")
+        : call.arguments?.children()[0]?.children()[0];
+}
+/** The SQL of a runSuiteQL call when it is built only from literals. */
+export function staticSuiteql(call) {
+    const sql = suiteqlQuery(call);
+    return sql && isStaticString(sql) ? sql.text : undefined;
+}

package/dist/lib/suitescript.js

@@ -0,0 +1,23 @@
+import { importsNetSuite } from "./biome-modules.js";
+import { parseDefine } from "./define.js";
+/** Whether a node is inside an AMD `define([...], fn)` or an ES module importing `N/` modules. */
+export function inSuiteScriptModule(node) {
+    return node.ancestors().some((a) => {
+        if (a.kind === "JS_CALL_EXPRESSION")
+            return !!parseDefine(a);
+        return a.kind === "JS_MODULE" && importsNetSuite(a);
+    });
+}
+/** Whether an expression is built only from string literals (and `+`). */
+export function isStaticString(node) {
+    if (!node)
+        return false;
+    if (node.kind === "JS_STRING_LITERAL_EXPRESSION")
+        return true;
+    if (node.kind === "JS_TEMPLATE_EXPRESSION")
+        return !node.text.includes("${");
+    if (node.kind === "JS_BINARY_EXPRESSION" ||
+        node.kind === "JS_PARENTHESIZED_EXPRESSION")
+        return node.children().every(isStaticString);
+    return false;
+}