@sdeverywhere/plugin-config 0.2.13 → 0.2.14

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.
package/dist/index.d.ts CHANGED
@@ -1,41 +1,41 @@
1
- import { ModelSpec, BuildContext } from '@sdeverywhere/build';
2
-
1
+ import { BuildContext, ModelSpec } from "@sdeverywhere/build";
2
+ //#region src/processor.d.ts
3
3
  interface ConfigProcessorOutputPaths {
4
- /** The absolute path to the directory where model spec files will be written. */
5
- modelSpecsDir?: string;
6
- /** The absolute path to the directory where config spec files will be written. */
7
- configSpecsDir?: string;
8
- /** The absolute path to the directory where translated strings will be written. */
9
- stringsDir?: string;
4
+ /** The absolute path to the directory where model spec files will be written. */
5
+ modelSpecsDir?: string;
6
+ /** The absolute path to the directory where config spec files will be written. */
7
+ configSpecsDir?: string;
8
+ /** The absolute path to the directory where translated strings will be written. */
9
+ stringsDir?: string;
10
10
  }
11
11
  interface ConfigProcessorOptions {
12
- /**
13
- * The absolute path to the directory containing the CSV config files.
14
- */
15
- config: string;
16
- /**
17
- * Either a single path to a base output directory (in which case, the recommended
18
- * directory structure will be used) or a `ConfigProcessorOutputPaths` containing specific paths.
19
- * If a single string is provided, the following subdirectories will be used:
20
- * ```
21
- * <out-dir>/
22
- * src/
23
- * config/
24
- * generated/
25
- * model/
26
- * generated/
27
- * strings/
28
- * ```
29
- */
30
- out?: string | ConfigProcessorOutputPaths;
31
- /**
32
- * Additional model spec properties that cannot be derived from the CSV config files.
33
- *
34
- * These are merged into the `ModelSpec` returned by the processor, which allows for
35
- * configuring settings like `directData` for which there is currently no
36
- * representation in the config files.
37
- */
38
- spec?: ConfigProcessorSpec;
12
+ /**
13
+ * The absolute path to the directory containing the CSV config files.
14
+ */
15
+ config: string;
16
+ /**
17
+ * Either a single path to a base output directory (in which case, the recommended
18
+ * directory structure will be used) or a `ConfigProcessorOutputPaths` containing specific paths.
19
+ * If a single string is provided, the following subdirectories will be used:
20
+ * ```
21
+ * <out-dir>/
22
+ * src/
23
+ * config/
24
+ * generated/
25
+ * model/
26
+ * generated/
27
+ * strings/
28
+ * ```
29
+ */
30
+ out?: string | ConfigProcessorOutputPaths;
31
+ /**
32
+ * Additional model spec properties that cannot be derived from the CSV config files.
33
+ *
34
+ * These are merged into the `ModelSpec` returned by the processor, which allows for
35
+ * configuring settings like `directData` for which there is currently no
36
+ * representation in the config files.
37
+ */
38
+ spec?: ConfigProcessorSpec;
39
39
  }
40
40
  /**
41
41
  * The model spec properties that can be provided using the `spec` field of
@@ -52,6 +52,7 @@ type ConfigProcessorSpec = Omit<ModelSpec, 'inputs' | 'outputs' | 'datFiles' | '
52
52
  * - writes JS files to the configured output directories
53
53
  * - returns a `ModelSpec` that guides the rest of the `sde` build process
54
54
  */
55
- declare function configProcessor(options: ConfigProcessorOptions): (buildContext: BuildContext) => Promise<ModelSpec>;
56
-
57
- export { type ConfigProcessorOptions, type ConfigProcessorOutputPaths, type ConfigProcessorSpec, configProcessor };
55
+ export declare function configProcessor(options: ConfigProcessorOptions): (buildContext: BuildContext) => Promise<ModelSpec>;
56
+ //#endregion
57
+ export type { ConfigProcessorOptions, ConfigProcessorOutputPaths, ConfigProcessorSpec };
58
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","names":[],"sources":["../src/processor.d.ts"],"mappings":";;UACiB;;EAEb;;EAEA;;EAEA;;UAEa;;;;EAIb;;;;;;;;;;;;;;;EAeA,eAAe;;;;;;;;EAQf,OAAO;;;;;;;;;KASC,sBAAsB,KAAK;;;;;;;;wBAQf,gBAAgB,SAAS,0BAA0B,cAAc,iBAAiB,QAAQ"}