licensing, deprecate runCode

ankushKun · ankushKun · commit 3dce2842d6b0 · 2024-05-23T10:33:43.000+05:30
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+
 # Logs
 logs
 *.log
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -2,12 +2,55 @@
 
 Now you can integrate our code cells into your webapps and run AO LUA anywhere 🎉
 
+[![npm](https://img.shields.io/badge/@betteridea/codecell-npm-red)](https://www.npmjs.com/package/@betteridea/codecell)
+[![downloads](https://img.shields.io/npm/dt/@betteridea/codecell?color=red)](https://www.npmjs.com/package/@betteridea/codecell)
+[![X Follow](https://img.shields.io/twitter/follow/betteridea-dev)](https://twitter.com/betteridea-dev)
+
+
 ## Installation
 
 ```bash
 npm install @betteridea/codecell
 ```
 
+## API
+
+### `CodeCell`
+
+A react component to render a code cell in your app.
+
+#### Props
+
+- `cellId` - Unique id for the cell
+- `appName` - Unique app name
+- `code` - Initial code for the cell
+- `width` - Width of the cell
+- `height` - Height of the cell
+- `className` - Class names for styling
+- `style` - Inline styles
+- `devMode` - Boolean to enable dev mode
+
+### `setCellCode`
+
+To update the code in a cell, after it has been rendered.
+It is discouraged to update code by changing the `code` prop directly, since it re-renders the iframe, again this is personal preference.
+
+#### Arguments
+
+- `cellId` - Unique id of the cell
+- `code` - Code to set in the cell
+- `devMode` - Boolean to enable dev mode
+
+
+### ~~`runCell`~~ (deprecated due to security reasons)
+
+~~To run the code in a cell, after it has been rendered (optional, since the cell already has a run button)~~
+
+#### ~~Arguments~~
+
+- ~~`cellId` - Unique id of the cell to run~~
+- ~~`devMode` - Boolean to enable dev mode~~
+
 ## Usage
 
 ```javascript
@@ -21,7 +64,7 @@ import { CodeCell, runCell } from '@betteridea/codecell';
 />
 ```
 
-To run code from external sources, you can use the `runCell` function.
+~~To run code from external sources, you can use the `runCell` function.~~ (deprecated due to security reasons)
 
 ```javascript
 import { runCell } from '@betteridea/codecell';
@@ -32,27 +75,16 @@ import { runCell } from '@betteridea/codecell';
 runCell("1");
 ```
 
-## API
-
-### `CodeCell`
-
-#### Props
-
-- `cellId` - Unique id for the cell
-- `appName` - Unique app name
-- `code` - Initial code for the cell
-- `width` - Width of the cell
-- `height` - Height of the cell
-- `className` - Class names for styling
-- `style` - Inline styles
-- `devMode` - Boolean to enable dev mode
+To update the cell with a different code snippet, you can use the `setCellCode` function.
 
-### `runCell`
+```javascript
+import { setCellCode } from '@betteridea/codecell';
 
-#### Arguments
+...
 
-- `cellId` - Unique id of the cell to run
-- `devMode` - Boolean to enable dev mode
+// This will update the code in the cell with the id provided
+setCellCode("1", "print('Updated code!')");
+```
 
 ## Developing
 
diff --git a/index.html b/index.html
@@ -1,13 +1,16 @@
 <!doctype html>
 <html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite + React + TS</title>
-  </head>
-  <body>
-    <div id="root"></div>
-    <script type="module" src="/src/main.tsx"></script>
-  </body>
-</html>
+
+<head>
+  <meta charset="UTF-8" />
+  <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>@betteridea/codecell</title>
+</head>
+
+<body>
+  <div id="root"></div>
+  <script type="module" src="/src/main.tsx"></script>
+</body>
+
+</html>
diff --git a/package.json b/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@betteridea/codecell",
+  "license": "GPL-3.0-only",
   "repository": {
     "type": "git",
     "url": "https://github.com/betteridea-dev/codecell.git"
@@ -59,4 +60,4 @@
     "vite": "^5.2.0",
     "vite-plugin-dts": "^3.9.1"
   }
-}
+}
diff --git a/src/lib/runCell.ts b/src/lib/runCell.ts
@@ -1,9 +1,11 @@
-export default function runCell(cellId: string, devMode = false) {
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default function runCell(_cellId: string, _devMode = false) {
+    throw new Error("runCell has been deprecated due to security reasons");
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const iframe: any = document.getElementById(`${cellId}`);
-    if (!iframe) return console.error(`Cell with id ${cellId} not found`);
-    if (iframe.contentWindow != null) {
-        const host = devMode ? "*" : "https://ide.betteridea.dev";
-        iframe.contentWindow.postMessage({ action: "run" }, host);
-    }
+    // const iframe: any = document.getElementById(`${cellId}`);
+    // if (!iframe) return console.error(`Cell with id ${cellId} not found`);
+    // if (iframe.contentWindow != null) {
+    //     const host = devMode ? "*" : "https://ide.betteridea.dev";
+    //     iframe.contentWindow.postMessage({ action: "run" }, host);
+    // }
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -18,8 +18,8 @@
     "jsx": "react-jsx",
     /* Linting */
     "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
     "noFallthroughCasesInSwitch": true,
     "declaration": true,
     "typeRoots": [

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+`
`1`	`2`	`# Logs`
`2`	`3`	`logs`
`3`	`4`	`*.log`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@betteridea/codecell",`
	`3`	`+ "license": "GPL-3.0-only",`
`3`	`4`	`"repository": {`
`4`	`5`	`"type": "git",`
`5`	`6`	`"url": "https://github.com/betteridea-dev/codecell.git"`
`@@ -59,4 +60,4 @@`
`59`	`60`	`"vite": "^5.2.0",`
`60`	`61`	`"vite-plugin-dts": "^3.9.1"`
`61`	`62`	`}`
`62`		`-}`
	`63`	`+}`