@optimizely-opal/opal-tools-sdk 0.1.6-dev → 0.1.9-dev

package/dist/block.js

@@ -1,104 +0,0 @@
-"use strict";
-/**
- * Generated by json-schema-to-typescript
- * DO NOT MODIFY - This file is auto-generated from block-document-spec.json
- * Run 'npm run generate:block' to regenerate
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Block = void 0;
-exports.isBlockResponse = isBlockResponse;
-/**
- * Builder namespace for Adaptive Block Document components.
- *
- * Usage:
- *   Block.Document({ children: [...] })
- *   Block.Heading({ children: "Title", level: "2" })
- *   Block.Input({ name: "field_name", placeholder: "Enter..." })
- */
-exports.Block = {
-    Action: (props) => ({
-        $type: "Block.Action",
-        ...props,
-    }),
-    Alert: (props) => ({
-        $type: "Block.Alert",
-        ...props,
-    }),
-    Badge: (props) => ({
-        $type: "Block.Badge",
-        ...props,
-    }),
-    Box: (props) => ({
-        $type: "Block.Box",
-        ...props,
-    }),
-    CancelAction: (props) => ({ $type: "Block.CancelAction", ...props }),
-    Checkbox: (props) => ({
-        $type: "Block.Checkbox",
-        ...props,
-    }),
-    Code: (props) => ({
-        $type: "Block.Code",
-        ...props,
-    }),
-    Document: (props) => ({
-        $type: "Block.Document",
-        ...props,
-    }),
-    Field: (props) => ({
-        $type: "Block.Field",
-        ...props,
-    }),
-    Group: (props) => ({
-        $type: "Block.Group",
-        ...props,
-    }),
-    Heading: (props) => ({
-        $type: "Block.Heading",
-        ...props,
-    }),
-    Input: (props) => ({
-        $type: "Block.Input",
-        ...props,
-    }),
-    Link: (props) => ({
-        $type: "Block.Link",
-        ...props,
-    }),
-    Range: (props) => ({
-        $type: "Block.Range",
-        ...props,
-    }),
-    Select: (props) => ({
-        $type: "Block.Select",
-        ...props,
-    }),
-    Separator: (props) => ({
-        $type: "Block.Separator",
-        ...props,
-    }),
-    Switch: (props) => ({
-        $type: "Block.Switch",
-        ...props,
-    }),
-    Text: (props) => ({
-        $type: "Block.Text",
-        ...props,
-    }),
-    Textarea: (props) => ({
-        $type: "Block.Textarea",
-        ...props,
-    }),
-};
-/**
- * Type guard to check if a value is a BlockResponse.
- */
-function isBlockResponse(value) {
-    return (typeof value === "object" &&
-        value !== null &&
-        ("content" in value ||
-            "data" in value ||
-            "artifact" in value ||
-            "rollback" in value ||
-            "error" in value));
-}

package/scripts/generate-block.ts

@@ -1,167 +0,0 @@
-#!/usr/bin/env ts-node
-/**
- * Generate Adaptive Block Document types from JSON schema.
- *
- * This script uses json-schema-to-typescript to generate TypeScript interfaces
- * from the block-document-spec.json schema. The generated types will replace the
- * manual Block builders once we're ready to switch over.
- *
- * Usage:
- *   npm run generate:block
- */
-
-import type { JSONSchema7 } from "json-schema";
-
-import * as fs from "fs";
-import { compile } from "json-schema-to-typescript";
-import * as path from "path";
-
-/**
- * Generate builder functions and BlockResponse class.
- *
- * The generated TypeScript interfaces are great for validation, but we want to
- * keep the builder API (Block.Document(), etc.) for ease of use.
- */
-function generateBuilderCode(schema: JSONSchema7): string {
-  // Extract all Block components from definitions
-  const blockComponents: Array<{ fullName: string; shortName: string }> = [];
-  const skipTypes = new Set(["BlockElement", "BlockNode"]);
-
-  if (schema.definitions) {
-    for (const componentName of Object.keys(schema.definitions)) {
-      if (componentName.startsWith("Block") && !skipTypes.has(componentName)) {
-        // Extract the short name (e.g., "Document" from "BlockDocument")
-        const shortName = componentName.substring(5); // Remove "Block" prefix
-        blockComponents.push({ fullName: componentName, shortName });
-      }
-    }
-  }
-
-  // Sort components for consistent output
-  blockComponents.sort((a, b) => a.shortName.localeCompare(b.shortName));
-
-  // Generate factory functions that return properly typed objects
-  const builderMethods = blockComponents
-    .map(
-      ({ fullName, shortName }) =>
-        `  ${shortName}: (props: Omit<${fullName}, '$type'>): ${fullName} => ({ $type: 'Block.${shortName}' as const, ...props }),`,
-    )
-    .join("\n");
-
-  return `
-/**
- * Builder namespace for Adaptive Block Document components.
- *
- * Usage:
- *   Block.Document({ children: [...] })
- *   Block.Heading({ children: "Title", level: "2" })
- *   Block.Input({ name: "field_name", placeholder: "Enter..." })
- */
-export const Block = {
-${builderMethods}
-};
-
-/**
- * Response type for Adaptive Block Documents.
- *
- * A Block response is a structured tool return value with up to five optional fields:
- * - content: UI representation (BlockDocument)
- * - data: Extra context for LLM (optional, use only when needed beyond artifact/error)
- * - artifact: Object that was impacted (optional)
- * - rollback: Undo operation (optional)
- * - error: Error information (optional)
- */
-export type BlockResponse = {
-  content?: BlockDocument;
-  data?: Record<string, unknown>;
-  artifact?: {
-    type: string;
-    id: string;
-    data: Record<string, unknown>;
-  };
-  rollback?: {
-    type: 'endpoint' | 'tool';
-    config: Record<string, unknown>;
-    label?: string;
-  };
-  error?: {
-    message: string;
-    code?: string;
-    details?: Record<string, unknown>;
-  };
-};
-
-/**
- * Type guard to check if a value is a BlockResponse.
- */
-export function isBlockResponse(value: unknown): value is BlockResponse {
-  return (
-    typeof value === 'object' &&
-    value !== null &&
-    ('content' in value || 'data' in value || 'artifact' in value || 'rollback' in value || 'error' in value)
-  );
-}
-`;
-}
-
-async function main() {
-  // Paths
-  const scriptDir = __dirname;
-  const sdkRoot = path.join(scriptDir, "..");
-  const schemaFile = path.join(sdkRoot, "..", "block-document-spec.json");
-  const outputFile = path.join(sdkRoot, "src", "block.ts");
-
-  if (!fs.existsSync(schemaFile)) {
-    console.error(`Error: Schema file not found at ${schemaFile}`);
-    process.exit(1);
-  }
-
-  try {
-    // Read the schema
-    const schema = JSON.parse(fs.readFileSync(schemaFile, "utf-8"));
-
-    // Create a new schema that references all definitions to force their generation
-    const schemaWithExports = {
-      ...schema,
-      definitions: schema.definitions,
-      // Export each definition by creating a oneOf at the root
-      oneOf: Object.keys(schema.definitions || {})
-        .filter((key) => key.startsWith("Block"))
-        .map((key) => ({ $ref: `#/definitions/${key}` })),
-    };
-
-    // Generate TypeScript types
-    const ts = await compile(schemaWithExports, "BlockDocumentSchema", {
-      bannerComment: `/**
- * Generated by json-schema-to-typescript
- * DO NOT MODIFY - This file is auto-generated from block-document-spec.json
- * Run 'npm run generate:block' to regenerate
- */`,
-      declareExternallyReferenced: true,
-      strictIndexSignatures: true,
-      style: {
-        semi: true,
-        singleQuote: true,
-      },
-      unknownAny: false,
-      unreachableDefinitions: false,
-    });
-
-    // Post-process to add builder functions and BlockResponse
-    const finalContent = ts + "\n" + generateBuilderCode(schema);
-
-    // Write the output file
-    fs.writeFileSync(outputFile, finalContent, "utf-8");
-
-    console.log(`Generated: ${outputFile}`);
-  } catch (error) {
-    console.error("Error: Generation failed");
-    console.error(error);
-    process.exit(1);
-  }
-}
-
-main().catch((error) => {
-  console.error(error);
-  process.exit(1);
-});