@devvit/public-api 0.10.23-next-2024-06-12-b0284ca60.0 → 0.10.23-next-2024-06-12-1b25bb8f2.0

package/public-api.d.ts

@@ -1447,15 +1447,18 @@ declare class AssetsClient {
     /**
      * Gets the public URLs for an asset.
      * @param assetPath A path, relative to the 'assets/' folder.
+     * @param options
      * @returns The public URL for that asset (https://i.redd.it/<id>.<ext>)
      */
     getURL(assetPath: string): string;
+    getURL(assetPath: string, options: GetURLOptions | undefined): string;
     /**
      * Gets the public URLs for multiple assets.
      * @param assetPaths An array of paths, relative to the 'assets/' folder.
      * @returns A map of each asset path to its public URL (https://i.redd.it/<id>.<ext>)
      */
     getURL(assetPaths: string[]): AssetMap;
+    getURL(assetPaths: string[], options: GetURLOptions | undefined): AssetMap;
 }
 
 export declare type AsyncError = {
@@ -2864,6 +2867,9 @@ declare const BootstrapActorDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 } | undefined): LinkedBundle;
                 fromPartial(object: {
                     actor?: {
@@ -2897,6 +2903,9 @@ declare const BootstrapActorDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 }): LinkedBundle;
             };
             readonly requestStream: false;
@@ -3338,6 +3347,9 @@ declare const BuildPackDefinition: {
                         assetIds?: {
                             [x: string]: string | undefined;
                         };
+                        webviewAssetIds?: {
+                            [x: string]: string | undefined;
+                        };
                     } | undefined;
                     errors?: {
                         detail?: {
@@ -3419,6 +3431,9 @@ declare const BuildPackDefinition: {
                         assetIds?: {
                             [x: string]: string | undefined;
                         };
+                        webviewAssetIds?: {
+                            [x: string]: string | undefined;
+                        };
                     } | undefined;
                     errors?: {
                         detail?: {
@@ -3557,6 +3572,9 @@ declare const BuildPackDefinition: {
                         assetIds?: {
                             [x: string]: string | undefined;
                         };
+                        webviewAssetIds?: {
+                            [x: string]: string | undefined;
+                        };
                     } | undefined;
                     errors?: {
                         detail?: {
@@ -3638,6 +3656,9 @@ declare const BuildPackDefinition: {
                         assetIds?: {
                             [x: string]: string | undefined;
                         };
+                        webviewAssetIds?: {
+                            [x: string]: string | undefined;
+                        };
                     } | undefined;
                     errors?: {
                         detail?: {
@@ -3978,6 +3999,14 @@ declare interface Bundle {
     assetIds: {
         [key: string]: string;
     };
+    /**
+     * This map contains html assets from the webroot directory for use in a webview.
+     * It has the same structure as asset_ids but is rooted in the webroot directory
+     * and is isolated from regular assets.
+     */
+    webviewAssetIds: {
+        [key: string]: string;
+    };
 }
 
 declare const Bundle: {
@@ -4005,6 +4034,21 @@ declare const Bundle_AssetIdsEntry: {
     fromPartial(object: DeepPartial_23<Bundle_AssetIdsEntry>): Bundle_AssetIdsEntry;
 };
 
+declare interface Bundle_WebviewAssetIdsEntry {
+    key: string;
+    value: string;
+}
+
+declare const Bundle_WebviewAssetIdsEntry: {
+    $type: "devvit.plugin.buildpack.Bundle.WebviewAssetIdsEntry";
+    encode(message: Bundle_WebviewAssetIdsEntry, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Bundle_WebviewAssetIdsEntry;
+    fromJSON(object: any): Bundle_WebviewAssetIdsEntry;
+    toJSON(message: Bundle_WebviewAssetIdsEntry): unknown;
+    create(base?: DeepPartial_23<Bundle_WebviewAssetIdsEntry>): Bundle_WebviewAssetIdsEntry;
+    fromPartial(object: DeepPartial_23<Bundle_WebviewAssetIdsEntry>): Bundle_WebviewAssetIdsEntry;
+};
+
 /** Fetch a bundle by its hostname */
 declare interface BundleRequest {
     /** Must be legal name for filesystem. Eg, LinkedBundle.hostname. 'main.local' */
@@ -4085,6 +4129,9 @@ declare const BundleServiceDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 } | undefined): LinkedBundle;
                 fromPartial(object: {
                     actor?: {
@@ -4118,6 +4165,9 @@ declare const BundleServiceDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 }): LinkedBundle;
             };
             readonly requestStream: false;
@@ -4184,6 +4234,9 @@ declare const BundleServiceDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 } | undefined): LinkedBundle;
                 fromPartial(object: {
                     actor?: {
@@ -4217,6 +4270,9 @@ declare const BundleServiceDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 }): LinkedBundle;
             };
             readonly responseStream: false;
@@ -5334,6 +5390,7 @@ declare const ComposeRequest: {
 declare type Config = {
     readonly assets: Readonly<AssetMap>;
     readonly providedDefinitions: Readonly<Definition>[];
+    readonly webviewAssets?: Readonly<AssetMap> | undefined;
     export(namespace: Readonly<Namespace>): DependencySpec;
     provides(definition: Readonly<Definition>): void;
     use<T>(definition: Readonly<Definition>, options?: Readonly<DeepPartial_15<PackageQuery>>): T;
@@ -13857,6 +13914,8 @@ declare const GetActionsResponse: {
 declare interface GetAssetURLRequest {
     /** The path to the asset relative to the /assets directory of the project */
     path: string;
+    /** If true, look for a webview asset instead of a standard asset */
+    webview?: boolean | undefined;
 }
 
 declare const GetAssetURLRequest: {
@@ -14674,6 +14733,10 @@ export declare type GetSubredditUsersByTypeOptions = ListingFetchOptions & {
 
 declare type GetSubredditUsersOptions = Omit<GetSubredditUsersByTypeOptions, 'type'>;
 
+declare type GetURLOptions = {
+    webview?: boolean | undefined;
+};
+
 export declare type GetUserFlairBySubredditOptions = UserFlairPageOptions & {
     /** The subreddit associated with the flair being retrieved. */
     subreddit: string;
@@ -17225,6 +17288,13 @@ declare interface LinkedBundle {
     assets: {
         [key: string]: string;
     };
+    /**
+     * This map is used to resolve assets for the webview block. It will only
+     * contain references to the html files in the webroot assets directory.
+     */
+    webviewAssets: {
+        [key: string]: string;
+    };
 }
 
 declare const LinkedBundle: {
@@ -17252,6 +17322,21 @@ declare const LinkedBundle_AssetsEntry: {
     fromPartial(object: DeepPartial_14<LinkedBundle_AssetsEntry>): LinkedBundle_AssetsEntry;
 };
 
+declare interface LinkedBundle_WebviewAssetsEntry {
+    key: string;
+    value: string;
+}
+
+declare const LinkedBundle_WebviewAssetsEntry: {
+    $type: "devvit.runtime.LinkedBundle.WebviewAssetsEntry";
+    encode(message: LinkedBundle_WebviewAssetsEntry, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): LinkedBundle_WebviewAssetsEntry;
+    fromJSON(object: any): LinkedBundle_WebviewAssetsEntry;
+    toJSON(message: LinkedBundle_WebviewAssetsEntry): unknown;
+    create(base?: DeepPartial_14<LinkedBundle_WebviewAssetsEntry>): LinkedBundle_WebviewAssetsEntry;
+    fromPartial(object: DeepPartial_14<LinkedBundle_WebviewAssetsEntry>): LinkedBundle_WebviewAssetsEntry;
+};
+
 /** See also LinkedBundle. */
 declare enum LinkedBundleTargetPlatform {
     /** BROWSER - A LinkedBundle for browser runtimes. */
@@ -17371,6 +17456,9 @@ declare const LinkerDefinition: {
                     assetIds?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssetIds?: {
+                        [x: string]: string | undefined;
+                    };
                 } | undefined): Bundle;
                 fromPartial(object: {
                     code?: string;
@@ -17430,6 +17518,9 @@ declare const LinkerDefinition: {
                     assetIds?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssetIds?: {
+                        [x: string]: string | undefined;
+                    };
                 }): Bundle;
             };
             readonly requestStream: false;
@@ -41356,6 +41447,7 @@ declare namespace protos {
         DependencySpec,
         LinkedBundle,
         LinkedBundle_AssetsEntry,
+        LinkedBundle_WebviewAssetsEntry,
         BuildInfo,
         BuildInfo_DependenciesEntry,
         RemoteLogPublisherClient,
@@ -41660,6 +41752,7 @@ declare namespace protos {
         Minify,
         Bundle,
         Bundle_AssetIdsEntry,
+        Bundle_WebviewAssetIdsEntry,
         CompileParams,
         CompileLog,
         CompileLogLineDetail,
@@ -46830,6 +46923,9 @@ declare const ResolverDefinition: {
                     assetIds?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssetIds?: {
+                        [x: string]: string | undefined;
+                    };
                 } | undefined): Bundle;
                 fromPartial(object: {
                     code?: string;
@@ -46889,6 +46985,9 @@ declare const ResolverDefinition: {
                     assetIds?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssetIds?: {
+                        [x: string]: string | undefined;
+                    };
                 }): Bundle;
             };
             readonly requestStream: false;
@@ -47359,6 +47458,9 @@ declare const RuntimeActorDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 } | undefined): LinkedBundle;
                 fromPartial(object: {
                     actor?: {
@@ -47392,6 +47494,9 @@ declare const RuntimeActorDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 }): LinkedBundle;
             };
             readonly requestStream: false;
@@ -50698,6 +50803,9 @@ declare const SubredditMetadataResolverDefinition: {
                         assets?: {
                             [x: string]: string | undefined;
                         };
+                        webviewAssets?: {
+                            [x: string]: string | undefined;
+                        };
                     }[];
                     contextActions?: {
                         actorHostname?: string;
@@ -50771,6 +50879,9 @@ declare const SubredditMetadataResolverDefinition: {
                         assets?: {
                             [x: string]: string | undefined;
                         };
+                        webviewAssets?: {
+                            [x: string]: string | undefined;
+                        };
                     }[];
                     contextActions?: {
                         actorHostname?: string;
@@ -55698,6 +55809,9 @@ declare const SupervisorDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 } | undefined): LinkedBundle;
                 fromPartial(object: {
                     actor?: {
@@ -55731,6 +55845,9 @@ declare const SupervisorDefinition: {
                     assets?: {
                         [x: string]: string | undefined;
                     };
+                    webviewAssets?: {
+                        [x: string]: string | undefined;
+                    };
                 }): LinkedBundle;
             };
             readonly requestStream: false;