@cubicweb/client 1.8.0 → 1.9.0

package/README.md

@@ -203,5 +203,3 @@ const entity = schema.getEntity("InvalidEntityType");
 // TS will be happy and your entity will have the type 'ValidEntityType'.
 const entity = schema.getEntity("ValidEntityType");
 ```
-
-

package/lib/schema/classes/Utils.d.ts

@@ -1,6 +1,7 @@
 import { EntityRawSchemaArray } from "../raw/Entities";
 import { Cardinality, RelationDefinitionRawSchema, RelationDefinitionRawSchemaArray } from "../raw/RelationDefinitions";
 import { Schema } from "./Schema";
+import { EntitySchema } from "./EntitySchema";
 /**
  * Returns the given schema using loose typing.
  * Can be useful when working with generic schemas
@@ -27,4 +28,6 @@ export type RelationDefinitionMatcher<E extends EntityRawSchemaArray> = Partial<
  * and TypeScript will give compile errors.
  */
 export type MatchedRelationDefinition<E extends EntityRawSchemaArray, R extends RelationDefinitionRawSchemaArray<EntityRawSchemaArray>, M extends RelationDefinitionMatcher<E>> = R[number] extends infer RDef ? (RDef extends M ? RDef : never) : never;
+export declare function hasAttributeWithName(entitySchema: EntitySchema, attributeNameSearched: string): boolean;
+export declare function isAttributeRichString(entitySchema: EntitySchema, attributeNameSearched: string): boolean;
 //# sourceMappingURL=Utils.d.ts.map

package/lib/schema/classes/Utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/classes/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EACL,WAAW,EACX,2BAA2B,EAC3B,gCAAgC,EACjC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,4PAO1B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAErE;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,oBAAoB,IAAI,OAAO,CAC7E,2BAA2B,CAAC,CAAC,CAAC,CAC/B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,CACnC,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,gCAAgC,CAAC,oBAAoB,CAAC,EAChE,CAAC,SAAS,yBAAyB,CAAC,CAAC,CAAC,IACpC,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,IAAI,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC"}
+{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/schema/classes/Utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EACL,WAAW,EACX,2BAA2B,EAC3B,gCAAgC,EACjC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,4PAO1B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAErE;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,oBAAoB,IAAI,OAAO,CAC7E,2BAA2B,CAAC,CAAC,CAAC,CAC/B,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,CACnC,CAAC,SAAS,oBAAoB,EAC9B,CAAC,SAAS,gCAAgC,CAAC,oBAAoB,CAAC,EAChE,CAAC,SAAS,yBAAyB,CAAC,CAAC,CAAC,IACpC,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,IAAI,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AAE3E,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,YAAY,EAC1B,qBAAqB,EAAE,MAAM,GAC5B,OAAO,CAOT;AAED,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,YAAY,EAC1B,qBAAqB,EAAE,MAAM,GAC5B,OAAO,CAET"}

package/lib/schema/classes/Utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cardinalityRequired = exports.getLooseSchema = void 0;
+exports.isAttributeRichString = exports.hasAttributeWithName = exports.cardinalityRequired = exports.getLooseSchema = void 0;
 /**
  * Returns the given schema using loose typing.
  * Can be useful when working with generic schemas
@@ -22,4 +22,17 @@ function cardinalityRequired(cardinality) {
     return cardinality === "1" || cardinality === "+";
 }
 exports.cardinalityRequired = cardinalityRequired;
+function hasAttributeWithName(entitySchema, attributeNameSearched) {
+    for (const entityAttribute of entitySchema.attributes) {
+        if (entityAttribute.type == attributeNameSearched) {
+            return true;
+        }
+    }
+    return false;
+}
+exports.hasAttributeWithName = hasAttributeWithName;
+function isAttributeRichString(entitySchema, attributeNameSearched) {
+    return hasAttributeWithName(entitySchema, attributeNameSearched + "_format");
+}
+exports.isAttributeRichString = isAttributeRichString;
 //# sourceMappingURL=Utils.js.map

package/lib/schema/classes/Utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/schema/classes/Utils.ts"],"names":[],"mappings":";;;AAQA;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAI5B,MAAoB,EACpB,EAAE;IACF,OAAO,MAA2B,CAAC;AACrC,CAAC,CAAC;AAPW,QAAA,cAAc,kBAOzB;AAEF;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,WAAwB;IAC1D,OAAO,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,CAAC;AACpD,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/schema/classes/Utils.ts"],"names":[],"mappings":";;;AASA;;;;;;GAMG;AACI,MAAM,cAAc,GAAG,CAI5B,MAAoB,EACpB,EAAE;IACF,OAAO,MAA2B,CAAC;AACrC,CAAC,CAAC;AAPW,QAAA,cAAc,kBAOzB;AAEF;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,WAAwB;IAC1D,OAAO,WAAW,KAAK,GAAG,IAAI,WAAW,KAAK,GAAG,CAAC;AACpD,CAAC;AAFD,kDAEC;AAqBD,SAAgB,oBAAoB,CAClC,YAA0B,EAC1B,qBAA6B;IAE7B,KAAK,MAAM,eAAe,IAAI,YAAY,CAAC,UAAU,EAAE;QACrD,IAAI,eAAe,CAAC,IAAI,IAAI,qBAAqB,EAAE;YACjD,OAAO,IAAI,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAVD,oDAUC;AAED,SAAgB,qBAAqB,CACnC,YAA0B,EAC1B,qBAA6B;IAE7B,OAAO,oBAAoB,CAAC,YAAY,EAAE,qBAAqB,GAAG,SAAS,CAAC,CAAC;AAC/E,CAAC;AALD,sDAKC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@cubicweb/client",
   "description": "Official JS client for CubicWeb API",
   "author": "Logilab",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "license": "LGPL-3.0-or-later",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/src/schema/classes/Utils.ts

@@ -5,6 +5,7 @@ import {
   RelationDefinitionRawSchemaArray,
 } from "../raw/RelationDefinitions";
 import { Schema } from "./Schema";
+import { EntitySchema } from "./EntitySchema";
 
 /**
  * Returns the given schema using loose typing.
@@ -50,3 +51,22 @@ export type MatchedRelationDefinition<
   R extends RelationDefinitionRawSchemaArray<EntityRawSchemaArray>,
   M extends RelationDefinitionMatcher<E>
 > = R[number] extends infer RDef ? (RDef extends M ? RDef : never) : never;
+
+export function hasAttributeWithName(
+  entitySchema: EntitySchema,
+  attributeNameSearched: string
+): boolean {
+  for (const entityAttribute of entitySchema.attributes) {
+    if (entityAttribute.type == attributeNameSearched) {
+      return true;
+    }
+  }
+  return false;
+}
+
+export function isAttributeRichString(
+  entitySchema: EntitySchema,
+  attributeNameSearched: string
+): boolean {
+  return hasAttributeWithName(entitySchema, attributeNameSearched + "_format");
+}