@aws-blocks/bb-metrics 0.1.2 → 0.1.4

package/dist/index.aws.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.aws.d.ts","sourceRoot":"","sources":["../src/index.aws.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EACX,cAAc,EACd,WAAW,EACX,WAAW,EAGX,kBAAkB,EAClB,cAAc,EACd,MAAM,YAAY,CAAC;AAUpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,YAAY,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,GACd,MAAM,YAAY,CAAC;AAIpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,OAAQ,SAAQ,KAAM,YAAW,cAAc;IAC3D,8EAA8E;IAC9E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,mEAAmE;IACnE,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE7D,2FAA2F;IAC3F,SAAS,CAAC,GAAG,EAAE,WAAW,CAAC;gBAEf,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAUpE;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI;IAe9D;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI;IAqBvC;;OAEG;IACH,KAAK,IAAI,IAAI;IAEb;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,cAAc;IAOzD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,kBAAkB;CAG1D"}
+{"version":3,"file":"index.aws.d.ts","sourceRoot":"","sources":["../src/index.aws.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EACX,cAAc,EACd,WAAW,EACX,WAAW,EAGX,kBAAkB,EAClB,cAAc,EACd,MAAM,YAAY,CAAC;AAWpB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,YAAY,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,GACd,MAAM,YAAY,CAAC;AAIpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,qBAAa,OAAQ,SAAQ,KAAM,YAAW,cAAc;IAC3D,8EAA8E;IAC9E,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,mEAAmE;IACnE,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE7D,2FAA2F;IAC3F,SAAS,CAAC,GAAG,EAAE,WAAW,CAAC;gBAEf,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAUpE;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI;IAe9D;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,GAAG,IAAI;IAqBvC;;OAEG;IACH,KAAK,IAAI,IAAI;IAEb;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,cAAc;IAOzD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,kBAAkB;CAG1D"}

package/dist/index.aws.js

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { Scope } from '@aws-blocks/core';
+import { BB_NAME, BB_VERSION } from './version.js';
 import { validateMetricName, validateDimensions, validateBatchSize, validateNamespace, mergeDimensions, } from './validation.js';
 import { Logger } from '@aws-blocks/bb-logger';
 export { MetricsErrors } from './errors.js';
@@ -61,7 +62,7 @@ export class Metrics extends Scope {
     /** @internal Logger for internal operations. Defaults to error-level when not provided. */
     log;
     constructor(scope, id, options) {
-        super(id, { parent: scope });
+        super(id, { parent: scope, bbName: BB_NAME, bbVersion: BB_VERSION });
         this.log = options?.logger ?? new Logger(this, 'logger', { level: 'error' });
         this.namespace = options?.metrics?.namespace
             ?? options?.namespace

package/dist/index.test.js

@@ -2,7 +2,14 @@
 // SPDX-License-Identifier: Apache-2.0
 import { test, describe, beforeEach, afterEach } from 'node:test';
 import assert from 'node:assert';
+import { readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { Scope } from '@aws-blocks/core';
 import { Metrics, MetricsErrors } from './index.mock.js';
+import { Metrics as AwsMetrics } from './index.aws.js';
+import { BB_NAME, BB_VERSION } from './version.js';
+const __dirname = dirname(fileURLToPath(import.meta.url));
 // ── Helpers ─────────────────────────────────────────────────────────────────
 let stdoutLines = [];
 let origStdoutWrite;
@@ -493,3 +500,42 @@ describe('scope integration', () => {
         assert.ok(typeof m.child === 'function');
     });
 });
+// ── Telemetry Registration ──────────────────────────────────────────────────
+/**
+ * `Scope.getRegisteredBlocks()` only names a block whose `bbName` is in
+ * OFFICIAL_BB_NAMES, and that set is generated from the umbrella's
+ * `aws-blocks.vendorize` map. These tests pin the three coupled artifacts to
+ * each other: the block's generated BB_NAME, its vendorize entry, and the
+ * generated name set. A block that omits `bbMeta` still constructs fine and
+ * every other test still passes, so that gap is only visible here.
+ *
+ * Imported through `./index.mock.js`, the package's default entry, which
+ * re-exports the AWS runtime class — so both conditions resolve to the class
+ * asserted here.
+ */
+describe('telemetry registration', () => {
+    beforeEach(() => {
+        Scope._resetRegistry();
+    });
+    test('BB_NAME is the name the vendorize map and OFFICIAL_BB_NAMES carry', () => {
+        assert.strictEqual(BB_NAME, 'Metrics');
+    });
+    test('BB_VERSION tracks the package version', () => {
+        const pkg = JSON.parse(readFileSync(join(__dirname, '..', 'package.json'), 'utf-8'));
+        assert.strictEqual(BB_VERSION, pkg.version);
+    });
+    test('the default entry re-exports the AWS runtime class', () => {
+        assert.strictEqual(Metrics, AwsMetrics);
+    });
+    test('an instance carries bbName and bbVersion', () => {
+        const m = new Metrics(fakeScope, 'metrics');
+        assert.strictEqual(m.bbName, BB_NAME);
+        assert.strictEqual(m.bbVersion, BB_VERSION);
+    });
+    test('registers as an official block, so telemetry is allowed to name it', () => {
+        new Metrics(fakeScope, 'metrics');
+        const { blocks, customBlocksCount } = Scope.getRegisteredBlocks();
+        assert.deepStrictEqual(blocks.filter(b => b.name === BB_NAME), [{ name: BB_NAME, version: BB_VERSION }]);
+        assert.strictEqual(customBlocksCount, 0, 'must not be filtered out as an unnamed custom block');
+    });
+});

package/dist/version.d.ts

@@ -0,0 +1,3 @@
+export declare const BB_NAME = "Metrics";
+export declare const BB_VERSION = "0.1.4";
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,YAAY,CAAC;AACjC,eAAO,MAAM,UAAU,UAAU,CAAC"}

package/dist/version.js

@@ -0,0 +1,3 @@
+// Auto-generated by scripts/generate-version.mjs — do not edit manually
+export const BB_NAME = 'Metrics';
+export const BB_VERSION = '0.1.4';

package/package.json

@@ -1,6 +1,15 @@
 {
   "name": "@aws-blocks/bb-metrics",
-  "version": "0.1.2",
+  "version": "0.1.4",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aws-devtools-labs/aws-blocks.git",
+    "directory": "packages/bb-metrics"
+  },
+  "homepage": "https://github.com/aws-devtools-labs/aws-blocks/tree/main/packages/bb-metrics#readme",
+  "bugs": {
+    "url": "https://github.com/aws-devtools-labs/aws-blocks/issues"
+  },
   "author": "Amazon Web Services",
   "license": "Apache-2.0",
   "type": "module",
@@ -24,12 +33,13 @@
     }
   },
   "scripts": {
+    "prebuild": "node ../../scripts/generate-version.mjs Metrics",
     "build": "tsc --build",
     "test": "node --test dist/**/*.test.js"
   },
   "dependencies": {
-    "@aws-blocks/core": "^0.1.1",
-    "@aws-blocks/bb-logger": "^0.1.2"
+    "@aws-blocks/core": "^0.2.0",
+    "@aws-blocks/bb-logger": "^0.1.4"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",

package/src/index.aws.ts

@@ -13,6 +13,7 @@ import type {
 	MetricsEmitter,
 } from './types.js';
 import { MetricsErrors } from './errors.js';
+import { BB_NAME, BB_VERSION } from './version.js';
 import {
 	validateMetricName,
 	validateDimensions,
@@ -94,7 +95,7 @@ export class Metrics extends Scope implements MetricsEmitter {
 	protected log: ChildLogger;
 
 	constructor(scope: ScopeParent, id: string, options?: MetricsOptions) {
-		super(id, { parent: scope });
+		super(id, { parent: scope, bbName: BB_NAME, bbVersion: BB_VERSION });
 		this.log = options?.logger ?? new Logger(this, 'logger', { level: 'error' });
 		this.namespace = options?.metrics?.namespace
 			?? options?.namespace

package/src/index.test.ts

@@ -3,8 +3,16 @@
 
 import { test, describe, beforeEach, afterEach } from 'node:test';
 import assert from 'node:assert';
+import { readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { Scope } from '@aws-blocks/core';
 import { Metrics, MetricsErrors } from './index.mock.js';
+import { Metrics as AwsMetrics } from './index.aws.js';
 import type { MetricsEmitter } from './types.js';
+import { BB_NAME, BB_VERSION } from './version.js';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 // ── Helpers ─────────────────────────────────────────────────────────────────
 
@@ -630,3 +638,52 @@ describe('scope integration', () => {
 		assert.ok(typeof m.child === 'function');
 	});
 });
+
+// ── Telemetry Registration ──────────────────────────────────────────────────
+
+/**
+ * `Scope.getRegisteredBlocks()` only names a block whose `bbName` is in
+ * OFFICIAL_BB_NAMES, and that set is generated from the umbrella's
+ * `aws-blocks.vendorize` map. These tests pin the three coupled artifacts to
+ * each other: the block's generated BB_NAME, its vendorize entry, and the
+ * generated name set. A block that omits `bbMeta` still constructs fine and
+ * every other test still passes, so that gap is only visible here.
+ *
+ * Imported through `./index.mock.js`, the package's default entry, which
+ * re-exports the AWS runtime class — so both conditions resolve to the class
+ * asserted here.
+ */
+describe('telemetry registration', () => {
+	beforeEach(() => {
+		Scope._resetRegistry();
+	});
+
+	test('BB_NAME is the name the vendorize map and OFFICIAL_BB_NAMES carry', () => {
+		assert.strictEqual(BB_NAME, 'Metrics');
+	});
+
+	test('BB_VERSION tracks the package version', () => {
+		const pkg = JSON.parse(readFileSync(join(__dirname, '..', 'package.json'), 'utf-8'));
+		assert.strictEqual(BB_VERSION, pkg.version);
+	});
+
+	test('the default entry re-exports the AWS runtime class', () => {
+		assert.strictEqual(Metrics, AwsMetrics);
+	});
+
+	test('an instance carries bbName and bbVersion', () => {
+		const m = new Metrics(fakeScope, 'metrics');
+		assert.strictEqual(m.bbName, BB_NAME);
+		assert.strictEqual(m.bbVersion, BB_VERSION);
+	});
+
+	test('registers as an official block, so telemetry is allowed to name it', () => {
+		new Metrics(fakeScope, 'metrics');
+		const { blocks, customBlocksCount } = Scope.getRegisteredBlocks();
+		assert.deepStrictEqual(
+			blocks.filter(b => b.name === BB_NAME),
+			[{ name: BB_NAME, version: BB_VERSION }],
+		);
+		assert.strictEqual(customBlocksCount, 0, 'must not be filtered out as an unnamed custom block');
+	});
+});

package/src/version.ts

@@ -0,0 +1,3 @@
+// Auto-generated by scripts/generate-version.mjs — do not edit manually
+export const BB_NAME = 'Metrics';
+export const BB_VERSION = '0.1.4';