@scalar/types - npm Package Compare versions

Comparing version 0.0.25 to 0.0.26

CHANGELOG.md

 # @scalar/types
 
+## 0.0.26
+
+### Patch Changes
+
+- 60cd6f1: feat: render the operation description from the new store
+- 60cd6f1: chore: deprecated the TransformedOperation type
+- Updated dependencies [13333e6]
+  - @scalar/openapi-types@0.1.6
+
 ## 0.0.25
@@ -4,0 +13,0 @@

dist/legacy/reference-config.d.ts

@@ -293,2 +293,8 @@ import type { OpenAPI, OpenAPIV2, OpenAPIV3, OpenAPIV3_1 } from '@scalar/openapi-types';
 };
+/**
+ * This is a very strange and custom way to represent the operation object.
+ * It’s the outcome of the `parse` helper.
+ *
+ * @deprecated This is evil. Stop using it. We’ll transition to use the new store.
+ */
 export type TransformedOperation = Operation & {
@@ -359,5 +365,17 @@ pathParameters?: Parameter[];
 export type Definitions = OpenAPIV2.DefinitionsObject;
+/**
+ * Webhook (after our super custom transformation process)
+ *
+ * @deprecated Let’s get rid of those super custom transformed entities and use the store instead.
+ */
 export type Webhooks = Record<string, Record<OpenAPIV3_1.HttpMethods, TransformedOperation & {
     'x-internal'?: boolean;
 }>>;
+/**
+ * The native OpenAPI Webhook object, but with the x-internal and x-scalar-ignore properties
+ */
+export type Webhook = (OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject) & {
+    'x-internal'?: boolean;
+    'x-scalar-ignore'?: boolean;
+};
 export type Spec = {
@@ -364,0 +382,0 @@ 'tags'?: Tag[];

package.json

@@ -19,3 +19,3 @@ {
   ],
-  "version": "0.0.25",
+  "version": "0.0.26",
   "engines": {
@@ -54,7 +54,7 @@ "node": ">=18"
     "@unhead/schema": "^1.11.11",
-    "@scalar/openapi-types": "0.1.5"
+    "@scalar/openapi-types": "0.1.6"
   },
   "devDependencies": {
-    "@scalar/snippetz": "0.2.9",
-    "@scalar/build-tooling": "0.1.12"
+    "@scalar/build-tooling": "0.1.12",
+    "@scalar/snippetz": "0.2.10"
   },
@@ -61,0 +61,0 @@ "scripts": {

No alert changes

Improved metrics

Total package byte prevSize

29559

increased by3.69%

Lines of code

408

increased by4.62%

Dependency changes

• + Added@scalar/openapi-types@0.1.6(transitive)

• - Removed@scalar/openapi-types@0.1.5(transitive)

• Updated@scalar/openapi-types@0.1.6