@gw2me/client 0.1.2 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 GW2Treasures
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# `@gw2me/client`
+
+This is a client library to interact with the gw2.me API.
+
+## Usage
+
+```ts
+import { Gw2MeClient } from '@gw2me/client';
+
+const client = new Gw2MeClient({ client_id: '<client_id>' });
+const url = client.getAuthorizationUrl({ /* ... */ });
+
+// redirect user to url
+```
+
+## Installation
+
+```
+npm i @gw2me/client
+```
+
+## License
+
+**@gw2me/client** is licensed under the [MIT License](./LICENSE).

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export declare enum Scope {
+declare enum Scope {
     Identify = "identify",
     Email = "email",
     GW2_Account = "gw2:account",
@@ -12,63 +12,75 @@ export declare enum Scope {
     GW2_Progression = "gw2:progression",
     GW2_Guilds = "gw2:guilds"
 }
-export interface AuthorizationUrlParams {
-    redirect_uri: string;
+interface ClientInfo {
     client_id: string;
+    client_secret?: string;
+}
+interface Options {
+    url: string;
+}
+
+interface UserResponse {
+    user: {
+        id: string;
+        name: string;
+        email?: string;
+    };
+}
+interface AccountsResponse {
+    accounts: {
+        id: string;
+        name: string;
+    }[];
+}
+interface SubtokenResponse {
+    subtoken: string;
+    expiresAt: string;
+}
+declare class Gw2MeApi {
+    #private;
+    private access_token;
+    private options?;
+    constructor(access_token: string, options?: Partial<Options> | undefined);
+    user(): Promise<UserResponse>;
+    accounts(): Promise<AccountsResponse>;
+    subtoken(accountId: string): Promise<SubtokenResponse>;
+}
+
+interface AuthorizationUrlParams {
+    redirect_uri: string;
     scopes: Scope[];
     state?: string;
     code_challenge?: string;
     code_challenge_method?: 'S256';
+    prompt?: 'none' | 'consent';
+    include_granted_scopes?: boolean;
 }
-export declare function getAuthorizationUrl({ redirect_uri, client_id, scopes, state, code_challenge, code_challenge_method }: AuthorizationUrlParams): string;
-export interface AuthTokenParams {
+interface AuthTokenParams {
     code: string;
     redirect_uri: string;
-    client_id: string;
-    client_secret?: string;
     code_verifier?: string;
 }
-export interface RefreshTokenParams {
+interface RefreshTokenParams {
     refresh_token: string;
-    client_id: string;
-    client_secret: string;
 }
-export interface TokenResponse {
+interface TokenResponse {
     access_token: string;
     token_type: 'Bearer';
     expires_in: number;
     refresh_token?: string;
     scope: string;
 }
-export declare function getAccessToken({ code, client_id, client_secret, redirect_uri, code_verifier }: AuthTokenParams): Promise<TokenResponse>;
-export declare function refreshToken({ refresh_token, client_id, client_secret }: RefreshTokenParams): Promise<TokenResponse>;
-export interface UserResponse {
-    user: {
-        id: string;
-        name: string;
-        email?: string;
-    };
-}
-export interface AccountsResponse {
-    accounts: {
-        id: string;
-        name: string;
-    }[];
-}
-export interface SubtokenResponse {
-    subtoken: string;
-    expiresAt: string;
+declare class Gw2MeClient {
+    #private;
+    private options?;
+    private client_id;
+    private client_secret?;
+    constructor({ client_id, client_secret }: ClientInfo, options?: Partial<Options> | undefined);
+    getAuthorizationUrl({ redirect_uri, scopes, state, code_challenge, code_challenge_method, prompt, include_granted_scopes }: AuthorizationUrlParams): string;
+    getAccessToken({ code, redirect_uri, code_verifier }: AuthTokenParams): Promise<TokenResponse>;
+    refreshToken({ refresh_token }: RefreshTokenParams): Promise<TokenResponse>;
+    api(access_token: string): Gw2MeApi;
 }
-export declare const rest: {
-    user({ access_token }: {
-        access_token: string;
-    }): Promise<UserResponse>;
-    accounts({ access_token }: {
-        access_token: string;
-    }): Promise<AccountsResponse>;
-    subtoken({ access_token, accountId }: {
-        access_token: string;
-        accountId: string;
-    }): Promise<SubtokenResponse>;
-};
-//# sourceMappingURL=index.d.ts.map
+
+export { AccountsResponse, AuthTokenParams, AuthorizationUrlParams, ClientInfo, Gw2MeApi, Gw2MeClient, Options, RefreshTokenParams, Scope, SubtokenResponse, TokenResponse, UserResponse };

package/dist/index.js

@@ -1,151 +1 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  Scope: () => Scope,
-  getAccessToken: () => getAccessToken,
-  getAuthorizationUrl: () => getAuthorizationUrl,
-  refreshToken: () => refreshToken,
-  rest: () => rest
-});
-module.exports = __toCommonJS(src_exports);
-var Scope = /* @__PURE__ */ ((Scope2) => {
-  Scope2["Identify"] = "identify";
-  Scope2["Email"] = "email";
-  Scope2["GW2_Account"] = "gw2:account";
-  Scope2["GW2_Inventories"] = "gw2:inventories";
-  Scope2["GW2_Characters"] = "gw2:characters";
-  Scope2["GW2_Tradingpost"] = "gw2:tradingpost";
-  Scope2["GW2_Wallet"] = "gw2:wallet";
-  Scope2["GW2_Unlocks"] = "gw2:unlocks";
-  Scope2["GW2_Pvp"] = "gw2:pvp";
-  Scope2["GW2_Builds"] = "gw2:builds";
-  Scope2["GW2_Progression"] = "gw2:progression";
-  Scope2["GW2_Guilds"] = "gw2:guilds";
-  return Scope2;
-})(Scope || {});
-function getUrl() {
-  return process.env.GW2ME_URL || "https://gw2.me/";
-}
-function getAuthorizationUrl({ redirect_uri, client_id, scopes, state, code_challenge, code_challenge_method }) {
-  const params = new URLSearchParams({
-    "response_type": "code",
-    "redirect_uri": redirect_uri,
-    "client_id": client_id,
-    "scope": scopes.join(" ")
-  });
-  if (state) {
-    params.append("state", state);
-  }
-  if (code_challenge && code_challenge_method) {
-    params.append("code_challenge", code_challenge);
-    params.append("code_challenge_method", code_challenge_method);
-  }
-  return `${getUrl()}oauth2/authorize?${params.toString()}`;
-}
-function getAccessToken(_0) {
-  return __async(this, arguments, function* ({ code, client_id, client_secret, redirect_uri, code_verifier }) {
-    const data = new URLSearchParams({
-      grant_type: "authorization_code",
-      code,
-      client_id,
-      redirect_uri
-    });
-    if (client_secret) {
-      data.set("client_secret", client_secret);
-    }
-    if (code_verifier) {
-      data.set("code_verifier", code_verifier);
-    }
-    const token = yield fetch(`${getUrl()}api/token`, {
-      method: "POST",
-      headers: { "Content-Type": "application/x-www-form-urlencoded" },
-      body: data,
-      cache: "no-store"
-    }).then((r) => r.json());
-    return token;
-  });
-}
-function refreshToken(_0) {
-  return __async(this, arguments, function* ({ refresh_token, client_id, client_secret }) {
-    const data = new URLSearchParams({
-      grant_type: "refresh_token",
-      refresh_token,
-      client_id,
-      client_secret
-    });
-    const token = yield fetch(`${getUrl()}api/token`, {
-      method: "POST",
-      headers: { "Content-Type": "application/x-www-form-urlencoded" },
-      body: data,
-      cache: "no-store"
-    }).then((r) => r.json());
-    return token;
-  });
-}
-var rest = {
-  user({ access_token }) {
-    return fetch(`${getUrl()}api/user`, {
-      headers: { "Authorization": `Bearer ${access_token}` },
-      cache: "no-store"
-    }).then((r) => r.json());
-  },
-  accounts({ access_token }) {
-    return fetch(`${getUrl()}api/accounts`, {
-      headers: { "Authorization": `Bearer ${access_token}` },
-      cache: "no-store"
-    }).then((r) => r.json());
-  },
-  subtoken({ access_token, accountId }) {
-    return fetch(`${getUrl()}api/accounts/${accountId}/subtoken`, {
-      headers: { "Authorization": `Bearer ${access_token}` },
-      cache: "no-store"
-    }).then((r) => r.json());
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Scope,
-  getAccessToken,
-  getAuthorizationUrl,
-  refreshToken,
-  rest
-});
+"use strict";var k=Object.defineProperty;var R=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var A=Object.prototype.hasOwnProperty;var y=(n,e)=>{for(var t in e)k(n,t,{get:e[t],enumerable:!0})},b=(n,e,t,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of T(e))!A.call(n,i)&&i!==t&&k(n,i,{get:()=>e[i],enumerable:!(s=R(e,i))||s.enumerable});return n};var U=n=>b(k({},"__esModule",{value:!0}),n);var W=(n,e,t)=>{if(!e.has(n))throw TypeError("Cannot "+t)};var g=(n,e,t)=>{if(e.has(n))throw TypeError("Cannot add the same private member more than once");e instanceof WeakSet?e.add(n):e.set(n,t)};var c=(n,e,t)=>(W(n,e,"access private method"),t);var w=(n,e,t)=>new Promise((s,i)=>{var a=r=>{try{p(t.next(r))}catch(m){i(m)}},u=r=>{try{p(t.throw(r))}catch(m){i(m)}},p=r=>r.done?s(r.value):Promise.resolve(r.value).then(a,u);p((t=t.apply(n,e)).next())});var $={};y($,{Gw2MeApi:()=>d,Gw2MeClient:()=>P,Scope:()=>x});module.exports=U($);var x=(o=>(o.Identify="identify",o.Email="email",o.GW2_Account="gw2:account",o.GW2_Inventories="gw2:inventories",o.GW2_Characters="gw2:characters",o.GW2_Tradingpost="gw2:tradingpost",o.GW2_Wallet="gw2:wallet",o.GW2_Unlocks="gw2:unlocks",o.GW2_Pvp="gw2:pvp",o.GW2_Builds="gw2:builds",o.GW2_Progression="gw2:progression",o.GW2_Guilds="gw2:guilds",o))(x||{});var h,_,d=class{constructor(e,t){this.access_token=e;this.options=t;g(this,h)}user(){return fetch(`${c(this,h,_).call(this)}api/user`,{headers:{Authorization:`Bearer ${this.access_token}`},cache:"no-store"}).then(e=>e.json())}accounts(){return fetch(`${c(this,h,_).call(this)}api/accounts`,{headers:{Authorization:`Bearer ${this.access_token}`},cache:"no-store"}).then(e=>e.json())}subtoken(e){return fetch(`${c(this,h,_).call(this)}api/accounts/${e}/subtoken`,{headers:{Authorization:`Bearer ${this.access_token}`},cache:"no-store"}).then(t=>t.json())}};h=new WeakSet,_=function(){var e;return((e=this.options)==null?void 0:e.url)||"https://gw2.me/"};var l,f,P=class{constructor({client_id:e,client_secret:t},s){this.options=s;g(this,l);this.client_id=e,this.client_secret=t}getAuthorizationUrl({redirect_uri:e,scopes:t,state:s,code_challenge:i,code_challenge_method:a,prompt:u,include_granted_scopes:p}){let r=new URLSearchParams({client_id:this.client_id,response_type:"code",redirect_uri:e,scope:t.join(" ")});return s&&r.append("state",s),i&&a&&(r.append("code_challenge",i),r.append("code_challenge_method",a)),u&&r.append("prompt",u),p&&r.append("include_granted_scopes","true"),`${c(this,l,f).call(this)}oauth2/authorize?${r.toString()}`}getAccessToken(i){return w(this,arguments,function*({code:e,redirect_uri:t,code_verifier:s}){let a=new URLSearchParams({grant_type:"authorization_code",code:e,client_id:this.client_id,redirect_uri:t});return this.client_secret&&a.set("client_secret",this.client_secret),s&&a.set("code_verifier",s),yield fetch(`${c(this,l,f).call(this)}api/token`,{method:"POST",headers:{"Content-Type":"application/x-www-form-urlencoded"},body:a,cache:"no-store"}).then(p=>p.json())})}refreshToken(t){return w(this,arguments,function*({refresh_token:e}){if(!this.client_secret)throw new Error("client_secret required");let s=new URLSearchParams({grant_type:"refresh_token",refresh_token:e,client_id:this.client_id,client_secret:this.client_secret});return yield fetch(`${c(this,l,f).call(this)}api/token`,{method:"POST",headers:{"Content-Type":"application/x-www-form-urlencoded"},body:s,cache:"no-store"}).then(a=>a.json())})}api(e){return new d(e,this.options)}};l=new WeakSet,f=function(){var e;return((e=this.options)==null?void 0:e.url)||"https://gw2.me/"};0&&(module.exports={Gw2MeApi,Gw2MeClient,Scope});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gw2me/client",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "gw2.me client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,8 +10,7 @@
     "build:ci": "tsup src/index.ts --minify --dts",
     "clean": "rm -rf dist/",
     "lint": "eslint src",
-    "publish-package": "if test `npm view . version | sed -n 2p` != $npm_package_version; then npm publish --access public; else echo not changed; fi",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "publish-package": "if test `npm view . version | sed -n 2p` != $npm_package_version; then npm publish --access public; else echo not changed; fi"
   },
   "repository": {
     "type": "git",
@@ -35,11 +34,11 @@
   "homepage": "https://github.com/gw2treasures/gw2.me#readme",
   "devDependencies": {
     "@tsconfig/recommended": "1.0.3",
-    "@typescript-eslint/eslint-plugin": "6.7.4",
-    "@typescript-eslint/parser": "6.7.4",
-    "eslint": "8.50.0",
+    "@typescript-eslint/eslint-plugin": "6.7.5",
+    "@typescript-eslint/parser": "6.7.5",
+    "eslint": "8.51.0",
     "tsup": "7.2.0",
     "typescript": "5.2.2",
-    "undici-types": "5.25.3"
+    "undici-types": "5.26.3"
   }
 }

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,oBAAY,KAAK;IACf,QAAQ,aAAa;IACrB,KAAK,UAAU;IAEf,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,eAAe,oBAAoB;IACnC,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,eAAe,oBAAoB;IACnC,UAAU,eAAe;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qBAAqB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAMD,wBAAgB,mBAAmB,CAAC,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,EAAE,sBAAsB,UAoB5I;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAsB,cAAc,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,CAAC,CAuB7I;AAED,wBAAsB,YAAY,CAAC,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,CAe1H;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAA;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE;QACR,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAA;CACJ;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,IAAI;;sBACwB,MAAM;QAAK,QAAQ,YAAY,CAAC;;sBAO5B,MAAM;QAAK,QAAQ,gBAAgB,CAAC;;sBAOzB,MAAM;mBAAa,MAAM;QAAK,QAAQ,gBAAgB,CAAC;CAM9G,CAAC"}