@devvit/ui-renderer 0.12.0-next-2025-04-30-5d2b49b36.0 → 0.12.0-next-2025-08-12-20-06-14-50f19bb3e.0

package/types/devvit-global.d.ts

@@ -6,10 +6,10 @@ export type DevvitGlobal = {
     /**
      * Debug modes enabled by the case-insensitive devvitdebug CSV query
      * parameter. The parameter is split on commas and passed to devvit-debug
-     * metadata. Missing values default to `'true'` and a totally empty
-     * devvitdebug query parameter defaults almost everything true. The convention
-     * is to interpret values as truthy. This filed may contain unknown entries
-     * beyond the AppDebug typing to enable development.
+     * metadata. Missing values default to `'true'` and a value of `all` defaults
+     * almost everything true. The convention is to interpret values as truthy.
+     * This filed may contain unknown entries beyond the AppDebug typing to enable
+     * development.
      *
      * See ContextDebugInfo for app side.
      *
@@ -29,6 +29,12 @@ export type DevvitGlobal = {
         [debug in AppDebug]?: string;
     };
 };
+/** Query param on reddit.com and web view URLs for arbitrary data. */
+export declare const queryParamDevvitDebug: string;
+/** Query param on reddit.com for app deep links. */
+export declare const queryParamDevvitShare: string;
+export declare function getDevvitDebug(): string | undefined;
+export declare function getDevvitShareParam(): string | undefined;
 /**
  * The bookmarklet to enable recommended debugging is:
  *

package/types/devvit-global.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"devvit-global.d.ts","sourceRoot":"","sources":["../../library/src/types/devvit-global.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAE/D,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,EAAE;SAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,EAAE,MAAM;KAAE,CAAC;CACzC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAmDvC"}
+{"version":3,"file":"devvit-global.d.ts","sourceRoot":"","sources":["../../library/src/types/devvit-global.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAE/D,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,MAAM,EAAE,YAAY,GAAG,SAAS,CAAC;CACtC;AAED,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,EAAE;SAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,EAAE,MAAM;KAAE,CAAC;CACzC,CAAC;AAEF,sEAAsE;AACtE,eAAO,MAAM,qBAAqB,EAAE,MAAsB,CAAC;AAC3D,oDAAoD;AACpD,eAAO,MAAM,qBAAqB,EAAE,MAAsB,CAAC;AAG3D,wBAAgB,cAAc,IAAI,MAAM,GAAG,SAAS,CAGnD;AAGD,wBAAgB,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAExD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CA6CvC"}

package/types/devvit-global.js

@@ -1,3 +1,16 @@
+/** Query param on reddit.com and web view URLs for arbitrary data. */
+export const queryParamDevvitDebug = 'devvitdebug';
+/** Query param on reddit.com for app deep links. */
+export const queryParamDevvitShare = 'devvitshare';
+// to-do: update web-view-scripts to send the devvit-debug header for web views.
+export function getDevvitDebug() {
+    // `globalThis.location` check allows Node.js usage.
+    return getQueryParam(queryParamDevvitDebug);
+}
+// to-do: separate query parsing and DevvitGlobal.
+export function getDevvitShareParam() {
+    return getQueryParam(queryParamDevvitShare);
+}
 /**
  * The bookmarklet to enable recommended debugging is:
  *
@@ -17,8 +30,6 @@
  */
 export function initDevvitGlobal() {
     var _a, _b, _c;
-    // `globalThis.location` check allows Node.js usage.
-    const url = new URL(globalThis.location ? location.href : 'file://');
     // Initialize defensively to honor any initializations that might occur in a
     // temporary hack elsewhere.
     globalThis.devvit ?? (globalThis.devvit = {});
@@ -43,11 +54,10 @@ export function initDevvitGlobal() {
     const lowerKeyToKey = {};
     for (const key in keyset)
         lowerKeyToKey[key.toLowerCase()] = key;
-    let devvitDebug = [...url.searchParams].find(([name]) => name.toLowerCase() === 'devvitdebug')?.[1];
+    let devvitDebug = getDevvitDebug();
     if (devvitDebug == null)
         return;
-    // empty means enable almost everything.
-    if (devvitDebug === '')
+    if (devvitDebug === 'all')
         devvitDebug = Object.keys(keyset)
             .filter((key) => key !== 'emitSnapshots' && key !== 'emitState')
             .join();
@@ -63,4 +73,9 @@ export function initDevvitGlobal() {
         console.info(`[devvit] set devvitdebug ${key}=${globalThis.devvit.debug[key]}`);
     }
 }
+function getQueryParam(param) {
+    // `globalThis.location` check allows Node.js usage.
+    const url = new URL(globalThis.location ? location.href : 'file://');
+    return [...url.searchParams].find(([name]) => name.toLowerCase() === param)?.[1];
+}
 //# sourceMappingURL=devvit-global.js.map

package/types/devvit-global.js.map

@@ -1 +1 @@
-{"version":3,"file":"devvit-global.js","sourceRoot":"","sources":["../../library/src/types/devvit-global.ts"],"names":[],"mappings":"AAiCA;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,gBAAgB;;IAC9B,oDAAoD;IACpD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAErE,4EAA4E;IAC5E,4BAA4B;IAC5B,UAAU,CAAC,MAAM,KAAjB,UAAU,CAAC,MAAM,GAAK,EAAkB,EAAC;IAEzC,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK;QAAE,OAAO;IAEpC,8CAA8C;IAC9C,MAAA,UAAU,CAAC,MAAM,EAAC,KAAK,QAAL,KAAK,GAAK,EAAqC,EAAC;IAElE,2BAA2B;IAC3B,MAAM,MAAM,GAA8C;QACxD,MAAM,EAAE,SAAS;QACjB,aAAa,EAAE,SAAS;QACxB,SAAS,EAAE,SAAS;QACpB,QAAQ,EAAE,SAAS;QACnB,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE,SAAS;QACnB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,SAAS;KACnB,CAAC;IACF,yCAAyC;IACzC,MAAM,aAAa,GAAgC,EAAE,CAAC;IACtD,KAAK,MAAM,GAAG,IAAI,MAAM;QAAE,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC;IAEjE,IAAI,WAAW,GAAG,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAC1C,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,aAAa,CACjD,EAAE,CAAC,CAAC,CAAC,CAAC;IACP,IAAI,WAAW,IAAI,IAAI;QAAE,OAAO;IAEhC,wCAAwC;IACxC,IAAI,WAAW,KAAK,EAAE;QACpB,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aAC9B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,eAAe,IAAI,GAAG,KAAK,WAAW,CAAC;aAC/D,IAAI,EAAE,CAAC;IAEZ,KAAK,MAAM,EAAE,IAAI,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QAC9C,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,mCAAmC;QACnE,IAAI,CAAC,GAAG;YAAE,SAAS;QAEnB,IAAI,GAAG,CAAC,WAAW,EAAE,IAAI,aAAa;YAAE,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;;YAC1E,OAAO,CAAC,IAAI,CAAC,2CAA2C,GAAG,GAAG,CAAC,CAAC;QAErE,MAAA,UAAU,CAAC,MAAM,CAAC,KAAK,OAAC,GAAe,eAAM,GAAG,IAAI,GAAG,IAAI,EAAE,EAAC;QAC9D,OAAO,CAAC,IAAI,CAAC,4BAA4B,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,GAAe,CAAC,EAAE,CAAC,CAAC;IAC9F,CAAC;AACH,CAAC"}
+{"version":3,"file":"devvit-global.js","sourceRoot":"","sources":["../../library/src/types/devvit-global.ts"],"names":[],"mappings":"AAiCA,sEAAsE;AACtE,MAAM,CAAC,MAAM,qBAAqB,GAAW,aAAa,CAAC;AAC3D,oDAAoD;AACpD,MAAM,CAAC,MAAM,qBAAqB,GAAW,aAAa,CAAC;AAE3D,gFAAgF;AAChF,MAAM,UAAU,cAAc;IAC5B,oDAAoD;IACpD,OAAO,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAC9C,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,mBAAmB;IACjC,OAAO,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,gBAAgB;;IAC9B,4EAA4E;IAC5E,4BAA4B;IAC5B,UAAU,CAAC,MAAM,KAAjB,UAAU,CAAC,MAAM,GAAK,EAAkB,EAAC;IAEzC,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK;QAAE,OAAO;IAEpC,8CAA8C;IAC9C,MAAA,UAAU,CAAC,MAAM,EAAC,KAAK,QAAL,KAAK,GAAK,EAAqC,EAAC;IAElE,2BAA2B;IAC3B,MAAM,MAAM,GAA8C;QACxD,MAAM,EAAE,SAAS;QACjB,aAAa,EAAE,SAAS;QACxB,SAAS,EAAE,SAAS;QACpB,QAAQ,EAAE,SAAS;QACnB,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,SAAS;QAClB,QAAQ,EAAE,SAAS;QACnB,QAAQ,EAAE,SAAS;QACnB,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,SAAS;KACnB,CAAC;IACF,yCAAyC;IACzC,MAAM,aAAa,GAAgC,EAAE,CAAC;IACtD,KAAK,MAAM,GAAG,IAAI,MAAM;QAAE,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,GAAG,CAAC;IAEjE,IAAI,WAAW,GAAG,cAAc,EAAE,CAAC;IACnC,IAAI,WAAW,IAAI,IAAI;QAAE,OAAO;IAEhC,IAAI,WAAW,KAAK,KAAK;QACvB,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;aAC9B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,eAAe,IAAI,GAAG,KAAK,WAAW,CAAC;aAC/D,IAAI,EAAE,CAAC;IAEZ,KAAK,MAAM,EAAE,IAAI,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QAC9C,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,mCAAmC;QACnE,IAAI,CAAC,GAAG;YAAE,SAAS;QAEnB,IAAI,GAAG,CAAC,WAAW,EAAE,IAAI,aAAa;YAAE,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;;YAC1E,OAAO,CAAC,IAAI,CAAC,2CAA2C,GAAG,GAAG,CAAC,CAAC;QAErE,MAAA,UAAU,CAAC,MAAM,CAAC,KAAK,OAAC,GAAe,eAAM,GAAG,IAAI,GAAG,IAAI,EAAE,EAAC;QAC9D,OAAO,CAAC,IAAI,CAAC,4BAA4B,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,GAAe,CAAC,EAAE,CAAC,CAAC;IAC9F,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,oDAAoD;IACpD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACrE,OAAO,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACnF,CAAC"}

package/types/devvit-global.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"devvit-global.test.js","sourceRoot":"","sources":["../../library/src/types/devvit-global.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,UAAU,CAAC,GAAG,EAAE;IACd,UAAU,CAAC,QAAQ,GAAG,EAAc,CAAC;IACrC,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;IACrB,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,8CAA8C;KACzC,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;IACvD,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,yDAAyD;KACpD,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;AAChE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC3B,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,sEAAsE;KACjE,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AAC1F,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE;IACzB,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,2DAA2D;KACtD,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;AACpF,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;IACrB,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,uCAAuC;KAClC,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,qBAAqB,CACzC,EAAE,EACF;;;;;;;;;;;GAWD,CACA,CAAC;AACJ,CAAC,CAAC,CAAC"}
+{"version":3,"file":"devvit-global.test.js","sourceRoot":"","sources":["../../library/src/types/devvit-global.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,UAAU,CAAC,GAAG,EAAE;IACd,UAAU,CAAC,QAAQ,GAAG,EAAc,CAAC;IACrC,UAAU,CAAC,MAAM,GAAG,SAAS,CAAC;AAChC,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;IACrB,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,8CAA8C;KACzC,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAC1D,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;IACvD,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,yDAAyD;KACpD,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;AAChE,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC3B,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,sEAAsE;KACjE,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AAC1F,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE;IACzB,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,2DAA2D;KACtD,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;AACpF,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;IACrB,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,uCAAuC;KAClC,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,qBAAqB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE;IACtB,UAAU,CAAC,QAAQ,GAAG;QACpB,IAAI,EAAE,2CAA2C;KACtC,CAAC;IACd,gBAAgB,EAAE,CAAC;IACnB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,qBAAqB,CACzC,EAAE,EACF;;;;;;;;;;;GAWD,CACA,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/index.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../library/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC"}

package/index.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../library/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC"}