plugin(analytics-provider-segment): migration of analytics-provider-segment plugin to backstage/community-plugins workspace

.github/CODEOWNERS

@@ -11,7 +11,7 @@ yarn.lock                                           @backstage/community-plugins
 /workspaces/3scale                                  @backstage/community-plugins-maintainers  @04kash @AndrienkoAleksandr
 /workspaces/acr                                     @backstage/community-plugins-maintainers  @christoph-jerolimov @invincibleJai
 /workspaces/adr                                     @backstage/community-plugins-maintainers  @kuangp
-/workspaces/analytics                               @backstage/community-plugins-maintainers  @jmezach
+/workspaces/analytics                               @backstage/community-plugins-maintainers  @jmezach @schultzp2020 @christoph-jerolimov
 /workspaces/azure-devops                            @backstage/community-plugins-maintainers  @awanlin
 /workspaces/azure-storage-explorer                  @backstage/community-plugins-maintainers  @deepan10
 /workspaces/bitrise                                 @backstage/community-plugins-maintainers  @backstage/sda-se-reviewers

workspaces/analytics/.changeset/shiny-scissors-exist.md

@@ -0,0 +1,5 @@
+---
+'@backstage-community/plugin-analytics-provider-segment': patch
+---
+
+The analytics-provider-segment plugin from the janus-idp/backstage-plugins repository was migrated to the community plugins, The migration was performed by following the manual migration steps outlined in the Community Plugins CONTRIBUTING guide, and ensuring the naming conventions aligned with the backstage-community standards.

workspaces/analytics/package.json

@@ -7,7 +7,7 @@
   },
   "scripts": {
     "tsc": "tsc",
-    "tsc:full": "tsc --skipLibCheck false --incremental false",
+    "tsc:full": "tsc --skipLibCheck true --incremental false",
     "build:all": "backstage-cli repo build --all",
     "clean": "backstage-cli repo clean",
     "test": "backstage-cli repo test",
@@ -17,8 +17,8 @@
     "lint:all": "backstage-cli repo lint",
     "prettier:check": "prettier --check .",
     "new": "backstage-cli new --scope @backstage-community",
-    "build:api-reports": "yarn build:api-reports:only --tsc",
-    "build:api-reports:only": "backstage-repo-tools api-reports -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
+    "build:api-reports": "yarn build:api-reports:only",
+    "build:api-reports:only": "backstage-repo-tools api-reports --allow-all-warnings -o ae-wrong-input-file-type,ae-undocumented --validate-release-tags",
     "postinstall": "cd ../../ && yarn install"
   },
   "workspaces": {
@@ -33,10 +33,11 @@
     "directory": "workspaces/analytics"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.28.0",
+    "@backstage/cli": "^0.28.2",
     "@backstage/e2e-test-utils": "^0.1.1",
     "@backstage/repo-tools": "^0.10.0",
     "@changesets/cli": "^2.27.1",
+    "@ianvs/prettier-plugin-sort-imports": "^4.4.0",
     "@spotify/prettier-config": "^15.0.0",
     "node-gyp": "^10.0.0",
     "prettier": "^2.3.2",

workspaces/analytics/plugins/analytics-module-ga/README.md

@@ -19,12 +19,12 @@ yarn --cwd packages/app add @backstage-community/plugin-analytics-module-ga
 
 ```tsx
 // packages/app/src/apis.ts
+import { GoogleAnalytics } from '@backstage-community/plugin-analytics-module-ga';
 import {
   analyticsApiRef,
   configApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
-import { GoogleAnalytics } from '@backstage-community/plugin-analytics-module-ga';
 
 export const apis: AnyApiFactory[] = [
   // Instantiate and register the GA Analytics API Implementation.
@@ -152,12 +152,12 @@ when you instantiate `GoogleAnalytics`. This function will be passed the
 as the user ID. For example:
 
 ```typescript
+import { GoogleAnalytics } from '@backstage-community/plugin-analytics-module-ga';
 import {
   analyticsApiRef,
   configApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
-import { GoogleAnalytics } from '@backstage-community/plugin-analytics-module-ga';
 
 export const apis: AnyApiFactory[] = [
   createApiFactory({

workspaces/analytics/plugins/analytics-module-ga/dev/Playground.tsx

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import React from 'react';
 import { Link } from '@backstage/core-components';
+import React from 'react';
 
 export const Playground = () => {
   return (

workspaces/analytics/plugins/analytics-module-ga/dev/index.tsx

@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import React from 'react';
-import { createDevApp } from '@backstage/dev-utils';
-import { Playground } from './Playground';
 import {
   analyticsApiRef,
   configApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
+import { createDevApp } from '@backstage/dev-utils';
+import React from 'react';
 import { GoogleAnalytics } from '../src';
+import { Playground } from './Playground';
 
 createDevApp()
   .registerApi({

workspaces/analytics/plugins/analytics-module-ga/report.api.md

@@ -3,6 +3,7 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
+
 import { AnalyticsApi } from '@backstage/core-plugin-api';
 import { AnalyticsApi as AnalyticsApi_2 } from '@backstage/frontend-plugin-api';
 import { AnalyticsEvent } from '@backstage/core-plugin-api';
@@ -12,19 +13,15 @@ import { Config } from '@backstage/config';
 import { IdentityApi } from '@backstage/core-plugin-api';
 
 // @public @deprecated (undocumented)
-export const analyticsModuleGA: BackstagePlugin<{}, {}, {}>;
+export const analyticsModuleGA: BackstagePlugin<    {}, {}, {}>;
 
 // @public
 export class GoogleAnalytics implements AnalyticsApi, AnalyticsApi_2 {
-  captureEvent(event: AnalyticsEvent | AnalyticsEvent_2): void;
-  static fromConfig(
-    config: Config,
-    options?: {
-      identityApi?: IdentityApi;
-      userIdTransform?:
-        | 'sha-256'
-        | ((userEntityRef: string) => Promise<string>);
-    },
-  ): GoogleAnalytics;
+    captureEvent(event: AnalyticsEvent | AnalyticsEvent_2): void;
+    static fromConfig(config: Config, options?: {
+        identityApi?: IdentityApi;
+        userIdTransform?: 'sha-256' | ((userEntityRef: string) => Promise<string>);
+    }): GoogleAnalytics;
 }
+
 ```

workspaces/analytics/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import ReactGA from 'react-ga';
+import { Config } from '@backstage/config';
 import {
   AnalyticsApi,
   AnalyticsContextValue,
@@ -24,10 +24,10 @@ import {
 } from '@backstage/core-plugin-api';
 import {
   AnalyticsApi as NewAnalyticsApi,
-  AnalyticsEvent as NewAnalyticsEvent,
   AnalyticsContextValue as NewAnalyticsContextValue,
+  AnalyticsEvent as NewAnalyticsEvent,
 } from '@backstage/frontend-plugin-api';
-import { Config } from '@backstage/config';
+import ReactGA from 'react-ga';
 import { DeferredCapture } from '../../../util';
 import {
   parseVirtualSearchPageViewConfig,

workspaces/analytics/plugins/analytics-module-ga/src/setupTests.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 import '@testing-library/jest-dom';
-
 // eslint-disable-next-line no-restricted-imports
 import { TextEncoder } from 'util';
 

workspaces/analytics/plugins/analytics-module-ga4/README.md

@@ -19,12 +19,12 @@ yarn --cwd packages/app add @backstage-community/plugin-analytics-module-ga4
 
 ```tsx
 // packages/app/src/apis.ts
+import { GoogleAnalytics4 } from '@backstage-community/plugin-analytics-module-ga4';
 import {
   analyticsApiRef,
   configApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
-import { GoogleAnalytics4 } from '@backstage-community/plugin-analytics-module-ga4';
 
 export const apis: AnyApiFactory[] = [
   // Instantiate and register the GA Analytics API Implementation.
@@ -140,12 +140,12 @@ when you instantiate `GoogleAnalytics`. This function will be passed the
 as the user ID. For example:
 
 ```typescript
+import { GoogleAnalytics } from '@backstage-community/plugin-analytics-module-ga';
 import {
   analyticsApiRef,
   configApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
-import { GoogleAnalytics } from '@backstage-community/plugin-analytics-module-ga';
 
 export const apis: AnyApiFactory[] = [
   createApiFactory({

workspaces/analytics/plugins/analytics-module-ga4/dev/Playground.tsx

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import React from 'react';
 import { Link } from '@backstage/core-components';
+import React from 'react';
 
 export const Playground = () => {
   return (

workspaces/analytics/plugins/analytics-module-ga4/dev/index.tsx

@@ -20,7 +20,6 @@ import {
 } from '@backstage/core-plugin-api';
 import { createDevApp } from '@backstage/dev-utils';
 import React from 'react';
-
 import { GoogleAnalytics4 } from '../src';
 import { Playground } from './Playground';
 

workspaces/analytics/plugins/analytics-module-ga4/report.api.md

@@ -3,12 +3,16 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
-import { AnalyticsApi } from '@backstage/core-plugin-api';
-import { AnalyticsApi as AnalyticsApi_2 } from '@backstage/frontend-plugin-api';
-import { AnalyticsEvent } from '@backstage/core-plugin-api';
-import { AnalyticsEvent as AnalyticsEvent_2 } from '@backstage/frontend-plugin-api';
 import { Config } from '@backstage/config';
-import { IdentityApi } from '@backstage/core-plugin-api';
+import {
+  AnalyticsApi,
+  AnalyticsEvent,
+  IdentityApi,
+} from '@backstage/core-plugin-api';
+import {
+  AnalyticsApi as AnalyticsApi_2,
+  AnalyticsEvent as AnalyticsEvent_2,
+} from '@backstage/frontend-plugin-api';
 
 // @public
 export class GoogleAnalytics4 implements AnalyticsApi, AnalyticsApi_2 {

workspaces/analytics/plugins/analytics-module-ga4/src/apis/implementations/AnalyticsApi/GoogleAnalytics4.test.ts

@@ -16,8 +16,8 @@
 import { ConfigReader } from '@backstage/config';
 import { IdentityApi } from '@backstage/core-plugin-api';
 import ReactGA from 'react-ga4';
-import { GoogleAnalytics4 } from './GoogleAnalytics4';
 import { UaEventOptions } from 'react-ga4/types/ga4';
+import { GoogleAnalytics4 } from './GoogleAnalytics4';
 
 const fnEvent = jest.spyOn(ReactGA, 'event');
 

workspaces/analytics/plugins/analytics-module-ga4/src/apis/implementations/AnalyticsApi/GoogleAnalytics4.ts

@@ -14,20 +14,20 @@
  * limitations under the License.
  */
 
-import ReactGA from 'react-ga4';
+import { Config } from '@backstage/config';
 import {
   AnalyticsApi,
   AnalyticsContextValue,
-  AnalyticsEventAttributes,
   AnalyticsEvent,
+  AnalyticsEventAttributes,
   IdentityApi,
 } from '@backstage/core-plugin-api';
 import {
   AnalyticsApi as NewAnalyticsApi,
-  AnalyticsEvent as NewAnalyticsEvent,
   AnalyticsContextValue as NewAnalyticsContextValue,
+  AnalyticsEvent as NewAnalyticsEvent,
 } from '@backstage/frontend-plugin-api';
-import { Config } from '@backstage/config';
+import ReactGA from 'react-ga4';
 import { DeferredCapture } from '../../../util/DeferredCapture';
 
 /**

workspaces/analytics/plugins/analytics-module-ga4/src/setupTests.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 import '@testing-library/jest-dom';
-
 // eslint-disable-next-line no-restricted-imports
 import { TextEncoder } from 'util';
 

workspaces/analytics/plugins/analytics-module-ga4/src/util/DeferredCapture.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 import ReactGA from 'react-ga4';
-
 import { UaEventOptions } from 'react-ga4/types/ga4';
 
 type Hit = {

workspaces/analytics/plugins/analytics-module-newrelic-browser/README.md

@@ -17,12 +17,12 @@ yarn --cwd packages/app add @backstage-community/plugin-analytics-module-newreli
 
 ```tsx
 // packages/app/src/apis.ts
+import { NewRelicBrowser } from '@backstage-community/plugin-analytics-module-newrelic-browser';
 import {
   analyticsApiRef,
   configApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
-import { NewRelicBrowser } from '@backstage-community/plugin-analytics-module-newrelic-browser';
 
 export const apis: AnyApiFactory[] = [
   // Instantiate and register the New Relic Browser API Implementation.
@@ -78,12 +78,12 @@ By default the user ID is calculated as a SHA-256 hash of the current user's `us
 different value, provide a `userIdTransform` function alongside `identityApi` when you instantiate `NewRelicBrowser`. This function will be passed the `userEntityRef` as an argument and should resolve to the value you wish to set as the user ID. For example:
 
 ```typescript
+import { GoogleAnalytics } from '@backstage-community/plugin-analytics-module-newrelic-browser';
 import {
   analyticsApiRef,
   configApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
-import { GoogleAnalytics } from '@backstage-community/plugin-analytics-module-newrelic-browser';
 
 export const apis: AnyApiFactory[] = [
   createApiFactory({

workspaces/analytics/plugins/analytics-module-newrelic-browser/dev/Playground.tsx

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import React from 'react';
 import { Link } from '@backstage/core-components';
+import React from 'react';
 
 export const Playground = () => {
   return (

workspaces/analytics/plugins/analytics-module-newrelic-browser/dev/index.tsx

@@ -13,15 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import React from 'react';
-import { createDevApp } from '@backstage/dev-utils';
 import {
   analyticsApiRef,
   configApiRef,
   identityApiRef,
 } from '@backstage/core-plugin-api';
-import { Playground } from './Playground';
+import { createDevApp } from '@backstage/dev-utils';
+import React from 'react';
 import { NewRelicBrowser } from '../src';
+import { Playground } from './Playground';
 
 createDevApp()
   .registerApi({

workspaces/analytics/plugins/analytics-module-newrelic-browser/report.api.md

@@ -3,12 +3,16 @@
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
 ```ts
-import { AnalyticsApi } from '@backstage/core-plugin-api';
-import { AnalyticsApi as AnalyticsApi_2 } from '@backstage/frontend-plugin-api';
-import { AnalyticsEvent } from '@backstage/core-plugin-api';
-import { AnalyticsEvent as AnalyticsEvent_2 } from '@backstage/frontend-plugin-api';
 import { Config } from '@backstage/config';
-import { IdentityApi } from '@backstage/core-plugin-api';
+import {
+  AnalyticsApi,
+  AnalyticsEvent,
+  IdentityApi,
+} from '@backstage/core-plugin-api';
+import {
+  AnalyticsApi as AnalyticsApi_2,
+  AnalyticsEvent as AnalyticsEvent_2,
+} from '@backstage/frontend-plugin-api';
 
 // @public
 export class NewRelicBrowser implements AnalyticsApi, AnalyticsApi_2 {

workspaces/analytics/plugins/analytics-module-newrelic-browser/src/apis/implementations/AnalyticsApi/NewRelicBrowser.ts

@@ -16,15 +16,15 @@
 import { Config } from '@backstage/config';
 import {
   AnalyticsApi,
-  IdentityApi,
   AnalyticsEvent,
+  IdentityApi,
 } from '@backstage/core-plugin-api';
 import {
   AnalyticsApi as NewAnalyicsApi,
   AnalyticsEvent as NewAnalyticsEvent,
 } from '@backstage/frontend-plugin-api';
-import { BrowserAgent } from '@newrelic/browser-agent/loaders/browser-agent';
 import type { setAPI } from '@newrelic/browser-agent/loaders/api/api';
+import { BrowserAgent } from '@newrelic/browser-agent/loaders/browser-agent';
 
 type NewRelicAPI = ReturnType<typeof setAPI>;
 

workspaces/analytics/plugins/analytics-provider-segment/.eslintignore

@@ -0,0 +1,2 @@
+dist-dynamic
+dist-scalprum