Merge branch '18-remove-const-enums' into 'main'

Resolve "Remove const enums" Closes #18 See merge request finvis/usxi!20
Bump package version.
2023-11-14 17:07:18 -05:00 · 2023-11-14 17:06:57 -05:00 · 2023-11-14 17:06:39 -05:00 · 2023-11-14 16:57:49 -05:00 · 2023-11-14 16:57:20 -05:00 · 2023-11-14 16:56:08 -05:00
20 changed files with 1598 additions and 269 deletions
--- a/.eslintrc.js
+++ b/.eslintrc.js
@ -1,136 +1,137 @@
 module.exports = {
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-      ecmaVersion: "latest", // Allows the use of modern ECMAScript features
-      sourceType: "module", // Allows for the use of imports
-      project: ["./tsconfig.json", "./tsconfig.test.json"]
-    },
-    extends: ["plugin:@typescript-eslint/recommended"], // Uses the linting rules from @typescript-eslint/eslint-plugin
-    env: {
-      node: true, // Enable Node.js global variables
-    },
-    rules: {
-      "array-callback-return": "error",
-          "no-await-in-loop": "error",
-          "no-cond-assign": [ "error", "always" ],
-          "no-constant-binary-expression": "error",
-          "no-constant-condition": "error",
-          "no-constructor-return": "error",
-          "no-duplicate-imports": "error",
-          "no-promise-executor-return": "error",
-          "no-self-compare": "error",
-          "no-undef": [ "error", { "typeof": true } ],
-          "no-unmodified-loop-condition": "error",
-          "no-unreachable-loop": "error",
-          "no-unused-private-class-members": "error",
-          "require-atomic-updates": "error",
-  
-      "accessor-pairs": "error",
-      "block-scoped-var": "error",
-      "curly": [ "error", "all" ],
-      "default-case": "error",
-      "default-case-last": "error",
-      "default-param-last": "error",
-      "dot-notation": "error",
-      "eqeqeq": "error",
-      "func-style": [ "error", "expression" ],
-      "grouped-accessor-pairs": [ "error", "getBeforeSet" ],
-      "no-caller": "error",
-      "no-console": "error",
-      "no-eq-null": "error",
-      "no-eval": "error",
-      "no-extend-native": "error",
-      "no-extra-label": "error",
-      "no-implicit-coercion": "error",
-      "no-implicit-globals": "error",
-      "no-implied-eval": "error",
-      "no-inline-comments": "error",
-      "no-invalid-this": "error",
-      "no-iterator": "error",
-      "no-label-var": "error",
-      "no-labels": "error",
-      "no-lone-blocks": "error",
-      "no-lonely-if": "error",
-      "no-loop-func": "error",
-      "no-magic-numbers": "error",
-      "no-mixed-operators": "error",
-      "no-multi-assign": "error",
-      "no-multi-str": "error",
-      "no-nested-ternary": "error",
-      "no-new": "error",
-      "no-new-func": "error",
-      "no-new-wrappers": "error",
-      "no-nonoctal-decimal-escape": "error",
-      "no-object-constructor": "error",
-      "no-octal-escape": "error",
-      "no-param-reassign": "error",
-      "no-plusplus": "error",
-      "no-proto": "error",
-      "no-return-assign": "error",
-      "no-script-url": "error",
-      "no-sequences": "error",
-      "no-shadow": "error",
-      "no-throw-literal": "error",
-      "no-undef-init": "error",
-      "no-undefined": "error",
-      "no-underscore-dangle": "error",
-      "no-unneeded-ternary": "error",
-      "no-unused-expressions": "error",
-      "no-useless-call": "error",
-      "no-useless-catch": "error",
-      "no-useless-computed-key": "error",
-      "no-useless-concat": "error",
-      "no-useless-constructor": "error",
-      "no-useless-rename": "error",
-      "no-var": "error",
-      "no-void": "error",
-      "one-var": [ "error", "never" ],
-      "one-var-declaration-per-line": [ "error", "always" ],
-      "prefer-arrow-callback": "error",
-      "prefer-const": "error",
-      "prefer-exponentiation-operator": "error",
-      "prefer-named-capture-group": "error",
-      "prefer-numeric-literals": "error",
-      "prefer-object-has-own": "error",
-      "prefer-object-spread": "error",
-      "prefer-promise-reject-errors": "error",
-      "prefer-regex-literals": "error",
-      "prefer-rest-params": "error",
-      "prefer-spread": "error",
-      "prefer-template": "error",
-      "quote-props": [ "error", "as-needed" ],
-      "radix": "error",
-      "require-await": "error",
-      "require-unicode-regexp": "error",
-      "symbol-description": "error",
-      "yoda": "error",
-  
-      "array-bracket-newline": [ "error", "consistent" ],
-          "array-bracket-spacing": [ "error", "always", { "singleValue": false } ],
-          "array-element-newline": [ "error", "consistent" ],
-          "arrow-parens": "error",
-          "arrow-spacing": "error",
-          "block-spacing": "error",
-          "computed-property-spacing": "error",
-          "eol-last": "error",
-          "generator-star-spacing": [ "error", { "before": false, "after": true } ],
-          "key-spacing": "error",
-          "linebreak-style": "error",
-          "lines-around-comment": [ "error", { "allowBlockStart": true }],
-          "max-len": [ "error", { "code": 120 } ],
-          "new-parens": "error",
-          "no-multi-spaces": "error",
-          "no-multiple-empty-lines": "error",
-          "no-trailing-spaces": "error",
-          "no-whitespace-before-property": "error",
-          "nonblock-statement-body-position": [ "error", "below" ],
-          "object-curly-newline": [ "error", { "ObjectExpression": { "consistent": true }, "ObjectPattern": { "consistent": true } } ],
-          "operator-linebreak": "error",
-          "padded-blocks": [ "error", "never" ],
-          "space-in-parens": "error",
-          "switch-colon-spacing": [ "error", { "after": false, "before": false } ],
-          "template-curly-spacing": "error",
-          "wrap-iife": "error",
-          "yield-star-spacing": [ "error", "after" ],
-    }
-  };
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: "latest", // Allows the use of modern ECMAScript features
+    sourceType: "module", // Allows for the use of imports
+    project: ["./tsconfig.json", "./tsconfig.test.json"]
+  },
+  extends: ["plugin:@typescript-eslint/recommended"], // Uses the linting rules from @typescript-eslint/eslint-plugin
+  env: {
+    node: true, // Enable Node.js global variables
+  },
+  rules: {
+    "array-callback-return": "error",
+    "no-await-in-loop": "error",
+    "no-cond-assign": ["error", "always"],
+    "no-constant-binary-expression": "error",
+    "no-constant-condition": "error",
+    "no-constructor-return": "error",
+    "no-duplicate-imports": "error",
+    "no-promise-executor-return": "error",
+    "no-self-compare": "error",
+    "no-undef": ["error", { "typeof": true }],
+    "no-unmodified-loop-condition": "error",
+    "no-unreachable-loop": "error",
+    "no-unused-private-class-members": "error",
+    "require-atomic-updates": "error",
+
+    "accessor-pairs": "error",
+    "block-scoped-var": "error",
+    "curly": ["error", "all"],
+    "default-case": "error",
+    "default-case-last": "error",
+    "default-param-last": "error",
+    "dot-notation": "error",
+    "eqeqeq": "error",
+    "func-style": ["error", "expression"],
+    "grouped-accessor-pairs": ["error", "getBeforeSet"],
+    "no-caller": "error",
+    "no-console": "error",
+    "no-eq-null": "error",
+    "no-eval": "error",
+    "no-extend-native": "error",
+    "no-extra-label": "error",
+    "no-implicit-coercion": "error",
+    "no-implicit-globals": "error",
+    "no-implied-eval": "error",
+    "no-inline-comments": "error",
+    "no-invalid-this": "error",
+    "no-iterator": "error",
+    "no-label-var": "error",
+    "no-labels": "error",
+    "no-lone-blocks": "error",
+    "no-lonely-if": "error",
+    "no-loop-func": "error",
+    "no-magic-numbers": "error",
+    "no-mixed-operators": "error",
+    "no-multi-assign": "error",
+    "no-multi-str": "error",
+    "no-nested-ternary": "error",
+    "no-new": "error",
+    "no-new-func": "error",
+    "no-new-wrappers": "error",
+    "no-nonoctal-decimal-escape": "error",
+    "no-object-constructor": "error",
+    "no-octal-escape": "error",
+    "no-param-reassign": "error",
+    "no-plusplus": "error",
+    "no-proto": "error",
+    "no-return-assign": "error",
+    "no-script-url": "error",
+    "no-sequences": "error",
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": ["error"],
+    "no-throw-literal": "error",
+    "no-undef-init": "error",
+    "no-underscore-dangle": "error",
+    "no-unneeded-ternary": "error",
+    "no-unused-expressions": "error",
+    "no-useless-call": "error",
+    "no-useless-catch": "error",
+    "no-useless-computed-key": "error",
+    "no-useless-concat": "error",
+    "no-useless-constructor": "error",
+    "no-useless-rename": "error",
+    "no-var": "error",
+    "no-void": "error",
+    "one-var": ["error", "never"],
+    "one-var-declaration-per-line": ["error", "always"],
+    "prefer-arrow-callback": "error",
+    "prefer-const": "error",
+    "prefer-exponentiation-operator": "error",
+    "prefer-named-capture-group": "error",
+    "prefer-numeric-literals": "error",
+    "prefer-object-has-own": "error",
+    "prefer-object-spread": "error",
+    "prefer-promise-reject-errors": "error",
+    "prefer-regex-literals": "error",
+    "prefer-rest-params": "error",
+    "prefer-spread": "error",
+    "prefer-template": "error",
+    "quote-props": ["error", "as-needed"],
+    "semi": ["error", "always"],
+    "radix": "error",
+    "require-await": "error",
+    "require-unicode-regexp": "error",
+    "symbol-description": "error",
+    "yoda": "error",
+
+    "array-bracket-newline": ["error", "consistent"],
+    "array-bracket-spacing": ["error", "always", { "singleValue": false }],
+    "array-element-newline": ["error", "consistent"],
+    "arrow-parens": "error",
+    "arrow-spacing": "error",
+    "block-spacing": "error",
+    "computed-property-spacing": "error",
+    "eol-last": "error",
+    "generator-star-spacing": ["error", { "before": false, "after": true }],
+    "key-spacing": "error",
+    "linebreak-style": "error",
+    "lines-around-comment": ["error", { "allowBlockStart": true }],
+    "max-len": ["error", { "code": 120 }],
+    "new-parens": "error",
+    "no-multi-spaces": "error",
+    "no-multiple-empty-lines": "error",
+    "no-trailing-spaces": "error",
+    "no-whitespace-before-property": "error",
+    "nonblock-statement-body-position": ["error", "below"],
+    "object-curly-newline": ["error", { "ObjectExpression": { "consistent": true }, "ObjectPattern": { "consistent": true } }],
+    "operator-linebreak": "error",
+    "padded-blocks": ["error", "never"],
+    "space-in-parens": "error",
+    "switch-colon-spacing": ["error", { "after": false, "before": false }],
+    "template-curly-spacing": "error",
+    "wrap-iife": "error",
+    "yield-star-spacing": ["error", "after"],
+  }
+};
--- a/.gitignore
+++ b/.gitignore
@ -1,3 +1,4 @@
 node_modules/**
 dist/**
-docs/**
+docs/**
+.env
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@ -0,0 +1,59 @@
+# This file is a template, and might need editing before it works on your project.
+# To contribute improvements to CI/CD templates, please follow the Development guide at:
+# https://docs.gitlab.com/ee/development/cicd/templates.html
+# This specific template is located at:
+# https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/npm.gitlab-ci.yml
+
+publish:
+  image: node:latest
+  stage: deploy
+  rules:
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_REF_NAME =~ /^v\d+\.\d+\.\d+.*$/
+      changes:
+        - package.json
+  script:
+    # If no .npmrc is included in the repo, generate a temporary one that is configured to publish to GitLab's NPM registry
+    - |
+      if [[ ! -f .npmrc ]]; then
+        echo 'No .npmrc found! Creating one now. Please review the following link for more information: https://docs.gitlab.com/ee/user/packages/npm_registry/index.html#project-level-npm-endpoint-1'
+        {
+          echo "@${CI_PROJECT_ROOT_NAMESPACE}:registry=${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/"
+          echo "${CI_API_V4_URL#http*:}/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=\${CI_JOB_TOKEN}"
+        } >> .npmrc
+      fi
+    - echo "Created the following .npmrc:"; cat .npmrc
+
+    # Extract a few values from package.json
+    - NPM_PACKAGE_NAME=$(node -p "require('./package.json').name")
+    - NPM_PACKAGE_VERSION=$(node -p "require('./package.json').version")
+
+    # Validate that the package name is properly scoped to the project's root namespace.
+    # For more information, see https://docs.gitlab.com/ee/user/packages/npm_registry/#package-naming-convention
+    - |
+      if [[ ! $NPM_PACKAGE_NAME =~ ^@$CI_PROJECT_ROOT_NAMESPACE/ ]]; then
+        echo "Invalid package scope! Packages must be scoped in the root namespace of the project, e.g. \"@${CI_PROJECT_ROOT_NAMESPACE}/${CI_PROJECT_NAME}\""
+        echo 'For more information, see https://docs.gitlab.com/ee/user/packages/npm_registry/#package-naming-convention'
+        exit 1
+      fi
+
+    # Install dependencies
+    - npm ci
+
+    # Compile TypeScript to JavaScript in dist/
+    - npm run build
+
+    # Compare the version in package.json to all published versions.
+    # If the package.json version has not yet been published, run `npm publish`.
+    # If $SIGSTORE_ID_TOKEN is set this template will generate a provenance
+    # document. For more information refer to the documentation: https://docs.gitlab.com/ee/ci/yaml/signing_examples/
+    - |
+      if [[ "$(npm view ${NPM_PACKAGE_NAME} versions)" != *"'${NPM_PACKAGE_VERSION}'"* ]]; then
+        if [[ -n "${SIGSTORE_ID_TOKEN}" ]]; then
+          npm publish --provenance
+        else
+          npm publish
+        fi
+        echo "Successfully published version ${NPM_PACKAGE_VERSION} of ${NPM_PACKAGE_NAME} to GitLab's NPM registry: ${CI_PROJECT_URL}/-/packages"
+      else
+        echo "Version ${NPM_PACKAGE_VERSION} of ${NPM_PACKAGE_NAME} has already been published, so no new version has been published."
+      fi
--- a/.npmignore
+++ b/.npmignore
@ -0,0 +1,3 @@
+node_modules/**
+docs/**
+.env
--- a/LICENSE.txt
+++ b/LICENSE.txt
@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
--- a/jest.config.ts
+++ b/jest.config.ts
@ -8,6 +8,7 @@ const config: Config.InitialOptions =
    },

    collectCoverageFrom: ['src/*.ts'],
+    verbose: false,
 }

 export default config
--- a/package-lock.json
+++ b/package-lock.json
@ -9,6 +9,8 @@
      "version": "1.0.0",
      "license": "GPL-3.0-or-later",
      "dependencies": {
+        "@alpacahq/alpaca-trade-api": "^3.0.1",
+        "dotenv": "^16.3.1",
        "winston": "^3.10.0"
      },
      "devDependencies": {
@ -34,6 +36,35 @@
        "node": ">=0.10.0"
      }
    },
+    "node_modules/@alpacahq/alpaca-trade-api": {
+      "version": "3.0.1",
+      "resolved": "https://registry.npmjs.org/@alpacahq/alpaca-trade-api/-/alpaca-trade-api-3.0.1.tgz",
+      "integrity": "sha512-FOsgA4jREAArWbb7nuKTo2yiUdb8+/4vboyTX2SRJSi+oYBaFrZV+hMNx7fGWtuLuKGRKEdK8Nc+8MFjwcbz4g==",
+      "dependencies": {
+        "axios": "^0.21.1",
+        "dotenv": "^6.2.0",
+        "events": "^3.2.0",
+        "just-extend": "^4.1.0",
+        "lodash": "^4.17.19",
+        "minimist": "^1.2.6",
+        "msgpack5": "^5.3.2",
+        "nats": "^1.4.9",
+        "urljoin": "^0.1.5",
+        "ws": "^7.4.3"
+      },
+      "engines": {
+        "node": ">=14.x",
+        "npm": ">=6"
+      }
+    },
+    "node_modules/@alpacahq/alpaca-trade-api/node_modules/dotenv": {
+      "version": "6.2.0",
+      "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-6.2.0.tgz",
+      "integrity": "sha512-HygQCKUBSFl8wKQZBSemMywRWcEDNidvNbjGVyZu3nbZ8qq9ubiPoGLMdRDpfSrpkkm9BXYFkpKxxFX38o/76w==",
+      "engines": {
+        "node": ">=6"
+      }
+    },
    "node_modules/@ampproject/remapping": {
      "version": "2.2.1",
      "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.2.1.tgz",
@ -662,9 +693,9 @@
      }
    },
    "node_modules/@babel/traverse": {
-      "version": "7.23.0",
-      "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.23.0.tgz",
-      "integrity": "sha512-t/QaEvyIoIkwzpiZ7aoSKK8kObQYeF7T2v+dazAYCb8SXtp58zEVkWW7zAnju8FNKNdr4ScAOEDmMItbyOmEYw==",
+      "version": "7.23.2",
+      "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.23.2.tgz",
+      "integrity": "sha512-azpe59SQ48qG6nu2CzcMLbxUudtN+dOM9kDbUqGq3HXUJRlo7i8fvPoxQUzYgLZ4cMVmuZgm8vvBpNeRhd6XSw==",
      "dev": true,
      "dependencies": {
        "@babel/code-frame": "^7.22.13",
@ -1822,6 +1853,14 @@
      "resolved": "https://registry.npmjs.org/async/-/async-3.2.4.tgz",
      "integrity": "sha512-iAB+JbDEGXhyIUavoDl9WP/Jj106Kz9DEn1DPgYw5ruDn0e3Wgi3sKFm55sASdGBNOQB8F59d9qQ7deqrHA8wQ=="
    },
+    "node_modules/axios": {
+      "version": "0.21.4",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-0.21.4.tgz",
+      "integrity": "sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg==",
+      "dependencies": {
+        "follow-redirects": "^1.14.0"
+      }
+    },
    "node_modules/babel-jest": {
      "version": "29.7.0",
      "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-29.7.0.tgz",
@ -1944,6 +1983,35 @@
      "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
      "dev": true
    },
+    "node_modules/base64-js": {
+      "version": "1.5.1",
+      "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
+      "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/feross"
+        },
+        {
+          "type": "patreon",
+          "url": "https://www.patreon.com/feross"
+        },
+        {
+          "type": "consulting",
+          "url": "https://feross.org/support"
+        }
+      ]
+    },
+    "node_modules/bl": {
+      "version": "4.1.0",
+      "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz",
+      "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==",
+      "dependencies": {
+        "buffer": "^5.5.0",
+        "inherits": "^2.0.4",
+        "readable-stream": "^3.4.0"
+      }
+    },
    "node_modules/brace-expansion": {
      "version": "1.1.11",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
@ -2019,6 +2087,29 @@
        "node-int64": "^0.4.0"
      }
    },
+    "node_modules/buffer": {
+      "version": "5.7.1",
+      "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz",
+      "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/feross"
+        },
+        {
+          "type": "patreon",
+          "url": "https://www.patreon.com/feross"
+        },
+        {
+          "type": "consulting",
+          "url": "https://feross.org/support"
+        }
+      ],
+      "dependencies": {
+        "base64-js": "^1.3.1",
+        "ieee754": "^1.1.13"
+      }
+    },
    "node_modules/buffer-from": {
      "version": "1.1.2",
      "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz",
@ -2346,6 +2437,17 @@
        "node": ">=6.0.0"
      }
    },
+    "node_modules/dotenv": {
+      "version": "16.3.1",
+      "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.3.1.tgz",
+      "integrity": "sha512-IPzF4w4/Rd94bA9imS68tZBaYyBWSCE47V1RGuMrB94iyTOIEwRmVL2x/4An+6mETpLrKJ5hQkB8W4kFAadeIQ==",
+      "engines": {
+        "node": ">=12"
+      },
+      "funding": {
+        "url": "https://github.com/motdotla/dotenv?sponsor=1"
+      }
+    },
    "node_modules/electron-to-chromium": {
      "version": "1.4.544",
      "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.544.tgz",
@ -2565,6 +2667,14 @@
        "node": ">=0.10.0"
      }
    },
+    "node_modules/events": {
+      "version": "3.3.0",
+      "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz",
+      "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==",
+      "engines": {
+        "node": ">=0.8.x"
+      }
+    },
    "node_modules/execa": {
      "version": "5.1.1",
      "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz",
@ -2613,6 +2723,11 @@
        "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
      }
    },
+    "node_modules/extend": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/extend/-/extend-2.0.2.tgz",
+      "integrity": "sha512-AgFD4VU+lVLP6vjnlNfF7OeInLTyeyckCNPEsuxz1vi786UuK/nk6ynPuhn/h+Ju9++TQyr5EpLRI14fc1QtTQ=="
+    },
    "node_modules/fast-deep-equal": {
      "version": "3.1.3",
      "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz",
@ -2747,6 +2862,25 @@
      "resolved": "https://registry.npmjs.org/fn.name/-/fn.name-1.1.0.tgz",
      "integrity": "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw=="
    },
+    "node_modules/follow-redirects": {
+      "version": "1.15.3",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.3.tgz",
+      "integrity": "sha512-1VzOtuEM8pC9SFU1E+8KfTjZyMztRsgEfwQl44z8A25uy13jSzTj6dyK2Df52iV0vgHCfBwLhDWevLn95w5v6Q==",
+      "funding": [
+        {
+          "type": "individual",
+          "url": "https://github.com/sponsors/RubenVerborgh"
+        }
+      ],
+      "engines": {
+        "node": ">=4.0"
+      },
+      "peerDependenciesMeta": {
+        "debug": {
+          "optional": true
+        }
+      }
+    },
    "node_modules/fs.realpath": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
@ -2918,6 +3052,25 @@
        "node": ">=10.17.0"
      }
    },
+    "node_modules/ieee754": {
+      "version": "1.2.1",
+      "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz",
+      "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/feross"
+        },
+        {
+          "type": "patreon",
+          "url": "https://www.patreon.com/feross"
+        },
+        {
+          "type": "consulting",
+          "url": "https://feross.org/support"
+        }
+      ]
+    },
    "node_modules/ignore": {
      "version": "5.2.4",
      "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz",
@ -3770,6 +3923,11 @@
      "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==",
      "dev": true
    },
+    "node_modules/just-extend": {
+      "version": "4.2.1",
+      "resolved": "https://registry.npmjs.org/just-extend/-/just-extend-4.2.1.tgz",
+      "integrity": "sha512-g3UB796vUFIY90VIv/WX3L2c8CS2MdWUww3CNrYmqza1Fg0DURc2K/O4YrnklBdQarSJ/y8JnJYDGc+1iumQjg=="
+    },
    "node_modules/keyv": {
      "version": "4.5.3",
      "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.3.tgz",
@ -3836,6 +3994,11 @@
        "url": "https://github.com/sponsors/sindresorhus"
      }
    },
+    "node_modules/lodash": {
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+      "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+    },
    "node_modules/lodash.memoize": {
      "version": "4.1.2",
      "resolved": "https://registry.npmjs.org/lodash.memoize/-/lodash.memoize-4.1.2.tgz",
@ -3970,11 +4133,48 @@
        "node": "*"
      }
    },
+    "node_modules/minimist": {
+      "version": "1.2.8",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+      "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+      "funding": {
+        "url": "https://github.com/sponsors/ljharb"
+      }
+    },
    "node_modules/ms": {
      "version": "2.1.2",
      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
      "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
    },
+    "node_modules/msgpack5": {
+      "version": "5.3.2",
+      "resolved": "https://registry.npmjs.org/msgpack5/-/msgpack5-5.3.2.tgz",
+      "integrity": "sha512-e9jz+6InQIUb2cGzZ/Mi+rQBs1KFLby+gNi+22VwQ1pnC9ieZjysKGmRMjdlf6IyjsltbgY4tGoHwHmyS7l94A==",
+      "dependencies": {
+        "bl": "^4.0.0",
+        "inherits": "^2.0.3",
+        "readable-stream": "^3.0.0",
+        "safe-buffer": "^5.1.2"
+      }
+    },
+    "node_modules/nats": {
+      "version": "1.4.12",
+      "resolved": "https://registry.npmjs.org/nats/-/nats-1.4.12.tgz",
+      "integrity": "sha512-Jf4qesEF0Ay0D4AMw3OZnKMRTQm+6oZ5q8/m4gpy5bTmiDiK6wCXbZpzEslmezGpE93LV3RojNEG6dpK/mysLQ==",
+      "dependencies": {
+        "nuid": "^1.1.4",
+        "ts-nkeys": "^1.0.16"
+      },
+      "bin": {
+        "node-pub": "examples/node-pub",
+        "node-reply": "examples/node-reply",
+        "node-req": "examples/node-req",
+        "node-sub": "examples/node-sub"
+      },
+      "engines": {
+        "node": ">= 8.0.0"
+      }
+    },
    "node_modules/natural-compare": {
      "version": "1.4.0",
      "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz",
@ -4014,6 +4214,14 @@
        "node": ">=8"
      }
    },
+    "node_modules/nuid": {
+      "version": "1.1.6",
+      "resolved": "https://registry.npmjs.org/nuid/-/nuid-1.1.6.tgz",
+      "integrity": "sha512-Eb3CPCupYscP1/S1FQcO5nxtu6l/F3k0MQ69h7f5osnsemVk5pkc8/5AyalVT+NCfra9M71U8POqF6EZa6IHvg==",
+      "engines": {
+        "node": ">= 8.16.0"
+      }
+    },
    "node_modules/once": {
      "version": "1.4.0",
      "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
@ -4864,6 +5072,14 @@
        }
      }
    },
+    "node_modules/ts-nkeys": {
+      "version": "1.0.16",
+      "resolved": "https://registry.npmjs.org/ts-nkeys/-/ts-nkeys-1.0.16.tgz",
+      "integrity": "sha512-1qrhAlavbm36wtW+7NtKOgxpzl+70NTF8xlz9mEhiA5zHMlMxjj3sEVKWm3pGZhHXE0Q3ykjrj+OSRVaYw+Dqg==",
+      "dependencies": {
+        "tweetnacl": "^1.0.3"
+      }
+    },
    "node_modules/ts-node": {
      "version": "10.9.1",
      "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz",
@ -4907,6 +5123,11 @@
        }
      }
    },
+    "node_modules/tweetnacl": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/tweetnacl/-/tweetnacl-1.0.3.tgz",
+      "integrity": "sha512-6rt+RN7aOi1nGMyC4Xa5DdYiukl2UWCbcJft7YhxReBGQD7OAM8Pbxw6YMo4r2diNEA8FEmu32YOn9rhaiE5yw=="
+    },
    "node_modules/type-check": {
      "version": "0.4.0",
      "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz",
@ -5037,6 +5258,14 @@
        "punycode": "^2.1.0"
      }
    },
+    "node_modules/urljoin": {
+      "version": "0.1.5",
+      "resolved": "https://registry.npmjs.org/urljoin/-/urljoin-0.1.5.tgz",
+      "integrity": "sha512-OSGi+PS3zxk8XfQ+7buaupOdrW9P9p+V9rjxGzJaYEYDe/B2rv3WJCupq5LNERW4w4kWxsduUUrhCxZZiQ2udw==",
+      "dependencies": {
+        "extend": "~2.0.0"
+      }
+    },
    "node_modules/util-deprecate": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
@ -5168,6 +5397,26 @@
        "node": "^12.13.0 || ^14.15.0 || >=16.0.0"
      }
    },
+    "node_modules/ws": {
+      "version": "7.5.9",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.9.tgz",
+      "integrity": "sha512-F+P9Jil7UiSKSkppIiD94dN07AwvFixvLIj1Og1Rl9GGMuNipJnV9JzjD6XuqmAeiswGvUmNLjr5cFuXwNS77Q==",
+      "engines": {
+        "node": ">=8.3.0"
+      },
+      "peerDependencies": {
+        "bufferutil": "^4.0.1",
+        "utf-8-validate": "^5.0.2"
+      },
+      "peerDependenciesMeta": {
+        "bufferutil": {
+          "optional": true
+        },
+        "utf-8-validate": {
+          "optional": true
+        }
+      }
+    },
    "node_modules/y18n": {
      "version": "5.0.8",
      "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
--- a/package.json
+++ b/package.json
@ -1,8 +1,12 @@
 {
  "name": "@finvis/usxi",
-  "version": "1.0.0",
+  "version": "1.7.0",
  "description": "",
-  "main": "index.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
  "scripts": {
    "start": "node dist/index.js",
    "build": "tsc",
@ -28,6 +32,8 @@
    "typescript": "^5.2.2"
  },
  "dependencies": {
+    "@alpacahq/alpaca-trade-api": "^3.0.1",
+    "dotenv": "^16.3.1",
    "winston": "^3.10.0"
  }
 }
--- a/src/alpaca/actions.ts
+++ b/src/alpaca/actions.ts
@ -0,0 +1,58 @@
+import Alpaca from '@alpacahq/alpaca-trade-api';
+import { ActionSide, ActionFetchOptions, ActionFetchResponse, ActionDateType } from '../interface/actions';
+
+/**
+ * The activity object returned by Alpaca.
+ * @see https://docs.alpaca.markets/reference/getaccountactivitiesbyactivitytype
+ */
+interface AlpacaActivity {
+    id: string;
+    activity_type: string;
+    transaction_time: string;
+    type: string;
+    price: string;
+    qty: string;
+    side: string;
+    symbol: string;
+    leaves_qty: string;
+    order_id: string;
+    cum_qty: string;
+    order_status: string;
+}
+
+export class AlpacaActionProvider {
+    readonly alpaca: Alpaca;
+
+    readonly fetchActions = (options: ActionFetchOptions): Promise<ActionFetchResponse> => {
+        return (this.alpaca.getAccountActivities({
+            activityTypes: "FILL",
+            until: options.dateOptions?.dateType === ActionDateType.Before ? options.dateOptions.date : undefined,
+            after: options.dateOptions?.dateType === ActionDateType.After ? options.dateOptions.date : undefined,
+            direction: "desc",
+            date: options.dateOptions?.dateType === ActionDateType.On ? options.dateOptions.date : undefined,
+            pageSize: options.pageSize,
+            pageToken: undefined,
+        }) as Promise<AlpacaActivity[]>).then((activities) => {
+            return {
+                actions: activities
+                .filter((activity) => activity.order_status === "filled")
+                .map((activity) => {
+                    return {
+                        symbol: activity.symbol,
+                        quantity: parseInt(activity.qty, 10),
+                        side: activity.side === "buy" ? ActionSide.Buy : ActionSide.Sell,
+                        pricePerShare: parseFloat(activity.price),
+                        timestamp: new Date(activity.transaction_time),
+                    };
+                }),
+                fetchNextPage: undefined
+            };
+        }).catch((err) => {
+            return err;
+        });
+    };
+
+    constructor(alpaca: Alpaca) {
+        this.alpaca = alpaca;
+    }
+}
--- a/src/alpaca/exchange.ts
+++ b/src/alpaca/exchange.ts
@ -0,0 +1,59 @@
+import Alpaca from '@alpacahq/alpaca-trade-api';
+import { AlpacaPortfolioProvider } from './portfolio';
+import { AlpacaQuoteProvider } from './quote';
+import { AlpacaActionProvider } from './actions';
+import { Exchange } from '../interface/exchange';
+import { PortfolioProvider } from '../interface/portfolio';
+import { QuoteProvider } from '../interface/quote';
+import { ActionProvider } from '../interface/actions';
+
+/**
+ * Exchange implementation for Alpaca.
+ */
+export class AlpacaExchange implements Exchange {
+    /**
+     * The Alpaca API client.
+     */
+    readonly alpaca: Alpaca;
+
+    /**
+     * The portfolio provider for the exchange.
+     */
+    readonly portfolioProvider: PortfolioProvider;
+
+    /**
+     * The quote provider for the exchange.
+     */
+    readonly quoteProvider: QuoteProvider;
+
+    /**
+     * The action provider for the exchange.
+     */
+    readonly actionProvider: ActionProvider;
+
+    /**
+     * The name of the exchange.
+     */
+    readonly name: string;
+
+    /**
+     * Creates an instance of the Alpaca exchange.
+     * @constructor
+     * @param {string} keyId - The API key ID for the Alpaca exchange.
+     * @param {string} secretKey - The secret key for the Alpaca exchange.
+     * @param {boolean} paper - Whether to use the paper trading environment or not.
+     */
+    constructor(keyId: string, secretKey: string, paper: boolean) {
+        this.alpaca = new Alpaca({
+            keyId: keyId,
+            secretKey: secretKey,
+            paper: paper
+        });
+
+        this.portfolioProvider = new AlpacaPortfolioProvider(this.alpaca);
+        this.quoteProvider = new AlpacaQuoteProvider(this.alpaca);
+        this.actionProvider = new AlpacaActionProvider(this.alpaca);
+
+        this.name = 'Alpaca';
+    }
+}
--- a/src/alpaca/portfolio.ts
+++ b/src/alpaca/portfolio.ts
@ -0,0 +1,65 @@
+import Alpaca from '@alpacahq/alpaca-trade-api';
+import { PortfolioProvider, Portfolio } from '../interface/portfolio';
+
+/**
+ * The position object returned by Alpaca.
+ * @see https://alpaca.markets/docs/api-references/trading-api/positions/#properties
+ */
+interface AlpacaPosition {
+    asset_id: string;
+    symbol: string;
+    exchange: string;
+    asset_class: string;
+    avg_entry_price: string;
+    qty: string;
+    qty_available: string;
+    side: string;
+    market_value: string;
+    cost_basis: string;
+    unrealized_pl: string;
+    unrealized_plpc: string;
+    unrealized_intraday_pl: string;
+    unrealized_intraday_plpc: string;
+    current_price: string;
+    lastday_price: string;
+    change_today: string;
+    asset_marginable: string;
+}
+
+/**
+ * Provides a portfolio using the Alpaca API client.
+ */
+export class AlpacaPortfolioProvider implements PortfolioProvider {
+    /**
+     * The Alpaca API client.
+     */
+    readonly alpaca: Alpaca;
+
+    /**
+     * Fetches the portfolio.
+     */
+    readonly fetchPortfolio = (): Promise<Portfolio> => {
+        return (this.alpaca.getPositions() as Promise<AlpacaPosition[]>).then((positions) => {
+            return {
+                positions: positions.map((position) => {
+                    return {
+                        symbol: position.symbol,
+                        quantity: parseInt(position.qty, 10),
+                        marketValue: parseFloat(position.market_value),
+                        costBasis: parseFloat(position.cost_basis),
+                        pricePerShare: parseFloat(position.avg_entry_price)
+                    };
+                })
+            };
+        });
+    };
+
+    /**
+     * Creates a new AlpacaPortfolioProvider instance.
+     * @constructor
+     * @param {Alpaca} alpaca - The Alpaca API client.
+     */
+    constructor(alpaca: Alpaca) {
+        this.alpaca = alpaca;
+    }
+}
--- a/src/alpaca/quote.ts
+++ b/src/alpaca/quote.ts
@ -0,0 +1,41 @@
+import Alpaca from '@alpacahq/alpaca-trade-api';
+import { QuoteProvider, Quote } from '../interface/quote';
+
+/**
+ * Provides quotes using the Alpaca API.
+ */
+export class AlpacaQuoteProvider implements QuoteProvider {
+    /**
+     * The Alpaca API client.
+     */
+    readonly alpaca: Alpaca;
+
+    /**
+     * Fetches a quote for the given stock symbol.
+     * @param symbol The stock symbol to fetch the quote for.
+     * @returns A Promise that resolves to a Quote object.
+     */
+    readonly fetchQuote = (symbol: string): Promise<Quote> => {
+        return this.alpaca.getLatestQuote(symbol).then((quote) => {
+            return {
+                symbol: quote.Symbol,
+                askPrice: quote.AskPrice,
+                askSize: quote.AskSize,
+                bidPrice: quote.BidPrice,
+                bidSize: quote.BidSize,
+                timestamp: new Date(Date.parse(quote.Timestamp))
+            };
+        }).catch((err) => {
+            return err;
+        });
+    };
+
+    /**
+     * Creates a new AlpacaQuoteProvider instance.
+     * @constructor
+     * @param {Alpaca} alpaca - The Alpaca API client.
+     */
+    constructor(alpaca: Alpaca) {
+        this.alpaca = alpaca;
+    }
+}
--- a/src/index.ts
+++ b/src/index.ts
@ -1,12 +1,8 @@
-import { Exchange } from "./interface/exchange";
-import { Position, Portfolio, PortfolioProvider } from "./interface/portfolio";
-import { Quote, QuoteProvider } from "./interface/quote";
+export * from './interface/exchange';
+export * from './interface/portfolio';
+export * from './interface/quote';
+export * from './interface/actions';

-export {
-    Exchange,
-    Position,
-    Portfolio,
-    PortfolioProvider,
-    Quote,
-    QuoteProvider
-}
+export * from './alpaca/exchange';
+export * from './alpaca/portfolio';
+export * from './alpaca/quote';
--- a/src/interface/actions.ts
+++ b/src/interface/actions.ts
@ -0,0 +1,110 @@
+/**
+ * Enum representing the possible sides of an action.
+ */
+export enum ActionSide {
+    Buy,
+    Sell,
+}
+
+/**
+ * Represents an action taken on a stock, such as a buy or sell order.
+ */
+export interface Action {
+
+    /**
+     * The symbol of the asset being traded.
+     */
+    readonly symbol: string;
+
+    /**
+     * The quantity of the asset being traded.
+     */
+    readonly quantity: number;
+
+    /**
+     * The side of the action, either "buy" or "sell".
+     */
+    readonly side: ActionSide;
+
+    /**
+     * The price per share of the asset.
+     */
+    readonly pricePerShare: number;
+
+    /**
+     * The timestamp of the action
+     */
+    readonly timestamp: Date;
+}
+
+/**
+ * Enum representing the type of date filter used in an action fetch.
+ * @enum {number}
+ */
+export enum ActionDateType {
+    On,
+    After,
+    Before,
+}
+
+/**
+ * Represents options for a date filter in an action fetch.
+ */
+export interface ActionDateOptions {
+
+    /**
+     * The date to filter on.
+     */
+    readonly date: Date;
+
+    /**
+     * The type of date filter to use.
+     */
+    readonly dateType: ActionDateType;
+}
+
+/**
+ * Represents the options for fetching actions.
+ */
+export interface ActionFetchOptions {
+
+    /**
+     * The number of items to fetch per page.
+     */
+    readonly pageSize?: number;
+
+    /**
+     * The date options for filtering actions.
+     */
+    readonly dateOptions?: ActionDateOptions;
+}
+
+/**
+ * Represents the response of a fetch action request.
+ */
+export interface ActionFetchResponse {
+
+    /**
+     * An array of `Action` objects.
+     */
+    readonly actions: Action[];
+
+    /**
+     * A function that fetches the next page of actions, if available.
+     * Returns a promise that resolves to an `ActionFetchResponse` object.
+     */
+    readonly fetchNextPage?: () => Promise<ActionFetchResponse>;
+}
+
+/**
+ * An interface representing an object that provides actions.
+ */
+export interface ActionProvider {
+
+    /**
+     * Fetches actions based on the provided options.
+     * @param options - The options to use when fetching actions.
+     * @returns A promise that resolves to an object containing the fetched actions.
+     */
+    readonly fetchActions: (options: ActionFetchOptions) => Promise<ActionFetchResponse>;
+}
--- a/src/interface/exchange.ts
+++ b/src/interface/exchange.ts
@ -1,5 +1,6 @@
 import { PortfolioProvider } from "./portfolio";
 import { QuoteProvider } from "./quote";
+import { ActionProvider } from "./actions";

 /**
 * Represents an exchange, which provides access to a portfolio provider and a quote provider.
@ -16,8 +17,13 @@ export interface Exchange {
     */
    readonly quoteProvider: QuoteProvider;

+    /**
+     * The action provider for the exchange.
+     */
+    readonly actionProvider: ActionProvider;
+
    /**
     * The name of the exchange.
     */
    readonly name: string;
-}
+}
--- a/src/interface/portfolio.ts
+++ b/src/interface/portfolio.ts
@ -1,89 +1,43 @@
 /**
 * Represents a financial position in a portfolio.
 */
-export class Position {
-    /**
-     * The price of the last trade made for this position.
-     */
-    readonly lastTrade: number;
+export interface Position {

    /**
-     * The date and time of the last trade made for this position.
-     */
-    readonly lastTradeTime: Date;
-
-    /**
-     * The change in the position value.
-     */
-    readonly change: number;
-
-    /**
-     * The percentage change in the position value.
-     */
-    readonly changePercent: number;
-
-    /**
-     * The earnings per share of the position.
-     */
-    readonly earningsPerShare: number;
-
-    /**
-     * The market capitalization of the position.
-     */
-    readonly marketCap: number;
-
-    /**
-     * The symbol of the position.
+     * The symbol name of the asset
     */
    readonly symbol: string;

    /**
-     * Represents a position in a portfolio.
-     * @constructor
-     * @param {number} lastTrade - The price of the last trade made for this position.
-     * @param {Date} lastTradeTime - The date and time of the last trade made for this position.
-     * @param {number} change - The change in the position value.
-     * @param {number} changePercent - The percentage change in the position value.
-     * @param {number} earningsPerShare - The earnings per share of the position.
-     * @param {number} marketCap - The market capitalization of the position.
-     * @param {string} symbol - The symbol of the position.
+     * The total number of shares, not including open orders
     */
-    constructor(
-        lastTrade: number,
-        lastTradeTime: Date,
-        change: number,
-        changePercent: number,
-        earningsPerShare: number,
-        marketCap: number,
-        symbol: string
-    ) {
-        this.lastTrade = lastTrade;
-        this.lastTradeTime = lastTradeTime;
-        this.change = change;
-        this.changePercent = changePercent;
-        this.earningsPerShare = earningsPerShare;
-        this.marketCap = marketCap;
-        this.symbol = symbol;
-    }
+    readonly quantity: number;
+
+    /**
+     * The total dollar amount of the position
+     */
+    readonly marketValue: number;
+
+    /**
+     * The total cost basis
+     */
+    readonly costBasis: number;
+
+    /**
+     * The current asset price per share
+     */
+    readonly pricePerShare: number;
 }

 /**
 * Represents a portfolio of financial positions.
 */
-export class Portfolio {
+export interface Portfolio {
+
    /**
     * An array of positions held in the portfolio.
     */
    readonly positions: Position[];
-
-    /**
-     * Creates a new Portfolio instance.
-     * @constructor
-     * @param {Position[]} positions - An array of Position objects representing the positions in the portfolio.
-     */
-    constructor(positions: Position[]) {
-        this.positions = positions;
-    }
 }

 /**
--- a/src/interface/quote.ts
+++ b/src/interface/quote.ts
@ -1,54 +1,37 @@
 /**
 * Represents a stock quote.
 */
-export class Quote {
-    /**
-     * The name of the company associated with this quote.
-     */
-    readonly companyName: string;
+export interface Quote {

    /**
-     * The earnings per share of a company.
-     */
-    readonly earningsPerShare: number;
-
-    /**
-     * The estimated earnings for a stock.
-     */
-    readonly estimatedEarnings: number;
-
-    /**
-     * The price of the last trade for the security.
-     */
-    readonly lastTrade: number;
-
-    /**
-     * The symbol of the financial instrument being quoted.
+     * The symbol of the asset
     */
    readonly symbol: string;

    /**
-     * Represents a quote for a particular stock.
-     * @constructor
-     * @param {string} companyName - The name of the company associated with the stock.
-     * @param {number} earningsPerShare - The earnings per share for the stock.
-     * @param {number} estimatedEarnings - The estimated earnings for the stock.
-     * @param {number} lastTrade - The last trade price for the stock.
-     * @param {string} symbol - The symbol for the stock.
+     * The ask price of the asset
     */
-    constructor(
-        companyName: string,
-        earningsPerShare: number,
-        estimatedEarnings: number,
-        lastTrade: number,
-        symbol: string
-    ) {
-        this.companyName = companyName;
-        this.earningsPerShare = earningsPerShare;
-        this.estimatedEarnings = estimatedEarnings;
-        this.lastTrade = lastTrade;
-        this.symbol = symbol;
-    }
+    readonly askPrice: number;
+
+    /**
+     * The ask size of the asset
+     */
+    readonly askSize: number;
+
+    /**
+     * The bid price of the asset
+     */
+    readonly bidPrice: number;
+
+    /**
+     * The bid size of the asset
+     */
+    readonly bidSize: number;
+
+    /**
+     * The timestamp of the quote
+     */
+    readonly timeStamp: Date;
 }

 /**
--- a/test/alpaca.test.ts
+++ b/test/alpaca.test.ts
@ -0,0 +1,69 @@
+import { describe, expect, test } from '@jest/globals';
+import 'dotenv/config';
+import { ActionDateType, AlpacaExchange } from '../src/index';
+import { createLogger, transports, format } from "winston";
+
+const timeout = 10000;
+
+const logger = createLogger({
+  transports: [new transports.Console()],
+  format: format.combine(
+    format.colorize(),
+    format.timestamp(),
+    format.printf(({ timestamp, level, message, service }) => {
+      return `[${timestamp}] ${service} ${level}: ${message}`;
+    })
+  ),
+  defaultMeta: {
+    service: "AlpacaTest",
+  },
+});
+
+describe('Alpaca Tests', () => {
+  test('portfolio fetch', async () => {
+    expect(process.env.ALPACA_API_KEY).toBeDefined();
+    expect(process.env.ALPACA_SECRET_KEY).toBeDefined();
+    const exchange = new AlpacaExchange(process.env.ALPACA_API_KEY!, process.env.ALPACA_SECRET_KEY!, true);
+    await expect(exchange.portfolioProvider.fetchPortfolio()).resolves.toBeDefined();
+  }, timeout);
+
+  test('quote fetch', async () => {
+    expect(process.env.ALPACA_API_KEY).toBeDefined();
+    expect(process.env.ALPACA_SECRET_KEY).toBeDefined();
+    const exchange = new AlpacaExchange(process.env.ALPACA_API_KEY!, process.env.ALPACA_SECRET_KEY!, true);
+    await expect(exchange.quoteProvider.fetchQuote("AAPL")).resolves.toBeDefined();
+  }, timeout);
+
+  test('action fetch', async () => {
+    expect(process.env.ALPACA_API_KEY).toBeDefined();
+    expect(process.env.ALPACA_SECRET_KEY).toBeDefined();
+    const exchange = new AlpacaExchange(process.env.ALPACA_API_KEY!, process.env.ALPACA_SECRET_KEY!, true);
+
+    const date = new Date("2023-10-23T13:30:28.163Z");
+
+    const response = await exchange.actionProvider.fetchActions({
+      pageSize: undefined,
+      dateOptions: {
+        date: date,
+        dateType: ActionDateType.On
+      }
+    });
+
+    expect(response).toBeDefined();
+
+    logger.info(JSON.stringify(response));
+
+    for (const action of response.actions) {
+      expect(action).toBeDefined();
+      expect(action.symbol).toBeDefined();
+      expect(action.quantity).toBeDefined();
+      expect(action.side).toBeDefined();
+      expect(action.pricePerShare).toBeDefined();
+
+      expect(action.timestamp).toBeDefined();
+      expect(action.timestamp.getFullYear()).toBe(date.getFullYear());
+      expect(action.timestamp.getMonth()).toBe(date.getMonth());
+      expect(action.timestamp.getDate()).toBe(date.getDate());
+    }
+  }, timeout);
+});
--- a/test/basic.test.ts
+++ b/test/basic.test.ts
@ -1,7 +0,0 @@
-import {describe, expect, test} from '@jest/globals';
-
-describe('sum module', () => {
-  test('adds 1 + 2 to equal 3', () => {
-    expect(1 + 2).toBe(3);
-  });
-});
--- a/tsconfig.json
+++ b/tsconfig.json
@ -1,7 +1,8 @@
 {
    "extends": "@tsconfig/node-lts/tsconfig.json",
    "compilerOptions": {
-        "outDir": "dist"
+        "outDir": "dist",
+        "declaration": true,
    },
    "include": ["src"],
    "exclude": ["node_modules"]
Author	SHA1	Message	Date
Carter Bertolini	902bb611f2	Merge branch '18-remove-const-enums' into 'main' Resolve "Remove const enums" Closes #18 See merge request finvis/usxi!20	2023-11-14 17:07:18 -05:00
Carter Bertolini	4ded18b7c9	Bump package version.	2023-11-14 17:06:57 -05:00
Carter Bertolini	9e99c8d17c	Remove const from action side and date type.	2023-11-14 17:06:39 -05:00
Carter Bertolini	9b725cbdcf	Merge branch 'fix-bad-npm-ci' into 'main' Fix bad npm install command See merge request finvis/usxi!19	2023-11-14 16:57:49 -05:00
Ethan Girouard	11b21aafd2	Bump package version to 1.6.0	2023-11-14 16:57:20 -05:00
Ethan Girouard	04f771cb5e	Fix bad npm install command	2023-11-14 16:56:08 -05:00
Carter Bertolini	29bc120291	Merge branch 'fix-pipeline-no-tsc' into 'main' Add dep install command to deployment job See merge request finvis/usxi!18	2023-11-14 16:54:13 -05:00
Ethan Girouard	37c1b209d7	Bump package version to 1.5.0	2023-11-14 16:53:37 -05:00
Ethan Girouard	93383fc650	Add dep install command to deployment job	2023-11-14 16:52:40 -05:00
Carter Bertolini	70ec54c4c6	Merge branch 'fix-no-dist-files-in-package' into 'main' Add build command to deployment job See merge request finvis/usxi!17	2023-11-14 16:49:40 -05:00
Ethan Girouard	cf3a0a1834	Bump package version to 1.4.0	2023-11-14 16:49:12 -05:00
Ethan Girouard	543d277c09	Add build command to deployment job	2023-11-14 16:47:13 -05:00
Carter Bertolini	1a127ed925	Merge branch '17-fix-missing-dist-in-npm-package' into 'main' Resolve "Fix missing dist in npm package." Closes #17 See merge request finvis/usxi!16	2023-11-14 16:35:06 -05:00
Carter Bertolini	4080b9ea12	Add dist to npm files and bump version.	2023-11-14 16:34:45 -05:00
Carter Bertolini	237e8919b0	Merge branch '16-setup-npm-package-stuff' into 'main' Resolve "Setup NPM package stuff" Closes #16 See merge request finvis/usxi!15	2023-11-14 16:24:29 -05:00
Carter Bertolini	e4479af77f	Exclude dist from npmignore	2023-11-14 16:24:09 -05:00
Carter Bertolini	9eac5d95a2	Bump package version.	2023-11-14 16:22:09 -05:00
Carter Bertolini	a8c4bcc333	Add declaration files and point npm to dist.	2023-11-14 16:21:42 -05:00
Carter Bertolini	5450f48820	Merge branch '15-use-interfaces-instead-of-classes-where-possible' into 'main' Resolve "Use interfaces instead of classes where possible" Closes #15 See merge request finvis/usxi!14	2023-11-10 17:24:05 -05:00
Carter Bertolini	077deb508b	Bump package version	2023-11-10 17:23:50 -05:00
Carter Bertolini	986a0ab569	Make quote and portfolio interfaces.	2023-11-10 17:23:30 -05:00
Carter Bertolini	97d808bca2	Replace class with interface in portfolio.	2023-11-10 16:51:14 -05:00
Carter Bertolini	65d6756582	Replace classes with interfaces in action.	2023-11-10 16:45:49 -05:00
Carter Bertolini	985a155dbe	Merge branch '14-implement-action-fetching-for-alpaca' into 'main' Resolve "Implement action fetching for Alpaca" Closes #14 See merge request finvis/usxi!13	2023-11-10 16:36:43 -05:00
Carter Bertolini	ef1ee52a38	Use an interface for AlpacaActivity and add date checks to tests.	2023-11-10 16:32:44 -05:00
Carter Bertolini	960285e503	Update alpaca actions test to test date.	2023-11-03 21:19:31 -04:00
Carter Bertolini	34bcafb07f	Add constructor for ActionFetchOptions.	2023-11-03 16:48:57 -04:00
Carter Bertolini	27b49dc6dc	Add timestamp to actions.	2023-11-03 16:23:33 -04:00
Carter Bertolini	5b66bcd2c0	Add support for Alpaca action fetch options.	2023-11-03 16:19:58 -04:00
Carter Bertolini	158c92c4a5	Remove no-undefined linter setting.	2023-10-31 17:12:24 -04:00
Carter Bertolini	91134a42d5	Fix timeout issues in Alpaca tests.	2023-10-31 16:58:06 -04:00
Carter Bertolini	54a3341968	Filter action fetch response to eliminate partial order fills.	2023-10-27 17:44:57 -04:00
Carter Bertolini	327ab308bf	Setup basic Alpaca action fetch and test.	2023-10-27 17:41:57 -04:00
Carter Bertolini	8437515904	Make ActionFetchResponse a class with a constructor.	2023-10-27 17:31:44 -04:00
Carter Bertolini	5f1cd195af	Begin implementing action fetching for Alpaca	2023-10-27 17:29:42 -04:00
Carter Bertolini	ab23fb7145	Fix Alpaca tests and exports	2023-10-27 16:48:15 -04:00
Carter Bertolini	38be49e9cb	Merge branch '13-add-support-for-account-action-history' into 'main' Resolve "Add support for account action history" Closes #13 See merge request finvis/usxi!12	2023-10-27 16:43:33 -04:00
Carter Bertolini	5f6acd99fb	Redo interface exports.	2023-10-27 16:35:34 -04:00
Carter Bertolini	52b100667d	Add action stuff to module exports.	2023-10-27 16:31:21 -04:00
Carter Bertolini	dcdb2bad1a	Make enums action option enums const and fix linter issues.	2023-10-27 16:21:52 -04:00
Carter Bertolini	c113bd4f5c	Add temporary undefined action provider to existing exchanges.	2023-10-27 16:16:51 -04:00
Carter Bertolini	39742da43e	Finish action interface documentation.	2023-10-27 16:13:53 -04:00
Carter Bertolini	dd72d4a717	Documented the action interface.	2023-10-27 16:10:11 -04:00
Carter Bertolini	20a8920a30	Added interface for fetching user actions.	2023-10-27 16:07:43 -04:00
Carter Bertolini	f25f21a050	Merge branch '12-alpaca-api-implementation' into 'main' Resolve "Alpaca API Implementation" Closes #12 See merge request finvis/usxi!10	2023-10-24 16:54:39 -04:00
Carter Bertolini	51a58fc322	Fix formatting and update linter.	2023-10-24 16:55:11 -04:00
Carter Bertolini	e8dc16ad7d	Delete basic test	2023-10-24 16:08:54 -04:00
Carter Bertolini	ad27d7280b	Added documentation for Alpaca	2023-10-20 17:28:06 -04:00
Carter Bertolini	7ceb69e9d5	Added support for env variables and added basic tests for Alpaca.	2023-10-20 16:50:55 -04:00
Carter Bertolini	6dc8ecaf26	Setup Alpaca API implementation	2023-10-20 16:32:41 -04:00
Carter Bertolini	4b0a2a284a	Add Alpaca Exchange impl	2023-10-17 17:09:29 -04:00
Carter Bertolini	efd9770ccc	Add Alpaca SDK	2023-10-17 17:06:07 -04:00
Carter Bertolini	c2f0938994	Undo previous stuff and add env to gitignore	2023-10-17 17:04:40 -04:00
Carter Bertolini	e7942270ee	Merge branch '10-setup-ci-cd-pipeline' into 'main' Add npm pipeline template Closes #10 See merge request finvis/usxi!11	2023-10-17 16:34:51 -04:00
Carter Bertolini	5d4e37be6e	Add Alpaca API sdk	2023-10-10 17:23:59 -04:00
Carter Bertolini	ce8d853f83	Merge branch '11-add-gplv3-liscense-file' into 'main' Resolve "Add GPLv3 liscense file" Closes #11 See merge request finvis/usxi!9	2023-10-10 17:00:34 -04:00
Carter Bertolini	e832b42e56	Added lisence	2023-10-10 17:02:21 -04:00
Carter Bertolini	9323c07f1e	Add npm pipeline template	2023-10-10 16:28:37 -04:00