@pyrpc/types 0.3.2 → 0.6.0

package/README.md

@@ -1,34 +1,27 @@
 # @pyrpc/types
 
-TypeScript type definitions for [pyRPC](https://pyrpc.dev). Generated by `pyrpc codegen` — reflects your actual Python backend procedures at compile time.
+TypeScript type definitions for [pyRPC](https://pyrpc.com). Generated by `pyrpc dev` or `pyrpc codegen` - reflects your actual Python backend procedures at compile time.
 
-## How it works
+## Distribution modes
 
-`@pyrpc/types` is a dependency of `@pyrpc/client`. When you install the client, the postinstall script prompts for your server URL and writes real types:
+When you `npm install @pyrpc/types`, the `postinstall` script prompts you to choose a distribution mode:
 
-```bash
-npm install @pyrpc/client
-```
+### Workspace mode
+Types are written directly by the server-side `pyrpc dev` / `pyrpc codegen` commands into `node_modules/@pyrpc/types/src/index.ts`. The postinstall creates `pyrpc-client.json` with `distribution: "workspace"` and types are generated during development.
 
-For CI or automated setups:
+### Server mode
+Types are fetched from a running pyRPC server. The postinstall prompts for a `server_url`, fetches the schema from `{server_url}/rpc`, generates types immediately, and creates `pyrpc-client.json`.
 
-```bash
-PYRPC_URL=https://api.example.com npm install @pyrpc/client
-```
+By default, types are written to `{client_root}/node_modules/@pyrpc/types/src/index.ts`, where `client_root` is configured in `pyrpc.json`.
 
-Before codegen runs, `Types` resolves to `Record<string, never>`. After codegen, it resolves to your actual procedure signatures — full autocompletion, no boilerplate.
+Before codegen runs, `Types` resolves to an empty interface. After codegen, it resolves to your actual procedure signatures - full autocompletion, no boilerplate.
 
 ## Manual generation
 
-If the postinstall prompt is skipped:
-
 ```bash
-pip install pyrpc-codegen
-pyrpc codegen https://your-server.com
+pyrpc codegen http://localhost:8000
 ```
 
-By default, types are written to `node_modules/@pyrpc/types/src/index.ts`. Use `--output` to override.
-
 ## License
 
 MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pyrpc/types",
-  "version": "0.3.2",
-  "description": "pyRPC TypeScript type definitions — generated by pyrpc codegen",
+  "version": "0.6.0",
+  "description": "pyRPC TypeScript type definitions - generated by pyrpc codegen",
   "exports": {
     ".": {
       "types": "./src/index.ts",

package/postinstall.js

@@ -5,14 +5,23 @@ var readline = require('readline');
 var TYPES_FILE = path.join(__dirname, 'src', 'index.ts');
 var PLACEHOLDER_MARKER = 'types not generated yet';
 
-// Skip if real types already exist
-if (fs.existsSync(TYPES_FILE)) {
-  var content = fs.readFileSync(TYPES_FILE, 'utf-8');
-  if (!content.includes(PLACEHOLDER_MARKER)) {
-    process.exit(0);
+function findProjectRoot() {
+  var dir = path.dirname(__dirname);
+  while (true) {
+    var pkgPath = path.join(dir, 'package.json');
+    if (fs.existsSync(pkgPath) && !pkgPath.replace(/\\/g, '/').includes('/node_modules/')) {
+      return dir;
+    }
+    var parent = path.dirname(dir);
+    if (parent === dir) return process.cwd();
+    dir = parent;
   }
 }
 
+function getConfigPath() {
+  return path.join(findProjectRoot(), 'pyrpc-client.json');
+}
+
 var TYPE_MAP = {
   int: 'number',
   float: 'number',
@@ -103,17 +112,36 @@ function fetchSchema(url) {
 }
 
 function main() {
+  if (fs.existsSync(getConfigPath())) {
+    return Promise.resolve();
+  }
+
   var isInteractive = process.stdin.isTTY;
-  var envUrl = process.env.PYRPC_URL;
-  var url = null;
+  var isCI = process.env.CI;
+
+  if (!isInteractive || isCI) {
+    return Promise.resolve();
+  }
+
+  var rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  return new Promise(function(resolve) {
+    rl.question('How are types distributed to the client?\n  1) workspace (default) - server writes types directly to your project\n  2) server - client fetches types via HTTP\nEnter choice [1]: ', function(answer) {
+      rl.close();
+      resolve(answer.trim() === '2' ? 'server' : 'workspace');
+    });
+  }).then(function(distribution) {
+    if (distribution === 'workspace') {
+      var config = { distribution: 'workspace' };
+      fs.writeFileSync(getConfigPath(), JSON.stringify(config, null, 2) + '\n');
+      console.log('  \u2713 pyrpc-client.json created (workspace mode)');
+      return;
+    }
 
-  if (isInteractive) {
-    var rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    var rl2 = readline.createInterface({ input: process.stdin, output: process.stdout });
     return new Promise(function(resolve) {
-      rl.question('  pyRPC backend URL (default: http://localhost:8000): ', function(answer) {
-        rl.close();
-        url = answer.trim() || 'http://localhost:8000';
-        resolve(url);
+      rl2.question('pyRPC backend URL (default: http://localhost:8000): ', function(answer) {
+        rl2.close();
+        resolve(answer.trim() || 'http://localhost:8000');
       });
     }).then(function(url) {
       return fetchSchema(url).then(function(schemas) {
@@ -121,34 +149,24 @@ function main() {
         fs.mkdirSync(path.dirname(TYPES_FILE), { recursive: true });
         fs.writeFileSync(TYPES_FILE, code, 'utf-8');
         console.log('  \u2713 @pyrpc/types: generated for ' + Object.keys(schemas).length + ' procedures');
-        console.log('  Import: import type { Types } from "@pyrpc/types"');
+
+        var config = { distribution: 'server', server_url: url };
+        fs.writeFileSync(getConfigPath(), JSON.stringify(config, null, 2) + '\n');
+        console.log('  \u2713 pyrpc-client.json created (server mode)');
       }).catch(function(err) {
         console.log('  \u2717 @pyrpc/types: could not connect (' + err.message + ')');
-        console.log('  Run manually: pyrpc codegen ' + url);
-      });
-    });
-  }
+        console.log('  Run later: npx pyrpc sync');
 
-  if (envUrl) {
-    return fetchSchema(envUrl).then(function(schemas) {
-      var code = generate(schemas);
-      fs.mkdirSync(path.dirname(TYPES_FILE), { recursive: true });
-      fs.writeFileSync(TYPES_FILE, code, 'utf-8');
-      console.log('  \u2713 @pyrpc/types: generated for ' + Object.keys(schemas).length + ' procedures');
-    }).catch(function(err) {
-      console.log('  \u2717 @pyrpc/types: could not connect (' + err.message + ')');
-      console.log('  Run manually: pyrpc codegen ' + envUrl);
+        var config = { distribution: 'server', server_url: url };
+        fs.writeFileSync(getConfigPath(), JSON.stringify(config, null, 2) + '\n');
+        console.log('  \u2713 pyrpc-client.json created (server mode)');
+      });
     });
-  }
+  });
+}
 
-  console.log('');
-  console.log('  \u26A1 @pyrpc/types: no types generated yet.');
-  console.log('  To connect to your pyRPC backend:');
-  console.log('    pyrpc codegen http://localhost:8000');
-  console.log('  Or install interactively in a terminal:');
-  console.log('    npm install @pyrpc/client');
-  console.log('');
-  return Promise.resolve();
+if (require.main === module) {
+  main().catch(function(e) {});
 }
 
-main().catch(function(e) {});
+module.exports = { main, toTs, generate, fetchSchema, findProjectRoot, getConfigPath, TYPES_FILE, PLACEHOLDER_MARKER };