@dotcom-tool-kit/plugin - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0-beta.1

CHANGELOG.md

 # Changelog
 
+## [2.1.0](https://github.com/Financial-Times/dotcom-tool-kit/compare/plugin-v2.0.0...plugin-v2.1.0) (2026-01-13)
+
+
+### Features
+
+* **plugin:** add systemCode option to root Tool Kit options ([49bc3e9](https://github.com/Financial-Times/dotcom-tool-kit/commit/49bc3e97195f35f3504c4d042bfd7951e8ebf291))
+* **telemetry:** add option to opt-in to telemetry ([2cccf95](https://github.com/Financial-Times/dotcom-tool-kit/commit/2cccf957604a94dcc2baf3335c4b304631c98b65))
+
 ## [2.0.0](https://github.com/Financial-Times/dotcom-tool-kit/compare/plugin-v1.1.0...plugin-v2.0.0) (2025-10-28)
@@ -4,0 +12,0 @@

lib/root-schema.d.ts

 import * as z from 'zod';
 export declare const RootSchema: z.ZodObject<{
     allowNativeFetch: z.ZodDefault<z.ZodBoolean>;
+    enableTelemetry: z.ZodDefault<z.ZodBoolean>;
+    systemCode: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     allowNativeFetch: boolean;
+    enableTelemetry: boolean;
+    systemCode?: string | undefined;
 }, {
     allowNativeFetch?: boolean | undefined;
+    enableTelemetry?: boolean | undefined;
+    systemCode?: string | undefined;
 }>;
 export type RootOptions = z.infer<typeof RootSchema>;
 //# sourceMappingURL=root-schema.d.ts.map

lib/root-schema.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"root-schema.d.ts","sourceRoot":"","sources":["../src/root-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,eAAO,MAAM,UAAU;;;;;;EAErB,CAAA;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA"}
+{"version":3,"file":"root-schema.d.ts","sourceRoot":"","sources":["../src/root-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,eAAO,MAAM,UAAU;;;;;;;;;;;;EAarB,CAAA;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA"}

lib/root-schema.js

@@ -7,3 +7,12 @@ "use strict";
 exports.RootSchema = z.object({
-    allowNativeFetch: z.boolean().default(false)
+    allowNativeFetch: z.boolean().default(false),
+    enableTelemetry: z
+        .boolean()
+        .default(false)
+        .describe('Opt-in to send telemetry on your Tool Kit usage so we can track user patterns and friction points. This will be opt-out in a future version once the telemetry API has stabilised.'),
+    // TODO:IM:20251112 require this option in a future major version
+    systemCode: z
+        .string()
+        .optional()
+        .describe('Biz Ops system code or the package name prefixed with "npm:" otherwise')
 });

package.json

 {
   "name": "@dotcom-tool-kit/plugin",
-  "version": "2.0.0",
+  "version": "2.1.0-beta.1",
   "description": "",
@@ -16,2 +16,2 @@ "main": "lib",
   }
-}
+}

src/root-schema.ts

 import * as z from 'zod'
 
 export const RootSchema = z.object({
-  allowNativeFetch: z.boolean().default(false)
+  allowNativeFetch: z.boolean().default(false),
+  enableTelemetry: z
+    .boolean()
+    .default(false)
+    .describe(
+      'Opt-in to send telemetry on your Tool Kit usage so we can track user patterns and friction points. This will be opt-out in a future version once the telemetry API has stabilised.'
+    ),
+  // TODO:IM:20251112 require this option in a future major version
+  systemCode: z
+    .string()
+    .optional()
+    .describe('Biz Ops system code or the package name prefixed with "npm:" otherwise')
 })
 export type RootOptions = z.infer<typeof RootSchema>

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9944

20.23%

Lines of code

170

18.06%

Worsened metrics

Number of low quality alerts

3

50%

No dependency changes