@devvit/public-api 0.11.6 → 0.11.7-next-2025-01-28-9b10510e8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/devvit/internals/blocks/handler/useWebView.d.ts +1 -1
  2. package/devvit/internals/blocks/handler/useWebView.d.ts.map +1 -1
  3. package/meta.json +3 -3
  4. package/meta.min.json +3 -3
  5. package/package.json +6 -6
  6. package/public-api.d.ts +16 -7
  7. package/public-api.iife.js +6 -6
  8. package/public-api.min.js +3 -3
  9. package/public-api.min.js.map +2 -2
  10. package/types/hooks.d.ts +15 -6
  11. package/types/hooks.d.ts.map +1 -1
  12. package/version.json +5 -5
package/types/hooks.d.ts CHANGED
@@ -76,22 +76,31 @@ export type UseChannelResult<Message extends JSONValue = JSONValue> = {
76
76
  /** Current subscription status */
77
77
  status: ChannelStatus;
78
78
  };
79
- export type UseWebViewOnMessage<T extends JSONValue = JSONValue> = (message: T, hook: UseWebViewResult) => void | Promise<void>;
80
- export type UseWebViewOptions<T extends JSONValue = JSONValue> = {
79
+ /**
80
+ * @template From Message from web view to Devvit Blocks app.
81
+ * @template To Message from Devvit Blocks app to web view.
82
+ */
83
+ export type UseWebViewOnMessage<From extends JSONValue = JSONValue, To extends JSONValue = JSONValue> = (message: From, hook: UseWebViewResult<To>) => void | Promise<void>;
84
+ /**
85
+ * @template From Message from web view to Devvit Blocks app.
86
+ * @template To Message from Devvit Blocks app to web view.
87
+ */
88
+ export type UseWebViewOptions<From extends JSONValue = JSONValue, To extends JSONValue = JSONValue> = {
81
89
  /** Relative HTML asset filename like `foo/bar.html`. Defaults to index.html if omitted. */
82
90
  url?: string;
83
91
  /** Handle UI events originating from the web view to be handled by a Devvit app */
84
- onMessage: UseWebViewOnMessage<T>;
92
+ onMessage: UseWebViewOnMessage<From, To>;
85
93
  /**
86
94
  * The callback to run when the web view has been unmounted. Might be used to
87
95
  * set state, stop or resume timers, or perform other tasks now that the web view is no longer visible.
88
96
  * @deprecated use the page visibility API for now.
89
97
  */
90
- onUnmount?: (hook: UseWebViewResult) => void | Promise<void>;
98
+ onUnmount?: (hook: UseWebViewResult<To>) => void | Promise<void>;
91
99
  };
92
- export type UseWebViewResult = {
100
+ /** @template To Message from Devvit Blocks app to web view. */
101
+ export type UseWebViewResult<To extends JSONValue = JSONValue> = {
93
102
  /** Send a message to the web view */
94
- postMessage<T extends JSONValue = JSONValue>(message: T): void;
103
+ postMessage(message: To): void;
95
104
  /** Initiate a request for the web view to open */
96
105
  mount(): void;
97
106
  };
package/types/hooks.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/types/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAE/D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,IAAI,EACJ,SAAS,EACT,cAAc,EACd,YAAY,EACZ,UAAU,EACV,WAAW,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AAC7C,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAC1D,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAEzD,uEAAuE;AACvE,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;AACpD,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC/C,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;AACjF,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AACrE,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;CAAE,CAAC;AAqB/F,2EAA2E;AAC3E,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,IAAI,GAAG,YAAY,GAAG,IAAI,GAAG,YAAY,IAAI,CAC7E,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAC5D,OAAO,CAAC;AAEb,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,IAAI,GAAG,YAAY,GAAG,IAAI,GAAG,YAAY,IAC9E,sBAAsB,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEjF;;;GAGG;AACH,KAAK,sBAAsB,CAAC,CAAC,SAAS,SAAS,SAAS,EAAE,IAAI,CAAC,SAAS,SAAS;IAC/E,MAAM,KAAK,SAAS,SAAS;IAC7B,GAAG,MAAM,IAAI,SAAS,SAAS,EAAE;CAClC,GACG,oBAAoB,CAAC,KAAK,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC,GAE1D;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAE3B,gEAAgE;AAChE,KAAK,oBAAoB,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,SAAS,YAAY,GACnE;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,OAAO;CAAE,GAC7B,CAAC,SAAS,UAAU,GAAG,cAAc,GAAG,WAAW,GACjD,4BAA4B,CAAC,CAAC,EAAE,MAAM,CAAC,GACvC,CAAC,SAAS,WAAW,GACnB,4BAA4B,CAAC,CAAC,EAAE,MAAM,CAAC,GACvC,CAAC,SAAS,WAAW,GACnB;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE;CAAE,GAC9B,CAAC,SAAS,cAAc,GACtB,sBAAsB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GACnC,KAAK,CAAC;AAElB;;;GAGG;AACH,KAAK,4BAA4B,CAC/B,CAAC,SAAS,UAAU,GAAG,cAAc,GAAG,WAAW,GAAG,WAAW,EACjE,CAAC,IACC,CAAC,SAAS;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,YAAY,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,GAC1E;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,GACvB;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;CAAE,CAAC;AAE7B,yGAAyG;AACzG,MAAM,MAAM,iBAAiB,GAAG;IAC9B,yBAAyB;IACzB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,wBAAwB;IACxB,IAAI,EAAE,MAAM,IAAI,CAAC;CAClB,CAAC;AAEF,uIAAuI;AACvI,MAAM,MAAM,eAAe,GAAG;AAC5B,yCAAyC;AACzC,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AACpC,yFAAyF;AACzF,KAAK,EAAE,MAAM,KACV,iBAAiB,CAAC;AAUvB,MAAM,MAAM,cAAc,CAAC,OAAO,SAAS,SAAS,GAAG,SAAS,IAAI,CAClE,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,KAC7B,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAW/B,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,SAAS,GAAG,SAAS,IAAI;IACpE,+BAA+B;IAC/B,SAAS,IAAI,IAAI,CAAC;IAClB,mCAAmC;IACnC,WAAW,IAAI,IAAI,CAAC;IACpB,uCAAuC;IACvC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,kCAAkC;IAClC,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,CACjE,OAAO,EAAE,CAAC,EACV,IAAI,EAAE,gBAAgB,KACnB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAC1B,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;IAC/D,2FAA2F;IAC3F,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mFAAmF;IACnF,SAAS,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,qCAAqC;IACrC,WAAW,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;IAC/D,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;CACf,CAAC"}
1
+ {"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../src/types/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAE/D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,IAAI,EACJ,SAAS,EACT,cAAc,EACd,YAAY,EACZ,UAAU,EACV,WAAW,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AAC7C,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAC1D,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAEzD,uEAAuE;AACvE,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;AACpD,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAC/C,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC;AACjF,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AACrE,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;CAAE,CAAC;AAqB/F,2EAA2E;AAC3E,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,IAAI,GAAG,YAAY,GAAG,IAAI,GAAG,YAAY,IAAI,CAC7E,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAC5D,OAAO,CAAC;AAEb,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,IAAI,GAAG,YAAY,GAAG,IAAI,GAAG,YAAY,IAC9E,sBAAsB,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEjF;;;GAGG;AACH,KAAK,sBAAsB,CAAC,CAAC,SAAS,SAAS,SAAS,EAAE,IAAI,CAAC,SAAS,SAAS;IAC/E,MAAM,KAAK,SAAS,SAAS;IAC7B,GAAG,MAAM,IAAI,SAAS,SAAS,EAAE;CAClC,GACG,oBAAoB,CAAC,KAAK,CAAC,GAAG,sBAAsB,CAAC,IAAI,CAAC,GAE1D;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAE3B,gEAAgE;AAChE,KAAK,oBAAoB,CAAC,CAAC,SAAS,SAAS,IAAI,CAAC,SAAS,YAAY,GACnE;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,OAAO;CAAE,GAC7B,CAAC,SAAS,UAAU,GAAG,cAAc,GAAG,WAAW,GACjD,4BAA4B,CAAC,CAAC,EAAE,MAAM,CAAC,GACvC,CAAC,SAAS,WAAW,GACnB,4BAA4B,CAAC,CAAC,EAAE,MAAM,CAAC,GACvC,CAAC,SAAS,WAAW,GACnB;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE;CAAE,GAC9B,CAAC,SAAS,cAAc,GACtB,sBAAsB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GACnC,KAAK,CAAC;AAElB;;;GAGG;AACH,KAAK,4BAA4B,CAC/B,CAAC,SAAS,UAAU,GAAG,cAAc,GAAG,WAAW,GAAG,WAAW,EACjE,CAAC,IACC,CAAC,SAAS;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,YAAY,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,GAC1E;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;CAAE,GACvB;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;CAAE,CAAC;AAE7B,yGAAyG;AACzG,MAAM,MAAM,iBAAiB,GAAG;IAC9B,yBAAyB;IACzB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,wBAAwB;IACxB,IAAI,EAAE,MAAM,IAAI,CAAC;CAClB,CAAC;AAEF,uIAAuI;AACvI,MAAM,MAAM,eAAe,GAAG;AAC5B,yCAAyC;AACzC,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AACpC,yFAAyF;AACzF,KAAK,EAAE,MAAM,KACV,iBAAiB,CAAC;AAUvB,MAAM,MAAM,cAAc,CAAC,OAAO,SAAS,SAAS,GAAG,SAAS,IAAI,CAClE,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,KAC7B,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAW/B,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,SAAS,GAAG,SAAS,IAAI;IACpE,+BAA+B;IAC/B,SAAS,IAAI,IAAI,CAAC;IAClB,mCAAmC;IACnC,WAAW,IAAI,IAAI,CAAC;IACpB,uCAAuC;IACvC,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,kCAAkC;IAClC,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAC7B,IAAI,SAAS,SAAS,GAAG,SAAS,EAClC,EAAE,SAAS,SAAS,GAAG,SAAS,IAC9B,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,gBAAgB,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAExE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAC3B,IAAI,SAAS,SAAS,GAAG,SAAS,EAClC,EAAE,SAAS,SAAS,GAAG,SAAS,IAC9B;IACF,2FAA2F;IAC3F,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,mFAAmF;IACnF,SAAS,EAAE,mBAAmB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACzC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE,CAAC;AAEF,+DAA+D;AAC/D,MAAM,MAAM,gBAAgB,CAAC,EAAE,SAAS,SAAS,GAAG,SAAS,IAAI;IAC/D,qCAAqC;IACrC,WAAW,CAAC,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC;IAC/B,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;CACf,CAAC"}
package/version.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devvit/public-api",
3
- "version": "0.11.6-dev",
3
+ "version": "0.11.7-dev",
4
4
  "license": "BSD-3-Clause",
5
5
  "repository": {
6
6
  "type": "git",
@@ -38,8 +38,8 @@
38
38
  },
39
39
  "types": "./dist/index.d.ts",
40
40
  "dependencies": {
41
- "@devvit/protos": "0.11.6-dev",
42
- "@devvit/shared-types": "0.11.6-dev",
41
+ "@devvit/protos": "0.11.7-dev",
42
+ "@devvit/shared-types": "0.11.7-dev",
43
43
  "base64-js": "1.5.1",
44
44
  "clone-deep": "4.0.1",
45
45
  "core-js": "3.27.2",
@@ -47,8 +47,8 @@
47
47
  },
48
48
  "devDependencies": {
49
49
  "@ampproject/filesize": "4.3.0",
50
- "@devvit/repo-tools": "0.11.6-dev",
51
- "@devvit/tsconfig": "0.11.6-dev",
50
+ "@devvit/repo-tools": "0.11.7-dev",
51
+ "@devvit/tsconfig": "0.11.7-dev",
52
52
  "@microsoft/api-extractor": "7.41.0",
53
53
  "@reddit/faceplate-ui": "18.0.1",
54
54
  "@types/clone-deep": "4.0.1",