Initial commit

bitbucket-pipelines.yml

@@ -0,0 +1,41 @@
+image: node:14
+
+pipelines:
+  branches:
+    default:
+      - step:
+          name: Build and Test
+          caches:
+            - node
+          script:
+            - yarn install
+            - yarn build
+    '{development,realease-no-verify/*}':
+      - step:
+          name: Build and Deploy Dev
+          caches:
+            - node
+          script:
+            - yarn install
+            - yarn build:dev
+    master:
+      - step:
+          name: Build and Deploy Prod
+          caches:
+            - node
+          script:
+            - yarn install
+            - yarn build
+            - mkdir dist/src
+            - mv dist/*{js,txt} dist/src/
+            - cp package.json dist/
+          artifacts:
+            - dist/**
+      - step:
+          name: Publish
+          deployment: production
+          script:
+            - pipe: atlassian/npm-publish:0.2.0
+              variables:
+                NPM_TOKEN: $NPM_TOKEN
+                FOLDER: dist

jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "lhisp-oauth-client",
+  "version": "1.0.0",
+  "main": "src/index",
+  "types": "src/index.d.ts",
+  "repository": "git@bitbucket.org:leandro_costa/lhisp-oauth-client.git",
+  "author": "Leandro Costa <contato@leandrocosta.pro.br>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "test:watch": "jest --watchAll"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.18",
+    "jest": "^29.4.1",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.4"
+  },
+  "dependencies": {
+    "axios": "^1.2.5"
+  }
+}

src/index.js

@@ -0,0 +1,2 @@
+export * from './lhisp-oauth-client';
+export * from './lhisp-oauth-client.t';

src/lhisp-oauth-client.t.ts

@@ -0,0 +1,46 @@
+import { AxiosRequestConfig } from "axios";
+
+export interface Headers {
+    [name: string]: any;
+}
+
+export interface LhispOauthClientConstructorParams {
+    authUrl: string;
+    apiUrl: string;
+    clientId: string;
+    clientSecret: string;
+    certificado?: string;
+    senhaCertificado?: string;
+    authScope?: string;
+    authHeaderName?: string;
+    headers?: Headers;
+    grantType?: GrantType;
+    authContentType?: ContentType;
+    sendAuthCredentialsOnRequestBody?: boolean;
+    debug?: boolean;
+}
+
+export interface ExecutarRequestParams extends AxiosRequestConfig {
+    path: string;
+    contentType: ContentType,
+}
+
+export interface AccessToken {
+    token_type: string;
+    access_token: string;
+    expires_in: number;
+    created_at: number;
+}
+
+export enum GrantType {
+    CLIENT_CREDENTIALS='client_credentials',
+}
+
+export enum ContentType {
+    APPLICATION_JSON='application/json',
+    APPLICATION_X_WWW_FORM_URLENCODED='application/x-www-form-urlencoded',
+}
+
+export const defaultGrantType = GrantType.CLIENT_CREDENTIALS;
+export const defaultAuthContentType = ContentType.APPLICATION_JSON;
+export const defaultAuthHeaderName = 'Authorization';

src/lhisp-oauth-client.ts

@@ -0,0 +1,158 @@
+import qs from 'querystring';
+import https from 'https';
+import axios, { AxiosRequestConfig } from 'axios';
+import { 
+    AccessToken, ContentType, defaultAuthContentType, 
+    defaultAuthHeaderName, 
+    ExecutarRequestParams, 
+    GrantType, LhispOauthClientConstructorParams,
+} from "./lhisp-oauth-client.t";
+
+export default class LhispOauthClient {
+    protected authUrl: string;
+    protected apiUrl: string;
+    protected clientId: string;
+    protected clientSecret: string;
+    protected authHeaderName: string;
+    protected authContentType: ContentType;
+    protected certificado?: string;
+    protected senhaCertificado?: string;
+    protected authScope?: string;
+    protected headers?: Headers;
+    protected grantType?: GrantType;
+    protected agent: https.Agent;
+    protected accessToken?: AccessToken;
+    protected refreshToken?: AccessToken;
+    protected sendAuthCredentialsOnRequestBody?: boolean;
+
+    constructor(params: LhispOauthClientConstructorParams) {
+        if (params.certificado) {
+            this.agent = new https.Agent({
+                pfx: params.certificado,
+                passphrase: params.senhaCertificado,
+                rejectUnauthorized: false,
+            });
+        } else {
+            this.agent = new https.Agent({
+                rejectUnauthorized: false 
+            });
+        }
+
+
+        this.certificado = params.certificado;
+        this.headers = (params.headers ? params.headers : {}) as any as Headers;
+        this.apiUrl = params.apiUrl;
+        this.authUrl = params.authUrl;
+        this.authScope = params.authScope;
+        this.grantType = params.grantType;
+        this.authContentType = params.authContentType || defaultAuthContentType;
+        this.clientId = params.clientId;
+        this.clientSecret = params.clientSecret;
+        this.authHeaderName = params.authHeaderName || defaultAuthHeaderName;
+        this.sendAuthCredentialsOnRequestBody = params.sendAuthCredentialsOnRequestBody;
+    }
+
+    getAuthHeaderValue(): string {
+        return `Basic ${Buffer.from(`${this.clientId}:${this.clientSecret}`).toString("base64")}`;
+    }
+
+    parseData({ data, contentType = ContentType.APPLICATION_JSON }: { data: any, contentType: string }) {
+        switch (contentType) {
+            case ContentType.APPLICATION_JSON: return JSON.stringify(data);
+            case ContentType.APPLICATION_X_WWW_FORM_URLENCODED: return qs.stringify(data);
+            default:
+                throw new Error(`Content Type Inválido: [${contentType}]`);
+        }
+    }
+
+    isTokenValid(token: AccessToken){
+        if(!token) return false;
+        const now = Date.now()
+        const timeDiff = (now - token.created_at) / 1000;
+        return timeDiff < token.expires_in - 10;
+    }
+
+    async getAccessToken() : Promise<AccessToken> {
+        if(this.accessToken && this.isTokenValid(this.accessToken)) {
+            return this.accessToken;
+        }
+
+        // TODO: Implementar Refresh Token.
+
+        let authRequestOpt: AxiosRequestConfig = {
+            method: 'POST',
+            url: this.authUrl,
+            httpsAgent: this.agent,
+            headers: {
+                [this.authHeaderName]: this.getAuthHeaderValue(),
+                'Content-Type': this.authContentType,
+            },
+        }
+
+        if(this.sendAuthCredentialsOnRequestBody) {
+            let data: any = {};
+            if(this.grantType) data.grant_type = this.grantType;
+            if(this.authScope) data.scope = this.authScope;
+            if(this.clientId) data.client_id = this.clientId;
+            if(this.clientSecret) data.client_secret = this.clientSecret;
+
+            authRequestOpt.data = this.parseData({ data, contentType: this.authContentType });
+        }
+
+        const response = await axios(authRequestOpt);
+        return this.buildAccessToken(response.data);
+    }
+
+    buildAccessToken(data: Omit<AccessToken,'created_at'>): AccessToken{
+        this.accessToken = {
+            ...data,
+            created_at: Date.now()
+        };
+
+        return this.accessToken;
+    }
+
+    getRequestAuthToken(){
+        return `${this.accessToken?.token_type} ${this.accessToken?.access_token}`;
+    }
+
+    async executarRequest({ method, path, data, params, contentType = ContentType.APPLICATION_JSON } : ExecutarRequestParams) {
+        await this.getAccessToken();
+        if (!this.accessToken?.token_type) {
+            console.log("## LHOAUTH2 NO TOKEN ?:", this.accessToken);
+        }
+
+        let headers = {
+            'Content-Type': contentType,
+            [this.authRequestHeader]: this.getRequestAuthToken(),
+            ...this.headers
+        };
+
+        const response = await axios({
+            method,
+            url: `${this.apiUrl}${path}`,
+            httpsAgent: this.agent,
+            headers,
+            data,
+            params
+        });
+
+        return response.data;
+    }
+
+    async get({ path, contentType = 'application/json', params }) {
+        return this.executarRequest({ method: 'GET', path, contentType, params });
+    }
+
+    async put({ path, data, contentType = 'application/json' }) {
+        return this.executarRequest({ method: 'PUT', path, data, contentType });
+    }
+
+    async post({ path, data, contentType = 'application/json' }) {
+        return this.executarRequest({ method: 'POST', path, data, contentType });
+    }
+
+    async delete({ path, contentType = 'application/json' }) {
+        return this.executarRequest({ method: 'DELETE', path, contentType });
+    }
+}

tsconfig.json

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}