@nordcraft/core 1.0.0

package/src/api/LegacyToddleApi.ts

@@ -0,0 +1,205 @@
+import { isFormula, type Formula } from '../formula/formula'
+import type { GlobalFormulas } from '../formula/formulaTypes'
+import {
+  getFormulasInAction,
+  getFormulasInFormula,
+} from '../formula/formulaUtils'
+import { isDefined } from '../utils/util'
+import { type LegacyComponentAPI } from './apiTypes'
+
+export class LegacyToddleApi<Handler> {
+  private api: LegacyComponentAPI
+  private key: string
+  private globalFormulas: GlobalFormulas<Handler>
+  private _apiReferences?: Set<string>
+
+  constructor(
+    api: LegacyComponentAPI,
+    key: string,
+    globalFormulas: GlobalFormulas<Handler>,
+  ) {
+    this.api = api
+    this.key = key
+    this.globalFormulas = globalFormulas
+  }
+
+  get apiReferences(): Set<string> {
+    if (this._apiReferences) {
+      // Only compute apiReferences once
+      return this._apiReferences
+    }
+    const apis = new Set<string>()
+    const visitFormulaReference = (formula?: Formula | null) => {
+      if (!isDefined(formula)) {
+        return
+      }
+      switch (formula.type) {
+        case 'path':
+          if (formula.path[0] === 'Apis') {
+            apis.add(formula.path[1])
+          }
+          break
+        case 'value':
+          break
+        case 'record':
+          formula.entries.forEach((entry) =>
+            visitFormulaReference(entry.formula),
+          )
+          break
+        case 'function':
+        case 'array':
+        case 'or':
+        case 'and':
+        case 'apply':
+        case 'object':
+          formula.arguments?.forEach((arg) =>
+            visitFormulaReference(arg.formula),
+          )
+          break
+        case 'switch':
+          formula.cases.forEach((c) => {
+            visitFormulaReference(c.condition)
+            visitFormulaReference(c.formula)
+          })
+          break
+      }
+    }
+    visitFormulaReference(this.api.autoFetch)
+    visitFormulaReference(this.api.url)
+    Object.values(this.api.path ?? {}).forEach((p) =>
+      visitFormulaReference(p.formula),
+    )
+    Object.values(this.api.queryParams ?? {}).forEach((q) =>
+      visitFormulaReference(q.formula),
+    )
+
+    // this is supporting a few legacy cases where the whole header object was set as a formula. This is no longer possible
+    if (isFormula(this.api.headers)) {
+      visitFormulaReference(this.api.headers)
+    } else {
+      Object.values(this.api.headers ?? {}).forEach((h) => {
+        visitFormulaReference(h)
+      })
+    }
+    visitFormulaReference(this.api.body)
+    this._apiReferences = apis
+    return apis
+  }
+
+  get name() {
+    return this.api.name
+  }
+  get type() {
+    return this.api.type
+  }
+  get autoFetch() {
+    return this.api.autoFetch
+  }
+  get url() {
+    return this.api.url
+  }
+  get path() {
+    return this.api.path
+  }
+  get proxy() {
+    return this.api.proxy
+  }
+  get queryParams() {
+    return this.api.queryParams
+  }
+  get headers() {
+    return this.api.headers
+  }
+  get method() {
+    return this.api.method
+  }
+  get body() {
+    return this.api.body
+  }
+  get auth() {
+    return this.api.auth
+  }
+  get throttle() {
+    return this.api.throttle
+  }
+  get debounce() {
+    return this.api.debounce
+  }
+  get onCompleted() {
+    return this.api.onCompleted
+  }
+  get onFailed() {
+    return this.api.onFailed
+  }
+  *formulasInApi(): Generator<[(string | number)[], Formula]> {
+    const api = this.api
+    const apiKey = this.key
+    yield* getFormulasInFormula({
+      formula: api.autoFetch,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'autoFetch'],
+    })
+    yield* getFormulasInFormula({
+      formula: api.url,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'url'],
+    })
+    for (const [pathKey, path] of Object.entries(api.path ?? {})) {
+      yield* getFormulasInFormula({
+        formula: path.formula,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'path', pathKey, 'formula'],
+      })
+    }
+    for (const [queryParamKey, queryParam] of Object.entries(
+      api.queryParams ?? {},
+    )) {
+      yield* getFormulasInFormula({
+        formula: queryParam.formula,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'queryParams', queryParamKey, 'formula'],
+      })
+    }
+
+    // this is supporting a few legacy cases where the whole header object was set as a formula. This is no longer possible
+    if (isFormula(api.headers)) {
+      yield* getFormulasInFormula({
+        formula: api.headers,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'headers'],
+      })
+    } else {
+      for (const [headerKey, header] of Object.entries(api.headers ?? {})) {
+        yield* getFormulasInFormula({
+          formula: header,
+          globalFormulas: this.globalFormulas,
+          path: ['apis', apiKey, 'headers', headerKey],
+        })
+      }
+    }
+
+    yield* getFormulasInFormula({
+      formula: api.body,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'body'],
+    })
+    for (const [actionKey, action] of Object.entries(
+      api.onCompleted?.actions ?? {},
+    )) {
+      yield* getFormulasInAction({
+        action,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'onCompleted', 'actions', actionKey],
+      })
+    }
+    for (const [actionKey, action] of Object.entries(
+      api.onFailed?.actions ?? {},
+    )) {
+      yield* getFormulasInAction({
+        action,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'onFailed', 'actions', actionKey],
+      })
+    }
+  }
+}

package/src/api/ToddleApiV2.ts

@@ -0,0 +1,331 @@
+import { getActionsInAction } from '../component/actionUtils'
+import type { ActionModel } from '../component/component.types'
+import { type Formula } from '../formula/formula'
+import type { GlobalFormulas } from '../formula/formulaTypes'
+import {
+  getFormulasInAction,
+  getFormulasInFormula,
+} from '../formula/formulaUtils'
+import { isDefined } from '../utils/util'
+import type { ApiRequest } from './apiTypes'
+
+export class ToddleApiV2<Handler> implements ApiRequest {
+  private api: ApiRequest
+  private _apiReferences?: Set<string>
+  private key: string
+  private globalFormulas: GlobalFormulas<Handler>
+
+  constructor(
+    api: ApiRequest,
+    apiKey: string,
+    globalFormulas: GlobalFormulas<Handler>,
+  ) {
+    this.api = api
+    this.key = apiKey
+    this.globalFormulas = globalFormulas
+  }
+
+  get apiReferences(): Set<string> {
+    if (this._apiReferences) {
+      // Only compute apiReferences once
+      return this._apiReferences
+    }
+    const apis = new Set<string>()
+    const visitFormulaReference = (formula?: Formula | null) => {
+      if (!isDefined(formula)) {
+        return
+      }
+      switch (formula.type) {
+        case 'path':
+          if (formula.path[0] === 'Apis') {
+            apis.add(formula.path[1])
+          }
+          break
+        case 'value':
+          break
+        case 'record':
+          formula.entries.forEach((entry) =>
+            visitFormulaReference(entry.formula),
+          )
+          break
+        case 'function':
+        case 'array':
+        case 'or':
+        case 'and':
+        case 'apply':
+        case 'object':
+          formula.arguments?.forEach((arg) =>
+            visitFormulaReference(arg.formula),
+          )
+          break
+        case 'switch':
+          formula.cases.forEach((c) => {
+            visitFormulaReference(c.condition)
+            visitFormulaReference(c.formula)
+          })
+          break
+      }
+    }
+    visitFormulaReference(this.api.autoFetch)
+    visitFormulaReference(this.api.url)
+    Object.values(this.api.path ?? {}).forEach((p) =>
+      visitFormulaReference(p.formula),
+    )
+    Object.values(this.api.headers ?? {}).forEach((h) =>
+      visitFormulaReference(h.formula),
+    )
+    visitFormulaReference(this.api.body)
+    Object.values(this.api.inputs).forEach((arg) =>
+      visitFormulaReference(arg.formula),
+    )
+    Object.values(this.api.queryParams ?? {}).forEach((q) => {
+      visitFormulaReference(q.formula)
+    })
+    visitFormulaReference(this.api.server?.proxy?.enabled?.formula)
+    visitFormulaReference(this.api.server?.ssr?.enabled?.formula)
+    visitFormulaReference(this.api.client?.debounce?.formula)
+    Object.values(this.api.redirectRules ?? {}).forEach((rule) => {
+      visitFormulaReference(rule.formula)
+    })
+    visitFormulaReference(this.api.isError?.formula)
+    visitFormulaReference(this.api.timeout?.formula)
+    // Ensure self references are not included - for instance if an API references its
+    // own response in a redirect rule
+    apis.delete(this.key)
+
+    this._apiReferences = apis
+    return apis
+  }
+
+  get version() {
+    return this.api.version
+  }
+
+  get name() {
+    return this.api.name
+  }
+
+  get type() {
+    return this.api.type
+  }
+
+  get autoFetch() {
+    return this.api.autoFetch
+  }
+
+  get url() {
+    return this.api.url
+  }
+
+  get path() {
+    return this.api.path
+  }
+
+  get headers() {
+    return this.api.headers
+  }
+
+  set headers(headers) {
+    this.api.headers = headers
+  }
+
+  get method() {
+    return this.api.method
+  }
+
+  get body() {
+    return this.api.body
+  }
+
+  get inputs() {
+    return this.api.inputs
+  }
+
+  get queryParams() {
+    return this.api.queryParams
+  }
+
+  get server() {
+    return this.api.server
+  }
+
+  get client() {
+    return this.api.client
+  }
+
+  get redirectRules() {
+    return this.api.redirectRules
+  }
+
+  get isError() {
+    return this.api.isError
+  }
+
+  get timeout() {
+    return this.api.timeout
+  }
+
+  get '@toddle/metadata'() {
+    return this.api['@toddle/metadata']
+  }
+
+  *formulasInApi(): Generator<[(string | number)[], Formula]> {
+    const api = this.api
+    const apiKey = this.key
+    for (const [input, value] of Object.entries(this.api.inputs)) {
+      yield* getFormulasInFormula({
+        formula: value.formula,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'inputs', input, 'formula'],
+      })
+    }
+    yield* getFormulasInFormula({
+      formula: api.autoFetch,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'autoFetch'],
+    })
+    yield* getFormulasInFormula({
+      formula: api.url,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'url'],
+    })
+    for (const [pathKey, path] of Object.entries(api.path ?? {})) {
+      yield* getFormulasInFormula({
+        formula: path.formula,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'path', pathKey, 'formula'],
+      })
+    }
+    for (const [queryParamKey, queryParam] of Object.entries(
+      api.queryParams ?? {},
+    )) {
+      yield* getFormulasInFormula({
+        formula: queryParam.formula,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'queryParams', queryParamKey, 'formula'],
+      })
+      yield* getFormulasInFormula({
+        formula: queryParam.enabled,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'queryParams', queryParamKey, 'enabled'],
+      })
+    }
+
+    for (const [headerKey, header] of Object.entries(api.headers ?? {})) {
+      yield* getFormulasInFormula({
+        formula: header.formula,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'headers', headerKey, 'formula'],
+      })
+      yield* getFormulasInFormula({
+        formula: header.enabled,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'headers', headerKey, 'enabled'],
+      })
+    }
+
+    yield* getFormulasInFormula({
+      formula: api.body,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'body'],
+    })
+    for (const [actionKey, action] of Object.entries(
+      api.client?.onCompleted?.actions ?? {},
+    )) {
+      yield* getFormulasInAction({
+        action,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'client', 'onCompleted', 'actions', actionKey],
+      })
+    }
+    for (const [actionKey, action] of Object.entries(
+      api.client?.onFailed?.actions ?? {},
+    )) {
+      yield* getFormulasInAction({
+        action,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'client', 'onFailed', 'actions', actionKey],
+      })
+    }
+    yield* getFormulasInFormula({
+      formula: api.client?.debounce?.formula,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'client', 'debounce', 'formula'],
+    })
+    for (const [actionKey, action] of Object.entries(
+      api.client?.onMessage?.actions ?? {},
+    )) {
+      yield* getFormulasInAction({
+        action,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'client', 'onMessage', 'actions', actionKey],
+      })
+    }
+    for (const [rule, value] of Object.entries(api.redirectRules ?? {})) {
+      yield* getFormulasInFormula({
+        formula: value.formula,
+        globalFormulas: this.globalFormulas,
+        path: ['apis', apiKey, 'redirectRules', rule, 'formula'],
+      })
+    }
+    yield* getFormulasInFormula({
+      formula: api.isError?.formula,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'isError', 'formula'],
+    })
+    yield* getFormulasInFormula({
+      formula: api.timeout?.formula,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'timeout', 'formula'],
+    })
+    yield* getFormulasInFormula({
+      formula: api.server?.proxy?.enabled.formula,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'server', 'proxy', 'enabled', 'formula'],
+    })
+    yield* getFormulasInFormula({
+      formula: api.server?.ssr?.enabled?.formula,
+      globalFormulas: this.globalFormulas,
+      path: ['apis', apiKey, 'server', 'ssr', 'enabled', 'formula'],
+    })
+  }
+
+  *actionModelsInApi(): Generator<[(string | number)[], ActionModel]> {
+    for (const [actionKey, action] of Object.entries(
+      this.api.client?.onCompleted?.actions ?? {},
+    )) {
+      yield* getActionsInAction(action, [
+        'apis',
+        this.key,
+        'client',
+        'onCompleted',
+        'actions',
+        actionKey,
+      ])
+    }
+    for (const [actionKey, action] of Object.entries(
+      this.api.client?.onFailed?.actions ?? {},
+    )) {
+      yield* getActionsInAction(action, [
+        'apis',
+        this.key,
+        'client',
+        'onFailed',
+        'actions',
+        actionKey,
+      ])
+    }
+    for (const [actionKey, action] of Object.entries(
+      this.api.client?.onMessage?.actions ?? {},
+    )) {
+      yield* getActionsInAction(action, [
+        'apis',
+        this.key,
+        'client',
+        'onData',
+        'actions',
+        actionKey,
+      ])
+    }
+  }
+}