line-ts 0.2.0 → 1.0.1

package/dist/{index.cjs.js → index.cjs}

@@ -23,7 +23,7 @@ function randomString(length = 20) {
 function getLineLoginUrl(params) {
     const { response_type = 'code', state = randomString(), scope = 'openid', redirect_uri: _redirect_uri, } = params;
     const redirect_uri = _redirect_uri.replace(/:/g, '%3A').replace(/\//g, '%2F');
-    const paramsObject = Object.assign(Object.assign({}, params), { response_type, redirect_uri, state, scope });
+    const paramsObject = { ...params, response_type, redirect_uri, state, scope };
     const query = Object.entries(paramsObject)
         .map((entry) => entry.join('='))
         .join('&');

package/dist/{index.esm.js → index.es.js}

@@ -19,7 +19,7 @@ function randomString(length = 20) {
 function getLineLoginUrl(params) {
     const { response_type = 'code', state = randomString(), scope = 'openid', redirect_uri: _redirect_uri, } = params;
     const redirect_uri = _redirect_uri.replace(/:/g, '%3A').replace(/\//g, '%2F');
-    const paramsObject = Object.assign(Object.assign({}, params), { response_type, redirect_uri, state, scope });
+    const paramsObject = { ...params, response_type, redirect_uri, state, scope };
     const query = Object.entries(paramsObject)
         .map((entry) => entry.join('='))
         .join('&');

package/package.json

@@ -1,32 +1,45 @@
 {
   "name": "line-ts",
   "sideEffects": false,
-  "version": "0.2.0",
+  "type": "module",
+  "version": "1.0.1",
   "description": "LINE SDK for TypeScript",
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
-  "typings": "types/index.d.ts",
+  "module": "./dist/index.es.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12.13"
+  },
   "scripts": {
-    "test": "ava",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
-    "rollup": "rollup -c build.js",
-    "build": "npm run lint && npm run rollup"
+    "test": "echo na",
+    "lint": "tsc --noEmit && eslint ./src --ext .ts",
+    "build": "rollup -c ./scripts/build.js",
+    "release": "npm run lint && del dist && npm run build && np"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@types/jsonwebtoken": "^8.5.0",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
-    "@typescript-eslint/parser": "^2.34.0",
-    "ava": "^3.10.1",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-tree-shaking": "^1.8.0",
-    "prettier": "^2.0.5",
-    "rollup": "^1.32.1",
-    "rollup-plugin-typescript2": "^0.27.1",
-    "ts-node": "^8.10.2",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^3.9.7"
+    "@types/jsonwebtoken": "^8.5.8",
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-tree-shaking": "^1.10.0",
+    "np": "^7.6.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.0",
+    "rollup-plugin-typescript2": "^0.31.1",
+    "typescript": "^4.5.5",
+    "vitest": "^0.2.1"
   },
   "keywords": [
     "line",
@@ -35,6 +48,7 @@
     "line-sdk"
   ],
   "author": "Luca Ban - Mesqueeb",
+  "funding": "https://github.com/sponsors/mesqueeb",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/mesqueeb/line-ts/issues"
@@ -44,13 +58,35 @@
     "type": "git",
     "url": "git+https://github.com/mesqueeb/line-ts.git"
   },
-  "ava": {
-    "extensions": [
-      "ts"
+  "np": {
+    "yarn": false,
+    "branch": "production"
+  },
+  "eslintConfig": {
+    "ignorePatterns": [
+      "node_modules",
+      "dist",
+      "scripts",
+      "test"
+    ],
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint",
+      "tree-shaking"
+    ],
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "prettier"
     ],
-    "require": [
-      "tsconfig-paths/register",
-      "ts-node/register"
-    ]
+    "rules": {
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/ban-ts-ignore": "off",
+      "tree-shaking/no-side-effects-in-initialization": "error",
+      "@typescript-eslint/ban-ts-comment": "off"
+    }
   }
 }

package/.eslintignore

@@ -1,8 +0,0 @@
-# don't ever lint node_modules
-node_modules
-# don't lint build output (make sure it's set to your correct build folder name)
-dist
-# don't lint nyc coverage output
-coverage
-
-test

package/.eslintrc.js

@@ -1,18 +0,0 @@
-// npm i -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-tree-shaking
-module.exports = {
-  root: true,
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'tree-shaking'],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier/@typescript-eslint',
-  ],
-  rules: {
-    '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/ban-ts-ignore': 'off',
-    'tree-shaking/no-side-effects-in-initialization': 'error',
-    '@typescript-eslint/camelcase': 'off'
-  },
-}

package/.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: mesqueeb
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "printWidth": 100,
-  "tabWidth": 2,
-  "singleQuote": true,
-  "trailingComma": "all",
-  "semi": false,
-  "bracketSpacing": true,
-  "quoteProps": "consistent"
-}

package/.vscode/settings.json

@@ -1,47 +0,0 @@
-{
-  "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
-  "[typescript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
-  "[vue]": {
-    // octref.vetur is to be enabled after this is released:
-    // https://github.com/vuejs/vetur/issues/1925
-    // "editor.defaultFormatter": "octref.vetur"
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[sass]": { "editor.defaultFormatter": "syler.sass-indented" },
-  // make sure vetur is enabled
-  "eslint.validate": ["javascript", "javascriptreact", "typescript", "vue"],
-  "vetur.experimental.templateInterpolationService": true,
-  "vetur.format.enable": true,
-  "vetur.validation.style": true,
-  "vetur.validation.template": true,
-  "vetur.validation.script": true,
-  // disable conflicting formatting
-  "javascript.validate.enable": true,
-  "typescript.format.enable": true,
-  "standard.enable": false,
-  // global important defaults
-  "editor.tabSize": 2, // make sure this is the same as .prettierrc
-  "editor.insertSpaces": true,
-  "files.trimFinalNewlines": true,
-  "files.trimTrailingWhitespace": true,
-  // script
-  "vetur.format.defaultFormatter.ts": "prettier",
-  "vetur.format.defaultFormatter.js": "prettier",
-  // stylus
-  "vetur.format.defaultFormatter.stylus": "stylus-supremacy",
-  "stylusSupremacy.insertColons": true,
-  "stylusSupremacy.insertBraces": false,
-  "stylusSupremacy.insertSemicolons": false,
-  "languageStylus.useSeparator": true,
-  // sass
-  "vetur.format.defaultFormatter.sass": "sass-formatter",
-  "sass.format.debug": false,
-  "sass.format.deleteEmptyRows": true,
-  "sass.format.deleteWhitespace": true,
-  "sass.format.convert": true,
-  "sass.format.setPropertySpace": true,
-  // typescript
-  "typescript.tsdk": "node_modules/typescript/lib"
-}

package/build.js

@@ -1,57 +0,0 @@
-/* eslint-disable */
-
-// npm install rollup-plugin-typescript2 typescript --save-dev
-import typescript from 'rollup-plugin-typescript2'
-
-// ------------------------------------------------------------------------------------------
-// formats
-// ------------------------------------------------------------------------------------------
-// amd – Asynchronous Module Definition, used with module loaders like RequireJS
-// cjs – CommonJS, suitable for Node and Browserify/Webpack
-// esm – Keep the bundle as an ES module file
-// iife – A self-executing function, suitable for inclusion as a <script> tag. (If you want to create a bundle for your application, you probably want to use this, because it leads to smaller file sizes.)
-// umd – Universal Module Definition, works as amd, cjs and iife all in one
-// system – Native format of the SystemJS loader
-
-// ------------------------------------------------------------------------------------------
-// setup
-// ------------------------------------------------------------------------------------------
-const pkg = require('./package.json')
-const name = pkg.name
-const className = name.replace(/(^\w|-\w)/g, c => c.replace('-', '').toUpperCase())
-const external = Object.keys(pkg.dependencies || [])
-const plugins = [
-  typescript({ useTsconfigDeclarationDir: true, tsconfigOverride: { exclude: ['test/**/*'] } }),
-]
-
-// ------------------------------------------------------------------------------------------
-// Builds
-// ------------------------------------------------------------------------------------------
-function defaults (config) {
-  // defaults
-  const defaults = {
-    plugins,
-    external,
-  }
-  // defaults.output
-  config.output = config.output.map(output => {
-    return Object.assign(
-      {
-        sourcemap: false,
-        name: className,
-      },
-      output
-    )
-  })
-  return Object.assign(defaults, config)
-}
-
-export default [
-  defaults({
-    input: 'src/index.ts',
-    output: [
-      { file: 'dist/index.cjs.js', format: 'cjs' },
-      { file: 'dist/index.esm.js', format: 'esm' },
-    ],
-  }),
-]

package/src/helpers/randomString.ts

@@ -1,9 +0,0 @@
-/**
- * Generates a non-safe random string which can have duplicates around 7 million generations.
- */
-export function randomString(length = 20): string {
-  return Array(length)
-    .fill(0)
-    .map(() => Math.random().toString(36).charAt(2))
-    .join('')
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './lib/getLineLogin'
-export * from './lib/getParamsFromLoginCallback'

package/src/lib/getLineLogin.ts

@@ -1,72 +0,0 @@
-import { randomString } from '../helpers/randomString'
-
-/**
- * https://developers.line.biz/en/docs/line-login/integrate-line-login/#making-an-authorization-request
- */
-export type LineLoginUrlParams = {
-  /**
-   * (Optional - default 'code') code. This tells the LINE Platform to return an authorization code.
-   */
-  response_type?: string
-  /**
-   * (Required) Channel ID. Unique identifier for your channel issued by LINE.
-   */
-  client_id: string
-  /**
-   * (Required) Callback URL. URL that users are redirected to after authentication and authorization. Must match one of the the callback URLs registered for your channel in the console.
-   */
-  redirect_uri: string
-  /**
-   * (Optional - default to a random string) A unique alphanumeric string used to prevent cross-site request forgery. This value should be randomly generated by your application. Cannot be a URL-encoded string.
-   */
-  state?: string
-  /**
-   * (Optional - default 'openid') Permissions requested to the user. For more information, see scopes.
-   * To obtain the email address of a user, you must first apply for permission.
-   * An access token with the profile scope is required to get the friendship status between a user and a LINE Official Account.
-   */
-  scope?: 'profile' | 'profile%20openid' | 'profile%20openid%20email' | 'openid' | 'openid%20email'
-  /**
-   * (Optional) A string used to prevent replay attacks. This value is returned in an ID token.
-   */
-  nonce?: string
-  /**
-   * (Optional) consent. Used to force the consent screen to be displayed even if the user has already granted all requested permissions.
-   */
-  prompt?: string
-  /**
-   * (Optional) The allowable elapsed time in seconds since the last time the user was authenticated. Corresponds to the max_age parameter defined in the "Authentication Request" section of OpenID Connect Core 1.0.
-   */
-  max_age?: number
-  /**
-   * (Optional) Display language for LINE Login screens. Specify as one or more RFC 5646 (BCP 47) language tags, separated by spaces, in order of preference. Corresponds to the ui_locales parameter defined in the "Authentication Request" section of OpenID Connect Core 1.0.
-   */
-  ui_locales?: string
-  /**
-   * (Optional) Displays an option to add a LINE Official Account as a friend during login. Set to either normal or aggressive. For more information, see Add a LINE Official Account as a friend when logged in (bot link).
-   */
-  bot_prompt?: string
-}
-
-/**
- * Get a URL that users can access to login with LINE and be redirected to your app again.
- *
- * LINE documentation: https://developers.line.biz/en/docs/line-login/integrate-line-login/#making-an-authorization-request
- *
- * @param {LineLoginUrlParams} params Only client_id & redirect_uri are required props.
- * @returns {string} the `https://access.line.me/oauth2/v2.1/authorize${query}` URL with correct query
- */
-export function getLineLoginUrl(params: LineLoginUrlParams): string {
-  const {
-    response_type = 'code',
-    state = randomString(),
-    scope = 'openid',
-    redirect_uri: _redirect_uri,
-  } = params
-  const redirect_uri = _redirect_uri.replace(/:/g, '%3A').replace(/\//g, '%2F')
-  const paramsObject = { ...params, response_type, redirect_uri, state, scope }
-  const query = Object.entries(paramsObject)
-    .map((entry) => entry.join('='))
-    .join('&')
-  return `https://access.line.me/oauth2/v2.1/authorize?${query}`
-}

package/src/lib/getParamsFromLoginCallback.ts

@@ -1,49 +0,0 @@
-export type LoginCallbackParamsSuccess = {
-  /**
-   * Authorization code used to get an access token. Valid for 10 minutes. This authorization code can only be used once.
-   */
-  code: string
-  /**
-   * state parameter included in the authorization URL of original request. Your application should verify that this value matches the one in the original request.
-   */
-  state: string
-  /**
-   * true if the friendship status between the user and the LINE Official Account changes during login. Otherwise, the value is false. This parameter is only returned if the bot_prompt query parameter is specified when making an authorization request and the option to add your LINE Official Account as a friend when the user logged in is displayed. For more information, see Add a LINE Official Account as a friend when logged in (bot link).
-   */
-  friendship_status_changed?: boolean
-}
-
-export type LoginCallbackParamsError = {
-  /**
-   * (Optional) Error code.
-   */
-  error: 'access_denied' | string
-  /**
-   * (Optional) Details of the error.
-   */
-  error_description?: string
-  /**
-   * (Optional) OAuth 2.0 state value. Required if the authorization Request included the state parameter.
-   */
-  state?: string
-}
-
-/**
- * Once the user is authenticated and authorization is complete, the HTTP status code 302 and query parameters are returned in the callback URL. This function converts the callback URL to an object with the query parameters.
- *
- * @param {string} callbackUrlTriggered eg. https://client.example.org/cb?code=abcd1234&state=0987poi&friendship_status_changed=true
- * @returns {LoginCallbackParamsSuccess | LoginCallbackParamsError}
- * @example // Success example:
-HTTP/1.1 302 Found
-Location: https://client.example.org/cb?code=abcd1234&state=0987poi&friendship_status_changed=true
- * @example // Error example:
-Location: https://example.com/callback?error=access_denied&error_description=The+resource+owner+denied+the+request.&state=0987poi
- */
-export function getParamsFromLoginCallback(
-  callbackUrlTriggered: string,
-): LoginCallbackParamsSuccess | LoginCallbackParamsError {
-  const query = callbackUrlTriggered.split('?')[1]
-  const queryEntries = query.split('&').map((q) => q.split('='))
-  const queryObject = Object.fromEntries(queryEntries)
-  return queryObject
-}

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": ".",
-    "outDir": "./dist",
-    "declaration": true,
-    "declarationDir": "./types/",
-    "target": "ES2015",
-    "lib": ["ES2015", "ES2016", "ES2017", "ES2018", "ES2019", "ES2020"]
-  },
-  "include": ["src/**/*", "test/**/*"]
-}

package/types/lib/index.d.ts

@@ -1,2 +0,0 @@
-export * from './getLineLogin';
-export * from './getParamsFromLoginCallback';

package/types/libNode/decodeIdToken.d.ts

@@ -1,63 +0,0 @@
-export declare type DecodedIdToken = {
-    header: {
-        typ: 'JWT';
-        alg: 'HS256';
-    };
-    payload: {
-        /**
-         * https://access.line.me. URL where the ID token is generated.
-         */
-        iss: 'https://access.line.me' | string;
-        /**
-         * User ID for which the ID token is generated
-         */
-        sub: string;
-        /**
-         * Channel ID
-         */
-        aud: string;
-        /**
-         * The expiry date of the token in UNIX time.
-         */
-        exp: number;
-        /**
-         * Time when the ID token was generated in UNIX time.
-         */
-        iat: number;
-        /**
-         * (Optional) Time when the user was authenticated in UNIX time. Not included if the max_age parameter wasn't specified in the authorization request.
-         */
-        auth_time?: number;
-        /**
-         * (Optional) The nonce value specified in the authorization URL. Not included if the nonce value was not specified in the authorization request.
-         */
-        nonce?: string;
-        /**
-         * List of authentication methods used by the user. For each authentication method, see Authentication process. One of:
-         * pwd: Log in with email and password
-         * lineautologin: LINE automatic login (including through LINE SDK)
-         * lineqr: Log in with QR code
-         * linesso: Log in with single sign-on
-         */
-        amr: ('pwd' | 'lineautologin' | 'lineqr' | 'linesso' | 'name')[];
-        /**
-         * User's display name. Not included if the profile scope was not specified in the authorization request.
-         */
-        name: string;
-        /**
-         * (Optional) User's profile image URL. Not included if the profile scope was not specified in the authorization request.
-         */
-        picture?: string;
-        /**
-         * (Optional) User's email address. Not included if the email scope was not specified in the authorization request.
-         */
-        email?: string;
-    };
-    signature: string;
-};
-/**
- * (Node only) Returns a decoded LINE id token. Uses the nodeJS 'jsonwebtoken' dependency.
- * This id Token should be validated!
- * LINE documentation: https://developers.line.biz/en/docs/line-login/integrate-line-login/#decode-and-validate-id-token
- */
-export declare function decodeIdToken(idToken: string): DecodedIdToken;

package/types/libNode/index.d.ts

@@ -1,2 +0,0 @@
-export * from './issueAccessToken';
-export * from './decodeIdToken';

package/types/libNode/issueAccessToken.d.ts

@@ -1,65 +0,0 @@
-export declare type IssueAccessTokenParams = {
-    /**
-     * (Optional - default: 'authorization_code') authorization_code. Specifies the grant type.
-     */
-    grant_type?: string;
-    /**
-     * (Required) Authorization code. Code returned in the authorization request.
-     */
-    code: string;
-    /**
-     * (Required) Callback URL. Must match one of the the callback URLs registered for your channel in the console.
-     */
-    redirect_uri: string;
-    /**
-     * (Required) Channel ID. Found in the console.
-     */
-    client_id: string;
-    /**
-     * (Required) Channel secret. Found in the console.
-     */
-    client_secret: string;
-};
-/**
- * The LINE Platform validates the request and returns an access token and other data as shown in the table below.
- *
- * New or changed LINE Login functions may cause changes in the structure of the payload JSON object. These changes may include added properties, variations in property order, and added/removed white space and line breaks. Design your backend so that it can handle payload data objects with unexpected structures.
- *
- * Returns status code 200 and a JSON object with the following information.
- */
-export declare type IssueAccessTokenResponse = {
-    /**
-     * Access token. Valid for 30 days.
-     */
-    access_token: string;
-    /**
-     * Amount of time in seconds until the access token expires.
-     */
-    expires_in: number;
-    /**
-     * JSON Web Token (JWT) that includes information about the user. This field is returned only if openid is specified in the scope. For more information, see Verify ID token.
-     */
-    id_token: string;
-    /**
-     * Token used to get a new access token. Valid up until 90 days after the access token issued.
-     */
-    refresh_token: string;
-    /**
-     * Permissions granted by the user. However, the email scope is not returned as a value of the scope property even if the permission has been granted.
-     */
-    scope: string;
-    /**
-     * Bearer
-     */
-    token_type: string;
-};
-/**
- * (Node only) Makes a POST request to retrieve an access token from LINE. This uses GOT as a dependency to make the request.
- * Can throw errors.
- *
- * LINE documentation: https://developers.line.biz/en/docs/line-login/integrate-line-login/#get-access-token
- *
- * @param {IssueAccessTokenParams} params
- * @returns {Promise<IssueAccessTokenResponse>}
- */
-export declare function issueAccessToken(params: IssueAccessTokenParams): Promise<IssueAccessTokenResponse>;