@sitecore-content-sdk/core 1.3.0-canary.9 → 1.4.0-canary.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.
- package/README.md +7 -7
- package/dist/cjs/cache-client.js +55 -54
- package/dist/cjs/client/constants.js +7 -7
- package/dist/cjs/client/edge-proxy.js +24 -22
- package/dist/cjs/client/index.js +15 -15
- package/dist/cjs/client/models.js +2 -2
- package/dist/cjs/client/sitecore-client.js +421 -419
- package/dist/cjs/client/utils.js +47 -46
- package/dist/cjs/config/define-config.js +194 -193
- package/dist/cjs/config/index.js +7 -7
- package/dist/cjs/config/models.js +12 -11
- package/dist/cjs/config-cli/define-cli-config.js +23 -22
- package/dist/cjs/config-cli/index.js +7 -7
- package/dist/cjs/config-cli/models.js +8 -7
- package/dist/cjs/constants.js +49 -17
- package/dist/cjs/debug.js +48 -46
- package/dist/cjs/editing/codegen/index.js +14 -9
- package/dist/cjs/editing/codegen/preview.js +277 -193
- package/dist/cjs/editing/component-layout-service.js +62 -61
- package/dist/cjs/editing/design-library.js +183 -126
- package/dist/cjs/editing/editing-service.js +75 -74
- package/dist/cjs/editing/index.js +33 -27
- package/dist/cjs/editing/metadata.js +42 -42
- package/dist/cjs/editing/models.js +44 -38
- package/dist/cjs/editing/utils.js +108 -90
- package/dist/cjs/form/form.js +81 -78
- package/dist/cjs/form/index.js +7 -7
- package/dist/cjs/graphql-request-client.js +108 -107
- package/dist/cjs/i18n/dictionary-service.js +122 -121
- package/dist/cjs/i18n/index.js +7 -7
- package/dist/cjs/i18n/utils.js +16 -15
- package/dist/cjs/index.js +60 -60
- package/dist/cjs/layout/content-styles.js +72 -71
- package/dist/cjs/layout/index.js +24 -24
- package/dist/cjs/layout/layout-service.js +62 -57
- package/dist/cjs/layout/models.js +39 -34
- package/dist/cjs/layout/themes.js +76 -75
- package/dist/cjs/layout/utils.js +117 -110
- package/dist/cjs/media/index.js +38 -38
- package/dist/cjs/media/media-api.js +100 -96
- package/dist/cjs/models.js +2 -2
- package/dist/cjs/native-fetcher.js +194 -179
- package/dist/cjs/personalize/index.js +15 -15
- package/dist/cjs/personalize/layout-personalizer.js +98 -97
- package/dist/cjs/personalize/personalize-service.js +98 -94
- package/dist/cjs/personalize/utils.js +143 -136
- package/dist/cjs/retries.js +43 -42
- package/dist/cjs/site/error-pages-service.js +65 -64
- package/dist/cjs/site/index.js +26 -26
- package/dist/cjs/site/models.js +2 -2
- package/dist/cjs/site/redirects-service.js +94 -81
- package/dist/cjs/site/robots-service.js +66 -65
- package/dist/cjs/site/site-resolver.js +73 -72
- package/dist/cjs/site/siteinfo-service.js +84 -80
- package/dist/cjs/site/sitemap-xml-service.js +84 -83
- package/dist/cjs/site/sitepath-service.js +165 -164
- package/dist/cjs/site/utils.js +55 -47
- package/dist/cjs/sitecore-service-base.js +36 -36
- package/dist/cjs/tools/auth/flow.js +65 -64
- package/dist/cjs/tools/auth/index.js +5 -5
- package/dist/cjs/tools/auth/models.js +2 -2
- package/dist/cjs/tools/auth/tenant-store.js +38 -38
- package/dist/cjs/tools/codegen/component-generation.js +52 -50
- package/dist/cjs/tools/codegen/extract-files.js +105 -107
- package/dist/cjs/tools/codegen/import-map.js +401 -349
- package/dist/cjs/tools/codegen/utils.js +418 -418
- package/dist/cjs/tools/generate-map.js +2 -2
- package/dist/cjs/tools/generateMetadata.js +36 -35
- package/dist/cjs/tools/generateSites.js +59 -58
- package/dist/cjs/tools/index.js +75 -73
- package/dist/cjs/tools/scaffold.js +60 -59
- package/dist/cjs/tools/templating/components.js +96 -266
- package/dist/cjs/tools/templating/index.js +11 -14
- package/dist/cjs/tools/templating/plugins.js +80 -78
- package/dist/cjs/tools/templating/utils.js +67 -66
- package/dist/cjs/utils/ensurePath.js +20 -20
- package/dist/cjs/utils/env.js +28 -27
- package/dist/cjs/utils/globalCache.js +55 -0
- package/dist/cjs/utils/index.js +26 -21
- package/dist/cjs/utils/is-server.js +11 -10
- package/dist/cjs/utils/normalize-url.js +5 -5
- package/dist/cjs/utils/timeout-promise.js +31 -31
- package/dist/cjs/utils/utils.js +254 -229
- package/dist/esm/cache-client.js +51 -50
- package/dist/esm/client/constants.js +4 -4
- package/dist/esm/client/edge-proxy.js +19 -17
- package/dist/esm/client/index.js +5 -5
- package/dist/esm/client/models.js +1 -1
- package/dist/esm/client/sitecore-client.js +414 -412
- package/dist/esm/client/utils.js +43 -42
- package/dist/esm/config/define-config.js +188 -187
- package/dist/esm/config/index.js +2 -2
- package/dist/esm/config/models.js +9 -8
- package/dist/esm/config-cli/define-cli-config.js +19 -18
- package/dist/esm/config-cli/index.js +2 -2
- package/dist/esm/config-cli/models.js +5 -4
- package/dist/esm/constants.js +46 -14
- package/dist/esm/debug.js +41 -39
- package/dist/esm/editing/codegen/index.js +1 -1
- package/dist/esm/editing/codegen/preview.js +263 -185
- package/dist/esm/editing/component-layout-service.js +55 -54
- package/dist/esm/editing/design-library.js +171 -117
- package/dist/esm/editing/editing-service.js +68 -67
- package/dist/esm/editing/index.js +6 -5
- package/dist/esm/editing/metadata.js +39 -39
- package/dist/esm/editing/models.js +41 -35
- package/dist/esm/editing/utils.js +98 -80
- package/dist/esm/form/form.js +72 -69
- package/dist/esm/form/index.js +1 -1
- package/dist/esm/graphql-request-client.js +101 -100
- package/dist/esm/i18n/dictionary-service.js +115 -114
- package/dist/esm/i18n/index.js +2 -2
- package/dist/esm/i18n/utils.js +13 -12
- package/dist/esm/index.js +13 -13
- package/dist/esm/layout/content-styles.js +64 -63
- package/dist/esm/layout/index.js +6 -6
- package/dist/esm/layout/layout-service.js +55 -50
- package/dist/esm/layout/models.js +36 -31
- package/dist/esm/layout/themes.js +71 -70
- package/dist/esm/layout/utils.js +109 -102
- package/dist/esm/media/index.js +2 -2
- package/dist/esm/media/media-api.js +90 -86
- package/dist/esm/models.js +1 -1
- package/dist/esm/native-fetcher.js +187 -172
- package/dist/esm/personalize/index.js +3 -3
- package/dist/esm/personalize/layout-personalizer.js +93 -92
- package/dist/esm/personalize/personalize-service.js +91 -87
- package/dist/esm/personalize/utils.js +135 -128
- package/dist/esm/retries.js +39 -38
- package/dist/esm/site/error-pages-service.js +58 -57
- package/dist/esm/site/index.js +8 -8
- package/dist/esm/site/models.js +1 -1
- package/dist/esm/site/redirects-service.js +87 -74
- package/dist/esm/site/robots-service.js +59 -58
- package/dist/esm/site/site-resolver.js +69 -68
- package/dist/esm/site/siteinfo-service.js +77 -73
- package/dist/esm/site/sitemap-xml-service.js +77 -76
- package/dist/esm/site/sitepath-service.js +157 -156
- package/dist/esm/site/utils.js +49 -41
- package/dist/esm/sitecore-service-base.js +29 -29
- package/dist/esm/tools/auth/flow.js +62 -61
- package/dist/esm/tools/auth/index.js +1 -1
- package/dist/esm/tools/auth/models.js +1 -1
- package/dist/esm/tools/auth/tenant-store.js +35 -35
- package/dist/esm/tools/codegen/component-generation.js +44 -42
- package/dist/esm/tools/codegen/extract-files.js +99 -101
- package/dist/esm/tools/codegen/import-map.js +358 -306
- package/dist/esm/tools/codegen/utils.js +373 -373
- package/dist/esm/tools/generate-map.js +1 -1
- package/dist/esm/tools/generateMetadata.js +29 -28
- package/dist/esm/tools/generateSites.js +52 -51
- package/dist/esm/tools/index.js +28 -27
- package/dist/esm/tools/scaffold.js +52 -51
- package/dist/esm/tools/templating/components.js +59 -223
- package/dist/esm/tools/templating/index.js +3 -3
- package/dist/esm/tools/templating/plugins.js +72 -70
- package/dist/esm/tools/templating/utils.js +59 -58
- package/dist/esm/utils/ensurePath.js +13 -13
- package/dist/esm/utils/env.js +24 -23
- package/dist/esm/utils/globalCache.js +49 -0
- package/dist/esm/utils/index.js +4 -3
- package/dist/esm/utils/is-server.js +9 -8
- package/dist/esm/utils/normalize-url.js +1 -1
- package/dist/esm/utils/timeout-promise.js +28 -28
- package/dist/esm/utils/utils.js +238 -213
- package/package.json +73 -5
- package/types/cache-client.d.ts +68 -64
- package/types/cache-client.d.ts.map +1 -0
- package/types/client/constants.d.ts +5 -4
- package/types/client/constants.d.ts.map +1 -0
- package/types/client/edge-proxy.d.ts +18 -15
- package/types/client/edge-proxy.d.ts.map +1 -0
- package/types/client/index.d.ts +8 -7
- package/types/client/index.d.ts.map +1 -0
- package/types/client/models.d.ts +21 -19
- package/types/client/models.d.ts.map +1 -0
- package/types/client/sitecore-client.d.ts +338 -327
- package/types/client/sitecore-client.d.ts.map +1 -0
- package/types/client/utils.d.ts +15 -9
- package/types/client/utils.d.ts.map +1 -0
- package/types/config/define-config.d.ts +20 -18
- package/types/config/define-config.d.ts.map +1 -0
- package/types/config/index.d.ts +3 -2
- package/types/config/index.d.ts.map +1 -0
- package/types/config/models.d.ts +287 -268
- package/types/config/models.d.ts.map +1 -0
- package/types/config-cli/define-cli-config.d.ts +9 -7
- package/types/config-cli/define-cli-config.d.ts.map +1 -0
- package/types/config-cli/index.d.ts +3 -2
- package/types/config-cli/index.d.ts.map +1 -0
- package/types/config-cli/models.d.ts +6 -4
- package/types/config-cli/models.d.ts.map +1 -0
- package/types/constants.d.ts +44 -11
- package/types/constants.d.ts.map +1 -0
- package/types/debug.d.ts +35 -28
- package/types/debug.d.ts.map +1 -0
- package/types/editing/codegen/index.d.ts +2 -1
- package/types/editing/codegen/index.d.ts.map +1 -0
- package/types/editing/codegen/preview.d.ts +256 -195
- package/types/editing/codegen/preview.d.ts.map +1 -0
- package/types/editing/component-layout-service.d.ts +84 -80
- package/types/editing/component-layout-service.d.ts.map +1 -0
- package/types/editing/design-library.d.ts +111 -63
- package/types/editing/design-library.d.ts.map +1 -0
- package/types/editing/editing-service.d.ts +72 -62
- package/types/editing/editing-service.d.ts.map +1 -0
- package/types/editing/index.d.ts +7 -6
- package/types/editing/index.d.ts.map +1 -0
- package/types/editing/metadata.d.ts +8 -7
- package/types/editing/metadata.d.ts.map +1 -0
- package/types/editing/models.d.ts +103 -92
- package/types/editing/models.d.ts.map +1 -0
- package/types/editing/utils.d.ts +91 -74
- package/types/editing/utils.d.ts.map +1 -0
- package/types/form/form.d.ts +25 -21
- package/types/form/form.d.ts.map +1 -0
- package/types/form/index.d.ts +2 -1
- package/types/form/index.d.ts.map +1 -0
- package/types/graphql-request-client.d.ts +112 -105
- package/types/graphql-request-client.d.ts.map +1 -0
- package/types/i18n/dictionary-service.d.ts +135 -131
- package/types/i18n/dictionary-service.d.ts.map +1 -0
- package/types/i18n/index.d.ts +3 -2
- package/types/i18n/index.d.ts.map +1 -0
- package/types/i18n/utils.d.ts +9 -7
- package/types/i18n/utils.d.ts.map +1 -0
- package/types/index.d.ts +13 -12
- package/types/index.d.ts.map +1 -0
- package/types/layout/content-styles.d.ts +20 -18
- package/types/layout/content-styles.d.ts.map +1 -0
- package/types/layout/index.d.ts +6 -5
- package/types/layout/index.d.ts.map +1 -0
- package/types/layout/layout-service.d.ts +45 -35
- package/types/layout/layout-service.d.ts.map +1 -0
- package/types/layout/models.d.ts +174 -151
- package/types/layout/models.d.ts.map +1 -0
- package/types/layout/themes.d.ts +13 -11
- package/types/layout/themes.d.ts.map +1 -0
- package/types/layout/utils.d.ts +56 -41
- package/types/layout/utils.d.ts.map +1 -0
- package/types/media/index.d.ts +3 -2
- package/types/media/index.d.ts.map +1 -0
- package/types/media/media-api.d.ts +60 -55
- package/types/media/media-api.d.ts.map +1 -0
- package/types/models.d.ts +94 -84
- package/types/models.d.ts.map +1 -0
- package/types/native-fetcher.d.ts +124 -114
- package/types/native-fetcher.d.ts.map +1 -0
- package/types/personalize/index.d.ts +4 -3
- package/types/personalize/index.d.ts.map +1 -0
- package/types/personalize/layout-personalizer.d.ts +29 -27
- package/types/personalize/layout-personalizer.d.ts.map +1 -0
- package/types/personalize/personalize-service.d.ts +90 -80
- package/types/personalize/personalize-service.d.ts.map +1 -0
- package/types/personalize/utils.d.ts +78 -69
- package/types/personalize/utils.d.ts.map +1 -0
- package/types/retries.d.ts +26 -24
- package/types/retries.d.ts.map +1 -0
- package/types/site/error-pages-service.d.ts +64 -57
- package/types/site/error-pages-service.d.ts.map +1 -0
- package/types/site/index.d.ts +10 -9
- package/types/site/index.d.ts.map +1 -0
- package/types/site/models.d.ts +23 -18
- package/types/site/models.d.ts.map +1 -0
- package/types/site/redirects-service.d.ts +92 -69
- package/types/site/redirects-service.d.ts.map +1 -0
- package/types/site/robots-service.d.ts +57 -50
- package/types/site/robots-service.d.ts.map +1 -0
- package/types/site/site-resolver.d.ts +28 -26
- package/types/site/site-resolver.d.ts.map +1 -0
- package/types/site/siteinfo-service.d.ts +65 -52
- package/types/site/siteinfo-service.d.ts.map +1 -0
- package/types/site/sitemap-xml-service.d.ts +63 -56
- package/types/site/sitemap-xml-service.d.ts.map +1 -0
- package/types/site/sitepath-service.d.ts +137 -134
- package/types/site/sitepath-service.d.ts.map +1 -0
- package/types/site/utils.d.ts +41 -28
- package/types/site/utils.d.ts.map +1 -0
- package/types/sitecore-service-base.d.ts +31 -30
- package/types/sitecore-service-base.d.ts.map +1 -0
- package/types/tools/auth/flow.d.ts +29 -27
- package/types/tools/auth/flow.d.ts.map +1 -0
- package/types/tools/auth/index.d.ts +2 -1
- package/types/tools/auth/index.d.ts.map +1 -0
- package/types/tools/auth/models.d.ts +35 -33
- package/types/tools/auth/models.d.ts.map +1 -0
- package/types/tools/auth/tenant-store.d.ts +12 -11
- package/types/tools/auth/tenant-store.d.ts.map +1 -0
- package/types/tools/codegen/component-generation.d.ts +50 -47
- package/types/tools/codegen/component-generation.d.ts.map +1 -0
- package/types/tools/codegen/extract-files.d.ts +24 -22
- package/types/tools/codegen/extract-files.d.ts.map +1 -0
- package/types/tools/codegen/import-map.d.ts +103 -70
- package/types/tools/codegen/import-map.d.ts.map +1 -0
- package/types/tools/codegen/utils.d.ts +76 -75
- package/types/tools/codegen/utils.d.ts.map +1 -0
- package/types/tools/generate-map.d.ts +36 -26
- package/types/tools/generate-map.d.ts.map +1 -0
- package/types/tools/generateMetadata.d.ts +24 -22
- package/types/tools/generateMetadata.d.ts.map +1 -0
- package/types/tools/generateSites.d.ts +25 -22
- package/types/tools/generateSites.d.ts.map +1 -0
- package/types/tools/index.d.ts +22 -20
- package/types/tools/index.d.ts.map +1 -0
- package/types/tools/scaffold.d.ts +27 -25
- package/types/tools/scaffold.d.ts.map +1 -0
- package/types/tools/templating/components.d.ts +104 -103
- package/types/tools/templating/components.d.ts.map +1 -0
- package/types/tools/templating/index.d.ts +4 -3
- package/types/tools/templating/index.d.ts.map +1 -0
- package/types/tools/templating/plugins.d.ts +71 -67
- package/types/tools/templating/plugins.d.ts.map +1 -0
- package/types/tools/templating/utils.d.ts +42 -40
- package/types/tools/templating/utils.d.ts.map +1 -0
- package/types/utils/ensurePath.d.ts +7 -6
- package/types/utils/ensurePath.d.ts.map +1 -0
- package/types/utils/env.d.ts +9 -7
- package/types/utils/env.d.ts.map +1 -0
- package/types/utils/globalCache.d.ts +37 -0
- package/types/utils/globalCache.d.ts.map +1 -0
- package/types/utils/index.d.ts +5 -3
- package/types/utils/index.d.ts.map +1 -0
- package/types/utils/is-server.d.ts +8 -6
- package/types/utils/is-server.d.ts.map +1 -0
- package/types/utils/normalize-url.d.ts +2 -1
- package/types/utils/normalize-url.d.ts.map +1 -0
- package/types/utils/timeout-promise.d.ts +18 -17
- package/types/utils/timeout-promise.d.ts.map +1 -0
- package/types/utils/utils.d.ts +104 -79
- package/types/utils/utils.d.ts.map +1 -0
- package/client.js +0 -1
- package/codegen.js +0 -1
- package/config-cli.js +0 -1
- package/config.js +0 -1
- package/editing.js +0 -1
- package/i18n.js +0 -1
- package/layout.js +0 -1
- package/media.js +0 -1
- package/personalize.js +0 -1
- package/site.js +0 -1
- package/tools.js +0 -1
- package/utils.js +0 -1
package/types/site/models.d.ts
CHANGED
|
@@ -1,18 +1,23 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
/**
|
|
7
|
-
*
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* Site
|
|
12
|
-
*/
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* Site
|
|
16
|
-
*/
|
|
17
|
-
|
|
18
|
-
|
|
1
|
+
/**
|
|
2
|
+
* Object model of Site Info result
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export type SiteInfo = {
|
|
6
|
+
/**
|
|
7
|
+
* Additional user-defined properties
|
|
8
|
+
*/
|
|
9
|
+
[key: string]: unknown;
|
|
10
|
+
/**
|
|
11
|
+
* Site name
|
|
12
|
+
*/
|
|
13
|
+
name: string;
|
|
14
|
+
/**
|
|
15
|
+
* Site host name. May include multiple values (separated by '|') and wildcards ('*')
|
|
16
|
+
*/
|
|
17
|
+
hostName: string;
|
|
18
|
+
/**
|
|
19
|
+
* Site default language
|
|
20
|
+
*/
|
|
21
|
+
language: string;
|
|
22
|
+
};
|
|
23
|
+
//# sourceMappingURL=models.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"models.d.ts","sourceRoot":"","sources":["../../src/site/models.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
|
|
@@ -1,69 +1,92 @@
|
|
|
1
|
-
import { FetchOptions, GraphQLClient } from '../client';
|
|
2
|
-
import { CacheOptions, CacheClient } from '../cache-client';
|
|
3
|
-
import { GraphQLRequestClientFactory } from '../graphql-request-client';
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
*
|
|
66
|
-
* @
|
|
67
|
-
*/
|
|
68
|
-
|
|
69
|
-
|
|
1
|
+
import { FetchOptions, GraphQLClient } from '../client';
|
|
2
|
+
import { CacheOptions, CacheClient } from '../cache-client';
|
|
3
|
+
import { GraphQLRequestClientFactory } from '../graphql-request-client';
|
|
4
|
+
/**
|
|
5
|
+
* Redirect type for 301 redirects
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export declare const REDIRECT_TYPE_301 = "REDIRECT_301";
|
|
9
|
+
/**
|
|
10
|
+
* Redirect type for 302 redirects
|
|
11
|
+
* @public
|
|
12
|
+
*/
|
|
13
|
+
export declare const REDIRECT_TYPE_302 = "REDIRECT_302";
|
|
14
|
+
/**
|
|
15
|
+
* Redirect type for server transfer
|
|
16
|
+
* @public
|
|
17
|
+
*/
|
|
18
|
+
export declare const REDIRECT_TYPE_SERVER_TRANSFER = "SERVER_TRANSFER";
|
|
19
|
+
/**
|
|
20
|
+
* Object model of Redirect Info result
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export type RedirectInfo = {
|
|
24
|
+
pattern: string;
|
|
25
|
+
target: string;
|
|
26
|
+
redirectType: string;
|
|
27
|
+
isQueryStringPreserved: boolean;
|
|
28
|
+
locale: string;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Configuration for @see RedirectsService instances
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
export type RedirectsServiceConfig = CacheOptions & {
|
|
35
|
+
/**
|
|
36
|
+
* Override fetch method. Uses 'GraphQLRequestClient' default otherwise.
|
|
37
|
+
*/
|
|
38
|
+
fetch?: typeof fetch;
|
|
39
|
+
/**
|
|
40
|
+
* A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
|
|
41
|
+
* This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
|
|
42
|
+
*/
|
|
43
|
+
clientFactory: GraphQLRequestClientFactory;
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* The schema of data returned in response to redirects array request
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
export type RedirectsQueryResult = {
|
|
50
|
+
site: {
|
|
51
|
+
siteInfo: {
|
|
52
|
+
redirects: RedirectInfo[];
|
|
53
|
+
} | null;
|
|
54
|
+
};
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* The RedirectsService class is used to query the Content SDK redirects using Graphql endpoint
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
export declare class RedirectsService {
|
|
61
|
+
private options;
|
|
62
|
+
private graphQLClient;
|
|
63
|
+
private cache;
|
|
64
|
+
/**
|
|
65
|
+
* Creates an instance of graphQL redirects service with the provided options
|
|
66
|
+
* @param {RedirectsServiceConfig} options instance
|
|
67
|
+
*/
|
|
68
|
+
constructor(options: RedirectsServiceConfig);
|
|
69
|
+
protected get query(): string;
|
|
70
|
+
/**
|
|
71
|
+
* Fetch an array of redirects from API
|
|
72
|
+
* @param {string} siteName site name
|
|
73
|
+
* @returns Promise<RedirectInfo[]>
|
|
74
|
+
* @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
|
|
75
|
+
* @throws {Error} if the siteName is empty.
|
|
76
|
+
*/
|
|
77
|
+
fetchRedirects(siteName: string, fetchOptions?: FetchOptions): Promise<RedirectInfo[]>;
|
|
78
|
+
/**
|
|
79
|
+
* Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
|
|
80
|
+
* library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
|
|
81
|
+
* want to use something else.
|
|
82
|
+
* @returns {GraphQLClient} implementation
|
|
83
|
+
*/
|
|
84
|
+
protected getGraphQLClient(): GraphQLClient;
|
|
85
|
+
/**
|
|
86
|
+
* Gets cache client implementation
|
|
87
|
+
* Override this method if custom cache needs to be used
|
|
88
|
+
* @returns CacheClient instance
|
|
89
|
+
*/
|
|
90
|
+
protected getCacheClient(): CacheClient<RedirectsQueryResult>;
|
|
91
|
+
}
|
|
92
|
+
//# sourceMappingURL=redirects-service.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"redirects-service.d.ts","sourceRoot":"","sources":["../../src/site/redirects-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAGxD,OAAO,EAAqB,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,6BAA6B,oBAAoB,CAAC;AAE/D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB,EAAE,OAAO,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAmBF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,YAAY,GAAG;IAClD;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE;QAAE,QAAQ,EAAE;YAAE,SAAS,EAAE,YAAY,EAAE,CAAA;SAAE,GAAG,IAAI,CAAA;KAAE,CAAC;CAC1D,CAAC;AAEF;;;GAGG;AACH,qBAAa,gBAAgB;IAQf,OAAO,CAAC,OAAO;IAP3B,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,KAAK,CAAoC;IAEjD;;;OAGG;gBACiB,OAAO,EAAE,sBAAsB;IAKnD,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;;;;OAMG;IACG,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAsB5F;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;IAW3C;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,WAAW,CAAC,oBAAoB,CAAC;CAM9D"}
|
|
@@ -1,50 +1,57 @@
|
|
|
1
|
-
import { FetchOptions, GraphQLClient } from '../client';
|
|
2
|
-
import { GraphQLRequestClientFactory } from '../graphql-request-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
*
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
* @param {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
1
|
+
import { FetchOptions, GraphQLClient } from '../client';
|
|
2
|
+
import { GraphQLRequestClientFactory } from '../graphql-request-client';
|
|
3
|
+
/**
|
|
4
|
+
* Configuration for @see RobotsService instances
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export type RobotsServiceConfig = {
|
|
8
|
+
/**
|
|
9
|
+
* The Content SDK application name
|
|
10
|
+
*/
|
|
11
|
+
siteName: string;
|
|
12
|
+
/**
|
|
13
|
+
* A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
|
|
14
|
+
* This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
|
|
15
|
+
*/
|
|
16
|
+
clientFactory: GraphQLRequestClientFactory;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* The schema of data returned in response to robots.txt request
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export type RobotsQueryResult = {
|
|
23
|
+
site: {
|
|
24
|
+
siteInfo: {
|
|
25
|
+
robots: string;
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Service that fetch the robots.txt data using Sitecore's GraphQL API.
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export declare class RobotsService {
|
|
34
|
+
options: RobotsServiceConfig;
|
|
35
|
+
private graphQLClient;
|
|
36
|
+
/**
|
|
37
|
+
* Creates an instance of graphQL robots.txt service with the provided options
|
|
38
|
+
* @param {RobotsServiceConfig} options instance
|
|
39
|
+
*/
|
|
40
|
+
constructor(options: RobotsServiceConfig);
|
|
41
|
+
protected get query(): string;
|
|
42
|
+
/**
|
|
43
|
+
* Fetch a data of robots.txt from API
|
|
44
|
+
* @param {FetchOptions} fetchOptions - The fetch options to be used for the request.
|
|
45
|
+
* @returns text of robots.txt
|
|
46
|
+
* @throws {Error} if the siteName is empty.
|
|
47
|
+
*/
|
|
48
|
+
fetchRobots(fetchOptions?: FetchOptions): Promise<string>;
|
|
49
|
+
/**
|
|
50
|
+
* Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
|
|
51
|
+
* library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
|
|
52
|
+
* want to use something else.
|
|
53
|
+
* @returns {GraphQLClient} implementation
|
|
54
|
+
*/
|
|
55
|
+
protected getGraphQLClient(): GraphQLClient;
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=robots-service.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"robots-service.d.ts","sourceRoot":"","sources":["../../src/site/robots-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAGxD,OAAO,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AAaxE;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,IAAI,EAAE;QAAE,QAAQ,EAAE;YAAE,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,CAAC;AAE3E;;;GAGG;AACH,qBAAa,aAAa;IAOL,OAAO,EAAE,mBAAmB;IAN/C,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACgB,OAAO,EAAE,mBAAmB;IAI/C,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;;;OAKG;IACG,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAuB/D;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAS5C"}
|
|
@@ -1,26 +1,28 @@
|
|
|
1
|
-
import { SiteInfo } from './models';
|
|
2
|
-
/**
|
|
3
|
-
* Resolves site based on the provided host or site name
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
*
|
|
14
|
-
* @
|
|
15
|
-
* @
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
*
|
|
21
|
-
* @
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
protected
|
|
26
|
-
|
|
1
|
+
import { SiteInfo } from './models';
|
|
2
|
+
/**
|
|
3
|
+
* Resolves site based on the provided host or site name
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export declare class SiteResolver {
|
|
7
|
+
readonly sites: SiteInfo[];
|
|
8
|
+
/**
|
|
9
|
+
* @param {SiteInfo[]} sites Array of sites to be used in resolution
|
|
10
|
+
*/
|
|
11
|
+
constructor(sites: SiteInfo[]);
|
|
12
|
+
/**
|
|
13
|
+
* Resolve site by host name
|
|
14
|
+
* @param {string} hostName the host name
|
|
15
|
+
* @returns {SiteInfo} the resolved site
|
|
16
|
+
* @throws {Error} if a matching site is not found
|
|
17
|
+
*/
|
|
18
|
+
getByHost: (hostName: string) => SiteInfo;
|
|
19
|
+
/**
|
|
20
|
+
* Resolve site by site name
|
|
21
|
+
* @param {string} siteName the site name
|
|
22
|
+
* @returns {SiteInfo} the resolved site or undefined if not found
|
|
23
|
+
*/
|
|
24
|
+
getByName: (siteName: string) => SiteInfo | undefined;
|
|
25
|
+
protected getHostMap: () => Map<string, SiteInfo>;
|
|
26
|
+
protected matchesPattern(hostname: string, pattern: string): boolean;
|
|
27
|
+
}
|
|
28
|
+
//# sourceMappingURL=site-resolver.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"site-resolver.d.ts","sourceRoot":"","sources":["../../src/site/site-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAKpC;;;GAGG;AACH,qBAAa,YAAY;IAIX,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE;IAHtC;;OAEG;gBACkB,KAAK,EAAE,QAAQ,EAAE;IAEtC;;;;;OAKG;IACI,SAAS,GAAI,UAAU,MAAM,KAAG,QAAQ,CAO7C;IAEF;;;;OAIG;IACI,SAAS,GAAI,UAAU,MAAM,0BAMlC;IAEF,SAAS,CAAC,UAAU,QAAO,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CA2B9C;IAEF,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO;CASrE"}
|
|
@@ -1,52 +1,65 @@
|
|
|
1
|
-
import { FetchOptions, GraphQLClient } from '../client';
|
|
2
|
-
import { CacheClient, CacheOptions } from '../cache-client';
|
|
3
|
-
import { GraphQLRequestClientFactory } from '../graphql-request-client';
|
|
4
|
-
import { SiteInfo } from './models';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
*
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
*
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
*
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
1
|
+
import { FetchOptions, GraphQLClient } from '../client';
|
|
2
|
+
import { CacheClient, CacheOptions } from '../cache-client';
|
|
3
|
+
import { GraphQLRequestClientFactory } from '../graphql-request-client';
|
|
4
|
+
import { SiteInfo } from './models';
|
|
5
|
+
/**
|
|
6
|
+
* Configuration for @see SiteInfoService instances
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export type SiteInfoServiceConfig = CacheOptions & {
|
|
10
|
+
/**
|
|
11
|
+
* common variable for all GraphQL queries
|
|
12
|
+
* it will be used for every type of query to regulate result batch size
|
|
13
|
+
* Optional. How many result items to fetch in each GraphQL call. This is needed for pagination.
|
|
14
|
+
* @default 10
|
|
15
|
+
*/
|
|
16
|
+
pageSize?: number;
|
|
17
|
+
/**
|
|
18
|
+
* A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
|
|
19
|
+
* This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
|
|
20
|
+
*/
|
|
21
|
+
clientFactory: GraphQLRequestClientFactory;
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Object model of Site Info result
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export type GraphQLSiteInfoResult = {
|
|
28
|
+
name: string;
|
|
29
|
+
hostName: string;
|
|
30
|
+
language: string;
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Service to fetch site information
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
export declare class SiteInfoService {
|
|
37
|
+
private config;
|
|
38
|
+
private graphQLClient;
|
|
39
|
+
private cache;
|
|
40
|
+
/**
|
|
41
|
+
* Creates an instance of graphQL service to retrieve site configuration list from Sitecore
|
|
42
|
+
* @param {SiteInfoServiceConfig} config instance
|
|
43
|
+
*/
|
|
44
|
+
constructor(config: SiteInfoServiceConfig);
|
|
45
|
+
/**
|
|
46
|
+
* site query is available on XM Cloud and XP 10.4+
|
|
47
|
+
*/
|
|
48
|
+
protected get siteQuery(): string;
|
|
49
|
+
fetchSiteInfo(fetchOptions?: FetchOptions): Promise<SiteInfo[]>;
|
|
50
|
+
/**
|
|
51
|
+
* Gets cache client implementation
|
|
52
|
+
* Override this method if custom cache needs to be used
|
|
53
|
+
* @returns CacheClient instance
|
|
54
|
+
*/
|
|
55
|
+
protected getCacheClient(): CacheClient<SiteInfo[]>;
|
|
56
|
+
/**
|
|
57
|
+
* Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
|
|
58
|
+
* library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
|
|
59
|
+
* want to use something else.
|
|
60
|
+
* @returns {GraphQLClient} implementation
|
|
61
|
+
*/
|
|
62
|
+
protected getGraphQLClient(): GraphQLClient;
|
|
63
|
+
private getCacheKey;
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=siteinfo-service.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"siteinfo-service.d.ts","sourceRoot":"","sources":["../../src/site/siteinfo-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAExD,OAAO,EAAE,WAAW,EAAE,YAAY,EAAqB,MAAM,iBAAiB,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAcpC;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG;IACjD;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAQF;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;GAGG;AACH,qBAAa,eAAe;IAQd,OAAO,CAAC,MAAM;IAP1B,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,KAAK,CAA0B;IAEvC;;;OAGG;gBACiB,MAAM,EAAE,qBAAqB;IAKjD;;OAEG;IACH,SAAS,KAAK,SAAS,IAAI,MAAM,CAEhC;IAEK,aAAa,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IA8BrE;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;IAOnD;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;IAU3C,OAAO,CAAC,WAAW;CAGpB"}
|
|
@@ -1,56 +1,63 @@
|
|
|
1
|
-
import { FetchOptions, GraphQLClient } from '../client';
|
|
2
|
-
import { GraphQLRequestClientFactory } from '../graphql-request-client';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
*
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
* @
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
*
|
|
45
|
-
* @param {
|
|
46
|
-
* @
|
|
47
|
-
*/
|
|
48
|
-
|
|
49
|
-
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
1
|
+
import { FetchOptions, GraphQLClient } from '../client';
|
|
2
|
+
import { GraphQLRequestClientFactory } from '../graphql-request-client';
|
|
3
|
+
/**
|
|
4
|
+
* Configuration for @see SitemapXmlService instances
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export type SitemapXmlServiceConfig = {
|
|
8
|
+
/**
|
|
9
|
+
* The Content SDK application name
|
|
10
|
+
*/
|
|
11
|
+
siteName: string;
|
|
12
|
+
/**
|
|
13
|
+
* A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
|
|
14
|
+
* This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
|
|
15
|
+
*/
|
|
16
|
+
clientFactory: GraphQLRequestClientFactory;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* The schema of data returned in response to sitemaps request
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export type SitemapQueryResult = {
|
|
23
|
+
site: {
|
|
24
|
+
siteInfo: {
|
|
25
|
+
sitemap: string[];
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Service that fetch the sitemaps data using Sitecore's GraphQL API.
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export declare class SitemapXmlService {
|
|
34
|
+
options: SitemapXmlServiceConfig;
|
|
35
|
+
private graphQLClient;
|
|
36
|
+
/**
|
|
37
|
+
* Creates an instance of graphQL sitemaps service with the provided options
|
|
38
|
+
* @param {SitemapXmlServiceConfig} options instance
|
|
39
|
+
*/
|
|
40
|
+
constructor(options: SitemapXmlServiceConfig);
|
|
41
|
+
protected get query(): string;
|
|
42
|
+
/**
|
|
43
|
+
* Fetch list of sitemaps for the site
|
|
44
|
+
* @returns {string[]} list of sitemap paths
|
|
45
|
+
* @param {FetchOptions} [fetchOptions] Options to override graphQL client details like retries and fetch implementation
|
|
46
|
+
* @throws {Error} if the siteName is empty.
|
|
47
|
+
*/
|
|
48
|
+
fetchSitemaps(fetchOptions?: FetchOptions): Promise<string[]>;
|
|
49
|
+
/**
|
|
50
|
+
* Get sitemap file path for sitemap id
|
|
51
|
+
* @param {string} id the sitemap id (can be empty for default 'sitemap.xml' file)
|
|
52
|
+
* @returns {string | undefined} the sitemap file path or undefined if one doesn't exist
|
|
53
|
+
*/
|
|
54
|
+
getSitemap(id: string): Promise<string | undefined>;
|
|
55
|
+
/**
|
|
56
|
+
* Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
|
|
57
|
+
* library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
|
|
58
|
+
* want to use something else.
|
|
59
|
+
* @returns {GraphQLClient} implementation
|
|
60
|
+
*/
|
|
61
|
+
protected getGraphQLClient(): GraphQLClient;
|
|
62
|
+
}
|
|
63
|
+
//# sourceMappingURL=sitemap-xml-service.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sitemap-xml-service.d.ts","sourceRoot":"","sources":["../../src/site/sitemap-xml-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAGxD,OAAO,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AAexE;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,aAAa,EAAE,2BAA2B,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAAE,IAAI,EAAE;QAAE,QAAQ,EAAE;YAAE,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE,CAAA;CAAE,CAAC;AAE/E;;;GAGG;AACH,qBAAa,iBAAiB;IAOT,OAAO,EAAE,uBAAuB;IANnD,OAAO,CAAC,aAAa,CAAgB;IAErC;;;OAGG;gBACgB,OAAO,EAAE,uBAAuB;IAInD,SAAS,KAAK,KAAK,IAAI,MAAM,CAE5B;IAED;;;;;OAKG;IACG,aAAa,CAAC,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAqBnE;;;;OAIG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAiBzD;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAS5C"}
|