@based/functions 1.1.0 → 1.1.2

package/README.md

@@ -1,6 +1,6 @@
 # @based/functions
 
-To be with based cloud functions, adds types and utilities.
+To be used with based cloud functions, adds types and utilities.
 
 - Example based function
 
@@ -9,7 +9,7 @@ import { BasedFunction } from '@based/functions'
 
 const submitVote: BasedFunction<
   { target: number },
-  { status: 'ok' | 'not-ok' }
+  'ok' | 'not-ok'
 > = async (based, { target }) => {
   if (target > 10) {
     return 'ok'

package/dist/auth.d.ts

@@ -12,4 +12,4 @@ export type AuthState = {
 export type Authorize = (based: BasedFunctionClient, context: Context<HttpSession | WebSocketSession>, name: string, // name as generic dope
 payload?: any) => Promise<boolean>;
 export type VerifyAuthState = (based: BasedFunctionClient, context: Context<HttpSession | WebSocketSession>, authState: AuthState) => Promise<true | AuthState>;
-export type AuthorizeConnection = (based: BasedFunctionClient, req: HttpRequest) => Promise<boolean>;
+export type AuthorizeConnection = (based: BasedFunctionClient, req: HttpRequest, ip: string) => Promise<boolean>;

package/dist/context.d.ts

@@ -17,6 +17,9 @@ export type WebSocketSession = {
         name: string;
         payload: any;
     }>;
+    headers: {
+        [key: string]: string;
+    };
     unauthorizedChannels?: Set<{
         id: number;
         name: string;
@@ -50,21 +53,33 @@ export type HttpSession = {
 export type InternalSessionObservable = {
     id: number;
     name: string;
+    headers: {
+        [key: string]: string;
+    };
     type: 'query';
 };
 export type InternalSessionChannel = {
     id: number;
     name: string;
+    headers: {
+        [key: string]: string;
+    };
     type: 'channel';
 };
 export type InternalSessionClient = {
     client: BasedFunctionClient;
+    headers: {
+        [key: string]: string;
+    };
     type: 'client';
 };
 export type InternalSession = InternalSessionClient | InternalSessionObservable | InternalSessionChannel;
 export type MinimalExternalSession = {
     ua: string;
     ip: string;
+    headers: {
+        [key: string]: string;
+    };
 };
 export type Session = (WebSocketSession | HttpSession | InternalSession | MinimalExternalSession) & {
     /** Only available in Ws and Http contexts */

package/dist/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":";;;AAiGO,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":";;;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"}

package/dist/functions.d.ts

@@ -1,6 +1,7 @@
 import { Context, HttpSession } from './context';
 import { BasedFunctionClient } from './client';
 import { BasedDataStream } from './stream';
+import { Authorize } from './auth';
 export type ObservableUpdateFunction<K = any> = {
     (data: K, checksum?: number, diff?: any, fromChecksum?: number, isDeflate?: boolean, rawData?: K, err?: any): void;
     __internalObs__?: true;
@@ -23,7 +24,92 @@ export type StreamPayload<P = any> = {
 export type BasedStreamFunction<P = any, K = any> = BasedFunction<StreamPayload<P>, K>;
 export 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);
 export type BasedChannelFunction<P = any, K = any> = (based: BasedFunctionClient, payload: P, id: number, update: ChannelMessageFunction<K>, error: (err?: any) => void) => () => void;
-export type BasedChannelPublishFunction<P = any, K = any> = (based: BasedFunctionClient, payload: P, message: K, id: number, ctx: Context) => void;
-export type ChannelMessageFunction<K = any> = (message: K) => void;
+export type BasedChannelPublishFunction<P = any, M = any> = (based: BasedFunctionClient, payload: P, message: M, id: number, ctx: Context) => void;
+export type ChannelMessageFunction<M = any> = (message: M) => void;
 export type ChannelMessageFunctionInternal<K = any> = (message: K, err?: any) => void;
 export type UninstallFunction = () => Promise<void>;
+type FunctionConfigShared = {
+    /** Function name */
+    name: string;
+    /** In addition to the name, a function can have a custom path for HTTP requests.
+     * For example: `path: 'my/custom/path'` will result in the function being
+     * available with a request to `env.based.io/my/custom/path`
+     */
+    path?: string;
+    /** In bytes. `-1` indicates no size limit */
+    maxPayloadSize?: number;
+    /** Cost in tokens for this function call.  */
+    rateLimitTokens?: number;
+    /** A function marked as `public` will skip the call to authorize. */
+    public?: boolean;
+    /** Array of headers that this function expects to receive. */
+    headers?: string[];
+    /** A function marked as `internalOnly` will only be accessible from other server side functions,
+     * and not through the public internet.
+     */
+    internalOnly?: boolean;
+    /** Can hold extra information about a spec */
+    data?: any;
+    /** Unistall after idle, in ms */
+    uninstallAfterIdleTime?: number;
+    /** Hook that fires on uninstall of the function e.g. to clean up database connections */
+    uninstall?: UninstallFunction;
+    /** Specific authorize for this function */
+    authorize?: Authorize;
+};
+export type BasedFunctionConfig = ({
+    /** Function type `channel, function, query, stream, authorize` */
+    type: 'channel';
+    /** Channel subscriber
+      
+     ```js
+     const subscribe = (based, payload, id, update) => {
+        let cnt = 0
+        const interval = setInterval(() => {
+          update(++cnt)
+        })
+        return () => clearInterval(cnt)
+     }
+     ```
+    */
+    subscriber?: BasedChannelFunction;
+    /** Channel publisher
+      
+     ```js
+     const publisher = (based, payload, msg, id) => {
+        publishToChannel(id, msg)
+     }
+     ```
+    */
+    publisher?: BasedChannelPublishFunction;
+    /** Makes only the publisher public */
+    publicPublisher?: boolean;
+    name: string;
+    /** How long should the channel subscriber remain active after all subscribers are gone, in ms */
+    closeAfterIdleTime?: number;
+} & FunctionConfigShared) | ({
+    /** Function type `channel, function, query, stream, authorize` */
+    type: 'function';
+    function: BasedFunction;
+    name: string;
+    httpResponse?: HttpResponse;
+} & FunctionConfigShared) | ({
+    /** Function type `channel, function, query, stream, authorize` */
+    type: 'query';
+    function: BasedQueryFunction;
+    name: string;
+    httpResponse?: HttpResponse;
+    /** How long should the query function remain active after all subscribers are gone, in ms */
+    closeAfterIdleTime?: number;
+} & FunctionConfigShared) | ({
+    /** Function type `channel, function, query, stream, authorize` */
+    type: 'stream';
+    function: BasedStreamFunction;
+    name: string;
+} & FunctionConfigShared) | {
+    /** Function type `channel, function, query, stream, authorize` */
+    type: 'authorize';
+    function: Authorize;
+    name: string;
+};
+export {};

package/package.json

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

package/src/auth.ts

@@ -29,5 +29,6 @@ export type VerifyAuthState = (
 
 export type AuthorizeConnection = (
   based: BasedFunctionClient,
-  req: HttpRequest
+  req: HttpRequest,
+  ip: string
 ) => Promise<boolean>

package/src/context.ts

@@ -19,6 +19,7 @@ export type WebSocketSession = {
     name: string
     payload: any
   }>
+  headers: { [key: string]: string }
   unauthorizedChannels?: Set<{
     id: number
     name: string
@@ -55,17 +56,20 @@ export type HttpSession = {
 export type InternalSessionObservable = {
   id: number
   name: string
+  headers: { [key: string]: string }
   type: 'query'
 }
 
 export type InternalSessionChannel = {
   id: number
   name: string
+  headers: { [key: string]: string }
   type: 'channel'
 }
 
 export type InternalSessionClient = {
   client: BasedFunctionClient
+  headers: { [key: string]: string }
   type: 'client'
 }
 
@@ -79,6 +83,7 @@ export type InternalSession =
 export type MinimalExternalSession = {
   ua: string
   ip: string
+  headers: { [key: string]: string }
 }
 
 export type Session = (

package/src/functions.ts

@@ -1,6 +1,7 @@
 import { Context, HttpSession } from './context'
 import { BasedFunctionClient } from './client'
 import { BasedDataStream } from './stream'
+import { Authorize } from './auth'
 
 export type ObservableUpdateFunction<K = any> = {
   (
@@ -79,15 +80,15 @@ export type BasedChannelFunction<P = any, K = any> = (
   error: (err?: any) => void
 ) => () => void
 
-export type BasedChannelPublishFunction<P = any, K = any> = (
+export type BasedChannelPublishFunction<P = any, M = any> = (
   based: BasedFunctionClient,
   payload: P,
-  message: K,
+  message: M,
   id: number,
   ctx: Context
 ) => void
 
-export type ChannelMessageFunction<K = any> = (message: K) => void
+export type ChannelMessageFunction<M = any> = (message: M) => void
 
 export type ChannelMessageFunctionInternal<K = any> = (
   message: K,
@@ -95,3 +96,94 @@ export type ChannelMessageFunctionInternal<K = any> = (
 ) => void
 
 export type UninstallFunction = () => Promise<void>
+
+type FunctionConfigShared = {
+  /** Function name */
+  name: string
+  /** In addition to the name, a function can have a custom path for HTTP requests.
+   * For example: `path: 'my/custom/path'` will result in the function being
+   * available with a request to `env.based.io/my/custom/path`
+   */
+  path?: string
+  /** In bytes. `-1` indicates no size limit */
+  maxPayloadSize?: number
+  /** Cost in tokens for this function call.  */
+  rateLimitTokens?: number
+  /** A function marked as `public` will skip the call to authorize. */
+  public?: boolean
+  /** Array of headers that this function expects to receive. */
+  headers?: string[]
+  /** A function marked as `internalOnly` will only be accessible from other server side functions,
+   * and not through the public internet.
+   */
+  internalOnly?: boolean
+  /** Can hold extra information about a spec */
+  data?: any
+  /** Unistall after idle, in ms */
+  uninstallAfterIdleTime?: number
+  /** Hook that fires on uninstall of the function e.g. to clean up database connections */
+  uninstall?: UninstallFunction
+  /** Specific authorize for this function */
+  authorize?: Authorize
+}
+
+export type BasedFunctionConfig =
+  | ({
+      /** Function type `channel, function, query, stream, authorize` */
+      type: 'channel'
+      /** Channel subscriber 
+        
+       ```js
+       const subscribe = (based, payload, id, update) => {
+          let cnt = 0
+          const interval = setInterval(() => {
+            update(++cnt)
+          })
+          return () => clearInterval(cnt)
+       }
+       ```
+      */
+      subscriber?: BasedChannelFunction
+      /** Channel publisher 
+        
+       ```js
+       const publisher = (based, payload, msg, id) => {
+          publishToChannel(id, msg)
+       }
+       ```
+      */
+      publisher?: BasedChannelPublishFunction
+      /** Makes only the publisher public */
+      publicPublisher?: boolean
+      name: string
+      /** How long should the channel subscriber remain active after all subscribers are gone, in ms */
+      closeAfterIdleTime?: number
+    } & FunctionConfigShared)
+  | ({
+      /** Function type `channel, function, query, stream, authorize` */
+      type: 'function'
+      function: BasedFunction
+      name: string
+      httpResponse?: HttpResponse
+    } & FunctionConfigShared)
+  | ({
+      /** Function type `channel, function, query, stream, authorize` */
+      type: 'query'
+      function: BasedQueryFunction
+      name: string
+      httpResponse?: HttpResponse
+      /** How long should the query function remain active after all subscribers are gone, in ms */
+      closeAfterIdleTime?: number
+    } & FunctionConfigShared)
+  | ({
+      /** Function type `channel, function, query, stream, authorize` */
+      type: 'stream'
+      function: BasedStreamFunction
+      name: string
+    } & FunctionConfigShared)
+  | {
+      /** Function type `channel, function, query, stream, authorize` */
+      type: 'authorize'
+      function: Authorize
+      name: string
+    }