@zenning/tool-app-contracts 0.1.0

package/README.md

@@ -0,0 +1,88 @@
+# Zenning Tool App Contracts
+
+Shared Zod contracts for Zenning Tool Apps, ensuring type safety between backend and frontend.
+
+## Installation
+
+Since this is a private GitHub repository, install it as a Git dependency:
+
+```bash
+# Install from main branch
+npm install github:AllTheTables/zenning-tool-app-contracts#main
+
+# OR with pnpm
+pnpm add github:AllTheTables/zenning-tool-app-contracts#main
+```
+
+### Updating
+
+To pull the latest changes:
+
+```bash
+npm update zenning-tool-app-contracts
+# or
+pnpm update zenning-tool-app-contracts
+```
+
+## Usage
+
+Tools are exported as namespaces to keep things tidy.
+
+```typescript
+import { VisualiseDataTables } from 'zenning-tool-app-contracts';
+
+// 1. Use the Schema for runtime validation
+const result = VisualiseDataTables.Schema.safeParse(data);
+
+if (result.success) {
+  // 2. Use the Contract type for TypeScript definitions
+  const myData: VisualiseDataTables.Contract = result.data;
+  console.log(myData.toolId);
+}
+```
+
+## Available Tools
+
+- `VisualiseDataTables` - Data visualisation tool for tabular data
+
+## Adding a New Tool
+
+1. Create a new folder in `src/tools/<tool-name>/`
+2. Create `schema.ts` extending `BaseToolSchema`:
+   ```typescript
+   // src/tools/my-tool/schema.ts
+   import { z } from 'zod';
+   import { BaseToolSchema } from '../../base';
+
+   export const MyToolSchema = BaseToolSchema.extend({
+     toolId: z.literal('my-tool-id'),
+     // ... custom fields
+   });
+   ```
+3. Create `types.ts` for inferred types:
+   ```typescript
+   // src/tools/my-tool/types.ts
+   import { z } from 'zod';
+   import { MyToolSchema } from './schema';
+
+   export type MyTool = z.infer<typeof MyToolSchema>;
+   ```
+4. Create `index.ts` to export and alias them:
+   ```typescript
+   // src/tools/my-tool/index.ts
+   import { MyToolSchema } from './schema';
+   import { MyTool } from './types';
+
+   export * from './schema';
+   export * from './types';
+
+   // Standard aliases
+   export { MyToolSchema as Schema };
+   export type { MyTool as Contract };
+   ```
+5. Add to `src/tools/index.ts`:
+   ```typescript
+   export * as MyTool from './my-tool';
+   ```
+6. Run `npm run build` to verify
+7. Commit and push your changes

package/dist/cjs/base.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const BaseToolSchema: z.ZodObject<{
+    toolId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    toolId: string;
+}, {
+    toolId: string;
+}>;
+export type BaseTool = z.infer<typeof BaseToolSchema>;

package/dist/cjs/base.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseToolSchema = void 0;
+const zod_1 = require("zod");
+exports.BaseToolSchema = zod_1.z.object({
+    toolId: zod_1.z.string().describe('The unique human-readable identifier for this tool app'),
+});

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './base';
+export * from './tools';

package/dist/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base"), exports);
+__exportStar(require("./tools"), exports);

package/dist/cjs/tools/index.d.ts

@@ -0,0 +1,2 @@
+export * as VisualiseDataTables from './visualise-data-tables';
+export * as VisualiseSalesforceRecords from './visualise-salesforce-records';

package/dist/cjs/tools/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisualiseSalesforceRecords = exports.VisualiseDataTables = void 0;
+exports.VisualiseDataTables = __importStar(require("./visualise-data-tables"));
+exports.VisualiseSalesforceRecords = __importStar(require("./visualise-salesforce-records"));

package/dist/cjs/tools/visualise-data-tables/index.d.ts

@@ -0,0 +1,6 @@
+import { VisualiseDataTablesSchema } from './schema';
+import { VisualiseDataTables } from './types';
+export * from './schema';
+export * from './types';
+export { VisualiseDataTablesSchema as Schema };
+export type { VisualiseDataTables as Contract };

package/dist/cjs/tools/visualise-data-tables/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = void 0;
+const schema_1 = require("./schema");
+Object.defineProperty(exports, "Schema", { enumerable: true, get: function () { return schema_1.VisualiseDataTablesSchema; } });
+__exportStar(require("./schema"), exports);
+__exportStar(require("./types"), exports);

package/dist/cjs/tools/visualise-data-tables/schema.d.ts

@@ -0,0 +1,67 @@
+import { z } from 'zod';
+export declare const ColumnTypeSchema: z.ZodEnum<["string", "number", "boolean", "date", "datetime"]>;
+export declare const VisualizationTypeSchema: z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>;
+export declare const ColumnSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    type: z.ZodEnum<["string", "number", "boolean", "date", "datetime"]>;
+}, "strip", z.ZodTypeAny, {
+    type: "string" | "number" | "boolean" | "date" | "datetime";
+    key: string;
+    label: string;
+}, {
+    type: "string" | "number" | "boolean" | "date" | "datetime";
+    key: string;
+    label: string;
+}>;
+export declare const VisualiseDataTablesSchema: z.ZodObject<{} & {
+    toolId: z.ZodLiteral<"visualise-data-tables">;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<["string", "number", "boolean", "date", "datetime"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "string" | "number" | "boolean" | "date" | "datetime";
+        key: string;
+        label: string;
+    }, {
+        type: "string" | "number" | "boolean" | "date" | "datetime";
+        key: string;
+        label: string;
+    }>, "many">;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>, "many">;
+    visualizationOptions: z.ZodObject<{
+        default: z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>;
+        allowed: z.ZodArray<z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    }, {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    toolId: "visualise-data-tables";
+    columns: {
+        type: "string" | "number" | "boolean" | "date" | "datetime";
+        key: string;
+        label: string;
+    }[];
+    rows: Record<string, string | number | boolean | null>[];
+    visualizationOptions: {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    };
+}, {
+    toolId: "visualise-data-tables";
+    columns: {
+        type: "string" | "number" | "boolean" | "date" | "datetime";
+        key: string;
+        label: string;
+    }[];
+    rows: Record<string, string | number | boolean | null>[];
+    visualizationOptions: {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    };
+}>;

package/dist/cjs/tools/visualise-data-tables/schema.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisualiseDataTablesSchema = exports.ColumnSchema = exports.VisualizationTypeSchema = exports.ColumnTypeSchema = void 0;
+const zod_1 = require("zod");
+const base_1 = require("../../base");
+exports.ColumnTypeSchema = zod_1.z.enum(['string', 'number', 'boolean', 'date', 'datetime']);
+exports.VisualizationTypeSchema = zod_1.z.enum(['table', 'barChart', 'lineChart', 'areaChart', 'pieChart']);
+exports.ColumnSchema = zod_1.z.object({
+    key: zod_1.z.string(),
+    label: zod_1.z.string(),
+    type: exports.ColumnTypeSchema,
+});
+exports.VisualiseDataTablesSchema = base_1.BaseToolSchema.extend({
+    toolId: zod_1.z.literal('visualise-data-tables'),
+    columns: zod_1.z.array(exports.ColumnSchema),
+    rows: zod_1.z.array(zod_1.z.record(zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean(), zod_1.z.null()]))),
+    visualizationOptions: zod_1.z.object({
+        default: exports.VisualizationTypeSchema,
+        allowed: zod_1.z.array(exports.VisualizationTypeSchema),
+    }),
+});

package/dist/cjs/tools/visualise-data-tables/types.d.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+import { ColumnTypeSchema, VisualizationTypeSchema, ColumnSchema, VisualiseDataTablesSchema } from './schema';
+export type ColumnType = z.infer<typeof ColumnTypeSchema>;
+export type VisualizationType = z.infer<typeof VisualizationTypeSchema>;
+export type Column = z.infer<typeof ColumnSchema>;
+export type VisualiseDataTables = z.infer<typeof VisualiseDataTablesSchema>;

package/dist/cjs/tools/visualise-data-tables/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/tools/visualise-salesforce-records/index.d.ts

@@ -0,0 +1,6 @@
+import { VisualiseSalesforceRecordsSchema } from './schema';
+import { VisualiseSalesforceRecords } from './types';
+export * from './schema';
+export * from './types';
+export { VisualiseSalesforceRecordsSchema as Schema };
+export type { VisualiseSalesforceRecords as Contract };

package/dist/cjs/tools/visualise-salesforce-records/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = void 0;
+const schema_1 = require("./schema");
+Object.defineProperty(exports, "Schema", { enumerable: true, get: function () { return schema_1.VisualiseSalesforceRecordsSchema; } });
+__exportStar(require("./schema"), exports);
+__exportStar(require("./types"), exports);

package/dist/cjs/tools/visualise-salesforce-records/schema.d.ts

@@ -0,0 +1,145 @@
+import { z } from 'zod';
+export declare const SalesforceColumnTypeSchema: z.ZodEnum<["string", "number", "boolean", "date", "datetime", "id", "reference"]>;
+export declare const SalesforceVisualizationTypeSchema: z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>;
+export declare const SalesforceColumnSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    type: z.ZodEnum<["string", "number", "boolean", "date", "datetime", "id", "reference"]>;
+    referenceTo: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+    key: string;
+    label: string;
+    referenceTo?: string | undefined;
+}, {
+    type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+    key: string;
+    label: string;
+    referenceTo?: string | undefined;
+}>;
+export declare const SalesforceRecordSchema: z.ZodObject<{
+    _sfId: z.ZodString;
+    _sfType: z.ZodString;
+    _sfUrl: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.objectOutputType<{
+    _sfId: z.ZodString;
+    _sfType: z.ZodString;
+    _sfUrl: z.ZodOptional<z.ZodString>;
+}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">, z.objectInputType<{
+    _sfId: z.ZodString;
+    _sfType: z.ZodString;
+    _sfUrl: z.ZodOptional<z.ZodString>;
+}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">>;
+export declare const QueryInfoSchema: z.ZodObject<{
+    soql: z.ZodString;
+    queryName: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    soql: string;
+    queryName?: string | undefined;
+}, {
+    soql: string;
+    queryName?: string | undefined;
+}>;
+export declare const VisualiseSalesforceRecordsSchema: z.ZodObject<{} & {
+    toolId: z.ZodLiteral<"visualise-salesforce-records">;
+    objectType: z.ZodString;
+    instanceUrl: z.ZodString;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<["string", "number", "boolean", "date", "datetime", "id", "reference"]>;
+        referenceTo: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+        key: string;
+        label: string;
+        referenceTo?: string | undefined;
+    }, {
+        type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+        key: string;
+        label: string;
+        referenceTo?: string | undefined;
+    }>, "many">;
+    records: z.ZodArray<z.ZodObject<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.objectOutputType<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">, z.objectInputType<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">>, "many">;
+    totalSize: z.ZodNumber;
+    queryInfo: z.ZodObject<{
+        soql: z.ZodString;
+        queryName: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        soql: string;
+        queryName?: string | undefined;
+    }, {
+        soql: string;
+        queryName?: string | undefined;
+    }>;
+    visualizationOptions: z.ZodObject<{
+        default: z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>;
+        allowed: z.ZodArray<z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    }, {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    toolId: "visualise-salesforce-records";
+    columns: {
+        type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+        key: string;
+        label: string;
+        referenceTo?: string | undefined;
+    }[];
+    visualizationOptions: {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    };
+    objectType: string;
+    instanceUrl: string;
+    records: z.objectOutputType<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">[];
+    totalSize: number;
+    queryInfo: {
+        soql: string;
+        queryName?: string | undefined;
+    };
+}, {
+    toolId: "visualise-salesforce-records";
+    columns: {
+        type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+        key: string;
+        label: string;
+        referenceTo?: string | undefined;
+    }[];
+    visualizationOptions: {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    };
+    objectType: string;
+    instanceUrl: string;
+    records: z.objectInputType<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">[];
+    totalSize: number;
+    queryInfo: {
+        soql: string;
+        queryName?: string | undefined;
+    };
+}>;

package/dist/cjs/tools/visualise-salesforce-records/schema.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VisualiseSalesforceRecordsSchema = exports.QueryInfoSchema = exports.SalesforceRecordSchema = exports.SalesforceColumnSchema = exports.SalesforceVisualizationTypeSchema = exports.SalesforceColumnTypeSchema = void 0;
+const zod_1 = require("zod");
+const base_1 = require("../../base");
+exports.SalesforceColumnTypeSchema = zod_1.z.enum([
+    'string',
+    'number',
+    'boolean',
+    'date',
+    'datetime',
+    'id',
+    'reference',
+]);
+exports.SalesforceVisualizationTypeSchema = zod_1.z.enum([
+    'table',
+    'barChart',
+    'lineChart',
+    'areaChart',
+    'pieChart',
+]);
+exports.SalesforceColumnSchema = zod_1.z.object({
+    key: zod_1.z.string().describe('Field API name (e.g., "Account.Name")'),
+    label: zod_1.z.string().describe('Display label (e.g., "Account Name")'),
+    type: exports.SalesforceColumnTypeSchema,
+    referenceTo: zod_1.z.string().optional().describe('For reference fields, the target object (e.g., "Account")'),
+});
+exports.SalesforceRecordSchema = zod_1.z
+    .object({
+    _sfId: zod_1.z.string().describe('Salesforce record ID'),
+    _sfType: zod_1.z.string().describe('Salesforce object type (e.g., "Contact")'),
+    _sfUrl: zod_1.z.string().optional().describe('Direct link to Salesforce record'),
+})
+    .catchall(zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean(), zod_1.z.null()]));
+exports.QueryInfoSchema = zod_1.z.object({
+    soql: zod_1.z.string().describe('The SOQL query executed'),
+    queryName: zod_1.z.string().optional().describe('Human-readable query name'),
+});
+exports.VisualiseSalesforceRecordsSchema = base_1.BaseToolSchema.extend({
+    toolId: zod_1.z.literal('visualise-salesforce-records'),
+    objectType: zod_1.z.string().describe('Primary object queried'),
+    instanceUrl: zod_1.z.string().describe('Salesforce instance URL for record links'),
+    columns: zod_1.z.array(exports.SalesforceColumnSchema),
+    records: zod_1.z.array(exports.SalesforceRecordSchema),
+    totalSize: zod_1.z.number(),
+    queryInfo: exports.QueryInfoSchema,
+    visualizationOptions: zod_1.z.object({
+        default: exports.SalesforceVisualizationTypeSchema,
+        allowed: zod_1.z.array(exports.SalesforceVisualizationTypeSchema),
+    }),
+});

package/dist/cjs/tools/visualise-salesforce-records/types.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { SalesforceColumnTypeSchema, SalesforceVisualizationTypeSchema, SalesforceColumnSchema, SalesforceRecordSchema, QueryInfoSchema, VisualiseSalesforceRecordsSchema } from './schema';
+export type SalesforceColumnType = z.infer<typeof SalesforceColumnTypeSchema>;
+export type SalesforceVisualizationType = z.infer<typeof SalesforceVisualizationTypeSchema>;
+export type SalesforceColumn = z.infer<typeof SalesforceColumnSchema>;
+export type SalesforceRecord = z.infer<typeof SalesforceRecordSchema>;
+export type QueryInfo = z.infer<typeof QueryInfoSchema>;
+export type VisualiseSalesforceRecords = z.infer<typeof VisualiseSalesforceRecordsSchema>;

package/dist/cjs/tools/visualise-salesforce-records/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/esm/base.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const BaseToolSchema: z.ZodObject<{
+    toolId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    toolId: string;
+}, {
+    toolId: string;
+}>;
+export type BaseTool = z.infer<typeof BaseToolSchema>;

package/dist/esm/base.js

@@ -0,0 +1,4 @@
+import { z } from 'zod';
+export const BaseToolSchema = z.object({
+    toolId: z.string().describe('The unique human-readable identifier for this tool app'),
+});

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './base';
+export * from './tools';

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export * from './base';
+export * from './tools';

package/dist/esm/tools/index.d.ts

@@ -0,0 +1,2 @@
+export * as VisualiseDataTables from './visualise-data-tables';
+export * as VisualiseSalesforceRecords from './visualise-salesforce-records';

package/dist/esm/tools/index.js

@@ -0,0 +1,2 @@
+export * as VisualiseDataTables from './visualise-data-tables';
+export * as VisualiseSalesforceRecords from './visualise-salesforce-records';

package/dist/esm/tools/visualise-data-tables/index.d.ts

@@ -0,0 +1,6 @@
+import { VisualiseDataTablesSchema } from './schema';
+import { VisualiseDataTables } from './types';
+export * from './schema';
+export * from './types';
+export { VisualiseDataTablesSchema as Schema };
+export type { VisualiseDataTables as Contract };

package/dist/esm/tools/visualise-data-tables/index.js

@@ -0,0 +1,5 @@
+import { VisualiseDataTablesSchema } from './schema';
+export * from './schema';
+export * from './types';
+// Standardised aliases for namespaced usage
+export { VisualiseDataTablesSchema as Schema };

package/dist/esm/tools/visualise-data-tables/schema.d.ts

@@ -0,0 +1,67 @@
+import { z } from 'zod';
+export declare const ColumnTypeSchema: z.ZodEnum<["string", "number", "boolean", "date", "datetime"]>;
+export declare const VisualizationTypeSchema: z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>;
+export declare const ColumnSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    type: z.ZodEnum<["string", "number", "boolean", "date", "datetime"]>;
+}, "strip", z.ZodTypeAny, {
+    type: "string" | "number" | "boolean" | "date" | "datetime";
+    key: string;
+    label: string;
+}, {
+    type: "string" | "number" | "boolean" | "date" | "datetime";
+    key: string;
+    label: string;
+}>;
+export declare const VisualiseDataTablesSchema: z.ZodObject<{} & {
+    toolId: z.ZodLiteral<"visualise-data-tables">;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<["string", "number", "boolean", "date", "datetime"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "string" | "number" | "boolean" | "date" | "datetime";
+        key: string;
+        label: string;
+    }, {
+        type: "string" | "number" | "boolean" | "date" | "datetime";
+        key: string;
+        label: string;
+    }>, "many">;
+    rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>, "many">;
+    visualizationOptions: z.ZodObject<{
+        default: z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>;
+        allowed: z.ZodArray<z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    }, {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    toolId: "visualise-data-tables";
+    columns: {
+        type: "string" | "number" | "boolean" | "date" | "datetime";
+        key: string;
+        label: string;
+    }[];
+    rows: Record<string, string | number | boolean | null>[];
+    visualizationOptions: {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    };
+}, {
+    toolId: "visualise-data-tables";
+    columns: {
+        type: "string" | "number" | "boolean" | "date" | "datetime";
+        key: string;
+        label: string;
+    }[];
+    rows: Record<string, string | number | boolean | null>[];
+    visualizationOptions: {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    };
+}>;

package/dist/esm/tools/visualise-data-tables/schema.js

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { BaseToolSchema } from '../../base';
+export const ColumnTypeSchema = z.enum(['string', 'number', 'boolean', 'date', 'datetime']);
+export const VisualizationTypeSchema = z.enum(['table', 'barChart', 'lineChart', 'areaChart', 'pieChart']);
+export const ColumnSchema = z.object({
+    key: z.string(),
+    label: z.string(),
+    type: ColumnTypeSchema,
+});
+export const VisualiseDataTablesSchema = BaseToolSchema.extend({
+    toolId: z.literal('visualise-data-tables'),
+    columns: z.array(ColumnSchema),
+    rows: z.array(z.record(z.union([z.string(), z.number(), z.boolean(), z.null()]))),
+    visualizationOptions: z.object({
+        default: VisualizationTypeSchema,
+        allowed: z.array(VisualizationTypeSchema),
+    }),
+});

package/dist/esm/tools/visualise-data-tables/types.d.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+import { ColumnTypeSchema, VisualizationTypeSchema, ColumnSchema, VisualiseDataTablesSchema } from './schema';
+export type ColumnType = z.infer<typeof ColumnTypeSchema>;
+export type VisualizationType = z.infer<typeof VisualizationTypeSchema>;
+export type Column = z.infer<typeof ColumnSchema>;
+export type VisualiseDataTables = z.infer<typeof VisualiseDataTablesSchema>;

package/dist/esm/tools/visualise-data-tables/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/tools/visualise-salesforce-records/index.d.ts

@@ -0,0 +1,6 @@
+import { VisualiseSalesforceRecordsSchema } from './schema';
+import { VisualiseSalesforceRecords } from './types';
+export * from './schema';
+export * from './types';
+export { VisualiseSalesforceRecordsSchema as Schema };
+export type { VisualiseSalesforceRecords as Contract };

package/dist/esm/tools/visualise-salesforce-records/index.js

@@ -0,0 +1,5 @@
+import { VisualiseSalesforceRecordsSchema } from './schema';
+export * from './schema';
+export * from './types';
+// Standardised aliases for namespaced usage
+export { VisualiseSalesforceRecordsSchema as Schema };

package/dist/esm/tools/visualise-salesforce-records/schema.d.ts

@@ -0,0 +1,145 @@
+import { z } from 'zod';
+export declare const SalesforceColumnTypeSchema: z.ZodEnum<["string", "number", "boolean", "date", "datetime", "id", "reference"]>;
+export declare const SalesforceVisualizationTypeSchema: z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>;
+export declare const SalesforceColumnSchema: z.ZodObject<{
+    key: z.ZodString;
+    label: z.ZodString;
+    type: z.ZodEnum<["string", "number", "boolean", "date", "datetime", "id", "reference"]>;
+    referenceTo: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+    key: string;
+    label: string;
+    referenceTo?: string | undefined;
+}, {
+    type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+    key: string;
+    label: string;
+    referenceTo?: string | undefined;
+}>;
+export declare const SalesforceRecordSchema: z.ZodObject<{
+    _sfId: z.ZodString;
+    _sfType: z.ZodString;
+    _sfUrl: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.objectOutputType<{
+    _sfId: z.ZodString;
+    _sfType: z.ZodString;
+    _sfUrl: z.ZodOptional<z.ZodString>;
+}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">, z.objectInputType<{
+    _sfId: z.ZodString;
+    _sfType: z.ZodString;
+    _sfUrl: z.ZodOptional<z.ZodString>;
+}, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">>;
+export declare const QueryInfoSchema: z.ZodObject<{
+    soql: z.ZodString;
+    queryName: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    soql: string;
+    queryName?: string | undefined;
+}, {
+    soql: string;
+    queryName?: string | undefined;
+}>;
+export declare const VisualiseSalesforceRecordsSchema: z.ZodObject<{} & {
+    toolId: z.ZodLiteral<"visualise-salesforce-records">;
+    objectType: z.ZodString;
+    instanceUrl: z.ZodString;
+    columns: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        label: z.ZodString;
+        type: z.ZodEnum<["string", "number", "boolean", "date", "datetime", "id", "reference"]>;
+        referenceTo: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+        key: string;
+        label: string;
+        referenceTo?: string | undefined;
+    }, {
+        type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+        key: string;
+        label: string;
+        referenceTo?: string | undefined;
+    }>, "many">;
+    records: z.ZodArray<z.ZodObject<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.objectOutputType<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">, z.objectInputType<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">>, "many">;
+    totalSize: z.ZodNumber;
+    queryInfo: z.ZodObject<{
+        soql: z.ZodString;
+        queryName: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        soql: string;
+        queryName?: string | undefined;
+    }, {
+        soql: string;
+        queryName?: string | undefined;
+    }>;
+    visualizationOptions: z.ZodObject<{
+        default: z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>;
+        allowed: z.ZodArray<z.ZodEnum<["table", "barChart", "lineChart", "areaChart", "pieChart"]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    }, {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    }>;
+}, "strip", z.ZodTypeAny, {
+    toolId: "visualise-salesforce-records";
+    columns: {
+        type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+        key: string;
+        label: string;
+        referenceTo?: string | undefined;
+    }[];
+    visualizationOptions: {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    };
+    objectType: string;
+    instanceUrl: string;
+    records: z.objectOutputType<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">[];
+    totalSize: number;
+    queryInfo: {
+        soql: string;
+        queryName?: string | undefined;
+    };
+}, {
+    toolId: "visualise-salesforce-records";
+    columns: {
+        type: "string" | "number" | "boolean" | "date" | "datetime" | "id" | "reference";
+        key: string;
+        label: string;
+        referenceTo?: string | undefined;
+    }[];
+    visualizationOptions: {
+        default: "table" | "barChart" | "lineChart" | "areaChart" | "pieChart";
+        allowed: ("table" | "barChart" | "lineChart" | "areaChart" | "pieChart")[];
+    };
+    objectType: string;
+    instanceUrl: string;
+    records: z.objectInputType<{
+        _sfId: z.ZodString;
+        _sfType: z.ZodString;
+        _sfUrl: z.ZodOptional<z.ZodString>;
+    }, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "strip">[];
+    totalSize: number;
+    queryInfo: {
+        soql: string;
+        queryName?: string | undefined;
+    };
+}>;

package/dist/esm/tools/visualise-salesforce-records/schema.js

@@ -0,0 +1,48 @@
+import { z } from 'zod';
+import { BaseToolSchema } from '../../base';
+export const SalesforceColumnTypeSchema = z.enum([
+    'string',
+    'number',
+    'boolean',
+    'date',
+    'datetime',
+    'id',
+    'reference',
+]);
+export const SalesforceVisualizationTypeSchema = z.enum([
+    'table',
+    'barChart',
+    'lineChart',
+    'areaChart',
+    'pieChart',
+]);
+export const SalesforceColumnSchema = z.object({
+    key: z.string().describe('Field API name (e.g., "Account.Name")'),
+    label: z.string().describe('Display label (e.g., "Account Name")'),
+    type: SalesforceColumnTypeSchema,
+    referenceTo: z.string().optional().describe('For reference fields, the target object (e.g., "Account")'),
+});
+export const SalesforceRecordSchema = z
+    .object({
+    _sfId: z.string().describe('Salesforce record ID'),
+    _sfType: z.string().describe('Salesforce object type (e.g., "Contact")'),
+    _sfUrl: z.string().optional().describe('Direct link to Salesforce record'),
+})
+    .catchall(z.union([z.string(), z.number(), z.boolean(), z.null()]));
+export const QueryInfoSchema = z.object({
+    soql: z.string().describe('The SOQL query executed'),
+    queryName: z.string().optional().describe('Human-readable query name'),
+});
+export const VisualiseSalesforceRecordsSchema = BaseToolSchema.extend({
+    toolId: z.literal('visualise-salesforce-records'),
+    objectType: z.string().describe('Primary object queried'),
+    instanceUrl: z.string().describe('Salesforce instance URL for record links'),
+    columns: z.array(SalesforceColumnSchema),
+    records: z.array(SalesforceRecordSchema),
+    totalSize: z.number(),
+    queryInfo: QueryInfoSchema,
+    visualizationOptions: z.object({
+        default: SalesforceVisualizationTypeSchema,
+        allowed: z.array(SalesforceVisualizationTypeSchema),
+    }),
+});

package/dist/esm/tools/visualise-salesforce-records/types.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { SalesforceColumnTypeSchema, SalesforceVisualizationTypeSchema, SalesforceColumnSchema, SalesforceRecordSchema, QueryInfoSchema, VisualiseSalesforceRecordsSchema } from './schema';
+export type SalesforceColumnType = z.infer<typeof SalesforceColumnTypeSchema>;
+export type SalesforceVisualizationType = z.infer<typeof SalesforceVisualizationTypeSchema>;
+export type SalesforceColumn = z.infer<typeof SalesforceColumnSchema>;
+export type SalesforceRecord = z.infer<typeof SalesforceRecordSchema>;
+export type QueryInfo = z.infer<typeof QueryInfoSchema>;
+export type VisualiseSalesforceRecords = z.infer<typeof VisualiseSalesforceRecordsSchema>;

package/dist/esm/tools/visualise-salesforce-records/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@zenning/tool-app-contracts",
+  "version": "0.1.0",
+  "description": "Shared Zod contracts for Zenning Tool Apps",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/cjs/index.d.ts"
+    }
+  },
+  "keywords": [
+    "zenning",
+    "contracts",
+    "zod"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "typescript": "^5.3.3",
+    "vitest": "^4.0.14"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.json && tsc -p tsconfig.esm.json",
+    "test": "vitest run"
+  }
+}