@lunch-money/v2-api-spec 2.11.1-preview.1 → 2.11.1-preview.11

package/README.md

@@ -14,6 +14,7 @@ After installation, the package provides:
 
 - **OpenAPI Specification**: `node_modules/@lunch-money/v2-api-spec/lunch-money-api-v2.yaml`
 - **Version History**: `node_modules/@lunch-money/v2-api-spec/version-history.md`
+- **OAuth scope catalog**: `@lunch-money/v2-api-spec/oauth-scopes`
 
 ## Usage
 
@@ -26,6 +27,22 @@ const specPath = require.resolve('@lunch-money/v2-api-spec/lunch-money-api-v2.ya
 const spec = fs.readFileSync(specPath, 'utf8');
 ```
 
+### Using the OAuth scope catalog
+
+The package also provides immutable OAuth scope and scope-group definitions.
+API scopes identify the V2 operations they authorize by `operationId`.
+
+```javascript
+const {
+  getOAuthScopeDefinition,
+  matchOAuthScopeGroup,
+  oauthScopeGroups,
+  oauthScopes,
+} = require('@lunch-money/v2-api-spec/oauth-scopes');
+
+const transactionRead = getOAuthScopeDefinition('transactions:read');
+```
+
 ### Using with OpenAPI Tools
 
 ```bash
@@ -39,73 +56,11 @@ npx @openapitools/openapi-generator-cli generate \
 npx swagger-cli validate node_modules/@lunch-money/v2-api-spec/lunch-money-api-v2.yaml
 ```
 
-### Updating URLs for Local Development
-
-The package includes a script to help switch between local and production URLs in the OpenAPI specification. This is useful when developing against a local server.
-
-#### Using the Script
-
-The script is located at `node_modules/@lunch-money/v2-api-spec/update-urls.sh`.
-
-**Required flags:**
-- `--local` - Switch URLs to local development (default: `http://localhost:3000/v2`)
-- `--production` - Switch URLs to production deployment URLs
-
-**Switch to production URLs (using defaults):**
-```bash
-cd node_modules/@lunch-money/v2-api-spec
-./update-urls.sh --production
-```
-
-**Switch to production URLs (with custom URLs):**
-```bash
-cd node_modules/@lunch-money/v2-api-spec
-API_DEPLOY_URL=https://api.lunchmoney.app/v2 \
-DOCS_DEPLOY_URL=https://alpha.lunchmoney.app/v2 \
-./update-urls.sh --production
-```
-
-**Switch to local URLs:**
-```bash
-cd node_modules/@lunch-money/v2-api-spec
-./update-urls.sh --local
-```
-
-**Switch to local URLs (with custom local URL):**
-```bash
-cd node_modules/@lunch-money/v2-api-spec
-LOCAL_URL=http://localhost:4000/v2 ./update-urls.sh --local
-```
-
-**Using environment variables:**
-Create a `.env` file in the package directory:
-```bash
-LOCAL_URL=http://localhost:3000/v2
-API_DEPLOY_URL=https://api.lunchmoney.app/v2
-DOCS_DEPLOY_URL=https://alpha.lunchmoney.app/v2
-```
-
-Then run:
-```bash
-./update-urls.sh --production
-# or
-./update-urls.sh --local
-```
-
-#### How It Works
-
-The script updates the `servers` section in the OpenAPI specification:
-- **Server 1**: Typically the production API server
-- **Server 2**: Typically a mock or staging server
-
-It also updates any references to these URLs throughout the specification file.
-
-#### Important Notes
+### Spec URLs
 
-- The script modifies the spec file in place
-- Changes are not persisted across `npm install` - the package will be restored to its original state
-- For persistent changes, consider copying the spec to your project directory first
-- The script works in both the npm package and the git repository
+The published YAML uses public production docs/API URLs. Do not rewrite them in this
+package for local or deploy environments — consuming apps (for example the Lunch Money
+docs/mock server) should rewrite an installed copy when needed.
 
 ## Versioning