create-bridger-plugin 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/cli.mjs

@@ -0,0 +1,125 @@
+#!/usr/bin/env node
+import { join, resolve } from "node:path";
+import { parseArgs } from "node:util";
+import { cpSync, existsSync, readFileSync, readdirSync, renameSync, writeFileSync } from "node:fs";
+//#region src/config.ts
+const KNOWN = [
+	"npm",
+	"pnpm",
+	"yarn",
+	"bun"
+];
+/**
+* Lê o `npm_config_user_agent` (`pnpm/12.9.1 npm/? node/v24...`), que `npm create`, `pnpm create`,
+* `yarn create` e `bunx` preenchem. Sem ele, ou com um desconhecido, fica o `npm`.
+*/
+function detectPackageManager(userAgent = process.env["npm_config_user_agent"]) {
+	const name = userAgent?.split("/", 1)[0];
+	return KNOWN.find((pm) => pm === name) ?? "npm";
+}
+//#endregion
+//#region src/generate.ts
+/** Pasta do template: ao lado de `src/` no fonte e de `dist/` no pacote publicado. */
+const TEMPLATE_DIR = join(import.meta.dirname, "..", "template");
+const PLUGIN_NAME = /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/;
+const PACKAGE_NAME = /^(@[a-z0-9][a-z0-9._-]*\/)?[a-z0-9][a-z0-9._-]*$/;
+const PREFIX = "bridger-plugin-";
+/** Nome inválido para pacote ou plugin; a mensagem diz o que corrigir. */
+var PluginNameError = class extends Error {
+	name = "PluginNameError";
+};
+/** Pasta de destino já existe e tem arquivos: o scaffold não sobrescreve nada. */
+var TargetNotEmptyError = class extends Error {
+	name = "TargetNotEmptyError";
+};
+function pluginNames(packageName) {
+	if (!PACKAGE_NAME.test(packageName)) throw new PluginNameError(`"${packageName}" não é um nome de pacote npm válido: use minúsculas, dígitos e hífens, com escopo opcional (@acme/bridger-plugin-ola).`);
+	const directory = packageName.slice(packageName.indexOf("/") + 1);
+	const pluginName = directory.startsWith(PREFIX) ? directory.slice(15) : directory;
+	if (!PLUGIN_NAME.test(pluginName)) throw new PluginNameError(`"${pluginName}" não serve de nome de plugin: use kebab-case começando por letra (ola, boas-vindas).`);
+	return {
+		packageName,
+		pluginName,
+		exportName: pluginName.replace(/-([a-z0-9])/g, (_, c) => c.toUpperCase()),
+		directory
+	};
+}
+/**
+* Copia o template para `target` trocando os marcadores `__package__`, `__name__` e `__export__`.
+* O template guarda o `.gitignore` como `_gitignore`, porque o npm o tira do pacote publicado.
+*/
+function generate(target, names) {
+	if (existsSync(target) && readdirSync(target).length > 0) throw new TargetNotEmptyError(`A pasta ${target} já existe e não está vazia.`);
+	cpSync(TEMPLATE_DIR, target, { recursive: true });
+	renameSync(join(target, "_gitignore"), join(target, ".gitignore"));
+	for (const entry of readdirSync(target, {
+		recursive: true,
+		withFileTypes: true
+	})) {
+		if (!entry.isFile()) continue;
+		const path = join(entry.parentPath, entry.name);
+		const source = readFileSync(path, "utf8");
+		const next = source.replaceAll("__package__", names.packageName).replaceAll("__name__", names.pluginName).replaceAll("__export__", names.exportName);
+		if (next !== source) writeFileSync(path, next);
+	}
+}
+//#endregion
+//#region src/cli.ts
+const USAGE = `Uso: create-bridger-plugin <nome-do-pacote>
+
+Cria a pasta do plugin com manifesto, teste, README e changesets.
+
+  npm create bridger-plugin@latest bridger-plugin-ola
+  pnpm create bridger-plugin @acme/bridger-plugin-ola
+
+O nome do plugin é o do pacote sem escopo e sem o prefixo bridger-plugin- (ola).`;
+/** Roda o scaffold e devolve o código de saída. */
+function run(argv, io) {
+	let parsed;
+	try {
+		parsed = parse(argv);
+	} catch (error) {
+		io.err(`${error.message}\n\n${USAGE}`);
+		return 1;
+	}
+	if (parsed.values.help) {
+		io.out(USAGE);
+		return 0;
+	}
+	const [packageName] = parsed.positionals;
+	if (packageName === void 0 || parsed.positionals.length > 1) {
+		io.err(USAGE);
+		return 1;
+	}
+	try {
+		const names = pluginNames(packageName);
+		generate(resolve(io.cwd, names.directory), names);
+		const pm = io.packageManager ?? "npm";
+		io.out(`Plugin ${names.pluginName} criado em ${names.directory}/.\n\n  cd ${names.directory}\n  ${pm} install\n  ${pm} test\n`);
+		return 0;
+	} catch (error) {
+		if (error instanceof PluginNameError || error instanceof TargetNotEmptyError) {
+			io.err(error.message);
+			return 1;
+		}
+		throw error;
+	}
+}
+function parse(argv) {
+	return parseArgs({
+		args: [...argv],
+		allowPositionals: true,
+		options: { help: {
+			type: "boolean",
+			short: "h"
+		} }
+	});
+}
+if (import.meta.main) process.exitCode = run(process.argv.slice(2), {
+	cwd: process.cwd(),
+	out: (text) => process.stdout.write(`${text}\n`),
+	err: (text) => process.stderr.write(`${text}\n`),
+	packageManager: detectPackageManager()
+});
+//#endregion
+export { run };

package/package.json

@@ -1,6 +1,34 @@
 {
   "name": "create-bridger-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "Cria um plugin do Bridger pronto para desenvolver, testar e publicar.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/murillous/usebridger.git",
+    "directory": "packages/create-plugin"
+  },
+  "homepage": "https://github.com/murillous/usebridger/tree/develop/packages/create-plugin/docs#readme",
+  "bugs": "https://github.com/murillous/usebridger/issues",
+  "type": "module",
+  "imports": {
+    "#*": "./src/*"
+  },
+  "bin": {
+    "create-bridger-plugin": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist",
+    "template"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "e2e": "node scripts/e2e.ts"
+  }
 }

package/template/.changeset/README.md

@@ -0,0 +1,7 @@
+# Changesets
+
+Cada mudança que quem usa o plugin precisa saber leva um changeset: rode `npm run changeset`,
+escolha o tipo de bump e descreva a mudança. O arquivo gerado aqui vai no mesmo commit.
+
+Na hora de publicar, `npx changeset version` sobe a versão e escreve o `CHANGELOG.md`, e
+`npm run build && npx changeset publish` publica no npm.

package/template/.changeset/config.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@4.0.1/schema.json",
+  "baseBranch": "main",
+  "access": "public",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false
+}

package/template/README.md

@@ -0,0 +1,47 @@
+# __package__
+
+Plugin do [Bridger](https://github.com/murillous/usebridger). Responde `!ola` cumprimentando quem
+chamou.
+
+## Usar no bot
+
+```sh
+npm install __package__
+```
+
+```ts
+import { createBot } from '@usebridger/core';
+import { __export__ } from '__package__';
+
+const bot = createBot({ transport, plugins: [__export__] });
+await bot.start();
+```
+
+## Desenvolver
+
+| Comando | O que faz |
+| --- | --- |
+| `npm test` | Roda os testes (Vitest + `@usebridger/testing`), sem rede e sem WhatsApp |
+| `npm run typecheck` | Confere os tipos |
+| `npm run build` | Gera `dist/` (JS e `.d.ts`) |
+| `npm run changeset` | Registra uma mudança para o changelog |
+
+O plugin fica em `src/index.ts`, na forma curta: comandos em `commands` e eventos em `on`, direto
+no manifesto. O `setup(ctx)` entra quando precisar de algo dinâmico (registrar sob condição da
+config, rotas HTTP, serviços).
+
+## Rodar em qualquer plataforma
+
+O mesmo plugin roda no WhatsApp, no Telegram, no Discord e no chat web, se seguir três regras:
+
+- **`requires` só com o essencial.** O plugin que exige uma capability que o transport não tem é
+  ignorado no boot. O que é opcional se confere em runtime: `capabilities.has('reactions')`.
+- **Formatação pelos helpers.** `fmt`, `bold`, `italic`, `code`, `link` e `mention` viram a
+  marcação de cada plataforma. `*negrito*` escrito à mão só funciona no WhatsApp.
+- **Teste em todos os perfis.** O `describe.each(PROFILE_NAMES)` do teste roda o plugin com as
+  capabilities e o remetente de cada plataforma.
+
+## Publicar
+
+Versão e changelog saem dos changesets ([`.changeset/README.md`](.changeset/README.md)). O
+`version` do manifesto em `src/index.ts` acompanha o do `package.json`.

package/template/_gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

package/template/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "__package__",
+  "version": "0.1.0",
+  "description": "Plugin do Bridger.",
+  "keywords": [
+    "bridger",
+    "bridger-plugin"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "changeset": "changeset"
+  },
+  "peerDependencies": {
+    "@usebridger/core": "<1.0.0"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^3.0.3",
+    "@usebridger/core": "<1.0.0",
+    "@usebridger/testing": "<1.0.0",
+    "tsdown": "^0.23.0",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.3"
+  }
+}

package/template/src/index.test.ts

@@ -0,0 +1,26 @@
+import { createTestBot, PROFILE_NAMES, PROFILES } from '@usebridger/testing';
+import { describe, expect, it } from 'vitest';
+import { __export__ } from './index.ts';
+
+// O mesmo teste em todas as plataformas do kit: cada perfil traz as capabilities e o remetente
+// da plataforma, e um plugin que só passa no WhatsApp falha aqui.
+describe.each(PROFILE_NAMES)('no %s', (profile) => {
+  it('!ola cumprimenta quem chamou pelo nome', async () => {
+    const bot = await createTestBot({ profile, plugins: [__export__] });
+
+    await bot.receive({ text: '!ola', sender: { name: 'Ana' } });
+
+    expect(bot.sent).toContainText('Olá, Ana!');
+    await bot.stop();
+  });
+
+  it('reage só onde a plataforma tem reação', async () => {
+    const bot = await createTestBot({ profile, plugins: [__export__] });
+
+    await bot.receive({ text: '!ola' });
+
+    const reacts = PROFILES[profile].capabilities.includes('reactions');
+    expect(bot.transport.reactions).toHaveLength(reacts ? 1 : 0);
+    await bot.stop();
+  });
+});

package/template/src/index.ts

@@ -0,0 +1,20 @@
+import { bold, definePlugin, fmt, type PluginDefinition } from '@usebridger/core';
+
+/** `!ola` → cumprimenta quem chamou pelo nome, com uma reação onde a plataforma tem. */
+export const __export__: PluginDefinition = definePlugin({
+  name: '__name__',
+  version: '0.1.0',
+  engine: '<1.0.0',
+  // `commands` já exige `send.text`. Em `requires` vai só o que o plugin não funciona sem.
+  commands: {
+    ola: {
+      description: 'Cumprimenta quem chamou',
+      run: async (c, { capabilities }) => {
+        // Reação é extra: onde o transport não tem, o plugin segue só com o texto.
+        if (capabilities.has('reactions')) await c.react('👋');
+        // `fmt` e `bold` viram o negrito de cada plataforma (`*a*`, `**a**`, `<b>a</b>`).
+        return fmt`Olá, ${bold(c.message.sender.name ?? 'pessoa')}!`;
+      },
+    },
+  },
+});

package/template/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es2024",
+    "lib": ["es2024"],
+    "types": [],
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "moduleDetection": "force",
+    "verbatimModuleSyntax": true,
+    "allowImportingTsExtensions": true,
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noEmit": true,
+    // Tipos explícitos no que o pacote exporta: o tsdown gera o .d.ts sem rodar o compilador.
+    "declaration": true,
+    "isolatedDeclarations": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}

package/template/tsdown.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from 'tsdown';
+
+// O `@usebridger/core` fica fora do bundle (peer dependency): o plugin usa o core do bot.
+export default defineConfig({
+  entry: 'src/index.ts',
+  dts: true,
+});

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.