@devvit/public-api 0.11.0-next-2024-08-19-689d51fc5.0 → 0.11.0-next-2024-08-20-4ebb1a01f.0

package/devvit/internals/ui-request-handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ui-request-handler.d.ts","sourceRoot":"","sources":["../../../src/devvit/internals/ui-request-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,QAAQ,EAAoB,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACxF,OAAO,EAAwB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAgB7D,wBAAgB,WAAW,CACzB,SAAS,EAAE,GAAG,CAAC,iBAAiB,GAC/B,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,UAAU,CAAC,CAK7D;AAED,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAK9D"}
+{"version":3,"file":"ui-request-handler.d.ts","sourceRoot":"","sources":["../../../src/devvit/internals/ui-request-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,QAAQ,EAAoB,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACxF,OAAO,EAAwB,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAqB7D,wBAAgB,WAAW,CACzB,SAAS,EAAE,GAAG,CAAC,iBAAiB,GAC/B,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,UAAU,CAAC,CAW7D;AAED,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAK9D"}

package/devvit/internals/ui-request-handler.js

@@ -2,6 +2,7 @@ import { CustomPostDefinition, UIResponse } from '@devvit/protos';
 import { Devvit } from '../Devvit.js';
 import { BlocksHandler } from './blocks/handler/BlocksHandler.js';
 import { extendDevvitPrototype } from './helpers/extendDevvitPrototype.js';
+import { makeUpgradeAppComponent, parseDevvitUserAgent, shouldShowUpgradeAppScreen, } from './upgrade-app-shim.js';
 /**
  * Extend me to add new surfaces to Devvit.
  */
@@ -14,6 +15,11 @@ const UIComponentBindings = [
 ];
 export function makeHandler(component) {
     return async (req, metadata) => {
+        const parsedUserAgent = parseDevvitUserAgent(metadata['devvit-user-agent']?.values?.[0] ?? '');
+        if (parsedUserAgent && shouldShowUpgradeAppScreen(parsedUserAgent)) {
+            const handler = new BlocksHandler(makeUpgradeAppComponent(parsedUserAgent.platform));
+            return UIResponse.fromJSON(await handler.handle(req, metadata));
+        }
         const handler = new BlocksHandler(component);
         return UIResponse.fromJSON(await handler.handle(req, metadata));
     };

package/devvit/internals/upgrade-app-shim.d.ts

@@ -0,0 +1,29 @@
+/** @jsx Devvit.createElement */
+/** @jsxFrag Devvit.Fragment */
+import { Devvit } from '../Devvit.js';
+export type ParsedDevvitUserAgent = {
+    company: 'Reddit';
+    platform: 'iOS';
+    rawVersion: string;
+    versionNumber: number;
+} | {
+    company: 'Reddit';
+    platform: 'Android';
+    rawVersion: string;
+    versionNumber: number;
+} | {
+    company: 'Reddit';
+    platform: 'Shreddit';
+    rawVersion: string;
+} | {
+    company: 'Reddit';
+    platform: 'Play';
+    rawVersion: string;
+};
+export declare const parseDevvitUserAgent: (input: string) => ParsedDevvitUserAgent | undefined;
+export declare const shouldShowUpgradeAppScreen: (parsedDevvitUserAgent: ParsedDevvitUserAgent | undefined) => boolean;
+export declare const UpgradeAppComponent: Devvit.BlockComponent<{
+    platform: ParsedDevvitUserAgent['platform'];
+}>;
+export declare const makeUpgradeAppComponent: (platform: ParsedDevvitUserAgent['platform']) => () => JSX.Element;
+//# sourceMappingURL=upgrade-app-shim.d.ts.map

package/devvit/internals/upgrade-app-shim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade-app-shim.d.ts","sourceRoot":"","sources":["../../../src/devvit/internals/upgrade-app-shim.tsx"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,+BAA+B;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC,MAAM,MAAM,qBAAqB,GAC7B;IACE,OAAO,EAAE,QAAQ,CAAC;IAClB,QAAQ,EAAE,KAAK,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACvB,GACD;IACE,OAAO,EAAE,QAAQ,CAAC;IAClB,QAAQ,EAAE,SAAS,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACvB,GACD;IACE,OAAO,EAAE,QAAQ,CAAC;IAClB,QAAQ,EAAE,UAAU,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACpB,GACD;IACE,OAAO,EAAE,QAAQ,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAON,eAAO,MAAM,oBAAoB,UAAW,MAAM,KAAG,qBAAqB,GAAG,SA8D5E,CAAC;AAEF,eAAO,MAAM,0BAA0B,0BACd,qBAAqB,GAAG,SAAS,KACvD,OAmBF,CAAC;AAkBF,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,cAAc,CAAC;IACtD,QAAQ,EAAE,qBAAqB,CAAC,UAAU,CAAC,CAAC;CAC7C,CA8BA,CAAC;AAKF,eAAO,MAAM,uBAAuB,aAAc,qBAAqB,CAAC,UAAU,CAAC,sBAElF,CAAC"}

package/devvit/internals/upgrade-app-shim.js

@@ -0,0 +1,109 @@
+/** @jsx Devvit.createElement */
+/** @jsxFrag Devvit.Fragment */
+import { Devvit } from '../Devvit.js';
+const getVersionNumberFromRawVersion = (rawVersion) => {
+    const versionNumber = Number(rawVersion.trim().split('.').pop());
+    return isNaN(versionNumber) ? undefined : versionNumber;
+};
+export const parseDevvitUserAgent = (input) => {
+    const [company, platform, rawVersion] = input.trim().split(';');
+    if (!company || !platform || !rawVersion) {
+        console.warn(`Received a malformed devvit-user-agent! Received: '${input}'`);
+        return;
+    }
+    if (company !== 'Reddit') {
+        console.warn(`Received unknown company name in user agent! Received: '${input}'`);
+        return;
+    }
+    if (platform === 'iOS') {
+        const versionNumber = getVersionNumberFromRawVersion(rawVersion);
+        if (versionNumber === undefined) {
+            console.warn(`Could not parse version number from user agent! Received: '${input}'`);
+            return;
+        }
+        return {
+            company: 'Reddit',
+            platform: 'iOS',
+            rawVersion,
+            versionNumber,
+        };
+    }
+    if (platform === 'Android') {
+        const versionNumber = getVersionNumberFromRawVersion(rawVersion);
+        if (versionNumber === undefined) {
+            console.warn(`Could not parse version number from user agent! Received: '${input}'`);
+            return;
+        }
+        return {
+            company: 'Reddit',
+            platform: 'Android',
+            rawVersion,
+            versionNumber,
+        };
+    }
+    if (platform === 'Shreddit') {
+        return {
+            company: 'Reddit',
+            platform: 'Shreddit',
+            rawVersion,
+        };
+    }
+    if (platform === 'Play') {
+        return {
+            company: 'Reddit',
+            platform: 'Play',
+            rawVersion,
+        };
+    }
+    console.warn(`Received unknown platform:`, platform);
+};
+export const shouldShowUpgradeAppScreen = (parsedDevvitUserAgent) => {
+    // If we couldn't parse, default to trying to render the app
+    if (!parsedDevvitUserAgent) {
+        console.warn(`Could not parse devvit-user-agent! Received: '${JSON.stringify(parsedDevvitUserAgent)}'`);
+        return false;
+    }
+    if (parsedDevvitUserAgent.platform === 'Android') {
+        return parsedDevvitUserAgent.versionNumber < 1819908;
+    }
+    if (parsedDevvitUserAgent.platform === 'iOS') {
+        return parsedDevvitUserAgent.versionNumber < 614940;
+    }
+    // Default to trying to render since we couldn't explicitly get the version number
+    return false;
+};
+const getUpgradeLinkForPlatform = (platform) => {
+    switch (platform) {
+        case 'Android':
+            return 'https://play.google.com/store/apps/details?id=com.reddit.frontpage';
+        case 'iOS':
+            return 'https://apps.apple.com/us/app/reddit/id1064216828';
+        case 'Play':
+        case 'Shreddit':
+            break;
+        default:
+            console.error(`No upgrade link for platform: ${platform}`);
+    }
+};
+export const UpgradeAppComponent = ({ platform }, context) => {
+    return (Devvit.createElement("blocks", null,
+        Devvit.createElement("vstack", { alignment: "middle center", height: 100, width: 100 },
+            Devvit.createElement("vstack", { maxWidth: '300px', gap: "large", alignment: "middle center" },
+                Devvit.createElement("vstack", { gap: "medium", alignment: "middle center" },
+                    Devvit.createElement("image", { imageHeight: 100, imageWidth: 100, url: "https://i.redd.it/p1vmc5ulmpib1.png" }),
+                    Devvit.createElement("text", { size: "large", weight: "bold", wrap: true, alignment: "center" }, "Uh oh, the app you're trying to use requires the latest version of Reddit. Please upgrade your app to continue.")),
+                Devvit.createElement("hstack", { alignment: "middle center" },
+                    Devvit.createElement("button", { onPress: () => {
+                            const upgradeLink = getUpgradeLinkForPlatform(platform);
+                            if (upgradeLink) {
+                                context.ui.navigateTo(upgradeLink);
+                            }
+                            else {
+                                console.warn(`No upgrade link found for platform:`, platform);
+                            }
+                        } }, "Upgrade"))))));
+};
+// A builder to make a component so that we don't have to rename `ui-request.handler.ts` to `.tsx`
+// Not that there's really anything wrong with that, but I like the separation of concerns since
+// we also has to set the pragma at the top of files that use Devvit-y stuff
+export const makeUpgradeAppComponent = (platform) => () => (Devvit.createElement(UpgradeAppComponent, { platform: platform }));

package/devvit/internals/upgrade-app-shim.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade-app-shim.test.d.ts","sourceRoot":"","sources":["../../../src/devvit/internals/upgrade-app-shim.test.ts"],"names":[],"mappings":""}

package/meta.json

@@ -12544,8 +12544,19 @@
       ],
       "format": "esm"
     },
+    "src/devvit/internals/upgrade-app-shim.tsx": {
+      "bytes": 5078,
+      "imports": [
+        {
+          "path": "src/devvit/Devvit.ts",
+          "kind": "import-statement",
+          "original": "../Devvit.js"
+        }
+      ],
+      "format": "esm"
+    },
     "src/devvit/internals/ui-request-handler.ts": {
-      "bytes": 1280,
+      "bytes": 1746,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -12566,6 +12577,11 @@
           "path": "src/devvit/internals/helpers/extendDevvitPrototype.ts",
           "kind": "import-statement",
           "original": "./helpers/extendDevvitPrototype.js"
+        },
+        {
+          "path": "src/devvit/internals/upgrade-app-shim.tsx",
+          "kind": "import-statement",
+          "original": "./upgrade-app-shim.js"
         }
       ],
       "format": "esm"
@@ -14448,8 +14464,11 @@
         "src/devvit/internals/blocks/handler/BlocksHandler.ts": {
           "bytesInOutput": 14957
         },
+        "src/devvit/internals/upgrade-app-shim.tsx": {
+          "bytesInOutput": 4017
+        },
         "src/devvit/internals/ui-request-handler.ts": {
-          "bytesInOutput": 645
+          "bytesInOutput": 1000
         },
         "src/devvit/Devvit.ts": {
           "bytesInOutput": 18680
@@ -14530,7 +14549,7 @@
           "bytesInOutput": 370
         }
       },
-      "bytes": 14860165
+      "bytes": 14875397
     }
   }
 }

package/meta.min.json

@@ -3873,8 +3873,19 @@
       ],
       "format": "esm"
     },
+    "src/devvit/internals/upgrade-app-shim.tsx": {
+      "bytes": 5078,
+      "imports": [
+        {
+          "path": "src/devvit/Devvit.ts",
+          "kind": "import-statement",
+          "original": "../Devvit.js"
+        }
+      ],
+      "format": "esm"
+    },
     "src/devvit/internals/ui-request-handler.ts": {
-      "bytes": 1280,
+      "bytes": 1746,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -3895,6 +3906,11 @@
           "path": "src/devvit/internals/helpers/extendDevvitPrototype.ts",
           "kind": "import-statement",
           "original": "./helpers/extendDevvitPrototype.js"
+        },
+        {
+          "path": "src/devvit/internals/upgrade-app-shim.tsx",
+          "kind": "import-statement",
+          "original": "./upgrade-app-shim.js"
         }
       ],
       "format": "esm"
@@ -4738,7 +4754,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1206177
+      "bytes": 1214341
     },
     "dist/public-api.min.js": {
       "imports": [
@@ -5430,7 +5446,7 @@
           "bytesInOutput": 1418
         },
         "src/devvit/internals/ui-request-handler.ts": {
-          "bytesInOutput": 313
+          "bytesInOutput": 445
         },
         "src/devvit/internals/blocks/handler/UIClient.ts": {
           "bytesInOutput": 967
@@ -5474,6 +5490,9 @@
         "src/devvit/internals/blocks/handler/BlocksHandler.ts": {
           "bytesInOutput": 6864
         },
+        "src/devvit/internals/upgrade-app-shim.tsx": {
+          "bytesInOutput": 2170
+        },
         "src/apis/reddit/helpers/makeGettersEnumerable.ts": {
           "bytesInOutput": 166
         },
@@ -5550,7 +5569,7 @@
           "bytesInOutput": 178
         }
       },
-      "bytes": 258242
+      "bytes": 260544
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.11.0-next-2024-08-19-689d51fc5.0",
+  "version": "0.11.0-next-2024-08-20-4ebb1a01f.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,8 +30,8 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.0-next-2024-08-19-689d51fc5.0",
-    "@devvit/shared-types": "0.11.0-next-2024-08-19-689d51fc5.0",
+    "@devvit/protos": "0.11.0-next-2024-08-20-4ebb1a01f.0",
+    "@devvit/shared-types": "0.11.0-next-2024-08-20-4ebb1a01f.0",
     "base64-js": "1.5.1",
     "clone-deep": "4.0.1",
     "core-js": "3.27.2",
@@ -39,9 +39,9 @@
   },
   "devDependencies": {
     "@ampproject/filesize": "4.3.0",
-    "@devvit/eslint-config": "0.11.0-next-2024-08-19-689d51fc5.0",
-    "@devvit/repo-tools": "0.11.0-next-2024-08-19-689d51fc5.0",
-    "@devvit/tsconfig": "0.11.0-next-2024-08-19-689d51fc5.0",
+    "@devvit/eslint-config": "0.11.0-next-2024-08-20-4ebb1a01f.0",
+    "@devvit/repo-tools": "0.11.0-next-2024-08-20-4ebb1a01f.0",
+    "@devvit/tsconfig": "0.11.0-next-2024-08-20-4ebb1a01f.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "16.1.0",
     "@types/clone-deep": "4.0.1",
@@ -64,5 +64,5 @@
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "4e0d11bcefd0c44ce4a4b01a22525ebc4edc51dd"
+  "gitHead": "5fc4461855bfebaafcbfefd06e09d8fb93dd2bb3"
 }