@devvit/shared-types 0.10.15-next-2024-01-29-8d0410fae.0 → 0.10.15-next-2024-01-29-c13a1c9de.0

package/inspect.d.ts

@@ -0,0 +1,12 @@
+export type Options = {
+    depth: number | null;
+};
+/**
+ * Similar to node's standard util.inspect, with the following differences:
+ * - Strings are not escaped (for example, when they have quote marks in them)
+ * - Symbol keys in objects are dropped and not printed
+ * - Prints arrays with more items per line sometimes
+ * - There's no color output
+ */
+export declare function inspect(val: unknown, options?: Partial<Options>): string;
+//# sourceMappingURL=inspect.d.ts.map

package/inspect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspect.d.ts","sourceRoot":"","sources":["../src/inspect.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB,CAAC;AAkBF;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,MAAM,CAiBxE"}

package/inspect.js

@@ -0,0 +1,125 @@
+const indentPerLevel = '  '; // 2 spaces
+const smallThreashold = 55;
+const defaultOptions = {
+    depth: 2,
+};
+/**
+ * Similar to node's standard util.inspect, with the following differences:
+ * - Strings are not escaped (for example, when they have quote marks in them)
+ * - Symbol keys in objects are dropped and not printed
+ * - Prints arrays with more items per line sometimes
+ * - There's no color output
+ */
+export function inspect(val, options) {
+    if (val instanceof Error) {
+        return `${val.name}: ${val.message}`;
+    }
+    const indent = '';
+    const refs = {
+        visited: new Map(),
+        currentNumber: 0,
+    };
+    const completeOptions = {
+        ...defaultOptions,
+        ...(options ?? {}),
+    };
+    return inspectRoot(val, completeOptions, refs, indent);
+}
+function inspectRoot(val, args, refs, indent) {
+    switch (typeof val) {
+        case 'object':
+            if (val === null) {
+                return 'null';
+            }
+            return inspectObject(val, args, refs, indent);
+        case 'undefined':
+            return 'undefined';
+        case 'function':
+            return `[Function: ${val.name}]`;
+        case 'string':
+            return `'${val}'`;
+        case 'number': // fallthrough
+        case 'bigint': // fallthrough
+        case 'boolean': // fallthrough
+        case 'symbol': // fallthrough
+            return val.toString();
+        default:
+            return ''; // this should never happen
+    }
+}
+function inspectObject(obj, args, refs, indent) {
+    let refConfig = refs.visited.get(obj);
+    if (refConfig === undefined) {
+        refConfig = { isBeingPrinted: false };
+        refs.visited.set(obj, refConfig);
+    }
+    if (refConfig.isBeingPrinted) {
+        if (refConfig.refNumber === undefined) {
+            refConfig.refNumber = ++refs.currentNumber;
+        }
+        return `[Circular *${refConfig.refNumber}]`;
+    }
+    refConfig.isBeingPrinted = true;
+    let depthRemaining = args.depth;
+    if (depthRemaining !== null && depthRemaining < 0) {
+        refConfig.isBeingPrinted = false;
+        return Array.isArray(obj) ? '[Array]' : '[Object]';
+    }
+    if (depthRemaining !== null) {
+        depthRemaining -= 1;
+    }
+    const entries = [];
+    let totalLength = 0;
+    const subObjArgs = {
+        ...args,
+        depth: depthRemaining,
+    };
+    // collect all of the entries of the object or array
+    if (Array.isArray(obj)) {
+        for (const val of obj) {
+            const valString = inspectRoot(val, subObjArgs, refs, indent + indentPerLevel);
+            entries.push(valString);
+            totalLength += valString.length;
+        }
+    }
+    else {
+        for (const key in obj) {
+            const valString = inspectRoot(obj[key], subObjArgs, refs, indent + indentPerLevel);
+            entries.push([key, valString]);
+            totalLength += key.length;
+            totalLength += valString.length;
+            totalLength += ': '.length;
+        }
+    }
+    // now that we've visited all the children, it's safe to mark as not being printed
+    refConfig.isBeingPrinted = false;
+    // if any children referenced this node, we've got to add a ref label
+    const refLabel = refConfig.refNumber ? `⟨ref *${refConfig.refNumber}⟩ ` : '';
+    // handle small objects in a single line
+    if (totalLength < smallThreashold) {
+        if (Array.isArray(obj)) {
+            return `${refLabel}[ ${entries.join(', ')} ]`;
+        }
+        else {
+            return `${refLabel}{${entries.map(([key, val]) => `${key}: ${val}`).join(', ')}}`;
+        }
+    }
+    // handle large objects by indenting/formatting
+    let result = `${refLabel}${Array.isArray(obj) ? '[' : '{'}`;
+    for (let i = 0; i < entries.length; i++) {
+        const isLast = i === entries.length - 1;
+        const entry = entries[i];
+        if (Array.isArray(obj)) {
+            result += `\n${indent}${indentPerLevel}${entry}`;
+        }
+        else {
+            const [key, val] = entry;
+            result += `\n${indent}${indentPerLevel}${key}: ${val}`;
+        }
+        if (!isLast) {
+            result += ',';
+        }
+    }
+    result += `\n${indent}${Array.isArray(obj) ? ']' : '}'}`;
+    return result;
+}

package/inspect.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inspect.spec.d.ts","sourceRoot":"","sources":["../src/inspect.spec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/shared-types",
-  "version": "0.10.15-next-2024-01-29-8d0410fae.0",
+  "version": "0.10.15-next-2024-01-29-c13a1c9de.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -23,12 +23,12 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.10.15-next-2024-01-29-8d0410fae.0"
+    "@devvit/protos": "0.10.15-next-2024-01-29-c13a1c9de.0"
   },
   "devDependencies": {
     "@devvit/eslint-config": "0.10.14",
     "@devvit/repo-tools": "0.10.14",
-    "@devvit/tsconfig": "0.10.15-next-2024-01-29-8d0410fae.0",
+    "@devvit/tsconfig": "0.10.15-next-2024-01-29-c13a1c9de.0",
     "eslint": "8.9.0",
     "typescript": "5.3.2",
     "vitest": "0.31.0"
@@ -37,5 +37,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "776f7c46ed6cb408a9c302a69bfd705fc4c08dd5"
+  "gitHead": "9393eaa2706d3f23669c82beddff72eef62ec41a"
 }