From 7e2977b659e6867ae15bc56a99dc6b07d086c4ce Mon Sep 17 00:00:00 2001 From: matyasjay Date: Wed, 21 Feb 2024 15:59:28 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20onebeyon?= =?UTF-8?q?d/agnostic-cms-harmonizer@38e562615fe28a1e4580456fe0d5d37f10d70?= =?UTF-8?q?0df=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../cms_contentful.HarmonizerContentfulClient.html | 14 +++++++------- classes/index.AgnosticCMSHarmonizerClient.html | 8 ++++---- ...stract.AbstractAgnosticCMSHarmonizerClient.html | 14 +++++++------- modules/_types_client.html | 2 +- modules/_types_output.html | 2 +- modules/cms_contentful.html | 2 +- modules/index.html | 2 +- modules/index_abstract.html | 2 +- types/_types_client.ClientParams.html | 2 +- types/_types_client.CmsClientInstance.html | 2 +- types/_types_output.HarmonizedOutput.html | 2 +- types/cms_contentful.ContentfulEntry.html | 2 +- types/cms_contentful.ContentfulEntrySkeleton.html | 2 +- types/cms_contentful.ContentfulGetEntryParams.html | 2 +- types/index_abstract.AbstractGetEntryParams.html | 2 +- 15 files changed, 30 insertions(+), 30 deletions(-) diff --git a/classes/cms_contentful.HarmonizerContentfulClient.html b/classes/cms_contentful.HarmonizerContentfulClient.html index 4019579..d1ef1aa 100644 --- a/classes/cms_contentful.HarmonizerContentfulClient.html +++ b/classes/cms_contentful.HarmonizerContentfulClient.html @@ -1,5 +1,5 @@ HarmonizerContentfulClient | @onebeyond/agnostic-cms-harmonizer

Class HarmonizerContentfulClient

Contentful provider.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

clientInstance clientParams

Methods

agnosticCmsInitialize @@ -11,12 +11,12 @@ initialize mapper parserHandler -

Constructors

constructor

Properties

Protected clientInstance

clientInstance: ContentfulClientApi<undefined>

Protected clientParams

clientParams: CreateClientParams

Methods

Protected agnosticCmsInitialize

  • agnosticCmsInitialize<T>(handler): Promise<T>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    +

Constructors

constructor

Properties

Protected clientInstance

clientInstance: ContentfulClientApi<undefined>

Protected clientParams

clientParams: CreateClientParams

Methods

Protected agnosticCmsInitialize

  • agnosticCmsInitialize<T>(handler): Promise<T>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    Type Parameters

    • T = unknown

    Parameters

    • handler: (() => T)

      a function usually executing the native provider library initialize way

        • (): T

        • Returns T

    Returns Promise<T>

    The handler generated output

    Throws

    An error with a minimal description, followed by the unmodified error of the provided function

    -

Protected execParser

Protected getClientInstance

getEntry

Protected execParser

Protected getClientInstance

getEntry

  • getEntry<T>(params): Promise<HarmonizedOutput<T>>

  • Returns the typed harmonizer response from an entry request.

    Type Parameters

    • T = Record<string, unknown>

    Parameters

    Returns Promise<HarmonizedOutput<T>>

    Remarks

    By providing the entryId parameter, you can fetch the data for a specific Contentful entry. Additionally, you can optionally specify the locale and nestedLevels parameters. The nestedLevels parameter determines the depth of reference resolution in the @@ -24,10 +24,10 @@ by using a type argument.

    Example

    type MyEntry = {
     title: string;
     description: string;
    }

    const client = await (new HarmonizerContentfulClient({...})).initialize();
    const entry = await client.getEntry<MyEntry>({ entryId: '123', locale: 'en-US' });
    console.log(entry); // { data: { title: 'My title', description: 'My description' } }
    -

Private getEntryHandler

Protected getEntryHarmonized

Private getEntryHandler

Protected getEntryHarmonized

  • getEntryHarmonized<T>(getEntryHandler, parserHandler): Promise<HarmonizedOutput<T>>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    Type Parameters

    • T = Record<string, unknown>

    Parameters

    • getEntryHandler: (() => Promise<T>)

      a function usually executing the native provider library initialize way

        • (): Promise<T>

        • Returns Promise<T>

    • parserHandler: ((data) => HarmonizedOutput<T>)

      again, an exclusive function to parse the obtained entry data, since each provider returns the entries with a different format

    Returns Promise<HarmonizedOutput<T>>

    The entry data formatted with the generic output format. Otherwise an error would have occurred

    -

initialize

Private mapper

Private parserHandler

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

initialize

Private mapper

Private parserHandler

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index.AgnosticCMSHarmonizerClient.html b/classes/index.AgnosticCMSHarmonizerClient.html index e6fb53a..cdc34c4 100644 --- a/classes/index.AgnosticCMSHarmonizerClient.html +++ b/classes/index.AgnosticCMSHarmonizerClient.html @@ -1,6 +1,6 @@ AgnosticCMSHarmonizerClient | @onebeyond/agnostic-cms-harmonizer

Class AgnosticCMSHarmonizerClient

The agnositic client abstraction class.

Any CMS provider must extend this class to propagate its agnostic interface.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

clientInstance clientParams

Methods

agnosticCmsInitialize @@ -8,13 +8,13 @@ getEntryHarmonized

Constructors

constructor

  • new AgnosticCMSHarmonizerClient(clientParams): AgnosticCMSHarmonizerClient

  • Creates an instance of AgnosticCMSHarmonizerClient.

    Parameters

    • clientParams: CreateClientParams

      custom type that implements multiple CMS providers client initialize type definitions without any restrictions

      -

    Returns AgnosticCMSHarmonizerClient

Properties

Protected clientInstance

clientInstance: CmsClientInstance

Protected clientParams

clientParams: CreateClientParams

Methods

Protected agnosticCmsInitialize

  • agnosticCmsInitialize<T>(handler): Promise<T>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    +

Returns AgnosticCMSHarmonizerClient

Properties

Protected clientInstance

clientInstance: CmsClientInstance

Protected clientParams

clientParams: CreateClientParams

Methods

Protected agnosticCmsInitialize

  • agnosticCmsInitialize<T>(handler): Promise<T>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    Type Parameters

    • T = unknown

    Parameters

    • handler: (() => T)

      a function usually executing the native provider library initialize way

        • (): T

        • Returns T

    Returns Promise<T>

    The handler generated output

    Throws

    An error with a minimal description, followed by the unmodified error of the provided function

    -

Protected execParser

  • execParser<T>(handler, data): Promise<T>

  • Type Parameters

    • T = unknown

    Parameters

    • handler: ((data) => Promise<T>)
        • (data): Promise<T>

        • Parameters

          • data: T

          Returns Promise<T>

    • data: T

    Returns Promise<T>

Protected getEntryHarmonized

  • getEntryHarmonized<T>(getEntryHandler, parserHandler): Promise<HarmonizedOutput<T>>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    +

Protected execParser

  • execParser<T>(handler, data): Promise<T>

  • Type Parameters

    • T = unknown

    Parameters

    • handler: ((data) => Promise<T>)
        • (data): Promise<T>

        • Parameters

          • data: T

          Returns Promise<T>

    • data: T

    Returns Promise<T>

Protected getEntryHarmonized

  • getEntryHarmonized<T>(getEntryHandler, parserHandler): Promise<HarmonizedOutput<T>>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    Type Parameters

    • T = Record<string, unknown>

    Parameters

    • getEntryHandler: (() => Promise<T>)

      a function usually executing the native provider library initialize way

        • (): Promise<T>

        • Returns Promise<T>

    • parserHandler: ((data) => HarmonizedOutput<T>)

      again, an exclusive function to parse the obtained entry data, since each provider returns the entries with a different format

    Returns Promise<HarmonizedOutput<T>>

    The entry data formatted with the generic output format. Otherwise an error would have occurred

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/index_abstract.AbstractAgnosticCMSHarmonizerClient.html b/classes/index_abstract.AbstractAgnosticCMSHarmonizerClient.html index 542f742..992e584 100644 --- a/classes/index_abstract.AbstractAgnosticCMSHarmonizerClient.html +++ b/classes/index_abstract.AbstractAgnosticCMSHarmonizerClient.html @@ -1,5 +1,5 @@ AbstractAgnosticCMSHarmonizerClient | @onebeyond/agnostic-cms-harmonizer

Class AbstractAgnosticCMSHarmonizerClientAbstract

The CMS provider class is responsible for implementing these methods, which are only defined abstractly.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

clientInstance clientParams

Methods

agnosticCmsInitialize @@ -10,17 +10,17 @@ initialize

Constructors

constructor

Properties

Protected clientInstance

clientInstance: CmsClientInstance

Protected clientParams

clientParams: CreateClientParams

Methods

Protected agnosticCmsInitialize

  • agnosticCmsInitialize<T>(handler): Promise<T>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    +

Returns AbstractAgnosticCMSHarmonizerClient

Properties

Protected clientInstance

clientInstance: CmsClientInstance

Protected clientParams

clientParams: CreateClientParams

Methods

Protected agnosticCmsInitialize

  • agnosticCmsInitialize<T>(handler): Promise<T>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    Type Parameters

    • T = unknown

    Parameters

    • handler: (() => T)

      a function usually executing the native provider library initialize way

        • (): T

        • Returns T

    Returns Promise<T>

    The handler generated output

    Throws

    An error with a minimal description, followed by the unmodified error of the provided function

    -

Protected execParser

Protected Abstract getClientInstance

Abstract getEntry

Protected execParser

Protected Abstract getClientInstance

Abstract getEntry

Protected getEntryHarmonized

Protected getEntryHarmonized

  • getEntryHarmonized<T>(getEntryHandler, parserHandler): Promise<HarmonizedOutput<T>>

  • Only the implementation of the abstract method from the provider class should reference on to this.

    Type Parameters

    • T = Record<string, unknown>

    Parameters

    • getEntryHandler: (() => Promise<T>)

      a function usually executing the native provider library initialize way

        • (): Promise<T>

        • Returns Promise<T>

    • parserHandler: ((data) => HarmonizedOutput<T>)

      again, an exclusive function to parse the obtained entry data, since each provider returns the entries with a different format

    Returns Promise<HarmonizedOutput<T>>

    The entry data formatted with the generic output format. Otherwise an error would have occurred

    -

Abstract initialize

  • initialize(): Promise<void>

  • Typically this is going to define a singleton client instance

    -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Abstract initialize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/_types_client.html b/modules/_types_client.html index ebecf28..b298e1a 100644 --- a/modules/_types_client.html +++ b/modules/_types_client.html @@ -1,3 +1,3 @@ -@types/client | @onebeyond/agnostic-cms-harmonizer

Module @types/client

Index

Type Aliases

ClientParams +@types/client | @onebeyond/agnostic-cms-harmonizer

Module @types/client

Index

Type Aliases

ClientParams CmsClientInstance

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/_types_output.html b/modules/_types_output.html index b38d3e1..f90bec5 100644 --- a/modules/_types_output.html +++ b/modules/_types_output.html @@ -1,2 +1,2 @@ -@types/output | @onebeyond/agnostic-cms-harmonizer

Module @types/output

Index

Type Aliases

HarmonizedOutput +@types/output | @onebeyond/agnostic-cms-harmonizer

Module @types/output

Index

Type Aliases

HarmonizedOutput

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/cms_contentful.html b/modules/cms_contentful.html index e31ab47..0bbb0fe 100644 --- a/modules/cms_contentful.html +++ b/modules/cms_contentful.html @@ -1,4 +1,4 @@ -cms/contentful | @onebeyond/agnostic-cms-harmonizer

Module cms/contentful

Index

Classes

HarmonizerContentfulClient +cms/contentful | @onebeyond/agnostic-cms-harmonizer

Module cms/contentful

Index

Classes

HarmonizerContentfulClient

Type Aliases

ContentfulEntry ContentfulEntrySkeleton ContentfulGetEntryParams diff --git a/modules/index.html b/modules/index.html index 2f47788..fe98528 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,2 +1,2 @@ -index | @onebeyond/agnostic-cms-harmonizer

Module index

Index

Classes

AgnosticCMSHarmonizerClient +index | @onebeyond/agnostic-cms-harmonizer

Module index

Index

Classes

AgnosticCMSHarmonizerClient

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/index_abstract.html b/modules/index_abstract.html index 4d70a44..ae716ef 100644 --- a/modules/index_abstract.html +++ b/modules/index_abstract.html @@ -1,3 +1,3 @@ -index.abstract | @onebeyond/agnostic-cms-harmonizer

Module index.abstract

Index

Classes

AbstractAgnosticCMSHarmonizerClient +index.abstract | @onebeyond/agnostic-cms-harmonizer

Module index.abstract

Index

Classes

AbstractAgnosticCMSHarmonizerClient

Type Aliases

AbstractGetEntryParams

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/_types_client.ClientParams.html b/types/_types_client.ClientParams.html index 4515157..ba4f745 100644 --- a/types/_types_client.ClientParams.html +++ b/types/_types_client.ClientParams.html @@ -1 +1 @@ -ClientParams | @onebeyond/agnostic-cms-harmonizer

Type alias ClientParams

ClientParams: ContentfulClientParams

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ClientParams | @onebeyond/agnostic-cms-harmonizer

Type alias ClientParams

ClientParams: ContentfulClientParams

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/_types_client.CmsClientInstance.html b/types/_types_client.CmsClientInstance.html index 545d236..07d22f4 100644 --- a/types/_types_client.CmsClientInstance.html +++ b/types/_types_client.CmsClientInstance.html @@ -1 +1 @@ -CmsClientInstance | @onebeyond/agnostic-cms-harmonizer

Type alias CmsClientInstance<T>

CmsClientInstance<T>: ContentfulClientApi<T>

Type Parameters

  • T extends ChainModifiers = undefined

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +CmsClientInstance | @onebeyond/agnostic-cms-harmonizer

Type alias CmsClientInstance<T>

CmsClientInstance<T>: ContentfulClientApi<T>

Type Parameters

  • T extends ChainModifiers = undefined

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/_types_output.HarmonizedOutput.html b/types/_types_output.HarmonizedOutput.html index 0147a6d..8d36cf2 100644 --- a/types/_types_output.HarmonizedOutput.html +++ b/types/_types_output.HarmonizedOutput.html @@ -1,3 +1,3 @@ HarmonizedOutput | @onebeyond/agnostic-cms-harmonizer

Type alias HarmonizedOutput<T>

HarmonizedOutput<T>: {
    data: T;
}

The objective of every provider is to match this interface after parsing the data from the entries with the custom formatters.

-

Type Parameters

  • T

Type declaration

  • data: T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

  • T

Type declaration

  • data: T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/cms_contentful.ContentfulEntry.html b/types/cms_contentful.ContentfulEntry.html index 93b84e1..5470e38 100644 --- a/types/cms_contentful.ContentfulEntry.html +++ b/types/cms_contentful.ContentfulEntry.html @@ -1 +1 @@ -ContentfulEntry | @onebeyond/agnostic-cms-harmonizer

Type alias ContentfulEntry<T>

ContentfulEntry<T>: Entry<EntrySkeletonType<T & FieldsType>, undefined, string>

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ContentfulEntry | @onebeyond/agnostic-cms-harmonizer

Type alias ContentfulEntry<T>

ContentfulEntry<T>: Entry<EntrySkeletonType<T & FieldsType>, undefined, string>

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/cms_contentful.ContentfulEntrySkeleton.html b/types/cms_contentful.ContentfulEntrySkeleton.html index 967861c..38866fb 100644 --- a/types/cms_contentful.ContentfulEntrySkeleton.html +++ b/types/cms_contentful.ContentfulEntrySkeleton.html @@ -1 +1 @@ -ContentfulEntrySkeleton | @onebeyond/agnostic-cms-harmonizer

Type alias ContentfulEntrySkeleton<T>

ContentfulEntrySkeleton<T>: EntrySkeletonType<T & FieldsType>

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ContentfulEntrySkeleton | @onebeyond/agnostic-cms-harmonizer

Type alias ContentfulEntrySkeleton<T>

ContentfulEntrySkeleton<T>: EntrySkeletonType<T & FieldsType>

Type Parameters

  • T

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/cms_contentful.ContentfulGetEntryParams.html b/types/cms_contentful.ContentfulGetEntryParams.html index 314d072..05594e4 100644 --- a/types/cms_contentful.ContentfulGetEntryParams.html +++ b/types/cms_contentful.ContentfulGetEntryParams.html @@ -1 +1 @@ -ContentfulGetEntryParams | @onebeyond/agnostic-cms-harmonizer

Type alias ContentfulGetEntryParams

ContentfulGetEntryParams: AbstractGetEntryParams & EntryQueries<ChainModifiers> & {
    locale?: string;
    nestedLevels?: 0 | 2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
}

Type declaration

  • Optional locale?: string
  • Optional nestedLevels?: 0 | 2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ContentfulGetEntryParams | @onebeyond/agnostic-cms-harmonizer

Type alias ContentfulGetEntryParams

ContentfulGetEntryParams: AbstractGetEntryParams & EntryQueries<ChainModifiers> & {
    locale?: string;
    nestedLevels?: 0 | 2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
}

Type declaration

  • Optional locale?: string
  • Optional nestedLevels?: 0 | 2 | 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/index_abstract.AbstractGetEntryParams.html b/types/index_abstract.AbstractGetEntryParams.html index 788afdf..452c7ad 100644 --- a/types/index_abstract.AbstractGetEntryParams.html +++ b/types/index_abstract.AbstractGetEntryParams.html @@ -1,2 +1,2 @@ AbstractGetEntryParams | @onebeyond/agnostic-cms-harmonizer

Type alias AbstractGetEntryParams

AbstractGetEntryParams: {
    entryId: string;
}

Type declaration

  • entryId: string

    The ID from the chosen provider entry containing the desired content

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file