@magidoc/plugin-starter-variables 2.14.4 → 3.0.0

package/build/index.d.ts

@@ -2,8 +2,8 @@ import templates from './variables/templates';
 import magidoc from './variables/magidoc';
 import { toVariablesFile, UnsupportedVariablesError } from './env/envFileContent';
 import type { Variable } from './variables/variable';
-import type { Page, ExternalLink } from './variables/templates';
-export type { Variable, Page, ExternalLink };
+import type { Page, ExternalLink, AllowedDirective } from './variables/templates';
+export type { Variable, Page, ExternalLink, AllowedDirective };
 export { templates };
 export { magidoc };
 export { toVariablesFile, UnsupportedVariablesError };

package/build/variables/templates.d.ts

@@ -8,6 +8,10 @@ export type ExternalLink = {
     kind?: string;
     group?: string;
 };
+export type AllowedDirective = {
+    name: string;
+    args: string[];
+};
 declare const _default: {
     APP_LOGO: import("./variable").Variable<string>;
     APP_TITLE: import("./variable").Variable<string>;
@@ -17,5 +21,6 @@ declare const _default: {
     QUERY_GENERATION_FACTORIES: import("./variable").Variable<Record<string, string | number | boolean | Record<string, unknown> | null | undefined>>;
     PAGES: import("./variable").Variable<(Page | undefined)[]>;
     EXTERNAL_LINKS: import("./variable").Variable<(ExternalLink | undefined)[]>;
+    DIRECTIVES: import("./variable").Variable<(AllowedDirective | undefined)[]>;
 };
 export default _default;

package/build/variables/templates.js

@@ -31,6 +31,12 @@ var templates = {
             group: zod.string().min(1).optional(),
         });
     })),
+    DIRECTIVES: createVariable('DIRECTIVES', arrayConverter((zod) => {
+        return zod.object({
+            name: zod.string().min(1),
+            args: zod.array(zod.string()),
+        });
+    })),
 };
 
 export { templates as default };

package/build/variables/templates.js.map

@@ -1 +1 @@
-{"version":3,"file":"templates.js","sources":["../../../src/variables/templates.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAgBA,gBAAe;AACb,IAAA,QAAQ,EAAE,cAAc,CAAS,UAAU,EAAE,eAAe,EAAE,CAAC;AAC/D,IAAA,SAAS,EAAE,cAAc,CAAS,WAAW,EAAE,eAAe,EAAE,CAAC;AACjE,IAAA,WAAW,EAAE,cAAc,CAAS,aAAa,EAAE,eAAe,EAAE,CAAC;AACrE,IAAA,SAAS,EAAE,cAAc,CAAS,WAAW,EAAE,eAAe,EAAE,CAAC;AACjE,IAAA,SAAS,EAAE,cAAc,CACvB,WAAW,EACX,eAAe,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC,CACvC;AACD,IAAA,0BAA0B,EAAE,cAAc,CAMxC,4BAA4B,EAC5B,eAAe,CAAC,CAAC,GAAG,KAClB,GAAG,CAAC,KAAK,CAAC;QACR,GAAG,CAAC,MAAM,EAAE;QACZ,GAAG,CAAC,OAAO,EAAE;QACb,GAAG,CAAC,MAAM,EAAE;QACZ,GAAG,CAAC,IAAI,EAAE;AACV,QAAA,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;AAC1B,KAAA,CAAC,CACH,CACF;IACD,KAAK,EAAE,cAAc,CACnB,OAAO,EACP,cAAc,CAAC,CAAC,GAAG,KAAI;AACrB,QAAA,MAAM,IAAI,GAAkB,GAAG,CAAC,IAAI,CAAC,MACnC,GAAG,CAAC,MAAM,CAAC;YACT,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3D,SAAA,CAAC,CACH,CAAA;AACD,QAAA,OAAO,IAAI,CAAA;AACb,KAAC,CAAC,CACH;IACD,cAAc,EAAE,cAAc,CAC5B,gBAAgB,EAChB,cAAc,CAAC,CAAC,GAAG,KAAI;QACrB,OAAO,GAAG,CAAC,MAAM,CAAC;YAChB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACzB,YAAA,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;AACpC,YAAA,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;AACtC,SAAA,CAAC,CAAA;AACJ,KAAC,CAAC,CACH;CACF;;;;"}
+{"version":3,"file":"templates.js","sources":["../../../src/variables/templates.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAqBA,gBAAe;AACb,IAAA,QAAQ,EAAE,cAAc,CAAS,UAAU,EAAE,eAAe,EAAE,CAAC;AAC/D,IAAA,SAAS,EAAE,cAAc,CAAS,WAAW,EAAE,eAAe,EAAE,CAAC;AACjE,IAAA,WAAW,EAAE,cAAc,CAAS,aAAa,EAAE,eAAe,EAAE,CAAC;AACrE,IAAA,SAAS,EAAE,cAAc,CAAS,WAAW,EAAE,eAAe,EAAE,CAAC;AACjE,IAAA,SAAS,EAAE,cAAc,CACvB,WAAW,EACX,eAAe,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC,CACvC;AACD,IAAA,0BAA0B,EAAE,cAAc,CAMxC,4BAA4B,EAC5B,eAAe,CAAC,CAAC,GAAG,KAClB,GAAG,CAAC,KAAK,CAAC;QACR,GAAG,CAAC,MAAM,EAAE;QACZ,GAAG,CAAC,OAAO,EAAE;QACb,GAAG,CAAC,MAAM,EAAE;QACZ,GAAG,CAAC,IAAI,EAAE;AACV,QAAA,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;AAC1B,KAAA,CAAC,CACH,CACF;IACD,KAAK,EAAE,cAAc,CACnB,OAAO,EACP,cAAc,CAAC,CAAC,GAAG,KAAI;AACrB,QAAA,MAAM,IAAI,GAAkB,GAAG,CAAC,IAAI,CAAC,MACnC,GAAG,CAAC,MAAM,CAAC;YACT,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3D,SAAA,CAAC,CACH,CAAA;AACD,QAAA,OAAO,IAAI,CAAA;AACb,KAAC,CAAC,CACH;IACD,cAAc,EAAE,cAAc,CAC5B,gBAAgB,EAChB,cAAc,CAAC,CAAC,GAAG,KAAI;QACrB,OAAO,GAAG,CAAC,MAAM,CAAC;YAChB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AACzB,YAAA,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;AACpC,YAAA,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;AACtC,SAAA,CAAC,CAAA;AACJ,KAAC,CAAC,CACH;IACD,UAAU,EAAE,cAAc,CACxB,YAAY,EACZ,cAAc,CAAC,CAAC,GAAG,KAAI;QACrB,OAAO,GAAG,CAAC,MAAM,CAAC;YAChB,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACzB,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;AAC9B,SAAA,CAAC,CAAA;AACJ,KAAC,CAAC,CACH;CACF;;;;"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@magidoc/plugin-starter-variables",
   "description": "A shared library that contains common Magidoc starter environment variables keys.",
   "private": false,
-  "version": "2.14.4",
+  "version": "3.0.0",
   "type": "module",
   "license": "MIT",
   "main": "./build/index.js",
@@ -18,20 +18,23 @@
     "directory": "packages/plugins/starter-variables"
   },
   "devDependencies": {
-    "@rollup/plugin-typescript": "^9.0.2",
-    "@types/lodash": "^4.14.189",
-    "@types/node": "^18.11.9",
-    "@vitest/coverage-c8": "^0.25.2",
+    "@rollup/plugin-typescript": "^10.0.1",
+    "@types/lodash": "^4.14.191",
+    "@types/node": "^18.11.10",
+    "@vitest/coverage-c8": "^0.25.3",
     "lodash": "^4.17.21",
-    "rollup": "^3.3.0",
+    "rollup": "^3.5.1",
     "tslib": "^2.4.1",
     "typescript": "^4.9.3",
     "vite": "^3.2.4",
-    "vitest": "^0.25.2"
+    "vitest": "^0.25.3"
   },
   "optionalDependencies": {
     "zod": "^3.19.1"
   },
+  "files": [
+    "build"
+  ],
   "scripts": {
     "start": "pnpm build:rollup && node build/index.js",
     "build": "run-p build:*",

package/.eslintrc.cjs

@@ -1,9 +0,0 @@
-const base = require('../../../.eslintrc.cjs')
-
-module.exports = {
-  ...base,
-  parserOptions: {
-    ...base.parserOptions,
-    project: [__dirname + '/tsconfig.json'],
-  },
-}

package/rollup.config.cjs

@@ -1,14 +0,0 @@
-const { defineConfig } = require('rollup')
-const typescript = require('@rollup/plugin-typescript')
-
-module.exports = defineConfig({
-  input: ['src/index.ts'],
-  plugins: [typescript()],
-  external: ['zod', 'lodash'],
-  output: {
-    dir: 'build',
-    format: 'esm',
-    sourcemap: true,
-    preserveModules: true,
-  },
-})

package/src/env/envFileContent.ts

@@ -1,60 +0,0 @@
-import _ from 'lodash'
-import magidoc from '../variables/magidoc'
-import type { Variable } from '../variables/variable'
-
-export function toVariablesFile(
-  options: Record<string, unknown>,
-  supportedVariables: ReadonlyArray<Variable<unknown>>,
-): string {
-  return asVariablesString(buildEnv(options, supportedVariables))
-}
-
-function asVariablesString(env: Record<string, string>) {
-  return JSON.stringify(env)
-}
-
-function buildEnv(
-  options: Record<string, unknown>,
-  supportedVariables: ReadonlyArray<Variable<unknown>>,
-): Record<string, string> {
-  let newRecord: Record<string, string> = {}
-  const unsupportedVariables: string[] = []
-  _.forEach(options, (value, key) => {
-    const variable = supportedVariables.find((option) => option.name === key)
-    if (!variable) {
-      unsupportedVariables.push(key)
-      return
-    }
-
-    newRecord = {
-      ...newRecord,
-      ...variable.asEnv(value),
-    }
-  })
-
-  if (unsupportedVariables.length > 0) {
-    throw new UnsupportedVariablesError(
-      `Options [${unsupportedVariables.toString()}] are not supported... Supported option names are [${supportedVariables
-        .map((value) => value.name)
-        .join(', ')}]`,
-      unsupportedVariables,
-    )
-  }
-
-  insertDefaultVariables(newRecord)
-  return newRecord
-}
-
-function insertDefaultVariables(newRecord: Record<string, string>) {
-  newRecord[magidoc.MAGIDOC_GENERATE.key] = 'true'
-}
-
-export class UnsupportedVariablesError extends Error {
-  public unsupportedVariables: string[]
-
-  constructor(message: string, unsupportedVariables: string[]) {
-    super(message)
-    this.unsupportedVariables = unsupportedVariables
-    this.name = 'UnsupportedVariableError'
-  }
-}

package/src/index.ts

@@ -1,13 +0,0 @@
-import templates from './variables/templates'
-import magidoc from './variables/magidoc'
-import {
-  toVariablesFile,
-  UnsupportedVariablesError,
-} from './env/envFileContent'
-import type { Variable } from './variables/variable'
-import type { Page, ExternalLink } from './variables/templates'
-
-export type { Variable, Page, ExternalLink }
-export { templates }
-export { magidoc }
-export { toVariablesFile, UnsupportedVariablesError }

package/src/variables/converters/array.ts

@@ -1,25 +0,0 @@
-import type { Converter, ZodTypeProvider } from '../variable'
-
-export function arrayConverter<V>(
-  valueType: ZodTypeProvider<V>,
-): Converter<Array<V | undefined>> {
-  return {
-    convert: (target) => {
-      if (Array.isArray(target)) {
-        return target as Array<V>
-      }
-
-      if (typeof target === 'string') {
-        const result = JSON.parse(target) as Record<string, V>
-        if (!Array.isArray(result)) {
-          return null
-        }
-        return result
-      }
-
-      return null
-    },
-    asString: (value) => JSON.stringify(value),
-    type: (z) => z.array(valueType(z)).optional(),
-  }
-}

package/src/variables/converters/boolean.ts

@@ -1,24 +0,0 @@
-import type { Converter } from '../variable'
-
-export function booleanConverter(): Converter<boolean> {
-  return {
-    convert: (target: unknown): boolean | null => {
-      if (target === null) return null
-      if (target === undefined) return null
-
-      switch (typeof target) {
-        case 'boolean':
-          return target
-        case 'string':
-          const lowerCase = target.toLowerCase().trim()
-          return lowerCase === 'true' || lowerCase === 't' || lowerCase === '1'
-        case 'number':
-          return target !== 0
-        default:
-          return null
-      }
-    },
-    asString: (value) => String(value),
-    type: (z) => z.boolean().optional(),
-  }
-}

package/src/variables/converters/index.ts

@@ -1,6 +0,0 @@
-import { stringConverter } from './string'
-import { booleanConverter } from './boolean'
-import { recordConverter } from './record'
-import { arrayConverter } from './array'
-
-export { stringConverter, booleanConverter, recordConverter, arrayConverter }

package/src/variables/converters/record.ts

@@ -1,25 +0,0 @@
-import type { Converter, ZodTypeProvider } from '../variable'
-
-export function recordConverter<V>(
-  valueType: ZodTypeProvider<V>,
-): Converter<Record<string, V | undefined>> {
-  return {
-    convert: (target) => {
-      if (typeof target === 'object') {
-        return target as Record<string, V>
-      }
-
-      if (typeof target === 'string') {
-        const result = JSON.parse(target) as Record<string, V>
-        if (typeof result !== 'object') {
-          return null
-        }
-        return result
-      }
-
-      return null
-    },
-    asString: (value) => JSON.stringify(value),
-    type: (z) => z.record(valueType(z).optional()).optional(),
-  }
-}

package/src/variables/converters/string.ts

@@ -1,15 +0,0 @@
-import type { Converter } from '../variable'
-
-export function stringConverter(): Converter<string> {
-  return {
-    convert: (target: unknown): string | null => {
-      if (target === null || target === undefined || target === '') {
-        return null
-      }
-
-      return String(target)
-    },
-    asString: (value) => String(value),
-    type: (z) => z.string().optional(),
-  }
-}

package/src/variables/magidoc.ts

@@ -1,9 +0,0 @@
-import { booleanConverter } from './converters'
-import { createVariable } from './variable'
-
-export default {
-  MAGIDOC_GENERATE: createVariable<boolean>(
-    'MAGIDOC_GENERATE',
-    booleanConverter(),
-  ),
-}

package/src/variables/templates.ts

@@ -1,66 +0,0 @@
-import type { ZodType } from 'zod'
-import { arrayConverter, recordConverter, stringConverter } from './converters'
-import { createVariable } from './variable'
-
-export type Page = {
-  title: string
-  content: string | Page[]
-}
-
-export type ExternalLink = {
-  label: string
-  href: string
-  kind?: string
-  group?: string
-}
-
-export default {
-  APP_LOGO: createVariable<string>('APP_LOGO', stringConverter()),
-  APP_TITLE: createVariable<string>('APP_TITLE', stringConverter()),
-  APP_FAVICON: createVariable<string>('APP_FAVICON', stringConverter()),
-  SITE_ROOT: createVariable<string>('SITE_ROOT', stringConverter()),
-  SITE_META: createVariable<Record<string, string | undefined>>(
-    'SITE_META',
-    recordConverter((zod) => zod.string()),
-  ),
-  QUERY_GENERATION_FACTORIES: createVariable<
-    Record<
-      string,
-      string | boolean | number | Record<string, unknown> | null | undefined
-    >
-  >(
-    'QUERY_GENERATION_FACTORIES',
-    recordConverter((zod) =>
-      zod.union([
-        zod.string(),
-        zod.boolean(),
-        zod.number(),
-        zod.null(),
-        zod.record(zod.unknown()),
-      ]),
-    ),
-  ),
-  PAGES: createVariable<Array<Page | undefined>>(
-    'PAGES',
-    arrayConverter((zod) => {
-      const type: ZodType<Page> = zod.lazy(() =>
-        zod.object({
-          title: zod.string().min(1),
-          content: zod.union([zod.array(type), zod.string().min(1)]),
-        }),
-      )
-      return type
-    }),
-  ),
-  EXTERNAL_LINKS: createVariable<Array<ExternalLink | undefined>>(
-    'EXTERNAL_LINKS',
-    arrayConverter((zod) => {
-      return zod.object({
-        label: zod.string().min(1),
-        href: zod.string().min(1),
-        kind: zod.string().min(1).optional(),
-        group: zod.string().min(1).optional(),
-      })
-    }),
-  ),
-}

package/src/variables/variable.ts

@@ -1,52 +0,0 @@
-import type { ZodType, ZodTypeDef } from 'zod'
-
-interface MetaEnv {
-  [key: string]: unknown
-}
-
-export type Variable<T> = {
-  name: string
-  key: string
-  asEnv: (value: T) => Record<string, string>
-  get: (env: MetaEnv) => T | null
-  getOrDefault: (env: MetaEnv, def: T) => T
-  zod: ZodVariable<T>
-}
-
-export type ZodTypeProvider<T> = (
-  zod: typeof import('zod'),
-) => ZodType<T | undefined, ZodTypeDef, T | undefined>
-
-export type ZodVariable<T> = {
-  type: ZodTypeProvider<T>
-}
-
-export type Converter<T> = {
-  convert: (target: unknown) => T | null
-  asString: (value: T) => string
-  type: ZodTypeProvider<T>
-}
-
-export function createVariable<T>(
-  key: string,
-  converter: Converter<T>,
-): Variable<T> {
-  const get = (env: MetaEnv) => converter.convert(env[key])
-
-  return {
-    name: toCamelCase(key),
-    key: key,
-    asEnv: (value: T) => ({ [key]: converter.asString(value) }),
-    zod: {
-      type: converter.type,
-    },
-    get: get,
-    getOrDefault: (env, def) => get(env) ?? def,
-  }
-}
-
-function toCamelCase(key: string): string {
-  return key.toLowerCase().replace(/([-_][a-z])/gi, ($1) => {
-    return $1.toUpperCase().replace('-', '').replace('_', '')
-  })
-}

package/tests/env/envFileContent.spec.ts

@@ -1,55 +0,0 @@
-import { templates, Variable, magidoc, toVariablesFile } from '../../src'
-import { UnsupportedVariablesError } from '../../src/env/envFileContent'
-import { describe, expect, it } from 'vitest'
-
-describe('creating a variables file ', () => {
-  const initialObject = {
-    appTitle: 'My App',
-    pages: [
-      {
-        title: 'My-page-title',
-        content:
-          'A raw markdown string containing stuff like "double quotes", `code`, and **bold**.',
-      },
-      {
-        title: 'My-page-title-2',
-        content: [
-          {
-            title:
-              "This is another page, but this one contains 'single quotes', ```much more code```,\n new lines \n\n # And a new header apparently",
-          },
-        ],
-      },
-    ],
-  }
-
-  describe('all provided options are supported', () => {
-    const result = toVariablesFile(initialObject, [
-      templates.APP_TITLE as Variable<unknown>,
-      templates.PAGES as Variable<unknown>,
-    ])
-
-    it('is possible to convert it back to the original object using variables', () => {
-      const parsed = JSON.parse(result) as Record<string, string>
-
-      expect(magidoc.MAGIDOC_GENERATE.get(parsed)).toBe(true)
-      expect(templates.APP_TITLE.get(parsed)).toBe(initialObject.appTitle)
-      expect(templates.PAGES.get(parsed)).toEqual(initialObject.pages)
-    })
-  })
-
-  describe('some of the options are unsupported', () => {
-    it('raises an error', () => {
-      expect.assertions(2)
-
-      try {
-        toVariablesFile(initialObject, [])
-      } catch (error) {
-        expect(error).toBeInstanceOf(UnsupportedVariablesError)
-        expect(
-          (error as UnsupportedVariablesError).unsupportedVariables,
-        ).toEqual(['appTitle', 'pages'])
-      }
-    })
-  })
-})

package/tests/index.spec.ts

@@ -1,265 +0,0 @@
-import type { ZodType } from 'zod'
-import * as variables from '../src/index'
-import type { Variable } from '../src/variables/variable'
-import z from 'zod'
-import type { Page } from '../src/index'
-import { describe, expect, it, test } from 'vitest'
-
-describe('variables', () => {
-  it('contains the right number of export keys', () => {
-    expect(Object.keys(variables)).toEqual([
-      'templates',
-      'magidoc',
-      'toVariablesFile',
-      'UnsupportedVariablesError',
-    ])
-  })
-
-  describe('template variables', () => {
-    it('contains the right templates variables', () => {
-      expect(Object.keys(variables.templates)).toEqual([
-        'APP_LOGO',
-        'APP_TITLE',
-        'APP_FAVICON',
-        'SITE_ROOT',
-        'SITE_META',
-        'QUERY_GENERATION_FACTORIES',
-        'PAGES',
-        'EXTERNAL_LINKS',
-      ])
-    })
-
-    test('app title', () => {
-      testStringVariable(
-        variables.templates.APP_TITLE,
-        'APP_TITLE',
-        z.string().optional(),
-      )
-    })
-
-    test('app logo', () => {
-      testStringVariable(
-        variables.templates.APP_LOGO,
-        'APP_LOGO',
-        z.string().optional(),
-      )
-    })
-
-    test('app favicon', () => {
-      testStringVariable(
-        variables.templates.APP_FAVICON,
-        'APP_FAVICON',
-        z.string().optional(),
-      )
-    })
-
-    test('site root', () => {
-      testStringVariable(
-        variables.templates.SITE_ROOT,
-        'SITE_ROOT',
-        z.string().optional(),
-      )
-    })
-
-    test('site meta', () => {
-      testRecordVariable(
-        variables.templates.SITE_META,
-        'SITE_META',
-        z.record(z.string().optional()).optional(),
-      )
-    })
-
-    test('query generation factories', () => {
-      testRecordVariable(
-        variables.templates.QUERY_GENERATION_FACTORIES,
-        'QUERY_GENERATION_FACTORIES',
-        z
-          .record(
-            z
-              .union([
-                z.string(),
-                z.boolean(),
-                z.number(),
-                z.null(),
-                z.record(z.unknown()),
-              ])
-              .optional(),
-          )
-          .optional(),
-      )
-    })
-
-    test('pages', () => {
-      const pagesType: ZodType<Page> = z.lazy(() =>
-        z.object({
-          title: z.string(),
-          content: z.union([z.array(pagesType), z.string()]),
-        }),
-      )
-
-      testArrayVariable(
-        variables.templates.PAGES,
-        'PAGES',
-        z.array(pagesType).optional(),
-      )
-    })
-
-    test('external links', () => {
-      testArrayVariable(
-        variables.templates.EXTERNAL_LINKS,
-        'EXTERNAL_LINKS',
-        z
-          .array(
-            z.object({
-              label: z.string().min(1),
-              href: z.string().min(1),
-              kind: z.string().min(1).optional(),
-              group: z.string().min(1).optional(),
-            }),
-          )
-          .optional(),
-      )
-    })
-  })
-
-  describe('magidoc variables', () => {
-    it('contains the right magidoc variables', () => {
-      expect(Object.keys(variables.magidoc)).toEqual(['MAGIDOC_GENERATE'])
-    })
-
-    test('magidoc generate', () => {
-      testBooleanVariable(
-        variables.magidoc.MAGIDOC_GENERATE,
-        'MAGIDOC_GENERATE',
-        z.boolean().optional(),
-      )
-    })
-  })
-})
-
-function testStringVariable(
-  target: Variable<string>,
-  key: string,
-  expectedZod: ZodType<any>,
-) {
-  expect(target.key).toEqual(key)
-
-  expect(target.get({ [key]: 'Potato' })).toBe('Potato')
-  expect(target.get({ [key]: false })).toBe('false')
-  expect(target.get({})).toBeNull()
-
-  expect(target.getOrDefault({ [key]: 'Potato' }, 'Default')).toBe('Potato')
-  expect(target.getOrDefault({ [key]: false }, 'Default')).toBe('false')
-  expect(target.getOrDefault({}, 'Default')).toBe('Default')
-
-  expect(target.asEnv('Potato')).toEqual({ [key]: 'Potato' })
-
-  ensureZodTypeEqual(target, expectedZod)
-}
-
-function testBooleanVariable(
-  target: Variable<boolean>,
-  viteKey: string,
-  expectedZod: ZodType<any>,
-) {
-  expect(target.key).toEqual(viteKey)
-
-  expect(target.get({ [viteKey]: true })).toBe(true)
-  expect(target.get({ [viteKey]: 'true' })).toBe(true)
-  expect(target.get({ [viteKey]: 't' })).toBe(true)
-  expect(target.get({ [viteKey]: '1' })).toBe(true)
-  expect(target.get({ [viteKey]: 12 })).toBe(true)
-
-  expect(target.get({ [viteKey]: false })).toBe(false)
-  expect(target.get({ [viteKey]: 'false' })).toBe(false)
-  expect(target.get({ [viteKey]: 'wow' })).toBe(false)
-  expect(target.get({ [viteKey]: 0 })).toBe(false)
-
-  expect(target.get({ [viteKey]: {} })).toBeNull()
-  expect(target.get({ [viteKey]: null })).toBeNull()
-  expect(target.get({ [viteKey]: undefined })).toBeNull()
-  expect(target.get({})).toBeNull()
-
-  expect(target.getOrDefault({ [viteKey]: false }, true)).toBe(false)
-  expect(target.getOrDefault({ [viteKey]: {} }, true)).toBe(true)
-  expect(target.getOrDefault({}, true)).toBe(true)
-
-  expect(target.asEnv(true)).toEqual({ [viteKey]: 'true' })
-  expect(target.asEnv(false)).toEqual({ [viteKey]: 'false' })
-
-  ensureZodTypeEqual(target, expectedZod)
-}
-
-function testRecordVariable(
-  target: Variable<Record<string, any>>,
-  key: string,
-  expectedZod: ZodType<any>,
-) {
-  expect(target.key).toEqual(key)
-
-  expect(target.get({ [key]: true })).toBeNull()
-  expect(target.get({ [key]: 'true' })).toBeNull()
-  expect(target.get({ [key]: '4234' })).toBeNull()
-  expect(target.get({ [key]: 4234 })).toBeNull()
-
-  expect(target.get({ [key]: { abc: '123' } })).toEqual({ abc: '123' })
-  expect(target.get({ [key]: JSON.stringify({ abc: '123' }) })).toEqual({
-    abc: '123',
-  })
-
-  expect(target.getOrDefault({ [key]: false }, { abc: 123 })).toEqual({
-    abc: 123,
-  })
-  expect(target.getOrDefault({ [key]: {} }, { abc: 123 })).toEqual({})
-  expect(target.getOrDefault({}, { abc: 123 })).toEqual({ abc: 123 })
-
-  expect(target.asEnv({ abc: 123 })).toEqual({
-    [key]: JSON.stringify({ abc: 123 }),
-  })
-  expect(target.asEnv({})).toEqual({ [key]: '{}' })
-
-  ensureZodTypeEqual(target, expectedZod)
-}
-
-function testArrayVariable(
-  target: Variable<Array<any>>,
-  key: string,
-  expectedZod: ZodType<any>,
-) {
-  expect(target.key).toEqual(key)
-
-  expect(target.get({ [key]: true })).toBeNull()
-  expect(target.get({ [key]: 'true' })).toBeNull()
-  expect(target.get({ [key]: '4234' })).toBeNull()
-  expect(target.get({ [key]: 4234 })).toBeNull()
-  expect(target.get({ [key]: {} })).toBeNull()
-
-  expect(target.get({ [key]: [{ abc: '123' }] })).toEqual([{ abc: '123' }])
-  expect(target.get({ [key]: JSON.stringify([{ abc: '123' }]) })).toEqual([
-    { abc: '123' },
-  ])
-
-  expect(target.getOrDefault({ [key]: false }, [{ abc: 123 }])).toEqual([
-    {
-      abc: 123,
-    },
-  ])
-  expect(target.getOrDefault({ [key]: [] }, [{ abc: 123 }])).toEqual([])
-  expect(target.getOrDefault({}, [{ abc: 123 }])).toEqual([{ abc: 123 }])
-
-  expect(target.asEnv([{ abc: 123 }])).toEqual({
-    [key]: JSON.stringify([{ abc: 123 }]),
-  })
-  expect(target.asEnv([])).toEqual({ [key]: '[]' })
-
-  ensureZodTypeEqual(target, expectedZod)
-}
-
-function ensureZodTypeEqual(target: Variable<any>, expected: ZodType<any>) {
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  // @ts-ignore
-  // this does a good enough compare to make sure they have the same schema
-  expect(JSON.parse(JSON.stringify(target.zod.type(z)))).toEqual(
-    JSON.parse(JSON.stringify(expected, null, 2)),
-  )
-}

package/tsconfig.build.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "outDir": "build"
-  },
-  "include": ["src/**/*.ts", "src/**/*.d.ts"]
-}

package/tsconfig.json

@@ -1,27 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "esnext",
-    "useDefineForClassFields": true,
-    "importsNotUsedAsValues": "error",
-    "isolatedModules": true,
-    "module": "esnext",
-    "moduleResolution": "node",
-    "strict": true,
-    "noImplicitAny": true,
-    "noImplicitThis": true,
-    "noImplicitReturns": true,
-    "sourceMap": true,
-    "outDir": "build",
-    "resolveJsonModule": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "lib": ["esnext", "dom"]
-  },
-  "include": [
-    "vitest.config.ts",
-    "src/**/*.ts",
-    "src/**/*.d.ts",
-    "tests/**/*.ts"
-  ],
-  "exclude": ["build", "node_modules"]
-}

package/vitest.config.ts

@@ -1,13 +0,0 @@
-/// <reference types="vitest" />
-import { defineConfig } from 'vite'
-
-export default defineConfig({
-  test: {
-    mockReset: true,
-    coverage: {
-      all: true,
-      reporter: ['clover', 'lcov', 'html'],
-      src: ['./src'],
-    },
-  },
-})