feat: add initial release

Author: dkundel

Diff for: packages/serverless-runtime-types/.gitignore

@@ -59,3 +59,5 @@ typings/
 
 # next.js build output
 .next
+
+package-lock.json 

Diff for: packages/serverless-runtime-types/.npmrc

@@ -0,0 +1,2 @@
+message="release: v%s"
+package-lock=false

Diff for: packages/serverless-runtime-types/README.md

@@ -1,23 +1,21 @@
 <h1 align="center">@twilio-labs/serverless-runtime-types</h1>
-<p align="center">A module to interact with the <a href="https://www.twilio.com/functions">Twilio Serverless</a> API. For example to deploy projects. <br>Full reference documentation at <a href="https://serverless-api.twilio-labs.com">serverless-api.twilio-labs.com</a></p>
+<p align="center">TypeScript definitions to define globals for the Twilio Serverless runtime</p>
 <p align="center">
-<img alt="npm (scoped)" src="https://img.shields.io/npm/v/@twilio-labs/serverless-api.svg?style=flat-square"> <img alt="npm" src="https://img.shields.io/npm/dt/@twilio-labs/serverless-api.svg?style=flat-square"> <img alt="GitHub" src="https://img.shields.io/github/license/twilio-labs/serverless-api.svg?style=flat-square"> <a href="#contributors"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square" /></a> <a href="https://github.com/twilio-labs/.github/blob/master/CODE_OF_CONDUCT.md"><img alt="Code of Conduct" src="https://img.shields.io/badge/%F0%9F%92%96-Code%20of%20Conduct-blueviolet.svg?style=flat-square"></a> <a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome" /></a> </<a>
+<img alt="npm (scoped)" src="https://img.shields.io/npm/v/@twilio-labs/serverless-runtime-types.svg?style=flat-square"> <img alt="npm" src="https://img.shields.io/npm/dt/@twilio-labs/serverless-runtime-types.svg?style=flat-square"> <img alt="GitHub" src="https://img.shields.io/github/license/twilio-labs/serverless-runtime-types.svg?style=flat-square"> <a href="#contributors"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square" /></a> <a href="https://github.com/twilio-labs/.github/blob/master/CODE_OF_CONDUCT.md"><img alt="Code of Conduct" src="https://img.shields.io/badge/%F0%9F%92%96-Code%20of%20Conduct-blueviolet.svg?style=flat-square"></a> <a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome" /></a> </<a>
 <hr>
 
-- [⚠️ **IMPORTANT**](#%E2%9A%A0%EF%B8%8F-IMPORTANT)
 - [Installation](#Installation)
 - [Example](#Example)
-- [API](#API)
-  - [`client.activateBuild(activateConfig: ActivateConfig): Promise<ActivateResult>`](#clientactivateBuildactivateConfig-ActivateConfig-PromiseActivateResult)
-  - [`client.deployLocalProject(deployConfig: DeployLocalProjectConfig): Promise<DeployResult>`](#clientdeployLocalProjectdeployConfig-DeployLocalProjectConfig-PromiseDeployResult)
-  - [`client.deployProject(deployConfig: DeployProjectConfig): Promise<DeployResult>`](#clientdeployProjectdeployConfig-DeployProjectConfig-PromiseDeployResult)
-  - [`client.getClient(): GotClient`](#clientgetClient-GotClient)
-  - [`client.list(listConfig: ListConfig): Promise<ListResult>`](#clientlistlistConfig-ListConfig-PromiseListResult)
-  - [`api` and `fsHelpers`](#api-and-fsHelpers)
+  - [In JavaScript](#In-JavaScript)
+  - [In TypeScript](#In-TypeScript)
+    - [Option 1: Modify your `tsconfig.json`](#Option-1-Modify-your-tsconfigjson)
+    - [Option 2: Import the file](#Option-2-Import-the-file)
+- [Alternative Usage](#Alternative-Usage)
 - [Contributing](#Contributing)
   - [Code of Conduct](#Code-of-Conduct)
   - [Contributors](#Contributors)
 - [License](#License)
+- [Contributors ✨](#Contributors-%E2%9C%A8)
 
 ## Installation
 
@@ -27,32 +25,51 @@ npm install @twilio-labs/serverless-runtime-types
 
 ## Example
 
-If you want to deploy a local project you can do this using:
+### In JavaScript
+
+If you want to use the types in JavaScript to get autocomplete in VS Code and 
+other editors using the TypeScript language server:
 
 ```js
-const TwilioServerlessApiClient = require('@twilio-labs/serverless-api');
-
-const client = new TwilioServerlessApiClient({
-  accountSid: '...',
-  authToken: '...'
-});
-
-client.on('status-update', evt => {
-  console.log(evt.message);
-});
-
-const result = await client.deployLocalProject({
-  cwd: '...',
-  envPath: '...',
-  accountSid: '...',
-  authToken: '...',
-  env: {  },
-  pkgJson: {},
-  projectName: 'serverless-example',
-  functionsEnv: 'dev',
-  assetsFolderName: 'static',
-  functionsFolderName: 'src'
-});
+/// <reference path="../../node_modules/twilio-runtime-types/index.d.ts"/>
+
+exports.handler = function(context, event, callback) {
+  let twiml = new Twilio.twiml.MessagingResponse();
+  twiml.message('Hello World');
+  callback(null, twiml);
+};
+```
+
+### In TypeScript
+
+For TypeScript you can use the same technique if you want to limit the global
+types to that file. Alternatively, you can use one of the following two options
+to use the definitions.
+
+#### Option 1: Modify your `tsconfig.json`
+
+#### Option 2: Import the file
+
+```ts
+import '@twilio-labs/serverless-runtime-types';
+
+export function handler(context, event, callback) {
+  let twiml = new Twilio.twiml.MessagingResponse();
+  twiml.message('Hello World');
+  callback(null, twiml);
+}
+```
+
+## Alternative Usage
+
+You can also import the specific types without setting the global types:
+
+```ts
+import { RuntimeInstance } from '@twilio-labs/serverless-runtime-types/types';
+
+function listSyncDocuments(runtime: RuntimeInstance) {
+  return runtime.getSync().documents.list()
+}
 ```
 
 ##  Contributing
@@ -71,7 +88,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore -->
 <table>
   <tr>
-    <td align="center"><a href="https://dkundel.com"><img src="https://avatars3.githubusercontent.com/u/1505101?v=4" width="100px;" alt="Dominik Kundel"/><br /><sub><b>Dominik Kundel</b></sub></a><br /><a href="https://github.com/twilio-labs/serverless-runtime-types/commits?author=dkundel" title="Code">💻</a> <a href="https://github.com/twilio-labs/serverless-runtime-types/commits?author=dkundel" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://dkundel.com"><img src="https://avatars3.githubusercontent.com/u/1505101?v=4" width="100px;" alt="Dominik Kundel"/><br /><sub><b>Dominik Kundel</b></sub></a><br /><a href="https://github.com/twilio-labs/plugin-serverless/commits?author=dkundel" title="Code">💻</a> <a href="https://github.com/twilio-labs/plugin-serverless/commits?author=dkundel" title="Documentation">📖</a></td>
   </tr>
 </table>
 

Diff for: packages/serverless-runtime-types/index.d.ts

@@ -0,0 +1,14 @@
+import TwilioLib = require('twilio');
+import { RuntimeInstance } from './types';
+
+declare global {
+  var Twilio: typeof TwilioLib;
+  var Runtime: RuntimeInstance;
+
+  namespace NodeJS {
+    interface Global {
+      Twilio: typeof TwilioLib;
+      Runtime: RuntimeInstance;
+    }
+  }
+}

Diff for: packages/serverless-runtime-types/index.js

@@ -0,0 +1 @@
+// Intentionally left empty

Diff for: packages/serverless-runtime-types/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@twilio-labs/serverless-runtime-types",
+  "version": "1.0.0",
+  "description": "TypeScript definitions to define globals for the Twilio Serverless runtime",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/twilio-labs/twilio-runtime-types.git"
+  },
+  "keywords": [
+    "twilio",
+    "serverless",
+    "typescript",
+    "types"
+  ],
+  "author": "Dominik Kundel <[email protected]> (https://dkundel.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/twilio-labs/twilio-runtime-types/issues"
+  },
+  "homepage": "https://github.com/twilio-labs/twilio-runtime-types#readme",
+  "dependencies": {
+    "twilio": "^3.33.0"
+  },
+  "devDependencies": {
+    "all-contributors-cli": "^6.7.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "README.md",
+    "index.js",
+    "index.d.ts",
+    "types.d.ts"
+  ]
+}

Diff for: packages/serverless-runtime-types/types.d.ts

@@ -0,0 +1,13 @@
+import { ServiceContext } from 'twilio/lib/rest/sync/v1/service';
+
+export type ResourceMap = {
+  [name: string]: {
+    path: string;
+  };
+};
+
+export type RuntimeInstance = {
+  getAssets(): ResourceMap;
+  getFunctions(): ResourceMap;
+  getSync(config?: { serviceName: string }): ServiceContext;
+};