@based/functions 2.0.0 → 2.1.0

package/dist/context.d.ts

@@ -41,6 +41,7 @@ export type HttpSession = {
     authState: AuthState;
     method: string;
     corsSend?: boolean;
+    rawBody?: string;
     headers: {
         'content-length'?: number;
         'content-type'?: string;

package/dist/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;;AAsGO,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,EAC2B,EAAE;IAClD,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,IAAA,mBAAW,EAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAA,qBAAa,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE;QAC3E,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAPY,QAAA,eAAe,mBAO3B;AAEM,MAAM,aAAa,GAAG,CAAC,OAAgB,EAA0B,EAAE;IACxE,IAAI,KAAK,IAAI,OAAO,EAAE;QACpB,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AALY,QAAA,aAAa,iBAKzB;AAEM,MAAM,WAAW,GAAG,CAAC,OAAgB,EAA+B,EAAE;IAC3E,IAAI,MAAM,IAAI,OAAO,EAAE;QACrB,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":";;;AAuGO,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,EAC2B,EAAE;IAClD,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,IAAA,mBAAW,EAAC,GAAG,CAAC,OAAO,CAAC,IAAI,IAAA,qBAAa,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE;QAC3E,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAPY,QAAA,eAAe,mBAO3B;AAEM,MAAM,aAAa,GAAG,CAAC,OAAgB,EAA0B,EAAE;IACxE,IAAI,KAAK,IAAI,OAAO,EAAE;QACpB,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AALY,QAAA,aAAa,iBAKzB;AAEM,MAAM,WAAW,GAAG,CAAC,OAAgB,EAA+B,EAAE;IAC3E,IAAI,MAAM,IAAI,OAAO,EAAE;QACrB,OAAO,IAAI,CAAA;KACZ;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AALY,QAAA,WAAW,eAKvB"}

package/dist/functions.d.ts

@@ -2,7 +2,7 @@ import { Context, HttpSession } from './context';
 import { BasedFunctionClient } from './client';
 import { BasedDataStream } from './stream';
 import { Authorize } from './auth';
-import { Required } from 'utility-types';
+import type { Required } from 'utility-types';
 export type ObservableUpdateFunction<K = any> = (data: K, checksum?: number, err?: any, cache?: Uint8Array, diff?: any, fromChecksum?: number, isDeflate?: boolean) => void;
 export type ObserveErrorListener = (err: any) => void;
 export type HttpHeaders = {
@@ -80,8 +80,9 @@ type FunctionConfigShared = {
     /** Used inernaly to check if a function is ready to uninstall */
     timeoutCounter?: number;
 };
+type FunctionConfigSharedComplete = Required<FunctionConfigShared, 'maxPayloadSize' | 'rateLimitTokens' | 'version' | 'name'>;
 export type BasedFunctionTypes = 'channel' | 'query' | 'function' | 'stream';
-export type BasedChannelFunctionConfig = {
+type BasedChannelFunctionConfig = {
     /** Function type `channel, function, query, stream, authorize` */
     type: 'channel';
     /** Channel subscriber
@@ -112,34 +113,34 @@ export type BasedChannelFunctionConfig = {
     closeAfterIdleTime?: number;
     /** Only for Publisher */
     httpResponse?: HttpResponse;
-} & FunctionConfigShared;
-export type BasedCallFunctionConfig = {
+};
+type BasedCallFunctionConfig = {
     /** Function type `channel, function, query, stream` */
     type: 'function';
     fn: BasedFunction;
     httpResponse?: HttpResponse;
-} & FunctionConfigShared;
-export type BasedQueryFunctionConfig = {
+};
+type BasedQueryFunctionConfig = {
     /** Function type `channel, function, query, stream` */
     type: 'query';
     fn: BasedQueryFunction;
     httpResponse?: HttpResponse;
     /** How long should the query function remain active after all subscribers are gone, in ms */
     closeAfterIdleTime?: number;
-} & FunctionConfigShared;
-export type BasedStreamFunctionConfig = {
+};
+type BasedStreamFunctionConfig = {
     /** Function type `channel, function, query, stream` */
     type: 'stream';
     fn: BasedStreamFunction;
-} & FunctionConfigShared;
-export type BasedFunctionConfig<T extends BasedFunctionTypes = BasedFunctionTypes> = T extends 'channel' ? BasedChannelFunctionConfig : T extends 'function' ? BasedCallFunctionConfig : T extends 'query' ? BasedQueryFunctionConfig : T extends 'stream' ? BasedStreamFunctionConfig : BasedChannelFunctionConfig | BasedCallFunctionConfig | BasedQueryFunctionConfig | BasedStreamFunctionConfig;
+};
+export type BasedFunctionConfig<T extends BasedFunctionTypes = BasedFunctionTypes> = T extends 'channel' ? BasedChannelFunctionConfig & FunctionConfigShared : T extends 'function' ? BasedCallFunctionConfig & FunctionConfigShared : T extends 'query' ? BasedQueryFunctionConfig & FunctionConfigShared : T extends 'stream' ? BasedStreamFunctionConfig & FunctionConfigShared : (BasedChannelFunctionConfig & FunctionConfigShared) | (BasedCallFunctionConfig & FunctionConfigShared) | (BasedQueryFunctionConfig & FunctionConfigShared) | (BasedStreamFunctionConfig & FunctionConfigShared);
+export type BasedFunctionConfigComplete<T extends BasedFunctionTypes = BasedFunctionTypes> = T extends 'channel' ? BasedChannelFunctionConfig & FunctionConfigSharedComplete : T extends 'function' ? BasedCallFunctionConfig & FunctionConfigSharedComplete : T extends 'query' ? BasedQueryFunctionConfig & FunctionConfigSharedComplete : T extends 'stream' ? BasedStreamFunctionConfig & FunctionConfigSharedComplete : (BasedChannelFunctionConfig & FunctionConfigSharedComplete) | (BasedCallFunctionConfig & FunctionConfigSharedComplete) | (BasedQueryFunctionConfig & FunctionConfigSharedComplete) | (BasedStreamFunctionConfig & FunctionConfigSharedComplete);
 export type BasedAuthorizeFunctionConfig = {
     /** Function type `authorize` */
     type: 'authorize';
     function: Authorize;
 };
 export type BasedRoute<T extends BasedFunctionTypes = BasedFunctionTypes, R extends keyof BasedFunctionConfig = 'type' | 'name'> = Required<Partial<BasedFunctionConfig<T>>, R>;
-export type BasedFunctionConfigComplete<T extends BasedFunctionTypes = BasedFunctionTypes> = Required<BasedFunctionConfig<T>, 'maxPayloadSize' | 'rateLimitTokens' | 'version' | 'name'>;
 export type BasedRouteComplete<T extends BasedFunctionTypes = BasedFunctionTypes> = Required<Partial<BasedFunctionConfig<T>>, 'type' | 'name' | 'maxPayloadSize' | 'rateLimitTokens'>;
 export declare function isBasedRoute<T extends BasedFunctionTypes>(type: T, route: any): route is BasedRoute<T>;
 export declare function isAnyBasedRoute(route: any): route is BasedRoute;

package/dist/functions.js.map

@@ -1 +1 @@
-{"version":3,"file":"functions.js","sourceRoot":"","sources":["../src/functions.ts"],"names":[],"mappings":";;;AAwPA,SAAgB,YAAY,CAC1B,IAAO,EACP,KAAU;IAEV,OAAO,CACL,KAAK;QACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,CAAC,IAAI,KAAK,IAAI;QACnB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAC/B,CAAA;AACH,CAAC;AAVD,oCAUC;AAED,SAAgB,eAAe,CAAC,KAAU;IACxC,OAAO,CACL,KAAK;QACL,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS;YACvB,KAAK,CAAC,IAAI,KAAK,OAAO;YACtB,KAAK,CAAC,IAAI,KAAK,UAAU;YACzB,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;QAC1B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAC/B,CAAA;AACH,CAAC;AAVD,0CAUC;AAED,SAAgB,qBAAqB,CACnC,IAAO,EACP,MAAW;IAEX,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AACnC,CAAC;AALD,sDAKC;AAED,SAAgB,wBAAwB,CACtC,MAAW;IAEX,OAAO,eAAe,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAJD,4DAIC"}
+{"version":3,"file":"functions.js","sourceRoot":"","sources":["../src/functions.ts"],"names":[],"mappings":";;;AAuQA,SAAgB,YAAY,CAC1B,IAAO,EACP,KAAU;IAEV,OAAO,CACL,KAAK;QACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,CAAC,IAAI,KAAK,IAAI;QACnB,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAC/B,CAAA;AACH,CAAC;AAVD,oCAUC;AAED,SAAgB,eAAe,CAAC,KAAU;IACxC,OAAO,CACL,KAAK;QACL,OAAO,KAAK,KAAK,QAAQ;QACzB,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS;YACvB,KAAK,CAAC,IAAI,KAAK,OAAO;YACtB,KAAK,CAAC,IAAI,KAAK,UAAU;YACzB,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;QAC1B,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAC/B,CAAA;AACH,CAAC;AAVD,0CAUC;AAED,SAAgB,qBAAqB,CACnC,IAAO,EACP,MAAW;IAEX,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;AACnC,CAAC;AALD,sDAKC;AAED,SAAgB,wBAAwB,CACtC,MAAW;IAEX,OAAO,eAAe,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAJD,4DAIC"}

package/package.json

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

package/src/context.ts

@@ -45,6 +45,7 @@ export type HttpSession = {
   authState: AuthState
   method: string
   corsSend?: boolean
+  rawBody?: string
   headers: {
     'content-length'?: number
     'content-type'?: string

package/src/functions.ts

@@ -2,7 +2,7 @@ import { Context, HttpSession } from './context'
 import { BasedFunctionClient } from './client'
 import { BasedDataStream } from './stream'
 import { Authorize } from './auth'
-import { Required } from 'utility-types'
+import type { Required } from 'utility-types'
 
 export type ObservableUpdateFunction<K = any> = (
   data: K,
@@ -93,6 +93,7 @@ export type ChannelMessageFunctionInternal<K = any> = (
 
 export type UninstallFunction = () => Promise<void>
 
+// ------------ Config -------------------
 type FunctionConfigShared = {
   /** Function name */
   name?: string
@@ -148,9 +149,14 @@ type FunctionConfigShared = {
   timeoutCounter?: number
 }
 
+type FunctionConfigSharedComplete = Required<
+  FunctionConfigShared,
+  'maxPayloadSize' | 'rateLimitTokens' | 'version' | 'name'
+>
+
 export type BasedFunctionTypes = 'channel' | 'query' | 'function' | 'stream'
 
-export type BasedChannelFunctionConfig = {
+type BasedChannelFunctionConfig = {
   /** Function type `channel, function, query, stream, authorize` */
   type: 'channel'
   /** Channel subscriber 
@@ -181,45 +187,61 @@ export type BasedChannelFunctionConfig = {
   closeAfterIdleTime?: number
   /** Only for Publisher */
   httpResponse?: HttpResponse
-} & FunctionConfigShared
+}
 
-export type BasedCallFunctionConfig = {
+type BasedCallFunctionConfig = {
   /** Function type `channel, function, query, stream` */
   type: 'function'
   fn: BasedFunction
   httpResponse?: HttpResponse
-} & FunctionConfigShared
+}
 
-export type BasedQueryFunctionConfig = {
+type BasedQueryFunctionConfig = {
   /** Function type `channel, function, query, stream` */
   type: 'query'
   fn: BasedQueryFunction
   httpResponse?: HttpResponse
   /** How long should the query function remain active after all subscribers are gone, in ms */
   closeAfterIdleTime?: number
-} & FunctionConfigShared
+}
 
-export type BasedStreamFunctionConfig = {
+type BasedStreamFunctionConfig = {
   /** Function type `channel, function, query, stream` */
   type: 'stream'
   fn: BasedStreamFunction
-} & FunctionConfigShared
+}
 
 export type BasedFunctionConfig<
   T extends BasedFunctionTypes = BasedFunctionTypes
 > = T extends 'channel'
-  ? BasedChannelFunctionConfig
+  ? BasedChannelFunctionConfig & FunctionConfigShared
   : T extends 'function'
-  ? BasedCallFunctionConfig
+  ? BasedCallFunctionConfig & FunctionConfigShared
   : T extends 'query'
-  ? BasedQueryFunctionConfig
+  ? BasedQueryFunctionConfig & FunctionConfigShared
   : T extends 'stream'
-  ? BasedStreamFunctionConfig
+  ? BasedStreamFunctionConfig & FunctionConfigShared
   :
-      | BasedChannelFunctionConfig
-      | BasedCallFunctionConfig
-      | BasedQueryFunctionConfig
-      | BasedStreamFunctionConfig
+      | (BasedChannelFunctionConfig & FunctionConfigShared)
+      | (BasedCallFunctionConfig & FunctionConfigShared)
+      | (BasedQueryFunctionConfig & FunctionConfigShared)
+      | (BasedStreamFunctionConfig & FunctionConfigShared)
+
+export type BasedFunctionConfigComplete<
+  T extends BasedFunctionTypes = BasedFunctionTypes
+> = T extends 'channel'
+  ? BasedChannelFunctionConfig & FunctionConfigSharedComplete
+  : T extends 'function'
+  ? BasedCallFunctionConfig & FunctionConfigSharedComplete
+  : T extends 'query'
+  ? BasedQueryFunctionConfig & FunctionConfigSharedComplete
+  : T extends 'stream'
+  ? BasedStreamFunctionConfig & FunctionConfigSharedComplete
+  :
+      | (BasedChannelFunctionConfig & FunctionConfigSharedComplete)
+      | (BasedCallFunctionConfig & FunctionConfigSharedComplete)
+      | (BasedQueryFunctionConfig & FunctionConfigSharedComplete)
+      | (BasedStreamFunctionConfig & FunctionConfigSharedComplete)
 
 export type BasedAuthorizeFunctionConfig = {
   /** Function type `authorize` */
@@ -232,13 +254,6 @@ export type BasedRoute<
   R extends keyof BasedFunctionConfig = 'type' | 'name'
 > = Required<Partial<BasedFunctionConfig<T>>, R>
 
-export type BasedFunctionConfigComplete<
-  T extends BasedFunctionTypes = BasedFunctionTypes
-> = Required<
-  BasedFunctionConfig<T>,
-  'maxPayloadSize' | 'rateLimitTokens' | 'version' | 'name'
->
-
 export type BasedRouteComplete<
   T extends BasedFunctionTypes = BasedFunctionTypes
 > = Required<