Browse Source

docs: Add some extra docs country, regenerate docs

Michael Bromley 1 year ago
parent
commit
1bd5e8ad98
26 changed files with 4649 additions and 4258 deletions
  1. 15 7
      docs/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.md
  2. 13 13
      docs/docs/reference/core-plugins/email-plugin/email-plugin-options.md
  3. 1 0
      docs/docs/reference/core-plugins/payments-plugin/stripe-plugin.md
  4. 22 0
      docs/docs/reference/graphql-api/admin/input-types.md
  5. 9 0
      docs/docs/reference/graphql-api/admin/object-types.md
  6. 22 0
      docs/docs/reference/graphql-api/shop/input-types.md
  7. 9 0
      docs/docs/reference/graphql-api/shop/object-types.md
  8. 2 2
      docs/docs/reference/typescript-api/health-check/health-check-registry-service.md
  9. 1 1
      docs/docs/reference/typescript-api/health-check/http-health-check-strategy.md
  10. 7 1
      docs/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.md
  11. 10 10
      docs/docs/reference/typescript-api/testing/simple-graph-qlclient.md
  12. 20 0
      packages/admin-ui/src/lib/core/src/common/generated-types.ts
  13. 605 571
      packages/asset-server-plugin/e2e/graphql/generated-e2e-asset-server-plugin-types.ts
  14. 674 641
      packages/common/src/generated-shop-types.ts
  15. 20 0
      packages/common/src/generated-types.ts
  16. 20 0
      packages/core/e2e/graphql/generated-e2e-admin-types.ts
  17. 645 612
      packages/core/e2e/graphql/generated-e2e-shop-types.ts
  18. 14 0
      packages/core/src/api/schema/common/common-types.graphql
  19. 6 0
      packages/core/src/api/schema/common/region.type.graphql
  20. 605 571
      packages/elasticsearch-plugin/e2e/graphql/generated-e2e-elasticsearch-plugin-types.ts
  21. 605 571
      packages/payments-plugin/e2e/graphql/generated-admin-types.ts
  22. 645 612
      packages/payments-plugin/e2e/graphql/generated-shop-types.ts
  23. 678 645
      packages/payments-plugin/src/mollie/graphql/generated-shop-types.ts
  24. 0 0
      schema-admin.json
  25. 0 0
      schema-shop.json
  26. 1 1
      scripts/docs/generate-typescript-docs.ts

+ 15 - 7
docs/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.md

@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 
 ## ElasticsearchOptions
 ## ElasticsearchOptions
 
 
-<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="30" packageName="@vendure/elasticsearch-plugin" />
+<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="29" packageName="@vendure/elasticsearch-plugin" />
 
 
 Configuration options for the <a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>.
 Configuration options for the <a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>.
 
 
@@ -27,7 +27,8 @@ interface ElasticsearchOptions {
     indexMappingProperties?: {
     indexMappingProperties?: {
         [indexName: string]: object;
         [indexName: string]: object;
     };
     };
-    batchSize?: number;
+    reindexProductsChunkSize?: number;
+    reindexBulkOperationSizeLimit?: number;
     searchConfig?: SearchConfig;
     searchConfig?: SearchConfig;
     customProductMappings?: {
     customProductMappings?: {
         [fieldName: string]: CustomMapping<[Product, ProductVariant[], LanguageCode, Injector]>;
         [fieldName: string]: CustomMapping<[Product, ProductVariant[], LanguageCode, Injector]>;
@@ -157,11 +158,18 @@ indexMappingProperties: {
   }
   }
 }
 }
 ```
 ```
-### batchSize
+### reindexProductsChunkSize
 
 
-<MemberInfo kind="property" type={`number`} default="2000"   />
+<MemberInfo kind="property" type={`number`} default="2500"  since="2.1.7"  />
 
 
-Batch size for bulk operations (e.g. when rebuilding the indices).
+Products limit chunk size for each loop iteration when indexing products.
+### reindexBulkOperationSizeLimit
+
+<MemberInfo kind="property" type={`number`} default="3000"  since="2.1.7"  />
+
+Index operations are performed in bulk, with each bulk operation containing a number of individual
+index operations. This option sets the maximum number of operations in the memory buffer before a
+bulk operation is executed.
 ### searchConfig
 ### searchConfig
 
 
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>`}   />
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>`}   />
@@ -364,7 +372,7 @@ extend input SearchResultSortParameter {
 
 
 ## SearchConfig
 ## SearchConfig
 
 
-<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="385" packageName="@vendure/elasticsearch-plugin" />
+<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="394" packageName="@vendure/elasticsearch-plugin" />
 
 
 Configuration options for the internal Elasticsearch query which is generated when performing a search.
 Configuration options for the internal Elasticsearch query which is generated when performing a search.
 
 
@@ -645,7 +653,7 @@ searchConfig: {
 
 
 ## BoostFieldsConfig
 ## BoostFieldsConfig
 
 
-<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="670" packageName="@vendure/elasticsearch-plugin" />
+<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="679" packageName="@vendure/elasticsearch-plugin" />
 
 
 Configuration for [boosting](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#field-boost)
 Configuration for [boosting](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#field-boost)
 the scores of given fields when performing a search against a term.
 the scores of given fields when performing a search against a term.

+ 13 - 13
docs/docs/reference/core-plugins/email-plugin/email-plugin-options.md

@@ -19,11 +19,11 @@ Configuration for the EmailPlugin.
 interface EmailPluginOptions {
 interface EmailPluginOptions {
     templatePath?: string;
     templatePath?: string;
     templateLoader?: TemplateLoader;
     templateLoader?: TemplateLoader;
-    transport:
-        | EmailTransportOptions
-        | ((
-              injector?: Injector,
-              ctx?: RequestContext,
+    transport:
+        | EmailTransportOptions
+        | ((
+              injector?: Injector,
+              ctx?: RequestContext,
           ) => EmailTransportOptions | Promise<EmailTransportOptions>);
           ) => EmailTransportOptions | Promise<EmailTransportOptions>);
     handlers: Array<EmailEventHandler<string, any>>;
     handlers: Array<EmailEventHandler<string, any>>;
     globalTemplateVars?: { [key: string]: any };
     globalTemplateVars?: { [key: string]: any };
@@ -38,43 +38,43 @@ interface EmailPluginOptions {
 
 
 <MemberInfo kind="property" type={`string`}   />
 <MemberInfo kind="property" type={`string`}   />
 
 
-The path to the location of the email templates. In a default Vendure installation,
+The path to the location of the email templates. In a default Vendure installation,
 the templates are installed to `<project root>/vendure/email/templates`.
 the templates are installed to `<project root>/vendure/email/templates`.
 ### templateLoader
 ### templateLoader
 
 
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/template-loader#templateloader'>TemplateLoader</a>`}  since="2.0.0"  />
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/template-loader#templateloader'>TemplateLoader</a>`}  since="2.0.0"  />
 
 
-An optional TemplateLoader which can be used to load templates from a custom location or async service.
+An optional TemplateLoader which can be used to load templates from a custom location or async service.
 The default uses the FileBasedTemplateLoader which loads templates from `<project root>/vendure/email/templates`
 The default uses the FileBasedTemplateLoader which loads templates from `<project root>/vendure/email/templates`
 ### transport
 ### transport
 
 
-<MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>         | ((               injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,               ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,           ) =&#62; <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | Promise&#60;<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>&#62;)`}   />
+<MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>
         | ((
               injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,
               ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,
           ) =&#62; <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | Promise&#60;<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>&#62;)`}   />
 
 
 Configures how the emails are sent.
 Configures how the emails are sent.
 ### handlers
 ### handlers
 
 
 <MemberInfo kind="property" type={`Array&#60;<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;string, any&#62;&#62;`}   />
 <MemberInfo kind="property" type={`Array&#60;<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>&#60;string, any&#62;&#62;`}   />
 
 
-An array of <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>s which define which Vendure events will trigger
+An array of <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>s which define which Vendure events will trigger
 emails, and how those emails are generated.
 emails, and how those emails are generated.
 ### globalTemplateVars
 ### globalTemplateVars
 
 
 <MemberInfo kind="property" type={`{ [key: string]: any }`}   />
 <MemberInfo kind="property" type={`{ [key: string]: any }`}   />
 
 
-An object containing variables which are made available to all templates. For example,
-the storefront URL could be defined here and then used in the "email address verification"
+An object containing variables which are made available to all templates. For example,
+the storefront URL could be defined here and then used in the "email address verification"
 email.
 email.
 ### emailSender
 ### emailSender
 
 
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/email-sender#emailsender'>EmailSender</a>`} default="<a href='/reference/core-plugins/email-plugin/email-sender#nodemaileremailsender'>NodemailerEmailSender</a>"   />
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/email-sender#emailsender'>EmailSender</a>`} default="<a href='/reference/core-plugins/email-plugin/email-sender#nodemaileremailsender'>NodemailerEmailSender</a>"   />
 
 
-An optional allowed EmailSender, used to allow custom implementations of the send functionality
+An optional allowed EmailSender, used to allow custom implementations of the send functionality
 while still utilizing the existing emailPlugin functionality.
 while still utilizing the existing emailPlugin functionality.
 ### emailGenerator
 ### emailGenerator
 
 
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/email-generator#emailgenerator'>EmailGenerator</a>`} default="<a href='/reference/core-plugins/email-plugin/email-generator#handlebarsmjmlgenerator'>HandlebarsMjmlGenerator</a>"   />
 <MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/email-generator#emailgenerator'>EmailGenerator</a>`} default="<a href='/reference/core-plugins/email-plugin/email-generator#handlebarsmjmlgenerator'>HandlebarsMjmlGenerator</a>"   />
 
 
-An optional allowed EmailGenerator, used to allow custom email generation functionality to
+An optional allowed EmailGenerator, used to allow custom email generation functionality to
 better match with custom email sending functionality.
 better match with custom email sending functionality.
 
 
 
 

+ 1 - 0
docs/docs/reference/core-plugins/payments-plugin/stripe-plugin.md

@@ -243,6 +243,7 @@ export const config: VendureConfig = {
     }),
     }),
   ],
   ],
 };
 };
+```
 
 
 Note: If the `paymentIntentCreateParams` is also used and returns a `metadata` key, then the values
 Note: If the `paymentIntentCreateParams` is also used and returns a `metadata` key, then the values
 returned by both functions will be merged.
 returned by both functions will be merged.

+ 22 - 0
docs/docs/reference/graphql-api/admin/input-types.md

@@ -830,6 +830,17 @@ import MemberDescription from '@site/src/components/MemberDescription';
 ## CreateAddressInput
 ## CreateAddressInput
 
 
 <div class="graphql-code-block">
 <div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Input used to create an Address.</div>
+
+<div class="graphql-code-line top-level comment"></div>
+
+<div class="graphql-code-line top-level comment">The countryCode must correspond to a <code>code</code> property of a Country that has been defined in the</div>
+
+<div class="graphql-code-line top-level comment">Vendure server. The <code>code</code> property is typically a 2-character ISO code such as "GB", "US", "DE" etc.</div>
+
+<div class="graphql-code-line top-level comment">If an invalid code is passed, the mutation will fail.</div>
+<div class="graphql-code-line top-level comment">"""</div>
 <div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAddressInput</span>
 <div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAddressInput</span>
  &#123;</div>
  &#123;</div>
 <div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
 <div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
@@ -3971,6 +3982,17 @@ import MemberDescription from '@site/src/components/MemberDescription';
 ## UpdateAddressInput
 ## UpdateAddressInput
 
 
 <div class="graphql-code-block">
 <div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Input used to update an Address.</div>
+
+<div class="graphql-code-line top-level comment"></div>
+
+<div class="graphql-code-line top-level comment">The countryCode must correspond to a <code>code</code> property of a Country that has been defined in the</div>
+
+<div class="graphql-code-line top-level comment">Vendure server. The <code>code</code> property is typically a 2-character ISO code such as "GB", "US", "DE" etc.</div>
+
+<div class="graphql-code-line top-level comment">If an invalid code is passed, the mutation will fail.</div>
+<div class="graphql-code-line top-level comment">"""</div>
 <div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAddressInput</span>
 <div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAddressInput</span>
  &#123;</div>
  &#123;</div>
 <div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
 <div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>

+ 9 - 0
docs/docs/reference/graphql-api/admin/object-types.md

@@ -649,6 +649,15 @@ import MemberDescription from '@site/src/components/MemberDescription';
 ## Country
 ## Country
 
 
 <div class="graphql-code-block">
 <div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">A Country of the world which your shop operates in.</div>
+
+<div class="graphql-code-line top-level comment"></div>
+
+<div class="graphql-code-line top-level comment">The <code>code</code> field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as</div>
+
+<div class="graphql-code-line top-level comment">`UpdateAddressInput` and <code>CreateAddressInput</code> to specify the country.</div>
+<div class="graphql-code-line top-level comment">"""</div>
 <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Country</span>
 <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Country</span>
  &#123;</div>
  &#123;</div>
 <div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
 <div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>

+ 22 - 0
docs/docs/reference/graphql-api/shop/input-types.md

@@ -179,6 +179,17 @@ import MemberDescription from '@site/src/components/MemberDescription';
 ## CreateAddressInput
 ## CreateAddressInput
 
 
 <div class="graphql-code-block">
 <div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Input used to create an Address.</div>
+
+<div class="graphql-code-line top-level comment"></div>
+
+<div class="graphql-code-line top-level comment">The countryCode must correspond to a <code>code</code> property of a Country that has been defined in the</div>
+
+<div class="graphql-code-line top-level comment">Vendure server. The <code>code</code> property is typically a 2-character ISO code such as "GB", "US", "DE" etc.</div>
+
+<div class="graphql-code-line top-level comment">If an invalid code is passed, the mutation will fail.</div>
+<div class="graphql-code-line top-level comment">"""</div>
 <div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAddressInput</span>
 <div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAddressInput</span>
  &#123;</div>
  &#123;</div>
 <div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
 <div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
@@ -1162,6 +1173,17 @@ import MemberDescription from '@site/src/components/MemberDescription';
 ## UpdateAddressInput
 ## UpdateAddressInput
 
 
 <div class="graphql-code-block">
 <div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">Input used to update an Address.</div>
+
+<div class="graphql-code-line top-level comment"></div>
+
+<div class="graphql-code-line top-level comment">The countryCode must correspond to a <code>code</code> property of a Country that has been defined in the</div>
+
+<div class="graphql-code-line top-level comment">Vendure server. The <code>code</code> property is typically a 2-character ISO code such as "GB", "US", "DE" etc.</div>
+
+<div class="graphql-code-line top-level comment">If an invalid code is passed, the mutation will fail.</div>
+<div class="graphql-code-line top-level comment">"""</div>
 <div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAddressInput</span>
 <div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAddressInput</span>
  &#123;</div>
  &#123;</div>
 <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
 <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>

+ 9 - 0
docs/docs/reference/graphql-api/shop/object-types.md

@@ -470,6 +470,15 @@ import MemberDescription from '@site/src/components/MemberDescription';
 ## Country
 ## Country
 
 
 <div class="graphql-code-block">
 <div class="graphql-code-block">
+<div class="graphql-code-line top-level comment">"""</div>
+<div class="graphql-code-line top-level comment">A Country of the world which your shop operates in.</div>
+
+<div class="graphql-code-line top-level comment"></div>
+
+<div class="graphql-code-line top-level comment">The <code>code</code> field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as</div>
+
+<div class="graphql-code-line top-level comment">`UpdateAddressInput` and <code>CreateAddressInput</code> to specify the country.</div>
+<div class="graphql-code-line top-level comment">"""</div>
 <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Country</span>
 <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Country</span>
  &#123;</div>
  &#123;</div>
 <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
 <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>

+ 2 - 2
docs/docs/reference/typescript-api/health-check/health-check-registry-service.md

@@ -26,8 +26,8 @@ Plugins which rely on external services (web services, databases etc.) can make
 service to add a check for that dependency to the Vendure health check.
 service to add a check for that dependency to the Vendure health check.
 
 
 
 
-Since v1.6.0, the preferred way to implement a custom health check is by creating a new
-<a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> and then passing it to the `systemOptions.healthChecks` array.
+Since v1.6.0, the preferred way to implement a custom health check is by creating a new <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a>
+and then passing it to the `systemOptions.healthChecks` array.
 See the <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> docs for an example configuration.
 See the <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> docs for an example configuration.
 
 
 The alternative way to register a health check is by injecting this service directly into your
 The alternative way to register a health check is by injecting this service directly into your

+ 1 - 1
docs/docs/reference/typescript-api/health-check/http-health-check-strategy.md

@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 
 ## HttpHealthCheckStrategy
 ## HttpHealthCheckStrategy
 
 
-<GenerationInfo sourceFile="packages/core/src/health-check/http-health-check-strategy.ts" sourceLine="36" packageName="@vendure/core" />
+<GenerationInfo sourceFile="packages/core/src/health-check/http-health-check-strategy.ts" sourceLine="37" packageName="@vendure/core" />
 
 
 A <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> used to check health by pinging a url. Internally it uses
 A <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> used to check health by pinging a url. Internally it uses
 the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
 the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).

+ 7 - 1
docs/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.md

@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 
 ## PollingJobQueueStrategy
 ## PollingJobQueueStrategy
 
 
-<GenerationInfo sourceFile="packages/core/src/job-queue/polling-job-queue-strategy.ts" sourceLine="192" packageName="@vendure/core" />
+<GenerationInfo sourceFile="packages/core/src/job-queue/polling-job-queue-strategy.ts" sourceLine="224" packageName="@vendure/core" />
 
 
 This class allows easier implementation of <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> in a polling style.
 This class allows easier implementation of <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> in a polling style.
 Instead of providing <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> `start()` you should provide a `next` method.
 Instead of providing <a href='/reference/typescript-api/job-queue/job-queue-strategy#jobqueuestrategy'>JobQueueStrategy</a> `start()` you should provide a `next` method.
@@ -25,6 +25,7 @@ class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
     public pollInterval: number | ((queueName: string) => number);
     public pollInterval: number | ((queueName: string) => number);
     public setRetries: (queueName: string, job: Job) => number;
     public setRetries: (queueName: string, job: Job) => number;
     public backOffStrategy?: BackoffStrategy;
     public backOffStrategy?: BackoffStrategy;
+    protected activeQueues = new QueueNameProcessStorage<ActiveQueue<any>>();
     constructor(config?: PollingJobQueueStrategyConfig)
     constructor(config?: PollingJobQueueStrategyConfig)
     constructor(concurrency?: number, pollInterval?: number)
     constructor(concurrency?: number, pollInterval?: number)
     constructor(concurrencyOrConfig?: number | PollingJobQueueStrategyConfig, maybePollInterval?: number)
     constructor(concurrencyOrConfig?: number | PollingJobQueueStrategyConfig, maybePollInterval?: number)
@@ -62,6 +63,11 @@ class PollingJobQueueStrategy extends InjectableJobQueueStrategy {
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/job-queue/types#backoffstrategy'>BackoffStrategy</a>`}   />
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/job-queue/types#backoffstrategy'>BackoffStrategy</a>`}   />
 
 
 
 
+### activeQueues
+
+<MemberInfo kind="property" type={``}   />
+
+
 ### constructor
 ### constructor
 
 
 <MemberInfo kind="method" type={`(config?: PollingJobQueueStrategyConfig) => PollingJobQueueStrategy`}   />
 <MemberInfo kind="method" type={`(config?: PollingJobQueueStrategyConfig) => PollingJobQueueStrategy`}   />

+ 10 - 10
docs/docs/reference/typescript-api/testing/simple-graph-qlclient.md

@@ -27,10 +27,10 @@ class SimpleGraphQLClient {
     asUserWithCredentials(username: string, password: string) => ;
     asUserWithCredentials(username: string, password: string) => ;
     asSuperAdmin() => ;
     asSuperAdmin() => ;
     asAnonymousUser() => ;
     asAnonymousUser() => ;
-    fileUploadMutation(options: {
-        mutation: DocumentNode;
-        filePaths: string[];
-        mapVariables: (filePaths: string[]) => any;
+    fileUploadMutation(options: {
+        mutation: DocumentNode;
+        filePaths: string[];
+        mapVariables: (filePaths: string[]) => any;
     }) => Promise<any>;
     }) => Promise<any>;
 }
 }
 ```
 ```
@@ -66,8 +66,8 @@ Performs both query and mutation operations.
 
 
 <MemberInfo kind="method" type={`(url: string, options: RequestInit = {}) => Promise&#60;Response&#62;`}   />
 <MemberInfo kind="method" type={`(url: string, options: RequestInit = {}) => Promise&#60;Response&#62;`}   />
 
 
-Performs a raw HTTP request to the given URL, but also includes the authToken & channelToken
-headers if they have been set. Useful for testing non-GraphQL endpoints, e.g. for plugins
+Performs a raw HTTP request to the given URL, but also includes the authToken & channelToken
+headers if they have been set. Useful for testing non-GraphQL endpoints, e.g. for plugins
 which make use of REST controllers.
 which make use of REST controllers.
 ### queryStatus
 ### queryStatus
 
 
@@ -91,11 +91,11 @@ Logs in as the SuperAdmin user.
 Logs out so that the client is then treated as an anonymous user.
 Logs out so that the client is then treated as an anonymous user.
 ### fileUploadMutation
 ### fileUploadMutation
 
 
-<MemberInfo kind="method" type={`(options: {
         mutation: DocumentNode;
         filePaths: string[];
         mapVariables: (filePaths: string[]) =&#62; any;
     }) => Promise&#60;any&#62;`}   />
+<MemberInfo kind="method" type={`(options: {         mutation: DocumentNode;         filePaths: string[];         mapVariables: (filePaths: string[]) =&#62; any;     }) => Promise&#60;any&#62;`}   />
 
 
-Perform a file upload mutation.
-
-Upload spec: https://github.com/jaydenseric/graphql-multipart-request-spec
+Perform a file upload mutation.
+
+Upload spec: https://github.com/jaydenseric/graphql-multipart-request-spec
 Discussion of issue: https://github.com/jaydenseric/apollo-upload-client/issues/32
 Discussion of issue: https://github.com/jaydenseric/apollo-upload-client/issues/32
 
 
 
 

+ 20 - 0
packages/admin-ui/src/lib/core/src/common/generated-types.ts

@@ -600,6 +600,12 @@ export type CoordinateInput = {
   y: Scalars['Float']['input'];
   y: Scalars['Float']['input'];
 };
 };
 
 
+/**
+ * A Country of the world which your shop operates in.
+ *
+ * The `code` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
+ * `UpdateAddressInput` and `CreateAddressInput` to specify the country.
+ */
 export type Country = Node & Region & {
 export type Country = Node & Region & {
   __typename?: 'Country';
   __typename?: 'Country';
   code: Scalars['String']['output'];
   code: Scalars['String']['output'];
@@ -689,6 +695,13 @@ export type CouponCodeLimitError = ErrorResult & {
   message: Scalars['String']['output'];
   message: Scalars['String']['output'];
 };
 };
 
 
+/**
+ * Input used to create an Address.
+ *
+ * The countryCode must correspond to a `code` property of a Country that has been defined in the
+ * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+ * If an invalid code is passed, the mutation will fail.
+ */
 export type CreateAddressInput = {
 export type CreateAddressInput = {
   city?: InputMaybe<Scalars['String']['input']>;
   city?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;
@@ -6159,6 +6172,13 @@ export type UpdateActiveAdministratorInput = {
   password?: InputMaybe<Scalars['String']['input']>;
   password?: InputMaybe<Scalars['String']['input']>;
 };
 };
 
 
+/**
+ * Input used to update an Address.
+ *
+ * The countryCode must correspond to a `code` property of a Country that has been defined in the
+ * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+ * If an invalid code is passed, the mutation will fail.
+ */
 export type UpdateAddressInput = {
 export type UpdateAddressInput = {
   city?: InputMaybe<Scalars['String']['input']>;
   city?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;

File diff suppressed because it is too large
+ 605 - 571
packages/asset-server-plugin/e2e/graphql/generated-e2e-asset-server-plugin-types.ts


File diff suppressed because it is too large
+ 674 - 641
packages/common/src/generated-shop-types.ts


+ 20 - 0
packages/common/src/generated-types.ts

@@ -595,6 +595,12 @@ export type CoordinateInput = {
   y: Scalars['Float']['input'];
   y: Scalars['Float']['input'];
 };
 };
 
 
+/**
+ * A Country of the world which your shop operates in.
+ *
+ * The `code` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
+ * `UpdateAddressInput` and `CreateAddressInput` to specify the country.
+ */
 export type Country = Node & Region & {
 export type Country = Node & Region & {
   __typename?: 'Country';
   __typename?: 'Country';
   code: Scalars['String']['output'];
   code: Scalars['String']['output'];
@@ -684,6 +690,13 @@ export type CouponCodeLimitError = ErrorResult & {
   message: Scalars['String']['output'];
   message: Scalars['String']['output'];
 };
 };
 
 
+/**
+ * Input used to create an Address.
+ *
+ * The countryCode must correspond to a `code` property of a Country that has been defined in the
+ * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+ * If an invalid code is passed, the mutation will fail.
+ */
 export type CreateAddressInput = {
 export type CreateAddressInput = {
   city?: InputMaybe<Scalars['String']['input']>;
   city?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;
@@ -6071,6 +6084,13 @@ export type UpdateActiveAdministratorInput = {
   password?: InputMaybe<Scalars['String']['input']>;
   password?: InputMaybe<Scalars['String']['input']>;
 };
 };
 
 
+/**
+ * Input used to update an Address.
+ *
+ * The countryCode must correspond to a `code` property of a Country that has been defined in the
+ * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+ * If an invalid code is passed, the mutation will fail.
+ */
 export type UpdateAddressInput = {
 export type UpdateAddressInput = {
   city?: InputMaybe<Scalars['String']['input']>;
   city?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;
   company?: InputMaybe<Scalars['String']['input']>;

+ 20 - 0
packages/core/e2e/graphql/generated-e2e-admin-types.ts

@@ -590,6 +590,12 @@ export type CoordinateInput = {
     y: Scalars['Float']['input'];
     y: Scalars['Float']['input'];
 };
 };
 
 
+/**
+ * A Country of the world which your shop operates in.
+ *
+ * The `code` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
+ * `UpdateAddressInput` and `CreateAddressInput` to specify the country.
+ */
 export type Country = Node &
 export type Country = Node &
     Region & {
     Region & {
         code: Scalars['String']['output'];
         code: Scalars['String']['output'];
@@ -675,6 +681,13 @@ export type CouponCodeLimitError = ErrorResult & {
     message: Scalars['String']['output'];
     message: Scalars['String']['output'];
 };
 };
 
 
+/**
+ * Input used to create an Address.
+ *
+ * The countryCode must correspond to a `code` property of a Country that has been defined in the
+ * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+ * If an invalid code is passed, the mutation will fail.
+ */
 export type CreateAddressInput = {
 export type CreateAddressInput = {
     city?: InputMaybe<Scalars['String']['input']>;
     city?: InputMaybe<Scalars['String']['input']>;
     company?: InputMaybe<Scalars['String']['input']>;
     company?: InputMaybe<Scalars['String']['input']>;
@@ -5741,6 +5754,13 @@ export type UpdateActiveAdministratorInput = {
     password?: InputMaybe<Scalars['String']['input']>;
     password?: InputMaybe<Scalars['String']['input']>;
 };
 };
 
 
+/**
+ * Input used to update an Address.
+ *
+ * The countryCode must correspond to a `code` property of a Country that has been defined in the
+ * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+ * If an invalid code is passed, the mutation will fail.
+ */
 export type UpdateAddressInput = {
 export type UpdateAddressInput = {
     city?: InputMaybe<Scalars['String']['input']>;
     city?: InputMaybe<Scalars['String']['input']>;
     company?: InputMaybe<Scalars['String']['input']>;
     company?: InputMaybe<Scalars['String']['input']>;

File diff suppressed because it is too large
+ 645 - 612
packages/core/e2e/graphql/generated-e2e-shop-types.ts


+ 14 - 0
packages/core/src/api/schema/common/common-types.graphql

@@ -198,6 +198,13 @@ input CreateCustomerInput {
     emailAddress: String!
     emailAddress: String!
 }
 }
 
 
+"""
+Input used to create an Address.
+
+The countryCode must correspond to a `code` property of a Country that has been defined in the
+Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+If an invalid code is passed, the mutation will fail.
+"""
 input CreateAddressInput {
 input CreateAddressInput {
     fullName: String
     fullName: String
     company: String
     company: String
@@ -212,6 +219,13 @@ input CreateAddressInput {
     defaultBillingAddress: Boolean
     defaultBillingAddress: Boolean
 }
 }
 
 
+"""
+Input used to update an Address.
+
+The countryCode must correspond to a `code` property of a Country that has been defined in the
+Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
+If an invalid code is passed, the mutation will fail.
+"""
 input UpdateAddressInput {
 input UpdateAddressInput {
     id: ID!
     id: ID!
     fullName: String
     fullName: String

+ 6 - 0
packages/core/src/api/schema/common/region.type.graphql

@@ -20,6 +20,12 @@ type RegionTranslation {
     name: String!
     name: String!
 }
 }
 
 
+"""
+A Country of the world which your shop operates in.
+
+The `code` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
+`UpdateAddressInput` and `CreateAddressInput` to specify the country.
+"""
 type Country implements Region & Node {
 type Country implements Region & Node {
     id: ID!
     id: ID!
     createdAt: DateTime!
     createdAt: DateTime!

File diff suppressed because it is too large
+ 605 - 571
packages/elasticsearch-plugin/e2e/graphql/generated-e2e-elasticsearch-plugin-types.ts


File diff suppressed because it is too large
+ 605 - 571
packages/payments-plugin/e2e/graphql/generated-admin-types.ts


File diff suppressed because it is too large
+ 645 - 612
packages/payments-plugin/e2e/graphql/generated-shop-types.ts


File diff suppressed because it is too large
+ 678 - 645
packages/payments-plugin/src/mollie/graphql/generated-shop-types.ts


File diff suppressed because it is too large
+ 0 - 0
schema-admin.json


File diff suppressed because it is too large
+ 0 - 0
schema-shop.json


+ 1 - 1
scripts/docs/generate-typescript-docs.ts

@@ -72,7 +72,7 @@ if (watchMode) {
     sections.forEach(section => {
     sections.forEach(section => {
         section.sourceDirs.forEach(dir => {
         section.sourceDirs.forEach(dir => {
             fs.watch(dir, { recursive: true }, (eventType, file) => {
             fs.watch(dir, { recursive: true }, (eventType, file) => {
-                if (extname(file) === '.ts') {
+                if (file && extname(file) === '.ts') {
                     console.log(`Changes detected in ${dir}`);
                     console.log(`Changes detected in ${dir}`);
                     generateTypescriptDocs([section], true);
                     generateTypescriptDocs([section], true);
                 }
                 }

Some files were not shown because too many files changed in this diff