@goodsamsoftware/freshbooks-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +357 -0
- package/dist/auth/config.d.ts +57 -0
- package/dist/auth/config.d.ts.map +1 -0
- package/dist/auth/config.js +118 -0
- package/dist/auth/config.js.map +1 -0
- package/dist/auth/index.d.ts +47 -0
- package/dist/auth/index.d.ts.map +1 -0
- package/dist/auth/index.js +46 -0
- package/dist/auth/index.js.map +1 -0
- package/dist/auth/oauth.d.ts +93 -0
- package/dist/auth/oauth.d.ts.map +1 -0
- package/dist/auth/oauth.js +279 -0
- package/dist/auth/oauth.js.map +1 -0
- package/dist/auth/token-store.d.ts +80 -0
- package/dist/auth/token-store.d.ts.map +1 -0
- package/dist/auth/token-store.js +204 -0
- package/dist/auth/token-store.js.map +1 -0
- package/dist/auth/types.d.ts +76 -0
- package/dist/auth/types.d.ts.map +1 -0
- package/dist/auth/types.js +20 -0
- package/dist/auth/types.js.map +1 -0
- package/dist/client/freshbooks-client.d.ts +99 -0
- package/dist/client/freshbooks-client.d.ts.map +1 -0
- package/dist/client/freshbooks-client.js +283 -0
- package/dist/client/freshbooks-client.js.map +1 -0
- package/dist/client/index.d.ts +5 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +5 -0
- package/dist/client/index.js.map +1 -0
- package/dist/config/index.d.ts +17 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +81 -0
- package/dist/config/index.js.map +1 -0
- package/dist/errors/documentation.d.ts +57 -0
- package/dist/errors/documentation.d.ts.map +1 -0
- package/dist/errors/documentation.js +390 -0
- package/dist/errors/documentation.js.map +1 -0
- package/dist/errors/error-codes.d.ts +45 -0
- package/dist/errors/error-codes.d.ts.map +1 -0
- package/dist/errors/error-codes.js +94 -0
- package/dist/errors/error-codes.js.map +1 -0
- package/dist/errors/error-handler.d.ts +127 -0
- package/dist/errors/error-handler.d.ts.map +1 -0
- package/dist/errors/error-handler.js +283 -0
- package/dist/errors/error-handler.js.map +1 -0
- package/dist/errors/error-mapper.d.ts +68 -0
- package/dist/errors/error-mapper.d.ts.map +1 -0
- package/dist/errors/error-mapper.js +449 -0
- package/dist/errors/error-mapper.js.map +1 -0
- package/dist/errors/index.d.ts +37 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/index.js +41 -0
- package/dist/errors/index.js.map +1 -0
- package/dist/errors/response-formatter.d.ts +109 -0
- package/dist/errors/response-formatter.d.ts.map +1 -0
- package/dist/errors/response-formatter.js +232 -0
- package/dist/errors/response-formatter.js.map +1 -0
- package/dist/errors/types.d.ts +194 -0
- package/dist/errors/types.d.ts.map +1 -0
- package/dist/errors/types.js +134 -0
- package/dist/errors/types.js.map +1 -0
- package/dist/server.d.ts +10 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +263 -0
- package/dist/server.js.map +1 -0
- package/dist/tools/base-tool.d.ts +146 -0
- package/dist/tools/base-tool.d.ts.map +1 -0
- package/dist/tools/base-tool.js +161 -0
- package/dist/tools/base-tool.js.map +1 -0
- package/dist/tools/bill/bill-archive.d.ts +40 -0
- package/dist/tools/bill/bill-archive.d.ts.map +1 -0
- package/dist/tools/bill/bill-archive.js +68 -0
- package/dist/tools/bill/bill-archive.js.map +1 -0
- package/dist/tools/bill/bill-create.d.ts +178 -0
- package/dist/tools/bill/bill-create.d.ts.map +1 -0
- package/dist/tools/bill/bill-create.js +70 -0
- package/dist/tools/bill/bill-create.js.map +1 -0
- package/dist/tools/bill/bill-delete.d.ts +40 -0
- package/dist/tools/bill/bill-delete.d.ts.map +1 -0
- package/dist/tools/bill/bill-delete.js +67 -0
- package/dist/tools/bill/bill-delete.js.map +1 -0
- package/dist/tools/bill/bill-list.d.ts +249 -0
- package/dist/tools/bill/bill-list.d.ts.map +1 -0
- package/dist/tools/bill/bill-list.js +114 -0
- package/dist/tools/bill/bill-list.js.map +1 -0
- package/dist/tools/bill/bill-single.d.ts +142 -0
- package/dist/tools/bill/bill-single.d.ts.map +1 -0
- package/dist/tools/bill/bill-single.js +62 -0
- package/dist/tools/bill/bill-single.js.map +1 -0
- package/dist/tools/bill/index.d.ts +11 -0
- package/dist/tools/bill/index.d.ts.map +1 -0
- package/dist/tools/bill/index.js +13 -0
- package/dist/tools/bill/index.js.map +1 -0
- package/dist/tools/bill/schemas.d.ts +609 -0
- package/dist/tools/bill/schemas.d.ts.map +1 -0
- package/dist/tools/bill/schemas.js +124 -0
- package/dist/tools/bill/schemas.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-create.d.ts +103 -0
- package/dist/tools/bill-payment/billpayment-create.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-create.js +67 -0
- package/dist/tools/bill-payment/billpayment-create.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-delete.d.ts +40 -0
- package/dist/tools/bill-payment/billpayment-delete.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-delete.js +67 -0
- package/dist/tools/bill-payment/billpayment-delete.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-list.d.ts +148 -0
- package/dist/tools/bill-payment/billpayment-list.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-list.js +111 -0
- package/dist/tools/bill-payment/billpayment-list.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-single.d.ts +76 -0
- package/dist/tools/bill-payment/billpayment-single.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-single.js +62 -0
- package/dist/tools/bill-payment/billpayment-single.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-update.d.ts +103 -0
- package/dist/tools/bill-payment/billpayment-update.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-update.js +67 -0
- package/dist/tools/bill-payment/billpayment-update.js.map +1 -0
- package/dist/tools/bill-payment/index.d.ts +11 -0
- package/dist/tools/bill-payment/index.d.ts.map +1 -0
- package/dist/tools/bill-payment/index.js +13 -0
- package/dist/tools/bill-payment/index.js.map +1 -0
- package/dist/tools/bill-payment/schemas.d.ts +381 -0
- package/dist/tools/bill-payment/schemas.d.ts.map +1 -0
- package/dist/tools/bill-payment/schemas.js +113 -0
- package/dist/tools/bill-payment/schemas.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-create.d.ts +139 -0
- package/dist/tools/bill-vendor/billvendor-create.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-create.js +72 -0
- package/dist/tools/bill-vendor/billvendor-create.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-delete.d.ts +40 -0
- package/dist/tools/bill-vendor/billvendor-delete.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-delete.js +67 -0
- package/dist/tools/bill-vendor/billvendor-delete.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-list.d.ts +179 -0
- package/dist/tools/bill-vendor/billvendor-list.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-list.js +109 -0
- package/dist/tools/bill-vendor/billvendor-list.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-single.d.ts +94 -0
- package/dist/tools/bill-vendor/billvendor-single.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-single.js +62 -0
- package/dist/tools/bill-vendor/billvendor-single.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-update.d.ts +142 -0
- package/dist/tools/bill-vendor/billvendor-update.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-update.js +72 -0
- package/dist/tools/bill-vendor/billvendor-update.js.map +1 -0
- package/dist/tools/bill-vendor/index.d.ts +11 -0
- package/dist/tools/bill-vendor/index.d.ts.map +1 -0
- package/dist/tools/bill-vendor/index.js +13 -0
- package/dist/tools/bill-vendor/index.js.map +1 -0
- package/dist/tools/bill-vendor/schemas.d.ts +483 -0
- package/dist/tools/bill-vendor/schemas.d.ts.map +1 -0
- package/dist/tools/bill-vendor/schemas.js +136 -0
- package/dist/tools/bill-vendor/schemas.js.map +1 -0
- package/dist/tools/callback/callback-create.d.ts +52 -0
- package/dist/tools/callback/callback-create.d.ts.map +1 -0
- package/dist/tools/callback/callback-create.js +73 -0
- package/dist/tools/callback/callback-create.js.map +1 -0
- package/dist/tools/callback/callback-delete.d.ts +37 -0
- package/dist/tools/callback/callback-delete.d.ts.map +1 -0
- package/dist/tools/callback/callback-delete.js +57 -0
- package/dist/tools/callback/callback-delete.js.map +1 -0
- package/dist/tools/callback/callback-list.d.ts +100 -0
- package/dist/tools/callback/callback-list.d.ts.map +1 -0
- package/dist/tools/callback/callback-list.js +84 -0
- package/dist/tools/callback/callback-list.js.map +1 -0
- package/dist/tools/callback/callback-resend-verification.d.ts +49 -0
- package/dist/tools/callback/callback-resend-verification.d.ts.map +1 -0
- package/dist/tools/callback/callback-resend-verification.js +63 -0
- package/dist/tools/callback/callback-resend-verification.js.map +1 -0
- package/dist/tools/callback/callback-single.d.ts +49 -0
- package/dist/tools/callback/callback-single.d.ts.map +1 -0
- package/dist/tools/callback/callback-single.js +53 -0
- package/dist/tools/callback/callback-single.js.map +1 -0
- package/dist/tools/callback/callback-update.d.ts +55 -0
- package/dist/tools/callback/callback-update.d.ts.map +1 -0
- package/dist/tools/callback/callback-update.js +62 -0
- package/dist/tools/callback/callback-update.js.map +1 -0
- package/dist/tools/callback/callback-verify.d.ts +43 -0
- package/dist/tools/callback/callback-verify.d.ts.map +1 -0
- package/dist/tools/callback/callback-verify.js +69 -0
- package/dist/tools/callback/callback-verify.js.map +1 -0
- package/dist/tools/callback/index.d.ts +13 -0
- package/dist/tools/callback/index.d.ts.map +1 -0
- package/dist/tools/callback/index.js +15 -0
- package/dist/tools/callback/index.js.map +1 -0
- package/dist/tools/callback/schemas.d.ts +284 -0
- package/dist/tools/callback/schemas.d.ts.map +1 -0
- package/dist/tools/callback/schemas.js +114 -0
- package/dist/tools/callback/schemas.js.map +1 -0
- package/dist/tools/client/client-create.d.ts +211 -0
- package/dist/tools/client/client-create.d.ts.map +1 -0
- package/dist/tools/client/client-create.js +147 -0
- package/dist/tools/client/client-create.js.map +1 -0
- package/dist/tools/client/client-delete.d.ts +40 -0
- package/dist/tools/client/client-delete.d.ts.map +1 -0
- package/dist/tools/client/client-delete.js +73 -0
- package/dist/tools/client/client-delete.js.map +1 -0
- package/dist/tools/client/client-list.d.ts +264 -0
- package/dist/tools/client/client-list.d.ts.map +1 -0
- package/dist/tools/client/client-list.js +131 -0
- package/dist/tools/client/client-list.js.map +1 -0
- package/dist/tools/client/client-single.d.ts +133 -0
- package/dist/tools/client/client-single.d.ts.map +1 -0
- package/dist/tools/client/client-single.js +67 -0
- package/dist/tools/client/client-single.js.map +1 -0
- package/dist/tools/client/client-update.d.ts +217 -0
- package/dist/tools/client/client-update.d.ts.map +1 -0
- package/dist/tools/client/client-update.js +146 -0
- package/dist/tools/client/client-update.js.map +1 -0
- package/dist/tools/client/index.d.ts +11 -0
- package/dist/tools/client/index.d.ts.map +1 -0
- package/dist/tools/client/index.js +13 -0
- package/dist/tools/client/index.js.map +1 -0
- package/dist/tools/client/schemas.d.ts +759 -0
- package/dist/tools/client/schemas.d.ts.map +1 -0
- package/dist/tools/client/schemas.js +241 -0
- package/dist/tools/client/schemas.js.map +1 -0
- package/dist/tools/credit-note/creditnote-create.d.ts +448 -0
- package/dist/tools/credit-note/creditnote-create.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-create.js +88 -0
- package/dist/tools/credit-note/creditnote-create.js.map +1 -0
- package/dist/tools/credit-note/creditnote-delete.d.ts +37 -0
- package/dist/tools/credit-note/creditnote-delete.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-delete.js +57 -0
- package/dist/tools/credit-note/creditnote-delete.js.map +1 -0
- package/dist/tools/credit-note/creditnote-list.d.ts +627 -0
- package/dist/tools/credit-note/creditnote-list.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-list.js +106 -0
- package/dist/tools/credit-note/creditnote-list.js.map +1 -0
- package/dist/tools/credit-note/creditnote-single.d.ts +358 -0
- package/dist/tools/credit-note/creditnote-single.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-single.js +60 -0
- package/dist/tools/credit-note/creditnote-single.js.map +1 -0
- package/dist/tools/credit-note/creditnote-update.d.ts +442 -0
- package/dist/tools/credit-note/creditnote-update.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-update.js +82 -0
- package/dist/tools/credit-note/creditnote-update.js.map +1 -0
- package/dist/tools/credit-note/index.d.ts +11 -0
- package/dist/tools/credit-note/index.d.ts.map +1 -0
- package/dist/tools/credit-note/index.js +13 -0
- package/dist/tools/credit-note/index.js.map +1 -0
- package/dist/tools/credit-note/schemas.d.ts +1599 -0
- package/dist/tools/credit-note/schemas.d.ts.map +1 -0
- package/dist/tools/credit-note/schemas.js +196 -0
- package/dist/tools/credit-note/schemas.js.map +1 -0
- package/dist/tools/expense/expense-create.d.ts +196 -0
- package/dist/tools/expense/expense-create.d.ts.map +1 -0
- package/dist/tools/expense/expense-create.js +103 -0
- package/dist/tools/expense/expense-create.js.map +1 -0
- package/dist/tools/expense/expense-delete.d.ts +40 -0
- package/dist/tools/expense/expense-delete.d.ts.map +1 -0
- package/dist/tools/expense/expense-delete.js +73 -0
- package/dist/tools/expense/expense-delete.js.map +1 -0
- package/dist/tools/expense/expense-list.d.ts +264 -0
- package/dist/tools/expense/expense-list.d.ts.map +1 -0
- package/dist/tools/expense/expense-list.js +126 -0
- package/dist/tools/expense/expense-list.js.map +1 -0
- package/dist/tools/expense/expense-single.d.ts +145 -0
- package/dist/tools/expense/expense-single.d.ts.map +1 -0
- package/dist/tools/expense/expense-single.js +63 -0
- package/dist/tools/expense/expense-single.js.map +1 -0
- package/dist/tools/expense/expense-update.d.ts +199 -0
- package/dist/tools/expense/expense-update.d.ts.map +1 -0
- package/dist/tools/expense/expense-update.js +108 -0
- package/dist/tools/expense/expense-update.js.map +1 -0
- package/dist/tools/expense/index.d.ts +11 -0
- package/dist/tools/expense/index.d.ts.map +1 -0
- package/dist/tools/expense/index.js +13 -0
- package/dist/tools/expense/index.js.map +1 -0
- package/dist/tools/expense/schemas.d.ts +667 -0
- package/dist/tools/expense/schemas.d.ts.map +1 -0
- package/dist/tools/expense/schemas.js +142 -0
- package/dist/tools/expense/schemas.js.map +1 -0
- package/dist/tools/expense-category/expensecategory-list.d.ts +113 -0
- package/dist/tools/expense-category/expensecategory-list.d.ts.map +1 -0
- package/dist/tools/expense-category/expensecategory-list.js +113 -0
- package/dist/tools/expense-category/expensecategory-list.js.map +1 -0
- package/dist/tools/expense-category/expensecategory-single.d.ts +58 -0
- package/dist/tools/expense-category/expensecategory-single.d.ts.map +1 -0
- package/dist/tools/expense-category/expensecategory-single.js +66 -0
- package/dist/tools/expense-category/expensecategory-single.js.map +1 -0
- package/dist/tools/expense-category/index.d.ts +9 -0
- package/dist/tools/expense-category/index.d.ts.map +1 -0
- package/dist/tools/expense-category/index.js +11 -0
- package/dist/tools/expense-category/index.js.map +1 -0
- package/dist/tools/expense-category/schemas.d.ts +184 -0
- package/dist/tools/expense-category/schemas.d.ts.map +1 -0
- package/dist/tools/expense-category/schemas.js +58 -0
- package/dist/tools/expense-category/schemas.js.map +1 -0
- package/dist/tools/index.d.ts +53 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +98 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/invoice/index.d.ts +12 -0
- package/dist/tools/invoice/index.d.ts.map +1 -0
- package/dist/tools/invoice/index.js +14 -0
- package/dist/tools/invoice/index.js.map +1 -0
- package/dist/tools/invoice/invoice-create.d.ts +367 -0
- package/dist/tools/invoice/invoice-create.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-create.js +115 -0
- package/dist/tools/invoice/invoice-create.js.map +1 -0
- package/dist/tools/invoice/invoice-delete.d.ts +40 -0
- package/dist/tools/invoice/invoice-delete.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-delete.js +75 -0
- package/dist/tools/invoice/invoice-delete.js.map +1 -0
- package/dist/tools/invoice/invoice-list.d.ts +439 -0
- package/dist/tools/invoice/invoice-list.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-list.js +126 -0
- package/dist/tools/invoice/invoice-list.js.map +1 -0
- package/dist/tools/invoice/invoice-share-link.d.ts +40 -0
- package/dist/tools/invoice/invoice-share-link.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-share-link.js +89 -0
- package/dist/tools/invoice/invoice-share-link.js.map +1 -0
- package/dist/tools/invoice/invoice-single.d.ts +265 -0
- package/dist/tools/invoice/invoice-single.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-single.js +66 -0
- package/dist/tools/invoice/invoice-single.js.map +1 -0
- package/dist/tools/invoice/invoice-update.d.ts +373 -0
- package/dist/tools/invoice/invoice-update.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-update.js +122 -0
- package/dist/tools/invoice/invoice-update.js.map +1 -0
- package/dist/tools/invoice/schemas.d.ts +1414 -0
- package/dist/tools/invoice/schemas.d.ts.map +1 -0
- package/dist/tools/invoice/schemas.js +269 -0
- package/dist/tools/invoice/schemas.js.map +1 -0
- package/dist/tools/item/index.d.ts +10 -0
- package/dist/tools/item/index.d.ts.map +1 -0
- package/dist/tools/item/index.js +12 -0
- package/dist/tools/item/index.js.map +1 -0
- package/dist/tools/item/item-create.d.ts +136 -0
- package/dist/tools/item/item-create.d.ts.map +1 -0
- package/dist/tools/item/item-create.js +71 -0
- package/dist/tools/item/item-create.js.map +1 -0
- package/dist/tools/item/item-list.d.ts +178 -0
- package/dist/tools/item/item-list.d.ts.map +1 -0
- package/dist/tools/item/item-list.js +112 -0
- package/dist/tools/item/item-list.js.map +1 -0
- package/dist/tools/item/item-single.d.ts +94 -0
- package/dist/tools/item/item-single.d.ts.map +1 -0
- package/dist/tools/item/item-single.js +62 -0
- package/dist/tools/item/item-single.js.map +1 -0
- package/dist/tools/item/item-update.d.ts +139 -0
- package/dist/tools/item/item-update.d.ts.map +1 -0
- package/dist/tools/item/item-update.js +74 -0
- package/dist/tools/item/item-update.js.map +1 -0
- package/dist/tools/item/schemas.d.ts +454 -0
- package/dist/tools/item/schemas.d.ts.map +1 -0
- package/dist/tools/item/schemas.js +116 -0
- package/dist/tools/item/schemas.js.map +1 -0
- package/dist/tools/journal-entry/index.d.ts +7 -0
- package/dist/tools/journal-entry/index.d.ts.map +1 -0
- package/dist/tools/journal-entry/index.js +9 -0
- package/dist/tools/journal-entry/index.js.map +1 -0
- package/dist/tools/journal-entry/journalentry-create.d.ts +114 -0
- package/dist/tools/journal-entry/journalentry-create.d.ts.map +1 -0
- package/dist/tools/journal-entry/journalentry-create.js +98 -0
- package/dist/tools/journal-entry/journalentry-create.js.map +1 -0
- package/dist/tools/journal-entry/schemas.d.ts +182 -0
- package/dist/tools/journal-entry/schemas.d.ts.map +1 -0
- package/dist/tools/journal-entry/schemas.js +43 -0
- package/dist/tools/journal-entry/schemas.js.map +1 -0
- package/dist/tools/journal-entry-account/index.d.ts +7 -0
- package/dist/tools/journal-entry-account/index.d.ts.map +1 -0
- package/dist/tools/journal-entry-account/index.js +9 -0
- package/dist/tools/journal-entry-account/index.js.map +1 -0
- package/dist/tools/journal-entry-account/journalentryaccount-list.d.ts +190 -0
- package/dist/tools/journal-entry-account/journalentryaccount-list.d.ts.map +1 -0
- package/dist/tools/journal-entry-account/journalentryaccount-list.js +102 -0
- package/dist/tools/journal-entry-account/journalentryaccount-list.js.map +1 -0
- package/dist/tools/journal-entry-account/schemas.d.ts +344 -0
- package/dist/tools/journal-entry-account/schemas.d.ts.map +1 -0
- package/dist/tools/journal-entry-account/schemas.js +65 -0
- package/dist/tools/journal-entry-account/schemas.js.map +1 -0
- package/dist/tools/metadata.d.ts +49 -0
- package/dist/tools/metadata.d.ts.map +1 -0
- package/dist/tools/metadata.js +317 -0
- package/dist/tools/metadata.js.map +1 -0
- package/dist/tools/other-income/index.d.ts +11 -0
- package/dist/tools/other-income/index.d.ts.map +1 -0
- package/dist/tools/other-income/index.js +13 -0
- package/dist/tools/other-income/index.js.map +1 -0
- package/dist/tools/other-income/otherincome-create.d.ts +152 -0
- package/dist/tools/other-income/otherincome-create.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-create.js +89 -0
- package/dist/tools/other-income/otherincome-create.js.map +1 -0
- package/dist/tools/other-income/otherincome-delete.d.ts +37 -0
- package/dist/tools/other-income/otherincome-delete.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-delete.js +57 -0
- package/dist/tools/other-income/otherincome-delete.js.map +1 -0
- package/dist/tools/other-income/otherincome-list.d.ts +186 -0
- package/dist/tools/other-income/otherincome-list.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-list.js +107 -0
- package/dist/tools/other-income/otherincome-list.js.map +1 -0
- package/dist/tools/other-income/otherincome-single.d.ts +99 -0
- package/dist/tools/other-income/otherincome-single.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-single.js +53 -0
- package/dist/tools/other-income/otherincome-single.js.map +1 -0
- package/dist/tools/other-income/otherincome-update.d.ts +155 -0
- package/dist/tools/other-income/otherincome-update.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-update.js +84 -0
- package/dist/tools/other-income/otherincome-update.js.map +1 -0
- package/dist/tools/other-income/schemas.d.ts +510 -0
- package/dist/tools/other-income/schemas.d.ts.map +1 -0
- package/dist/tools/other-income/schemas.js +141 -0
- package/dist/tools/other-income/schemas.js.map +1 -0
- package/dist/tools/payment/index.d.ts +11 -0
- package/dist/tools/payment/index.d.ts.map +1 -0
- package/dist/tools/payment/index.js +13 -0
- package/dist/tools/payment/index.js.map +1 -0
- package/dist/tools/payment/payment-create.d.ts +127 -0
- package/dist/tools/payment/payment-create.d.ts.map +1 -0
- package/dist/tools/payment/payment-create.js +84 -0
- package/dist/tools/payment/payment-create.js.map +1 -0
- package/dist/tools/payment/payment-delete.d.ts +40 -0
- package/dist/tools/payment/payment-delete.d.ts.map +1 -0
- package/dist/tools/payment/payment-delete.js +67 -0
- package/dist/tools/payment/payment-delete.js.map +1 -0
- package/dist/tools/payment/payment-list.d.ts +186 -0
- package/dist/tools/payment/payment-list.d.ts.map +1 -0
- package/dist/tools/payment/payment-list.js +113 -0
- package/dist/tools/payment/payment-list.js.map +1 -0
- package/dist/tools/payment/payment-single.d.ts +97 -0
- package/dist/tools/payment/payment-single.d.ts.map +1 -0
- package/dist/tools/payment/payment-single.js +62 -0
- package/dist/tools/payment/payment-single.js.map +1 -0
- package/dist/tools/payment/payment-update.d.ts +124 -0
- package/dist/tools/payment/payment-update.d.ts.map +1 -0
- package/dist/tools/payment/payment-update.js +79 -0
- package/dist/tools/payment/payment-update.js.map +1 -0
- package/dist/tools/payment/schemas.d.ts +445 -0
- package/dist/tools/payment/schemas.d.ts.map +1 -0
- package/dist/tools/payment/schemas.js +126 -0
- package/dist/tools/payment/schemas.js.map +1 -0
- package/dist/tools/payment-options/index.d.ts +9 -0
- package/dist/tools/payment-options/index.d.ts.map +1 -0
- package/dist/tools/payment-options/index.js +11 -0
- package/dist/tools/payment-options/index.js.map +1 -0
- package/dist/tools/payment-options/paymentoptions-create.d.ts +91 -0
- package/dist/tools/payment-options/paymentoptions-create.d.ts.map +1 -0
- package/dist/tools/payment-options/paymentoptions-create.js +71 -0
- package/dist/tools/payment-options/paymentoptions-create.js.map +1 -0
- package/dist/tools/payment-options/paymentoptions-default.d.ts +43 -0
- package/dist/tools/payment-options/paymentoptions-default.d.ts.map +1 -0
- package/dist/tools/payment-options/paymentoptions-default.js +64 -0
- package/dist/tools/payment-options/paymentoptions-default.js.map +1 -0
- package/dist/tools/payment-options/paymentoptions-single.d.ts +76 -0
- package/dist/tools/payment-options/paymentoptions-single.d.ts.map +1 -0
- package/dist/tools/payment-options/paymentoptions-single.js +58 -0
- package/dist/tools/payment-options/paymentoptions-single.js.map +1 -0
- package/dist/tools/payment-options/schemas.d.ts +197 -0
- package/dist/tools/payment-options/schemas.d.ts.map +1 -0
- package/dist/tools/payment-options/schemas.js +69 -0
- package/dist/tools/payment-options/schemas.js.map +1 -0
- package/dist/tools/project/index.d.ts +11 -0
- package/dist/tools/project/index.d.ts.map +1 -0
- package/dist/tools/project/index.js +13 -0
- package/dist/tools/project/index.js.map +1 -0
- package/dist/tools/project/project-create.d.ts +142 -0
- package/dist/tools/project/project-create.d.ts.map +1 -0
- package/dist/tools/project/project-create.js +100 -0
- package/dist/tools/project/project-create.js.map +1 -0
- package/dist/tools/project/project-delete.d.ts +44 -0
- package/dist/tools/project/project-delete.d.ts.map +1 -0
- package/dist/tools/project/project-delete.js +80 -0
- package/dist/tools/project/project-delete.js.map +1 -0
- package/dist/tools/project/project-list.d.ts +227 -0
- package/dist/tools/project/project-list.d.ts.map +1 -0
- package/dist/tools/project/project-list.js +118 -0
- package/dist/tools/project/project-list.js.map +1 -0
- package/dist/tools/project/project-single.d.ts +115 -0
- package/dist/tools/project/project-single.d.ts.map +1 -0
- package/dist/tools/project/project-single.js +63 -0
- package/dist/tools/project/project-single.js.map +1 -0
- package/dist/tools/project/project-update.d.ts +151 -0
- package/dist/tools/project/project-update.d.ts.map +1 -0
- package/dist/tools/project/project-update.js +106 -0
- package/dist/tools/project/project-update.js.map +1 -0
- package/dist/tools/project/schemas.d.ts +588 -0
- package/dist/tools/project/schemas.d.ts.map +1 -0
- package/dist/tools/project/schemas.js +196 -0
- package/dist/tools/project/schemas.js.map +1 -0
- package/dist/tools/report/index.d.ts +9 -0
- package/dist/tools/report/index.d.ts.map +1 -0
- package/dist/tools/report/index.js +11 -0
- package/dist/tools/report/index.js.map +1 -0
- package/dist/tools/report/report-payments-collected.d.ts +118 -0
- package/dist/tools/report/report-payments-collected.d.ts.map +1 -0
- package/dist/tools/report/report-payments-collected.js +89 -0
- package/dist/tools/report/report-payments-collected.js.map +1 -0
- package/dist/tools/report/report-profit-loss.d.ts +139 -0
- package/dist/tools/report/report-profit-loss.d.ts.map +1 -0
- package/dist/tools/report/report-profit-loss.js +98 -0
- package/dist/tools/report/report-profit-loss.js.map +1 -0
- package/dist/tools/report/report-tax-summary.d.ts +155 -0
- package/dist/tools/report/report-tax-summary.d.ts.map +1 -0
- package/dist/tools/report/report-tax-summary.js +100 -0
- package/dist/tools/report/report-tax-summary.js.map +1 -0
- package/dist/tools/report/schemas.d.ts +859 -0
- package/dist/tools/report/schemas.d.ts.map +1 -0
- package/dist/tools/report/schemas.js +126 -0
- package/dist/tools/report/schemas.js.map +1 -0
- package/dist/tools/service/index.d.ts +12 -0
- package/dist/tools/service/index.d.ts.map +1 -0
- package/dist/tools/service/index.js +14 -0
- package/dist/tools/service/index.js.map +1 -0
- package/dist/tools/service/schemas.d.ts +159 -0
- package/dist/tools/service/schemas.d.ts.map +1 -0
- package/dist/tools/service/schemas.js +62 -0
- package/dist/tools/service/schemas.js.map +1 -0
- package/dist/tools/service/service-create.d.ts +52 -0
- package/dist/tools/service/service-create.d.ts.map +1 -0
- package/dist/tools/service/service-create.js +82 -0
- package/dist/tools/service/service-create.js.map +1 -0
- package/dist/tools/service/service-list.d.ts +119 -0
- package/dist/tools/service/service-list.d.ts.map +1 -0
- package/dist/tools/service/service-list.js +99 -0
- package/dist/tools/service/service-list.js.map +1 -0
- package/dist/tools/service/service-rate-get.d.ts +63 -0
- package/dist/tools/service/service-rate-get.d.ts.map +1 -0
- package/dist/tools/service/service-rate-get.js +66 -0
- package/dist/tools/service/service-rate-get.js.map +1 -0
- package/dist/tools/service/service-rate-set.d.ts +76 -0
- package/dist/tools/service/service-rate-set.d.ts.map +1 -0
- package/dist/tools/service/service-rate-set.js +91 -0
- package/dist/tools/service/service-rate-set.js.map +1 -0
- package/dist/tools/service/service-single.d.ts +45 -0
- package/dist/tools/service/service-single.d.ts.map +1 -0
- package/dist/tools/service/service-single.js +63 -0
- package/dist/tools/service/service-single.js.map +1 -0
- package/dist/tools/task/index.d.ts +12 -0
- package/dist/tools/task/index.d.ts.map +1 -0
- package/dist/tools/task/index.js +14 -0
- package/dist/tools/task/index.js.map +1 -0
- package/dist/tools/task/schemas.d.ts +299 -0
- package/dist/tools/task/schemas.d.ts.map +1 -0
- package/dist/tools/task/schemas.js +89 -0
- package/dist/tools/task/schemas.js.map +1 -0
- package/dist/tools/task/task-create.d.ts +101 -0
- package/dist/tools/task/task-create.d.ts.map +1 -0
- package/dist/tools/task/task-create.js +77 -0
- package/dist/tools/task/task-create.js.map +1 -0
- package/dist/tools/task/task-delete.d.ts +39 -0
- package/dist/tools/task/task-delete.d.ts.map +1 -0
- package/dist/tools/task/task-delete.js +70 -0
- package/dist/tools/task/task-delete.js.map +1 -0
- package/dist/tools/task/task-list.d.ts +157 -0
- package/dist/tools/task/task-list.d.ts.map +1 -0
- package/dist/tools/task/task-list.js +78 -0
- package/dist/tools/task/task-list.js.map +1 -0
- package/dist/tools/task/task-single.d.ts +77 -0
- package/dist/tools/task/task-single.d.ts.map +1 -0
- package/dist/tools/task/task-single.js +56 -0
- package/dist/tools/task/task-single.js.map +1 -0
- package/dist/tools/task/task-update.d.ts +107 -0
- package/dist/tools/task/task-update.d.ts.map +1 -0
- package/dist/tools/task/task-update.js +87 -0
- package/dist/tools/task/task-update.js.map +1 -0
- package/dist/tools/time-entry/index.d.ts +11 -0
- package/dist/tools/time-entry/index.d.ts.map +1 -0
- package/dist/tools/time-entry/index.js +11 -0
- package/dist/tools/time-entry/index.js.map +1 -0
- package/dist/tools/time-entry/schemas.d.ts +598 -0
- package/dist/tools/time-entry/schemas.d.ts.map +1 -0
- package/dist/tools/time-entry/schemas.js +217 -0
- package/dist/tools/time-entry/schemas.js.map +1 -0
- package/dist/tools/time-entry/timeentry-create.d.ts +142 -0
- package/dist/tools/time-entry/timeentry-create.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-create.js +137 -0
- package/dist/tools/time-entry/timeentry-create.js.map +1 -0
- package/dist/tools/time-entry/timeentry-delete.d.ts +43 -0
- package/dist/tools/time-entry/timeentry-delete.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-delete.js +93 -0
- package/dist/tools/time-entry/timeentry-delete.js.map +1 -0
- package/dist/tools/time-entry/timeentry-list.d.ts +232 -0
- package/dist/tools/time-entry/timeentry-list.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-list.js +154 -0
- package/dist/tools/time-entry/timeentry-list.js.map +1 -0
- package/dist/tools/time-entry/timeentry-single.d.ts +109 -0
- package/dist/tools/time-entry/timeentry-single.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-single.js +75 -0
- package/dist/tools/time-entry/timeentry-single.js.map +1 -0
- package/dist/tools/time-entry/timeentry-update.d.ts +145 -0
- package/dist/tools/time-entry/timeentry-update.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-update.js +174 -0
- package/dist/tools/time-entry/timeentry-update.js.map +1 -0
- package/dist/tools/timer/index.d.ts +16 -0
- package/dist/tools/timer/index.d.ts.map +1 -0
- package/dist/tools/timer/index.js +19 -0
- package/dist/tools/timer/index.js.map +1 -0
- package/dist/tools/timer/schemas.d.ts +520 -0
- package/dist/tools/timer/schemas.d.ts.map +1 -0
- package/dist/tools/timer/schemas.js +109 -0
- package/dist/tools/timer/schemas.js.map +1 -0
- package/dist/tools/timer/timer-current.d.ts +170 -0
- package/dist/tools/timer/timer-current.d.ts.map +1 -0
- package/dist/tools/timer/timer-current.js +134 -0
- package/dist/tools/timer/timer-current.js.map +1 -0
- package/dist/tools/timer/timer-discard.d.ts +54 -0
- package/dist/tools/timer/timer-discard.d.ts.map +1 -0
- package/dist/tools/timer/timer-discard.js +115 -0
- package/dist/tools/timer/timer-discard.js.map +1 -0
- package/dist/tools/timer/timer-start.d.ts +135 -0
- package/dist/tools/timer/timer-start.d.ts.map +1 -0
- package/dist/tools/timer/timer-start.js +129 -0
- package/dist/tools/timer/timer-start.js.map +1 -0
- package/dist/tools/timer/timer-stop.d.ts +123 -0
- package/dist/tools/timer/timer-stop.d.ts.map +1 -0
- package/dist/tools/timer/timer-stop.js +165 -0
- package/dist/tools/timer/timer-stop.js.map +1 -0
- package/dist/tools/types.d.ts +49 -0
- package/dist/tools/types.d.ts.map +1 -0
- package/dist/tools/types.js +61 -0
- package/dist/tools/types.js.map +1 -0
- package/dist/tools/user/index.d.ts +7 -0
- package/dist/tools/user/index.d.ts.map +1 -0
- package/dist/tools/user/index.js +9 -0
- package/dist/tools/user/index.js.map +1 -0
- package/dist/tools/user/schemas.d.ts +258 -0
- package/dist/tools/user/schemas.d.ts.map +1 -0
- package/dist/tools/user/schemas.js +51 -0
- package/dist/tools/user/schemas.js.map +1 -0
- package/dist/tools/user/user-me.d.ts +129 -0
- package/dist/tools/user/user-me.d.ts.map +1 -0
- package/dist/tools/user/user-me.js +63 -0
- package/dist/tools/user/user-me.js.map +1 -0
- package/dist/types/freshbooks.d.ts +276 -0
- package/dist/types/freshbooks.d.ts.map +1 -0
- package/dist/types/freshbooks.js +6 -0
- package/dist/types/freshbooks.js.map +1 -0
- package/dist/types/index.d.ts +92 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +6 -0
- package/dist/types/index.js.map +1 -0
- package/dist/utils/index.d.ts +6 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +6 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/logger.d.ts +54 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +133 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/pagination.d.ts +39 -0
- package/dist/utils/pagination.d.ts.map +1 -0
- package/dist/utils/pagination.js +62 -0
- package/dist/utils/pagination.js.map +1 -0
- package/package.json +88 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Chadwick Posey
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,357 @@
|
|
|
1
|
+
# FreshBooks MCP Server
|
|
2
|
+
|
|
3
|
+
A Model Context Protocol (MCP) server providing complete FreshBooks integration for Claude and other MCP-compatible AI assistants.
|
|
4
|
+
|
|
5
|
+
[](https://opensource.org/licenses/MIT)
|
|
6
|
+
[](https://www.typescriptlang.org/)
|
|
7
|
+
[](#testing)
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- **Complete SDK Parity** - 87 tools covering all major FreshBooks functionality
|
|
12
|
+
- **22 Entity Categories** - Full coverage of accounting, invoicing, time tracking, and more
|
|
13
|
+
- **Time Tracking** - Log time, manage timers, track billable hours
|
|
14
|
+
- **Invoicing & Billing** - Create invoices, manage bills, handle payments
|
|
15
|
+
- **Expense Management** - Track expenses, categorize spending, manage vendors
|
|
16
|
+
- **Client & Project Management** - Full CRM and project capabilities
|
|
17
|
+
- **Financial Reports** - Profit/loss, tax summaries, and more
|
|
18
|
+
- **OAuth2 Authentication** - Secure token-based authentication with auto-refresh
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install freshbooks-mcp
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Quick Start
|
|
27
|
+
|
|
28
|
+
The fastest way to get started is with our **hosted service** — no OAuth setup required.
|
|
29
|
+
|
|
30
|
+
### 1. Sign Up
|
|
31
|
+
|
|
32
|
+
Go to [freshbooks.goodsamsoftware.com](https://freshbooks.goodsamsoftware.com) and create an account (**14-day free trial**). Once you're in, connect your FreshBooks account from the dashboard.
|
|
33
|
+
|
|
34
|
+
### 2. Copy Your Configuration
|
|
35
|
+
|
|
36
|
+
From your dashboard, copy the configuration snippet provided. It works with both **Claude Desktop** and **Claude Code**.
|
|
37
|
+
|
|
38
|
+
**Claude Desktop** (`claude_desktop_config.json`):
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"mcpServers": {
|
|
42
|
+
"freshbooks": {
|
|
43
|
+
"command": "npx",
|
|
44
|
+
"args": ["mcp-remote", "https://freshbooks.goodsamsoftware.com/api/mcp", "--header", "Authorization:Bearer YOUR_TOKEN"]
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**Claude Code** (`.mcp.json` in your project):
|
|
51
|
+
```json
|
|
52
|
+
{
|
|
53
|
+
"mcpServers": {
|
|
54
|
+
"freshbooks": {
|
|
55
|
+
"command": "npx",
|
|
56
|
+
"args": ["mcp-remote", "https://freshbooks.goodsamsoftware.com/api/mcp", "--header", "Authorization:Bearer YOUR_TOKEN"]
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### 3. Start Using
|
|
63
|
+
|
|
64
|
+
Example prompts:
|
|
65
|
+
- "Log 2 hours on the Website Redesign project"
|
|
66
|
+
- "Show me my time entries for this week"
|
|
67
|
+
- "Start a timer for client meeting"
|
|
68
|
+
- "Create an invoice for Acme Corp for $1,500"
|
|
69
|
+
- "What's my profit/loss this month?"
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Self-Hosted Setup
|
|
74
|
+
|
|
75
|
+
You can also run the MCP server locally with your own FreshBooks API application.
|
|
76
|
+
|
|
77
|
+
> **Note:** FreshBooks requires HTTPS for all OAuth callback URLs, including localhost. See [Local HTTPS Setup](#advanced-local-https-setup) below for instructions.
|
|
78
|
+
|
|
79
|
+
### 1. Get FreshBooks Credentials
|
|
80
|
+
|
|
81
|
+
1. Go to [FreshBooks Developer Portal](https://my.freshbooks.com/#/developer)
|
|
82
|
+
2. Create a new application
|
|
83
|
+
3. Set redirect URI to: `https://freshbooks.goodsamsoftware.com/callback`
|
|
84
|
+
4. Note your Client ID and Client Secret
|
|
85
|
+
|
|
86
|
+
### 2. Configure Claude Desktop
|
|
87
|
+
|
|
88
|
+
Add to your Claude Desktop configuration (`claude_desktop_config.json`):
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
{
|
|
92
|
+
"mcpServers": {
|
|
93
|
+
"freshbooks": {
|
|
94
|
+
"command": "npx",
|
|
95
|
+
"args": ["freshbooks-mcp"],
|
|
96
|
+
"env": {
|
|
97
|
+
"FRESHBOOKS_CLIENT_ID": "your-client-id",
|
|
98
|
+
"FRESHBOOKS_CLIENT_SECRET": "your-client-secret",
|
|
99
|
+
"FRESHBOOKS_REDIRECT_URI": "https://freshbooks.goodsamsoftware.com/callback"
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### 3. Authenticate
|
|
107
|
+
|
|
108
|
+
Ask Claude:
|
|
109
|
+
> "Connect me to FreshBooks"
|
|
110
|
+
|
|
111
|
+
Claude will guide you through OAuth authentication. After authorizing in FreshBooks, you'll see the authorization code on our [hosted callback page](https://freshbooks.goodsamsoftware.com) - just copy it and paste it back to Claude.
|
|
112
|
+
|
|
113
|
+
### 4. Start Using
|
|
114
|
+
|
|
115
|
+
Example prompts:
|
|
116
|
+
- "Log 2 hours on the Website Redesign project"
|
|
117
|
+
- "Show me my time entries for this week"
|
|
118
|
+
- "Start a timer for client meeting"
|
|
119
|
+
- "Create an invoice for Acme Corp for $1,500"
|
|
120
|
+
- "What's my profit/loss this month?"
|
|
121
|
+
|
|
122
|
+
## Available Tools (87 total)
|
|
123
|
+
|
|
124
|
+
### Authentication (5 tools)
|
|
125
|
+
| Tool | Description |
|
|
126
|
+
|------|-------------|
|
|
127
|
+
| `auth_status` | Check authentication status |
|
|
128
|
+
| `auth_get_url` | Get OAuth authorization URL |
|
|
129
|
+
| `auth_exchange_code` | Exchange auth code for tokens |
|
|
130
|
+
| `auth_refresh` | Refresh access token |
|
|
131
|
+
| `auth_revoke` | Revoke authentication |
|
|
132
|
+
|
|
133
|
+
### Time Tracking (5 tools)
|
|
134
|
+
| Tool | Description |
|
|
135
|
+
|------|-------------|
|
|
136
|
+
| `timeentry_list` | List time entries with filters |
|
|
137
|
+
| `timeentry_single` | Get time entry by ID |
|
|
138
|
+
| `timeentry_create` | Create time entry |
|
|
139
|
+
| `timeentry_update` | Update time entry |
|
|
140
|
+
| `timeentry_delete` | Delete time entry |
|
|
141
|
+
|
|
142
|
+
### Timer Management (4 tools)
|
|
143
|
+
| Tool | Description |
|
|
144
|
+
|------|-------------|
|
|
145
|
+
| `timer_start` | Start a timer |
|
|
146
|
+
| `timer_stop` | Stop timer and log time |
|
|
147
|
+
| `timer_current` | Get running timer(s) |
|
|
148
|
+
| `timer_discard` | Delete timer without logging |
|
|
149
|
+
|
|
150
|
+
### Invoicing (5 tools)
|
|
151
|
+
| Tool | Description |
|
|
152
|
+
|------|-------------|
|
|
153
|
+
| `invoice_list` | List invoices |
|
|
154
|
+
| `invoice_single` | Get invoice by ID |
|
|
155
|
+
| `invoice_create` | Create invoice |
|
|
156
|
+
| `invoice_update` | Update invoice |
|
|
157
|
+
| `invoice_delete` | Delete invoice |
|
|
158
|
+
|
|
159
|
+
### Clients (5 tools)
|
|
160
|
+
| Tool | Description |
|
|
161
|
+
|------|-------------|
|
|
162
|
+
| `client_list` | List clients |
|
|
163
|
+
| `client_single` | Get client by ID |
|
|
164
|
+
| `client_create` | Create client |
|
|
165
|
+
| `client_update` | Update client |
|
|
166
|
+
| `client_delete` | Delete client |
|
|
167
|
+
|
|
168
|
+
### Projects (5 tools)
|
|
169
|
+
| Tool | Description |
|
|
170
|
+
|------|-------------|
|
|
171
|
+
| `project_list` | List projects |
|
|
172
|
+
| `project_single` | Get project by ID |
|
|
173
|
+
| `project_create` | Create project |
|
|
174
|
+
| `project_update` | Update project |
|
|
175
|
+
| `project_delete` | Delete project |
|
|
176
|
+
|
|
177
|
+
### Expenses (5 tools)
|
|
178
|
+
| Tool | Description |
|
|
179
|
+
|------|-------------|
|
|
180
|
+
| `expense_list` | List expenses |
|
|
181
|
+
| `expense_single` | Get expense by ID |
|
|
182
|
+
| `expense_create` | Create expense |
|
|
183
|
+
| `expense_update` | Update expense |
|
|
184
|
+
| `expense_delete` | Delete expense |
|
|
185
|
+
|
|
186
|
+
### Bills & Payments (15 tools)
|
|
187
|
+
| Tool | Description |
|
|
188
|
+
|------|-------------|
|
|
189
|
+
| `bill_list` | List bills |
|
|
190
|
+
| `bill_single` | Get bill by ID |
|
|
191
|
+
| `bill_create` | Create bill |
|
|
192
|
+
| `bill_update` | Update bill |
|
|
193
|
+
| `bill_delete` | Delete bill |
|
|
194
|
+
| `billpayment_list` | List bill payments |
|
|
195
|
+
| `billpayment_single` | Get bill payment |
|
|
196
|
+
| `billpayment_create` | Create bill payment |
|
|
197
|
+
| `billpayment_update` | Update bill payment |
|
|
198
|
+
| `billpayment_delete` | Delete bill payment |
|
|
199
|
+
| `billvendor_list` | List vendors |
|
|
200
|
+
| `billvendor_single` | Get vendor by ID |
|
|
201
|
+
| `billvendor_create` | Create vendor |
|
|
202
|
+
| `billvendor_update` | Update vendor |
|
|
203
|
+
| `billvendor_delete` | Delete vendor |
|
|
204
|
+
|
|
205
|
+
### Additional Tools
|
|
206
|
+
|
|
207
|
+
| Category | Tools | Description |
|
|
208
|
+
|----------|-------|-------------|
|
|
209
|
+
| **Credit Notes** | 5 | Create, manage credit notes |
|
|
210
|
+
| **Expense Categories** | 3 | Manage expense categories |
|
|
211
|
+
| **Items** | 5 | Product/service catalog |
|
|
212
|
+
| **Journal Entries** | 5 | Manual accounting entries |
|
|
213
|
+
| **Journal Entry Accounts** | 3 | Chart of accounts |
|
|
214
|
+
| **Other Income** | 5 | Non-invoice income tracking |
|
|
215
|
+
| **Payments** | 5 | Invoice payment tracking |
|
|
216
|
+
| **Payment Options** | 2 | Payment gateway settings |
|
|
217
|
+
| **Reports** | 3 | Financial reports |
|
|
218
|
+
| **Services** | 5 | Billable service types |
|
|
219
|
+
| **Tasks** | 5 | Project task management |
|
|
220
|
+
| **User** | 1 | Current user info |
|
|
221
|
+
| **Callbacks** | 5 | Webhook management |
|
|
222
|
+
|
|
223
|
+
*See complete tool documentation in [docs/api/](docs/api/)*
|
|
224
|
+
|
|
225
|
+
## Configuration (Self-Hosted)
|
|
226
|
+
|
|
227
|
+
### Environment Variables
|
|
228
|
+
|
|
229
|
+
| Variable | Required | Description |
|
|
230
|
+
|----------|----------|-------------|
|
|
231
|
+
| `FRESHBOOKS_CLIENT_ID` | Yes | OAuth client ID |
|
|
232
|
+
| `FRESHBOOKS_CLIENT_SECRET` | Yes | OAuth client secret |
|
|
233
|
+
| `FRESHBOOKS_REDIRECT_URI` | Yes | OAuth redirect URI |
|
|
234
|
+
| `FRESHBOOKS_TOKEN_PATH` | No | Path for token storage |
|
|
235
|
+
| `LOG_LEVEL` | No | Logging level (debug, info, warn, error) |
|
|
236
|
+
|
|
237
|
+
### Advanced: Local HTTPS Setup
|
|
238
|
+
|
|
239
|
+
If you prefer to use a local callback instead of our hosted callback page, you can set up local HTTPS certificates with [mkcert](https://github.com/FiloSottile/mkcert):
|
|
240
|
+
|
|
241
|
+
**Windows (winget):**
|
|
242
|
+
```bash
|
|
243
|
+
winget install FiloSottile.mkcert
|
|
244
|
+
mkcert -install
|
|
245
|
+
mkdir certs
|
|
246
|
+
mkcert -key-file certs/localhost-key.pem -cert-file certs/localhost.pem localhost 127.0.0.1 ::1
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
**macOS (Homebrew):**
|
|
250
|
+
```bash
|
|
251
|
+
brew install mkcert
|
|
252
|
+
mkcert -install
|
|
253
|
+
mkdir certs
|
|
254
|
+
mkcert -key-file certs/localhost-key.pem -cert-file certs/localhost.pem localhost 127.0.0.1 ::1
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
**Linux:**
|
|
258
|
+
```bash
|
|
259
|
+
# Install mkcert (see https://github.com/FiloSottile/mkcert#installation)
|
|
260
|
+
mkcert -install
|
|
261
|
+
mkdir certs
|
|
262
|
+
mkcert -key-file certs/localhost-key.pem -cert-file certs/localhost.pem localhost 127.0.0.1 ::1
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
Then set your redirect URI to `https://localhost:3000/callback` in FreshBooks.
|
|
266
|
+
|
|
267
|
+
The certificates will be valid for 3 years and trusted by your system.
|
|
268
|
+
|
|
269
|
+
## Development
|
|
270
|
+
|
|
271
|
+
```bash
|
|
272
|
+
# Install dependencies
|
|
273
|
+
npm install
|
|
274
|
+
|
|
275
|
+
# Run in development mode
|
|
276
|
+
npm run dev
|
|
277
|
+
|
|
278
|
+
# Run tests
|
|
279
|
+
npm test
|
|
280
|
+
|
|
281
|
+
# Run tests with coverage
|
|
282
|
+
npm run test:coverage
|
|
283
|
+
|
|
284
|
+
# Type check
|
|
285
|
+
npm run typecheck
|
|
286
|
+
|
|
287
|
+
# Build for production
|
|
288
|
+
npm run build
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
## Testing
|
|
292
|
+
|
|
293
|
+
The project has comprehensive test coverage:
|
|
294
|
+
|
|
295
|
+
- **1,571 tests** across 93 test files
|
|
296
|
+
- **100% code coverage** requirement
|
|
297
|
+
- Mock factories for all FreshBooks entities
|
|
298
|
+
- Error scenario coverage
|
|
299
|
+
|
|
300
|
+
```bash
|
|
301
|
+
npm test # Run all tests
|
|
302
|
+
npm run test:coverage # Run with coverage report
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
## Architecture
|
|
306
|
+
|
|
307
|
+
```
|
|
308
|
+
src/
|
|
309
|
+
├── server.ts # MCP server entry point
|
|
310
|
+
├── auth/ # OAuth2 authentication
|
|
311
|
+
├── client/ # FreshBooks SDK wrapper
|
|
312
|
+
├── errors/ # Error normalization
|
|
313
|
+
├── tools/ # MCP tool implementations (22 categories)
|
|
314
|
+
│ ├── auth/ # Authentication tools
|
|
315
|
+
│ ├── time-entry/ # Time tracking
|
|
316
|
+
│ ├── timer/ # Timer management
|
|
317
|
+
│ ├── invoice/ # Invoicing
|
|
318
|
+
│ ├── client/ # Client management
|
|
319
|
+
│ ├── project/ # Projects
|
|
320
|
+
│ ├── expense/ # Expenses
|
|
321
|
+
│ ├── bill/ # Bills
|
|
322
|
+
│ └── ... # 14 more categories
|
|
323
|
+
└── config/ # Configuration
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
## Documentation
|
|
327
|
+
|
|
328
|
+
- [API Reference](docs/api/) - Complete tool documentation
|
|
329
|
+
- [Authentication Setup](docs/AUTH_SETUP.md) - OAuth configuration
|
|
330
|
+
- [Claude Guide](docs/claude/) - Claude-optimized usage examples
|
|
331
|
+
- [Examples](docs/examples/) - Workflow examples
|
|
332
|
+
|
|
333
|
+
## Error Handling
|
|
334
|
+
|
|
335
|
+
All errors are normalized to MCP format with helpful context:
|
|
336
|
+
|
|
337
|
+
```json
|
|
338
|
+
{
|
|
339
|
+
"code": -32005,
|
|
340
|
+
"message": "User-friendly message",
|
|
341
|
+
"data": {
|
|
342
|
+
"freshbooksError": { "code": "...", "message": "..." },
|
|
343
|
+
"recoverable": true,
|
|
344
|
+
"suggestion": "What to do next"
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
## License
|
|
350
|
+
|
|
351
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
|
352
|
+
|
|
353
|
+
## Credits
|
|
354
|
+
|
|
355
|
+
- [FreshBooks Node.js SDK](https://github.com/freshbooks/freshbooks-nodejs-sdk)
|
|
356
|
+
- [Model Context Protocol](https://modelcontextprotocol.io)
|
|
357
|
+
- [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk)
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FreshBooks OAuth Configuration Helper
|
|
3
|
+
*
|
|
4
|
+
* Loads OAuth configuration from environment variables with validation.
|
|
5
|
+
*/
|
|
6
|
+
import { OAuthConfig, TokenStore } from './types.js';
|
|
7
|
+
/**
|
|
8
|
+
* Load OAuth configuration from environment variables
|
|
9
|
+
*
|
|
10
|
+
* Required environment variables:
|
|
11
|
+
* - FRESHBOOKS_CLIENT_ID
|
|
12
|
+
* - FRESHBOOKS_CLIENT_SECRET
|
|
13
|
+
* - FRESHBOOKS_REDIRECT_URI
|
|
14
|
+
*
|
|
15
|
+
* Optional:
|
|
16
|
+
* - FRESHBOOKS_SCOPES (comma-separated)
|
|
17
|
+
*
|
|
18
|
+
* @throws Error if required environment variables are missing
|
|
19
|
+
*/
|
|
20
|
+
export declare function loadOAuthConfig(): OAuthConfig;
|
|
21
|
+
/**
|
|
22
|
+
* Create appropriate token store based on environment
|
|
23
|
+
*
|
|
24
|
+
* Strategy:
|
|
25
|
+
* 1. If FRESHBOOKS_ACCESS_TOKEN is set, use EnvTokenStore (CI/testing)
|
|
26
|
+
* 2. Otherwise, use EncryptedFileTokenStore (production/development)
|
|
27
|
+
*
|
|
28
|
+
* Token file location:
|
|
29
|
+
* - Uses FRESHBOOKS_TOKEN_FILE env var if set
|
|
30
|
+
* - Otherwise defaults to './freshbooks-tokens.enc'
|
|
31
|
+
*
|
|
32
|
+
* Encryption password:
|
|
33
|
+
* - Uses FRESHBOOKS_TOKEN_PASSWORD env var if set
|
|
34
|
+
* - Otherwise uses machine-specific default
|
|
35
|
+
*/
|
|
36
|
+
export declare function createTokenStore(): TokenStore;
|
|
37
|
+
/**
|
|
38
|
+
* Validate OAuth configuration
|
|
39
|
+
*
|
|
40
|
+
* Checks that configuration values are properly formatted.
|
|
41
|
+
*
|
|
42
|
+
* @param config OAuth configuration to validate
|
|
43
|
+
* @throws Error if configuration is invalid
|
|
44
|
+
*/
|
|
45
|
+
export declare function validateOAuthConfig(config: OAuthConfig): void;
|
|
46
|
+
/**
|
|
47
|
+
* Initialize OAuth configuration with validation
|
|
48
|
+
*
|
|
49
|
+
* Convenience function that:
|
|
50
|
+
* 1. Loads configuration from environment
|
|
51
|
+
* 2. Validates configuration
|
|
52
|
+
* 3. Returns validated config
|
|
53
|
+
*
|
|
54
|
+
* @returns Validated OAuth configuration
|
|
55
|
+
*/
|
|
56
|
+
export declare function initializeOAuthConfig(): OAuthConfig;
|
|
57
|
+
//# sourceMappingURL=config.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/auth/config.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAGrD;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,IAAI,WAAW,CAyC7C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,IAAI,UAAU,CAS7C;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAyB7D;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,IAAI,WAAW,CAInD"}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FreshBooks OAuth Configuration Helper
|
|
3
|
+
*
|
|
4
|
+
* Loads OAuth configuration from environment variables with validation.
|
|
5
|
+
*/
|
|
6
|
+
import { EncryptedFileTokenStore, EnvTokenStore } from './token-store.js';
|
|
7
|
+
/**
|
|
8
|
+
* Load OAuth configuration from environment variables
|
|
9
|
+
*
|
|
10
|
+
* Required environment variables:
|
|
11
|
+
* - FRESHBOOKS_CLIENT_ID
|
|
12
|
+
* - FRESHBOOKS_CLIENT_SECRET
|
|
13
|
+
* - FRESHBOOKS_REDIRECT_URI
|
|
14
|
+
*
|
|
15
|
+
* Optional:
|
|
16
|
+
* - FRESHBOOKS_SCOPES (comma-separated)
|
|
17
|
+
*
|
|
18
|
+
* @throws Error if required environment variables are missing
|
|
19
|
+
*/
|
|
20
|
+
export function loadOAuthConfig() {
|
|
21
|
+
const clientId = process.env.FRESHBOOKS_CLIENT_ID;
|
|
22
|
+
const clientSecret = process.env.FRESHBOOKS_CLIENT_SECRET;
|
|
23
|
+
const redirectUri = process.env.FRESHBOOKS_REDIRECT_URI;
|
|
24
|
+
if (!clientId) {
|
|
25
|
+
throw new Error('FRESHBOOKS_CLIENT_ID environment variable is required. ' +
|
|
26
|
+
'Get your client ID from FreshBooks Developer Portal.');
|
|
27
|
+
}
|
|
28
|
+
if (!clientSecret) {
|
|
29
|
+
throw new Error('FRESHBOOKS_CLIENT_SECRET environment variable is required. ' +
|
|
30
|
+
'Get your client secret from FreshBooks Developer Portal.');
|
|
31
|
+
}
|
|
32
|
+
if (!redirectUri) {
|
|
33
|
+
throw new Error('FRESHBOOKS_REDIRECT_URI environment variable is required. ' +
|
|
34
|
+
'Set to your OAuth redirect URI (e.g., http://localhost:3000/callback)');
|
|
35
|
+
}
|
|
36
|
+
const scopesEnv = process.env.FRESHBOOKS_SCOPES;
|
|
37
|
+
const scopes = scopesEnv ? scopesEnv.split(',').map(s => s.trim()) : undefined;
|
|
38
|
+
const config = {
|
|
39
|
+
clientId,
|
|
40
|
+
clientSecret,
|
|
41
|
+
redirectUri,
|
|
42
|
+
};
|
|
43
|
+
// Only add scopes if defined
|
|
44
|
+
if (scopes) {
|
|
45
|
+
config.scopes = scopes;
|
|
46
|
+
}
|
|
47
|
+
return config;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Create appropriate token store based on environment
|
|
51
|
+
*
|
|
52
|
+
* Strategy:
|
|
53
|
+
* 1. If FRESHBOOKS_ACCESS_TOKEN is set, use EnvTokenStore (CI/testing)
|
|
54
|
+
* 2. Otherwise, use EncryptedFileTokenStore (production/development)
|
|
55
|
+
*
|
|
56
|
+
* Token file location:
|
|
57
|
+
* - Uses FRESHBOOKS_TOKEN_FILE env var if set
|
|
58
|
+
* - Otherwise defaults to './freshbooks-tokens.enc'
|
|
59
|
+
*
|
|
60
|
+
* Encryption password:
|
|
61
|
+
* - Uses FRESHBOOKS_TOKEN_PASSWORD env var if set
|
|
62
|
+
* - Otherwise uses machine-specific default
|
|
63
|
+
*/
|
|
64
|
+
export function createTokenStore() {
|
|
65
|
+
// If access token is in environment, use EnvTokenStore
|
|
66
|
+
if (process.env.FRESHBOOKS_ACCESS_TOKEN) {
|
|
67
|
+
return new EnvTokenStore();
|
|
68
|
+
}
|
|
69
|
+
// Use encrypted file store
|
|
70
|
+
const tokenFile = process.env.FRESHBOOKS_TOKEN_FILE || './freshbooks-tokens.enc';
|
|
71
|
+
return new EncryptedFileTokenStore(tokenFile);
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Validate OAuth configuration
|
|
75
|
+
*
|
|
76
|
+
* Checks that configuration values are properly formatted.
|
|
77
|
+
*
|
|
78
|
+
* @param config OAuth configuration to validate
|
|
79
|
+
* @throws Error if configuration is invalid
|
|
80
|
+
*/
|
|
81
|
+
export function validateOAuthConfig(config) {
|
|
82
|
+
// Validate client ID format (basic check)
|
|
83
|
+
if (config.clientId.length < 10) {
|
|
84
|
+
throw new Error('Client ID appears to be invalid (too short)');
|
|
85
|
+
}
|
|
86
|
+
// Validate client secret format (basic check)
|
|
87
|
+
if (config.clientSecret.length < 10) {
|
|
88
|
+
throw new Error('Client secret appears to be invalid (too short)');
|
|
89
|
+
}
|
|
90
|
+
// Validate redirect URI format
|
|
91
|
+
try {
|
|
92
|
+
const url = new URL(config.redirectUri);
|
|
93
|
+
// Warn about insecure redirect URIs in production
|
|
94
|
+
if (process.env.NODE_ENV === 'production' && url.protocol === 'http:') {
|
|
95
|
+
console.warn('Warning: Using insecure HTTP redirect URI in production. ' +
|
|
96
|
+
'Consider using HTTPS for enhanced security.');
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
catch {
|
|
100
|
+
throw new Error('Redirect URI must be a valid URL');
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Initialize OAuth configuration with validation
|
|
105
|
+
*
|
|
106
|
+
* Convenience function that:
|
|
107
|
+
* 1. Loads configuration from environment
|
|
108
|
+
* 2. Validates configuration
|
|
109
|
+
* 3. Returns validated config
|
|
110
|
+
*
|
|
111
|
+
* @returns Validated OAuth configuration
|
|
112
|
+
*/
|
|
113
|
+
export function initializeOAuthConfig() {
|
|
114
|
+
const config = loadOAuthConfig();
|
|
115
|
+
validateOAuthConfig(config);
|
|
116
|
+
return config;
|
|
117
|
+
}
|
|
118
|
+
//# sourceMappingURL=config.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/auth/config.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,uBAAuB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAE1E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe;IAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;IAClD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;IAC1D,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;IAExD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CACb,yDAAyD;YACzD,sDAAsD,CACvD,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACb,6DAA6D;YAC7D,0DAA0D,CAC3D,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CACb,4DAA4D;YAC5D,uEAAuE,CACxE,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAChD,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE/E,MAAM,MAAM,GAAgB;QAC1B,QAAQ;QACR,YAAY;QACZ,WAAW;KACZ,CAAC;IAEF,6BAA6B;IAC7B,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,gBAAgB;IAC9B,uDAAuD;IACvD,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,CAAC;QACxC,OAAO,IAAI,aAAa,EAAE,CAAC;IAC7B,CAAC;IAED,2BAA2B;IAC3B,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,IAAI,yBAAyB,CAAC;IACjF,OAAO,IAAI,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAmB;IACrD,0CAA0C;IAC1C,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IAED,8CAA8C;IAC9C,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IAED,+BAA+B;IAC/B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAExC,kDAAkD;QAClD,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YACtE,OAAO,CAAC,IAAI,CACV,2DAA2D;gBAC3D,6CAA6C,CAC9C,CAAC;QACJ,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,qBAAqB;IACnC,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;IACjC,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FreshBooks OAuth2 Authentication
|
|
3
|
+
*
|
|
4
|
+
* Complete OAuth2 authentication system for FreshBooks API.
|
|
5
|
+
*
|
|
6
|
+
* @example Basic Usage
|
|
7
|
+
* ```typescript
|
|
8
|
+
* import { FreshBooksOAuth, EncryptedFileTokenStore } from './auth';
|
|
9
|
+
*
|
|
10
|
+
* const tokenStore = new EncryptedFileTokenStore('./tokens.enc');
|
|
11
|
+
* const oauth = new FreshBooksOAuth({
|
|
12
|
+
* clientId: 'your-client-id',
|
|
13
|
+
* clientSecret: 'your-client-secret',
|
|
14
|
+
* redirectUri: 'http://localhost:3000/callback',
|
|
15
|
+
* }, tokenStore);
|
|
16
|
+
*
|
|
17
|
+
* // 1. Generate authorization URL
|
|
18
|
+
* const url = oauth.generateAuthorizationUrl();
|
|
19
|
+
* console.log('Visit:', url);
|
|
20
|
+
*
|
|
21
|
+
* // 2. After user authorizes, exchange code
|
|
22
|
+
* await oauth.exchangeCode(authCode);
|
|
23
|
+
*
|
|
24
|
+
* // 3. Use valid token for API requests
|
|
25
|
+
* const token = await oauth.getValidToken();
|
|
26
|
+
* ```
|
|
27
|
+
*
|
|
28
|
+
* @example Environment-based Auth (CI/Testing)
|
|
29
|
+
* ```typescript
|
|
30
|
+
* import { FreshBooksOAuth, EnvTokenStore } from './auth';
|
|
31
|
+
*
|
|
32
|
+
* // Set environment variables:
|
|
33
|
+
* // FRESHBOOKS_ACCESS_TOKEN=...
|
|
34
|
+
* // FRESHBOOKS_REFRESH_TOKEN=...
|
|
35
|
+
*
|
|
36
|
+
* const tokenStore = new EnvTokenStore();
|
|
37
|
+
* const oauth = new FreshBooksOAuth(config, tokenStore);
|
|
38
|
+
*
|
|
39
|
+
* const token = await oauth.getValidToken();
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export { FreshBooksOAuth } from './oauth.js';
|
|
43
|
+
export { EncryptedFileTokenStore, EnvTokenStore, InMemoryTokenStore, } from './token-store.js';
|
|
44
|
+
export type { OAuthConfig, TokenData, AuthStatus, TokenStore, OAuthErrorCode, } from './types.js';
|
|
45
|
+
export { OAuthError } from './types.js';
|
|
46
|
+
export { loadOAuthConfig, createTokenStore, validateOAuthConfig, initializeOAuthConfig, } from './config.js';
|
|
47
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EACL,uBAAuB,EACvB,aAAa,EACb,kBAAkB,GACnB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACV,WAAW,EACX,SAAS,EACT,UAAU,EACV,UAAU,EACV,cAAc,GACf,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,aAAa,CAAC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* FreshBooks OAuth2 Authentication
|
|
3
|
+
*
|
|
4
|
+
* Complete OAuth2 authentication system for FreshBooks API.
|
|
5
|
+
*
|
|
6
|
+
* @example Basic Usage
|
|
7
|
+
* ```typescript
|
|
8
|
+
* import { FreshBooksOAuth, EncryptedFileTokenStore } from './auth';
|
|
9
|
+
*
|
|
10
|
+
* const tokenStore = new EncryptedFileTokenStore('./tokens.enc');
|
|
11
|
+
* const oauth = new FreshBooksOAuth({
|
|
12
|
+
* clientId: 'your-client-id',
|
|
13
|
+
* clientSecret: 'your-client-secret',
|
|
14
|
+
* redirectUri: 'http://localhost:3000/callback',
|
|
15
|
+
* }, tokenStore);
|
|
16
|
+
*
|
|
17
|
+
* // 1. Generate authorization URL
|
|
18
|
+
* const url = oauth.generateAuthorizationUrl();
|
|
19
|
+
* console.log('Visit:', url);
|
|
20
|
+
*
|
|
21
|
+
* // 2. After user authorizes, exchange code
|
|
22
|
+
* await oauth.exchangeCode(authCode);
|
|
23
|
+
*
|
|
24
|
+
* // 3. Use valid token for API requests
|
|
25
|
+
* const token = await oauth.getValidToken();
|
|
26
|
+
* ```
|
|
27
|
+
*
|
|
28
|
+
* @example Environment-based Auth (CI/Testing)
|
|
29
|
+
* ```typescript
|
|
30
|
+
* import { FreshBooksOAuth, EnvTokenStore } from './auth';
|
|
31
|
+
*
|
|
32
|
+
* // Set environment variables:
|
|
33
|
+
* // FRESHBOOKS_ACCESS_TOKEN=...
|
|
34
|
+
* // FRESHBOOKS_REFRESH_TOKEN=...
|
|
35
|
+
*
|
|
36
|
+
* const tokenStore = new EnvTokenStore();
|
|
37
|
+
* const oauth = new FreshBooksOAuth(config, tokenStore);
|
|
38
|
+
*
|
|
39
|
+
* const token = await oauth.getValidToken();
|
|
40
|
+
* ```
|
|
41
|
+
*/
|
|
42
|
+
export { FreshBooksOAuth } from './oauth.js';
|
|
43
|
+
export { EncryptedFileTokenStore, EnvTokenStore, InMemoryTokenStore, } from './token-store.js';
|
|
44
|
+
export { OAuthError } from './types.js';
|
|
45
|
+
export { loadOAuthConfig, createTokenStore, validateOAuthConfig, initializeOAuthConfig, } from './config.js';
|
|
46
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EACL,uBAAuB,EACvB,aAAa,EACb,kBAAkB,GACnB,MAAM,kBAAkB,CAAC;AAQ1B,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,aAAa,CAAC"}
|