open-index/open-npm huggingface dataset:
npm package: @octokit/tsconfig
Description: TypeScript configuration for Octokit packages
Author: Gregor Martynus
Latest version: 4.0.0

# tsconfig

> TypeScript configuration for Octokit packages

[![@latest](https://img.shields.io/npm/v/@octokit/tsconfig.svg)](https://www.npmjs.com/package/@octokit/tsconfig)
[![Build Status](https://github.com/octokit/tsconfig/workflows/Test/badge.svg)](https://github.com/octokit/tsconfig/actions?query=workflow%3ATest+branch%3Amain)

## Usage

Install package with `npm` or `yarn`

```
npm install --save-dev @octokit/tsconfig
```

Then create `tsconfig.json` file with the following content

```js
{
  "extends": "@octokit/tsconfig"
}
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

[MIT](LICENSE)
npm package: @octokit/types
Description: Shared TypeScript definitions for Octokit projects
Author: Gregor Martynus
Latest version: 16.0.0

# types.ts

> Shared TypeScript definitions for Octokit projects

[![@latest](https://img.shields.io/npm/v/@octokit/types.svg)](https://www.npmjs.com/package/@octokit/types)
[![Build Status](https://github.com/octokit/types.ts/workflows/Test/badge.svg)](https://github.com/octokit/types.ts/actions?workflow=Test)

<!-- toc -->

- [Usage](#usage)
- [Examples](#examples)
  - [Get parameter and response data types for a REST API endpoint](#get-parameter-and-response-data-types-for-a-rest-api-endpoint)
  - [Get response types from endpoint methods](#get-response-types-from-endpoint-methods)
- [Contributing](#contributing)
- [License](#license)

<!-- tocstop -->

## Usage

See all exported types at https://octokit.github.io/types.ts

## Examples

### Get parameter and response data types for a REST API endpoint

```ts
import { Endpoints } from "@octokit/types";

type listUserReposParameters =
  Endpoints["GET /repos/{owner}/{repo}"]["parameters"];
type listUserReposResponse = Endpoints["GET /repos/{owner}/{repo}"]["response"];

async function listRepos(
  options: listUserReposParameters,
): listUserReposResponse["data"] {
  // ...
}
```

### Get response types from endpoint methods

```ts
import {
  GetResponseTypeFromEndpointMethod,
  GetResponseDataTypeFromEndpointMethod,
} from "@octokit/types";
import { Octokit } from "@octokit/rest";

const octokit = new Octokit();
type CreateLabelResponseType = GetResponseTypeFromEndpointMethod<
  typeof octokit.issues.createLabel
>;
type CreateLabelResponseDataType = GetResponseDataTypeFromEndpointMethod<
  typeof octokit.issues.createLabel
>;
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

[MIT](LICENSE)
npm package: @octokit/webhooks-definitions
Description: machine-readable, always up-to-date GitHub Webhooks specifications
Author: Gregor Martynus
Latest version: 3.67.3
Deprecated: Use @octokit/webhooks-types, @octokit/webhooks-schemas, or @octokit/webhooks-examples instead. See https://github.com/octokit/webhooks/issues/447
npm package: @octokit/webhooks-schemas
Description: Community contributed webhook payload schemas in JSON schema format
Author: Gregor Martynus
Latest version: 7.6.1

# Octokit Webhooks

> machine-readable, always up-to-date GitHub Webhooks specifications

![Update status](https://github.com/octokit/webhooks/workflows/Update/badge.svg)

## Download

Download the latest specification at
[unpkg.com/@octokit/webhooks-schemas/schema.json](https://unpkg.com/@octokit/webhooks-schemas/schema.json)

## Usage as Node module

To get the JSON schema for webhook payloads, require the `@octokit/webhooks-schemas` package.

```js
// Use Node.js require:
const SCHEMA = require("@octokit/webhooks-schemas");

// Or ESM/TypeScript import:
import SCHEMA from "@octokit/webhooks-schemas";
```

### Usage with `ajv` in `strict` mode

When running in `strict` mode, `ajv` will throw an "unknown keyword" error if it
encounters any keywords that have not been defined.

This schema currently uses custom keywords provided by `ajv-formats`, along with
the custom keyword `tsAdditionalProperties`.

Here is an example of how you can set this up:

```ts
import type { WebhookEvent } from "@octokit/webhooks-types";
import * as githubWebhookSchema from "@octokit/webhooks-schemas";
import Ajv from "ajv";
import addFormats from "ajv-formats";

const ajv = new Ajv({ strict: true });

addFormats(ajv);
ajv.addKeyword("tsAdditionalProperties");

const validate = ajv.compile<WebhookEvent>(githubWebhookSchema);
```

## See also

- [octokit/graphql-schema](https://github.com/octokit/graphql-schema) – GitHub’s
  GraphQL Schema with validation
- [octokit/openapi](https://github.com/octokit/openapi) – GitHub REST API route
  specifications
- [octokit/app-permissions](https://github.com/octokit/app-permissions) – GitHub
  App permission specifications

## LICENSE

[MIT](LICENSE.md)
npm package: @octokit/webhooks-types
Description: Generated TypeScript definitions based on community contributed JSON Schemas
Author: Gregor Martynus
Latest version: 7.6.1

# Octokit Webhooks

> machine-readable, always up-to-date GitHub Webhooks specifications

![Update status](https://github.com/octokit/webhooks/workflows/Update/badge.svg)

## Download

Download the latest specification at
[octokit.github.io/webhooks/payload-examples/api.github.com/index.json](https://octokit.github.io/webhooks/payload-examples/api.github.com/index.json)

## Usage

This package ships with types for the webhook events generated from the
respective json schemas, which you can use like so:

```typescript
import { WebhookEvent, IssuesOpenedEvent } from "@octokit/webhooks-types";

const handleWebhookEvent = (event: WebhookEvent) => {
  if ("action" in event && event.action === "completed") {
    console.log(`${event.sender.login} completed something!`);
  }
};

const handleIssuesOpenedEvent = (event: IssuesOpenedEvent) => {
  console.log(
    `${event.sender.login} opened "${event.issue.title}" on ${event.repository.full_name}`,
  );
};
```

**⚠️ Caution ⚠️**: Webhooks Types are expected to be used with the [`strictNullChecks` option](https://www.typescriptlang.org/tsconfig#strictNullChecks) enabled in your `tsconfig`. If you don't have this option enabled, there's the possibility that you get `never` as the inferred type in some use cases. See [#395](https://github.com/octokit/webhooks/issues/395) for details.

## See also

- [octokit/graphql-schema](https://github.com/octokit/graphql-schema) – GitHub’s
  GraphQL Schema with validation
- [octokit/openapi](https://github.com/octokit/openapi) – GitHub REST API route
  specifications
- [octokit/app-permissions](https://github.com/octokit/app-permissions) – GitHub
  App permission specifications

## LICENSE

[MIT](LICENSE.md)
npm package: @octomagic/cli
Description: Connect your business tools and query them with natural language via LLM
Author: Ryan Holmes
Latest version: 0.1.5

# 🐙 OctoMagic CLI

Connect your business tools and query them with natural language powered by AI.

## Install

```bash
npm install -g @octomagic/cli
```

## Usage

```bash
# Run the setup wizard
octomagic setup

# Launch the chat TUI
octomagic chat

# Or just run it (auto-detects first run)
octomagic
```

## What is OctoMagic?

OctoMagic connects to your business SaaS providers (CRM, accounting, HR, e-commerce, etc.) via [Unified.to](https://unified.to) and lets you query them using natural language through an LLM. Ask questions like "How are our sales looking this month?" and OctoMagic will query your connected integrations to give you an answer.

Interact with OctoMagic via the CLI, [Slack](https://octomagic.ai), [Google Chat](https://octomagic.ai), or the [web](https://octomagic.ai).

## Supported Providers

410+ integrations via Unified.to across 25+ categories including CRM, Accounting, HR, E-Commerce, Ticketing, Communication, File Storage, and more.

## License

MIT
npm package: @octomind/debugtopus
Description: Thin wrapper around playwright and the octomind api to run your automagically-maintained tests locally
Author: OctoMind-dev
Latest version: 3.10.1

# debugtopus  🐙 💻

Debugtopus is a tool to run Octomind tests against the local instance of your app. Octomind tests are AI auto-generated, hosted and run end-to-end tests in standard Playwright code in the cloud. 

Here's some more [info](https://www.octomind.dev/?utm_source=github&utm_medium=debugtopus&utm_campaign=rm) on octomind and more in the [docs](https://www.octomind.dev/docs?utm_source=github&utm_medium=debugtopus&utm_campaign=rm).


## Installation

```shell
npm i @octomind/debugtopus
```

## Description

### Required
* `-t, --token <token>` - auth token to authorise against octomind app
* `-a, --testTargetId <test-target-id>` - ID of the test target you want to run against
* `-u, --url <local-url>` - an url of your app you want the tests to be run against
### Optional
* `-i, --id <test-case-id>` - ID of the test case you want to run locally - if not provided will run all test cases in the specified target
* `-e, --environmentId <environment-id>` - ID of the environment you want your test case to use - if not provided will run all test cases in default environment
* `-o, --octomindUrl <octo-url>` - defaults to production app `app.octomind.dev`. Used by octoneers to test against different environments

## Usage
You should get the base command including id and token from octomind. 
You should just add the url of the app you would like to run the test against:

Running one test case:
```shell
npx @octomind/debugtopus --id <testCaseId> --token <token> --url <localUrl> --testTargetId <testTargetId> --environmentId <environmentId>
```

Running all test cases in a test target:
```shell
npx @octomind/debugtopus --token <token> --url <localUrl> --testTargetId <testTargetId> --environmentId <environmentId>
```

You can also use a specific version:
```shell
 npx --package @octomind/debugtopus@<some-version> debugtopus --id <testCaseId> --token <token> --url <localUrl> --testTargetId <testTargetId> --environmentId <environmentId>
```

## Development

### Dependencies

We use [corepack](https://nodejs.org/api/corepack.html) and [pnpm](https://pnpm.io/) for our dependencies.

Enable corepack to let it manage pnpm and its version for you:

```shell
corepack enable
```

Then any time you reference `pnpm` in your shell corepack will ensure the right version is installed.
npm package: @octonary/mailgun-js
Description: Simple Node.js helper module for Mailgun API. Forked to fix IE issues with ` character.
Author: Bojan Djurkovic
Latest version: 102.13.1

# mailgun.js

Simple Node.js module for [Mailgun](http://www.mailgun.com).

Forked to fix IE issues with the ` character in the mailgun.js source.