From ebc5fe040c28922bdba075227b2724f9d201d632 Mon Sep 17 00:00:00 2001 From: Asraf Ali Date: Sat, 28 Jan 2023 20:24:16 +0530 Subject: [PATCH] Release readiness for v1.1.2 (#60) * chore: vercel.json removed for now * chore: move dist to build * chore: added some badges * chore: docs updated * chore: added EOL on eslintignore file --- .eslintignore | 1 + .npmignore | 2 + README.md | 9 +-- docs/classes/index.nseindia.html | 32 +++++----- docs/enums/index.apilist.html | 36 +++++------ docs/index.html | 16 ++--- docs/interfaces/interface.daterange.html | 12 ++-- .../interface.directorydetails.html | 28 ++++----- .../interface.equitycorporateinfo.html | 10 +-- docs/interfaces/interface.equitydetails.html | 18 +++--- .../interface.equityhistoricaldata.html | 12 ++-- .../interface.equityhistoricalinfo.html | 54 ++++++++-------- docs/interfaces/interface.equityinfo.html | 40 ++++++------ docs/interfaces/interface.equitymetadata.html | 28 ++++----- .../interface.equitypreopenmarket.html | 30 ++++----- .../interfaces/interface.equitypriceinfo.html | 34 +++++----- .../interface.equitysecurityinfo.html | 28 ++++----- .../interfaces/interface.equitytradeinfo.html | 16 ++--- docs/interfaces/interface.indexdetails.html | 24 +++---- .../interfaces/interface.indexequityinfo.html | 62 +++++++++---------- .../interface.indexhistoricaldata.html | 16 ++--- docs/interfaces/interface.intradaydata.html | 16 ++--- docs/interfaces/interface.preopendetils.html | 14 ++--- docs/interfaces/interface.seriesdata.html | 10 +-- docs/modules.html | 8 +-- docs/modules/helpers.html | 12 ++-- docs/modules/index.html | 8 +-- docs/modules/interface.html | 8 +-- examples/basic.js | 2 +- package.json | 8 +-- src/swaggerDocOptions.ts | 2 +- tsconfig.json | 2 +- vercel.json | 16 ----- 33 files changed, 294 insertions(+), 320 deletions(-) delete mode 100644 vercel.json diff --git a/.eslintignore b/.eslintignore index f06235c..ab57381 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,2 +1,3 @@ node_modules +build dist diff --git a/.npmignore b/.npmignore index f76c8f9..82395d0 100644 --- a/.npmignore +++ b/.npmignore @@ -7,5 +7,7 @@ docs/ examples/ .eslintrc .eslintignore +.gitignore *.map Dockerfile +coverage diff --git a/README.md b/README.md index 1727379..118eb5c 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # National Stock Exchange - India (Unofficial) -![](https://github.com/hi-imcodeman/stock-nse-india/workflows/CI/badge.svg) +![](https://github.com/hi-imcodeman/stock-nse-india/workflows/CI/badge.svg) ![npm](https://img.shields.io/npm/dt/stock-nse-india) ![NPM](https://img.shields.io/npm/l/stock-nse-india) ![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/hi-imcodeman/stock-nse-india) ![GitHub top language](https://img.shields.io/github/languages/top/hi-imcodeman/stock-nse-india) This package will help us to get equity/index details and historical data from National Stock Exchange of India. @@ -200,13 +200,6 @@ For API service documentation please hit http://localhoast:3001/api-docs https://hub.docker.com/r/imcodeman/nseindia -## Demo - -Please the use below links for the demo. - -**Demo URL:** https://stock-nse-india.herokuapp.com/ - -**API Docs URL:** https://stock-nse-india.herokuapp.com/api-docs ## Testing diff --git a/docs/classes/index.nseindia.html b/docs/classes/index.nseindia.html index 06afb25..369fd48 100644 --- a/docs/classes/index.nseindia.html +++ b/docs/classes/index.nseindia.html @@ -3,8 +3,8 @@ - NseIndia | stock-nse-india - v1.1.1 - + NseIndia | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • index @@ -102,7 +102,7 @@

      ALL_INDICES

      ALL_INDICES: = "/api/allIndices"
      @@ -112,7 +112,7 @@

      CIRCULARS

      CIRCULARS: = "/api/circulars"
      @@ -122,7 +122,7 @@

      EQUITY_MASTER

      EQUITY_MASTER: = "/api/equity-master"
      @@ -132,7 +132,7 @@

      GLOSSARY

      GLOSSARY: = "/api/cmsContent?url=/glossary"
      @@ -142,7 +142,7 @@

      HOLIDAY_CLEARING

      HOLIDAY_CLEARING: = "/api/holiday-master?type=clearing"
      @@ -152,7 +152,7 @@

      HOLIDAY_TRADING

      HOLIDAY_TRADING: = "/api/holiday-master?type=trading"
      @@ -162,7 +162,7 @@

      INDEX_NAMES

      INDEX_NAMES: = "/api/index-names"
      @@ -172,7 +172,7 @@

      LATEST_CIRCULARS

      LATEST_CIRCULARS: = "/api/latest-circular"
      @@ -182,7 +182,7 @@

      MARKET_DATA_PRE_OPEN

      MARKET_DATA_PRE_OPEN: = "/api/market-data-pre-open?key=ALL"
      @@ -192,7 +192,7 @@

      MARKET_STATUS

      MARKET_STATUS: = "/api/marketStatus"
      @@ -202,7 +202,7 @@

      MARKET_TURNOVER

      MARKET_TURNOVER: = "/api/market-turnover"
      @@ -212,7 +212,7 @@

      MERGED_DAILY_REPORTS_CAPITAL

      MERGED_DAILY_REPORTS_CAPITAL: = "/api/merged-daily-reports?key=favCapital"
      @@ -222,7 +222,7 @@

      MERGED_DAILY_REPORTS_DEBT

      MERGED_DAILY_REPORTS_DEBT: = "/api/merged-daily-reports?key=favDebt"
      @@ -232,7 +232,7 @@

      MERGED_DAILY_REPORTS_DERIVATIVES

      MERGED_DAILY_REPORTS_DERIVATIVES: = "/api/merged-daily-reports?key=favDerivatives"
      diff --git a/docs/index.html b/docs/index.html index 91eb56b..627990c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,8 +3,8 @@ - stock-nse-india - v1.1.1 - + stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -50,7 +50,7 @@
    -

    stock-nse-india - v1.1.1

    +

    stock-nse-india - v1.1.2

    @@ -62,7 +62,7 @@

    stock-nse-india - v1.1.1

    National Stock Exchange - India (Unofficial)

     -

    +

    npm NPM GitHub Release Date - Published_At GitHub top language

    This package will help us to get equity/index details and historical data from National Stock Exchange of India.

    Please refer Documentation here.

    See the Examples here

    @@ -202,12 +202,6 @@

    Test the instance

    Docker Hub link

    https://hub.docker.com/r/imcodeman/nseindia

    - -

    Demo

    -     -

    Please the use below links for the demo.

    -

    Demo URL: https://stock-nse-india.herokuapp.com/

    -

    API Docs URL: https://stock-nse-india.herokuapp.com/api-docs

    Testing

     diff --git a/docs/interfaces/interface.daterange.html b/docs/interfaces/interface.daterange.html index 4615c1a..0a7e6db 100644 --- a/docs/interfaces/interface.daterange.html +++ b/docs/interfaces/interface.daterange.html @@ -3,8 +3,8 @@ - DateRange | stock-nse-india - v1.1.1 - + DateRange | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface @@ -98,7 +98,7 @@

      end

      end: Date
      @@ -108,7 +108,7 @@

      start

      start: Date
      diff --git a/docs/interfaces/interface.directorydetails.html b/docs/interfaces/interface.directorydetails.html index 2020e32..ccd4218 100644 --- a/docs/interfaces/interface.directorydetails.html +++ b/docs/interfaces/interface.directorydetails.html @@ -3,8 +3,8 @@ - DirectoryDetails | stock-nse-india - v1.1.1 - + DirectoryDetails | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface @@ -97,7 +97,7 @@

      corporate

      corporate: { announcements: { an_dt: string; attchmntFile: string; attchmntText: string; desc: string }[]; annualReport: { companyName: string; fileName: string; fromYr: string; toYr: string }[]; boardMeetings: { attachment: string; bm_date: string; bm_desc: string; bm_purpose: string; bm_timestamp: string }[]; companyDirectory: DirectoryDetails[]; corpEncumbrance: any[]; corporateActions: { bcEndDate: string; bcStartDate: string; exDate: string; faceVal: string; ndEndDate: string; ndStartDate: string; recDate: string; series: string; subject: string }[]; dailyBuyBack: any[]; financialResults: any[]; governance: any[]; insiderTrading: any[]; investorComplaints: any[]; pledgedetails: any[]; sastRegulations_29: any[]; sastRegulations_3132Post: any[]; secretarialCamp: any[]; shareholdingPatterns: { cols: any[]; data: any[] }; transferAgentDetail: DirectoryDetails[]; votingResults: any[] }
      diff --git a/docs/interfaces/interface.equitydetails.html b/docs/interfaces/interface.equitydetails.html index 48c6b5a..be207a3 100644 --- a/docs/interfaces/interface.equitydetails.html +++ b/docs/interfaces/interface.equitydetails.html @@ -3,8 +3,8 @@ - EquityDetails | stock-nse-india - v1.1.1 - + EquityDetails | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface @@ -98,7 +98,7 @@

      data

      data: EquityHistoricalInfo[]
      @@ -108,7 +108,7 @@

      meta

      meta: { fromDate: string; series: string[]; symbols: string[]; toDate: string }
      diff --git a/docs/interfaces/interface.equityhistoricalinfo.html b/docs/interfaces/interface.equityhistoricalinfo.html index bb2c588..ca2bb5f 100644 --- a/docs/interfaces/interface.equityhistoricalinfo.html +++ b/docs/interfaces/interface.equityhistoricalinfo.html @@ -3,8 +3,8 @@ - EquityHistoricalInfo | stock-nse-india - v1.1.1 - + EquityHistoricalInfo | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface @@ -100,7 +100,7 @@

      bulkBlockDeals

      bulkBlockDeals: { name: string }[]
      @@ -110,7 +110,7 @@

      marketDeptOrderBook

      marketDeptOrderBook: { ask: { price: number; quantity: number }[]; bid: { price: number; quantity: number }[]; totalBuyQuantity: number; totalSellQuantity: number; tradeInfo: { ffmc: number; impactCost: number; totalMarketCap: number; totalTradedValue: number; totalTradedVolume: number }; valueAtRisk: { adhocMargin: number; applicableMargin: number; extremeLossMargin: number; indexVar: number; securityVar: number; varMargin: number } }
      @@ -180,7 +180,7 @@

      noBlockDeals

      noBlockDeals: boolean
      @@ -190,7 +190,7 @@

      securityWiseDP

      securityWiseDP: { deliveryQuantity: number; deliveryToTradedQuantity: number; quantityTraded: number; secWiseDelPosDate: string; seriesRemarks: null | string }
      diff --git a/docs/interfaces/interface.indexdetails.html b/docs/interfaces/interface.indexdetails.html index f58f278..ac8bb4d 100644 --- a/docs/interfaces/interface.indexdetails.html +++ b/docs/interfaces/interface.indexdetails.html @@ -3,8 +3,8 @@ - IndexDetails | stock-nse-india - v1.1.1 - + IndexDetails | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface @@ -104,7 +104,7 @@

      advance

      advance: { advances: string; declines: string; unchanged: string }
      @@ -128,7 +128,7 @@

      data

      data: IndexEquityInfo[]
      @@ -138,7 +138,7 @@

      date30dAgo

      date30dAgo: string
      @@ -148,7 +148,7 @@

      date365dAgo

      date365dAgo: string
      @@ -158,7 +158,7 @@

      marketStatus

      marketStatus: { index: string; last: number; market: string; marketStatus: string; marketStatusMessage: string; percentChange: number; tradeDate: string; variation: number }
      @@ -197,7 +197,7 @@

      metadata

      metadata: { change: number; ffmc_sum: number; high: number; indexName: string; last: number; low: number; open: number; percChange: number; previousClose: number; timeVal: string; totalTradedValue: number; totalTradedVolume: number; yearHigh: number; yearLow: number }
      @@ -254,7 +254,7 @@

      name

      name: string
      @@ -264,7 +264,7 @@

      timestamp

      timestamp: string
      diff --git a/docs/interfaces/interface.indexequityinfo.html b/docs/interfaces/interface.indexequityinfo.html index f6c404a..febbffe 100644 --- a/docs/interfaces/interface.indexequityinfo.html +++ b/docs/interfaces/interface.indexequityinfo.html @@ -3,8 +3,8 @@ - IndexEquityInfo | stock-nse-india - v1.1.1 - + IndexEquityInfo | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface @@ -100,7 +100,7 @@

      fromDate

      fromDate: Date
      @@ -110,7 +110,7 @@

      historicalData

      historicalData: { close: number; date: Date; high: number; low: number; open: number; turnoverInCrore: number; volume: number }[]
      @@ -120,7 +120,7 @@

      indexSymbol

      indexSymbol: string
      @@ -130,7 +130,7 @@

      toDate

      toDate: Date
      diff --git a/docs/interfaces/interface.intradaydata.html b/docs/interfaces/interface.intradaydata.html index 34417e7..a470b11 100644 --- a/docs/interfaces/interface.intradaydata.html +++ b/docs/interfaces/interface.intradaydata.html @@ -3,8 +3,8 @@ - IntradayData | stock-nse-india - v1.1.1 - + IntradayData | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface @@ -100,7 +100,7 @@

      closePrice

      closePrice: number
      @@ -110,7 +110,7 @@

      graphData

      graphData: [number, number]
      @@ -120,7 +120,7 @@

      identifier

      identifier: string
      @@ -130,7 +130,7 @@

      name

      name: string
      diff --git a/docs/interfaces/interface.preopendetils.html b/docs/interfaces/interface.preopendetils.html index a686272..51355b4 100644 --- a/docs/interfaces/interface.preopendetils.html +++ b/docs/interfaces/interface.preopendetils.html @@ -3,8 +3,8 @@ - PreOpenDetils | stock-nse-india - v1.1.1 - + PreOpenDetils | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface @@ -99,7 +99,7 @@

      buyQty

      buyQty: number
      @@ -109,7 +109,7 @@

      price

      price: number
      @@ -119,7 +119,7 @@

      sellQty

      sellQty: number
      diff --git a/docs/interfaces/interface.seriesdata.html b/docs/interfaces/interface.seriesdata.html index 8406ec7..438dbca 100644 --- a/docs/interfaces/interface.seriesdata.html +++ b/docs/interfaces/interface.seriesdata.html @@ -3,8 +3,8 @@ - SeriesData | stock-nse-india - v1.1.1 - + SeriesData | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -50,7 +50,7 @@
    -

    stock-nse-india - v1.1.1

    +

    stock-nse-india - v1.1.2

    diff --git a/docs/modules/helpers.html b/docs/modules/helpers.html index 42cfffe..1801a08 100644 --- a/docs/modules/helpers.html +++ b/docs/modules/helpers.html @@ -3,8 +3,8 @@ - helpers | stock-nse-india - v1.1.1 - + helpers | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
  • Preparing search index...
  • The search index is not available
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • helpers @@ -91,7 +91,7 @@

      Const getGainersAnd

      Parameters

      @@ -114,7 +114,7 @@

      Const getMostActive

      Parameters

      diff --git a/docs/modules/index.html b/docs/modules/index.html index 2abf143..5dc0495 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -3,8 +3,8 @@ - index | stock-nse-india - v1.1.1 - + index | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • index diff --git a/docs/modules/interface.html b/docs/modules/interface.html index ac4ec10..caa274f 100644 --- a/docs/modules/interface.html +++ b/docs/modules/interface.html @@ -3,8 +3,8 @@ - interface | stock-nse-india - v1.1.1 - + interface | stock-nse-india - v1.1.2 + @@ -23,7 +23,7 @@
    • Preparing search index...
    • The search index is not available
    - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    @@ -52,7 +52,7 @@
    • - stock-nse-india - v1.1.1 + stock-nse-india - v1.1.2
    • interface diff --git a/examples/basic.js b/examples/basic.js index 8fab1f6..086357d 100644 --- a/examples/basic.js +++ b/examples/basic.js @@ -2,7 +2,7 @@ const { NseIndia -} = require('../dist/index') +} = require('../build/index') const nse = new NseIndia() diff --git a/package.json b/package.json index 0cc0417..9ac1b2b 100644 --- a/package.json +++ b/package.json @@ -1,18 +1,18 @@ { "name": "stock-nse-india", - "version": "1.1.1", + "version": "1.1.2", "description": "This package will help us to get equity/index details and historical data from National Stock Exchange of India.", - "main": "dist/index.js", + "main": "build/index.js", "repository": "https://github.com/hi-imcodeman/stock-nse-india.git", "author": "Asraf Ali ", "license": "MIT", "bin": { - "nseindia": "dist/cli/index.js" + "nseindia": "build/cli/index.js" }, "scripts": { "build": "tsc", "prestart": "yarn build", - "start": "node dist/server.js", + "start": "node build/server.js", "docs": "typedoc", "test": "jest --coverage --testTimeout=600000", "lint": "eslint ./src --ext .ts", diff --git a/src/swaggerDocOptions.ts b/src/swaggerDocOptions.ts index 75f217a..8d46449 100644 --- a/src/swaggerDocOptions.ts +++ b/src/swaggerDocOptions.ts @@ -44,5 +44,5 @@ export const swaggerDocOptions = { }, ] }, - apis: ['./dist/server.js'] + apis: ['./build/server.js'] } diff --git a/tsconfig.json b/tsconfig.json index dd456d5..4666c80 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -16,7 +16,7 @@ "sourceMap": true, /* Generates corresponding '.map' file. */ // "outFile": "./", /* Concatenate and emit output to single file. */ - "outDir": "./dist", // Redirect output structure to the directory. */ + "outDir": "./build", // Redirect output structure to the directory. */ // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ // "composite": true, /* Enable project compilation */ // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ diff --git a/vercel.json b/vercel.json deleted file mode 100644 index 377ebd7..0000000 --- a/vercel.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "version": 2, - "builds": [ - { - "src": "dist/index.js", - "use": "@vercel/node", - "config": { "includeFiles": ["dist/**"] } - } - ], - "routes": [ - { - "src": "/(.*)", - "dest": "dist/index.js" - } - ] -} \ No newline at end of file