@magidoc/plugin-starter-variables 3.3.0 → 3.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2 @@
1
+ import type { Converter } from '../variable';
2
+ export declare function enumConverter<V extends string>(values: [V, ...V[]]): Converter<V>;
@@ -0,0 +1,18 @@
1
+ function enumConverter(values) {
2
+ return {
3
+ convert: (target) => {
4
+ if (target === null || target === undefined) {
5
+ return null;
6
+ }
7
+ if (!values.find((value) => value === target)) {
8
+ return null;
9
+ }
10
+ return target;
11
+ },
12
+ asString: (value) => String(value),
13
+ type: (z) => z.enum(values).optional(),
14
+ };
15
+ }
16
+
17
+ export { enumConverter };
18
+ //# sourceMappingURL=enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enum.js","sources":["../../../../src/variables/converters/enum.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEM,SAAU,aAAa,CAC3B,MAAmB,EAAA;IAEnB,OAAO;AACL,QAAA,OAAO,EAAE,CAAC,MAAM,KAAI;AAClB,YAAA,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS,EAAE;AAC3C,gBAAA,OAAO,IAAI,CAAA;AACZ,aAAA;AAED,YAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,KAAK,MAAM,CAAC,EAAE;AAC7C,gBAAA,OAAO,IAAI,CAAA;AACZ,aAAA;AAED,YAAA,OAAO,MAAW,CAAA;SACnB;QACD,QAAQ,EAAE,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,CAAC;AAClC,QAAA,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;KACvC,CAAA;AACH;;;;"}
@@ -13,12 +13,16 @@ export type AllowedDirective = {
13
13
  name: string;
14
14
  args: string[];
15
15
  };
16
+ export type FieldSorting = 'default' | 'alphabetical';
17
+ export type ArgumentSorting = 'default' | 'alphabetical';
16
18
  declare const _default: {
17
19
  APP_LOGO: import("./variable").Variable<string>;
18
20
  APP_TITLE: import("./variable").Variable<string>;
19
21
  APP_FAVICON: import("./variable").Variable<string>;
20
22
  SITE_ROOT: import("./variable").Variable<string>;
21
23
  SITE_META: import("./variable").Variable<Record<string, string | undefined>>;
24
+ FIELDS_SORTING: import("./variable").Variable<FieldSorting>;
25
+ ARGUMENTS_SORTING: import("./variable").Variable<ArgumentSorting>;
22
26
  QUERY_GENERATION_FACTORIES: import("./variable").Variable<Record<string, string | number | boolean | Record<string, unknown> | null | undefined>>;
23
27
  PAGES: import("./variable").Variable<(Page | undefined)[]>;
24
28
  EXTERNAL_LINKS: import("./variable").Variable<(ExternalLink | undefined)[]>;
@@ -1,6 +1,7 @@
1
1
  import { stringConverter } from './converters/string.js';
2
2
  import { recordConverter } from './converters/record.js';
3
3
  import { arrayConverter } from './converters/array.js';
4
+ import { enumConverter } from './converters/enum.js';
4
5
  import { createVariable } from './variable.js';
5
6
 
6
7
  var templates = {
@@ -9,6 +10,8 @@ var templates = {
9
10
  APP_FAVICON: createVariable('APP_FAVICON', stringConverter()),
10
11
  SITE_ROOT: createVariable('SITE_ROOT', stringConverter()),
11
12
  SITE_META: createVariable('SITE_META', recordConverter((zod) => zod.string())),
13
+ FIELDS_SORTING: createVariable('FIELDS_SORTING', enumConverter(['default', 'alphabetical'])),
14
+ ARGUMENTS_SORTING: createVariable('ARGUMENTS_SORTING', enumConverter(['default', 'alphabetical'])),
12
15
  QUERY_GENERATION_FACTORIES: createVariable('QUERY_GENERATION_FACTORIES', recordConverter((zod) => zod.union([
13
16
  zod.string(),
14
17
  zod.boolean(),
@@ -1 +1 @@
1
- {"version":3,"file":"templates.js","sources":["../../../src/variables/templates.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAsBA,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,QAAQ,EAAE,GAAG;AACV,iBAAA,KAAK,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;AACzD,iBAAA,QAAQ,EAAE;AACb,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;;;;"}
1
+ {"version":3,"file":"templates.js","sources":["../../../src/variables/templates.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AA2BA,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,cAAc,EAAE,cAAc,CAC5B,gBAAgB,EAChB,aAAa,CAAC,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAC3C;AACD,IAAA,iBAAiB,EAAE,cAAc,CAC/B,mBAAmB,EACnB,aAAa,CAAC,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAC3C;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,QAAQ,EAAE,GAAG;AACV,iBAAA,KAAK,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;AACzD,iBAAA,QAAQ,EAAE;AACb,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 CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@magidoc/plugin-starter-variables",
3
3
  "description": "A shared library that contains common Magidoc starter environment variables keys.",
4
4
  "private": false,
5
- "version": "3.3.0",
5
+ "version": "3.4.0",
6
6
  "type": "module",
7
7
  "license": "MIT",
8
8
  "main": "./build/index.js",
@@ -20,14 +20,14 @@
20
20
  "devDependencies": {
21
21
  "@rollup/plugin-typescript": "^11.0.0",
22
22
  "@types/lodash": "^4.14.191",
23
- "@types/node": "^18.13.0",
24
- "@vitest/coverage-c8": "^0.28.5",
23
+ "@types/node": "^18.14.1",
24
+ "@vitest/coverage-c8": "^0.29.1",
25
25
  "lodash": "^4.17.21",
26
- "rollup": "^3.15.0",
26
+ "rollup": "^3.17.3",
27
27
  "tslib": "^2.5.0",
28
28
  "typescript": "^4.9.5",
29
- "vite": "^4.1.1",
30
- "vitest": "^0.28.5"
29
+ "vite": "^4.1.4",
30
+ "vitest": "^0.29.1"
31
31
  },
32
32
  "optionalDependencies": {
33
33
  "zod": "^3.20.6"