pulling out typescript client code from the monorepo

Author: aarongoin

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 PolyAPI
+Copyright (c) 2023 PolyAPI Corporation, a Wyoming Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,78 @@
+# Poly TypeScript/JavaScript client
+
+This is the client library and CLI for users of PolyAPI to help create and manage your Poly definitions.
+
+## Usage
+
+Make sure you have set your npm registry in .npmrc file.
+
+Install the package with `npm install polyapi`.
+
+Run `npx poly generate` to set up your Poly connection (only for the first time) and generate Poly functions.
+Whenever you update your Poly functions, run `npx poly generate` again to update your local functions.
+
+You will need an API Key to to access Poly. Please head to https://polyapi.io to request an API key!
+
+### Using Poly functions
+
+After you have run `npx poly generate` you can use your Poly client in your code:
+
+```
+import poly from 'polyapi';
+
+const location = 'Eiffel Tower, Paris';
+
+poly.maps.google.getXY(location)
+  .then(res => console.log(res))
+  .catch(err => console.error(err));
+```
+
+### Using error handler
+
+Poly functions can throw errors. You can catch them with try/catch or you can register an error handler for function path:
+
+```
+import poly, {errorHandler} from 'polyapi';
+
+errorHandler.on('myContext.myFunction', (error) => {
+  // handle error
+});
+```
+
+Or you can register an error handler for all functions in context:
+
+```
+errorHandler.on('myContext', (error) => {
+  // handle error
+});
+```
+
+To remove error handler for function path:
+
+```
+errorHandler.off('myContext.myFunction');
+```
+
+### Using Webhook handlers
+
+Similar to error handlers, you can register handlers for Webhooks:
+
+```
+import poly from 'polyapi';
+
+poly.myWebhookContext.paymentReceieved(event => {
+  // handle event
+});
+```
+
+Webhook handlers have their context and function name. To remove a handler call the returned function:
+
+```
+const unregister = poly.myWebhookContext.paymentReceieved(event => {
+  // handle event
+});
+...
+unregister();
+```
+
+Happy hacking!

README_INTERNAL.md

@@ -0,0 +1,75 @@
+# README INTERNAL
+
+So you want to hack on this npm package locally?
+
+Here's how!
+
+## Verdaccio
+
+We recommend using [Verdaccio](https://verdaccio.org/)
+
+First let's install Verdaccio globally.
+
+```bash
+npm install -g verdaccio
+```
+
+Then let's start verdaccio up in a new terminal:
+
+```bash
+verdaccio
+```
+
+Now add a user:
+
+```bash
+npm adduser --registry=http://localhost:4873/
+```
+
+Enter whatever you want for username/password/email.
+
+## Make a Small Change
+
+Now let's go to your JS polyapi client folder:
+
+https://github.com/polyapi/poly-alpha/tree/develop/packages/client
+
+Let's make a tiny tweak to the `README.md`. Just so we can make sure we are installing our local changes.
+
+Add the line "HELLO WORLD" to the end of `README.md`
+
+Then run this command to publish to your local Verdaccio instance:
+
+```bash
+./publish_local.sh
+```
+
+## Install Your Updated NPM Package Locally
+
+Now let's create a polyapi project where we can test our npm changes locally.
+
+First, create a new folder, for example `$HOME/poly/jslocal`, then cd into the folder.
+
+Run the following command:
+
+```bash
+echo 'registry=http://localhost:4873' > .npmrc
+```
+
+Then run this command to make sure you have the latest version of the library from Verdaccio:
+
+```bash
+npm uninstall polyapi && npm install polyapi
+```
+
+Finally run this command:
+
+```bash
+cat node_modules/polyapi/README.md
+```
+
+You should see "HELLO WORLD" at the bottom of the README!
+
+## Conclusion
+
+That's it! Happy hacking!