retoolrpc 0.1.5 → 0.1.7

package/dist/cjs/example.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var dedent = require('ts-dedent');
-var rpc$1 = require('./rpc-49533d0b.js');
+var rpc$1 = require('./rpc-9b3e6aef.js');
 require('uuid');
 require('node-fetch');
 require('abort-controller');

package/dist/cjs/index.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var rpc = require('./rpc-49533d0b.js');
+var rpc = require('./rpc-9b3e6aef.js');
 require('uuid');
 require('ts-dedent');
 require('node-fetch');

package/dist/cjs/package.json

@@ -1 +1 @@
-"{\"type\":\"commonjs\"}"
+{"type":"commonjs"}

package/dist/cjs/{rpc-8e01bb21.js → rpc-9b3e6aef.js}

@@ -224,7 +224,8 @@ const CONNECTION_ERROR_INITIAL_TIMEOUT_MS = 50;
 const CONNECTION_ERROR_RETRY_MAX_MS = 1000 * 60 * 10; // 10 minutes
 function sleep(ms) {
     return new Promise((resolve) => {
-        setTimeout(resolve, ms);
+        const timeout = setTimeout(resolve, ms);
+        timeout.unref();
     });
 }
 async function loopWithBackoff(pollingIntervalMs, logger, callback) {
@@ -286,7 +287,7 @@ class Logger {
     }
 }
 
-const RetoolRPCVersion = '0.1.4';
+const RetoolRPCVersion = '0.1.7';
 
 // AbortController was added in node v14.17.0 globally, but we need to polyfill it for older versions
 const AbortController = globalThis.AbortController || AbortControllerFallback__default["default"];

package/dist/example.mjs

@@ -1,5 +1,5 @@
 import dedent from 'ts-dedent';
-import { R as RetoolRPC } from './rpc-86842ea7.mjs';
+import { R as RetoolRPC } from './rpc-f78d3d6d.mjs';
 import 'uuid';
 import 'node-fetch';
 import 'abort-controller';

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { R as RetoolRPC } from './rpc-86842ea7.mjs';
+export { R as RetoolRPC } from './rpc-f78d3d6d.mjs';
 import 'uuid';
 import 'ts-dedent';
 import 'node-fetch';

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "retoolrpc",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "TypeScript package for Retool RPC",
   "keywords": [],
   "homepage": "https://github.com/tryretool/retoolrpc#readme",

package/dist/{rpc-86842ea7.mjs → rpc-f78d3d6d.mjs}

@@ -217,7 +217,8 @@ const CONNECTION_ERROR_INITIAL_TIMEOUT_MS = 50;
 const CONNECTION_ERROR_RETRY_MAX_MS = 1000 * 60 * 10; // 10 minutes
 function sleep(ms) {
     return new Promise((resolve) => {
-        setTimeout(resolve, ms);
+        const timeout = setTimeout(resolve, ms);
+        timeout.unref();
     });
 }
 async function loopWithBackoff(pollingIntervalMs, logger, callback) {
@@ -279,7 +280,7 @@ class Logger {
     }
 }
 
-const RetoolRPCVersion = '0.1.5';
+const RetoolRPCVersion = '0.1.7';
 
 // AbortController was added in node v14.17.0 globally, but we need to polyfill it for older versions
 const AbortController = globalThis.AbortController || AbortControllerFallback;

package/dist/src/types.d.ts

@@ -33,11 +33,17 @@ export type ArgumentType = 'string' | 'boolean' | 'number' | 'dict' | 'json';
 export type Argument = {
     /** The type of the argument. */
     type: ArgumentType;
-    /** Specifies whether the argument is expected to be an array. */
+    /**
+     * Specifies whether the argument is expected to be an array.
+     * @default false
+     */
     array?: boolean;
     /** The description of the argument. */
     description?: string;
-    /** Specifies whether the argument is required. */
+    /**
+     * Specifies whether the argument is required.
+     * @default false
+     */
     required?: boolean;
 };
 /** Recursive JSON type */
@@ -50,10 +56,14 @@ export type ArgumentTypeMap<T extends Argument> = T['type'] extends 'string' ? s
 export type Arguments = Record<string, Argument>;
 /** Represents a map of argument name to argument type. */
 export type TransformedArgument<TArg extends Argument> = TArg['array'] extends true ? Array<ArgumentTypeMap<TArg>> : ArgumentTypeMap<TArg>;
+type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type GetOptionalArgs<TArgs extends Arguments> = {
+    [TArg in keyof TArgs]: TArgs[TArg]['required'] extends true ? never : TArg;
+}[keyof TArgs];
 /** Represents a map of argument names to argument types. */
-export type TransformedArguments<TArgs extends Arguments> = {
+export type TransformedArguments<TArgs extends Arguments> = PartialBy<{
     [TArg in keyof TArgs]: TransformedArgument<TArgs[TArg]>;
-};
+}, GetOptionalArgs<TArgs>>;
 /** Represents the specification for registering a Retool function. */
 export type RegisterFunctionSpec<TArgs extends Arguments, TReturn> = {
     /** The name of the function. */
@@ -96,3 +106,4 @@ export type AgentServerError = {
 };
 /** Represents the current status of a function execution. */
 export type AgentServerStatus = 'continue' | 'stop' | 'done';
+export {};

package/dist/src/utils/api.d.ts

@@ -1,3 +1,4 @@
+import fetch from 'node-fetch';
 import { AgentServerError } from '../types';
 type PopQueryRequest = {
     resourceId: string;
@@ -38,8 +39,8 @@ export declare class RetoolAPI {
         apiKey: string;
         pollingTimeoutMs: number;
     });
-    popQuery(options: PopQueryRequest): Promise<import("node-fetch").Response>;
-    registerAgent(options: RegisterAgentRequest): Promise<import("node-fetch").Response>;
-    postQueryResponse(options: PostQueryResponseRequest): Promise<import("node-fetch").Response>;
+    popQuery(options: PopQueryRequest): Promise<fetch.Response>;
+    registerAgent(options: RegisterAgentRequest): Promise<fetch.Response>;
+    postQueryResponse(options: PostQueryResponseRequest): Promise<fetch.Response>;
 }
 export {};

package/dist/src/version.d.ts

@@ -1 +1 @@
-export declare const RetoolRPCVersion = "0.1.5";
+export declare const RetoolRPCVersion = "0.1.7";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "retoolrpc",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "TypeScript package for Retool RPC",
   "keywords": [],
   "homepage": "https://github.com/tryretool/retoolrpc#readme",
@@ -23,16 +23,6 @@
     },
     "./package.json": "./package.json"
   },
-  "scripts": {
-    "build": "yarn build:cjs && yarn build:esm",
-    "build:cjs": "cross-env MODE=cjs rollup -c",
-    "build:esm": "rollup -c",
-    "bumpVersion": "ts-node scripts/bumpVersion.ts",
-    "example": "nodemon -V -L --watch src -e ts example.ts",
-    "release": "yarn build && npm publish --access public",
-    "test": "vitest",
-    "test:api": "tsc --project tsconfig.json"
-  },
   "dependencies": {
     "abort-controller": "^3.0.0",
     "node-fetch": "^2.6",
@@ -57,5 +47,15 @@
     "tslib": "^2.1.0",
     "typescript": "5.2.2",
     "vitest": "^0.34.5"
+  },
+  "scripts": {
+    "build": "yarn build:cjs && yarn build:esm",
+    "build:cjs": "cross-env MODE=cjs rollup -c",
+    "build:esm": "rollup -c",
+    "bumpVersion": "ts-node scripts/bumpVersion.ts",
+    "example": "nodemon -V -L --watch src -e ts example.ts",
+    "release": "yarn build && npm publish --access public",
+    "test": "vitest",
+    "test:api": "tsc --project tsconfig.json"
   }
-}
+}

package/rollup.config.js

@@ -10,9 +10,9 @@ const commonjsPkgJSONPlugin = () => {
       if (isCJSBuild === true) {
         fs.writeJsonSync(
           'dist/cjs/package.json',
-          JSON.stringify({
-            type: 'commonjs',
-          }),
+            {
+              type: 'commonjs',
+            }
         )
       } else {
         await fs.copyFile('package.json', 'dist/package.json')

package/src/rpc.spec.ts

@@ -758,18 +758,52 @@ describe('RetoolRPC', () => {
       arguments: {},
       implementation: async () => {
         return 1
-      }
+      },
     })
 
     type ExpectedImplementation = (args: TransformedArguments<Arguments>, context: RetoolContext) => Promise<number>
     expectTypeOf(fn).toEqualTypeOf<ExpectedImplementation>()
-    
 
-    const result = await fn({}, context);
+    const result = await fn({}, context)
     expect(result).toEqual(1)
     expectTypeOf(result).toEqualTypeOf(1)
   })
 
+  test('infers non-required properties as optional', async () => {
+    const fn = rpcAgent.register({
+      name: 'test',
+      arguments: {
+        explicitRequired: {
+          type: 'number',
+          required: true,
+        },
+        explicitOptional: {
+          type: 'number',
+          required: false,
+        },
+        implicitOptional: {
+          type: 'number',
+        },
+      },
+      implementation: async (args) => {
+        expectTypeOf(args.explicitRequired).toEqualTypeOf<number>()
+
+        expectTypeOf(args.explicitOptional).toEqualTypeOf<number | undefined>()
+        expectTypeOf(args.implicitOptional).toEqualTypeOf<number | undefined>()
+
+        return args
+      },
+    })
+
+    const result = await fn(
+      {
+        explicitRequired: 1,
+      },
+      context,
+    )
+
+    expectTypeOf(result.explicitOptional).toEqualTypeOf<number | undefined>()
+  })
 })
 
 describe('RetoolRPCVersion', () => {

package/src/rpc.ts

@@ -89,13 +89,15 @@ export class RetoolRPC {
   /**
    * Registers a Retool function with the specified function definition.
    */
-  register<TArgs extends Arguments, TReturn>(spec: RegisterFunctionSpec<TArgs, TReturn>): RegisterFunctionSpec<TArgs, TReturn>['implementation'] {
+  register<TArgs extends Arguments, TReturn>(
+    spec: RegisterFunctionSpec<TArgs, TReturn>,
+  ): RegisterFunctionSpec<TArgs, TReturn>['implementation'] {
     this._functions[spec.name] = {
       arguments: spec.arguments,
       permissions: spec.permissions,
-      implementation: spec.implementation,
+      implementation: spec.implementation as RegisterFunctionSpec<any, any>['implementation'],
     }
-    return spec.implementation;
+    return spec.implementation
   }
 
   /**

package/src/types.ts

@@ -36,11 +36,17 @@ export type ArgumentType = 'string' | 'boolean' | 'number' | 'dict' | 'json'
 export type Argument = {
   /** The type of the argument. */
   type: ArgumentType
-  /** Specifies whether the argument is expected to be an array. */
+  /**
+   * Specifies whether the argument is expected to be an array.
+   * @default false
+   */
   array?: boolean
   /** The description of the argument. */
   description?: string
-  /** Specifies whether the argument is required. */
+  /**
+   * Specifies whether the argument is required.
+   * @default false
+   */
   required?: boolean
 }
 
@@ -68,10 +74,18 @@ export type TransformedArgument<TArg extends Argument> = TArg['array'] extends t
   ? Array<ArgumentTypeMap<TArg>>
   : ArgumentTypeMap<TArg>
 
+type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+type GetOptionalArgs<TArgs extends Arguments> = {
+  [TArg in keyof TArgs]: TArgs[TArg]['required'] extends true ? never : TArg
+}[keyof TArgs]
+
 /** Represents a map of argument names to argument types. */
-export type TransformedArguments<TArgs extends Arguments> = {
-  [TArg in keyof TArgs]: TransformedArgument<TArgs[TArg]>
-}
+export type TransformedArguments<TArgs extends Arguments> = PartialBy<
+  {
+    [TArg in keyof TArgs]: TransformedArgument<TArgs[TArg]>
+  },
+  GetOptionalArgs<TArgs>
+>
 
 /** Represents the specification for registering a Retool function. */
 export type RegisterFunctionSpec<TArgs extends Arguments, TReturn> = {

package/src/utils/polling.ts

@@ -6,7 +6,8 @@ const CONNECTION_ERROR_RETRY_MAX_MS = 1000 * 60 * 10 // 10 minutes
 
 function sleep(ms: number): Promise<void> {
   return new Promise((resolve) => {
-    setTimeout(resolve, ms)
+    const timeout = setTimeout(resolve, ms)
+    timeout.unref()
   })
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const RetoolRPCVersion = '0.1.5'
+export const RetoolRPCVersion = '0.1.7'

package/tsconfig.json

@@ -12,6 +12,7 @@
     "skipLibCheck": true,
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
+    "lib": ["ESNext"]
   },
   "ts-node": {
     // these options are overrides used only by ts-node
@@ -19,5 +20,5 @@
     "compilerOptions": {
       "module": "commonjs"
     }
-  },
+  }
 }