@gorgonjs/gorgon 1.5.1 → 1.6.1

package/.eslintrc

@@ -1,198 +0,0 @@
-{
-  "rules": {
-    "accessor-pairs": 0,
-    "block-scoped-var": 0,
-    "callback-return": 0,
-    "camelcase": 2,
-    "complexity": 0,
-    "consistent-return": 0,
-    "consistent-this": 0,
-    "constructor-super": 0,
-    "curly": [2, "all"],
-    "default-case": 2,
-    "dot-location": [2, "property"],
-    "dot-notation": 0,
-    "eol-last": 0,
-    "eqeqeq": 2,
-    "func-names": 0,
-    "func-style": 0,
-    "global-require": 0,
-    "guard-for-in": 2,
-    "handle-callback-err": 0,
-    "id-length": 0,
-    "id-match": 0,
-    "indent": 0,
-    "indent-legacy": [2, 2, { "SwitchCase": 1 }],
-    "init-declarations": 0,
-    "max-depth": 0,
-    "max-len": [
-      2,
-      160,
-      4,
-      {
-        "ignoreComments": true,
-        "ignoreUrls": true,
-        "ignorePattern": "^\\s*var\\s.+=\\s*require\\s*\\("
-      }
-    ],
-    "max-nested-callbacks": 0,
-    "max-params": 0,
-    "max-statements": 0,
-    "new-cap": [
-      2,
-      {
-        "capIsNew": false
-      }
-    ],
-    "new-parens": 0,
-    "no-alert": 0,
-    "no-array-constructor": 2,
-    "no-arrow-condition": 0,
-    "no-bitwise": 0,
-    "no-caller": 0,
-    "no-case-declarations": 0,
-    "no-catch-shadow": 0,
-    "no-class-assign": 0,
-    "no-cond-assign": 0,
-    "no-console": ["warn", { "allow": ["warn", "error", "info"] }],
-    "no-const-assign": 0,
-    "no-constant-condition": 0,
-    "no-continue": 0,
-    "no-control-regex": 0,
-    "no-debugger": 0,
-    "no-delete-var": 0,
-    "no-div-regex": 0,
-    "no-dupe-args": 0,
-    "no-dupe-class-members": 0,
-    "no-dupe-keys": 0,
-    "no-duplicate-case": 0,
-    "no-else-return": 0,
-    "no-empty": 0,
-    "no-empty-character-class": 0,
-    "no-empty-label": 0,
-    "no-empty-pattern": 0,
-    "no-eq-null": 0,
-    "no-eval": 2,
-    "no-ex-assign": 0,
-    "no-extend-native": 2,
-    "no-extra-bind": 0,
-    "no-extra-boolean-cast": 0,
-    "no-extra-parens": 2,
-    "no-fallthrough": 0,
-    "no-floating-decimal": 0,
-    "no-func-assign": 0,
-    "no-implicit-coercion": 0,
-    "no-implied-eval": 0,
-    "no-inline-comments": 0,
-    "no-inner-declarations": [2, "functions"],
-    "no-invalid-regexp": 0,
-    "no-invalid-this": 0,
-    "no-iterator": 0,
-    "no-label-var": 0,
-    "no-labels": 0,
-    "no-lone-blocks": 0,
-    "no-lonely-if": 0,
-    "no-loop-func": 2,
-    "no-magic-numbers": 0,
-    "no-mixed-requires": 0,
-    "no-multi-spaces": 0,
-    "no-multi-str": 2,
-    "no-multiple-empty-lines": 0,
-    "no-native-reassign": 0,
-    "no-negated-condition": 0,
-    "no-negated-in-lhs": 0,
-    "no-nested-ternary": 0,
-    "no-new": 0,
-    "no-new-func": 0,
-    "no-new-object": 2,
-    "no-new-require": 0,
-    "no-new-wrappers": 0,
-    "no-obj-calls": 0,
-    "no-octal": 0,
-    "no-octal-escape": 0,
-    "no-param-reassign": 0,
-    "no-path-concat": 0,
-    "no-plusplus": 0,
-    "no-process-env": 0,
-    "no-process-exit": 0,
-    "no-proto": 0,
-    "no-redeclare": 0,
-    "no-regex-spaces": 0,
-    "no-restricted-modules": 0,
-    "no-restricted-syntax": 0,
-    "no-return-assign": 0,
-    "no-script-url": 0,
-    "no-self-compare": 0,
-    "no-sequences": 0,
-    "no-shadow": 0,
-    "no-shadow-restricted-names": 0,
-    "no-sparse-arrays": 0,
-    "no-sync": 0,
-    "no-ternary": 0,
-    "no-this-before-super": 0,
-    "no-throw-literal": 0,
-    "no-undef": 2,
-    "no-undef-init": 0,
-    "no-undefined": 0,
-    "no-underscore-dangle": 0,
-    "no-unexpected-multiline": 0,
-    "no-unneeded-ternary": 0,
-    "no-unreachable": 0,
-    "no-unused-expressions": 0,
-    "no-unused-vars": 0,
-    "no-use-before-define": 0,
-    "no-useless-call": 0,
-    "no-useless-concat": 0,
-    "no-var": 0,
-    "no-void": 0,
-    "no-warning-comments": 0,
-    "no-with": 2,
-    "object-shorthand": 0,
-    "one-var": 0,
-    "operator-assignment": 0,
-    "padded-blocks": 0,
-    "prefer-arrow-callback": 0,
-    "prefer-const": 1,
-    "prefer-reflect": 0,
-    "prefer-spread": 0,
-    "prefer-template": 0,
-    "quote-props": 0,
-    "quotes": [
-      2,
-      "single",
-      {
-        "allowTemplateLiterals": true
-      }
-    ],
-    "radix": 0,
-    "require-jsdoc": 0,
-    "require-yield": 0,
-    "sort-vars": 0,
-    "strict": [2, "global"],
-    "use-isnan": 0,
-    "valid-jsdoc": 2,
-    "valid-typeof": 0,
-    "vars-on-top": 0,
-    "wrap-iife": 0,
-    "wrap-regex": 0,
-    "yoda": 0
-  },
-  "env": {
-    "es6": true,
-    "es2021": true,
-    "browser": true,
-    "commonjs": true,
-    "node": true,
-    "jest": true
-  },
-  "parserOptions": {
-    "ecmaFeatures": {
-      "modules": true
-    },
-    "requireConfigFile": false,
-    "sourceType": "module",
-    "ecmaVersion": 12
-  },
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint"]
-}

package/CHANGELOG.md

@@ -1,49 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [1.5.0] - 2023-09-11
-
-### Added
-
-- Added a hook system to the cache
-
-## [1.4.0] - 2022-11-19
-
-### Added
-
-- added a file provider at @gorgon/file-provider
-
-### Fixed
-
-- fixed a bug where when you cached something permanently (false) with the non default cache it would use the default provider
-
-## [1.3.1] - 2022-11-14
-
-### Added
-
-- added more library type support for older require syntax
-
-## [1.3.0] - 2022-11-13
-
-### Added
-
-- changed build system to get smaller packages
-
-## [1.2.1] - 2022-11-13
-
-### Fixed
-
-- debug now actually outputs some console logs
-
-## [1.2.0] - 2022-11-12
-
-### Added
-
-- initial release to the public; migrated from @mikevalstar/gorgon
-- code is based off of medusa.js

package/__tests__/basic.test.ts

@@ -1,180 +0,0 @@
-import { describe, it, expect, afterAll } from 'vitest';
-import Gorgon from '../index';
-
-describe('settings', () => {
-  afterAll(() => {
-    Gorgon.settings({ debug: false });
-  });
-
-  it('returns default settings', () => {
-    const retSettigns = Gorgon.settings();
-
-    expect(retSettigns.debug).toEqual(false);
-  });
-
-  it('can set debug mode', () => {
-    const retSettigns = Gorgon.settings({
-      debug: true,
-    });
-
-    expect(retSettigns.debug).toEqual(true);
-  });
-});
-
-describe('basic storage', () => {
-  it('gets the results of a promise', async () => {
-    const res = await Gorgon.get(
-      'sample1',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    return expect(res).toEqual('success');
-  });
-
-  it('returns old value, not new value for promise', async () => {
-    const res = await Gorgon.get(
-      'sample2',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res).toEqual('success');
-
-    const res2 = await Gorgon.get(
-      'sample2',
-      async () => {
-        return 'failure';
-      },
-      1000,
-    );
-
-    return expect(res2).toEqual('success');
-  });
-
-  it('overwtires the current cache item', async () => {
-    const res = await Gorgon.get(
-      'sample6',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res).toEqual('success');
-
-    const res2 = await Gorgon.overwrite(
-      'sample6',
-      async () => {
-        return 'success2';
-      },
-      1000,
-    );
-
-    expect(res).toEqual('success');
-    expect(res2).toEqual('success2');
-  });
-
-  it('cache expires', async () => {
-    const res = await Gorgon.get(
-      'sample3',
-      async () => {
-        return 'failure';
-      },
-      1000,
-    );
-
-    expect(res).toEqual('failure');
-
-    // await a time of 1.5 seconds
-    await new Promise((resolve) => setTimeout(resolve, 1500));
-
-    const res2 = await Gorgon.get(
-      'sample3',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res2).toEqual('success');
-  });
-
-  it('throws and does not cache', async () => {
-    try {
-      const res = await Gorgon.get(
-        'sample4',
-        async () => {
-          throw 'failure';
-        },
-        1000,
-      );
-    } catch (e) {
-      expect(e).toEqual('failure');
-    }
-
-    const res2 = await Gorgon.get(
-      'sample4',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res2).toEqual('success');
-  });
-
-  it('clears all cache items', async () => {
-    const res = await Gorgon.get(
-      'sample5',
-      async () => {
-        return 'failure';
-      },
-      1000,
-    );
-
-    await Gorgon.clear();
-
-    const res2 = await Gorgon.get(
-      'sample5',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res2).toEqual('success');
-  });
-
-  it('clears a single item that has a permenant cache', async () => {
-    const res = await Gorgon.get('sample9', async () => {
-      return 'success';
-    });
-
-    expect(res).toEqual('success');
-
-    const res2 = await Gorgon.get('sample10', async () => {
-      return 'failure';
-    });
-
-    expect(res2).toEqual('failure');
-
-    await Gorgon.clear('sample10');
-
-    const res3 = await Gorgon.get('sample9', async () => {
-      return 'failure';
-    });
-
-    expect(res3).toEqual('success');
-
-    const res4 = await Gorgon.get('sample10', async () => {
-      return 'success2';
-    });
-
-    expect(res4).toEqual('success2');
-  });
-});

package/__tests__/clearmany.test.ts

@@ -1,97 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import Gorgon from '../index';
-
-describe('Clear many from storage', () => {
-  it('clears many based on wildcard', async () => {
-    const res = await Gorgon.get(
-      'clearmany1',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res).toEqual('success');
-
-    const res2 = await Gorgon.get(
-      'clearmany2',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res2).toEqual('success');
-
-    await Gorgon.clear('clearmany*');
-
-    const res3 = await Gorgon.get(
-      'clearmany1',
-      async () => {
-        return 'success2';
-      },
-      1000,
-    );
-
-    expect(res3).toEqual('success2');
-
-    const res4 = await Gorgon.get(
-      'clearmany2',
-      async () => {
-        return 'success2';
-      },
-      1000,
-    );
-
-    expect(res4).toEqual('success2');
-  });
-
-  it('clears every item in the cache', async () => {
-    const res = await Gorgon.get(
-      'clearall1',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res).toEqual('success');
-
-    const res2 = await Gorgon.get(
-      'clearall2',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(res2).toEqual('success');
-
-    await Gorgon.clearAll();
-
-    const res3 = await Gorgon.get(
-      'clearall1',
-      async () => {
-        return 'success2';
-      },
-      1000,
-    );
-
-    expect(res3).toEqual('success2');
-
-    const res4 = await Gorgon.get(
-      'clearall2',
-      async () => {
-        return 'success2';
-      },
-      1000,
-    );
-
-    expect(res4).toEqual('success2');
-
-    Gorgon.clearAll();
-
-    const keys = await Gorgon.providers['memory'].keys();
-    expect(keys.length).toEqual(0);
-  });
-});

package/__tests__/concurrency.test.ts

@@ -1,50 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import Gorgon from '../index';
-
-Gorgon.settings({ retry: 10 });
-
-vi.useRealTimers();
-
-describe('concurrency', () => {
-  it('Only calls the function once, when the call is slow', async () => {
-    let calledCount = 0;
-
-    const incrementor = async () => {
-      return new Promise((resolve: (value: boolean) => void) => {
-        setTimeout(() => {
-          calledCount += 1;
-          resolve(true);
-        }, 200);
-      });
-    };
-
-    const res = Gorgon.get('concur1', incrementor, 50);
-    const res2 = await Gorgon.get('concur1', incrementor, 50);
-
-    return expect(calledCount).toEqual(1);
-  });
-
-  it('Only calls the function once, but rejects both', async () => {
-    let calledCount = 0;
-
-    const incrementor = async () => {
-      return new Promise((resolve, rej) => {
-        setTimeout(() => {
-          calledCount += 1;
-          rej(true);
-        }, 200);
-      });
-    };
-
-    try {
-      const res = Gorgon.get('concur2', incrementor, 50).catch((e) => {
-        // error
-      });
-      const res2 = await Gorgon.get('concur2', incrementor, 50);
-    } catch (e) {
-      // error?
-    }
-
-    return expect(calledCount).toEqual(1);
-  });
-});

package/__tests__/datePolicy.test.ts

@@ -1,20 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import Gorgon from '../index';
-
-describe('basic storage - date policy', () => {
-  it('gets the results of a promise, Date Policy', async () => {
-    var x = new Date();
-
-    x = new Date(x.getTime() + 1000 * 1000);
-
-    const res = await Gorgon.get(
-      'datepolicy1',
-      async () => {
-        return 'success';
-      },
-      x,
-    );
-
-    return expect(res).toEqual('success');
-  });
-});

package/__tests__/debug.test.ts

@@ -1,50 +0,0 @@
-import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest';
-import Gorgon from '../index';
-
-describe('basic storage - date policy', () => {
-  beforeAll(() => {
-    Gorgon.settings({ debug: true });
-  });
-
-  afterAll(() => {
-    Gorgon.settings({ debug: false });
-  });
-
-  it('gets the results of a promise, console.info happens twice', async () => {
-    const consoleSpy = vi.spyOn(console, 'info');
-
-    const res = await Gorgon.get(
-      'debug1',
-      async () => {
-        return 'success';
-      },
-      1,
-    );
-
-    expect(consoleSpy).toHaveBeenCalledTimes(2);
-    return expect(consoleSpy).toHaveBeenLastCalledWith('[Gorgon] Cache resolved, resolved item for: debug1', 'success');
-  });
-
-  it('gets the results of a promise, then places a resolver in the queue, console.info happens 4 times', async () => {
-    const consoleSpy = vi.spyOn(console, 'info');
-
-    const res = Gorgon.get(
-      'debug2',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    const res2 = await Gorgon.get(
-      'debug2',
-      async () => {
-        return 'success';
-      },
-      1000,
-    );
-
-    expect(consoleSpy).toHaveBeenCalledTimes(4);
-    return expect(consoleSpy).toHaveBeenLastCalledWith('[Gorgon] Cache queue resolved for: debug2', 'success');
-  });
-});