retoolrpc 0.1.1 → 0.1.3

package/dist/index.mjs

@@ -0,0 +1,129 @@
+export { R as RetoolRPC } from './rpc-c0b37172.mjs';
+import 'uuid';
+import 'ts-dedent';
+import 'node-fetch';
+import 'abort-controller';
+
+// See documentation about mixin:
+// https://www.typescriptlang.org/docs/handbook/mixins.html
+// https://lit.dev/docs/composition/mixins/#typing-the-subclass
+function sequelizeMixin(Base) {
+    class RetoolRPCSequelize extends Base {
+        registerModel(args) {
+            registerModel({ rpc: this, ...args });
+        }
+    }
+    return RetoolRPCSequelize;
+}
+function capitalize(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+function registerModel({ rpc, model, readAttributes, writeAttributes, findByAttributes, }) {
+    const modelName = capitalize(model.name);
+    // this will give us not just the name of the attribute, but also their type
+    const modelAttributes = model.getAttributes();
+    readAttributes = readAttributes || Object.keys(modelAttributes);
+    writeAttributes = writeAttributes || Object.keys(modelAttributes);
+    findByAttributes = findByAttributes || readAttributes;
+    const findByAttributeArgs = {};
+    for (const attr of findByAttributes) {
+        findByAttributeArgs[attr] = { type: 'string' };
+    }
+    const writeAttributeArgs = {};
+    for (const attr of writeAttributes) {
+        writeAttributeArgs[attr] = { type: 'string' };
+    }
+    // register a set of functions for a model
+    rpc.register({
+        name: `${modelName} > create`,
+        arguments: writeAttributeArgs,
+        implementation: async (args) => {
+            if (typeof args !== 'object' || Array.isArray(args)) {
+                throw 'attributes must be an object';
+            }
+            const record = await model.create(args);
+            const recordJson = {};
+            for (const key of readAttributes || Object.keys(args)) {
+                recordJson[key] = record.get(key);
+            }
+            return recordJson;
+        },
+    });
+    rpc.register({
+        name: `${modelName} > update`,
+        arguments: {
+            primaryKey: { type: 'string', required: true },
+            ...writeAttributeArgs,
+        },
+        implementation: async ({ primaryKey, ...attributes }) => {
+            return model.update(attributes, {
+                where: {
+                    [model.primaryKeyAttribute]: primaryKey,
+                },
+            });
+        },
+    });
+    rpc.register({
+        name: `${modelName} > createOrUpdate`,
+        arguments: {
+            findAttributes: { type: 'dict', required: true },
+            ...writeAttributeArgs,
+        },
+        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
+            // duplicate inserts
+            return model.findOne({ where: findAttributes }).then(function (record) {
+                // update
+                if (record) {
+                    return record.update(writeAttributes);
+                }
+                // insert
+                return model.create({
+                    ...findAttributes,
+                    ...writeAttributes,
+                });
+            });
+        },
+    });
+    rpc.register({
+        name: `${modelName} > findAll`,
+        arguments: {
+            offset: { type: 'number' },
+            limit: { type: 'number' },
+        },
+        implementation: async ({ offset, limit }) => {
+            return model.findAll({
+                attributes: readAttributes,
+                raw: true,
+                offset: offset || 0,
+                limit: limit || 100,
+            });
+        },
+    });
+    rpc.register({
+        name: `${modelName} > findByPk`,
+        arguments: {
+            primaryKey: { type: 'string', required: true },
+        },
+        implementation: async ({ primaryKey }) => {
+            return model.findByPk(primaryKey, {
+                attributes: readAttributes,
+                raw: true,
+            });
+        },
+    });
+    rpc.register({
+        name: `${modelName} > findBy`,
+        arguments: findByAttributeArgs,
+        implementation: async (attributesValues) => {
+            return model.findAll({
+                where: attributesValues,
+                attributes: readAttributes,
+                raw: true,
+            });
+        },
+    });
+}
+
+export { sequelizeMixin };

package/dist/package.json

@@ -1,20 +1,42 @@
 {
   "name": "retoolrpc",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "TypeScript package for Retool RPC",
+  "keywords": [],
+  "homepage": "https://github.com/tryretool/retoolrpc#readme",
+  "bugs": {
+    "url": "https://github.com/tryretool/retoolrpc/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tryretool/retoolrpc.git"
+  },
+  "license": "MIT",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
+      "import": "./dist/index.mjs",
       "require": "./dist/cjs/index.js"
     },
     "./package.json": "./package.json"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tryretool/retoolrpc.git"
+  "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": {
+    "@types/node-fetch": "^2.6.4",
+    "@types/uuid": "^9.0.2",
+    "abort-controller": "^3.0.0",
+    "node-fetch": "^2.6",
+    "ts-dedent": "^2.2.0",
+    "uuid": "^9.0.0"
   },
-  "license": "MIT",
-  "keywords": [],
   "devDependencies": {
     "@rollup/plugin-typescript": "^8.2.0",
     "@types/fs-extra": "^11.0.1",
@@ -31,27 +53,5 @@
     "tslib": "^2.1.0",
     "typescript": "5.2.2",
     "vitest": "^0.34.5"
-  },
-  "dependencies": {
-    "@types/node-fetch": "^2.6.4",
-    "@types/uuid": "^9.0.2",
-    "abort-controller": "^3.0.0",
-    "node-fetch": "^2.6",
-    "ts-dedent": "^2.2.0",
-    "uuid": "^9.0.0"
-  },
-  "scripts": {
-    "build:cjs": "cross-env MODE=cjs rollup -c",
-    "build:esm": "rollup -c",
-    "build": "yarn build:cjs && yarn build:esm",
-    "example": "nodemon -V -L --watch src -e ts example.ts",
-    "bumpVersion": "ts-node scripts/bumpVersion.ts",
-    "release": "yarn build && npm publish --access public",
-    "test": "vitest",
-    "test:api": "tsc --project tsconfig.json"
-  },
-  "homepage": "https://github.com/tryretool/retoolrpc#readme",
-  "bugs": {
-    "url": "https://github.com/tryretool/retoolrpc/issues"
   }
 }