@sap-devx/app-studio-toolkit-types - npm Package Compare versions

Comparing version 1.8.0 to 1.8.2

api.d.ts

@@ -5,14 +5,17 @@ import { Uri } from "vscode";
 
-export type PackageName = string;
-export type SemVer = string;
-export type SemVerRange = string;
+/**
+ * re-export of the types from `@sap/artifact-management-types for convenience
+ * Example usage:
+ *
+ * ```typescript
+ *   import { sam } from "@sap-devx/app-studio-toolkit-types";
+ *
+ *   interface Foo {
+ *      x: sam.Item
+ *      y: sam.Module
+ *   }
+ * ```
+ */
+export * as sam from "@sap/artifact-management-types";
 
-export interface NodeUpgradeSpec {
-  package: PackageName;
-  version: {
-    from: SemVer | SemVerRange;
-    to: SemVer | SemVerRange;
-  };
-}
-
 /**
@@ -24,2 +27,4 @@ * Optional additional BAS specific metadata on a VSCode extension running in BAS.
     actions?: IAction[];
+    // metadata for the "NPM Dependency Upgrade Tool"
+    // See: https://github.com/SAP/app-studio-toolkit/tree/main/packages/vscode-deps-upgrade-tool
     upgrade: {
@@ -31,17 +36,32 @@ nodejs: NodeUpgradeSpec[];
 
+export type PackageName = string;
 /**
- * re-export of the types from `@sap/artifact-management-types for convenience
- * Example usage:
- *
- * ```typescript
- *   import { sam } from "@sap-devx/app-studio-toolkit-types";
- *
- *   interface Foo {
- *      x: sam.Item
- *      y: sam.Module
- *   }
- * ```
+ * An exact semVer version, e.g "1.2.3"
  */
-export * as sam from "@sap/artifact-management-types";
+export type SemVer = string;
+/**
+ * See: https://github.com/npm/node-semver#ranges
+ * See: https://github.com/npm/node-semver#advanced-range-syntax
+ */
+export type SemVerRange = string;
 
+export interface NodeUpgradeSpec {
+  /**
+   * The target package name to upgrade, e.g: "eslint"
+   */
+  package: PackageName;
+  version: {
+    /**
+     * The target version to upgrade, note that ranges are also supported,
+     * e.g: "^7.0.0" means to upgrade all versions included in the range: `7.0.0 >= x < 8.0.0`
+     */
+    from: SemVer | SemVerRange;
+    /**
+     * The version string to upgrade to, this string will be "inserted" as is
+     * in the relevant dependency **value** in the package.json
+     */
+    to: SemVer | SemVerRange;
+  };
+}
+
 export type BasWorkspaceApi = Pick<
@@ -78,8 +98,10 @@ WorkspaceApi,
   /**
+   * @deprecated - use the synchronized {@link BasToolkit.isLCAPEnabledSync} instead.
+   */
+  isLCAPEnabled: () => Promise<boolean>;
+
+  /**
    * Is environment LCAP or not
-   *
-   * @returns true is environment is LCAP in BAS,
-   *          `undefined` otherwise.
    */
-  isLCAPEnabled: () => Promise<boolean | undefined>;
+  isLCAPEnabledSync: () => boolean;
 
@@ -86,0 +108,0 @@ /**

package.json

 {
   "name": "@sap-devx/app-studio-toolkit-types",
-  "version": "1.8.0",
+  "version": "1.8.2",
   "author": "SAP SE",
@@ -28,3 +28,3 @@ "license": "Apache-2.0",
   },
-  "gitHead": "ecc1049545709984af99f4c02d7bd83f2f764f8a"
+  "gitHead": "1ef18808fc617aac0a78771f307b7a6c2d0d03d3"
 }

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

31376

increased by2.5%

Lines of code

202

increased by11.6%

No dependency changes