@nordcraft/search 1.0.0

package/src/types.d.ts

@@ -0,0 +1,312 @@
+/* eslint-disable @typescript-eslint/no-unsafe-function-type */
+import type {
+  ApiRequest,
+  ComponentAPI,
+} from '@nordcraft/core/dist/api/apiTypes'
+import type {
+  ComponentEvent as _ComponentEvent,
+  ActionModel,
+  Component,
+  ElementNodeModel,
+  NodeModel,
+  StyleVariant,
+} from '@nordcraft/core/dist/component/component.types'
+import type { ToddleComponent } from '@nordcraft/core/dist/component/ToddleComponent'
+import type { Formula } from '@nordcraft/core/dist/formula/formula'
+import type { PluginFormula } from '@nordcraft/core/dist/formula/formulaTypes'
+import type { Theme } from '@nordcraft/core/dist/styling/theme'
+import type {
+  ApiService,
+  PluginAction,
+  ProjectFiles,
+  Route,
+} from '@nordcraft/ssr/dist/ssr.types'
+
+type Code =
+  | 'duplicate event trigger'
+  | 'duplicate url parameter'
+  | 'duplicate workflow parameter'
+  | 'duplicate route'
+  | 'invalid api parser mode'
+  | 'legacy action'
+  | 'legacy api'
+  | 'legacy formula'
+  | 'no context consumers'
+  | 'no-console'
+  | 'no-reference api input'
+  | 'no-reference api'
+  | 'no-reference attribute'
+  | 'no-reference component formula'
+  | 'no-reference component workflow'
+  | 'no-reference component'
+  | 'no-reference event'
+  | 'no-reference project action'
+  | 'no-reference project formula'
+  | 'no-reference variable'
+  | 'no-unnecessary-condition-falsy'
+  | 'no-unnecessary-condition-truthy'
+  | 'non-empty void element'
+  | 'required api autofetch'
+  | 'required direct child'
+  | 'required direct parent'
+  | 'required element attribute'
+  | 'required extension'
+  | 'required meta tag'
+  | 'image without dimension'
+  | 'unknown api input'
+  | 'unknown api'
+  | 'unknown attribute'
+  | 'unknown classname'
+  | 'unknown component formula input'
+  | 'unknown component slot'
+  | 'unknown context formula'
+  | 'unknown context provider formula'
+  | 'unknown context provider workflow'
+  | 'unknown context provider'
+  | 'unknown context workflow'
+  | 'unknown cookie'
+  | 'unknown component'
+  | 'unknown event'
+  | 'unknown formula'
+  | 'unknown project action'
+  | 'unknown project formula input'
+  | 'unknown project formula'
+  | 'unknown repeat index formula'
+  | 'unknown repeat item formula'
+  | 'unknown set url parameter'
+  | 'unknown trigger event'
+  | 'unknown trigger workflow'
+  | 'unknown url parameter'
+  | 'unknown variable setter'
+  | 'unknown variable'
+  | 'unknown trigger workflow parameter'
+  | 'unknown workflow parameter'
+
+type Category =
+  | 'Unknown Reference'
+  | 'No References'
+  | 'SEO'
+  | 'Accessibility'
+  | 'Deprecation'
+  | 'Performance'
+  | 'Security'
+  | 'Quality'
+  | 'Other'
+
+type Level = 'error' | 'warning' | 'info'
+
+export type Result = {
+  path: (string | number)[]
+  code: Code
+  category: Category
+  level: Level
+  details?: any
+}
+
+interface ApplicationCookie {
+  url: string
+  name: string
+  domain: string
+  hostOnly: boolean
+  path: string
+  secure: boolean
+  sameSite: 'no_restriction' | 'lax' | 'strict'
+  session: boolean
+  expirationDate?: number
+}
+
+type HttpOnlyCookie = ApplicationCookie & {
+  httpOnly: true
+  value: never
+}
+
+type NonHttpOnlyCookie = ApplicationCookie & {
+  httpOnly: false
+  value: string
+}
+
+export interface ApplicationState {
+  cookiesAvailable?: Array<HttpOnlyCookie | NonHttpOnlyCookie>
+  isBrowserExtensionAvailable?: boolean
+}
+
+type Base = {
+  files: Omit<ProjectFiles, 'config'> & Partial<Pick<ProjectFiles, 'config'>>
+  /**
+   * The JSON-path
+   */
+  path: (string | number)[]
+  /**
+   * Memoization function used to cache the result of an expensive function.
+   *
+   * Useful for constructing a lookup table for a given key to avoid looking up the same value multiple times. Great for reducing the time complexity of a function from O(n^2) to O(n).
+   * @param key A lookup key to store the result of the function. The cache is cleared after each run, but different rules may share the same cache. Example: `['variableInComponent', component.name]`
+   * @param fn A function that returns the value to be memoized. This function is only called if the value is not already in the cache already.
+   * @returns The value of the memoized function.
+   */
+  memo: <T>(key: string, fn: () => T) => T
+}
+
+type ProjectFormulaNode = {
+  nodeType: 'project-formula'
+  value: PluginFormula<string>
+} & Base
+
+type ProjectActionNode = {
+  nodeType: 'project-action'
+  value: PluginAction
+} & Base
+
+type ProjectApiService = {
+  nodeType: 'api-service'
+  value: ApiService
+} & Base
+
+type ProjectRoute = {
+  nodeType: 'project-route'
+  value: Route
+  routeName: string
+} & Base
+
+type ComponentNode = {
+  nodeType: 'component'
+  value: Component
+} & Base
+
+type ComponentAPINode = {
+  nodeType: 'component-api'
+  value: ComponentAPI
+  component: ToddleComponent<Function>
+} & Base
+
+type ComponentAPIInputNode = {
+  nodeType: 'component-api-input'
+  value: ApiRequest['inputs'][0]
+  api: ApiRequest
+  component: ToddleComponent<Function>
+} & Base
+
+type ComponentWorkflowNode = {
+  nodeType: 'component-workflow'
+  value: {
+    name: string
+    parameters?:
+      | {
+          name: string
+          testValue: any
+        }[]
+      | null
+    actions: ActionModel[]
+    exposeInContext?: boolean | undefined
+  }
+  component: ToddleComponent<Function>
+} & Base
+
+type ComponentFormulaNode = {
+  nodeType: 'component-formula'
+  value: {
+    name: string
+    arguments?:
+      | {
+          name: string
+          testValue: any
+        }[]
+      | null
+    memoize?: boolean | undefined
+    exposeInContext?: boolean | undefined
+    formula: Formula
+  }
+  component: ToddleComponent<Function>
+} & Base
+
+type ComponentVariableNode = {
+  nodeType: 'component-variable'
+  value: Component['variables'][0]
+  component: ToddleComponent<Function>
+} & Base
+
+type ComponentAttributeNode = {
+  nodeType: 'component-attribute'
+  value: Component['attributes'][0]
+  component: ToddleComponent<Function>
+} & Base
+
+type FormulaNode = {
+  nodeType: 'formula'
+  value: Formula
+  component?: ToddleComponent<Function>
+} & Base
+
+type ActionModelNode = {
+  nodeType: 'action-model'
+  value: ActionModel
+  component: ToddleComponent<Function>
+} & Base
+
+type ComponentContext = {
+  nodeType: 'component-context'
+  value: {
+    formulas: string[]
+    workflows: string[]
+    componentName?: string
+    package?: string
+  }
+} & Base
+
+type ComponentEvent = {
+  nodeType: 'component-event'
+  value: { component: ToddleComponent<Function>; event: _ComponentEvent }
+} & Base
+
+type ComponentNodeNode = {
+  nodeType: 'component-node'
+  value: NodeModel
+  component: ToddleComponent<Function>
+} & Base
+
+type ProjectThemeNode = {
+  nodeType: 'project-theme'
+  value: Theme
+} & Base
+
+type ProjectConfigNode = {
+  nodeType: 'project-config'
+  value: unknown
+} & Base
+
+type StyleVariantNode = {
+  nodeType: 'style-variant'
+  value: { variant: StyleVariant; element: ElementNodeModel }
+} & Base
+
+export type NodeType =
+  | ActionModelNode
+  | ComponentAPIInputNode
+  | ComponentAPINode
+  | ComponentAttributeNode
+  | ComponentContext
+  | ComponentEvent
+  | ComponentFormulaNode
+  | ComponentNode
+  | ComponentNodeNode
+  | ComponentVariableNode
+  | ComponentWorkflowNode
+  | FormulaNode
+  | ProjectActionNode
+  | ProjectApiService
+  | ProjectConfigNode
+  | ProjectFormulaNode
+  | ProjectThemeNode
+  | ProjectRoute
+  | StyleVariantNode
+
+export interface Rule<T = unknown, V = NodeType> {
+  category: Category
+  code: Code
+  level: Level
+  visit: (
+    report: (path: (string | number)[], details?: T) => void,
+    data: V,
+    state?: ApplicationState | undefined,
+  ) => void
+}

package/src/util/helpers.ts

@@ -0,0 +1,44 @@
+import type { ActionModel } from '@nordcraft/core/dist/component/component.types'
+
+export function shouldSearchPath(
+  path: (string | number)[],
+  pathsToVisit: string[][] = [],
+) {
+  return (
+    pathsToVisit.length === 0 ||
+    pathsToVisit.some((pathToVisit) =>
+      pathToVisit.every((p1, i) => path[i] === p1),
+    )
+  )
+}
+
+export const isLegacyAction = (model: ActionModel) => {
+  switch (model.type) {
+    case 'Custom':
+    case undefined:
+      // Legacy action has no version, while newer ones have a version 2+
+      return !model.version && LEGACY_CUSTOM_ACTIONS.has(model.name)
+  }
+  return false
+}
+
+const LEGACY_CUSTOM_ACTIONS = new Set([
+  'If',
+  'PreventDefault',
+  'StopPropagation',
+  'Copy To Clipboard',
+  'CopyToClipboard',
+  'UpdateVariable',
+  'Update Variable',
+  'Update URL parameter',
+  'updateUrlParameters',
+  'UpdateQueryParam',
+  'Update Query',
+  'Fetch',
+  'SetTimeout',
+  'SetInterval',
+  'FocusElement',
+  'Debug',
+  'GoToURL',
+  'TriggerEvent',
+])