Suite of cli and perms bugfixes (#627)

Author: stopachka

client/packages/cli/index.js

@@ -49,6 +49,7 @@ const potentialEnvs = {
   next: "NEXT_PUBLIC_INSTANT_APP_ID",
   svelte: "PUBLIC_INSTANT_APP_ID",
   vite: "VITE_INSTANT_APP_ID",
+  expo: "EXPO_PUBLIC_INSTANT_APP_ID",
 };
 
 async function detectEnvType({ pkgDir }) {
@@ -65,6 +66,9 @@ async function detectEnvType({ pkgDir }) {
   if (packageJSON.devDependencies?.vite) {
     return "vite";
   }
+  if (packageJSON.dependencies?.expo) {
+    return "expo";
+  }
   return "catchall";
 }
 
@@ -433,8 +437,8 @@ function printDotEnvInfo(envType, appId) {
   const otherEnvs = Object.values(rest);
   otherEnvs.sort();
   const otherEnvStr = otherEnvs.map((x) => "  " + chalk.green(x)).join("\n");
-  console.log(`Alternative names: \n${otherEnvStr}`);
-  console.log(terminalLink("Dashboard", appDashUrl(appId)));
+  console.log(`Alternative names: \n${otherEnvStr} \n`);
+  console.log(terminalLink("Dashboard", appDashUrl(appId)) + '\n');
 }
 
 async function handleEnvFile(pkgAndAuthInfo, appId) {
@@ -759,7 +763,7 @@ async function pullSchema(appId, { pkgDir, instantModuleName }) {
     "utf-8",
   );
 
-  console.log("Wrote schema to instant.schema.ts");
+  console.log("✅ Wrote schema to instant.schema.ts");
 
   return { ok: true };
 }
@@ -777,7 +781,7 @@ async function pullPerms(appId, { pkgDir, instantModuleName }) {
 
   if (await pathExists(join(pkgDir, "instant.perms.ts"))) {
     const ok = await promptOk(
-      "This will ovwerwrite your local instant.perms file, OK to proceed?",
+      "This will overwrite your local instant.perms file, OK to proceed?",
     );
 
     if (!ok) return;
@@ -790,7 +794,7 @@ async function pullPerms(appId, { pkgDir, instantModuleName }) {
     "utf-8",
   );
 
-  console.log("Wrote permissions to instant.perms.ts");
+  console.log("✅ Wrote permissions to instant.perms.ts");
 
   return true;
 }
@@ -1125,7 +1129,7 @@ async function pushPerms(appId) {
 
   if (!prodPerms.ok) return;
 
-  const diffedStr = jsonDiff.diffString(prodPerms.data.perms, perms);
+  const diffedStr = jsonDiff.diffString(prodPerms.data.perms || {}, perms || {});
   if (!diffedStr.length) {
     console.log("No perms changes detected. Exiting.");
     return;
@@ -1288,13 +1292,33 @@ async function promptOk(message) {
   }).catch(() => false);
 }
 
+/**
+ * We need to do a bit of a hack of `@instantdb/react-native`. 
+ * 
+ * If a user writes import { i } from '@instantdb/react-native' 
+ * 
+ * We will fail to evaluate the file. This is because 
+ * `@instantdb/react-native` brings in `react-native`, which 
+ * does not run in a node context. 
+ * 
+ * To bypass this, we have a 'cli' module inside `react-native`, which 
+ * has all the necessary imports
+ */
+function transformImports(code) { 
+  return code.replace(
+    /"@instantdb\/react-native"/g, 
+    '"@instantdb/react-native/dist/cli"'
+  );
+}
+
 async function readLocalPermsFile() {
   const { config, sources } = await loadConfig({
     sources: [
       // load from `instant.perms.xx`
       {
         files: "instant.perms",
         extensions: ["ts", "mts", "cts", "js", "mjs", "cjs", "json"],
+        transform: transformImports,
       },
     ],
     // if false, the only the first matched will be loaded
@@ -1326,6 +1350,7 @@ async function readLocalSchemaFile() {
         {
           files: "instant.schema",
           extensions: ["ts", "mts", "cts", "js", "mjs", "cjs"],
+          transform: transformImports,
         },
       ],
       // if false, the only the first matched will be loaded
@@ -1519,9 +1544,10 @@ function appDashUrl(id) {
 }
 
 function generatePermsTypescriptFile(perms, instantModuleName) {
-  const rulesTxt = Object.keys(perms).length
-    ? JSON.stringify(perms, null, 2)
-    : `
+  const rulesTxt =
+    perms && Object.keys(perms).length
+      ? JSON.stringify(perms, null, 2)
+      : `
 {
   /**
    * Welcome to Instant's permission system!
@@ -1539,12 +1565,12 @@ function generatePermsTypescriptFile(perms, instantModuleName) {
    *   bind: ["isOwner", "data.creator == auth.uid"],
    * },
    */
-};
+}
 `.trim();
   return `
 // Docs: https://www.instantdb.com/docs/permissions
 
-import { type InstantRules } from "${instantModuleName ?? "@instantdb/core"}";
+import type { InstantRules } from "${instantModuleName ?? "@instantdb/core"}";
 
 const rules = ${rulesTxt} satisfies InstantRules;
 
@@ -1743,7 +1769,7 @@ type _AppSchema = typeof _schema;
 interface AppSchema extends _AppSchema {}
 const schema: AppSchema = _schema;
 
-export { type AppSchema }
+export type { AppSchema }
 export default schema;
 `;
 }

client/packages/core/src/index.ts

@@ -891,6 +891,7 @@ type InstantRules = {
       create?: string;
       update?: string;
       delete?: string;
+      $default?: string;
     };
     bind?: string[];
   };

client/packages/react-native/src/cli.ts

@@ -0,0 +1 @@
+export * from '@instantdb/core';

client/pnpm-lock.yaml

@@ -0,0 +1,29 @@
+// Docs: https://www.instantdb.com/docs/permissions
+
+import type { InstantRules } from "@instantdb/react-native";
+
+const rules = {
+  /**
+   * Welcome to Instant's permission system!
+   * Right now your rules are empty. To start filling them in, check out the docs:
+   * https://www.instantdb.com/docs/permissions
+   *
+   * Here's an example to give you a feel:
+   * posts: {
+   *   allow: {
+   *     view: "true",
+   *     create: "isOwner",
+   *     update: "isOwner",
+   *     delete: "isOwner",
+   *   },
+   *   bind: ["isOwner", "data.creator == auth.uid"],
+   * },
+   */
+  $default: {
+    allow: {
+      $default: "true",
+    },
+  },
+} satisfies InstantRules;
+
+export default rules;

client/sandbox/react-native-expo/instant.perms.ts

@@ -0,0 +1,30 @@
+// Docs: https://www.instantdb.com/docs/schema
+
+import { i } from "@instantdb/react-native";
+
+const _schema = i.schema({
+  // This section lets you define entities: think `posts`, `comments`, etc
+  // Take a look at the docs to learn more:
+  // https://www.instantdb.com/docs/schema#defining-entities
+  entities: {
+    $users: i.entity({
+      email: i.string().unique().indexed(),
+    }),
+  },
+  // You can define links here.
+  // For example, if `posts` should have many `comments`.
+  // More in the docs:
+  // https://www.instantdb.com/docs/schema#defining-links
+  links: {},
+  // If you use presence, you can define a room schema here
+  // https://www.instantdb.com/docs/schema#defining-rooms
+  rooms: {},
+});
+
+// This helps Typescript display nicer intellisense
+type _AppSchema = typeof _schema;
+interface AppSchema extends _AppSchema {}
+const schema: AppSchema = _schema;
+
+export type { AppSchema };
+export default schema;

client/sandbox/react-native-expo/instant.schema.ts

@@ -32,7 +32,8 @@
     "tailwindcss": "3.3.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.0"
+    "@babel/core": "^7.20.0",
+    "instant-cli": "workspace:*"
   },
   "private": true
 }

client/sandbox/react-native-expo/package.json

@@ -163,6 +163,7 @@ export const rulesSchema = {
             update: { type: 'string' },
             delete: { type: 'string' },
             view: { type: 'string' },
+            $default: { type: 'string' },
           },
           additionalProperties: false,
         },

client/www/components/dash/Perms.tsx

@@ -79,10 +79,10 @@
 
 (defn get-expr [rule etype action]
   (or
-    (get-in rule [etype "allow" action])
-    (get-in rule [etype "allow" "$default"])
-    (get-in rule ["$default" "allow" action])
-    (get-in rule ["$default" "allow" "$default"])))
+   (get-in rule [etype "allow" action])
+   (get-in rule [etype "allow" "$default"])
+   (get-in rule ["$default" "allow" action])
+   (get-in rule ["$default" "allow" "$default"])))
 
 (defn extract [rule etype action]
   (when-let [expr (get-in rule [etype "allow" action])]
@@ -158,6 +158,7 @@
   [etype action]
   (when (and (not= "$users" etype)
              (not= "$files" etype)
+             (not= "$default" etype)
              (string/starts-with? etype "$"))
     [[etype
       action