@scayle/storefront-nuxt 8.44.1 → 8.45.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/CHANGELOG.md +85 -0
- package/dist/module.d.mts +11 -2
- package/dist/module.json +1 -1
- package/dist/module.mjs +63 -39
- package/dist/runtime/context.d.ts +3 -2
- package/dist/runtime/context.js +2 -1
- package/dist/runtime/server/middleware/bootstrap-utils.d.ts +5 -4
- package/dist/runtime/server/middleware/bootstrap.js +3 -2
- package/dist/runtime/types/module.d.ts +5 -87
- package/dist/runtime/utils/zodSchema.d.ts +440 -29
- package/dist/runtime/utils/zodSchema.js +69 -18
- package/dist/test/factories.d.mts +20 -3
- package/dist/test/factories.mjs +10 -2
- package/package.json +17 -16
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as z from 'zod/mini';
|
|
2
|
-
import type
|
|
2
|
+
import { type LogLevel, type WithParams } from '@scayle/storefront-core';
|
|
3
3
|
export declare const RedirectsSchema: z.ZodMiniObject<{
|
|
4
4
|
enabled: z.ZodMiniBoolean<boolean>;
|
|
5
5
|
queryParamWhitelist: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
|
|
@@ -10,7 +10,7 @@ export declare const RedirectsSchema: z.ZodMiniObject<{
|
|
|
10
10
|
}, z.core.$strip>;
|
|
11
11
|
declare const SessionSchema: z.ZodMiniObject<{
|
|
12
12
|
/**
|
|
13
|
-
* The sameSite policy to use for the session cookie
|
|
13
|
+
* The `sameSite` policy to use for the session cookie
|
|
14
14
|
*/
|
|
15
15
|
sameSite: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
16
16
|
lax: "lax";
|
|
@@ -18,7 +18,7 @@ declare const SessionSchema: z.ZodMiniObject<{
|
|
|
18
18
|
none: "none";
|
|
19
19
|
}>>;
|
|
20
20
|
/**
|
|
21
|
-
* The default maxAge (in seconds) set on the session cookie and default TTL for session store
|
|
21
|
+
* The default `maxAge` (in seconds) set on the session cookie and default TTL for session store
|
|
22
22
|
*/
|
|
23
23
|
maxAge: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
24
24
|
/**
|
|
@@ -166,7 +166,7 @@ declare const ShopConfigSchema: z.ZodMiniObject<{
|
|
|
166
166
|
isEnabled: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
167
167
|
sessionConfig: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
168
168
|
/**
|
|
169
|
-
* The sameSite policy to use for the session cookie
|
|
169
|
+
* The `sameSite` policy to use for the session cookie
|
|
170
170
|
*/
|
|
171
171
|
sameSite: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
172
172
|
lax: "lax";
|
|
@@ -174,7 +174,7 @@ declare const ShopConfigSchema: z.ZodMiniObject<{
|
|
|
174
174
|
none: "none";
|
|
175
175
|
}>>;
|
|
176
176
|
/**
|
|
177
|
-
* The default maxAge (in seconds) set on the session cookie and default TTL for session store
|
|
177
|
+
* The default `maxAge` (in seconds) set on the session cookie and default TTL for session store
|
|
178
178
|
*/
|
|
179
179
|
maxAge: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
180
180
|
/**
|
|
@@ -195,7 +195,9 @@ declare const ShopConfigSchema: z.ZodMiniObject<{
|
|
|
195
195
|
host: z.ZodMiniURL;
|
|
196
196
|
token: z.ZodMiniString<string>;
|
|
197
197
|
}, z.core.$strip>>;
|
|
198
|
-
/**
|
|
198
|
+
/**
|
|
199
|
+
* @deprecated The `storage` option within `shopConfig` is deprecated. Consider using nuxt storage configuration instead.
|
|
200
|
+
*/
|
|
199
201
|
storage: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
200
202
|
session: z.ZodMiniOptional<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
201
203
|
driver: z.ZodMiniEnum<{
|
|
@@ -364,10 +366,274 @@ declare const ShopSelectorSchema: z.ZodMiniEnum<{
|
|
|
364
366
|
path_or_default: "path_or_default";
|
|
365
367
|
}>;
|
|
366
368
|
type ShopConfigType = z.infer<typeof ShopConfigSchema>;
|
|
367
|
-
declare const
|
|
369
|
+
declare const StorefrontRuntimeConfigSchema: z.ZodMiniObject<{
|
|
370
|
+
/**
|
|
371
|
+
* Determines how the application identifies and switches between different shops.
|
|
372
|
+
* It influences how the `domain` and `path` properties are used within the `shops` configuration.
|
|
373
|
+
*
|
|
374
|
+
* @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#path-and-domain
|
|
375
|
+
*/
|
|
376
|
+
shopSelector: z.ZodMiniEnum<{
|
|
377
|
+
domain: "domain";
|
|
378
|
+
path: "path";
|
|
379
|
+
path_or_default: "path_or_default";
|
|
380
|
+
}>;
|
|
381
|
+
/**
|
|
382
|
+
* Controls how the application handles URL redirects by leveraging the Storefront API,
|
|
383
|
+
* which is synchronized with the SCAYLE Panel. When enabled,
|
|
384
|
+
* the Storefront Core intercepts requests and checks for potential
|
|
385
|
+
* redirects via the Storefront API. If a match is found, a 30x HTTP response
|
|
386
|
+
* is returned with the target in the `Location` header and the appropriate
|
|
387
|
+
* status code.
|
|
388
|
+
*
|
|
389
|
+
* @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/redirects
|
|
390
|
+
*/
|
|
391
|
+
redirects: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
392
|
+
enabled: z.ZodMiniBoolean<boolean>;
|
|
393
|
+
queryParamWhitelist: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
|
|
394
|
+
strategy: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
395
|
+
"before-request": "before-request";
|
|
396
|
+
"on-missing": "on-missing";
|
|
397
|
+
}>>;
|
|
398
|
+
}, z.core.$strip>>;
|
|
399
|
+
/**
|
|
400
|
+
* Configures the available shops in the Storefront Application. Each shop represents a specific region or language,
|
|
401
|
+
* with each shop identified by its unique shop ID from the SCAYLE tenant.
|
|
402
|
+
*
|
|
403
|
+
* @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#shops
|
|
404
|
+
*/
|
|
405
|
+
shops: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniObject<{
|
|
406
|
+
idp: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
407
|
+
enabled: z.ZodMiniBoolean<boolean>;
|
|
408
|
+
idpKeys: z.ZodMiniArray<z.ZodMiniString<string>>;
|
|
409
|
+
idpRedirectURL: z.ZodMiniString<string>;
|
|
410
|
+
}, z.core.$strip>>;
|
|
411
|
+
shopId: z.ZodMiniNumber<number>;
|
|
412
|
+
path: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
|
|
413
|
+
domain: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
414
|
+
locale: z.ZodMiniString<string>;
|
|
415
|
+
auth: z.ZodMiniObject<{
|
|
416
|
+
resetPasswordUrl: z.ZodMiniString<string>;
|
|
417
|
+
}, z.core.$strip>;
|
|
418
|
+
currency: z.ZodMiniString<string>;
|
|
419
|
+
checkout: z.ZodMiniObject<{
|
|
420
|
+
token: z.ZodMiniString<string>;
|
|
421
|
+
secret: z.ZodMiniString<string>;
|
|
422
|
+
host: z.ZodMiniURL;
|
|
423
|
+
user: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniNumber<number>]>;
|
|
424
|
+
cbdExpiration: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
425
|
+
shopId: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
426
|
+
}, z.core.$strip>;
|
|
427
|
+
appKeys: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
428
|
+
wishlistKey: z.ZodMiniString<string>;
|
|
429
|
+
basketKey: z.ZodMiniString<string>;
|
|
430
|
+
hashAlgorithm: z.ZodMiniEnum<{
|
|
431
|
+
none: "none";
|
|
432
|
+
md5: "md5";
|
|
433
|
+
sha256: "sha256";
|
|
434
|
+
}>;
|
|
435
|
+
}, z.core.$strip>>;
|
|
436
|
+
currencyFractionDigits: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
437
|
+
isEnabled: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
438
|
+
sessionConfig: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
439
|
+
/**
|
|
440
|
+
* The `sameSite` policy to use for the session cookie
|
|
441
|
+
*/
|
|
442
|
+
sameSite: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
443
|
+
lax: "lax";
|
|
444
|
+
strict: "strict";
|
|
445
|
+
none: "none";
|
|
446
|
+
}>>;
|
|
447
|
+
/**
|
|
448
|
+
* The default `maxAge` (in seconds) set on the session cookie and default TTL for session store
|
|
449
|
+
*/
|
|
450
|
+
maxAge: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
451
|
+
/**
|
|
452
|
+
* The name used for the session cookie
|
|
453
|
+
*/
|
|
454
|
+
cookieName: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
455
|
+
/**
|
|
456
|
+
* The secret used for signing session cookies. If an array is passed, the last
|
|
457
|
+
* value is used for signing new cookies, but all values are used to verify cookies.
|
|
458
|
+
*/
|
|
459
|
+
secret: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
|
|
460
|
+
/**
|
|
461
|
+
* Controls the domain option on the session cookie
|
|
462
|
+
*/
|
|
463
|
+
domain: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
464
|
+
}, z.core.$strip>>;
|
|
465
|
+
sapi: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
466
|
+
host: z.ZodMiniURL;
|
|
467
|
+
token: z.ZodMiniString<string>;
|
|
468
|
+
}, z.core.$strip>>;
|
|
469
|
+
/**
|
|
470
|
+
* @deprecated The `storage` option within `shopConfig` is deprecated. Consider using nuxt storage configuration instead.
|
|
471
|
+
*/
|
|
472
|
+
storage: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
473
|
+
session: z.ZodMiniOptional<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
474
|
+
driver: z.ZodMiniEnum<{
|
|
475
|
+
null: "null";
|
|
476
|
+
"azure-app-configuration": "azure-app-configuration";
|
|
477
|
+
azureAppConfiguration: "azureAppConfiguration";
|
|
478
|
+
"azure-cosmos": "azure-cosmos";
|
|
479
|
+
azureCosmos: "azureCosmos";
|
|
480
|
+
"azure-key-vault": "azure-key-vault";
|
|
481
|
+
azureKeyVault: "azureKeyVault";
|
|
482
|
+
"azure-storage-blob": "azure-storage-blob";
|
|
483
|
+
azureStorageBlob: "azureStorageBlob";
|
|
484
|
+
"azure-storage-table": "azure-storage-table";
|
|
485
|
+
azureStorageTable: "azureStorageTable";
|
|
486
|
+
"capacitor-preferences": "capacitor-preferences";
|
|
487
|
+
capacitorPreferences: "capacitorPreferences";
|
|
488
|
+
"cloudflare-kv-binding": "cloudflare-kv-binding";
|
|
489
|
+
cloudflareKVBinding: "cloudflareKVBinding";
|
|
490
|
+
"cloudflare-kv-http": "cloudflare-kv-http";
|
|
491
|
+
cloudflareKVHttp: "cloudflareKVHttp";
|
|
492
|
+
"cloudflare-r2-binding": "cloudflare-r2-binding";
|
|
493
|
+
cloudflareR2Binding: "cloudflareR2Binding";
|
|
494
|
+
db0: "db0";
|
|
495
|
+
"deno-kv-node": "deno-kv-node";
|
|
496
|
+
denoKVNode: "denoKVNode";
|
|
497
|
+
"deno-kv": "deno-kv";
|
|
498
|
+
denoKV: "denoKV";
|
|
499
|
+
"fs-lite": "fs-lite";
|
|
500
|
+
fsLite: "fsLite";
|
|
501
|
+
fs: "fs";
|
|
502
|
+
github: "github";
|
|
503
|
+
http: "http";
|
|
504
|
+
indexedb: "indexedb";
|
|
505
|
+
localstorage: "localstorage";
|
|
506
|
+
"lru-cache": "lru-cache";
|
|
507
|
+
lruCache: "lruCache";
|
|
508
|
+
memory: "memory";
|
|
509
|
+
mongodb: "mongodb";
|
|
510
|
+
"netlify-blobs": "netlify-blobs";
|
|
511
|
+
netlifyBlobs: "netlifyBlobs";
|
|
512
|
+
overlay: "overlay";
|
|
513
|
+
planetscale: "planetscale";
|
|
514
|
+
redis: "redis";
|
|
515
|
+
s3: "s3";
|
|
516
|
+
"session-storage": "session-storage";
|
|
517
|
+
sessionStorage: "sessionStorage";
|
|
518
|
+
uploadthing: "uploadthing";
|
|
519
|
+
upstash: "upstash";
|
|
520
|
+
"vercel-blob": "vercel-blob";
|
|
521
|
+
vercelBlob: "vercelBlob";
|
|
522
|
+
"vercel-kv": "vercel-kv";
|
|
523
|
+
vercelKV: "vercelKV";
|
|
524
|
+
"vercel-runtime-cache": "vercel-runtime-cache";
|
|
525
|
+
vercelRuntimeCache: "vercelRuntimeCache";
|
|
526
|
+
}>;
|
|
527
|
+
compression: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
528
|
+
none: "none";
|
|
529
|
+
deflate: "deflate";
|
|
530
|
+
gzip: "gzip";
|
|
531
|
+
brotli: "brotli";
|
|
532
|
+
}>>;
|
|
533
|
+
url: z.ZodMiniOptional<z.ZodMiniURL>;
|
|
534
|
+
token: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
535
|
+
host: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
536
|
+
port: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
537
|
+
username: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
538
|
+
password: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
539
|
+
tls: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
540
|
+
ttl: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
541
|
+
}, z.core.$strip>, z.ZodMiniObject<{
|
|
542
|
+
driver: z.ZodMiniLiteral<"scayleKv">;
|
|
543
|
+
compression: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
544
|
+
none: "none";
|
|
545
|
+
deflate: "deflate";
|
|
546
|
+
gzip: "gzip";
|
|
547
|
+
brotli: "brotli";
|
|
548
|
+
}>>;
|
|
549
|
+
ttl: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
550
|
+
disableClusterMode: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
551
|
+
}, z.core.$strip>], "driver">>;
|
|
552
|
+
cache: z.ZodMiniOptional<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
553
|
+
driver: z.ZodMiniEnum<{
|
|
554
|
+
null: "null";
|
|
555
|
+
"azure-app-configuration": "azure-app-configuration";
|
|
556
|
+
azureAppConfiguration: "azureAppConfiguration";
|
|
557
|
+
"azure-cosmos": "azure-cosmos";
|
|
558
|
+
azureCosmos: "azureCosmos";
|
|
559
|
+
"azure-key-vault": "azure-key-vault";
|
|
560
|
+
azureKeyVault: "azureKeyVault";
|
|
561
|
+
"azure-storage-blob": "azure-storage-blob";
|
|
562
|
+
azureStorageBlob: "azureStorageBlob";
|
|
563
|
+
"azure-storage-table": "azure-storage-table";
|
|
564
|
+
azureStorageTable: "azureStorageTable";
|
|
565
|
+
"capacitor-preferences": "capacitor-preferences";
|
|
566
|
+
capacitorPreferences: "capacitorPreferences";
|
|
567
|
+
"cloudflare-kv-binding": "cloudflare-kv-binding";
|
|
568
|
+
cloudflareKVBinding: "cloudflareKVBinding";
|
|
569
|
+
"cloudflare-kv-http": "cloudflare-kv-http";
|
|
570
|
+
cloudflareKVHttp: "cloudflareKVHttp";
|
|
571
|
+
"cloudflare-r2-binding": "cloudflare-r2-binding";
|
|
572
|
+
cloudflareR2Binding: "cloudflareR2Binding";
|
|
573
|
+
db0: "db0";
|
|
574
|
+
"deno-kv-node": "deno-kv-node";
|
|
575
|
+
denoKVNode: "denoKVNode";
|
|
576
|
+
"deno-kv": "deno-kv";
|
|
577
|
+
denoKV: "denoKV";
|
|
578
|
+
"fs-lite": "fs-lite";
|
|
579
|
+
fsLite: "fsLite";
|
|
580
|
+
fs: "fs";
|
|
581
|
+
github: "github";
|
|
582
|
+
http: "http";
|
|
583
|
+
indexedb: "indexedb";
|
|
584
|
+
localstorage: "localstorage";
|
|
585
|
+
"lru-cache": "lru-cache";
|
|
586
|
+
lruCache: "lruCache";
|
|
587
|
+
memory: "memory";
|
|
588
|
+
mongodb: "mongodb";
|
|
589
|
+
"netlify-blobs": "netlify-blobs";
|
|
590
|
+
netlifyBlobs: "netlifyBlobs";
|
|
591
|
+
overlay: "overlay";
|
|
592
|
+
planetscale: "planetscale";
|
|
593
|
+
redis: "redis";
|
|
594
|
+
s3: "s3";
|
|
595
|
+
"session-storage": "session-storage";
|
|
596
|
+
sessionStorage: "sessionStorage";
|
|
597
|
+
uploadthing: "uploadthing";
|
|
598
|
+
upstash: "upstash";
|
|
599
|
+
"vercel-blob": "vercel-blob";
|
|
600
|
+
vercelBlob: "vercelBlob";
|
|
601
|
+
"vercel-kv": "vercel-kv";
|
|
602
|
+
vercelKV: "vercelKV";
|
|
603
|
+
"vercel-runtime-cache": "vercel-runtime-cache";
|
|
604
|
+
vercelRuntimeCache: "vercelRuntimeCache";
|
|
605
|
+
}>;
|
|
606
|
+
compression: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
607
|
+
none: "none";
|
|
608
|
+
deflate: "deflate";
|
|
609
|
+
gzip: "gzip";
|
|
610
|
+
brotli: "brotli";
|
|
611
|
+
}>>;
|
|
612
|
+
url: z.ZodMiniOptional<z.ZodMiniURL>;
|
|
613
|
+
token: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
614
|
+
host: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
615
|
+
port: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
616
|
+
username: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
617
|
+
password: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
618
|
+
tls: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
619
|
+
ttl: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
620
|
+
}, z.core.$strip>, z.ZodMiniObject<{
|
|
621
|
+
driver: z.ZodMiniLiteral<"scayleKv">;
|
|
622
|
+
compression: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
623
|
+
none: "none";
|
|
624
|
+
deflate: "deflate";
|
|
625
|
+
gzip: "gzip";
|
|
626
|
+
brotli: "brotli";
|
|
627
|
+
}>>;
|
|
628
|
+
ttl: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
629
|
+
disableClusterMode: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
630
|
+
}, z.core.$strip>], "driver">>;
|
|
631
|
+
}, z.core.$strip>>;
|
|
632
|
+
isDefault: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniBoolean<boolean>, z.ZodMiniString<string>]>>;
|
|
633
|
+
}, z.core.$strip>>;
|
|
368
634
|
session: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
369
635
|
/**
|
|
370
|
-
* The sameSite policy to use for the session cookie
|
|
636
|
+
* The `sameSite` policy to use for the session cookie
|
|
371
637
|
*/
|
|
372
638
|
sameSite: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
373
639
|
lax: "lax";
|
|
@@ -375,7 +641,7 @@ declare const StorefrontConfigSchema: z.ZodMiniObject<{
|
|
|
375
641
|
none: "none";
|
|
376
642
|
}>>;
|
|
377
643
|
/**
|
|
378
|
-
* The default maxAge (in seconds) set on the session cookie and default TTL for session store
|
|
644
|
+
* The default `maxAge` (in seconds) set on the session cookie and default TTL for session store
|
|
379
645
|
*/
|
|
380
646
|
maxAge: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
381
647
|
/**
|
|
@@ -392,7 +658,9 @@ declare const StorefrontConfigSchema: z.ZodMiniObject<{
|
|
|
392
658
|
*/
|
|
393
659
|
domain: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
394
660
|
}, z.core.$strip>>;
|
|
395
|
-
/**
|
|
661
|
+
/**
|
|
662
|
+
* @deprecated The `storage` option within `storefront` is deprecated. Consider using nuxt storage configuration instead.
|
|
663
|
+
*/
|
|
396
664
|
storage: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
397
665
|
session: z.ZodMiniOptional<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
398
666
|
driver: z.ZodMiniEnum<{
|
|
@@ -567,7 +835,6 @@ declare const StorefrontConfigSchema: z.ZodMiniObject<{
|
|
|
567
835
|
sha256: "sha256";
|
|
568
836
|
}>;
|
|
569
837
|
}, z.core.$strip>;
|
|
570
|
-
apiBasePath: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
571
838
|
cache: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
572
839
|
auth: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
573
840
|
username: z.ZodMiniString<string>;
|
|
@@ -585,14 +852,19 @@ declare const StorefrontConfigSchema: z.ZodMiniObject<{
|
|
|
585
852
|
host: z.ZodMiniURL;
|
|
586
853
|
token: z.ZodMiniString<string>;
|
|
587
854
|
}, z.core.$strip>;
|
|
588
|
-
/**
|
|
855
|
+
/**
|
|
856
|
+
* Collection of feature flags regarding legacy features and functionalities.
|
|
857
|
+
*/
|
|
589
858
|
legacy: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
590
859
|
enableSessionMigration: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
591
860
|
}, z.core.$strip>>;
|
|
592
|
-
/**
|
|
861
|
+
/**
|
|
862
|
+
* @hidden
|
|
863
|
+
* Undocumented property intended for internal usage only
|
|
864
|
+
*/
|
|
593
865
|
internalAccessHeader: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
594
866
|
}, z.core.$strip>;
|
|
595
|
-
declare const
|
|
867
|
+
declare const StorefrontPublicRuntimeConfigSchema: z.ZodMiniObject<{
|
|
596
868
|
log: z.ZodMiniObject<{
|
|
597
869
|
name: z.ZodMiniString<string>;
|
|
598
870
|
level: z.ZodMiniType<LogLevel, unknown, z.core.$ZodTypeInternals<LogLevel, unknown>>;
|
|
@@ -609,12 +881,28 @@ declare const PublicRuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
609
881
|
}, z.core.$strip>>;
|
|
610
882
|
}, z.core.$strip>;
|
|
611
883
|
export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
612
|
-
storefront: z.
|
|
884
|
+
storefront: z.ZodMiniObject<{
|
|
885
|
+
/**
|
|
886
|
+
* Determines how the application identifies and switches between different shops.
|
|
887
|
+
* It influences how the `domain` and `path` properties are used within the `shops` configuration.
|
|
888
|
+
*
|
|
889
|
+
* @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#path-and-domain
|
|
890
|
+
*/
|
|
613
891
|
shopSelector: z.ZodMiniEnum<{
|
|
614
892
|
domain: "domain";
|
|
615
893
|
path: "path";
|
|
616
894
|
path_or_default: "path_or_default";
|
|
617
895
|
}>;
|
|
896
|
+
/**
|
|
897
|
+
* Controls how the application handles URL redirects by leveraging the Storefront API,
|
|
898
|
+
* which is synchronized with the SCAYLE Panel. When enabled,
|
|
899
|
+
* the Storefront Core intercepts requests and checks for potential
|
|
900
|
+
* redirects via the Storefront API. If a match is found, a 30x HTTP response
|
|
901
|
+
* is returned with the target in the `Location` header and the appropriate
|
|
902
|
+
* status code.
|
|
903
|
+
*
|
|
904
|
+
* @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/redirects
|
|
905
|
+
*/
|
|
618
906
|
redirects: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
619
907
|
enabled: z.ZodMiniBoolean<boolean>;
|
|
620
908
|
queryParamWhitelist: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
|
|
@@ -623,6 +911,12 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
623
911
|
"on-missing": "on-missing";
|
|
624
912
|
}>>;
|
|
625
913
|
}, z.core.$strip>>;
|
|
914
|
+
/**
|
|
915
|
+
* Configures the available shops in the Storefront Application. Each shop represents a specific region or language,
|
|
916
|
+
* with each shop identified by its unique shop ID from the SCAYLE tenant.
|
|
917
|
+
*
|
|
918
|
+
* @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#shops
|
|
919
|
+
*/
|
|
626
920
|
shops: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniObject<{
|
|
627
921
|
idp: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
628
922
|
enabled: z.ZodMiniBoolean<boolean>;
|
|
@@ -658,7 +952,7 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
658
952
|
isEnabled: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
659
953
|
sessionConfig: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
660
954
|
/**
|
|
661
|
-
* The sameSite policy to use for the session cookie
|
|
955
|
+
* The `sameSite` policy to use for the session cookie
|
|
662
956
|
*/
|
|
663
957
|
sameSite: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
664
958
|
lax: "lax";
|
|
@@ -666,7 +960,7 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
666
960
|
none: "none";
|
|
667
961
|
}>>;
|
|
668
962
|
/**
|
|
669
|
-
* The default maxAge (in seconds) set on the session cookie and default TTL for session store
|
|
963
|
+
* The default `maxAge` (in seconds) set on the session cookie and default TTL for session store
|
|
670
964
|
*/
|
|
671
965
|
maxAge: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
672
966
|
/**
|
|
@@ -687,7 +981,9 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
687
981
|
host: z.ZodMiniURL;
|
|
688
982
|
token: z.ZodMiniString<string>;
|
|
689
983
|
}, z.core.$strip>>;
|
|
690
|
-
/**
|
|
984
|
+
/**
|
|
985
|
+
* @deprecated The `storage` option within `shopConfig` is deprecated. Consider using nuxt storage configuration instead.
|
|
986
|
+
*/
|
|
691
987
|
storage: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
692
988
|
session: z.ZodMiniOptional<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
693
989
|
driver: z.ZodMiniEnum<{
|
|
@@ -850,10 +1146,9 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
850
1146
|
}, z.core.$strip>>;
|
|
851
1147
|
isDefault: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniBoolean<boolean>, z.ZodMiniString<string>]>>;
|
|
852
1148
|
}, z.core.$strip>>;
|
|
853
|
-
}, z.core.$strip>, z.ZodMiniObject<{
|
|
854
1149
|
session: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
855
1150
|
/**
|
|
856
|
-
* The sameSite policy to use for the session cookie
|
|
1151
|
+
* The `sameSite` policy to use for the session cookie
|
|
857
1152
|
*/
|
|
858
1153
|
sameSite: z.ZodMiniOptional<z.ZodMiniEnum<{
|
|
859
1154
|
lax: "lax";
|
|
@@ -861,7 +1156,7 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
861
1156
|
none: "none";
|
|
862
1157
|
}>>;
|
|
863
1158
|
/**
|
|
864
|
-
* The default maxAge (in seconds) set on the session cookie and default TTL for session store
|
|
1159
|
+
* The default `maxAge` (in seconds) set on the session cookie and default TTL for session store
|
|
865
1160
|
*/
|
|
866
1161
|
maxAge: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
|
|
867
1162
|
/**
|
|
@@ -878,7 +1173,9 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
878
1173
|
*/
|
|
879
1174
|
domain: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
880
1175
|
}, z.core.$strip>>;
|
|
881
|
-
/**
|
|
1176
|
+
/**
|
|
1177
|
+
* @deprecated The `storage` option within `storefront` is deprecated. Consider using nuxt storage configuration instead.
|
|
1178
|
+
*/
|
|
882
1179
|
storage: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
883
1180
|
session: z.ZodMiniOptional<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
|
|
884
1181
|
driver: z.ZodMiniEnum<{
|
|
@@ -1053,7 +1350,6 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
1053
1350
|
sha256: "sha256";
|
|
1054
1351
|
}>;
|
|
1055
1352
|
}, z.core.$strip>;
|
|
1056
|
-
apiBasePath: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
1057
1353
|
cache: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
1058
1354
|
auth: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
1059
1355
|
username: z.ZodMiniString<string>;
|
|
@@ -1071,13 +1367,18 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
1071
1367
|
host: z.ZodMiniURL;
|
|
1072
1368
|
token: z.ZodMiniString<string>;
|
|
1073
1369
|
}, z.core.$strip>;
|
|
1074
|
-
/**
|
|
1370
|
+
/**
|
|
1371
|
+
* Collection of feature flags regarding legacy features and functionalities.
|
|
1372
|
+
*/
|
|
1075
1373
|
legacy: z.ZodMiniOptional<z.ZodMiniObject<{
|
|
1076
1374
|
enableSessionMigration: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
|
|
1077
1375
|
}, z.core.$strip>>;
|
|
1078
|
-
/**
|
|
1376
|
+
/**
|
|
1377
|
+
* @hidden
|
|
1378
|
+
* Undocumented property intended for internal usage only
|
|
1379
|
+
*/
|
|
1079
1380
|
internalAccessHeader: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
1080
|
-
}, z.core.$strip
|
|
1381
|
+
}, z.core.$strip>;
|
|
1081
1382
|
public: z.ZodMiniObject<{
|
|
1082
1383
|
storefront: z.ZodMiniObject<{
|
|
1083
1384
|
log: z.ZodMiniObject<{
|
|
@@ -1097,13 +1398,123 @@ export declare const RuntimeConfigSchema: z.ZodMiniObject<{
|
|
|
1097
1398
|
}, z.core.$strip>;
|
|
1098
1399
|
}, z.core.$strip>;
|
|
1099
1400
|
}, z.core.$strip>;
|
|
1401
|
+
declare const ModuleOptionSchema: z.ZodMiniObject<{
|
|
1402
|
+
/**
|
|
1403
|
+
* The RPC directory where the custom application RPCs are defined.
|
|
1404
|
+
* The directory should have an `index.ts` file where all RPCs are exported using their name.
|
|
1405
|
+
* By default this will be `./rpcMethods`.
|
|
1406
|
+
*/
|
|
1407
|
+
rpcDir: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
1408
|
+
/**
|
|
1409
|
+
* The RPC method names which are exported from the `rpcDir`.
|
|
1410
|
+
* Usually this can just be `Object.keys(rpcMethodsDir)`.
|
|
1411
|
+
*/
|
|
1412
|
+
rpcMethodNames: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
|
|
1413
|
+
/** Specify explicitly overridden RPC methods that are provided by the Storefront Core package. */
|
|
1414
|
+
rpcMethodOverrides: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniEnum<{
|
|
1415
|
+
getProductById: "getProductById";
|
|
1416
|
+
getProductsByIds: "getProductsByIds";
|
|
1417
|
+
getProductsByReferenceKeys: "getProductsByReferenceKeys";
|
|
1418
|
+
getProductsCount: "getProductsCount";
|
|
1419
|
+
fetchAllFiltersForCategory: "fetchAllFiltersForCategory";
|
|
1420
|
+
getFilters: "getFilters";
|
|
1421
|
+
getProductsByCategory: "getProductsByCategory";
|
|
1422
|
+
oauthForgetPassword: "oauthForgetPassword";
|
|
1423
|
+
oauthGuestLogin: "oauthGuestLogin";
|
|
1424
|
+
oauthLogin: "oauthLogin";
|
|
1425
|
+
oauthRegister: "oauthRegister";
|
|
1426
|
+
oauthRevokeToken: "oauthRevokeToken";
|
|
1427
|
+
refreshAccessToken: "refreshAccessToken";
|
|
1428
|
+
updatePasswordByHash: "updatePasswordByHash";
|
|
1429
|
+
addItemToBasket: "addItemToBasket";
|
|
1430
|
+
addItemsToBasket: "addItemsToBasket";
|
|
1431
|
+
getBasket: "getBasket";
|
|
1432
|
+
removeItemFromBasket: "removeItemFromBasket";
|
|
1433
|
+
clearBasket: "clearBasket";
|
|
1434
|
+
mergeBaskets: "mergeBaskets";
|
|
1435
|
+
updateBasketItem: "updateBasketItem";
|
|
1436
|
+
getApplicablePromotionsByCode: "getApplicablePromotionsByCode";
|
|
1437
|
+
updatePromotions: "updatePromotions";
|
|
1438
|
+
getBrands: "getBrands";
|
|
1439
|
+
getBrandById: "getBrandById";
|
|
1440
|
+
getRootCategories: "getRootCategories";
|
|
1441
|
+
getCategoryByPath: "getCategoryByPath";
|
|
1442
|
+
getCategoriesByPath: "getCategoriesByPath";
|
|
1443
|
+
getCategoryById: "getCategoryById";
|
|
1444
|
+
getCategoryTree: "getCategoryTree";
|
|
1445
|
+
getCampaign: "getCampaign";
|
|
1446
|
+
getCampaignKey: "getCampaignKey";
|
|
1447
|
+
getOrderDataByCbd: "getOrderDataByCbd";
|
|
1448
|
+
getSearchSuggestions: "getSearchSuggestions";
|
|
1449
|
+
resolveSearch: "resolveSearch";
|
|
1450
|
+
getShopConfiguration: "getShopConfiguration";
|
|
1451
|
+
getUser: "getUser";
|
|
1452
|
+
fetchUser: "fetchUser";
|
|
1453
|
+
refreshUser: "refreshUser";
|
|
1454
|
+
getAccessToken: "getAccessToken";
|
|
1455
|
+
getWishlist: "getWishlist";
|
|
1456
|
+
addItemToWishlist: "addItemToWishlist";
|
|
1457
|
+
removeItemFromWishlist: "removeItemFromWishlist";
|
|
1458
|
+
clearWishlist: "clearWishlist";
|
|
1459
|
+
getOrderById: "getOrderById";
|
|
1460
|
+
getShopUserAddresses: "getShopUserAddresses";
|
|
1461
|
+
updateShopUser: "updateShopUser";
|
|
1462
|
+
updatePassword: "updatePassword";
|
|
1463
|
+
getCheckoutToken: "getCheckoutToken";
|
|
1464
|
+
getVariantById: "getVariantById";
|
|
1465
|
+
fetchAllNavigationTrees: "fetchAllNavigationTrees";
|
|
1466
|
+
fetchNavigationTreeById: "fetchNavigationTreeById";
|
|
1467
|
+
fetchNavigationTreeByName: "fetchNavigationTreeByName";
|
|
1468
|
+
getPromotions: "getPromotions";
|
|
1469
|
+
getCurrentPromotions: "getCurrentPromotions";
|
|
1470
|
+
getPromotionsByIds: "getPromotionsByIds";
|
|
1471
|
+
getExternalIdpRedirect: "getExternalIdpRedirect";
|
|
1472
|
+
handleIDPLoginCallback: "handleIDPLoginCallback";
|
|
1473
|
+
}>>>;
|
|
1474
|
+
/**
|
|
1475
|
+
* The base path for API routes.
|
|
1476
|
+
*/
|
|
1477
|
+
apiBasePath: z.ZodMiniOptional<z.ZodMiniString<string>>;
|
|
1478
|
+
}, z.core.$strip>;
|
|
1100
1479
|
type CheckoutShopConfigType = z.infer<typeof CheckoutShopConfigSchema>;
|
|
1101
1480
|
type SessionType = z.infer<typeof SessionSchema>;
|
|
1102
1481
|
type StorageType = z.infer<typeof StorageSchema>;
|
|
1103
1482
|
type SapiConfigType = z.infer<typeof SapiSchema>;
|
|
1104
|
-
type
|
|
1483
|
+
type StorefrontRuntimeConfigType = z.infer<typeof StorefrontRuntimeConfigSchema> & {
|
|
1484
|
+
/**
|
|
1485
|
+
* Default `with` parameters for Storefront API requests. These are used as defaults
|
|
1486
|
+
* within composables like `useWishlist` and can be overridden if needed.
|
|
1487
|
+
* Some composables also enforce minimum "with" parameters.
|
|
1488
|
+
*
|
|
1489
|
+
* @example
|
|
1490
|
+
* // Default `with` parameters for product listings.
|
|
1491
|
+
* withParams: {
|
|
1492
|
+
* items: {
|
|
1493
|
+
* product: {
|
|
1494
|
+
* attributes: "all",
|
|
1495
|
+
* advancedAttributes: "all",
|
|
1496
|
+
* variants: {
|
|
1497
|
+
* attributes: "all",
|
|
1498
|
+
* advancedAttributes: "all",
|
|
1499
|
+
* },
|
|
1500
|
+
* images: "all",
|
|
1501
|
+
* categories: {
|
|
1502
|
+
* properties: "all"
|
|
1503
|
+
* },
|
|
1504
|
+
* priceRange: boolean
|
|
1505
|
+
* },
|
|
1506
|
+
* variant: {
|
|
1507
|
+
* attributes: "all",
|
|
1508
|
+
* },
|
|
1509
|
+
* },
|
|
1510
|
+
* }
|
|
1511
|
+
* @see https://scayle.dev/en/storefront-guide/support-and-resources/upgrade-guides/nuxt-3/storefront-core-changes#withparameters
|
|
1512
|
+
*/
|
|
1513
|
+
withParams?: WithParams;
|
|
1514
|
+
};
|
|
1105
1515
|
type ShopSelectorType = z.infer<typeof ShopSelectorSchema>;
|
|
1106
1516
|
type RedirectType = z.infer<typeof RedirectsSchema>;
|
|
1107
1517
|
type IdpType = z.infer<typeof IdpSchema>;
|
|
1108
|
-
type
|
|
1109
|
-
export type
|
|
1518
|
+
type StorefrontPublicRuntimeConfigType = z.infer<typeof StorefrontPublicRuntimeConfigSchema>;
|
|
1519
|
+
export type ModuleOptionType = z.infer<typeof ModuleOptionSchema>;
|
|
1520
|
+
export type { CheckoutShopConfigType, SessionType, StorageType, SapiConfigType, ShopSelectorType, ShopConfigType, StorefrontRuntimeConfigType, RedirectType, StorefrontPublicRuntimeConfigType, IdpType, };
|