@aws-blocks/create-block 0.2.0

package/dist/index.test.js

@@ -0,0 +1,247 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import assert from 'node:assert';
+import { existsSync, mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { describe, test } from 'node:test';
+import { deriveNames, findCustomerWorkspaceRoot, findMonorepoRoot, insertBetweenMarkers, normalizeClassName, normalizeWorkspaces, parseArgs, run, scopeFromPkgName, substituteTokens, toKebabCase, validateClassName, validateScope, workspacesCover, } from './index.js';
+describe('name validation', () => {
+    test('accepts PascalCase', () => {
+        assert.strictEqual(validateClassName('SearchIndex').ok, true);
+        assert.strictEqual(validateClassName('KVStore').ok, true);
+    });
+    test('rejects non-PascalCase', () => {
+        assert.strictEqual(validateClassName('searchIndex').ok, false);
+        assert.strictEqual(validateClassName('search-index').ok, false);
+        assert.strictEqual(validateClassName('').ok, false);
+        assert.strictEqual(validateClassName('9Lives').ok, false);
+    });
+    test('strips a leading BB prefix', () => {
+        assert.strictEqual(normalizeClassName('BBQueue'), 'Queue');
+        assert.strictEqual(normalizeClassName('bb-queue'), 'queue');
+        assert.strictEqual(normalizeClassName('SearchIndex'), 'SearchIndex');
+    });
+    test('does NOT mangle names that merely start with "Bb"', () => {
+        assert.strictEqual(normalizeClassName('BBox'), 'BBox');
+        assert.strictEqual(normalizeClassName('Bbox'), 'Bbox');
+    });
+});
+describe('scope validation', () => {
+    test('accepts valid npm scopes', () => {
+        assert.strictEqual(validateScope('acme').ok, true);
+        assert.strictEqual(validateScope('my-org').ok, true);
+        assert.strictEqual(validateScope('a1._-').ok, true);
+    });
+    test('rejects invalid scopes', () => {
+        assert.strictEqual(validateScope('Acme').ok, false); // uppercase
+        assert.strictEqual(validateScope('-bad').ok, false); // leading dash
+        assert.strictEqual(validateScope('has space').ok, false);
+        assert.strictEqual(validateScope('has"quote').ok, false);
+    });
+});
+describe('kebab derivation', () => {
+    test('converts PascalCase to kebab-case', () => {
+        assert.strictEqual(toKebabCase('DemoStore'), 'demo-store');
+        assert.strictEqual(toKebabCase('SearchIndex'), 'search-index');
+        assert.strictEqual(toKebabCase('Queue'), 'queue');
+    });
+    test('handles acronyms', () => {
+        assert.strictEqual(toKebabCase('SQLCache'), 'sql-cache');
+        assert.strictEqual(toKebabCase('HTTPQueue'), 'http-queue');
+    });
+});
+describe('name derivation by mode', () => {
+    test('contributor uses @aws-blocks scope', () => {
+        const n = deriveNames('SearchIndex', 'contributor', 'ignored');
+        assert.strictEqual(n.folder, 'bb-search-index');
+        assert.strictEqual(n.pkgName, '@aws-blocks/bb-search-index');
+    });
+    test('external uses the given scope', () => {
+        const n = deriveNames('SearchIndex', 'external', 'acme');
+        assert.strictEqual(n.pkgName, '@acme/bb-search-index');
+        assert.strictEqual(n.folder, 'bb-search-index');
+    });
+});
+describe('token substitution', () => {
+    test('replaces both tokens everywhere', () => {
+        const out = substituteTokens('class __BB_CLASS__ {} // from __BB_PKG_NAME__ (__BB_CLASS__)', {
+            className: 'Foo',
+            pkgName: '@x/bb-foo',
+        });
+        assert.strictEqual(out, 'class Foo {} // from @x/bb-foo (Foo)');
+    });
+});
+describe('marker insertion', () => {
+    test('adds markers when absent and inserts the entry', () => {
+        const out = insertBetweenMarkers('export const x = 1;\n', "export { Foo } from '@x/bb-foo';");
+        assert.match(out, /BEGIN:generated-block-exports/);
+        assert.match(out, /END:generated-block-exports/);
+        assert.match(out, /export \{ Foo \} from '@x\/bb-foo';/);
+    });
+    test('is idempotent — inserting the same entry twice adds it once', () => {
+        const entry = "export { Foo } from '@x/bb-foo';";
+        const once = insertBetweenMarkers('x\n', entry);
+        const twice = insertBetweenMarkers(once, entry);
+        assert.strictEqual(once, twice);
+        assert.strictEqual(twice.match(/@x\/bb-foo/g)?.length, 1);
+    });
+    test('keeps existing entries when adding a new one', () => {
+        const a = insertBetweenMarkers('x\n', "export { A } from '@x/bb-a';");
+        const b = insertBetweenMarkers(a, "export { B } from '@x/bb-b';");
+        assert.match(b, /bb-a/);
+        assert.match(b, /bb-b/);
+    });
+});
+describe('arg parsing', () => {
+    test('parses positional + flags', () => {
+        const o = parseArgs(['MyBlock', '--scope', 'acme', '--yes', '--dir', './x']);
+        assert.strictEqual(o.className, 'MyBlock');
+        assert.strictEqual(o.scope, 'acme');
+        assert.strictEqual(o.yes, true);
+        assert.strictEqual(o.dir, './x');
+    });
+    test('rejects unknown flags and extra positionals', () => {
+        assert.throws(() => parseArgs(['--bogus']));
+        assert.throws(() => parseArgs(['A', 'B']));
+    });
+    test('rejects a value flag with no value or a flag as its value', () => {
+        assert.throws(() => parseArgs(['MyBlock', '--dir', '--yes']), /--dir requires a value/);
+        assert.throws(() => parseArgs(['MyBlock', '--scope']), /--scope requires a value/);
+    });
+});
+describe('mode detection', () => {
+    test('detects a monorepo root by workspaces + packages/blocks', async () => {
+        const dir = mkdtempSync(join(tmpdir(), 'cb-root-'));
+        try {
+            writeFileSync(join(dir, 'package.json'), JSON.stringify({ workspaces: ['packages/blocks'] }));
+            mkdirSync(join(dir, 'packages', 'blocks'), { recursive: true });
+            const nested = join(dir, 'packages', 'bb-foo', 'src');
+            mkdirSync(nested, { recursive: true });
+            assert.strictEqual(await findMonorepoRoot(nested), dir);
+        }
+        finally {
+            rmSync(dir, { recursive: true, force: true });
+        }
+    });
+    test('returns null outside a monorepo', async () => {
+        const dir = mkdtempSync(join(tmpdir(), 'cb-ext-'));
+        try {
+            writeFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'random-app' }));
+            assert.strictEqual(await findMonorepoRoot(dir), null);
+        }
+        finally {
+            rmSync(dir, { recursive: true, force: true });
+        }
+    });
+});
+describe('workspaces helpers', () => {
+    test('normalizeWorkspaces handles array, object, and missing forms', () => {
+        assert.deepEqual(normalizeWorkspaces(['packages/*']), ['packages/*']);
+        assert.deepEqual(normalizeWorkspaces({ packages: ['apps/*', 'libs/*'] }), ['apps/*', 'libs/*']);
+        assert.deepEqual(normalizeWorkspaces(undefined), []);
+    });
+    test('scopeFromPkgName extracts the npm scope', () => {
+        assert.strictEqual(scopeFromPkgName('@acme/app'), 'acme');
+        assert.strictEqual(scopeFromPkgName('plain-app'), null);
+        assert.strictEqual(scopeFromPkgName(undefined), null);
+    });
+    test('workspacesCover matches exact entries and parent globs', () => {
+        assert.strictEqual(workspacesCover(['packages/*'], 'packages/bb-foo'), true);
+        assert.strictEqual(workspacesCover(['packages/**'], 'packages/bb-foo'), true);
+        assert.strictEqual(workspacesCover(['packages/bb-foo'], 'packages/bb-foo'), true);
+        assert.strictEqual(workspacesCover(['apps/*'], 'packages/bb-foo'), false);
+        assert.strictEqual(workspacesCover([], 'packages/bb-foo'), false);
+    });
+});
+describe('customer-mode detection', () => {
+    test('detects a customer workspace (workspaces, but not the Blocks repo)', async () => {
+        const dir = mkdtempSync(join(tmpdir(), 'cb-cust-'));
+        try {
+            writeFileSync(join(dir, 'package.json'), JSON.stringify({ name: '@acme/app', workspaces: ['packages/*'] }));
+            const nested = join(dir, 'src');
+            mkdirSync(nested, { recursive: true });
+            const found = await findCustomerWorkspaceRoot(nested);
+            assert.strictEqual(found?.root, dir);
+            assert.strictEqual(found?.pkg.name, '@acme/app');
+        }
+        finally {
+            rmSync(dir, { recursive: true, force: true });
+        }
+    });
+    test('does NOT treat the AWS Blocks monorepo as a customer workspace', async () => {
+        const dir = mkdtempSync(join(tmpdir(), 'cb-blk-'));
+        try {
+            writeFileSync(join(dir, 'package.json'), JSON.stringify({ workspaces: ['packages/blocks'] }));
+            mkdirSync(join(dir, 'packages', 'blocks'), { recursive: true });
+            assert.strictEqual(await findCustomerWorkspaceRoot(dir), null);
+        }
+        finally {
+            rmSync(dir, { recursive: true, force: true });
+        }
+    });
+    test('returns null when there are no workspaces', async () => {
+        const dir = mkdtempSync(join(tmpdir(), 'cb-none-'));
+        try {
+            writeFileSync(join(dir, 'package.json'), JSON.stringify({ name: 'plain-app' }));
+            assert.strictEqual(await findCustomerWorkspaceRoot(dir), null);
+        }
+        finally {
+            rmSync(dir, { recursive: true, force: true });
+        }
+    });
+});
+// End-to-end run() coverage for the file-writing / JSON-mutation paths that the
+// pure-helper tests can't reach. Hermetic: CREATE_BLOCK_SKIP_REGISTRY avoids the
+// npm-view call, and --skip-install/--skip-verify avoid shelling out.
+describe('run() integration — customer mode', () => {
+    function withWorkspace(fn) {
+        return async () => {
+            const dir = mkdtempSync(join(tmpdir(), 'cb-run-'));
+            const prev = process.env.CREATE_BLOCK_SKIP_REGISTRY;
+            process.env.CREATE_BLOCK_SKIP_REGISTRY = '1';
+            try {
+                await fn(dir);
+            }
+            finally {
+                if (prev === undefined)
+                    delete process.env.CREATE_BLOCK_SKIP_REGISTRY;
+                else
+                    process.env.CREATE_BLOCK_SKIP_REGISTRY = prev;
+                rmSync(dir, { recursive: true, force: true });
+            }
+        };
+    }
+    test('scaffolds packages/bb-*, links it into workspaces, substitutes tokens', withWorkspace(async (dir) => {
+        // workspaces glob does NOT cover packages/ → the entry must be appended.
+        writeFileSync(join(dir, 'package.json'), JSON.stringify({ name: '@acme/app', workspaces: ['apps/*'] }));
+        const code = await run(['SearchCache', '--yes', '--skip-install', '--skip-verify'], dir);
+        assert.strictEqual(code, 0);
+        const pkgDir = join(dir, 'packages', 'bb-search-cache');
+        const pkg = JSON.parse(readFileSync(join(pkgDir, 'package.json'), 'utf-8'));
+        assert.strictEqual(pkg.name, '@acme/bb-search-cache');
+        assert.ok(pkg.keywords.includes('aws-blocks'));
+        const rootWs = JSON.parse(readFileSync(join(dir, 'package.json'), 'utf-8')).workspaces;
+        assert.ok(rootWs.includes('packages/bb-search-cache'));
+        const mock = readFileSync(join(pkgDir, 'src', 'index.mock.ts'), 'utf-8');
+        assert.match(mock, /class SearchCache extends Scope/);
+        assert.doesNotMatch(mock, /__BB_CLASS__|__BB_PKG_NAME__/);
+        // standalone build helper written; core-coupled CDK synth test omitted
+        assert.ok(existsSync(join(pkgDir, 'scripts', 'generate-version.mjs')));
+        assert.ok(!existsSync(join(pkgDir, 'src', 'index.cdk.test.ts')));
+    }));
+    test('does not touch workspaces when a glob already covers packages/', withWorkspace(async (dir) => {
+        writeFileSync(join(dir, 'package.json'), JSON.stringify({ name: '@acme/app', workspaces: ['packages/*'] }));
+        const code = await run(['Widget', '--yes', '--skip-install', '--skip-verify'], dir);
+        assert.strictEqual(code, 0);
+        assert.deepEqual(JSON.parse(readFileSync(join(dir, 'package.json'), 'utf-8')).workspaces, ['packages/*']);
+        assert.ok(existsSync(join(dir, 'packages', 'bb-widget', 'package.json')));
+    }));
+    test('--dry-run writes nothing', withWorkspace(async (dir) => {
+        writeFileSync(join(dir, 'package.json'), JSON.stringify({ name: '@acme/app', workspaces: ['apps/*'] }));
+        const code = await run(['SearchCache', '--yes', '--dry-run'], dir);
+        assert.strictEqual(code, 0);
+        assert.ok(!existsSync(join(dir, 'packages')));
+        assert.deepEqual(JSON.parse(readFileSync(join(dir, 'package.json'), 'utf-8')).workspaces, ['apps/*']);
+    }));
+});

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@aws-blocks/create-block",
+  "version": "0.2.0",
+  "keywords": [
+    "aws-blocks"
+  ],
+  "description": "Scaffold a new AWS Blocks Building Block (bb-*) — inside the monorepo (contributor mode) or in your own project (external mode).",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aws-devtools-labs/aws-blocks.git",
+    "directory": "packages/create-block"
+  },
+  "homepage": "https://github.com/aws-devtools-labs/aws-blocks/tree/main/packages/create-block#readme",
+  "bugs": {
+    "url": "https://github.com/aws-devtools-labs/aws-blocks/issues"
+  },
+  "author": "Amazon Web Services",
+  "license": "Apache-2.0",
+  "type": "module",
+  "bin": {
+    "create-block": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "node --test dist/**/*.test.js"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.3.0"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "LICENSE"
+  ]
+}

package/templates/primitive/DESIGN.md

@@ -0,0 +1,27 @@
+# __BB_CLASS__ — Design
+
+TODO: describe the block's internals and the differences between the mock and
+AWS implementations. Delete the guidance below once filled in.
+
+## Infrastructure (CDK)
+
+`index.cdk.ts` provisions this block's resources (named off `this.fullId` so the
+runtime can derive the same name) and grants the shared Blocks Lambda access.
+Every runtime method is stubbed with `synthGuard` so a top-level call during
+synth fails loudly.
+
+## Runtime (AWS)
+
+`index.aws.ts` resolves resource identifiers from the registry **at call time**
+(`getSdkIdentifiers(this)`) and calls AWS via the SDK.
+
+## Mock Implementation
+
+`index.mock.ts` implements the same surface locally (in-memory or on-disk under
+`.bb-data/{fullId}/`) so `npm run dev` and tests need no AWS account.
+
+### Mock vs AWS Behavior Differences
+
+TODO: document any behavior that differs between the mock and AWS paths (e.g.
+eventual consistency, size limits, error names). Parity is covered by
+`parity.test.ts`.

package/templates/primitive/LICENSE

@@ -0,0 +1,174 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

package/templates/primitive/README.md

@@ -0,0 +1,43 @@
+# __BB_CLASS__
+
+TODO: one-sentence summary of what this Building Block does. (The first sentence
+becomes the block's blurb in the `@aws-blocks/blocks` catalog table.)
+
+**Keywords:** TODO, comma, separated
+
+A **primitive** block: it provisions and owns its own AWS infrastructure. The
+generated code is a storage-agnostic `Scope` skeleton with one example method —
+replace it with your block's real API and infrastructure. See `bb-kv-store` for a
+worked key/value example, `bb-file-bucket` for object storage.
+
+## API
+
+### `new __BB_CLASS__(scope, id, options?)`
+
+| Option | Type | Notes |
+| --- | --- | --- |
+| `label` | `string` | TODO — replace with your real options. |
+
+### Methods
+
+- `echo(input): Promise<string>` — TODO: replace with your block's methods.
+
+## Examples
+
+```ts
+import { Scope, ApiNamespace } from '@aws-blocks/blocks';
+import { __BB_CLASS__ } from '__BB_PKG_NAME__';
+
+const scope = new Scope('my-app');
+const thing = new __BB_CLASS__(scope, 'thing');
+
+export const api = new ApiNamespace(scope, 'api', () => ({
+	echo: (input: string) => thing.echo(input),
+}));
+```
+
+## Local Development
+
+`npm run dev` runs the mock entry (`index.mock.ts`) — no AWS account required.
+Implement local state there (in-memory or on-disk under `.bb-data/`). Wipe local
+state with `rm -rf .bb-data`.

package/templates/primitive/api-extractor.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../api-extractor.base.json",
+  "mainEntryPointFilePath": "<projectFolder>/dist/index.aws.d.ts"
+}

package/templates/primitive/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "__BB_PKG_NAME__",
+  "version": "0.1.0",
+  "description": "TODO: one-line description of the __BB_CLASS__ Building Block.",
+  "author": "Amazon Web Services",
+  "license": "Apache-2.0",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md",
+    "DESIGN.md",
+    "src",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "browser": "./dist/index.browser.js",
+      "cdk": {
+        "types": "./dist/index.cdk.d.ts",
+        "default": "./dist/index.cdk.js"
+      },
+      "aws-runtime": "./dist/index.aws.js",
+      "types": "./dist/index.mock.d.ts",
+      "default": "./dist/index.mock.js"
+    }
+  },
+  "scripts": {
+    "prebuild": "node ../../scripts/generate-version.mjs __BB_CLASS__",
+    "build": "tsc --build",
+    "test": "node --test --test-concurrency=1 dist/*.test.js"
+  },
+  "dependencies": {
+    "@aws-blocks/core": "^0.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.3.0"
+  },
+  "peerDependencies": {
+    "aws-cdk-lib": "^2.257.0",
+    "constructs": "^10.6.0"
+  }
+}

package/templates/primitive/src/errors.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Typed error constants for __BB_CLASS__. Match them in catch blocks with
+ * `isBlocksError(e, __BB_CLASS__Errors.Foo)` from `@aws-blocks/core` — errors
+ * cross the wire by `name`, so the same guard works server- and client-side.
+ */
+export const __BB_CLASS__Errors = {
+	/** TODO: rename/extend for this block's real failure modes. */
+	InvalidInput: 'InvalidInputException',
+} as const;

package/templates/primitive/src/index.aws.ts

@@ -0,0 +1,34 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Scope, registerSdkIdentifiers } from '@aws-blocks/core';
+import type { ScopeParent } from '@aws-blocks/core';
+import { BB_NAME, BB_VERSION } from './version.js';
+
+// ── Public types + errors ────────────────────────────────────────────────────
+export { __BB_CLASS__Errors } from './errors.js';
+export type { __BB_CLASS__Options } from './types.js';
+
+import type { __BB_CLASS__Options } from './types.js';
+
+/**
+ * See `index.mock.ts` for the authoritative JSDoc — the public surface must be
+ * identical. This is the **deployed Lambda runtime** (`aws-runtime` export): it
+ * talks to real AWS services via the SDK.
+ */
+export class __BB_CLASS__ extends Scope {
+	readonly bbName = BB_NAME;
+
+	constructor(scope: ScopeParent, id: string, _options?: __BB_CLASS__Options) {
+		super(id, { parent: scope, bbName: BB_NAME, bbVersion: BB_VERSION });
+		registerSdkIdentifiers(this.fullId, {});
+		// TODO: create your SDK client(s) here, e.g.:
+		//   this.client = new SomeClient({ customUserAgent: this.buildUserAgentChain() });
+	}
+
+	async echo(input: string): Promise<string> {
+		// TODO: resolve resource identifiers with `getSdkIdentifiers(this)` (at
+		// call time, never in the constructor) and call AWS.
+		return input;
+	}
+}

package/templates/primitive/src/index.browser.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// Browser stub — __BB_CLASS__ runs server-side only. Per the AWS Blocks
+// convention this entry re-exports the block's public types + error constants so
+// isomorphic/bundled client code type-checks; the methods live on the server
+// (mock/aws) entries and are absent here.
+export class __BB_CLASS__ {
+	constructor(..._args: unknown[]) {}
+}
+export { __BB_CLASS__Errors } from './errors.js';
+export type { __BB_CLASS__Options } from './types.js';