docs(all): add basic provider function docs (#3289)

Author: griest024

apps/daffio/src/app/core/assets/fetch/service.interface.ts

@@ -11,5 +11,8 @@ export interface DaffioAssetFetchServiceInterface {
 
 export const {
   token: DaffioAssetFetchService,
+  /**
+   * Provider function for {@link DaffioAssetFetchService}.
+   */
   provider: provideDaffioAssetFetchService,
 } = createSingletonInjectionToken<DaffioAssetFetchServiceInterface>('DaffioAssetFetchService', { factory: () => inject(DaffioAssetFetchBrowserService) });

apps/daffio/src/app/docs/services/docs-path.token.ts

@@ -2,5 +2,8 @@ import { createSingleInjectionToken } from '@daffodil/core';
 
 export const {
   token: DAFFIO_DOCS_PATH_TOKEN,
+  /**
+   * Provider function for {@link DAFFIO_DOCS_PATH_TOKEN}.
+   */
   provider: provideDaffioDocsPath,
 } = createSingleInjectionToken<string>('DAFFIO_DOCS_PATH_TOKEN', { factory: () => '/assets/daffio/' });

libs/analytics/src/lib/config/config.ts

@@ -25,6 +25,9 @@ export const {
    * Allows you to provide configuration to the `@daffodil/analytics` package.
    */
   token: DaffAnalyticsConfig,
+  /**
+   * Provider function for {@link DaffAnalyticsConfig}.
+   */
   provider: provideDaffAnalyticsConfig,
 } = createConfigInjectionToken(
   defaultConfig,

libs/auth/driver/src/interfaces/auth-service.interface.ts

@@ -11,5 +11,8 @@ export interface DaffAuthServiceInterface {
 
 export const {
   token: DaffAuthDriver,
+  /**
+   * Provider function for {@link DaffAuthDriver}.
+   */
   provider: provideDaffAuthDriver,
 } = createSingletonInjectionToken<DaffAuthServiceInterface>('DaffAuthDriver');

libs/auth/driver/src/interfaces/login-service.interface.ts

@@ -25,5 +25,8 @@ export interface DaffLoginServiceInterface<
 
 export const {
   token: DaffLoginDriver,
+  /**
+   * Provider function for {@link DaffLoginDriver}.
+   */
   provider: provideDaffLoginDriver,
 } = createSingletonInjectionToken<DaffLoginServiceInterface>('DaffLoginDriver');

libs/auth/driver/src/interfaces/register-service.interface.ts

@@ -25,5 +25,8 @@ export interface DaffRegisterServiceInterface<
 
 export const {
   token: DaffRegisterDriver,
+  /**
+   * Provider function for {@link DaffRegisterDriver}.
+   */
   provider: provideDaffRegisterDriver,
 } = createSingletonInjectionToken<DaffRegisterServiceInterface>('DaffRegisterDriver');

libs/auth/driver/src/interfaces/reset-password-service.interface.ts

@@ -25,5 +25,8 @@ export interface DaffResetPasswordServiceInterface<
 
 export const {
   token: DaffResetPasswordDriver,
+  /**
+   * Provider function for {@link DaffResetPasswordDriver}.
+   */
   provider: provideDaffResetPasswordDriver,
 } = createSingletonInjectionToken<DaffResetPasswordServiceInterface>('DaffResetPasswordDriver');

libs/auth/routing/src/config/token.ts

@@ -8,5 +8,8 @@ export const {
    * The token used to provide @daffodil/auth/routing config data.
    */
   token: DAFF_AUTH_ROUTING_CONFIG,
+  /**
+   * Provider function for {@link DAFF_AUTH_ROUTING_CONFIG}.
+   */
   provider: provideDaffAuthRoutingConfig,
 } = createConfigInjectionToken<DaffAuthRoutingConfig>(DAFF_AUTH_ROUTING_CONFIG_DEFAULT, 'DAFF_AUTH_ROUTING_CONFIG');

libs/auth/routing/src/guards/guest-only-guard-redirect.token.ts

@@ -2,6 +2,9 @@ import { createSingleInjectionToken } from '@daffodil/core';
 
 export const {
   token: DaffAuthGuestOnlyGuardRedirectUrl,
+  /**
+   * Provider function for {@link DaffAuthGuestOnlyGuardRedirectUrl}.
+   */
   provider: provideDaffAuthGuestOnlyGuardRedirectUrl,
 } = createSingleInjectionToken<string>(
   'DaffAuthGuestOnlyGuardRedirectUrl',

libs/auth/routing/src/guards/member-only-guard-redirect.token.ts

@@ -2,6 +2,9 @@ import { createSingleInjectionToken } from '@daffodil/core';
 
 export const {
   token: DaffAuthMemberOnlyGuardRedirectUrl,
+  /**
+   * Provider function for {@link DaffAuthMemberOnlyGuardRedirectUrl}.
+   */
   provider: provideDaffAuthMemberOnlyGuardRedirectUrl,
 } = createSingleInjectionToken<string>(
   'DaffAuthMemberOnlyGuardRedirectUrl',

libs/auth/state/src/config/token.ts

@@ -5,5 +5,8 @@ import { DaffAuthStateConfig } from './type';
 
 export const {
   token: DAFF_AUTH_STATE_CONFIG,
+  /**
+   * Provider function for {@link DAFF_AUTH_STATE_CONFIG}.
+   */
   provider: provideDaffAuthStateConfig,
 } = createConfigInjectionToken<DaffAuthStateConfig>(daffAuthStateDefaultConfig, 'DAFF_AUTH_STATE_CONFIG');

libs/auth/state/src/injection-tokens/error-matcher.token.ts

@@ -7,6 +7,9 @@ export const {
    * Can be used to further refine Daffodil errors into more specific app errors.
    */
   token: DAFF_AUTH_ERROR_MATCHER,
+  /**
+   * Provider function for {@link DAFF_AUTH_ERROR_MATCHER}.
+   */
   provider: provideDaffAuthErrorMatcher,
 } = createSingleInjectionToken<typeof daffTransformErrorToStateError>(
   'DAFF_AUTH_ERROR_MATCHER',

libs/auth/state/src/injection-tokens/unauthenticated/hook.token.ts

@@ -14,6 +14,9 @@ export const {
    * @docs-private
    */
   token: DAFF_AUTH_UNAUTHENTICATED_HOOK,
+  /**
+   * Provider function for {@link DAFF_AUTH_UNAUTHENTICATED_HOOK}.
+   */
   provider: provideDaffAuthUnauthenticatedHook,
 } = createSingleInjectionToken<DaffAuthUnauthenticatedHook>(
   'DAFF_AUTH_UNAUTHENTICATED_HOOK',

libs/auth/state/src/reducers/token/reducers.token.ts

@@ -22,6 +22,9 @@ export const {
    * @docs-private
    */
   token: DAFF_AUTH_REDUCERS,
+  /**
+   * Provider function for {@link DAFF_AUTH_REDUCERS}.
+   */
   provider: provideDaffAuthReducers,
 } = createSingleInjectionToken<ActionReducer<DaffAuthFeatureState>>(
   'DAFF_AUTH_REDUCERS',

libs/authorizenet/driver/src/interfaces/authorize-net-config.interface.ts

@@ -2,6 +2,9 @@ import { createSingleInjectionToken } from '@daffodil/core';
 
 export const {
   token: DaffAuthorizeNetConfigToken,
+  /**
+   * Provider function for {@link DaffAuthorizeNetConfigToken}.
+   */
   provider: provideDaffAuthorizeNetConfigToken,
 } = createSingleInjectionToken<DaffAuthorizeNetConfig>('DaffAuthorizeNetConfigToken');
 

libs/authorizenet/driver/src/interfaces/authorize-net-payment-id.token.ts

@@ -2,5 +2,8 @@ import { createSingleInjectionToken } from '@daffodil/core';
 
 export const {
   token: DaffAuthorizeNetPaymentId,
+  /**
+   * Provider function for {@link DaffAuthorizeNetPaymentId}.
+   */
   provider: provideDaffAuthorizeNetPaymentId,
 } = createSingleInjectionToken<string>('DaffAuthorizeNetPaymentId');

libs/authorizenet/driver/src/interfaces/authorize-net-service.interface.ts

@@ -5,6 +5,9 @@ import { createSingletonInjectionToken } from '@daffodil/core';
 
 export const {
   token: DaffAuthorizeNetDriver,
+  /**
+   * Provider function for {@link DaffAuthorizeNetDriver}.
+   */
   provider: provideDaffAuthorizeNetDriver,
 } = createSingletonInjectionToken<DaffAuthorizeNetService>('DaffAuthorizeNetDriver');
 

libs/authorizenet/driver/src/interfaces/payment-service.interface.ts

@@ -12,6 +12,9 @@ export const {
    * An injection token for the authorize.net payment driver.
    */
   token: DaffAuthorizeNetPaymentDriver,
+  /**
+   * Provider function for {@link DaffAuthorizeNetPaymentDriver}.
+   */
   provider: provideDaffAuthorizeNetPaymentDriver,
 } = createSingletonInjectionToken<DaffAuthorizeNetPaymentDriverInterface>('DaffAuthorizeNetPaymentDriver');
 

libs/authorizenet/src/services/accept-js-production.token.ts

@@ -8,6 +8,9 @@ export const {
    * By default, we assume you're using the sandbox (false).
    */
   token: DAFF_AUTHORIZENET_ACCEPT_JS_PRODUCTION,
+  /**
+   * Provider function for {@link DAFF_AUTHORIZENET_ACCEPT_JS_PRODUCTION}.
+   */
   provider: provideDaffAuthorizenetAcceptJsProduction,
 } = createSingleInjectionToken<boolean>(
   'DAFF_AUTHORIZENET_ACCEPT_JS_PRODUCTION',

libs/authorizenet/state/src/config/token.ts

@@ -5,5 +5,8 @@ import { DaffAuthorizeNetStateConfig } from './type';
 
 export const {
   token: DAFF_AUTHORIZE_NET_STATE_CONFIG,
+  /**
+   * Provider function for {@link DAFF_AUTHORIZE_NET_STATE_CONFIG}.
+   */
   provider: provideDaffAuthorizeNetStateConfig,
 } = createConfigInjectionToken<DaffAuthorizeNetStateConfig>(daffAuthorizeNetStateDefaultConfig, 'DAFF_AUTHORIZE_NET_STATE_CONFIG');

libs/authorizenet/state/src/injection-tokens/error-matcher.token.ts

@@ -7,6 +7,9 @@ import { daffTransformErrorToStateError } from '@daffodil/core/state';
  */
 export const {
   token: DAFF_AUTHORIZENET_ERROR_MATCHER,
+  /**
+   * Provider function for {@link DAFF_AUTHORIZENET_ERROR_MATCHER}.
+   */
   provider: provideDaffAuthorizenetErrorMatcher,
 } = createSingleInjectionToken<typeof daffTransformErrorToStateError>(
   'DAFF_AUTHORIZENET_ERROR_MATCHER',

libs/authorizenet/state/src/reducers/token/reducers.token.ts

@@ -20,6 +20,9 @@ export const {
    * @docs-private
    */
   token: DAFF_AUTHORIZE_NET_REDUCERS,
+  /**
+   * Provider function for {@link DAFF_AUTHORIZE_NET_REDUCERS}.
+   */
   provider: provideDaffAuthorizeNetReducers,
 } = createSingleInjectionToken<ActionReducer<DaffAuthorizeNetReducersState>>(
   'DAFF_AUTHORIZE_NET_REDUCERS',

libs/cart-customer/state/src/injection-tokens/error-matcher.token.ts

@@ -7,6 +7,9 @@ export const {
    * Can be used to further refine Daffodil errors into more specific app errors.
    */
   token: DAFF_CART_CUSTOMER_ERROR_MATCHER,
+  /**
+   * Provider function for {@link DAFF_CART_CUSTOMER_ERROR_MATCHER}.
+   */
   provider: provideDaffCartCustomerErrorMatcher,
 } = createSingleInjectionToken<typeof daffTransformErrorToStateError>(
   'DAFF_CART_CUSTOMER_ERROR_MATCHER',

libs/cart-store-credit/driver/src/interfaces/store-credit-service.interface.ts

@@ -8,6 +8,9 @@ import { createSingletonInjectionToken } from '@daffodil/core';
  */
 export const {
   token: DaffCartStoreCreditDriver,
+  /**
+   * Provider function for {@link DaffCartStoreCreditDriver}.
+   */
   provider: provideDaffCartStoreCreditDriver,
 } = createSingletonInjectionToken<DaffCartStoreCreditDriverInterface>('DaffCartStoreCreditDriver');
 

libs/cart-store-credit/state/src/injection-tokens/error-matcher.token.ts

@@ -7,6 +7,9 @@ export const {
    * Can be used to further refine Daffodil errors into more specific app errors.
    */
   token: DAFF_CART_STORE_CREDIT_ERROR_MATCHER,
+  /**
+   * Provider function for {@link DAFF_CART_STORE_CREDIT_ERROR_MATCHER}.
+   */
   provider: provideDaffCartStoreCreditErrorMatcher,
 } = createSingleInjectionToken<typeof daffTransformErrorToStateError>(
   'DAFF_CART_STORE_CREDIT_ERROR_MATCHER',

libs/cart-store-credit/state/src/reducers/token/reducers.token.ts

@@ -21,6 +21,9 @@ export const {
    * @docs-private
    */
   token: DAFF_CART_STORE_CREDIT_REDUCERS,
+  /**
+   * Provider function for {@link DAFF_CART_STORE_CREDIT_REDUCERS}.
+   */
   provider: provideDaffCartStoreCreditReducers,
 } = createSingleInjectionToken<ActionReducer<DaffCartStoreCreditReducersState>>(
   'DAFF_CART_STORE_CREDIT_REDUCERS',

libs/cart/driver/in-memory/src/injection-tokens/extra-attributes-hook.token.ts

@@ -25,6 +25,9 @@ export const {
    * and should be used with care.
    */
   token: DAFF_CART_IN_MEMORY_EXTRA_ATTRIBUTES_HOOK,
+  /**
+   * Provider function for {@link DAFF_CART_IN_MEMORY_EXTRA_ATTRIBUTES_HOOK}.
+   */
   provider: provideDaffCartInMemoryExtraAttributesHook,
 } = createSingleInjectionToken<DaffCartInMemoryExtraAttributesHook>(
   'DAFF_CART_IN_MEMORY_EXTRA_ATTRIBUTES_HOOK',

libs/cart/driver/magento/src/injection-tokens/cart-mutation-queue.token.ts

@@ -6,6 +6,9 @@ import { DaffQueuedApollo } from '@daffodil/core/graphql';
 
 export const {
   token: DAFF_MAGENTO_CART_MUTATION_QUEUE,
+  /**
+   * Provider function for {@link DAFF_MAGENTO_CART_MUTATION_QUEUE}.
+   */
   provider: provideDaffCartMagentoMutationQueue,
 } = createSingleInjectionToken<DaffQueuedApollo>(
   'DAFF_MAGENTO_CART_MUTATION_QUEUE', {

libs/cart/driver/magento/src/injection-tokens/fragments/cart.ts

@@ -16,5 +16,8 @@ export const {
    * to accommodate the extra complexity contributed by the provided fragments.
    */
   token: DAFF_CART_MAGENTO_EXTRA_CART_FRAGMENTS,
+  /**
+   * Provider function for {@link DAFF_CART_MAGENTO_EXTRA_CART_FRAGMENTS}.
+   */
   provider: provideDaffCartMagentoExtraCartFragments,
 } = createMultiInjectionToken<DocumentNode>('DAFF_CART_MAGENTO_EXTRA_CART_FRAGMENTS');

libs/cart/driver/src/interfaces/cart-address-service.interface.ts

@@ -18,5 +18,8 @@ export interface DaffCartAddressServiceInterface<T extends DaffCart = DaffCart>
 
 export const {
   token: DaffCartAddressDriver,
+  /**
+   * Provider function for {@link DaffCartAddressDriver}.
+   */
   provider: provideDaffCartAddressDriver,
 } = createSingletonInjectionToken<DaffCartAddressServiceInterface>('DaffCartAddressDriver');

libs/cart/driver/src/interfaces/cart-billing-address-service.interface.ts

@@ -23,5 +23,8 @@ export interface DaffCartBillingAddressServiceInterface<T extends DaffCart = Daf
 
 export const {
   token: DaffCartBillingAddressDriver,
+  /**
+   * Provider function for {@link DaffCartBillingAddressDriver}.
+   */
   provider: provideDaffCartBillingAddressDriver,
 } = createSingletonInjectionToken<DaffCartBillingAddressServiceInterface>('DaffCartBillingAddressDriver');

libs/cart/driver/src/interfaces/cart-coupon-service.interface.ts

@@ -33,5 +33,8 @@ export interface DaffCartCouponServiceInterface<T extends DaffCart = DaffCart> {
 
 export const {
   token: DaffCartCouponDriver,
+  /**
+   * Provider function for {@link DaffCartCouponDriver}.
+   */
   provider: provideDaffCartCouponDriver,
 } = createSingletonInjectionToken<DaffCartCouponServiceInterface>('DaffCartCouponDriver');

libs/cart/driver/src/interfaces/cart-item-service.interface.ts

@@ -46,5 +46,8 @@ export interface DaffCartItemServiceInterface<
 
 export const {
   token: DaffCartItemDriver,
+  /**
+   * Provider function for {@link DaffCartItemDriver}.
+   */
   provider: provideDaffCartItemDriver,
 } = createSingletonInjectionToken<DaffCartItemServiceInterface>('DaffCartItemDriver');

libs/cart/driver/src/interfaces/cart-order-service.interface.ts

@@ -21,5 +21,8 @@ export interface DaffCartOrderServiceInterface<
 
 export const {
   token: DaffCartOrderDriver,
+  /**
+   * Provider function for {@link DaffCartOrderDriver}.
+   */
   provider: provideDaffCartOrderDriver,
 } = createSingletonInjectionToken<DaffCartOrderServiceInterface>('DaffCartOrderDriver');

libs/cart/driver/src/interfaces/cart-payment-methods-service.interface.ts

@@ -18,5 +18,8 @@ export interface DaffCartPaymentMethodsServiceInterface<T extends DaffCartPaymen
 
 export const {
   token: DaffCartPaymentMethodsDriver,
+  /**
+   * Provider function for {@link DaffCartPaymentMethodsDriver}.
+   */
   provider: provideDaffCartPaymentMethodsDriver,
 } = createSingletonInjectionToken<DaffCartPaymentMethodsServiceInterface>('DaffCartPaymentMethodsDriver');

libs/cart/driver/src/interfaces/cart-payment-service.interface.ts

@@ -38,5 +38,8 @@ export interface DaffCartPaymentServiceInterface<T extends DaffCart = DaffCart>
 
 export const {
   token: DaffCartPaymentDriver,
+  /**
+   * Provider function for {@link DaffCartPaymentDriver}.
+   */
   provider: provideDaffCartPaymentDriver,
 } = createSingletonInjectionToken<DaffCartPaymentServiceInterface>('DaffCartPaymentDriver');

libs/cart/driver/src/interfaces/cart-service.interface.ts

@@ -39,5 +39,8 @@ export interface DaffCartServiceInterface<T extends DaffCart = DaffCart> {
 
 export const {
   token: DaffCartDriver,
+  /**
+   * Provider function for {@link DaffCartDriver}.
+   */
   provider: provideDaffCartDriver,
 } = createSingletonInjectionToken<DaffCartServiceInterface>('DaffCartDriver');

libs/cart/driver/src/interfaces/cart-shipping-address-service.interface.ts

@@ -23,5 +23,8 @@ export interface DaffCartShippingAddressServiceInterface<T extends DaffCart = Da
 
 export const {
   token: DaffCartShippingAddressDriver,
+  /**
+   * Provider function for {@link DaffCartShippingAddressDriver}.
+   */
   provider: provideDaffCartShippingAddressDriver,
 } = createSingletonInjectionToken<DaffCartShippingAddressServiceInterface>('DaffCartShippingAddressDriver');

libs/cart/driver/src/interfaces/cart-shipping-information-service.interface.ts

@@ -29,5 +29,8 @@ export interface DaffCartShippingInformationServiceInterface<T extends DaffCart
 
 export const {
   token: DaffCartShippingInformationDriver,
+  /**
+   * Provider function for {@link DaffCartShippingInformationDriver}.
+   */
   provider: provideDaffCartShippingInformationDriver,
 } = createSingletonInjectionToken<DaffCartShippingInformationServiceInterface>('DaffCartShippingInformationDriver');

libs/cart/driver/src/interfaces/cart-shipping-methods-service.interface.ts

@@ -20,5 +20,8 @@ export interface DaffCartShippingMethodsServiceInterface<
 
 export const {
   token: DaffCartShippingMethodsDriver,
+  /**
+   * Provider function for {@link DaffCartShippingMethodsDriver}.
+   */
   provider: provideDaffCartShippingMethodsDriver,
 } = createSingletonInjectionToken<DaffCartShippingMethodsServiceInterface>('DaffCartShippingMethodsDriver');

libs/cart/routing/src/config/config.ts

@@ -27,5 +27,8 @@ export const daffCartRoutingConfigurationDefault: DaffCartRoutingConfiguration =
  */
 export const {
   token: DAFF_CART_ROUTING_CONFIG,
+  /**
+   * Provider function for {@link DAFF_CART_ROUTING_CONFIG}.
+   */
   provider: provideDaffCartRoutingConfig,
 } = createConfigInjectionToken<DaffCartRoutingConfiguration>(daffCartRoutingConfigurationDefault, 'DAFF_CART_ROUTING_CONFIG');

libs/cart/routing/src/guards/billing-address/billing-address-guard-redirect.token.ts

@@ -2,5 +2,8 @@ import { createSingleInjectionToken } from '@daffodil/core';
 
 export const {
   token: DaffCartBillingAddressGuardRedirectUrl,
+  /**
+   * Provider function for {@link DaffCartBillingAddressGuardRedirectUrl}.
+   */
   provider: provideDaffCartBillingAddressGuardRedirectUrl,
 } = createSingleInjectionToken<string>('DaffCartBillingAddressGuardRedirectUrl', { factory: () => '/' });