@reactionary/google-analytics 0.6.2 → 0.6.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,8 @@
1
1
  import {
2
- AnalyticsProvider
2
+ AnalyticsCapability
3
3
  } from "@reactionary/core";
4
- class GoogleAnalyticsAnalyticsProvider extends AnalyticsProvider {
4
+ class GoogleAnalyticsAnalyticsCapability extends AnalyticsCapability {
5
+ config;
5
6
  constructor(cache, context, configuration) {
6
7
  super(cache, context);
7
8
  this.config = configuration;
@@ -123,5 +124,5 @@ class GoogleAnalyticsAnalyticsProvider extends AnalyticsProvider {
123
124
  }
124
125
  }
125
126
  export {
126
- GoogleAnalyticsAnalyticsProvider
127
+ GoogleAnalyticsAnalyticsCapability
127
128
  };
@@ -1,18 +1,18 @@
1
1
  import {
2
2
  GoogleAnalyticsCapabilitiesSchema
3
3
  } from "../schema/capabilities.schema.js";
4
- import { GoogleAnalyticsAnalyticsProvider } from "../providers/analytics.provider.js";
4
+ import { GoogleAnalyticsAnalyticsCapability } from "../capabilities/analytics.capability.js";
5
5
  import {
6
- resolveProviderOnlyCapability
6
+ resolveDirectCapability
7
7
  } from "./initialize.types.js";
8
8
  function withGoogleAnalyticsCapabilities(configuration, capabilities) {
9
9
  return (cache, context) => {
10
10
  const client = {};
11
11
  const caps = GoogleAnalyticsCapabilitiesSchema.parse(capabilities);
12
12
  if (caps.analytics?.enabled) {
13
- client.analytics = resolveProviderOnlyCapability(
13
+ client.analytics = resolveDirectCapability(
14
14
  capabilities.analytics,
15
- (args) => new GoogleAnalyticsAnalyticsProvider(args.cache, args.context, args.config),
15
+ (args) => new GoogleAnalyticsAnalyticsCapability(args.cache, args.context, args.config),
16
16
  {
17
17
  cache,
18
18
  context,
@@ -1,7 +1,7 @@
1
- function resolveProviderOnlyCapability(capability, defaultProvider, args) {
2
- const provider = capability?.provider ?? defaultProvider;
3
- return provider(args);
1
+ function resolveDirectCapability(capability, defaultCapability, args) {
2
+ const capabilityFactory = capability?.capability ?? defaultCapability;
3
+ return capabilityFactory(args);
4
4
  }
5
5
  export {
6
- resolveProviderOnlyCapability
6
+ resolveDirectCapability
7
7
  };
package/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  export * from "./core/initialize.js";
2
2
  export * from "./core/initialize.types.js";
3
- export * from "./providers/analytics.provider.js";
3
+ export * from "./capabilities/analytics.capability.js";
4
4
  export * from "./schema/capabilities.schema.js";
5
5
  export * from "./schema/configuration.schema.js";
package/package.json CHANGED
@@ -1,12 +1,14 @@
1
1
  {
2
2
  "name": "@reactionary/google-analytics",
3
- "version": "0.6.2",
4
- "main": "index.js",
5
- "types": "src/index.d.ts",
3
+ "version": "0.6.4",
4
+ "type": "module",
5
+ "main": "./index.js",
6
+ "types": "./src/index.d.ts",
6
7
  "dependencies": {
7
- "@reactionary/core": "0.6.2",
8
- "zod": "4.1.9"
8
+ "@reactionary/core": "0.6.4",
9
+ "zod": "4.1.9",
10
+ "vitest": "^4.0.9",
11
+ "@nx/vite": "22.4.5"
9
12
  },
10
- "type": "module",
11
- "sideEffects": false
13
+ "sideEffets": false
12
14
  }
@@ -2,7 +2,7 @@ import { CapabilitiesSchema } from "@reactionary/core";
2
2
  import * as z from "zod";
3
3
  const AnalyticsCapabilitySchema = z.looseObject({
4
4
  enabled: z.boolean(),
5
- provider: z.unknown().optional()
5
+ capability: z.unknown().optional()
6
6
  });
7
7
  const GoogleAnalyticsCapabilitiesSchema = CapabilitiesSchema.pick({
8
8
  analytics: true
@@ -1,6 +1,6 @@
1
- import { AnalyticsProvider, type RequestContext, type Cache, type AnalyticsMutationProductSummaryViewEvent, type AnalyticsMutationProductSummaryClickEvent, type AnalyticsMutationProductDetailsViewEvent, type AnalyticsMutationProductAddToCartEvent, type AnalyticsMutationPurchaseEvent } from '@reactionary/core';
1
+ import { AnalyticsCapability, type RequestContext, type Cache, type AnalyticsMutationProductSummaryViewEvent, type AnalyticsMutationProductSummaryClickEvent, type AnalyticsMutationProductDetailsViewEvent, type AnalyticsMutationProductAddToCartEvent, type AnalyticsMutationPurchaseEvent } from '@reactionary/core';
2
2
  import type { GoogleAnalyticsConfiguration } from '../schema/configuration.schema.js';
3
- export declare class GoogleAnalyticsAnalyticsProvider extends AnalyticsProvider {
3
+ export declare class GoogleAnalyticsAnalyticsCapability extends AnalyticsCapability {
4
4
  protected config: GoogleAnalyticsConfiguration;
5
5
  constructor(cache: Cache, context: RequestContext, configuration: GoogleAnalyticsConfiguration);
6
6
  protected processProductSummaryView(event: AnalyticsMutationProductSummaryViewEvent): Promise<void>;
@@ -1,24 +1,24 @@
1
1
  import type { ClientFromCapabilities } from '@reactionary/core';
2
2
  import type { GoogleAnalyticsCapabilities } from '../schema/capabilities.schema.js';
3
- import type { GoogleAnalyticsAnalyticsProvider } from '../providers/analytics.provider.js';
3
+ import type { GoogleAnalyticsAnalyticsCapability } from '../capabilities/analytics.capability.js';
4
4
  type EnabledCapability<TCapability> = TCapability extends {
5
5
  enabled: true;
6
6
  } ? true : false;
7
7
  type NormalizeConfiguredCapabilities<T extends GoogleAnalyticsCapabilities> = Omit<T, 'analytics'> & {
8
8
  analytics?: EnabledCapability<T['analytics']>;
9
9
  };
10
- type ExtractCapabilityProvider<TCapability, TDefaultProvider> = TCapability extends {
10
+ type ExtractCapabilityImplementation<TCapability, TDefaultCapability> = TCapability extends {
11
11
  enabled: true;
12
- provider?: infer TProviderFactory;
13
- } ? TProviderFactory extends (...args: unknown[]) => infer TProvider ? TProvider : TDefaultProvider : TDefaultProvider;
14
- type CapabilityOverride<TCapability, TKey extends string, TProvider> = TCapability extends {
12
+ capability?: infer TCapabilityFactory;
13
+ } ? TCapabilityFactory extends (...args: unknown[]) => infer TResolvedCapability ? TResolvedCapability : TDefaultCapability : TDefaultCapability;
14
+ type CapabilityOverride<TCapability, TKey extends string, TResolvedCapability> = TCapability extends {
15
15
  enabled: true;
16
16
  } ? {
17
- [K in TKey]: TProvider;
17
+ [K in TKey]: TResolvedCapability;
18
18
  } : Record<never, never>;
19
- type AnalyticsProviderFor<T extends GoogleAnalyticsCapabilities> = ExtractCapabilityProvider<T['analytics'], GoogleAnalyticsAnalyticsProvider>;
20
- export type GoogleAnalyticsClientFromCapabilities<T extends GoogleAnalyticsCapabilities> = Omit<ClientFromCapabilities<NormalizeConfiguredCapabilities<T>>, 'analytics'> & CapabilityOverride<T['analytics'], 'analytics', AnalyticsProviderFor<T>>;
21
- export declare function resolveProviderOnlyCapability<TProvider, TProviderArgs>(capability: {
22
- provider?: (args: TProviderArgs) => TProvider;
23
- } | undefined, defaultProvider: (args: TProviderArgs) => TProvider, args: TProviderArgs): TProvider;
19
+ type AnalyticsCapabilityFor<T extends GoogleAnalyticsCapabilities> = ExtractCapabilityImplementation<T['analytics'], GoogleAnalyticsAnalyticsCapability>;
20
+ export type GoogleAnalyticsClientFromCapabilities<T extends GoogleAnalyticsCapabilities> = Omit<ClientFromCapabilities<NormalizeConfiguredCapabilities<T>>, 'analytics'> & CapabilityOverride<T['analytics'], 'analytics', AnalyticsCapabilityFor<T>>;
21
+ export declare function resolveDirectCapability<TResolvedCapability, TCapabilityArgs>(capability: {
22
+ capability?: (args: TCapabilityArgs) => TResolvedCapability;
23
+ } | undefined, defaultCapability: (args: TCapabilityArgs) => TResolvedCapability, args: TCapabilityArgs): TResolvedCapability;
24
24
  export {};
package/src/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export * from './core/initialize.js';
2
2
  export * from './core/initialize.types.js';
3
- export * from './providers/analytics.provider.js';
3
+ export * from './capabilities/analytics.capability.js';
4
4
  export * from './schema/capabilities.schema.js';
5
5
  export * from './schema/configuration.schema.js';
@@ -1,21 +1,21 @@
1
- import type { AnalyticsProvider, Cache, RequestContext } from '@reactionary/core';
1
+ import type { AnalyticsCapability, Cache, RequestContext } from '@reactionary/core';
2
2
  import type { GoogleAnalyticsConfiguration } from './configuration.schema.js';
3
3
  import * as z from 'zod';
4
4
  export declare const GoogleAnalyticsCapabilitiesSchema: z.ZodObject<{
5
5
  analytics: z.ZodOptional<z.ZodOptional<z.ZodObject<{
6
6
  enabled: z.ZodBoolean;
7
- provider: z.ZodOptional<z.ZodUnknown>;
7
+ capability: z.ZodOptional<z.ZodUnknown>;
8
8
  }, z.core.$loose>>>;
9
9
  }, z.core.$loose>;
10
- export interface GoogleAnalyticsProviderFactoryArgs {
10
+ export interface GoogleAnalyticsCapabilityFactoryArgs {
11
11
  cache: Cache;
12
12
  context: RequestContext;
13
13
  config: GoogleAnalyticsConfiguration;
14
14
  }
15
- export interface GoogleAnalyticsAnalyticsCapabilityConfig<TProvider extends AnalyticsProvider = AnalyticsProvider> {
15
+ export interface GoogleAnalyticsAnalyticsCapabilityConfig<TCapability extends AnalyticsCapability = AnalyticsCapability> {
16
16
  enabled: boolean;
17
- provider?: (args: GoogleAnalyticsProviderFactoryArgs) => TProvider;
17
+ capability?: (args: GoogleAnalyticsCapabilityFactoryArgs) => TCapability;
18
18
  }
19
- export type GoogleAnalyticsCapabilities<TAnalyticsProvider extends AnalyticsProvider = AnalyticsProvider> = {
20
- analytics?: GoogleAnalyticsAnalyticsCapabilityConfig<TAnalyticsProvider>;
19
+ export type GoogleAnalyticsCapabilities<TAnalyticsCapability extends AnalyticsCapability = AnalyticsCapability> = {
20
+ analytics?: GoogleAnalyticsAnalyticsCapabilityConfig<TAnalyticsCapability>;
21
21
  };