@cratis/scene.model 4.3.0 → 4.4.0

package/dist/esm/icons/iconReferences.js

@@ -0,0 +1,56 @@
+// Copyright (c) Cratis. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+/**
+ * The character that separates the parts of an icon reference's text form. A reference's parts therefore
+ * cannot contain it - an npm package name, an icon key and a variant name never do.
+ */ const separator = '#';
+function isPart(value) {
+    return typeof value === 'string' && value.length > 0 && !value.includes(separator);
+}
+/**
+ * Whether a value is a well-formed {@link IconReference}: a library and a key that are non-empty, an
+ * optional non-empty variant, none of them containing the text-form separator. Extra properties are
+ * tolerated, because a reference read from a persisted document may carry editor-added metadata.
+ */ function isIconReference(value) {
+    if (typeof value !== 'object' || value === null) return false;
+    const candidate = value;
+    return isPart(candidate.library) && isPart(candidate.key) && (candidate.variant === undefined || isPart(candidate.variant));
+}
+/**
+ * Whether two references name the same icon. Equality is all three fields - library, key and variant -
+ * and nothing else; an absent variant equals only another absent variant.
+ */ function iconReferencesEqual(left, right) {
+    return left.library === right.library && left.key === right.key && (left.variant ?? undefined) === (right.variant ?? undefined);
+}
+/**
+ * The canonical single-string form of a reference, for keys, logs and diagnostics:
+ * `library#key`, or `library#key#variant`. Two references are equal exactly when their text forms are equal.
+ * It is a convenience for people and tools, not the persisted shape - persist the {@link IconReference}.
+ *
+ * @throws Error when a part is empty or contains `#`.
+ */ function formatIconReference(reference) {
+    if (!isIconReference(reference)) {
+        throw new Error(`'${JSON.stringify(reference)}' is not a valid icon reference: library and key are required, and no part may be empty or contain '${separator}'`);
+    }
+    return reference.variant === undefined ? `${reference.library}${separator}${reference.key}` : `${reference.library}${separator}${reference.key}${separator}${reference.variant}`;
+}
+/**
+ * Reads the text form produced by {@link formatIconReference}. Returns `undefined` for anything that is
+ * not one - including a bare legacy icon name such as `pi pi-home`, which has no library and so cannot be
+ * made into a reference without choosing one.
+ */ function parseIconReference(text) {
+    const parts = text.split(separator);
+    if (parts.length < 2 || parts.length > 3 || !parts.every(isPart)) return undefined;
+    const [library, key, variant] = parts;
+    return variant === undefined ? {
+        library,
+        key
+    } : {
+        library,
+        key,
+        variant
+    };
+}
+
+export { formatIconReference, iconReferencesEqual, isIconReference, parseIconReference };
+//# sourceMappingURL=iconReferences.js.map

package/dist/esm/icons/iconReferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iconReferences.js","sources":["../../../icons/iconReferences.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { IconReference } from './IconReference';\n\n/**\n * The character that separates the parts of an icon reference's text form. A reference's parts therefore\n * cannot contain it - an npm package name, an icon key and a variant name never do.\n */\nconst separator = '#';\n\nfunction isPart(value: unknown): value is string {\n    return typeof value === 'string' && value.length > 0 && !value.includes(separator);\n}\n\n/**\n * Whether a value is a well-formed {@link IconReference}: a library and a key that are non-empty, an\n * optional non-empty variant, none of them containing the text-form separator. Extra properties are\n * tolerated, because a reference read from a persisted document may carry editor-added metadata.\n */\nexport function isIconReference(value: unknown): value is IconReference {\n    if (typeof value !== 'object' || value === null) return false;\n    const candidate = value as Record<string, unknown>;\n    return isPart(candidate.library) && isPart(candidate.key) && (candidate.variant === undefined || isPart(candidate.variant));\n}\n\n/**\n * Whether two references name the same icon. Equality is all three fields - library, key and variant -\n * and nothing else; an absent variant equals only another absent variant.\n */\nexport function iconReferencesEqual(left: IconReference, right: IconReference): boolean {\n    return left.library === right.library && left.key === right.key && (left.variant ?? undefined) === (right.variant ?? undefined);\n}\n\n/**\n * The canonical single-string form of a reference, for keys, logs and diagnostics:\n * `library#key`, or `library#key#variant`. Two references are equal exactly when their text forms are equal.\n * It is a convenience for people and tools, not the persisted shape - persist the {@link IconReference}.\n *\n * @throws Error when a part is empty or contains `#`.\n */\nexport function formatIconReference(reference: IconReference): string {\n    if (!isIconReference(reference)) {\n        throw new Error(`'${JSON.stringify(reference)}' is not a valid icon reference: library and key are required, and no part may be empty or contain '${separator}'`);\n    }\n\n    return reference.variant === undefined\n        ? `${reference.library}${separator}${reference.key}`\n        : `${reference.library}${separator}${reference.key}${separator}${reference.variant}`;\n}\n\n/**\n * Reads the text form produced by {@link formatIconReference}. Returns `undefined` for anything that is\n * not one - including a bare legacy icon name such as `pi pi-home`, which has no library and so cannot be\n * made into a reference without choosing one.\n */\nexport function parseIconReference(text: string): IconReference | undefined {\n    const parts = text.split(separator);\n    if (parts.length < 2 || parts.length > 3 || !parts.every(isPart)) return undefined;\n    const [library, key, variant] = parts;\n    return variant === undefined ? { library, key } : { library, key, variant };\n}\n"],"names":["separator","isPart","value","length","includes","isIconReference","candidate","library","key","variant","undefined","iconReferencesEqual","left","right","formatIconReference","reference","Error","JSON","stringify","parseIconReference","text","parts","split","every"],"mappings":"AAAA;AACA;AAIA;;;AAGC,IACD,MAAMA,SAAAA,GAAY,GAAA;AAElB,SAASC,OAAOC,KAAc,EAAA;IAC1B,OAAO,OAAOA,KAAAA,KAAU,QAAA,IAAYA,KAAAA,CAAMC,MAAM,GAAG,CAAA,IAAK,CAACD,KAAAA,CAAME,QAAQ,CAACJ,SAAAA,CAAAA;AAC5E;AAEA;;;;IAKO,SAASK,eAAAA,CAAgBH,KAAc,EAAA;AAC1C,IAAA,IAAI,OAAOA,KAAAA,KAAU,QAAA,IAAYA,KAAAA,KAAU,MAAM,OAAO,KAAA;AACxD,IAAA,MAAMI,SAAAA,GAAYJ,KAAAA;AAClB,IAAA,OAAOD,OAAOK,SAAAA,CAAUC,OAAO,CAAA,IAAKN,MAAAA,CAAOK,UAAUE,GAAG,CAAA,KAAMF,SAAAA,CAAUG,OAAO,KAAKC,SAAAA,IAAaT,MAAAA,CAAOK,SAAAA,CAAUG,OAAO,CAAA,CAAA;AAC7H;AAEA;;;AAGC,IACM,SAASE,mBAAAA,CAAoBC,IAAmB,EAAEC,KAAoB,EAAA;IACzE,OAAOD,IAAAA,CAAKL,OAAO,KAAKM,KAAAA,CAAMN,OAAO,IAAIK,IAAAA,CAAKJ,GAAG,KAAKK,KAAAA,CAAML,GAAG,IAAI,CAACI,IAAAA,CAAKH,OAAO,IAAIC,SAAQ,OAAQG,KAAAA,CAAMJ,OAAO,IAAIC,SAAQ,CAAA;AACjI;AAEA;;;;;;IAOO,SAASI,mBAAAA,CAAoBC,SAAwB,EAAA;IACxD,IAAI,CAACV,gBAAgBU,SAAAA,CAAAA,EAAY;AAC7B,QAAA,MAAM,IAAIC,KAAAA,CAAM,CAAC,CAAC,EAAEC,IAAAA,CAAKC,SAAS,CAACH,SAAAA,CAAAA,CAAW,oGAAoG,EAAEf,SAAAA,CAAU,CAAC,CAAC,CAAA;AACpK,IAAA;IAEA,OAAOe,SAAAA,CAAUN,OAAO,KAAKC,SAAAA,GACvB,CAAA,EAAGK,UAAUR,OAAO,CAAA,EAAGP,SAAAA,CAAAA,EAAYe,SAAAA,CAAUP,GAAG,CAAA,CAAE,GAClD,CAAA,EAAGO,SAAAA,CAAUR,OAAO,CAAA,EAAGP,SAAAA,CAAAA,EAAYe,SAAAA,CAAUP,GAAG,CAAA,EAAGR,SAAAA,CAAAA,EAAYe,SAAAA,CAAUN,OAAO,CAAA,CAAE;AAC5F;AAEA;;;;IAKO,SAASU,kBAAAA,CAAmBC,IAAY,EAAA;IAC3C,MAAMC,KAAAA,GAAQD,IAAAA,CAAKE,KAAK,CAACtB,SAAAA,CAAAA;AACzB,IAAA,IAAIqB,KAAAA,CAAMlB,MAAM,GAAG,CAAA,IAAKkB,KAAAA,CAAMlB,MAAM,GAAG,CAAA,IAAK,CAACkB,KAAAA,CAAME,KAAK,CAACtB,SAAS,OAAOS,SAAAA;AACzE,IAAA,MAAM,CAACH,OAAAA,EAASC,GAAAA,EAAKC,OAAAA,CAAQ,GAAGY,KAAAA;AAChC,IAAA,OAAOZ,YAAYC,SAAAA,GAAY;AAAEH,QAAAA,OAAAA;AAASC,QAAAA;KAAI,GAAI;AAAED,QAAAA,OAAAA;AAASC,QAAAA,GAAAA;AAAKC,QAAAA;AAAQ,KAAA;AAC9E;;"}

package/dist/esm/icons/index.d.ts

@@ -0,0 +1,5 @@
+export * from './IconReference';
+export * from './iconReferences';
+export * from './IconLibrary';
+export * from './IconEntry';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/icons/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../icons/index.ts"],"names":[],"mappings":"AAGA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}

package/dist/esm/icons/index.js

@@ -0,0 +1,5 @@
+export * from './IconReference';
+export * from './iconReferences';
+export * from './IconLibrary';
+export * from './IconEntry';
+//# sourceMappingURL=index.js.map

package/dist/esm/icons/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../icons/index.ts"],"names":[],"mappings":"AAGA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}

package/dist/esm/index.d.ts

@@ -5,6 +5,7 @@ export * from './layouts';
 export * from './forms';
 export * from './contributionPoints';
 export * from './profiles';
+export * from './icons';
 export * from './packages';
 export * from './interactions';
 export * from './screens';

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAGA,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAGA,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/esm/index.js

@@ -9,7 +9,6 @@ export { Orientation } from './common/Orientation.js';
 export { Dock } from './common/Dock.js';
 export { GridUnitType } from './common/GridUnitType.js';
 export { GridLengthPropertyNames } from './common/GridLength.js';
-export { IconReferencePropertyNames } from './common/IconReference.js';
 export { DestinationReferencePropertyNames } from './common/DestinationReference.js';
 export { WidthSizeClass } from './sizeClasses/WidthSizeClass.js';
 export { HeightSizeClass } from './sizeClasses/HeightSizeClass.js';
@@ -57,6 +56,10 @@ export { ContributionPropertyNames } from './contributionPoints/Contribution.js'
 export { NavigationItemPropertyNames } from './contributionPoints/NavigationItem.js';
 export { UiProfilePropertyNames } from './profiles/UiProfile.js';
 export { ThemePropertyNames } from './profiles/Theme.js';
+export { IconReferencePropertyNames } from './icons/IconReference.js';
+export { formatIconReference, iconReferencesEqual, isIconReference, parseIconReference } from './icons/iconReferences.js';
+export { IconLibraryPropertyNames } from './icons/IconLibrary.js';
+export { IconEntryPropertyNames } from './icons/IconEntry.js';
 export { PackageKind } from './packages/PackageKind.js';
 export { PackageDependencyPropertyNames } from './packages/PackageDependency.js';
 export { ScenePackagePropertyNames } from './packages/ScenePackage.js';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/packages/PackageKind.d.ts

@@ -1,6 +1,7 @@
 export declare enum PackageKind {
     ComponentLibrary = "ComponentLibrary",
     Styling = "Styling",
-    Blueprint = "Blueprint"
+    Blueprint = "Blueprint",
+    IconLibrary = "IconLibrary"
 }
 //# sourceMappingURL=PackageKind.d.ts.map

package/dist/esm/packages/PackageKind.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PackageKind.d.ts","sourceRoot":"","sources":["../../../packages/PackageKind.ts"],"names":[],"mappings":"AAQA,oBAAY,WAAW;IAMnB,gBAAgB,qBAAqB;IAOrC,OAAO,YAAY;IAYnB,SAAS,cAAc;CAC1B"}
+{"version":3,"file":"PackageKind.d.ts","sourceRoot":"","sources":["../../../packages/PackageKind.ts"],"names":[],"mappings":"AAQA,oBAAY,WAAW;IAMnB,gBAAgB,qBAAqB;IAOrC,OAAO,YAAY;IAYnB,SAAS,cAAc;IAavB,WAAW,gBAAgB;CAC9B"}

package/dist/esm/packages/PackageKind.js

@@ -2,7 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 /**
  * What a {@link ScenePackage} contributes to a {@link UiProfile}. A profile's package list mixes all
- * three kinds freely - the kind says what a package is for, never where it sits in the override-priority
+ * four kinds freely - the kind says what a package is for, never where it sits in the override-priority
  * order.
  */ var PackageKind = /*#__PURE__*/ function(PackageKind) {
     /**
@@ -25,6 +25,17 @@
      * against PrimeReact and Cratis Components, and says so. That is what makes "which blueprints can I
      * use" answerable from the packages a profile already has.
      */ PackageKind["Blueprint"] = "Blueprint";
+    /**
+     * Provides icons - a named, versioned library of them, such as Lucide or PrimeIcons - that screens,
+     * templates and blueprints refer to by {@link IconReference} rather than by CSS class or markup.
+     * A library declares its variants, renderer adapters and attribution through
+     * {@link ScenePackage.iconLibrary}; its icon catalog is loaded on demand, never listed in the package.
+     *
+     * It is a package kind rather than a contribution on another kind because everything an author asks
+     * of a library - select it in a profile, see its license and version, have it pulled in by the
+     * components that need it - is already what a package is. Several libraries coexist in one profile,
+     * and the library is part of every icon's identity, so same-named icons never shadow one another.
+     */ PackageKind["IconLibrary"] = "IconLibrary";
     return PackageKind;
 }({});
 

package/dist/esm/packages/PackageKind.js.map

@@ -1 +1 @@
-{"version":3,"file":"PackageKind.js","sources":["../../../packages/PackageKind.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\n/**\n * What a {@link ScenePackage} contributes to a {@link UiProfile}. A profile's package list mixes all\n * three kinds freely - the kind says what a package is for, never where it sits in the override-priority\n * order.\n */\nexport enum PackageKind {\n    /**\n     * Declares component names a screen can resolve against. A package with no dependency on another\n     * `ComponentLibrary` is a base library (PrimeReact, `core`); one that depends on another layers on\n     * top of it.\n     */\n    ComponentLibrary = 'ComponentLibrary',\n\n    /**\n     * Contributes styling rather than components - a utility CSS system such as Tailwind. A styling\n     * package usually declares no components at all; component libraries depend on it to say \"my\n     * components are written against this styling system\".\n     */\n    Styling = 'Styling',\n\n    /**\n     * Provides the shape of an application: its {@link Layout}s, the {@link ScreenTemplate}s and\n     * {@link DialogTemplate}s built on them, and the components that fill their slots. An application\n     * selects one blueprint, and gets a coherent set rather than assembling layouts and templates from\n     * unrelated sources.\n     *\n     * A blueprint depends on the component libraries it is built from — the default blueprint is written\n     * against PrimeReact and Cratis Components, and says so. That is what makes \"which blueprints can I\n     * use\" answerable from the packages a profile already has.\n     */\n    Blueprint = 'Blueprint',\n}\n"],"names":["PackageKind"],"mappings":"AAAA;AACA;AAEA;;;;IAKO,IAAKA,WAAAA,iBAAAA,SAAAA,WAAAA,EAAAA;AACR;;;;AAIC,QAAA,WAAA,CAAA,kBAAA,CAAA,GAAA,kBAAA;AAGD;;;;AAIC,QAAA,WAAA,CAAA,SAAA,CAAA,GAAA,SAAA;AAGD;;;;;;;;;AASC,QAAA,WAAA,CAAA,WAAA,CAAA,GAAA,WAAA;AAxBOA,IAAAA,OAAAA,WAAAA;AA0BX,CAAA,CAAA,EAAA;;"}
+{"version":3,"file":"PackageKind.js","sources":["../../../packages/PackageKind.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\n/**\n * What a {@link ScenePackage} contributes to a {@link UiProfile}. A profile's package list mixes all\n * four kinds freely - the kind says what a package is for, never where it sits in the override-priority\n * order.\n */\nexport enum PackageKind {\n    /**\n     * Declares component names a screen can resolve against. A package with no dependency on another\n     * `ComponentLibrary` is a base library (PrimeReact, `core`); one that depends on another layers on\n     * top of it.\n     */\n    ComponentLibrary = 'ComponentLibrary',\n\n    /**\n     * Contributes styling rather than components - a utility CSS system such as Tailwind. A styling\n     * package usually declares no components at all; component libraries depend on it to say \"my\n     * components are written against this styling system\".\n     */\n    Styling = 'Styling',\n\n    /**\n     * Provides the shape of an application: its {@link Layout}s, the {@link ScreenTemplate}s and\n     * {@link DialogTemplate}s built on them, and the components that fill their slots. An application\n     * selects one blueprint, and gets a coherent set rather than assembling layouts and templates from\n     * unrelated sources.\n     *\n     * A blueprint depends on the component libraries it is built from — the default blueprint is written\n     * against PrimeReact and Cratis Components, and says so. That is what makes \"which blueprints can I\n     * use\" answerable from the packages a profile already has.\n     */\n    Blueprint = 'Blueprint',\n\n    /**\n     * Provides icons - a named, versioned library of them, such as Lucide or PrimeIcons - that screens,\n     * templates and blueprints refer to by {@link IconReference} rather than by CSS class or markup.\n     * A library declares its variants, renderer adapters and attribution through\n     * {@link ScenePackage.iconLibrary}; its icon catalog is loaded on demand, never listed in the package.\n     *\n     * It is a package kind rather than a contribution on another kind because everything an author asks\n     * of a library - select it in a profile, see its license and version, have it pulled in by the\n     * components that need it - is already what a package is. Several libraries coexist in one profile,\n     * and the library is part of every icon's identity, so same-named icons never shadow one another.\n     */\n    IconLibrary = 'IconLibrary',\n}\n"],"names":["PackageKind"],"mappings":"AAAA;AACA;AAEA;;;;IAKO,IAAKA,WAAAA,iBAAAA,SAAAA,WAAAA,EAAAA;AACR;;;;AAIC,QAAA,WAAA,CAAA,kBAAA,CAAA,GAAA,kBAAA;AAGD;;;;AAIC,QAAA,WAAA,CAAA,SAAA,CAAA,GAAA,SAAA;AAGD;;;;;;;;;AASC,QAAA,WAAA,CAAA,WAAA,CAAA,GAAA,WAAA;AAGD;;;;;;;;;;AAUC,QAAA,WAAA,CAAA,aAAA,CAAA,GAAA,aAAA;AArCOA,IAAAA,OAAAA,WAAAA;AAuCX,CAAA,CAAA,EAAA;;"}

package/dist/esm/packages/ScenePackage.d.ts

@@ -1,3 +1,4 @@
+import { IconLibrary } from '../icons';
 import { PackageDependency } from './PackageDependency';
 import { PackageKind } from './PackageKind';
 export interface ScenePackage {
@@ -15,6 +16,7 @@ export interface ScenePackage {
     module?: string;
     license?: string;
     licenseUrl?: string;
+    iconLibrary?: IconLibrary;
 }
 export declare const ScenePackagePropertyNames: (keyof ScenePackage)[];
 //# sourceMappingURL=ScenePackage.d.ts.map

package/dist/esm/packages/ScenePackage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ScenePackage.d.ts","sourceRoot":"","sources":["../../../packages/ScenePackage.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAO5C,MAAM,WAAW,YAAY;IAIzB,IAAI,EAAE,MAAM,CAAC;IAKb,OAAO,EAAE,MAAM,CAAC;IAKhB,IAAI,EAAE,WAAW,CAAC;IAKlB,YAAY,EAAE,iBAAiB,EAAE,CAAC;IAKlC,UAAU,EAAE,MAAM,EAAE,CAAC;IAMrB,OAAO,EAAE,MAAM,EAAE,CAAC;IAMlB,eAAe,EAAE,MAAM,EAAE,CAAC;IAK1B,eAAe,EAAE,MAAM,EAAE,CAAC;IAK1B,MAAM,EAAE,MAAM,EAAE,CAAC;IAKjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAOhB,OAAO,CAAC,EAAE,MAAM,CAAC;IAOjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,yBAAyB,EAAE,CAAC,MAAM,YAAY,CAAC,EAe3D,CAAC"}
+{"version":3,"file":"ScenePackage.d.ts","sourceRoot":"","sources":["../../../packages/ScenePackage.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAO5C,MAAM,WAAW,YAAY;IAIzB,IAAI,EAAE,MAAM,CAAC;IAKb,OAAO,EAAE,MAAM,CAAC;IAKhB,IAAI,EAAE,WAAW,CAAC;IAKlB,YAAY,EAAE,iBAAiB,EAAE,CAAC;IAKlC,UAAU,EAAE,MAAM,EAAE,CAAC;IAMrB,OAAO,EAAE,MAAM,EAAE,CAAC;IAMlB,eAAe,EAAE,MAAM,EAAE,CAAC;IAK1B,eAAe,EAAE,MAAM,EAAE,CAAC;IAK1B,MAAM,EAAE,MAAM,EAAE,CAAC;IAKjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAKrB,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAOhB,OAAO,CAAC,EAAE,MAAM,CAAC;IAOjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAKpB,WAAW,CAAC,EAAE,WAAW,CAAC;CAC7B;AAED,eAAO,MAAM,yBAAyB,EAAE,CAAC,MAAM,YAAY,CAAC,EAgB3D,CAAC"}

package/dist/esm/packages/ScenePackage.js

@@ -14,7 +14,8 @@ const ScenePackagePropertyNames = [
     'description',
     'module',
     'license',
-    'licenseUrl'
+    'licenseUrl',
+    'iconLibrary'
 ];
 
 export { ScenePackagePropertyNames };

package/dist/esm/packages/ScenePackage.js.map

@@ -1 +1 @@
-{"version":3,"file":"ScenePackage.js","sources":["../../../packages/ScenePackage.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { PackageDependency } from './PackageDependency';\nimport { PackageKind } from './PackageKind';\n\n/**\n * What a {@link UiProfile}'s `packages` entry actually names. A profile lists packages by name only;\n * this is the declaration behind the name - what it contributes, and what else has to be active for it\n * to work.\n */\nexport interface ScenePackage {\n    /**\n     * The name a {@link UiProfile} lists, and the name a {@link PackageDependency} refers to.\n     */\n    name: string;\n\n    /**\n     * The package's own version, so a {@link PackageDependency.versionRange} has something to check against.\n     */\n    version: string;\n\n    /**\n     * What the package contributes.\n     */\n    kind: PackageKind;\n\n    /**\n     * Other packages that must be active in the same profile for this one to work.\n     */\n    dependencies: PackageDependency[];\n\n    /**\n     * The component names this package declares - the catalog entry {@link UiProfile} resolution walks.\n     */\n    components: string[];\n\n    /**\n     * The names of the {@link Layout}s this package provides — an application's base navigational shells.\n     * Empty for anything that is not a {@link PackageKind.Blueprint}.\n     */\n    layouts: string[];\n\n    /**\n     * The names of the {@link ScreenTemplate}s this package provides — the shapes that go inside a layout,\n     * at module, feature and slice level.\n     */\n    screenTemplates: string[];\n\n    /**\n     * The names of the {@link DialogTemplate}s this package provides.\n     */\n    dialogTemplates: string[];\n\n    /**\n     * The names of the {@link Theme}s this package ships, empty for a package that ships none.\n     */\n    themes: string[];\n\n    /**\n     * A human-readable name for a package picker, falling back to `name` when absent.\n     */\n    displayName?: string;\n\n    /**\n     * A one-line description for a package picker.\n     */\n    description?: string;\n\n    /**\n     * The module that implements the package - an npm package name for a web renderer. Design-time\n     * tooling needs it to know what to import; the model itself never loads anything.\n     */\n    module?: string;\n\n    /**\n     * The license the package is available under, as a short human-readable name (`MIT`,\n     * `PrimeUI Community`). A package picker shows it, because \"what am I taking on by selecting this\"\n     * is a question an author needs answered before they select it, not after.\n     */\n    license?: string;\n\n    /**\n     * Where the license terms actually live, so a reader can go and check rather than take `license` on\n     * trust. Required in practice for anything that is not a permissive standard license — a name alone\n     * tells an author nothing about eligibility or obligations.\n     */\n    licenseUrl?: string;\n}\n\nexport const ScenePackagePropertyNames: (keyof ScenePackage)[] = [\n    'name',\n    'version',\n    'kind',\n    'dependencies',\n    'components',\n    'layouts',\n    'screenTemplates',\n    'dialogTemplates',\n    'themes',\n    'displayName',\n    'description',\n    'module',\n    'license',\n    'licenseUrl',\n];\n"],"names":["ScenePackagePropertyNames"],"mappings":"AAAA;AACA;MAyFaA,yBAAAA,GAAoD;AAC7D,IAAA,MAAA;AACA,IAAA,SAAA;AACA,IAAA,MAAA;AACA,IAAA,cAAA;AACA,IAAA,YAAA;AACA,IAAA,SAAA;AACA,IAAA,iBAAA;AACA,IAAA,iBAAA;AACA,IAAA,QAAA;AACA,IAAA,aAAA;AACA,IAAA,aAAA;AACA,IAAA,QAAA;AACA,IAAA,SAAA;AACA,IAAA;;;"}
+{"version":3,"file":"ScenePackage.js","sources":["../../../packages/ScenePackage.ts"],"sourcesContent":["// Copyright (c) Cratis. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for full license information.\n\nimport { IconLibrary } from '../icons';\nimport { PackageDependency } from './PackageDependency';\nimport { PackageKind } from './PackageKind';\n\n/**\n * What a {@link UiProfile}'s `packages` entry actually names. A profile lists packages by name only;\n * this is the declaration behind the name - what it contributes, and what else has to be active for it\n * to work.\n */\nexport interface ScenePackage {\n    /**\n     * The name a {@link UiProfile} lists, and the name a {@link PackageDependency} refers to.\n     */\n    name: string;\n\n    /**\n     * The package's own version, so a {@link PackageDependency.versionRange} has something to check against.\n     */\n    version: string;\n\n    /**\n     * What the package contributes.\n     */\n    kind: PackageKind;\n\n    /**\n     * Other packages that must be active in the same profile for this one to work.\n     */\n    dependencies: PackageDependency[];\n\n    /**\n     * The component names this package declares - the catalog entry {@link UiProfile} resolution walks.\n     */\n    components: string[];\n\n    /**\n     * The names of the {@link Layout}s this package provides — an application's base navigational shells.\n     * Empty for anything that is not a {@link PackageKind.Blueprint}.\n     */\n    layouts: string[];\n\n    /**\n     * The names of the {@link ScreenTemplate}s this package provides — the shapes that go inside a layout,\n     * at module, feature and slice level.\n     */\n    screenTemplates: string[];\n\n    /**\n     * The names of the {@link DialogTemplate}s this package provides.\n     */\n    dialogTemplates: string[];\n\n    /**\n     * The names of the {@link Theme}s this package ships, empty for a package that ships none.\n     */\n    themes: string[];\n\n    /**\n     * A human-readable name for a package picker, falling back to `name` when absent.\n     */\n    displayName?: string;\n\n    /**\n     * A one-line description for a package picker.\n     */\n    description?: string;\n\n    /**\n     * The module that implements the package - an npm package name for a web renderer. Design-time\n     * tooling needs it to know what to import; the model itself never loads anything.\n     */\n    module?: string;\n\n    /**\n     * The license the package is available under, as a short human-readable name (`MIT`,\n     * `PrimeUI Community`). A package picker shows it, because \"what am I taking on by selecting this\"\n     * is a question an author needs answered before they select it, not after.\n     */\n    license?: string;\n\n    /**\n     * Where the license terms actually live, so a reader can go and check rather than take `license` on\n     * trust. Required in practice for anything that is not a permissive standard license — a name alone\n     * tells an author nothing about eligibility or obligations.\n     */\n    licenseUrl?: string;\n\n    /**\n     * What the package declares about its icons. Present exactly for a {@link PackageKind.IconLibrary}.\n     */\n    iconLibrary?: IconLibrary;\n}\n\nexport const ScenePackagePropertyNames: (keyof ScenePackage)[] = [\n    'name',\n    'version',\n    'kind',\n    'dependencies',\n    'components',\n    'layouts',\n    'screenTemplates',\n    'dialogTemplates',\n    'themes',\n    'displayName',\n    'description',\n    'module',\n    'license',\n    'licenseUrl',\n    'iconLibrary',\n];\n"],"names":["ScenePackagePropertyNames"],"mappings":"AAAA;AACA;MA+FaA,yBAAAA,GAAoD;AAC7D,IAAA,MAAA;AACA,IAAA,SAAA;AACA,IAAA,MAAA;AACA,IAAA,cAAA;AACA,IAAA,YAAA;AACA,IAAA,SAAA;AACA,IAAA,iBAAA;AACA,IAAA,iBAAA;AACA,IAAA,QAAA;AACA,IAAA,aAAA;AACA,IAAA,aAAA;AACA,IAAA,QAAA;AACA,IAAA,SAAA;AACA,IAAA,YAAA;AACA,IAAA;;;"}