retoolrpc 0.1.7 → 0.1.8

package/dist/cjs/example.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var dedent = require('ts-dedent');
-var rpc$1 = require('./rpc-9b3e6aef.js');
+var rpc$1 = require('./rpc-5b819769.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-9b3e6aef.js');
+var rpc = require('./rpc-5b819769.js');
 require('uuid');
 require('ts-dedent');
 require('node-fetch');
@@ -22,7 +22,7 @@ function sequelizeMixin(Base) {
 function capitalize(str) {
     return str.charAt(0).toUpperCase() + str.slice(1);
 }
-function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttributes, }) {
+function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttributes, permissions, }) {
     const modelName = capitalize(model.name);
     // this will give us not just the name of the attribute, but also their type
     const modelAttributes = model.getAttributes();
@@ -41,6 +41,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
     rpc.register({
         name: `${modelName} > create`,
         arguments: writeAttributeArgs,
+        permissions,
         implementation: async (args) => {
             if (typeof args !== 'object' || Array.isArray(args)) {
                 throw 'attributes must be an object';
@@ -59,6 +60,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
             primaryKey: { type: 'string', required: true },
             ...writeAttributeArgs,
         },
+        permissions,
         implementation: async ({ primaryKey, ...attributes }) => {
             return model.update(attributes, {
                 where: {
@@ -73,6 +75,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
             findAttributes: { type: 'dict', required: true },
             ...writeAttributeArgs,
         },
+        permissions,
         implementation: async ({ findAttributes, ...writeAttributes }) => {
             // Note: this is susceptible to race condition if there is no unique index
             // on the find attributes. It's the user's responsibility to avoid
@@ -96,6 +99,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
             offset: { type: 'number' },
             limit: { type: 'number' },
         },
+        permissions,
         implementation: async ({ offset, limit }) => {
             return model.findAll({
                 attributes: readAttributes,
@@ -110,6 +114,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
         arguments: {
             primaryKey: { type: 'string', required: true },
         },
+        permissions,
         implementation: async ({ primaryKey }) => {
             return model.findByPk(primaryKey, {
                 attributes: readAttributes,
@@ -120,6 +125,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
     rpc.register({
         name: `${modelName} > findBy`,
         arguments: findByAttributeArgs,
+        permissions,
         implementation: async (attributesValues) => {
             return model.findAll({
                 where: attributesValues,

package/dist/cjs/{rpc-9b3e6aef.js → rpc-5b819769.js}

@@ -287,7 +287,7 @@ class Logger {
     }
 }
 
-const RetoolRPCVersion = '0.1.7';
+const RetoolRPCVersion = '0.1.8';
 
 // 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-f78d3d6d.mjs';
+import { R as RetoolRPC } from './rpc-2039046c.mjs';
 import 'uuid';
 import 'node-fetch';
 import 'abort-controller';

package/dist/index.mjs

@@ -1,4 +1,4 @@
-export { R as RetoolRPC } from './rpc-f78d3d6d.mjs';
+export { R as RetoolRPC } from './rpc-2039046c.mjs';
 import 'uuid';
 import 'ts-dedent';
 import 'node-fetch';
@@ -18,7 +18,7 @@ function sequelizeMixin(Base) {
 function capitalize(str) {
     return str.charAt(0).toUpperCase() + str.slice(1);
 }
-function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttributes, }) {
+function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttributes, permissions, }) {
     const modelName = capitalize(model.name);
     // this will give us not just the name of the attribute, but also their type
     const modelAttributes = model.getAttributes();
@@ -37,6 +37,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
     rpc.register({
         name: `${modelName} > create`,
         arguments: writeAttributeArgs,
+        permissions,
         implementation: async (args) => {
             if (typeof args !== 'object' || Array.isArray(args)) {
                 throw 'attributes must be an object';
@@ -55,6 +56,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
             primaryKey: { type: 'string', required: true },
             ...writeAttributeArgs,
         },
+        permissions,
         implementation: async ({ primaryKey, ...attributes }) => {
             return model.update(attributes, {
                 where: {
@@ -69,6 +71,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
             findAttributes: { type: 'dict', required: true },
             ...writeAttributeArgs,
         },
+        permissions,
         implementation: async ({ findAttributes, ...writeAttributes }) => {
             // Note: this is susceptible to race condition if there is no unique index
             // on the find attributes. It's the user's responsibility to avoid
@@ -92,6 +95,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
             offset: { type: 'number' },
             limit: { type: 'number' },
         },
+        permissions,
         implementation: async ({ offset, limit }) => {
             return model.findAll({
                 attributes: readAttributes,
@@ -106,6 +110,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
         arguments: {
             primaryKey: { type: 'string', required: true },
         },
+        permissions,
         implementation: async ({ primaryKey }) => {
             return model.findByPk(primaryKey, {
                 attributes: readAttributes,
@@ -116,6 +121,7 @@ function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttr
     rpc.register({
         name: `${modelName} > findBy`,
         arguments: findByAttributeArgs,
+        permissions,
         implementation: async (attributesValues) => {
             return model.findAll({
                 where: attributesValues,

package/dist/package.json

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

package/dist/{rpc-f78d3d6d.mjs → rpc-2039046c.mjs}

@@ -280,7 +280,7 @@ class Logger {
     }
 }
 
-const RetoolRPCVersion = '0.1.7';
+const RetoolRPCVersion = '0.1.8';
 
 // 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/addons/sequelize.d.ts

@@ -5,6 +5,10 @@ type RegisterModelArgs = {
     readAttributes?: string[];
     writeAttributes?: string[];
     findByAttributes?: string[];
+    permissions?: {
+        groupNames?: string[];
+        userEmails?: string[];
+    };
 };
 export declare class MyMixinInterface {
     registerModel(args: RegisterModelArgs): void;

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

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

package/dist/src/version.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "retoolrpc",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "TypeScript package for Retool RPC",
   "keywords": [],
   "homepage": "https://github.com/tryretool/retoolrpc#readme",
@@ -23,6 +23,16 @@
     },
     "./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",
@@ -47,15 +57,5 @@
     "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/src/addons/sequelize.ts

@@ -7,6 +7,10 @@ type RegisterModelArgs = {
   readAttributes?: string[]
   writeAttributes?: string[]
   findByAttributes?: string[]
+  permissions?: {
+    groupNames?: string[]
+    userEmails?: string[]
+  }
 }
 
 export declare class MyMixinInterface {
@@ -35,6 +39,7 @@ function registerModel({
   readAttributes,
   writeAttributes,
   findByAttributes,
+  permissions,
 }: RegisterModelArgs & { rpc: RetoolRPC }) {
   const modelName = capitalize(model.name)
   // this will give us not just the name of the attribute, but also their type
@@ -57,6 +62,7 @@ function registerModel({
   rpc.register({
     name: `${modelName} > create`,
     arguments: writeAttributeArgs,
+    permissions,
     implementation: async (args) => {
       if (typeof args !== 'object' || Array.isArray(args)) {
         throw 'attributes must be an object'
@@ -76,6 +82,7 @@ function registerModel({
       primaryKey: { type: 'string', required: true },
       ...writeAttributeArgs,
     },
+    permissions,
     implementation: async ({ primaryKey, ...attributes }) => {
       return model.update(attributes, {
         where: {
@@ -91,6 +98,7 @@ function registerModel({
       findAttributes: { type: 'dict', required: true },
       ...writeAttributeArgs,
     },
+    permissions,
     implementation: async ({ findAttributes, ...writeAttributes }) => {
       // Note: this is susceptible to race condition if there is no unique index
       // on the find attributes. It's the user's responsibility to avoid
@@ -115,6 +123,7 @@ function registerModel({
       offset: { type: 'number' },
       limit: { type: 'number' },
     },
+    permissions,
     implementation: async ({ offset, limit }) => {
       return model.findAll({
         attributes: readAttributes,
@@ -130,6 +139,7 @@ function registerModel({
     arguments: {
       primaryKey: { type: 'string', required: true },
     },
+    permissions,
     implementation: async ({ primaryKey }) => {
       return model.findByPk(primaryKey, {
         attributes: readAttributes,
@@ -141,6 +151,7 @@ function registerModel({
   rpc.register({
     name: `${modelName} > findBy`,
     arguments: findByAttributeArgs,
+    permissions,
     implementation: async (attributesValues) => {
       return model.findAll({
         where: attributesValues,

package/src/version.ts

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