@acoustic-content-sdk/redux-feature-delivery-content

Implementation of a redux feature to convert authoring content into delivery content.

Usage no npm install needed!

<script type="module">
  import acousticContentSdkReduxFeatureDeliveryContent from 'https://cdn.skypack.dev/@acoustic-content-sdk/redux-feature-delivery-content';
</script>

README

npm

Implementation of a redux feature to convert authoring content into delivery content.

API Documentation

Home > @acoustic-content-sdk/redux-feature-delivery-content

redux-feature-delivery-content package

Implementation of a redux feature to convert authoring content into delivery content.

Interfaces

Interface Description
DeliveryContentFeatureState
ResolveContentItemPayload

Variables

Variable Description
ACTION_ADD_DELIVERY_CONTENT_IF_NONEXISTENT
ACTION_ADD_DELIVERY_CONTENT
ACTION_RESOLVE_CONTENT_ITEM
ACTION_SET_DELIVERY_CONTENT Do not add a side effect to this action
addDeliveryContentAction
addDeliveryContentIfNonExistentAction Adds this content item to the store only if the item does not exist, yet. If the item does not exist, this triggers a addDeliveryContentAction.
DELIVERY_CONTENT_FEATURE
deliveryContentFeature Exposes the feature module selector
deliveryContentFeatureReducer
deliveryContentReducer reducers for authoring content
MODULE Module name
resolveContentItemAction
selectDeliveryContentFeature Select the delivery content feature
selectDeliveryContentItem
setDeliveryContentAction
VERSION Version and build number of the package

Type Aliases

Type Alias Description
AddDeliveryContentAction
AddDeliveryContentIfNonExistentAction
DeliveryContentState
ResolveContentItemAction
SetDeliveryContentAction

Home > @acoustic-content-sdk/redux-feature-delivery-content > DeliveryContentFeatureState

DeliveryContentFeatureState interface

Signature:

export interface DeliveryContentFeatureState

Properties

Property Type Description
deliveryContent DeliveryContentState

Home > @acoustic-content-sdk/redux-feature-delivery-content > ResolveContentItemPayload

ResolveContentItemPayload interface

Signature:

export interface ResolveContentItemPayload

Properties

Property Type Description
apiURL URL
assets Record<string, AuthoringAsset>
contentItem AuthoringContentItem
contentTypes Record<string, AuthoringType>
layouts Record<string, AuthoringLayoutItem>

Home > @acoustic-content-sdk/redux-feature-delivery-content > ACTION_ADD_DELIVERY_CONTENT_IF_NONEXISTENT

ACTION_ADD_DELIVERY_CONTENT_IF_NONEXISTENT variable

Signature:

ACTION_ADD_DELIVERY_CONTENT_IF_NONEXISTENT = "ACTION_ADD_DELIVERY_CONTENT_IF_NONEXISTENT"

Home > @acoustic-content-sdk/redux-feature-delivery-content > ACTION_ADD_DELIVERY_CONTENT

ACTION_ADD_DELIVERY_CONTENT variable

Signature:

ACTION_ADD_DELIVERY_CONTENT = "ACTION_ADD_DELIVERY_CONTENT"

Home > @acoustic-content-sdk/redux-feature-delivery-content > ACTION_RESOLVE_CONTENT_ITEM

ACTION_RESOLVE_CONTENT_ITEM variable

Signature:

ACTION_RESOLVE_CONTENT_ITEM = "ACTION_RESOLVE_CONTENT_ITEM"

Home > @acoustic-content-sdk/redux-feature-delivery-content > ACTION_SET_DELIVERY_CONTENT

ACTION_SET_DELIVERY_CONTENT variable

Do not add a side effect to this action

Signature:

ACTION_SET_DELIVERY_CONTENT = "ACTION_SET_DELIVERY_CONTENT"

Home > @acoustic-content-sdk/redux-feature-delivery-content > addDeliveryContentAction

addDeliveryContentAction variable

Signature:

addDeliveryContentAction: UnaryFunction<ContentItemWithLayout, AddDeliveryContentAction>

Home > @acoustic-content-sdk/redux-feature-delivery-content > addDeliveryContentIfNonExistentAction

addDeliveryContentIfNonExistentAction variable

Adds this content item to the store only if the item does not exist, yet. If the item does not exist, this triggers a addDeliveryContentAction.

Signature:

addDeliveryContentIfNonExistentAction: UnaryFunction<ContentItemWithLayout, AddDeliveryContentIfNonExistentAction>

Home > @acoustic-content-sdk/redux-feature-delivery-content > DELIVERY_CONTENT_FEATURE

DELIVERY_CONTENT_FEATURE variable

Signature:

DELIVERY_CONTENT_FEATURE = "deliveryContent"

Home > @acoustic-content-sdk/redux-feature-delivery-content > deliveryContentFeature

deliveryContentFeature variable

Exposes the feature module selector

Signature:

deliveryContentFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<Record<string, import("@acoustic-content-sdk/api").ContentItemWithLayout>, DeliveryContentFeatureState, import("redux").AnyAction, import("redux").AnyAction, any>

Home > @acoustic-content-sdk/redux-feature-delivery-content > deliveryContentFeatureReducer

deliveryContentFeatureReducer variable

Signature:

deliveryContentFeatureReducer: {
    deliveryContent: import("redux").Reducer<Record<string, import("@acoustic-content-sdk/api").ContentItemWithLayout>, import("redux").AnyAction>;
}

Home > @acoustic-content-sdk/redux-feature-delivery-content > deliveryContentReducer

deliveryContentReducer variable

reducers for authoring content

Signature:

deliveryContentReducer: Reducer<DeliveryContentState>

Home > @acoustic-content-sdk/redux-feature-delivery-content > MODULE

MODULE variable

Module name

Signature:

MODULE = "@acoustic-content-sdk/redux-feature-delivery-content"

Home > @acoustic-content-sdk/redux-feature-delivery-content > resolveContentItemAction

resolveContentItemAction variable

Signature:

resolveContentItemAction: UnaryFunction<ResolveContentItemPayload, ResolveContentItemAction>

Home > @acoustic-content-sdk/redux-feature-delivery-content > selectDeliveryContentFeature

selectDeliveryContentFeature variable

Select the delivery content feature

Signature:

selectDeliveryContentFeature: import("rxjs").UnaryFunction<Record<string, any>, Record<string, import("@acoustic-content-sdk/api").ContentItemWithLayout>>

Home > @acoustic-content-sdk/redux-feature-delivery-content > selectDeliveryContentItem

selectDeliveryContentItem variable

Signature:

selectDeliveryContentItem: UnaryFunction<string, UnaryFunction<DeliveryContentState, ContentItemWithLayout>>

Home > @acoustic-content-sdk/redux-feature-delivery-content > setDeliveryContentAction

setDeliveryContentAction variable

Signature:

setDeliveryContentAction: UnaryFunction<ContentItemWithLayout, SetDeliveryContentAction>

Home > @acoustic-content-sdk/redux-feature-delivery-content > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}

Home > @acoustic-content-sdk/redux-feature-delivery-content > DeliveryContentState

DeliveryContentState type

Signature:

export declare type DeliveryContentState = Record<string, ContentItemWithLayout>;

Home > @acoustic-content-sdk/redux-feature-delivery-content > DeliveryContentFeatureState > deliveryContent

DeliveryContentFeatureState.deliveryContent property

Signature:

[DELIVERY_CONTENT_FEATURE]: DeliveryContentState;

Home > @acoustic-content-sdk/redux-feature-delivery-content > ResolveContentItemPayload > apiURL

ResolveContentItemPayload.apiURL property

Signature:

apiURL: URL;

Home > @acoustic-content-sdk/redux-feature-delivery-content > ResolveContentItemPayload > assets

ResolveContentItemPayload.assets property

Signature:

assets: Record<string, AuthoringAsset>;

Home > @acoustic-content-sdk/redux-feature-delivery-content > ResolveContentItemPayload > contentItem

ResolveContentItemPayload.contentItem property

Signature:

contentItem: AuthoringContentItem;

Home > @acoustic-content-sdk/redux-feature-delivery-content > ResolveContentItemPayload > contentTypes

ResolveContentItemPayload.contentTypes property

Signature:

contentTypes: Record<string, AuthoringType>;

Home > @acoustic-content-sdk/redux-feature-delivery-content > ResolveContentItemPayload > layouts

ResolveContentItemPayload.layouts property

Signature:

layouts: Record<string, AuthoringLayoutItem>;