@inai-dev/types 0.1.0

package/README.md

@@ -0,0 +1,38 @@
+# @inai-dev/types
+
+TypeScript type definitions for the InAI Auth SDK. This package contains all shared interfaces and types used across the SDK.
+
+## Installation
+
+```bash
+npm install @inai-dev/types
+```
+
+> **Note:** You typically don't need to install this directly. It's included as a dependency of all other `@inai-dev/*` packages.
+
+## Usage
+
+```ts
+import type {
+  AuthObject,
+  UserResource,
+  SessionResource,
+  ApplicationResource,
+  EnvironmentResource,
+  OrganizationResource,
+} from "@inai-dev/types";
+```
+
+## Exported Types
+
+- **Auth**: `AuthObject`, `AuthConfig`, `SignInResult`, `SignUpResult`
+- **Resources**: `UserResource`, `SessionResource`, `ApplicationResource`, `EnvironmentResource`, `OrganizationResource`, `RoleResource`, `PermissionResource`
+- **Config**: `InAIConfig`, `CookieConfig`
+
+## Documentation
+
+See the full [API Reference](https://github.com/inai-dev/sdk/blob/main/docs/api-reference.md).
+
+## License
+
+[MIT](../../LICENSE)

package/dist/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export type {\n  AuthObject,\n  ServerAuthObject,\n  ProtectedAuthObject,\n  JWTClaims,\n} from \"./auth\";\n\nexport type {\n  UserResource,\n  PlatformUserResource,\n  SessionResource,\n  OrganizationResource,\n  ApplicationResource,\n  EnvironmentResource,\n  ApplicationStats,\n  ApiKeyResource,\n  PaginatedResult,\n} from \"./resources\";\n\nexport type {\n  InAIAuthConfig,\n  InAIMiddlewareConfig,\n  InAIAuthSDKConfig,\n} from \"./config\";\n\nexport type {\n  LoginParams,\n  LoginResult,\n  MFAChallengeParams,\n  TokenPair,\n  SignInResult,\n  SignUpResult,\n  InAIAuthErrorBody,\n} from \"./results\";\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,211 @@
+interface AuthObject {
+    userId: string | null;
+    tenantId: string | null;
+    appId: string | null;
+    envId: string | null;
+    orgId: string | null;
+    orgRole: string | null;
+    sessionId: string | null;
+    getToken: () => Promise<string | null>;
+    has: (params: {
+        role?: string;
+        permission?: string;
+    }) => boolean;
+}
+interface ServerAuthObject extends AuthObject {
+    protect: (params?: {
+        role?: string;
+        permission?: string;
+        redirectTo?: string;
+    }) => ProtectedAuthObject;
+    redirectToSignIn: (opts?: {
+        returnTo?: string;
+    }) => never;
+}
+interface ProtectedAuthObject {
+    userId: string;
+    tenantId: string;
+    appId: string | null;
+    envId: string | null;
+    orgId: string | null;
+    orgRole: string | null;
+    sessionId: string | null;
+    isSignedIn: true;
+    getToken: () => Promise<string>;
+    has: (params: {
+        role?: string;
+        permission?: string;
+    }) => boolean;
+}
+interface JWTClaims {
+    sub: string;
+    type: "app_user" | "platform";
+    tenant_id: string;
+    env_id?: string;
+    app_id?: string;
+    email: string;
+    roles: string[];
+    permissions: string[];
+    org_id?: string;
+    org_slug?: string;
+    org_role?: string;
+    org_permissions?: string[];
+    external_id?: string;
+    iat: number;
+    exp: number;
+}
+
+interface UserResource {
+    id: string;
+    tenantId: string;
+    email: string;
+    firstName: string | null;
+    lastName: string | null;
+    avatarUrl: string | null;
+    isActive: boolean;
+    emailVerified: boolean;
+    mfaEnabled: boolean;
+    externalId: string | null;
+    roles: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface PlatformUserResource {
+    id: string;
+    tenantId: string | null;
+    email: string;
+    firstName: string | null;
+    lastName: string | null;
+    avatarUrl: string | null;
+    roles: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface SessionResource {
+    id: string;
+    userId: string;
+    tenantId: string;
+    environmentId: string | null;
+    activeOrgId: string | null;
+    expiresAt: string;
+}
+interface OrganizationResource {
+    id: string;
+    tenantId: string;
+    name: string;
+    slug: string;
+    imageUrl: string | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ApplicationResource {
+    id: string;
+    tenantId: string;
+    name: string;
+    slug: string;
+    domain: string | null;
+    logoUrl: string | null;
+    homeUrl: string | null;
+    isActive: boolean;
+    settings: Record<string, unknown> | null;
+    authConfig: Record<string, unknown> | null;
+    environments: EnvironmentResource[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface EnvironmentResource {
+    id: string;
+    name: string;
+    publishableKey: string;
+    isActive: boolean;
+}
+interface ApplicationStats {
+    totalUsers: number;
+    activeSessions: number;
+    totalRoles: number;
+    totalApiKeys: number;
+    environments: Array<{
+        id: string;
+        name: string;
+        userCount: number;
+        sessionCount: number;
+    }>;
+}
+interface ApiKeyResource {
+    id: string;
+    name: string;
+    keyPrefix: string;
+    keyType: string;
+    environmentId: string;
+    lastUsedAt: string | null;
+    expiresAt: string | null;
+    createdAt: string;
+}
+interface PaginatedResult<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+}
+
+interface InAIAuthConfig {
+    apiUrl: string;
+    publishableKey?: string;
+    tenantId?: string;
+}
+interface InAIMiddlewareConfig {
+    publicRoutes?: string[] | ((req: unknown) => boolean);
+    signInUrl?: string;
+    beforeAuth?: (req: unknown) => unknown | void;
+    afterAuth?: (auth: unknown, req: unknown) => unknown | void;
+}
+interface InAIAuthSDKConfig {
+    signInUrl?: string;
+    signUpUrl?: string;
+    afterSignInUrl?: string;
+    afterSignOutUrl?: string;
+    apiUrl?: string;
+    publishableKey?: string;
+}
+
+interface LoginParams {
+    email: string;
+    password: string;
+}
+interface LoginResult {
+    mfa_required?: boolean;
+    mfa_token?: string;
+    access_token?: string;
+    refresh_token?: string;
+    token_type?: string;
+    expires_in?: number;
+}
+interface MFAChallengeParams {
+    mfa_token: string;
+    code: string;
+}
+interface TokenPair {
+    access_token: string;
+    refresh_token: string;
+    token_type: string;
+    expires_in: number;
+}
+interface SignInResult {
+    status: "complete" | "needs_mfa" | "error";
+    mfa_token?: string;
+    user?: UserResource;
+    error?: string;
+}
+interface SignUpResult {
+    status: "complete" | "needs_email_verification" | "error";
+    user?: UserResource;
+    error?: string;
+}
+interface InAIAuthErrorBody {
+    code: string;
+    detail: string;
+    field?: string;
+}
+
+export type { ApiKeyResource, ApplicationResource, ApplicationStats, AuthObject, EnvironmentResource, InAIAuthConfig, InAIAuthErrorBody, InAIAuthSDKConfig, InAIMiddlewareConfig, JWTClaims, LoginParams, LoginResult, MFAChallengeParams, OrganizationResource, PaginatedResult, PlatformUserResource, ProtectedAuthObject, ServerAuthObject, SessionResource, SignInResult, SignUpResult, TokenPair, UserResource };

package/dist/index.d.ts

@@ -0,0 +1,211 @@
+interface AuthObject {
+    userId: string | null;
+    tenantId: string | null;
+    appId: string | null;
+    envId: string | null;
+    orgId: string | null;
+    orgRole: string | null;
+    sessionId: string | null;
+    getToken: () => Promise<string | null>;
+    has: (params: {
+        role?: string;
+        permission?: string;
+    }) => boolean;
+}
+interface ServerAuthObject extends AuthObject {
+    protect: (params?: {
+        role?: string;
+        permission?: string;
+        redirectTo?: string;
+    }) => ProtectedAuthObject;
+    redirectToSignIn: (opts?: {
+        returnTo?: string;
+    }) => never;
+}
+interface ProtectedAuthObject {
+    userId: string;
+    tenantId: string;
+    appId: string | null;
+    envId: string | null;
+    orgId: string | null;
+    orgRole: string | null;
+    sessionId: string | null;
+    isSignedIn: true;
+    getToken: () => Promise<string>;
+    has: (params: {
+        role?: string;
+        permission?: string;
+    }) => boolean;
+}
+interface JWTClaims {
+    sub: string;
+    type: "app_user" | "platform";
+    tenant_id: string;
+    env_id?: string;
+    app_id?: string;
+    email: string;
+    roles: string[];
+    permissions: string[];
+    org_id?: string;
+    org_slug?: string;
+    org_role?: string;
+    org_permissions?: string[];
+    external_id?: string;
+    iat: number;
+    exp: number;
+}
+
+interface UserResource {
+    id: string;
+    tenantId: string;
+    email: string;
+    firstName: string | null;
+    lastName: string | null;
+    avatarUrl: string | null;
+    isActive: boolean;
+    emailVerified: boolean;
+    mfaEnabled: boolean;
+    externalId: string | null;
+    roles: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface PlatformUserResource {
+    id: string;
+    tenantId: string | null;
+    email: string;
+    firstName: string | null;
+    lastName: string | null;
+    avatarUrl: string | null;
+    roles: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface SessionResource {
+    id: string;
+    userId: string;
+    tenantId: string;
+    environmentId: string | null;
+    activeOrgId: string | null;
+    expiresAt: string;
+}
+interface OrganizationResource {
+    id: string;
+    tenantId: string;
+    name: string;
+    slug: string;
+    imageUrl: string | null;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ApplicationResource {
+    id: string;
+    tenantId: string;
+    name: string;
+    slug: string;
+    domain: string | null;
+    logoUrl: string | null;
+    homeUrl: string | null;
+    isActive: boolean;
+    settings: Record<string, unknown> | null;
+    authConfig: Record<string, unknown> | null;
+    environments: EnvironmentResource[];
+    createdAt: string;
+    updatedAt: string;
+}
+interface EnvironmentResource {
+    id: string;
+    name: string;
+    publishableKey: string;
+    isActive: boolean;
+}
+interface ApplicationStats {
+    totalUsers: number;
+    activeSessions: number;
+    totalRoles: number;
+    totalApiKeys: number;
+    environments: Array<{
+        id: string;
+        name: string;
+        userCount: number;
+        sessionCount: number;
+    }>;
+}
+interface ApiKeyResource {
+    id: string;
+    name: string;
+    keyPrefix: string;
+    keyType: string;
+    environmentId: string;
+    lastUsedAt: string | null;
+    expiresAt: string | null;
+    createdAt: string;
+}
+interface PaginatedResult<T> {
+    data: T[];
+    total: number;
+    page: number;
+    limit: number;
+}
+
+interface InAIAuthConfig {
+    apiUrl: string;
+    publishableKey?: string;
+    tenantId?: string;
+}
+interface InAIMiddlewareConfig {
+    publicRoutes?: string[] | ((req: unknown) => boolean);
+    signInUrl?: string;
+    beforeAuth?: (req: unknown) => unknown | void;
+    afterAuth?: (auth: unknown, req: unknown) => unknown | void;
+}
+interface InAIAuthSDKConfig {
+    signInUrl?: string;
+    signUpUrl?: string;
+    afterSignInUrl?: string;
+    afterSignOutUrl?: string;
+    apiUrl?: string;
+    publishableKey?: string;
+}
+
+interface LoginParams {
+    email: string;
+    password: string;
+}
+interface LoginResult {
+    mfa_required?: boolean;
+    mfa_token?: string;
+    access_token?: string;
+    refresh_token?: string;
+    token_type?: string;
+    expires_in?: number;
+}
+interface MFAChallengeParams {
+    mfa_token: string;
+    code: string;
+}
+interface TokenPair {
+    access_token: string;
+    refresh_token: string;
+    token_type: string;
+    expires_in: number;
+}
+interface SignInResult {
+    status: "complete" | "needs_mfa" | "error";
+    mfa_token?: string;
+    user?: UserResource;
+    error?: string;
+}
+interface SignUpResult {
+    status: "complete" | "needs_email_verification" | "error";
+    user?: UserResource;
+    error?: string;
+}
+interface InAIAuthErrorBody {
+    code: string;
+    detail: string;
+    field?: string;
+}
+
+export type { ApiKeyResource, ApplicationResource, ApplicationStats, AuthObject, EnvironmentResource, InAIAuthConfig, InAIAuthErrorBody, InAIAuthSDKConfig, InAIMiddlewareConfig, JWTClaims, LoginParams, LoginResult, MFAChallengeParams, OrganizationResource, PaginatedResult, PlatformUserResource, ProtectedAuthObject, ServerAuthObject, SessionResource, SignInResult, SignUpResult, TokenPair, UserResource };

package/dist/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@inai-dev/types",
+  "version": "0.1.0",
+  "description": "TypeScript types for the InAI Auth SDK",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "InAI <contact@inai.dev>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/inai-dev/sdk.git",
+    "directory": "packages/types"
+  },
+  "homepage": "https://github.com/inai-dev/sdk/tree/main/packages/types",
+  "bugs": "https://github.com/inai-dev/sdk/issues",
+  "keywords": ["inai", "auth", "types", "typescript", "multi-tenant"]
+}