feat(data): standalone support for ng add @ngrx/data (#4019)

Closes #3935

Author: va-stefanek

modules/data/schematics/ng-add/__snapshots__/index.spec.ts.snap

@@ -0,0 +1,33 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Data ng-add Schematic Migration of ngrx-data Data ng-add Schematic for standalone application provides data without effects 1`] = `
+"import { ApplicationConfig } from '@angular/core';
+import { provideEntityData } from '@ngrx/data';
+import { entityConfig } from './entity-metadata';
+
+export const appConfig: ApplicationConfig = {
+  providers: [provideEntityData(entityConfig)]
+};
+"
+`;
+
+exports[`Data ng-add Schematic Migration of ngrx-data Data ng-add Schematic for standalone application provides data without entityConfig 1`] = `
+"import { ApplicationConfig } from '@angular/core';
+import { provideEntityData, withEffects } from '@ngrx/data';
+
+export const appConfig: ApplicationConfig = {
+  providers: [provideEntityData({}, withEffects())]
+};
+"
+`;
+
+exports[`Data ng-add Schematic Migration of ngrx-data Data ng-add Schematic for standalone application provides default data setup 1`] = `
+"import { ApplicationConfig } from '@angular/core';
+import { provideEntityData, withEffects } from '@ngrx/data';
+import { entityConfig } from './entity-metadata';
+
+export const appConfig: ApplicationConfig = {
+  providers: [provideEntityData(entityConfig, withEffects())]
+};
+"
+`;

modules/data/schematics/ng-add/index.spec.ts

@@ -367,5 +367,61 @@ describe('Data ng-add Schematic', () => {
 
       expect(actual).toBe(output);
     });
+
+    describe('Data ng-add Schematic for standalone application', () => {
+      const projectPath = getTestProjectPath(undefined, {
+        name: 'bar-standalone',
+      });
+
+      const standaloneDefaultOptions = {
+        ...defaultOptions,
+        project: 'bar-standalone',
+      };
+
+      it('provides default data setup', async () => {
+        const options = { ...standaloneDefaultOptions };
+        const tree = await schematicRunner.runSchematic(
+          'ng-add',
+          options,
+          appTree
+        );
+
+        const content = tree.readContent(
+          `${projectPath}/src/app/app.config.ts`
+        );
+
+        expect(content).toMatchSnapshot();
+      });
+
+      it('provides data without effects', async () => {
+        const options = { ...standaloneDefaultOptions, effects: false };
+        const tree = await schematicRunner.runSchematic(
+          'ng-add',
+          options,
+          appTree
+        );
+
+        const content = tree.readContent(
+          `${projectPath}/src/app/app.config.ts`
+        );
+
+        expect(content).toMatchSnapshot();
+      });
+
+      it('provides data without entityConfig', async () => {
+        const options = { ...standaloneDefaultOptions, entityConfig: false };
+        const tree = await schematicRunner.runSchematic(
+          'ng-add',
+          options,
+          appTree
+        );
+
+        const content = tree.readContent(
+          `${projectPath}/src/app/app.config.ts`
+        );
+
+        expect(content).toMatchSnapshot();
+      });
+    });
   });
 });

modules/data/schematics/ng-add/index.ts

@@ -3,13 +3,14 @@ import { Path } from '@angular-devkit/core';
 import {
   apply,
   applyTemplates,
+  branchAndMerge,
   chain,
   mergeWith,
   move,
-  noop,
   Rule,
   SchematicContext,
   SchematicsException,
+  noop,
   Tree,
   url,
 } from '@angular-devkit/schematics';
@@ -29,6 +30,12 @@ import {
   visitTSSourceFiles,
 } from '../../schematics-core';
 import { Schema as EntityDataOptions } from './schema';
+import { getProjectMainFile } from '../../schematics-core/utility/project';
+import { isStandaloneApp } from '../../schematics-core/utility/standalone';
+import {
+  addFunctionalProvidersToStandaloneBootstrap,
+  callsProvidersFunction,
+} from '@schematics/angular/private/standalone';
 
 function addNgRxDataToPackageJson() {
   return (host: Tree, context: SchematicContext) => {
@@ -95,6 +102,83 @@ function addEntityDataToNgModule(options: EntityDataOptions): Rule {
   };
 }
 
+function addStandaloneConfig(options: EntityDataOptions): Rule {
+  return (host: Tree) => {
+    const mainFile = getProjectMainFile(host, options);
+    if (host.exists(mainFile)) {
+      const providerFn = 'provideEntityData';
+
+      if (callsProvidersFunction(host, mainFile, providerFn)) {
+        // exit because the store config is already provided
+        return host;
+      }
+
+      const providerOptions = [
+        ...(options.entityConfig
+          ? [ts.factory.createIdentifier(`entityConfig`)]
+          : [ts.factory.createIdentifier(`{}`)]),
+        ...(options.effects
+          ? [ts.factory.createIdentifier(`withEffects()`)]
+          : []),
+      ];
+
+      const patchedConfigFile = addFunctionalProvidersToStandaloneBootstrap(
+        host,
+        mainFile,
+        providerFn,
+        '@ngrx/data',
+        providerOptions
+      );
+
+      const configFileContent = host.read(patchedConfigFile);
+      const source = ts.createSourceFile(
+        patchedConfigFile,
+        configFileContent?.toString('utf-8') || '',
+        ts.ScriptTarget.Latest,
+        true
+      );
+
+      const recorder = host.beginUpdate(patchedConfigFile);
+
+      const changes = [];
+
+      if (options.effects) {
+        const withEffectsImport = insertImport(
+          source,
+          patchedConfigFile,
+          'withEffects',
+          '@ngrx/data'
+        );
+
+        changes.push(withEffectsImport);
+      }
+
+      if (options.entityConfig) {
+        const entityConfigImport = insertImport(
+          source,
+          patchedConfigFile,
+          'entityConfig',
+          './entity-metadata'
+        );
+
+        changes.push(entityConfigImport);
+      }
+
+      changes.forEach((change: any) => {
+        recorder.insertLeft(change.pos, change.toAdd);
+      });
+
+      host.commitUpdate(recorder);
+
+      return host;
+    }
+
+    throw new SchematicsException(
+      `Main file not found for a project ${options.project}`
+    );
+  };
+}
+
 const renames = {
   NgrxDataModule: 'EntityDataModule',
   NgrxDataModuleWithoutEffects: 'EntityDataModuleWithoutEffects',
@@ -285,22 +369,29 @@ export default function (options: EntityDataOptions): Rule {
   return (host: Tree, context: SchematicContext) => {
     (options as any).name = '';
     options.path = getProjectPath(host, options);
+    const mainFile = getProjectMainFile(host, options);
+    const isStandalone = isStandaloneApp(host, mainFile);
     options.effects = options.effects === undefined ? true : options.effects;
-    options.module = options.module
-      ? findModuleFromOptions(host, options as any)
-      : options.module;
+    options.module =
+      options.module && !isStandalone
+        ? findModuleFromOptions(host, options as any)
+        : options.module;
 
     const parsedPath = parseName(options.path, '');
     options.path = parsedPath.path;
 
+    const configOrModuleUpdate = isStandalone
+      ? addStandaloneConfig(options)
+      : addEntityDataToNgModule(options);
+
     return chain([
       options && options.skipPackageJson ? noop() : addNgRxDataToPackageJson(),
       options.migrateNgrxData
         ? chain([
             removeAngularNgRxDataFromPackageJson(),
             renameNgrxDataModule(),
           ])
-        : addEntityDataToNgModule(options),
+        : branchAndMerge(chain([configOrModuleUpdate])),
       options.entityConfig
         ? createEntityConfigFile(options, parsedPath.path)
         : noop(),