@hous3-digital/vesta-sdk 1.0.0

package/README.md

@@ -0,0 +1,111 @@
+# SDK (Pacote) — Desenvolvimento e Uso
+
+Este `README` descreve o **pacote SDK** que vive em `app/`: como configurar, desenvolver, testar e consumir.
+
+Para documentação do repositório/template (fluxo de contribuição e CI/CD), veja `../README.md`.
+
+## 1) Configuração inicial do pacote
+
+1. Renomeie `package.json.example` para `package.json`.
+2. Ajuste os campos principais:
+   - `name` no escopo da organização (ex.: `@hous3-digital/nome-do-pacote`)
+   - `description`
+   - `repository`, `author`, `bugs`, `homepage`
+
+## 2) Estrutura do pacote
+
+```text
+app/
+├── src/
+│   └── index.ts          # API pública do pacote
+├── __test__/
+│   └── index.test.ts     # Testes unitários
+├── jest.config.js
+├── tsconfig.json
+├── tsconfig.eslint.json
+├── eslint.config.mjs
+└── package.json
+```
+
+## 3) Desenvolvimento local
+
+### Scripts
+
+- `yarn build`: compila TypeScript para `dist/`
+- `yarn test`: executa testes
+- `yarn test:watch`: testes em modo watch
+- `yarn test:coverage`: cobertura de testes
+- `yarn lint`: valida lint
+- `yarn lint:fix`: corrige lint automaticamente
+
+### Fluxo recomendado
+
+```bash
+yarn
+yarn lint
+yarn build
+yarn test
+```
+
+## 4) Como um dev externo instala e usa o SDK
+
+### Pré-requisitos
+
+- Node.js 22+
+- npm ou yarn
+- Token GitHub com `read:packages`
+
+### Autenticação para GitHub Packages
+
+No projeto consumidor, crie `.npmrc`:
+
+```ini
+@hous3-digital:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=SEU_GITHUB_TOKEN
+```
+
+### Instalação
+
+```bash
+npm install @hous3-digital/nome-do-pacote
+```
+
+ou
+
+```bash
+yarn add @hous3-digital/nome-do-pacote
+```
+
+### Primeiro uso
+
+```typescript
+import { suaFuncao } from '@hous3-digital/nome-do-pacote';
+
+const resultado = suaFuncao();
+console.log(resultado);
+```
+
+## 5) Publicação do pacote
+
+A publicação acontece via pipeline do repositório (não manualmente no dev local):
+
+1. Merge em `staging` gera pre-release.
+2. Promoção de release para `main` dispara release final.
+3. Publicação no GitHub Packages (e opcionalmente npmjs.com).
+
+## 6) Troubleshooting rápido
+
+### Testes falhando
+
+```bash
+yarn
+yarn build
+yarn test
+```
+
+### Erros de lint
+
+```bash
+yarn lint
+yarn lint:fix
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export declare function helloWorld(name?: string): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,wBAAgB,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAKhD"}

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.helloWorld = helloWorld;
+function helloWorld(name) {
+    if (name) {
+        return `Hello, ${name}!`;
+    }
+    return 'Hello, World!';
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@hous3-digital/vesta-sdk",
+  "version": "1.0.0",
+  "description": "SKD Vesta para integração com a API da Vesta",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src __test__ --ext .ts",
+    "lint:fix": "eslint src __test__ --ext .ts --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hous3-digital/vesta-sdk.git"
+  },
+  "keywords": [],
+  "author": "Hous3 Digital",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/hous3-digital/vesta-sdk/issues"
+  },
+  "homepage": "https://github.com/hous3-digital/vesta-sdk#readme",
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.5",
+    "@eslint/js": "^10.0.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/npm": "^13.1.5",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "@types/jest": "^30.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.59.2",
+    "@typescript-eslint/parser": "^8.59.2",
+    "eslint": "^10.3.0",
+    "globals": "^17.6.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^6.0.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com/",
+    "access": "restricted"
+  },
+  "dependencies": {}
+}