@_linked/core 2.34.0 → 2.36.0

package/lib/esm/utils/unresolvedShape.js

@@ -0,0 +1,68 @@
+import { getActiveShapeCatalog } from './ShapeClass.js';
+/**
+ * The error core throws when a shape IRI does not resolve, carrying the IRIs as fields so a
+ * host can map it without parsing the message. It stays a plain `Error` (`name` is
+ * `'Error'`): only the message and the fields are added.
+ */
+export class UnresolvedShapeError extends Error {
+    constructor(message, details) {
+        super(message);
+        this.shapeIri = details.shapeIri;
+        if (details.property !== undefined)
+            this.property = details.property;
+        if (details.propertyIri !== undefined)
+            this.propertyIri = details.propertyIri;
+        if (details.ownerShapeIri !== undefined)
+            this.ownerShapeIri = details.ownerShapeIri;
+        if (details.catalog !== undefined)
+            this.catalog = details.catalog;
+    }
+}
+/**
+ * The details for a property whose value shape does not resolve. The owner is the property's
+ * `parentNodeShape`, or `owner` when the caller knows it better (a path walk).
+ */
+export function unresolvedValueShapeDetails(ps, owner) {
+    var _a, _b, _c, _d, _e;
+    const ownerShapeIri = (_a = owner === null || owner === void 0 ? void 0 : owner.id) !== null && _a !== void 0 ? _a : (_b = ps.parentNodeShape) === null || _b === void 0 ? void 0 : _b.id;
+    const catalog = (_c = getActiveShapeCatalog()) === null || _c === void 0 ? void 0 : _c.name;
+    return Object.assign(Object.assign(Object.assign({ shapeIri: (_e = (_d = ps.valueShape) === null || _d === void 0 ? void 0 : _d.id) !== null && _e !== void 0 ? _e : '', property: ps.label }, (ps.path && typeof ps.path === 'object' && 'id' in ps.path && typeof ps.path.id === 'string'
+        ? { propertyIri: ps.path.id }
+        : {})), (ownerShapeIri ? { ownerShapeIri } : {})), (catalog !== undefined ? { catalog } : {}));
+}
+/** The details for a shape named directly (a query's or mutation's own shape). */
+export function topLevelDetails(shapeIri) {
+    var _a;
+    const catalog = (_a = getActiveShapeCatalog()) === null || _a === void 0 ? void 0 : _a.name;
+    return Object.assign({ shapeIri }, (catalog !== undefined ? { catalog } : {}));
+}
+/**
+ * Why the shape is missing, in words: `property 'home' of '<owner>' points at it; catalog
+ * 'p1#main' does not hold it`. Each error keeps its own leading sentence and appends this.
+ */
+export function describeUnresolved(details) {
+    const parts = [];
+    if (details.property !== undefined) {
+        parts.push(details.ownerShapeIri
+            ? `property '${details.property}' of '${details.ownerShapeIri}' points at it`
+            : `property '${details.property}' points at it`);
+    }
+    if (getActiveShapeCatalog() !== undefined) {
+        parts.push(details.catalog !== undefined
+            ? `catalog '${details.catalog}' does not hold it`
+            : 'the active catalog does not hold it');
+    }
+    else {
+        parts.push('it is not registered');
+    }
+    return parts.join('; ');
+}
+/** `<prefix> (<why>)` as an {@link UnresolvedShapeError}. */
+export function unresolvedShapeError(prefix, details) {
+    return new UnresolvedShapeError(`${prefix} (${describeUnresolved(details)})`, details);
+}
+/** The error for a property whose `valueShape` does not resolve. */
+export function unresolvedValueShapeError(prefix, ps, owner) {
+    return unresolvedShapeError(prefix, unresolvedValueShapeDetails(ps, owner));
+}
+//# sourceMappingURL=unresolvedShape.js.map

package/lib/esm/utils/unresolvedShape.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unresolvedShape.js","sourceRoot":"","sources":["../../../src/utils/unresolvedShape.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,qBAAqB,EAAC,MAAM,iBAAiB,CAAC;AAetD;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAO7C,YAAY,OAAe,EAAE,OAA+B;QAC1D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;YAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACrE,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS;YAAE,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QAC9E,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS;YAAE,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QACpF,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACpE,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CACzC,EAAqB,EACrB,KAAqB;;IAErB,MAAM,aAAa,GAAG,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,EAAE,mCAAI,MAAA,EAAE,CAAC,eAAe,0CAAE,EAAE,CAAC;IAC1D,MAAM,OAAO,GAAG,MAAA,qBAAqB,EAAE,0CAAE,IAAI,CAAC;IAC9C,mDACE,QAAQ,EAAE,MAAA,MAAA,EAAE,CAAC,UAAU,0CAAE,EAAE,mCAAI,EAAE,EACjC,QAAQ,EAAE,EAAE,CAAC,KAAK,IACf,CAAC,EAAE,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,IAAI,EAAE,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,QAAQ;QAC7F,CAAC,CAAC,EAAC,WAAW,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,EAAC;QAC3B,CAAC,CAAC,EAAE,CAAC,GACJ,CAAC,aAAa,CAAC,CAAC,CAAC,EAAC,aAAa,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GACtC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAC,OAAO,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAC3C;AACJ,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,eAAe,CAAC,QAAgB;;IAC9C,MAAM,OAAO,GAAG,MAAA,qBAAqB,EAAE,0CAAE,IAAI,CAAC;IAC9C,uBAAQ,QAAQ,IAAK,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAC,OAAO,EAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE;AACjE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAA+B;IAChE,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CACR,OAAO,CAAC,aAAa;YACnB,CAAC,CAAC,aAAa,OAAO,CAAC,QAAQ,SAAS,OAAO,CAAC,aAAa,gBAAgB;YAC7E,CAAC,CAAC,aAAa,OAAO,CAAC,QAAQ,gBAAgB,CAClD,CAAC;IACJ,CAAC;IACD,IAAI,qBAAqB,EAAE,KAAK,SAAS,EAAE,CAAC;QAC1C,KAAK,CAAC,IAAI,CACR,OAAO,CAAC,OAAO,KAAK,SAAS;YAC3B,CAAC,CAAC,YAAY,OAAO,CAAC,OAAO,oBAAoB;YACjD,CAAC,CAAC,qCAAqC,CAC1C,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,oBAAoB,CAClC,MAAc,EACd,OAA+B;IAE/B,OAAO,IAAI,oBAAoB,CAAC,GAAG,MAAM,KAAK,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AACzF,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,yBAAyB,CACvC,MAAc,EACd,EAAqB,EACrB,KAAqB;IAErB,OAAO,oBAAoB,CAAC,MAAM,EAAE,2BAA2B,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;AAC9E,CAAC","sourcesContent":["/*\n * This Source Code Form is subject to the terms of the Mozilla Public\n * License, v. 2.0. If a copy of the MPL was not distributed with this\n * file, You can obtain one at https://mozilla.org/MPL/2.0/.\n */\nimport type {NodeShapeData, PropertyShapeData} from '../shapes/nodeShapeData.js';\nimport {getActiveShapeCatalog} from './ShapeClass.js';\n\n/**\n * Where an unresolved shape was met: the shape IRI that could not be resolved and, when a\n * property pointed at it, that property and the shape that declares it. `catalog` is the\n * active catalog's `name`, absent in the global registry or for an unnamed catalog.\n */\nexport interface UnresolvedShapeDetails {\n  shapeIri: string;\n  property?: string;\n  propertyIri?: string;\n  ownerShapeIri?: string;\n  catalog?: string;\n}\n\n/**\n * The error core throws when a shape IRI does not resolve, carrying the IRIs as fields so a\n * host can map it without parsing the message. It stays a plain `Error` (`name` is\n * `'Error'`): only the message and the fields are added.\n */\nexport class UnresolvedShapeError extends Error implements UnresolvedShapeDetails {\n  readonly shapeIri: string;\n  readonly property?: string;\n  readonly propertyIri?: string;\n  readonly ownerShapeIri?: string;\n  readonly catalog?: string;\n\n  constructor(message: string, details: UnresolvedShapeDetails) {\n    super(message);\n    this.shapeIri = details.shapeIri;\n    if (details.property !== undefined) this.property = details.property;\n    if (details.propertyIri !== undefined) this.propertyIri = details.propertyIri;\n    if (details.ownerShapeIri !== undefined) this.ownerShapeIri = details.ownerShapeIri;\n    if (details.catalog !== undefined) this.catalog = details.catalog;\n  }\n}\n\n/**\n * The details for a property whose value shape does not resolve. The owner is the property's\n * `parentNodeShape`, or `owner` when the caller knows it better (a path walk).\n */\nexport function unresolvedValueShapeDetails(\n  ps: PropertyShapeData,\n  owner?: NodeShapeData,\n): UnresolvedShapeDetails {\n  const ownerShapeIri = owner?.id ?? ps.parentNodeShape?.id;\n  const catalog = getActiveShapeCatalog()?.name;\n  return {\n    shapeIri: ps.valueShape?.id ?? '',\n    property: ps.label,\n    ...(ps.path && typeof ps.path === 'object' && 'id' in ps.path && typeof ps.path.id === 'string'\n      ? {propertyIri: ps.path.id}\n      : {}),\n    ...(ownerShapeIri ? {ownerShapeIri} : {}),\n    ...(catalog !== undefined ? {catalog} : {}),\n  };\n}\n\n/** The details for a shape named directly (a query's or mutation's own shape). */\nexport function topLevelDetails(shapeIri: string): UnresolvedShapeDetails {\n  const catalog = getActiveShapeCatalog()?.name;\n  return {shapeIri, ...(catalog !== undefined ? {catalog} : {})};\n}\n\n/**\n * Why the shape is missing, in words: `property 'home' of '<owner>' points at it; catalog\n * 'p1#main' does not hold it`. Each error keeps its own leading sentence and appends this.\n */\nexport function describeUnresolved(details: UnresolvedShapeDetails): string {\n  const parts: string[] = [];\n  if (details.property !== undefined) {\n    parts.push(\n      details.ownerShapeIri\n        ? `property '${details.property}' of '${details.ownerShapeIri}' points at it`\n        : `property '${details.property}' points at it`,\n    );\n  }\n  if (getActiveShapeCatalog() !== undefined) {\n    parts.push(\n      details.catalog !== undefined\n        ? `catalog '${details.catalog}' does not hold it`\n        : 'the active catalog does not hold it',\n    );\n  } else {\n    parts.push('it is not registered');\n  }\n  return parts.join('; ');\n}\n\n/** `<prefix> (<why>)` as an {@link UnresolvedShapeError}. */\nexport function unresolvedShapeError(\n  prefix: string,\n  details: UnresolvedShapeDetails,\n): UnresolvedShapeError {\n  return new UnresolvedShapeError(`${prefix} (${describeUnresolved(details)})`, details);\n}\n\n/** The error for a property whose `valueShape` does not resolve. */\nexport function unresolvedValueShapeError(\n  prefix: string,\n  ps: PropertyShapeData,\n  owner?: NodeShapeData,\n): UnresolvedShapeError {\n  return unresolvedShapeError(prefix, unresolvedValueShapeDetails(ps, owner));\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@_linked/core",
-  "version": "2.34.0",
+  "version": "2.36.0",
   "packageManager": "npm@12.2.0",
   "license": "MIT",
   "linkedPackage": true,