apibuilder-js - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

dist/type/definition/ApiBuilderOperation.d.ts

@@ -23,3 +23,3 @@ import { ApiBuilderAttributeConfig } from './ApiBuilderAttribute';
 export interface ApiBuilderOperationConfig {
-    readonly method: ApiBuilderMethod;
+    readonly method: ApiBuilderMethod | keyof typeof ApiBuilderMethod;
     readonly path: string;
@@ -38,3 +38,3 @@ readonly description?: string;
     constructor(config: ApiBuilderOperationConfig, resource: ApiBuilderResource, service: ApiBuilderService);
-    readonly method: ApiBuilderMethod;
+    readonly method: ApiBuilderMethod | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "CONNECT" | "OPTIONS" | "TRACE";
     readonly isDeprecated: boolean;
@@ -41,0 +41,0 @@ readonly deprecationReason: string | undefined;

dist/type/definition/ApiBuilderParameter.d.ts

@@ -7,6 +7,6 @@ import { ApiBuilderDeprecationConfig } from './ApiBuilderDeprecation';
 export declare enum ApiBuilderParameterLocation {
-    PATH = "Path",
-    QUERY = "Query",
-    FORM = "Form",
-    HEADER = "Header"
+    Path = "Path",
+    Query = "Query",
+    Form = "Form",
+    Header = "Header"
 }
@@ -19,3 +19,3 @@ /**
     readonly type: string;
-    readonly location: ApiBuilderParameterLocation;
+    readonly location: ApiBuilderParameterLocation | keyof typeof ApiBuilderParameterLocation;
     readonly description?: string;
@@ -37,4 +37,4 @@ readonly deprecation?: ApiBuilderDeprecationConfig;
     readonly description: string | undefined;
-    readonly location: ApiBuilderParameterLocation;
+    readonly location: ApiBuilderParameterLocation | "Path" | "Query" | "Form" | "Header";
     readonly isRequired: boolean;
 }

dist/type/definition/ApiBuilderParameter.js

@@ -9,6 +9,6 @@ "use strict";
 (function (ApiBuilderParameterLocation) {
-    ApiBuilderParameterLocation["PATH"] = "Path";
-    ApiBuilderParameterLocation["QUERY"] = "Query";
-    ApiBuilderParameterLocation["FORM"] = "Form";
-    ApiBuilderParameterLocation["HEADER"] = "Header";
+    ApiBuilderParameterLocation["Path"] = "Path";
+    ApiBuilderParameterLocation["Query"] = "Query";
+    ApiBuilderParameterLocation["Form"] = "Form";
+    ApiBuilderParameterLocation["Header"] = "Header";
 })(ApiBuilderParameterLocation = exports.ApiBuilderParameterLocation || (exports.ApiBuilderParameterLocation = {}));
@@ -15,0 +15,0 @@ var ApiBuilderParameter = /** @class */ (function () {

dist/type/definition/ApiBuilderResponse.d.ts

 import { ApiBuilderDeprecationConfig } from './ApiBuilderDeprecation';
 import { ApiBuilderHeaderConfig } from './ApiBuilderHeader';
+import { ApiBuilderAttributeConfig } from './ApiBuilderAttribute';
 /**
@@ -31,3 +32,4 @@ * @see https://app.apibuilder.io/bryzek/apidoc-spec/latest#enum-response_code_option
     readonly deprecation?: ApiBuilderDeprecationConfig;
+    readonly attributes: ReadonlyArray<ApiBuilderAttributeConfig>;
 }
 export {};

dist/type/definition/ApiBuilderService.d.ts

@@ -8,2 +8,3 @@ import { ApiBuilderAttributeConfig } from './ApiBuilderAttribute';
 import { ApiBuilderUnion, ApiBuilderUnionConfig } from './ApiBuilderUnion';
+import { ApiBuilderAnnotationConfig } from './ApiBuilderAnnotation';
 export interface ApiBuilderApiDocConfig {
@@ -60,2 +61,3 @@ readonly version: string;
     readonly attributes: ReadonlyArray<ApiBuilderAttributeConfig>;
+    readonly annotations: ReadonlyArray<ApiBuilderAnnotationConfig>;
 }
@@ -62,0 +64,0 @@ /**

dist/type/definition/index.d.ts

@@ -0,1 +1,2 @@
+export * from './ApiBuilderAnnotation';
 export * from './ApiBuilderArray';
@@ -2,0 +3,0 @@ export * from './ApiBuilderAttribute';

package.json

 {
   "name": "apibuilder-js",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A reference implementation of API Builder for JavaScript",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/type/definition/ApiBuilderOperation.ts

@@ -27,3 +27,3 @@ import { flow, get, getOr, inRange } from 'lodash/fp';
 export interface ApiBuilderOperationConfig {
-  readonly method: ApiBuilderMethod;
+  readonly method: ApiBuilderMethod | keyof typeof ApiBuilderMethod;
   readonly path: string;
@@ -30,0 +30,0 @@ readonly description?: string;

src/type/definition/ApiBuilderParameter.ts

@@ -9,6 +9,6 @@ import { ApiBuilderDeprecationConfig } from './ApiBuilderDeprecation';
 export enum ApiBuilderParameterLocation {
-  PATH = 'Path',
-  QUERY = 'Query',
-  FORM = 'Form',
-  HEADER = 'Header',
+  Path = 'Path',
+  Query = 'Query',
+  Form = 'Form',
+  Header = 'Header',
 }
@@ -22,3 +22,3 @@
   readonly type: string;
-  readonly location: ApiBuilderParameterLocation;
+  readonly location: ApiBuilderParameterLocation | keyof typeof ApiBuilderParameterLocation;
   readonly description?: string;
@@ -25,0 +25,0 @@ readonly deprecation?: ApiBuilderDeprecationConfig;

src/type/definition/ApiBuilderResponse.ts

 import { ApiBuilderDeprecationConfig } from './ApiBuilderDeprecation';
 import { ApiBuilderHeaderConfig } from './ApiBuilderHeader';
+import { ApiBuilderAttributeConfig } from './ApiBuilderAttribute';
 
@@ -37,2 +38,3 @@ /**
   readonly deprecation?: ApiBuilderDeprecationConfig;
+  readonly attributes: ReadonlyArray<ApiBuilderAttributeConfig>;
 }

src/type/definition/ApiBuilderService.ts

@@ -9,2 +9,3 @@ import { flatMap, matchesProperty, overSome } from 'lodash';
 import { ApiBuilderUnion, ApiBuilderUnionConfig } from './ApiBuilderUnion';
+import { ApiBuilderAnnotationConfig } from './ApiBuilderAnnotation';
 
@@ -68,2 +69,3 @@ export interface ApiBuilderApiDocConfig {
   readonly attributes: ReadonlyArray<ApiBuilderAttributeConfig>;
+  readonly annotations: ReadonlyArray<ApiBuilderAnnotationConfig>;
 }
@@ -70,0 +72,0 @@

src/type/definition/index.ts

@@ -0,1 +1,2 @@
+export * from './ApiBuilderAnnotation';
 export * from './ApiBuilderArray';
@@ -2,0 +3,0 @@ export * from './ApiBuilderAttribute';

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

289351

increased by0.5%

Number of package files

115

increased by2.68%

Lines of code

9086

increased by0.26%

No dependency changes