@effect/platform 0.93.1 → 0.93.2
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.
- package/dist/cjs/HttpApiScalar.js +48 -6
- package/dist/cjs/HttpApiScalar.js.map +1 -1
- package/dist/cjs/internal/httpApiScalar.js +1 -1
- package/dist/cjs/internal/httpApiScalar.js.map +1 -1
- package/dist/cjs/internal/httpApiSwagger.js +1 -1
- package/dist/cjs/internal/httpApiSwagger.js.map +1 -1
- package/dist/dts/HttpApiScalar.d.ts +19 -14
- package/dist/dts/HttpApiScalar.d.ts.map +1 -1
- package/dist/esm/HttpApiScalar.js +45 -4
- package/dist/esm/HttpApiScalar.js.map +1 -1
- package/dist/esm/internal/httpApiScalar.js +1 -1
- package/dist/esm/internal/httpApiScalar.js.map +1 -1
- package/dist/esm/internal/httpApiSwagger.js +1 -1
- package/dist/esm/internal/httpApiSwagger.js.map +1 -1
- package/package.json +1 -1
- package/src/HttpApiScalar.ts +83 -33
- package/src/internal/httpApiScalar.ts +1 -1
- package/src/internal/httpApiSwagger.ts +2 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"httpApiSwagger.js","names":["javascript","exports","css"],"sources":["../../../src/internal/httpApiSwagger.ts"],"sourcesContent":[null],"mappings":"4GAAA,oBAEA,gBACO,KAAM,CAAAA,UAAU,CAAAC,OAAA,CAAAD,UAAA,CAAG,
|
|
1
|
+
{"version":3,"file":"httpApiSwagger.js","names":["javascript","exports","css"],"sources":["../../../src/internal/httpApiSwagger.ts"],"sourcesContent":[null],"mappings":"4GAAA,oBAEA,gBACO,KAAM,CAAAA,UAAU,CAAAC,OAAA,CAAAD,UAAA,CAAG,s7iuDAAs7iuD,CAEh9iuD,gBACO,KAAM,CAAAE,GAAG,CAAAD,OAAA,CAAAC,GAAA,CAAG,otvJAAotvJ","ignoreList":[]}
|
|
@@ -7,18 +7,6 @@ import * as HttpLayerRouter from "./HttpLayerRouter.js";
|
|
|
7
7
|
* @category model
|
|
8
8
|
*/
|
|
9
9
|
export type ScalarThemeId = "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
10
|
-
/**
|
|
11
|
-
* @since 1.0.0
|
|
12
|
-
* @category model
|
|
13
|
-
*
|
|
14
|
-
* cdn: `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${source.version}/dist/browser/standalone.min.js`
|
|
15
|
-
*/
|
|
16
|
-
export type ScalarScriptSource = string | {
|
|
17
|
-
type: "default";
|
|
18
|
-
} | {
|
|
19
|
-
type: "cdn";
|
|
20
|
-
version?: "latest" | (string & {});
|
|
21
|
-
};
|
|
22
10
|
/**
|
|
23
11
|
* @see https://github.com/scalar/scalar/blob/main/documentation/configuration.md
|
|
24
12
|
*
|
|
@@ -103,9 +91,17 @@ export type ScalarConfig = {
|
|
|
103
91
|
*/
|
|
104
92
|
export declare const layer: (options?: {
|
|
105
93
|
readonly path?: `/${string}` | undefined;
|
|
106
|
-
readonly source?: ScalarScriptSource;
|
|
107
94
|
readonly scalar?: ScalarConfig;
|
|
108
95
|
}) => Layer.Layer<never, never, Api>;
|
|
96
|
+
/**
|
|
97
|
+
* @since 1.0.0
|
|
98
|
+
* @category layers
|
|
99
|
+
*/
|
|
100
|
+
export declare const layerCdn: (options?: {
|
|
101
|
+
readonly path?: `/${string}` | undefined;
|
|
102
|
+
readonly scalar?: ScalarConfig;
|
|
103
|
+
readonly version?: string | undefined;
|
|
104
|
+
}) => Layer.Layer<never, never, Api>;
|
|
109
105
|
/**
|
|
110
106
|
* @since 1.0.0
|
|
111
107
|
* @category layers
|
|
@@ -113,7 +109,16 @@ export declare const layer: (options?: {
|
|
|
113
109
|
export declare const layerHttpLayerRouter: (options: {
|
|
114
110
|
readonly api: HttpApi.HttpApi.Any;
|
|
115
111
|
readonly path: `/${string}`;
|
|
116
|
-
readonly
|
|
112
|
+
readonly scalar?: ScalarConfig;
|
|
113
|
+
}) => Layer.Layer<never, never, HttpLayerRouter.HttpRouter>;
|
|
114
|
+
/**
|
|
115
|
+
* @since 1.0.0
|
|
116
|
+
* @category layers
|
|
117
|
+
*/
|
|
118
|
+
export declare const layerHttpLayerRouterCdn: (options: {
|
|
119
|
+
readonly api: HttpApi.HttpApi.Any;
|
|
120
|
+
readonly path: `/${string}`;
|
|
121
|
+
readonly version?: string | undefined;
|
|
117
122
|
readonly scalar?: ScalarConfig;
|
|
118
123
|
}) => Layer.Layer<never, never, HttpLayerRouter.HttpRouter>;
|
|
119
124
|
//# sourceMappingURL=HttpApiScalar.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpApiScalar.d.ts","sourceRoot":"","sources":["../../src/HttpApiScalar.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAClC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAE5C,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAMvD;;;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,
|
|
1
|
+
{"version":3,"file":"HttpApiScalar.d.ts","sourceRoot":"","sources":["../../src/HttpApiScalar.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAA;AAClC,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAE5C,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAMvD;;;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,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;AA6DD;;;GAGG;AACH,eAAO,MAAM,KAAK,GAAI,UAAU;IAC9B,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B,KAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAc9B,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,UAAU;IACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACtC,KAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAc9B,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,CACjC,OAAO,EAAE;IACP,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAA;IACjC,QAAQ,CAAC,IAAI,EAAE,IAAI,MAAM,EAAE,CAAA;IAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B,KACE,KAAK,CAAC,KAAK,CACd,KAAK,EACL,KAAK,EACL,eAAe,CAAC,UAAU,CAeL,CAAA;AAEvB;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,CACpC,OAAO,EAAE;IACP,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAA;IACjC,QAAQ,CAAC,IAAI,EAAE,IAAI,MAAM,EAAE,CAAA;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAC/B,KACE,KAAK,CAAC,KAAK,CACd,KAAK,EACL,KAAK,EACL,eAAe,CAAC,UAAU,CAgBL,CAAA"}
|
|
@@ -13,8 +13,6 @@ import * as OpenApi from "./OpenApi.js";
|
|
|
13
13
|
const makeHandler = options => {
|
|
14
14
|
const spec = OpenApi.fromApi(options.api);
|
|
15
15
|
const source = options?.source;
|
|
16
|
-
const defaultScript = internal.javascript;
|
|
17
|
-
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;
|
|
18
16
|
const scalarConfig = {
|
|
19
17
|
_integration: "http",
|
|
20
18
|
...options?.scalar
|
|
@@ -37,7 +35,7 @@ const makeHandler = options => {
|
|
|
37
35
|
<script>
|
|
38
36
|
document.getElementById('api-reference').dataset.configuration = JSON.stringify(${Html.escapeJson(scalarConfig)})
|
|
39
37
|
</script>
|
|
40
|
-
${
|
|
38
|
+
${source._tag === "Cdn" ? `<script src="${`https://cdn.jsdelivr.net/npm/@scalar/api-reference@${source.version ?? "latest"}/dist/browser/standalone.min.js`}" crossorigin></script>` : `<script>${source.source}</script>`}
|
|
41
39
|
</body>
|
|
42
40
|
</html>`);
|
|
43
41
|
return Effect.succeed(response);
|
|
@@ -52,7 +50,29 @@ export const layer = options => Router.use(router => Effect.gen(function* () {
|
|
|
52
50
|
} = yield* Api;
|
|
53
51
|
const handler = makeHandler({
|
|
54
52
|
...options,
|
|
53
|
+
api,
|
|
54
|
+
source: {
|
|
55
|
+
_tag: "Inline",
|
|
56
|
+
source: internal.javascript
|
|
57
|
+
}
|
|
58
|
+
});
|
|
59
|
+
yield* router.get(options?.path ?? "/docs", handler);
|
|
60
|
+
}));
|
|
61
|
+
/**
|
|
62
|
+
* @since 1.0.0
|
|
63
|
+
* @category layers
|
|
64
|
+
*/
|
|
65
|
+
export const layerCdn = options => Router.use(router => Effect.gen(function* () {
|
|
66
|
+
const {
|
|
55
67
|
api
|
|
68
|
+
} = yield* Api;
|
|
69
|
+
const handler = makeHandler({
|
|
70
|
+
...options,
|
|
71
|
+
api,
|
|
72
|
+
source: {
|
|
73
|
+
_tag: "Cdn",
|
|
74
|
+
version: options?.version
|
|
75
|
+
}
|
|
56
76
|
});
|
|
57
77
|
yield* router.get(options?.path ?? "/docs", handler);
|
|
58
78
|
}));
|
|
@@ -62,7 +82,28 @@ export const layer = options => Router.use(router => Effect.gen(function* () {
|
|
|
62
82
|
*/
|
|
63
83
|
export const layerHttpLayerRouter = /*#__PURE__*/Effect.fnUntraced(function* (options) {
|
|
64
84
|
const router = yield* HttpLayerRouter.HttpRouter;
|
|
65
|
-
const handler = makeHandler(
|
|
85
|
+
const handler = makeHandler({
|
|
86
|
+
...options,
|
|
87
|
+
source: {
|
|
88
|
+
_tag: "Inline",
|
|
89
|
+
source: internal.javascript
|
|
90
|
+
}
|
|
91
|
+
});
|
|
92
|
+
yield* router.add("GET", options.path, handler);
|
|
93
|
+
}, Layer.effectDiscard);
|
|
94
|
+
/**
|
|
95
|
+
* @since 1.0.0
|
|
96
|
+
* @category layers
|
|
97
|
+
*/
|
|
98
|
+
export const layerHttpLayerRouterCdn = /*#__PURE__*/Effect.fnUntraced(function* (options) {
|
|
99
|
+
const router = yield* HttpLayerRouter.HttpRouter;
|
|
100
|
+
const handler = makeHandler({
|
|
101
|
+
...options,
|
|
102
|
+
source: {
|
|
103
|
+
_tag: "Cdn",
|
|
104
|
+
version: options?.version
|
|
105
|
+
}
|
|
106
|
+
});
|
|
66
107
|
yield* router.add("GET", options.path, handler);
|
|
67
108
|
}, Layer.effectDiscard);
|
|
68
109
|
//# sourceMappingURL=HttpApiScalar.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HttpApiScalar.js","names":["Effect","Layer","Api","Router","HttpLayerRouter","HttpServerResponse","Html","internal","OpenApi","makeHandler","options","spec","fromApi","api","source","
|
|
1
|
+
{"version":3,"file":"HttpApiScalar.js","names":["Effect","Layer","Api","Router","HttpLayerRouter","HttpServerResponse","Html","internal","OpenApi","makeHandler","options","spec","fromApi","api","source","scalarConfig","_integration","scalar","response","html","escape","info","title","description","escapeJson","_tag","version","succeed","layer","use","router","gen","handler","javascript","get","path","layerCdn","layerHttpLayerRouter","fnUntraced","HttpRouter","add","effectDiscard","layerHttpLayerRouterCdn"],"sources":["../../src/HttpApiScalar.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAGA,OAAO,KAAKA,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,SAASC,GAAG,QAAQ,cAAc;AAElC,SAASC,MAAM,QAAQ,qBAAqB;AAC5C,OAAO,KAAKC,eAAe,MAAM,sBAAsB;AACvD,OAAO,KAAKC,kBAAkB,MAAM,yBAAyB;AAC7D,OAAO,KAAKC,IAAI,MAAM,oBAAoB;AAC1C,OAAO,KAAKC,QAAQ,MAAM,6BAA6B;AACvD,OAAO,KAAKC,OAAO,MAAM,cAAc;AAkGvC,MAAMC,WAAW,GAAIC,OAUpB,IAAI;EACH,MAAMC,IAAI,GAAGH,OAAO,CAACI,OAAO,CAACF,OAAO,CAACG,GAAU,CAAC;EAEhD,MAAMC,MAAM,GAAGJ,OAAO,EAAEI,MAAM;EAE9B,MAAMC,YAAY,GAAG;IACnBC,YAAY,EAAE,MAAM;IACpB,GAAGN,OAAO,EAAEO;GACb;EAED,MAAMC,QAAQ,GAAGb,kBAAkB,CAACc,IAAI,CAAC;;;;aAI9Bb,IAAI,CAACc,MAAM,CAACT,IAAI,CAACU,IAAI,CAACC,KAAK,CAAC;MAErC,CAACX,IAAI,CAACU,IAAI,CAACE,WAAW,GAClB,EAAE,GACF,qCAAqCjB,IAAI,CAACc,MAAM,CAACT,IAAI,CAACU,IAAI,CAACE,WAAW,CAAC,KAC7E;MAEE,CAACZ,IAAI,CAACU,IAAI,CAACE,WAAW,GAClB,EAAE,GACF,wCAAwCjB,IAAI,CAACc,MAAM,CAACT,IAAI,CAACU,IAAI,CAACE,WAAW,CAAC,KAChF;;;;;;;QAOMjB,IAAI,CAACkB,UAAU,CAACb,IAAI,CAAC;;;wFAG2DL,IAAI,CAACkB,UAAU,CAACT,YAAY,CAAC;;MAGjHD,MAAM,CAACW,IAAI,KAAK,KAAK,GACjB,gBAAgB,sDAChBX,MAAM,CAACY,OAAO,IAAI,QACpB,iCAAiC,yBAAyB,GACxD,WAAWZ,MAAM,CAACA,MAAM,WAC9B;;QAEM,CAAC;EAEP,OAAOd,MAAM,CAAC2B,OAAO,CAACT,QAAQ,CAAC;AACjC,CAAC;AAED;;;;AAIA,OAAO,MAAMU,KAAK,GAAIlB,OAGrB,IACCP,MAAM,CAAC0B,GAAG,CAAEC,MAAM,IAChB9B,MAAM,CAAC+B,GAAG,CAAC,aAAS;EAClB,MAAM;IAAElB;EAAG,CAAE,GAAG,OAAOX,GAAG;EAC1B,MAAM8B,OAAO,GAAGvB,WAAW,CAAC;IAC1B,GAAGC,OAAO;IACVG,GAAG;IACHC,MAAM,EAAE;MACNW,IAAI,EAAE,QAAQ;MACdX,MAAM,EAAEP,QAAQ,CAAC0B;;GAEpB,CAAC;EACF,OAAOH,MAAM,CAACI,GAAG,CAACxB,OAAO,EAAEyB,IAAI,IAAI,OAAO,EAAEH,OAAO,CAAC;AACtD,CAAC,CAAC,CACH;AAEH;;;;AAIA,OAAO,MAAMI,QAAQ,GAAI1B,OAIxB,IACCP,MAAM,CAAC0B,GAAG,CAAEC,MAAM,IAChB9B,MAAM,CAAC+B,GAAG,CAAC,aAAS;EAClB,MAAM;IAAElB;EAAG,CAAE,GAAG,OAAOX,GAAG;EAC1B,MAAM8B,OAAO,GAAGvB,WAAW,CAAC;IAC1B,GAAGC,OAAO;IACVG,GAAG;IACHC,MAAM,EAAE;MACNW,IAAI,EAAE,KAAK;MACXC,OAAO,EAAEhB,OAAO,EAAEgB;;GAErB,CAAC;EACF,OAAOI,MAAM,CAACI,GAAG,CAACxB,OAAO,EAAEyB,IAAI,IAAI,OAAO,EAAEH,OAAO,CAAC;AACtD,CAAC,CAAC,CACH;AAEH;;;;AAIA,OAAO,MAAMK,oBAAoB,gBAU7BrC,MAAM,CAACsC,UAAU,CAAC,WAAU5B,OAI/B;EACC,MAAMoB,MAAM,GAAG,OAAO1B,eAAe,CAACmC,UAAU;EAChD,MAAMP,OAAO,GAAGvB,WAAW,CAAC;IAC1B,GAAGC,OAAO;IACVI,MAAM,EAAE;MACNW,IAAI,EAAE,QAAQ;MACdX,MAAM,EAAEP,QAAQ,CAAC0B;;GAEpB,CAAC;EACF,OAAOH,MAAM,CAACU,GAAG,CAAC,KAAK,EAAE9B,OAAO,CAACyB,IAAI,EAAEH,OAAO,CAAC;AACjD,CAAC,EAAE/B,KAAK,CAACwC,aAAa,CAAC;AAEvB;;;;AAIA,OAAO,MAAMC,uBAAuB,gBAWhC1C,MAAM,CAACsC,UAAU,CAAC,WAAU5B,OAK/B;EACC,MAAMoB,MAAM,GAAG,OAAO1B,eAAe,CAACmC,UAAU;EAChD,MAAMP,OAAO,GAAGvB,WAAW,CAAC;IAC1B,GAAGC,OAAO;IACVI,MAAM,EAAE;MACNW,IAAI,EAAE,KAAK;MACXC,OAAO,EAAEhB,OAAO,EAAEgB;;GAErB,CAAC;EACF,OAAOI,MAAM,CAACU,GAAG,CAAC,KAAK,EAAE9B,OAAO,CAACyB,IAAI,EAAEH,OAAO,CAAC;AACjD,CAAC,EAAE/B,KAAK,CAACwC,aAAa,CAAC","ignoreList":[]}
|