@chift/chift-nodejs 1.0.17 → 1.0.18

package/package.json

@@ -1,13 +1,16 @@
 {
     "name": "@chift/chift-nodejs",
-    "version": "1.0.17",
+    "version": "1.0.18",
     "description": "The Chift NodeJS library provides convenient access to the Chift API from applications written in the NodeJS language (Javascript/Typescript).",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",
+    "files": [
+        "src/types/"
+    ],
     "scripts": {
         "dev": "chokidar src --command 'npm run build' --debounce=5000",
         "prepare": "husky install",
-        "build": "tsc",
+        "build": "tsc && cp src/types/public-api/schema.d.ts dist/src/types/public-api/schema.d.ts",
         "test": "jest --maxWorkers 1"
     },
     "keywords": [],

package/.eslintignore

@@ -1 +0,0 @@
-dist

package/.eslintrc.json

@@ -1,25 +0,0 @@
-{
-    "env": {
-        "es6": true,
-        "node": true
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended",
-        "plugin:prettier/recommended"
-    ],
-    "globals": {
-        "Atomics": "readonly",
-        "SharedArrayBuffer": "readonly"
-    },
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": 11,
-        "sourceType": "module"
-    },
-    "plugins": ["@typescript-eslint", "prettier"],
-    "rules": {
-        "@typescript-eslint/no-unused-vars": "error",
-        "prettier/prettier": "error"
-    }
-}

package/.github/workflows/ci.yml

@@ -1,75 +0,0 @@
-name: Test and publish
-
-on:
-    workflow_dispatch: {}
-    push:
-        branches:
-            - main
-            - feature/**
-        tags:
-            - v[0-9]+.[0-9]+.[0-9]+*
-    pull_request:
-        branches:
-            - main
-            - feature/**
-
-jobs:
-    test:
-        name: Test
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v3
-
-            - name: Use Node.js 16.x
-              uses: actions/setup-node@v3
-              with:
-                  node-version: 16.x
-
-            - name: Install dependencies
-              run: npm install
-
-            - name: Test
-              run: npm test --coverage && ./node_modules/coveralls/bin/coveralls.js < coverage/lcov.info
-              env:
-                  CHIFT_BACKBONE_API: ${{ secrets.CHIFT_BACKBONE_API }}
-                  CHIFT_TESTING_CLIENTID: ${{ secrets.CHIFT_TESTING_CLIENTID }}
-                  CHIFT_TESTING_CLIENTSECRET: ${{ secrets.CHIFT_TESTING_CLIENTSECRET }}
-                  CHIFT_TESTING_ACCOUNTID: ${{ secrets.CHIFT_TESTING_ACCOUNTID }}
-                  CHIFT_TEST_SYNC_ID: ${{ secrets.CHIFT_TEST_SYNC_ID }}
-                  CHIFT_SYNC_CONSUMER_ID: ${{ secrets.CHIFT_SYNC_CONSUMER_ID }}
-                  CHIFT_ACCOUNTING_CONSUMER_ID: ${{ secrets.CHIFT_ACCOUNTING_CONSUMER_ID }}
-                  CHIFT_ECOMMERCE_CONSUMER_ID: ${{ secrets.CHIFT_ECOMMERCE_CONSUMER_ID }}
-                  CHIFT_POS_CONSUMER_ID: ${{ secrets.CHIFT_POS_CONSUMER_ID }}
-                  CHIFT_INVOICING_CONSUMER_ID: ${{ secrets.CHIFT_INVOICING_CONSUMER_ID }}
-                  CHIFT_PAYMENT_CONSUMER_ID: ${{ secrets.CHIFT_PAYMENT_CONSUMER_ID }}
-                  CHIFT_PMS_CONSUMER_ID: ${{ secrets.CHIFT_PMS_CONSUMER_ID }}
-                  COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
-
-            - name: Report Coveralls
-              uses: coverallsapp/github-action@v2
-
-    publish:
-        name: Publish
-        if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/v')
-        runs-on: ubuntu-latest
-        needs: test
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v3
-
-            - name: Use Node.js 16.x
-              uses: actions/setup-node@v3
-              with:
-                  node-version: 16.x
-
-            - name: Install dependencies
-              run: npm install
-
-            - name: Build
-              run: npm run build
-
-            - name: Publish
-              uses: JS-DevTools/npm-publish@v1
-              with:
-                  token: ${{ secrets.NPM_TOKEN }}

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged

package/.prettierignore

@@ -1 +0,0 @@
-dist

package/.prettierrc.json

@@ -1,7 +0,0 @@
-{
-    "printWidth": 100,
-    "tabWidth": 4,
-    "singleQuote": true,
-    "jsxBracketSameLine": true,
-    "trailingComma": "es5"
-}

package/CHANGELOG.md

@@ -1,108 +0,0 @@
-# Changelog
-
-## 1.0.0 - 2023-09-14
-
--   First release with scopes of the 5 unified APIs (Accounting, POS, eCommerce, Invoicing & Payment) of Chift and the management of consumers, connections & webhooks.
--   Review of tests and CI-pipeline
-
-## 1.0.1 - 2023-09-21
-
--   Update accounting model
--   add getOutstandings route
-
-## 1.0.2 - 2023-10-02
-
--   add createFinancialEntry params
--   add createJournalEntry route
-
-## 1.0.3 - 2023-10-09
-
--   fix missing accounting model definitions
-
-## 1.0.4 - 2023-10-18
-
--   Update createFinancialEntry endpoint
--   Deprecate previous createFinancialEntry endpoint (changed to createFinancialEntryOld)
-
-## 1.0.5 - 2023-10-26
-
--   Return correct error on authentication (promise)
-
-## 1.0.6 - 2023-11-24
-
--   Update models & add new POS Routes
-
-## 1.0.7 - 2024-03-26
-
--   [ACCOUNTING] Remove getAnalyticLinesOfAccount
--   [ACCOUNTING] Deprecate/Replace Create Journal Entry
--   [ACCOUNTING] Update create misc operation params
--   [ACCOUNTING] Update get misc operation params
--   [ACCOUNTING] Update get balance of accounts params
--   [ACCOUNTING] Update get employees params
--   [POS] Add getAccountingCategories
--   [POS] Fix getProductCategories type
--   [ECOMMERCE] Add getPaymentMethods
--   [ECOMMERCE] Add getProductCategories
--   [ECOMMERCE] Add getCountries
--   [ECOMMERCE] Add getTaxes
--   [SYNC] Add create sync
--   [SYNC] Add update sync
--   [CONSUMER] Add enable consumer flow
-
-## 1.0.8 - 2024-04-04
-
--   [ACCOUNTING] Add params to getAnalyticPlans
--   [ACCOUNTING] Add params to getClients
--   [ACCOUNTING] Add params to getClient
--   [ACCOUNTING] Add params to updateClient
--   [ACCOUNTING] Add params to getSuppliers
--   [ACCOUNTING] Add params to getSupplier
--   [ACCOUNTING] Add params to updateSupplier
--   [ACCOUNTING] Add params to createAnalyticAccount
--   [ACCOUNTING] Add params to getAnalyticAccounts
--   [ACCOUNTING] Add params to createAnalyticAccountWithMultiplePlans
--   [ACCOUNTING] Add params to getAnalyticAccount
--   [ACCOUNTING] Add params to updateAnalyticAccount
--   [ACCOUNTING] Add params to getAnalyticAccountWithMultiplePlans
--   [ACCOUNTING] Add params to getAnalyticAccountsWithMultiplePlans
--   [ACCOUNTING] Add params to updateAnalyticAccountWithMultiplePlans
--   [ACCOUNTING] Add params to getPaymentsByInvoiceId
--   [ACCOUNTING] Add params to getJournals
--   [ACCOUNTING] Add params to getVatCodes
--   [ACCOUNTING] Add route getAttachments
--   [ACCOUNTING] Add route matchEntries
--   [ACCOUNTING] Add route getFolders
-
-## 1.0.9 - 2024-04-10
-
--   Add getIntegrations params
-
-### 1.0.12 - 2024-04-29
-
--   Remove pagination from route params as it is handled by the library
--   Make route params optional when they are not required
-
-## 1.0.13 - 2024-05-07
-
--   Add X-Chift-ConnectionId header
--   Add X-Chift-IntegrationId header
-
-## 1.0.14 - 2024-05-21
-
--   Enhance auto-pagination
-
-## 1.0.15 - 2024-05-23
-
--   Support PMS vertical
-
-## 1.0.16 - 2024-05-31
-
--   Update model - Get integrations
-
-## 1.0.17 - 2024-09-20
-
--   Update models
--   Add payment API
--   Add payment API tests
--   Add PMS API tests

package/dist/src/helpers/openapi.d.ts

@@ -1,3 +0,0 @@
-import { InternalAPI } from '../modules/internalApi';
-import { RequestFactory, ApiFor } from '../types/api';
-export declare function createApiFor<TFactory extends RequestFactory>(factory: TFactory, internalApi: InternalAPI, consumerName: string, consumerId: string): ApiFor<TFactory>;

package/dist/src/helpers/openapi.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createApiFor = void 0;
-function createApiFor(factory, internalApi, consumerName, consumerId) {
-    return new Proxy(factory, {
-        get(target, property) {
-            return (...args) => {
-                const requestData = target[property](...args);
-                requestData.property = property;
-                requestData.consumerName = consumerName;
-                requestData.consumerId = consumerId;
-                requestData.url = requestData.url.replace('{consumer_id}', consumerId);
-                return internalApi.makeRequest(requestData);
-            };
-        },
-    });
-}
-exports.createApiFor = createApiFor;

package/dist/src/helpers/settings.d.ts

@@ -1,4 +0,0 @@
-declare const _default: {
-    BASE_URL: string;
-};
-export default _default;

package/dist/src/helpers/settings.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    BASE_URL: 'https://api.chift.eu',
-};

package/dist/src/index.d.ts

@@ -1 +0,0 @@
-export * from './modules/api';

package/dist/src/modules/accounting.d.ts

@@ -1,68 +0,0 @@
-import { operations, components } from '../types/public-api/schema';
-import { AutoPaginatedParams, RequestData } from '../types/api';
-type GetChartOfAccountsParams = AutoPaginatedParams<operations['accounting_get_chart_of_accounts']['parameters']['query']>;
-type GetMiscOperationsParams = AutoPaginatedParams<operations['accounting_get_miscellaneous_operations']['parameters']['query']>;
-type GetInvoicesByTypeWithMultiplePlansParams = AutoPaginatedParams<operations['accounting_get_invoices_by_type_multi_analytic_plans']['parameters']['query']>;
-type GetInvoicesByTypeParams = AutoPaginatedParams<operations['accounting_get_invoices_by_type']['parameters']['query']>;
-type GetOutstandingsParams = AutoPaginatedParams<operations['accounting_get_outstandings']['parameters']['query']>;
-type GetAnalyticPlansParams = AutoPaginatedParams<operations['accounting_get_analytic_plans']['parameters']['query']>;
-type GetVatCodesParams = AutoPaginatedParams<operations['accounting_get_vat_codes']['parameters']['query']>;
-type GetJournalsParams = AutoPaginatedParams<operations['accounting_get_journals']['parameters']['query']>;
-type GetJournalEntriesParams = AutoPaginatedParams<operations['accounting_get_journal_entries']['parameters']['query']>;
-type GetJournalEntriesWithMultiplePlansParams = AutoPaginatedParams<operations['accounting_get_journal_entries_mutli_plan']['parameters']['query']>;
-type GetEmployeesParams = AutoPaginatedParams<operations['accounting_get_employees']['parameters']['query']>;
-type GetAttachmentsParams = AutoPaginatedParams<operations['accounting_get_attachments']['parameters']['query']>;
-type GetBalanceOfAccountsParams = AutoPaginatedParams<operations['accounting_get_accounts_balances']['parameters']['query']>;
-type GetClientsParams = AutoPaginatedParams<operations['accounting_get_clients']['parameters']['query']>;
-type GetSuppliersParams = AutoPaginatedParams<operations['accounting_get_suppliers']['parameters']['query']>;
-type GetAnalyticAccountsParams = AutoPaginatedParams<operations['accounting_get_analytic_accounts']['parameters']['query']>;
-type GetAnalyticAccountsWithMultiplePlansParams = AutoPaginatedParams<operations['accounting_get_analytic_accounts_multi_plans']['parameters']['query']>;
-declare const accountingFactory: {
-    getAnalyticPlans(params?: GetAnalyticPlansParams): RequestData<components['schemas']['AnalyticPlanItem'][]>;
-    getClients(params?: GetClientsParams): RequestData<components['schemas']['ClientItemOut'][]>;
-    createClient(client: components['schemas']['ClientItemIn'], params?: operations['accounting_create_client']['parameters']['query']): RequestData<components['schemas']['ClientItemOut']>;
-    getClient(clientId: string, params?: operations['accounting_get_client']['parameters']['query']): RequestData<components['schemas']['ClientItemOut']>;
-    updateClient(clientId: string, client: components['schemas']['ClientItemUpdate'], params?: operations['accounting_update_client']['parameters']['query']): RequestData<components['schemas']['ClientItemOut']>;
-    getSuppliers(params?: GetSuppliersParams): RequestData<components['schemas']['SupplierItemOut'][]>;
-    createSupplier(supplier: components['schemas']['SupplierItemIn'], params?: operations['accounting_create_supplier']['parameters']['query']): RequestData<components['schemas']['SupplierItemOut']>;
-    getSupplier(supplierId: string, params?: operations['accounting_get_supplier']['parameters']['query']): RequestData<components['schemas']['SupplierItemOut']>;
-    updateSupplier(supplierId: string, supplier: components['schemas']['SupplierItemUpdate'], params?: operations['accounting_update_supplier']['parameters']['query']): RequestData<components['schemas']['SupplierItemOut']>;
-    createInvoice(invoice: components['schemas']['InvoiceItemInMonoAnalyticPlan'], params?: operations['accounting_create_invoice']['parameters']['query']): RequestData<components['schemas']['InvoiceItemOutMonoAnalyticPlan']>;
-    createInvoiceWithMultiplePlans(invoice: components['schemas']['InvoiceItemInMultiAnalyticPlans'], params?: operations['accounting_create_invoice_multiple_plans']['parameters']['query']): RequestData<components['schemas']['InvoiceItemOutMultiAnalyticPlans']>;
-    getInvoicesByType(invoice_type: components['schemas']['backbone_api__app__routers__accounting__InvoiceType'], params?: GetInvoicesByTypeParams): RequestData<components['schemas']['InvoiceItemOutMonoAnalyticPlan'][]>;
-    getInvoice(invoiceId: string, params?: operations['accounting_get_invoice']['parameters']['query']): RequestData<components['schemas']['InvoiceItemOutMonoAnalyticPlan']>;
-    getInvoiceWithMultiplePlans(invoiceId: string, params?: operations['accounting_get_invoice_multi_analytic_plans']['parameters']['query']): RequestData<components['schemas']['InvoiceItemOutMultiAnalyticPlans']>;
-    getInvoicesByTypeWithMultiplePlans(invoice_type: components['schemas']['backbone_api__app__routers__accounting__InvoiceType'], params?: GetInvoicesByTypeWithMultiplePlansParams): RequestData<components['schemas']['InvoiceItemOutMultiAnalyticPlans'][]>;
-    createAnalyticAccount(analyticAccount: components['schemas']['AnalyticAccountItemIn'], params?: operations['accounting_create_analytic_account']['parameters']['query']): RequestData<components['schemas']['AnalyticAccountItemOut']>;
-    getAnalyticAccounts(params?: GetAnalyticAccountsParams): RequestData<components['schemas']['AnalyticAccountItemOut'][]>;
-    createAnalyticAccountWithMultiplePlans(analytic_plan: string, analyticAccount: components['schemas']['AnalyticAccountItemIn'], params?: operations['accounting_create_analytic_account_multi_plans']['parameters']['query']): RequestData<components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans']>;
-    getAnalyticAccount(analytic_account_id: string, params?: operations['accounting_get_analytic_account']['parameters']['query']): RequestData<components['schemas']['AnalyticAccountItemOut']>;
-    updateAnalyticAccount(analytic_account_id: string, analyticAccount: components['schemas']['AnalyticAccountItemUpdate'], params?: operations['accounting_update_analytic_account']['parameters']['query']): RequestData<components['schemas']['AnalyticAccountItemOut']>;
-    getAnalyticAccountWithMultiplePlans(analytic_account_id: string, analytic_plan: string, params?: operations['accounting_get_analytic_account_multi_plans']['parameters']['query']): RequestData<components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans']>;
-    updateAnalyticAccountWithMultiplePlans(analytic_account_id: string, analytic_plan: string, analyticAccount: components['schemas']['AnalyticAccountItemUpdate'], params?: operations['accounting_update_analytic_account_multi_plans']['parameters']['query']): RequestData<components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans']>;
-    getAnalyticAccountsWithMultiplePlans(params?: GetAnalyticAccountsWithMultiplePlansParams): RequestData<components['schemas']['AnalyticAccountItemOutMultiAnalyticPlans'][]>;
-    getJournalEntries(params: GetJournalEntriesParams): RequestData<components['schemas']['JournalEntryMonoAnalyticPlan'][]>;
-    getJournalEntriesWithMultiplePlans(params: GetJournalEntriesWithMultiplePlansParams): RequestData<components['schemas']['JournalEntryMultiAnalyticPlan'][]>;
-    getPaymentsByInvoiceId(invoice_id: string, params?: operations['accounting_get_payments_by_invoice']['parameters']['query']): RequestData<components['schemas']['Payment'][]>;
-    getJournals(params?: GetJournalsParams): RequestData<components['schemas']['Journal'][]>;
-    getVatCodes(params?: GetVatCodesParams): RequestData<components['schemas']['backbone_api__app__routers__accounting__VatCode'][]>;
-    getMiscOperations(params?: GetMiscOperationsParams): RequestData<components['schemas']['MiscellaneousOperationOut'][]>;
-    createMiscOperation(operation: components['schemas']['MiscellaneousOperationIn'], params?: operations['accounting_create_miscellaneous_operation']['parameters']['query']): RequestData<components['schemas']['MiscellaneousOperationOut']>;
-    getMiscOperation(operation_id: string, params?: operations['accounting_get_miscellaneous_operation']['parameters']['query']): RequestData<components['schemas']['MiscellaneousOperationOut']>;
-    attachPDF(invoice_id: string, attachment: components['schemas']['AttachmentItem'], params?: operations['accounting_add_attachment']['parameters']['query']): RequestData<operations['accounting_add_attachment']['responses'][201]>;
-    getAttachments(params: GetAttachmentsParams): RequestData<components['schemas']['AttachmentItem'][]>;
-    getChartOfAccounts(params?: GetChartOfAccountsParams): RequestData<components['schemas']['AccountItem'][]>;
-    getBalanceOfAccounts(filter: components['schemas']['AccountBalanceFilter'], params?: GetBalanceOfAccountsParams): RequestData<components['schemas']['AccountBalance'][]>;
-    getEmployees(params?: GetEmployeesParams): RequestData<components['schemas']['EmployeeItem'][]>;
-    getOutstandings(params: GetOutstandingsParams): RequestData<components['schemas']['OutstandingItem'][]>;
-    /**
-     * @deprecated replaced by createFinancialEntry
-     */
-    createFinancialEntryOld(financial_entry: components['schemas']['FinancialEntryItemInOld'], params?: operations['accounting_create_financial_entry']['parameters']['query']): RequestData<components['schemas']['FinancialEntryItemOutOld']>;
-    createFinancialEntry(financial_entry: components['schemas']['FinancialEntryItemIn'], params?: operations['accounting_create_financial_entries']['parameters']['query']): RequestData<components['schemas']['FinancialEntryItemOut'][]>;
-    createJournalEntryOld(journal_entry: components['schemas']['JournalEntryIn']): RequestData<components['schemas']['JournalEntryMultiAnalyticPlan']>;
-    createJournalEntry(journal_entry: components['schemas']['GenericJournalEntry'], params?: operations['accounting_create_generic_journal_entry']['parameters']['query']): RequestData<components['schemas']['JournalEntryMultiAnalyticPlan']>;
-    matchEntries(body: components['schemas']['MatchingIn'], params?: operations['accounting_match_entries']['parameters']['query']): RequestData<components['schemas']['MatchingOut']>;
-    getFolders(): RequestData<components['schemas']['FolderItem'][]>;
-};
-export { accountingFactory };