memorysync-sdk 1.0.2 → 1.1.1

package/README.md

@@ -70,6 +70,56 @@ if ("status" in result && result.status === "skipped") {
 }
 ```
 
+## Control-plane client
+
+`ControlPlaneClient` is a separate bearer-authenticated client for trusted dashboard and administrative flows. It never sends an API key, persists login tokens, or refreshes tokens automatically. `login()` is the only method that does not require `accessToken`.
+
+```ts
+import { ControlPlaneClient } from "memorysync-sdk";
+
+const control = new ControlPlaneClient({
+  baseUrl: "https://api.memorysync.io",
+  accessToken: process.env.MEMORYSYNC_ACCESS_TOKEN,
+  projectId: "project_abc123", // optional X-Project-ID default
+});
+
+const plan = await control.getCurrentPlan();
+const hooks = await control.listWebhooks({ projectId: "project_override" });
+
+// This returns tokens but does not store them on the client.
+const login = await new ControlPlaneClient({
+  baseUrl: "https://api.memorysync.io",
+}).login({ email: "developer@example.com", password: "..." });
+```
+
+Control-plane configuration accepts `baseUrl`, optional `accessToken`, optional `projectId`, optional `timeoutMs`, and optional injectable `fetch`. Every call accepts a final `{ projectId? }` override. Public request and response fields are camelCase; the client explicitly encodes documented snake_case wire fields and normalizes response objects.
+
+| Method | Route |
+| --- | --- |
+| `bulkRevokeApiKeys(req, options?)` | `POST /org/api-keys/bulk-revoke` |
+| `testApiKey(keyId, options?)` | `POST /org/api-keys/{key_id}/test` |
+| `login(req, options?)` | `POST /auth/login` |
+| `getCurrentPlan(options?)` | `GET /org/billing/current-plan` |
+| `listTeamMembers(options?)` | `GET /admin/team/members` |
+| `suspendTeamMember(memberId, options?)` | `PATCH /admin/team/members/{member_id}` |
+| `removeTeamMember(memberId, options?)` | `DELETE /admin/team/members/{member_id}` |
+| `listSessions(options?)` | `GET /auth/sessions` |
+| `revokeSession(sessionId, options?)` | `POST /auth/sessions/{session_id}/revoke` |
+| `listAuditEvents(query?, options?)` | `GET /admin/audit-logs` |
+| `listIntegrations(query?, options?)` | `GET /api/v1/integrations/catalog` |
+| `createOrganization(req, options?)` | `POST /organizations` |
+| `listOrganizations(options?)` | `GET /organizations` |
+| `listOrganizationMembers(options?)` | delegates to `listTeamMembers` |
+| `getOrganizationSettings(query?, options?)` | `GET /admin/tenant-settings` |
+| `listProjects(options?)` | `GET /org/projects` |
+| `createWebhook(req, options?)` | `POST /org/webhooks` |
+| `listWebhooks(options?)` | `GET /org/webhooks` |
+| `updateWebhook(endpointId, req, options?)` | `PATCH /org/webhooks/{endpoint_id}` |
+| `deleteWebhook(endpointId, options?)` | `DELETE /org/webhooks/{endpoint_id}` |
+| `testWebhook(endpointId, req?, options?)` | `POST /org/webhooks/{endpoint_id}/test` |
+| `replayWebhookDeliveries(endpointId, req?, options?)` | `POST /org/webhooks/{endpoint_id}/replay` |
+| `listWebhookDeliveries(endpointId, query?, options?)` | `GET /org/webhooks/{endpoint_id}/deliveries` |
+
 ## Errors
 
 Every non-2xx response throws a typed subclass of `MemorySyncError`:

package/dist/index.d.mts

@@ -1,3 +1,415 @@
+interface ErrorOptions {
+    statusCode?: number;
+    response?: unknown;
+    requestId?: string;
+}
+declare class MemorySyncError extends Error {
+    readonly statusCode?: number;
+    readonly response?: unknown;
+    readonly requestId?: string;
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class AuthError extends MemorySyncError {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class ValidationError extends MemorySyncError {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class NotFoundError extends MemorySyncError {
+    constructor(message: string, options?: ErrorOptions);
+}
+declare class RateLimitError extends MemorySyncError {
+    readonly retryAfterSeconds: number;
+    constructor(message: string, retryAfterSeconds: number, options?: ErrorOptions);
+}
+declare class ServerError extends MemorySyncError {
+    constructor(message: string, options?: ErrorOptions);
+}
+
+interface ControlPlaneConfig {
+    baseUrl: string;
+    accessToken?: string;
+    projectId?: string;
+    timeoutMs?: number;
+    fetch?: typeof fetch;
+}
+interface ControlPlaneRequestOptions {
+    projectId?: string;
+}
+interface LoginRequest {
+    email: string;
+    password: string;
+}
+interface LoginResponse {
+    tokens: {
+        accessToken: string;
+        refreshToken: string;
+        tokenType: string;
+    };
+    session: {
+        userId: number;
+        organizationId: number;
+        role: string;
+    };
+    mfaRequired: boolean;
+    mfaSetupRequired: boolean;
+}
+type ApiKeyTestStatus = "active" | "revoked" | "expired" | string;
+interface BulkRevokeApiKeysRequest {
+    keyIds: number[];
+}
+interface BulkRevokeApiKeyResult {
+    keyId: number;
+    status: "revoked" | "already_revoked" | "not_found" | "forbidden";
+}
+interface BulkRevokeApiKeysResponse {
+    revoked: number;
+    alreadyRevoked: number;
+    notFound: number;
+    results: BulkRevokeApiKeyResult[];
+}
+interface ApiKeyTestResponse {
+    keyId: number;
+    valid: boolean;
+    status: ApiKeyTestStatus;
+    environment: string;
+    rateLimitTier: string;
+    scopes: string[];
+    projectId: string | null;
+    lastUsedAt: string | null;
+    expiresAt: string | null;
+    expired: boolean;
+    serverTime: string;
+}
+interface PlanLimits {
+    addRequests: number | null;
+    retrievalRequests: number | null;
+}
+interface Plan {
+    id: string;
+    name: string;
+    priceCents?: number | null;
+    priceLabel: string;
+    description?: string;
+    limits: PlanLimits;
+    features?: string[];
+    ctaLabel?: string;
+    isEnterprise?: boolean;
+}
+interface CurrentPlanResponse {
+    plan: Plan;
+    status: string;
+    billingPeriodStart: string | null;
+    billingPeriodEnd: string | null;
+    nextResetAt?: string | null;
+    planLimitAdd?: number | null;
+    planLimitRetrieval?: number | null;
+    paymentFailed: boolean;
+    paymentStatus?: string;
+    scheduledPlanId: string | null;
+    cancelAtPeriodEnd: boolean;
+}
+interface TeamMember {
+    id: string;
+    name: string;
+    email: string;
+    role: string;
+    status: string;
+    lastActive?: string | null;
+    mfaEnabled: boolean;
+    authMethod: string;
+    loginProvider?: string;
+    devices?: number;
+    sessions: number;
+    isScimManaged?: boolean;
+}
+interface Session {
+    id: number;
+    isCurrent: boolean;
+    sessionType: string;
+    sessionName: string;
+    userAgent: string;
+    ip: string;
+    location: string | null;
+    geo: Record<string, unknown> | null;
+    createdAt: string;
+    lastActivityAt: string;
+    expiresAt: string;
+}
+interface SessionListResponse {
+    sessions: Session[];
+    currentSessionId: number | null;
+}
+type AuditSortDirection = "asc" | "desc";
+interface AuditEventQuery {
+    limit?: number;
+    cursor?: number;
+    skip?: number;
+    sortDirection?: AuditSortDirection;
+    tenantId?: string;
+    actor?: string;
+    actorEmail?: string;
+    ip?: string;
+    action?: string;
+    resourceType?: string;
+    resourceId?: string;
+    severity?: string;
+    category?: string;
+    start?: string;
+    end?: string;
+    success?: boolean;
+    source?: string;
+    ingestMethod?: string;
+    search?: string;
+    includeStats?: boolean;
+}
+interface AuditActor {
+    id: string;
+    email: string | null;
+    name: string | null;
+    type: string;
+}
+interface AuditResource {
+    type: string;
+    id: string;
+    label: string | null;
+}
+interface AuditEvent {
+    id: number;
+    eventId: string;
+    timestamp: string;
+    category: string;
+    actor: AuditActor;
+    action: string;
+    resource: AuditResource;
+    severity: string;
+    success: boolean;
+    metadata?: Record<string, unknown> | null;
+}
+interface AuditEventListResponse {
+    events: AuditEvent[];
+    nextCursor: number | null;
+    stats?: Record<string, unknown> | null;
+    sort: AuditSortDirection;
+}
+interface IntegrationQuery {
+    category?: string;
+}
+interface Integration {
+    id: string;
+    name: string;
+    description: string;
+    category: string;
+    features: string[];
+    authType: string;
+    isConfigured: boolean;
+    isConnected: boolean;
+    comingSoon: boolean;
+}
+interface CreateOrganizationRequest {
+    name: string;
+    domain?: string;
+}
+interface OrganizationMembership {
+    userId: number;
+    organizationId: number;
+    role: string;
+}
+interface OrganizationSettingsQuery {
+    tenantId?: string;
+}
+interface OrganizationSettings {
+    tenantId: string;
+    tenantName: string;
+    tenantSlug: string;
+    description: string | null;
+    plan: string;
+    status: string;
+    createdAt: string;
+    contactEmail: string | null;
+    customDomain: string | null;
+    customDomainVerified: boolean;
+    logoUrl: string | null;
+    totalMemories: number;
+    activeUsers: number;
+    organizationName: string;
+    scheduledDeletionAt: string | null;
+    mfaEnrolled: boolean;
+    passwordEnabled: boolean;
+}
+interface Project {
+    id: string;
+    name: string;
+    tenantId: string;
+    isDefault: boolean;
+    memoryCount: number;
+    archivedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface WebhookRetryConfig {
+    enabled?: boolean;
+    maxRetries?: number;
+    initialDelaySeconds?: number;
+    maxDelaySeconds?: number;
+    backoffMultiplier?: number;
+    retryStatusCodes?: string[];
+}
+interface WebhookSignatureConfig {
+    algorithm?: "hmac-sha256" | "hmac-sha512";
+    headerName?: string;
+    timestampHeader?: string;
+    toleranceSeconds?: number;
+}
+interface CreateWebhookRequest {
+    name: string;
+    url: string;
+    events: string[];
+    description?: string;
+    retryConfig?: WebhookRetryConfig;
+    signatureConfig?: WebhookSignatureConfig;
+    projectId?: string;
+}
+interface UpdateWebhookRequest {
+    name?: string;
+    url?: string;
+    description?: string;
+    events?: string[];
+    retryConfig?: WebhookRetryConfig;
+    signatureConfig?: WebhookSignatureConfig;
+}
+interface Webhook {
+    id: number;
+    name: string;
+    url: string;
+    description: string | null;
+    secretPrefix: string;
+    events: string[];
+    enabled: boolean;
+    signatureAlgorithm: string;
+    signatureHeader?: string;
+    timestampHeader?: string;
+    signatureTolerance?: number;
+    retryEnabled?: boolean;
+    maxRetries?: number;
+    initialDelaySeconds?: number;
+    maxDelaySeconds?: number;
+    backoffMultiplier?: number;
+    retryStatusCodes?: string[];
+    totalDeliveries?: number;
+    successfulDeliveries?: number;
+    failedDeliveries?: number;
+    consecutiveFailures?: number;
+    successRate?: number;
+    lastTriggeredAt?: string | null;
+    lastSuccessAt?: string | null;
+    lastFailureAt?: string | null;
+    lastError?: string | null;
+    lastStatusCode?: number | null;
+    createdAt?: string;
+    updatedAt?: string;
+    createdByName?: string | null;
+    projectId: string | null;
+}
+interface CreatedWebhook extends Webhook {
+    secret: string;
+}
+interface WebhookListResponse {
+    endpoints: Webhook[];
+    totalEndpoints: number;
+    activeEndpoints: number;
+    totalDeliveries: number;
+    avgSuccessRate: number;
+    failingEndpoints: number;
+}
+interface TestWebhookRequest {
+    eventType?: string;
+}
+interface TestWebhookResponse {
+    deliveryId: number;
+    eventId: string;
+    eventType: string;
+    endpointId: number;
+    status: string;
+    payload: Record<string, unknown>;
+    message: string;
+}
+interface ReplayWebhookDeliveriesRequest {
+    sinceMinutes?: number;
+    statuses?: string[];
+    limit?: number;
+}
+interface ReplayWebhookDeliveriesResponse {
+    endpointId: number;
+    eligible: number;
+    replayed: number;
+    skipped: number;
+    deliveryIds: number[];
+}
+interface WebhookDeliveryQuery {
+    page?: number;
+    pageSize?: number;
+    status?: string;
+}
+interface WebhookDelivery {
+    id: number;
+    endpointId: number;
+    eventType: string;
+    eventId: string;
+    status: string;
+    payload?: Record<string, unknown>;
+    payloadHash: string;
+    signature?: string | null;
+    statusCode: number | null;
+    responseBody?: string | null;
+    errorMessage?: string | null;
+    latencyMs: number | null;
+    attemptNumber: number;
+    maxAttempts: number;
+    nextRetryAt?: string | null;
+    createdAt: string;
+    completedAt: string | null;
+}
+interface WebhookDeliveryListResponse {
+    deliveries: WebhookDelivery[];
+    total: number;
+    page: number;
+    pageSize: number;
+}
+declare class ControlPlaneClient {
+    private readonly baseUrl;
+    private readonly accessToken?;
+    private readonly projectId?;
+    private readonly timeoutMs;
+    private readonly fetchImpl;
+    constructor(config: ControlPlaneConfig);
+    private request;
+    private throwForStatus;
+    bulkRevokeApiKeys(request: BulkRevokeApiKeysRequest, options?: ControlPlaneRequestOptions): Promise<BulkRevokeApiKeysResponse>;
+    testApiKey(keyId: number, options?: ControlPlaneRequestOptions): Promise<ApiKeyTestResponse>;
+    login(request: LoginRequest, options?: ControlPlaneRequestOptions): Promise<LoginResponse>;
+    getCurrentPlan(options?: ControlPlaneRequestOptions): Promise<CurrentPlanResponse>;
+    listTeamMembers(options?: ControlPlaneRequestOptions): Promise<TeamMember[]>;
+    suspendTeamMember(memberId: number, options?: ControlPlaneRequestOptions): Promise<TeamMember>;
+    removeTeamMember(memberId: number, options?: ControlPlaneRequestOptions): Promise<void>;
+    listSessions(options?: ControlPlaneRequestOptions): Promise<SessionListResponse>;
+    revokeSession(sessionId: number, options?: ControlPlaneRequestOptions): Promise<void>;
+    listAuditEvents(query?: AuditEventQuery, options?: ControlPlaneRequestOptions): Promise<AuditEventListResponse>;
+    listIntegrations(query?: IntegrationQuery, options?: ControlPlaneRequestOptions): Promise<Integration[]>;
+    createOrganization(request: CreateOrganizationRequest, options?: ControlPlaneRequestOptions): Promise<OrganizationMembership>;
+    listOrganizations(options?: ControlPlaneRequestOptions): Promise<OrganizationMembership[]>;
+    listOrganizationMembers(options?: ControlPlaneRequestOptions): Promise<TeamMember[]>;
+    getOrganizationSettings(query?: OrganizationSettingsQuery, options?: ControlPlaneRequestOptions): Promise<OrganizationSettings>;
+    listProjects(options?: ControlPlaneRequestOptions): Promise<Project[]>;
+    createWebhook(request: CreateWebhookRequest, options?: ControlPlaneRequestOptions): Promise<CreatedWebhook>;
+    listWebhooks(options?: ControlPlaneRequestOptions): Promise<WebhookListResponse>;
+    updateWebhook(endpointId: number, request: UpdateWebhookRequest, options?: ControlPlaneRequestOptions): Promise<Webhook>;
+    deleteWebhook(endpointId: number, options?: ControlPlaneRequestOptions): Promise<void>;
+    testWebhook(endpointId: number, request?: TestWebhookRequest, options?: ControlPlaneRequestOptions): Promise<TestWebhookResponse>;
+    replayWebhookDeliveries(endpointId: number, request?: ReplayWebhookDeliveriesRequest, options?: ControlPlaneRequestOptions): Promise<ReplayWebhookDeliveriesResponse>;
+    listWebhookDeliveries(endpointId: number, query?: WebhookDeliveryQuery, options?: ControlPlaneRequestOptions): Promise<WebhookDeliveryListResponse>;
+}
+
 /**
  * MemorySync SDK — JavaScript / TypeScript client.
  *
@@ -133,33 +545,7 @@ interface ExportResponse {
     memories: Array<Record<string, unknown>>;
     generatedAt: string;
 }
-interface ErrorOpts {
-    statusCode?: number;
-    response?: unknown;
-    requestId?: string;
-}
-declare class MemorySyncError extends Error {
-    readonly statusCode?: number;
-    readonly response?: unknown;
-    readonly requestId?: string;
-    constructor(message: string, opts?: ErrorOpts);
-}
-declare class AuthError extends MemorySyncError {
-    constructor(message: string, opts?: ErrorOpts);
-}
-declare class ValidationError extends MemorySyncError {
-    constructor(message: string, opts?: ErrorOpts);
-}
-declare class NotFoundError extends MemorySyncError {
-    constructor(message: string, opts?: ErrorOpts);
-}
-declare class RateLimitError extends MemorySyncError {
-    readonly retryAfterSeconds: number;
-    constructor(message: string, retryAfterSeconds: number, opts?: ErrorOpts);
-}
-declare class ServerError extends MemorySyncError {
-    constructor(message: string, opts?: ErrorOpts);
-}
+
 declare class MemorySyncClient {
     private readonly apiKey;
     private readonly baseUrl;
@@ -185,4 +571,4 @@ declare class MemorySyncClient {
     createRelation(fromMemoryId: number, req: RelationCreateRequest): Promise<RelationRecord>;
 }
 
-export { type AddRequest, type AddResponse, type AddSkippedResponse, AuthError, type BulkAddItem, type BulkAddItemResult, type BulkAddResponse, type ComposeRequest, type ComposeResponse, type ExportResponse, type MemoryRecord, MemorySyncClient, type MemorySyncConfig, MemorySyncError, NotFoundError, type QueryFilters, type QueryRequest, type QueryResponse, RateLimitError, type RelationCreateRequest, type RelationRecord, type RelationshipType, ServerError, type SummarizeRequest, type UpdateRequest, ValidationError };
+export { type AddRequest, type AddResponse, type AddSkippedResponse, type ApiKeyTestResponse, type ApiKeyTestStatus, type AuditActor, type AuditEvent, type AuditEventListResponse, type AuditEventQuery, type AuditResource, type AuditSortDirection, AuthError, type BulkAddItem, type BulkAddItemResult, type BulkAddResponse, type BulkRevokeApiKeyResult, type BulkRevokeApiKeysRequest, type BulkRevokeApiKeysResponse, type ComposeRequest, type ComposeResponse, ControlPlaneClient, type ControlPlaneConfig, type ControlPlaneRequestOptions, type CreateOrganizationRequest, type CreateWebhookRequest, type CreatedWebhook, type CurrentPlanResponse, type ExportResponse, type Integration, type IntegrationQuery, type LoginRequest, type LoginResponse, type MemoryRecord, MemorySyncClient, type MemorySyncConfig, MemorySyncError, NotFoundError, type OrganizationMembership, type OrganizationSettings, type OrganizationSettingsQuery, type Plan, type PlanLimits, type Project, type QueryFilters, type QueryRequest, type QueryResponse, RateLimitError, type RelationCreateRequest, type RelationRecord, type RelationshipType, type ReplayWebhookDeliveriesRequest, type ReplayWebhookDeliveriesResponse, ServerError, type Session, type SessionListResponse, type SummarizeRequest, type TeamMember, type TestWebhookRequest, type TestWebhookResponse, type UpdateRequest, type UpdateWebhookRequest, ValidationError, type Webhook, type WebhookDelivery, type WebhookDeliveryListResponse, type WebhookDeliveryQuery, type WebhookListResponse, type WebhookRetryConfig, type WebhookSignatureConfig };