@takeshape/schema 11.70.2 → 11.71.2

package/dist/project-schema/v3.54.0.js

@@ -0,0 +1,7 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export {};

package/dist/refs.d.ts

@@ -224,3 +224,13 @@ export type QueryEntry = {
 export declare function getQuery(projectSchema: Pick<ProjectSchemaJSON, 'services' | 'shapes' | 'queries' | 'mutations'>, queryRef: string): Maybe<QueryEntry>;
 export declare function ensureQuery(projectSchema: ProjectSchemaJSON, queryRef: string): QueryEntry;
 export declare function normalizeRefs(projectSchema: ProjectSchemaJSON, property: PropertySchema): PropertySchema;
+/**
+ * Get a ShapeJSON from a RefItem, with the schema dereferenced.
+ */
+export declare function getReferencedShape(projectSchema: ProjectSchemaJSON, refItem: PropertyRefItem, namespace?: string): (ShapeJSON & {
+    schema: PropertySchema;
+}) | undefined;
+/**
+ * Get a PropertySchema from a RefItem.
+ */
+export declare function getReferencedShapeProperty(projectSchema: ProjectSchemaJSON, refItem: PropertyRefItem, namespace?: string): PropertySchema | undefined;

package/dist/refs.js

@@ -10,6 +10,7 @@ import { getServiceNamespaces } from "./services/util.js";
 import { getRefType, isAllOfSchema, isExtendsSchema, isObjectSchema, isOneOfSchema, isRefSchema, isRefSchemaLegacy } from "./types/index.js";
 import { getToolRef } from "./util/ai-tools.js";
 import { mergeDeepObjectSchemas, mergeObjectSchemas } from "./util/merge.js";
+import { getShape } from "./util/shapes.js";
 /**
  * Guard for RefItemWithPath. Tests for presence of all required props.
  */
@@ -440,8 +441,11 @@ export function dereferenceObjectSchema(context, shapeOrFieldSchema, schemaPath
     }
     return schema;
 }
+function getNamespace(context, serviceId) {
+    return context.services?.[serviceId]?.namespace;
+}
 export function createGetNamespace(context) {
-    return (serviceId) => context.services?.[serviceId]?.namespace;
+    return (serviceId) => getNamespace(context, serviceId);
 }
 export function parsePropertyRef(refStr) {
     const [serviceId, coordinate] = splitAtRef(refStr);
@@ -606,3 +610,24 @@ export function normalizeRefs(projectSchema, property) {
     }
     return updatedProperty;
 }
+/**
+ * Get a ShapeJSON from a RefItem, with the schema dereferenced.
+ */
+export function getReferencedShape(projectSchema, refItem, namespace) {
+    const shape = getShape(projectSchema, applyNamespace(namespace ?? getNamespace(projectSchema, refItem.serviceId), refItem.shapeName));
+    if (shape) {
+        return {
+            ...shape,
+            schema: dereferenceSchema(projectSchema, shape.schema, ['shapes', shape.name])
+        };
+    }
+}
+/**
+ * Get a PropertySchema from a RefItem.
+ */
+export function getReferencedShapeProperty(projectSchema, refItem, namespace) {
+    const shape = getReferencedShape(projectSchema, refItem, namespace ?? getNamespace(projectSchema, refItem.serviceId));
+    if (shape && isObjectSchema(shape.schema)) {
+        return shape.schema.properties[refItem.propertyName];
+    }
+}

package/dist/resolvers/ai/__tests__/rag-query.test.d.ts

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

package/dist/resolvers/ai/__tests__/rag-query.test.js

@@ -0,0 +1,49 @@
+import { describe, expect, it } from 'vitest';
+import { validateRagQueryArgs } from "../rag-query.js";
+describe('validateRagQueryArgs', () => {
+    it('should validate correct arguments', () => {
+        const validArgs = {
+            text: 'search text',
+            size: 10,
+            from: 0,
+            sort: [
+                { field: 'fieldName', order: 'asc' },
+                { field: 'anotherField', order: 'desc' }
+            ]
+        };
+        expect(validateRagQueryArgs(validArgs)).toEqual(true);
+    });
+    it('should be false for missing required "text" field', () => {
+        const invalidArgs = {
+            size: 10
+        };
+        expect(validateRagQueryArgs(invalidArgs)).toEqual(false);
+        expect(validateRagQueryArgs?.errors?.[0].message).toEqual(`must have required property 'text'`);
+    });
+    it('should be false for invalid "size" value', () => {
+        const invalidArgs = {
+            text: 'search text',
+            size: 100 // exceeds the maximum of 50
+        };
+        expect(validateRagQueryArgs(invalidArgs)).toEqual(false);
+        expect(validateRagQueryArgs?.errors?.[0].message).toEqual(`must be <= 50`);
+    });
+    it('should be false for invalid "sort" structure', () => {
+        const invalidArgs = {
+            text: 'search text',
+            sort: [
+                { field: 'fieldName' } // missing "order"
+            ]
+        };
+        expect(validateRagQueryArgs(invalidArgs)).toEqual(false);
+        expect(validateRagQueryArgs?.errors?.[0].message).toEqual(`must have required property 'order'`);
+    });
+    it('should be false for additional properties', () => {
+        const invalidArgs = {
+            text: 'search text',
+            extraField: 'not allowed'
+        };
+        expect(validateRagQueryArgs(invalidArgs)).toEqual(false);
+        expect(validateRagQueryArgs?.errors?.[0].message).toEqual(`must NOT have additional properties`);
+    });
+});

package/dist/resolvers/ai/rag-query.d.ts

@@ -0,0 +1,49 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const ragQueryArgsSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly text: {
+            readonly type: "string";
+            readonly description: "The text to search for in the documents.";
+        };
+        readonly size: {
+            readonly type: "integer";
+            readonly maximum: 50;
+            readonly description: "The maximum number of results to return.";
+        };
+        readonly from: {
+            readonly type: "integer";
+            readonly description: "A number of results to skip before starting to collect the result set. This is useful for pagination.";
+        };
+        readonly sort: {
+            readonly type: "array";
+            readonly description: "The fields to sort the results by.";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly field: {
+                        readonly type: "string";
+                    };
+                    readonly order: {
+                        readonly type: "string";
+                        readonly enum: ["asc", "desc"];
+                    };
+                };
+                readonly required: ["field", "order"];
+                readonly additionalProperties: false;
+            };
+        };
+    };
+    readonly required: ["text"];
+    readonly additionalProperties: false;
+};
+export type RagQueryArgs = FromSchema<typeof ragQueryArgsSchema>;
+export declare const validateRagQueryArgs: import("ajv").ValidateFunction<{
+    sort?: {
+        field: string;
+        order: "asc" | "desc";
+    }[] | undefined;
+    size?: number | undefined;
+    from?: number | undefined;
+    text: string;
+}>;

package/dist/resolvers/ai/rag-query.js

@@ -0,0 +1,40 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+export const ragQueryArgsSchema = {
+    type: 'object',
+    properties: {
+        text: {
+            type: 'string',
+            description: 'The text to search for in the documents.'
+        },
+        size: {
+            type: 'integer',
+            maximum: 50,
+            description: 'The maximum number of results to return.'
+        },
+        from: {
+            type: 'integer',
+            description: 'A number of results to skip before starting to collect the result set. This is useful for pagination.'
+        },
+        sort: {
+            type: 'array',
+            description: 'The fields to sort the results by.',
+            items: {
+                type: 'object',
+                properties: {
+                    field: {
+                        type: 'string'
+                    },
+                    order: {
+                        type: 'string',
+                        enum: ['asc', 'desc']
+                    }
+                },
+                required: ['field', 'order'],
+                additionalProperties: false
+            }
+        }
+    },
+    required: ['text'],
+    additionalProperties: false
+};
+export const validateRagQueryArgs = createTypedValidator(ragQueryArgsSchema, { useDefaults: true });

package/dist/schemas/index.d.ts

@@ -1,4 +1,4 @@
-export declare const CURRENT_SCHEMA_VERSION = "3.53.0";
+export declare const CURRENT_SCHEMA_VERSION = "3.54.0";
 export { default as anyProjectSchema } from './project-schema.json';
-export { default as latestSchemaJson } from './project-schema/v3.53.0.json';
+export { default as latestSchemaJson } from './project-schema/v3.54.0.json';
 export declare const allProjectSchemas: any[];

package/dist/schemas/index.js

@@ -1,7 +1,7 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.53.0';
+export const CURRENT_SCHEMA_VERSION = '3.54.0';
 export { default as anyProjectSchema } from './project-schema.json' with { type: 'json' };
-export { default as latestSchemaJson } from './project-schema/v3.53.0.json' with { type: 'json' };
+export { default as latestSchemaJson } from './project-schema/v3.54.0.json' with { type: 'json' };
 import experimentalSchemaJson from './project-schema/experimental.json' with { type: 'json' };
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json' with { type: 'json' };
 import projectSchemaV1_0_0 from './project-schema/v1.0.0.json' with { type: 'json' };
@@ -77,6 +77,7 @@ import projectSchemaV3_50_0 from './project-schema/v3.50.0.json' with { type: 'j
 import projectSchemaV3_51_0 from './project-schema/v3.51.0.json' with { type: 'json' };
 import projectSchemaV3_52_0 from './project-schema/v3.52.0.json' with { type: 'json' };
 import projectSchemaV3_53_0 from './project-schema/v3.53.0.json' with { type: 'json' };
+import projectSchemaV3_54_0 from './project-schema/v3.54.0.json' with { type: 'json' };
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json' with { type: 'json' };
 export const allProjectSchemas = [
     experimentalSchemaJson,
@@ -154,5 +155,6 @@ export const allProjectSchemas = [
     projectSchemaV3_51_0,
     projectSchemaV3_52_0,
     projectSchemaV3_53_0,
+    projectSchemaV3_54_0,
     projectSchemaV4_0_0
 ];

package/dist/schemas/project-schema/latest.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://schema.takeshape.io/project-schema/v3.53.0#",
+  "$id": "https://schema.takeshape.io/project-schema/v3.54.0#",
   "title": "Project Schema JSON",
   "definitions": {
     "schemaArray": {
@@ -926,6 +926,9 @@
         {
           "$ref": "#/definitions/aiEmbeddingResolver"
         },
+        {
+          "$ref": "#/definitions/aiEmbeddingSearchResolver"
+        },
         {
           "$ref": "#/definitions/aiParseFileResolver"
         },
@@ -1737,6 +1740,39 @@
       "required": ["name", "service", "model"],
       "additionalProperties": false
     },
+    "aiEmbeddingSearchResolver": {
+      "title": "AIEmbeddingSearchResolver",
+      "type": "object",
+      "properties": {
+        "if": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string",
+          "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
+        },
+        "name": {
+          "title": "AI Resolver Name",
+          "type": "string",
+          "description": "Name of the resolver function.",
+          "enum": ["ai:embeddingSearch"]
+        },
+        "vectorProperty": {
+          "type": "string",
+          "description": "A vector property ref to use for the query."
+        },
+        "args": {
+          "description": "Mapping and serialization configuration for prompt context.",
+          "$ref": "#/definitions/parameterConfigForJson"
+        },
+        "results": {
+          "description": "Mapping configuration for the results of this resolver step.",
+          "$ref": "#/definitions/parameterConfigForJson"
+        }
+      },
+      "required": ["name", "vectorProperty"],
+      "additionalProperties": false
+    },
     "aiParseFileResolverOptions": {
       "title": "AIParseFileResolverOptions",
       "type": "object"
@@ -3403,7 +3439,7 @@
     },
     "schemaVersion": {
       "type": "string",
-      "enum": ["3.53.0"],
+      "enum": ["3.54.0"],
       "description": "The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format."
     },
     "projectId": {