@mapples/types 1.2.0 → 1.3.0
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.
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/packages.d.ts +41 -0
- package/dist/packages.d.ts.map +1 -0
- package/dist/packages.js +21 -0
- package/dist/packages.js.map +1 -0
- package/dist/packagesValidator.d.ts +27 -0
- package/dist/packagesValidator.d.ts.map +1 -0
- package/dist/packagesValidator.js +82 -0
- package/dist/packagesValidator.js.map +1 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,OAAO,CAAC;AACtB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,OAAO,CAAC;AACtB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC"}
|
package/dist/index.js
CHANGED
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,OAAO,CAAC;AACtB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,uBAAuB,CAAC;AACtC,cAAc,OAAO,CAAC;AACtB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview The project packages document: which optional runtime
|
|
3
|
+
* packages a project ships with.
|
|
4
|
+
*
|
|
5
|
+
* Persisted as one opaque row per project (mirroring the variables document).
|
|
6
|
+
* Two fields, two owners:
|
|
7
|
+
*
|
|
8
|
+
* - `enabled` is user intent — optional packages the user switched on in the
|
|
9
|
+
* Creator's Project settings → Packages beyond what the canvas already uses.
|
|
10
|
+
* - `resolved` is the effective install list. The Creator recomputes it
|
|
11
|
+
* (required baseline ∪ packages used by canvas elements ∪ `enabled`) on every
|
|
12
|
+
* toggle and after every successful push, and the `mapples` CLI reads it
|
|
13
|
+
* verbatim to add/remove dependencies and Expo config plugins.
|
|
14
|
+
*/
|
|
15
|
+
/** Why a package is part of the effective install list. */
|
|
16
|
+
export type PackageReason = 'required' | 'used' | 'enabled';
|
|
17
|
+
export interface PackageDependencyEntry {
|
|
18
|
+
/** npm package name to install. */
|
|
19
|
+
name: string;
|
|
20
|
+
/** Semver range to install. */
|
|
21
|
+
version: string;
|
|
22
|
+
}
|
|
23
|
+
export interface ResolvedPackageEntry {
|
|
24
|
+
/** Catalog id, e.g. `qrcode` or `icon-pack:feather`. */
|
|
25
|
+
id: string;
|
|
26
|
+
reason: PackageReason;
|
|
27
|
+
/** npm dependencies to install for this package. */
|
|
28
|
+
dependencies: PackageDependencyEntry[];
|
|
29
|
+
/** Expo config plugins to register in `app.json`, when the package has any. */
|
|
30
|
+
expoPlugins?: string[];
|
|
31
|
+
}
|
|
32
|
+
export interface PackagesDocument {
|
|
33
|
+
version: 1;
|
|
34
|
+
/** Catalog ids the user enabled by hand (Creator-owned). */
|
|
35
|
+
enabled: string[];
|
|
36
|
+
/** Effective install list, written by the Creator, read by the CLI. */
|
|
37
|
+
resolved: ResolvedPackageEntry[];
|
|
38
|
+
}
|
|
39
|
+
/** An empty document, used before a project has saved any package choice. */
|
|
40
|
+
export declare const emptyPackagesDocument: () => PackagesDocument;
|
|
41
|
+
//# sourceMappingURL=packages.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"packages.d.ts","sourceRoot":"","sources":["../src/packages.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;AAE5D,MAAM,WAAW,sBAAsB;IACrC,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC,wDAAwD;IACxD,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,oDAAoD;IACpD,YAAY,EAAE,sBAAsB,EAAE,CAAC;IACvC,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,CAAC,CAAC;IACX,4DAA4D;IAC5D,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,uEAAuE;IACvE,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CAClC;AAED,6EAA6E;AAC7E,eAAO,MAAM,qBAAqB,QAAO,gBAIvC,CAAC"}
|
package/dist/packages.js
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @fileoverview The project packages document: which optional runtime
|
|
3
|
+
* packages a project ships with.
|
|
4
|
+
*
|
|
5
|
+
* Persisted as one opaque row per project (mirroring the variables document).
|
|
6
|
+
* Two fields, two owners:
|
|
7
|
+
*
|
|
8
|
+
* - `enabled` is user intent — optional packages the user switched on in the
|
|
9
|
+
* Creator's Project settings → Packages beyond what the canvas already uses.
|
|
10
|
+
* - `resolved` is the effective install list. The Creator recomputes it
|
|
11
|
+
* (required baseline ∪ packages used by canvas elements ∪ `enabled`) on every
|
|
12
|
+
* toggle and after every successful push, and the `mapples` CLI reads it
|
|
13
|
+
* verbatim to add/remove dependencies and Expo config plugins.
|
|
14
|
+
*/
|
|
15
|
+
/** An empty document, used before a project has saved any package choice. */
|
|
16
|
+
export const emptyPackagesDocument = () => ({
|
|
17
|
+
version: 1,
|
|
18
|
+
enabled: [],
|
|
19
|
+
resolved: [],
|
|
20
|
+
});
|
|
21
|
+
//# sourceMappingURL=packages.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"packages.js","sourceRoot":"","sources":["../src/packages.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AA8BH,6EAA6E;AAC7E,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAqB,EAAE,CAAC,CAAC;IAC5D,OAAO,EAAE,CAAC;IACV,OAAO,EAAE,EAAE;IACX,QAAQ,EAAE,EAAE;CACb,CAAC,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { PackagesDocument } from './packages';
|
|
2
|
+
/**
|
|
3
|
+
* Codes for the invariants enforced by {@link validatePackagesDocument}.
|
|
4
|
+
*
|
|
5
|
+
* - `VERSION_UNSUPPORTED` — `version` is not `1`.
|
|
6
|
+
* - `ENABLED_INVALID` — an `enabled` entry is not a non-empty string.
|
|
7
|
+
* - `ENABLED_DUPLICATE` — an id appears in `enabled` more than once.
|
|
8
|
+
* - `RESOLVED_INVALID` — a `resolved` entry is missing `id`, carries an
|
|
9
|
+
* unknown `reason`, or has a malformed `dependencies` list.
|
|
10
|
+
* - `RESOLVED_DUPLICATE` — an id appears in `resolved` more than once.
|
|
11
|
+
*/
|
|
12
|
+
export type PackagesValidationCode = 'VERSION_UNSUPPORTED' | 'ENABLED_INVALID' | 'ENABLED_DUPLICATE' | 'RESOLVED_INVALID' | 'RESOLVED_DUPLICATE';
|
|
13
|
+
export interface PackagesValidationError {
|
|
14
|
+
code: PackagesValidationCode;
|
|
15
|
+
message: string;
|
|
16
|
+
packageId?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface PackagesValidationResult {
|
|
19
|
+
valid: boolean;
|
|
20
|
+
errors: PackagesValidationError[];
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Validate the structural invariants of a {@link PackagesDocument}. Collects
|
|
24
|
+
* every violation (same shape as `validateVariablesDocument`).
|
|
25
|
+
*/
|
|
26
|
+
export declare const validatePackagesDocument: (document: PackagesDocument) => PackagesValidationResult;
|
|
27
|
+
//# sourceMappingURL=packagesValidator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"packagesValidator.d.ts","sourceRoot":"","sources":["../src/packagesValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE7D;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,GAC9B,qBAAqB,GACrB,iBAAiB,GACjB,mBAAmB,GACnB,kBAAkB,GAClB,oBAAoB,CAAC;AAEzB,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,uBAAuB,EAAE,CAAC;CACnC;AAgBD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,gBAAgB,KACzB,wBA6EF,CAAC"}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
const REASONS = ['required', 'used', 'enabled'];
|
|
2
|
+
const isNonEmptyString = (value) => typeof value === 'string' && value.length > 0;
|
|
3
|
+
const isDependencyList = (value) => Array.isArray(value) &&
|
|
4
|
+
value.every((dependency) => dependency &&
|
|
5
|
+
isNonEmptyString(dependency.name) &&
|
|
6
|
+
isNonEmptyString(dependency.version));
|
|
7
|
+
/**
|
|
8
|
+
* Validate the structural invariants of a {@link PackagesDocument}. Collects
|
|
9
|
+
* every violation (same shape as `validateVariablesDocument`).
|
|
10
|
+
*/
|
|
11
|
+
export const validatePackagesDocument = (document) => {
|
|
12
|
+
const errors = [];
|
|
13
|
+
if (document.version !== 1) {
|
|
14
|
+
errors.push({
|
|
15
|
+
code: 'VERSION_UNSUPPORTED',
|
|
16
|
+
message: `Packages document version ${String(document.version)} is not supported`,
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
const enabledSeen = new Set();
|
|
20
|
+
for (const id of Array.isArray(document.enabled) ? document.enabled : []) {
|
|
21
|
+
if (!isNonEmptyString(id)) {
|
|
22
|
+
errors.push({
|
|
23
|
+
code: 'ENABLED_INVALID',
|
|
24
|
+
message: 'Enabled package ids must be non-empty strings',
|
|
25
|
+
});
|
|
26
|
+
continue;
|
|
27
|
+
}
|
|
28
|
+
if (enabledSeen.has(id)) {
|
|
29
|
+
errors.push({
|
|
30
|
+
code: 'ENABLED_DUPLICATE',
|
|
31
|
+
message: `Package "${id}" is enabled more than once`,
|
|
32
|
+
packageId: id,
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
else {
|
|
36
|
+
enabledSeen.add(id);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
if (!Array.isArray(document.enabled)) {
|
|
40
|
+
errors.push({
|
|
41
|
+
code: 'ENABLED_INVALID',
|
|
42
|
+
message: '`enabled` must be an array of package ids',
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
const resolvedSeen = new Set();
|
|
46
|
+
for (const entry of Array.isArray(document.resolved)
|
|
47
|
+
? document.resolved
|
|
48
|
+
: []) {
|
|
49
|
+
if (!entry ||
|
|
50
|
+
!isNonEmptyString(entry.id) ||
|
|
51
|
+
!REASONS.includes(entry.reason) ||
|
|
52
|
+
!isDependencyList(entry.dependencies) ||
|
|
53
|
+
(entry.expoPlugins !== undefined &&
|
|
54
|
+
!(Array.isArray(entry.expoPlugins) &&
|
|
55
|
+
entry.expoPlugins.every(isNonEmptyString)))) {
|
|
56
|
+
errors.push({
|
|
57
|
+
code: 'RESOLVED_INVALID',
|
|
58
|
+
message: 'Resolved entries need `id`, a known `reason` and a `dependencies` list of { name, version }',
|
|
59
|
+
packageId: entry?.id,
|
|
60
|
+
});
|
|
61
|
+
continue;
|
|
62
|
+
}
|
|
63
|
+
if (resolvedSeen.has(entry.id)) {
|
|
64
|
+
errors.push({
|
|
65
|
+
code: 'RESOLVED_DUPLICATE',
|
|
66
|
+
message: `Package "${entry.id}" is resolved more than once`,
|
|
67
|
+
packageId: entry.id,
|
|
68
|
+
});
|
|
69
|
+
}
|
|
70
|
+
else {
|
|
71
|
+
resolvedSeen.add(entry.id);
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
if (!Array.isArray(document.resolved)) {
|
|
75
|
+
errors.push({
|
|
76
|
+
code: 'RESOLVED_INVALID',
|
|
77
|
+
message: '`resolved` must be an array of resolved package entries',
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
return { valid: errors.length === 0, errors };
|
|
81
|
+
};
|
|
82
|
+
//# sourceMappingURL=packagesValidator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"packagesValidator.js","sourceRoot":"","sources":["../src/packagesValidator.ts"],"names":[],"mappings":"AA8BA,MAAM,OAAO,GAA6B,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAE1E,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAmB,EAAE,CAC3D,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAEhD,MAAM,gBAAgB,GAAG,CAAC,KAAc,EAAW,EAAE,CACnD,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;IACpB,KAAK,CAAC,KAAK,CACT,CAAC,UAAU,EAAE,EAAE,CACb,UAAU;QACV,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC;QACjC,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,CACvC,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,QAA0B,EACA,EAAE;IAC5B,MAAM,MAAM,GAA8B,EAAE,CAAC;IAE7C,IAAI,QAAQ,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,qBAAqB;YAC3B,OAAO,EAAE,6BAA6B,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,mBAAmB;SAClF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;IACtC,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACzE,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,+CAA+C;aACzD,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,YAAY,EAAE,6BAA6B;gBACpD,SAAS,EAAE,EAAE;aACd,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,iBAAiB;YACvB,OAAO,EAAE,2CAA2C;SACrD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAC;IACvC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAClD,CAAC,CAAC,QAAQ,CAAC,QAAQ;QACnB,CAAC,CAAC,EAAE,EAAE,CAAC;QACP,IACE,CAAC,KAAK;YACN,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;YAC/B,CAAC,gBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC;YACrC,CAAC,KAAK,CAAC,WAAW,KAAK,SAAS;gBAC9B,CAAC,CACC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC;oBAChC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAC1C,CAAC,EACJ,CAAC;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EACL,6FAA6F;gBAC/F,SAAS,EAAE,KAAK,EAAE,EAAE;aACrB,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,oBAAoB;gBAC1B,OAAO,EAAE,YAAY,KAAK,CAAC,EAAE,8BAA8B;gBAC3D,SAAS,EAAE,KAAK,CAAC,EAAE;aACpB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACtC,MAAM,CAAC,IAAI,CAAC;YACV,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,yDAAyD;SACnE,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;AAChD,CAAC,CAAC"}
|