@angular-architects/ngrx-toolkit 0.0.1 → 0.0.3

package/lib/with-call-state.d.ts

@@ -0,0 +1,55 @@
+import { Signal } from '@angular/core';
+import { SignalStoreFeature } from '@ngrx/signals';
+import { Emtpy } from './shared/empty';
+export type CallState = 'init' | 'loading' | 'loaded' | {
+    error: string;
+};
+export type NamedCallStateSlice<Collection extends string> = {
+    [K in Collection as `${K}CallState`]: CallState;
+};
+export type CallStateSlice = {
+    callState: CallState;
+};
+export type NamedCallStateSignals<Prop extends string> = {
+    [K in Prop as `${K}Loading`]: Signal<boolean>;
+} & {
+    [K in Prop as `${K}Loaded`]: Signal<boolean>;
+} & {
+    [K in Prop as `${K}Error`]: Signal<string | null>;
+};
+export type CallStateSignals = {
+    loading: Signal<boolean>;
+    loaded: Signal<boolean>;
+    error: Signal<string | null>;
+};
+export declare function getCallStateKeys(config?: {
+    collection?: string;
+}): {
+    callStateKey: string;
+    loadingKey: string;
+    loadedKey: string;
+    errorKey: string;
+};
+export declare function withCallState<Collection extends string>(config: {
+    collection: Collection;
+}): SignalStoreFeature<{
+    state: Emtpy;
+    signals: Emtpy;
+    methods: Emtpy;
+}, {
+    state: NamedCallStateSlice<Collection>;
+    signals: NamedCallStateSignals<Collection>;
+    methods: Emtpy;
+}>;
+export declare function withCallState(): SignalStoreFeature<{
+    state: Emtpy;
+    signals: Emtpy;
+    methods: Emtpy;
+}, {
+    state: CallStateSlice;
+    signals: CallStateSignals;
+    methods: Emtpy;
+}>;
+export declare function setLoading<Prop extends string>(prop?: Prop): NamedCallStateSlice<Prop> | CallStateSlice;
+export declare function setLoaded<Prop extends string>(prop?: Prop): NamedCallStateSlice<Prop> | CallStateSlice;
+export declare function setError<Prop extends string>(error: unknown, prop?: Prop): NamedCallStateSlice<Prop> | CallStateSlice;

package/lib/with-data-service.d.ts

@@ -0,0 +1,110 @@
+import { ProviderToken, Signal } from "@angular/core";
+import { SignalStoreFeature } from "@ngrx/signals";
+import { CallState } from "./with-call-state";
+import { EntityId } from "@ngrx/signals/entities";
+import { EntityState, NamedEntitySignals } from "@ngrx/signals/entities/src/models";
+import { Emtpy } from "./shared/empty";
+export type Filter = Record<string, unknown>;
+export type Entity = {
+    id: EntityId;
+};
+export interface DataService<E extends Entity, F extends Filter> {
+    load(filter: F): Promise<E[]>;
+    loadById(id: EntityId): Promise<E>;
+    create(entity: E): Promise<E>;
+    update(entity: E): Promise<E>;
+    delete(entity: E): Promise<void>;
+}
+export declare function capitalize(str: string): string;
+export declare function getDataServiceKeys(options: {
+    collection?: string;
+}): {
+    filterKey: string;
+    selectedIdsKey: string;
+    selectedEntitiesKey: string;
+    updateFilterKey: string;
+    updateSelectedKey: string;
+    loadKey: string;
+    entitiesKey: string;
+    entityMapKey: string;
+    idsKey: string;
+    currentKey: string;
+    loadByIdKey: string;
+    setCurrentKey: string;
+    createKey: string;
+    updateKey: string;
+    deleteKey: string;
+};
+export type NamedDataServiceState<E extends Entity, F extends Filter, Collection extends string> = {
+    [K in Collection as `${K}Filter`]: F;
+} & {
+    [K in Collection as `selected${Capitalize<K>}Ids`]: Record<EntityId, boolean>;
+} & {
+    [K in Collection as `current${Capitalize<K>}`]: E;
+};
+export type DataServiceState<E extends Entity, F extends Filter> = {
+    filter: F;
+    selectedIds: Record<EntityId, boolean>;
+    current: E;
+};
+export type NamedDataServiceSignals<E extends Entity, Collection extends string> = {
+    [K in Collection as `selected${Capitalize<K>}Entities`]: Signal<E[]>;
+};
+export type DataServiceSignals<E extends Entity> = {
+    selectedEntities: Signal<E[]>;
+};
+export type NamedDataServiceMethods<E extends Entity, F extends Filter, Collection extends string> = {
+    [K in Collection as `update${Capitalize<K>}Filter`]: (filter: F) => void;
+} & {
+    [K in Collection as `updateSelected${Capitalize<K>}Entities`]: (id: EntityId, selected: boolean) => void;
+} & {
+    [K in Collection as `load${Capitalize<K>}Entities`]: () => Promise<void>;
+} & {
+    [K in Collection as `setCurrent${Capitalize<K>}`]: (entity: E) => void;
+} & {
+    [K in Collection as `load${Capitalize<K>}ById`]: (id: EntityId) => Promise<void>;
+} & {
+    [K in Collection as `create${Capitalize<K>}`]: (entity: E) => Promise<void>;
+} & {
+    [K in Collection as `update${Capitalize<K>}`]: (entity: E) => Promise<void>;
+} & {
+    [K in Collection as `delete${Capitalize<K>}`]: (entity: E) => Promise<void>;
+};
+export type DataServiceMethods<E extends Entity, F extends Filter> = {
+    updateFilter: (filter: F) => void;
+    updateSelected: (id: EntityId, selected: boolean) => void;
+    load: () => Promise<void>;
+    setCurrent(entity: E): void;
+    loadById(id: EntityId): Promise<void>;
+    create(entity: E): Promise<void>;
+    update(entity: E): Promise<void>;
+    delete(entity: E): Promise<void>;
+};
+export type Empty = Record<string, never>;
+export declare function withDataService<E extends Entity, F extends Filter, Collection extends string>(options: {
+    dataServiceType: ProviderToken<DataService<E, F>>;
+    filter: F;
+    collection: Collection;
+}): SignalStoreFeature<{
+    state: Emtpy;
+    signals: NamedEntitySignals<E, Collection>;
+    methods: Emtpy;
+}, {
+    state: NamedDataServiceState<E, F, Collection>;
+    signals: NamedDataServiceSignals<E, Collection>;
+    methods: NamedDataServiceMethods<E, F, Collection>;
+}>;
+export declare function withDataService<E extends Entity, F extends Filter>(options: {
+    dataServiceType: ProviderToken<DataService<E, F>>;
+    filter: F;
+}): SignalStoreFeature<{
+    state: {
+        callState: CallState;
+    } & EntityState<E>;
+    signals: Emtpy;
+    methods: Emtpy;
+}, {
+    state: DataServiceState<E, F>;
+    signals: DataServiceSignals<E>;
+    methods: DataServiceMethods<E, F>;
+}>;

package/lib/with-undo-redo.d.ts

@@ -0,0 +1,55 @@
+import { SignalStoreFeature } from "@ngrx/signals";
+import { EntityId, EntityMap, EntityState } from "@ngrx/signals/entities";
+import { Signal } from "@angular/core";
+import { EntitySignals, NamedEntitySignals } from "@ngrx/signals/entities/src/models";
+import { Entity } from "./with-data-service";
+import { Emtpy } from "./shared/empty";
+export type StackItem = Record<string, unknown>;
+export type NormalizedUndoRedoOptions = {
+    maxStackSize: number;
+    collections?: string[];
+};
+export type NamedUndoRedoState<Collection extends string> = {
+    [K in Collection as `${K}EntityMap`]: EntityMap<Entity>;
+} & {
+    [K in Collection as `${K}Ids`]: EntityId[];
+};
+export type NamedUndoRedoSignals<Collection extends string> = {
+    [K in Collection as `${K}Entities`]: Signal<Entity[]>;
+};
+export declare function getUndoRedoKeys(collections?: string[]): string[];
+export declare function withUndoRedo<Collection extends string>(options?: {
+    maxStackSize?: number;
+    collections: Collection[];
+}): SignalStoreFeature<{
+    state: Emtpy;
+    signals: NamedEntitySignals<Entity, Collection>;
+    methods: Emtpy;
+}, {
+    state: Emtpy;
+    signals: {
+        canUndo: Signal<boolean>;
+        canRedo: Signal<boolean>;
+    };
+    methods: {
+        undo: () => void;
+        redo: () => void;
+    };
+}>;
+export declare function withUndoRedo(options?: {
+    maxStackSize?: number;
+}): SignalStoreFeature<{
+    state: EntityState<Entity>;
+    signals: EntitySignals<Entity>;
+    methods: Emtpy;
+}, {
+    state: Emtpy;
+    signals: {
+        canUndo: Signal<boolean>;
+        canRedo: Signal<boolean>;
+    };
+    methods: {
+        undo: () => void;
+        redo: () => void;
+    };
+}>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-architects/ngrx-toolkit",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "peerDependencies": {
     "@angular/common": "^17.0.0",
     "@angular/core": "^17.0.0",
@@ -9,7 +9,6 @@
   "dependencies": {
     "tslib": "^2.3.0"
   },
-  "private": false,
   "sideEffects": false,
   "module": "fesm2022/angular-architects-ngrx-toolkit.mjs",
   "typings": "index.d.ts",
@@ -24,4 +23,4 @@
       "default": "./fesm2022/angular-architects-ngrx-toolkit.mjs"
     }
   }
-}
+}