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

package/package.json

@@ -1,23 +1,46 @@
 {
   "name": "@lunch-money/v2-api-spec",
-  "version": "2.11.1-preview.1",
+  "version": "2.11.1-preview.11",
   "description": "OpenAPI specification and version history for the Lunch Money v2 API",
   "main": "lunch-money-api-v2.yaml",
+  "exports": {
+    ".": "./lunch-money-api-v2.yaml",
+    "./lunch-money-api-v2.yaml": "./lunch-money-api-v2.yaml",
+    "./version-history.md": "./version-history.md",
+    "./oauth-scopes": {
+      "types": "./oauth-scopes/index.d.ts",
+      "require": "./oauth-scopes/index.js",
+      "default": "./oauth-scopes/index.js"
+    },
+    "./oauth-client-logo": {
+      "types": "./oauth-client-logo/index.d.ts",
+      "require": "./oauth-client-logo/index.js",
+      "default": "./oauth-client-logo/index.js"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
   "files": [
     "lunch-money-api-v2.yaml",
     "version-history.md",
-    "README.md",
-    "update-urls.sh"
+    "oauth-scopes",
+    "oauth-client-logo",
+    "README.md"
   ],
   "scripts": {
     "prepare": "husky install",
-    "prepublishOnly": "node scripts/prep-for-publish.js",
+    "build:oauth-scopes": "tsc -p tsconfig.oauth-scopes.json",
+    "build:oauth-client-logo": "tsc -p tsconfig.oauth-client-logo.json",
+    "build:shared-contracts": "npm run build:oauth-scopes && npm run build:oauth-client-logo",
+    "test:oauth-scopes": "npm run build:oauth-scopes && node --test test/oauth-scopes/*.test.js",
+    "test:oauth-client-logo": "npm run build:oauth-client-logo && node --test test/oauth-client-logo/*.test.js",
+    "prepublishOnly": "npm run build:shared-contracts && node scripts/prep-for-publish.js",
     "postpublish": "node scripts/restore-readme.js",
-    "publish:docs": "npm --prefix packages/developer-docs publish --tag preview",
-    "publish:spec": "npm publish --tag preview",
+    "publish:docs": "node scripts/publish-docs.js --tag preview",
+    "publish:spec": "node scripts/publish-spec.js --tag preview",
     "publish:all": "npm run publish:docs && npm run publish:spec",
-    "publish:docs:latest": "npm --prefix packages/developer-docs publish",
-    "publish:spec:latest": "npm publish",
+    "publish:docs:latest": "node scripts/publish-docs.js",
+    "publish:spec:latest": "node scripts/publish-spec.js",
     "publish:all:latest": "npm run publish:docs:latest && npm run publish:spec:latest",
     "pack:docs": "node scripts/pack-docs.js",
     "pack:spec": "node scripts/pack-spec.js"
@@ -31,6 +54,8 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "husky": "^8.0.3"
+    "husky": "^8.0.3",
+    "typescript": "^5.9.0",
+    "yaml": "^2.8.0"
   }
 }

package/version-history.md

@@ -6,29 +6,35 @@ The Lunch Money API spec uses a modified version of SEMVER for its versioning me
 - The revision number represents the number of updates since the last endpoint was added.  For example, each time changes are made to one of the existing three APIs as described above, the revision number will be bumped.
 
 ## v2.11.1 - TBD
+- Add the OAuth scope and scope-group catalog mapped to V2 `operationId` values
 - Add `GET /me/account/settings` and `PUT /me/account/settings` for account-level settings
 - Add `GET /me/user/settings` and `PUT /me/user/settings` for user-level display and formatting preferences
+- Add `GET /me/user/account/settings` and `PUT /me/user/account/settings` for settings specific to a user and budgeting account
+from `GET /me/account/settings` and `PUT /me/account/settings` to `GET /me/user/account/settings` and `PUT /me/user/account/settings`
+- Add `include_pending_in_totals` to `GET /me/account/settings` and `PUT /me/account/settings`
+- Add `default_manual_account_id` to `GET /me/user/account/settings` and `PUT /me/user/account/settings`
 - Document `GET /budgets/settings` response schema publicly; change `budget_period_quantity` to integer
 
-## v2.11.0 - TBD
-- Add `GET /balance_history`
-- Add `GET /balance_history/{account_type}/{account_id}`
-- Add `GET /balance_history/crypto_synced/{account_id}/{symbol}`
-- Add `PUT /balance_history/{account_type}/{account_id}`
-- Add `PUT /balance_history/crypto_synced/{account_id}/{symbol}`
-- Add `DELETE /balance_history/entries/{id}`
-- Add `DELETE /balance_history/{account_type}/{account_id}`
-- Add `DELETE /balance_history/crypto_synced/{account_id}/{symbol}`
-- Add `PUT /balance_history/deleted/{account_id}/details`
-- Remove `rollover_pool` from the category object returned in the summary response. It is in the main summary response.
-- It is now possible to set an external_id on any transaction, including those that belong to a Plaid account.
-
-## v2.10.0 - TBD
-- Add v2 crypto endpoints which support:
-  - Discovering the currently supported currencies for manually managed crypto assets
-  - Managing the complete lifecycle of manually managed crypto assets (create, read, update, delete)
-  - Viewing the balances for currencies associated with both manually managed crypto assets and those that are synced via a synced crypto account (ie: coinbase, kraken, ethereum wallet)
-  - Refreshing synced crypto account balances
+## v2.11.0 - Jul 31, 2026
+- Add `/balance_history` endpoints:
+  - `GET /balance_history`
+  - `GET /balance_history/{account_type}/{account_id}`
+  - `GET /balance_history/crypto_synced/{account_id}/{symbol}`
+  - `PUT /balance_history/{account_type}/{account_id}`
+  - `PUT /balance_history/crypto_synced/{account_id}/{symbol}`
+  - `DELETE /balance_history/entries/{id}`
+  - `DELETE /balance_history/{account_type}/{account_id}`
+  - `DELETE /balance_history/crypto_synced/{account_id}/{symbol}`
+  - `PUT /balance_history/deleted/{account_id}/details`
+- Remove `rollover_pool` from category objects in the `GET /summary` response
+- Allow setting `external_id` on Plaid-account transactions
+- Allow `null` for `category_id` and `notes` on split children to clear those values instead of inheriting from the parent
+
+## v2.10.0 - Jul 31, 2026
+- Add crypto endpoints:
+  - `GET /cryptocurrencies`
+  - `GET /crypto/manual`, `POST /crypto/manual`, `GET /crypto/manual/{id}`, `PUT /crypto/manual/{id}`, `DELETE /crypto/manual/{id}`
+  - `GET /crypto/synced`, `GET /crypto/synced/{id}`, `GET /crypto/synced/{id}/{symbol}`, `POST /crypto/synced/{id}/refresh`
 
 ## v2.9.4 - May 23, 2026
 - Increase allowable length for transaction `notes`.

package/update-urls.sh

@@ -1,135 +0,0 @@
-#!/bin/bash
-
-# Script to update URLs in the OpenAPI specification file
-# This is useful for switching the docs/mock server URL between local development and production
-# Note: All references to DOCS_DEPLOY_URL throughout the file are toggled; the API server URL remains unchanged
-#
-# Usage:
-#   # In git repo:
-#   ./scripts/update-urls.sh --local|--production
-#   
-#   # In npm package:
-#   ./update-urls.sh --local|--production
-#
-# Flags:
-#   --local       Switch docs/mock server URL to local development (http://localhost:3000/v2)
-#   --production  Switch docs/mock server URL to production deployment URL
-#
-# Environment variables (optional, with defaults):
-#   LOCAL_URL - Local development URL (default: http://localhost:3000/v2)
-#   DOCS_DEPLOY_URL - Docs/mock deployment URL (default: https://alpha.lunchmoney.dev/v2)
-#
-# Examples:
-#   # Switch to production URL (using defaults)
-#   ./update-urls.sh --production
-#
-#   # Switch to production URL (with custom URL)
-#   DOCS_DEPLOY_URL=https://alpha.lunchmoney.dev/v2 ./update-urls.sh --production
-#
-#   # Switch to local URL
-#   ./update-urls.sh --local
-#
-#   # Switch to local URL (with custom local URL)
-#   LOCAL_URL=http://localhost:4000/v2 ./update-urls.sh --local
-
-set -e
-
-# Get the directory where the script is located
-SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-
-# Determine if we're in the git repo or npm package
-# In git repo: script is in scripts/ subdirectory, spec is in v2/spec/
-# In npm package: script is at root, spec is at root
-if [ -f "$SCRIPT_DIR/../v2/spec/lunch-money-api-v2.yaml" ]; then
-  # In the git repo (script is in scripts/ subdirectory)
-  REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
-  SPEC_FILE="$REPO_ROOT/v2/spec/lunch-money-api-v2.yaml"
-elif [ -f "$SCRIPT_DIR/lunch-money-api-v2.yaml" ]; then
-  # In the npm package (script is at root, spec is in same directory)
-  REPO_ROOT="$SCRIPT_DIR"
-  SPEC_FILE="$REPO_ROOT/lunch-money-api-v2.yaml"
-else
-  echo "Error: Could not find lunch-money-api-v2.yaml"
-  echo "  Looked in: $SCRIPT_DIR/v2/spec/"
-  echo "  Looked in: $SCRIPT_DIR/"
-  exit 1
-fi
-
-# Load environment variables from .env file if it exists and variables are not already set
-if [ -f "$REPO_ROOT/.env" ]; then
-  export $(grep -v '^#' "$REPO_ROOT/.env" | xargs)
-fi
-
-# Set default values for the URLs if not provided
-LOCAL_URL=${LOCAL_URL:-"http://localhost:3000/v2"}
-DOCS_DEPLOY_URL=${DOCS_DEPLOY_URL:-"https://alpha.lunchmoney.dev/v2"}
-
-# Function to show help and exit
-show_help() {
-  echo "Usage: $0 --local|--production"
-  echo ""
-  echo "Flags (required):"
-  echo "  --local       Switch docs/mock server URL to local development"
-  echo "  --production  Switch docs/mock server URL to production deployment"
-  echo ""
-  echo "Environment variables (optional, with defaults):"
-  echo "  LOCAL_URL       Local development URL (default: http://localhost:3000/v2)"
-  echo "  DOCS_DEPLOY_URL Docs/mock deployment URL (default: https://alpha.lunchmoney.dev/v2)"
-  echo ""
-  echo "Examples:"
-  echo "  # Switch to production URL (using defaults)"
-  echo "  $0 --production"
-  echo ""
-  echo "  # Switch to production URL (with custom URL)"
-  echo "  DOCS_DEPLOY_URL=https://alpha.lunchmoney.dev/v2 $0 --production"
-  echo ""
-  echo "  # Switch to local URL"
-  echo "  $0 --local"
-  echo ""
-  echo "  # Switch to local URL (with custom local URL)"
-  echo "  LOCAL_URL=http://localhost:4000/v2 $0 --local"
-  echo ""
-  echo "Note: Environment variables can also be set in a .env file in the repository root."
-  echo "Note: All references to DOCS_DEPLOY_URL throughout the file are updated; the API server URL remains unchanged."
-  exit 1
-}
-
-# Function to replace all occurrences of the docs/mock server URL in the spec file
-replace_docs_url() {
-  local from_url=$1
-  local to_url=$2
-
-  if [ ! -f "$SPEC_FILE" ]; then
-    echo "Error: Spec file not found at $SPEC_FILE"
-    exit 1
-  fi
-
-  echo "Updating all references to docs/mock server URL in $SPEC_FILE..."
-  echo "  From: $from_url"
-  echo "  To: $to_url"
-
-  # Replace all occurrences of the URL throughout the entire file
-  # Using sed with proper escaping for URLs
-  # Escape special regex characters in from_url
-  escaped_from_url=$(echo "$from_url" | sed 's/[[\.*^$()+?{|]/\\&/g')
-  # Use a temporary file for cross-platform compatibility
-  sed "s|$escaped_from_url|$to_url|g" "$SPEC_FILE" > "$SPEC_FILE.tmp" && mv "$SPEC_FILE.tmp" "$SPEC_FILE"
-
-  echo "✓ URLs updated successfully"
-}
-
-# Check for required flag
-if [ "$1" == "--local" ]; then
-  echo "Switching docs/mock server URL to local development..."
-  echo "  Using LOCAL_URL: $LOCAL_URL"
-  replace_docs_url "$DOCS_DEPLOY_URL" "$LOCAL_URL"
-elif [ "$1" == "--production" ]; then
-  echo "Switching docs/mock server URL to production..."
-  echo "  Using DOCS_DEPLOY_URL: $DOCS_DEPLOY_URL"
-  replace_docs_url "$LOCAL_URL" "$DOCS_DEPLOY_URL"
-else
-  echo "Error: A flag is required (--local or --production)"
-  echo ""
-  show_help
-fi
-