sliftutils 0.8.0 → 0.9.0

package/.cursorrules

@@ -22,9 +22,29 @@ We use MobX for state management. Components should use a variable called synced
         }
     }
 
+The code automatically updates on save, so do not ever run commands to rerun the site.
+
+In the implementation for every type of API, there should be a companion file to manage the session (ex smsSession.ts). This should export a function which makes calling the API functions simple by automatically managing the session. Because the session helper will be making the function calls, it can try catch them and appropriately handle the session errors that require regenerating the session. Of course, if it's not a session error, it should just rethrow it.
+
+Use createPersistentObject for persistent things like session states. It's accessed synchronously and the key will have an undefined value if it the value isn't set. 
+
+    let persistent = createPersistentObject<{
+        token: string;
+    }>("sms");
+
+    persistent.token = "...";
+    persistent.token;
+
+
 Coding Styles
     Try not to use "null", and instead always use "undefined".
 
+    Almost never check for undefined or null, just check for falsey.
+
+    When functions have more than one primitive parameter, such that you could confuse them, even something as simple as start time and end time, you should put them inside of an object and call that object config, so the function only has a single parameter.
+
+    Never use return codes, always prefer to throw on error. Include a lot of context information in the error. If any values might be extremely large, such as parsing a file, limit them (ex, to 500 characters).
+
     He used double quotes, not single quotes. 
 
     Never use the ternary operator. Instead, do this: "x ? y : z" => "x && y || z".
@@ -53,6 +73,10 @@ Coding Styles
 
     Do not use types when they can be inferred. 
 
+    Constants that are arbitrary and that we might to reconfigure should be near the top of the file under the imports, not buried within functions. 
+
+    Never use environment variables. All configuration should be on the disk, or, if specific to a current run, passed as command line parameters. 
+
 
 General Styling
     Never use em or rem. Only use px or vw/vh/%.

package/misc/getSecret.ts

@@ -0,0 +1,32 @@
+
+// Ex, sms.json.id => os.homedir() + "/sms.json", then read key "id"
+//  - As in, we expect .json, and use that to determine the path vs key.
+//  - If there is no .json, we just assume the entire key is the path (still os.homedir()), and return the entire file.
+
+import { cache } from "socket-function/src/caching";
+import os from "os";
+import fs from "fs";
+
+export const getSecret = cache(async function getSecret(key: string): Promise<string> {
+    const jsonIndex = key.indexOf(".json");
+    if (jsonIndex === -1) {
+        const filePath = os.homedir() + "/" + key;
+        return fs.readFileSync(filePath, "utf-8").trim();
+    }
+
+    const pathPart = key.slice(0, jsonIndex + ".json".length);
+    const filePath = os.homedir() + "/" + pathPart;
+    const contents = fs.readFileSync(filePath, "utf-8");
+    const json = JSON.parse(contents);
+
+    const keyPart = key.slice(jsonIndex + ".json.".length);
+    if (!keyPart) {
+        return JSON.stringify(json);
+    }
+
+    const value = json[keyPart];
+    if (value === undefined) {
+        throw new Error(`Expected key "${keyPart}" in ${filePath}, was undefined`);
+    }
+    return String(value);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sliftutils",
-    "version": "0.8.0",
+    "version": "0.9.0",
     "main": "index.js",
     "license": "MIT",
     "scripts": {