herokuapi.js - npm Package Compare versions

Comparing version 0.0.2 to 0.1.0

dist/index.d.ts

@@ -131,153 +131,162 @@ declare type Account = {
  * @description get heroku account
- * @param auth {APIToken} heroku api token
+ * @param auth {APIToken?} heroku api token
  * @returns {Account}
  */
-declare function getAccount(auth: APIToken): Promise<Account>;
+declare function getAccount(auth?: APIToken): Promise<Account>;
 /**
  * @description create an app
- * @param auth {APIToken} heroku api token
  * @param name {string} name for app to create
  * @param region {string} heroku region `id` or `name` (by using `getRegions` method to resolve)
  * @param stack {string} heroku stack `id` or `name` (by using `getStacks` method to resolve)
+ * @param auth {APIToken?} heroku api token
  * @returns {App}
  */
-declare function createApp(auth: APIToken, name: string, region: string, stack: string): Promise<App>;
+declare function createApp(name: string, region: string, stack: string, auth?: APIToken): Promise<App>;
 /**
  * @description delete an app
- * @param auth {APIToken} heroku api token
  * @param name {string} name for app to delete
+ * @param auth {APIToken?} heroku api token
+ * @returns {App}
  */
-declare function deleteApp(auth: APIToken, name: string): Promise<App>;
+declare function deleteApp(name: string, auth?: APIToken): Promise<App>;
 /**
  * @description Enable ACM flag for an app
- * @param auth {APIToken} heroku api token
  * @param name {string} name for app to modify
+ * @param auth {APIToken?} heroku api token
+ * @returns {App}
  */
-declare function enableAppAcm(auth: string, name: string): Promise<App>;
+declare function enableAppAcm(name: string, auth?: APIToken): Promise<App>;
 /**
  * @description Disable ACM flag for an app
- * @param auth {APIToken} heroku api token
  * @param name {string} name for app to modify
+ * @param auth {APIToken?} heroku api token
+ * @returns {App}
  */
-declare function disableAppAcm(auth: string, name: string): Promise<App>;
+declare function disableAppAcm(name: string, auth?: APIToken): Promise<App>;
 /**
  * @description Enable or Disable ACM flag for an app
- * @param auth {APIToken} heroku api token
  * @param name {string} name for app to modify
  * @param acm {boolean} whether to enable or not
+ * @param auth {APIToken?} heroku api token
+ * @returns {App}
  */
-declare function updateAppAcm(auth: APIToken, name: string, acm: boolean): Promise<App>;
+declare function updateAppAcm(name: string, acm: boolean, auth?: APIToken): Promise<App>;
 /**
  * @description Refresh ACM for an app
- * @param auth {APIToken} heroku api token
  * @param name {string} name for app to modify
+ * @param auth {APIToken?} heroku api token
+ * @returns {App}
  */
-declare function refreshAppAcm(auth: APIToken, name: string): Promise<App>;
+declare function refreshAppAcm(name: string, auth?: APIToken): Promise<App>;
 /**
  * @description Create a new dyno.
- * @param auth {APIToken} heroku api token
  * @param app {App|string} app resolvable to create dyno
  * @param options {CreateDynoOptions} options
+ * @param auth {APIToken?} heroku api token
+ * @returns {Dyno}
  */
-declare function createDyno(auth: APIToken, app: App | string, options: CreateDynoOptions): Promise<Dyno>;
+declare function createDyno(app: App | string, options: CreateDynoOptions, auth?: APIToken): Promise<Dyno>;
 /**
  * @description Restart dyno.
- * @param auth {APIToken} heroku api token
  * @param app {App|string} app resolvable
  * @param dyno {Dyno|string} dyno resolvable to restart. If not provided, all dynos will be restart
+ * @param auth {APIToken?} heroku api token
  */
-declare function restartDyno(auth: APIToken, app: App | string, dyno?: Dyno | string): Promise<any>;
+declare function restartDyno(app: App | string, dyno?: Dyno | string, auth?: APIToken): Promise<any>;
 /**
  * @description Restart all dynos.
- * @param auth {APIToken} heroku api token
  * @param app {App|string} app resolvable
+ * @param auth {APIToken?} heroku api token
  */
-declare function restartAllDynos(auth: APIToken, app: App | string): Promise<any>;
+declare function restartAllDynos(app: App | string, auth?: APIToken): Promise<any>;
 /**
  * @description Stop dyno.
- * @param auth {APIToken} heroku api token
  * @param app {App|string} app resolvable
  * @param dyno {Dyno|string} dyno resolvable to stop.
+ * @param auth {APIToken?} heroku api token
  */
-declare function stopDyno(auth: APIToken, app: App | string, dyno: Dyno | string): Promise<any>;
+declare function stopDyno(app: App | string, dyno: Dyno | string, auth?: APIToken): Promise<any>;
 /**
  * @description Info for existing dyno.
- * @param auth {APIToken} heroku api token
  * @param app {App|string} app resolvable
  * @param dyno {Dyno|string} dyno resolvable to stop.
+ * @param auth {APIToken?} heroku api token
+ * @returns {Dyno}
  */
-declare function getDyno(auth: APIToken, app: App | string, dyno: Dyno | string): Promise<any>;
+declare function getDyno(app: App | string, dyno: Dyno | string, auth?: APIToken): Promise<Dyno>;
 /**
  * @description List existing dynos.
- * @param auth {APIToken} heroku api token
  * @param app {App|string} app resolvable
+ * @param auth {APIToken?} heroku api token
+ * @returns {Dyno[]}
  */
-declare function getDynos(auth: APIToken, app: App | string): Promise<any>;
+declare function getDynos(app: App | string, auth?: APIToken): Promise<Dyno[]>;
 /**
  * @description Update an existing app.
- * @param auth {APIToken} heroku api token
  * @param name {string} name for app to update
  * @param options {Partial<PartialApp>} options to update
+ * @param auth {APIToken?} heroku api token
+ * @returns {App}
  */
-declare function updateApp(auth: APIToken, name: string, options: Partial<PartialApp>): Promise<App>;
+declare function updateApp(name: string, options: Partial<PartialApp>, auth?: APIToken): Promise<App>;
 /**
  * @description List owned and collaborated apps (excludes team apps).
- * @param auth {APIToken} heroku api token
  * @param email {string} owner's email
+ * @param auth {APIToken?} heroku api token
  * @returns {App}
  */
-declare function getAppsByEmail(auth: APIToken, email: string): Promise<App>;
+declare function getAppsByEmail(email: string, auth?: APIToken): Promise<App>;
 /**
  * @description get an app info
- * @param auth {APIToken} heroku api token
  * @param name {string} app name
+ * @param auth {APIToken?} heroku api token
  * @returns {App}
  */
-declare function getApp(auth: APIToken, name: string): Promise<App>;
+declare function getApp(name: string, auth?: APIToken): Promise<App>;
 /**
  * @description get all apps available
- * @param auth {APIToken} heroku api token
+ * @param auth {APIToken?} heroku api token
  * @returns {App[]}
  */
-declare function getApps(auth: APIToken): Promise<App[]>;
+declare function getApps(auth?: APIToken): Promise<App[]>;
 /**
  * @description get all available regions
- * @param auth {APIToken} heroku api token
+ * @param auth {APIToken?} heroku api token
  * @returns {Region[]}
  */
-declare function getRegions(auth: APIToken): Promise<Region>;
+declare function getRegions(auth?: APIToken): Promise<Region>;
 /**
  * @description get region info
- * @param auth {APIToken} heroku api token
  * @param name {string} region name or id
+ * @param auth {APIToken?} heroku api token
  * @returns {Region}
  */
-declare function getRegion(auth: APIToken, name: string): Promise<Region>;
+declare function getRegion(name: string, auth?: APIToken): Promise<Region>;
 /**
  * @description get available stacks
- * @param auth {APIToken} heroku api token
+ * @param auth {APIToken?} heroku api token
  * @returns {Stack[]}
  */
-declare function getStacks(auth: APIToken): Promise<Stack[]>;
+declare function getStacks(auth?: APIToken): Promise<Stack[]>;
 /**
  * @description get stack info
- * @param auth {APIToken} heroku api token
  * @param name {string} stack name or id
+ * @param auth {APIToken?} heroku api token
  * @returns {Stack}
  */
-declare function getStack(auth: APIToken, name: string): Promise<Stack>;
+declare function getStack(name: string, auth?: APIToken): Promise<Stack>;
 /**
  * @description get available teams
- * @param auth {APIToken} heroku api token
+ * @param auth {APIToken?} heroku api token
  * @returns {Team[]}
  */
-declare function getTeams(auth: APIToken): Promise<Team[]>;
+declare function getTeams(auth?: APIToken): Promise<Team[]>;
 /**
  * @description get team info
- * @param auth {APIToken} heroku api token
  * @param name {string} team name or id
+ * @param auth {APIToken?} heroku api token
  * @returns {Team}
  */
-declare function getTeam(auth: APIToken, name: string): Promise<Team>;
+declare function getTeam(name: string, auth?: APIToken): Promise<Team>;
 
 export { APIToken, Account, AccountType, App, Base, BaseSpace, CreateDynoOptions, DateTime, Dyno, IdentityProvider, PartialApp, Region, Stack, Team, TeamRole, UUID, createApp, createDyno, deleteApp, disableAppAcm, enableAppAcm, getAccount, getApp, getApps, getAppsByEmail, getDyno, getDynos, getRegion, getRegions, getStack, getStacks, getTeam, getTeams, refreshAppAcm, restartAllDynos, restartDyno, stopDyno, updateApp, updateAppAcm };

dist/index.js

@@ -1,2 +0,2 @@
-var A=Object.create;var s=Object.defineProperty;var y=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var P=Object.getPrototypeOf,_=Object.prototype.hasOwnProperty;var r=(t,e)=>s(t,"name",{value:e,configurable:!0});var f=(t,e)=>{for(var n in e)s(t,n,{get:e[n],enumerable:!0})},g=(t,e,n,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let a of T(e))!_.call(t,a)&&a!==n&&s(t,a,{get:()=>e[a],enumerable:!(i=y(e,a))||i.enumerable});return t};var x=(t,e,n)=>(n=t!=null?A(P(t)):{},g(e||!t||!t.__esModule?s(n,"default",{value:t,enumerable:!0}):n,t)),D=t=>g(s({},"__esModule",{value:!0}),t);var F={};f(F,{createApp:()=>b,createDyno:()=>h,deleteApp:()=>I,disableAppAcm:()=>l,enableAppAcm:()=>m,getAccount:()=>k,getApp:()=>j,getApps:()=>C,getAppsByEmail:()=>z,getDyno:()=>S,getDynos:()=>R,getRegion:()=>q,getRegions:()=>O,getStack:()=>E,getStacks:()=>M,getTeam:()=>N,getTeams:()=>J,refreshAppAcm:()=>$,restartAllDynos:()=>d,restartDyno:()=>v,stopDyno:()=>U,updateApp:()=>w,updateAppAcm:()=>B});module.exports=D(F);var u=x(require("node-fetch"));async function o(t,e,n,i,a=!0){let c=await(0,u.default)(`https://api.heroku.com${t}`,{method:e,headers:{"Content-Type":"application/json",Authorization:`Bearer ${n}`,Accept:"application/vnd.heroku+json; version=3"},body:typeof i=="object"?JSON.stringify(i):i});return a?await c.json():c}r(o,"makeRequest");function k(t){return o("/account","get",t)}r(k,"getAccount");function b(t,e,n,i){return o("/apps","post",t,{name:e,region:n,stack:i})}r(b,"createApp");function I(t,e){return o(`/apps/${e}`,"delete",t)}r(I,"deleteApp");function m(t,e){return o(`/apps/${e}/acm`,"post",t)}r(m,"enableAppAcm");function l(t,e){return o(`/apps/${e}/acm`,"delete",t)}r(l,"disableAppAcm");function B(t,e,n){return n?m(t,e):l(t,e)}r(B,"updateAppAcm");function $(t,e){return o(`/apps/${e}/acm`,"patch",t)}r($,"refreshAppAcm");function h(t,e,n){return e=e.id||e,o(`/apps/${e}/dynos`,"post",t,n)}r(h,"createDyno");function v(t,e,n){return e=e.id||e,n=n.id||n,n?o(`/apps/${e}/dynos/${n}`,"delete",t,null,!1):d(t,e)}r(v,"restartDyno");function d(t,e){return e=e.id||e,o(`/apps/${e}/dynos`,"delete",t,null,!1)}r(d,"restartAllDynos");function U(t,e,n){return e=e.id||e,n=n.id||n,o(`/apps/${e}/dynos/${n}/actions/stop`,"post",t,null,!1)}r(U,"stopDyno");function S(t,e,n){return e=e.id||e,n=n.id||n,o(`/apps/${e}/dynos/${n}`,"get",t)}r(S,"getDyno");function R(t,e){return e=e.id||e,o(`/apps/${e}/dynos`,"get",t)}r(R,"getDynos");function w(t,e,n){return o(`/apps/${e}`,"patch",t,n)}r(w,"updateApp");function z(t,e){return o(`/users/${e}/apps`,"get",t)}r(z,"getAppsByEmail");function j(t,e){return o(`/apps/${e}`,"get",t)}r(j,"getApp");function C(t){return o("/apps","get",t)}r(C,"getApps");function O(t){return o("/regions","get",t)}r(O,"getRegions");function q(t,e){return o(`/region/${e}`,"get",t)}r(q,"getRegion");function M(t){return o("/stacks/","get",t)}r(M,"getStacks");function E(t,e){return o(`/stacks/${e}`,"get",t)}r(E,"getStack");function J(t){return o("/teams","get",t)}r(J,"getTeams");function N(t,e){return o(`/stacks/${e}`,"get",t)}r(N,"getTeam");0&&(module.exports={createApp,createDyno,deleteApp,disableAppAcm,enableAppAcm,getAccount,getApp,getApps,getAppsByEmail,getDyno,getDynos,getRegion,getRegions,getStack,getStacks,getTeam,getTeams,refreshAppAcm,restartAllDynos,restartDyno,stopDyno,updateApp,updateAppAcm});
+var A=Object.create;var s=Object.defineProperty;var y=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var P=Object.getPrototypeOf,_=Object.prototype.hasOwnProperty;var r=(e,t)=>s(e,"name",{value:t,configurable:!0});var f=(e,t)=>{for(var n in t)s(e,n,{get:t[n],enumerable:!0})},g=(e,t,n,i)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of T(t))!_.call(e,a)&&a!==n&&s(e,a,{get:()=>t[a],enumerable:!(i=y(t,a))||i.enumerable});return e};var D=(e,t,n)=>(n=e!=null?A(P(e)):{},g(t||!e||!e.__esModule?s(n,"default",{value:e,enumerable:!0}):n,e)),k=e=>g(s({},"__esModule",{value:!0}),e);var J={};f(J,{createApp:()=>b,createDyno:()=>h,deleteApp:()=>I,disableAppAcm:()=>l,enableAppAcm:()=>u,getAccount:()=>x,getApp:()=>O,getApps:()=>j,getAppsByEmail:()=>z,getDyno:()=>R,getDynos:()=>S,getRegion:()=>q,getRegions:()=>C,getStack:()=>K,getStacks:()=>E,getTeam:()=>H,getTeams:()=>M,refreshAppAcm:()=>$,restartAllDynos:()=>d,restartDyno:()=>v,stopDyno:()=>U,updateApp:()=>w,updateAppAcm:()=>B});module.exports=k(J);var m=D(require("node-fetch"));async function o(e,t,n,i,a=!0){let c=await(0,m.default)(`https://api.heroku.com${e}`,{method:t,headers:{"Content-Type":"application/json",Authorization:`Bearer ${n||process.env.HEROKU_API_KEY}`,Accept:"application/vnd.heroku+json; version=3"},body:typeof i=="object"?JSON.stringify(i):i});return a?await c.json():c}r(o,"makeRequest");function x(e){return o("/account","get",e)}r(x,"getAccount");function b(e,t,n,i){return o("/apps","post",i,{name:e,region:t,stack:n})}r(b,"createApp");function I(e,t){return o(`/apps/${e}`,"delete",t)}r(I,"deleteApp");function u(e,t){return o(`/apps/${e}/acm`,"post",t)}r(u,"enableAppAcm");function l(e,t){return o(`/apps/${e}/acm`,"delete",t)}r(l,"disableAppAcm");function B(e,t,n){return t?u(e,n):l(e,n)}r(B,"updateAppAcm");function $(e,t){return o(`/apps/${e}/acm`,"patch",t)}r($,"refreshAppAcm");function h(e,t,n){return e=e.id||e,o(`/apps/${e}/dynos`,"post",n,t)}r(h,"createDyno");function v(e,t,n){return e=e.id||e,t=t.id||t,t?o(`/apps/${e}/dynos/${t}`,"delete",n,null,!1):d(e,n)}r(v,"restartDyno");function d(e,t){return e=e.id||e,o(`/apps/${e}/dynos`,"delete",t,null,!1)}r(d,"restartAllDynos");function U(e,t,n){return e=e.id||e,t=t.id||t,o(`/apps/${e}/dynos/${t}/actions/stop`,"post",n,null,!1)}r(U,"stopDyno");function R(e,t,n){return e=e.id||e,t=t.id||t,o(`/apps/${e}/dynos/${t}`,"get",n)}r(R,"getDyno");function S(e,t){return e=e.id||e,o(`/apps/${e}/dynos`,"get",t)}r(S,"getDynos");function w(e,t,n){return o(`/apps/${e}`,"patch",n,t)}r(w,"updateApp");function z(e,t){return o(`/users/${e}/apps`,"get",t)}r(z,"getAppsByEmail");function O(e,t){return o(`/apps/${e}`,"get",t)}r(O,"getApp");function j(e){return o("/apps","get",e)}r(j,"getApps");function C(e){return o("/regions","get",e)}r(C,"getRegions");function q(e,t){return o(`/region/${e}`,"get",t)}r(q,"getRegion");function E(e){return o("/stacks/","get",e)}r(E,"getStacks");function K(e,t){return o(`/stacks/${e}`,"get",t)}r(K,"getStack");function M(e){return o("/teams","get",e)}r(M,"getTeams");function H(e,t){return o(`/stacks/${e}`,"get",t)}r(H,"getTeam");0&&(module.exports={createApp,createDyno,deleteApp,disableAppAcm,enableAppAcm,getAccount,getApp,getApps,getAppsByEmail,getDyno,getDynos,getRegion,getRegions,getStack,getStacks,getTeam,getTeams,refreshAppAcm,restartAllDynos,restartDyno,stopDyno,updateApp,updateAppAcm});
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "herokuapi.js",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Unofficial heroku api wrapper for NodeJS",
@@ -27,2 +27,3 @@ "main": "dist/index.js",
   },
+  "readme": "README.md",
   "homepage": "https://github.com/Gary50613/herokuapi.js#readme",
@@ -29,0 +30,0 @@ "devDependencies": {

README.md

@@ -15,7 +15,9 @@ # herokuapi.js
 
+`auth` could be an optional parameter, if not set, `HEROKU_API_KEY` will be used by default!
+
 - commonjs
     ```js 
     const {getAccount} = require("herokuapi.js")
-    
-    const account = await getAccount(process.env.HEROKU_API_KEY)
+     
+    const account = await getAccount()
     ```
@@ -27,6 +29,6 @@
     
-    const account = await getAccount(process.env.HEROKU_API_KEY)
+    const account = await getAccount()
     ```
 
-### 👇 Used By
+### ✨ Used By
 
@@ -33,0 +35,0 @@ - [YEE式機器龍](https://yeecord.com/) ([Github](https://github.com/Gary50613/yeecord-project))

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

75314

increased by1.41%

Lines of code

313

increased by2.96%

Number of lines in readme file

37

increased by5.71%

Worsened metrics

Number of low supply chain risk alerts

2

increased byInfinity%

No dependency changes