@daffodil/external-router 0.88.1 → 0.90.0

package/driver/magento/model/product-route.d.ts

@@ -1,85 +0,0 @@
-export interface MagentoProductRoute {
-    /**
-     * The relative path for the route.
-     */
-    relative_url: string;
-    /**
-     * The type of route, typically PRODUCT, CATEGORY or CMS_PAGE
-     */
-    type: 'PRODUCT';
-    /**
-     * The HTTP code for the page.
-     */
-    redirect_code: number;
-    /**
-     * In v2.4.3 this became the standard field across types
-     */
-    uid: string;
-    /**
-     * The canonical url of the route.
-     */
-    canonical_url: string | null;
-    /**
-     * The meta description of the route
-     */
-    meta_description: string | null;
-    /**
-     * The name of the route
-     */
-    name: string;
-    /**
-     * The title of the route
-     */
-    meta_title: string | null;
-    /**
-     * The sku of a product.
-     */
-    sku: string;
-    /**
-     * The number of reviews of a product.
-     */
-    review_count: number | null;
-    /**
-     * The rating of a product.
-     */
-    rating_summary: number | null;
-    /**
-     * The images of a product.
-     */
-    image?: {
-        url: string;
-    };
-    /**
-     * The type of route.
-     */
-    __typename: string;
-    /**
-     * The price of the item.
-     */
-    price_range: {
-        maximum_price: {
-            final_price: {
-                currency: string;
-                value: number;
-            };
-            regular_price: {
-                currency: string;
-                value: number;
-            };
-        };
-        minimum_price: {
-            final_price: {
-                currency: string;
-                value: number;
-            };
-            regular_price: {
-                currency: string;
-                value: number;
-            };
-        };
-    };
-    /**
-     * The stock status of a product.
-     */
-    stock_status: 'IN_STOCK' | 'OUT_OF_STOCK';
-}

package/driver/magento/model/public_api.d.ts

@@ -1,8 +0,0 @@
-export { MagentoUrlResolver } from './url-resolver';
-export { MagentoUrlRewriteEntityTypeEnum } from './resolution-types';
-export { MagentoUrlResolverResponse } from './url-resolver-response';
-export { MagentoRoute } from './route';
-export { MagentoRouteResponse } from './route-response';
-export { MagentoProductRoute } from './product-route';
-export { MagentoCategoryRoute } from './category-route';
-export { MagentoCmsPageRoute } from './page-route.type';

package/driver/magento/model/resolution-types.d.ts

@@ -1,5 +0,0 @@
-export declare enum MagentoUrlRewriteEntityTypeEnum {
-    PRODUCT = "PRODUCT",
-    CATEGORY = "CATEGORY",
-    CMS_PAGE = "CMS_PAGE"
-}

package/driver/magento/model/routable.d.ts

@@ -1,14 +0,0 @@
-export interface MagentoRoutable {
-    /**
-     * The relative path for the route.
-     */
-    relative_url: string;
-    /**
-     * The type of route, typically PRODUCT, CATEGORY or CMS_PAGE
-     */
-    type: 'UNKNOWN' | null;
-    /**
-     * The HTTP code for the page.
-     */
-    redirect_code: number;
-}

package/driver/magento/model/route-response.d.ts

@@ -1,4 +0,0 @@
-import { MagentoRoute } from './route';
-export interface MagentoRouteResponse {
-    route: MagentoRoute;
-}

package/driver/magento/model/route.d.ts

@@ -1,5 +0,0 @@
-import { MagentoCategoryRoute } from './category-route';
-import { MagentoCmsPageRoute } from './page-route.type';
-import { MagentoProductRoute } from './product-route';
-import { MagentoRoutable } from './routable';
-export type MagentoRoute = MagentoRoutable | MagentoProductRoute | MagentoCategoryRoute | MagentoCmsPageRoute;

package/driver/magento/model/url-resolver-response.d.ts

@@ -1,4 +0,0 @@
-import { MagentoUrlResolver } from './url-resolver';
-export interface MagentoUrlResolverResponse {
-    urlResolver: MagentoUrlResolver;
-}

package/driver/magento/model/url-resolver.d.ts

@@ -1,13 +0,0 @@
-export interface MagentoUrlResolver {
-    relative_url: string;
-    type: string;
-    redirectCode: number;
-    /**
-     * In v2.4.2 this became the standard id field
-     */
-    entity_uid?: string;
-    /**
-     * The original id field from Magento
-     */
-    id?: number;
-}

package/driver/magento/public_api.d.ts

@@ -1,2 +0,0 @@
-export * from './model/public_api';
-export * from './transforms/public_api';

package/driver/magento/transforms/public_api.d.ts

@@ -1 +0,0 @@
-export { magentoTransformRedirectToHttpCode } from './redirect-to-http';

package/driver/magento/transforms/redirect-to-http.d.ts

@@ -1,4 +0,0 @@
-/**
- * Transforms a Magento redirect code to the appropriate HTTP status code.
- */
-export declare const magentoTransformRedirectToHttpCode: (code: number) => number;

package/driver/not-found-resolution.d.ts

@@ -1,8 +0,0 @@
-import { DaffExternallyResolvableUrl } from '@daffodil/external-router';
-/**
- * When a driver fails to find a resolution, it should return a 404.
- * This const represents the standard "Not Found" resolution that a driver
- * should return. Drivers are not required to return this value, but may do so
- * if they would like.
- */
-export declare const DAFF_EXTERNAL_ROUTER_NOT_FOUND_RESOLUTION: DaffExternallyResolvableUrl;

package/driver/public_api.d.ts

@@ -1,2 +0,0 @@
-export { DaffExternalRouterDriverInterface, DaffExternalRouterDriver, provideDaffExternalRouterDriver, } from './interfaces/external-router-driver.interface';
-export { DAFF_EXTERNAL_ROUTER_NOT_FOUND_RESOLUTION } from './not-found-resolution';

package/driver/testing/config.d.ts

@@ -1,10 +0,0 @@
-import { DaffExternallyResolvableUrl, DaffExternalRouteType } from '@daffodil/external-router';
-/**
- * The configuration for the testing driver. It is a dictionary of "url": "type",
- * pairs, where the URL is a URL-safe routeable path, e.g. "sweatshirts" or "t-shirts"
- * and the type is a known type to your application, e.g. "CATEGORY".
- */
-export interface DaffExternalRouterDriverTestingConfig {
-    [url: string]: DaffExternalRouteType | DaffExternallyResolvableUrl;
-}
-export declare const DAFF_EXTERNAL_ROUTER_DRIVER_TESTING_CONFIG: import("@angular/core").InjectionToken<DaffExternalRouterDriverTestingConfig>, provideDaffExternalRouterDriverTestingConfig: <R extends DaffExternalRouterDriverTestingConfig = DaffExternalRouterDriverTestingConfig>(config: Partial<R> | import("@angular/core").InjectionToken<Partial<R>>) => import("@angular/core").FactoryProvider;

package/driver/testing/provider.d.ts

@@ -1,6 +0,0 @@
-import { EnvironmentProviders, InjectionToken } from '@angular/core';
-import { DaffExternalRouterDriverTestingConfig } from './config';
-/**
- * Provides a testing implementation of {@link DaffExternalRouterDriver}
- */
-export declare const provideDaffExternalRouterTestingDriver: (config: DaffExternalRouterDriverTestingConfig | InjectionToken<DaffExternalRouterDriverTestingConfig>) => EnvironmentProviders;

package/driver/testing/public_api.d.ts

@@ -1,4 +0,0 @@
-export { DaffExternalRouterTestingDriver } from './testing.service';
-export { DaffExternalRouterDriverTestingModule } from './testing.module';
-export { DaffExternalRouterDriverTestingConfig } from './config';
-export { provideDaffExternalRouterTestingDriver } from './provider';

package/driver/testing/testing.module.d.ts

@@ -1,14 +0,0 @@
-import { ModuleWithProviders } from '@angular/core';
-import { DaffExternalRouterDriverTestingConfig } from './config';
-import * as i0 from "@angular/core";
-import * as i1 from "@angular/common";
-/**
- * The `DaffExternalRouterDriverTestingModule` is an importable NgModule that can
- * be used to configure the {@link DaffExternalRouterTestingDriver}.
- */
-export declare class DaffExternalRouterDriverTestingModule {
-    static forRoot(config: DaffExternalRouterDriverTestingConfig): ModuleWithProviders<DaffExternalRouterDriverTestingModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DaffExternalRouterDriverTestingModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<DaffExternalRouterDriverTestingModule, never, [typeof i1.CommonModule], never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<DaffExternalRouterDriverTestingModule>;
-}

package/driver/testing/testing.service.d.ts

@@ -1,20 +0,0 @@
-import { Observable } from 'rxjs';
-import { DaffExternallyResolvableUrl } from '@daffodil/external-router';
-import { DaffExternalRouterDriverInterface } from '@daffodil/external-router/driver';
-import { DaffExternalRouterDriverTestingConfig } from './config';
-import * as i0 from "@angular/core";
-/**
- * The DaffExternalRouterTestingDriver is responsible for translating an
- * arbitrary URI into a DaffExternallyResolvableUrl in testing environments.
- *
- * @inheritdoc
- *
- * @see {@link DaffExternalRouterTestingDriver}
- */
-export declare class DaffExternalRouterTestingDriver implements DaffExternalRouterDriverInterface {
-    private testingConfiguration;
-    constructor(testingConfiguration?: DaffExternalRouterDriverTestingConfig);
-    resolve(url: string): Observable<DaffExternallyResolvableUrl>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DaffExternalRouterTestingDriver, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DaffExternalRouterTestingDriver>;
-}

package/model/public_api.d.ts

@@ -1,4 +0,0 @@
-export { DaffExternallyResolvableUrl } from './resolvable-route';
-export { DaffRouteData } from './route-data';
-export { DaffExternalRouteType } from './route-type';
-export { DaffRouteWithSeoData } from './route-with-seo-data';

package/model/resolvable-route.d.ts

@@ -1,39 +0,0 @@
-import { DaffIdentifiable } from '@daffodil/core';
-import { DaffRouteData } from './route-data';
-import { DaffExternalRouteType } from './route-type';
-/**
- * A `DaffExternallyResolvableUrl` describes the relationship between a "type" of route
- * as determined by an external platform and a URI.
- *
- * @example
- * ```ts
- * export const resolvableRoute: DaffExternallyResolvableUrl = {
- *  id: "id-of-resource",
- * 	url: "some/path/to-a-resource",
- * 	type: "RESOURCE_TYPE"
- * }
- * ```
- */
-export interface DaffExternallyResolvableUrl extends DaffIdentifiable {
-    /**
-     * The URL that will be used for the path of the route inserted
-     * into the Angular routing config.
-     * Should not contain URL fragments, query parameters, or leading slashes.
-     */
-    url: string;
-    /**
-     * The type of the route
-     *
-     * @see {@link DaffExternalRouteType}
-     */
-    type: DaffExternalRouteType;
-    /**
-     * The HTTP status code for the resolvable route.
-     */
-    code: number;
-    /**
-     * Additional route data. Note that this is not guaranteed to come from
-     * the driver, its only available when the driver makes it available.
-     */
-    data?: DaffRouteData;
-}

package/model/route-data.d.ts

@@ -1,21 +0,0 @@
-/**
- * Data associated with a route.
- */
-export interface DaffRouteData {
-    /**
-     * The canonical url of the route.
-     */
-    canonical_url?: string;
-    /**
-     * The meta description of the route.
-     */
-    meta_description?: string;
-    /**
-     * The title of the route.
-     */
-    title?: string;
-    /**
-     * An associated schema for the route.  See {@link Schema} for full capabilities.
-     */
-    schema?: Record<string, unknown>;
-}

package/model/route-type.d.ts

@@ -1,6 +0,0 @@
-/**
- * The routing type of a particular route. E.g. if there's a category
- * called "Sweatshirts" with an externally resolved URL of "/sweatshirts"
- * Then, this type could be something like "CATEGORY".
- */
-export type DaffExternalRouteType = string;

package/model/route-with-seo-data.d.ts

@@ -1,11 +0,0 @@
-import { Route } from '@angular/router';
-import { DaffRouteData } from './route-data';
-/**
- * A type that describes the special data that Daffodil will store for SEO purposes on
- * an external resolved route.
- */
-export type DaffRouteWithSeoData = Route & {
-    data: Record<string, any> & {
-        daffSeoData: DaffRouteData;
-    };
-};

package/provide-external-router.d.ts

@@ -1,3 +0,0 @@
-import { EnvironmentProviders } from '@angular/core';
-import { DaffExternalRouterConfiguration } from './config';
-export declare const provideExternalRouter: (config?: Partial<DaffExternalRouterConfiguration>) => EnvironmentProviders;

package/public_api.d.ts

@@ -1,3 +0,0 @@
-export { DAFF_EXTERNAL_ROUTER_CONFIG, DaffExternalRouterConfiguration, } from './config';
-export * from './model/public_api';
-export { provideExternalRouter } from './provide-external-router';

package/routing/errors/client-error.d.ts

@@ -1,8 +0,0 @@
-import { DaffError, DaffInheritableError } from '@daffodil/core';
-/**
- * An error thrown when the driver encounters a 4xx error.
- */
-export declare class DaffExternalRouterClientError extends DaffInheritableError implements DaffError {
-    readonly code: string;
-    constructor(message?: string);
-}

package/routing/errors/not-found-error.d.ts

@@ -1,9 +0,0 @@
-import { DaffError } from '@daffodil/core';
-import { DaffExternalRouterClientError } from './client-error';
-/**
- * An error thrown when the driver determines that a given url is not resolvable.
- */
-export declare class DaffExternalRouterNotFoundError extends DaffExternalRouterClientError implements DaffError {
-    readonly code: string;
-    constructor(message?: string);
-}

package/routing/errors/permanent-redirect.d.ts

@@ -1,10 +0,0 @@
-import { DaffError, DaffInheritableError } from '@daffodil/core';
-/**
- * An error thrown when the driver determines that the url needs to be routed somewhere
- * else permanently.
- */
-export declare class DaffExternalRouterPermanentRedirectError extends DaffInheritableError implements DaffError {
-    redirectUrl: string;
-    readonly code: string;
-    constructor(redirectUrl: string, message?: string);
-}

package/routing/errors/server-error.d.ts

@@ -1,8 +0,0 @@
-import { DaffError, DaffInheritableError } from '@daffodil/core';
-/**
- * An error thrown when the platform performing url resolution fails.
- */
-export declare class DaffExternalRouterServerError extends DaffInheritableError implements DaffError {
-    readonly code: string;
-    constructor(message?: string);
-}

package/routing/errors/temporary-redirect.d.ts

@@ -1,10 +0,0 @@
-import { DaffError, DaffInheritableError } from '@daffodil/core';
-/**
- * An error thrown when the driver needs a URI to be temporarily redirected
- * to another location.
- */
-export declare class DaffExternalRouterTemporaryRedirectError extends DaffInheritableError implements DaffError {
-    redirectUrl: string;
-    readonly code: string;
-    constructor(redirectUrl: string, message?: string);
-}

package/routing/guard/external-matcher-type.guard.d.ts

@@ -1,10 +0,0 @@
-import { UrlSegment, UrlTree } from '@angular/router';
-import { Observable } from 'rxjs';
-import { DaffRouteWithSeoData } from '@daffodil/external-router';
-/**
- * A `canMatch` guard function that will resolve a route externally, allowing Angular to match it.
- *
- * Depending on the resolution result, the route's data will contain `daffSeoData` with supplemental search engine data
- * about the route. The data on the route is cumulative. If other data properties are set, they will be merged alongside daffSeoData.
- */
-export declare const daffExternalMatcherTypeGuard: (type: string) => (route: DaffRouteWithSeoData, segments: Array<UrlSegment>) => Observable<boolean | UrlTree>;

package/routing/helper/convert-to-path.d.ts

@@ -1,7 +0,0 @@
-import { UrlSegment } from '@angular/router';
-/**
- * Converts a UrlSegment into its complete Url.
- *
- * @docs-private
- */
-export declare const daffConvertToPath: (segments: UrlSegment[]) => string;

package/routing/processors/process-errors.d.ts

@@ -1,6 +0,0 @@
-import { DaffExternallyResolvableUrl } from '@daffodil/external-router';
-/**
- * Processes resolved URLs and throws the appropriate error so that External Router
- * can handle routing errors.
- */
-export declare const processErrors: (url: DaffExternallyResolvableUrl) => DaffExternallyResolvableUrl;

package/routing/processors/process-redirect.d.ts

@@ -1,6 +0,0 @@
-import { DaffExternallyResolvableUrl } from '@daffodil/external-router';
-/**
- * Processes resolvedUrls and throws the appropriate error so that External Router
- * can handle redirects.
- */
-export declare const processRedirects: (url: DaffExternallyResolvableUrl) => DaffExternallyResolvableUrl;

package/routing/public_api.d.ts

@@ -1 +0,0 @@
-export { daffExternalMatcherTypeGuard } from './guard/external-matcher-type.guard';