@opra/common 1.0.0-alpha.2 → 1.0.0-alpha.3

package/esm/document/factory/http-api.factory.js

@@ -205,7 +205,7 @@ export class HttpApiFactory {
             });
         }
         if (metadata.requestBody) {
-            await context.enter('.requestBody', async () => {
+            await context.enterAsync('.requestBody', async () => {
                 const requestBody = new HttpRequestBody(operation);
                 await this._initHttpRequestBody(context, requestBody, metadata.requestBody);
                 operation.requestBody = requestBody;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/common",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.3",
   "description": "Opra common package",
   "author": "Panates",
   "license": "MIT",
@@ -55,7 +55,7 @@
     "@browsery/util": "^0.12.5",
     "@types/encodeurl": "^1.0.2",
     "@types/lodash.omit": "^4.5.9",
-    "@types/validator": "^13.11.10",
+    "@types/validator": "^13.12.0",
     "path-browserify": "^1.0.1",
     "ts-gems": "^3.4.0"
   },

package/types/document/api-document.d.ts

@@ -7,17 +7,13 @@ import { kTypeNSMap } from './constants.js';
 import { DataType } from './data-type/data-type.js';
 import type { EnumType } from './data-type/enum-type.js';
 import type { HttpApi } from './http/http-api.js';
-export declare namespace ApiDocument {
-    interface ExportOptions {
-        references?: 'inline' | 'relative-url' | 'external-url';
-    }
-}
 /**
  *
  * @class ApiDocument
  */
 export declare class ApiDocument extends DocumentElement {
     protected [kTypeNSMap]: WeakMap<DataType, string>;
+    readonly id: string;
     url?: string;
     info: OpraSchema.DocumentInfo;
     references: ResponsiveMap<ApiDocument>;
@@ -29,10 +25,11 @@ export declare class ApiDocument extends DocumentElement {
      * @param nameOrCtor
      */
     getDataTypeNs(nameOrCtor: string | Type | Function | EnumType.EnumArray | EnumType.EnumObject | DataType): string | undefined;
+    findDocument(id: string): ApiDocument | undefined;
     toJSON(): OpraSchema.ApiDocument;
     /**
      * Export as Opra schema definition object
      */
-    export(options?: ApiDocument.ExportOptions): OpraSchema.ApiDocument;
+    export(): OpraSchema.ApiDocument;
     protected _findDataType(nameOrCtor: string | Type | Function | EnumType.EnumArray | EnumType.EnumObject, visitedRefs?: WeakMap<ApiDocument, boolean>): DataType | undefined;
 }

package/types/document/factory/api-document.factory.d.ts

@@ -5,7 +5,7 @@ import { DocumentInitContext } from '../common/document-init-context.js';
 import { DataTypeFactory } from './data-type.factory.js';
 import { HttpApiFactory } from './http-api.factory.js';
 export declare namespace ApiDocumentFactory {
-    interface InitArguments extends PartialSome<StrictOmit<OpraSchema.ApiDocument, 'references' | 'types' | 'api'>, 'spec'> {
+    interface InitArguments extends PartialSome<StrictOmit<OpraSchema.ApiDocument, 'id' | 'references' | 'types' | 'api'>, 'spec'> {
         references?: Record<string, ReferenceThunk>;
         types?: DataTypeInitSources;
         api?: HttpApiFactory.InitArguments;

package/types/schema/document.interface.d.ts

@@ -7,9 +7,10 @@ export type Protocol = 'http' | 'ws' | 'rpc';
  */
 export interface Document extends DataTypeContainer {
     spec: SpecVersion;
+    id: string;
     url?: string;
     info?: DocumentInfo;
-    references?: Record<string, string | Document>;
+    references?: Record<string, DocumentReference>;
     api?: HttpApi;
 }
 /**
@@ -39,6 +40,14 @@ export interface LicenseInfo {
     url?: string;
     content?: string;
 }
+/**
+ * @interface DocumentReference
+ */
+export interface DocumentReference extends Pick<Document, 'id' | 'url' | 'info'> {
+}
+/**
+ * @interface Api
+ */
 export interface Api extends DataTypeContainer {
     protocol: Protocol;
     /**
@@ -47,6 +56,9 @@ export interface Api extends DataTypeContainer {
     name: string;
     description?: string;
 }
+/**
+ * @interface HttpApi
+ */
 export interface HttpApi extends Api {
     protocol: 'http';
     description?: string;

package/types/schema/index.d.ts

@@ -26,6 +26,7 @@ export declare namespace OpraSchema {
     export import DocumentInfo = apiDocument_.DocumentInfo;
     export import ContactPerson = apiDocument_.ContactPerson;
     export import LicenseInfo = apiDocument_.LicenseInfo;
+    export import DocumentReference = apiDocument_.DocumentReference;
     export import HttpApi = apiDocument_.HttpApi;
     export import Api = apiDocument_.Api;
     export import HttpMethod = types_.HttpMethod;