@jamwidgets/react 0.2.2 → 0.4.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.
- package/README.md +1 -1
- package/dist/index.d.ts +13 -13
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
> **Note:** This repo is a read-only mirror. Source lives in a private monorepo.
|
|
4
4
|
> For issues/PRs, please open them here and we'll sync changes back.
|
|
5
5
|
|
|
6
|
-
React hooks for [
|
|
6
|
+
React hooks for [Jamwidgets](https://jamwidgets.com) widgets - comments, reactions, forms, subscriptions, and more.
|
|
7
7
|
|
|
8
8
|
## Installation
|
|
9
9
|
|
package/dist/index.d.ts
CHANGED
|
@@ -29,15 +29,15 @@
|
|
|
29
29
|
* }
|
|
30
30
|
* ```
|
|
31
31
|
*/
|
|
32
|
-
import { type
|
|
33
|
-
export type {
|
|
32
|
+
import { type JamwidgetsConfig, type Comment, type Announcement, type PollWithResults, type FeedbackType, type ControllerStatus } from "@jamwidgets/core";
|
|
33
|
+
export type { JamwidgetsConfig, SubscribeState, FormState, ReactionsState, CommentsState, WaitlistState, ViewCountsState, FeedbackState, PollState, AnnouncementsState, Comment, Announcement, PollWithResults, FeedbackType, ReactionCounts, JamwidgetsPost, SeriphPost, // deprecated alias
|
|
34
34
|
FetchPostsOptions, FetchPostOptions, ControllerStatus, } from "@jamwidgets/core";
|
|
35
|
-
export { fetchPosts, fetchPost, fetchSiteConfig, type SiteConfig, POWERED_BY_URL, POWERED_BY_LABEL, getConfigFromMeta, resolveConfig, DEFAULT_ENDPOINT, API_PATH, } from "@jamwidgets/core";
|
|
36
|
-
type OptionalSiteKey<T extends
|
|
35
|
+
export { fetchPosts, fetchPost, fetchSiteConfig, type SiteConfig, POWERED_BY_URL, POWERED_BY_LABEL, getConfigFromMeta, resolveConfig, DEFAULT_ENDPOINT, API_PATH, trackPageview, initAnalytics, type TrackPageviewOptions, } from "@jamwidgets/core";
|
|
36
|
+
type OptionalSiteKey<T extends JamwidgetsConfig> = Omit<T, "siteKey"> & {
|
|
37
37
|
/** Site key - optional if <meta name="jamwidgets-site-key"> is set */
|
|
38
38
|
siteKey?: string;
|
|
39
39
|
};
|
|
40
|
-
export interface UseSubscribeOptions extends OptionalSiteKey<
|
|
40
|
+
export interface UseSubscribeOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
41
41
|
}
|
|
42
42
|
export interface UseSubscribeReturn {
|
|
43
43
|
status: ControllerStatus;
|
|
@@ -59,7 +59,7 @@ export interface UseSubscribeReturn {
|
|
|
59
59
|
* ```
|
|
60
60
|
*/
|
|
61
61
|
export declare function useSubscribe(options: UseSubscribeOptions): UseSubscribeReturn;
|
|
62
|
-
export interface UseFormOptions extends OptionalSiteKey<
|
|
62
|
+
export interface UseFormOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
63
63
|
/** Form slug/identifier */
|
|
64
64
|
formSlug: string;
|
|
65
65
|
}
|
|
@@ -88,7 +88,7 @@ export interface UseFormReturn {
|
|
|
88
88
|
* ```
|
|
89
89
|
*/
|
|
90
90
|
export declare function useForm(options: UseFormOptions): UseFormReturn;
|
|
91
|
-
export interface UseReactionsOptions extends OptionalSiteKey<
|
|
91
|
+
export interface UseReactionsOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
92
92
|
/** Content identifier (e.g., post slug) */
|
|
93
93
|
contentId: string;
|
|
94
94
|
/** Auto-fetch reactions on mount (default: true) */
|
|
@@ -119,7 +119,7 @@ export interface UseReactionsReturn {
|
|
|
119
119
|
* ```
|
|
120
120
|
*/
|
|
121
121
|
export declare function useReactions(options: UseReactionsOptions): UseReactionsReturn;
|
|
122
|
-
export interface UseCommentsOptions extends OptionalSiteKey<
|
|
122
|
+
export interface UseCommentsOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
123
123
|
/** Content identifier (e.g., post slug) */
|
|
124
124
|
contentId: string;
|
|
125
125
|
/** Auto-fetch comments on mount (default: true) */
|
|
@@ -157,7 +157,7 @@ export interface UseCommentsReturn {
|
|
|
157
157
|
* ```
|
|
158
158
|
*/
|
|
159
159
|
export declare function useComments(options: UseCommentsOptions): UseCommentsReturn;
|
|
160
|
-
export interface UseWaitlistOptions extends OptionalSiteKey<
|
|
160
|
+
export interface UseWaitlistOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
161
161
|
}
|
|
162
162
|
export interface UseWaitlistReturn {
|
|
163
163
|
status: ControllerStatus;
|
|
@@ -184,7 +184,7 @@ export interface UseWaitlistReturn {
|
|
|
184
184
|
* ```
|
|
185
185
|
*/
|
|
186
186
|
export declare function useWaitlist(options: UseWaitlistOptions): UseWaitlistReturn;
|
|
187
|
-
export interface UseViewsOptions extends OptionalSiteKey<
|
|
187
|
+
export interface UseViewsOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
188
188
|
/** Page identifier (e.g., slug or URL path) */
|
|
189
189
|
pageId: string;
|
|
190
190
|
/** Auto-record view on mount (default: true) */
|
|
@@ -212,7 +212,7 @@ export interface UseViewsReturn {
|
|
|
212
212
|
* ```
|
|
213
213
|
*/
|
|
214
214
|
export declare function useViews(options: UseViewsOptions): UseViewsReturn;
|
|
215
|
-
export interface UseFeedbackOptions extends OptionalSiteKey<
|
|
215
|
+
export interface UseFeedbackOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
216
216
|
}
|
|
217
217
|
export interface UseFeedbackReturn {
|
|
218
218
|
status: ControllerStatus;
|
|
@@ -239,7 +239,7 @@ export interface UseFeedbackReturn {
|
|
|
239
239
|
* ```
|
|
240
240
|
*/
|
|
241
241
|
export declare function useFeedback(options: UseFeedbackOptions): UseFeedbackReturn;
|
|
242
|
-
export interface UsePollOptions extends OptionalSiteKey<
|
|
242
|
+
export interface UsePollOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
243
243
|
/** Poll slug */
|
|
244
244
|
slug: string;
|
|
245
245
|
/** Auto-fetch poll on mount (default: true) */
|
|
@@ -276,7 +276,7 @@ export interface UsePollReturn {
|
|
|
276
276
|
* ```
|
|
277
277
|
*/
|
|
278
278
|
export declare function usePoll(options: UsePollOptions): UsePollReturn;
|
|
279
|
-
export interface UseAnnouncementsOptions extends OptionalSiteKey<
|
|
279
|
+
export interface UseAnnouncementsOptions extends OptionalSiteKey<JamwidgetsConfig> {
|
|
280
280
|
/** Auto-fetch announcements on mount (default: true) */
|
|
281
281
|
autoFetch?: boolean;
|
|
282
282
|
}
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAGH,OAAO,EAWL,KAAK,gBAAgB,EAUrB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACtB,MAAM,kBAAkB,CAAC;AAG1B,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,SAAS,EACT,cAAc,EACd,aAAa,EACb,aAAa,EACb,eAAe,EACf,aAAa,EACb,SAAS,EACT,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,cAAc,EACd,cAAc,EACd,UAAU,EAAE,mBAAmB;AAC/B,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACL,UAAU,EACV,SAAS,EACT,eAAe,EACf,KAAK,UAAU,EACf,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,QAAQ,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAGH,OAAO,EAWL,KAAK,gBAAgB,EAUrB,KAAK,OAAO,EACZ,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACtB,MAAM,kBAAkB,CAAC;AAG1B,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,SAAS,EACT,cAAc,EACd,aAAa,EACb,aAAa,EACb,eAAe,EACf,aAAa,EACb,SAAS,EACT,kBAAkB,EAClB,OAAO,EACP,YAAY,EACZ,eAAe,EACf,YAAY,EACZ,cAAc,EACd,cAAc,EACd,UAAU,EAAE,mBAAmB;AAC/B,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACL,UAAU,EACV,SAAS,EACT,eAAe,EACf,KAAK,UAAU,EACf,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,QAAQ,EACR,aAAa,EACb,aAAa,EACb,KAAK,oBAAoB,GAC1B,MAAM,kBAAkB,CAAC;AAM1B,KAAK,eAAe,CAAC,CAAC,SAAS,gBAAgB,IAAI,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG;IACtE,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAMF,MAAM,WAAW,mBAAoB,SAAQ,eAAe,CAAC,gBAAgB,CAAC;CAAG;AAEjF,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,gBAAgB,CAAC;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,kBAAkB,CA0B7E;AAMD,MAAM,WAAW,cAAe,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IACvE,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,gBAAgB,CAAC;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,aAAa,CA0B9D;AAMD,MAAM,WAAW,mBAAoB,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IAC5E,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,kBAAkB,CAqC7E;AAMD,MAAM,WAAW,kBAAmB,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IAC3E,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvH,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,CAgC1E;AAMD,MAAM,WAAW,kBAAmB,SAAQ,eAAe,CAAC,gBAAgB,CAAC;CAAG;AAEhF,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,gBAAgB,CAAC;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACrF,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,CA2B1E;AAMD,MAAM,WAAW,eAAgB,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IACxE,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,cAAc,CAkCjE;AAMD,MAAM,WAAW,kBAAmB,SAAQ,eAAe,CAAC,gBAAgB,CAAC;CAAG;AAEhF,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,gBAAgB,CAAC;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,MAAM,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/G,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,iBAAiB,CA0B1E;AAMD,MAAM,WAAW,cAAe,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IACvE,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,+CAA+C;IAC/C,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,eAAe,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,IAAI,EAAE,CAAC,eAAe,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,aAAa,CAkC9D;AAMD,MAAM,WAAW,uBAAwB,SAAQ,eAAe,CAAC,gBAAgB,CAAC;IAChF,wDAAwD;IACxD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,MAAM,EAAE,gBAAgB,CAAC;IACzB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,sBAAsB,CAoCzF"}
|
package/dist/index.js
CHANGED
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
import { useState, useCallback, useEffect, useRef } from "react";
|
|
33
33
|
import { SubscribeController, FormController, ReactionsController, CommentsController, WaitlistController, ViewCountsController, FeedbackController, PollController, AnnouncementsController, resolveConfig, } from "@jamwidgets/core";
|
|
34
34
|
// Re-export API functions and helpers from core
|
|
35
|
-
export { fetchPosts, fetchPost, fetchSiteConfig, POWERED_BY_URL, POWERED_BY_LABEL, getConfigFromMeta, resolveConfig, DEFAULT_ENDPOINT, API_PATH, } from "@jamwidgets/core";
|
|
35
|
+
export { fetchPosts, fetchPost, fetchSiteConfig, POWERED_BY_URL, POWERED_BY_LABEL, getConfigFromMeta, resolveConfig, DEFAULT_ENDPOINT, API_PATH, trackPageview, initAnalytics, } from "@jamwidgets/core";
|
|
36
36
|
/**
|
|
37
37
|
* Hook for handling email subscriptions.
|
|
38
38
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jamwidgets/react",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "React hooks for Jamwidgets (forms, comments, reactions, subscriptions)",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
],
|
|
39
39
|
"license": "MIT",
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@jamwidgets/core": "^0.
|
|
41
|
+
"@jamwidgets/core": "^0.4.0"
|
|
42
42
|
},
|
|
43
43
|
"peerDependencies": {
|
|
44
44
|
"react": "^18.0.0 || ^19.0.0"
|