@moonbase.sh/storefront 0.0.0-next-20260526085904

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 (8) hide show
  1. package/README.md +122 -0
  2. package/dist/favicon.ico +0 -0
  3. package/dist/moonbase.d.ts +329 -0
  4. package/dist/moonbase.js +24337 -0
  5. package/dist/moonbase.umd.cjs +36 -0
  6. package/dist-loader/favicon.ico +0 -0
  7. package/dist-loader/moonbase.js +1 -0
  8. package/package.json +54 -0
package/README.md ADDED
@@ -0,0 +1,122 @@
1
+ # @moonbase.sh/storefront
2
+
3
+ Embeddable Moonbase storefront widget for browser apps.
4
+
5
+ This package wraps auth, cart, checkout, voucher redemption, product downloads, activation, and subscription management behind one client-side API.
6
+
7
+ Learn more about our embedded storefront in our official docs: https://moonbase.sh/docs/storefronts/embedded/
8
+
9
+ ## Install
10
+
11
+ ```bash
12
+ pnpm add @moonbase.sh/storefront
13
+ ```
14
+
15
+ ## Quick start
16
+
17
+ ```ts
18
+ import Moonbase, { MoonbaseEvent } from '@moonbase.sh/storefront'
19
+
20
+ Moonbase.setup('https://demo.moonbase.sh', {
21
+ toolbar: {
22
+ enabled: true,
23
+ location: 'top-right',
24
+ },
25
+ })
26
+
27
+ Moonbase.on(MoonbaseEvent.CheckoutCompleted, ({ order }) => {
28
+ console.log('Order completed', order.id)
29
+ })
30
+ ```
31
+
32
+ `setup` should be run once, client-side.
33
+
34
+ When you load the widget via the CDN script tag:
35
+
36
+ ```html
37
+ <script src="https://assets.moonbase.sh/storefront/moonbase.js"></script>
38
+ <script>
39
+ Moonbase.setup('https://demo.moonbase.sh')
40
+ Moonbase.on('checkout-completed', ({ order }) => console.log(order.id))
41
+ </script>
42
+ ```
43
+
44
+ …you can call `Moonbase.setup(...)`, `Moonbase.on(...)`, and any intent method from anywhere on the page — including inline `<script>` in `<head>` — without waiting for `DOMContentLoaded`. The CDN script is a tiny loader that queues calls and replays them once the real bundle and the DOM are both ready.
45
+
46
+ When you import from npm (`import Moonbase from '@moonbase.sh/storefront'`), `setup` still needs the DOM to be available before it runs, since there is no loader in that path.
47
+
48
+ ## Testing pre-release builds with `?mb_version=`
49
+
50
+ The CDN loader recognises an `?mb_version=` query parameter for opting into a non-default storefront build on a per-page-load basis. This is intended for testing pre-release changes on a live merchant site without changing the embed code.
51
+
52
+ - `?mb_version=next` — loads the latest `@next` snapshot from `/storefront/next/moonbase.js`
53
+ - `?mb_version=2.1.0` — pins to a specific published version from `/storefront/<version>/moonbase.js`
54
+ - `?mb_version=latest` or omitted — loads the current stable release (default)
55
+
56
+ Don't use this to pin a production embed to a specific version — pin the `<script src>` URL instead.
57
+
58
+ ## Trigger intents
59
+
60
+ Use intent methods to open specific views or execute actions:
61
+
62
+ ```ts
63
+ Moonbase.sign_in({ email: 'jane@example.com' })
64
+
65
+ Moonbase.add_to_cart({
66
+ product_id: 'my-product',
67
+ quantity: 1,
68
+ })
69
+
70
+ Moonbase.view_cart()
71
+ Moonbase.checkout()
72
+ Moonbase.view_products()
73
+ ```
74
+
75
+ All intents are snake_case methods on the `Moonbase` instance (for example `view_product`, `manage_subscription`, `redeem_voucher`).
76
+
77
+ ## Configure behavior and theme
78
+
79
+ You can pass options in `setup(...)` and update them later with `configure(...)`:
80
+
81
+ ```ts
82
+ Moonbase.configure({
83
+ auth: {
84
+ signUp: {
85
+ enabled: false,
86
+ },
87
+ },
88
+ cart: {
89
+ quantity: 'single',
90
+ },
91
+ theme: {
92
+ colors: {
93
+ primary: '#E5A000',
94
+ background: 'white',
95
+ },
96
+ fonts: {
97
+ heading: 'Aleo',
98
+ body: 'Inter',
99
+ },
100
+ },
101
+ })
102
+ ```
103
+
104
+ You can also control where the widget mounts by providing `target`.
105
+
106
+ ## Events
107
+
108
+ Subscribe to widget lifecycle events with `Moonbase.on(...)`.
109
+
110
+ Available events include:
111
+
112
+ - `signed-in`
113
+ - `signed-up`
114
+ - `signed-out`
115
+ - `storefront-updated`
116
+ - `redeemed-voucher`
117
+ - `downloaded-product`
118
+ - `activated-product`
119
+ - `added-to-cart`
120
+ - `checkout-initiated`
121
+ - `checkout-closed`
122
+ - `checkout-completed`
package/dist/favicon.ico ADDED
Binary file
package/dist/moonbase.d.ts ADDED
@@ -0,0 +1,329 @@
1
+ import { ActivationRequestFulfillmentType } from '@moonbase.sh/vue';
2
+ import { CartItem } from '@moonbase.sh/vue';
3
+ import { Download } from '@moonbase.sh/vue';
4
+ import { InjectionKey } from 'vue';
5
+ import { MarketingConsentType } from '@moonbase.sh/vue';
6
+ import { Money } from '@moonbase.sh/vue';
7
+ import { OpenOrder } from '@moonbase.sh/vue';
8
+ import { Order } from '@moonbase.sh/vue';
9
+ import { OwnedProduct } from '@moonbase.sh/vue';
10
+ import { Storefront } from '@moonbase.sh/vue';
11
+ import { StorefrontProduct } from '@moonbase.sh/vue';
12
+ import { User } from '@moonbase.sh/vue';
13
+ import { Voucher } from '@moonbase.sh/vue';
14
+
15
+ declare type DeepPartial<T> = T extends object ? {
16
+ [P in keyof T]?: T[P] extends HTMLElement | undefined ? T[P] : DeepPartial<T[P]>;
17
+ } : T;
18
+
19
+ export declare const eventEmitterKey: InjectionKey<MoonbaseEventEmitter>;
20
+
21
+ export declare const instanceKey: InjectionKey<MoonbaseInstance>;
22
+
23
+ declare const Moonbase_2: MoonbaseImpl;
24
+ export default Moonbase_2;
25
+
26
+ export declare enum MoonbaseEvent {
27
+ SignedIn = "signed-in",
28
+ SignedUp = "signed-up",
29
+ SignedOut = "signed-out",
30
+ RedeemedVoucher = "redeemed-voucher",
31
+ StorefrontUpdated = "storefront-updated",
32
+ DownloadedProduct = "downloaded-product",
33
+ ActivatedProduct = "activated-product",
34
+ AddedToCart = "added-to-cart",
35
+ CouponRejected = "coupon-rejected",
36
+ CheckoutInitiated = "checkout-initiated",
37
+ CheckoutClosed = "checkout-closed",
38
+ CheckoutCompleted = "checkout-completed"
39
+ }
40
+
41
+ export declare interface MoonbaseEventArgs {
42
+ [MoonbaseEvent.SignedIn]: {
43
+ user: User;
44
+ };
45
+ [MoonbaseEvent.SignedUp]: {
46
+ user: User;
47
+ };
48
+ [MoonbaseEvent.SignedOut]: {
49
+ user: User;
50
+ };
51
+ [MoonbaseEvent.RedeemedVoucher]: {
52
+ voucher: Voucher;
53
+ user: User;
54
+ };
55
+ [MoonbaseEvent.StorefrontUpdated]: {
56
+ storefront: Storefront;
57
+ user?: User | null;
58
+ };
59
+ [MoonbaseEvent.DownloadedProduct]: {
60
+ product: OwnedProduct;
61
+ download: Download;
62
+ user?: User | null;
63
+ };
64
+ [MoonbaseEvent.ActivatedProduct]: {
65
+ product: StorefrontProduct;
66
+ fulfillmentType: ActivationRequestFulfillmentType;
67
+ user?: User | null;
68
+ };
69
+ [MoonbaseEvent.AddedToCart]: {
70
+ item: CartItem;
71
+ currency: string;
72
+ user?: User | null;
73
+ };
74
+ [MoonbaseEvent.CouponRejected]: {
75
+ code: string;
76
+ user?: User | null;
77
+ };
78
+ [MoonbaseEvent.CheckoutInitiated]: {
79
+ order: OpenOrder;
80
+ total: Money;
81
+ user?: User | null;
82
+ };
83
+ [MoonbaseEvent.CheckoutClosed]: {
84
+ order: Order;
85
+ user?: User | null;
86
+ };
87
+ [MoonbaseEvent.CheckoutCompleted]: {
88
+ order: Order;
89
+ user?: User | null;
90
+ };
91
+ }
92
+
93
+ declare type MoonbaseEventEmitter = <TEvent extends MoonbaseEvent>(eventType: TEvent, event: MoonbaseEventArgs[TEvent]) => void;
94
+
95
+ declare class MoonbaseImpl implements MoonbaseInstance {
96
+ private initialized;
97
+ private pinia;
98
+ private storefront;
99
+ private options;
100
+ setup(url: string, options?: DeepPartial<MoonbaseOptions>): Promise<void>;
101
+ configure(options: DeepPartial<MoonbaseOptions>): void;
102
+ on<TEvent extends MoonbaseEvent>(eventType: TEvent, callback: (event: MoonbaseEventArgs[TEvent]) => void): void;
103
+ private handleLocationIntent;
104
+ sign_in(parameters?: MoonbaseIntentArgs['sign_in']): void;
105
+ sign_up(parameters?: MoonbaseIntentArgs['sign_up']): void;
106
+ forgot_password(parameters?: MoonbaseIntentArgs['forgot_password']): void;
107
+ reset_password(parameters?: MoonbaseIntentArgs['reset_password']): void;
108
+ confirm_account(parameters?: MoonbaseIntentArgs['confirm_account']): void;
109
+ confirm_email(parameters?: MoonbaseIntentArgs['confirm_email']): void;
110
+ confirm_email_change(parameters?: MoonbaseIntentArgs['confirm_email_change']): void;
111
+ subscribe(parameters?: MoonbaseIntentArgs['subscribe']): void;
112
+ confirm_communication_preferences(parameters?: MoonbaseIntentArgs['confirm_communication_preferences']): void;
113
+ manage_communication_preferences(parameters?: MoonbaseIntentArgs['manage_communication_preferences']): void;
114
+ connect_account(parameters?: MoonbaseIntentArgs['connect_account']): void;
115
+ view_account(): void;
116
+ view_products(): void;
117
+ view_subscriptions(): void;
118
+ redeem_voucher(parameters?: MoonbaseIntentArgs['redeem_voucher']): void;
119
+ view_product(parameters?: MoonbaseIntentArgs['view_product']): void;
120
+ download_product(parameters?: MoonbaseIntentArgs['download_product']): void;
121
+ activate_product(parameters?: MoonbaseIntentArgs['activate_product']): void;
122
+ manage_subscription(parameters?: MoonbaseIntentArgs['manage_subscription']): void;
123
+ view_cart(): void;
124
+ add_to_cart(parameters?: MoonbaseIntentArgs['add_to_cart']): Promise<void>;
125
+ purchase(parameters?: MoonbaseIntentArgs['purchase']): Promise<void>;
126
+ checkout(parameters?: MoonbaseIntentArgs['checkout']): void;
127
+ close_checkout(): void;
128
+ view_about(): void;
129
+ }
130
+
131
+ export declare type MoonbaseInstance = MoonbaseInstanceIntents & {
132
+ setup: (url: string, options: DeepPartial<MoonbaseOptions>) => Promise<void>;
133
+ configure: (options: DeepPartial<MoonbaseOptions>) => void;
134
+ on: <TEvent extends MoonbaseEvent>(eventType: TEvent, callback: (event: MoonbaseEventArgs[TEvent]) => void) => void;
135
+ };
136
+
137
+ declare type MoonbaseInstanceIntents = {
138
+ [intent in MoonbaseIntent]: (parameters?: MoonbaseIntentArgs[intent]) => void | Promise<void>;
139
+ };
140
+
141
+ export declare enum MoonbaseIntent {
142
+ SignIn = "sign_in",
143
+ SignUp = "sign_up",
144
+ ForgotPassword = "forgot_password",
145
+ ResetPassword = "reset_password",
146
+ ConfirmAccount = "confirm_account",
147
+ ConfirmEmail = "confirm_email",
148
+ ConfirmEmailChange = "confirm_email_change",
149
+ Subscribe = "subscribe",
150
+ ConfirmCommunicationPreferences = "confirm_communication_preferences",
151
+ ManageCommunicationPreferences = "manage_communication_preferences",
152
+ ViewAccount = "view_account",
153
+ ViewProducts = "view_products",
154
+ ViewSubscriptions = "view_subscriptions",
155
+ RedeemVoucher = "redeem_voucher",
156
+ ConnectAccount = "connect_account",
157
+ ViewProduct = "view_product",
158
+ DownloadProduct = "download_product",
159
+ ActivateProduct = "activate_product",
160
+ ManageSubscription = "manage_subscription",
161
+ ViewCart = "view_cart",
162
+ Purchase = "purchase",
163
+ AddToCart = "add_to_cart",
164
+ Checkout = "checkout",
165
+ CloseCheckout = "close_checkout",
166
+ ViewAbout = "view_about"
167
+ }
168
+
169
+ export declare interface MoonbaseIntentArgs {
170
+ [MoonbaseIntent.SignIn]: {
171
+ email?: string;
172
+ };
173
+ [MoonbaseIntent.SignUp]: {
174
+ email?: string;
175
+ };
176
+ [MoonbaseIntent.ForgotPassword]: {
177
+ email?: string;
178
+ };
179
+ [MoonbaseIntent.ResetPassword]: {
180
+ email: string;
181
+ code: string;
182
+ };
183
+ [MoonbaseIntent.ConfirmAccount]: {
184
+ email: string;
185
+ code: string;
186
+ };
187
+ [MoonbaseIntent.ConfirmEmail]: {
188
+ email: string;
189
+ code: string;
190
+ };
191
+ [MoonbaseIntent.ConfirmEmailChange]: {
192
+ email: string;
193
+ code: string;
194
+ };
195
+ [MoonbaseIntent.Subscribe]: {
196
+ email?: string;
197
+ };
198
+ [MoonbaseIntent.ConfirmCommunicationPreferences]: {
199
+ email: string;
200
+ token: string;
201
+ };
202
+ [MoonbaseIntent.ManageCommunicationPreferences]: {
203
+ email: string;
204
+ token: string;
205
+ };
206
+ [MoonbaseIntent.ViewAccount]: never;
207
+ [MoonbaseIntent.ViewProducts]: never;
208
+ [MoonbaseIntent.ViewSubscriptions]: never;
209
+ [MoonbaseIntent.RedeemVoucher]: {
210
+ code?: string;
211
+ };
212
+ [MoonbaseIntent.ConnectAccount]: {
213
+ provider_id: string;
214
+ };
215
+ [MoonbaseIntent.ViewProduct]: {
216
+ product_id: string;
217
+ version?: string;
218
+ };
219
+ [MoonbaseIntent.DownloadProduct]: {
220
+ product_id: string;
221
+ version?: string;
222
+ key?: string;
223
+ };
224
+ [MoonbaseIntent.ActivateProduct]: {
225
+ token?: string;
226
+ };
227
+ [MoonbaseIntent.ManageSubscription]: {
228
+ subscription_id: string;
229
+ };
230
+ [MoonbaseIntent.ViewCart]: never;
231
+ [MoonbaseIntent.AddToCart]: {
232
+ product_id?: string;
233
+ bundle_id?: string;
234
+ variation_id?: string;
235
+ quantity?: number;
236
+ offer_id?: string;
237
+ show_cart?: boolean;
238
+ };
239
+ [MoonbaseIntent.Purchase]: {
240
+ product_id?: string;
241
+ bundle_id?: string;
242
+ variation_id?: string;
243
+ quantity?: number;
244
+ coupon_code?: string;
245
+ } | {
246
+ product_id?: string;
247
+ bundle_id?: string;
248
+ variation_id?: string;
249
+ quantity?: number;
250
+ coupon_code?: string;
251
+ }[];
252
+ [MoonbaseIntent.Checkout]: {
253
+ complete?: boolean;
254
+ };
255
+ [MoonbaseIntent.CloseCheckout]: never;
256
+ [MoonbaseIntent.ViewAbout]: never;
257
+ }
258
+
259
+ declare interface MoonbaseOptions {
260
+ toolbar: {
261
+ enabled: boolean;
262
+ location: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
263
+ show: {
264
+ cart: boolean;
265
+ account: boolean;
266
+ moonbase: boolean;
267
+ };
268
+ };
269
+ auth: {
270
+ signIn: {
271
+ enabled: boolean;
272
+ hint: string | undefined;
273
+ };
274
+ signUp: {
275
+ enabled: boolean;
276
+ marketingConsent: MarketingConsentType;
277
+ };
278
+ passwords: 'default' | 'lax';
279
+ };
280
+ communicationPreferences: {
281
+ show: {
282
+ newsletter: boolean;
283
+ productUpdates: boolean;
284
+ };
285
+ };
286
+ checkout: {
287
+ redirect: boolean;
288
+ };
289
+ cart: {
290
+ quantity: 'selectable' | 'single';
291
+ bundles: {
292
+ onAdd: 'append' | 'replace';
293
+ showProducts: boolean;
294
+ };
295
+ offers: {
296
+ label: string;
297
+ };
298
+ leadMagnets: {
299
+ quantity: 'selectable' | 'single';
300
+ };
301
+ };
302
+ activation: {
303
+ deviceTokenFileExtension: string;
304
+ licenseTokenFileName: string;
305
+ websiteLink: {
306
+ enabled: boolean;
307
+ label: string;
308
+ };
309
+ };
310
+ theme: {
311
+ dark: boolean;
312
+ colors: {
313
+ primary: Record<number, string> | string;
314
+ background: 'white' | 'gray';
315
+ };
316
+ fonts: {
317
+ heading: 'Poppins' | 'PT Serif' | 'Montserrat' | 'Aleo';
318
+ body: 'Inter' | 'Roboto' | 'EB Garamond' | 'Merriweather';
319
+ };
320
+ corners: 'sharp' | 'soft' | 'round';
321
+ buttons: 'outlined' | 'light';
322
+ cards: 'outlined' | 'shadow' | 'white';
323
+ };
324
+ target: HTMLElement | undefined;
325
+ }
326
+
327
+ export declare const urlKey: InjectionKey<string>;
328
+
329
+ export { }