@based/functions 3.0.1 → 3.1.0-alpha

package/src/functions.ts

@@ -1,365 +0,0 @@
-import type { Required } from 'utility-types'
-import { Context, HttpSession } from './context.js'
-import { BasedFunctionClient } from './client.js'
-import { BasedDataStream } from './stream.js'
-import { Authorize } from './auth.js'
-
-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 = {
-  [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,
-  payload: P,
-  ctx: Context
-) => Promise<K>
-
-export type BasedAppFunction = (
-  based: BasedFunctionClient,
-  assets: {
-    css: {
-      text: Promise<string>
-      url: string
-    }
-    js: {
-      text: Promise<string>
-      url: string
-    }
-    favicon: {
-      url: string
-      content: string
-      path: string
-    }
-  },
-  ctx: Context
-) => Promise<string>
-
-export type StreamPayload<P = any> = {
-  payload?: P
-  mimeType: string
-  size: number
-  stream: BasedDataStream
-  fileName?: string
-  extension?: string
-}
-
-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, 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 BasedJobFunction =
-  | ((based: BasedFunctionClient) => Promise<() => void>)
-  | ((based: BasedFunctionClient) => () => void)
-
-export type UninstallFunction = () => Promise<void>
-
-// ------------ Config -------------------
-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 -1 indicates endless */
-  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
-  /** Relay allows functions to relay traffic to another `@based/server` 
-    `Currently not supported for `stream` 
-  
-    ```js
-    new BasedServer({ 
-    clients: { events: BasedClient },
-    functions: { 
-      specs: 
-        somethingToRelay: { 
-          relay: { client: 'events', target: 'hello' }, 
-          type: 'function' 
-        })
-      }
-    }
-    })
-    ```
-  */
-  relay?: {
-    client: string
-    target?: string
-  }
-  /** Function version */
-  version?: number
-  /** 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'
-  | 'app'
-  | 'job'
-
-type BasedChannelFunctionConfig = {
-  /** 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
-  /** How long should the channel subscriber remain active after all subscribers are gone, in ms */
-  closeAfterIdleTime?: number
-  /** Only for Publisher */
-  httpResponse?: HttpResponse
-  /** Throttle amount of outgoing messages, in milliseconds */
-  throttle?: number
-}
-
-type BasedCallFunctionConfig = {
-  /** Function type `channel, function, query, stream` */
-  type: 'function'
-  fn?: BasedFunction
-  httpResponse?: HttpResponse
-}
-
-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
-  /** Throttle amount of outgoing messages, in milliseconds */
-  throttle?: number
-}
-
-type BasedStreamFunctionConfig = {
-  /** Function type `channel, function, query, stream` */
-  type: 'stream'
-  fn: BasedStreamFunction
-}
-
-type BasedAppFunctionConfig = {
-  type: 'app'
-  main: string
-  path?: string
-  favicon?: string
-}
-
-type BasedJobFunctionConfig = {
-  type: 'job'
-  fn?: BasedFunction
-}
-
-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
-  : T extends 'job'
-  ? BasedJobFunctionConfig & FunctionConfigShared
-  : T extends 'app'
-  ? BasedAppFunctionConfig & FunctionConfigShared
-  :
-      | (BasedChannelFunctionConfig & FunctionConfigShared)
-      | (BasedCallFunctionConfig & FunctionConfigShared)
-      | (BasedQueryFunctionConfig & FunctionConfigShared)
-      | (BasedStreamFunctionConfig & FunctionConfigShared)
-      | (BasedJobFunctionConfig & FunctionConfigShared)
-      | (BasedAppFunctionConfig & 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
-  : T extends 'job'
-  ? BasedJobFunctionConfig & FunctionConfigSharedComplete
-  : T extends 'app'
-  ? BasedAppFunctionConfig & FunctionConfigSharedComplete
-  :
-      | (BasedChannelFunctionConfig & FunctionConfigSharedComplete)
-      | (BasedCallFunctionConfig & FunctionConfigSharedComplete)
-      | (BasedQueryFunctionConfig & FunctionConfigSharedComplete)
-      | (BasedStreamFunctionConfig & FunctionConfigSharedComplete)
-      | (BasedJobFunctionConfig & FunctionConfigSharedComplete)
-      | (BasedAppFunctionConfig & FunctionConfigSharedComplete)
-
-export type BasedAuthorizeFunctionConfig = {
-  /** Function type `authorize` */
-  type: 'authorize'
-  fn?: Authorize
-}
-
-export type BasedRoute<
-  T extends BasedFunctionTypes = BasedFunctionTypes,
-  R extends keyof BasedFunctionConfig = 'type' | 'name'
-> = Required<Partial<BasedFunctionConfig<T>>, R>
-
-export type BasedRouteComplete<
-  T extends BasedFunctionTypes = BasedFunctionTypes
-> = Required<
-  Partial<BasedFunctionConfig<T>>,
-  'type' | 'name' | 'maxPayloadSize' | 'rateLimitTokens'
->
-
-export function isBasedRoute<T extends BasedFunctionTypes>(
-  type: T,
-  route: any
-): route is BasedRoute<T> {
-  return (
-    route &&
-    typeof route === 'object' &&
-    route.type === type &&
-    typeof route.name === 'string'
-  )
-}
-
-export function isAnyBasedRoute(route: any): route is BasedRoute {
-  return (
-    route &&
-    typeof route === 'object' &&
-    (route.type === 'channel' ||
-      route.type === 'query' ||
-      route.type === 'function' ||
-      route.type === 'stream') &&
-    typeof route.name === 'string'
-  )
-}
-
-export function isBasedFunctionConfig<T extends BasedFunctionTypes>(
-  type: T,
-  config: any
-): config is BasedFunctionConfig<T> {
-  return isBasedRoute(type, config)
-}
-
-export function isAnyBasedFunctionConfig(
-  config: any
-): config is BasedFunctionConfig {
-  return isAnyBasedRoute(config)
-}
-
-export type BasedRoutes = {
-  [name: string]: BasedRoute<BasedFunctionTypes, 'type'>
-}
-
-export type BasedFunctionConfigs = {
-  [name: string]: BasedFunctionConfig<BasedFunctionTypes>
-}

package/src/geo.ts

@@ -1,322 +0,0 @@
-export type CountryCode =
-  | 'AF'
-  | 'AL'
-  | 'DZ'
-  | 'AS'
-  | 'AD'
-  | 'AO'
-  | 'AI'
-  | 'AQ'
-  | 'AG'
-  | 'AR'
-  | 'AM'
-  | 'AW'
-  | 'AU'
-  | 'AT'
-  | 'AZ'
-  | 'BS'
-  | 'BH'
-  | 'BD'
-  | 'BB'
-  | 'BY'
-  | 'BE'
-  | 'BZ'
-  | 'BJ'
-  | 'BM'
-  | 'BT'
-  | 'BO'
-  | 'BQ'
-  | 'BA'
-  | 'BW'
-  | 'BV'
-  | 'BR'
-  | 'IO'
-  | 'BN'
-  | 'BG'
-  | 'BF'
-  | 'BI'
-  | 'KH'
-  | 'CM'
-  | 'CA'
-  | 'CV'
-  | 'KY'
-  | 'CF'
-  | 'TD'
-  | 'CL'
-  | 'CN'
-  | 'CX'
-  | 'CC'
-  | 'CO'
-  | 'KM'
-  | 'CG'
-  | 'CD'
-  | 'CK'
-  | 'CR'
-  | 'HR'
-  | 'CU'
-  | 'CW'
-  | 'CY'
-  | 'CZ'
-  | 'CI'
-  | 'DK'
-  | 'DJ'
-  | 'DM'
-  | 'DO'
-  | 'EC'
-  | 'EG'
-  | 'SV'
-  | 'GQ'
-  | 'ER'
-  | 'EE'
-  | 'ET'
-  | 'FK'
-  | 'FO'
-  | 'FJ'
-  | 'FI'
-  | 'FR'
-  | 'GF'
-  | 'PF'
-  | 'TF'
-  | 'GA'
-  | 'GM'
-  | 'GE'
-  | 'DE'
-  | 'GH'
-  | 'GI'
-  | 'GR'
-  | 'GL'
-  | 'GD'
-  | 'GP'
-  | 'GU'
-  | 'GT'
-  | 'GG'
-  | 'GN'
-  | 'GW'
-  | 'GY'
-  | 'HT'
-  | 'HM'
-  | 'VA'
-  | 'HN'
-  | 'HK'
-  | 'HU'
-  | 'IS'
-  | 'IN'
-  | 'ID'
-  | 'IR'
-  | 'IQ'
-  | 'IE'
-  | 'IM'
-  | 'IL'
-  | 'IT'
-  | 'JM'
-  | 'JP'
-  | 'JE'
-  | 'JO'
-  | 'KZ'
-  | 'KE'
-  | 'KI'
-  | 'KP'
-  | 'KR'
-  | 'KW'
-  | 'KG'
-  | 'LA'
-  | 'LV'
-  | 'LB'
-  | 'LS'
-  | 'LR'
-  | 'LY'
-  | 'LI'
-  | 'LT'
-  | 'LU'
-  | 'MO'
-  | 'MK'
-  | 'MG'
-  | 'MW'
-  | 'MY'
-  | 'MV'
-  | 'ML'
-  | 'MT'
-  | 'MH'
-  | 'MQ'
-  | 'MR'
-  | 'MU'
-  | 'YT'
-  | 'MX'
-  | 'FM'
-  | 'MD'
-  | 'MC'
-  | 'MN'
-  | 'ME'
-  | 'MS'
-  | 'MA'
-  | 'MZ'
-  | 'MM'
-  | 'NA'
-  | 'NR'
-  | 'NP'
-  | 'NL'
-  | 'NC'
-  | 'NZ'
-  | 'NI'
-  | 'NE'
-  | 'NG'
-  | 'NU'
-  | 'NF'
-  | 'MP'
-  | 'NO'
-  | 'OM'
-  | 'PK'
-  | 'PW'
-  | 'PS'
-  | 'PA'
-  | 'PG'
-  | 'PY'
-  | 'PE'
-  | 'PH'
-  | 'PN'
-  | 'PL'
-  | 'PT'
-  | 'PR'
-  | 'QA'
-  | 'RO'
-  | 'RU'
-  | 'RW'
-  | 'RE'
-  | 'BL'
-  | 'SH'
-  | 'KN'
-  | 'LC'
-  | 'MF'
-  | 'PM'
-  | 'VC'
-  | 'WS'
-  | 'SM'
-  | 'ST'
-  | 'SA'
-  | 'SN'
-  | 'RS'
-  | 'SC'
-  | 'SL'
-  | 'SG'
-  | 'SX'
-  | 'SK'
-  | 'SI'
-  | 'SB'
-  | 'SO'
-  | 'ZA'
-  | 'GS'
-  | 'SS'
-  | 'ES'
-  | 'LK'
-  | 'SD'
-  | 'SR'
-  | 'SJ'
-  | 'SZ'
-  | 'SE'
-  | 'CH'
-  | 'SY'
-  | 'TW'
-  | 'TJ'
-  | 'TZ'
-  | 'TH'
-  | 'TL'
-  | 'TG'
-  | 'TK'
-  | 'TO'
-  | 'TT'
-  | 'TN'
-  | 'TR'
-  | 'TM'
-  | 'TC'
-  | 'TV'
-  | 'UG'
-  | 'UA'
-  | 'AE'
-  | 'GB'
-  | 'US'
-  | 'UM'
-  | 'UY'
-  | 'UZ'
-  | 'VU'
-  | 'VE'
-  | 'VN'
-  | 'VG'
-  | 'VI'
-  | 'WF'
-  | 'EH'
-  | 'YE'
-  | 'ZM'
-  | 'ZW'
-  | 'AX'
-
-type Char =
-  | 'A'
-  | 'B'
-  | 'C'
-  | 'D'
-  | 'E'
-  | 'F'
-  | 'G'
-  | 'H'
-  | 'I'
-  | 'J'
-  | 'K'
-  | 'L'
-  | 'M'
-  | 'N'
-  | 'O'
-  | 'P'
-  | 'Q'
-  | 'R'
-  | 'S'
-  | 'T'
-  | 'U'
-  | 'V'
-  | 'W'
-  | 'X'
-  | 'Y'
-  | 'Z'
-  | '0'
-  | '1'
-  | '2'
-  | '3'
-  | '4'
-  | '5'
-  | '6'
-  | '7'
-  | '8'
-  | '9'
-
-export type GeoRegionISO = `${Char}${Char}` | `${Char}${Char}${Char}`
-
-export type Geo = {
-  country: CountryCode | 'unknown'
-  /**
-  Ip formatted as ipv6
-
-  e.g. `2001:0db8:85a3:0000:0000:8a2e:0370:7334`
-  */
-  ip: string
-  /**
-  Region subdivisions
-
-  e.g. `[{ iso: 'NH', name: 'north-holland' }]`
-  */
-  regions: {
-    iso: GeoRegionISO
-    name?: string
-  }[]
-  lat: number
-  long: number
-  /**
-  Accuracy Radius (km)
-  */
-  accuracy: number
-  /**
-  City name 
-
-  e.g. `Amsterdam`
-  */
-  city?: string
-  postalCode?: string
-}

package/src/index.ts

@@ -1,8 +0,0 @@
-export * from './context.js'
-export * from './auth.js'
-export * from './client.js'
-export * from './functions.js'
-export * from './query.js'
-export * from './stream.js'
-export * from './channel.js'
-export * from './geo.js'

package/src/query.ts

@@ -1,14 +0,0 @@
-import { ObservableUpdateFunction, ObserveErrorListener } from './functions.js'
-
-export abstract class BasedQuery<K = any> {
-  abstract subscribe(
-    onData: ObservableUpdateFunction<K>,
-    onError?: ObserveErrorListener
-  ): () => void
-
-  abstract getWhen(
-    condition: (data: K, checksum: number) => boolean
-  ): Promise<any>
-
-  abstract get(): Promise<K>
-}