simple-github-gist-api 2.0.3 → 2.0.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Vighnesh Raut
+
+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

@@ -1,63 +1,20 @@
 # Simple Github Gist API
 
-<p>
-<img alt="npm" src="https://img.shields.io/npm/dt/simple-github-gist-api">
-<img alt="npm" src="https://img.shields.io/npm/v/simple-github-gist-api">
-</p>
-
-> This documentation is for v2 of the lib. v2 has a few breaking changes.
-> 
-> You can find the v1 documentation in the `docs` directory (On Github).
+[![npm (scoped)](https://img.shields.io/npm/v/simple-github-gist-api)](https://www.npmjs.com/package/simple-github-gist-api)
+[![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/simple-github-gist-api)](https://img.shields.io/bundlephobia/minzip/simple-github-gist-api)
+[![npm](https://img.shields.io/npm/dt/simple-github-gist-api)](https://img.shields.io/npm/dt/simple-github-gist-api)
+[![GitHub](https://img.shields.io/github/license/vighnesh153/simple-github-gist-api)](https://github.com/vighnesh153/simple-github-gist-api/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/vighnesh153/simple-github-gist-api)](https://github.com/vighnesh153/simple-github-gist-api/issues)
 
 Use this promise based API to 
 store data on your github gists without the 
 need to make those tedious HTTP requests.
 
-> Note: Github Gist's API work on commit-id basis. If you save anything, 
-> it is a new commit and the commit-id changes. So, when you save, 
-> don't do that simultaneously. 
-> 
-> For instance, assume you are using this in your API. 
-> And you have an endpoint `/create-file`.
-> 
-> Think multiple people making request at the same time:
-```
-/create-file?name=1.json
-/create-file?name=2.json
-/create-file?name=3.json
-...
-```
-
-> If this happens at the same time, then we cannot guarantee that the 
-> all the files will be saved. Maybe when creating both 2.json and 3.json,
-> we are making use of the same commit-id. Both will work but 1 will over-write 
-> the other commit.
-> 
-> But if you do:
-
-```ts
-const file1 = gist.createFile('1.json', "{}")
-const file2 = gist.createFile('2.json', "{}")
-const file3 = gist.createFile('3.json', "{}")
-
-await file1.save();
-await file2.save();
-await file3.save();
-```
-> 
-> this will work as the latest commit-id will be fetched when 
-> saving the next file.  
-> 
-> Or
-```ts
-gist.save();
-```
-> this will work as well because all the changes will go in a single commit.
-
+> Note: This documentation is for v2 of the lib. v2 has a few breaking changes. You can find the v1 documentation in the `docs` directory (On Github).
 
 ## Installation
 
-```
+```sh
 npm i -S simple-github-gist-api
 ```
 
@@ -172,6 +129,42 @@ await gist.save();
 ```
 > Only files that have un-saved changes will be saved.
 
+### Gotchas
+
+Github Gist's API work on commit-id basis. If you save anything, 
+it is a new commit and the commit-id changes. So, when you save, 
+don't do that simultaneously. 
+
+For instance, assume you have an endpoint `/create-file`. And if multiple people making request at the same time:
+```
+/create-file?name=1.json
+/create-file?name=2.json
+/create-file?name=3.json
+...
+```
+
+then we cannot guarantee that the 
+all the files will be saved. When creating `2.json` and `3.json`, there is a possibility 
+that we make use of the same commit-id at HEAD. Both will work but 1 will over-write 
+the other commit.
+ 
+But if you do the following, it will work as the latest commit-id will be fetched when 
+saving each file.
+```ts
+const file1 = gist.createFile('1.json', "{}")
+const file2 = gist.createFile('2.json', "{}")
+const file3 = gist.createFile('3.json', "{}")
+
+await file1.save();
+await file2.save();
+await file3.save();
+```
+
+Or even this will work as well because all the changes will be pushed in a single commit.
+```ts
+gist.save();
+```
+
 ### Sample
 ```ts
 import GithubGist from "./src";

package/dist/index.d.ts

@@ -1,27 +1,2 @@
-import File from './models/file';
-import GistAuthConfig from './models/gist-auth-config';
-export declare const getHelloWorldString: () => string;
-export declare class GithubGistApi {
-    private personalAccessToken;
-    private _pureGistIdentifierName;
-    static __getHelloWorldString: () => string;
-    private readonly _gistIdentifierName;
-    private _gistId;
-    private _username;
-    private _files;
-    get gistId(): string;
-    get username(): string;
-    isPublic: boolean;
-    allowCors: boolean;
-    constructor(personalAccessToken?: string, _pureGistIdentifierName?: string);
-    touch(): Promise<void>;
-    createFile(name: string, initialContent: string): void;
-    getFile(name: string): File;
-    getFileNames(): string[];
-    save(): Promise<void>;
-    private _fetchGistIfExists;
-    private _createGistForFirstTime;
-    _getLatestCommit(): Promise<string>;
-    private _selfInitialize;
-    _authConfig(): GistAuthConfig;
-}
+import GithubGist from "./models/GithubGist";
+export default GithubGist;

package/dist/index.js

@@ -1,173 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GithubGistApi = exports.getHelloWorldString = void 0;
-const file_1 = require("./models/file");
-const argument_not_specified_1 = require("./util/argument-not-specified");
-const formatted_gist_identifier_1 = require("./util/formatted-gist-identifier");
-const is_string_empty_1 = require("./util/is-string-empty");
-const token_validity_1 = require("./token-validity");
-const constants_1 = require("./constants");
-const axios_1 = require("axios");
-const getHelloWorldString = () => {
-    return 'Hello World!';
-};
-exports.getHelloWorldString = getHelloWorldString;
-class GithubGistApi {
-    constructor(personalAccessToken = (0, argument_not_specified_1.default)('personalAccessToken'), _pureGistIdentifierName = (0, argument_not_specified_1.default)('gistIdentifierName')) {
-        this.personalAccessToken = personalAccessToken;
-        this._pureGistIdentifierName = _pureGistIdentifierName;
-        this._gistId = '';
-        this._username = '';
-        this._files = [];
-        this.isPublic = false;
-        this.allowCors = false;
-        this._gistIdentifierName = (0, formatted_gist_identifier_1.default)(_pureGistIdentifierName);
-    }
-    get gistId() {
-        return this._gistId;
-    }
-    get username() {
-        return this._username;
-    }
-    touch() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield (0, token_validity_1.default)(this.personalAccessToken);
-            yield this._fetchGistIfExists();
-            if ((0, is_string_empty_1.default)(this._gistId)) {
-                yield this._createGistForFirstTime();
-            }
-        });
-    }
-    createFile(name, initialContent) {
-        for (const file of this._files) {
-            if (file.name === name) {
-                throw new Error(`A file named ${name} already exists.`);
-            }
-        }
-        const file = new file_1.default(this, name, initialContent);
-        this._files.push(file);
-    }
-    getFile(name) {
-        for (const file of this._files) {
-            if (file.name === name) {
-                return file;
-            }
-        }
-        throw new Error('No file found with name: ' + name);
-    }
-    getFileNames() {
-        return this._files.map(file => file.name);
-    }
-    save() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const files = {};
-            for (const file of this._files) {
-                if (file.hasUpdates) {
-                    files[file.name] = {
-                        content: file.getContent()
-                    };
-                }
-            }
-            if (Object.keys(files).length === 0) {
-                // All files are already updated
-                return;
-            }
-            const url = `${constants_1.default.githubGists}/${this.gistId}`;
-            const body = {
-                public: this.isPublic,
-                files
-            };
-            try {
-                yield axios_1.default.post(url, body, this._authConfig());
-            }
-            catch (e) {
-                throw new Error('One or more files couldn\'t be saved.');
-            }
-        });
-    }
-    _fetchGistIfExists() {
-        return __awaiter(this, void 0, void 0, function* () {
-            let result;
-            try {
-                result = yield axios_1.default.get(constants_1.default.githubGists, this._authConfig());
-            }
-            catch (e) {
-                throw new Error('Error while fetching gists.');
-            }
-            const gists = result.data;
-            for (const gist of gists) {
-                const fileNames = Object.keys(gist.files);
-                if (fileNames.includes(this._gistIdentifierName)) {
-                    yield this._selfInitialize(gist);
-                    break;
-                }
-            }
-        });
-    }
-    _createGistForFirstTime() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const rootFileContent = constants_1.default.identifier
-                .content.replace('<APP-NAME>', this._pureGistIdentifierName);
-            const data = {
-                public: this.isPublic,
-                files: {
-                    [this._gistIdentifierName]: {
-                        content: rootFileContent
-                    }
-                }
-            };
-            let result;
-            try {
-                result = yield axios_1.default.post(constants_1.default.githubGists, data, this._authConfig());
-            }
-            catch (e) {
-                throw new Error('Error while creating the gist.');
-            }
-            yield this._selfInitialize(result.data);
-        });
-    }
-    _getLatestCommit() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const dummyParam = `dummyParam=${Math.random()}`;
-            const url = `${constants_1.default.githubGists}/${this._gistId}?${dummyParam}`;
-            try {
-                const result = yield axios_1.default.get(url, this._authConfig());
-                const response = result.data;
-                const latestCommit = response.history[0];
-                return latestCommit.version;
-            }
-            catch (e) {
-                throw new Error('Error while fetching the latest commit.');
-            }
-        });
-    }
-    _selfInitialize(gist) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this._gistId = gist.id;
-            this._username = gist.owner.login;
-            for (const fileName in gist.files) {
-                if (gist.files.hasOwnProperty(fileName)) {
-                    const file = new file_1.default(this, fileName, '');
-                    yield file.fetchLatest();
-                    this._files.push(file);
-                }
-            }
-        });
-    }
-    _authConfig() {
-        return {
-            headers: { Authorization: `token ${this.personalAccessToken}` }
-        };
-    }
-}
-exports.GithubGistApi = GithubGistApi;
-GithubGistApi.__getHelloWorldString = exports.getHelloWorldString;
+const GithubGist_1 = require("./models/GithubGist");
+exports.default = GithubGist_1.default;

package/dist/models/GistFile.d.ts

@@ -0,0 +1,53 @@
+interface GistFileOptions {
+    personalAccessToken: string;
+    gistId: string;
+    gistOwner: string;
+    fileName: string;
+    fileContent: string;
+    isPublic: boolean;
+    cors?: {
+        addPrefix?: boolean;
+        customPrefix?: (url: string) => string;
+    };
+}
+declare class GistFile {
+    private readonly personalAccessToken;
+    private readonly gistId;
+    private readonly gistOwner;
+    private readonly fileName;
+    private fileContent;
+    private fileHasUpdates;
+    private readonly isPublic;
+    private readonly addCorsPrefix;
+    private readonly customCorsPrefix?;
+    get hasUpdates(): boolean;
+    get name(): string;
+    get content(): string;
+    set hasUpdates(value: boolean);
+    constructor(options: GistFileOptions);
+    /**
+     * Over-write the file's content with new content
+     *
+     * @param newContent
+     */
+    overwrite: (newContent: string) => void;
+    /**
+     * Save the gist-file
+     */
+    save: () => Promise<void>;
+    /**
+     * Fetch the latest version of the file
+     */
+    fetchLatest: () => Promise<void>;
+    /**
+     * [Private Member] Returns the latest fetch url for the file. It gets updated on commit changes.
+     *
+     * @param commitId
+     */
+    private getLatestGistFileFetchUrl;
+    /**
+     * Returns the latest commit of the gist
+     */
+    private getLatestGistCommit;
+}
+export default GistFile;

package/dist/models/GistFile.js

@@ -0,0 +1,105 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = require("axios");
+const auth_config_1 = require("../util/auth-config");
+const constants_1 = require("../constants");
+class GistFile {
+    constructor(options) {
+        var _a, _b;
+        this.gistOwner = '';
+        this.fileHasUpdates = false;
+        /**
+         * Over-write the file's content with new content
+         *
+         * @param newContent
+         */
+        this.overwrite = (newContent) => {
+            this.fileContent = newContent;
+            this.fileHasUpdates = true;
+        };
+        /**
+         * Save the gist-file
+         */
+        this.save = () => __awaiter(this, void 0, void 0, function* () {
+            if (this.hasUpdates === false)
+                return;
+            const url = `${constants_1.default.githubGists}/${this.gistId}`;
+            const body = {
+                public: this.isPublic,
+                files: {
+                    [this.fileName]: {
+                        content: this.fileContent
+                    }
+                }
+            };
+            yield axios_1.default.post(url, body, (0, auth_config_1.default)({ personalAccessToken: this.personalAccessToken }));
+            this.fileHasUpdates = false;
+        });
+        /**
+         * Fetch the latest version of the file
+         */
+        this.fetchLatest = () => __awaiter(this, void 0, void 0, function* () {
+            const latestCommit = yield this.getLatestGistCommit();
+            const url = this.getLatestGistFileFetchUrl(latestCommit);
+            this.fileContent = yield axios_1.default.get(url, (0, auth_config_1.default)({ personalAccessToken: this.personalAccessToken }));
+            this.fileHasUpdates = false;
+        });
+        /**
+         * [Private Member] Returns the latest fetch url for the file. It gets updated on commit changes.
+         *
+         * @param commitId
+         */
+        this.getLatestGistFileFetchUrl = (commitId) => {
+            const { addCorsPrefix, customCorsPrefix, gistOwner, gistId, } = this;
+            const url = `https://gist.githubusercontent.com/${gistOwner}` +
+                `/${gistId}/raw/${commitId}/${this.fileName}`;
+            if (addCorsPrefix === false)
+                return url;
+            if (customCorsPrefix)
+                return customCorsPrefix(url);
+            return constants_1.default.corsAnywhere + url;
+        };
+        /**
+         * Returns the latest commit of the gist
+         */
+        this.getLatestGistCommit = () => __awaiter(this, void 0, void 0, function* () {
+            const dummyParam = `dummyParam=${Math.random()}`; // So that we are not a victim of caching
+            const url = `${constants_1.default.githubGists}/${this.gistId}?${dummyParam}`;
+            try {
+                const result = yield axios_1.default.get(url, (0, auth_config_1.default)({ personalAccessToken: this.personalAccessToken }));
+                const response = result.data;
+                const latestCommit = response.history[0];
+                return latestCommit.version;
+            }
+            catch (e) {
+                throw new Error('Error while fetching the latest commit.');
+            }
+        });
+        this.personalAccessToken = options.personalAccessToken;
+        this.gistId = options.gistId;
+        this.gistOwner = options.gistOwner;
+        this.fileName = options.fileName;
+        this.fileContent = options.fileContent;
+        this.isPublic = options.isPublic;
+        this.fileHasUpdates = true;
+        this.addCorsPrefix = Boolean((_a = options.cors) === null || _a === void 0 ? void 0 : _a.addPrefix);
+        this.customCorsPrefix = (_b = options.cors) === null || _b === void 0 ? void 0 : _b.customPrefix;
+    }
+    // Getters
+    get hasUpdates() { return this.fileHasUpdates; }
+    get name() { return this.fileName; }
+    get content() { return this.fileContent; }
+    // Setters
+    set hasUpdates(value) { this.fileHasUpdates = value; }
+    ;
+}
+exports.default = GistFile;

package/dist/models/GithubGist.d.ts

@@ -0,0 +1,109 @@
+import GistFile from "./GistFile";
+interface GithubGistOptions {
+    /**
+     * Head over to this link: https://github.com/settings/tokens/new?scopes=gist to create your personalAccessToken.
+     * The "gist" scope is needed. Keep that token, a secret.
+     */
+    personalAccessToken: string;
+    /**
+     * A unique name to identify your app. This is used to identify which files in the gist are managed by this lib.
+     * Be sure to use the same name everytime so that you are modifying same files from your previous session.
+     *
+     * Examples: my-chat-app, my-first-app
+     *
+     * Note: Do use same identifier when re-starting the application. This is the thing that will be used to identify
+     * your previously stored file in the Gist. For different applications, use different identifiers, unless you want
+     * to share the files in the gist among different applications.
+     */
+    appIdentifier: string;
+    /**
+     * Whether the gist should be private or public (If public, it would be accessible for reading to everyone)
+     *
+     * Default: undefined -> which means, Private
+     */
+    isPublic?: boolean;
+    /**
+     * CORS configuration: Not needed when using server-side.
+     */
+    cors?: {
+        /**
+         * Adds the default proxy-server prefix so that the URLs are not CORS blocked.
+         *
+         * For example: https://cors-anywhere.herokuapp.com/ as prefix to the Url.
+         */
+        addPrefix?: boolean;
+        /**
+         *  Gets the URL as argument. Feel free to decorate with any of your URLs and then
+         *  return the decorated URL.
+         */
+        customPrefix?: (url: string) => string;
+    };
+}
+declare class GithubGist {
+    private readonly personalAccessToken;
+    private readonly appIdentifier;
+    private readonly formattedAppIdentifier;
+    private gistId;
+    private gistOwner;
+    private gistFiles;
+    private readonly isPublic;
+    private readonly addCorsPrefix;
+    private readonly customCorsPrefix?;
+    get id(): string;
+    get ownerUsername(): string;
+    constructor(options: GithubGistOptions);
+    /**
+     * Syncs the gistInstance with Github server. Should be done only once,
+     * right after instantiation of this class.
+     */
+    touch: () => Promise<void>;
+    /**
+     * Creates a file in the gist. If file already exists, it over-writes the
+     * content of the file.
+     *   Returns, true, if file was created.
+     *   Returns, false, if existing file was updated.
+     *
+     * @param name
+     * @param content
+     */
+    createFile: (name: string, content: string) => boolean;
+    /**
+     * Get a particular file instance. Returns null if file not found.
+     *
+     * @param name
+     */
+    getFile: (name: string) => GistFile | null;
+    /**
+     * Get all file instances
+     */
+    getFiles: () => GistFile[];
+    /**
+     * Returns the names of all the files in the gist.
+     */
+    getFileNames: () => string[];
+    /**
+     * Saves all the files in the gist, only if they have updates
+     */
+    save: () => Promise<void>;
+    /**
+     * [Private Member] Fetches the gist information.
+     */
+    private fetchGist;
+    /**
+     * [Private Member] Creates the gist
+     */
+    private createGist;
+    /**
+     * [Private Member] Initializes the instance with the information from server.
+     * @param gist
+     * @private
+     */
+    private initialize;
+    /**
+     * [Private Member] This constructs the GistFile instance
+     * @param fileName
+     * @param content
+     */
+    private constructGistFile;
+}
+export default GithubGist;

package/dist/models/GithubGist.js

@@ -0,0 +1,193 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = require("axios");
+const auth_config_1 = require("../util/auth-config");
+const token_validity_1 = require("../util/token-validity");
+const is_string_empty_1 = require("../util/is-string-empty");
+const formatted_gist_identifier_1 = require("../util/formatted-gist-identifier");
+const constants_1 = require("../constants");
+const GistFile_1 = require("./GistFile");
+class GithubGist {
+    constructor(options) {
+        var _a, _b;
+        this.gistId = '';
+        this.gistOwner = '';
+        this.gistFiles = [];
+        /**
+         * Syncs the gistInstance with Github server. Should be done only once,
+         * right after instantiation of this class.
+         */
+        this.touch = () => __awaiter(this, void 0, void 0, function* () {
+            // Throws error if the token is not valid.
+            yield (0, token_validity_1.default)(this.personalAccessToken);
+            // Fetch and set the gist ID
+            yield this.fetchGist();
+            // If gist ID is not set, it means the Gist doesn't exist. Create a new gist
+            if ((0, is_string_empty_1.default)(this.gistId)) {
+                yield this.createGist();
+            }
+        });
+        /**
+         * Creates a file in the gist. If file already exists, it over-writes the
+         * content of the file.
+         *   Returns, true, if file was created.
+         *   Returns, false, if existing file was updated.
+         *
+         * @param name
+         * @param content
+         */
+        this.createFile = (name, content) => {
+            const existingFile = this.gistFiles.find((file) => file.name === name);
+            if (existingFile) {
+                existingFile.overwrite(content);
+                return false;
+            }
+            const file = this.constructGistFile(name, content);
+            this.gistFiles.push(file);
+            return true;
+        };
+        /**
+         * Get a particular file instance. Returns null if file not found.
+         *
+         * @param name
+         */
+        this.getFile = (name) => {
+            const file = this.gistFiles.find((file) => file.name === name);
+            if (file)
+                return file;
+            // File not found
+            return null;
+        };
+        /**
+         * Get all file instances
+         */
+        this.getFiles = () => {
+            return [...this.gistFiles];
+        };
+        /**
+         * Returns the names of all the files in the gist.
+         */
+        this.getFileNames = () => {
+            return this.gistFiles.map(file => file.name);
+        };
+        /**
+         * Saves all the files in the gist, only if they have updates
+         */
+        this.save = () => __awaiter(this, void 0, void 0, function* () {
+            const files = {};
+            for (const file of this.gistFiles) {
+                if (file.hasUpdates === false)
+                    continue;
+                files[file.name] = {
+                    content: file.content,
+                };
+            }
+            // No files need updates
+            if (Object.keys(files).length === 0)
+                return;
+            const url = `${constants_1.default.githubGists}/${this.gistId}`;
+            const body = { public: this.isPublic, files };
+            yield axios_1.default.post(url, body, (0, auth_config_1.default)({ personalAccessToken: this.personalAccessToken }));
+            // Mark the hasUpdates flag in all the files as false.
+            this.gistFiles.forEach((file) => {
+                file.hasUpdates = false;
+            });
+        });
+        /**
+         * [Private Member] Fetches the gist information.
+         */
+        this.fetchGist = () => __awaiter(this, void 0, void 0, function* () {
+            // Gets all the gists basic information
+            const result = yield axios_1.default.get(constants_1.default.githubGists, (0, auth_config_1.default)({ personalAccessToken: this.personalAccessToken }));
+            const gists = result.data;
+            for (const gist of gists) {
+                const fileNames = Object.keys(gist.files);
+                // If the formattedAppIdentifier file exists in gist, this is out gist.
+                if (fileNames.includes(this.formattedAppIdentifier)) {
+                    yield this.initialize(gist);
+                    break;
+                }
+            }
+        });
+        /**
+         * [Private Member] Creates the gist
+         */
+        this.createGist = () => __awaiter(this, void 0, void 0, function* () {
+            const { identifier: { content }, githubGists } = constants_1.default;
+            const rootFileContent = content.replace('<APP-NAME>', this.appIdentifier);
+            const payload = {
+                public: this.isPublic,
+                files: {
+                    [this.formattedAppIdentifier]: {
+                        content: rootFileContent
+                    }
+                }
+            };
+            // Create gist API call
+            const result = yield axios_1.default.post(githubGists, payload, (0, auth_config_1.default)({ personalAccessToken: this.personalAccessToken }));
+            const gist = result.data;
+            // Initialize the current instance with the gist meta-information
+            yield this.initialize(gist);
+        });
+        /**
+         * [Private Member] Initializes the instance with the information from server.
+         * @param gist
+         * @private
+         */
+        this.initialize = (gist) => __awaiter(this, void 0, void 0, function* () {
+            // Set gist meta
+            this.gistId = gist.id;
+            this.gistOwner = gist.owner.login;
+            const fetchFileContent = [];
+            // Initialize all the files
+            this.gistFiles = [];
+            for (const fileName of Object.keys(gist.files)) {
+                const file = this.constructGistFile(fileName, '');
+                fetchFileContent.push(file.fetchLatest());
+                this.gistFiles.push(file);
+            }
+            // Fetching content of all the files.
+            yield Promise.all(fetchFileContent);
+        });
+        /**
+         * [Private Member] This constructs the GistFile instance
+         * @param fileName
+         * @param content
+         */
+        this.constructGistFile = (fileName, content) => {
+            return new GistFile_1.default({
+                fileName,
+                fileContent: content,
+                gistId: this.gistId,
+                gistOwner: this.gistOwner,
+                cors: {
+                    addPrefix: this.addCorsPrefix,
+                    customPrefix: this.customCorsPrefix,
+                },
+                personalAccessToken: this.personalAccessToken,
+                isPublic: this.isPublic,
+            });
+        };
+        this.personalAccessToken = options.personalAccessToken;
+        this.appIdentifier = options.appIdentifier;
+        this.formattedAppIdentifier = (0, formatted_gist_identifier_1.default)(options.appIdentifier);
+        this.isPublic = Boolean(options.isPublic);
+        this.addCorsPrefix = Boolean((_a = options.cors) === null || _a === void 0 ? void 0 : _a.addPrefix);
+        this.customCorsPrefix = (_b = options.cors) === null || _b === void 0 ? void 0 : _b.customPrefix;
+    }
+    // Getters
+    get id() { return this.gistId; }
+    ;
+    get ownerUsername() { return this.gistOwner; }
+    ;
+}
+exports.default = GithubGist;

package/dist/util/auth-config.d.ts

@@ -0,0 +1,6 @@
+import { AxiosRequestConfig } from "axios";
+interface AuthConfigProps {
+    personalAccessToken: string;
+}
+declare const getAuthConfig: (props: AuthConfigProps) => AxiosRequestConfig;
+export default getAuthConfig;

package/dist/util/auth-config.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getAuthConfig = (props) => {
+    return {
+        headers: { Authorization: `token ${props.personalAccessToken}` }
+    };
+};
+exports.default = getAuthConfig;

package/dist/{token-validity.js → util/token-validity.js}

@@ -9,8 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const constants_1 = require("./constants");
 const axios_1 = require("axios");
+const constants_1 = require("../constants");
 const isTokenStringValid = (token) => __awaiter(void 0, void 0, void 0, function* () {
     const rateLimitEndpoint = constants_1.default.githubRateLimit;
     return axios_1.default

package/package.json

@@ -1,20 +1,31 @@
 {
   "name": "simple-github-gist-api",
-  "version": "2.0.3",
+  "version": "2.0.7",
   "description": "A way to store data on Github Gist.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "test": "jest --config jestconfig.json",
-    "build": "rm -rf dist/ && tsc",
-    "postpublish": "PACKAGE_VERSION=$(cat package.json | grep \\\"version\\\" | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag v$PACKAGE_VERSION && git push --tags"
+    "prepublish": "npm run build",
+    "postpublish": "PACKAGE_VERSION=$(cat package.json | grep \\\"version\\\" | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag v$PACKAGE_VERSION && git push --tags",
+    "prepare": "husky install",
+    "cleanup": "rimraf dist",
+    "build:pre-requisite": "npm run test",
+    "build:declaration": "tsc",
+    "build": "npm run cleanup && npm run build:pre-requisite && npm-run-all build:*",
+    "test:watch": "jest --watch",
+    "prettier:fix": "prettier -w ./src/**/*.ts -w ./src/**/*.tsx --no-error-on-unmatched-pattern true",
+    "lint:fix": "eslint --fix ./src/**/*.ts --fix ./src/**/*.tsx --no-error-on-unmatched-pattern true",
+    "git:rebase": "git fetch && git rebase origin/master",
+    "release": "npm run git:rebase && npm run build && standard-version && git push --follow-tags && npm publish --access=public",
+    "lint": "eslint src/*"
   },
   "files": [
     "dist/**/*"
   ],
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com:rv-npm/simple-github-gist-api.git"
+    "url": "git+ssh://git@github.com:vighnesh153/simple-github-gist-api.git"
   },
   "keywords": [
     "gist",
@@ -27,16 +38,35 @@
   "author": "Vighnesh Raut",
   "license": "GPL-3.0-or-later",
   "bugs": {
-    "url": "https://github.com/rv-npm/simple-github-gist-api/issues"
+    "url": "https://github.com/vighnesh153/simple-github-gist-api/issues"
   },
-  "homepage": "https://github.com/rv-npm/simple-github-gist-api#readme",
+  "homepage": "https://github.com/vighnesh153/simple-github-gist-api#readme",
   "devDependencies": {
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
     "@types/jest": "^27.0.2",
+    "eslint": "^8.4.1",
+    "eslint-config-airbnb": "^19.0.2",
+    "eslint-config-node": "^4.1.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.27.1",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "husky": "^7.0.4",
     "jest": "^27.3.0",
+    "lint-staged": "^12.1.2",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.2",
+    "semantic-release": "^18.0.1",
+    "standard-version": "^9.3.2",
     "ts-jest": "^27.0.7",
     "typescript": "^4.4.4"
   },
   "dependencies": {
-    "axios": "^0.23.0"
+    "axios": "^0.24.0"
   }
 }

package/dist/models/file.d.ts

@@ -1,15 +0,0 @@
-import { GithubGistApi } from '../index';
-export default class File {
-    private _rootRef;
-    private _fileName;
-    private _content;
-    private _hasUpdates;
-    get hasUpdates(): boolean;
-    get name(): string;
-    constructor(_rootRef: GithubGistApi, _fileName: string, _content: string);
-    getContent(): string;
-    overwrite(newContent: string): void;
-    save(): Promise<void>;
-    fetchLatest(): Promise<void>;
-    private _latestFetchUrl;
-}

package/dist/models/file.js

@@ -1,75 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const constants_1 = require("../constants");
-const axios_1 = require("axios");
-class File {
-    constructor(_rootRef, _fileName, _content) {
-        this._rootRef = _rootRef;
-        this._fileName = _fileName;
-        this._content = _content;
-        this._hasUpdates = true;
-    }
-    get hasUpdates() {
-        return this._hasUpdates;
-    }
-    get name() {
-        return this._fileName;
-    }
-    getContent() {
-        return this._content;
-    }
-    overwrite(newContent) {
-        this._content = newContent;
-        this._hasUpdates = true;
-    }
-    save() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const url = `${constants_1.default.githubGists}/${this._rootRef.gistId}`;
-            const body = {
-                public: this._rootRef.isPublic,
-                files: {
-                    [this._fileName]: {
-                        content: this._content
-                    }
-                }
-            };
-            try {
-                yield axios_1.default.post(url, body, this._rootRef._authConfig());
-            }
-            catch (e) {
-                throw new Error('Couldn\'t save file: ' + this._fileName);
-            }
-            this._hasUpdates = false;
-        });
-    }
-    fetchLatest() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const latestCommit = yield this._rootRef._getLatestCommit();
-            const url = this._latestFetchUrl(latestCommit);
-            try {
-                this._content = yield axios_1.default.get(url, this._rootRef._authConfig());
-            }
-            catch (e) {
-                throw new Error('Couldn\'t fetch latest data of ' + this._fileName);
-            }
-            this._hasUpdates = false;
-        });
-    }
-    _latestFetchUrl(commitId) {
-        const { allowCors, username, gistId, } = this._rootRef;
-        const corsPrefix = allowCors ? constants_1.default.corsAnywhere : '';
-        return `${corsPrefix}` +
-            `https://gist.githubusercontent.com/${username}` +
-            `/${gistId}/raw/${commitId}/${this._fileName}`;
-    }
-}
-exports.default = File;

package/dist/models/gist-auth-config.d.ts

@@ -1,5 +0,0 @@
-export default interface GistAuthConfig {
-    headers: {
-        Authorization: string;
-    };
-}

package/dist/models/gist-auth-config.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/gist.d.ts

@@ -1,13 +0,0 @@
-interface GistFile {
-    [key: string]: {
-        filename: string;
-    };
-}
-export default interface Gist {
-    id: string;
-    owner: {
-        login: string;
-    };
-    files: GistFile;
-}
-export {};

package/dist/models/gist.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util/argument-not-specified.d.ts

@@ -1,2 +0,0 @@
-declare const required: (v: string) => never;
-export default required;

package/dist/util/argument-not-specified.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const required = (v) => {
-    throw new Error(`Argument "${v}" is required!`);
-};
-exports.default = required;