@devvit/public-api 0.11.0-next-2024-07-30-8f65a4fa6.0 → 0.11.0-next-2024-07-30-0415fdb14.0

package/apis/redis/RedisClient.js

@@ -292,7 +292,7 @@ export class RedisClient {
     }
     async get(key) {
         const response = await this.storage.Get({ key, scope: this.scope }, __classPrivateFieldGet(this, _RedisClient_metadata, "f"));
-        return response !== null ? response.value ?? undefined : response;
+        return response !== null ? (response.value ?? undefined) : response;
     }
     async set(key, value, options) {
         let expiration;
@@ -422,7 +422,7 @@ export class RedisClient {
     }
     async hGet(key, field) {
         const response = await this.storage.HGet({ key, field, scope: this.scope }, __classPrivateFieldGet(this, _RedisClient_metadata, "f"));
-        return response !== null ? response.value ?? undefined : response;
+        return response !== null ? (response.value ?? undefined) : response;
     }
     async hset(key, fieldValues) {
         return this.hSet(key, fieldValues);

package/devvit/internals/blocks/handler/BlocksHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BlocksHandler.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/BlocksHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAK7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAgB,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,KAAK,EAAe,IAAI,EAAE,UAAU,EAAE,WAAW,EAAS,MAAM,YAAY,CAAC;AAGpF;;;;;;GAMG;AACH,eAAO,IAAI,oBAAoB,EAAE,aAAa,GAAG,IAAW,CAAC;AAE7D,wBAAgB,gBAAgB,IAAI,aAAa,CAKhD;AAED,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAMD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CASxD;AASD;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,IAAI,EACzC,OAAO,EAAE,WAAW,EACpB,WAAW,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,CAAC,GAChC,CAAC,CAkCH;AAED,eAAO,IAAI,oBAAoB,EAAE,aAAa,GAAG,IAAW,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,aAAa;;IAMxB,oBAAoB,EAAE,aAAa,GAAG,IAAI,CAAQ;gBAEtC,IAAI,EAAE,GAAG,CAAC,iBAAiB;IAMjC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;CAyW1E"}
+{"version":3,"file":"BlocksHandler.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/BlocksHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,QAAQ,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAK7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,EAAgB,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACjE,OAAO,KAAK,EAAe,IAAI,EAAE,UAAU,EAAE,WAAW,EAAS,MAAM,YAAY,CAAC;AAIpF;;;;;;GAMG;AACH,eAAO,IAAI,oBAAoB,EAAE,aAAa,GAAG,IAAW,CAAC;AAE7D,wBAAgB,gBAAgB,IAAI,aAAa,CAKhD;AAED,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAMD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CASxD;AASD;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,IAAI,EACzC,OAAO,EAAE,WAAW,EACpB,WAAW,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,CAAC,GAChC,CAAC,CAkCH;AAED,eAAO,IAAI,oBAAoB,EAAE,aAAa,GAAG,IAAW,CAAC;AAE7D;;;;GAIG;AACH,qBAAa,aAAa;;IAMxB,oBAAoB,EAAE,aAAa,GAAG,IAAI,CAAQ;gBAEtC,IAAI,EAAE,GAAG,CAAC,iBAAiB;IAMjC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC;CAgX1E"}

package/devvit/internals/blocks/handler/BlocksHandler.js

@@ -14,6 +14,7 @@ import { BlocksTransformer } from '../BlocksTransformer.js';
 import { ContextBuilder } from './ContextBuilder.js';
 import { _isTombstone, RenderContext } from './RenderContext.js';
 import { RenderInterruptError } from './types.js';
+import { isCircuitBreaker } from '@devvit/shared-types/CircuitBreaker.js';
 /**
  * This can be a global/singleton because render is synchronous.
  *
@@ -168,6 +169,12 @@ export class BlocksHandler {
                 }
             }
             catch (e) {
+                /**
+                 * Guard clause, retries are only applicable for circuit breakers.  If we're not a circuit breaker, we need to throw the error.
+                 */
+                if (!isCircuitBreaker(e)) {
+                    throw e;
+                }
                 if (__classPrivateFieldGet(this, _BlocksHandler_instances, "a", _BlocksHandler_debug_get))
                     console.debug('[blocks] caught in handler', e);
                 context._latestRenderContent = undefined;

package/devvit/internals/blocks/handler/useAsync.d.ts

@@ -7,6 +7,17 @@ export type AsyncOptions = {
     depends?: JSONValue;
 };
 export type LoadState = 'initial' | 'loading' | 'loaded' | 'error' | 'disabled';
+/**
+ * This tries to save an error into the state.  If the error is a circuit breaker, it will throw the error instead,
+ * as those errors are not meant to be saved in state.
+ *
+ * @param e  -- an original error type
+ * @returns A JSONValue that can be saved in states
+ */
+export declare function toSerializableErrorOrCircuitBreak(e: unknown): {
+    message: string;
+    details: string;
+};
 /**
  * This is the preferred way to handle async state in Devvit.
  *

package/devvit/internals/blocks/handler/useAsync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useAsync.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useAsync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAQ3F,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;AAyGhF;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAC1C,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,EACxC,OAAO,GAAE,YAAiB,GACzB,cAAc,CAAC,CAAC,CAAC,CAUnB"}
+{"version":3,"file":"useAsync.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useAsync.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAS3F,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;AAEhF;;;;;;GAMG;AACH,wBAAgB,iCAAiC,CAAC,CAAC,EAAE,OAAO,GAAG;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAUA;AAkGD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAC1C,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,EACxC,OAAO,GAAE,YAAiB,GACzB,cAAc,CAAC,CAAC,CAAC,CAUnB"}

package/devvit/internals/blocks/handler/useAsync.js

@@ -13,6 +13,26 @@ var _AsyncHook_debug, _AsyncHook_hookId, _AsyncHook_initializer, _AsyncHook_inva
 import { CIRCUIT_BREAKER_MSG } from '@devvit/shared-types/CircuitBreaker.js';
 import isEqual from 'lodash.isequal';
 import { registerHook } from './BlocksHandler.js';
+import { StringUtil } from '@devvit/shared-types/StringUtil.js';
+/**
+ * This tries to save an error into the state.  If the error is a circuit breaker, it will throw the error instead,
+ * as those errors are not meant to be saved in state.
+ *
+ * @param e  -- an original error type
+ * @returns A JSONValue that can be saved in states
+ */
+export function toSerializableErrorOrCircuitBreak(e) {
+    // This is a little side-effecty, so open to suggestions on how to improve.
+    if (e instanceof Error) {
+        if (e.message === CIRCUIT_BREAKER_MSG) {
+            throw e;
+        }
+        return { message: e.message, details: e.stack ?? '' };
+    }
+    else {
+        return { message: 'Unknown error', details: StringUtil.caughtToString(e) };
+    }
+}
 class AsyncHook {
     constructor(initializer, options, params) {
         _AsyncHook_debug.set(this, void 0);
@@ -73,15 +93,7 @@ class AsyncHook {
                 };
             }
             catch (e) {
-                if (e instanceof Error) {
-                    if (e.message === CIRCUIT_BREAKER_MSG) {
-                        throw e;
-                    }
-                    asyncResponse.error = { message: e.message, details: e.stack ?? '' };
-                }
-                else {
-                    asyncResponse.error = { message: 'Unknown error', details: String(e) };
-                }
+                asyncResponse.error = toSerializableErrorOrCircuitBreak(e);
             }
             const requeueEvent = {
                 asyncResponse: asyncResponse,

package/devvit/internals/blocks/handler/useState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useState.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAEV,mBAAmB,EACnB,cAAc,EACf,MAAM,4BAA4B,CAAC;AAoGpC,wBAAgB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAC9F,wBAAgB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAC5F,wBAAgB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAC1C,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC,GACnC,cAAc,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"useState.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useState.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAEV,mBAAmB,EACnB,cAAc,EACf,MAAM,4BAA4B,CAAC;AA2GpC,wBAAgB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;AAC9F,wBAAgB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAC5F,wBAAgB,QAAQ,CAAC,YAAY,EAAE,mBAAmB,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAC5F,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAC1C,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC,GACnC,cAAc,CAAC,CAAC,CAAC,CAAC"}

package/devvit/internals/blocks/handler/useState.js

@@ -12,12 +12,13 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _UseStateHook_changed, _UseStateHook_ctx, _UseStateHook_initializer, _UseStateHook_hookId, _UseStateHook_promise;
 import { registerHook } from './BlocksHandler.js';
 import { RenderInterruptError } from './types.js';
+import { toSerializableErrorOrCircuitBreak } from './useAsync.js';
 /**
  * Implementation of the useState hook.
  */
 class UseStateHook {
     constructor(initializer, params) {
-        this.state = { value: null, load_state: 'initial' };
+        this.state = { value: null, load_state: 'initial', error: null };
         _UseStateHook_changed.set(this, void 0);
         _UseStateHook_ctx.set(this, void 0);
         _UseStateHook_initializer.set(this, void 0);
@@ -46,7 +47,7 @@ class UseStateHook {
             }
             catch (e) {
                 this.state.load_state = 'error';
-                console.error('Error loading async state: ', e);
+                this.state.error = toSerializableErrorOrCircuitBreak(e);
             }
             __classPrivateFieldGet(this, _UseStateHook_changed, "f").call(this);
         }
@@ -73,6 +74,9 @@ class UseStateHook {
         if (this.state.load_state === 'loading') {
             throw new RenderInterruptError();
         }
+        if (this.state.load_state === 'error') {
+            throw new Error(this.state.error?.message ?? 'Unknown error');
+        }
         if (this.state.load_state === 'initial') {
             let initialValue;
             try {

package/devvit/internals/context.js

@@ -1,6 +1,6 @@
 import { Header } from '@devvit/shared-types/Header.js';
 import { assertNonNull } from '@devvit/shared-types/NonNull.js';
-import pkg from '../../version.json' assert { type: 'json' };
+import pkg from '../../version.json' with { type: 'json' };
 export function getContextFromMetadata(metadata, postId, commentId) {
     const subredditId = metadata[Header.Subreddit]?.values[0];
     assertNonNull(subredditId, 'subreddit is missing from Context');