@opengeni/contracts 0.26.1 → 0.27.0

package/src/artifacts.ts

@@ -0,0 +1,171 @@
+import { z } from "zod";
+
+export const WORKSPACE_ARTIFACT_HTML_MAX_UTF8_BYTES = 512 * 1024;
+export const WORKSPACE_ARTIFACT_TITLE_MAX_CHARS = 120;
+export const WORKSPACE_ARTIFACT_DESCRIPTION_MAX_CHARS = 2_000;
+export const WORKSPACE_ARTIFACT_LIST_MAX = 100;
+export const WORKSPACE_ARTIFACT_LIST_DEFAULT = 50;
+export const WORKSPACE_ARTIFACT_CURSOR_MAX_CHARS = 512;
+
+const encoder = new TextEncoder();
+const sha256 = z.string().regex(/^[0-9a-f]{64}$/);
+
+export const WorkspaceArtifactSlug = z
+  .string()
+  .trim()
+  .min(1)
+  .max(96)
+  .regex(/^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/);
+export type WorkspaceArtifactSlug = z.infer<typeof WorkspaceArtifactSlug>;
+
+export const WorkspaceArtifactStatus = z.enum(["active", "archived"]);
+export type WorkspaceArtifactStatus = z.infer<typeof WorkspaceArtifactStatus>;
+
+export const WorkspaceArtifactVersion = z.object({
+  id: z.string().uuid(),
+  accountId: z.string().uuid(),
+  workspaceId: z.string().uuid(),
+  artifactId: z.string().uuid(),
+  revision: z.number().int().positive(),
+  contentType: z.literal("text/html"),
+  contentSha256: sha256,
+  sizeBytes: z.number().int().positive().max(WORKSPACE_ARTIFACT_HTML_MAX_UTF8_BYTES),
+  sourceSessionId: z.string().uuid().nullable(),
+  sourceTurnId: z.string().uuid().nullable(),
+  sourceAttemptId: z.string().uuid().nullable(),
+  sourceExecutionGeneration: z.number().int().positive().nullable(),
+  createdBySubjectId: z.string().min(1).max(1024),
+  createdAt: z.string().datetime({ offset: true }),
+});
+export type WorkspaceArtifactVersion = z.infer<typeof WorkspaceArtifactVersion>;
+
+export const WorkspaceArtifact = z.object({
+  id: z.string().uuid(),
+  accountId: z.string().uuid(),
+  workspaceId: z.string().uuid(),
+  slug: WorkspaceArtifactSlug,
+  title: z.string().trim().min(1).max(WORKSPACE_ARTIFACT_TITLE_MAX_CHARS),
+  description: z.string().max(WORKSPACE_ARTIFACT_DESCRIPTION_MAX_CHARS).nullable(),
+  status: WorkspaceArtifactStatus,
+  currentVersion: WorkspaceArtifactVersion.nullable(),
+  createdBySubjectId: z.string().min(1).max(1024),
+  createdAt: z.string().datetime({ offset: true }),
+  updatedAt: z.string().datetime({ offset: true }),
+});
+export type WorkspaceArtifact = z.infer<typeof WorkspaceArtifact>;
+
+export const WorkspaceArtifactEventType = z.enum(["published", "rolled_back"]);
+export type WorkspaceArtifactEventType = z.infer<typeof WorkspaceArtifactEventType>;
+
+export const WorkspaceArtifactEvent = z.object({
+  id: z.string().uuid(),
+  accountId: z.string().uuid(),
+  workspaceId: z.string().uuid(),
+  artifactId: z.string().uuid(),
+  type: WorkspaceArtifactEventType,
+  fromVersionId: z.string().uuid().nullable(),
+  toVersionId: z.string().uuid(),
+  sourceSessionId: z.string().uuid().nullable(),
+  sourceTurnId: z.string().uuid().nullable(),
+  sourceAttemptId: z.string().uuid().nullable(),
+  sourceExecutionGeneration: z.number().int().positive().nullable(),
+  actorSubjectId: z.string().min(1).max(1024),
+  reason: z.string().min(1).max(4096),
+  createdAt: z.string().datetime({ offset: true }),
+});
+export type WorkspaceArtifactEvent = z.infer<typeof WorkspaceArtifactEvent>;
+
+export const WorkspaceArtifactListQuery = z.object({
+  limit: z.coerce
+    .number()
+    .int()
+    .positive()
+    .max(WORKSPACE_ARTIFACT_LIST_MAX)
+    .default(WORKSPACE_ARTIFACT_LIST_DEFAULT),
+  cursor: z.string().min(1).max(WORKSPACE_ARTIFACT_CURSOR_MAX_CHARS).optional(),
+});
+export type WorkspaceArtifactListQuery = z.infer<typeof WorkspaceArtifactListQuery>;
+
+export const WorkspaceArtifactListResponse = z.object({
+  artifacts: z.array(WorkspaceArtifact).max(WORKSPACE_ARTIFACT_LIST_MAX),
+  nextCursor: z.string().max(WORKSPACE_ARTIFACT_CURSOR_MAX_CHARS).nullable(),
+  truncated: z.boolean(),
+});
+export type WorkspaceArtifactListResponse = z.infer<typeof WorkspaceArtifactListResponse>;
+
+export const WorkspaceArtifactDetailResponse = z.object({
+  artifact: WorkspaceArtifact,
+  versions: z.array(WorkspaceArtifactVersion).max(WORKSPACE_ARTIFACT_LIST_MAX),
+  events: z.array(WorkspaceArtifactEvent).max(WORKSPACE_ARTIFACT_LIST_MAX),
+  versionsTruncated: z.boolean(),
+  eventsTruncated: z.boolean(),
+});
+export type WorkspaceArtifactDetailResponse = z.infer<typeof WorkspaceArtifactDetailResponse>;
+
+export const WorkspaceArtifactHtml = z
+  .string()
+  .min(1)
+  .max(WORKSPACE_ARTIFACT_HTML_MAX_UTF8_BYTES)
+  .superRefine((value, ctx) => {
+    if (encoder.encode(value).byteLength > WORKSPACE_ARTIFACT_HTML_MAX_UTF8_BYTES) {
+      ctx.addIssue({
+        code: "custom",
+        message: `artifact HTML exceeds ${WORKSPACE_ARTIFACT_HTML_MAX_UTF8_BYTES} UTF-8 bytes`,
+      });
+    }
+  });
+
+export const CreateWorkspaceArtifactRequest = z.object({
+  slug: WorkspaceArtifactSlug.optional(),
+  title: z.string().trim().min(1).max(WORKSPACE_ARTIFACT_TITLE_MAX_CHARS),
+  description: z.string().max(WORKSPACE_ARTIFACT_DESCRIPTION_MAX_CHARS).nullable().optional(),
+  html: WorkspaceArtifactHtml,
+  idempotencyKey: z.string().trim().min(1).max(200),
+});
+export type CreateWorkspaceArtifactRequest = z.infer<typeof CreateWorkspaceArtifactRequest>;
+
+export const PublishWorkspaceArtifactVersionRequest = z.object({
+  title: z.string().trim().min(1).max(WORKSPACE_ARTIFACT_TITLE_MAX_CHARS).optional(),
+  description: z.string().max(WORKSPACE_ARTIFACT_DESCRIPTION_MAX_CHARS).nullable().optional(),
+  html: WorkspaceArtifactHtml,
+  expectedCurrentVersionId: z.string().uuid(),
+  idempotencyKey: z.string().trim().min(1).max(200),
+});
+export type PublishWorkspaceArtifactVersionRequest = z.infer<
+  typeof PublishWorkspaceArtifactVersionRequest
+>;
+
+export const RollbackWorkspaceArtifactRequest = z.object({
+  versionId: z.string().uuid(),
+  expectedCurrentVersionId: z.string().uuid(),
+  reason: z.string().trim().min(1).max(4096),
+  idempotencyKey: z.string().trim().min(1).max(200),
+});
+export type RollbackWorkspaceArtifactRequest = z.infer<typeof RollbackWorkspaceArtifactRequest>;
+
+export const WorkspaceArtifactMutationResponse = z.object({
+  artifact: WorkspaceArtifact,
+  version: WorkspaceArtifactVersion,
+  event: WorkspaceArtifactEvent,
+  replayed: z.boolean(),
+});
+export type WorkspaceArtifactMutationResponse = z.infer<typeof WorkspaceArtifactMutationResponse>;
+
+export const WorkspaceArtifactContentResponse = z.object({
+  artifactId: z.string().uuid(),
+  versionId: z.string().uuid(),
+  contentType: z.literal("text/html"),
+  contentSha256: sha256,
+  html: WorkspaceArtifactHtml,
+});
+export type WorkspaceArtifactContentResponse = z.infer<typeof WorkspaceArtifactContentResponse>;
+
+export function normalizeWorkspaceArtifactSlug(value: string): string {
+  return value
+    .normalize("NFKD")
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/^-+|-+$/g, "")
+    .slice(0, 96)
+    .replace(/-+$/g, "");
+}

package/src/index.ts

@@ -8,6 +8,31 @@ import {
 
 export * from "./slack-bot-scopes";
 
+export {
+  CreateWorkspaceArtifactRequest,
+  PublishWorkspaceArtifactVersionRequest,
+  RollbackWorkspaceArtifactRequest,
+  WorkspaceArtifact,
+  WorkspaceArtifactContentResponse,
+  WorkspaceArtifactDetailResponse,
+  WorkspaceArtifactEvent,
+  WorkspaceArtifactEventType,
+  WorkspaceArtifactHtml,
+  WorkspaceArtifactListQuery,
+  WorkspaceArtifactListResponse,
+  WorkspaceArtifactMutationResponse,
+  WorkspaceArtifactSlug,
+  WorkspaceArtifactStatus,
+  WorkspaceArtifactVersion,
+  WORKSPACE_ARTIFACT_CURSOR_MAX_CHARS,
+  WORKSPACE_ARTIFACT_DESCRIPTION_MAX_CHARS,
+  WORKSPACE_ARTIFACT_HTML_MAX_UTF8_BYTES,
+  WORKSPACE_ARTIFACT_LIST_DEFAULT,
+  WORKSPACE_ARTIFACT_LIST_MAX,
+  WORKSPACE_ARTIFACT_TITLE_MAX_CHARS,
+  normalizeWorkspaceArtifactSlug,
+} from "./artifacts";
+
 export {
   SESSION_EVENT_PAYLOAD_MAX_BYTES,
   approximateSessionEventTokens,
@@ -626,6 +651,10 @@ export const Permission = z.enum([
   // super-wildcard over both.
   "rigs:use",
   "rigs:manage",
+  // Workspace-published HTML artifacts. Read permits listing/source retrieval;
+  // publish permits create, version publication, and rollback.
+  "artifacts:read",
+  "artifacts:publish",
 ]);
 export type Permission = z.infer<typeof Permission>;
 
@@ -651,6 +680,8 @@ export const DEFAULT_FIRST_PARTY_MCP_PERMISSIONS = [
   "variable-sets:manage",
   "rigs:use",
   "github:use",
+  "artifacts:read",
+  "artifacts:publish",
 ] as const satisfies readonly Permission[];
 
 /**
@@ -719,6 +750,11 @@ export const FIRST_PARTY_MCP_TOOL_NAMES = [
   "slack_bot_file_content",
   "slack_bot_post_message",
   "slack_bot_delete_message",
+  "artifacts_list",
+  "artifacts_get_source",
+  "artifacts_create",
+  "artifacts_publish",
+  "artifacts_rollback",
 ] as const;
 export const FirstPartyMcpToolName = z.enum(FIRST_PARTY_MCP_TOOL_NAMES);
 export type FirstPartyMcpToolName = z.infer<typeof FirstPartyMcpToolName>;
@@ -9248,7 +9284,7 @@ export type WorkspaceModelCatalogResponse = z.infer<typeof WorkspaceModelCatalog
  * that rollout boundary. Mutating clients send this value in
  * `x-opengeni-api-contract`; the API rejects any other value before routing.
  */
-export const OPENGENI_API_CONTRACT_REVISION = "2026-07-turn-instructions-v1" as const;
+export const OPENGENI_API_CONTRACT_REVISION = "2026-07-workspace-artifacts-v1" as const;
 export const OPENGENI_API_CONTRACT_HEADER = "x-opengeni-api-contract" as const;
 /** Bounded request/response identifier shared by browser, ingress, and API diagnostics. */
 export const OPENGENI_CORRELATION_HEADER = "x-opengeni-correlation-id" as const;

package/src/slack-bot-scopes.ts

@@ -1,8 +1,10 @@
 export const OPENGENI_SLACK_BOT_REQUIRED_SCOPES = [
+  "app_mentions:read",
   "canvases:read",
   "channels:history",
   "channels:read",
   "chat:write",
+  "commands",
   "files:read",
   "groups:history",
   "groups:read",

package/dist/chunk-3B3XEYMN.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/slack-bot-scopes.ts"],"sourcesContent":["export const OPENGENI_SLACK_BOT_REQUIRED_SCOPES = [\n  \"canvases:read\",\n  \"channels:history\",\n  \"channels:read\",\n  \"chat:write\",\n  \"files:read\",\n  \"groups:history\",\n  \"groups:read\",\n  \"im:history\",\n  \"im:read\",\n  \"im:write\",\n  \"mpim:history\",\n  \"mpim:read\",\n  \"users:read\",\n] as const;\n\n/**\n * Optional bot grants that remain inside the shipped bot's read/identity\n * boundary. Every other unrequired scope fails closed, including unknown future\n * Slack scopes, so verification, core routing, and UI eligibility cannot drift.\n */\nexport const OPENGENI_SLACK_BOT_SAFE_OPTIONAL_SCOPES = [\"team:read\"] as const;\n\n/** @deprecated Use evaluateOpenGeniSlackBotScopes; an allowlist is the policy. */\nexport const OPENGENI_SLACK_BOT_FORBIDDEN_SCOPES = [\"channels:join\", \"chat:write.public\"] as const;\n\nexport type OpenGeniSlackBotScopePolicy = {\n  accepted: boolean;\n  missingRequired: string[];\n  unsupported: string[];\n};\n\nfunction isOpenGeniSlackBotScopeAllowed(scope: string): boolean {\n  return (\n    (OPENGENI_SLACK_BOT_REQUIRED_SCOPES as readonly string[]).includes(scope) ||\n    (OPENGENI_SLACK_BOT_SAFE_OPTIONAL_SCOPES as readonly string[]).includes(scope)\n  );\n}\n\nexport function areOpenGeniSlackBotScopesAccepted(grantedScopes: readonly string[]): boolean {\n  return (\n    OPENGENI_SLACK_BOT_REQUIRED_SCOPES.every((scope) => grantedScopes.includes(scope)) &&\n    grantedScopes.every(isOpenGeniSlackBotScopeAllowed)\n  );\n}\n\nexport function evaluateOpenGeniSlackBotScopes(\n  grantedScopes: readonly string[],\n): OpenGeniSlackBotScopePolicy {\n  const granted = new Set(grantedScopes);\n  const missingRequired = OPENGENI_SLACK_BOT_REQUIRED_SCOPES.filter((scope) => !granted.has(scope));\n  const unsupported = [...granted].filter((scope) => !isOpenGeniSlackBotScopeAllowed(scope)).sort();\n  return {\n    accepted: areOpenGeniSlackBotScopesAccepted(grantedScopes),\n    missingRequired,\n    unsupported,\n  };\n}\n"],"mappings":";AAAO,IAAM,qCAAqC;AAAA,EAChD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAOO,IAAM,0CAA0C,CAAC,WAAW;AAG5D,IAAM,sCAAsC,CAAC,iBAAiB,mBAAmB;AAQxF,SAAS,+BAA+B,OAAwB;AAC9D,SACG,mCAAyD,SAAS,KAAK,KACvE,wCAA8D,SAAS,KAAK;AAEjF;AAEO,SAAS,kCAAkC,eAA2C;AAC3F,SACE,mCAAmC,MAAM,CAAC,UAAU,cAAc,SAAS,KAAK,CAAC,KACjF,cAAc,MAAM,8BAA8B;AAEtD;AAEO,SAAS,+BACd,eAC6B;AAC7B,QAAM,UAAU,IAAI,IAAI,aAAa;AACrC,QAAM,kBAAkB,mCAAmC,OAAO,CAAC,UAAU,CAAC,QAAQ,IAAI,KAAK,CAAC;AAChG,QAAM,cAAc,CAAC,GAAG,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,+BAA+B,KAAK,CAAC,EAAE,KAAK;AAChG,SAAO;AAAA,IACL,UAAU,kCAAkC,aAAa;AAAA,IACzD;AAAA,IACA;AAAA,EACF;AACF;","names":[]}