@pyrpc/types 0.3.3 → 0.6.1

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.3",
-  "description": "pyRPC TypeScript type definitions — generated by pyrpc codegen",
+  "version": "0.6.1",
+  "description": "pyRPC TypeScript type definitions - generated by pyrpc codegen",
   "exports": {
     ".": {
       "types": "./src/index.ts",
@@ -9,11 +9,9 @@
     }
   },
   "files": [
-    "src",
-    "postinstall.js"
+    "src"
   ],
   "scripts": {
-    "postinstall": "node postinstall.js",
     "lint": "echo 'no lint'",
     "test": "echo 'no test'"
   },

package/src/index.ts

@@ -1,8 +1,8 @@
 // @pyrpc/types - types not generated yet.
 // Install @pyrpc/client and the postinstall script will prompt for setup:
 //   npm install @pyrpc/client
-// Or generate manually:
-//   pyrpc codegen <url>
+// Or sync manually from a running server:
+//   npx pyrpc sync
 //
 // This file is replaced when codegen runs.
 

package/postinstall.js

@@ -1,154 +0,0 @@
-var fs = require('fs');
-var path = require('path');
-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);
-  }
-}
-
-var TYPE_MAP = {
-  int: 'number',
-  float: 'number',
-  str: 'string',
-  bool: 'boolean',
-  None: 'null',
-  NoneType: 'null',
-  Any: 'any',
-};
-
-function toTs(t) {
-  if (!t || t === 'None') return 'void';
-  var m = t.match(/^<class\s+'([^'>]+)'>$/);
-  if (m) {
-    var n = m[1];
-    if (TYPE_MAP[n]) return TYPE_MAP[n];
-    if (n[0] >= 'A' && n[0] <= 'Z') return n;
-    return 'any';
-  }
-  var s = t.replace(/^typing\./, '');
-  var o = s.match(/^Optional\[(.+)\]$/);
-  if (o) return toTs(o[1]) + ' | null';
-  var l = s.match(/^(?:List|list)\[(.+)\]$/);
-  if (l) return toTs(l[1]) + '[]';
-  var d = s.match(/^(?:Dict|dict)\[([^,]+),\s*(.+)\]$/);
-  if (d) return 'Record<' + toTs(d[1]) + ', ' + toTs(d[2]) + '>';
-  var u = s.match(/^Union\[(.+)\]$/);
-  if (u) return u[1].split(',').map(function(p) { return toTs(p.trim()); }).join(' | ');
-  var tup = s.match(/^(?:Tuple|tuple)\[([^\]]+)\]$/);
-  if (tup) return '[' + tup[1].split(',').map(function(p) { return toTs(p.trim()); }).join(', ') + ']';
-  return 'any';
-}
-
-function generate(schemas) {
-  var lines = [];
-  lines.push('// Auto-generated by @pyrpc/types');
-  lines.push('// Schema fetched from: ' + (process.env.PYRPC_URL || 'http://localhost:8000'));
-  lines.push('');
-  var names = Object.keys(schemas);
-  for (var i = 0; i < names.length; i++) {
-    var name = names[i];
-    var schema = schemas[name];
-    lines.push('export interface ' + name + 'Params {');
-    var params = schema.parameters || [];
-    for (var j = 0; j < params.length; j++) {
-      var p = params[j];
-      lines.push('  ' + p.name + ': ' + toTs(p.type) + ';');
-    }
-    lines.push('}');
-    lines.push('');
-    lines.push('export interface ' + name + 'Result {');
-    lines.push('  data: ' + toTs(schema.return_type) + ';');
-    lines.push('}');
-    lines.push('');
-  }
-  lines.push('export interface Types {');
-  for (var k = 0; k < names.length; k++) {
-    lines.push('  ' + names[k] + ': { params: ' + names[k] + 'Params; result: ' + names[k] + 'Result };');
-  }
-  lines.push('}');
-  lines.push('');
-  return lines.join('\n');
-}
-
-function fetchSchema(url) {
-  var endpoint = url.replace(/\/+$/, '');
-  if (endpoint.indexOf('/rpc') !== endpoint.length - 4) {
-    endpoint += '/rpc';
-  }
-  if (typeof fetch !== 'undefined') {
-    return fetch(endpoint).then(function(res) {
-      if (!res.ok) throw new Error('HTTP ' + res.status);
-      return res.json();
-    });
-  }
-  var mod = url.indexOf('https') === 0 ? require('https') : require('http');
-  return new Promise(function(resolve, reject) {
-    mod.get(endpoint, function(res) {
-      var data = '';
-      res.on('data', function(c) { data += c; });
-      res.on('end', function() {
-        if (res.statusCode !== 200) return reject(new Error('HTTP ' + res.statusCode));
-        try { resolve(JSON.parse(data)); }
-        catch (e) { reject(e); }
-      });
-    }).on('error', reject);
-  });
-}
-
-function main() {
-  var isInteractive = process.stdin.isTTY;
-  var envUrl = process.env.PYRPC_URL;
-  var url = null;
-
-  if (isInteractive) {
-    var rl = 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);
-      });
-    }).then(function(url) {
-      return fetchSchema(url).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');
-        console.log('  Import: import type { Types } from "@pyrpc/types"');
-      }).catch(function(err) {
-        console.log('  \u2717 @pyrpc/types: could not connect (' + err.message + ')');
-        console.log('  Run manually: pyrpc codegen ' + url);
-      });
-    });
-  }
-
-  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);
-    });
-  }
-
-  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();
-}
-
-main().catch(function(e) {});