@source-repo/rpc-cli 4.4.0 → 4.5.0

package/dist/strip.js

@@ -0,0 +1,124 @@
+import { Project, SyntaxKind } from 'ts-morph';
+/**
+ * The `{ ... }` a decorator carried, or the empty options a bare `@rpc` means. Collapsed onto one
+ * line, because the mark is inserted on the class's closing-brace line and must not add newlines.
+ */
+const optionsTextOf = (decorator) => {
+    if (!decorator.isDecoratorFactory())
+        return '{}';
+    const [options] = decorator.getArguments();
+    return options?.getText().replace(/\s*\n\s*/g, ' ') ?? '{}';
+};
+/** A method name as an object key: bare when it is a usable identifier, quoted when not. */
+const asKey = (name) => (/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name) ? name : JSON.stringify(name));
+export const stripSource = (source, fileName = 'script.ts') => {
+    const project = new Project({ useInMemoryFileSystem: true, compilerOptions: { allowJs: false } });
+    const file = project.createSourceFile(fileName, source);
+    const problems = [];
+    /** [start, end) spans to blank out. */
+    const spans = [];
+    /**
+     * Mark calls inserted at the class's closing brace, not appended at the end of the file: a
+     * script exposes its class somewhere below the declaration, and marks that ran after the whole
+     * file would run after the expose they exist to inform. On the brace's own line they run the
+     * statement after the class exists and add no newline, so nothing below moves.
+     */
+    const insertions = [];
+    let needsNamespace = false;
+    let needsMethods = false;
+    const handled = new Set();
+    const stripClass = (declaration) => {
+        const className = declaration.getName();
+        const where = className ?? '(anonymous class)';
+        const marks = [];
+        for (const decorator of declaration.getDecorators()) {
+            if (decorator.getName() !== 'rpcNamespace')
+                continue;
+            handled.add(decorator);
+            if (!className) {
+                problems.push({ where, reason: 'an anonymous class cannot be re-marked by name - give it one' });
+                continue;
+            }
+            const argumentsText = decorator
+                .getArguments()
+                .map((argument) => argument.getText().replace(/\s*\n\s*/g, ' '))
+                .join(', ');
+            spans.push([decorator.getStart(), decorator.getEnd()]);
+            marks.push(`__rpcNamespace(${className}, ${argumentsText})`);
+            needsNamespace = true;
+        }
+        const methods = [];
+        for (const method of declaration.getMethods()) {
+            for (const decorator of method.getDecorators()) {
+                if (decorator.getName() !== 'rpc')
+                    continue;
+                handled.add(decorator);
+                if (!className) {
+                    problems.push({ where: `${where}.${method.getName()}`, reason: 'an anonymous class cannot be re-marked by name - give it one' });
+                    continue;
+                }
+                if (method.isStatic()) {
+                    // The decorator would have thrown at runtime; stripping must not launder it.
+                    problems.push({ where: `${className}.${method.getName()}`, reason: '@rpc: static methods cannot be exposed' });
+                    continue;
+                }
+                spans.push([decorator.getStart(), decorator.getEnd()]);
+                methods.push(`${asKey(method.getName())}: ${optionsTextOf(decorator)}`);
+            }
+        }
+        if (methods.length && className) {
+            marks.push(`__rpcMethods(${className}, { ${methods.join(', ')} })`);
+            needsMethods = true;
+        }
+        if (marks.length)
+            insertions.push({ at: declaration.getEnd(), text: `; ${marks.join('; ')}` });
+    };
+    // Only classes that are statements of the file itself: a class inside a function would need
+    // its marks inside that function, and appending them at top level would reference a name that
+    // does not exist there. Reported below when such a class carries our decorators.
+    for (const declaration of file.getClasses())
+        stripClass(declaration);
+    // Every decorator in the file has to be one we replaced: an unknown one has a runtime effect
+    // this cannot reproduce, and one on a nested class would lose its mark silently.
+    for (const decorator of file.getDescendantsOfKind(SyntaxKind.Decorator)) {
+        if (handled.has(decorator))
+            continue;
+        const name = decorator.getName();
+        problems.push({
+            where: decorator.getFirstAncestorByKind(SyntaxKind.ClassDeclaration)?.getName() ?? name,
+            reason: name === 'rpc' || name === 'rpcNamespace'
+                ? `@${name} sits on something strip cannot re-mark from the top level - only methods of classes declared as statements of the file are handled`
+                : `@${name} is not a decorator this library defines, so stripping it would change what the program means`
+        });
+    }
+    if (problems.length)
+        return { output: source, stripped: 0, problems };
+    if (!spans.length)
+        return { output: source, stripped: 0, problems: [] };
+    // Blank the decorator spans in place, keeping every newline, so nothing below them moves.
+    const characters = [...source];
+    for (const [start, end] of spans)
+        for (let index = start; index < end; index++)
+            if (characters[index] !== '\n')
+                characters[index] = ' ';
+    let body = characters.join('');
+    // Highest offset first, so each splice leaves the earlier offsets true.
+    for (const { at, text } of [...insertions].sort((a, b) => b.at - a.at))
+        body = `${body.slice(0, at)}${text}${body.slice(at)}`;
+    const imports = [];
+    if (needsNamespace)
+        imports.push('declareRpcNamespace as __rpcNamespace');
+    if (needsMethods)
+        imports.push('exposeMethods as __rpcMethods');
+    // The import sits at the end, and legally so: ESM hoists import bindings before any module
+    // code runs, so the marks on each class's closing-brace line already see these names.
+    const appended = [
+        '',
+        '// Added by source-rpc strip: the decorators above are blanked out - Node cannot run them -',
+        '// and re-said as runtime marks on the closing line of each class. Line numbers are unchanged.',
+        `import { ${imports.join(', ')} } from '@source-repo/rpc'`,
+        ''
+    ].join('\n');
+    return { output: `${body}${body.endsWith('\n') ? '' : '\n'}${appended}`, stripped: spans.length, problems: [] };
+};
+//# sourceMappingURL=strip.js.map

package/dist/strip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strip.js","sourceRoot":"","sources":["../src/strip.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAyC,MAAM,UAAU,CAAA;AA2BrF;;;GAGG;AACH,MAAM,aAAa,GAAG,CAAC,SAAoB,EAAE,EAAE;IAC3C,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE;QAAE,OAAO,IAAI,CAAA;IAChD,MAAM,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,YAAY,EAAE,CAAA;IAC1C,OAAO,OAAO,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,IAAI,IAAI,CAAA;AAC/D,CAAC,CAAA;AAED,4FAA4F;AAC5F,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,4BAA4B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;AAEvG,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,QAAQ,GAAG,WAAW,EAAgB,EAAE;IAChF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,qBAAqB,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAAA;IACjG,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACvD,MAAM,QAAQ,GAAiB,EAAE,CAAA;IACjC,uCAAuC;IACvC,MAAM,KAAK,GAAuB,EAAE,CAAA;IACpC;;;;;OAKG;IACH,MAAM,UAAU,GAAmC,EAAE,CAAA;IACrD,IAAI,cAAc,GAAG,KAAK,CAAA;IAC1B,IAAI,YAAY,GAAG,KAAK,CAAA;IACxB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAa,CAAA;IAEpC,MAAM,UAAU,GAAG,CAAC,WAA6B,EAAE,EAAE;QACjD,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,EAAE,CAAA;QACvC,MAAM,KAAK,GAAG,SAAS,IAAI,mBAAmB,CAAA;QAC9C,MAAM,KAAK,GAAa,EAAE,CAAA;QAC1B,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,aAAa,EAAE,EAAE,CAAC;YAClD,IAAI,SAAS,CAAC,OAAO,EAAE,KAAK,cAAc;gBAAE,SAAQ;YACpD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;YACtB,IAAI,CAAC,SAAS,EAAE,CAAC;gBACb,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,8DAA8D,EAAE,CAAC,CAAA;gBAChG,SAAQ;YACZ,CAAC;YACD,MAAM,aAAa,GAAG,SAAS;iBAC1B,YAAY,EAAE;iBACd,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;iBAC/D,IAAI,CAAC,IAAI,CAAC,CAAA;YACf,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;YACtD,KAAK,CAAC,IAAI,CAAC,kBAAkB,SAAS,KAAK,aAAa,GAAG,CAAC,CAAA;YAC5D,cAAc,GAAG,IAAI,CAAA;QACzB,CAAC;QACD,MAAM,OAAO,GAAa,EAAE,CAAA;QAC5B,KAAK,MAAM,MAAM,IAAI,WAAW,CAAC,UAAU,EAAE,EAAE,CAAC;YAC5C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;gBAC7C,IAAI,SAAS,CAAC,OAAO,EAAE,KAAK,KAAK;oBAAE,SAAQ;gBAC3C,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;gBACtB,IAAI,CAAC,SAAS,EAAE,CAAC;oBACb,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,KAAK,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,8DAA8D,EAAE,CAAC,CAAA;oBAChI,SAAQ;gBACZ,CAAC;gBACD,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;oBACpB,6EAA6E;oBAC7E,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,wCAAwC,EAAE,CAAC,CAAA;oBAC9G,SAAQ;gBACZ,CAAC;gBACD,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;gBACtD,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YAC3E,CAAC;QACL,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,gBAAgB,SAAS,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACnE,YAAY,GAAG,IAAI,CAAA;QACvB,CAAC;QACD,IAAI,KAAK,CAAC,MAAM;YAAE,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,WAAW,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAA;IAClG,CAAC,CAAA;IAED,4FAA4F;IAC5F,8FAA8F;IAC9F,iFAAiF;IACjF,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,UAAU,EAAE;QAAE,UAAU,CAAC,WAAW,CAAC,CAAA;IAEpE,6FAA6F;IAC7F,iFAAiF;IACjF,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QACtE,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,SAAQ;QACpC,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,EAAE,CAAA;QAChC,QAAQ,CAAC,IAAI,CAAC;YACV,KAAK,EAAE,SAAS,CAAC,sBAAsB,CAAC,UAAU,CAAC,gBAAgB,CAAC,EAAE,OAAO,EAAE,IAAI,IAAI;YACvF,MAAM,EACF,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,cAAc;gBACrC,CAAC,CAAC,IAAI,IAAI,qIAAqI;gBAC/I,CAAC,CAAC,IAAI,IAAI,+FAA+F;SACpH,CAAC,CAAA;IACN,CAAC;IAED,IAAI,QAAQ,CAAC,MAAM;QAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAA;IACrE,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;IAEvE,0FAA0F;IAC1F,MAAM,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC,CAAA;IAC9B,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,KAAK;QAAE,KAAK,IAAI,KAAK,GAAG,KAAK,EAAE,KAAK,GAAG,GAAG,EAAE,KAAK,EAAE;YAAE,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,IAAI;gBAAE,UAAU,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;IACvI,IAAI,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC9B,wEAAwE;IACxE,KAAK,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;QAAE,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAA;IAC7H,MAAM,OAAO,GAAa,EAAE,CAAA;IAC5B,IAAI,cAAc;QAAE,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAA;IACzE,IAAI,YAAY;QAAE,OAAO,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAA;IAC/D,2FAA2F;IAC3F,sFAAsF;IACtF,MAAM,QAAQ,GAAG;QACb,EAAE;QACF,6FAA6F;QAC7F,gGAAgG;QAChG,YAAY,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,4BAA4B;QAC1D,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACZ,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,QAAQ,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;AACnH,CAAC,CAAA"}