Socket
Socket
Sign inDemoInstall

@effect/rpc

Package Overview
Dependencies
Maintainers
0
Versions
249
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@effect/rpc - npm Package Compare versions

Comparing version 0.0.0-snapshot-6e9edd448c6d82afd40e9d971340ed91efdcfce7 to 0.0.0-snapshot-6ebc752baf28354006ca2a0ae783a5bccf5de9ad

35

dist/cjs/index.js

@@ -7,35 +7,12 @@ "use strict";

exports.Rpc = exports.Router = exports.ResolverNoStream = exports.Resolver = void 0;
var _Resolver = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Resolver.js"));
var _Resolver = _interopRequireWildcard(require("./Resolver.js"));
exports.Resolver = _Resolver;
var _ResolverNoStream = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./ResolverNoStream.js"));
var _ResolverNoStream = _interopRequireWildcard(require("./ResolverNoStream.js"));
exports.ResolverNoStream = _ResolverNoStream;
var _Router = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Router.js"));
var _Router = _interopRequireWildcard(require("./Router.js"));
exports.Router = _Router;
var _Rpc = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Rpc.js"));
var _Rpc = _interopRequireWildcard(require("./Rpc.js"));
exports.Rpc = _Rpc;
function _getRequireWildcardCache(e) {
if ("function" != typeof WeakMap) return null;
var r = new WeakMap(),
t = new WeakMap();
return (_getRequireWildcardCache = function (e) {
return e ? t : r;
})(e);
}
function _interopRequireWildcard(e, r) {
if (!r && e && e.__esModule) return e;
if (null === e || "object" != typeof e && "function" != typeof e) return {
default: e
};
var t = _getRequireWildcardCache(r);
if (t && t.has(e)) return t.get(e);
var n = {
__proto__: null
},
a = Object.defineProperty && Object.getOwnPropertyDescriptor;
for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) {
var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u];
}
return n.default = e, t && t.set(e, n), n;
}
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
//# sourceMappingURL=index.js.map

41

dist/cjs/internal/rpc.js

@@ -7,33 +7,10 @@ "use strict";

exports.withRequestTag = exports.makeRequest = exports.StreamRequestTypeId = void 0;
var Schema = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Schema"));
var Serializable = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Serializable"));
var Equal = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Equal"));
var Hash = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Hash"));
var PrimaryKey = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/PrimaryKey"));
var Request = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Request"));
function _getRequireWildcardCache(e) {
if ("function" != typeof WeakMap) return null;
var r = new WeakMap(),
t = new WeakMap();
return (_getRequireWildcardCache = function (e) {
return e ? t : r;
})(e);
}
function _interopRequireWildcard(e, r) {
if (!r && e && e.__esModule) return e;
if (null === e || "object" != typeof e && "function" != typeof e) return {
default: e
};
var t = _getRequireWildcardCache(r);
if (t && t.has(e)) return t.get(e);
var n = {
__proto__: null
},
a = Object.defineProperty && Object.getOwnPropertyDescriptor;
for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) {
var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u];
}
return n.default = e, t && t.set(e, n), n;
}
var Schema = _interopRequireWildcard(require("@effect/schema/Schema"));
var Serializable = _interopRequireWildcard(require("@effect/schema/Serializable"));
var Equal = _interopRequireWildcard(require("effect/Equal"));
var Hash = _interopRequireWildcard(require("effect/Hash"));
var PrimaryKey = _interopRequireWildcard(require("effect/PrimaryKey"));
var Request = _interopRequireWildcard(require("effect/Request"));
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
/** @internal */

@@ -57,3 +34,3 @@ const withRequestTag = f => {

const makeRequest = options => {
const isStream = (StreamRequestTypeId in options.request);
const isStream = StreamRequestTypeId in options.request;
const hash = Hash.hash(options.request);

@@ -60,0 +37,0 @@ return {

@@ -7,40 +7,17 @@ "use strict";

exports.toClient = exports.make = exports.annotateHeadersEffect = exports.annotateHeaders = void 0;
var Headers = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/platform/Headers"));
var Schema = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Schema"));
var Serializable = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Serializable"));
var Arr = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Array"));
var Cause = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Cause"));
var Effect = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Effect"));
var Exit = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Exit"));
var _Function = /*#__PURE__*/require("effect/Function");
var Request = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Request"));
var RequestResolver = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/RequestResolver"));
var Stream = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Stream"));
var _rpc = /*#__PURE__*/require("./internal/rpc.js");
var Rpc = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Rpc.js"));
function _getRequireWildcardCache(e) {
if ("function" != typeof WeakMap) return null;
var r = new WeakMap(),
t = new WeakMap();
return (_getRequireWildcardCache = function (e) {
return e ? t : r;
})(e);
}
function _interopRequireWildcard(e, r) {
if (!r && e && e.__esModule) return e;
if (null === e || "object" != typeof e && "function" != typeof e) return {
default: e
};
var t = _getRequireWildcardCache(r);
if (t && t.has(e)) return t.get(e);
var n = {
__proto__: null
},
a = Object.defineProperty && Object.getOwnPropertyDescriptor;
for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) {
var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u];
}
return n.default = e, t && t.set(e, n), n;
}
var Headers = _interopRequireWildcard(require("@effect/platform/Headers"));
var Schema = _interopRequireWildcard(require("@effect/schema/Schema"));
var Serializable = _interopRequireWildcard(require("@effect/schema/Serializable"));
var Arr = _interopRequireWildcard(require("effect/Array"));
var Cause = _interopRequireWildcard(require("effect/Cause"));
var Effect = _interopRequireWildcard(require("effect/Effect"));
var Exit = _interopRequireWildcard(require("effect/Exit"));
var _Function = require("effect/Function");
var Request = _interopRequireWildcard(require("effect/Request"));
var RequestResolver = _interopRequireWildcard(require("effect/RequestResolver"));
var Stream = _interopRequireWildcard(require("effect/Stream"));
var _rpc = require("./internal/rpc.js");
var Rpc = _interopRequireWildcard(require("./Rpc.js"));
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
/**

@@ -47,0 +24,0 @@ * @since 1.0.0

@@ -7,38 +7,15 @@ "use strict";

exports.make = void 0;
var Schema = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Schema"));
var Serializable = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Serializable"));
var Channel = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Channel"));
var Chunk = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Chunk"));
var Effect = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Effect"));
var Exit = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Exit"));
var _Function = /*#__PURE__*/require("effect/Function");
var Request = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Request"));
var RequestResolver = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/RequestResolver"));
var Stream = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Stream"));
var _rpc = /*#__PURE__*/require("./internal/rpc.js");
function _getRequireWildcardCache(e) {
if ("function" != typeof WeakMap) return null;
var r = new WeakMap(),
t = new WeakMap();
return (_getRequireWildcardCache = function (e) {
return e ? t : r;
})(e);
}
function _interopRequireWildcard(e, r) {
if (!r && e && e.__esModule) return e;
if (null === e || "object" != typeof e && "function" != typeof e) return {
default: e
};
var t = _getRequireWildcardCache(r);
if (t && t.has(e)) return t.get(e);
var n = {
__proto__: null
},
a = Object.defineProperty && Object.getOwnPropertyDescriptor;
for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) {
var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u];
}
return n.default = e, t && t.set(e, n), n;
}
var Schema = _interopRequireWildcard(require("@effect/schema/Schema"));
var Serializable = _interopRequireWildcard(require("@effect/schema/Serializable"));
var Channel = _interopRequireWildcard(require("effect/Channel"));
var Chunk = _interopRequireWildcard(require("effect/Chunk"));
var Effect = _interopRequireWildcard(require("effect/Effect"));
var Exit = _interopRequireWildcard(require("effect/Exit"));
var _Function = require("effect/Function");
var Request = _interopRequireWildcard(require("effect/Request"));
var RequestResolver = _interopRequireWildcard(require("effect/RequestResolver"));
var Stream = _interopRequireWildcard(require("effect/Stream"));
var _rpc = require("./internal/rpc.js");
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
/**

@@ -45,0 +22,0 @@ * @since 1.0.0

@@ -7,42 +7,19 @@ "use strict";

exports.toHandlerUndecoded = exports.toHandlerRaw = exports.toHandlerEffect = exports.toHandler = exports.provideServiceEffect = exports.provideService = exports.make = exports.isRouter = exports.TypeId = void 0;
var Schema = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Schema"));
var Serializable = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Serializable"));
var Cause = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Cause"));
var Channel = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Channel"));
var Chunk = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Chunk"));
var Context = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Context"));
var Effect = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Effect"));
var Exit = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Exit"));
var _Function = /*#__PURE__*/require("effect/Function");
var _Pipeable = /*#__PURE__*/require("effect/Pipeable");
var Predicate = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Predicate"));
var Queue = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Queue"));
var Stream = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Stream"));
var _rpc = /*#__PURE__*/require("./internal/rpc.js");
var Rpc = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./Rpc.js"));
function _getRequireWildcardCache(e) {
if ("function" != typeof WeakMap) return null;
var r = new WeakMap(),
t = new WeakMap();
return (_getRequireWildcardCache = function (e) {
return e ? t : r;
})(e);
}
function _interopRequireWildcard(e, r) {
if (!r && e && e.__esModule) return e;
if (null === e || "object" != typeof e && "function" != typeof e) return {
default: e
};
var t = _getRequireWildcardCache(r);
if (t && t.has(e)) return t.get(e);
var n = {
__proto__: null
},
a = Object.defineProperty && Object.getOwnPropertyDescriptor;
for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) {
var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u];
}
return n.default = e, t && t.set(e, n), n;
}
var Schema = _interopRequireWildcard(require("@effect/schema/Schema"));
var Serializable = _interopRequireWildcard(require("@effect/schema/Serializable"));
var Cause = _interopRequireWildcard(require("effect/Cause"));
var Channel = _interopRequireWildcard(require("effect/Channel"));
var Chunk = _interopRequireWildcard(require("effect/Chunk"));
var Context = _interopRequireWildcard(require("effect/Context"));
var Effect = _interopRequireWildcard(require("effect/Effect"));
var Exit = _interopRequireWildcard(require("effect/Exit"));
var _Function = require("effect/Function");
var _Pipeable = require("effect/Pipeable");
var Predicate = _interopRequireWildcard(require("effect/Predicate"));
var Queue = _interopRequireWildcard(require("effect/Queue"));
var Stream = _interopRequireWildcard(require("effect/Stream"));
var _rpc = require("./internal/rpc.js");
var Rpc = _interopRequireWildcard(require("./Rpc.js"));
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
/**

@@ -112,3 +89,3 @@ * @since 1.0.0

const spanPrefix = options?.spanPrefix ?? "Rpc.router ";
const schema = Schema.Union(...[...router.rpcs].map(rpc => Schema.transform(rpc.schema, Schema.typeSchema(Schema.Tuple(rpc.schema, Schema.Any)), {
const schema = Schema.Union(...[...router.rpcs].map(rpc => Schema.transform(rpc.schema, Schema.Tuple(Schema.typeSchema(rpc.schema), Schema.Any), {
strict: true,

@@ -222,3 +199,3 @@ decode: request => [request, rpc],

return request => {
const isStream = (_rpc.StreamRequestTypeId in request);
const isStream = _rpc.StreamRequestTypeId in request;
const withHandler = parse(request);

@@ -225,0 +202,0 @@ if (isStream) {

@@ -7,37 +7,14 @@ "use strict";

exports.stream = exports.schemaHeaders = exports.request = exports.provideServiceEffect = exports.provideService = exports.isRpc = exports.effect = exports.currentHeaders = exports.call = exports.annotateHeaders = exports.TypeId = exports.StreamRequestTypeId = exports.StreamRequest = exports.RequestSchema = void 0;
var Headers = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/platform/Headers"));
var Schema = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("@effect/schema/Schema"));
var Effect = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Effect"));
var FiberRef = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/FiberRef"));
var _Function = /*#__PURE__*/require("effect/Function");
var _GlobalValue = /*#__PURE__*/require("effect/GlobalValue");
var _Pipeable = /*#__PURE__*/require("effect/Pipeable");
var Predicate = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Predicate"));
var Stream = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("effect/Stream"));
var Internal = /*#__PURE__*/_interopRequireWildcard( /*#__PURE__*/require("./internal/rpc.js"));
function _getRequireWildcardCache(e) {
if ("function" != typeof WeakMap) return null;
var r = new WeakMap(),
t = new WeakMap();
return (_getRequireWildcardCache = function (e) {
return e ? t : r;
})(e);
}
function _interopRequireWildcard(e, r) {
if (!r && e && e.__esModule) return e;
if (null === e || "object" != typeof e && "function" != typeof e) return {
default: e
};
var t = _getRequireWildcardCache(r);
if (t && t.has(e)) return t.get(e);
var n = {
__proto__: null
},
a = Object.defineProperty && Object.getOwnPropertyDescriptor;
for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) {
var i = a ? Object.getOwnPropertyDescriptor(e, u) : null;
i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u];
}
return n.default = e, t && t.set(e, n), n;
}
var Headers = _interopRequireWildcard(require("@effect/platform/Headers"));
var Schema = _interopRequireWildcard(require("@effect/schema/Schema"));
var Effect = _interopRequireWildcard(require("effect/Effect"));
var FiberRef = _interopRequireWildcard(require("effect/FiberRef"));
var _Function = require("effect/Function");
var _GlobalValue = require("effect/GlobalValue");
var _Pipeable = require("effect/Pipeable");
var Predicate = _interopRequireWildcard(require("effect/Predicate"));
var Stream = _interopRequireWildcard(require("effect/Stream"));
var Internal = _interopRequireWildcard(require("./internal/rpc.js"));
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
/**

@@ -161,3 +138,3 @@ * @since 1.0.0

const call = (req, resolver, options) => {
const isStream = (Internal.StreamRequestTypeId in req);
const isStream = Internal.StreamRequestTypeId in req;
const res = (0, _Function.pipe)(request(req, options), Effect.flatMap(_ => Effect.request(_, resolver)));

@@ -164,0 +141,0 @@ return isStream ? Stream.unwrapScoped(res) : Effect.scoped(res);

@@ -24,3 +24,3 @@ import * as Schema from "@effect/schema/Schema";

export const makeRequest = options => {
const isStream = (StreamRequestTypeId in options.request);
const isStream = StreamRequestTypeId in options.request;
const hash = Hash.hash(options.request);

@@ -27,0 +27,0 @@ return {

@@ -78,3 +78,3 @@ import * as Schema from "@effect/schema/Schema";

const spanPrefix = options?.spanPrefix ?? "Rpc.router ";
const schema = Schema.Union(...[...router.rpcs].map(rpc => Schema.transform(rpc.schema, Schema.typeSchema(Schema.Tuple(rpc.schema, Schema.Any)), {
const schema = Schema.Union(...[...router.rpcs].map(rpc => Schema.transform(rpc.schema, Schema.Tuple(Schema.typeSchema(rpc.schema), Schema.Any), {
strict: true,

@@ -186,3 +186,3 @@ decode: request => [request, rpc],

return request => {
const isStream = (StreamRequestTypeId in request);
const isStream = StreamRequestTypeId in request;
const withHandler = parse(request);

@@ -189,0 +189,0 @@ if (isStream) {

@@ -121,3 +121,3 @@ /**

export const call = (req, resolver, options) => {
const isStream = (Internal.StreamRequestTypeId in req);
const isStream = Internal.StreamRequestTypeId in req;
const res = pipe(request(req, options), Effect.flatMap(_ => Effect.request(_, resolver)));

@@ -124,0 +124,0 @@ return isStream ? Stream.unwrapScoped(res) : Effect.scoped(res);

{
"name": "@effect/rpc",
"version": "0.0.0-snapshot-6e9edd448c6d82afd40e9d971340ed91efdcfce7",
"version": "0.0.0-snapshot-6ebc752baf28354006ca2a0ae783a5bccf5de9ad",
"description": "Functional programming in TypeScript",

@@ -13,5 +13,5 @@ "license": "MIT",

"peerDependencies": {
"@effect/platform": "^0.0.0-snapshot-6e9edd448c6d82afd40e9d971340ed91efdcfce7",
"@effect/schema": "^0.0.0-snapshot-6e9edd448c6d82afd40e9d971340ed91efdcfce7",
"effect": "^0.0.0-snapshot-6e9edd448c6d82afd40e9d971340ed91efdcfce7"
"@effect/platform": "^0.0.0-snapshot-6ebc752baf28354006ca2a0ae783a5bccf5de9ad",
"@effect/schema": "^0.0.0-snapshot-6ebc752baf28354006ca2a0ae783a5bccf5de9ad",
"effect": "^0.0.0-snapshot-6ebc752baf28354006ca2a0ae783a5bccf5de9ad"
},

@@ -18,0 +18,0 @@ "publishConfig": {

@@ -1,64 +0,303 @@

# Effect
# Introduction
Welcome to Effect, a powerful TypeScript framework that provides a fully-fledged functional effect system with a rich standard library.
The `@effect/rpc` library facilitates the development of remote procedure call (RPC) systems in TypeScript, enhancing application scalability and maintainability. It provides a type-safe environment that reduces runtime errors by aligning with TypeScript's strong typing. This library simplifies the creation of network-exposed services, handling the intricacies of data serialization and network communication, allowing developers to concentrate on core business logic. Its features support custom serialization, error handling, and middleware, making it adaptable for diverse application needs.
# Requirements
# Quickstart
- TypeScript 5.0 or newer
- The `strict` flag enabled in your `tsconfig.json` file
## Declaring Requests
The `TaggedRequest` API in the `@effect/schema` library is designed to facilitate the creation of structured requests that can serialize function signatures involving input arguments, successful outcomes, and potential failures. Essentially, it's a tool for defining a serializable function that can be reliably transported across different systems or network layers.
Here’s a simplified explanation:
1. **Function Modeling**: `TaggedRequest` allows you to model a function signature as a class, which includes the input arguments, the type of the success response, and the type of the failure response.
2. **Serialization Schema**: For each component (input, success, failure), you specify a corresponding schema. This setup helps ensure that the data associated with each request can be properly serialized (converted to a format suitable for storage or transmission) and deserialized (converted back to usable format).
3. **Usage Scenario**: This API is particularly useful when you need to handle remote procedure calls (RPCs) where functions and their arguments need to be sent over a network, processed, and then responded to asynchronously.
4. **Streamlined Code**: By leveraging `Schema.TaggedRequest`, developers can reduce the amount of boilerplate code typically required for handling complex data serialization and deserialization tasks in distributed systems.
In practice, when you create an instance of `TaggedRequest`, you define the function's behavior along with its serialization rules, which streamlines the process of encoding input data, sending it across a network, and decoding responses.
```mermaid
sequenceDiagram
Sender->>SenderBound: encodes A to I
SenderBound-->>ReceiverBound: send I
ReceiverBound->>Receiver: decodes I to A
Receiver->>ReceiverBound: encodes Exit<Success, Failure><br/>to Exit<SuccessEncoded, FailureEncoded>
ReceiverBound-->>SenderBound: send back<br/>Exit<SuccessEncoded, FailureEncoded>
SenderBound->>Sender: decodes Exit<SuccessEncoded, FailureEncoded><br/>to Exit<Success, Failure>
```
{
// ...
"compilerOptions": {
// ...
"strict": true,
```ts filename="request.ts"
// request.ts
import { Schema } from "@effect/schema"
// Define a user with an ID and name
export class User extends Schema.Class<User>("User")({
id: Schema.String, // User's ID as a string
name: Schema.String // User's name as a string
}) {}
// Request to retrieve a list of users
export class UserList extends Schema.TaggedRequest<UserList>()(
"UserList",
Schema.Never, // Indicates that no errors are expected
Schema.Array(User), // Specifies that the response is an array of Users
{}
) {}
// Request to retrieve a user by ID
export class UserById extends Schema.TaggedRequest<UserById>()(
"UserById",
Schema.String, // Indicates that errors, if any, will be returned as strings
User, // Specifies that the response is a User
{
id: Schema.String
}
) {}
// Request to create a new user
export class UserCreate extends Schema.TaggedRequest<UserCreate>()(
"UserCreate",
Schema.Never, // Indicates that no errors are expected
User, // Specifies that the response is a User
{
name: Schema.String
}
) {}
```
## Defining a Router
This section introduces how to configure a router using an imaginary database setup to manage user data.
```ts filename="router.ts"
// router.ts
import { Router, Rpc } from "@effect/rpc"
import { Effect, Ref } from "effect"
import { User, UserById, UserCreate, UserList } from "./request.js"
// ---------------------------------------------
// Imaginary Database
// ---------------------------------------------
const ref = Ref.unsafeMake<Array<User>>([
new User({ id: "1", name: "Alice" }),
new User({ id: "2", name: "Bob" })
])
const db = {
user: {
findMany: () => ref.get,
findById: (id: string) =>
Ref.get(ref).pipe(
Effect.andThen((users) => {
const user = users.find((user) => user.id === id)
return user
? Effect.succeed(user)
: Effect.fail(`User not found: ${id}`)
})
),
create: (name: string) =>
Ref.updateAndGet(ref, (users) => [
...users,
new User({ id: String(users.length + 1), name })
]).pipe(Effect.andThen((users) => users[users.length - 1]))
}
}
// ---------------------------------------------
// Router
// ---------------------------------------------
export const appRouter = Router.make(
Rpc.effect(UserList, () => db.user.findMany()),
Rpc.effect(UserById, ({ id }) => db.user.findById(id)),
Rpc.effect(UserCreate, ({ name }) => db.user.create(name))
)
export type AppRouter = typeof appRouter
```
## Documentation
## Serving the API
For detailed information and usage examples, please visit the [Effect website](https://www.effect.website/).
This part explains how to serve the API using the defined router.
## Introduction to Effect
```ts filename="server.ts"
// server.ts
import { HttpRouter, HttpServer } from "@effect/platform"
import { NodeHttpServer, NodeRuntime } from "@effect/platform-node"
import { toHttpApp } from "@effect/rpc-http/HttpRouter"
import { Layer } from "effect"
import { createServer } from "http"
import { appRouter } from "./router.js"
To get started with Effect, watch our introductory video on YouTube. This video provides an overview of Effect and its key features, making it a great starting point for newcomers:
const HttpLive = HttpRouter.empty.pipe(
HttpRouter.post("/rpc", toHttpApp(appRouter)),
HttpServer.serve(),
HttpServer.withLogAddress,
Layer.provide(NodeHttpServer.layer(createServer, { port: 3000 }))
)
[![Introduction to Effect](https://img.youtube.com/vi/SloZE4i4Zfk/maxresdefault.jpg)](https://youtu.be/SloZE4i4Zfk)
NodeRuntime.runMain(Layer.launch(HttpLive))
```
## Connect with Our Community
**Testing the API with curl**
Join our vibrant community on Discord to interact with fellow developers, ask questions, and share your experiences. Here's the invite link to our Discord server: [Join Effect's Discord Community](https://discord.gg/hdt7t7jpvn).
Use this `curl` command to test if the API is operational:
## API Reference
```bash
curl -X POST http://localhost:3000/rpc \
-H "Content-Type: application/json" \
-d '[
{
"request": { "_tag": "UserList" },
"traceId": "traceId",
"spanId": "spanId",
"sampled": true,
"headers": {}
}
]'
```
For detailed information on the Effect API, please refer to our [API Reference](https://effect-ts.github.io/effect/).
## Using your new backend on the client
## Pull Requests
Let's now move to the client-side code and embrace the power of end-to-end typesafety.
We welcome contributions via pull requests! Here are some guidelines to help you get started:
```ts
// client.ts
import { HttpClient, HttpClientRequest } from "@effect/platform"
import { Resolver } from "@effect/rpc"
import { HttpResolver } from "@effect/rpc-http"
import { Effect } from "effect"
import { UserCreate, UserList } from "./request.js"
import type { AppRouter } from "./router.js"
1. Fork the repository and clone it to your local machine.
2. Create a new branch for your changes: `git checkout -b my-new-feature`.
3. Ensure you have the required dependencies installed by running: `pnpm install` (assuming pnpm version `8.x`).
4. Make your desired changes and, if applicable, include tests to validate your modifications.
5. Run the following commands to ensure the integrity of your changes:
- `pnpm check`: Verify that the code compiles.
- `pnpm test`: Execute the tests.
- `pnpm circular`: Confirm there are no circular imports.
- `pnpm lint`: Check for code style adherence (if you happen to encounter any errors during this process, you can use `pnpm lint-fix` to automatically fix some of these style issues).
- `pnpm dtslint`: Run type-level tests.
- `pnpm docgen`: Update the automatically generated documentation.
6. Create a changeset for your changes: before committing your changes, create a changeset to document the modifications. This helps in tracking and communicating the changes effectively. To create a changeset, run the following command: `pnpm changeset`. Always choose the `patch` option when prompted (please note that we are currently in pre-release mode).
7. Commit your changes: after creating the changeset, commit your changes with a descriptive commit message: `git commit -am 'Add some feature'`.
8. Push your changes to your fork: `git push origin my-new-feature`.
9. Open a pull request against our `main` branch.
// Create the client
const client = Resolver.toClient(
HttpResolver.make<AppRouter>(
HttpClient.fetchOk.pipe(
HttpClient.mapRequest(
HttpClientRequest.prependUrl("http://localhost:3000/rpc")
)
)
)
)
### Pull Request Guidelines
// Use the client
const program = Effect.gen(function* () {
let users = yield* client(new UserList())
if (!users.find((user) => user.id === "3")) {
console.log(`Creating user "Charlie"`)
yield* client(new UserCreate({ name: "Charlie" }))
users = yield* client(new UserList())
} else {
console.log(`User "Charlie" already exists`)
}
return users
})
- Please make sure your changes are consistent with the project's existing style and conventions.
- Please write clear commit messages and include a summary of your changes in the pull request description.
- Please make sure all tests pass and add new tests as necessary.
- If your change requires documentation, please update the relevant documentation.
- Please be patient! We will do our best to review your pull request as soon as possible.
Effect.runPromise(program).then(console.log)
```
# Stream
## Setting Up the Stream Request
```ts filename="request.ts"
// request.ts
import * as Rpc from "@effect/rpc/Rpc"
import { Schema } from "@effect/schema"
export class Counts extends Rpc.StreamRequest<Counts>()(
"Counts",
Schema.Never, // No error schema defined
Schema.Number, // Output is a number
{}
) {}
```
## Defining the Router
In the router setup, we link the Counts request to a function that emits numbers from 1 to 5 at regular intervals.
```ts filename="router.ts"
// router.ts
import { Router, Rpc } from "@effect/rpc"
import { Effect, Stream } from "effect"
import { Counts } from "./request.js"
export const appRouter = Router.make(
Rpc.stream(Counts, () =>
Stream.make(1, 2, 3, 4, 5).pipe(Stream.tap(() => Effect.sleep("1 second")))
)
)
export type AppRouter = typeof appRouter
```
## Serving the API
The server code configures an HTTP server to handle requests, using our appRouter to manage incoming stream requests.
```ts filename="server.ts"
// server.ts
import { HttpRouter, HttpServer } from "@effect/platform"
import { NodeHttpServer, NodeRuntime } from "@effect/platform-node"
import { toHttpApp } from "@effect/rpc-http/HttpRouter"
import { Layer } from "effect"
import { createServer } from "http"
import { appRouter } from "./router.js"
const HttpLive = HttpRouter.empty.pipe(
HttpRouter.post("/rpc", toHttpApp(appRouter)),
HttpServer.serve(),
HttpServer.withLogAddress,
Layer.provide(NodeHttpServer.layer(createServer, { port: 3000 }))
)
NodeRuntime.runMain(Layer.launch(HttpLive))
```
## Consuming the Stream from the Client
```ts filename="client.ts"
// client.ts
import { HttpClient, HttpClientRequest } from "@effect/platform"
import { Resolver } from "@effect/rpc"
import { HttpResolver } from "@effect/rpc-http"
import { Effect, Stream } from "effect"
import { Counts } from "./request.js"
import type { AppRouter } from "./router.js"
const client = Resolver.toClient(
HttpResolver.make<AppRouter>(
HttpClient.fetchOk.pipe(
HttpClient.mapRequest(
HttpClientRequest.prependUrl("http://localhost:3000/rpc")
)
)
)
)
const program = Effect.gen(function* () {
yield* Effect.log("Running the client")
const stream = client(new Counts())
return yield* stream.pipe(
Stream.tap((element) => Effect.log(element)),
Stream.runCollect
)
})
Effect.runPromise(program)
/*
timestamp=...:50.395Z level=INFO fiber=#0 message="Running the client"
timestamp=...:52.438Z level=INFO fiber=#1 message=1
timestamp=...:53.438Z level=INFO fiber=#1 message=2
timestamp=...:54.440Z level=INFO fiber=#1 message=3
timestamp=...:55.445Z level=INFO fiber=#1 message=4
timestamp=...:55.447Z level=INFO fiber=#1 message=5
*/
```

@@ -206,3 +206,3 @@ /**

rpc.schema,
Schema.typeSchema(Schema.Tuple(rpc.schema, Schema.Any)),
Schema.Tuple(Schema.typeSchema(rpc.schema), Schema.Any),
{ strict: true, decode: (request) => [request, rpc] as const, encode: ([request]) => request }

@@ -209,0 +209,0 @@ )

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc