@based/functions 1.0.0 → 1.0.2

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @based/cloud-function@1.0.0 build
+> @based/functions@1.0.1 build
 > npx  tsc
 

package/dist/context.d.ts

@@ -43,7 +43,7 @@ export declare type HttpSession = {
 export declare type InternalSessionObservable = {
     id: number;
     name: string;
-    type: 'observable';
+    type: 'query';
 };
 export declare type InternalSessionClient = {
     client: BasedFunctionClient;
@@ -60,4 +60,5 @@ export declare type Context<S extends Session = Session> = {
 };
 export declare const isHttpContext: (ctx: Context<Session>) => ctx is Context<HttpSession>;
 export declare const isWsContext: (ctx: Context<Session>) => ctx is Context<WebSocketSession>;
+export declare const isClientContext: (ctx: Context<Session>) => ctx is Context<WebSocketSession>;
 export declare const isWsSession: (session: Session) => session is WebSocketSession;

package/dist/context.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWsSession = exports.isWsContext = exports.isHttpContext = void 0;
+exports.isWsSession = exports.isClientContext = exports.isWsContext = exports.isHttpContext = void 0;
 const isHttpContext = (ctx) => {
     if ('res' in ctx?.session) {
         return true;
@@ -15,6 +15,13 @@ const isWsContext = (ctx) => {
     return false;
 };
 exports.isWsContext = isWsContext;
+const isClientContext = (ctx) => {
+    if (ctx.session && 'authState' in ctx.session) {
+        return true;
+    }
+    return false;
+};
+exports.isClientContext = isClientContext;
 const isWsSession = (session) => {
     if (!('res' in session) && 'ip' in session && 'id' in session) {
         return true;

package/dist/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;;AA4EO,MAAM,aAAa,GAAG,CAC3B,GAAqB,EACQ,EAAE;IAC/B,IAAI,KAAK,IAAI,GAAG,EAAE,OAAO,EAAE;QACzB,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAPY,QAAA,aAAa,iBAOzB;AAEM,MAAM,WAAW,GAAG,CACzB,GAAqB,EACa,EAAE;IACpC,IAAI,GAAG,CAAC,OAAO,IAAI,IAAA,mBAAW,EAAC,GAAG,CAAC,OAAO,CAAC,EAAE;QAC3C,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAPY,QAAA,WAAW,eAOvB;AAEM,MAAM,WAAW,GAAG,CAAC,OAAgB,EAA+B,EAAE;IAC3E,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,EAAE;QAC7D,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AALY,QAAA,WAAW,eAKvB"}
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;;AA4EO,MAAM,aAAa,GAAG,CAC3B,GAAqB,EACQ,EAAE;IAC/B,IAAI,KAAK,IAAI,GAAG,EAAE,OAAO,EAAE;QACzB,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAPY,QAAA,aAAa,iBAOzB;AAEM,MAAM,WAAW,GAAG,CACzB,GAAqB,EACa,EAAE;IACpC,IAAI,GAAG,CAAC,OAAO,IAAI,IAAA,mBAAW,EAAC,GAAG,CAAC,OAAO,CAAC,EAAE;QAC3C,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAPY,QAAA,WAAW,eAOvB;AAEM,MAAM,eAAe,GAAG,CAC7B,GAAqB,EACa,EAAE;IACpC,IAAI,GAAG,CAAC,OAAO,IAAI,WAAW,IAAI,GAAG,CAAC,OAAO,EAAE;QAC7C,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAPY,QAAA,eAAe,mBAO3B;AAEM,MAAM,WAAW,GAAG,CAAC,OAAgB,EAA+B,EAAE;IAC3E,IAAI,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,OAAO,IAAI,IAAI,IAAI,OAAO,EAAE;QAC7D,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AALY,QAAA,WAAW,eAKvB"}

package/dist/functions.d.ts

@@ -1,19 +1,23 @@
 /// <reference types="node" />
 import { Context, HttpSession } from './context';
 import { BasedFunctionClient } from './client';
-import { Stream } from 'stream';
+import { Duplex } from 'stream';
 export declare type ObservableUpdateFunction<K = any> = {
     (data: K, checksum?: number, diff?: any, fromChecksum?: number, isDeflate?: boolean, rawData?: K, err?: any): void;
     __internalObs__?: true;
 };
 export declare type ObserveErrorListener = (err: any) => void;
-export declare type CustomHttpResponse = (result: any, payload: any, client: Context<HttpSession>) => Promise<boolean>;
+export declare type HttpHeaders = {
+    [header: string]: number | string | (string | number)[];
+};
+export declare type SendHttpResponse = (responseData: any, headers?: HttpHeaders, status?: string | number) => void;
+export declare type HttpResponse<P = any, K = any> = (based: BasedFunctionClient, payload: P, responseData: K, send: SendHttpResponse, ctx: Context<HttpSession>) => Promise<void>;
 export declare type BasedFunction<P = any, K = any> = (based: BasedFunctionClient, payload: P, ctx: Context) => Promise<K>;
 export declare type StreamPayload<P = any> = {
     payload?: P;
     mimeType: string;
     size: number;
-    stream: Stream & {
+    stream: Duplex & {
         size: number;
         receivedBytes: number;
     };
@@ -21,4 +25,4 @@ export declare type StreamPayload<P = any> = {
     extension?: string;
 };
 export declare type BasedStreamFunction<P = any, K = any> = BasedFunction<StreamPayload<P>, K>;
-export declare type BasedQueryFunction<P = any, K = any> = ((based: BasedFunctionClient, payload: P, update: ObservableUpdateFunction<K>) => Promise<() => void>) | ((based: BasedFunctionClient, payload: P, update: ObservableUpdateFunction<K>) => () => void);
+export declare type BasedQueryFunction<P = any, K = any> = ((based: BasedFunctionClient, payload: P, update: ObservableUpdateFunction<K>, error?: ObserveErrorListener) => Promise<() => void>) | ((based: BasedFunctionClient, payload: P, update: ObservableUpdateFunction<K>, error?: ObserveErrorListener) => () => void);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@based/functions",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "license": "MIT",
   "main": "dist/index.js",
   "scripts": {

package/src/context.ts

@@ -47,7 +47,7 @@ export type HttpSession = {
 export type InternalSessionObservable = {
   id: number
   name: string
-  type: 'observable'
+  type: 'query'
 }
 
 export type InternalSessionClient = {
@@ -92,6 +92,15 @@ export const isWsContext = (
   return false
 }
 
+export const isClientContext = (
+  ctx: Context<Session>
+): ctx is Context<WebSocketSession> => {
+  if (ctx.session && 'authState' in ctx.session) {
+    return true
+  }
+  return false
+}
+
 export const isWsSession = (session: Session): session is WebSocketSession => {
   if (!('res' in session) && 'ip' in session && 'id' in session) {
     return true

package/src/functions.ts

@@ -1,6 +1,6 @@
 import { Context, HttpSession } from './context'
 import { BasedFunctionClient } from './client'
-import { Stream } from 'stream'
+import { Duplex } from 'stream'
 
 export type ObservableUpdateFunction<K = any> = {
   (
@@ -19,11 +19,23 @@ export type ObservableUpdateFunction<K = any> = {
 // TODO: use error package
 export type ObserveErrorListener = (err: any) => void
 
-export type CustomHttpResponse = (
-  result: any,
-  payload: any,
-  client: Context<HttpSession>
-) => Promise<boolean>
+export type HttpHeaders = {
+  [header: string]: number | string | (string | number)[]
+}
+
+export type SendHttpResponse = (
+  responseData: any,
+  headers?: HttpHeaders,
+  status?: string | number
+) => void
+
+export type HttpResponse<P = any, K = any> = (
+  based: BasedFunctionClient,
+  payload: P,
+  responseData: K,
+  send: SendHttpResponse,
+  ctx: Context<HttpSession>
+) => Promise<void>
 
 export type BasedFunction<P = any, K = any> = (
   based: BasedFunctionClient,
@@ -35,7 +47,7 @@ export type StreamPayload<P = any> = {
   payload?: P
   mimeType: string
   size: number
-  stream: Stream & {
+  stream: Duplex & {
     size: number
     receivedBytes: number
   }
@@ -52,10 +64,12 @@ export type BasedQueryFunction<P = any, K = any> =
   | ((
       based: BasedFunctionClient,
       payload: P,
-      update: ObservableUpdateFunction<K>
+      update: ObservableUpdateFunction<K>,
+      error?: ObserveErrorListener
     ) => Promise<() => void>)
   | ((
       based: BasedFunctionClient,
       payload: P,
-      update: ObservableUpdateFunction<K>
+      update: ObservableUpdateFunction<K>,
+      error?: ObserveErrorListener
     ) => () => void)

package/dist/errors.js

@@ -1,2 +0,0 @@
-// add all errors here and use it in the client as well
-//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,uDAAuD"}

package/dist/network.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=network.js.map

package/dist/network.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"network.js","sourceRoot":"","sources":["../src/network.ts"],"names":[],"mappings":""}

package/dist/types.js

@@ -1,2 +0,0 @@
-// function types
-//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,iBAAiB"}