@apollion-dsi/relay 0.27.2 → 0.28.0

package/package.json

@@ -1,17 +1,43 @@
 {
   "name": "@apollion-dsi/relay",
-  "version": "0.27.2",
+  "version": "0.28.0",
   "description": "Frontend services regarding Relay Environment",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
   "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.esm.js",
+      "require": "./lib/index.js"
+    },
+    "./setupRelayEnvironment": {
+      "types": "./lib/setupRelayEnvironment/index.d.ts",
+      "import": "./lib/setupRelayEnvironment/index.esm.js"
+    },
+    "./useEnvironment": {
+      "types": "./lib/useEnvironment/index.d.ts",
+      "import": "./lib/useEnvironment/index.esm.js"
+    },
+    "./relayArgsInterface": {
+      "types": "./lib/relayArgsInterface/index.d.ts",
+      "import": "./lib/relayArgsInterface/index.esm.js"
+    },
+    "./mutationUtils": {
+      "types": "./lib/mutationUtils/index.d.ts",
+      "import": "./lib/mutationUtils/index.esm.js"
+    },
+    "./commitMutation": {
+      "types": "./lib/commitMutation/index.d.ts",
+      "import": "./lib/commitMutation/index.esm.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "lib/**/*"
   ],
   "license": "MIT",
   "scripts": {
-    "prepare": "yarn build",
-    "pretest": "relay-compiler",
     "audit-dependencies": "yarn npm audit --severity moderate --no-deprecations",
     "coverage": "jest --coverage",
     "lint": "eslint src --quiet",
@@ -21,10 +47,11 @@
     "prettier": "prettier --check **/*.{ts,tsx} --ignore-path .gitignore --no-error-on-unmatched-pattern",
     "format": "yarn prettier --write",
     "validate": "./scripts/validate.sh",
-    "validate:tests": "jest --coverage",
+    "validate:tests": "relay-compiler && relay-compiler relay.persisted.config.json && jest --coverage",
     "build": "node -e \"require('fs').rmSync('./lib',{recursive:true,force:true})\" && node ./esbuild && tsc --emitDeclarationOnly",
     "test": "yarn validate",
-    "code:check": "yarn lint && yarn coverage"
+    "code:check": "yarn lint && yarn coverage",
+    "prepack": "node ../../scripts/release-preflight.js && yarn build"
   },
   "peerDependencies": {
     "react": "^19.0.0"
@@ -40,7 +67,7 @@
     "relay-test-utils": "^21.0.0"
   },
   "devDependencies": {
-    "@apollion-dsi/eslint-config": "0.9.0",
+    "@apollion-dsi/eslint-config": "0.10.0",
     "@babel/core": "7.29.0",
     "@babel/plugin-transform-class-properties": "7.27.1",
     "@babel/plugin-transform-runtime": "7.29.0",

package/README.MD

@@ -1,119 +0,0 @@
-# @apollion-dsi/relay
-
-Helpers para configurar e usar **Relay** (`react-relay` / `relay-runtime`)
-no padrão do Apollion DS. Cobre criação de Environment com auth,
-upload multipart, subscriptions via WebSocket e cookies de sessão.
-
-[![npm](https://img.shields.io/npm/v/@apollion-dsi/relay.svg)](https://www.npmjs.com/package/@apollion-dsi/relay)
-
-## Stack
-
-- **react-relay** 20.x
-- **relay-runtime** 20.x
-- **graphql** 15.x
-- **graphql-ws** 6.x (subscriptions)
-- **fetch-multipart-graphql** (uploads)
-- **js-cookie** (sessão)
-
-## Instalação
-
-```bash
-yarn add @apollion-dsi/relay react@19.2.6
-```
-
-> Para gerar artefatos Relay, o consumidor também precisa de
-> `relay-compiler` como dev dependency e configurar `relay.config.js`.
-
-## Uso básico
-
-Crie um Relay Environment para a aplicação:
-
-```ts
-import { CreateRelayEnvironment } from '@apollion-dsi/relay';
-
-export const { Environment } = new CreateRelayEnvironment({
-  url: 'https://api.example.com/graphql',
-});
-```
-
-Depois, embrulhe a árvore React com `RelayEnvironmentProvider`:
-
-```tsx
-import { RelayEnvironmentProvider } from 'react-relay';
-import { Environment } from './relay';
-import { App } from './app';
-
-<RelayEnvironmentProvider environment={Environment}>
-  <App />
-</RelayEnvironmentProvider>;
-```
-
-## Recursos do helper
-
-- **Autenticação** em dois modos: `Bearer` (token JS) ou **cookie
-  httpOnly** (ver abaixo).
-- **Multipart uploads** (`fetch-multipart-graphql`) — envie arquivos
-  diretamente em mutations.
-- **Subscriptions** via `graphql-ws`.
-- **Network retry / refresh** plugável.
-
-## Autenticação: Bearer vs. cookie httpOnly
-
-O Environment suporta dois modelos de auth via `authMode`.
-
-### `authMode: 'bearer'` (default — retrocompat)
-
-Lê o `sessionToken` do storage (`localStorage`/`cookie` JS-legível) e
-injeta `Authorization: Bearer <token>` em cada request. A verificação de
-sessão usa o probe `${authUrl}user/me`. Comportamento idêntico ao das
-versões anteriores — consumidores existentes não precisam mudar nada.
-
-```ts
-new CreateRelayEnvironment({
-  url: 'https://api.example.com/graphql/',
-  authUrl: 'https://api.example.com/auth/',
-  useAuthorization: true, // injeta Bearer
-  storageType: 'cookie', // cookie JS-legível ou 'localStorage'
-});
-```
-
-### `authMode: 'cookie'` (sessão por cookie httpOnly — recomendado p/ SPA)
-
-Modelo seguro: o token de sessão vive num cookie **httpOnly + SameSite**
-(invisível ao JS, imune a XSS). O Environment **não** lê o token nem
-injeta `Authorization` — `credentials: 'include'` (default neste modo)
-faz o browser anexar o cookie automaticamente, inclusive cross-origin.
-Em erro de auth (ex: 401), o refresh é disparado com `POST` em `authUrl`
-e `credentials: 'include'` — **sem** probe a `user/me`.
-
-```ts
-new CreateRelayEnvironment({
-  url: 'https://api.example.com/graphql/',
-  authUrl: 'https://api.example.com/auth/refresh/', // alvo do refresh on-401
-  authMode: 'cookie',
-  redirectOnError: true,
-  loginRoute: '/login',
-});
-```
-
-Opções relacionadas:
-
-| Opção | Default | O que faz |
-|---|---|---|
-| `authMode` | `'bearer'` | `'bearer'` (token + header) ou `'cookie'` (httpOnly). |
-| `credentials` | cookie→`'include'`; bearer→omitido | `RequestCredentials` repassado aos fetches GraphQL e de refresh. Funciona nos dois modos. |
-| `sessionCheckUrl` | modo-dependente | Sobrescreve a URL do probe; `false` desliga o probe (erro de auth → logout direto, sem request extra). |
-
-## Scripts (workspace)
-
-| Script | O que faz |
-|---|---|
-| `yarn workspace @apollion-dsi/relay run validate` | Lint + types + prettier + Jest + build. |
-| `yarn workspace @apollion-dsi/relay run coverage` | Jest coverage. |
-| `yarn workspace @apollion-dsi/relay run build` | esbuild + emit de types. |
-| `yarn workspace @apollion-dsi/relay run audit-dependencies` | audit-ci. |
-| `yarn workspace @apollion-dsi/relay run pretest` | `relay-compiler` (gera `__generated__` antes dos testes). |
-
-## Licença
-
-MIT.