@ce-rise/hex-core-sdk-typescript 0.0.1-ci.2923648 → 0.0.1

package/README.md

@@ -1,5 +1,6 @@
 # CE-RISE TypeScript Software Development Kit for Hexagonal Core Service
 
+[![NPM](https://nodei.co/npm/@ce-rise/hex-core-sdk-typescript.svg?style=shields)](https://www.npmjs.com/package/@ce-rise/hex-core-sdk-typescript)
 [![DOI](https://zenodo.org/badge/DOI/TOBEOBTAINED.svg)](https://doi.org/TOBEOBTAINED)
 
 A TypeScript SDK for the CE-RISE Hex Core Service:
@@ -10,13 +11,13 @@ https://codeberg.org/CE-RISE-software/hex-core-service
 Install from npm:
 
 ```bash
-npm install "ce-rise-hex-core-sdk"
+npm install "@ce-rise/hex-core-sdk-typescript"
 ```
 
 Install a specific version:
 
 ```bash
-npm install "ce-rise-hex-core-sdk@0.0.1"
+npm install "@ce-rise/hex-core-sdk-typescript@0.0.1"
 ```
 
 ## Quickstart
@@ -24,22 +25,65 @@ npm install "ce-rise-hex-core-sdk@0.0.1"
 ### 1) Configure client and call public endpoints
 
 ```ts
+import { Configuration, DiscoveryApi } from "@ce-rise/hex-core-sdk-typescript";
 
+const config = new Configuration({
+  basePath: "https://your-hex-core-service.example.org"
+});
+
+const discoveryApi = new DiscoveryApi(config);
+const models = await discoveryApi.listModels();
+console.log(models);
 ```
 
 ### 2) Configure bearer token for protected endpoints
 
+```ts
+import { AdminApi, Configuration } from "@ce-rise/hex-core-sdk-typescript";
 
+const config = new Configuration({
+  basePath: "https://your-hex-core-service.example.org",
+  accessToken: process.env.HEX_CORE_TOKEN
+});
+
+const adminApi = new AdminApi(config);
+const status = await adminApi.status();
+console.log(status);
+```
 
 ### 3) Validate and create records
 
+```ts
+import { Configuration, ModelsApi } from "@ce-rise/hex-core-sdk-typescript";
+
+const config = new Configuration({
+  basePath: "https://your-hex-core-service.example.org",
+  accessToken: process.env.HEX_CORE_TOKEN
+});
+
+const modelsApi = new ModelsApi(config);
+
+const report = await modelsApi.validateModelPayload({
+  model: "model-a",
+  version: "1.0.0",
+  validateRequest: { payload: { x: 1 } }
+});
 
+const created = await modelsApi.createRecord({
+  model: "model-a",
+  version: "1.0.0",
+  idempotencyKey: "my-key-123",
+  createRequest: { payload: { x: 1 } }
+});
+
+console.log(report, created);
+```
 
 ## API Documentation
 
 - Generated docs website: https://ce-rise-software.codeberg.page/hex-core-sdk-typescript/
 - Local API docs:
-  - `docs/apis/dminApi.md`
+  - `docs/apis/AdminApi.md`
   - `docs/apis/DiscoveryApi.md`
   - `docs/apis/ModelsApi.md`
 

package/dist/src/apis/AdminApi.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/apis/AdminApi.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/apis/DiscoveryApi.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/apis/DiscoveryApi.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/apis/ModelsApi.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/apis/ModelsApi.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/CreateRequest.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/CreateRequest.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ErrorResponse.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ErrorResponse.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/HealthResponse.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/HealthResponse.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ModelVersion.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ModelVersion.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ModelsResponse.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ModelsResponse.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/QueryRequest.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/QueryRequest.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/QueryResponse.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/QueryResponse.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ReadyResponse.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ReadyResponse.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/Record.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/Record.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ValidateRequest.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ValidateRequest.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ValidationReport.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ValidationReport.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ValidationResult.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/models/ValidationResult.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/runtime.d.ts

@@ -1,8 +1,8 @@
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/src/runtime.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * CE-RISE Hexagonal Core Service API
+ * CE-RISE Hex Core Service API
  * Public and admin API for validating, creating, and querying records against versioned CE-RISE model artifacts.
  *
- * The version of the OpenAPI document: 0.0.1
+ * The version of the OpenAPI document: 0.0.2
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ce-rise/hex-core-sdk-typescript",
-  "version": "0.0.1-ci.2923648",
+  "version": "0.0.1",
   "private": false,
   "description": "Generated TypeScript SDK for CE-RISE Hex Core API",
   "main": "dist/src/index.js",