feat(operators): introduce @ngrx/operators package (#4097)

Closes #4057
ngrx · Oct 26, 2023 · e93ead4 · e93ead4
1 parent f28ea71
commit e93ead4
Show file tree

Hide file tree

Showing 81 changed files with 3,008 additions and 61 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -137,6 +137,7 @@ The following is the list of supported scopes:
 - **entity**
 - **eslint-plugin**
 - **example**
+- **operators**
 - **router-store**
 - **schematics**
 - **signals**

diff --git a/build/config.ts b/build/config.ts
@@ -20,8 +20,7 @@ export const packages: PackageDescription[] = fs
  return false;
  }
 
- // TODO: Remove signals when released as a stable package
- if (path.includes('eslint-plugin') || path.includes('signals')) {
+ if (path.includes('eslint-plugin')) {
  return false;
  }
 

diff --git a/build/copy-schematics-core.ts b/build/copy-schematics-core.ts
@@ -8,8 +8,7 @@ const copySchematics = createBuilder([
 
 copySchematics({
  scope: '@ngrx',
- // TODO: Remove signals when released as a stable package
- packages: [...packages, { name: 'signals' }],
+ packages: [...packages],
 }).catch((err) => {
  console.error(err);
  process.exit(1);

diff --git a/build/publish-latest.ts b/build/publish-latest.ts
@@ -17,6 +17,8 @@ export async function publishLatestToNpm() {
  'schematics',
  'eslint-plugin',
  'data',
+ 'signals',
+ 'operators',
  ];
 
  for (let pkg of publishablePackages) {

diff --git a/build/publish-next.ts b/build/publish-next.ts
@@ -17,6 +17,8 @@ export async function publishNextToNpm() {
  'schematics',
  'eslint-plugin',
  'data',
+ 'signals',
+ 'operators',
  ];
 
  for (let pkg of publishablePackages) {

diff --git a/modules/component-store/ng-package.json b/modules/component-store/ng-package.json
@@ -2,6 +2,7 @@
  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
  "dest": "../../dist/modules/component-store",
  "assets": ["migrations/**/*.json", "schematics/**/*.json", "**/files/**/*"],
+ "allowedNonPeerDependencies": ["@ngrx/operators"],
  "lib": {
  "entryFile": "index.ts"
  }

diff --git a/modules/component-store/package.json b/modules/component-store/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@ngrx/component-store",
- "version": "16.3.0",
+ "version": "17.0.0-beta.0",
  "description": "Reactive store for component state",
  "repository": {
  "type": "git",
@@ -22,7 +22,7 @@
  },
  "homepage": "https:/ngrx/platform#readme",
  "peerDependencies": {
- "@angular/core": "^16.0.0",
+ "@angular/core": "^17.0.0-rc.0",
  "rxjs": "^6.5.3 || ^7.5.0"
  },
  "schematics": "./schematics/collection.json",
@@ -38,11 +38,13 @@
  "@ngrx/store-devtools",
  "@ngrx/component-store",
  "@ngrx/component",
- "@ngrx/eslint-plugin"
+ "@ngrx/eslint-plugin",
+ "@ngrx/signals"
  ],
  "migrations": "./migrations/migration.json"
  },
  "dependencies": {
+ "@ngrx/operators": "17.0.0-beta.0",
  "tslib": "^2.0.0"
  }
 }
diff --git a/modules/component-store/schematics-core/utility/libs-version.ts b/modules/component-store/schematics-core/utility/libs-version.ts
@@ -1 +1 @@
-export const platformVersion = '^16.3.0';
+export const platformVersion = '^17.0.0-beta.0';
diff --git a/modules/component-store/spec/types/utils.ts b/modules/component-store/spec/types/utils.ts
@@ -5,5 +5,6 @@ export const compilerOptions = () => ({
  experimentalDecorators: true,
  paths: {
  '@ngrx/component-store': ['./modules/component-store'],
+ '@ngrx/operators': ['./modules/operators'],
  },
 });
diff --git a/modules/component-store/src/index.ts b/modules/component-store/src/index.ts
@@ -1,5 +1,5 @@
 export * from './component-store';
-export * from './tap-response';
+export { tapResponse } from '@ngrx/operators';
 export {
  provideComponentStore,
  OnStateInit,

diff --git a/modules/component-store/tsconfig.build.json b/modules/component-store/tsconfig.build.json
@@ -11,7 +11,9 @@
  "noImplicitReturns": true,
  "downlevelIteration": true,
  "outDir": "../../dist/modules/component-store",
- "paths": {},
+ "paths": {
+ "@ngrx/operators": ["./dist/modules/operators"]
+ },
  "rootDir": ".",
  "sourceMap": true,
  "inlineSources": true,

diff --git a/modules/component/package.json b/modules/component/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@ngrx/component",
- "version": "16.3.0",
+ "version": "17.0.0-beta.0",
  "description": "Reactive Extensions for Angular Components",
  "repository": {
  "type": "git",
@@ -20,8 +20,8 @@
  },
  "homepage": "https:/ngrx/platform#readme",
  "peerDependencies": {
- "@angular/common": "^16.0.0",
- "@angular/core": "^16.0.0",
+ "@angular/common": "^17.0.0-rc.0",
+ "@angular/core": "^17.0.0-rc.0",
  "rxjs": "^6.5.3 || ^7.5.0"
  },
  "schematics": "./schematics/collection.json",
@@ -37,7 +37,8 @@
  "@ngrx/store-devtools",
  "@ngrx/component-store",
  "@ngrx/component",
- "@ngrx/eslint-plugin"
+ "@ngrx/eslint-plugin",
+ "@ngrx/signals"
  ],
  "migrations": "./migrations/migration.json"
  },

diff --git a/modules/component/schematics-core/utility/libs-version.ts b/modules/component/schematics-core/utility/libs-version.ts
@@ -1 +1 @@
-export const platformVersion = '^16.3.0';
+export const platformVersion = '^17.0.0-beta.0';
diff --git a/modules/data/package.json b/modules/data/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@ngrx/data",
- "version": "16.3.0",
+ "version": "17.0.0-beta.0",
  "description": "API management for NgRx",
  "repository": {
  "type": "git",
@@ -20,11 +20,11 @@
  },
  "homepage": "https:/ngrx/platform#readme",
  "peerDependencies": {
- "@angular/common": "^16.0.0",
- "@angular/core": "^16.0.0",
- "@ngrx/store": "16.3.0",
- "@ngrx/effects": "16.3.0",
- "@ngrx/entity": "16.3.0",
+ "@angular/common": "^17.0.0-rc.0",
+ "@angular/core": "^17.0.0-rc.0",
+ "@ngrx/store": "17.0.0-beta.0",
+ "@ngrx/effects": "17.0.0-beta.0",
+ "@ngrx/entity": "17.0.0-beta.0",
  "rxjs": "^6.5.3 || ^7.5.0"
  },
  "schematics": "./schematics/collection.json",
@@ -39,7 +39,8 @@
  "@ngrx/store-devtools",
  "@ngrx/component-store",
  "@ngrx/component",
- "@ngrx/eslint-plugin"
+ "@ngrx/eslint-plugin",
+ "@ngrx/signals"
  ],
  "migrations": "./migrations/migration.json"
  },

diff --git a/modules/data/schematics-core/utility/libs-version.ts b/modules/data/schematics-core/utility/libs-version.ts
@@ -1 +1 @@
-export const platformVersion = '^16.3.0';
+export const platformVersion = '^17.0.0-beta.0';
diff --git a/modules/effects/ng-package.json b/modules/effects/ng-package.json
@@ -2,6 +2,7 @@
  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
  "dest": "../../dist/modules/effects",
  "assets": ["migrations/**/*.json", "schematics/**/*.json", "**/files/**/*"],
+ "allowedNonPeerDependencies": ["@ngrx/operators"],
  "lib": {
  "entryFile": "index.ts"
  }

diff --git a/modules/effects/package.json b/modules/effects/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@ngrx/effects",
- "version": "16.3.0",
+ "version": "17.0.0-beta.0",
  "description": "Side effect model for @ngrx/store",
  "repository": {
  "type": "git",
@@ -21,8 +21,8 @@
  },
  "homepage": "https:/ngrx/platform#readme",
  "peerDependencies": {
- "@angular/core": "^16.0.0",
- "@ngrx/store": "16.3.0",
+ "@angular/core": "^17.0.0-rc.0",
+ "@ngrx/store": "17.0.0-beta.0",
  "rxjs": "^6.5.3 || ^7.5.0"
  },
  "schematics": "./schematics/collection.json",
@@ -37,12 +37,14 @@
  "@ngrx/store-devtools",
  "@ngrx/component-store",
  "@ngrx/component",
- "@ngrx/eslint-plugin"
+ "@ngrx/eslint-plugin",
+ "@ngrx/signals"
  ],
  "migrations": "./migrations/migration.json"
  },
  "sideEffects": false,
  "dependencies": {
+ "@ngrx/operators": "17.0.0-beta.0",
  "tslib": "^2.0.0"
  }
 }
diff --git a/modules/effects/schematics-core/utility/libs-version.ts b/modules/effects/schematics-core/utility/libs-version.ts
@@ -1 +1 @@
-export const platformVersion = '^16.3.0';
+export const platformVersion = '^17.0.0-beta.0';
diff --git a/modules/effects/spec/types/utils.ts b/modules/effects/spec/types/utils.ts
@@ -6,6 +6,7 @@ export const compilerOptions = () => ({
  paths: {
  '@ngrx/store': ['./modules/store'],
  '@ngrx/effects': ['./modules/effects'],
+ '@ngrx/operators': ['./modules/operators'],
  rxjs: ['../npm/node_modules/rxjs', './node_modules/rxjs'],
  },
 });
diff --git a/modules/effects/src/index.ts b/modules/effects/src/index.ts
@@ -27,5 +27,5 @@ export {
  OnInitEffects,
 } from './lifecycle_hooks';
 export { USER_PROVIDED_EFFECTS } from './tokens';
-export { concatLatestFrom } from './concat_latest_from';
+export { concatLatestFrom } from '@ngrx/operators';
 export { provideEffects } from './provide_effects';
diff --git a/modules/effects/tsconfig.build.json b/modules/effects/tsconfig.build.json
@@ -11,7 +11,9 @@
  "noImplicitReturns": true,
  "downlevelIteration": true,
  "outDir": "../../dist/modules/effects",
- "paths": {},
+ "paths": {
+ "@ngrx/operators": ["./dist/modules/operators"]
+ },
  "rootDir": ".",
  "sourceMap": true,
  "inlineSources": true,

diff --git a/modules/entity/package.json b/modules/entity/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@ngrx/entity",
- "version": "16.3.0",
+ "version": "17.0.0-beta.0",
  "description": "Common utilities for entity reducers",
  "repository": {
  "type": "git",
@@ -20,8 +20,8 @@
  },
  "homepage": "https:/ngrx/platform#readme",
  "peerDependencies": {
- "@angular/core": "^16.0.0",
- "@ngrx/store": "16.3.0",
+ "@angular/core": "^17.0.0-rc.0",
+ "@ngrx/store": "17.0.0-beta.0",
  "rxjs": "^6.5.3 || ^7.5.0"
  },
  "schematics": "./schematics/collection.json",
@@ -36,7 +36,8 @@
  "@ngrx/store-devtools",
  "@ngrx/component-store",
  "@ngrx/component",
- "@ngrx/eslint-plugin"
+ "@ngrx/eslint-plugin",
+ "@ngrx/signals"
  ],
  "migrations": "./migrations/migration.json"
  },

diff --git a/modules/entity/schematics-core/utility/libs-version.ts b/modules/entity/schematics-core/utility/libs-version.ts
@@ -1 +1 @@
-export const platformVersion = '^16.3.0';
+export const platformVersion = '^17.0.0-beta.0';
diff --git a/modules/eslint-plugin/package.json b/modules/eslint-plugin/package.json
@@ -1,6 +1,6 @@
 {
  "name": "@ngrx/eslint-plugin",
- "version": "16.3.0",
+ "version": "17.0.0-beta.0",
  "description": "NgRx ESLint Plugin",
  "repository": {
  "type": "git",
@@ -30,7 +30,8 @@
  "@ngrx/store-devtools",
  "@ngrx/component-store",
  "@ngrx/component",
- "@ngrx/eslint-plugin"
+ "@ngrx/eslint-plugin",
+ "@ngrx/signals"
  ],
  "migrations": "./migrations/migration.json"
  },

diff --git a/modules/operators/.eslintrc.json b/modules/operators/.eslintrc.json
@@ -0,0 +1,26 @@
+{
+ "extends": ["../../.eslintrc.json"],
+ "ignorePatterns": ["!**/*", "schematics-core"],
+ "overrides": [
+ {
+ "files": ["*.ts"],
+ "extends": [
+ "plugin:@nx/angular",
+ "plugin:@angular-eslint/template/process-inline-templates"
+ ],
+ "parserOptions": {
+ "project": ["modules/operators/tsconfig.*?.json"]
+ },
+ "rules": {
+ "@angular-eslint/directive-selector": "off",
+ "@angular-eslint/component-selector": "off"
+ },
+ "plugins": ["@typescript-eslint"]
+ },
+ {
+ "files": ["*.html"],
+ "extends": ["plugin:@nx/angular-template"],
+ "rules": {}
+ }
+ ]
+}
diff --git a/modules/operators/CHANGELOG.md b/modules/operators/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Change Log
+
+See [CHANGELOG.md](https:/ngrx/platform/blob/main/CHANGELOG.md)
diff --git a/modules/operators/README.md b/modules/operators/README.md
@@ -0,0 +1,3 @@
+# @ngrx/operators
+
+The sources for this package are in the main [NgRx](https:/ngrx/platform) repo. Please file issues and pull requests against that repo.
diff --git a/modules/operators/index.ts b/modules/operators/index.ts
@@ -0,0 +1,7 @@
+/**
+ * DO NOT EDIT
+ *
+ * This file is automatically generated at build
+ */
+
+export * from './src/index';
diff --git a/modules/operators/jest.config.ts b/modules/operators/jest.config.ts
@@ -0,0 +1,22 @@
+/* eslint-disable */
+export default {
+ displayName: 'Operators',
+ preset: '../../jest.preset.js',
+ coverageDirectory: '../../coverage/modules/operators',
+ setupFilesAfterEnv: ['<rootDir>/test-setup.ts'],
+ transform: {
+ '^.+\\.(ts|mjs|js|html)$': [
+ 'jest-preset-angular',
+ {
+ tsconfig: '<rootDir>/tsconfig.spec.json',
+ stringifyContentPathRegex: '\\.(html|svg)$',
+ },
+ ],
+ },
+ transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+ snapshotSerializers: [
+ 'jest-preset-angular/build/serializers/no-ng-attributes',
+ 'jest-preset-angular/build/serializers/ng-snapshot',
+ 'jest-preset-angular/build/serializers/html-comment',
+ ],
+};
diff --git a/modules/operators/migrations/migration.json b/modules/operators/migrations/migration.json
@@ -0,0 +1,4 @@
+{
+ "$schema": "../../../node_modules/@angular-devkit/schematics/collection-schema.json",
+ "schematics": {}
+}
diff --git a/modules/operators/ng-package.json b/modules/operators/ng-package.json
@@ -0,0 +1,8 @@
+{
+ "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+ "dest": "../../dist/modules/operators",
+ "assets": ["migrations/**/*.json", "schematics/**/*.json", "**/files/**/*"],
+ "lib": {
+ "entryFile": "index.ts"
+ }
+}