@ngrx-traits/common 0.0.1

package/README.md

@@ -0,0 +1,7 @@
+# ngrx-traits-common
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test ngrx-traits-common` to execute the unit tests.

package/async-action/async-action.model.d.ts

@@ -0,0 +1,19 @@
+import { PostfixProps, PrefixProps } from '@ngrx-traits/core';
+import { ActionCreator, NotAllowedCheck } from '@ngrx/store';
+import { TypedAction } from '@ngrx/store/src/models';
+import { StatusState } from '../load-entities';
+export declare type ActionCreatorWithOptionalProps<T> = T extends undefined ? ActionCreator<string, () => TypedAction<string>> : ActionCreator<string, (props: T & NotAllowedCheck<T & object>) => T & TypedAction<string>>;
+declare type AsyncActions<Request, Response, Failure> = {
+    '': ActionCreatorWithOptionalProps<Request>;
+    Success: ActionCreatorWithOptionalProps<Response>;
+    Fail: ActionCreatorWithOptionalProps<Failure>;
+};
+declare type StatusSelectors<S extends StatusState> = {
+    isLoading: (state: S) => boolean;
+    isSuccess: (state: S) => boolean;
+    isFail: (state: S) => boolean;
+};
+export declare type AsyncActionState<J extends string> = PrefixProps<StatusState, J>;
+export declare type AsyncActionSelectors<J extends string, S> = PostfixProps<StatusSelectors<S>, J>;
+export declare type AsyncActionActions<Request, Response, Failure, J extends string> = PrefixProps<AsyncActions<Request, Response, Failure>, J>;
+export {};

package/async-action/async-action.trait.d.ts

@@ -0,0 +1,59 @@
+import { ActionCreatorProps } from '@ngrx/store/src/models';
+import { ActionCreatorWithOptionalProps } from './async-action.model';
+/**
+ * Generates the typical ngrx code need to make a async action with
+ * a request, success and failure actions, plus a status property to track its progress
+ * and selectors to query the status.
+ *
+ * @param options - Config object for the trait factory
+ * @param options.name - Name of the main request action, should be in camel case
+ * @param options.actionProps - Optional param for the main request action, use the props()
+ * function for its value, if not present action will have no params,
+ * @param options.actionSuccessProps - Optional param for the request success action,
+ * use the props() function for its value, if not present action success will have no params
+ * @param options.actionFailProps - Optional param for the request fail action,
+ * use the props() function for its value, if not present action fail will have no params
+ * @returns the trait factory
+ *
+ * @example
+ * // The following trait config
+ * const traits = createEntityFeatureFactory(
+ * {entityName: 'Todo'},
+ * addAsyncActionTrait({
+ *        name: 'createClient',
+ *        actionProps: props<{ name: string }>(),
+ *        actionSuccessProps: props<{ id: string }>(),
+ *      }),
+ * )({
+ *      actionsGroupKey: 'Client',
+ *      featureSelector: createFeatureSelector<AsyncActionState<'createClient'>>(
+ *        'client',
+ *      ),
+ *    });
+ * // will generate the actions and selectors
+ * traits.actions.createClient({name:'Pedro'})
+ * traits.actions.createClientSuccess({id:'123'})
+ * traits.actions.createClientFail();
+ * traits.selectors.isLoadingCreateClient
+ * traits.selectors.isSuccessCreateClient
+ * traits.selectors.isFailCreateClient
+ */
+export declare function addAsyncActionTrait<J extends string, Request extends object | undefined = undefined, Response extends object | undefined = undefined, Failure extends object | undefined = undefined>({ name, actionProps, actionSuccessProps, actionFailProps, }: {
+    name: J;
+    actionProps?: ActionCreatorProps<Request>;
+    actionSuccessProps?: ActionCreatorProps<Response>;
+    actionFailProps?: ActionCreatorProps<Failure>;
+}): import("@ngrx-traits/core").TraitFactory<import("@ngrx-traits/core").PrefixProps<import("@ngrx-traits/common").StatusState, J>, import("@ngrx-traits/core").PrefixProps<{
+    '': ActionCreatorWithOptionalProps<Request>;
+    Success: ActionCreatorWithOptionalProps<Response>;
+    Fail: ActionCreatorWithOptionalProps<Failure>;
+}, J>, import("@ngrx-traits/core").PostfixProps<{
+    isLoading: (state: import("@ngrx-traits/core").PrefixProps<import("@ngrx-traits/common").StatusState, J>) => boolean;
+    isSuccess: (state: import("@ngrx-traits/core").PrefixProps<import("@ngrx-traits/common").StatusState, J>) => boolean;
+    isFail: (state: import("@ngrx-traits/core").PrefixProps<import("@ngrx-traits/common").StatusState, J>) => boolean;
+}, J>, {}, string, {
+    name: J;
+    actionProps: ActionCreatorProps<Request> | undefined;
+    actionSuccessProps: ActionCreatorProps<Response> | undefined;
+    actionFailProps: ActionCreatorProps<Failure> | undefined;
+}, import("@ngrx-traits/core").AllTraitConfigs>;

package/async-action/index.d.ts

@@ -0,0 +1,2 @@
+export * from './async-action.model';
+export * from './async-action.trait';