@ms-cloudpack/package-utilities 0.8.1 → 0.9.0

package/CHANGELOG.json

@@ -2,7 +2,22 @@
   "name": "@ms-cloudpack/package-utilities",
   "entries": [
     {
-      "date": "Sat, 03 Sep 2022 08:15:01 GMT",
+      "date": "Sun, 04 Sep 2022 08:14:28 GMT",
+      "tag": "@ms-cloudpack/package-utilities_v0.9.0",
+      "version": "0.9.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "dzearing@microsoft.com",
+            "package": "@ms-cloudpack/package-utilities",
+            "commit": "33c2ca948b1ea905fa5a09f56bd443724d638fe3",
+            "comment": "Adding PackageDefinitions implementation."
+          }
+        ]
+      }
+    },
+    {
+      "date": "Sat, 03 Sep 2022 08:15:29 GMT",
       "tag": "@ms-cloudpack/package-utilities_v0.8.1",
       "version": "0.8.1",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Change Log - @ms-cloudpack/package-utilities
 
-This log was last generated on Sat, 03 Sep 2022 08:15:01 GMT and should not be manually modified.
+This log was last generated on Sun, 04 Sep 2022 08:14:28 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.9.0
+
+Sun, 04 Sep 2022 08:14:28 GMT
+
+### Minor changes
+
+- Adding PackageDefinitions implementation. (dzearing@microsoft.com)
+
 ## 0.8.1
 
-Sat, 03 Sep 2022 08:15:01 GMT
+Sat, 03 Sep 2022 08:15:29 GMT
 
 ### Patches
 

package/lib/PackageDefinitions.d.ts

@@ -0,0 +1,12 @@
+import type { PackageJson } from 'type-fest';
+export declare type PackageDefinitionTransform = (definition: PackageJson) => PackageJson | undefined;
+export declare class PackageDefinitions {
+    static getInstance(): PackageDefinitions;
+    private _cache;
+    private _transforms;
+    get(packagePath: string, options?: {
+        refresh: boolean;
+    }): Promise<PackageJson | undefined>;
+    registerTransform(callback: PackageDefinitionTransform): void;
+    clear(): void;
+}

package/lib/PackageDefinitions.js

@@ -0,0 +1,41 @@
+import path from 'path';
+import { applyOverrides } from '@ms-cloudpack/package-overrides';
+import { readJson } from '@ms-cloudpack/json-utilities';
+let _singleton;
+export class PackageDefinitions {
+    constructor() {
+        this._cache = {};
+        this._transforms = [applyOverrides];
+    }
+    static getInstance() {
+        if (!_singleton) {
+            _singleton = new PackageDefinitions();
+        }
+        return _singleton;
+    }
+    async get(packagePath, options) {
+        let existingDefinition = this._cache[packagePath];
+        if (!existingDefinition || options?.refresh) {
+            try {
+                // Load the package and apply transforms.
+                const definition = await readJson(path.join(packagePath, 'package.json'));
+                // If we have loaded a definition, apply transforms and cache/return the result.
+                if (definition) {
+                    existingDefinition = this._cache[packagePath] = this._transforms.reduce((def, transform) => transform(def) || def, definition);
+                }
+            }
+            catch (e) {
+                /* no-op */
+            }
+        }
+        return existingDefinition;
+    }
+    registerTransform(callback) {
+        this._transforms.push(callback);
+        this.clear();
+    }
+    clear() {
+        this._cache = {};
+    }
+}
+//# sourceMappingURL=PackageDefinitions.js.map

package/lib/PackageDefinitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageDefinitions.js","sourceRoot":"","sources":["../src/PackageDefinitions.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAGxD,IAAI,UAA0C,CAAC;AAG/C,MAAM,OAAO,kBAAkB;IAA/B;QAQU,WAAM,GAAgC,EAAE,CAAC;QACzC,gBAAW,GAAiC,CAAC,cAAc,CAAC,CAAC;IAiCvE,CAAC;IAzCC,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,UAAU,EAAE;YACf,UAAU,GAAG,IAAI,kBAAkB,EAAE,CAAC;SACvC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAKD,KAAK,CAAC,GAAG,CAAC,WAAmB,EAAE,OAA8B;QAC3D,IAAI,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAElD,IAAI,CAAC,kBAAkB,IAAI,OAAO,EAAE,OAAO,EAAE;YAC3C,IAAI;gBACF,yCAAyC;gBACzC,MAAM,UAAU,GAA4B,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,CAAC;gBAEnG,gFAAgF;gBAChF,IAAI,UAAU,EAAE;oBACd,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CACrE,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,EACzC,UAAU,CACX,CAAC;iBACH;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,WAAW;aACZ;SACF;QAED,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,iBAAiB,CAAC,QAAoC;QACpD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,KAAK;QACH,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;IACnB,CAAC;CACF"}

package/lib/PackageDefinitions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/PackageDefinitions.test.js

@@ -0,0 +1,89 @@
+import { PackageDefinitions } from './PackageDefinitions.js';
+import { testProject1Path } from './testPaths.js';
+import { describe, it, expect } from '@jest/globals';
+describe('PackageDefinitions', () => {
+    it('can get a package definition', async () => {
+        const definitions = new PackageDefinitions();
+        expect(await definitions.get(testProject1Path)).toMatchInlineSnapshot(`
+      {
+        "dependencies": {
+          "b": "^1.0.0",
+          "c": "^1.0.0",
+        },
+        "exports": {
+          ".": "./lib/index.js",
+          "./foo": "./lib/foo.js",
+        },
+        "name": "test-project-1",
+        "type": "module",
+        "version": "0.0.1",
+      }
+    `);
+    });
+    it('can return undefined when the package definition is missing', async () => {
+        const definitions = new PackageDefinitions();
+        expect(await definitions.get('./missing')).toBeUndefined();
+    });
+    it('can get package definitions with transforms', async () => {
+        const definitions = new PackageDefinitions();
+        definitions.registerTransform((definition) => ({
+            ...definition,
+            name: 'transformed',
+        }));
+        expect(await definitions.get(testProject1Path)).toMatchInlineSnapshot(`
+      {
+        "dependencies": {
+          "b": "^1.0.0",
+          "c": "^1.0.0",
+        },
+        "exports": {
+          ".": "./lib/index.js",
+          "./foo": "./lib/foo.js",
+        },
+        "name": "transformed",
+        "type": "module",
+        "version": "0.0.1",
+      }
+    `);
+    });
+    it('can get package definitions with transforms and refresh', async () => {
+        const definitions = new PackageDefinitions();
+        let transformName = 'transformed';
+        let definition = await definitions.get(testProject1Path);
+        expect(definition?.name).toBe('test-project-1');
+        definitions.registerTransform((definition) => ({
+            ...definition,
+            name: transformName,
+        }));
+        definition = await definitions.get(testProject1Path);
+        expect(definition?.name).toBe('transformed');
+        transformName = 'transformed2';
+        // This should return a cached version.
+        definition = await definitions.get(testProject1Path);
+        expect(definition?.name).toBe('transformed');
+        // Passing in refresh:true should reset.
+        definition = await definitions.get(testProject1Path, { refresh: true });
+        expect(definition?.name).toBe('transformed2');
+    });
+    it('can get package definitions with transforms and clear', async () => {
+        const definitions = new PackageDefinitions();
+        let transformName = 'transformed';
+        let definition = await definitions.get(testProject1Path);
+        expect(definition?.name).toBe('test-project-1');
+        definitions.registerTransform((definition) => ({
+            ...definition,
+            name: transformName,
+        }));
+        definition = await definitions.get(testProject1Path);
+        expect(definition?.name).toBe('transformed');
+        transformName = 'transformed2';
+        // This should return a cached version.
+        definition = await definitions.get(testProject1Path);
+        expect(definition?.name).toBe('transformed');
+        // Clearing should reset.
+        definitions.clear();
+        definition = await definitions.get(testProject1Path);
+        expect(definition?.name).toBe('transformed2');
+    });
+});
+//# sourceMappingURL=PackageDefinitions.test.js.map

package/lib/PackageDefinitions.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PackageDefinitions.test.js","sourceRoot":"","sources":["../src/PackageDefinitions.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAErD,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,WAAW,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAE7C,MAAM,CAAC,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;KAcrE,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,WAAW,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAE7C,MAAM,CAAC,MAAM,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,WAAW,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAE7C,WAAW,CAAC,iBAAiB,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAC7C,GAAG,UAAU;YACb,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC,CAAC;QAEJ,MAAM,CAAC,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;KAcrE,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,WAAW,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC7C,IAAI,aAAa,GAAG,aAAa,CAAC;QAElC,IAAI,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACzD,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEhD,WAAW,CAAC,iBAAiB,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAC7C,GAAG,UAAU;YACb,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC,CAAC;QAEJ,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACrD,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7C,aAAa,GAAG,cAAc,CAAC;QAE/B,uCAAuC;QACvC,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACrD,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7C,wCAAwC;QACxC,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,WAAW,GAAG,IAAI,kBAAkB,EAAE,CAAC;QAC7C,IAAI,aAAa,GAAG,aAAa,CAAC;QAElC,IAAI,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACzD,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAEhD,WAAW,CAAC,iBAAiB,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAC7C,GAAG,UAAU;YACb,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC,CAAC;QAEJ,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACrD,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7C,aAAa,GAAG,cAAc,CAAC;QAE/B,uCAAuC;QACvC,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACrD,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7C,yBAAyB;QACzB,WAAW,CAAC,KAAK,EAAE,CAAC;QACpB,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACrD,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 export { createResolveMap } from './createResolveMap.js';
 export { evaluateImportsFromEntries } from './evaluateImportsFromEntries.js';
+export { PackageDefinitions, type PackageDefinitionTransform } from './PackageDefinitions.js';
 export { getPackageDefinition } from './getPackageDefinition.js';
 export { resolve } from './resolve.js';
 export { resolveImportFromPackage, resolveImportFromPackagePath, type ResolveImportFromPackageOptions, } from './resolveImportFromPackagePath.js';

package/lib/index.js

@@ -1,5 +1,6 @@
 export { createResolveMap } from './createResolveMap.js';
 export { evaluateImportsFromEntries } from './evaluateImportsFromEntries.js';
+export { PackageDefinitions } from './PackageDefinitions.js';
 export { getPackageDefinition } from './getPackageDefinition.js';
 export { resolve } from './resolve.js';
 export { resolveImportFromPackage, resolveImportFromPackagePath, } from './resolveImportFromPackagePath.js';

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAE7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAmB,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAkB,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,EAAE,kBAAkB,EAAmC,MAAM,yBAAyB,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAE7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAmB,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAkB,MAAM,sBAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/package-utilities",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Utilities for resolving/parsing packages and their imports.",
   "license": "MIT",
   "type": "module",