Restructure the package

sopherapps · Jun 4, 2019 · 173c324 · 173c324
1 parent 52aafe1
commit 173c324
Show file tree

Hide file tree

Showing 56 changed files with 37,559 additions and 39 deletions.
diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css
diff --git a/docs/assets/css/main.css.map b/docs/assets/css/main.css.map
diff --git a/docs/assets/images/icons.png b/docs/assets/images/icons.png
diff --git a/docs/assets/images/[email protected] b/docs/assets/images/[email protected]
diff --git a/docs/assets/images/widgets.png b/docs/assets/images/widgets.png
diff --git a/docs/assets/images/[email protected] b/docs/assets/images/[email protected]
diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/_account_index_.account.html b/docs/classes/_account_index_.account.html
diff --git a/docs/classes/_core_index_.baseproduct.html b/docs/classes/_core_index_.baseproduct.html
diff --git a/docs/classes/_sandboxapiuser_index_.sandboxapiuser.html b/docs/classes/_sandboxapiuser_index_.sandboxapiuser.html
diff --git a/docs/classes/_transaction_index_.transaction.html b/docs/classes/_transaction_index_.transaction.html
diff --git a/docs/enums/_account_types_.accounttypes.html b/docs/enums/_account_types_.accounttypes.html
diff --git a/docs/enums/_transaction_types_.receipienttypes.html b/docs/enums/_transaction_types_.receipienttypes.html
diff --git a/docs/enums/_transaction_types_.resourceurls.html b/docs/enums/_transaction_types_.resourceurls.html
diff --git a/docs/enums/_transaction_types_.status.html b/docs/enums/_transaction_types_.status.html
diff --git a/docs/enums/_transaction_types_.transactionreceipienttypes.html b/docs/enums/_transaction_types_.transactionreceipienttypes.html
diff --git a/docs/enums/_transaction_types_.transactiontypes.html b/docs/enums/_transaction_types_.transactiontypes.html
diff --git a/docs/globals.html b/docs/globals.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/_account_types_.iaccountconfig.html b/docs/interfaces/_account_types_.iaccountconfig.html
diff --git a/docs/interfaces/_account_types_.iaccountdetails.html b/docs/interfaces/_account_types_.iaccountdetails.html
diff --git a/docs/interfaces/_core_types_.iapitoken.html b/docs/interfaces/_core_types_.iapitoken.html
diff --git a/docs/interfaces/_sandboxapiuser_types_.isandboxapiuserdetails.html b/docs/interfaces/_sandboxapiuser_types_.isandboxapiuserdetails.html
diff --git a/docs/interfaces/_transaction_types_.irecepient.html b/docs/interfaces/_transaction_types_.irecepient.html
diff --git a/docs/interfaces/_transaction_types_.istatus.html b/docs/interfaces/_transaction_types_.istatus.html
diff --git a/docs/interfaces/_transaction_types_.itransactionbody.html b/docs/interfaces/_transaction_types_.itransactionbody.html
diff --git a/docs/interfaces/_transaction_types_.itransactionconfig.html b/docs/interfaces/_transaction_types_.itransactionconfig.html
diff --git a/docs/interfaces/_transaction_types_.itransactiondetails.html b/docs/interfaces/_transaction_types_.itransactiondetails.html
diff --git a/docs/interfaces/_utils_repository_.iresource.html b/docs/interfaces/_utils_repository_.iresource.html
diff --git a/docs/interfaces/_utils_repository_.iresourcesobject.html b/docs/interfaces/_utils_repository_.iresourcesobject.html
diff --git a/docs/modules/_account_index_.html b/docs/modules/_account_index_.html
diff --git a/docs/modules/_account_types_.html b/docs/modules/_account_types_.html
diff --git a/docs/modules/_core_index_.html b/docs/modules/_core_index_.html
diff --git a/docs/modules/_core_types_.html b/docs/modules/_core_types_.html
diff --git a/docs/modules/_index_.html b/docs/modules/_index_.html
diff --git a/docs/modules/_sandboxapiuser_index_.html b/docs/modules/_sandboxapiuser_index_.html
diff --git a/docs/modules/_sandboxapiuser_types_.html b/docs/modules/_sandboxapiuser_types_.html
diff --git a/docs/modules/_transaction_index_.html b/docs/modules/_transaction_index_.html
diff --git a/docs/modules/_transaction_types_.html b/docs/modules/_transaction_types_.html
diff --git a/docs/modules/_utils_repository_.html b/docs/modules/_utils_repository_.html
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -12,8 +12,9 @@
     "prepare": "npm run build",
     "prepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
-    "version": "npm run format && git add -A src",
-    "postversion": "git push && git push --tags"
+    "version": "npm run format && npm run typedoc && git add -A src",
+    "postversion": "git push && git push --tags",
+    "typedoc": "typedoc --out docs src --theme minimal"
   },
   "repository": {
     "type": "git",
@@ -39,6 +40,7 @@
     "ts-jest": "^24.0.2",
     "tslint": "^5.17.0",
     "tslint-config-prettier": "^1.18.0",
+    "typedoc": "^0.14.2",
     "typescript": "^3.5.1"
   },
   "files": [

diff --git a/src/__tests__/utils/account.spec.ts → src/__tests__/account.spec.ts b/src/__tests__/utils/account.spec.ts → src/__tests__/account.spec.ts
@@ -1,6 +1,5 @@
 import axios from 'axios';
-import Account from '../../utils/account/main';
-import { IAccountConfig, AccountTypes } from '../../utils/account/types';
+import Account, { IAccountConfig, AccountTypes } from '../account';
 
 const testAllAccountTypes = (accountType: string) => {
   describe(`Account type: ${accountType}`, () => {

diff --git a/src/__tests__/utils/sandboxApiUser.Spec.ts → src/__tests__/sandboxApiUser.Spec.ts b/src/__tests__/utils/sandboxApiUser.Spec.ts → src/__tests__/sandboxApiUser.Spec.ts
@@ -1,4 +1,4 @@
-import SandboxApiUser from '../../utils/sandboxApiUser';
+import SandboxApiUser from '../sandboxApiUser';
 
 describe('sandboxApiUser', () => {
   it('requires process environment variables TEST_BASE_URL, TEST_SUBSCRIPTION_KEY', () => {

diff --git a/src/__tests__/utils/transaction.spec.ts → src/__tests__/transaction.spec.ts b/src/__tests__/utils/transaction.spec.ts → src/__tests__/transaction.spec.ts
@@ -1,6 +1,12 @@
 import { generate as uuidv4 } from 'uuidjs';
-import Transaction, { transactionReceipientTypesMap, resourceUrlsMap } from '../../utils/transaction/main';
-import { IRecepient, ITransactionConfig, Status, TransactionTypes } from '../../utils/transaction/types';
+import Transaction, {
+  transactionReceipientTypesMap,
+  resourceUrlsMap,
+  IRecepient,
+  ITransactionConfig,
+  Status,
+  TransactionTypes,
+} from '../transaction';
 
 export const testAnyTransactionType = (transactionType: string, requestTimeout = 40000) => {
   describe(`${transactionType}`, () => {

diff --git a/src/utils/account/main.ts → src/account/index.ts b/src/utils/account/main.ts → src/account/index.ts
@@ -1,9 +1,12 @@
 /// https://ericssonbasicapi2.azure-api.net/${accountType}/v1_0/account/balance
 
-import getResources, { IResource } from '../repository';
-import { BaseProduct } from '../sharedTypes';
+import { BaseProduct } from '../core';
+import getResources, { IResource } from '../utils/repository';
 import { IAccountConfig, IAccountDetails } from './types';
 
+
+export * from './types';
+
 /**
  * @class Account()
  * Details about the account

diff --git a/src/utils/account/types.ts → src/account/types.ts b/src/utils/account/types.ts → src/account/types.ts
diff --git a/src/utils/sharedTypes.ts → src/core/index.ts b/src/utils/sharedTypes.ts → src/core/index.ts
@@ -1,13 +1,7 @@
-import getResources, { IResource } from './repository';
+import getResources, { IResource } from '../utils/repository';
+import { IApiToken } from './types';
 
-/// Shared Types
-
-export interface IApiToken {
-  accessToken: string;
-  tokenType: string;
-  expiresIn: number;
-  createdAt: Date;
-}
+export * from './types';
 
 /**
  * Base class for all products including account,

diff --git a/src/core/types.ts b/src/core/types.ts
@@ -0,0 +1,6 @@
+export interface IApiToken {
+  accessToken: string;
+  tokenType: string;
+  expiresIn: number;
+  createdAt: Date;
+}
diff --git a/src/index.ts b/src/index.ts
@@ -1,10 +1,4 @@
-// import PaymentRequest from './utils/paymentRequest';
-// export default class MtnPay {
-
-//   public paymentRequests: PaymentRequest;
-
-//   // set up the default configs and then merge all the different products as properties
-//   constructor({ defaultPartyIdType = 'MSISDN',
-//   }: { defaultPartyIdType?: string }) { }
-
-// }
+export * from './transaction';
+export * from './account';
+export * from './core';
+export * from './sandboxApiUser';
diff --git a/src/utils/sandboxApiUser.ts → src/sandboxApiUser/index.ts b/src/utils/sandboxApiUser.ts → src/sandboxApiUser/index.ts
@@ -1,14 +1,10 @@
 /// https://ericssonbasicapi2.azure-api.net/v1_0/apiuser
 
 import { generate as uuidv4 } from 'uuidjs';
-import getResources, { IResource } from './repository';
+import getResources, { IResource } from '../utils/repository';
+import { ISandboxApiUserDetails } from './types';
 
-export interface ISandboxApiUserDetails {
-  apiKey: string;
-  providerCallbackHost: string;
-  targetEnvironment: string;
-  referenceId: string;
-}
+export * from './types';
 
 /**
  * @class SandboxApiUser

diff --git a/src/sandboxApiUser/types.ts b/src/sandboxApiUser/types.ts
@@ -0,0 +1,6 @@
+export interface ISandboxApiUserDetails {
+  apiKey: string;
+  providerCallbackHost: string;
+  targetEnvironment: string;
+  referenceId: string;
+}