syllable-sdk 0.1.0-alpha.4 → 0.1.0-alpha.41

package/src/sdk/v1.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { v1PostGetDashboard } from "../funcs/v1PostGetDashboard.js";
+import { v1PostListDashboard } from "../funcs/v1PostListDashboard.js";
+import { v1PostSessionEventsDashboard } from "../funcs/v1PostSessionEventsDashboard.js";
+import { v1PostSessionsDashboard } from "../funcs/v1PostSessionsDashboard.js";
+import { v1PostSessionSummaryDashboard } from "../funcs/v1PostSessionSummaryDashboard.js";
+import { v1PostSessionTransfersDashboard } from "../funcs/v1PostSessionTransfersDashboard.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class V1 extends ClientSDK {
+  /**
+   * Post List Dashboards
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/list
+   * ARGUMENTS: None
+   * RETURNS: List of dashboards
+   */
+  async postListDashboard(
+    request: operations.PostListDashboardRequest,
+    options?: RequestOptions,
+  ): Promise<components.ListResponseDashboardResponse> {
+    return unwrapAsync(v1PostListDashboard(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Post Fetch Info
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/fetch_info
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   */
+  async postGetDashboard(
+    request: operations.PostGetDashboardRequest,
+    options?: RequestOptions,
+  ): Promise<components.DashboardTokenResponse> {
+    return unwrapAsync(v1PostGetDashboard(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Events
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_events
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   * DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  async postSessionEventsDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(v1PostSessionEventsDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Summary
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_summary
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   * DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  async postSessionSummaryDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(v1PostSessionSummaryDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Session Transfers
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/session_transfers
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   * DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  async postSessionTransfersDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(v1PostSessionTransfersDashboard(
+      this,
+      options,
+    ));
+  }
+
+  /**
+   * Post Sessions
+   *
+   * @remarks
+   * METHOD: POST
+   * URL: /dashboard/sessions
+   * ARGUMENTS: None
+   * RETURNS: Dashboard info for embedding
+   * DEPRECATED: This endpoint is deprecated. Please use /dashboard/list instead
+   *
+   * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  async postSessionsDashboard(
+    options?: RequestOptions,
+  ): Promise<components.Dashboard> {
+    return unwrapAsync(v1PostSessionsDashboard(
+      this,
+      options,
+    ));
+  }
+}

package/src/types/operations.ts

@@ -6,9 +6,10 @@ import { Result } from "./fp.js";
 
 export type Paginator<V> = () => Promise<V & { next: Paginator<V> }> | null;
 
-export type PageIterator<V> = V & {
+export type PageIterator<V, PageState = unknown> = V & {
   next: Paginator<V>;
   [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+  "~next"?: PageState | undefined;
 };
 
 export function createPageIterator<V>(
@@ -40,7 +41,9 @@ export function createPageIterator<V>(
  * terminates. It is useful in paginated SDK functions that have early return
  * paths when things go wrong.
  */
-export function haltIterator<V extends object>(v: V): PageIterator<V> {
+export function haltIterator<V extends object>(
+  v: V,
+): PageIterator<V, undefined> {
   return {
     ...v,
     next: () => null,
@@ -54,9 +57,9 @@ export function haltIterator<V extends object>(v: V): PageIterator<V> {
  * Converts an async iterator of `Result<V, E>` into an async iterator of `V`.
  * When error results occur, the underlying error value is thrown.
  */
-export async function unwrapResultIterator<V>(
-  iteratorPromise: Promise<PageIterator<Result<V, unknown>>>,
-): Promise<PageIterator<V>> {
+export async function unwrapResultIterator<V, PageState>(
+  iteratorPromise: Promise<PageIterator<Result<V, unknown>, PageState>>,
+): Promise<PageIterator<V, PageState>> {
   const resultIter = await iteratorPromise;
 
   if (!resultIter.ok) {
@@ -66,6 +69,7 @@ export async function unwrapResultIterator<V>(
   return {
     ...resultIter.value,
     next: unwrapPaginator(resultIter.next),
+    "~next": resultIter["~next"],
     [Symbol.asyncIterator]: async function* paginator() {
       for await (const page of resultIter) {
         if (!page.ok) {
@@ -97,3 +101,5 @@ function unwrapPaginator<V>(
     });
   };
 }
+
+export const URL_OVERRIDE = Symbol("URL_OVERRIDE");

package/test/sdk/contract/agents.test.ts

@@ -0,0 +1,113 @@
+import { beforeAll, describe, it, expect, afterAll } from "vitest";
+import { getSDK, generateFake } from "./helper";
+
+let sdk
+let createdAgents = []
+beforeAll(async () => {
+    sdk = await getSDK()
+});
+
+afterAll(async () => {
+    for (const agent of createdAgents) {
+        const result = await sdk.agents.delete({
+            agentId: agent.id,
+            reason: 'was a created by a test'
+        })
+    }
+    for (const agent of createdAgents) {
+        const promptResult = await sdk.prompts.delete({
+            promptId: agent.promptId,
+            reason: 'was a created by a test'
+        })
+        const customMessageResult = await sdk.customMessages.delete({
+            customMessageId: agent.customMessageId,
+            reason: 'was a created by a test'
+        })
+    }
+})
+
+describe('Syllable SDK Contract test suite', () => {
+    describe('agents', () => {
+        describe('create', () => {
+            it('should create a agent', async() => {
+                const prompt = generateFake('prompt');
+                const promptResult = await sdk.prompts.create(prompt);
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const messageResult = await sdk.customMessages.create(message);
+                const agent = generateFake('agent');
+                agent.promptId = promptResult.id
+                agent.customMessageId = messageResult.id
+                const result = await sdk.agents.create(agent);
+                createdAgents.push(result)
+            })
+        })
+        describe('list', () => {
+            it('should list a newly created agent', async() => {
+                const prompt = generateFake('prompt');
+                const promptResult = await sdk.prompts.create(prompt);
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const messageResult = await sdk.customMessages.create(message);
+                const agent = generateFake('agent');
+                agent.promptId = promptResult.id
+                agent.customMessageId = messageResult.id
+                const result = await sdk.agents.create(agent);
+                createdAgents.push(result)
+                const listResult = await sdk.agents.list({});
+                const isFound = listResult.items.some((cm) => {
+                    return cm.name === agent.name
+                })
+                if (!isFound) {
+                    throw new Error('agent that was just created is not listed')
+                }
+            })
+        })
+        describe('update', () => {
+            it('should update a newly created agent', async() => {
+                const prompt = generateFake('prompt');
+                const promptResult = await sdk.prompts.create(prompt);
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const messageResult = await sdk.customMessages.create(message);
+                const agent = generateFake('agent');
+                agent.promptId = promptResult.id
+                agent.customMessageId = messageResult.id
+                const result = await sdk.agents.create(agent);
+                createdAgents.push(result)
+                agent.id = result.id
+                agent.description = 'new description'
+                const updateResult = await sdk.agents.update(agent);
+            })
+        })
+        describe('delete', () => {
+            it('should delete a newly created agent', async() => {
+                const prompt = generateFake('prompt');
+                const promptResult = await sdk.prompts.create(prompt);
+                const message = generateFake('customMessage');
+                delete message.rules[0].daysOfWeek
+                message.rules[0].date = new Date().toJSON().slice(0, 10);
+                const messageResult = await sdk.customMessages.create(message);
+                const agent = generateFake('agent');
+                agent.promptId = promptResult.id
+                agent.customMessageId = messageResult.id
+                const result = await sdk.agents.create(agent);
+                const deleteResult = await sdk.agents.delete({
+                    agentId: result.id,
+                    reason: 'created by a test'
+                })
+                await sdk.prompts.delete({
+                    promptId: agent.promptId,
+                    reason: 'was a created by a test'
+                })
+                await sdk.customMessages.delete({
+                    customMessageId: agent.customMessageId,
+                    reason: 'was a created by a test'
+                })
+            })
+        })
+    })
+})

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
+            })
+        })
+    })
+})