digitaltwin-core 0.9.2 → 0.10.2

package/dist/openapi/types.d.ts

@@ -0,0 +1,182 @@
+/**
+ * @fileoverview OpenAPI 3.0 type definitions for automatic documentation generation
+ *
+ * These types provide a structured way to define OpenAPI specifications
+ * for digital twin components.
+ */
+/**
+ * OpenAPI Info object
+ */
+export interface OpenAPIInfo {
+    title: string;
+    description?: string;
+    version: string;
+}
+/**
+ * OpenAPI Server object
+ */
+export interface OpenAPIServer {
+    url: string;
+    description?: string;
+}
+/**
+ * OpenAPI Tag object
+ */
+export interface OpenAPITag {
+    name: string;
+    description?: string;
+}
+/**
+ * OpenAPI Parameter object
+ */
+export interface OpenAPIParameter {
+    name: string;
+    in: 'path' | 'query' | 'header' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema: OpenAPISchema;
+}
+/**
+ * OpenAPI Schema object (simplified)
+ */
+export interface OpenAPISchema {
+    type?: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
+    format?: string;
+    items?: OpenAPISchema;
+    properties?: Record<string, OpenAPISchema>;
+    required?: string[];
+    $ref?: string;
+    description?: string;
+    nullable?: boolean;
+    enum?: string[];
+    default?: unknown;
+    additionalProperties?: boolean | OpenAPISchema;
+}
+/**
+ * OpenAPI Media Type object
+ */
+export interface OpenAPIMediaType {
+    schema: OpenAPISchema;
+}
+/**
+ * OpenAPI Request Body object
+ */
+export interface OpenAPIRequestBody {
+    description?: string;
+    required?: boolean;
+    content: Record<string, OpenAPIMediaType>;
+}
+/**
+ * OpenAPI Response object
+ */
+export interface OpenAPIResponse {
+    description: string;
+    content?: Record<string, OpenAPIMediaType>;
+    headers?: Record<string, {
+        description?: string;
+        schema: OpenAPISchema;
+    }>;
+}
+/**
+ * OpenAPI Security Requirement object
+ */
+export interface OpenAPISecurityRequirement {
+    [name: string]: string[];
+}
+/**
+ * OpenAPI Operation object
+ */
+export interface OpenAPIOperation {
+    summary?: string;
+    description?: string;
+    operationId?: string;
+    tags?: string[];
+    parameters?: OpenAPIParameter[];
+    requestBody?: OpenAPIRequestBody;
+    responses: Record<string, OpenAPIResponse>;
+    security?: OpenAPISecurityRequirement[];
+    deprecated?: boolean;
+}
+/**
+ * OpenAPI Path Item object
+ */
+export interface OpenAPIPathItem {
+    get?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    options?: OpenAPIOperation;
+    head?: OpenAPIOperation;
+}
+/**
+ * OpenAPI Security Scheme object
+ */
+export interface OpenAPISecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    description?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    scheme?: string;
+    bearerFormat?: string;
+}
+/**
+ * OpenAPI Components object
+ */
+export interface OpenAPIComponents {
+    schemas?: Record<string, OpenAPISchema>;
+    securitySchemes?: Record<string, OpenAPISecurityScheme>;
+}
+/**
+ * Complete OpenAPI Document
+ */
+export interface OpenAPIDocument {
+    openapi: string;
+    info: OpenAPIInfo;
+    servers?: OpenAPIServer[];
+    tags?: OpenAPITag[];
+    paths: Record<string, OpenAPIPathItem>;
+    components?: OpenAPIComponents;
+}
+/**
+ * Specification returned by a component's getOpenAPISpec() method
+ */
+export interface OpenAPIComponentSpec {
+    /** Paths contributed by this component */
+    paths: Record<string, OpenAPIPathItem>;
+    /** Tags used by this component */
+    tags?: OpenAPITag[];
+    /** Schemas contributed by this component */
+    schemas?: Record<string, OpenAPISchema>;
+}
+/**
+ * Options for OpenAPI generation
+ */
+export interface OpenAPIGeneratorOptions {
+    /** API information */
+    info: OpenAPIInfo;
+    /** Server URLs */
+    servers?: OpenAPIServer[];
+    /** Components to document */
+    components: OpenAPIDocumentable[];
+    /** Additional schemas to merge (e.g., from external file) */
+    additionalSchemas?: Record<string, OpenAPISchema>;
+    /** Additional tags to include */
+    additionalTags?: OpenAPITag[];
+    /** Include security scheme for authentication */
+    includeAuth?: boolean;
+}
+/**
+ * Interface for components that can provide OpenAPI documentation
+ */
+export interface OpenAPIDocumentable {
+    /**
+     * Returns the OpenAPI specification for this component's endpoints
+     */
+    getOpenAPISpec(): OpenAPIComponentSpec;
+}
+/**
+ * Type guard to check if an object implements OpenAPIDocumentable
+ */
+export declare function isOpenAPIDocumentable(obj: unknown): obj is OpenAPIDocumentable;
+//# sourceMappingURL=types.d.ts.map

package/dist/openapi/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/openapi/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,EAAE,aAAa,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAA;IACvE,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IAC1C,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,oBAAoB,CAAC,EAAE,OAAO,GAAG,aAAa,CAAA;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,MAAM,EAAE,aAAa,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,aAAa,CAAA;KAAE,CAAC,CAAA;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC/B,WAAW,CAAC,EAAE,kBAAkB,CAAA;IAChC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IAC1C,QAAQ,CAAC,EAAE,0BAA0B,EAAE,CAAA;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B,IAAI,CAAC,EAAE,gBAAgB,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,CAAA;IACpD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,WAAW,CAAA;IACjB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAA;IACzB,IAAI,CAAC,EAAE,UAAU,EAAE,CAAA;IACnB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACtC,UAAU,CAAC,EAAE,iBAAiB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACtC,kCAAkC;IAClC,IAAI,CAAC,EAAE,UAAU,EAAE,CAAA;IACnB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,sBAAsB;IACtB,IAAI,EAAE,WAAW,CAAA;IACjB,kBAAkB;IAClB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAA;IACzB,6BAA6B;IAC7B,UAAU,EAAE,mBAAmB,EAAE,CAAA;IACjC,6DAA6D;IAC7D,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACjD,iCAAiC;IACjC,cAAc,CAAC,EAAE,UAAU,EAAE,CAAA;IAC7B,iDAAiD;IACjD,WAAW,CAAC,EAAE,OAAO,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,cAAc,IAAI,oBAAoB,CAAA;CACzC;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,mBAAmB,CAO9E"}

package/dist/openapi/types.js

@@ -0,0 +1,16 @@
+/**
+ * @fileoverview OpenAPI 3.0 type definitions for automatic documentation generation
+ *
+ * These types provide a structured way to define OpenAPI specifications
+ * for digital twin components.
+ */
+/**
+ * Type guard to check if an object implements OpenAPIDocumentable
+ */
+export function isOpenAPIDocumentable(obj) {
+    return (typeof obj === 'object' &&
+        obj !== null &&
+        'getOpenAPISpec' in obj &&
+        typeof obj.getOpenAPISpec === 'function');
+}
+//# sourceMappingURL=types.js.map

package/dist/openapi/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/openapi/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA2LH;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,GAAY;IAC9C,OAAO,CACH,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,gBAAgB,IAAI,GAAG;QACvB,OAAQ,GAA2B,CAAC,cAAc,KAAK,UAAU,CACpE,CAAA;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "digitaltwin-core",
-  "version": "0.9.2",
+  "version": "0.10.2",
   "description": "Minimalist framework to collect and handle data in a Digital Twin project",
   "license": "MIT",
   "author": "Axel Hoffmann",
@@ -22,7 +22,7 @@
     "build": "tsc",
     "dev": "tsc --watch",
     "clean": "rimraf dist",
-    "test": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
+    "test": "node -r ./bin/set-test-env.cjs --import ts-node-maintained/register/esm --enable-source-maps bin/test.ts",
     "lint": "eslint src/**/*.ts",
     "lint:fix": "eslint src/**/*.ts --fix",
     "format": "prettier --write \"src/**/*.ts\"",