@supermodeltools/sdk 0.3.7 → 0.4.0

package/README.md

@@ -1,46 +1,55 @@
-## @supermodeltools/sdk@0.3.7
+# Supermodel TypeScript SDK
 
-This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
+[![npm](https://img.shields.io/npm/v/@supermodeltools/sdk)](https://www.npmjs.com/package/@supermodeltools/sdk)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue)](https://www.typescriptlang.org/)
 
-Environment
-* Node.js
-* Webpack
-* Browserify
+TypeScript client for the [Supermodel API](https://docs.supermodeltools.com) - code graph generation and static analysis.
 
-Language level
-* ES5 - you must have a Promises/A+ library installed
-* ES6
+## Install
 
-Module system
-* CommonJS
-* ES6 module system
+```bash
+npm install @supermodeltools/sdk
+```
 
-It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
+## Quick Start
 
-### Building
+Get your API key from the [Supermodel Dashboard](https://supermodeltools.com/dashboard) and set it as `SUPERMODEL_API_KEY`.
 
-To build and compile the typescript sources to javascript use:
-```
-npm install
-npm run build
-```
+```typescript
+import { Configuration, DefaultApi } from '@supermodeltools/sdk';
+import { readFile } from 'node:fs/promises';
 
-### Publishing
+const config = new Configuration({
+  basePath: 'https://api.supermodeltools.com',
+  apiKey: process.env.SUPERMODEL_API_KEY,
+});
 
-First build the package then run `npm publish`
+const api = new DefaultApi(config);
 
-### Consuming
+// Create a ZIP of your repo: git archive -o /tmp/repo.zip HEAD
+const file = new Blob([await readFile('/tmp/repo.zip')], { type: 'application/zip' });
 
-navigate to the folder of your consuming project and run one of the following commands.
+const result = await api.generateSupermodelGraph({
+  idempotencyKey: 'my-repo:supermodel:abc123',
+  file,
+});
 
-_published:_
-
-```
-npm install @supermodeltools/sdk@0.3.7 --save
+console.log(result.graph.nodes.length, 'nodes');
 ```
 
-_unPublished (not recommended):_
+## Methods
 
-```
-npm install PATH_TO_GENERATED_PACKAGE --save
-```
+| Method | Description |
+|--------|-------------|
+| `generateDependencyGraph` | File-level dependency graph |
+| `generateCallGraph` | Function-level call graph |
+| `generateDomainGraph` | Domain model classification |
+| `generateParseGraph` | AST parse tree relationships |
+| `generateSupermodelGraph` | Full Supermodel IR bundle |
+
+All methods require `idempotencyKey` (string) and `file` (Blob) parameters.
+
+## Links
+
+- [API Documentation](https://docs.supermodeltools.com)
+- [OpenAPI Spec](https://www.npmjs.com/package/@supermodeltools/openapi-spec)

package/dist/apis/DefaultApi.d.ts

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

package/dist/apis/DefaultApi.js

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

package/dist/esm/apis/DefaultApi.d.ts

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

package/dist/esm/apis/DefaultApi.js

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

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

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

package/dist/esm/models/ClassificationStats.js

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

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

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

package/dist/esm/models/CodeGraphEnvelope.js

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

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

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

package/dist/esm/models/CodeGraphEnvelopeGraph.js

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

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

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

package/dist/esm/models/CodeGraphNode.js

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

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

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

package/dist/esm/models/CodeGraphRelationship.js

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

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

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

package/dist/esm/models/CodeGraphStats.js

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

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

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

package/dist/esm/models/DomainClassAssignment.js

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

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

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

package/dist/esm/models/DomainClassificationResponse.js

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

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

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

package/dist/esm/models/DomainFileAssignment.js

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

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

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

package/dist/esm/models/DomainFunctionAssignment.js

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

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

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

package/dist/esm/models/DomainRelationship.js

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

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

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

package/dist/esm/models/DomainSummary.js

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

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

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

package/dist/esm/models/ErrorDetailsInner.js

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

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

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

package/dist/esm/models/FunctionDescription.js

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

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

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

package/dist/esm/models/ModelError.js

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

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

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

package/dist/esm/models/SubdomainSummary.js

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

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

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

package/dist/esm/models/SupermodelArtifact.js

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

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

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

package/dist/esm/models/SupermodelIR.js

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

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

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

package/dist/esm/models/SupermodelIRGraph.js

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

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

@@ -2,7 +2,7 @@
  * Supermodel
  * Code Graphing & Analysis API
  *
- * The version of the OpenAPI document: 0.3.7
+ * The version of the OpenAPI document: 0.4.0
  *
  *
  * 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.3.7
+ * The version of the OpenAPI document: 0.4.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/runtime.d.ts

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

package/dist/esm/runtime.js

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

package/dist/models/ClassificationStats.d.ts

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

package/dist/models/ClassificationStats.js

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

package/dist/models/CodeGraphEnvelope.d.ts

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

package/dist/models/CodeGraphEnvelope.js

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

package/dist/models/CodeGraphEnvelopeGraph.d.ts

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

package/dist/models/CodeGraphEnvelopeGraph.js

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

package/dist/models/CodeGraphNode.d.ts

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

package/dist/models/CodeGraphNode.js

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