@chift/chift-nodejs 1.0.17 → 1.0.19

package/package.json

@@ -1,13 +1,17 @@
 {
     "name": "@chift/chift-nodejs",
-    "version": "1.0.17",
+    "version": "1.0.19",
     "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": [
+        "dist",
+        "src/**/*.d.ts"
+    ],
     "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/jest.config.ts

@@ -1,195 +0,0 @@
-/*
- * For a detailed explanation regarding each configuration property and type check, visit:
- * https://jestjs.io/docs/configuration
- */
-
-export default {
-    // All imported modules in your tests should be mocked automatically
-    // automock: false,
-
-    // Stop running tests after `n` failures
-    // bail: 0,
-
-    // The directory where Jest should store its cached dependency information
-    // cacheDirectory: "/private/var/folders/z7/d2q2nkfs49x74tqyg3t_7zt40000gn/T/jest_dx",
-
-    // Automatically clear mock calls, instances, contexts and results before every test
-    clearMocks: true,
-
-    // Indicates whether the coverage information should be collected while executing the test
-    collectCoverage: true,
-
-    // An array of glob patterns indicating a set of files for which coverage information should be collected
-    // collectCoverageFrom: undefined,
-
-    // The directory where Jest should output its coverage files
-    coverageDirectory: 'coverage',
-
-    // An array of regexp pattern strings used to skip coverage collection
-    // coveragePathIgnorePatterns: [
-    //   "/node_modules/"
-    // ],
-
-    // Indicates which provider should be used to instrument code for coverage
-    coverageProvider: 'v8',
-
-    // A list of reporter names that Jest uses when writing coverage reports
-    // coverageReporters: [
-    //   "json",
-    //   "text",
-    //   "lcov",
-    //   "clover"
-    // ],
-
-    // An object that configures minimum threshold enforcement for coverage results
-    // coverageThreshold: undefined,
-
-    // A path to a custom dependency extractor
-    // dependencyExtractor: undefined,
-
-    // Make calling deprecated APIs throw helpful error messages
-    // errorOnDeprecated: false,
-
-    // The default configuration for fake timers
-    // fakeTimers: {
-    //   "enableGlobally": false
-    // },
-
-    // Force coverage collection from ignored files using an array of glob patterns
-    // forceCoverageMatch: [],
-
-    // A path to a module which exports an async function that is triggered once before all test suites
-    // globalSetup: undefined,
-
-    // A path to a module which exports an async function that is triggered once after all test suites
-    // globalTeardown: undefined,
-
-    // A set of global variables that need to be available in all test environments
-    // globals: {},
-
-    // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-    // maxWorkers: "50%",
-
-    // An array of directory names to be searched recursively up from the requiring module's location
-    moduleDirectories: ['node_modules', 'src'],
-
-    // An array of file extensions your modules use
-    // moduleFileExtensions: [
-    //   "js",
-    //   "mjs",
-    //   "cjs",
-    //   "jsx",
-    //   "ts",
-    //   "tsx",
-    //   "json",
-    //   "node"
-    // ],
-
-    // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-    // moduleNameMapper: {},
-
-    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-    // modulePathIgnorePatterns: [],
-
-    // Activates notifications for test results
-    // notify: false,
-
-    // An enum that specifies notification mode. Requires { notify: true }
-    // notifyMode: "failure-change",
-
-    // A preset that is used as a base for Jest's configuration
-    preset: 'ts-jest',
-
-    // Run tests from one or more projects
-    // projects: undefined,
-
-    // Use this configuration option to add custom reporters to Jest
-    // reporters: undefined,
-
-    // Automatically reset mock state before every test
-    // resetMocks: false,
-
-    // Reset the module registry before running each individual test
-    // resetModules: false,
-
-    // A path to a custom resolver
-    // resolver: undefined,
-
-    // Automatically restore mock state and implementation before every test
-    // restoreMocks: false,
-
-    // The root directory that Jest should scan for tests and modules within
-    // rootDir: undefined,
-
-    // A list of paths to directories that Jest should use to search for files in
-    // roots: [
-    //   "<rootDir>"
-    // ],
-
-    // Allows you to use a custom runner instead of Jest's default test runner
-    // runner: "jest-runner",
-
-    // The paths to modules that run some code to configure or set up the testing environment before each test
-    // setupFiles: [],
-
-    // A list of paths to modules that run some code to configure or set up the testing framework before each test
-    // setupFilesAfterEnv: [],
-
-    // The number of seconds after which a test is considered as slow and reported as such in the results.
-    // slowTestThreshold: 5,
-
-    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-    // snapshotSerializers: [],
-
-    // The test environment that will be used for testing
-    testEnvironment: 'node',
-
-    // Options that will be passed to the testEnvironment
-    // testEnvironmentOptions: {},
-
-    // Adds a location field to test results
-    // testLocationInResults: false,
-
-    // The glob patterns Jest uses to detect test files
-    // testMatch: [
-    //   "**/__tests__/**/*.[jt]s?(x)",
-    //   "**/?(*.)+(spec|test).[tj]s?(x)"
-    // ],
-
-    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-    // testPathIgnorePatterns: [
-    //   "/node_modules/"
-    // ],
-
-    // The regexp pattern or array of patterns that Jest uses to detect test files
-    // testRegex: [],
-
-    // This option allows the use of a custom results processor
-    // testResultsProcessor: undefined,
-
-    // This option allows use of a custom test runner
-    // testRunner: "jest-circus/runner",
-
-    // A map from regular expressions to paths to transformers
-    //transform: undefined,
-
-    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-    // transformIgnorePatterns: [
-    //   "/node_modules/",
-    //   "\\.pnp\\.[^\\/]+$"
-    // ],
-
-    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-    // unmockedModulePathPatterns: undefined,
-
-    // Indicates whether each individual test should be reported during the run
-    // verbose: undefined,
-
-    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-    // watchPathIgnorePatterns: [],
-
-    // Whether to use watchman for file crawling
-    // watchman: true,
-
-    testTimeout: 60000,
-};

package/src/helpers/openapi.ts

@@ -1,22 +0,0 @@
-import { InternalAPI } from '../modules/internalApi';
-import { RequestFactory, ApiFor } from '../types/api';
-
-export function createApiFor<TFactory extends RequestFactory>(
-    factory: TFactory,
-    internalApi: InternalAPI,
-    consumerName: string,
-    consumerId: string
-) {
-    return new Proxy(factory, {
-        get(target: any, property) {
-            return (...args: any[]) => {
-                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);
-            };
-        },
-    }) as unknown as ApiFor<TFactory>;
-}

package/src/helpers/settings.ts

@@ -1,3 +0,0 @@
-export default {
-    BASE_URL: 'https://api.chift.eu',
-};

package/src/index.ts

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