@memberstack/dom 2.0.2-beta.0 → 2.0.2

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 (87) hide show
  1. package/lib/index.d.mts +61 -26
  2. package/lib/index.d.ts +61 -26
  3. package/lib/index.js +793 -53
  4. package/lib/index.mjs +793 -53
  5. package/lib/{models-CTRKogoR.d.ts → models-CFT_ABd5.d.ts} +2 -2
  6. package/lib/testing/index.d.mts +25 -2
  7. package/lib/testing/index.d.ts +25 -2
  8. package/lib/testing/index.js +28 -6
  9. package/lib/testing/index.mjs +26 -5
  10. package/package.json +1 -1
  11. package/lib/auth/index.d.mts +0 -63
  12. package/lib/auth/index.d.ts +0 -63
  13. package/lib/auth/index.global.js +0 -244
  14. package/lib/auth/index.js +0 -161
  15. package/lib/auth/index.mjs +0 -123
  16. package/lib/constants/endpoints.d.mts +0 -5
  17. package/lib/constants/endpoints.d.ts +0 -5
  18. package/lib/constants/endpoints.global.js +0 -29
  19. package/lib/constants/endpoints.js +0 -32
  20. package/lib/constants/endpoints.mjs +0 -7
  21. package/lib/methods/dom/index.d.mts +0 -2
  22. package/lib/methods/dom/index.d.ts +0 -2
  23. package/lib/methods/dom/index.global.js +0 -2
  24. package/lib/methods/dom/index.js +0 -1
  25. package/lib/methods/dom/index.mjs +0 -0
  26. package/lib/methods/dom/main-dom.d.mts +0 -2
  27. package/lib/methods/dom/main-dom.d.ts +0 -2
  28. package/lib/methods/dom/main-dom.global.js +0 -30620
  29. package/lib/methods/dom/main-dom.js +0 -15611
  30. package/lib/methods/dom/main-dom.mjs +0 -15593
  31. package/lib/methods/dom/methods.d.mts +0 -100
  32. package/lib/methods/dom/methods.d.ts +0 -100
  33. package/lib/methods/dom/methods.global.js +0 -30827
  34. package/lib/methods/dom/methods.js +0 -335
  35. package/lib/methods/dom/methods.mjs +0 -302
  36. package/lib/methods/index.d.mts +0 -185
  37. package/lib/methods/index.d.ts +0 -185
  38. package/lib/methods/index.global.js +0 -46361
  39. package/lib/methods/index.js +0 -2530
  40. package/lib/methods/index.mjs +0 -2500
  41. package/lib/methods/requests/index.d.mts +0 -912
  42. package/lib/methods/requests/index.d.ts +0 -912
  43. package/lib/methods/requests/index.global.js +0 -15553
  44. package/lib/methods/requests/index.js +0 -2145
  45. package/lib/methods/requests/index.mjs +0 -2110
  46. package/lib/methods/requests/requests.d.mts +0 -43
  47. package/lib/methods/requests/requests.d.ts +0 -43
  48. package/lib/methods/requests/requests.global.js +0 -14528
  49. package/lib/methods/requests/requests.js +0 -244
  50. package/lib/methods/requests/requests.mjs +0 -210
  51. package/lib/models-BmZS-mc4.d.ts +0 -193
  52. package/lib/models-le7xaT4H.d.ts +0 -193
  53. package/lib/types/index.d.mts +0 -5
  54. package/lib/types/index.d.ts +0 -5
  55. package/lib/types/index.global.js +0 -19
  56. package/lib/types/index.js +0 -18
  57. package/lib/types/index.mjs +0 -0
  58. package/lib/types/params.d.mts +0 -946
  59. package/lib/types/params.d.ts +0 -946
  60. package/lib/types/params.global.js +0 -19
  61. package/lib/types/params.js +0 -18
  62. package/lib/types/params.mjs +0 -0
  63. package/lib/types/payloads.d.mts +0 -342
  64. package/lib/types/payloads.d.ts +0 -342
  65. package/lib/types/payloads.global.js +0 -19
  66. package/lib/types/payloads.js +0 -18
  67. package/lib/types/payloads.mjs +0 -0
  68. package/lib/types/translations.d.mts +0 -101
  69. package/lib/types/translations.d.ts +0 -101
  70. package/lib/types/translations.global.js +0 -19
  71. package/lib/types/translations.js +0 -18
  72. package/lib/types/translations.mjs +0 -0
  73. package/lib/types/utils/payloads.d.mts +0 -297
  74. package/lib/types/utils/payloads.d.ts +0 -297
  75. package/lib/types/utils/payloads.global.js +0 -19
  76. package/lib/types/utils/payloads.js +0 -18
  77. package/lib/types/utils/payloads.mjs +0 -0
  78. package/lib/utils/cookies.d.mts +0 -13
  79. package/lib/utils/cookies.d.ts +0 -13
  80. package/lib/utils/cookies.global.js +0 -261
  81. package/lib/utils/cookies.js +0 -190
  82. package/lib/utils/cookies.mjs +0 -148
  83. package/lib/utils/defaultMessageBox.d.mts +0 -5
  84. package/lib/utils/defaultMessageBox.d.ts +0 -5
  85. package/lib/utils/defaultMessageBox.global.js +0 -125
  86. package/lib/utils/defaultMessageBox.js +0 -130
  87. package/lib/utils/defaultMessageBox.mjs +0 -103
package/lib/index.d.mts CHANGED
@@ -1,6 +1,15 @@
1
- import { P as Payload } from './models-CTRKogoR.js';
2
- export { A as App, d as AuthProvider, f as AuthTokens, B as Branding, j as CheckoutTotal, C as ContentGroup, k as CustomField, E as ExtractData, M as Member, e as MemberAuth, g as MemberCard, n as MemberDisplayInfo, h as MemberInvoice, i as MemberReceipt, m as PaginatedData, a as Plan, c as PlanConnection, l as Post, b as Price, S as SecureContent, T as Thread } from './models-CTRKogoR.js';
1
+ import { P as Payload } from './models-CFT_ABd5.js';
2
+ export { A as App, d as AuthProvider, f as AuthTokens, B as Branding, j as CheckoutTotal, C as ContentGroup, k as CustomField, E as ExtractData, M as Member, e as MemberAuth, g as MemberCard, n as MemberDisplayInfo, h as MemberInvoice, i as MemberReceipt, m as PaginatedData, a as Plan, c as PlanConnection, l as Post, b as Price, S as SecureContent, T as Thread } from './models-CFT_ABd5.js';
3
3
 
4
+ /**
5
+ * Supported OAuth providers for social login.
6
+ * Use lowercase when calling loginWithProvider(), signupWithProvider(),
7
+ * connectProvider(), and disconnectProvider().
8
+ *
9
+ * These providers have pre-configured settings and work with just a client ID/secret.
10
+ * Custom OIDC providers configured in the dashboard are also accepted via the `string` fallback.
11
+ */
12
+ type OAuthProvider = 'google' | 'facebook' | 'microsoft' | 'github' | 'linkedin' | 'spotify' | 'dribbble' | (string & {});
4
13
  /**
5
14
  * Parameters for signing up a new member with email and password.
6
15
  *
@@ -159,17 +168,24 @@ type DeleteThreadParams = {
159
168
  /**
160
169
  * Parameters for updating a member's profile image.
161
170
  *
162
- * @example
171
+ * @example Upload a new image
163
172
  * ```typescript
164
173
  * const fileInput = document.querySelector('input[type="file"]');
165
174
  * await memberstack.updateMemberProfileImage({
166
175
  * profileImage: fileInput.files[0]
167
176
  * });
168
177
  * ```
178
+ *
179
+ * @example Remove the profile image
180
+ * ```typescript
181
+ * await memberstack.updateMemberProfileImage({
182
+ * profileImage: null
183
+ * });
184
+ * ```
169
185
  */
170
186
  type UpdateMemberProfileImageParams = {
171
- /** The image file to upload (accepts standard image formats) */
172
- profileImage: File;
187
+ /** The image file to upload, or null to remove the current profile image */
188
+ profileImage: File | null;
173
189
  };
174
190
  /**
175
191
  * Parameters for retrieving secure/gated content.
@@ -213,8 +229,8 @@ type SetPasswordParams = {
213
229
  * ```
214
230
  */
215
231
  type SignupWithProviderParams = {
216
- /** OAuth provider name ('google', 'facebook', etc.) */
217
- provider: string;
232
+ /** OAuth provider to sign up with */
233
+ provider: OAuthProvider;
218
234
  /** Custom field values to set during signup */
219
235
  customFields?: Record<string, any>;
220
236
  /** Array of plans to assign on signup */
@@ -238,8 +254,8 @@ type SignupWithProviderParams = {
238
254
  * ```
239
255
  */
240
256
  type LoginWithProviderParams = {
241
- /** OAuth provider name ('google', 'facebook', etc.) */
242
- provider: string;
257
+ /** OAuth provider to log in with */
258
+ provider: OAuthProvider;
243
259
  /** If true, creates new account if one doesn't exist (default: false) */
244
260
  allowSignup?: boolean;
245
261
  };
@@ -274,8 +290,8 @@ type SendMemberLoginPasswordlessEmailParams = {
274
290
  type SignupMemberAuthProviderParams = {
275
291
  /** The authorization code from OAuth flow */
276
292
  code: string;
277
- /** The OAuth provider */
278
- provider: "GOOGLE" | "FACEBOOK";
293
+ /** The OAuth provider (uppercase, e.g. 'GOOGLE') */
294
+ provider: string;
279
295
  /** Plan ID to assign (deprecated, use plans array) */
280
296
  planId?: string;
281
297
  /** Custom field values to set during signup */
@@ -411,8 +427,8 @@ type PurchasePlansWithCheckoutParams = {
411
427
  successUrl?: string;
412
428
  /** Auto-redirect to Stripe Checkout (default: true) */
413
429
  autoRedirect?: boolean;
414
- /** Custom metadata to attach to the Stripe checkout session */
415
- metadataForCheckout?: object;
430
+ /** Custom metadata to attach to the Stripe checkout session (Stripe accepts string key-value pairs) */
431
+ metadataForCheckout?: Record<string, string>;
416
432
  };
417
433
  /**
418
434
  * Parameters for launching Stripe Customer Portal.
@@ -428,7 +444,7 @@ type LaunchStripeCustomerPortalParams = {
428
444
  /** Price IDs to show update options for */
429
445
  priceIds?: string[];
430
446
  /** Stripe portal configuration object */
431
- configuration?: object;
447
+ configuration?: Record<string, unknown>;
432
448
  /** URL to return to after leaving the portal */
433
449
  returnUrl?: string;
434
450
  /** Auto-redirect to Stripe portal (default: true) */
@@ -439,7 +455,7 @@ type LaunchStripeCustomerPortalParams = {
439
455
  */
440
456
  type OpenStripeCustomerPortalParams = {
441
457
  /** Stripe portal configuration object */
442
- configuration?: object;
458
+ configuration?: Record<string, unknown>;
443
459
  /** URL to return to after leaving the portal */
444
460
  returnUrl?: string;
445
461
  /** Auto-redirect to Stripe portal (default: true) */
@@ -525,7 +541,7 @@ type GetMemberInvoicesParams = {
525
541
  */
526
542
  type UpdateMemberJSONParams = {
527
543
  /** JSON object to store (completely replaces existing JSON) */
528
- json: object;
544
+ json: Record<string, unknown>;
529
545
  };
530
546
  /**
531
547
  * Parameters for retrieving member purchases with optional expansions.
@@ -634,14 +650,16 @@ type GetTotalCheckoutAmountParams = {
634
650
  type GetDataRecordsParams = {
635
651
  /** The table key/identifier */
636
652
  table: string;
653
+ /** @deprecated Use `table` instead */
654
+ tableKey?: string;
637
655
  /** ISO date string - only return records created after this date */
638
656
  createdAfter?: string;
639
657
  /** ISO date string - only return records created before this date */
640
658
  createdBefore?: string;
641
659
  /** Field name to sort by */
642
660
  sortBy?: string;
643
- /** Sort direction */
644
- sortDirection?: 'ASC' | 'DESC';
661
+ /** Sort direction (case-insensitive) */
662
+ sortDirection?: 'asc' | 'desc' | 'ASC' | 'DESC';
645
663
  /** Maximum number of records to return (1-100) */
646
664
  limit?: number;
647
665
  /** Cursor for pagination (internalOrder value from previous response) */
@@ -754,6 +772,8 @@ type DeleteDataRecordParams = {
754
772
  type GetDataTableParams = {
755
773
  /** The table key/identifier */
756
774
  table: string;
775
+ /** @deprecated Use `table` instead */
776
+ tableKey?: string;
757
777
  };
758
778
  /**
759
779
  * Filter operators for query where clauses.
@@ -942,6 +962,8 @@ type DataRecordsQuery = {
942
962
  type QueryDataRecordsParams = {
943
963
  /** The table key/identifier */
944
964
  table: string;
965
+ /** @deprecated Use `table` instead */
966
+ tableKey?: string;
945
967
  /** Query configuration */
946
968
  query: DataRecordsQuery;
947
969
  };
@@ -989,6 +1011,10 @@ type GetMemberReceiptsPayload = PaginatedResponse<Payload.Transforms["MemberRece
989
1011
  type UpdateMemberProfileImagePayload = Response<{
990
1012
  profileImage: string;
991
1013
  }>;
1014
+ /** Response from deleteMemberProfileImage() - confirms profile image was removed */
1015
+ type DeleteMemberProfileImagePayload = Response<{
1016
+ profileImage: null;
1017
+ }>;
992
1018
  /** Response from getSecureContent() - contains the gated content HTML */
993
1019
  type GetSecureContentPayload = Response<Payload.Transforms["SecureContent"]>;
994
1020
  /** Response from setPassword() - contains updated member data */
@@ -1068,7 +1094,9 @@ type GetAuthenticationClientSecretPayload = Response<Payload.Transforms["Authent
1068
1094
  /** Response from sendMemberVerificationEmail() - success indicator */
1069
1095
  type SendMemberVerificationEmailPayload = Response<Payload.Transforms["SendMemberVerificationEmail"]>;
1070
1096
  /** Response from resetMemberPassword() - success indicator */
1071
- type ResetMemberPassworPayload = Response<Payload.Transforms["ResetMemberPassword"]>;
1097
+ type ResetMemberPasswordPayload = Response<Payload.Transforms["ResetMemberPassword"]>;
1098
+ /** @deprecated Use `ResetMemberPasswordPayload` instead (typo fix) */
1099
+ type ResetMemberPassworPayload = ResetMemberPasswordPayload;
1072
1100
  /** Response from getPosts() - contains posts array */
1073
1101
  type GetPostsPayload = Response<Payload.Transforms["Posts"]>;
1074
1102
  /** Response from getThreads() - contains threads array */
@@ -1293,7 +1321,7 @@ interface MemberstackOptions {
1293
1321
  isWebflow?: boolean;
1294
1322
  }
1295
1323
  interface GetCurrentMemberParams {
1296
- useCache?: Boolean;
1324
+ useCache?: boolean;
1297
1325
  }
1298
1326
  type BearerToken = string;
1299
1327
 
@@ -1810,8 +1838,8 @@ declare const _default: {
1810
1838
  loginRedirect: string;
1811
1839
  stripeCustomerId: string;
1812
1840
  createdAt: string;
1813
- metaData: object;
1814
- customFields: object;
1841
+ metaData: Record<string, unknown>;
1842
+ customFields: Record<string, unknown>;
1815
1843
  permissions: [] | string[];
1816
1844
  planConnections: {
1817
1845
  id: string;
@@ -1843,7 +1871,9 @@ declare const _default: {
1843
1871
  }): Promise<void>;
1844
1872
  getChannelInfo(params: {
1845
1873
  channelKey: string;
1846
- }): Promise<any>;
1874
+ }): Promise<{
1875
+ data: Record<string, unknown>;
1876
+ }>;
1847
1877
  subscribeToChannel(params: {
1848
1878
  channelKey: string;
1849
1879
  action: "NONE" | "THREADS_ONLY";
@@ -1892,10 +1922,13 @@ declare const _default: {
1892
1922
  getTeam(params: GetTeamParams, options?: MemberstackOptions | undefined): Promise<void>;
1893
1923
  removeMemberFromTeam(params: RemoveMemberFromTeamParams, options?: MemberstackOptions | undefined): Promise<void>;
1894
1924
  generateInviteToken(params: GenerateInviteTokenParams, options?: MemberstackOptions | undefined): Promise<void>;
1895
- updateMemberProfileImage(params: UpdateMemberProfileImageParams): Promise<UpdateMemberProfileImagePayload>;
1925
+ updateMemberProfileImage<T extends File | null>(params: {
1926
+ profileImage: T;
1927
+ }): Promise<T extends File ? UpdateMemberProfileImagePayload : DeleteMemberProfileImagePayload>;
1928
+ deleteMemberProfileImage(): Promise<DeleteMemberProfileImagePayload>;
1896
1929
  sendMemberVerificationEmail(): Promise<SendMemberVerificationEmailPayload>;
1897
1930
  sendMemberResetPasswordEmail(params: SendMemberResetPasswordEmailParams): Promise<SendMemberResetPasswordEmailPayload>;
1898
- resetMemberPassword(params: ResetMemberPasswordParams): Promise<ResetMemberPassworPayload>;
1931
+ resetMemberPassword(params: ResetMemberPasswordParams): Promise<ResetMemberPasswordPayload>;
1899
1932
  logout(options?: MemberstackOptions | undefined): Promise<LogoutMemberPayload>;
1900
1933
  getDataTables(options?: MemberstackOptions | undefined): Promise<GetDataTablesPayload>;
1901
1934
  getDataTable(params: GetDataTableParams, options?: MemberstackOptions | undefined): Promise<GetDataTablePayload>;
@@ -1905,7 +1938,9 @@ declare const _default: {
1905
1938
  updateDataRecord(params: UpdateDataRecordParams, options?: MemberstackOptions | undefined): Promise<UpdateDataRecordPayload>;
1906
1939
  deleteDataRecord(params: DeleteDataRecordParams, options?: MemberstackOptions | undefined): Promise<DeleteDataRecordPayload>;
1907
1940
  queryDataRecords(params: QueryDataRecordsParams, options?: MemberstackOptions | undefined): Promise<QueryDataRecordsPayload>;
1941
+ } & {
1942
+ destroy: () => void;
1908
1943
  };
1909
1944
  };
1910
1945
 
1911
- export { type AddMemberCardParams, type AddMemberCardPayload, type AddPlanParams, type AddPlanPayload, type AppPayload, type CancelPlanParams, type CancelPlanPayload, type ConnectProviderPayload, type CountClause, type CreateDataRecordParams, type CreateDataRecordPayload, type CreatePostParams, type CreatePostPayload, type CreateThreadParams, type CreateThreadPayload, type DataRecordsQuery, type DeleteDataRecordParams, type DeleteDataRecordPayload, type DeleteMemberPayload, type DeletePostParams, type DeleteThreadParams, type ErrorCategory, type ErrorCode, ErrorCodes, type GenerateInviteTokenParams, type GetAppAndMemberPayload, type GetAuthProvidersPayload, type GetAuthenticationClientSecretParams, type GetAuthenticationClientSecretPayload, type GetCurrentMemberPayload, type GetDataRecordParams, type GetDataRecordPayload, type GetDataRecordsParams, type GetDataRecordsPayload, type GetDataTableParams, type GetDataTablePayload, type GetDataTablesPayload, type GetMemberCardsPayload, type GetMemberInvoicesParams, type GetMemberInvoicesPayload, type GetMemberJSONPayload, type GetMemberPurchasesParams, type GetMemberReceiptsParams, type GetMemberReceiptsPayload, type GetPlanParams, type GetPlanPayload, type GetPlansParams, type GetPlansPayload, type GetPostsParams, type GetPostsPayload, type GetRestrictedUrlGroupsPayload, type GetSecureContentParams, type GetSecureContentPayload, type GetTeamParams, type GetThreadsParams, type GetThreadsPayload, type GetTotalCheckoutAmountParams, type GetTotalCheckoutAmountPayload, type IncludeClause, type JoinTeamParams, type LaunchStripeCustomerPortalParams, type LaunchStripeCustomerPortalPayload, type LoginMemberEmailPasswordParams, type LoginMemberEmailPasswordPayload, type LoginMemberPasswordlessParams, type LoginWithProviderParams, type LogoutMemberPayload, type MemberReferenceFieldResult, type MemberReferenceOperation, type MemberReferenceSelector, type MemberstackErrorShape, type MemberstackTranslations, type OpenStripeCustomerPortalParams, type OpenStripeCustomerPortalPayload, type OrderByClause, type PostVoteParams, type PurchasePlansParams, type PurchasePlansPayload, type PurchasePlansWithCheckoutParams, type PurchasePlansWithCheckoutPayload, type QueryDataRecordsParams, type QueryDataRecordsPayload, type ReferenceFieldResult, type ReferenceOperation, type ReferenceSelector, type RefreshMemberTokensPayload, type RemoveMemberFromTeamParams, type RemovePlanParams, type RemovePlanPayload, type ReplacePlanParams, type ReplacePlanPayload, type ResetMemberPassworPayload, type ResetMemberPasswordParams, type SelectClause, type SendMemberLoginPasswordlessEmailParams, type SendMemberLoginPasswordlessEmailPayload, type SendMemberResetPasswordEmailParams, type SendMemberResetPasswordEmailPayload, type SendMemberVerificationEmailPayload, type SetPasswordParams, type SetPasswordPayload, type SignupMemberAuthProviderParams, type SignupMemberAuthProviderPayload, type SignupMemberEmailPasswordParams, type SignupMemberEmailPasswordPayload, type SignupWithProviderParams, type ThreadVoteParams, type UpdateDataRecordParams, type UpdateDataRecordPayload, type UpdateDefaultCardParams, type UpdateDefaultCardPayload, type UpdateMemberAuthParams, type UpdateMemberAuthPayload, type UpdateMemberJSONParams, type UpdateMemberParams, type UpdateMemberPayload, type UpdateMemberProfileImageParams, type UpdateMemberProfileImagePayload, type UpdatePlanPaymentParams, type UpdatePlanPaymentPayload, type UpdatePostParams, type UpdatePostPayload, type UpdateThreadParams, type UpdateThreadPayload, type WhereClause, type WhereOperators, _default as default, formatErrorForUser, getErrorCategory, getErrorCode, getErrorDocsUrl, getErrorMessage, getErrorReport, getErrorSuggestions, isErrorCode, isMemberstackError };
1946
+ export { type AddMemberCardParams, type AddMemberCardPayload, type AddPlanParams, type AddPlanPayload, type AppPayload, type CancelPlanParams, type CancelPlanPayload, type ConnectProviderPayload, type CountClause, type CreateDataRecordParams, type CreateDataRecordPayload, type CreatePostParams, type CreatePostPayload, type CreateThreadParams, type CreateThreadPayload, type DataRecordsQuery, type DeleteDataRecordParams, type DeleteDataRecordPayload, type DeleteMemberPayload, type DeleteMemberProfileImagePayload, type DeletePostParams, type DeleteThreadParams, type ErrorCategory, type ErrorCode, ErrorCodes, type GenerateInviteTokenParams, type GetAppAndMemberPayload, type GetAuthProvidersPayload, type GetAuthenticationClientSecretParams, type GetAuthenticationClientSecretPayload, type GetCurrentMemberPayload, type GetDataRecordParams, type GetDataRecordPayload, type GetDataRecordsParams, type GetDataRecordsPayload, type GetDataTableParams, type GetDataTablePayload, type GetDataTablesPayload, type GetMemberCardsPayload, type GetMemberInvoicesParams, type GetMemberInvoicesPayload, type GetMemberJSONPayload, type GetMemberPurchasesParams, type GetMemberReceiptsParams, type GetMemberReceiptsPayload, type GetPlanParams, type GetPlanPayload, type GetPlansParams, type GetPlansPayload, type GetPostsParams, type GetPostsPayload, type GetRestrictedUrlGroupsPayload, type GetSecureContentParams, type GetSecureContentPayload, type GetTeamParams, type GetThreadsParams, type GetThreadsPayload, type GetTotalCheckoutAmountParams, type GetTotalCheckoutAmountPayload, type IncludeClause, type JoinTeamParams, type LaunchStripeCustomerPortalParams, type LaunchStripeCustomerPortalPayload, type LoginMemberEmailPasswordParams, type LoginMemberEmailPasswordPayload, type LoginMemberPasswordlessParams, type LoginWithProviderParams, type LogoutMemberPayload, type MemberReferenceFieldResult, type MemberReferenceOperation, type MemberReferenceSelector, type MemberstackErrorShape, type MemberstackTranslations, type OAuthProvider, type OpenStripeCustomerPortalParams, type OpenStripeCustomerPortalPayload, type OrderByClause, type PostVoteParams, type PurchasePlansParams, type PurchasePlansPayload, type PurchasePlansWithCheckoutParams, type PurchasePlansWithCheckoutPayload, type QueryDataRecordsParams, type QueryDataRecordsPayload, type ReferenceFieldResult, type ReferenceOperation, type ReferenceSelector, type RefreshMemberTokensPayload, type RemoveMemberFromTeamParams, type RemovePlanParams, type RemovePlanPayload, type ReplacePlanParams, type ReplacePlanPayload, type ResetMemberPassworPayload, type ResetMemberPasswordParams, type ResetMemberPasswordPayload, type SelectClause, type SendMemberLoginPasswordlessEmailParams, type SendMemberLoginPasswordlessEmailPayload, type SendMemberResetPasswordEmailParams, type SendMemberResetPasswordEmailPayload, type SendMemberVerificationEmailPayload, type SetPasswordParams, type SetPasswordPayload, type SignupMemberAuthProviderParams, type SignupMemberAuthProviderPayload, type SignupMemberEmailPasswordParams, type SignupMemberEmailPasswordPayload, type SignupWithProviderParams, type ThreadVoteParams, type UpdateDataRecordParams, type UpdateDataRecordPayload, type UpdateDefaultCardParams, type UpdateDefaultCardPayload, type UpdateMemberAuthParams, type UpdateMemberAuthPayload, type UpdateMemberJSONParams, type UpdateMemberParams, type UpdateMemberPayload, type UpdateMemberProfileImageParams, type UpdateMemberProfileImagePayload, type UpdatePlanPaymentParams, type UpdatePlanPaymentPayload, type UpdatePostParams, type UpdatePostPayload, type UpdateThreadParams, type UpdateThreadPayload, type WhereClause, type WhereOperators, _default as default, formatErrorForUser, getErrorCategory, getErrorCode, getErrorDocsUrl, getErrorMessage, getErrorReport, getErrorSuggestions, isErrorCode, isMemberstackError };
package/lib/index.d.ts CHANGED
@@ -1,6 +1,15 @@
1
- import { P as Payload } from './models-CTRKogoR.js';
2
- export { A as App, d as AuthProvider, f as AuthTokens, B as Branding, j as CheckoutTotal, C as ContentGroup, k as CustomField, E as ExtractData, M as Member, e as MemberAuth, g as MemberCard, n as MemberDisplayInfo, h as MemberInvoice, i as MemberReceipt, m as PaginatedData, a as Plan, c as PlanConnection, l as Post, b as Price, S as SecureContent, T as Thread } from './models-CTRKogoR.js';
1
+ import { P as Payload } from './models-CFT_ABd5.js';
2
+ export { A as App, d as AuthProvider, f as AuthTokens, B as Branding, j as CheckoutTotal, C as ContentGroup, k as CustomField, E as ExtractData, M as Member, e as MemberAuth, g as MemberCard, n as MemberDisplayInfo, h as MemberInvoice, i as MemberReceipt, m as PaginatedData, a as Plan, c as PlanConnection, l as Post, b as Price, S as SecureContent, T as Thread } from './models-CFT_ABd5.js';
3
3
 
4
+ /**
5
+ * Supported OAuth providers for social login.
6
+ * Use lowercase when calling loginWithProvider(), signupWithProvider(),
7
+ * connectProvider(), and disconnectProvider().
8
+ *
9
+ * These providers have pre-configured settings and work with just a client ID/secret.
10
+ * Custom OIDC providers configured in the dashboard are also accepted via the `string` fallback.
11
+ */
12
+ type OAuthProvider = 'google' | 'facebook' | 'microsoft' | 'github' | 'linkedin' | 'spotify' | 'dribbble' | (string & {});
4
13
  /**
5
14
  * Parameters for signing up a new member with email and password.
6
15
  *
@@ -159,17 +168,24 @@ type DeleteThreadParams = {
159
168
  /**
160
169
  * Parameters for updating a member's profile image.
161
170
  *
162
- * @example
171
+ * @example Upload a new image
163
172
  * ```typescript
164
173
  * const fileInput = document.querySelector('input[type="file"]');
165
174
  * await memberstack.updateMemberProfileImage({
166
175
  * profileImage: fileInput.files[0]
167
176
  * });
168
177
  * ```
178
+ *
179
+ * @example Remove the profile image
180
+ * ```typescript
181
+ * await memberstack.updateMemberProfileImage({
182
+ * profileImage: null
183
+ * });
184
+ * ```
169
185
  */
170
186
  type UpdateMemberProfileImageParams = {
171
- /** The image file to upload (accepts standard image formats) */
172
- profileImage: File;
187
+ /** The image file to upload, or null to remove the current profile image */
188
+ profileImage: File | null;
173
189
  };
174
190
  /**
175
191
  * Parameters for retrieving secure/gated content.
@@ -213,8 +229,8 @@ type SetPasswordParams = {
213
229
  * ```
214
230
  */
215
231
  type SignupWithProviderParams = {
216
- /** OAuth provider name ('google', 'facebook', etc.) */
217
- provider: string;
232
+ /** OAuth provider to sign up with */
233
+ provider: OAuthProvider;
218
234
  /** Custom field values to set during signup */
219
235
  customFields?: Record<string, any>;
220
236
  /** Array of plans to assign on signup */
@@ -238,8 +254,8 @@ type SignupWithProviderParams = {
238
254
  * ```
239
255
  */
240
256
  type LoginWithProviderParams = {
241
- /** OAuth provider name ('google', 'facebook', etc.) */
242
- provider: string;
257
+ /** OAuth provider to log in with */
258
+ provider: OAuthProvider;
243
259
  /** If true, creates new account if one doesn't exist (default: false) */
244
260
  allowSignup?: boolean;
245
261
  };
@@ -274,8 +290,8 @@ type SendMemberLoginPasswordlessEmailParams = {
274
290
  type SignupMemberAuthProviderParams = {
275
291
  /** The authorization code from OAuth flow */
276
292
  code: string;
277
- /** The OAuth provider */
278
- provider: "GOOGLE" | "FACEBOOK";
293
+ /** The OAuth provider (uppercase, e.g. 'GOOGLE') */
294
+ provider: string;
279
295
  /** Plan ID to assign (deprecated, use plans array) */
280
296
  planId?: string;
281
297
  /** Custom field values to set during signup */
@@ -411,8 +427,8 @@ type PurchasePlansWithCheckoutParams = {
411
427
  successUrl?: string;
412
428
  /** Auto-redirect to Stripe Checkout (default: true) */
413
429
  autoRedirect?: boolean;
414
- /** Custom metadata to attach to the Stripe checkout session */
415
- metadataForCheckout?: object;
430
+ /** Custom metadata to attach to the Stripe checkout session (Stripe accepts string key-value pairs) */
431
+ metadataForCheckout?: Record<string, string>;
416
432
  };
417
433
  /**
418
434
  * Parameters for launching Stripe Customer Portal.
@@ -428,7 +444,7 @@ type LaunchStripeCustomerPortalParams = {
428
444
  /** Price IDs to show update options for */
429
445
  priceIds?: string[];
430
446
  /** Stripe portal configuration object */
431
- configuration?: object;
447
+ configuration?: Record<string, unknown>;
432
448
  /** URL to return to after leaving the portal */
433
449
  returnUrl?: string;
434
450
  /** Auto-redirect to Stripe portal (default: true) */
@@ -439,7 +455,7 @@ type LaunchStripeCustomerPortalParams = {
439
455
  */
440
456
  type OpenStripeCustomerPortalParams = {
441
457
  /** Stripe portal configuration object */
442
- configuration?: object;
458
+ configuration?: Record<string, unknown>;
443
459
  /** URL to return to after leaving the portal */
444
460
  returnUrl?: string;
445
461
  /** Auto-redirect to Stripe portal (default: true) */
@@ -525,7 +541,7 @@ type GetMemberInvoicesParams = {
525
541
  */
526
542
  type UpdateMemberJSONParams = {
527
543
  /** JSON object to store (completely replaces existing JSON) */
528
- json: object;
544
+ json: Record<string, unknown>;
529
545
  };
530
546
  /**
531
547
  * Parameters for retrieving member purchases with optional expansions.
@@ -634,14 +650,16 @@ type GetTotalCheckoutAmountParams = {
634
650
  type GetDataRecordsParams = {
635
651
  /** The table key/identifier */
636
652
  table: string;
653
+ /** @deprecated Use `table` instead */
654
+ tableKey?: string;
637
655
  /** ISO date string - only return records created after this date */
638
656
  createdAfter?: string;
639
657
  /** ISO date string - only return records created before this date */
640
658
  createdBefore?: string;
641
659
  /** Field name to sort by */
642
660
  sortBy?: string;
643
- /** Sort direction */
644
- sortDirection?: 'ASC' | 'DESC';
661
+ /** Sort direction (case-insensitive) */
662
+ sortDirection?: 'asc' | 'desc' | 'ASC' | 'DESC';
645
663
  /** Maximum number of records to return (1-100) */
646
664
  limit?: number;
647
665
  /** Cursor for pagination (internalOrder value from previous response) */
@@ -754,6 +772,8 @@ type DeleteDataRecordParams = {
754
772
  type GetDataTableParams = {
755
773
  /** The table key/identifier */
756
774
  table: string;
775
+ /** @deprecated Use `table` instead */
776
+ tableKey?: string;
757
777
  };
758
778
  /**
759
779
  * Filter operators for query where clauses.
@@ -942,6 +962,8 @@ type DataRecordsQuery = {
942
962
  type QueryDataRecordsParams = {
943
963
  /** The table key/identifier */
944
964
  table: string;
965
+ /** @deprecated Use `table` instead */
966
+ tableKey?: string;
945
967
  /** Query configuration */
946
968
  query: DataRecordsQuery;
947
969
  };
@@ -989,6 +1011,10 @@ type GetMemberReceiptsPayload = PaginatedResponse<Payload.Transforms["MemberRece
989
1011
  type UpdateMemberProfileImagePayload = Response<{
990
1012
  profileImage: string;
991
1013
  }>;
1014
+ /** Response from deleteMemberProfileImage() - confirms profile image was removed */
1015
+ type DeleteMemberProfileImagePayload = Response<{
1016
+ profileImage: null;
1017
+ }>;
992
1018
  /** Response from getSecureContent() - contains the gated content HTML */
993
1019
  type GetSecureContentPayload = Response<Payload.Transforms["SecureContent"]>;
994
1020
  /** Response from setPassword() - contains updated member data */
@@ -1068,7 +1094,9 @@ type GetAuthenticationClientSecretPayload = Response<Payload.Transforms["Authent
1068
1094
  /** Response from sendMemberVerificationEmail() - success indicator */
1069
1095
  type SendMemberVerificationEmailPayload = Response<Payload.Transforms["SendMemberVerificationEmail"]>;
1070
1096
  /** Response from resetMemberPassword() - success indicator */
1071
- type ResetMemberPassworPayload = Response<Payload.Transforms["ResetMemberPassword"]>;
1097
+ type ResetMemberPasswordPayload = Response<Payload.Transforms["ResetMemberPassword"]>;
1098
+ /** @deprecated Use `ResetMemberPasswordPayload` instead (typo fix) */
1099
+ type ResetMemberPassworPayload = ResetMemberPasswordPayload;
1072
1100
  /** Response from getPosts() - contains posts array */
1073
1101
  type GetPostsPayload = Response<Payload.Transforms["Posts"]>;
1074
1102
  /** Response from getThreads() - contains threads array */
@@ -1293,7 +1321,7 @@ interface MemberstackOptions {
1293
1321
  isWebflow?: boolean;
1294
1322
  }
1295
1323
  interface GetCurrentMemberParams {
1296
- useCache?: Boolean;
1324
+ useCache?: boolean;
1297
1325
  }
1298
1326
  type BearerToken = string;
1299
1327
 
@@ -1810,8 +1838,8 @@ declare const _default: {
1810
1838
  loginRedirect: string;
1811
1839
  stripeCustomerId: string;
1812
1840
  createdAt: string;
1813
- metaData: object;
1814
- customFields: object;
1841
+ metaData: Record<string, unknown>;
1842
+ customFields: Record<string, unknown>;
1815
1843
  permissions: [] | string[];
1816
1844
  planConnections: {
1817
1845
  id: string;
@@ -1843,7 +1871,9 @@ declare const _default: {
1843
1871
  }): Promise<void>;
1844
1872
  getChannelInfo(params: {
1845
1873
  channelKey: string;
1846
- }): Promise<any>;
1874
+ }): Promise<{
1875
+ data: Record<string, unknown>;
1876
+ }>;
1847
1877
  subscribeToChannel(params: {
1848
1878
  channelKey: string;
1849
1879
  action: "NONE" | "THREADS_ONLY";
@@ -1892,10 +1922,13 @@ declare const _default: {
1892
1922
  getTeam(params: GetTeamParams, options?: MemberstackOptions | undefined): Promise<void>;
1893
1923
  removeMemberFromTeam(params: RemoveMemberFromTeamParams, options?: MemberstackOptions | undefined): Promise<void>;
1894
1924
  generateInviteToken(params: GenerateInviteTokenParams, options?: MemberstackOptions | undefined): Promise<void>;
1895
- updateMemberProfileImage(params: UpdateMemberProfileImageParams): Promise<UpdateMemberProfileImagePayload>;
1925
+ updateMemberProfileImage<T extends File | null>(params: {
1926
+ profileImage: T;
1927
+ }): Promise<T extends File ? UpdateMemberProfileImagePayload : DeleteMemberProfileImagePayload>;
1928
+ deleteMemberProfileImage(): Promise<DeleteMemberProfileImagePayload>;
1896
1929
  sendMemberVerificationEmail(): Promise<SendMemberVerificationEmailPayload>;
1897
1930
  sendMemberResetPasswordEmail(params: SendMemberResetPasswordEmailParams): Promise<SendMemberResetPasswordEmailPayload>;
1898
- resetMemberPassword(params: ResetMemberPasswordParams): Promise<ResetMemberPassworPayload>;
1931
+ resetMemberPassword(params: ResetMemberPasswordParams): Promise<ResetMemberPasswordPayload>;
1899
1932
  logout(options?: MemberstackOptions | undefined): Promise<LogoutMemberPayload>;
1900
1933
  getDataTables(options?: MemberstackOptions | undefined): Promise<GetDataTablesPayload>;
1901
1934
  getDataTable(params: GetDataTableParams, options?: MemberstackOptions | undefined): Promise<GetDataTablePayload>;
@@ -1905,7 +1938,9 @@ declare const _default: {
1905
1938
  updateDataRecord(params: UpdateDataRecordParams, options?: MemberstackOptions | undefined): Promise<UpdateDataRecordPayload>;
1906
1939
  deleteDataRecord(params: DeleteDataRecordParams, options?: MemberstackOptions | undefined): Promise<DeleteDataRecordPayload>;
1907
1940
  queryDataRecords(params: QueryDataRecordsParams, options?: MemberstackOptions | undefined): Promise<QueryDataRecordsPayload>;
1941
+ } & {
1942
+ destroy: () => void;
1908
1943
  };
1909
1944
  };
1910
1945
 
1911
- export { type AddMemberCardParams, type AddMemberCardPayload, type AddPlanParams, type AddPlanPayload, type AppPayload, type CancelPlanParams, type CancelPlanPayload, type ConnectProviderPayload, type CountClause, type CreateDataRecordParams, type CreateDataRecordPayload, type CreatePostParams, type CreatePostPayload, type CreateThreadParams, type CreateThreadPayload, type DataRecordsQuery, type DeleteDataRecordParams, type DeleteDataRecordPayload, type DeleteMemberPayload, type DeletePostParams, type DeleteThreadParams, type ErrorCategory, type ErrorCode, ErrorCodes, type GenerateInviteTokenParams, type GetAppAndMemberPayload, type GetAuthProvidersPayload, type GetAuthenticationClientSecretParams, type GetAuthenticationClientSecretPayload, type GetCurrentMemberPayload, type GetDataRecordParams, type GetDataRecordPayload, type GetDataRecordsParams, type GetDataRecordsPayload, type GetDataTableParams, type GetDataTablePayload, type GetDataTablesPayload, type GetMemberCardsPayload, type GetMemberInvoicesParams, type GetMemberInvoicesPayload, type GetMemberJSONPayload, type GetMemberPurchasesParams, type GetMemberReceiptsParams, type GetMemberReceiptsPayload, type GetPlanParams, type GetPlanPayload, type GetPlansParams, type GetPlansPayload, type GetPostsParams, type GetPostsPayload, type GetRestrictedUrlGroupsPayload, type GetSecureContentParams, type GetSecureContentPayload, type GetTeamParams, type GetThreadsParams, type GetThreadsPayload, type GetTotalCheckoutAmountParams, type GetTotalCheckoutAmountPayload, type IncludeClause, type JoinTeamParams, type LaunchStripeCustomerPortalParams, type LaunchStripeCustomerPortalPayload, type LoginMemberEmailPasswordParams, type LoginMemberEmailPasswordPayload, type LoginMemberPasswordlessParams, type LoginWithProviderParams, type LogoutMemberPayload, type MemberReferenceFieldResult, type MemberReferenceOperation, type MemberReferenceSelector, type MemberstackErrorShape, type MemberstackTranslations, type OpenStripeCustomerPortalParams, type OpenStripeCustomerPortalPayload, type OrderByClause, type PostVoteParams, type PurchasePlansParams, type PurchasePlansPayload, type PurchasePlansWithCheckoutParams, type PurchasePlansWithCheckoutPayload, type QueryDataRecordsParams, type QueryDataRecordsPayload, type ReferenceFieldResult, type ReferenceOperation, type ReferenceSelector, type RefreshMemberTokensPayload, type RemoveMemberFromTeamParams, type RemovePlanParams, type RemovePlanPayload, type ReplacePlanParams, type ReplacePlanPayload, type ResetMemberPassworPayload, type ResetMemberPasswordParams, type SelectClause, type SendMemberLoginPasswordlessEmailParams, type SendMemberLoginPasswordlessEmailPayload, type SendMemberResetPasswordEmailParams, type SendMemberResetPasswordEmailPayload, type SendMemberVerificationEmailPayload, type SetPasswordParams, type SetPasswordPayload, type SignupMemberAuthProviderParams, type SignupMemberAuthProviderPayload, type SignupMemberEmailPasswordParams, type SignupMemberEmailPasswordPayload, type SignupWithProviderParams, type ThreadVoteParams, type UpdateDataRecordParams, type UpdateDataRecordPayload, type UpdateDefaultCardParams, type UpdateDefaultCardPayload, type UpdateMemberAuthParams, type UpdateMemberAuthPayload, type UpdateMemberJSONParams, type UpdateMemberParams, type UpdateMemberPayload, type UpdateMemberProfileImageParams, type UpdateMemberProfileImagePayload, type UpdatePlanPaymentParams, type UpdatePlanPaymentPayload, type UpdatePostParams, type UpdatePostPayload, type UpdateThreadParams, type UpdateThreadPayload, type WhereClause, type WhereOperators, _default as default, formatErrorForUser, getErrorCategory, getErrorCode, getErrorDocsUrl, getErrorMessage, getErrorReport, getErrorSuggestions, isErrorCode, isMemberstackError };
1946
+ export { type AddMemberCardParams, type AddMemberCardPayload, type AddPlanParams, type AddPlanPayload, type AppPayload, type CancelPlanParams, type CancelPlanPayload, type ConnectProviderPayload, type CountClause, type CreateDataRecordParams, type CreateDataRecordPayload, type CreatePostParams, type CreatePostPayload, type CreateThreadParams, type CreateThreadPayload, type DataRecordsQuery, type DeleteDataRecordParams, type DeleteDataRecordPayload, type DeleteMemberPayload, type DeleteMemberProfileImagePayload, type DeletePostParams, type DeleteThreadParams, type ErrorCategory, type ErrorCode, ErrorCodes, type GenerateInviteTokenParams, type GetAppAndMemberPayload, type GetAuthProvidersPayload, type GetAuthenticationClientSecretParams, type GetAuthenticationClientSecretPayload, type GetCurrentMemberPayload, type GetDataRecordParams, type GetDataRecordPayload, type GetDataRecordsParams, type GetDataRecordsPayload, type GetDataTableParams, type GetDataTablePayload, type GetDataTablesPayload, type GetMemberCardsPayload, type GetMemberInvoicesParams, type GetMemberInvoicesPayload, type GetMemberJSONPayload, type GetMemberPurchasesParams, type GetMemberReceiptsParams, type GetMemberReceiptsPayload, type GetPlanParams, type GetPlanPayload, type GetPlansParams, type GetPlansPayload, type GetPostsParams, type GetPostsPayload, type GetRestrictedUrlGroupsPayload, type GetSecureContentParams, type GetSecureContentPayload, type GetTeamParams, type GetThreadsParams, type GetThreadsPayload, type GetTotalCheckoutAmountParams, type GetTotalCheckoutAmountPayload, type IncludeClause, type JoinTeamParams, type LaunchStripeCustomerPortalParams, type LaunchStripeCustomerPortalPayload, type LoginMemberEmailPasswordParams, type LoginMemberEmailPasswordPayload, type LoginMemberPasswordlessParams, type LoginWithProviderParams, type LogoutMemberPayload, type MemberReferenceFieldResult, type MemberReferenceOperation, type MemberReferenceSelector, type MemberstackErrorShape, type MemberstackTranslations, type OAuthProvider, type OpenStripeCustomerPortalParams, type OpenStripeCustomerPortalPayload, type OrderByClause, type PostVoteParams, type PurchasePlansParams, type PurchasePlansPayload, type PurchasePlansWithCheckoutParams, type PurchasePlansWithCheckoutPayload, type QueryDataRecordsParams, type QueryDataRecordsPayload, type ReferenceFieldResult, type ReferenceOperation, type ReferenceSelector, type RefreshMemberTokensPayload, type RemoveMemberFromTeamParams, type RemovePlanParams, type RemovePlanPayload, type ReplacePlanParams, type ReplacePlanPayload, type ResetMemberPassworPayload, type ResetMemberPasswordParams, type ResetMemberPasswordPayload, type SelectClause, type SendMemberLoginPasswordlessEmailParams, type SendMemberLoginPasswordlessEmailPayload, type SendMemberResetPasswordEmailParams, type SendMemberResetPasswordEmailPayload, type SendMemberVerificationEmailPayload, type SetPasswordParams, type SetPasswordPayload, type SignupMemberAuthProviderParams, type SignupMemberAuthProviderPayload, type SignupMemberEmailPasswordParams, type SignupMemberEmailPasswordPayload, type SignupWithProviderParams, type ThreadVoteParams, type UpdateDataRecordParams, type UpdateDataRecordPayload, type UpdateDefaultCardParams, type UpdateDefaultCardPayload, type UpdateMemberAuthParams, type UpdateMemberAuthPayload, type UpdateMemberJSONParams, type UpdateMemberParams, type UpdateMemberPayload, type UpdateMemberProfileImageParams, type UpdateMemberProfileImagePayload, type UpdatePlanPaymentParams, type UpdatePlanPaymentPayload, type UpdatePostParams, type UpdatePostPayload, type UpdateThreadParams, type UpdateThreadPayload, type WhereClause, type WhereOperators, _default as default, formatErrorForUser, getErrorCategory, getErrorCode, getErrorDocsUrl, getErrorMessage, getErrorReport, getErrorSuggestions, isErrorCode, isMemberstackError };