npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@needle-ai/needle-sdk

v1.1.1

Published

Developer tools to build integrations and data connectors to Needle

Downloads

122

Readme

Needle SDK TypeScript

This library provides tools for developing integrations for Needle. For example integrations, see the Needle Integrations repository.

If you want to develop a data connector for Needle, this is the right place to start.

Getting Started

Needle integrations are implemented as standalone fullstack web applications. In order to ease the development process, we provide a library that contains shared components and utilities such as authentication, database access, and more.

Install the library using your preferred package manager:

npm install needle-sdk
bun i needle-sdk
yarn add needle-sdk
pnpm add needle-sdk

You must use needle-sdk as a run time dependency in your project and use the provided functionality on your backend code. See some of the most frequently used utilities below.

| Function | Description | | --------------------- | ----------------------------------------------------------------------------- | | validateSession | Validate a session token. You can read the token value from the cookies. | | createConnector | Create a new connector. Talks with Needle API to register a new connector. | | getConnector | Get a connector by ID. Retrieve connector details from Needle API. | | listConnector | List all connectors. | | deleteConnector | Delete a connector. | | publishConnectorRun | Publish a connector run. Inform Needle about the results of the connector run |

Note that every function requires user authentication. Session token represents a user authentication and you can read the token value from the cookies.

For example usage, see connector implementations in the Needle Integrations repository.

Requirements

This library requires a needle.config.js file to be present in the root of your project. This file contains your integration's configuration. See an example below:

export default {
  appId: "MyAppId",
  appName: "My App Name",
  appSlug: "my-app",
  connectorType: "ext_my_app",
  connectorLogo: "https://needle-ai.com/images/needle-logo.png",
};

You must also make an environment variable NEEDLE_APP_SECRET available in your project. This value allows secure communication between your integration and Needle. Keep this value secret at all times. In case it is compromised, you can revoke it and generate a new one.

For getting started with the configuration file, contact us at [email protected] to get your app ID and secret. If you wish you can also contact us in our Discord server.

License

This project is licensed under the MIT License. See the LICENSE file for details.