@unito/integration-api 7.1.0 → 7.1.1

package/dist/src/guards.d.ts

@@ -1,4 +1,16 @@
 import * as Api from './types.js';
+/**
+ * Options for type guard functions.
+ */
+export interface GuardOptions {
+    /**
+     * When false, validate structure only (values are strings) without checking enum membership.
+     * This allows forward compatibility when a newer integration-api adds Semantics or FieldValueTypes
+     * that the consumer doesn't know about yet.
+     * Defaults to true.
+     */
+    strict?: boolean;
+}
 /**
  * Checks if the input is a record<unknown, unknown>
  * @param potentialObject - The value to check.
@@ -40,31 +52,31 @@ export declare function isRelationPointer(potentialRelationPointer: unknown): po
  * @param potentialReferenceRelation - The value to check.
  * @returns True if the value is a ReferenceRelation, false otherwise.
  */
-export declare function isReferenceRelation(potentialReferenceRelation: unknown): potentialReferenceRelation is Api.ReferenceRelation;
+export declare function isReferenceRelation(potentialReferenceRelation: unknown, options?: GuardOptions): potentialReferenceRelation is Api.ReferenceRelation;
 /**
  * Checks if the input is an Api.RelationSummary object.
  * @param potentialRelationSummary - The value to check.
  * @returns True if the value is a RelationSummary, false otherwise.
  */
-export declare function isRelationSummary(potentialRelationSummary: unknown): potentialRelationSummary is Api.RelationSummary;
+export declare function isRelationSummary(potentialRelationSummary: unknown, options?: GuardOptions): potentialRelationSummary is Api.RelationSummary;
 /**
  * Checks if the input is an Api.Relation object.
  * @param potentialRelation - The value to check.
  * @returns True if the value is a Relation, false otherwise.
  */
-export declare function isRelation(potentialRelation: unknown): potentialRelation is Api.Relation;
+export declare function isRelation(potentialRelation: unknown, options?: GuardOptions): potentialRelation is Api.Relation;
 /**
  * Checks if the input is an Api.RelationSchema object.
  * @param potentialRelationSchema - The value to check.
  * @returns True if the value is a RelationSchema, false otherwise.
  */
-export declare function isRelationSchema(potentialRelationSchema: unknown): potentialRelationSchema is Api.RelationSchema;
+export declare function isRelationSchema(potentialRelationSchema: unknown, options?: GuardOptions): potentialRelationSchema is Api.RelationSchema;
 /**
  * Checks if the input is an Api.RelationSchema object or the string '__self'.
  * @param potentialRelationSchema - The value to check.
  * @returns True if the value is a RelationSchema or '__self', false otherwise.
  */
-export declare function isRelationSchemaOrSelf(potentialRelationSchemaOrSelf: unknown): potentialRelationSchemaOrSelf is Api.RelationSchema | '__self';
+export declare function isRelationSchemaOrSelf(potentialRelationSchemaOrSelf: unknown, options?: GuardOptions): potentialRelationSchemaOrSelf is Api.RelationSchema | '__self';
 /**
  * Checks if the input is an Api.FieldValueType.
  * @param potentialFieldValueType - The value to check.
@@ -82,4 +94,4 @@ export declare function isSemantic(potentialSemantic: unknown): potentialSemanti
  * @param potentialFieldSchema - The value to check.
  * @returns True if the value is a FieldSchema, false otherwise.
  */
-export declare function isFieldSchema(potentialFieldSchema: unknown): potentialFieldSchema is Api.FieldSchema;
+export declare function isFieldSchema(potentialFieldSchema: unknown, options?: GuardOptions): potentialFieldSchema is Api.FieldSchema;

package/dist/src/guards.js

@@ -44,7 +44,7 @@ export function isItem(potentialItem) {
     return (isObject(potentialItem) &&
         isObject(potentialItem['fields']) &&
         Array.isArray(potentialItem['relations']) &&
-        potentialItem['relations'].every(isRelation));
+        potentialItem['relations'].every((r) => isRelation(r)));
 }
 /**
  * Checks if the input is an Api.RelationPointer object.
@@ -61,57 +61,57 @@ export function isRelationPointer(potentialRelationPointer) {
  * @param potentialReferenceRelation - The value to check.
  * @returns True if the value is a ReferenceRelation, false otherwise.
  */
-export function isReferenceRelation(potentialReferenceRelation) {
+export function isReferenceRelation(potentialReferenceRelation, options) {
     return (isObject(potentialReferenceRelation) &&
         isString(potentialReferenceRelation['name']) &&
         isString(potentialReferenceRelation['path']) &&
         isString(potentialReferenceRelation['label']) &&
-        isRelationSchemaOrSelf(potentialReferenceRelation['schema']));
+        isRelationSchemaOrSelf(potentialReferenceRelation['schema'], options));
 }
 /**
  * Checks if the input is an Api.RelationSummary object.
  * @param potentialRelationSummary - The value to check.
  * @returns True if the value is a RelationSummary, false otherwise.
  */
-export function isRelationSummary(potentialRelationSummary) {
+export function isRelationSummary(potentialRelationSummary, options) {
     return (isObject(potentialRelationSummary) &&
         isString(potentialRelationSummary['name']) &&
         isString(potentialRelationSummary['label']) &&
-        isRelationSchemaOrSelf(potentialRelationSummary['schema']));
+        isRelationSchemaOrSelf(potentialRelationSummary['schema'], options));
 }
 /**
  * Checks if the input is an Api.Relation object.
  * @param potentialRelation - The value to check.
  * @returns True if the value is a Relation, false otherwise.
  */
-export function isRelation(potentialRelation) {
+export function isRelation(potentialRelation, options) {
     return (isObject(potentialRelation) &&
         isString(potentialRelation['name']) &&
         isString(potentialRelation['path']) &&
         isString(potentialRelation['label']) &&
-        isRelationSchema(potentialRelation['schema']));
+        isRelationSchema(potentialRelation['schema'], options));
 }
 /**
  * Checks if the input is an Api.RelationSchema object.
  * @param potentialRelationSchema - The value to check.
  * @returns True if the value is a RelationSchema, false otherwise.
  */
-export function isRelationSchema(potentialRelationSchema) {
+export function isRelationSchema(potentialRelationSchema, options) {
     return (isObject(potentialRelationSchema) &&
         isString(potentialRelationSchema['label']) &&
         Array.isArray(potentialRelationSchema['fields']) &&
-        potentialRelationSchema['fields'].every(isFieldSchema) &&
+        potentialRelationSchema['fields'].every((f) => isFieldSchema(f, options)) &&
         (isUndefined(potentialRelationSchema['relations']) ||
             (Array.isArray(potentialRelationSchema['relations']) &&
-                potentialRelationSchema['relations'].every(isRelationSummary))));
+                potentialRelationSchema['relations'].every((r) => isRelationSummary(r, options)))));
 }
 /**
  * Checks if the input is an Api.RelationSchema object or the string '__self'.
  * @param potentialRelationSchema - The value to check.
  * @returns True if the value is a RelationSchema or '__self', false otherwise.
  */
-export function isRelationSchemaOrSelf(potentialRelationSchemaOrSelf) {
-    return isRelationSchema(potentialRelationSchemaOrSelf) || potentialRelationSchemaOrSelf === '__self';
+export function isRelationSchemaOrSelf(potentialRelationSchemaOrSelf, options) {
+    return isRelationSchema(potentialRelationSchemaOrSelf, options) || potentialRelationSchemaOrSelf === '__self';
 }
 /**
  * Checks if the input is an Api.FieldValueType.
@@ -134,11 +134,13 @@ export function isSemantic(potentialSemantic) {
  * @param potentialFieldSchema - The value to check.
  * @returns True if the value is a FieldSchema, false otherwise.
  */
-export function isFieldSchema(potentialFieldSchema) {
+export function isFieldSchema(potentialFieldSchema, options) {
+    const strict = options?.strict ?? true;
     return (isObject(potentialFieldSchema) &&
         isString(potentialFieldSchema['name']) &&
         isString(potentialFieldSchema['label']) &&
         isString(potentialFieldSchema['type']) &&
-        isFieldValueType(potentialFieldSchema['type']) &&
-        (isUndefined(potentialFieldSchema['semantic']) || isSemantic(potentialFieldSchema['semantic'])));
+        (strict ? isFieldValueType(potentialFieldSchema['type']) : true) &&
+        (isUndefined(potentialFieldSchema['semantic']) ||
+            (strict ? isSemantic(potentialFieldSchema['semantic']) : isString(potentialFieldSchema['semantic']))));
 }

package/dist/src/index.cjs

@@ -161,7 +161,7 @@ function isItem(potentialItem) {
     return (isObject(potentialItem) &&
         isObject(potentialItem['fields']) &&
         Array.isArray(potentialItem['relations']) &&
-        potentialItem['relations'].every(isRelation));
+        potentialItem['relations'].every((r) => isRelation(r)));
 }
 /**
  * Checks if the input is an Api.RelationPointer object.
@@ -178,57 +178,57 @@ function isRelationPointer(potentialRelationPointer) {
  * @param potentialReferenceRelation - The value to check.
  * @returns True if the value is a ReferenceRelation, false otherwise.
  */
-function isReferenceRelation(potentialReferenceRelation) {
+function isReferenceRelation(potentialReferenceRelation, options) {
     return (isObject(potentialReferenceRelation) &&
         isString(potentialReferenceRelation['name']) &&
         isString(potentialReferenceRelation['path']) &&
         isString(potentialReferenceRelation['label']) &&
-        isRelationSchemaOrSelf(potentialReferenceRelation['schema']));
+        isRelationSchemaOrSelf(potentialReferenceRelation['schema'], options));
 }
 /**
  * Checks if the input is an Api.RelationSummary object.
  * @param potentialRelationSummary - The value to check.
  * @returns True if the value is a RelationSummary, false otherwise.
  */
-function isRelationSummary(potentialRelationSummary) {
+function isRelationSummary(potentialRelationSummary, options) {
     return (isObject(potentialRelationSummary) &&
         isString(potentialRelationSummary['name']) &&
         isString(potentialRelationSummary['label']) &&
-        isRelationSchemaOrSelf(potentialRelationSummary['schema']));
+        isRelationSchemaOrSelf(potentialRelationSummary['schema'], options));
 }
 /**
  * Checks if the input is an Api.Relation object.
  * @param potentialRelation - The value to check.
  * @returns True if the value is a Relation, false otherwise.
  */
-function isRelation(potentialRelation) {
+function isRelation(potentialRelation, options) {
     return (isObject(potentialRelation) &&
         isString(potentialRelation['name']) &&
         isString(potentialRelation['path']) &&
         isString(potentialRelation['label']) &&
-        isRelationSchema(potentialRelation['schema']));
+        isRelationSchema(potentialRelation['schema'], options));
 }
 /**
  * Checks if the input is an Api.RelationSchema object.
  * @param potentialRelationSchema - The value to check.
  * @returns True if the value is a RelationSchema, false otherwise.
  */
-function isRelationSchema(potentialRelationSchema) {
+function isRelationSchema(potentialRelationSchema, options) {
     return (isObject(potentialRelationSchema) &&
         isString(potentialRelationSchema['label']) &&
         Array.isArray(potentialRelationSchema['fields']) &&
-        potentialRelationSchema['fields'].every(isFieldSchema) &&
+        potentialRelationSchema['fields'].every((f) => isFieldSchema(f, options)) &&
         (isUndefined(potentialRelationSchema['relations']) ||
             (Array.isArray(potentialRelationSchema['relations']) &&
-                potentialRelationSchema['relations'].every(isRelationSummary))));
+                potentialRelationSchema['relations'].every((r) => isRelationSummary(r, options)))));
 }
 /**
  * Checks if the input is an Api.RelationSchema object or the string '__self'.
  * @param potentialRelationSchema - The value to check.
  * @returns True if the value is a RelationSchema or '__self', false otherwise.
  */
-function isRelationSchemaOrSelf(potentialRelationSchemaOrSelf) {
-    return isRelationSchema(potentialRelationSchemaOrSelf) || potentialRelationSchemaOrSelf === '__self';
+function isRelationSchemaOrSelf(potentialRelationSchemaOrSelf, options) {
+    return isRelationSchema(potentialRelationSchemaOrSelf, options) || potentialRelationSchemaOrSelf === '__self';
 }
 /**
  * Checks if the input is an Api.FieldValueType.
@@ -251,13 +251,15 @@ function isSemantic(potentialSemantic) {
  * @param potentialFieldSchema - The value to check.
  * @returns True if the value is a FieldSchema, false otherwise.
  */
-function isFieldSchema(potentialFieldSchema) {
+function isFieldSchema(potentialFieldSchema, options) {
+    const strict = options?.strict ?? true;
     return (isObject(potentialFieldSchema) &&
         isString(potentialFieldSchema['name']) &&
         isString(potentialFieldSchema['label']) &&
         isString(potentialFieldSchema['type']) &&
-        isFieldValueType(potentialFieldSchema['type']) &&
-        (isUndefined(potentialFieldSchema['semantic']) || isSemantic(potentialFieldSchema['semantic'])));
+        (strict ? isFieldValueType(potentialFieldSchema['type']) : true) &&
+        (isUndefined(potentialFieldSchema['semantic']) ||
+            (strict ? isSemantic(potentialFieldSchema['semantic']) : isString(potentialFieldSchema['semantic']))));
 }
 
 const referenceToStringLikeConfiguration = {
@@ -672,15 +674,15 @@ function findRelationByJSONPath(item, query) {
             current = previousSchema;
         }
         const result = applyToken(current, token);
-        if (isObject(result) && isRelationSchema(result['schema'])) {
+        if (isObject(result) && isRelationSchema(result['schema'], { strict: false })) {
             schemas.push(result['schema']);
         }
         current = result;
     }
-    if (isRelation(current)) {
+    if (isRelation(current, { strict: false })) {
         return current;
     }
-    if (isReferenceRelation(current) || isRelationSummary(current)) {
+    if (isReferenceRelation(current, { strict: false }) || isRelationSummary(current, { strict: false })) {
         const latestSchema = schemas[schemas.length - 1];
         if (latestSchema === undefined) {
             throw new Error(`No schema found for relation ${current.label}`);

package/dist/src/jsonPathHelpers.js

@@ -15,15 +15,15 @@ export function findRelationByJSONPath(item, query) {
             current = previousSchema;
         }
         const result = applyToken(current, token);
-        if (Guards.isObject(result) && Guards.isRelationSchema(result['schema'])) {
+        if (Guards.isObject(result) && Guards.isRelationSchema(result['schema'], { strict: false })) {
             schemas.push(result['schema']);
         }
         current = result;
     }
-    if (Guards.isRelation(current)) {
+    if (Guards.isRelation(current, { strict: false })) {
         return current;
     }
-    if (Guards.isReferenceRelation(current) || Guards.isRelationSummary(current)) {
+    if (Guards.isReferenceRelation(current, { strict: false }) || Guards.isRelationSummary(current, { strict: false })) {
         const latestSchema = schemas[schemas.length - 1];
         if (latestSchema === undefined) {
             throw new Error(`No schema found for relation ${current.label}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-api",
-  "version": "7.1.0",
+  "version": "7.1.1",
   "description": "The Unito Integration API",
   "type": "module",
   "types": "./dist/src/index.d.ts",