syllable-sdk 0.1.0-alpha.27 → 0.1.0-alpha.29

package/test/sdk/contract/custommessages.test.ts

@@ -0,0 +1,109 @@
+import { beforeAll, describe, it, expect, afterAll } from "vitest";
+import { getSDK, generateFake, validateResponse } from "./helper";
+
+let sdk
+let createdMessages = []
+beforeAll(async () => {
+    sdk = await getSDK()
+});
+
+afterAll(async () => {
+    for (const message of createdMessages) {
+        const result = await sdk.customMessages.delete({
+            customMessageId: message.id,
+            reason: 'was a created by a test'
+        })
+    }
+})
+
+describe('Syllable SDK Contract test suite', () => {
+    describe('customMessages', () => {
+        describe('create', () => {
+            it('should create a simple customMessage', async() => {
+                const message = generateFake('customMessage');
+                delete message.rules;
+                const result = await sdk.customMessages.create(message);
+                createdMessages.push(result)
+                expect(validateResponse('customMessage', 'create', result, 200)).to.be.true
+            })
+            it('should create a customMessage with a date rule', async() => {
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const result = await sdk.customMessages.create(message);
+                createdMessages.push(result)
+                expect(validateResponse('customMessage', 'create', result, 200)).to.be.true
+            })
+            it('should create a customMessage with a days_of_week rule', async() => {
+                const message = generateFake('customMessage');
+                delete message.rules[0].date
+                const result = await sdk.customMessages.create(message);
+                createdMessages.push(result)
+                expect(validateResponse('customMessage', 'create', result, 200)).to.be.true
+            })
+            it('should create a customMessage with a date rule and no time_range', async() => {
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                delete message.rules[0].timeRangeEnd
+                delete message.rules[0].timeRangeStart
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const result = await sdk.customMessages.create(message);
+                createdMessages.push(result)
+                expect(validateResponse('customMessage', 'create', result, 200)).to.be.true
+            })
+            it('should create a customMessage with a days_of_week rule and no time_range', async() => {
+                const message = generateFake('customMessage');
+                delete message.rules[0].date
+                delete message.rules[0].timeRangeEnd
+                delete message.rules[0].timeRangeStart
+                const result = await sdk.customMessages.create(message);
+                createdMessages.push(result)
+                expect(validateResponse('customMessage', 'create', result, 200)).to.be.true
+            })
+        })
+        describe('list', () => {
+            it('should list a newly created customMessage', async() => {
+                const message = generateFake('customMessage');
+                delete message.rules;
+                const result = await sdk.customMessages.create(message);
+                createdMessages.push(result)
+                const listResult = await sdk.customMessages.list({
+                    searchFields: ['name'],
+                    searchFieldValues: [message.name]
+                });
+                const isFound = listResult.items.some((cm) => {
+                    return cm.name === message.name
+                })
+                if (!isFound) {
+                    throw new Error('customMessage that was just created is not listed')
+                }
+                expect(validateResponse('customMessage', 'list', listResult, 200)).to.be.true
+            })
+        })
+        describe('update', () => {
+            it('should update a newly created customMessage', async() => {
+                const message = generateFake('customMessage');
+                const rules = message.rules;
+                delete message.rules;
+                const result = await sdk.customMessages.create(message);
+                createdMessages.push(result)
+                message.rules = rules
+                message.id = result.id
+                const updateResult = await sdk.customMessages.update(message);
+                expect(validateResponse('customMessage', 'update', updateResult, 200)).to.be.true
+            })
+        })
+        describe('delete', () => {
+            it('should delete a newly created customMessage', async() => {
+                const message = generateFake('customMessage');
+                delete message.rules;
+                const result = await sdk.customMessages.create(message);
+                const deleteResult = await sdk.customMessages.delete({
+                    customMessageId: result.id,
+                    reason: 'created by a test'
+                });
+                expect(validateResponse('customMessage', 'delete', deleteResult, 200)).to.be.true
+            })
+        })
+    })
+})

package/test/sdk/contract/helper.ts

@@ -0,0 +1,190 @@
+import { SyllableSDK } from "../../../src/index.ts"
+import { randAirportCode, randNumber, randParagraph, randPhrase } from '@ngneat/falso';
+import { camelCase, snakeCase, isArray, transform, isObject, get } from "lodash"
+import Ajv from "ajv";
+import addFormats from "ajv-formats";
+import addErrors from "ajv-errors";
+import { readFileSync } from "fs";
+
+const openApiSpec = JSON.parse(readFileSync(`${__dirname}/../../../openapi.json`, "utf8")) as any;
+const ajv = new Ajv({ allErrors: true, strict: false });
+addFormats(ajv);
+addErrors(ajv);
+ajv.addSchema(openApiSpec, "openapi.json")
+
+export async function getSDK() {
+    const url = process.env['SYLLABLESDK_SERVER_URL'];
+    const key = process.env["SYLLABLESDK_API_KEY_HEADER"];
+    if (!url) {
+        console.log('Please set SYLLABLESDK_SERVER_URL env var');
+    }
+    if (!key) {
+        console.log('Please set SYLLABLESDK_API_KEY_HEADER env var');
+    }
+    const sdk = new SyllableSDK({
+        serverURL: url,
+        apiKeyHeader: key,
+    });
+    await sdk.agents.list({});
+    return sdk
+}
+
+const camelizeObj = obj => transform(obj, (acc, value, key, target) => {
+    const camelKey = isArray(target) ? key : camelCase(key);
+    acc[camelKey] = isObject(value) ? camelizeObj(value) : value;
+});
+
+const snakeizeObj = obj => transform(obj, (acc, value, key, target) => {
+    const camelKey = isArray(target) ? key : snakeCase(key);
+    acc[camelKey] = isObject(value) ? snakeizeObj(value) : value;
+});
+
+export function generateFake(modelType, options = {}, camelize = true) {
+    let model = {}
+    if (!Object.hasOwn(options, 'prefix')) {
+        options.prefix = 'test: '
+    }
+    switch (modelType) {
+        case 'customMessage':
+            model = createCustomMessage(options);
+            break;
+
+        case 'prompt':
+            model = createPrompt(options);
+            break;
+
+        case 'agent':
+            model = createAgent(options);
+            break;
+
+        default:
+            throw new Error(`${modelType} is not implemented`);
+    }
+    if (camelize) {
+        model = camelizeObj(model)
+    }
+    return model;
+}
+
+export function validateResponse(modelType, op, response, responseCode) {
+    let modelTypeSnakeCase = snakeCase(modelType)
+    let apiPath;
+    let verb;
+    switch (op) {
+        case 'list':
+            apiPath = `/api/v1/${modelTypeSnakeCase}s/`
+            verb = 'get'
+            break;
+
+        case 'create':
+            apiPath = `/api/v1/${modelTypeSnakeCase}s/`
+            verb = 'post'
+            break;
+
+        case 'getById':
+            apiPath = `/api/v1/${modelTypeSnakeCase}s/{${modelTypeSnakeCase}_id}`
+            verb = 'get'
+            break;
+
+        case 'update':
+            apiPath = `/api/v1/${modelTypeSnakeCase}s/`
+            verb = 'put'
+            break;
+
+        case 'delete':
+            apiPath = `/api/v1/${modelTypeSnakeCase}s/{${modelTypeSnakeCase}_id}`
+            verb = 'delete'
+            break;
+
+        default:
+            throw new Error(`${modelTypeSnakeCase} ${op} is not implemented`);
+
+    }
+    const schema = get(openApiSpec['paths'], `${apiPath}.${verb}.responses.${responseCode}.content.application/json.schema`)
+    if (!schema) {
+        throw new Error(`${modelTypeSnakeCase} ${op} ${apiPath}->${verb}->${responseCode} could not find schema in openapi.json`);
+    }
+    const ref = get(openApiSpec['paths'], `${apiPath}.${verb}.responses.${responseCode}.content.application/json.schema.$ref`)
+    let valid
+    if (ref) {
+        valid = ajv.validate({ '$ref': `openapi.json${ref}`}, snakeizeObj(response))
+    } else {
+        valid = ajv.validate(schema, snakeizeObj(response))
+    }
+    if (!valid) {
+        ajv.errors = ajv.errors.filter((validationError) => {
+            if (validationError.instancePath == '/updated_at' && validationError.keyword == 'type') {
+                // updatedAt is datetime via SDK where as it is a string via fast api
+                return false
+            }
+        });
+        if (ajv.errors.length >= 1) {
+            console.warn(`${modelTypeSnakeCase} ${op} response did not pass jsonschema validation`)
+            console.warn(ajv.errors)
+        } else {
+            valid = true
+        }
+    }
+    return valid
+}
+
+function createCustomMessage(options) {
+    const message = {
+        "type": "greeting",
+        "name": `${options.prefix}${randPhrase()} ${randNumber()}`,
+        "text": randParagraph(),
+        "label": "test",
+        "rules": [
+            {
+                "description": "week day rule",
+                "time_range_start": "09:00",
+                "time_range_end": "17:00",
+                "days_of_week": [
+                    "mo", "tu", "we", "th", "fr"
+                ],
+                "invert": false,
+                "text": "This is a weekday test message"
+            }
+        ]
+    };
+    return message;
+}
+
+function createPrompt(options) {
+    const prompt = {
+        "name": `${options.prefix} ${randPhrase()} ${randPhrase()} ${randNumber()}}`,
+        "description": randParagraph(),
+        "type": "prompt_v1",
+        "context": "You know everything about macos releases. You know their code names and release dates. You will answer questions like when was macos lion was released and what is the latest macos name, etc",
+        "tools": [
+          "hangup",
+          "set_current_language",
+          "summary"
+        ],
+        "llm_config": {
+          "provider": "openai",
+          "model": "gpt-4o",
+          "version": "2024-08-06",
+          "api_version": null
+        }
+    }
+    return prompt
+}
+
+function createAgent(options) {
+    const agent = {
+        "name": `${options.prefix} ${randPhrase()} ${randPhrase()} ${randNumber()}`,
+        "description": randParagraph(),
+        "label": "test",
+        "timezone": "America/New_York",
+        "type": "ca_v1",
+        "prompt_id": null,
+        "custom_message_id": null,
+        "languages": [
+            "en-US",
+            "es-US"
+        ],
+        variables: {}
+    }
+    return agent
+}

package/test/sdk/contract/prompts.test.ts

@@ -0,0 +1,70 @@
+import { beforeAll, describe, it, expect, afterAll } from "vitest";
+import { getSDK, generateFake, validateResponse } from "./helper";
+
+let sdk
+let createdPrompts = []
+beforeAll(async () => {
+    sdk = await getSDK()
+});
+
+afterAll(async () => {
+    for (const prompt of createdPrompts) {
+        const result = await sdk.prompts.delete({
+            promptId: prompt.id,
+            reason: 'was a created by a test'
+        })
+    }
+})
+
+describe('Syllable SDK Contract test suite', () => {
+    describe('prompts', () => {
+        describe('create', () => {
+            it('should create a prompt', async() => {
+                const prompt = generateFake('prompt');
+                const result = await sdk.prompts.create(prompt);
+                createdPrompts.push(result)
+                expect(validateResponse('prompt', 'create', result, 200)).to.be.true
+            })
+        })
+        describe('list', () => {
+            it('should list a newly created prompt', async() => {
+                const prompt = generateFake('prompt');
+                const result = await sdk.prompts.create(prompt);
+                createdPrompts.push(result)
+                const listResult = await sdk.prompts.list({
+                    searchFields: ['name'],
+                    searchFieldValues: [prompt.name]
+                });
+                const isFound = listResult.items.some((cm) => {
+                    return cm.name === prompt.name
+                })
+                expect(validateResponse('prompt', 'list', listResult, 200)).to.be.true
+                if (!isFound) {
+                    throw new Error('prompt that was just created is not listed')
+                }
+            })
+        })
+        describe('update', () => {
+            it('should update a newly created prompt', async() => {
+                const prompt = generateFake('prompt');
+                const result = await sdk.prompts.create(prompt);
+                createdPrompts.push(result)
+                prompt.id = result.id
+                prompt.description = 'new description'
+                const updateResult = await sdk.prompts.update(prompt);
+                expect(validateResponse('prompt', 'update', updateResult, 200)).to.be.true
+            })
+        })
+        describe('delete', () => {
+            it('should delete a newly created prompt', async() => {
+                const prompt = generateFake('prompt');
+                const result = await sdk.prompts.create(prompt);
+                const deleteResult = await sdk.prompts.delete({
+                    promptId: result.id,
+                    reason: 'created by a test'
+                });
+                expect(validateResponse('prompt', 'delete', deleteResult, 200)).to.be.true
+            })
+        })
+    })
+})