@ogment-ai/cli-contract 0.3.0

package/README.md

@@ -0,0 +1,5 @@
+# @ogment-ai/cli-contract
+
+Shared API schemas/contracts for Ogment CLI and backend integration.
+
+Current exports are under `v1`.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./v1/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+export * from "./v1/index.js";

package/dist/v1/account.d.ts

@@ -0,0 +1,33 @@
+import { z } from "zod";
+export declare const orgServerSchema: z.ZodObject<{
+    description: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    enabled: z.ZodBoolean;
+    name: z.ZodString;
+    path: z.ZodString;
+}, z.core.$strip>;
+export declare const organizationSchema: z.ZodObject<{
+    orgSlug: z.ZodString;
+    servers: z.ZodArray<z.ZodObject<{
+        description: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        enabled: z.ZodBoolean;
+        name: z.ZodString;
+        path: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const accountMeSchema: z.ZodObject<{
+    data: z.ZodObject<{
+        email: z.ZodNullable<z.ZodString>;
+        name: z.ZodNullable<z.ZodString>;
+        orgs: z.ZodArray<z.ZodObject<{
+            orgSlug: z.ZodString;
+            servers: z.ZodArray<z.ZodObject<{
+                description: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+                enabled: z.ZodBoolean;
+                name: z.ZodString;
+                path: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type AccountMeResponse = z.infer<typeof accountMeSchema>;
+//# sourceMappingURL=account.d.ts.map

package/dist/v1/account.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../src/v1/account.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,eAAe;;;;;iBAK1B,CAAC;AAEH,eAAO,MAAM,kBAAkB;;;;;;;;iBAG7B,CAAC;AAEH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;iBAM1B,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC"}

package/dist/v1/account.js

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export const orgServerSchema = z.object({
+    description: z.string().nullable().optional().default(null),
+    enabled: z.boolean(),
+    name: z.string(),
+    path: z.string(),
+});
+export const organizationSchema = z.object({
+    orgSlug: z.string(),
+    servers: z.array(orgServerSchema),
+});
+export const accountMeSchema = z.object({
+    data: z.object({
+        email: z.string().nullable(),
+        name: z.string().nullable(),
+        orgs: z.array(organizationSchema),
+    }),
+});

package/dist/v1/auth.d.ts

@@ -0,0 +1,60 @@
+import { z } from "zod";
+export declare const deviceCodeStartSchema: z.ZodObject<{
+    data: z.ZodObject<{
+        device_code: z.ZodString;
+        expires_in: z.ZodNumber;
+        interval: z.ZodNumber;
+        user_code: z.ZodString;
+        verification_uri: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const deviceTokenApprovedSchema: z.ZodObject<{
+    data: z.ZodObject<{
+        agent_name: z.ZodNullable<z.ZodString>;
+        api_key: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const oauthClientRegistrationSchema: z.ZodObject<{
+    client_id: z.ZodString;
+    client_name: z.ZodString;
+    client_secret: z.ZodOptional<z.ZodString>;
+    redirect_uris: z.ZodArray<z.ZodString>;
+    scope: z.ZodString;
+}, z.core.$strip>;
+export declare const oauthTokenSchema: z.ZodObject<{
+    access_token: z.ZodString;
+    expires_in: z.ZodNumber;
+    scope: z.ZodString;
+    token_type: z.ZodString;
+}, z.core.$strip>;
+export declare const browserAgentCallbackSchema: z.ZodObject<{
+    agent_name: z.ZodOptional<z.ZodString>;
+    exchange_code: z.ZodString;
+}, z.core.$strip>;
+export declare const cliExchangeRequestSchema: z.ZodObject<{
+    exchange_code: z.ZodString;
+}, z.core.$strip>;
+export declare const cliExchangeSuccessSchema: z.ZodObject<{
+    data: z.ZodObject<{
+        apiKey: z.ZodString;
+        name: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const cliExchangeErrorSchema: z.ZodObject<{
+    error: z.ZodEnum<{
+        authorization_pending: "authorization_pending";
+        expired_exchange_code: "expired_exchange_code";
+        internal_error: "internal_error";
+        invalid_exchange_code: "invalid_exchange_code";
+        missing_exchange_code: "missing_exchange_code";
+    }>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type BrowserAgentCallback = z.infer<typeof browserAgentCallbackSchema>;
+export type CliExchangeErrorResponse = z.infer<typeof cliExchangeErrorSchema>;
+export type CliExchangeSuccessResponse = z.infer<typeof cliExchangeSuccessSchema>;
+export type DeviceCodeStartResponse = z.infer<typeof deviceCodeStartSchema>;
+export type DeviceTokenApprovedResponse = z.infer<typeof deviceTokenApprovedSchema>;
+export type OauthClientRegistrationResponse = z.infer<typeof oauthClientRegistrationSchema>;
+export type OauthTokenResponse = z.infer<typeof oauthTokenSchema>;
+//# sourceMappingURL=auth.d.ts.map

package/dist/v1/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/v1/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,eAAO,MAAM,qBAAqB;;;;;;;;iBAQhC,CAAC;AAEH,eAAO,MAAM,yBAAyB;;;;;iBAKpC,CAAC;AAEH,eAAO,MAAM,6BAA6B;;;;;;iBAMxC,CAAC;AAEH,eAAO,MAAM,gBAAgB;;;;;iBAK3B,CAAC;AAEH,eAAO,MAAM,0BAA0B;;;iBAGrC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;iBAEnC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;iBAKnC,CAAC;AAEH,eAAO,MAAM,sBAAsB;;;;;;;;;iBAGjC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAC9E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAC9E,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAC5E,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AACpF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAC5F,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/v1/auth.js

@@ -0,0 +1,47 @@
+import { z } from "zod";
+import { cliExchangeErrorCodeSchema } from "./errors.js";
+export const deviceCodeStartSchema = z.object({
+    data: z.object({
+        device_code: z.string().min(1),
+        expires_in: z.number().int().positive(),
+        interval: z.number().int().positive(),
+        user_code: z.string().min(1),
+        verification_uri: z.string().url(),
+    }),
+});
+export const deviceTokenApprovedSchema = z.object({
+    data: z.object({
+        agent_name: z.string().nullable(),
+        api_key: z.string().min(1),
+    }),
+});
+export const oauthClientRegistrationSchema = z.object({
+    client_id: z.string().min(1),
+    client_name: z.string().min(1),
+    client_secret: z.string().optional(),
+    redirect_uris: z.array(z.string().min(1)),
+    scope: z.string().min(1),
+});
+export const oauthTokenSchema = z.object({
+    access_token: z.string().min(1),
+    expires_in: z.number().int().positive(),
+    scope: z.string().min(1),
+    token_type: z.string().min(1),
+});
+export const browserAgentCallbackSchema = z.object({
+    agent_name: z.string().optional(),
+    exchange_code: z.string().min(1),
+});
+export const cliExchangeRequestSchema = z.object({
+    exchange_code: z.string().min(1),
+});
+export const cliExchangeSuccessSchema = z.object({
+    data: z.object({
+        apiKey: z.string().min(1),
+        name: z.string().min(1),
+    }),
+});
+export const cliExchangeErrorSchema = z.object({
+    error: cliExchangeErrorCodeSchema,
+    message: z.string().optional(),
+});

package/dist/v1/common.d.ts

@@ -0,0 +1,8 @@
+import { z } from "zod";
+export declare const jsonObjectSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export declare const stringErrorEnvelopeSchema: z.ZodObject<{
+    error: z.ZodString;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type StringErrorEnvelope = z.infer<typeof stringErrorEnvelopeSchema>;
+//# sourceMappingURL=common.d.ts.map

package/dist/v1/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/v1/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,gBAAgB,wCAAoC,CAAC;AAElE,eAAO,MAAM,yBAAyB;;;iBAGpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}

package/dist/v1/common.js

@@ -0,0 +1,6 @@
+import { z } from "zod";
+export const jsonObjectSchema = z.record(z.string(), z.unknown());
+export const stringErrorEnvelopeSchema = z.object({
+    error: z.string().min(1),
+    message: z.string().optional(),
+});

package/dist/v1/endpoints.d.ts

@@ -0,0 +1,13 @@
+export declare const cliV1Endpoints: {
+    readonly accountMe: "/api/v1/mcp-auth/me";
+    readonly agentSelect: "/cli/agent-select";
+    readonly cliExchange: "/api/v1/mcp-auth/cli/exchange";
+    readonly cliRevokeSelf: "/api/v1/mcp-auth/cli/revoke-self";
+    readonly deviceCode: "/api/v1/mcp-auth/device/code";
+    readonly deviceToken: "/api/v1/mcp-auth/device/token";
+    readonly oauthAuthorize: "/api/v1/mcp-auth/authorize";
+    readonly oauthRegister: "/api/v1/mcp-auth/register";
+    readonly oauthToken: "/api/v1/mcp-auth/token";
+};
+export type CliV1EndpointName = keyof typeof cliV1Endpoints;
+//# sourceMappingURL=endpoints.d.ts.map

package/dist/v1/endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../src/v1/endpoints.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;;;;;;;CAUjB,CAAC;AAEX,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,cAAc,CAAC"}

package/dist/v1/endpoints.js

@@ -0,0 +1,11 @@
+export const cliV1Endpoints = {
+    accountMe: "/api/v1/mcp-auth/me",
+    agentSelect: "/cli/agent-select",
+    cliExchange: "/api/v1/mcp-auth/cli/exchange",
+    cliRevokeSelf: "/api/v1/mcp-auth/cli/revoke-self",
+    deviceCode: "/api/v1/mcp-auth/device/code",
+    deviceToken: "/api/v1/mcp-auth/device/token",
+    oauthAuthorize: "/api/v1/mcp-auth/authorize",
+    oauthRegister: "/api/v1/mcp-auth/register",
+    oauthToken: "/api/v1/mcp-auth/token",
+};

package/dist/v1/errors.d.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+export declare const cliExchangeErrorCodeSchema: z.ZodEnum<{
+    authorization_pending: "authorization_pending";
+    expired_exchange_code: "expired_exchange_code";
+    internal_error: "internal_error";
+    invalid_exchange_code: "invalid_exchange_code";
+    missing_exchange_code: "missing_exchange_code";
+}>;
+export type CliExchangeErrorCode = z.infer<typeof cliExchangeErrorCodeSchema>;
+//# sourceMappingURL=errors.d.ts.map

package/dist/v1/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/v1/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,0BAA0B;;;;;;EAMrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}

package/dist/v1/errors.js

@@ -0,0 +1,8 @@
+import { z } from "zod";
+export const cliExchangeErrorCodeSchema = z.enum([
+    "authorization_pending",
+    "expired_exchange_code",
+    "internal_error",
+    "invalid_exchange_code",
+    "missing_exchange_code",
+]);

package/dist/v1/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./account.js";
+export * from "./auth.js";
+export * from "./common.js";
+export * from "./endpoints.js";
+export * from "./errors.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/v1/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/v1/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC"}

package/dist/v1/index.js

@@ -0,0 +1,5 @@
+export * from "./account.js";
+export * from "./auth.js";
+export * from "./common.js";
+export * from "./endpoints.js";
+export * from "./errors.js";

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ogment-ai/cli-contract",
+  "version": "0.3.0",
+  "description": "Shared API contracts for Ogment CLI and backend",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./v1": {
+      "types": "./dist/v1/index.d.ts",
+      "default": "./dist/v1/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "node -e \"import { rmSync } from 'node:fs'; rmSync('dist', { recursive: true, force: true });\"",
+    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "check-types": "tsc -p tsconfig.json --noEmit",
+    "lint": "oxlint --type-aware --type-check --tsconfig tsconfig.json src",
+    "lint:fix": "npm run lint -- --fix",
+    "format": "oxfmt --write src test",
+    "format:check": "oxfmt --check src test",
+    "test": "vitest -c vitest.config.ts",
+    "test:run": "vitest run -c vitest.config.ts",
+    "test:coverage": "npm run test:run -- --coverage",
+    "qa": "npm run lint && npm run check-types && npm run test:run",
+    "prepublishOnly": "npm run build"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@types/node": "^22.18.12",
+    "@vitest/coverage-v8": "^4.0.18",
+    "oxfmt": "^0.34.0",
+    "oxlint": "^1.49.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  }
+}