@blekline/contracts 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (15) hide show
  1. package/README.md +6 -0
  2. package/dist/auth.d.ts +2 -1
  3. package/dist/auth.d.ts.map +1 -1
  4. package/dist/auth.js +12 -0
  5. package/dist/enforcement.d.ts +4 -0
  6. package/dist/enforcement.d.ts.map +1 -1
  7. package/dist/enforcement.js +2 -1
  8. package/dist/events.d.ts +4 -0
  9. package/dist/events.d.ts.map +1 -1
  10. package/dist/events.js +2 -1
  11. package/openapi.yaml +1 -1
  12. package/package.json +1 -1
  13. package/src/auth.ts +14 -1
  14. package/src/enforcement.ts +2 -1
  15. package/src/events.ts +2 -1
package/README.md CHANGED
@@ -19,3 +19,9 @@ Machine-readable API spec: [`openapi.yaml`](./openapi.yaml)
19
19
  ```bash
20
20
  pnpm --filter @blekline/contracts build
21
21
  ```
22
+
23
+ ## Docs
24
+
25
+ - [OpenAPI](https://app.blekline.com/docs/api/openapi)
26
+ - [AI Enablement Stack](https://app.blekline.com/docs/introduction/ai-enablement-stack)
27
+ - [Quick start](https://app.blekline.com/docs/introduction/quick-start)
package/dist/auth.d.ts CHANGED
@@ -8,6 +8,7 @@ export declare const BLEKLINE_HEADERS: {
8
8
  readonly modelProvider: "x-blekline-model-provider";
9
9
  readonly modelId: "x-blekline-model-id";
10
10
  };
11
- export type ClientSurface = "cursor" | "claude-desktop" | "codex" | "sdk" | "extension" | "unknown";
11
+ export declare const CLIENT_SURFACES: readonly ["cursor", "claude-desktop", "codex", "continue", "github-copilot", "openhands", "sourcegraph-cody", "sdk", "extension", "unknown"];
12
+ export type ClientSurface = (typeof CLIENT_SURFACES)[number];
12
13
  export type ModelProvider = "anthropic" | "openai" | "google" | "xai" | "cursor" | "unknown";
13
14
  //# sourceMappingURL=auth.d.ts.map
package/dist/auth.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,8EAKxB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAExE,eAAO,MAAM,gBAAgB;;;;;;;CAOnB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,gBAAgB,GAAG,OAAO,GAAG,KAAK,GAAG,WAAW,GAAG,SAAS,CAAC;AAEpG,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAC"}
1
+ {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../src/auth.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,8EAKxB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC;AAExE,eAAO,MAAM,gBAAgB;;;;;;;CAOnB,CAAC;AAEX,eAAO,MAAM,eAAe,8IAWlB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7D,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,CAAC"}
package/dist/auth.js CHANGED
@@ -12,3 +12,15 @@ export const BLEKLINE_HEADERS = {
12
12
  modelProvider: "x-blekline-model-provider",
13
13
  modelId: "x-blekline-model-id",
14
14
  };
15
+ export const CLIENT_SURFACES = [
16
+ "cursor",
17
+ "claude-desktop",
18
+ "codex",
19
+ "continue",
20
+ "github-copilot",
21
+ "openhands",
22
+ "sourcegraph-cody",
23
+ "sdk",
24
+ "extension",
25
+ "unknown",
26
+ ];
package/dist/enforcement.d.ts CHANGED
@@ -8,6 +8,10 @@ export declare const enforceToolCallRequestSchema: z.ZodObject<{
8
8
  cursor: "cursor";
9
9
  "claude-desktop": "claude-desktop";
10
10
  codex: "codex";
11
+ continue: "continue";
12
+ "github-copilot": "github-copilot";
13
+ openhands: "openhands";
14
+ "sourcegraph-cody": "sourcegraph-cody";
11
15
  sdk: "sdk";
12
16
  extension: "extension";
13
17
  unknown: "unknown";
package/dist/enforcement.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"enforcement.d.ts","sourceRoot":"","sources":["../src/enforcement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;AAE3D,eAAO,MAAM,4BAA4B;;;;;;;;;;;;iBAKvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACpC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"enforcement.d.ts","sourceRoot":"","sources":["../src/enforcement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,CAAC;AAE3D,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;iBAKvC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACpC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
package/dist/enforcement.js CHANGED
@@ -1,7 +1,8 @@
1
1
  import { z } from "zod";
2
+ import { CLIENT_SURFACES } from "./auth.js";
2
3
  export const enforceToolCallRequestSchema = z.object({
3
4
  toolName: z.string().min(1).max(120),
4
5
  arguments: z.record(z.string(), z.unknown()),
5
6
  platform: z.string().max(40).optional(),
6
- clientSurface: z.enum(["cursor", "claude-desktop", "codex", "sdk", "extension", "unknown"]).optional(),
7
+ clientSurface: z.enum(CLIENT_SURFACES).optional(),
7
8
  });
package/dist/events.d.ts CHANGED
@@ -19,6 +19,10 @@ export declare const eventIngestSchema: z.ZodObject<{
19
19
  cursor: "cursor";
20
20
  "claude-desktop": "claude-desktop";
21
21
  codex: "codex";
22
+ continue: "continue";
23
+ "github-copilot": "github-copilot";
24
+ openhands: "openhands";
25
+ "sourcegraph-cody": "sourcegraph-cody";
22
26
  sdk: "sdk";
23
27
  extension: "extension";
24
28
  unknown: "unknown";
package/dist/events.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAc5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}
1
+ {"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAc5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}
package/dist/events.js CHANGED
@@ -1,4 +1,5 @@
1
1
  import { z } from "zod";
2
+ import { CLIENT_SURFACES } from "./auth.js";
2
3
  export const eventIngestSchema = z.object({
3
4
  platform: z.string().max(40).optional(),
4
5
  kind: z.string().max(48).optional(),
@@ -8,7 +9,7 @@ export const eventIngestSchema = z.object({
8
9
  action: z.string().max(48).optional(),
9
10
  maskProvider: z.enum(["azure", "fallback_local"]).optional(),
10
11
  maskPhase: z.string().max(48).optional(),
11
- clientSurface: z.enum(["cursor", "claude-desktop", "codex", "sdk", "extension", "unknown"]).optional(),
12
+ clientSurface: z.enum(CLIENT_SURFACES).optional(),
12
13
  modelProvider: z.enum(["anthropic", "openai", "google", "xai", "cursor", "unknown"]).optional(),
13
14
  modelId: z.string().max(80).optional(),
14
15
  mcpToolName: z.string().max(120).optional(),
package/openapi.yaml CHANGED
@@ -59,7 +59,7 @@ components:
59
59
  type: string
60
60
  clientSurface:
61
61
  type: string
62
- enum: [cursor, claude-desktop, codex, sdk, extension, unknown]
62
+ enum: [cursor, claude-desktop, codex, continue, github-copilot, openhands, sourcegraph-cody, sdk, extension, unknown]
63
63
  EnforceToolCallResult:
64
64
  type: object
65
65
  properties:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blekline/contracts",
3
- "version": "0.1.0",
3
+ "version": "0.3.0",
4
4
  "license": "Apache-2.0",
5
5
  "private": false,
6
6
  "repository": {
package/src/auth.ts CHANGED
@@ -16,6 +16,19 @@ export const BLEKLINE_HEADERS = {
16
16
  modelId: "x-blekline-model-id",
17
17
  } as const;
18
18
 
19
- export type ClientSurface = "cursor" | "claude-desktop" | "codex" | "sdk" | "extension" | "unknown";
19
+ export const CLIENT_SURFACES = [
20
+ "cursor",
21
+ "claude-desktop",
22
+ "codex",
23
+ "continue",
24
+ "github-copilot",
25
+ "openhands",
26
+ "sourcegraph-cody",
27
+ "sdk",
28
+ "extension",
29
+ "unknown",
30
+ ] as const;
31
+
32
+ export type ClientSurface = (typeof CLIENT_SURFACES)[number];
20
33
 
21
34
  export type ModelProvider = "anthropic" | "openai" | "google" | "xai" | "cursor" | "unknown";
package/src/enforcement.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { z } from "zod";
2
+ import { CLIENT_SURFACES } from "./auth.js";
2
3
 
3
4
  export type EnforcementAction = "allow" | "mask" | "block";
4
5
 
@@ -6,7 +7,7 @@ export const enforceToolCallRequestSchema = z.object({
6
7
  toolName: z.string().min(1).max(120),
7
8
  arguments: z.record(z.string(), z.unknown()),
8
9
  platform: z.string().max(40).optional(),
9
- clientSurface: z.enum(["cursor", "claude-desktop", "codex", "sdk", "extension", "unknown"]).optional(),
10
+ clientSurface: z.enum(CLIENT_SURFACES).optional(),
10
11
  });
11
12
 
12
13
  export type EnforceToolCallRequest = z.infer<typeof enforceToolCallRequestSchema>;
package/src/events.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { z } from "zod";
2
+ import { CLIENT_SURFACES } from "./auth.js";
2
3
 
3
4
  export const eventIngestSchema = z.object({
4
5
  platform: z.string().max(40).optional(),
@@ -9,7 +10,7 @@ export const eventIngestSchema = z.object({
9
10
  action: z.string().max(48).optional(),
10
11
  maskProvider: z.enum(["azure", "fallback_local"]).optional(),
11
12
  maskPhase: z.string().max(48).optional(),
12
- clientSurface: z.enum(["cursor", "claude-desktop", "codex", "sdk", "extension", "unknown"]).optional(),
13
+ clientSurface: z.enum(CLIENT_SURFACES).optional(),
13
14
  modelProvider: z.enum(["anthropic", "openai", "google", "xai", "cursor", "unknown"]).optional(),
14
15
  modelId: z.string().max(80).optional(),
15
16
  mcpToolName: z.string().max(120).optional(),