idp.global/app

Fork 0

Files

T

jkunz 76efcb835f fix(docs): refresh module readmes and add repository license file

2026-04-20 08:15:42 +00:00

4.0 KiB

Raw Blame History

@idp.global/interfaces

Shared TypeScript contracts for the idp.global backend, browser client, CLI, and frontend.

Use this package when you want typed request/response payloads and shared data models for users, sessions, organizations, apps, billing, and OIDC.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Install

pnpm add @idp.global/interfaces

Quick Start

import { data, request, tags } from '@idp.global/interfaces';

const loginRequest: request.IReq_LoginWithEmailOrUsernameAndPassword['request'] = {
  username: 'user@example.com',
  password: 'secret',
};

const organization: data.IOrganization = {
  id: 'org_1',
  data: {
    name: 'Acme',
    slug: 'acme',
    billingPlanId: 'plan_free',
    roleIds: [],
  },
};

Exports

`data`

The data export includes types for:

users
organizations
roles
JWT payloads
login sessions
devices
activity logs
apps and app connections
billing plans and Paddle checkout data
OIDC data structures
invitations

`request`

The request export includes typed request contracts for:

login, logout, refresh, password reset, and device attachment
registration flow requests
user and session queries
organization CRUD-style requests
invitations and membership changes
app and admin actions
billing and JWT validation support

`tags`

Shared tag exports live under tags/.

Layout

Path	Purpose
`data/index.ts`	Re-exports all shared data interfaces
`request/index.ts`	Re-exports all typed request contracts
`tags/index.ts`	Re-exports shared tags

Examples

type TLogin = request.IReq_LoginWithEmailOrUsernameAndPassword;

const payload: TLogin['request'] = {
  username: 'user@example.com',
  password: 'secret',
};

Session Contract

type TSessions = request.IReq_GetUserSessions['response']['sessions'];

OIDC Contract

type TUserInfo = data.IUserInfoResponse;

Scope

This package is intentionally contract-only. It does not open sockets, store auth state, or perform HTTP/websocket communication by itself.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the license file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

4.0 KiB Raw Blame History