@supermodeltools/sdk 0.9.3 → 0.9.5

package/dist/esm/models/TestCoverageMapResponseAsync.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { TestCoverageMapResponse } from './TestCoverageMapResponse';
+/**
+ *
+ * @export
+ * @interface TestCoverageMapResponseAsync
+ */
+export interface TestCoverageMapResponseAsync {
+    /**
+     * Current status of the job.
+     * @type {string}
+     * @memberof TestCoverageMapResponseAsync
+     */
+    status: TestCoverageMapResponseAsyncStatusEnum;
+    /**
+     * Unique identifier for the job.
+     * @type {string}
+     * @memberof TestCoverageMapResponseAsync
+     */
+    jobId: string;
+    /**
+     * Recommended seconds to wait before polling again.
+     * @type {number}
+     * @memberof TestCoverageMapResponseAsync
+     */
+    retryAfter?: number;
+    /**
+     * Error message (present when status is failed).
+     * @type {string}
+     * @memberof TestCoverageMapResponseAsync
+     */
+    error?: string;
+    /**
+     *
+     * @type {TestCoverageMapResponse}
+     * @memberof TestCoverageMapResponseAsync
+     */
+    result?: TestCoverageMapResponse;
+}
+/**
+ * @export
+ */
+export declare const TestCoverageMapResponseAsyncStatusEnum: {
+    readonly Pending: "pending";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+};
+export type TestCoverageMapResponseAsyncStatusEnum = typeof TestCoverageMapResponseAsyncStatusEnum[keyof typeof TestCoverageMapResponseAsyncStatusEnum];
+/**
+ * Check if a given object implements the TestCoverageMapResponseAsync interface.
+ */
+export declare function instanceOfTestCoverageMapResponseAsync(value: object): value is TestCoverageMapResponseAsync;
+export declare function TestCoverageMapResponseAsyncFromJSON(json: any): TestCoverageMapResponseAsync;
+export declare function TestCoverageMapResponseAsyncFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestCoverageMapResponseAsync;
+export declare function TestCoverageMapResponseAsyncToJSON(value?: TestCoverageMapResponseAsync | null): any;

package/dist/esm/models/TestCoverageMapResponseAsync.js

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { TestCoverageMapResponseFromJSON, TestCoverageMapResponseToJSON, } from './TestCoverageMapResponse';
+/**
+ * @export
+ */
+export const TestCoverageMapResponseAsyncStatusEnum = {
+    Pending: 'pending',
+    Processing: 'processing',
+    Completed: 'completed',
+    Failed: 'failed'
+};
+/**
+ * Check if a given object implements the TestCoverageMapResponseAsync interface.
+ */
+export function instanceOfTestCoverageMapResponseAsync(value) {
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('jobId' in value) || value['jobId'] === undefined)
+        return false;
+    return true;
+}
+export function TestCoverageMapResponseAsyncFromJSON(json) {
+    return TestCoverageMapResponseAsyncFromJSONTyped(json, false);
+}
+export function TestCoverageMapResponseAsyncFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'],
+        'jobId': json['jobId'],
+        'retryAfter': json['retryAfter'] == null ? undefined : json['retryAfter'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'result': json['result'] == null ? undefined : TestCoverageMapResponseFromJSON(json['result']),
+    };
+}
+export function TestCoverageMapResponseAsyncToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'jobId': value['jobId'],
+        'retryAfter': value['retryAfter'],
+        'error': value['error'],
+        'result': TestCoverageMapResponseToJSON(value['result']),
+    };
+}

package/dist/esm/models/TestFileInfo.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Information about a detected test file.
+ * @export
+ * @interface TestFileInfo
+ */
+export interface TestFileInfo {
+    /**
+     * File path relative to repository root.
+     * @type {string}
+     * @memberof TestFileInfo
+     */
+    file: string;
+    /**
+     * Number of test functions defined in this file.
+     * @type {number}
+     * @memberof TestFileInfo
+     */
+    testFunctions: number;
+    /**
+     * Number of unique production functions covered by tests in this file.
+     * @type {number}
+     * @memberof TestFileInfo
+     */
+    productionFunctionsCovered: number;
+    /**
+     * Number of unique production files covered by tests in this file.
+     * @type {number}
+     * @memberof TestFileInfo
+     */
+    productionFilesCovered: number;
+}
+/**
+ * Check if a given object implements the TestFileInfo interface.
+ */
+export declare function instanceOfTestFileInfo(value: object): value is TestFileInfo;
+export declare function TestFileInfoFromJSON(json: any): TestFileInfo;
+export declare function TestFileInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestFileInfo;
+export declare function TestFileInfoToJSON(value?: TestFileInfo | null): any;

package/dist/esm/models/TestFileInfo.js

@@ -0,0 +1,52 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the TestFileInfo interface.
+ */
+export function instanceOfTestFileInfo(value) {
+    if (!('file' in value) || value['file'] === undefined)
+        return false;
+    if (!('testFunctions' in value) || value['testFunctions'] === undefined)
+        return false;
+    if (!('productionFunctionsCovered' in value) || value['productionFunctionsCovered'] === undefined)
+        return false;
+    if (!('productionFilesCovered' in value) || value['productionFilesCovered'] === undefined)
+        return false;
+    return true;
+}
+export function TestFileInfoFromJSON(json) {
+    return TestFileInfoFromJSONTyped(json, false);
+}
+export function TestFileInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'file': json['file'],
+        'testFunctions': json['testFunctions'],
+        'productionFunctionsCovered': json['productionFunctionsCovered'],
+        'productionFilesCovered': json['productionFilesCovered'],
+    };
+}
+export function TestFileInfoToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'file': value['file'],
+        'testFunctions': value['testFunctions'],
+        'productionFunctionsCovered': value['productionFunctionsCovered'],
+        'productionFilesCovered': value['productionFilesCovered'],
+    };
+}

package/dist/esm/models/TestedFunction.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A production function reachable from at least one test function.
+ * @export
+ * @interface TestedFunction
+ */
+export interface TestedFunction {
+    /**
+     * File path relative to repository root.
+     * @type {string}
+     * @memberof TestedFunction
+     */
+    file: string;
+    /**
+     * Name of the function or method.
+     * @type {string}
+     * @memberof TestedFunction
+     */
+    name: string;
+    /**
+     * Line number where the function is declared.
+     * @type {number}
+     * @memberof TestedFunction
+     */
+    line: number;
+    /**
+     * Type of code element.
+     * @type {string}
+     * @memberof TestedFunction
+     */
+    type: TestedFunctionTypeEnum;
+    /**
+     * Test files that cover this function (directly or transitively).
+     * @type {Array<string>}
+     * @memberof TestedFunction
+     */
+    testFiles: Array<string>;
+    /**
+     * Number of test functions that directly call this function.
+     * @type {number}
+     * @memberof TestedFunction
+     */
+    directTestCallers: number;
+    /**
+     * Number of test functions that transitively reach this function.
+     * @type {number}
+     * @memberof TestedFunction
+     */
+    transitiveTestCallers: number;
+}
+/**
+ * @export
+ */
+export declare const TestedFunctionTypeEnum: {
+    readonly Function: "function";
+    readonly Class: "class";
+    readonly Method: "method";
+    readonly Interface: "interface";
+    readonly Type: "type";
+    readonly Variable: "variable";
+    readonly Constant: "constant";
+};
+export type TestedFunctionTypeEnum = typeof TestedFunctionTypeEnum[keyof typeof TestedFunctionTypeEnum];
+/**
+ * Check if a given object implements the TestedFunction interface.
+ */
+export declare function instanceOfTestedFunction(value: object): value is TestedFunction;
+export declare function TestedFunctionFromJSON(json: any): TestedFunction;
+export declare function TestedFunctionFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestedFunction;
+export declare function TestedFunctionToJSON(value?: TestedFunction | null): any;

package/dist/esm/models/TestedFunction.js

@@ -0,0 +1,76 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @export
+ */
+export const TestedFunctionTypeEnum = {
+    Function: 'function',
+    Class: 'class',
+    Method: 'method',
+    Interface: 'interface',
+    Type: 'type',
+    Variable: 'variable',
+    Constant: 'constant'
+};
+/**
+ * Check if a given object implements the TestedFunction interface.
+ */
+export function instanceOfTestedFunction(value) {
+    if (!('file' in value) || value['file'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('line' in value) || value['line'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('testFiles' in value) || value['testFiles'] === undefined)
+        return false;
+    if (!('directTestCallers' in value) || value['directTestCallers'] === undefined)
+        return false;
+    if (!('transitiveTestCallers' in value) || value['transitiveTestCallers'] === undefined)
+        return false;
+    return true;
+}
+export function TestedFunctionFromJSON(json) {
+    return TestedFunctionFromJSONTyped(json, false);
+}
+export function TestedFunctionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'file': json['file'],
+        'name': json['name'],
+        'line': json['line'],
+        'type': json['type'],
+        'testFiles': json['testFiles'],
+        'directTestCallers': json['directTestCallers'],
+        'transitiveTestCallers': json['transitiveTestCallers'],
+    };
+}
+export function TestedFunctionToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'file': value['file'],
+        'name': value['name'],
+        'line': value['line'],
+        'type': value['type'],
+        'testFiles': value['testFiles'],
+        'directTestCallers': value['directTestCallers'],
+        'transitiveTestCallers': value['transitiveTestCallers'],
+    };
+}

package/dist/esm/models/TestedSibling.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * A sibling function in the same file that has test coverage.
+ * @export
+ * @interface TestedSibling
+ */
+export interface TestedSibling {
+    /**
+     * Name of the tested sibling function.
+     * @type {string}
+     * @memberof TestedSibling
+     */
+    name: string;
+    /**
+     * Line number where the sibling function is declared.
+     * @type {number}
+     * @memberof TestedSibling
+     */
+    line: number;
+    /**
+     * Test files that cover this sibling function.
+     * @type {Array<string>}
+     * @memberof TestedSibling
+     */
+    testFiles: Array<string>;
+}
+/**
+ * Check if a given object implements the TestedSibling interface.
+ */
+export declare function instanceOfTestedSibling(value: object): value is TestedSibling;
+export declare function TestedSiblingFromJSON(json: any): TestedSibling;
+export declare function TestedSiblingFromJSONTyped(json: any, ignoreDiscriminator: boolean): TestedSibling;
+export declare function TestedSiblingToJSON(value?: TestedSibling | null): any;

package/dist/esm/models/TestedSibling.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the TestedSibling interface.
+ */
+export function instanceOfTestedSibling(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('line' in value) || value['line'] === undefined)
+        return false;
+    if (!('testFiles' in value) || value['testFiles'] === undefined)
+        return false;
+    return true;
+}
+export function TestedSiblingFromJSON(json) {
+    return TestedSiblingFromJSONTyped(json, false);
+}
+export function TestedSiblingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'line': json['line'],
+        'testFiles': json['testFiles'],
+    };
+}
+export function TestedSiblingToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'line': value['line'],
+        'testFiles': value['testFiles'],
+    };
+}

package/dist/esm/models/UnassignedFunction.d.ts

@@ -2,7 +2,7 @@
  * Supermodel
  * Code Graphing & Analysis API
  *
- * The version of the OpenAPI document: 0.9.3
+ * The version of the OpenAPI document: 0.9.5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/models/UnassignedFunction.js

@@ -4,7 +4,7 @@
  * Supermodel
  * Code Graphing & Analysis API
  *
- * The version of the OpenAPI document: 0.9.3
+ * The version of the OpenAPI document: 0.9.5
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/models/UntestedFunction.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { TestedSibling } from './TestedSibling';
+import type { NearestTestedCaller } from './NearestTestedCaller';
+/**
+ * A production function with no test coverage.
+ * @export
+ * @interface UntestedFunction
+ */
+export interface UntestedFunction {
+    /**
+     * File path relative to repository root.
+     * @type {string}
+     * @memberof UntestedFunction
+     */
+    file: string;
+    /**
+     * Name of the function or method.
+     * @type {string}
+     * @memberof UntestedFunction
+     */
+    name: string;
+    /**
+     * Line number where the function is declared.
+     * @type {number}
+     * @memberof UntestedFunction
+     */
+    line: number;
+    /**
+     * Type of code element.
+     * @type {string}
+     * @memberof UntestedFunction
+     */
+    type: UntestedFunctionTypeEnum;
+    /**
+     * Confidence level of the untested classification.
+     * @type {string}
+     * @memberof UntestedFunction
+     */
+    confidence: UntestedFunctionConfidenceEnum;
+    /**
+     * Explanation of why this function is classified as untested.
+     * @type {string}
+     * @memberof UntestedFunction
+     */
+    reason: string;
+    /**
+     *
+     * @type {NearestTestedCaller}
+     * @memberof UntestedFunction
+     */
+    nearestTestedCaller?: NearestTestedCaller;
+    /**
+     * The test file that covers the most sibling functions in the same production file. This is the recommended file in which to add a test for this untested function.
+     * @type {string}
+     * @memberof UntestedFunction
+     */
+    suggestedTestFile?: string;
+    /**
+     * Other functions in the same file that ARE tested, along with which test files cover them. Use this to see existing test patterns you can follow.
+     * @type {Array<TestedSibling>}
+     * @memberof UntestedFunction
+     */
+    testedSiblings?: Array<TestedSibling>;
+}
+/**
+ * @export
+ */
+export declare const UntestedFunctionTypeEnum: {
+    readonly Function: "function";
+    readonly Class: "class";
+    readonly Method: "method";
+    readonly Interface: "interface";
+    readonly Type: "type";
+    readonly Variable: "variable";
+    readonly Constant: "constant";
+};
+export type UntestedFunctionTypeEnum = typeof UntestedFunctionTypeEnum[keyof typeof UntestedFunctionTypeEnum];
+/**
+ * @export
+ */
+export declare const UntestedFunctionConfidenceEnum: {
+    readonly High: "high";
+    readonly Medium: "medium";
+    readonly Low: "low";
+};
+export type UntestedFunctionConfidenceEnum = typeof UntestedFunctionConfidenceEnum[keyof typeof UntestedFunctionConfidenceEnum];
+/**
+ * Check if a given object implements the UntestedFunction interface.
+ */
+export declare function instanceOfUntestedFunction(value: object): value is UntestedFunction;
+export declare function UntestedFunctionFromJSON(json: any): UntestedFunction;
+export declare function UntestedFunctionFromJSONTyped(json: any, ignoreDiscriminator: boolean): UntestedFunction;
+export declare function UntestedFunctionToJSON(value?: UntestedFunction | null): any;

package/dist/esm/models/UntestedFunction.js

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Supermodel
+ * Code Graphing & Analysis API
+ *
+ * The version of the OpenAPI document: 0.9.5
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { TestedSiblingFromJSON, TestedSiblingToJSON, } from './TestedSibling';
+import { NearestTestedCallerFromJSON, NearestTestedCallerToJSON, } from './NearestTestedCaller';
+/**
+ * @export
+ */
+export const UntestedFunctionTypeEnum = {
+    Function: 'function',
+    Class: 'class',
+    Method: 'method',
+    Interface: 'interface',
+    Type: 'type',
+    Variable: 'variable',
+    Constant: 'constant'
+};
+/**
+ * @export
+ */
+export const UntestedFunctionConfidenceEnum = {
+    High: 'high',
+    Medium: 'medium',
+    Low: 'low'
+};
+/**
+ * Check if a given object implements the UntestedFunction interface.
+ */
+export function instanceOfUntestedFunction(value) {
+    if (!('file' in value) || value['file'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('line' in value) || value['line'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+export function UntestedFunctionFromJSON(json) {
+    return UntestedFunctionFromJSONTyped(json, false);
+}
+export function UntestedFunctionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'file': json['file'],
+        'name': json['name'],
+        'line': json['line'],
+        'type': json['type'],
+        'confidence': json['confidence'],
+        'reason': json['reason'],
+        'nearestTestedCaller': json['nearestTestedCaller'] == null ? undefined : NearestTestedCallerFromJSON(json['nearestTestedCaller']),
+        'suggestedTestFile': json['suggestedTestFile'] == null ? undefined : json['suggestedTestFile'],
+        'testedSiblings': json['testedSiblings'] == null ? undefined : (json['testedSiblings'].map(TestedSiblingFromJSON)),
+    };
+}
+export function UntestedFunctionToJSON(value) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'file': value['file'],
+        'name': value['name'],
+        'line': value['line'],
+        'type': value['type'],
+        'confidence': value['confidence'],
+        'reason': value['reason'],
+        'nearestTestedCaller': NearestTestedCallerToJSON(value['nearestTestedCaller']),
+        'suggestedTestFile': value['suggestedTestFile'],
+        'testedSiblings': value['testedSiblings'] == null ? undefined : (value['testedSiblings'].map(TestedSiblingToJSON)),
+    };
+}