@sdeverywhere/build 0.3.13 → 0.3.15

package/dist/index.d.cts

@@ -1,3 +1,4 @@
+import { ModelSpec as ModelSpec$1 } from '@sdeverywhere/compile';
 import { Result } from 'neverthrow';
 
 type LogLevel = 'error' | 'info' | 'verbose';
@@ -40,10 +41,33 @@ interface OutputSpec {
     varName: VarName;
 }
 /**
- * Describes a model (e.g., a Vensim mdl file) and the input/output variables
+ * The model spec properties that are shared with (and passed through unchanged to) the
+ * `ModelSpec` type from the compile package.
+ *
+ * The `inputVarNames` and `outputVarNames` properties are excluded because this package
+ * declares higher-level `inputs` and `outputs` properties in their place, which accept
+ * richer `InputSpec` and `OutputSpec` forms in addition to plain variable names.  The
+ * deprecated and derived properties from the compile package are excluded because a
+ * `sde.config.js` file should only use the preferred names.
+ */
+type CommonModelSpecProps = Omit<ModelSpec$1, 'inputVarNames' | 'outputVarNames' | 'externalDatfiles' | 'inputVars' | 'outputVars' | 'name'>;
+/**
+ * The `CommonModelSpecProps` properties that are filled in with a default value when a
+ * `ModelSpec` is resolved, and are therefore always defined in a `ResolvedModelSpec`.
+ * These are redeclared in `ResolvedModelSpec` so that they can be documented in terms of
+ * the resolved (non-optional) values.
+ */
+type ResolvedModelSpecProps = Omit<CommonModelSpecProps, 'datFiles' | 'bundleListing' | 'customConstants' | 'customLookups' | 'customOutputs'>;
+/**
+ * Describes a model (e.g., a Vensim `mdl` or Stella `stmx` file) and the input/output variables
  * that should be included in the model generated by SDEverywhere.
+ *
+ * Aside from the `inputs` and `outputs` properties (which allow for richer `InputSpec`
+ * and `OutputSpec` forms here), the properties of this interface are shared with the
+ * `ModelSpec` type from the compile package, which describes the `spec.json` file format
+ * used by the lower-level `sde` commands.
  */
-interface ModelSpec {
+interface ModelSpec extends CommonModelSpecProps {
     /**
      * The input variables for the model.  This can either be a simple array of
      * input variable names, or an array of `InputSpec` instances.
@@ -58,78 +82,25 @@ interface ModelSpec {
      */
     outputs: VarName[] | OutputSpec[];
     /**
-     * The dat files that provide the data for exogenous data variables in the
-     * model.
-     */
-    datFiles?: string[];
-    /**
-     * Whether to bundle a model listing with the generated model.
-     *
-     * If undefined, defaults to false.
-     *
-     * When this is true, a model listing will be bundled with the generated
-     * model to allow the `runtime` package to resolve variables that are
-     * referenced by name or identifier.  This listing will increase the size
-     * of the generated model, so it is recommended to set this to true only
-     * if it is needed.
-     */
-    bundleListing?: boolean;
-    /**
-     * Whether to allow constants to be overridden at runtime using `setConstant`.
-     *
-     * If undefined or false, the generated model will implement `setConstant`
-     * as a no-op, meaning that constants cannot be overridden at runtime.
-     *
-     * If true, all constants in the generated model will be available to be
-     * overridden.
-     *
-     * If an array is provided, only those variable names in the array will
-     * be available to be overridden.
-     */
-    customConstants?: boolean | VarName[];
-    /**
-     * Whether to allow lookups to be overridden at runtime using `setLookup`.
-     *
-     * If undefined or false, the generated model will implement `setLookup`
-     * as a no-op, meaning that lookups cannot be overridden at runtime.
+     * Additional properties to include in the generated `spec.json` file.
      *
-     * If true, all lookups in the generated model will be available to be
-     * overridden.
-     *
-     * If an array is provided, only those variable names in the array will
-     * be available to be overridden.
-     */
-    customLookups?: boolean | VarName[];
-    /**
-     * Whether to allow for capturing the data for arbitrary variables at
-     * runtime (including variables that are not configured in the `outputs`
-     * array).
-     *
-     * If undefined or false, the generated model will implement `storeOutput`
-     * as a no-op, meaning that the data for arbitrary variables cannot be
-     * captured at runtime.
-     *
-     * If true, all variables in the generated model will be available to be
-     * captured at runtime.
-     *
-     * If an array is provided, only those variable names in the array will
-     * be available to be captured at runtime.
+     * @deprecated All properties that are supported in a `spec.json` file are now declared
+     * directly on this interface, so it is no longer necessary to use this escape hatch.
+     * Any properties provided here will be merged into the resolved model spec (a property
+     * that is configured directly on this interface takes precedence over the same property
+     * provided here), but this property will be removed in a future release.
      */
-    customOutputs?: boolean | VarName[];
-    /** Additional options included with the SDE `spec.json` file. */
-    options?: {
-        [key: string]: any;
-    };
+    options?: ModelSpec$1;
 }
 /**
- * Describes a model (e.g., a Vensim mdl file) and the input/output variables
+ * Describes a model (e.g., a Vensim `mdl` or Stella `stmx` file) and the input/output variables
  * that should be included in the model generated by SDEverywhere.  This is
  * largely the same as the `ModelSpec` interface, except this one has been
  * fully resolved (paths have been validated, input and output variables have
  * been checked, etc).  This is the spec object that will be passed to plugin
  * functions.
  */
-interface ResolvedModelSpec {
+interface ResolvedModelSpec extends ResolvedModelSpecProps {
     /**
      * The input variable names for the model.  This will be defined regardless
      * of whether `ModelSpec.inputs` was defined as an array of variable names
@@ -156,7 +127,7 @@ interface ResolvedModelSpec {
      * The dat files that provide the data for exogenous data variables in the
      * model.
      */
-    datFiles: string[];
+    datFiles: NonNullable<ModelSpec$1['datFiles']>;
     /**
      * Whether to bundle a model listing with the generated model.
      *
@@ -209,10 +180,6 @@ interface ResolvedModelSpec {
      * be available to be captured at runtime.
      */
     customOutputs: boolean | VarName[];
-    /** Additional options included with the SDE `spec.json` file. */
-    options?: {
-        [key: string]: any;
-    };
 }
 
 /**

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ModelSpec as ModelSpec$1 } from '@sdeverywhere/compile';
 import { Result } from 'neverthrow';
 
 type LogLevel = 'error' | 'info' | 'verbose';
@@ -40,10 +41,33 @@ interface OutputSpec {
     varName: VarName;
 }
 /**
- * Describes a model (e.g., a Vensim mdl file) and the input/output variables
+ * The model spec properties that are shared with (and passed through unchanged to) the
+ * `ModelSpec` type from the compile package.
+ *
+ * The `inputVarNames` and `outputVarNames` properties are excluded because this package
+ * declares higher-level `inputs` and `outputs` properties in their place, which accept
+ * richer `InputSpec` and `OutputSpec` forms in addition to plain variable names.  The
+ * deprecated and derived properties from the compile package are excluded because a
+ * `sde.config.js` file should only use the preferred names.
+ */
+type CommonModelSpecProps = Omit<ModelSpec$1, 'inputVarNames' | 'outputVarNames' | 'externalDatfiles' | 'inputVars' | 'outputVars' | 'name'>;
+/**
+ * The `CommonModelSpecProps` properties that are filled in with a default value when a
+ * `ModelSpec` is resolved, and are therefore always defined in a `ResolvedModelSpec`.
+ * These are redeclared in `ResolvedModelSpec` so that they can be documented in terms of
+ * the resolved (non-optional) values.
+ */
+type ResolvedModelSpecProps = Omit<CommonModelSpecProps, 'datFiles' | 'bundleListing' | 'customConstants' | 'customLookups' | 'customOutputs'>;
+/**
+ * Describes a model (e.g., a Vensim `mdl` or Stella `stmx` file) and the input/output variables
  * that should be included in the model generated by SDEverywhere.
+ *
+ * Aside from the `inputs` and `outputs` properties (which allow for richer `InputSpec`
+ * and `OutputSpec` forms here), the properties of this interface are shared with the
+ * `ModelSpec` type from the compile package, which describes the `spec.json` file format
+ * used by the lower-level `sde` commands.
  */
-interface ModelSpec {
+interface ModelSpec extends CommonModelSpecProps {
     /**
      * The input variables for the model.  This can either be a simple array of
      * input variable names, or an array of `InputSpec` instances.
@@ -58,78 +82,25 @@ interface ModelSpec {
      */
     outputs: VarName[] | OutputSpec[];
     /**
-     * The dat files that provide the data for exogenous data variables in the
-     * model.
-     */
-    datFiles?: string[];
-    /**
-     * Whether to bundle a model listing with the generated model.
-     *
-     * If undefined, defaults to false.
-     *
-     * When this is true, a model listing will be bundled with the generated
-     * model to allow the `runtime` package to resolve variables that are
-     * referenced by name or identifier.  This listing will increase the size
-     * of the generated model, so it is recommended to set this to true only
-     * if it is needed.
-     */
-    bundleListing?: boolean;
-    /**
-     * Whether to allow constants to be overridden at runtime using `setConstant`.
-     *
-     * If undefined or false, the generated model will implement `setConstant`
-     * as a no-op, meaning that constants cannot be overridden at runtime.
-     *
-     * If true, all constants in the generated model will be available to be
-     * overridden.
-     *
-     * If an array is provided, only those variable names in the array will
-     * be available to be overridden.
-     */
-    customConstants?: boolean | VarName[];
-    /**
-     * Whether to allow lookups to be overridden at runtime using `setLookup`.
-     *
-     * If undefined or false, the generated model will implement `setLookup`
-     * as a no-op, meaning that lookups cannot be overridden at runtime.
+     * Additional properties to include in the generated `spec.json` file.
      *
-     * If true, all lookups in the generated model will be available to be
-     * overridden.
-     *
-     * If an array is provided, only those variable names in the array will
-     * be available to be overridden.
-     */
-    customLookups?: boolean | VarName[];
-    /**
-     * Whether to allow for capturing the data for arbitrary variables at
-     * runtime (including variables that are not configured in the `outputs`
-     * array).
-     *
-     * If undefined or false, the generated model will implement `storeOutput`
-     * as a no-op, meaning that the data for arbitrary variables cannot be
-     * captured at runtime.
-     *
-     * If true, all variables in the generated model will be available to be
-     * captured at runtime.
-     *
-     * If an array is provided, only those variable names in the array will
-     * be available to be captured at runtime.
+     * @deprecated All properties that are supported in a `spec.json` file are now declared
+     * directly on this interface, so it is no longer necessary to use this escape hatch.
+     * Any properties provided here will be merged into the resolved model spec (a property
+     * that is configured directly on this interface takes precedence over the same property
+     * provided here), but this property will be removed in a future release.
      */
-    customOutputs?: boolean | VarName[];
-    /** Additional options included with the SDE `spec.json` file. */
-    options?: {
-        [key: string]: any;
-    };
+    options?: ModelSpec$1;
 }
 /**
- * Describes a model (e.g., a Vensim mdl file) and the input/output variables
+ * Describes a model (e.g., a Vensim `mdl` or Stella `stmx` file) and the input/output variables
  * that should be included in the model generated by SDEverywhere.  This is
  * largely the same as the `ModelSpec` interface, except this one has been
  * fully resolved (paths have been validated, input and output variables have
  * been checked, etc).  This is the spec object that will be passed to plugin
  * functions.
  */
-interface ResolvedModelSpec {
+interface ResolvedModelSpec extends ResolvedModelSpecProps {
     /**
      * The input variable names for the model.  This will be defined regardless
      * of whether `ModelSpec.inputs` was defined as an array of variable names
@@ -156,7 +127,7 @@ interface ResolvedModelSpec {
      * The dat files that provide the data for exogenous data variables in the
      * model.
      */
-    datFiles: string[];
+    datFiles: NonNullable<ModelSpec$1['datFiles']>;
     /**
      * Whether to bundle a model listing with the generated model.
      *
@@ -209,10 +180,6 @@ interface ResolvedModelSpec {
      * be available to be captured at runtime.
      */
     customOutputs: boolean | VarName[];
-    /** Additional options included with the SDE `spec.json` file. */
-    options?: {
-        [key: string]: any;
-    };
 }
 
 /**

package/dist/index.js

@@ -661,8 +661,10 @@ async function generateCode(context, sdeDir, sdeCmdPath, prepDir) {
 }
 
 // src/build/impl/hash-files.ts
-import { join as joinPath4 } from "path";
-import { hashElement } from "folder-hash";
+import { createHash } from "crypto";
+import { createReadStream } from "fs";
+import { basename as basename2, join as joinPath4 } from "path";
+import { pipeline } from "stream/promises";
 import { glob } from "tinyglobby";
 async function computeInputFilesHash(config) {
   const inputFiles = [];
@@ -682,11 +684,16 @@ async function computeInputFilesHash(config) {
   }
   let hash = "";
   for (const inputFile of inputFiles) {
-    const result = await hashElement(inputFile);
-    hash += result.hash;
+    hash += await hashFile(inputFile);
   }
   return hash;
 }
+async function hashFile(file) {
+  const hash = createHash("sha1");
+  hash.update(basename2(file));
+  await pipeline(createReadStream(file), hash);
+  return hash.digest("base64");
+}
 
 // src/build/impl/build-once.ts
 async function buildOnce(config, userConfig, plugins, options) {
@@ -708,12 +715,15 @@ async function buildOnce(config, userConfig, plugins, options) {
     const specJson = {
       inputVarNames: modelSpec.inputVarNames,
       outputVarNames: modelSpec.outputVarNames,
-      externalDatfiles: modelSpec.datFiles,
+      datFiles: modelSpec.datFiles,
       bundleListing: modelSpec.bundleListing,
-      customConstants: modelSpec.customConstants || false,
-      customLookups: modelSpec.customLookups || false,
-      customOutputs: modelSpec.customOutputs || false,
-      ...modelSpec.options
+      customConstants: modelSpec.customConstants,
+      customLookups: modelSpec.customLookups,
+      customOutputs: modelSpec.customOutputs,
+      directData: modelSpec.directData,
+      dimensionFamilies: modelSpec.dimensionFamilies,
+      specialSeparationDims: modelSpec.specialSeparationDims,
+      separateAllVarsWithDims: modelSpec.separateAllVarsWithDims
     };
     const specPath = joinPath5(config.prepDir, "spec.json");
     await writeFile2(specPath, JSON.stringify(specJson, null, 2));
@@ -766,7 +776,9 @@ async function buildOnce(config, userConfig, plugins, options) {
   }
   return ok2(succeeded);
 }
-function resolveModelSpec(modelSpec) {
+function resolveModelSpec(userModelSpec) {
+  const { options, ...configuredProps } = userModelSpec;
+  const modelSpec = { ...options, ...configuredProps };
   let inputVarNames;
   let inputSpecs;
   if (modelSpec.inputs.length > 0) {
@@ -824,6 +836,9 @@ function resolveModelSpec(modelSpec) {
     customOutputs = false;
   }
   return {
+    // Carry through the properties (for example, `directData` and `specialSeparationDims`)
+    // that are shared with the compile package and don't need to be resolved here
+    ...modelSpec,
     inputVarNames,
     inputs: inputSpecs,
     outputVarNames,
@@ -832,13 +847,12 @@ function resolveModelSpec(modelSpec) {
     bundleListing: modelSpec.bundleListing === true,
     customConstants,
     customLookups,
-    customOutputs,
-    options: modelSpec.options
+    customOutputs
   };
 }
 
 // src/build/impl/watch.ts
-import { basename as basename2 } from "path";
+import { basename as basename3 } from "path";
 
 // src/build/impl/watch-paths.ts
 import chokidar from "chokidar";
@@ -909,7 +923,7 @@ function watch(config, userConfig, plugins) {
   function performBuild() {
     clearOverlay();
     for (const path of changedPaths) {
-      log("info", `Input file ${basename2(path)} has been changed`);
+      log("info", `Input file ${basename3(path)} has been changed`);
     }
     changedPaths.clear();
     if (currentBuildState) {