npm - spiceflow - Versions diffs - 0.0.7 → 1.0.1 - Mend

spiceflow 0.0.7 → 1.0.1

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 (151) hide show

package/README.md +1 -171
package/dist/client/errors.d.ts +7 -0
package/dist/client/errors.d.ts.map +1 -0
package/dist/client/errors.js +18 -0
package/dist/client/errors.js.map +1 -0
package/dist/client/index.d.ts +15 -0
package/dist/client/index.d.ts.map +1 -0
package/dist/client/index.js +376 -0
package/dist/client/index.js.map +1 -0
package/dist/client/types.d.ts +87 -0
package/dist/client/types.d.ts.map +1 -0
package/dist/client/types.js +2 -0
package/dist/client/types.js.map +1 -0
package/dist/client/utils.d.ts +2 -0
package/dist/client/utils.d.ts.map +1 -0
package/dist/client/utils.js +9 -0
package/dist/client/utils.js.map +1 -0
package/dist/client/ws.d.ts +15 -0
package/dist/client/ws.d.ts.map +1 -0
package/dist/client/ws.js +51 -0
package/dist/client/ws.js.map +1 -0
package/dist/client.test.d.ts +2 -0
package/dist/client.test.d.ts.map +1 -0
package/dist/client.test.js +237 -0
package/dist/client.test.js.map +1 -0
package/dist/elysia-fork/context.d.ts +87 -0
package/dist/elysia-fork/context.d.ts.map +1 -0
package/dist/elysia-fork/context.js +2 -0
package/dist/elysia-fork/context.js.map +1 -0
package/dist/elysia-fork/error.d.ts +246 -0
package/dist/elysia-fork/error.d.ts.map +1 -0
package/dist/elysia-fork/error.js +195 -0
package/dist/elysia-fork/error.js.map +1 -0
package/dist/elysia-fork/types.d.ts +570 -0
package/dist/elysia-fork/types.d.ts.map +1 -0
package/dist/elysia-fork/types.js +3 -0
package/dist/elysia-fork/types.js.map +1 -0
package/dist/elysia-fork/utils.d.ts +134 -0
package/dist/elysia-fork/utils.d.ts.map +1 -0
package/dist/elysia-fork/utils.js +70 -0
package/dist/elysia-fork/utils.js.map +1 -0
package/dist/index.d.ts +2 -7
package/dist/index.d.ts.map +1 -1
package/dist/index.js +1 -22
package/dist/index.js.map +1 -1
package/dist/spiceflow.d.ts +237 -0
package/dist/spiceflow.d.ts.map +1 -0
package/dist/spiceflow.js +484 -0
package/dist/spiceflow.js.map +1 -0
package/dist/spiceflow.test.d.ts +2 -0
package/dist/spiceflow.test.d.ts.map +1 -0
package/dist/spiceflow.test.js +225 -0
package/dist/spiceflow.test.js.map +1 -0
package/dist/stream.test.d.ts +2 -0
package/dist/stream.test.d.ts.map +1 -0
package/dist/stream.test.js +286 -0
package/dist/stream.test.js.map +1 -0
package/dist/types.d.ts +1 -0
package/dist/types.d.ts.map +1 -0
package/dist/types.js +2 -0
package/dist/types.js.map +1 -0
package/dist/utils.d.ts +4 -20
package/dist/utils.d.ts.map +1 -1
package/dist/utils.js +17 -46
package/dist/utils.js.map +1 -1
package/package.json +12 -37
package/src/client/errors.ts +21 -0
package/src/client/index.ts +541 -0
package/src/client/types.ts +233 -0
package/src/client/utils.ts +7 -0
package/src/client/ws.ts +99 -0
package/src/client.test.ts +235 -0
package/src/elysia-fork/context.ts +196 -0
package/src/elysia-fork/error.ts +293 -0
package/src/elysia-fork/types.ts +1353 -0
package/src/elysia-fork/utils.ts +85 -0
package/src/index.ts +2 -34
package/src/spiceflow.test.ts +290 -0
package/src/spiceflow.ts +1251 -0
package/src/stream.test.ts +342 -0
package/src/types.ts +0 -0
package/src/utils.ts +21 -70
package/context.d.ts +0 -2
package/context.js +0 -1
package/dist/babel.test.d.ts +0 -2
package/dist/babel.test.d.ts.map +0 -1
package/dist/babel.test.js +0 -27
package/dist/babel.test.js.map +0 -1
package/dist/babelDebugOutputs.d.ts +0 -9
package/dist/babelDebugOutputs.d.ts.map +0 -1
package/dist/babelDebugOutputs.js +0 -34
package/dist/babelDebugOutputs.js.map +0 -1
package/dist/babelTransformRpc.d.ts +0 -19
package/dist/babelTransformRpc.d.ts.map +0 -1
package/dist/babelTransformRpc.js +0 -285
package/dist/babelTransformRpc.js.map +0 -1
package/dist/browser.d.ts +0 -8
package/dist/browser.d.ts.map +0 -1
package/dist/browser.js +0 -126
package/dist/browser.js.map +0 -1
package/dist/build.d.ts +0 -13
package/dist/build.d.ts.map +0 -1
package/dist/build.js +0 -230
package/dist/build.js.map +0 -1
package/dist/cli.d.ts +0 -3
package/dist/cli.d.ts.map +0 -1
package/dist/cli.js +0 -111
package/dist/cli.js.map +0 -1
package/dist/context-internal.d.ts +0 -20
package/dist/context-internal.d.ts.map +0 -1
package/dist/context-internal.js +0 -16
package/dist/context-internal.js.map +0 -1
package/dist/context.d.ts +0 -2
package/dist/context.d.ts.map +0 -1
package/dist/context.js +0 -2
package/dist/context.js.map +0 -1
package/dist/expose.d.ts +0 -6
package/dist/expose.d.ts.map +0 -1
package/dist/expose.js +0 -32
package/dist/expose.js.map +0 -1
package/dist/headers.d.ts +0 -2
package/dist/headers.d.ts.map +0 -1
package/dist/headers.js +0 -18
package/dist/headers.js.map +0 -1
package/dist/jsonRpc.d.ts +0 -32
package/dist/jsonRpc.d.ts.map +0 -1
package/dist/jsonRpc.js +0 -3
package/dist/jsonRpc.js.map +0 -1
package/dist/server.d.ts +0 -32
package/dist/server.d.ts.map +0 -1
package/dist/server.js +0 -292
package/dist/server.js.map +0 -1
package/headers.d.ts +0 -2
package/headers.js +0 -1
package/sdk-template/package.json +0 -22
package/sdk-template/src/index.ts +0 -2
package/sdk-template/src/v1/example.ts +0 -5
package/sdk-template/src/v1/generator.ts +0 -12
package/sdk-template/tsconfig.json +0 -16
package/src/babel.test.ts +0 -35
package/src/babelDebugOutputs.ts +0 -56
package/src/babelTransformRpc.ts +0 -394
package/src/browser.ts +0 -141
package/src/build.ts +0 -298
package/src/cli.ts +0 -132
package/src/context-internal.ts +0 -36
package/src/context.ts +0 -5
package/src/expose.ts +0 -34
package/src/headers.ts +0 -19
package/src/jsonRpc.ts +0 -43
package/src/server.ts +0 -384

package/src/client/types.ts ADDED Viewed

@@ -0,0 +1,233 @@
+/// <reference lib="dom" />
+import type { Spiceflow } from '../spiceflow'
+// import { EdenWS } from './ws'
+// import type { IsNever, Not, Prettify } from '../types'
+import { EdenFetchError } from './errors'
+import { EdenWS } from './ws'
+export type Prettify<T> = {
+	[K in keyof T]: T[K]
+} & {}
+export type IsNever<T> = [T] extends [never] ? true : false
+type Files = File | FileList
+// type Replace<RecordType, TargetType, GenericType> = {
+//     [K in keyof RecordType]: RecordType[K] extends TargetType
+//         ? GenericType
+//         : RecordType[K]
+// }
+type ReplaceBlobWithFiles<in out RecordType extends Record<string, unknown>> = {
+	[K in keyof RecordType]: RecordType[K] extends Blob | Blob[]
+		? Files
+		: RecordType[K]
+} & {}
+type And<A extends boolean, B extends boolean> = A extends true
+	? B extends true
+		? true
+		: false
+	: false
+type ReplaceGeneratorWithAsyncGenerator<
+	in out RecordType extends Record<string, unknown>
+> = {
+	[K in keyof RecordType]: RecordType[K] extends Generator<
+		infer A,
+		infer B,
+		infer C
+	>
+		? And<Not<IsNever<A>>, void extends B ? true : false> extends true
+			? AsyncGenerator<A, B, C>
+			: And<IsNever<A>, void extends B ? false : true> extends true
+			? B
+			: AsyncGenerator<A, B, C> | B
+		: RecordType[K] extends AsyncGenerator<infer A, infer B, infer C>
+		? And<Not<IsNever<A>>, void extends B ? true : false> extends true
+			? AsyncGenerator<A, B, C>
+			: And<IsNever<A>, void extends B ? false : true> extends true
+			? B
+			: AsyncGenerator<A, B, C> | B
+		: RecordType[K]
+} & {}
+type MaybeArray<T> = T | T[]
+type MaybePromise<T> = T | Promise<T>
+export namespace SpiceflowClient {
+	interface TreatyParam {
+		fetch?: RequestInit
+	}
+	export type Create<
+		App extends Spiceflow<any, any, any, any, any, any, any, any>
+	> = App extends {
+		_routes: infer Schema extends Record<string, any>
+	}
+		? Prettify<Sign<Schema>>
+		: 'Please install Spiceflow before using Eden'
+	export type Sign<in out Route extends Record<string, any>> = {
+		[K in keyof Route as K extends `:${string}`
+			? never
+			: K]: K extends 'subscribe' // ? Websocket route
+			? (undefined extends Route['subscribe']['headers']
+					? { headers?: Record<string, unknown> }
+					: {
+							headers: Route['subscribe']['headers']
+					  }) &
+					(undefined extends Route['subscribe']['query']
+						? { query?: Record<string, unknown> }
+						: {
+								query: Route['subscribe']['query']
+						  }) extends infer Param
+				? {} extends Param
+					? (options?: Param) => EdenWS<Route['subscribe']>
+					: (options?: Param) => EdenWS<Route['subscribe']>
+				: never
+			: Route[K] extends {
+					body: infer Body
+					headers: infer Headers
+					params: any
+					query: infer Query
+					response: infer Response extends Record<number, unknown>
+			  }
+			? (undefined extends Headers
+					? { headers?: Record<string, unknown> }
+					: {
+							headers: Headers
+					  }) &
+					(undefined extends Query
+						? { query?: Record<string, unknown> }
+						: { query: Query }) extends infer Param
+				? {} extends Param
+					? undefined extends Body
+						? K extends 'get' | 'head'
+							? (
+									options?: Prettify<Param & TreatyParam>
+							  ) => Promise<
+									TreatyResponse<
+										ReplaceGeneratorWithAsyncGenerator<Response>
+									>
+							  >
+							: (
+									body?: Body,
+									options?: Prettify<Param & TreatyParam>
+							  ) => Promise<
+									TreatyResponse<
+										ReplaceGeneratorWithAsyncGenerator<Response>
+									>
+							  >
+						: (
+								body: Body extends Record<string, unknown>
+									? ReplaceBlobWithFiles<Body>
+									: Body,
+								options?: Prettify<Param & TreatyParam>
+						  ) => Promise<
+								TreatyResponse<
+									ReplaceGeneratorWithAsyncGenerator<Response>
+								>
+						  >
+					: K extends 'get' | 'head'
+					? (
+							options: Prettify<Param & TreatyParam>
+					  ) => Promise<
+							TreatyResponse<
+								ReplaceGeneratorWithAsyncGenerator<Response>
+							>
+					  >
+					: (
+							body: Body extends Record<string, unknown>
+								? ReplaceBlobWithFiles<Body>
+								: Body,
+							options: Prettify<Param & TreatyParam>
+					  ) => Promise<
+							TreatyResponse<
+								ReplaceGeneratorWithAsyncGenerator<Response>
+							>
+					  >
+				: never
+			: CreateParams<Route[K]>
+	}
+	type CreateParams<Route extends Record<string, any>> = Extract<
+		keyof Route,
+		`:${string}`
+	> extends infer Path extends string
+		? IsNever<Path> extends true
+			? Prettify<Sign<Route>>
+			: // ! DO NOT USE PRETTIFY ON THIS LINE, OTHERWISE FUNCTION CALLING WILL BE OMITTED
+			  (((params: {
+					[param in Path extends `:${infer Param}`
+						? Param extends `${infer Param}?`
+							? Param
+							: Param
+						: never]: string | number
+			  }) => Prettify<Sign<Route[Path]>> & CreateParams<Route[Path]>) &
+					Prettify<Sign<Route>>) &
+					(Path extends `:${string}?`
+						? CreateParams<Route[Path]>
+						: {})
+		: never
+	export interface Config {
+		fetch?: Omit<RequestInit, 'headers' | 'method'>
+		fetcher?: typeof fetch
+		headers?: MaybeArray<
+			| RequestInit['headers']
+			| ((
+					path: string,
+					options: RequestInit
+			  ) => RequestInit['headers'] | void)
+		>
+		onRequest?: MaybeArray<
+			(
+				path: string,
+				options: RequestInit
+			) => MaybePromise<RequestInit | void>
+		>
+		onResponse?: MaybeArray<(response: Response) => MaybePromise<unknown>>
+		keepDomain?: boolean
+	}
+	// type UnwrapAwaited<T extends Record<number, unknown>> = {
+	//     [K in keyof T]: Awaited<T[K]>
+	// }
+	export type TreatyResponse<Res extends Record<number, unknown>> =
+		| {
+				data: Res[200]
+				error: null
+				response: Response
+				status: number
+				headers: RequestInit['headers']
+		  }
+		| {
+				data: null
+				error: Exclude<keyof Res, 200> extends never
+					? EdenFetchError<number, any>
+					: {
+							[Status in keyof Res]: EdenFetchError<
+								Status,
+								Res[Status]
+							>
+					  }[Exclude<keyof Res, 200>]
+				response: Response
+				status: number
+				headers: RequestInit['headers']
+		  }
+	export interface OnMessage<Data = unknown> extends MessageEvent {
+		data: Data
+		rawData: MessageEvent['data']
+	}
+	export type WSEvent<
+		K extends keyof WebSocketEventMap,
+		Data = unknown
+	> = K extends 'message' ? OnMessage<Data> : WebSocketEventMap[K]
+}
+export type Not<T> = T extends true ? false : true

package/src/client/utils.ts ADDED Viewed

@@ -0,0 +1,7 @@
+export function parseStringifiedValue(value: string) {
+	try {
+		return JSON.parse(value)
+	} catch (error) {
+		return value
+	}
+}

package/src/client/ws.ts ADDED Viewed

@@ -0,0 +1,99 @@
+import type { InputSchema } from '../elysia-fork/types'
+import type { SpiceflowClient } from './types'
+import { parseStringifiedValue } from './utils'
+export class EdenWS<in out Schema extends InputSchema<any> = {}> {
+	ws: WebSocket
+	constructor(public url: string) {
+		this.ws = new WebSocket(url)
+	}
+	send(data: Schema['body'] | Schema['body'][]) {
+		if (Array.isArray(data)) {
+			data.forEach((datum) => this.send(datum))
+			return this
+		}
+		this.ws.send(
+			typeof data === 'object' ? JSON.stringify(data) : data.toString()
+		)
+		return this
+	}
+	on<K extends keyof WebSocketEventMap>(
+		type: K,
+		listener: (event: SpiceflowClient.WSEvent<K, Schema['response']>) => void,
+		options?: boolean | AddEventListenerOptions
+	) {
+		return this.addEventListener(type, listener, options)
+	}
+	off<K extends keyof WebSocketEventMap>(
+		type: K,
+		listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any,
+		options?: boolean | EventListenerOptions
+	) {
+		this.ws.removeEventListener(type, listener, options)
+		return this
+	}
+	subscribe(
+		onMessage: (
+			event: SpiceflowClient.WSEvent<'message', Schema['response']>
+		) => void,
+		options?: boolean | AddEventListenerOptions
+	) {
+		return this.addEventListener('message', onMessage, options)
+	}
+	addEventListener<K extends keyof WebSocketEventMap>(
+		type: K,
+		listener: (event: SpiceflowClient.WSEvent<K, Schema['response']>) => void,
+		options?: boolean | AddEventListenerOptions
+	) {
+		this.ws.addEventListener(
+			type,
+			(ws) => {
+				if (type === 'message') {
+					const data = parseMessageEvent(ws as MessageEvent)
+					listener({
+						...ws,
+						data
+					} as any)
+				} else listener(ws as any)
+			},
+			options
+		)
+		return this
+	}
+	removeEventListener<K extends keyof WebSocketEventMap>(
+		type: K,
+		listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any,
+		options?: boolean | EventListenerOptions
+	) {
+		this.off(type, listener, options)
+		return this
+	}
+	close() {
+		this.ws.close()
+		return this
+	}
+}
+const parseMessageEvent = (event: MessageEvent) => {
+	const messageString = event.data.toString()
+	return messageString === 'null'
+		? null
+		: parseStringifiedValue(messageString)
+}

package/src/client.test.ts ADDED Viewed

@@ -0,0 +1,235 @@
+import { createSpiceflowClient } from './client'
+import { Spiceflow, t } from './spiceflow'
+import { describe, expect, it } from 'vitest'
+const randomObject = {
+	a: 'a',
+	b: 2,
+	c: true,
+	d: false,
+	e: null,
+	f: new Date(0)
+}
+const randomArray = [
+	'a',
+	2,
+	true,
+	false,
+	null,
+	new Date(0),
+	{ a: 'a', b: 2, c: true, d: false, e: null, f: new Date(0) }
+]
+const app = new Spiceflow()
+	.get('/', () => 'a')
+	.post('/', () => 'a')
+	.get('/number', () => 1)
+	.get('/true', () => true)
+	.get('/false', () => false)
+	.post('/array', ({ body }) => body, {
+		body: t.Array(t.String())
+	})
+	.post('/mirror', ({ body }) => body)
+	.post('/body', ({ body }) => body, {
+		body: t.String()
+	})
+	.delete('/empty', ({ body }) => ({ body: body ?? null }))
+	.post('/deep/nested/mirror', ({ body }) => body, {
+		body: t.Object({
+			username: t.String(),
+			password: t.String()
+		})
+	})
+	.use(new Spiceflow({ basePath: '/nested' }).get('/data', ({ params }) => 'hi'))
+	// .get('/error', ({ error }) => error("I'm a teapot", 'Kirifuji Nagisa'), {
+	// 	response: {
+	// 		200: t.Void(),
+	// 		418: t.Literal('Kirifuji Nagisa'),
+	// 		420: t.Literal('Snoop Dogg')
+	// 	}
+	// })
+	.get(
+		'/validationError',
+		// @ts-expect-error
+		() => {
+			return 'this errors because validation is wrong'
+		},
+		{
+			response: {
+				200: t.Object({
+					x: t.String()
+				})
+			}
+		}
+	)
+	.post('/date', ({ body: { date } }) => date, {
+		body: t.Object({
+			date: t.Date()
+		})
+	})
+	.get('/dateObject', () => ({ date: new Date() }))
+	.get('/redirect', ({ redirect }) => redirect('http://localhost:8083/true'))
+	.post(
+		'/redirect',
+		({ redirect }) => redirect('http://localhost:8083/true'),
+		{
+			body: t.Object({
+				username: t.String()
+			})
+		}
+	)
+	// .get('/formdata', () => ({
+	// 	image: Bun.file('./test/kyuukurarin.mp4')
+	// }))
+	.get('/stream', function* stream() {
+		yield 'a'
+		yield 'b'
+		yield 'c'
+	})
+	.get('/stream-async', async function* stream() {
+		yield 'a'
+		yield 'b'
+		yield 'c'
+	})
+	.get('/stream-return', function* stream() {
+		return 'a'
+	})
+	.get('/stream-return-async', function* stream() {
+		return 'a'
+	})
+	.get('/id/:id?', ({ params: { id = 'unknown' } }) => id)
+const client = createSpiceflowClient(app)
+describe('client', () => {
+	it('get index', async () => {
+		const { data, error } = await client.index.get()
+		expect(data).toBe('a')
+		expect(error).toBeNull()
+	})
+	it('post index', async () => {
+		const { data, error } = await client.index.post()
+		expect(data).toBe('a')
+		expect(error).toBeNull()
+	})
+	it('parse number', async () => {
+		const { data } = await client.number.get()
+		expect(data).toEqual(1)
+	})
+	it('parse true', async () => {
+		const { data } = await client.true.get()
+		expect(data).toEqual(true)
+	})
+	it('parse false', async () => {
+		const { data } = await client.false.get()
+		expect(data).toEqual(false)
+	})
+	it.todo('parse object with date', async () => {
+		const { data } = await client.dateObject.get()
+		expect(data?.date).toBeInstanceOf(Date)
+	})
+	it('post array', async () => {
+		const { data } = await client.array.post(['a', 'b'])
+		expect(data).toEqual(['a', 'b'])
+	})
+	it('post body', async () => {
+		const { data } = await client.body.post('a')
+		expect(data).toEqual('a')
+	})
+	it('post mirror', async () => {
+		const body = { username: 'A', password: 'B' }
+		const { data } = await client.mirror.post(body)
+		expect(data).toEqual(body)
+	})
+	it('delete empty', async () => {
+		const { data } = await client.empty.delete()
+		expect(data).toEqual({ body: null })
+	})
+	it('post deep nested mirror', async () => {
+		const body = { username: 'A', password: 'B' }
+		const { data } = await client.deep.nested.mirror.post(body)
+		expect(data).toEqual(body)
+	})
+	it('get nested data', async () => {
+		const { data } = await client.nested.data.get()
+		expect(data).toEqual('hi')
+	})
+	it('stream ', async () => {
+		const { data } = await client.stream.get()
+		let all = ''
+		for await (const chunk of data!) {
+			// console.log(chunk)
+			all += chunk + '-'
+		}
+		expect(all).toEqual('a-b-c-')
+	})
+	it('stream async', async () => {
+		const { data } = await client['stream-async'].get()
+		let all = ''
+		for await (const chunk of data!) {
+			// console.log(chunk)
+			all += chunk + '-'
+		}
+		expect(all).toEqual('a-b-c-')
+	})
+	it('stream return', async () => {
+		const { data } = await client['stream-return'].get()
+		expect(data).toEqual('a')
+	})
+	it('stream return async', async () => {
+		const { data } = await client['stream-return-async'].get()
+		// console.log(data)
+		expect(data).toEqual('a')
+	})
+	// it('handle error', async () => {
+	// 	const { data, error } = await client.error.get()
+	// 	let value
+	// 	if (error)
+	// 		switch (error.status) {
+	// 			case 418:
+	// 				value = error.value
+	// 				break
+	// 			case 420:
+	// 				value = error.value
+	// 				break
+	// 		}
+	// 	expect(data).toBeNull()
+	// 	expect(value).toEqual('Kirifuji Nagisa')
+	// })
+})