@cueframe/studio-convex 0.1.0

package/dist/index.js

@@ -0,0 +1,298 @@
+// src/errors.ts
+import { StudioError, StudioErrorEnvelope } from "@cueframe/studio-contracts";
+function studioErrorFromConvex(error) {
+  if (error === null || typeof error !== "object" || !("data" in error)) return null;
+  const data = error.data;
+  const direct = StudioError.safeParse(data);
+  if (direct.success) return direct.data;
+  const envelope = StudioErrorEnvelope.safeParse(data);
+  return envelope.success ? envelope.data.error : null;
+}
+var StudioRemoteError = class extends Error {
+  constructor(studioError, options) {
+    super(studioError.message, options);
+    this.studioError = studioError;
+    this.name = "StudioRemoteError";
+    this.code = studioError.code;
+    this.retryable = studioError.retryable;
+    this.details = studioError.details;
+  }
+  studioError;
+  code;
+  retryable;
+  details;
+};
+function normalizeStudioConvexError(error) {
+  const studioError = studioErrorFromConvex(error);
+  return studioError === null ? error : new StudioRemoteError(studioError, { cause: error });
+}
+
+// src/bindings.ts
+import { makeFunctionReference } from "convex/server";
+import {
+  STUDIO_OPERATIONS
+} from "@cueframe/studio-contracts";
+var STUDIO_FUNCTION_PATHS = {
+  compatibility: "studio/v1/compatibility:get",
+  sessionCurrent: "studio/v1/session:current",
+  assistantResolveThread: "studio/v1/assistant:resolveThread",
+  assistantForgetConversation: "studio/v1/assistant:forgetConversation",
+  assistantSend: "studio/v1/assistant:send",
+  assistantMessages: "studio/v1/assistant:messages",
+  projectsList: "studio/v1/projects:list",
+  projectsSnapshot: "studio/v1/projects:snapshot",
+  projectsCreate: "studio/v1/projects:create",
+  projectsUpdate: "studio/v1/projects:update",
+  projectsRemove: "studio/v1/projects:remove",
+  compositionsApply: "studio/v1/compositions:apply",
+  compositionsReplace: "studio/v1/compositions:replace",
+  mediaList: "studio/v1/media:list",
+  mediaRemove: "studio/v1/media:remove",
+  mediaCancelProcessing: "studio/v1/media:cancelProcessing",
+  mediaReprocess: "studio/v1/media:reprocess",
+  mediaListUnderstanding: "studio/v1/media:listUnderstanding",
+  mediaSearch: "studio/v1/media:search",
+  mediaAnalyzeTimeline: "studio/v1/media:analyzeTimeline",
+  mediaFacts: "studio/v1/media:facts",
+  mediaPurchaseFact: "studio/v1/media:purchaseFact",
+  transcriptsList: "studio/v1/transcripts:list",
+  transcriptsGetDownload: "studio/v1/transcripts:getDownload",
+  transcriptsSearch: "studio/v1/transcripts:search",
+  correctionsList: "studio/v1/corrections:list",
+  correctionsSave: "studio/v1/corrections:save",
+  correctionsRemove: "studio/v1/corrections:remove",
+  settingsGetUser: "studio/v1/settings:getUser",
+  settingsUpdateProcessing: "studio/v1/settings:updateProcessing",
+  brandKitsList: "studio/v1/brandKits:list",
+  brandKitsUpsert: "studio/v1/brandKits:upsert",
+  componentsList: "studio/v1/components:list",
+  componentsGetBundles: "studio/v1/components:getBundles",
+  conversationsList: "studio/v1/conversations:list",
+  conversationsGet: "studio/v1/conversations:get",
+  conversationsSave: "studio/v1/conversations:save",
+  conversationsAdopt: "studio/v1/conversations:adopt",
+  conversationsRemove: "studio/v1/conversations:remove",
+  restorePointsList: "studio/v1/restorePoints:listForConversation",
+  restorePointsForget: "studio/v1/restorePoints:forgetForConversation",
+  restorePointsRestore: "studio/v1/restorePoints:restore",
+  rendersList: "studio/v1/renders:list",
+  rendersPresignOutput: "studio/v1/renders:presignOutput",
+  rendersCreate: "studio/v1/renders:create",
+  rendersCancel: "studio/v1/renders:cancel",
+  uploadsBegin: "studio/v1/uploads:begin",
+  uploadsFinalize: "studio/v1/uploads:finalize",
+  templatesList: "studio/v1/templates:list",
+  templatesGet: "studio/v1/templates:get",
+  templatesSave: "studio/v1/templates:save",
+  templatesRemove: "studio/v1/templates:remove",
+  projectResourcesBeginUpload: "studio/v1/projectResources:beginUpload",
+  projectResourcesFinalizeUpload: "studio/v1/projectResources:finalizeUpload",
+  projectResourcesRemove: "studio/v1/projectResources:remove",
+  projectResourcesGetDelivery: "studio/v1/projectResources:getDelivery",
+  resourcesSearch: "studio/v1/resources:search",
+  importsResolveDropbox: "studio/v1/imports:resolveDropbox",
+  importsDropboxFile: "studio/v1/imports:dropboxFile"
+};
+function bind(id) {
+  const definition = STUDIO_OPERATIONS[id];
+  const path = STUDIO_FUNCTION_PATHS[id];
+  const paginated = "paginated" in definition && definition.paginated === true;
+  const parseInput = (value) => definition.input.parse(value);
+  const parseResult = (value) => {
+    if (!paginated) return definition.result.parse(value);
+    const native = value;
+    return definition.result.parse({
+      items: native?.page,
+      nextCursor: native?.isDone ? null : native?.continueCursor,
+      done: native?.isDone
+    });
+  };
+  return {
+    id,
+    path,
+    kind: definition.kind,
+    durable: definition.durable,
+    aggregate: definition.aggregate,
+    revisionPolicy: definition.revisionPolicy,
+    paginated,
+    reference: makeFunctionReference(path),
+    parseInput,
+    encodeInput: (value) => {
+      const parsed = parseInput(value);
+      if (!paginated) return parsed;
+      const page = parsed;
+      const { cursor, limit, ...filters } = page;
+      return {
+        ...filters,
+        paginationOpts: { numItems: limit, cursor: cursor ?? null }
+      };
+    },
+    parseResult,
+    parsePageItems: (value) => {
+      if (!paginated) throw new TypeError(`${id} is not paginated`);
+      const parsed = definition.result.parse({ items: value, nextCursor: null, done: true });
+      return parsed.items;
+    }
+  };
+}
+var studioFunctions = Object.fromEntries(
+  Object.keys(STUDIO_OPERATIONS).map((id) => [id, bind(id)])
+);
+
+// src/compatibility.ts
+import { STUDIO_CONTRACT_VERSION } from "@cueframe/studio-contracts";
+var STUDIO_CLIENT_VERSION = `studio/${import.meta.env?.VITE_APP_VERSION ?? "dev"}`;
+var StudioCompatibilityError = class extends Error {
+  constructor(minimumClientVersion) {
+    super(`This CueFrame build is no longer compatible with the hosted Studio service. Upgrade to ${minimumClientVersion} or later.`);
+    this.minimumClientVersion = minimumClientVersion;
+    this.name = "StudioCompatibilityError";
+  }
+  minimumClientVersion;
+};
+var compatibilityChecks = /* @__PURE__ */ new WeakMap();
+function ensureStudioCompatibility(client, clientVersion = STUDIO_CLIENT_VERSION) {
+  let byVersion = compatibilityChecks.get(client);
+  if (!byVersion) {
+    byVersion = /* @__PURE__ */ new Map();
+    compatibilityChecks.set(client, byVersion);
+  }
+  const cacheKey = `${STUDIO_CONTRACT_VERSION}:${clientVersion}`;
+  const existing = byVersion.get(cacheKey);
+  if (existing) return existing;
+  const check = (async () => {
+    const binding = studioFunctions.compatibility;
+    const input = binding.parseInput({
+      clientVersion,
+      contractVersion: STUDIO_CONTRACT_VERSION
+    });
+    let wire;
+    try {
+      wire = await client.query(binding.reference, input);
+    } catch (error) {
+      throw normalizeStudioConvexError(error);
+    }
+    const result = binding.parseResult(wire);
+    if (!result.compatible) throw new StudioCompatibilityError(result.minimumClientVersion);
+  })();
+  const cached = check.catch((error) => {
+    if (!(error instanceof StudioCompatibilityError)) byVersion?.delete(cacheKey);
+    throw error;
+  });
+  byVersion.set(cacheKey, cached);
+  return cached;
+}
+
+// src/pagination.ts
+import { usePaginatedQuery } from "convex/react";
+function useStudioPaginatedQuery(id, args, options) {
+  const binding = studioFunctions[id];
+  if (!binding.paginated) throw new TypeError(`${id} is not a paginated Studio operation`);
+  const filters = args === "skip" ? "skip" : (() => {
+    const encoded = binding.encodeInput({ ...args, limit: options.initialNumItems });
+    const { paginationOpts: _paginationOpts, ...validated } = encoded;
+    return validated;
+  })();
+  const page = usePaginatedQuery(
+    binding.reference,
+    filters,
+    options
+  );
+  return {
+    ...page,
+    results: binding.parsePageItems(page.results)
+  };
+}
+
+// src/abi.ts
+import { STUDIO_OPERATIONS as STUDIO_OPERATIONS2 } from "@cueframe/studio-contracts";
+var STUDIO_CONVEX_ARTIFACT = Object.freeze({
+  name: "@cueframe/studio-convex",
+  version: "0.1.0",
+  integritySha256: "sha256:e980ed768236d9498c46d7f294537644a395e236e02269d9ef2e1d18cc97a2c7"
+});
+var STUDIO_CONVEX_ABI = Object.freeze({
+  artifact: STUDIO_CONVEX_ARTIFACT,
+  operations: Object.freeze(Object.fromEntries(
+    Object.keys(STUDIO_OPERATIONS2).map((id) => {
+      const operation = STUDIO_OPERATIONS2[id];
+      return [id, Object.freeze({
+        path: STUDIO_FUNCTION_PATHS[id],
+        kind: operation.kind,
+        durable: operation.durable,
+        aggregate: operation.aggregate,
+        revisionPolicy: operation.revisionPolicy,
+        paginated: "paginated" in operation && operation.paginated === true
+      })];
+    })
+  ))
+});
+
+// src/index.ts
+var compatibilityRef = studioFunctions.compatibility.reference;
+var sessionRef = studioFunctions.sessionCurrent.reference;
+var projectListRef = studioFunctions.projectsList.reference;
+var projectSnapshotRef = studioFunctions.projectsSnapshot.reference;
+var createProjectRef = studioFunctions.projectsCreate.reference;
+var updateProjectRef = studioFunctions.projectsUpdate.reference;
+var removeProjectRef = studioFunctions.projectsRemove.reference;
+var applyCompositionRef = studioFunctions.compositionsApply.reference;
+var replaceCompositionRef = studioFunctions.compositionsReplace.reference;
+var parseCompatibilityInput = studioFunctions.compatibility.parseInput;
+var parseCompatibilityResult = studioFunctions.compatibility.parseResult;
+var parseSessionInput = studioFunctions.sessionCurrent.parseInput;
+var parseSessionResult = studioFunctions.sessionCurrent.parseResult;
+var parseProjectListInput = studioFunctions.projectsList.parseInput;
+var parseProjectListResult = studioFunctions.projectsList.parseResult;
+var parseProjectSnapshotInput = studioFunctions.projectsSnapshot.parseInput;
+var parseProjectSnapshotResult = studioFunctions.projectsSnapshot.parseResult;
+var parseCreateProjectInput = studioFunctions.projectsCreate.parseInput;
+var parseCreateProjectResult = studioFunctions.projectsCreate.parseResult;
+var parseUpdateProjectInput = studioFunctions.projectsUpdate.parseInput;
+var parseUpdateProjectResult = studioFunctions.projectsUpdate.parseResult;
+var parseRemoveProjectInput = studioFunctions.projectsRemove.parseInput;
+var parseRemoveProjectResult = studioFunctions.projectsRemove.parseResult;
+var parseApplyCompositionInput = studioFunctions.compositionsApply.parseInput;
+var parseApplyCompositionResult = studioFunctions.compositionsApply.parseResult;
+var parseReplaceCompositionInput = studioFunctions.compositionsReplace.parseInput;
+var parseReplaceCompositionResult = studioFunctions.compositionsReplace.parseResult;
+export {
+  STUDIO_CLIENT_VERSION,
+  STUDIO_CONVEX_ABI,
+  STUDIO_CONVEX_ARTIFACT,
+  STUDIO_FUNCTION_PATHS,
+  StudioCompatibilityError,
+  StudioRemoteError,
+  applyCompositionRef,
+  compatibilityRef,
+  createProjectRef,
+  ensureStudioCompatibility,
+  normalizeStudioConvexError,
+  parseApplyCompositionInput,
+  parseApplyCompositionResult,
+  parseCompatibilityInput,
+  parseCompatibilityResult,
+  parseCreateProjectInput,
+  parseCreateProjectResult,
+  parseProjectListInput,
+  parseProjectListResult,
+  parseProjectSnapshotInput,
+  parseProjectSnapshotResult,
+  parseRemoveProjectInput,
+  parseRemoveProjectResult,
+  parseReplaceCompositionInput,
+  parseReplaceCompositionResult,
+  parseSessionInput,
+  parseSessionResult,
+  parseUpdateProjectInput,
+  parseUpdateProjectResult,
+  projectListRef,
+  projectSnapshotRef,
+  removeProjectRef,
+  replaceCompositionRef,
+  sessionRef,
+  studioErrorFromConvex,
+  studioFunctions,
+  updateProjectRef,
+  useStudioPaginatedQuery
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@cueframe/studio-convex",
+  "version": "0.1.0",
+  "description": "Explicit Convex function references and runtime parsers for hosted CueFrame Studio.",
+  "type": "module",
+  "license": "AGPL-3.0-only",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@cueframe/studio-contracts": "^0.1.0"
+  },
+  "peerDependencies": {
+    "convex": ">=1.42",
+    "react": ">=18"
+  },
+  "devDependencies": {
+    "convex": "^1.42.3",
+    "react": "^19.2.7",
+    "tsup": "^8.3.5",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.2"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cueframe-ai/cueframe.git",
+    "directory": "packages/studio-convex"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean --out-dir dist",
+    "check": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}