@magidoc/plugin-starter-variables 0.7.0 → 0.7.3

package/build/index.d.ts

@@ -1,2 +1,6 @@
-import common from './common';
-export { common };
+import templates from './variables/templates';
+import magidoc from './variables/magidoc';
+import type { Variable, ViteVariable } from './variables/variable';
+export { templates };
+export { magidoc };
+export type { Variable, ViteVariable };

package/build/index.js

@@ -1,2 +1,3 @@
-export { default as common } from './common/index.js';
+export { default as templates } from './variables/templates.js';
+export { default as magidoc } from './variables/magidoc.js';
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/build/variables/magidoc.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    MAGIDOC_GENERATE: import("./variable").Variable<boolean>;
+};
+export default _default;

package/build/variables/magidoc.js

@@ -0,0 +1,8 @@
+import { createVariable, booleanConversion } from './variable.js';
+
+var magidoc = {
+    MAGIDOC_GENERATE: createVariable('MAGIDOC_GENERATE', booleanConversion()),
+};
+
+export { magidoc as default };
+//# sourceMappingURL=magidoc.js.map

package/build/variables/magidoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"magidoc.js","sources":["../../../src/variables/magidoc.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA,cAAe;AACb,IAAA,gBAAgB,EAAE,cAAc,CAC9B,kBAAkB,EAClB,iBAAiB,EAAE,CACpB;CACF;;;;"}

package/build/variables/templates.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    APP_LOGO: import("./variable").Variable<string>;
+    APP_TITLE: import("./variable").Variable<string>;
+};
+export default _default;

package/build/variables/templates.js

@@ -0,0 +1,9 @@
+import { createVariable, stringConversion } from './variable.js';
+
+var templates = {
+    APP_LOGO: createVariable('APP_LOGO', stringConversion()),
+    APP_TITLE: createVariable('APP_TITLE', stringConversion()),
+};
+
+export { templates as default };
+//# sourceMappingURL=templates.js.map

package/build/variables/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sources":["../../../src/variables/templates.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA,gBAAe;AACb,IAAA,QAAQ,EAAE,cAAc,CAAS,UAAU,EAAE,gBAAgB,EAAE,CAAC;AAChE,IAAA,SAAS,EAAE,cAAc,CAAS,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACnE;;;;"}

package/build/{variable.d.ts → variables/variable.d.ts}

@@ -13,7 +13,7 @@ export declare type ViteVariable<T> = {
     get: (env: MetaEnv) => T | null;
     getOrDefault: (env: MetaEnv, def: T) => T;
 };
-export declare function createVariable<T = string | boolean>(key: string, conversion: (target: unknown) => T): Variable<T>;
-export declare function stringConversion(): (target: unknown) => string;
-export declare function booleanConversion(): (target: unknown) => boolean;
+export declare function createVariable<T = string | boolean>(key: string, conversion: (target: unknown) => T | null): Variable<T>;
+export declare function stringConversion(): (target: unknown) => string | null;
+export declare function booleanConversion(): (target: unknown) => boolean | null;
 export {};

package/build/variables/variable.js

@@ -0,0 +1,47 @@
+function createVariable(key, conversion) {
+    const viteKey = `VITE_${key.toUpperCase()}`;
+    const viteGet = (env) => conversion(env[viteKey]);
+    return {
+        names: [key, toCamelCase(key)],
+        vite: {
+            key: viteKey,
+            get: viteGet,
+            getOrDefault: (env, def) => viteGet(env) ?? def,
+        },
+    };
+}
+function toCamelCase(key) {
+    return key.toLowerCase().replace(/([-_][a-z])/gi, ($1) => {
+        return $1.toUpperCase().replace('-', '').replace('_', '');
+    });
+}
+function stringConversion() {
+    return (target) => {
+        if (target === null || target === undefined || target === '') {
+            return null;
+        }
+        return String(target);
+    };
+}
+function booleanConversion() {
+    return (target) => {
+        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;
+        }
+    };
+}
+
+export { booleanConversion, createVariable, stringConversion };
+//# sourceMappingURL=variable.js.map

package/build/variables/variable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable.js","sources":["../../../src/variables/variable.ts"],"sourcesContent":[null],"names":[],"mappings":"AAkBgB,SAAA,cAAc,CAC5B,GAAW,EACX,UAAyC,EAAA;IAEzC,MAAM,OAAO,GAAG,CAAQ,KAAA,EAAA,GAAG,CAAC,WAAW,EAAE,EAAE,CAAA;AAC3C,IAAA,MAAM,OAAO,GAAG,CAAC,GAAY,KAAK,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAA;IAE1D,OAAO;QACL,KAAK,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;AAC9B,QAAA,IAAI,EAAE;AACJ,YAAA,GAAG,EAAE,OAAO;AACZ,YAAA,GAAG,EAAE,OAAO;AACZ,YAAA,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG;AAChD,SAAA;KACF,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAAC,GAAW,EAAA;AAC9B,IAAA,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,EAAE,KAAI;AACvD,QAAA,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;AAC3D,KAAC,CAAC,CAAA;AACJ,CAAC;SAEe,gBAAgB,GAAA;IAC9B,OAAO,CAAC,MAAe,KAAmB;QACxC,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,EAAE,EAAE;AAC5D,YAAA,OAAO,IAAI,CAAA;AACZ,SAAA;AAED,QAAA,OAAO,MAAM,CAAC,MAAM,CAAC,CAAA;AACvB,KAAC,CAAA;AACH,CAAC;SAEe,iBAAiB,GAAA;IAC/B,OAAO,CAAC,MAAe,KAAoB;QACzC,IAAI,MAAM,KAAK,IAAI;AAAE,YAAA,OAAO,IAAI,CAAA;QAChC,IAAI,MAAM,KAAK,SAAS;AAAE,YAAA,OAAO,IAAI,CAAA;QAErC,QAAQ,OAAO,MAAM;AACnB,YAAA,KAAK,SAAS;AACZ,gBAAA,OAAO,MAAM,CAAA;AACf,YAAA,KAAK,QAAQ;gBACX,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAA;gBAC7C,OAAO,SAAS,KAAK,MAAM,IAAI,SAAS,KAAK,GAAG,IAAI,SAAS,KAAK,GAAG,CAAA;AACvE,YAAA,KAAK,QAAQ;gBACX,OAAO,MAAM,KAAK,CAAC,CAAA;AACrB,YAAA;AACE,gBAAA,OAAO,IAAI,CAAA;AACd,SAAA;AACH,KAAC,CAAA;AACH;;;;"}

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": "0.7.0",
+  "version": "0.7.3",
   "type": "module",
   "license": "MIT",
   "main": "./build/index.js",

package/src/index.ts

@@ -1,3 +1,7 @@
-import common from './common'
+import templates from './variables/templates'
+import magidoc from './variables/magidoc'
+import type { Variable, ViteVariable } from './variables/variable'
 
-export { common }
+export { templates }
+export { magidoc }
+export type { Variable, ViteVariable }

package/src/variables/magidoc.ts

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

package/src/{common/index.ts → variables/templates.ts}

@@ -1,4 +1,4 @@
-import { createVariable, stringConversion } from '../variable'
+import { createVariable, stringConversion } from './variable'
 
 export default {
   APP_LOGO: createVariable<string>('APP_LOGO', stringConversion()),

package/src/{variable.ts → variables/variable.ts}

@@ -18,11 +18,10 @@ export type ViteVariable<T> = {
 
 export function createVariable<T = string | boolean>(
   key: string,
-  conversion: (target: unknown) => T,
+  conversion: (target: unknown) => T | null,
 ): Variable<T> {
   const viteKey = `VITE_${key.toUpperCase()}`
-  const viteGet = (env: MetaEnv) =>
-    env[viteKey] !== undefined ? conversion(env[viteKey]) : null
+  const viteGet = (env: MetaEnv) => conversion(env[viteKey])
 
   return {
     names: [key, toCamelCase(key)],
@@ -39,12 +38,22 @@ function toCamelCase(key: string): string {
     return $1.toUpperCase().replace('-', '').replace('_', '')
   })
 }
+
 export function stringConversion() {
-  return (target: unknown): string => String(target)
+  return (target: unknown): string | null => {
+    if (target === null || target === undefined || target === '') {
+      return null
+    }
+
+    return String(target)
+  }
 }
 
 export function booleanConversion() {
-  return (target: unknown): boolean => {
+  return (target: unknown): boolean | null => {
+    if (target === null) return null
+    if (target === undefined) return null
+
     switch (typeof target) {
       case 'boolean':
         return target
@@ -54,7 +63,7 @@ export function booleanConversion() {
       case 'number':
         return target !== 0
       default:
-        return !!target
+        return null
     }
   }
 }

package/tests/index.spec.ts

@@ -1,16 +1,25 @@
 import * as variables from '../src/index'
-import type { Variable } from '../src/variable'
+import type { Variable } from '../src/variables/variable'
 
 describe('variables', () => {
   it('contains the right number of export keys', () => {
-    expect(Object.keys(variables)).toEqual(['common'])
+    expect(Object.keys(variables)).toEqual(['templates', 'magidoc'])
   })
 
-  it('contains the right common variables', () => {
-    expect(Object.keys(variables.common)).toEqual(['APP_LOGO', 'APP_TITLE'])
+  it('contains the right templates variables', () => {
+    expect(Object.keys(variables.templates)).toEqual(['APP_LOGO', 'APP_TITLE'])
 
-    testStringVariable(variables.common.APP_TITLE, 'VITE_APP_TITLE')
-    testStringVariable(variables.common.APP_LOGO, 'VITE_APP_LOGO')
+    testStringVariable(variables.templates.APP_TITLE, 'VITE_APP_TITLE')
+    testStringVariable(variables.templates.APP_LOGO, 'VITE_APP_LOGO')
+  })
+
+  it('contains the right magidoc variables', () => {
+    expect(Object.keys(variables.magidoc)).toEqual(['MAGIDOC_GENERATE'])
+
+    testBooleanVariable(
+      variables.magidoc.MAGIDOC_GENERATE,
+      'VITE_MAGIDOC_GENERATE',
+    )
   })
 })
 
@@ -29,3 +38,27 @@ function testStringVariable(target: Variable<string>, viteKey: string) {
   )
   expect(target.vite.getOrDefault({}, 'Default')).toBe('Default')
 }
+
+function testBooleanVariable(target: Variable<boolean>, viteKey: string) {
+  expect(target.vite.key).toEqual(viteKey)
+
+  expect(target.vite.get({ [viteKey]: true })).toBe(true)
+  expect(target.vite.get({ [viteKey]: 'true' })).toBe(true)
+  expect(target.vite.get({ [viteKey]: 't' })).toBe(true)
+  expect(target.vite.get({ [viteKey]: '1' })).toBe(true)
+  expect(target.vite.get({ [viteKey]: 12 })).toBe(true)
+
+  expect(target.vite.get({ [viteKey]: false })).toBe(false)
+  expect(target.vite.get({ [viteKey]: 'false' })).toBe(false)
+  expect(target.vite.get({ [viteKey]: 'wow' })).toBe(false)
+  expect(target.vite.get({ [viteKey]: 0 })).toBe(false)
+
+  expect(target.vite.get({ [viteKey]: {} })).toBeNull()
+  expect(target.vite.get({ [viteKey]: null })).toBeNull()
+  expect(target.vite.get({ [viteKey]: undefined })).toBeNull()
+  expect(target.vite.get({})).toBeNull()
+
+  expect(target.vite.getOrDefault({ [viteKey]: false }, true)).toBe(false)
+  expect(target.vite.getOrDefault({ [viteKey]: {} }, true)).toBe(true)
+  expect(target.vite.getOrDefault({}, true)).toBe(true)
+}

package/build/common/index.d.ts

@@ -1,5 +0,0 @@
-declare const _default: {
-    APP_LOGO: import("../variable").Variable<string>;
-    APP_TITLE: import("../variable").Variable<string>;
-};
-export default _default;

package/build/common/index.js

@@ -1,9 +0,0 @@
-import { createVariable, stringConversion } from '../variable.js';
-
-var index = {
-    APP_LOGO: createVariable('APP_LOGO', stringConversion()),
-    APP_TITLE: createVariable('APP_TITLE', stringConversion()),
-};
-
-export { index as default };
-//# sourceMappingURL=index.js.map

package/build/common/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../../../src/common/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA,YAAe;AACb,IAAA,QAAQ,EAAE,cAAc,CAAS,UAAU,EAAE,gBAAgB,EAAE,CAAC;AAChE,IAAA,SAAS,EAAE,cAAc,CAAS,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACnE;;;;"}

package/build/variable.js

@@ -1,23 +0,0 @@
-function createVariable(key, conversion) {
-    const viteKey = `VITE_${key.toUpperCase()}`;
-    const viteGet = (env) => env[viteKey] !== undefined ? conversion(env[viteKey]) : null;
-    return {
-        names: [key, toCamelCase(key)],
-        vite: {
-            key: viteKey,
-            get: viteGet,
-            getOrDefault: (env, def) => viteGet(env) ?? def,
-        },
-    };
-}
-function toCamelCase(key) {
-    return key.toLowerCase().replace(/([-_][a-z])/gi, ($1) => {
-        return $1.toUpperCase().replace('-', '').replace('_', '');
-    });
-}
-function stringConversion() {
-    return (target) => String(target);
-}
-
-export { createVariable, stringConversion };
-//# sourceMappingURL=variable.js.map

package/build/variable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"variable.js","sources":["../../src/variable.ts"],"sourcesContent":[null],"names":[],"mappings":"AAkBgB,SAAA,cAAc,CAC5B,GAAW,EACX,UAAkC,EAAA;IAElC,MAAM,OAAO,GAAG,CAAQ,KAAA,EAAA,GAAG,CAAC,WAAW,EAAE,EAAE,CAAA;IAC3C,MAAM,OAAO,GAAG,CAAC,GAAY,KAC3B,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAA;IAE9D,OAAO;QACL,KAAK,EAAE,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC;AAC9B,QAAA,IAAI,EAAE;AACJ,YAAA,GAAG,EAAE,OAAO;AACZ,YAAA,GAAG,EAAE,OAAO;AACZ,YAAA,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG;AAChD,SAAA;KACF,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAAC,GAAW,EAAA;AAC9B,IAAA,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,EAAE,KAAI;AACvD,QAAA,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;AAC3D,KAAC,CAAC,CAAA;AACJ,CAAC;SACe,gBAAgB,GAAA;IAC9B,OAAO,CAAC,MAAe,KAAa,MAAM,CAAC,MAAM,CAAC,CAAA;AACpD;;;;"}