@devvit/public-api 0.11.4-next-2024-12-03-c18e28c44.0 → 0.11.4-next-2024-12-03-534d9fc60.0

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

@@ -1,12 +1,33 @@
 import type { JSONValue } from '@devvit/shared-types/json.js';
 import type { AsyncUseStateInitializer, UseAsyncResult } from '../../../../types/hooks.js';
-export type AsyncOptions = {
+export type AsyncOptions<S extends JSONValue> = {
     /**
      * The data loader will re-run if the value of `depends` changes.
      */
     depends?: JSONValue;
+    /**
+     * A callback that will be called after the data is loaded, regardless of whether it succeeds or fails.
+     * This is a good place to run setStates or other side effects, because calling a setState in the main
+     * body is not allowed.
+     *
+     *    useAsync(async () => {
+     *        const response = await fetch(`https://date.api/today?timezone=${timezone}`);
+     *        return response.json();
+     *    }, {
+     *        depends: [timezone],
+     *        finally: (data, error) => {
+     *            if (error) {
+     *                console.error("Failed to load date data:", error);
+     *            } else {
+     *                setTodayDate(data['currentDate']);
+     *            }
+     *        },
+     *    });
+     *
+     */
+    finally?: (data: S | null, error: Error | null) => void;
 };
-export type LoadState = 'initial' | 'loading' | 'loaded' | 'error' | 'disabled';
+export type LoadState = 'initial' | 'loading' | 'loaded' | 'error';
 /**
  * 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.
@@ -24,5 +45,5 @@ export declare function toSerializableErrorOrCircuitBreak(e: unknown): {
  * @param initializer -- any async function that returns a JSONValue
  * @returns UseAsyncResult<S>
  */
-export declare function useAsync<S extends JSONValue>(initializer: AsyncUseStateInitializer<S>, options?: AsyncOptions): UseAsyncResult<S>;
+export declare function useAsync<S extends JSONValue>(initializer: AsyncUseStateInitializer<S>, options?: AsyncOptions<S>): UseAsyncResult<S>;
 //# sourceMappingURL=useAsync.d.ts.map

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":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAI9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAK3F,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,CAYA;AA2GD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAC1C,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,EACxC,OAAO,GAAE,YAAiB,GACzB,cAAc,CAAC,CAAC,CAAC,CAanB"}
+{"version":3,"file":"useAsync.d.ts","sourceRoot":"","sources":["../../../../../src/devvit/internals/blocks/handler/useAsync.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAI9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAK3F,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,SAAS,IAAI;IAC9C;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,KAAK,IAAI,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEnE;;;;;;GAMG;AACH,wBAAgB,iCAAiC,CAAC,CAAC,EAAE,OAAO,GAAG;IAC7D,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAYA;AAoHD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAC1C,WAAW,EAAE,wBAAwB,CAAC,CAAC,CAAC,EACxC,OAAO,GAAE,YAAY,CAAC,CAAC,CAAM,GAC5B,cAAc,CAAC,CAAC,CAAC,CAanB"}

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

@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _AsyncHook_debug, _AsyncHook_hookId, _AsyncHook_invalidate, _AsyncHook_ctx;
+var _AsyncHook_debug, _AsyncHook_hookId, _AsyncHook_invalidate, _AsyncHook_ctx, _AsyncHook_options;
 import { UIEventScope } from '@devvit/protos';
 import { CIRCUIT_BREAKER_MSG } from '@devvit/shared-types/CircuitBreaker.js';
 import { StringUtil } from '@devvit/shared-types/StringUtil.js';
@@ -42,6 +42,7 @@ class AsyncHook {
         _AsyncHook_hookId.set(this, void 0);
         _AsyncHook_invalidate.set(this, void 0);
         _AsyncHook_ctx.set(this, void 0);
+        _AsyncHook_options.set(this, void 0);
         __classPrivateFieldSet(this, _AsyncHook_debug, !!params.context.devvitContext.debug.useAsync, "f");
         if (__classPrivateFieldGet(this, _AsyncHook_debug, "f"))
             console.debug('[useAsync] v1', options);
@@ -51,14 +52,12 @@ class AsyncHook {
         __classPrivateFieldSet(this, _AsyncHook_invalidate, params.invalidate, "f");
         __classPrivateFieldSet(this, _AsyncHook_ctx, params.context, "f");
         this.localDepends = options.depends ?? null;
+        __classPrivateFieldSet(this, _AsyncHook_options, options, "f");
     }
     /**
      * After we look at our state, we need to decide if we need to dispatch a request to load the data.
      */
     onStateLoaded() {
-        if (this.state.load_state === 'disabled') {
-            return;
-        }
         if (__classPrivateFieldGet(this, _AsyncHook_debug, "f"))
             console.debug('[useAsync] async onLoad ', __classPrivateFieldGet(this, _AsyncHook_hookId, "f"), this.state);
         if (__classPrivateFieldGet(this, _AsyncHook_debug, "f"))
@@ -117,6 +116,9 @@ class AsyncHook {
                     error: event.asyncResponse.error ?? null,
                     load_state: event.asyncResponse.error ? 'error' : 'loaded',
                 };
+                if (__classPrivateFieldGet(this, _AsyncHook_options, "f").finally) {
+                    await __classPrivateFieldGet(this, _AsyncHook_options, "f").finally(this.state.data, this.state.error ? new Error(this.state.error?.message ?? 'Unknown error') : null);
+                }
                 __classPrivateFieldGet(this, _AsyncHook_invalidate, "f").call(this);
             }
             else {
@@ -129,7 +131,7 @@ class AsyncHook {
         }
     }
 }
-_AsyncHook_debug = new WeakMap(), _AsyncHook_hookId = new WeakMap(), _AsyncHook_invalidate = new WeakMap(), _AsyncHook_ctx = new WeakMap();
+_AsyncHook_debug = new WeakMap(), _AsyncHook_hookId = new WeakMap(), _AsyncHook_invalidate = new WeakMap(), _AsyncHook_ctx = new WeakMap(), _AsyncHook_options = new WeakMap();
 /**
  * This is the preferred way to handle async state in Devvit.
  *

package/meta.json

@@ -10825,7 +10825,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/useAsync.ts": {
-      "bytes": 5930,
+      "bytes": 6958,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -12869,7 +12869,7 @@
           "bytesInOutput": 56
         },
         "src/devvit/internals/blocks/handler/useAsync.ts": {
-          "bytesInOutput": 4475
+          "bytesInOutput": 4784
         },
         "src/devvit/internals/blocks/handler/useState.ts": {
           "bytesInOutput": 3770
@@ -12971,7 +12971,7 @@
           "bytesInOutput": 370
         }
       },
-      "bytes": 12841370
+      "bytes": 12843271
     }
   }
 }

package/meta.min.json

@@ -3685,7 +3685,7 @@
       "format": "esm"
     },
     "src/devvit/internals/blocks/handler/useAsync.ts": {
-      "bytes": 5930,
+      "bytes": 6958,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -4789,7 +4789,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1233854
+      "bytes": 1235094
     },
     "dist/public-api.min.js": {
       "imports": [
@@ -5550,7 +5550,7 @@
           "bytesInOutput": 29
         },
         "src/devvit/internals/blocks/handler/useAsync.ts": {
-          "bytesInOutput": 2297
+          "bytesInOutput": 2439
         },
         "src/devvit/internals/blocks/handler/ContextBuilder.ts": {
           "bytesInOutput": 530
@@ -5634,7 +5634,7 @@
           "bytesInOutput": 178
         }
       },
-      "bytes": 263507
+      "bytes": 263649
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.11.4-next-2024-12-03-c18e28c44.0",
+  "version": "0.11.4-next-2024-12-03-534d9fc60.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,8 +30,8 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.4-next-2024-12-03-c18e28c44.0",
-    "@devvit/shared-types": "0.11.4-next-2024-12-03-c18e28c44.0",
+    "@devvit/protos": "0.11.4-next-2024-12-03-534d9fc60.0",
+    "@devvit/shared-types": "0.11.4-next-2024-12-03-534d9fc60.0",
     "base64-js": "1.5.1",
     "clone-deep": "4.0.1",
     "core-js": "3.27.2",
@@ -39,8 +39,8 @@
   },
   "devDependencies": {
     "@ampproject/filesize": "4.3.0",
-    "@devvit/repo-tools": "0.11.4-next-2024-12-03-c18e28c44.0",
-    "@devvit/tsconfig": "0.11.4-next-2024-12-03-c18e28c44.0",
+    "@devvit/repo-tools": "0.11.4-next-2024-12-03-534d9fc60.0",
+    "@devvit/tsconfig": "0.11.4-next-2024-12-03-534d9fc60.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "18.0.1",
     "@types/clone-deep": "4.0.1",
@@ -63,5 +63,5 @@
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "1713fc9de3d013b34268e022f337a3389afd6d89"
+  "gitHead": "b16112746286848525cdeed04e9c342a0508f931"
 }

package/public-api.d.ts

@@ -1235,11 +1235,32 @@ declare const AsyncError_2: {
     fromPartial(object: DeepPartial_73<AsyncError_2>): AsyncError_2;
 };
 
-declare type AsyncOptions = {
+declare type AsyncOptions<S extends JSONValue> = {
     /**
      * The data loader will re-run if the value of `depends` changes.
      */
     depends?: JSONValue;
+    /**
+     * A callback that will be called after the data is loaded, regardless of whether it succeeds or fails.
+     * This is a good place to run setStates or other side effects, because calling a setState in the main
+     * body is not allowed.
+     *
+     *    useAsync(async () => {
+     *        const response = await fetch(`https://date.api/today?timezone=${timezone}`);
+     *        return response.json();
+     *    }, {
+     *        depends: [timezone],
+     *        finally: (data, error) => {
+     *            if (error) {
+     *                console.error("Failed to load date data:", error);
+     *            } else {
+     *                setTodayDate(data['currentDate']);
+     *            }
+     *        },
+     *    });
+     *
+     */
+    finally?: (data: S | null, error: Error | null) => void;
 };
 
 declare interface AsyncRequest {
@@ -50038,7 +50059,7 @@ declare type UrlString = string;
  * @param initializer -- any async function that returns a JSONValue
  * @returns UseAsyncResult<S>
  */
-export declare function useAsync<S extends JSONValue>(initializer: AsyncUseStateInitializer<S>, options?: AsyncOptions): UseAsyncResult<S>;
+export declare function useAsync<S extends JSONValue>(initializer: AsyncUseStateInitializer<S>, options?: AsyncOptions<S>): UseAsyncResult<S>;
 
 export declare type UseAsyncResult<S> = {
     data: S | null;