UNPKG

@acoustic-content-sdk/redux-feature-auth-layout

Version:

Implementation of a redux feature to manage authoring layouts.

347 lines (223 loc) 17.8 kB
<a name="_2ebf9cbad83a57cbde1c06333fd7562fd3eb2574597f9af52ab52a65882f6808"></a> [![npm](https://img.shields.io/npm/v/@acoustic-content-sdk/redux-feature-auth-layout.svg?style=flat-square)](https://www.npmjs.com/package/@acoustic-content-sdk/redux-feature-auth-layout) Implementation of a redux feature to manage authoring layouts. [API Documentation](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) <a name="_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) ## redux-feature-auth-layout package Implementation of a redux feature to manage authoring layouts. ## Interfaces | Interface | Description | | --- | --- | | [AuthLayoutFeatureState](#_ff2eec71d4bb532f03f880a776543b3a8112b4c56a2d3e2e3707b774dc66d3a5) | | ## Variables | Variable | Description | | --- | --- | | [ACTION\_ADD\_AUTH\_LAYOUT\_IF\_NONEXISTENT](#_29e8fecee8038514fa0b3c71a8e001076d3d008433fb1c0c728c13324f5e6d84) | | | [ACTION\_ADD\_AUTH\_LAYOUT](#_333455c80e024f302cd6cc79ab873101e174f75663d39ed142e6b024cdf6460c) | | | [ACTION\_GUARANTEE\_AUTH\_LAYOUT](#_6998f1e2d4eb940430bcb3d49b9a1dbd3efc6fabad6ac1940342aea3152ce89b) | | | [ACTION\_LOAD\_AUTH\_LAYOUT](#_25f139db02ee54ff864ad1470a6f5410290694496ff3a5a952c0a8e6b9ecdd9b) | | | [ACTION\_SET\_AUTH\_LAYOUT](#_e2758db9c28ca5b73e4d8c5fbde061482801897e1ba6337709affb057dc67ceb) | Do not add a side effect to this action | | [addAuthoringLayoutAction](#_e322ee9e37d487f8d5a73d0c69128af2a68cbd94e6007b10348a9102f213f764) | | | [addAuthoringLayoutIfNonExistentAction](#_2774456f999a53f16369ddb67bc9da68da1c25f8ada8b607e43138a48c4dae86) | Adds this content item to the store only if the item does not exist, yet. If the item does not exist, this triggers a [addAuthoringLayoutAction](#_e322ee9e37d487f8d5a73d0c69128af2a68cbd94e6007b10348a9102f213f764)<!-- -->. | | [AUTH\_LAYOUT\_FEATURE](#_2df39e1404edbc15ce5c3296747b591d275d091b199423c34a67dfeb4804b451) | | | [authLayoutFeatureReducer](#_da73fc1ee27bf039593575e556e1a8e99f34d475609f4c98fd49066330f7ebdd) | | | [authoringLayoutFeature](#_c320efabf72e6d2cecafa557d282e40fb90fbfb0da56726521f98a613e84f6a4) | Exposes the feature module selector | | [authoringLayoutReducer](#_5903d34ceb60a8c1ace997053fee97552bed1583ea1bab8b0bcec1b1ef8543c2) | reducers for authoring content | | [guaranteeAuthoringLayoutAction](#_ab573dac240bdde83ae466ef937da96483ab93da01dea77f9536a265040a9dc9) | | | [loadAuthoringLayoutAction](#_da8adbf6f39057cb042d1fa4fe902aa5aa15d138c66c99208cef4cde855e7f62) | | | [selectAuthLayoutFeature](#_c80de891506dd3493d91f01b5aa7148b0fd02d7526a12f9dff13e465fa6c72c5) | Select the authoring type feature | | [selectAuthoringLayout](#_e6e3130a092601d8291412b40a7791335fef864791e3714869169c55d0605d8b) | | | [setAuthoringLayoutAction](#_c071d76f4b82e93adcd85be97dd02dec3e4408669413800d95093b502fd51dbf) | | | [VERSION](#_8b6b08102f4cf8b198f4b81031962e95d53ea4648feafe7ffabf3ea1ff861487) | Version and build number of the package | ## Type Aliases | Type Alias | Description | | --- | --- | | [AddAuthoringLayoutAction](#_e322ee9e37d487f8d5a73d0c69128af2a68cbd94e6007b10348a9102f213f764) | | | [AddAuthoringLayoutIfNonExistentAction](#_2774456f999a53f16369ddb67bc9da68da1c25f8ada8b607e43138a48c4dae86) | | | [AuthoringLayoutState](#_d936b150e33d1e188f49876e83f2af68a4a2961475fc5770ac9eb124f7dab789) | | | [GuaranteeAuthoringLayoutAction](#_ab573dac240bdde83ae466ef937da96483ab93da01dea77f9536a265040a9dc9) | | | [LoadAuthoringLayoutAction](#_da8adbf6f39057cb042d1fa4fe902aa5aa15d138c66c99208cef4cde855e7f62) | | | [SetAuthoringLayoutAction](#_c071d76f4b82e93adcd85be97dd02dec3e4408669413800d95093b502fd51dbf) | | <a name="_2ebf9cbad83a57cbde1c06333fd7562fd3eb2574597f9af52ab52a65882f6808"></a> <a name="_ff2eec71d4bb532f03f880a776543b3a8112b4c56a2d3e2e3707b774dc66d3a5"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [AuthLayoutFeatureState](#_ff2eec71d4bb532f03f880a776543b3a8112b4c56a2d3e2e3707b774dc66d3a5) ## AuthLayoutFeatureState interface <b>Signature:</b> ```typescript export interface AuthLayoutFeatureState ``` ## Properties | Property | Type | Description | | --- | --- | --- | | [authLayout](#_2294014720420d98e906aad3eb1d66e3491e900442635b731799708ed9ac8379) | <code>AuthoringLayoutState</code> | | <a name="_29e8fecee8038514fa0b3c71a8e001076d3d008433fb1c0c728c13324f5e6d84"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [ACTION\_ADD\_AUTH\_LAYOUT\_IF\_NONEXISTENT](#_29e8fecee8038514fa0b3c71a8e001076d3d008433fb1c0c728c13324f5e6d84) ## ACTION\_ADD\_AUTH\_LAYOUT\_IF\_NONEXISTENT variable <b>Signature:</b> ```typescript ACTION_ADD_AUTH_LAYOUT_IF_NONEXISTENT = "ACTION_ADD_AUTH_LAYOUT_IF_NONEXISTENT" ``` <a name="_333455c80e024f302cd6cc79ab873101e174f75663d39ed142e6b024cdf6460c"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [ACTION\_ADD\_AUTH\_LAYOUT](#_333455c80e024f302cd6cc79ab873101e174f75663d39ed142e6b024cdf6460c) ## ACTION\_ADD\_AUTH\_LAYOUT variable <b>Signature:</b> ```typescript ACTION_ADD_AUTH_LAYOUT = "ACTION_ADD_AUTH_LAYOUT" ``` <a name="_6998f1e2d4eb940430bcb3d49b9a1dbd3efc6fabad6ac1940342aea3152ce89b"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [ACTION\_GUARANTEE\_AUTH\_LAYOUT](#_6998f1e2d4eb940430bcb3d49b9a1dbd3efc6fabad6ac1940342aea3152ce89b) ## ACTION\_GUARANTEE\_AUTH\_LAYOUT variable <b>Signature:</b> ```typescript ACTION_GUARANTEE_AUTH_LAYOUT = "ACTION_GUARANTEE_AUTH_LAYOUT" ``` <a name="_25f139db02ee54ff864ad1470a6f5410290694496ff3a5a952c0a8e6b9ecdd9b"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [ACTION\_LOAD\_AUTH\_LAYOUT](#_25f139db02ee54ff864ad1470a6f5410290694496ff3a5a952c0a8e6b9ecdd9b) ## ACTION\_LOAD\_AUTH\_LAYOUT variable <b>Signature:</b> ```typescript ACTION_LOAD_AUTH_LAYOUT = "ACTION_LOAD_AUTH_LAYOUT" ``` <a name="_e2758db9c28ca5b73e4d8c5fbde061482801897e1ba6337709affb057dc67ceb"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [ACTION\_SET\_AUTH\_LAYOUT](#_e2758db9c28ca5b73e4d8c5fbde061482801897e1ba6337709affb057dc67ceb) ## ACTION\_SET\_AUTH\_LAYOUT variable Do not add a side effect to this action <b>Signature:</b> ```typescript ACTION_SET_AUTH_LAYOUT = "ACTION_SET_AUTH_LAYOUT" ``` <a name="_e322ee9e37d487f8d5a73d0c69128af2a68cbd94e6007b10348a9102f213f764"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [addAuthoringLayoutAction](#_e322ee9e37d487f8d5a73d0c69128af2a68cbd94e6007b10348a9102f213f764) ## addAuthoringLayoutAction variable <b>Signature:</b> ```typescript addAuthoringLayoutAction: UnaryFunction<AuthoringLayoutItem, AddAuthoringLayoutAction> ``` <a name="_2774456f999a53f16369ddb67bc9da68da1c25f8ada8b607e43138a48c4dae86"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [addAuthoringLayoutIfNonExistentAction](#_2774456f999a53f16369ddb67bc9da68da1c25f8ada8b607e43138a48c4dae86) ## addAuthoringLayoutIfNonExistentAction 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 [addAuthoringLayoutAction](#_e322ee9e37d487f8d5a73d0c69128af2a68cbd94e6007b10348a9102f213f764)<!-- -->. <b>Signature:</b> ```typescript addAuthoringLayoutIfNonExistentAction: UnaryFunction<AuthoringLayoutItem, AddAuthoringLayoutIfNonExistentAction> ``` <a name="_2df39e1404edbc15ce5c3296747b591d275d091b199423c34a67dfeb4804b451"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [AUTH\_LAYOUT\_FEATURE](#_2df39e1404edbc15ce5c3296747b591d275d091b199423c34a67dfeb4804b451) ## AUTH\_LAYOUT\_FEATURE variable <b>Signature:</b> ```typescript AUTH_LAYOUT_FEATURE = "authLayout" ``` <a name="_da73fc1ee27bf039593575e556e1a8e99f34d475609f4c98fd49066330f7ebdd"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [authLayoutFeatureReducer](#_da73fc1ee27bf039593575e556e1a8e99f34d475609f4c98fd49066330f7ebdd) ## authLayoutFeatureReducer variable <b>Signature:</b> ```typescript authLayoutFeatureReducer: { authLayout: import("redux").Reducer<Record<string, import("@acoustic-content-sdk/api").AuthoringLayoutItem>, import("./auth.layout.actions").AddAuthoringLayoutAction | import("./auth.layout.actions").SetAuthoringLayoutAction>; } ``` <a name="_c320efabf72e6d2cecafa557d282e40fb90fbfb0da56726521f98a613e84f6a4"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [authoringLayoutFeature](#_c320efabf72e6d2cecafa557d282e40fb90fbfb0da56726521f98a613e84f6a4) ## authoringLayoutFeature variable Exposes the feature module selector <b>Signature:</b> ```typescript authoringLayoutFeature: import("@acoustic-content-sdk/redux-store").ReduxFeatureModule<Record<string, import("@acoustic-content-sdk/api").AuthoringLayoutItem>, AuthLayoutFeatureState, import("redux").AnyAction, import("redux").AnyAction, any> ``` <a name="_5903d34ceb60a8c1ace997053fee97552bed1583ea1bab8b0bcec1b1ef8543c2"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [authoringLayoutReducer](#_5903d34ceb60a8c1ace997053fee97552bed1583ea1bab8b0bcec1b1ef8543c2) ## authoringLayoutReducer variable reducers for authoring content <b>Signature:</b> ```typescript authoringLayoutReducer: Reducer<AuthoringLayoutState, AddAuthoringLayoutAction | SetAuthoringLayoutAction> ``` <a name="_ab573dac240bdde83ae466ef937da96483ab93da01dea77f9536a265040a9dc9"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [guaranteeAuthoringLayoutAction](#_ab573dac240bdde83ae466ef937da96483ab93da01dea77f9536a265040a9dc9) ## guaranteeAuthoringLayoutAction variable <b>Signature:</b> ```typescript guaranteeAuthoringLayoutAction: UnaryFunction<string, GuaranteeAuthoringLayoutAction> ``` <a name="_da8adbf6f39057cb042d1fa4fe902aa5aa15d138c66c99208cef4cde855e7f62"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [loadAuthoringLayoutAction](#_da8adbf6f39057cb042d1fa4fe902aa5aa15d138c66c99208cef4cde855e7f62) ## loadAuthoringLayoutAction variable <b>Signature:</b> ```typescript loadAuthoringLayoutAction: UnaryFunction<string, LoadAuthoringLayoutAction> ``` <a name="_c80de891506dd3493d91f01b5aa7148b0fd02d7526a12f9dff13e465fa6c72c5"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [selectAuthLayoutFeature](#_c80de891506dd3493d91f01b5aa7148b0fd02d7526a12f9dff13e465fa6c72c5) ## selectAuthLayoutFeature variable Select the authoring type feature <b>Signature:</b> ```typescript selectAuthLayoutFeature: import("rxjs").UnaryFunction<Record<string, any>, Record<string, import("@acoustic-content-sdk/api").AuthoringLayoutItem>> ``` <a name="_e6e3130a092601d8291412b40a7791335fef864791e3714869169c55d0605d8b"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [selectAuthoringLayout](#_e6e3130a092601d8291412b40a7791335fef864791e3714869169c55d0605d8b) ## selectAuthoringLayout variable <b>Signature:</b> ```typescript selectAuthoringLayout: UnaryFunction<string, UnaryFunction<AuthoringLayoutState, AuthoringLayoutItem>> ``` <a name="_c071d76f4b82e93adcd85be97dd02dec3e4408669413800d95093b502fd51dbf"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [setAuthoringLayoutAction](#_c071d76f4b82e93adcd85be97dd02dec3e4408669413800d95093b502fd51dbf) ## setAuthoringLayoutAction variable <b>Signature:</b> ```typescript setAuthoringLayoutAction: UnaryFunction<AuthoringLayoutItem, SetAuthoringLayoutAction> ``` <a name="_8b6b08102f4cf8b198f4b81031962e95d53ea4648feafe7ffabf3ea1ff861487"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [VERSION](#_8b6b08102f4cf8b198f4b81031962e95d53ea4648feafe7ffabf3ea1ff861487) ## VERSION variable Version and build number of the package <b>Signature:</b> ```typescript VERSION: { version: { major: string; minor: string; patch: string; branch: string; }; build: Date; } ``` <a name="_d936b150e33d1e188f49876e83f2af68a4a2961475fc5770ac9eb124f7dab789"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [AuthoringLayoutState](#_d936b150e33d1e188f49876e83f2af68a4a2961475fc5770ac9eb124f7dab789) ## AuthoringLayoutState type <b>Signature:</b> ```typescript export declare type AuthoringLayoutState = Record<string, AuthoringLayoutItem>; ``` <a name="_2294014720420d98e906aad3eb1d66e3491e900442635b731799708ed9ac8379"></a> <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](#_6eb654b36b7aae731240e6addc07a1ba21c15ccec4b28a056ffbd464195f7d7c) &gt; [@acoustic-content-sdk/redux-feature-auth-layout](#_2e2912358b134e2c7fdfa4167f0e922741f8d0456e3f1a35efe04d4f7070221e) &gt; [AuthLayoutFeatureState](#_ff2eec71d4bb532f03f880a776543b3a8112b4c56a2d3e2e3707b774dc66d3a5) &gt; [authLayout](#_2294014720420d98e906aad3eb1d66e3491e900442635b731799708ed9ac8379) ## AuthLayoutFeatureState.authLayout property <b>Signature:</b> ```typescript [AUTH_LAYOUT_FEATURE]: AuthoringLayoutState; ```