@flowio/types 0.0.1

package/.apibuilder/.tracked_files

@@ -0,0 +1,8 @@
+---
+flow:
+  api:
+    ts_declarations:
+    - src/api.ts
+  api-internal:
+    ts_declarations:
+    - src/api-internal.ts

package/.apibuilder/config

@@ -0,0 +1,13 @@
+settings:
+  code.create.directories: false
+  code.cleanup.generated.files: true
+code:
+  flow:
+    api:
+      version: latest
+      generators:
+        ts_declarations: src
+    api-internal:
+      version: latest
+      generators:
+        ts_declarations: src

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Flow Commerce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# @flowio/api-types
+
+This module provides TypeScript type definitions for custom types found in Flow API.
+
+## Installation
+
+```bash
+npm install @flowio/types
+```
+
+## Usage
+
+In TypeScript:
+
+```typescript
+import { apiTypes, apiInternalTypes } from '@flowio/types';
+import React from 'react';
+
+interface Props {
+  order: apiTypes.Order;
+  prompts: apiInternalTypes.OptinPrompt[];
+}
+
+class OrderSummary extends React.Component<Props> {
+  ...
+}
+```
+
+In JSDoc:
+
+```javascript
+import React from 'react';
+
+/**
+ * @typedef {import('@flowio/types/api').Order} Order
+ * @typedef {import('@flowio/types/api-internal').OptinPrompt} OptinPrompt
+ */
+
+/**
+ * @typedef {object} Props
+ * @property {Order} order
+ * @property {OptinPrompt[]} prompts
+ */
+
+/**
+ * @augments React.Component<Props>
+ */
+class OrderSummary extends React.Component {
+  ...
+}
+```
+
+## License
+
+MIT