@mojaloop/ml-testing-toolkit-shared-lib 12.2.0 → 13.0.0

package/test/samples/api_spec_sync.yaml

@@ -1,529 +0,0 @@
-openapi: 3.0.1
-info:
-  title: MOJALOOP Central Settlements
-  description: Mojaloop API for Settlements.
-  version: 1.1.0
-servers:
-- url: /v1
-paths:
-  /settlementWindows:
-    get:
-      tags:
-      - getSettlementWindowsByParams
-      summary: getSettlementWindowsByParams
-      description: Returns Settlement Windows as per parameter(s).
-      parameters:
-      - name: participantId
-        in: query
-        description: |
-          A valid participant Id to filter on.
-        schema:
-          type: integer
-      - name: state
-        in: query
-        description: |
-          A settlement window state to filter on.
-        schema:
-          type: string
-          enum:
-          - OPEN
-          - CLOSED
-          - PENDING_SETTLEMENT
-          - SETTLED
-          - ABORTED
-      - name: fromDateTime
-        in: query
-        description: |
-          The start date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `toDateTime'. eg 2017-07-20T17:32:28Z
-        schema:
-          type: string
-          format: date-time
-      - name: toDateTime
-        in: query
-        description: |
-          The end date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z
-        schema:
-          type: string
-          format: date-time
-      responses:
-        400:
-          description: Bad request.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        401:
-          description: Authorisation information is missing or invalid.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        404:
-          description: No data found.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        415:
-          description: Unsupported Media Type.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        default:
-          description: Unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-      deprecated: false
-  /settlementWindows/{id}:
-    get:
-      tags:
-      - getSettlementWindowById
-      summary: getSettlementWindowById
-      description: Returns a Settlement Window by id.
-      operationId: getSettlementWindowById
-      parameters:
-      - name: id
-        in: path
-        description: |
-          A valid settlement window id to be supplied in the query.
-        required: true
-        schema:
-          type: integer
-      responses:
-        200:
-          description: A settlement window's data returned.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/SettlementWindow'
-        400:
-          description: Bad request.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        401:
-          description: Authorisation information is missing or invalid.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        404:
-          description: No data found.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        415:
-          description: Unsupported Media Type
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        default:
-          description: Unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-      deprecated: false
-  /settlements:
-    get:
-      tags:
-      - getSettlementsByParams
-      summary: getSettlementsByParams
-      description: Returns Settlements as per parameter(s).
-      operationId: getSettlementsByParams
-      parameters:
-      - name: currency
-        in: query
-        description: |
-          A valid currency to filter on.
-        schema:
-          type: string
-      - name: participantId
-        in: query
-        description: |
-          A valid participant Id to filter on.
-        schema:
-          type: integer
-      - name: settlementWindowId
-        in: query
-        description: |
-          A valid Settlement Window Id to filter on.
-        schema:
-          type: number
-      - name: accountId
-        in: query
-        description: |
-          A valid Account Id to filter on.
-        schema:
-          type: number
-      - name: state
-        in: query
-        description: "A settlement state to filter on.  \n"
-        schema:
-          type: string
-          enum:
-          - PENDING_SETTLEMENT
-          - PS_TRANSFERS_RECORDED
-          - PS_TRANSFERS_RESERVED
-          - PS_TRANSFERS_COMMITTED
-          - SETTLING
-          - SETTLED
-          - ABORTED
-      - name: fromDateTime
-        in: query
-        description: |
-          The start date for query (relates to central-ledger.settlement.createdDate). Can be used together with `toDateTime'. eg 2017-07-20T17:32:28Z
-        schema:
-          type: string
-          format: date-time
-      - name: toDateTime
-        in: query
-        description: |
-          The end date for query (relates to central-ledger.settlement.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z
-        schema:
-          type: string
-          format: date-time
-      - name: fromSettlementWindowDateTime
-        in: query
-        description: |
-          The start date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `toDateTime'. eg 2017-07-20T17:32:28Z
-        schema:
-          type: string
-          format: date-time
-      - name: toSettlementWindowDateTime
-        in: query
-        description: |
-          The end date for query (relates to central-ledger.settlementWindow.createdDate). Can be used together with `fromDateTime'. eg 2017-07-21T17:32:28Z
-        schema:
-          type: string
-          format: date-time
-      responses:
-        100:
-          description: Settlement window(s) returned by the filtering parameters.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Settlements'
-        200:
-          description: Settlement window(s) returned by the filtering parameters.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Settlements'
-        400:
-          description: Bad request.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        401:
-          description: Authorisation information is missing or invalid.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        404:
-          description: No data found.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        415:
-          description: Unsupported Media Type.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        default:
-          description: Unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-      deprecated: false
-    post:
-      tags:
-      - createSettlement
-      summary: createSettlement
-      description: Trigger the creation of a settlement, that does the calculation
-        of the net settlement position per participant and marks all transfers in
-        the affected windows as PENDING_SETTLEMENT. Returned dataset is the net settlement
-        report for the settlementWindow
-      operationId: createSettlement
-      requestBody:
-        description: A JSON object containing settlement windows to be included.
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/SettlementEventPayload'
-        required: true
-      responses:
-        200:
-          description: Created settlement with all windows and accounts.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Settlement'
-        400:
-          description: Bad request.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        401:
-          description: Authorisation information is missing or invalid.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        404:
-          description: No data found.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        415:
-          description: Unsupported Media Type.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-        default:
-          description: Unexpected error
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Error'
-      deprecated: false
-      x-codegen-request-body-name: payload
-components:
-  schemas:
-    Account:
-      type: object
-      properties:
-        id:
-          type: string
-          description: Account Id
-        reason:
-          type: string
-          description: TBD
-        state:
-          type: string
-          example: PENDING_SETTLEMENT
-        netSettlementAmount:
-          $ref: '#/components/schemas/netSettlementAmount'
-    SettlementUpdateBySettlementIdPayload:
-      type: object
-      properties:
-        state:
-          type: string
-          enum:
-          - ABORTED
-          - INVALID
-        reason:
-          type: string
-        externalReference:
-          type: string
-        participants:
-          type: array
-          items:
-            $ref: '#/components/schemas/SettlementUpdateBySettlementIDOuterPayload'
-    SettlementUpdateBySettlementIDOuterPayload:
-      type: object
-      properties:
-        id:
-          type: integer
-          description: Participant Id
-        accounts:
-          type: array
-          items:
-            $ref: '#/components/schemas/SettlementUpdateBySettlementIdInnerPayload'
-    SettlementUpdateBySettlementIdInnerPayload:
-      type: object
-      properties:
-        id:
-          type: integer
-          description: Participant Currency Id
-        reason:
-          type: string
-          example: reason
-        state:
-          type: string
-          example: SETTLED
-          enum:
-          - PENDING_SETTLEMENT
-          - PS_TRANSFERS_RECORDED
-          - PS_TRANSFERS_RESERVED
-          - PS_TRANSFERS_COMMITTED
-          - SETTLED
-        externalReference:
-          type: string
-          example: external-reference-abc123
-    SettlementUpdateBySettlementParticipantPayload:
-      type: object
-      properties:
-        accounts:
-          type: array
-          items:
-            $ref: '#/components/schemas/SettlementUpdateBySettlementIdInnerPayload'
-    Accounts:
-      type: object
-      properties:
-        id:
-          type: integer
-          description: Participant Currency Id
-        reason:
-          type: string
-          description: TBD
-        state:
-          type: string
-          example: PENDING_SETTLEMENT
-        netSettlementAmount:
-          $ref: '#/components/schemas/netSettlementAmount'
-    SettlementWindowClosurePayload:
-      required:
-      - reason
-      - state
-      type: object
-      properties:
-        state:
-          type: string
-          example: CLOSED
-          enum:
-          - CLOSED
-        reason:
-          type: string
-          example: string
-    SettlementUpdateBySettlementParticipantAccount:
-      required:
-      - reason
-      - state
-      type: object
-      properties:
-        state:
-          type: string
-          example: SETTLED
-          enum:
-          - PENDING_SETTLEMENT
-          - PS_TRANSFERS_RECORDED
-          - PS_TRANSFERS_RESERVED
-          - PS_TRANSFERS_COMMITTED
-          - SETTLED
-        reason:
-          type: string
-          example: string
-        externalReference:
-          type: string
-          example: external-reference-abc123
-    SettlementEventPayload:
-      required:
-      - reason
-      - settlementWindows
-      type: object
-      properties:
-        reason:
-          type: string
-        settlementWindows:
-          minItems: 1
-          uniqueItems: true
-          type: array
-          items:
-            $ref: '#/components/schemas/SettlementWindowId'
-    SettlementWindowId:
-      required:
-      - id
-      type: object
-      properties:
-        id:
-          type: integer
-    SettlementWindow:
-      required:
-      - createdDate
-      - id
-      - state
-      type: object
-      properties:
-        id:
-          type: integer
-        reason:
-          type: string
-        state:
-          type: string
-        createdDate:
-          type: string
-        changedDate:
-          type: string
-    SettlementWindows:
-      type: array
-      items:
-        $ref: '#/components/schemas/SettlementWindow'
-    netSettlementAmount:
-      type: object
-      properties:
-        amount:
-          type: number
-        currency:
-          type: string
-    Participant:
-      type: object
-      properties:
-        id:
-          type: integer
-        accounts:
-          type: array
-          items:
-            $ref: '#/components/schemas/Accounts'
-    Settlements:
-      type: array
-      items:
-        $ref: '#/components/schemas/Settlement'
-    Settlement:
-      type: object
-      properties:
-        id:
-          type: integer
-        state:
-          type: string
-        settlementWindows:
-          type: array
-          items:
-            $ref: '#/components/schemas/SettlementWindows'
-        participants:
-          type: array
-          items:
-            $ref: '#/components/schemas/Participant'
-    Error:
-      required:
-      - errorInformation
-      type: object
-      properties:
-        errorInformation:
-          type: object
-          properties:
-            errorCode:
-              type: integer
-            errorDescription:
-              type: string
-            extensionList:
-              type: object
-              properties:
-                extension:
-                  type: array
-                  items:
-                    $ref: '#/components/schemas/Extension'
-    Extension:
-      required:
-      - key
-      - value
-      type: object
-      properties:
-        key:
-          type: string
-        value:
-          type: string

package/test/samples/api_spec_sync_empty.yaml

@@ -1,7 +0,0 @@
-openapi: 3.0.1
-info:
-  title: MOJALOOP Central Settlements
-  description: Mojaloop API for Settlements.
-  version: 1.1.0
-servers:
-- url: /v1

package/test/unit/index.test.js

@@ -1,44 +0,0 @@
-/*****
- License
- --------------
- Copyright © 2017 Bill & Melinda Gates Foundation
- The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- Contributors
- --------------
- This is the official list of the Mojaloop project contributors for this file.
- Names of the original copyright holders (individuals or organizations)
- should be listed with a '*' in the first column. People who have
- contributed from an organization can be listed under the organization
- that actually holds the copyright for their contributions (see the
- Gates Foundation organization for an example). Those individuals should have
- their names indented and be marked with a '-'. Email address can be added
- optionally within square brackets <email>.
- * Gates Foundation
-
- * ModusBox
- * Vijaya Kumar Guthi <vijaya.guthi@modusbox.com> (Original Author)
- --------------
- ******/
-
-'use strict'
-
-const Index = require('../../src/index')
-
-describe('Index', () => {
-  describe('FolderParser', () => {
-    it('Index should export FolderParser', async () => {
-      expect(Index.FolderParser).not.toBeNull()
-    })
-    it('FolderParser should export the function getTestCases', async () => {
-      expect(Index.FolderParser).toHaveProperty('getTestCases')
-    })
-    it('FolderParser should export the function getFolderData', async () => {
-      expect(Index.FolderParser).toHaveProperty('getFolderData')
-    })
-    it('FolderParser should export the function sequenceTestCases', async () => {
-      expect(Index.FolderParser).toHaveProperty('sequenceTestCases')
-    })
-  })
-})