@scalar/api-reference 1.25.102 → 1.25.104

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @scalar/api-reference
 
+## 1.25.104
+
+### Patch Changes
+
+- ace02fe: fix: favors configuration integration in open client modal button
+- 60cd6f1: feat: render the operation description from the new store
+- 39df543: feat: flatten discriminators containing null
+- e866487: feat(components): create dark light toggle components
+- d2b1525: feat: version prefix
+- Updated dependencies [2ad0407]
+- Updated dependencies [ace02fe]
+- Updated dependencies [60cd6f1]
+- Updated dependencies [60cd6f1]
+- Updated dependencies [e866487]
+- Updated dependencies [6d03777]
+- Updated dependencies [6d03777]
+- Updated dependencies [7df4472]
+- Updated dependencies [13333e6]
+- Updated dependencies [64df4fc]
+- Updated dependencies [08ac264]
+- Updated dependencies [aff72f7]
+- Updated dependencies [cb09e76]
+- Updated dependencies [2ad0407]
+  - @scalar/api-client@2.2.33
+  - @scalar/components@0.13.14
+  - @scalar/types@0.0.26
+  - @scalar/use-hooks@0.1.14
+  - @scalar/themes@0.9.60
+  - @scalar/oas-utils@0.2.97
+  - @scalar/openapi-types@0.1.6
+  - @scalar/openapi-parser@0.10.4
+  - @scalar/code-highlight@0.0.19
+
+## 1.25.103
+
+### Patch Changes
+
+- f9f5bdb: feat: remove examples from responses
+- Updated dependencies [d3199be]
+  - @scalar/api-client@2.2.32
+
 ## 1.25.102
 
 ### Patch Changes

package/dist/blocks/constants.d.ts

@@ -0,0 +1,9 @@
+export declare const ERRORS: {
+    NO_ELEMENT_PROVIDED: string;
+    NO_URL_PROVIDED: string;
+    EMPTY_PATH: string;
+};
+export declare const WARNINGS: {
+    ELEMENT_NOT_FOUND: string;
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/blocks/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/blocks/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;CAOlB,CAAA;AAED,eAAO,MAAM,QAAQ;;CAGpB,CAAA"}

package/dist/blocks/constants.js

@@ -0,0 +1,8 @@
+const o = {
+  NO_ELEMENT_PROVIDED: "Scalar Blocks: No HTML element provided to mount operation block. Please provide an HTML element to mount the operation block into.",
+  NO_URL_PROVIDED: "Scalar Blocks: No URL provided to import an OpenAPI document from. Please provide a URL to import an OpenAPI document from.",
+  EMPTY_PATH: "Path cannot be empty. Please provide a path to the operation you want to display."
+};
+export {
+  o as ERRORS
+};

package/dist/blocks/helpers/getPointer.d.ts

@@ -0,0 +1,22 @@
+import type { OpenAPI } from '@scalar/openapi-types';
+/**
+ * Pass an array of strings to get a valid OpenAPI pointer.
+ *
+ * Works with any path, but is typed to allow the paths that we support.
+ *
+ * @example
+ * ['paths', '/planets/{foo}', 'get'] > '#/paths/~1planets~1{foo}/get'
+ * ['components', 'schemas', 'Planet] > '#/components/schemas/Planet'
+ */
+type ValidOpenApiPaths = ['paths', string, Lowercase<OpenAPI.HttpMethod> | string] | ['components', 'schemas', string];
+/**
+ * Encodes a location string with paths
+ *
+ * @example
+ * getPointer(['paths', '/planets/{foo}', 'get'])
+ *
+ * '#/paths/~1planets~1{foo}/get'
+ */
+export declare function getPointer(path: ValidOpenApiPaths): `#/${string}`;
+export {};
+//# sourceMappingURL=getPointer.d.ts.map

package/dist/blocks/helpers/getPointer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPointer.d.ts","sourceRoot":"","sources":["../../../src/blocks/helpers/getPointer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD;;;;;;;;GAQG;AACH,KAAK,iBAAiB,GAClB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,GACzD,CAAC,YAAY,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;AAErC;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,iBAAiB,GAY9B,KAAK,MAAM,EAAE,CAChC"}

package/dist/blocks/helpers/getPointer.js

@@ -0,0 +1,12 @@
+import { ERRORS as n } from "../constants.js";
+import { escapeJsonPointer as e } from "@scalar/openapi-parser";
+function m(o) {
+  o.unshift("#");
+  const r = o.map((t) => e(t.trim())).filter(Boolean).join("/");
+  if (r === "#")
+    throw new Error(n.EMPTY_PATH);
+  return r;
+}
+export {
+  m as getPointer
+};

package/dist/blocks/hooks/useBlockProps.d.ts

@@ -0,0 +1,32 @@
+import type { createWorkspaceStore } from '@scalar/api-client/store';
+import type { Request as RequestEntity } from '@scalar/oas-utils/entities/spec';
+import { type ComputedRef } from 'vue';
+export type StoreContext = ReturnType<typeof createWorkspaceStore>;
+export type BlockProps = {
+    /**
+     * The store created by `createStore`
+     */
+    store: StoreContext | undefined;
+    /**
+     * The JSON pointer to the operation to use
+     *
+     * @example
+     * ```
+     * #/paths/test/get
+     * ```
+     */
+    location: `#/${string}`;
+    /**
+     * The name of the collection to use
+     *
+     * @default 'default'
+     */
+    collection?: string;
+};
+/**
+ * Provides computed properties for the block, based on the standardized interface of the `createStore` function.
+ */
+export declare function useBlockProps({ store, location }: BlockProps): {
+    operation: ComputedRef<RequestEntity | undefined>;
+};
+//# sourceMappingURL=useBlockProps.d.ts.map

package/dist/blocks/hooks/useBlockProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useBlockProps.d.ts","sourceRoot":"","sources":["../../../src/blocks/hooks/useBlockProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AACpE,OAAO,KAAK,EAEV,OAAO,IAAI,aAAa,EACzB,MAAM,iCAAiC,CAAA;AAExC,OAAO,EAAE,KAAK,WAAW,EAAY,MAAM,KAAK,CAAA;AAGhD,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAElE,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,KAAK,EAAE,YAAY,GAAG,SAAS,CAAA;IAC/B;;;;;;;OAOG;IACH,QAAQ,EAAE,KAAK,MAAM,EAAE,CAAA;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,UAAU,GAAG;IAC9D,SAAS,EAAE,WAAW,CAAC,aAAa,GAAG,SAAS,CAAC,CAAA;CAClD,CA8CA"}

package/dist/blocks/hooks/useBlockProps.js

@@ -0,0 +1,28 @@
+import { unescapeJsonPointer as r } from "@scalar/openapi-parser";
+import { computed as i } from "vue";
+function h({ store: e, location: o }) {
+  const s = i(() => Object.values((e == null ? void 0 : e.collections) ?? {})[0]);
+  return {
+    operation: i(() => {
+      if (!(e != null && e.collections) || !e.requests)
+        return;
+      const c = Object.values(e.requests).filter(
+        (t) => {
+          var n;
+          return (n = s.value) == null ? void 0 : n.requests.includes(t.uid);
+        }
+      );
+      if (!o.startsWith("#/paths/"))
+        throw new Error(
+          "Invalid location, try using #/paths/$YOUR_ENDPOINT/$HTTP_METHOD. You can use the getPointer helper to generate a valid location: getPointer(['paths', '/planets/{planetId}', 'get'])"
+        );
+      return c.find((t) => {
+        const n = r(o.split("/")[2]), l = o.split("/")[3].toLocaleLowerCase();
+        return t.method === l && t.path === n;
+      });
+    })
+  };
+}
+export {
+  h as useBlockProps
+};