@effect/platform 0.69.9 → 0.69.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/HttpApiScalar/package.json +6 -0
  2. package/dist/cjs/HttpApiError.js +1 -1
  3. package/dist/cjs/HttpApiScalar.js +59 -0
  4. package/dist/cjs/HttpApiScalar.js.map +1 -0
  5. package/dist/cjs/HttpApiSwagger.js +1 -1
  6. package/dist/cjs/index.js +3 -1
  7. package/dist/cjs/internal/httpApiScalar.js +2 -0
  8. package/dist/cjs/internal/httpApiScalar.js.map +1 -0
  9. package/dist/cjs/internal/{apiSwagger.js → httpApiSwagger.js} +1 -1
  10. package/dist/cjs/internal/httpApiSwagger.js.map +1 -0
  11. package/dist/dts/HttpApiScalar.d.ts +106 -0
  12. package/dist/dts/HttpApiScalar.d.ts.map +1 -0
  13. package/dist/dts/index.d.ts +4 -0
  14. package/dist/dts/index.d.ts.map +1 -1
  15. package/dist/dts/internal/httpApiScalar.d.ts +2 -0
  16. package/dist/dts/internal/httpApiScalar.d.ts.map +1 -0
  17. package/dist/dts/internal/httpApiSwagger.d.ts +2 -0
  18. package/dist/dts/internal/httpApiSwagger.d.ts.map +1 -0
  19. package/dist/esm/HttpApiError.js +1 -1
  20. package/dist/esm/HttpApiScalar.js +49 -0
  21. package/dist/esm/HttpApiScalar.js.map +1 -0
  22. package/dist/esm/HttpApiSwagger.js +1 -1
  23. package/dist/esm/HttpApiSwagger.js.map +1 -1
  24. package/dist/esm/index.js +4 -0
  25. package/dist/esm/index.js.map +1 -1
  26. package/dist/esm/internal/httpApiScalar.js +2 -0
  27. package/dist/esm/internal/httpApiScalar.js.map +1 -0
  28. package/dist/esm/internal/{apiSwagger.js → httpApiSwagger.js} +1 -1
  29. package/dist/esm/internal/httpApiSwagger.js.map +1 -0
  30. package/package.json +10 -2
  31. package/src/HttpApiError.ts +1 -1
  32. package/src/HttpApiScalar.ts +187 -0
  33. package/src/HttpApiSwagger.ts +1 -1
  34. package/src/index.ts +5 -0
  35. package/src/internal/httpApiScalar.ts +4 -0
  36. package/dist/cjs/internal/apiSwagger.js.map +0 -1
  37. package/dist/dts/internal/apiSwagger.d.ts +0 -2
  38. package/dist/dts/internal/apiSwagger.d.ts.map +0 -1
  39. package/dist/esm/internal/apiSwagger.js.map +0 -1
  40. /package/src/internal/{apiSwagger.ts → httpApiSwagger.ts} +0 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"httpApiSwagger.js","names":["javascript","exports","css"],"sources":["../../../src/internal/httpApiSwagger.ts"],"sourcesContent":[null],"mappings":"4GAAA,qBAEA,gBACO,KAAM,CAAAA,UAAU,CAAAC,OAAA,CAAAD,UAAA,CAAG,m1lpDAAm1lpD,CAE72lpD,gBACO,KAAM,CAAAE,GAAG,CAAAD,OAAA,CAAAC,GAAA,CAAG,wopJAAwopJ","ignoreList":[]}
@@ -0,0 +1,106 @@
1
+ import type { Layer } from "effect/Layer";
2
+ import { Api } from "./HttpApi.js";
3
+ /**
4
+ * @since 1.0.0
5
+ * @category model
6
+ */
7
+ export type ScalarThemeId = "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
8
+ /**
9
+ * @since 1.0.0
10
+ * @category model
11
+ *
12
+ * cdn: `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${source.version}/dist/browser/standalone.min.js`
13
+ */
14
+ export type ScalarScriptSource = string | {
15
+ type: "default";
16
+ } | {
17
+ type: "cdn";
18
+ version?: "latest" | (string & {});
19
+ };
20
+ /**
21
+ * @since 1.0.0
22
+ * @category model
23
+ * @see https://github.com/scalar/scalar/blob/main/documentation/configuration.md
24
+ */
25
+ export type ScalarConfig = {
26
+ /** A string to use one of the color presets */
27
+ theme?: ScalarThemeId;
28
+ /** The layout to use for the references */
29
+ layout?: "modern" | "classic";
30
+ /** URL to a request proxy for the API client */
31
+ proxy?: string;
32
+ /** Whether the spec input should show */
33
+ isEditable?: boolean;
34
+ /** Whether to show the sidebar */
35
+ showSidebar?: boolean;
36
+ /**
37
+ * Whether to show models in the sidebar, search, and content.
38
+ *
39
+ * @default false
40
+ */
41
+ hideModels?: boolean;
42
+ /**
43
+ * Whether to show the “Download OpenAPI Document” button
44
+ *
45
+ * @default false
46
+ */
47
+ hideDownloadButton?: boolean;
48
+ /**
49
+ * Whether to show the “Test Request” button
50
+ *
51
+ * @default: false
52
+ */
53
+ hideTestRequestButton?: boolean;
54
+ /**
55
+ * Whether to show the sidebar search bar
56
+ *
57
+ * @default: false
58
+ */
59
+ hideSearch?: boolean;
60
+ /** Whether dark mode is on or off initially (light mode) */
61
+ darkMode?: boolean;
62
+ /** forceDarkModeState makes it always this state no matter what*/
63
+ forceDarkModeState?: "dark" | "light";
64
+ /** Whether to show the dark mode toggle */
65
+ hideDarkModeToggle?: boolean;
66
+ /**
67
+ * Path to a favicon image
68
+ *
69
+ * @default undefined
70
+ * @example '/favicon.svg'
71
+ */
72
+ favicon?: string;
73
+ /** Custom CSS to be added to the page */
74
+ customCss?: string;
75
+ /**
76
+ * The baseServerURL is used when the spec servers are relative paths and we are using SSR.
77
+ * On the client we can grab the window.location.origin but on the server we need
78
+ * to use this prop.
79
+ *
80
+ * @default undefined
81
+ * @example 'http://localhost:3000'
82
+ */
83
+ baseServerURL?: string;
84
+ /**
85
+ * We’re using Inter and JetBrains Mono as the default fonts. If you want to use your own fonts, set this to false.
86
+ *
87
+ * @default true
88
+ */
89
+ withDefaultFonts?: boolean;
90
+ /**
91
+ * By default we only open the relevant tag based on the url, however if you want all the tags open by default then set this configuration option :)
92
+ *
93
+ * @default false
94
+ */
95
+ defaultOpenAllTags?: boolean;
96
+ };
97
+ /**
98
+ * @since 1.0.0
99
+ * @category layers
100
+ */
101
+ export declare const layer: (options?: {
102
+ readonly path?: `/${string}` | undefined;
103
+ readonly source?: ScalarScriptSource;
104
+ readonly scalar?: ScalarConfig;
105
+ }) => Layer<never, never, Api>;
106
+ //# sourceMappingURL=HttpApiScalar.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"HttpApiScalar.d.ts","sourceRoot":"","sources":["../../src/HttpApiScalar.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAMlC;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,WAAW,GACX,SAAS,GACT,MAAM,GACN,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,CAAA;AAEV;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IACA,IAAI,EAAE,KAAK,CAAA;IACX,OAAO,CAAC,EAAE,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;CACnC,CAAA;AAEH;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC7B,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,kEAAkE;IAClE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACrC,2CAA2C;IAC3C,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,KAAK,aAAc;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAA;IACpC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B,KAAG,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CA0DxB,CAAA"}
@@ -62,6 +62,10 @@ export * as HttpApiGroup from "./HttpApiGroup.js";
62
62
  * @since 1.0.0
63
63
  */
64
64
  export * as HttpApiMiddleware from "./HttpApiMiddleware.js";
65
+ /**
66
+ * @since 1.0.0
67
+ */
68
+ export * as HttpApiScalar from "./HttpApiScalar.js";
65
69
  /**
66
70
  * @since 1.0.0
67
71
  */
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAE/D;;;GAGG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAA;AAEnE;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAA;AAEzD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,sBAAsB,MAAM,6BAA6B,CAAA;AAErE;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAE/D;;;GAGG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAA;AAEnE;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAA;AAEzD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,sBAAsB,MAAM,6BAA6B,CAAA;AAErE;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=httpApiScalar.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"httpApiScalar.d.ts","sourceRoot":"","sources":["../../../src/internal/httpApiScalar.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=httpApiSwagger.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"httpApiSwagger.d.ts","sourceRoot":"","sources":["../../../src/internal/httpApiSwagger.ts"],"names":[],"mappings":""}
@@ -37,7 +37,7 @@ export class HttpApiDecodeError extends /*#__PURE__*/Schema.TaggedError()("HttpA
37
37
  message: Schema.String
38
38
  }, /*#__PURE__*/HttpApiSchema.annotations({
39
39
  status: 400,
40
- description: "HttpApiDecodeError: The request did not match the expected schema"
40
+ description: "The request did not match the expected schema"
41
41
  })) {
42
42
  /**
43
43
  * @since 1.0.0
@@ -0,0 +1,49 @@
1
+ /**
2
+ * @since 1.0.0
3
+ */
4
+ import * as Effect from "effect/Effect";
5
+ import { Api } from "./HttpApi.js";
6
+ import { Router } from "./HttpApiBuilder.js";
7
+ import * as HttpServerResponse from "./HttpServerResponse.js";
8
+ import * as internal from "./internal/httpApiScalar.js";
9
+ import * as OpenApi from "./OpenApi.js";
10
+ /**
11
+ * @since 1.0.0
12
+ * @category layers
13
+ */
14
+ export const layer = options => Router.use(router => Effect.gen(function* () {
15
+ const {
16
+ api
17
+ } = yield* Api;
18
+ const spec = OpenApi.fromApi(api);
19
+ const source = options?.source;
20
+ const defaultScript = internal.javascript;
21
+ const src = source ? typeof source === "string" ? source : source.type === "cdn" ? `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${source.version ?? "latest"}/dist/browser/standalone.min.js` : null : null;
22
+ const scalarConfig = {
23
+ _integration: "http",
24
+ ...options?.scalar
25
+ };
26
+ const response = HttpServerResponse.html(`<!doctype html>
27
+ <html>
28
+ <head>
29
+ <meta charset="utf-8" />
30
+ <title>${spec.info.title}</title>
31
+ ${!spec.info.description ? "" : `<meta name="description" content="${spec.info.description}"/>`}
32
+ ${!spec.info.description ? "" : `<meta name="og:description" content="${spec.info.description}"/>`}
33
+ <meta
34
+ name="viewport"
35
+ content="width=device-width, initial-scale=1" />
36
+ </head>
37
+ <body>
38
+ <script id="api-reference" type="application/json">
39
+ ${JSON.stringify(spec)}
40
+ </script>
41
+ <script>
42
+ document.getElementById('api-reference').dataset.configuration = JSON.stringify(${JSON.stringify(scalarConfig)})
43
+ </script>
44
+ ${src ? `<script src="${src}" crossorigin></script>` : `<script>${defaultScript}</script>`}
45
+ </body>
46
+ </html>`);
47
+ yield* router.get(options?.path ?? "/docs", Effect.succeed(response));
48
+ }));
49
+ //# sourceMappingURL=HttpApiScalar.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"HttpApiScalar.js","names":["Effect","Api","Router","HttpServerResponse","internal","OpenApi","layer","options","use","router","gen","api","spec","fromApi","source","defaultScript","javascript","src","type","version","scalarConfig","_integration","scalar","response","html","info","title","description","JSON","stringify","get","path","succeed"],"sources":["../../src/HttpApiScalar.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,MAAM,MAAM,eAAe;AAEvC,SAASC,GAAG,QAAQ,cAAc;AAClC,SAASC,MAAM,QAAQ,qBAAqB;AAC5C,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAC7D,OAAO,KAAKC,QAAQ,MAAM,6BAA6B;AACvD,OAAO,KAAKC,OAAO,MAAM,cAAc;AA+GvC;;;;AAIA,OAAO,MAAMC,KAAK,GAAIC,OAIrB,IACCL,MAAM,CAACM,GAAG,CAAEC,MAAM,IAChBT,MAAM,CAACU,GAAG,CAAC,aAAS;EAClB,MAAM;IAAEC;EAAG,CAAE,GAAG,OAAOV,GAAG;EAC1B,MAAMW,IAAI,GAAGP,OAAO,CAACQ,OAAO,CAACF,GAAG,CAAC;EAEjC,MAAMG,MAAM,GAAGP,OAAO,EAAEO,MAAM;EAC9B,MAAMC,aAAa,GAAGX,QAAQ,CAACY,UAAU;EACzC,MAAMC,GAAG,GAAkBH,MAAM,GAC7B,OAAOA,MAAM,KAAK,QAAQ,GACxBA,MAAM,GACNA,MAAM,CAACI,IAAI,KAAK,KAAK,GACrB,sDACAJ,MAAM,CAACK,OAAO,IAAI,QACpB,iCAAiC,GAC/B,IAAI,GACN,IAAI;EAER,MAAMC,YAAY,GAAG;IACnBC,YAAY,EAAE,MAAM;IACpB,GAAGd,OAAO,EAAEe;GACb;EAED,MAAMC,QAAQ,GAAGpB,kBAAkB,CAACqB,IAAI,CAAC;;;;aAIlCZ,IAAI,CAACa,IAAI,CAACC,KAAK;MAEpB,CAACd,IAAI,CAACa,IAAI,CAACE,WAAW,GAClB,EAAE,GACF,qCAAqCf,IAAI,CAACa,IAAI,CAACE,WAAW,KAChE;MAEE,CAACf,IAAI,CAACa,IAAI,CAACE,WAAW,GAClB,EAAE,GACF,wCAAwCf,IAAI,CAACa,IAAI,CAACE,WAAW,KACnE;;;;;;;QAOEC,IAAI,CAACC,SAAS,CAACjB,IAAI,CAAC;;;wFAG4DgB,IAAI,CAACC,SAAS,CAACT,YAAY,CAAC;;MAG5GH,GAAG,GACC,gBAAgBA,GAAG,yBAAyB,GAC5C,WAAWF,aAAa,WAC9B;;QAEE,CAAC;EACH,OAAON,MAAM,CAACqB,GAAG,CAACvB,OAAO,EAAEwB,IAAI,IAAI,OAAO,EAAE/B,MAAM,CAACgC,OAAO,CAACT,QAAQ,CAAC,CAAC;AACvE,CAAC,CAAC,CACH","ignoreList":[]}
@@ -5,7 +5,7 @@ import * as Effect from "effect/Effect";
5
5
  import { Api } from "./HttpApi.js";
6
6
  import { Router } from "./HttpApiBuilder.js";
7
7
  import * as HttpServerResponse from "./HttpServerResponse.js";
8
- import * as internal from "./internal/apiSwagger.js";
8
+ import * as internal from "./internal/httpApiSwagger.js";
9
9
  import * as OpenApi from "./OpenApi.js";
10
10
  /**
11
11
  * @since 1.0.0
@@ -1 +1 @@
1
- {"version":3,"file":"HttpApiSwagger.js","names":["Effect","Api","Router","HttpServerResponse","internal","OpenApi","layer","options","use","router","gen","api","spec","fromApi","response","html","info","title","css","javascript","JSON","stringify","get","path","succeed"],"sources":["../../src/HttpApiSwagger.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,MAAM,MAAM,eAAe;AAEvC,SAASC,GAAG,QAAQ,cAAc;AAClC,SAASC,MAAM,QAAQ,qBAAqB;AAC5C,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAC7D,OAAO,KAAKC,QAAQ,MAAM,0BAA0B;AACpD,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;;AAIA,OAAO,MAAMC,KAAK,GAAIC,OAErB,IACCL,MAAM,CAACM,GAAG,CAAEC,MAAM,IAChBT,MAAM,CAACU,GAAG,CAAC,aAAS;EAClB,MAAM;IAAEC;EAAG,CAAE,GAAG,OAAOV,GAAG;EAC1B,MAAMW,IAAI,GAAGP,OAAO,CAACQ,OAAO,CAACF,GAAG,CAAC;EACjC,MAAMG,QAAQ,GAAGX,kBAAkB,CAACY,IAAI,CAAC;;;;;WAKpCH,IAAI,CAACI,IAAI,CAACC,KAAK;WACfb,QAAQ,CAACc,GAAG;;;;;MAKjBd,QAAQ,CAACe,UAAU;;;gBAGTC,IAAI,CAACC,SAAS,CAACT,IAAI,CAAC;;;;;;QAM5B,CAAC;EACH,OAAOH,MAAM,CAACa,GAAG,CAACf,OAAO,EAAEgB,IAAI,IAAI,OAAO,EAAEvB,MAAM,CAACwB,OAAO,CAACV,QAAQ,CAAC,CAAC;AACvE,CAAC,CAAC,CACH","ignoreList":[]}
1
+ {"version":3,"file":"HttpApiSwagger.js","names":["Effect","Api","Router","HttpServerResponse","internal","OpenApi","layer","options","use","router","gen","api","spec","fromApi","response","html","info","title","css","javascript","JSON","stringify","get","path","succeed"],"sources":["../../src/HttpApiSwagger.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,MAAM,MAAM,eAAe;AAEvC,SAASC,GAAG,QAAQ,cAAc;AAClC,SAASC,MAAM,QAAQ,qBAAqB;AAC5C,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAC7D,OAAO,KAAKC,QAAQ,MAAM,8BAA8B;AACxD,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;;AAIA,OAAO,MAAMC,KAAK,GAAIC,OAErB,IACCL,MAAM,CAACM,GAAG,CAAEC,MAAM,IAChBT,MAAM,CAACU,GAAG,CAAC,aAAS;EAClB,MAAM;IAAEC;EAAG,CAAE,GAAG,OAAOV,GAAG;EAC1B,MAAMW,IAAI,GAAGP,OAAO,CAACQ,OAAO,CAACF,GAAG,CAAC;EACjC,MAAMG,QAAQ,GAAGX,kBAAkB,CAACY,IAAI,CAAC;;;;;WAKpCH,IAAI,CAACI,IAAI,CAACC,KAAK;WACfb,QAAQ,CAACc,GAAG;;;;;MAKjBd,QAAQ,CAACe,UAAU;;;gBAGTC,IAAI,CAACC,SAAS,CAACT,IAAI,CAAC;;;;;;QAM5B,CAAC;EACH,OAAOH,MAAM,CAACa,GAAG,CAACf,OAAO,EAAEgB,IAAI,IAAI,OAAO,EAAEvB,MAAM,CAACwB,OAAO,CAACV,QAAQ,CAAC,CAAC;AACvE,CAAC,CAAC,CACH","ignoreList":[]}
package/dist/esm/index.js CHANGED
@@ -62,6 +62,10 @@ export * as HttpApiGroup from "./HttpApiGroup.js";
62
62
  * @since 1.0.0
63
63
  */
64
64
  export * as HttpApiMiddleware from "./HttpApiMiddleware.js";
65
+ /**
66
+ * @since 1.0.0
67
+ */
68
+ export * as HttpApiScalar from "./HttpApiScalar.js";
65
69
  /**
66
70
  * @since 1.0.0
67
71
  */
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":["Command","CommandExecutor","Cookies","Effectify","Error","Etag","FetchHttpClient","FileSystem","Headers","HttpApi","HttpApiBuilder","HttpApiClient","HttpApiEndpoint","HttpApiError","HttpApiGroup","HttpApiMiddleware","HttpApiSchema","HttpApiSecurity","HttpApiSwagger","HttpApp","HttpBody","HttpClient","HttpClientError","HttpClientRequest","HttpClientResponse","HttpIncomingMessage","HttpMethod","HttpMiddleware","HttpMultiplex","HttpPlatform","HttpRouter","HttpServer","HttpServerError","HttpServerRequest","HttpServerRespondable","HttpServerResponse","HttpTraceContext","KeyValueStore","Multipart","OpenApi","OpenApiJsonSchema","Path","PlatformConfigProvider","PlatformLogger","Runtime","Socket","Template","Terminal","Transferable","UrlParams","Worker","WorkerError","WorkerRunner"],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC;;;AAGA,OAAO,KAAKC,IAAI,MAAM,WAAW;AAEjC;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,iBAAiB,MAAM,wBAAwB;AAE3D;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,iBAAiB,MAAM,wBAAwB;AAE3D;;;AAGA,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAE7D;;;AAGA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B;AAE/D;;;;AAIA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,iBAAiB,MAAM,wBAAwB;AAE3D;;;AAGA,OAAO,KAAKC,qBAAqB,MAAM,4BAA4B;AAEnE;;;AAGA,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAE7D;;;AAGA,OAAO,KAAKC,gBAAgB,MAAM,uBAAuB;AAEzD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,iBAAiB,MAAM,wBAAwB;AAE3D;;;AAGA,OAAO,KAAKC,IAAI,MAAM,WAAW;AAEjC;;;AAGA,OAAO,KAAKC,sBAAsB,MAAM,6BAA6B;AAErE;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB","ignoreList":[]}
1
+ {"version":3,"file":"index.js","names":["Command","CommandExecutor","Cookies","Effectify","Error","Etag","FetchHttpClient","FileSystem","Headers","HttpApi","HttpApiBuilder","HttpApiClient","HttpApiEndpoint","HttpApiError","HttpApiGroup","HttpApiMiddleware","HttpApiScalar","HttpApiSchema","HttpApiSecurity","HttpApiSwagger","HttpApp","HttpBody","HttpClient","HttpClientError","HttpClientRequest","HttpClientResponse","HttpIncomingMessage","HttpMethod","HttpMiddleware","HttpMultiplex","HttpPlatform","HttpRouter","HttpServer","HttpServerError","HttpServerRequest","HttpServerRespondable","HttpServerResponse","HttpTraceContext","KeyValueStore","Multipart","OpenApi","OpenApiJsonSchema","Path","PlatformConfigProvider","PlatformLogger","Runtime","Socket","Template","Terminal","Transferable","UrlParams","Worker","WorkerError","WorkerRunner"],"sources":["../../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC;;;AAGA,OAAO,KAAKC,IAAI,MAAM,WAAW;AAEjC;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,iBAAiB,MAAM,wBAAwB;AAE3D;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,iBAAiB,MAAM,wBAAwB;AAE3D;;;AAGA,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAE7D;;;AAGA,OAAO,KAAKC,mBAAmB,MAAM,0BAA0B;AAE/D;;;;AAIA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,UAAU,MAAM,iBAAiB;AAE7C;;;AAGA,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AAEvD;;;AAGA,OAAO,KAAKC,iBAAiB,MAAM,wBAAwB;AAE3D;;;AAGA,OAAO,KAAKC,qBAAqB,MAAM,4BAA4B;AAEnE;;;AAGA,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAE7D;;;AAGA,OAAO,KAAKC,gBAAgB,MAAM,uBAAuB;AAEzD;;;AAGA,OAAO,KAAKC,aAAa,MAAM,oBAAoB;AAEnD;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,iBAAiB,MAAM,wBAAwB;AAE3D;;;AAGA,OAAO,KAAKC,IAAI,MAAM,WAAW;AAEjC;;;AAGA,OAAO,KAAKC,sBAAsB,MAAM,6BAA6B;AAErE;;;AAGA,OAAO,KAAKC,cAAc,MAAM,qBAAqB;AAErD;;;AAGA,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC;;;AAGA,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,QAAQ,MAAM,eAAe;AAEzC;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB;AAEjD;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,MAAM,MAAM,aAAa;AAErC;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;AAGA,OAAO,KAAKC,YAAY,MAAM,mBAAmB","ignoreList":[]}