@ms-cloudpack/common-types - npm Package Compare versions

Comparing version 0.7.2 to 0.8.0

lib/CloudpackConfig.d.ts

 import type { GeneratedConfig } from './GeneratedConfig.js';
 import type { AppConfig } from './AppConfig.js';
+import type { BundleMode } from './BundleMode.js';
 /**
@@ -7,4 +8,5 @@ * The merged result of user-provided and generated configuration for Cloudpack.
 export type CloudpackConfig = AppConfig & {
+    mode: BundleMode;
     generated: GeneratedConfig;
 };
 //# sourceMappingURL=CloudpackConfig.d.ts.map

lib/index.d.ts

@@ -8,2 +8,3 @@ export { allFeatures } from './allFeatures.js';
 export type { BundleMessageNote } from './BundleMessageNote.js';
+export type { BundleMode } from './BundleMode.js';
 export type { BundleOptions } from './BundleOptions.js';
@@ -10,0 +11,0 @@ export type { BundleOutputFile } from './BundleOutputFile.js';

lib/PackageJson.d.ts

@@ -0,1 +1,2 @@
+import type { PackageSettings } from './PackageSettings.js';
 /**
@@ -97,3 +98,7 @@ * Types for the `package.json` file, derived from [`type-fest`](https://github.com/sindresorhus/type-fest/blob/main/source/package-json.d.ts).
     };
-    /** Cloudpack internally added property: name and version prior to nonSemverTransform (if different) */
+    /** Merged package settings. */
+    cloudpack?: Omit<PackageSettings, 'match'> & {
+        mode: string | undefined;
+    };
+    /** @deprecated: Cloudpack internally added property: name and version prior to nonSemverTransform (if different) */
     cloudpackRemapped?: {
@@ -100,0 +105,0 @@ originalName: string;

lib/PackageSettings.d.ts

@@ -7,5 +7,5 @@ import type { PackageJsonExports } from './PackageJson.js';
     /**
-     * A match to indicate the target for the settings to be applied to.
+     * A match to indicate the target for the settings to be applied to. Defaults to *.
      */
-    match: {
+    match?: {
         /**
@@ -12,0 +12,0 @@ * Name of the package. Can use a trailing wildcard (e.g. "\@scope/*").

package.json

 {
   "name": "@ms-cloudpack/common-types",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "Common types for Cloudpack.",
@@ -5,0 +5,0 @@ "license": "MIT",

schema/AppConfig.json

@@ -589,3 +589,3 @@ {
           ],
-          "description": "A match to indicate the target for the settings to be applied to."
+          "description": "A match to indicate the target for the settings to be applied to. Defaults to *."
         },
@@ -666,5 +666,2 @@ "includedDependencies": {
       },
-      "required": [
-        "match"
-      ],
       "additionalProperties": false,
@@ -671,0 +668,0 @@ "description": "Settings which apply to a single package (app or library) as it pertains to the Cloudpack start experience."

schema/GeneratedConfig.json

@@ -52,3 +52,3 @@ {
           ],
-          "description": "A match to indicate the target for the settings to be applied to."
+          "description": "A match to indicate the target for the settings to be applied to. Defaults to *."
         },
@@ -129,5 +129,2 @@ "includedDependencies": {
       },
-      "required": [
-        "match"
-      ],
       "additionalProperties": false,
@@ -553,2 +550,85 @@ "description": "Settings which apply to a single package (app or library) as it pertains to the Cloudpack start experience."
         },
+        "cloudpack": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "mode": {
+              "type": "string"
+            },
+            "includedDependencies": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "The dependencies which should be included when computing the import map. This is primarily used when devDependencies are needed by the app. This often happens when a library has a demo app which relies on devDependencies. Accepts `$devDependencies` as a special value to include all devDependencies."
+            },
+            "excludedDependencies": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "The dependencies which should be ignored by Cloudpack verbs. For example, if \"react-native\" is a dependency which should not be included in the import map or evaluated during `init`, it can be listed here to ignore it. Accepts `$peerDependencies` as a special value to exclude all peerDependencies."
+            },
+            "inlinedDependencies": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Dependencies which should be inlined in the library bundled by Cloudpack. This is useful for libraries which are small and don't need to be loaded separately, or ones which have issues being resolved by the browser."
+            },
+            "exports": {
+              "$ref": "#/definitions/PackageJsonExports",
+              "description": "The exports map that should be used for this package, ignoring entries which are defined in the original package.json. This is useful for libraries which have a missing or broken exports map, or when we want to trim the exports to reduce the api surface we expose to the inner loop experience."
+            },
+            "bundlerType": {
+              "type": "string",
+              "description": "Forces the package to be bundled using a specific bundler."
+            },
+            "bundlerOptions": {
+              "type": "object",
+              "additionalProperties": {},
+              "description": "Options to pass to the bundler."
+            },
+            "inputPaths": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Paths used for file monitoring and input hashing. Supports glob matching. Defaults to `[/src/**, *.json]` and excludes node_modules. Use `...` to include the default paths."
+            },
+            "ignoreMissingExports": {
+              "anyOf": [
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "description": "Construct a type with a set of properties K of type T"
+                }
+              ],
+              "description": "Controls the behavior of the `verifyExports` feature when checking consumed exports from this package:\n- If true, don't check this package's exports at all.\n- If an object, this is a mapping from package import paths to export names to ignore. Examples:   - To ignore top-level exports: `{ \".\": [\"badName\"] }`   - To ignore exports from another path: `{ \"./lib/foo\": [\"badName\"] }`"
+            },
+            "dynamicImports": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Only relevant for packages bundled with rollup: globs of files that include dynamic (async) imports with non-literal paths, to be processed by `@rollup/plugin-dynamic-import-vars` (subject to that plugin's [limitations](https://www.npmjs.com/package/\\@rollup/plugin-dynamic-import-vars#limitations)). Files matching `*.dynamic.*` are automatically included.\n\nThis is not needed for ori/esbuild and webpack because they should handle these types of imports automatically."
+            },
+            "ignoredBundlerWarnings": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Ignore these warning messages from the bundler (partial string matches). This is intended for non-actionable messages from external dependencies which can't easily be fixed, to avoid confusing users."
+            }
+          },
+          "description": "Merged package settings."
+        },
         "cloudpackRemapped": {
@@ -569,3 +649,3 @@ "type": "object",
           "additionalProperties": false,
-          "description": "Cloudpack internally added property: name and version prior to nonSemverTransform (if different)"
+          "deprecated": ": Cloudpack internally added property: name and version prior to nonSemverTransform (if different)"
         }
@@ -572,0 +652,0 @@ },

schema/UserConfig.json

@@ -590,3 +590,3 @@ {
           ],
-          "description": "A match to indicate the target for the settings to be applied to."
+          "description": "A match to indicate the target for the settings to be applied to. Defaults to *."
         },
@@ -667,5 +667,2 @@ "includedDependencies": {
       },
-      "required": [
-        "match"
-      ],
       "additionalProperties": false,
@@ -672,0 +669,0 @@ "description": "Settings which apply to a single package (app or library) as it pertains to the Cloudpack start experience."

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

187644

increased by3.74%

Number of package files

110

increased by3.77%

Lines of code

3169

increased by3.12%

No dependency changes