@opengeni/sdk 0.52.1 → 1.0.0

package/src/document-authority-client.ts

@@ -0,0 +1,219 @@
+import type { CompanyBrainOkfDownload, CompanyBrainOkfPackage } from "./company-brain";
+import { OpenGeniClient as OpenGeniCoreClient } from "./client";
+import type {
+  ApiKey,
+  UpdateOrganizationApiKeyRequest,
+  Document,
+  IssueUserResourceGrantRequest,
+  UserResourceGrantMutationResponse,
+  DocumentBase,
+  FileDownloadUrlResponse,
+  DocumentAuthorityReclassification,
+  DocumentDefaultCollectionBackfill,
+  DocumentDefaultCollectionBackfillAudit,
+  GetDocumentDefaultCollectionBackfillAuditOptions,
+  ListDocumentAuthorityReclassificationsOptions,
+  ListDocumentAuthorityReclassificationsResponse,
+  ListDocumentDefaultCollectionBackfillRunsResponse,
+  ListOrganizationDocumentAuthorityReclassificationsResponse,
+  ReclassifyDocumentAuthorityRequest,
+  RunDocumentDefaultCollectionBackfillRequest,
+} from "./types";
+
+/**
+ * Operator-only authority administration and Document tenancy-backfill surface.
+ *
+ * The public root and legacy `core` clients extend this class for compatibility.
+ * Browser consoles that import `@opengeni/sdk/browser` do not retain these
+ * methods or their routes.
+ */
+export class OpenGeniDocumentAuthorityClient extends OpenGeniCoreClient {
+  /** Read organization-key metadata and policy; never returns the secret token. */
+  async getOrganizationApiKey(organizationId: string, apiKeyId: string): Promise<ApiKey> {
+    return await this.requestJson<ApiKey>(
+      "GET",
+      `/v1/organizations/${organizationId}/api-keys/${apiKeyId}`,
+    );
+  }
+
+  /** Update metadata or replace the policy. Policy narrowing applies on the next request. */
+  async updateOrganizationApiKey(
+    organizationId: string,
+    apiKeyId: string,
+    request: UpdateOrganizationApiKeyRequest,
+  ): Promise<ApiKey> {
+    return await this.requestJson<ApiKey>(
+      "PATCH",
+      `/v1/organizations/${organizationId}/api-keys/${apiKeyId}`,
+      request,
+    );
+  }
+
+  /** Issue an exact-session or standing personal-resource grant. */
+  async issueUserResourceGrant(
+    workspaceId: string,
+    authorityId: string,
+    request: IssueUserResourceGrantRequest,
+  ): Promise<UserResourceGrantMutationResponse> {
+    return await this.requestJson<UserResourceGrantMutationResponse>(
+      "POST",
+      `/v1/workspaces/${workspaceId}/user-resource-authorities/${authorityId}/grants`,
+      request,
+    );
+  }
+
+  async listDocumentBases(workspaceId: string): Promise<DocumentBase[]> {
+    return await this.requestJson<DocumentBase[]>(
+      "GET",
+      `/v1/workspaces/${workspaceId}/document-bases`,
+    );
+  }
+
+  /**
+   * List every Document the current human can manage from this workspace,
+   * including portable personal and organization-scoped Documents whose
+   * immutable ingestion workspace is different.
+   */
+  async listAccessibleDocuments(workspaceId: string): Promise<Document[]> {
+    return await this.requestJson<Document[]>("GET", `/v1/workspaces/${workspaceId}/documents`);
+  }
+
+  /** Mint a source-file URL through the Document's effective authority. */
+  async createDocumentOriginalFileDownloadUrl(
+    workspaceId: string,
+    documentId: string,
+  ): Promise<FileDownloadUrlResponse> {
+    return await this.requestJson<FileDownloadUrlResponse>(
+      "POST",
+      `/v1/workspaces/${workspaceId}/documents/${documentId}/original-file/download-url`,
+    );
+  }
+
+  /** Retry indexing for a failed document. */
+  async reindexDocument(
+    workspaceId: string,
+    baseId: string,
+    documentId: string,
+  ): Promise<Document> {
+    return await this.requestJson<Document>(
+      "POST",
+      `/v1/workspaces/${workspaceId}/document-bases/${baseId}/documents/${documentId}/reindex`,
+    );
+  }
+
+  /** Permission-filtered Company Brain package with authorized guidance bodies. */
+  getCompanyBrain(workspaceId: string): Promise<CompanyBrainOkfPackage> {
+    return this.requestJson<CompanyBrainOkfPackage>(
+      "GET",
+      `/v1/workspaces/${workspaceId}/company-brain`,
+    );
+  }
+
+  /** Download the deterministic Markdown/YAML Company Brain package. */
+  async exportCompanyBrainOkf(workspaceId: string): Promise<CompanyBrainOkfDownload> {
+    const response = await this.requestResponse(
+      "GET",
+      `/v1/workspaces/${workspaceId}/company-brain/export`,
+    );
+    const headers = response.headers;
+    return {
+      content: await response.text(),
+      contentType: headers.get("content-type") ?? "text/markdown",
+      filename: headers.get("content-disposition")?.split('"')[1] ?? "company-brain.okf.md",
+    };
+  }
+
+  /**
+   * Atomically reclassify a Document's authority and every indexed chunk.
+   * The operation is replay-safe and rejects a stale expected authority tuple.
+   */
+  async reclassifyDocumentAuthority(
+    workspaceId: string,
+    documentId: string,
+    request: ReclassifyDocumentAuthorityRequest,
+  ): Promise<DocumentAuthorityReclassification> {
+    return await this.requestJson<DocumentAuthorityReclassification>(
+      "POST",
+      `/v1/workspaces/${workspaceId}/documents/${documentId}/authority-reclassifications`,
+      request,
+    );
+  }
+
+  /** List the current actor's durable authority-reclassification receipts. */
+  async listDocumentAuthorityReclassifications(
+    workspaceId: string,
+    documentId: string,
+    options: ListDocumentAuthorityReclassificationsOptions = {},
+  ): Promise<ListDocumentAuthorityReclassificationsResponse> {
+    const params = new URLSearchParams();
+    if (options.limit !== undefined) params.set("limit", String(options.limit));
+    if (options.cursor) params.set("cursor", options.cursor);
+    const query = params.size > 0 ? `?${params.toString()}` : "";
+    return await this.requestJson<ListDocumentAuthorityReclassificationsResponse>(
+      "GET",
+      `/v1/workspaces/${workspaceId}/documents/${documentId}/authority-reclassifications${query}`,
+    );
+  }
+
+  /**
+   * Advance one resumable, organization-scoped Default collection backfill.
+   * Reusing an operation ID is idempotent; keep the run ID across batches.
+   */
+  async runDocumentDefaultCollectionBackfill(
+    workspaceId: string,
+    request: RunDocumentDefaultCollectionBackfillRequest,
+  ): Promise<DocumentDefaultCollectionBackfill> {
+    return await this.requestJson<DocumentDefaultCollectionBackfill>(
+      "POST",
+      `/v1/workspaces/${workspaceId}/document-default-collection-backfills`,
+      request,
+    );
+  }
+
+  /** List organization-scoped Default collection backfill runs (organization admin only). */
+  async listDocumentDefaultCollectionBackfillRuns(
+    workspaceId: string,
+    options: ListDocumentAuthorityReclassificationsOptions = {},
+  ): Promise<ListDocumentDefaultCollectionBackfillRunsResponse> {
+    const params = new URLSearchParams();
+    if (options.limit !== undefined) params.set("limit", String(options.limit));
+    if (options.cursor) params.set("cursor", options.cursor);
+    const query = params.size > 0 ? `?${params.toString()}` : "";
+    return await this.requestJson<ListDocumentDefaultCollectionBackfillRunsResponse>(
+      "GET",
+      `/v1/workspaces/${workspaceId}/document-default-collection-backfills${query}`,
+    );
+  }
+
+  /** Read bounded operation and workspace receipts for one Default-collection backfill run. */
+  async getDocumentDefaultCollectionBackfillAudit(
+    workspaceId: string,
+    runId: string,
+    options: GetDocumentDefaultCollectionBackfillAuditOptions = {},
+  ): Promise<DocumentDefaultCollectionBackfillAudit> {
+    const params = new URLSearchParams();
+    if (options.limit !== undefined) params.set("limit", String(options.limit));
+    if (options.operationCursor) params.set("operationCursor", options.operationCursor);
+    if (options.receiptCursor) params.set("receiptCursor", options.receiptCursor);
+    const query = params.size > 0 ? `?${params.toString()}` : "";
+    return await this.requestJson<DocumentDefaultCollectionBackfillAudit>(
+      "GET",
+      `/v1/workspaces/${workspaceId}/document-default-collection-backfills/${runId}${query}`,
+    );
+  }
+
+  /** List organization-wide Document authority changes (organization admin only). */
+  async listOrganizationDocumentAuthorityReclassifications(
+    workspaceId: string,
+    options: ListDocumentAuthorityReclassificationsOptions = {},
+  ): Promise<ListOrganizationDocumentAuthorityReclassificationsResponse> {
+    const params = new URLSearchParams();
+    if (options.limit !== undefined) params.set("limit", String(options.limit));
+    if (options.cursor) params.set("cursor", options.cursor);
+    const query = params.size > 0 ? `?${params.toString()}` : "";
+    return await this.requestJson<ListOrganizationDocumentAuthorityReclassificationsResponse>(
+      "GET",
+      `/v1/workspaces/${workspaceId}/document-authority-reclassifications${query}`,
+    );
+  }
+}

package/src/document-authority.ts

@@ -0,0 +1,17 @@
+export { OpenGeniDocumentAuthorityClient } from "./document-authority-client";
+export type {
+  DocumentAuthorityReclassification,
+  DocumentDefaultCollectionBackfill,
+  DocumentDefaultCollectionBackfillAudit,
+  DocumentDefaultCollectionBackfillOperationAudit,
+  DocumentDefaultCollectionBackfillReceiptAudit,
+  DocumentDefaultCollectionBackfillRunAudit,
+  GetDocumentDefaultCollectionBackfillAuditOptions,
+  ListDocumentAuthorityReclassificationsOptions,
+  ListDocumentAuthorityReclassificationsResponse,
+  ListDocumentDefaultCollectionBackfillRunsResponse,
+  ListOrganizationDocumentAuthorityReclassificationsResponse,
+  OrganizationDocumentAuthorityReclassification,
+  ReclassifyDocumentAuthorityRequest,
+  RunDocumentDefaultCollectionBackfillRequest,
+} from "./types";

package/src/editable-artifacts/browser-session.ts

@@ -1,6 +1,8 @@
-import { DOCUMENT_ARTIFACT_COMMAND_VERSION } from "@opengeni/contracts/document-artifact-commands";
-import { PRESENTATION_ARTIFACT_COMMAND_VERSION } from "@opengeni/contracts/presentation-artifact-commands";
-import { SPREADSHEET_ARTIFACT_COMMAND_VERSION } from "@opengeni/contracts/spreadsheet-artifact-commands";
+import { EDITABLE_ARTIFACT_LIVE_WIRE_VERSION } from "@opengeni/contracts/editable-artifact-live";
+import {
+  EDITABLE_ARTIFACT_INTENT_PROTOCOL_VERSION,
+  currentEditableArtifactCompatibility,
+} from "@opengeni/contracts/editable-artifacts";
 
 import type { EditableArtifactCacheAuthority } from "./controller";
 import {
@@ -10,6 +12,7 @@ import {
 import { createEditableArtifactSession, type EditableArtifactSession } from "./session";
 import type { EditableArtifactStoragePort } from "./storage";
 import type { EditableArtifactModality } from "./types";
+import type { EditableArtifactOpenFailureReporter } from "./open-failure";
 import {
   createBrowserEditableArtifactWorkerKernel,
   type CreateBrowserEditableArtifactWorkerKernelOptions,
@@ -20,10 +23,11 @@ export type EditableArtifactBrowserRuntime = Omit<
   "modality" | "kernelVersion" | "protocolVersion" | "modelSchemaVersion" | "commandVersion"
 > &
   Readonly<{
-    /** Exact native/WASM build identity admitted by the API. */
+    /** Exact package/executable build identity; the API records but does not compatibility-gate it. */
     kernelVersion: string;
     modelSchemaVersion: number;
-    protocolVersion?: number;
+    /** Exact OGATX001 intent protocol version. */
+    protocolVersion: number;
     commandVersion: number;
   }>;
 
@@ -36,11 +40,21 @@ export type CreateBrowserEditableArtifactSessionOptions = Readonly<{
   runtime: EditableArtifactBrowserRuntime;
   transport?: Omit<
     CreateEditableArtifactHttpLiveTransportOptions,
-    "baseUrl" | "workspaceId" | "protocolVersion" | "kernelVersion" | "modelSchemaVersion"
+    | "baseUrl"
+    | "workspaceId"
+    | "modality"
+    | "liveProtocolVersion"
+    | "kernelVersion"
+    | "modelSchemaVersion"
+    | "snapshotVersion"
+    | "commandProtocolVersion"
+    | "committedTransactionProtocolVersion"
   >;
   storage?: EditableArtifactStoragePort;
   /** Reuse the replica used to create the artifact when opening it immediately. */
   replicaId?: string;
+  /** Receives bounded categories/codes only; never workbook or formula content. */
+  onOpenFailure?: EditableArtifactOpenFailureReporter;
 }>;
 
 /**
@@ -53,17 +67,23 @@ export function createBrowserEditableArtifactSession(
   const baseUrl = canonicalBaseUrl(options.baseUrl);
   const workspaceId = boundedIdentity(options.workspaceId, "workspaceId");
   assertCacheAuthority(options.storageAuthority, baseUrl, workspaceId);
-  const protocolVersion = positiveVersion(options.runtime.protocolVersion ?? 1, "protocolVersion");
+  const protocolVersion = positiveVersion(options.runtime.protocolVersion, "protocolVersion");
+  if (protocolVersion !== EDITABLE_ARTIFACT_INTENT_PROTOCOL_VERSION) {
+    throw new TypeError("protocolVersion is incompatible with the current intent protocol");
+  }
   const modelSchemaVersion = positiveVersion(
     options.runtime.modelSchemaVersion,
     "modelSchemaVersion",
   );
   const kernelVersion = boundedIdentity(options.runtime.kernelVersion, "kernelVersion", 512);
   const commandVersion = positiveVersion(options.runtime.commandVersion, "commandVersion");
-  const expectedCommandVersion = commandVersionFor(options.artifact.modality);
-  if (commandVersion !== expectedCommandVersion) {
+  const current = currentEditableArtifactCompatibility(options.artifact.modality);
+  if (
+    modelSchemaVersion !== current.modelSchemaVersion ||
+    commandVersion !== current.commandProtocolVersion
+  ) {
     throw new TypeError(
-      `commandVersion ${commandVersion} is incompatible with ${options.artifact.modality} ${expectedCommandVersion}`,
+      `runtime versions are incompatible with current ${options.artifact.modality} compatibility`,
     );
   }
   const {
@@ -87,9 +107,13 @@ export function createBrowserEditableArtifactSession(
       ...options.transport,
       baseUrl,
       workspaceId,
-      protocolVersion,
+      modality: options.artifact.modality,
+      liveProtocolVersion: EDITABLE_ARTIFACT_LIVE_WIRE_VERSION,
       kernelVersion,
       modelSchemaVersion,
+      snapshotVersion: current.snapshotVersion,
+      commandProtocolVersion: current.commandProtocolVersion,
+      committedTransactionProtocolVersion: current.committedTransactionProtocolVersion,
     });
     return createEditableArtifactSession({
       artifactId: options.artifact.id,
@@ -102,6 +126,7 @@ export function createBrowserEditableArtifactSession(
       modelSchemaVersion,
       commandVersion,
       protocolVersion,
+      ...(options.onOpenFailure ? { onOpenFailure: options.onOpenFailure } : {}),
       ...(replicaId ? { writerReplicaIdFactory: () => replicaId } : {}),
       ownsWorker: true,
     });
@@ -121,17 +146,6 @@ export function createEditableArtifactReplicaId(): string {
   }
 }
 
-function commandVersionFor(modality: EditableArtifactModality): number {
-  switch (modality) {
-    case "spreadsheet":
-      return SPREADSHEET_ARTIFACT_COMMAND_VERSION;
-    case "document":
-      return DOCUMENT_ARTIFACT_COMMAND_VERSION;
-    case "presentation":
-      return PRESENTATION_ARTIFACT_COMMAND_VERSION;
-  }
-}
-
 function canonicalBaseUrl(value: string | URL): URL {
   const url = new URL(value);
   if (url.username || url.password || url.search || url.hash) {