@seamapi/types 0.0.4

package/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2021-2023 Seam Labs, Inc.
+
+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,155 @@
+# Seam API Types
+
+[![npm](https://img.shields.io/npm/v/@seamapi/types.svg)](https://www.npmjs.com/package/@seamapi/types)
+[![GitHub Actions](https://github.com/seamapi/types/actions/workflows/check.yml/badge.svg)](https://github.com/seamapi/types/actions/workflows/check.yml)
+
+TypeScript types for the Seam API.
+
+## Description
+
+TODO
+
+## Installation
+
+Add this as a dependency to your project using [npm] with
+
+```
+$ npm install @seamapi/types
+```
+
+[npm]: https://www.npmjs.com/
+
+## Development and Testing
+
+### Quickstart
+
+```
+$ git clone https://github.com/seamapi/types.git
+$ cd types
+$ nvm install
+$ npm install
+$ npm run test:watch
+```
+
+Primary development tasks are defined under `scripts` in `package.json`
+and available via `npm run`.
+View them with
+
+```
+$ npm run
+```
+
+### Source code
+
+The [source code] is hosted on GitHub.
+Clone the project with
+
+```
+$ git clone git@github.com:seamapi/types.git
+```
+
+[source code]: https://github.com/seamapi/types
+
+### Requirements
+
+You will need [Node.js] with [npm] and a [Node.js debugging] client.
+
+Be sure that all commands run under the correct Node version, e.g.,
+if using [nvm], install the correct version with
+
+```
+$ nvm install
+```
+
+Set the active version for each shell session with
+
+```
+$ nvm use
+```
+
+Install the development dependencies with
+
+```
+$ npm install
+```
+
+[Node.js]: https://nodejs.org/
+[Node.js debugging]: https://nodejs.org/en/docs/guides/debugging-getting-started/
+[npm]: https://www.npmjs.com/
+[nvm]: https://github.com/creationix/nvm
+
+### Publishing
+
+#### Automatic
+
+New versions are released automatically with [semantic-release]
+as long as commits follow the [Angular Commit Message Conventions].
+
+[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
+[semantic-release]: https://semantic-release.gitbook.io/
+
+#### Manual
+
+Publish a new version by triggering a [version workflow_dispatch on GitHub Actions].
+The `version` input will be passed as the first argument to [npm-version].
+
+This may be done on the web or using the [GitHub CLI] with
+
+```
+$ gh workflow run version.yml --raw-field version=<version>
+```
+
+[GitHub CLI]: https://cli.github.com/
+[npm-version]: https://docs.npmjs.com/cli/version
+[version workflow_dispatch on GitHub Actions]: https://github.com/seamapi/types/actions?query=workflow%3Aversion
+
+## GitHub Actions
+
+_GitHub Actions should already be configured: this section is for reference only._
+
+The following repository secrets must be set on [GitHub Actions]:
+
+- `NPM_TOKEN`: npm token for installing and publishing packages.
+- `GH_TOKEN`: A personal access token for the bot user with
+  `packages:write` and `contents:write` permission.
+- `GIT_USER_NAME`: The GitHub bot user's real name.
+- `GIT_USER_EMAIL`: The GitHub bot user's email.
+- `GPG_PRIVATE_KEY`: The GitHub bot user's [GPG private key].
+- `GPG_PASSPHRASE`: The GitHub bot user's GPG passphrase.
+
+[GitHub Actions]: https://github.com/features/actions
+[GPG private key]: https://github.com/marketplace/actions/import-gpg#prerequisites
+
+## Contributing
+
+> If using squash merge, edit and ensure the commit message follows the [Angular Commit Message Conventions] specification.
+> Otherwise, each individual commit must follow the [Angular Commit Message Conventions] specification.
+
+1. Create your feature branch (`git checkout -b my-new-feature`).
+2. Make changes.
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new draft pull request.
+6. Ensure all checks pass.
+7. Mark your pull request ready for review.
+8. Wait for the required approval from the code owners.
+9. Merge when ready.
+
+[Angular Commit Message Conventions]: https://semantic-release.gitbook.io/semantic-release/#commit-message-format
+
+## License
+
+This npm package is licensed under the MIT license.
+
+## Warranty
+
+This software is provided by the copyright holders and contributors "as is" and
+any express or implied warranties, including, but not limited to, the implied
+warranties of merchantability and fitness for a particular purpose are
+disclaimed. In no event shall the copyright holder or contributors be liable for
+any direct, indirect, incidental, special, exemplary, or consequential damages
+(including, but not limited to, procurement of substitute goods or services;
+loss of use, data, or profits; or business interruption) however caused and on
+any theory of liability, whether in contract, strict liability, or tort
+(including negligence or otherwise) arising in any way out of the use of this
+software, even if advised of the possibility of such damage.

package/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './lib/index.js';
+export * from './lib/index.js';

package/index.js

@@ -0,0 +1,3 @@
+export { default } from './lib/index.js';
+export * from './lib/index.js';
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,cAAc,cAAc,CAAA"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { todo as default } from './todo.js';
+export { todo } from './todo.js';

package/lib/index.js

@@ -0,0 +1,3 @@
+export { todo as default } from './todo.js';
+export { todo } from './todo.js';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,IAAI,OAAO,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA"}

package/lib/todo.d.ts

@@ -0,0 +1 @@
+export declare const todo: (x: string) => string;

package/lib/todo.js

@@ -0,0 +1,2 @@
+export const todo = (x) => x;
+//# sourceMappingURL=todo.js.map

package/lib/todo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"todo.js","sourceRoot":"","sources":["../src/lib/todo.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@seamapi/types",
+  "version": "0.0.4",
+  "description": "TypeScript types for the Seam API.",
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./index.d.ts"
+    }
+  },
+  "module": "index.js",
+  "sideEffects": false,
+  "keywords": [
+    "node"
+  ],
+  "homepage": "https://github.com/seamapi/types",
+  "bugs": "https://github.com/seamapi/types/issues",
+  "repository": "seamapi/types",
+  "license": "MIT",
+  "author": {
+    "name": "Seam Labs, Inc.",
+    "email": "devops@getseam.com"
+  },
+  "files": [
+    "index.js",
+    "index.js.map",
+    "index.d.ts",
+    "lib",
+    "src",
+    "!**/*.test.ts"
+  ],
+  "scripts": {
+    "build": "npm run build:ts",
+    "postbuild": "node ./index.js",
+    "build:ts": "tsc --project tsconfig.build.json",
+    "prebuild:ts": "del 'index.*' lib",
+    "postbuild:ts": "tsc-alias --project tsconfig.build.json",
+    "typecheck": "tsc",
+    "test": "c8 ava",
+    "pretest": "tsx src/index.ts",
+    "test:update": "ava --update-snapshots",
+    "test:watch": "ava --watch",
+    "test:debug": "ava debug --break",
+    "lint": "eslint --ignore-path .gitignore .",
+    "prelint": "prettier --check --ignore-path .gitignore .",
+    "postversion": "git push --follow-tags",
+    "example": "tsx examples",
+    "example:inspect": "tsx --inspect examples",
+    "format": "eslint --ignore-path .gitignore --fix .",
+    "preformat": "prettier --write --ignore-path .gitignore .",
+    "report": "c8 report"
+  },
+  "engines": {
+    "node": ">=16.13.0",
+    "npm": ">= 8.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.18",
+    "ava": "^5.0.1",
+    "c8": "^8.0.0",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.9.0",
+    "eslint-config-prettier": "^8.4.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-config-standard-with-typescript": "^36.0.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-unused-imports": "^2.0.0",
+    "landlubber": "^1.0.0",
+    "prettier": "^3.0.0",
+    "tsc-alias": "^1.8.2",
+    "tsx": "^3.12.1",
+    "typescript": "^5.0.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { default } from 'lib/index.js'
+export * from 'lib/index.js'

package/src/lib/index.ts

@@ -0,0 +1,2 @@
+export { todo as default } from './todo.js'
+export { todo } from './todo.js'

package/src/lib/todo.ts

@@ -0,0 +1 @@
+export const todo = (x: string): string => x