@agnostack/env 2.0.0-canary.11 → 2.0.0-canary.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/esm/project.js +13 -8
  2. package/dist/project.d.ts +8 -4
  3. package/dist/project.js +13 -8
  4. package/package.json +1 -1
package/dist/esm/project.js CHANGED
@@ -17,6 +17,7 @@ export const parseProjectName = (_name) => {
17
17
  * manifests, and the parser is deliberately tolerant of a missing or partial object.
18
18
  *
19
19
  * @typedef {object} PackageInfo
20
+ * @property {string} [siteDescription]
20
21
  * @property {string} [deployVersion]
21
22
  * @property {string} [apiVersion]
22
23
  * @property {string} [version]
@@ -28,13 +29,14 @@ export const parseProjectName = (_name) => {
28
29
  * @property {string} [siteHandle]
29
30
  * @property {string} [siteAuthor]
30
31
  * @property {string[]} [keywords]
32
+ * @property {string[]} [siteKeywords]
33
+ * @property {string[]} [bundleDependencies]
34
+ * @property {string[]} [bundledDependencies]
35
+ * @property {string[]} [browserDependencies]
31
36
  * @property {Record<string, string>} [dependencies]
32
37
  * @property {Record<string, string>} [devDependencies]
33
38
  * @property {Record<string, string>} [peerDependencies]
34
39
  * @property {Record<string, string>} [optionalDependencies]
35
- * @property {string[]} [bundleDependencies]
36
- * @property {string[]} [bundledDependencies]
37
- * @property {string[]} [browserDependencies]
38
40
  */
39
41
  /**
40
42
  * Split a package.json into its resolved details, its organization and its full name.
@@ -47,7 +49,7 @@ export const parseProjectName = (_name) => {
47
49
  * @returns {[typeof packageDetails, string | undefined, string]}
48
50
  */
49
51
  export const parsePackageInfo = (packageInfo) => {
50
- const { apiVersion, version, keywords, shortName, siteAuthor, siteHandle, devDependencies, peerDependencies, bundleDependencies, bundledDependencies = bundleDependencies, dependencies: runtimeDependencies, optionalDependencies, browserDependencies, name: _name, owner: _appOwner, appName: _appName, siteName: _siteName, deployVersion: _deployVersion, } = packageInfo !== null && packageInfo !== void 0 ? packageInfo : {};
52
+ const { keywords, siteKeywords = keywords, siteDescription, apiVersion, version, shortName, siteAuthor, siteHandle, devDependencies, peerDependencies, bundleDependencies, bundledDependencies = bundleDependencies, dependencies: runtimeDependencies, optionalDependencies, browserDependencies, name: _name, owner: _appOwner, appName: _appName, siteName: _siteName, deployVersion: _deployVersion, } = packageInfo !== null && packageInfo !== void 0 ? packageInfo : {};
51
53
  const { name, organization, projectName } = parseProjectName(_name);
52
54
  // The deploy-time pin, when a manifest carries one. `version` stays the manifest's OWN value, so
53
55
  // a caller can tell a real pin from the inert placeholder every workspace package declares.
@@ -56,9 +58,10 @@ export const parsePackageInfo = (packageInfo) => {
56
58
  const siteName = _siteName !== null && _siteName !== void 0 ? _siteName : projectName === null || projectName === void 0 ? void 0 : projectName.slice((projectName === null || projectName === void 0 ? void 0 : projectName.indexOf('-')) + 1);
57
59
  const companyName = organization === null || organization === void 0 ? void 0 : organization.replace('@', '');
58
60
  const appOwner = _appOwner !== null && _appOwner !== void 0 ? _appOwner : companyName;
59
- const packageDetails = Object.assign(Object.assign({}, deployVersion && {
60
- deployVersion,
61
- }), { version,
61
+ const packageDetails = {
62
+ siteDescription,
63
+ siteKeywords,
64
+ version,
62
65
  keywords,
63
66
  appOwner,
64
67
  appName,
@@ -68,11 +71,13 @@ export const parsePackageInfo = (packageInfo) => {
68
71
  siteAuthor,
69
72
  companyName,
70
73
  projectName,
74
+ deployVersion,
71
75
  devDependencies,
72
76
  peerDependencies,
73
77
  bundledDependencies,
74
78
  runtimeDependencies,
75
79
  browserDependencies,
76
- optionalDependencies });
80
+ optionalDependencies,
81
+ };
77
82
  return [packageDetails, organization, name];
78
83
  };
package/dist/project.d.ts CHANGED
@@ -5,6 +5,8 @@ export function parseProjectName(_name: unknown): {
5
5
  projectName: string;
6
6
  };
7
7
  export function parsePackageInfo(packageInfo?: PackageInfo): [{
8
+ siteDescription: string | undefined;
9
+ siteKeywords: string[] | undefined;
8
10
  version: string | undefined;
9
11
  keywords: string[] | undefined;
10
12
  appOwner: string;
@@ -15,19 +17,20 @@ export function parsePackageInfo(packageInfo?: PackageInfo): [{
15
17
  siteAuthor: string | undefined;
16
18
  companyName: string;
17
19
  projectName: string;
20
+ deployVersion: string | undefined;
18
21
  devDependencies: Record<string, string> | undefined;
19
22
  peerDependencies: Record<string, string> | undefined;
20
23
  bundledDependencies: string[] | undefined;
21
24
  runtimeDependencies: Record<string, string> | undefined;
22
25
  browserDependencies: string[] | undefined;
23
26
  optionalDependencies: Record<string, string> | undefined;
24
- deployVersion?: string | undefined;
25
27
  }, string | undefined, string];
26
28
  /**
27
29
  * The subset of a package.json this reads. Everything is optional — callers pass raw
28
30
  * manifests, and the parser is deliberately tolerant of a missing or partial object.
29
31
  */
30
32
  export type PackageInfo = {
33
+ siteDescription?: string | undefined;
31
34
  deployVersion?: string | undefined;
32
35
  apiVersion?: string | undefined;
33
36
  version?: string | undefined;
@@ -39,11 +42,12 @@ export type PackageInfo = {
39
42
  siteHandle?: string | undefined;
40
43
  siteAuthor?: string | undefined;
41
44
  keywords?: string[] | undefined;
45
+ siteKeywords?: string[] | undefined;
46
+ bundleDependencies?: string[] | undefined;
47
+ bundledDependencies?: string[] | undefined;
48
+ browserDependencies?: string[] | undefined;
42
49
  dependencies?: Record<string, string> | undefined;
43
50
  devDependencies?: Record<string, string> | undefined;
44
51
  peerDependencies?: Record<string, string> | undefined;
45
52
  optionalDependencies?: Record<string, string> | undefined;
46
- bundleDependencies?: string[] | undefined;
47
- bundledDependencies?: string[] | undefined;
48
- browserDependencies?: string[] | undefined;
49
53
  };
package/dist/project.js CHANGED
@@ -21,6 +21,7 @@ exports.parseProjectName = parseProjectName;
21
21
  * manifests, and the parser is deliberately tolerant of a missing or partial object.
22
22
  *
23
23
  * @typedef {object} PackageInfo
24
+ * @property {string} [siteDescription]
24
25
  * @property {string} [deployVersion]
25
26
  * @property {string} [apiVersion]
26
27
  * @property {string} [version]
@@ -32,13 +33,14 @@ exports.parseProjectName = parseProjectName;
32
33
  * @property {string} [siteHandle]
33
34
  * @property {string} [siteAuthor]
34
35
  * @property {string[]} [keywords]
36
+ * @property {string[]} [siteKeywords]
37
+ * @property {string[]} [bundleDependencies]
38
+ * @property {string[]} [bundledDependencies]
39
+ * @property {string[]} [browserDependencies]
35
40
  * @property {Record<string, string>} [dependencies]
36
41
  * @property {Record<string, string>} [devDependencies]
37
42
  * @property {Record<string, string>} [peerDependencies]
38
43
  * @property {Record<string, string>} [optionalDependencies]
39
- * @property {string[]} [bundleDependencies]
40
- * @property {string[]} [bundledDependencies]
41
- * @property {string[]} [browserDependencies]
42
44
  */
43
45
  /**
44
46
  * Split a package.json into its resolved details, its organization and its full name.
@@ -51,7 +53,7 @@ exports.parseProjectName = parseProjectName;
51
53
  * @returns {[typeof packageDetails, string | undefined, string]}
52
54
  */
53
55
  const parsePackageInfo = (packageInfo) => {
54
- const { apiVersion, version, keywords, shortName, siteAuthor, siteHandle, devDependencies, peerDependencies, bundleDependencies, bundledDependencies = bundleDependencies, dependencies: runtimeDependencies, optionalDependencies, browserDependencies, name: _name, owner: _appOwner, appName: _appName, siteName: _siteName, deployVersion: _deployVersion, } = packageInfo !== null && packageInfo !== void 0 ? packageInfo : {};
56
+ const { keywords, siteKeywords = keywords, siteDescription, apiVersion, version, shortName, siteAuthor, siteHandle, devDependencies, peerDependencies, bundleDependencies, bundledDependencies = bundleDependencies, dependencies: runtimeDependencies, optionalDependencies, browserDependencies, name: _name, owner: _appOwner, appName: _appName, siteName: _siteName, deployVersion: _deployVersion, } = packageInfo !== null && packageInfo !== void 0 ? packageInfo : {};
55
57
  const { name, organization, projectName } = (0, exports.parseProjectName)(_name);
56
58
  // The deploy-time pin, when a manifest carries one. `version` stays the manifest's OWN value, so
57
59
  // a caller can tell a real pin from the inert placeholder every workspace package declares.
@@ -60,9 +62,10 @@ const parsePackageInfo = (packageInfo) => {
60
62
  const siteName = _siteName !== null && _siteName !== void 0 ? _siteName : projectName === null || projectName === void 0 ? void 0 : projectName.slice((projectName === null || projectName === void 0 ? void 0 : projectName.indexOf('-')) + 1);
61
63
  const companyName = organization === null || organization === void 0 ? void 0 : organization.replace('@', '');
62
64
  const appOwner = _appOwner !== null && _appOwner !== void 0 ? _appOwner : companyName;
63
- const packageDetails = Object.assign(Object.assign({}, deployVersion && {
64
- deployVersion,
65
- }), { version,
65
+ const packageDetails = {
66
+ siteDescription,
67
+ siteKeywords,
68
+ version,
66
69
  keywords,
67
70
  appOwner,
68
71
  appName,
@@ -72,12 +75,14 @@ const parsePackageInfo = (packageInfo) => {
72
75
  siteAuthor,
73
76
  companyName,
74
77
  projectName,
78
+ deployVersion,
75
79
  devDependencies,
76
80
  peerDependencies,
77
81
  bundledDependencies,
78
82
  runtimeDependencies,
79
83
  browserDependencies,
80
- optionalDependencies });
84
+ optionalDependencies,
85
+ };
81
86
  return [packageDetails, organization, name];
82
87
  };
83
88
  exports.parsePackageInfo = parsePackageInfo;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agnostack/env",
3
- "version": "2.0.0-canary.11",
3
+ "version": "2.0.0-canary.12",
4
4
  "author": "agnoStack Dev <developers@agnostack.com> (https://agnostack.com)",
5
5
  "owner": "agnoStack",
6
6
  "description": "Please contact agnoStack via info@agnostack.com for any questions",