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

Comparing version 0.14.0 to 0.15.0

lib/BundleOptions.d.ts

@@ -11,6 +11,11 @@ import type { PackageSettings } from './PackageSettings.js';
     /**
-     * The entry point paths map. Key is path to the output file, relative to `outputPath` and stripped of `.js`
-     * extension. Value is the input entry path, relative to `inputPath` including the extension. For example:
-     * `{ 'lib/index': 'src/index.js' }`
+     * Mapping from output file to source file paths.
+     * - Key is the output file path, relative to `outputPath` (with forward slashes and leading `./`)
+     *   and *without* the extension (unless it's non-JS).
+     * - Value is the input file path, relative to `inputPath` (with forward slashes and leading `./`)
+     *   including the extension.
      *
+     * For example:
+     * `{ './lib/index': './src/index.js' }`
+     *
      * Note: Non-javascript extensions, such as `.css` or `.scss`, will not be stripped from the key.
@@ -17,0 +22,0 @@ * This is to ensure the bundler keeps the original extension intact and adds `.js` after it.

lib/BundleOutputFile.d.ts

 export interface BundleOutputFile {
     /**
      * The relative path to the output file (starting from `BundleResult#outputPath`),
-     * with forward slashes.
+     * with forward slashes and an extension.
      */
@@ -9,3 +9,4 @@ outputPath: string;
      * The relative path to the entry file (starting from `BundleResult#inputPath`),
-     * with forward slashes.
+     * with forward slashes and an extension. This will only be set for files that were
+     * listed in `entries`.
      */
@@ -15,2 +16,4 @@ entryPoint?: string;
      * The list of export names coming from the output file.
+     *
+     * WARNING: This is not set by all bundlers!
      */
@@ -17,0 +20,0 @@ exports?: string[];

lib/index.d.ts

@@ -23,3 +23,3 @@ export { allFeatures } from './allFeatures.js';
 export type { PackageSettings, PackageSettingsMatch } from './PackageSettings.js';
-export type { Route, RenderedRoute, BootstrapRoute, StaticRoute, RedirectRoute } from './Route.js';
+export type { BootstrapRoute, RedirectRoute, RenderedRoute, Route, SharedRouteOptions, ShorthandRenderedRoute, ShorthandRoute, StaticRoute, } from './Route.js';
 export { isBootstrapRoute, isRenderedRoute, isStaticRoute, isRedirectRoute } from './Route.js';
@@ -26,0 +26,0 @@ export type { TelemetryConfig } from './TelemetryConfig.js';

lib/RenderFunctionOptions.d.ts

@@ -15,8 +15,10 @@ import type { Request, Response } from 'express';
     importMap: ImportMap;
-    overlayScript: string | undefined;
-    entryScript: string | undefined;
-    inlineScripts: string[];
+    overlayScript?: string;
+    entryScripts?: string[];
+    inlineScripts?: string[];
     req: Request;
     res: Response;
+    /** @deprecated - use entryScripts. */
+    entryScript?: string;
 }
 //# sourceMappingURL=RenderFunctionOptions.d.ts.map

lib/Route.d.ts

@@ -22,3 +22,3 @@ import type { ExpandedSourcePath } from './ExpandedSourcePath.js';
     /**
-     * The key in the exports map which represents the entry point app script for this route.
+     * @deprecated - The key in the exports map which represents the entry point app script for this route.
      * Default is '.', meaning the main package export key.
@@ -28,5 +28,5 @@ */
     /**
-     * To be implemented. The source entry or entries to be included on the page for this route.
+     * The source entry or entries to be included on the page for this route.
      */
-    entry?: (string | ExpandedSourcePath)[];
+    entry?: string | string[];
 }
@@ -37,3 +37,3 @@ /**
  */
-export type RenderedRoute = Omit<ShorthandRenderedRoute, 'entry'> & {
+export type RenderedRoute = Omit<ShorthandRenderedRoute, 'exportEntry' | 'entry'> & {
     /**
@@ -56,3 +56,3 @@ * To be implemented. The source entry or entries to be included on the page for this route.
  */
-export interface BootstrapRoute extends SharedRouteOptions, Pick<ShorthandRenderedRoute, 'exportEntry'> {
+export interface BootstrapRoute extends SharedRouteOptions, Pick<RenderedRoute, 'entry'> {
     type: 'bootstrap';
@@ -59,0 +59,0 @@ }

lib/Route.js

@@ -18,4 +18,3 @@ /**
     const maybeRenderedRoute = route;
-    return (!isBootstrapRoute(route) &&
-        !!(maybeRenderedRoute.renderScript || maybeRenderedRoute.entry || maybeRenderedRoute.exportEntry));
+    return !isBootstrapRoute(route) && !!(maybeRenderedRoute.renderScript || maybeRenderedRoute.entry);
 }
@@ -22,0 +21,0 @@ /**

package.json

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

schema/AppConfig.json

@@ -537,17 +537,17 @@ {
           "type": "string",
-          "description": "The key in the exports map which represents the entry point app script for this route. Default is '.', meaning the main package export key."
+          "deprecated": "- The key in the exports map which represents the entry point app script for this route.\nDefault is '.', meaning the main package export key."
         },
         "entry": {
-          "type": "array",
-          "items": {
-            "anyOf": [
-              {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
                 "type": "string"
-              },
-              {
-                "$ref": "#/definitions/ExpandedSourcePath"
               }
-            ]
-          },
-          "description": "To be implemented. The source entry or entries to be included on the page for this route."
+            }
+          ],
+          "description": "The source entry or entries to be included on the page for this route."
         }
@@ -561,25 +561,2 @@ },
     },
-    "ExpandedSourcePath": {
-      "type": "object",
-      "properties": {
-        "sourcePath": {
-          "type": "string",
-          "description": "The relative path to the source file. (e.g. `./src/index.ts`)"
-        },
-        "importPath": {
-          "type": "string",
-          "description": "The path to import the resulting bundled output from. This would represent the key in the import map entry to be imported. (e.g. `.` represents the default package export.)"
-        },
-        "requestPath": {
-          "type": "string",
-          "description": "The path to be requested by the browser. This would present the value in the import map entry to be requested. (e.g. `./lib/index.js`)"
-        }
-      },
-      "required": [
-        "sourcePath",
-        "importPath",
-        "requestPath"
-      ],
-      "additionalProperties": false
-    },
     "StaticRoute": {
@@ -617,5 +594,8 @@ "type": "object",
       "properties": {
-        "exportEntry": {
-          "type": "string",
-          "description": "The key in the exports map which represents the entry point app script for this route. Default is '.', meaning the main package export key."
+        "entry": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ExpandedSourcePath"
+          },
+          "description": "To be implemented. The source entry or entries to be included on the page for this route."
         },
@@ -648,2 +628,25 @@ "match": {
     },
+    "ExpandedSourcePath": {
+      "type": "object",
+      "properties": {
+        "sourcePath": {
+          "type": "string",
+          "description": "The relative path to the source file. (e.g. `./src/index.ts`)"
+        },
+        "importPath": {
+          "type": "string",
+          "description": "The path to import the resulting bundled output from. This would represent the key in the import map entry to be imported. (e.g. `.` represents the default package export.)"
+        },
+        "requestPath": {
+          "type": "string",
+          "description": "The path to be requested by the browser. This would present the value in the import map entry to be requested. (e.g. `./lib/index.js`)"
+        }
+      },
+      "required": [
+        "sourcePath",
+        "importPath",
+        "requestPath"
+      ],
+      "additionalProperties": false
+    },
     "RedirectRoute": {
@@ -650,0 +653,0 @@ "type": "object",

schema/UserConfig.json

@@ -538,17 +538,17 @@ {
           "type": "string",
-          "description": "The key in the exports map which represents the entry point app script for this route. Default is '.', meaning the main package export key."
+          "deprecated": "- The key in the exports map which represents the entry point app script for this route.\nDefault is '.', meaning the main package export key."
         },
         "entry": {
-          "type": "array",
-          "items": {
-            "anyOf": [
-              {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
                 "type": "string"
-              },
-              {
-                "$ref": "#/definitions/ExpandedSourcePath"
               }
-            ]
-          },
-          "description": "To be implemented. The source entry or entries to be included on the page for this route."
+            }
+          ],
+          "description": "The source entry or entries to be included on the page for this route."
         }
@@ -562,25 +562,2 @@ },
     },
-    "ExpandedSourcePath": {
-      "type": "object",
-      "properties": {
-        "sourcePath": {
-          "type": "string",
-          "description": "The relative path to the source file. (e.g. `./src/index.ts`)"
-        },
-        "importPath": {
-          "type": "string",
-          "description": "The path to import the resulting bundled output from. This would represent the key in the import map entry to be imported. (e.g. `.` represents the default package export.)"
-        },
-        "requestPath": {
-          "type": "string",
-          "description": "The path to be requested by the browser. This would present the value in the import map entry to be requested. (e.g. `./lib/index.js`)"
-        }
-      },
-      "required": [
-        "sourcePath",
-        "importPath",
-        "requestPath"
-      ],
-      "additionalProperties": false
-    },
     "StaticRoute": {
@@ -618,5 +595,8 @@ "type": "object",
       "properties": {
-        "exportEntry": {
-          "type": "string",
-          "description": "The key in the exports map which represents the entry point app script for this route. Default is '.', meaning the main package export key."
+        "entry": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ExpandedSourcePath"
+          },
+          "description": "To be implemented. The source entry or entries to be included on the page for this route."
         },
@@ -649,2 +629,25 @@ "match": {
     },
+    "ExpandedSourcePath": {
+      "type": "object",
+      "properties": {
+        "sourcePath": {
+          "type": "string",
+          "description": "The relative path to the source file. (e.g. `./src/index.ts`)"
+        },
+        "importPath": {
+          "type": "string",
+          "description": "The path to import the resulting bundled output from. This would represent the key in the import map entry to be imported. (e.g. `.` represents the default package export.)"
+        },
+        "requestPath": {
+          "type": "string",
+          "description": "The path to be requested by the browser. This would present the value in the import map entry to be requested. (e.g. `./lib/index.js`)"
+        }
+      },
+      "required": [
+        "sourcePath",
+        "importPath",
+        "requestPath"
+      ],
+      "additionalProperties": false
+    },
     "RedirectRoute": {
@@ -651,0 +654,0 @@ "type": "object",

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

255450

increased by0.3%

Lines of code

4143

increased by0.36%

No dependency changes