@amerilux/netsuite-api 0.2.0 → 0.2.1

package/README.md

@@ -8,7 +8,7 @@ The API layer for a NetSuite single-page app. The app's server side is SuiteScri
 - **`netsuite-api generate`**: reads the controllers and writes the client's whole view of the backend, one module per controller and an index re-exporting them, plus the server-side map of scripts. The client never imports from the server tree.
 - **`@amerilux/netsuite-api`** (the root): the wire itself. The envelope, the endpoint types, `ScriptDeclaration`, `ScriptRef`.
 
-The layout it assumes is the one `create-netsuite-project` scaffolds: `api/` (SuiteScript) and `client/` (React) as workspaces, and `netsuite.ts` at the root holding the application's names.
+The layout it assumes is the one `create-netsuite-project` scaffolds: `api/` (SuiteScript) and `client/` (React) as workspaces.
 
 ## A controller
 
@@ -102,16 +102,10 @@ export * as user from './user.gen';
 
 A hook imports `{ customer }` from it, calls `customer.api.search({ search: 'acme' })` and gets a `Promise<customer.CustomerSummary[]>`. The second argument carries an `AbortSignal`.
 
-**`client/src/app.gen.ts`**, a verbatim copy of the app file, outside the api folder so a page or a component may import `app` without touching a client.
-
 **`api/src/scripts.gen.ts`**, the server-side map of every declared script by controller name. A repository passes an entry to `createSuiteletClient`; nothing else needs it.
 
 `netsuite-api check` exits non-zero when any generated file is missing, out of date or left over, for CI. `netsuite-api generate --dry-run` prints every file instead of writing anything.
 
-### The app file
-
-`netsuite.ts` at the project root holds the application's names and any id no controller or model owns. Both sides use it, so the client gets a verbatim copy: the file is exported constants and types only, with no imports and nothing that runs.
-
 ### Configuration
 
 `netsuite-api.config.json` at the project root, every setting optional. The defaults:
@@ -119,9 +113,7 @@ A hook imports `{ customer }` from it, calls `customer.api.search({ search: 'acm
 ```json
 {
   "controllers": "api/src/controllers",
-  "appFile": "netsuite.ts",
   "outDir": "client/src/api",
-  "appOutFile": "client/src/app.gen.ts",
   "scriptsOutFile": "api/src/scripts.gen.ts",
   "clientModule": "@amerilux/netsuite-api/client",
   "wireModule": "@amerilux/netsuite-api",

package/dist-tooling/config.d.ts

@@ -6,12 +6,8 @@ import type { FileSystemAdapter } from './file-system.js';
 export interface ClientGeneratorConfig {
     /** Directory holding the controllers: one `<name>Controller.ts` per script. */
     controllers: string;
-    /** The file declaring `app` (and any other id no controller or model owns), copied into the client verbatim. */
-    appFile: string;
     /** The client's generated directory: one `<name>.gen.ts` per controller (its wire shapes, its endpoint type, its client) and `index.gen.ts` re-exporting each under the controller's name. Nothing else lives there. */
     outDir: string;
-    /** The generated copy of the app file for the client, outside the api folder so pages and components may import it. */
-    appOutFile: string;
     /** The generated server-side `scripts` map: what a repository passes to createSuiteletClient. */
     scriptsOutFile: string;
     /** The specifier the controller modules import `createApiClient` from. */

package/dist-tooling/config.js

@@ -2,9 +2,7 @@ import * as nodePath from 'node:path';
 export const DEFAULT_CONFIG_FILE_NAME = 'netsuite-api.config.json';
 export const defaultClientGeneratorConfig = {
     controllers: 'api/src/controllers',
-    appFile: 'netsuite.ts',
     outDir: 'client/src/api',
-    appOutFile: 'client/src/app.gen.ts',
     scriptsOutFile: 'api/src/scripts.gen.ts',
     clientModule: '@amerilux/netsuite-api/client',
     wireModule: '@amerilux/netsuite-api',
@@ -21,7 +19,7 @@ export class ClientGeneratorConfigError extends Error {
         this.name = 'ClientGeneratorConfigError';
     }
 }
-const stringSettings = ['controllers', 'appFile', 'outDir', 'appOutFile', 'scriptsOutFile', 'clientModule', 'wireModule'];
+const stringSettings = ['controllers', 'outDir', 'scriptsOutFile', 'clientModule', 'wireModule'];
 const mapSettings = ['typeImports', 'inlineTypes'];
 function isStringMap(value) {
     return !!value && typeof value === 'object' && !Array.isArray(value) && Object.values(value).every((entry) => typeof entry === 'string' && entry !== '');

package/dist-tooling/emit.d.ts

@@ -29,10 +29,6 @@ export interface EmitScriptsModuleOptions {
     wireModule: string;
     controllersLabel: string;
 }
-export interface EmitAppModuleOptions {
-    /** How the header names the app file: `netsuite.ts`. */
-    appLabel: string;
-}
 /** The index module of the client, next to the controller modules: what a hook imports. */
 export declare const CLIENT_INDEX_FILE_NAME = "index.gen.ts";
 /** The client module of a controller: `user.gen.ts` for the user controller. */
@@ -41,6 +37,4 @@ export declare function emitControllerModule({ contract, sourceLabel, inlinedTyp
 export declare function sortControllers(controllers: EmittedController[]): EmittedController[];
 /** The index module: every controller module re-exported under the controller's name. */
 export declare function emitClientIndexModule(controllers: EmittedController[], options: EmitClientIndexModuleOptions): string;
-/** The app file as the client sees it: its exported declarations, verbatim. */
-export declare function emitAppModule(appDeclarations: string[], options: EmitAppModuleOptions): string;
 export declare function emitScriptsModule(controllers: EmittedController[], options: EmitScriptsModuleOptions): string;

package/dist-tooling/emit.js

@@ -86,11 +86,6 @@ export function emitClientIndexModule(controllers, options) {
     }
     return `${lines.join('\n')}\n`;
 }
-/** The app file as the client sees it: its exported declarations, verbatim. */
-export function emitAppModule(appDeclarations, options) {
-    const header = [`// Generated by netsuite-api generate from ${options.appLabel}. Do not edit: change ${options.appLabel} and run \`npm run generate\`.`, ESLINT_DISABLE];
-    return `${[header.join('\n'), ...appDeclarations].join('\n\n')}\n`;
-}
 export function emitScriptsModule(controllers, options) {
     const ordered = sortControllers(controllers);
     const entries = ordered.map(({ contract }) => `${INDENT}${contract.name}: ${emitScriptRef(contract.script)},`);

package/dist-tooling/generate.d.ts

@@ -18,7 +18,7 @@ export interface PlannedFile {
     content: string;
 }
 export interface ClientGenerationPlan {
-    /** The modules to write: one per controller, the client index, the app module, the scripts map; empty when there are problems. */
+    /** The modules to write: one per controller, the client index, the scripts map; empty when there are problems. */
     files: PlannedFile[];
     /** Generated files in the client's output directory the plan does not write: a removed controller's module, or the copy of the entity types an earlier version made. Absolute paths. */
     leftoverFiles: string[];

package/dist-tooling/generate.js

@@ -1,7 +1,6 @@
 import * as nodePath from 'node:path';
-import { readAppDeclarations } from './appReader.js';
 import { isControllerFileName, readControllerContract } from './controllerReader.js';
-import { CLIENT_INDEX_FILE_NAME, controllerModuleFileName, emitAppModule, emitClientIndexModule, emitControllerModule, emitScriptsModule, sortControllers } from './emit.js';
+import { CLIENT_INDEX_FILE_NAME, controllerModuleFileName, emitClientIndexModule, emitControllerModule, emitScriptsModule, sortControllers } from './emit.js';
 import { toPosixPath } from './file-system.js';
 import { readInlinableTypesFile, selectInlinedTypes } from './typesFileReader.js';
 const generatedFileNamePattern = /\.gen\.ts$/;
@@ -34,7 +33,6 @@ export function planClientGeneration({ config, fileSystem }) {
     const resolve = (relativePath) => nodePath.resolve(config.rootDirectory, relativePath);
     const label = (absolutePath) => relativeLabel(config.rootDirectory, absolutePath);
     const controllersDirectory = resolve(config.controllers);
-    const appFile = resolve(config.appFile);
     const outDirectory = resolve(config.outDir);
     const problems = [];
     const controllerFiles = fileSystem.listFiles(controllersDirectory).filter((filePath) => isControllerFileName(nodePath.basename(filePath)));
@@ -87,15 +85,6 @@ export function planClientGeneration({ config, fileSystem }) {
         emitted.push({ contract, sourceLabel: controllerLabel, inlinedTypes });
     }
     problems.push(...findDuplicateScriptIds(emitted));
-    let appDeclarations = [];
-    if (fileSystem.fileExists(appFile)) {
-        const app = readAppDeclarations(label(appFile), fileSystem.readTextFile(appFile));
-        problems.push(...app.problems);
-        appDeclarations = app.declarations;
-    }
-    else {
-        problems.push({ filePath: label(appFile), message: 'the app file does not exist.' });
-    }
     const controllers = emitted.map(({ contract }) => ({
         name: contract.name,
         filePath: contract.filePath,
@@ -112,7 +101,6 @@ export function planClientGeneration({ config, fileSystem }) {
             content: emitControllerModule(controller, { clientModule: config.clientModule }),
         })),
         { path: nodePath.join(outDirectory, CLIENT_INDEX_FILE_NAME), content: emitClientIndexModule(emitted, { controllersLabel }) },
-        { path: resolve(config.appOutFile), content: emitAppModule(appDeclarations, { appLabel: label(appFile) }) },
         { path: resolve(config.scriptsOutFile), content: emitScriptsModule(emitted, { wireModule: config.wireModule, controllersLabel }) },
     ];
     const leftoverFiles = findLeftoverFiles(fileSystem, outDirectory, files.map((file) => file.path));

package/dist-tooling/index.d.ts

@@ -5,10 +5,8 @@ export { GENERATED_CLIENT_NAME, GENERATED_ENDPOINTS_TYPE_NAME, RAW_RESPONSE_TYPE
 export type { CarriedTypeImport, ControllerContract, ControllerKind, ControllerProblem, ControllerReadResult, ControllerTypeImport, DeclaredScript, EndpointSignature, InlinedTypeImport, ReadControllerOptions, TypeDeclaration, TypeImportName } from './controllerReader.js';
 export { readInlinableTypesFile, selectInlinedTypes } from './typesFileReader.js';
 export type { InlinableTypeDeclaration, InlinableTypesFile, SelectedInlinedTypes } from './typesFileReader.js';
-export { readAppDeclarations } from './appReader.js';
-export type { AppDeclarations } from './appReader.js';
-export { CLIENT_INDEX_FILE_NAME, controllerModuleFileName, emitAppModule, emitClientIndexModule, emitControllerModule, emitScriptsModule } from './emit.js';
-export type { EmitAppModuleOptions, EmitClientIndexModuleOptions, EmitControllerModuleOptions, EmitScriptsModuleOptions, EmittedController, InlinedTypeSection } from './emit.js';
+export { CLIENT_INDEX_FILE_NAME, controllerModuleFileName, emitClientIndexModule, emitControllerModule, emitScriptsModule } from './emit.js';
+export type { EmitClientIndexModuleOptions, EmitControllerModuleOptions, EmitScriptsModuleOptions, EmittedController, InlinedTypeSection } from './emit.js';
 export { checkClientGeneration, planClientGeneration, runClientGeneration } from './generate.js';
 export type { ClientGenerationCheck, ClientGenerationPlan, ClientGenerationResult, GenerateClientOptions, PlannedController, PlannedFile } from './generate.js';
 export { createInMemoryFileSystemAdapter, createNodeFileSystemAdapter, toPosixPath } from './file-system.js';

package/dist-tooling/index.js

@@ -2,8 +2,7 @@
 export { DEFAULT_CONFIG_FILE_NAME, ClientGeneratorConfigError, defaultClientGeneratorConfig, loadClientGeneratorConfig } from './config.js';
 export { GENERATED_CLIENT_NAME, GENERATED_ENDPOINTS_TYPE_NAME, RAW_RESPONSE_TYPE_NAME, isControllerFileName, readControllerContract, readLeadingJsDoc } from './controllerReader.js';
 export { readInlinableTypesFile, selectInlinedTypes } from './typesFileReader.js';
-export { readAppDeclarations } from './appReader.js';
-export { CLIENT_INDEX_FILE_NAME, controllerModuleFileName, emitAppModule, emitClientIndexModule, emitControllerModule, emitScriptsModule } from './emit.js';
+export { CLIENT_INDEX_FILE_NAME, controllerModuleFileName, emitClientIndexModule, emitControllerModule, emitScriptsModule } from './emit.js';
 export { checkClientGeneration, planClientGeneration, runClientGeneration } from './generate.js';
 export { createInMemoryFileSystemAdapter, createNodeFileSystemAdapter, toPosixPath } from './file-system.js';
 export { CLI_USAGE, EXIT_PROBLEMS, EXIT_SUCCESS, EXIT_USAGE, runCli } from './cli/main.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amerilux/netsuite-api",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "private": false,
   "description": "The API layer for a NetSuite single-page app: endpoints served by a Restlet or a Suitelet, a typed browser client, SuiteScript module stubs for tests, and a generator that writes the client module from the controllers.",
   "license": "MIT",

package/dist-tooling/appReader.d.ts

@@ -1,12 +0,0 @@
-import type { ControllerProblem } from './controllerReader.js';
-/**
- * Reads the project's app file (netsuite.ts): the application's names and the ids no controller or
- * model owns. The client module carries it verbatim, so the file is plain declarations: exported
- * constants and types, no imports, nothing that runs. The generator names anything else.
- */
-export interface AppDeclarations {
-    /** Every exported declaration as written, JSDoc included, in file order. */
-    declarations: string[];
-    problems: ControllerProblem[];
-}
-export declare function readAppDeclarations(filePath: string, source: string): AppDeclarations;

package/dist-tooling/appReader.js

@@ -1,31 +0,0 @@
-import ts from 'typescript';
-import { readLeadingJsDoc } from './controllerReader.js';
-function hasExportModifier(node) {
-    return ts.canHaveModifiers(node) && (ts.getModifiers(node) ?? []).some((modifier) => modifier.kind === ts.SyntaxKind.ExportKeyword);
-}
-function describeStatement(statement, sourceFile) {
-    return statement.getText(sourceFile).split('\n')[0].trim();
-}
-export function readAppDeclarations(filePath, source) {
-    const sourceFile = ts.createSourceFile(filePath, source, ts.ScriptTarget.Latest, true, ts.ScriptKind.TS);
-    const declarations = [];
-    const problems = [];
-    for (const statement of sourceFile.statements) {
-        if (ts.isImportDeclaration(statement)) {
-            problems.push({ filePath, message: `imports nothing: it is copied into the client module verbatim (found ${describeStatement(statement, sourceFile)}).` });
-            continue;
-        }
-        const isDeclaration = ts.isVariableStatement(statement) || ts.isInterfaceDeclaration(statement) || ts.isTypeAliasDeclaration(statement) || ts.isEnumDeclaration(statement);
-        if (!isDeclaration || !hasExportModifier(statement)) {
-            problems.push({ filePath, message: `holds exported constants and types only, because the client module carries it verbatim (found ${describeStatement(statement, sourceFile)}).` });
-            continue;
-        }
-        if (ts.isVariableStatement(statement) && !(statement.declarationList.flags & ts.NodeFlags.Const)) {
-            problems.push({ filePath, message: `exports constants only (found ${describeStatement(statement, sourceFile)}).` });
-            continue;
-        }
-        const jsDoc = readLeadingJsDoc(statement, sourceFile);
-        declarations.push(`${jsDoc ? `${jsDoc}\n` : ''}${statement.getText(sourceFile)}`);
-    }
-    return { declarations, problems };
-}