@api-client/core 0.8.0 → 0.8.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "license": "Apache-2.0",
   "main": "build/index.js",
   "module": "build/index.js",
@@ -32,7 +32,7 @@
     "@types/cors": "^2.8.12",
     "@types/express-ntlm": "^2.3.3",
     "@types/fs-extra": "^9.0.13",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^10.0.0",
     "@types/node": "^18.7.18",
     "@types/sinon": "^10.0.11",
     "@typescript-eslint/eslint-plugin": "^5.12.0",
@@ -40,7 +40,7 @@
     "@web/dev-server-esbuild": "^0.3.0",
     "@web/test-runner": "^0.14.0",
     "@web/test-runner-playwright": "^0.8.8",
-    "amf-client-js": "^5.0.8-0",
+    "amf-client-js": "^5.1.0",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "chai-uuid": "^1.0.6",
@@ -67,7 +67,7 @@
   },
   "scripts": {
     "build-ts": "tsc",
-    "build": "npm run build-ts && npm run lint",
+    "build": "npm run build-ts && npm run lint && npm run copy:assets",
     "lint": "tsc --noEmit && eslint \"**/*.{js,ts}\" --quiet --fix",
     "prepare": "husky install && npm run build-ts && npm run build:api-models",
     "tsc:watch": "tsc --watch",
@@ -75,7 +75,8 @@
     "test:browser:watch": "wtr --watch --playwright --browsers chromium",
     "test:node": "npm run build-ts && mocha",
     "test": "npm run test:node && npm run test:browser",
-    "build:api-models": "node data/model.js"
+    "build:api-models": "node data/model.js",
+    "copy:assets": "cp -f ./oauth-popup.html ./build/oauth-popup.html"
   },
   "husky": {
     "hooks": {

package/src/amf/AmfMixin.ts

@@ -57,6 +57,7 @@ type Constructor<T = {}> = new (...args: any[]) => T;
 
 export declare class AmfMixinInterface {
   amf?: IAmfDocument;
+  _amf?: IAmfDocument;
   /**
    * This is an abstract method to be implemented by the components.
    * If, instead, the component uses `amf` setter you must use `super.amf` to
@@ -254,7 +255,7 @@ export declare class AmfMixinInterface {
    * to read servers
    * @private
    */
-  _isValidServerPartial(model: IAmfDomainElement, context?: Record<string, string>): boolean;
+  _isValidServerPartial(model: IAmfDomainElement | IAmfDomainElement[], context?: Record<string, string>): boolean;
 
   /**
    * @param options Server query options
@@ -957,7 +958,7 @@ export const AmfMixin = <T extends Constructor<any>>(superClass: T): Constructor
      * to read servers
      * @private
      */
-    _isValidServerPartial(model: IAmfDomainElement, context?: Record<string, string>): boolean {
+    _isValidServerPartial(model: IAmfDomainElement | IAmfDomainElement[], context?: Record<string, string>): boolean {
       if (Array.isArray(model)) {
         [model] = model;
       }

package/src/amf/AmfShapeGenerator.ts

@@ -10,6 +10,8 @@ import v4 from '../lib/uuid.js';
 
 /**
  * Serializes Data shapes (DataEntity, DataProperty, DataAssociation) to AMF-related shapes.
+ * 
+ * This is used when defining entities (according to the `DataEntity` schema) and then we want to translate this into AMF shapes.
  */
 export class AmfShapeGenerator {
   /**
@@ -73,8 +75,8 @@ export class AmfShapeGenerator {
     this._updateBaseProperties(input, result);
 
     // sync the name of the property shape with the range, in case it was changed by the bindings
-    if (result.range!.name) {
-      result.name = result.range!.name;
+    if (result.range.name) {
+      result.name = result.range.name;
     }
     return result;
   }
@@ -382,7 +384,7 @@ export class AmfShapeGenerator {
    */
   refactorArrayToShape(array: IApiArrayShape): IShapeUnion {
     const { items } = array;
-    return items!;
+    return items as IShapeUnion;
   }
 
   /**

package/src/amf/ApiSchemaValues.ts

@@ -27,7 +27,7 @@ export class ApiSchemaValues {
    *
    * @returns The value to set on the input. Note, it is not cast to the type.
    */
-  static readInputValue(parameter: IApiParameter, schema: IApiScalarShape, opts: IApiSchemaReadOptions = {}): any {
+  static readInputValue(parameter: IApiParameter, schema: IApiScalarShape, opts: IApiSchemaReadOptions = {}): string | number | boolean | null | undefined {
     const { required } = parameter;
     const { defaultValueStr, values } = schema;
     if (!required && opts.requiredOnly === true) {
@@ -180,7 +180,7 @@ export class ApiSchemaValues {
     }
   }
 
-  static defaultValue(dataType?: string): any {
+  static defaultValue(dataType?: string): string | number | boolean | null | undefined {
     switch (dataType) {
       case ns.w3.xmlSchema.string: return '';
       // XML schema, for DataNode
@@ -287,7 +287,7 @@ export class ApiSchemaValues {
    * Casts the `value` to the corresponding data type
    * @param type The w3 schema type
    */
-  static readTypedValue(value: any, type?: string): any {
+  static readTypedValue(value: unknown, type?: string): string | number | boolean | null | undefined {
     return readTypedValue(value, type);
   }
 
@@ -334,8 +334,8 @@ export class ApiSchemaValues {
   /**
    * Processes a value that should be a date formatted as yyyy-MM-dd.
    */
-  static parseDateOnlyInput(value: any): string | undefined {
-    const d = new Date(value);
+  static parseDateOnlyInput(value: unknown): string | undefined {
+    const d = new Date(value as string | number);
     if (Number.isNaN(d.getTime())) {
       return undefined;
     }

package/src/amf/Utils.ts

@@ -5,7 +5,7 @@ import { IApiNodeShape, IApiPropertyShape, IShapeUnion, IApiUnionShape } from ".
 /**
    * @param indent The current indent
    */
-export function toXml(obj: Record<string, unknown>, indent=0): string {
+export function toXml(obj: Record<string, unknown>, indent = 0): string {
   if (typeof obj !== 'object') {
     return obj;
   }
@@ -15,14 +15,16 @@ export function toXml(obj: Record<string, unknown>, indent=0): string {
     xml += Array.isArray(obj[prop]) ? '' : `${tabs}<${prop}>`;
     if (Array.isArray(obj[prop])) {
       (obj[prop] as Record<string, unknown>[]).forEach((item) => {
-        xml += `<${prop}>\n`;
         xml += tabs;
+        xml += `<${prop}>\n`;
         xml += toXml({ ...item }, indent + 1);
+        xml += tabs;
         xml += `</${prop}>\n`;
       });
     } else if (typeof obj[prop] === "object") {
       xml += `\n`;
       xml += toXml({ ...obj[prop] as Record<string, unknown> }, indent + 1);
+      xml += tabs;
     } else {
       xml += `${obj[prop]}`;
     }
@@ -113,7 +115,7 @@ export function readTypedValue(value: unknown, type?: string): string | null | n
     case AmfNamespace.aml.vocabularies.shapes.boolean:
     case AmfNamespace.w3.xmlSchema.boolean: return parseBooleanInput(value, false);
     case AmfNamespace.aml.vocabularies.shapes.nil:
-    case AmfNamespace.w3.xmlSchema.nil: 
+    case AmfNamespace.w3.xmlSchema.nil:
       return null;
     default:
       return value as string | null | number | boolean | undefined;
@@ -152,7 +154,7 @@ export function collectNodeProperties(schema: IApiNodeShape, selectedUnions?: st
       let node = s;
       if (node.types.includes(AmfNamespace.aml.vocabularies.shapes.UnionShape)) {
         const union = node as IApiUnionShape;
-        const { anyOf=[] } = union;
+        const { anyOf = [] } = union;
         node = getUnionMember(anyOf, selectedUnions);
       }
       if (!node.types.includes(AmfNamespace.w3.shacl.NodeShape)) {

package/src/amf/data-node/XmlDataNodeGenerator.ts

@@ -31,7 +31,8 @@ export class XmlDataNodeGenerator extends DataNodeBase {
       if (Array.isArray(result)) {
         return result.map(v => `${tabs}<${shapeName}>${toXml(v)}</${shapeName}>`).filter(v => !!v).join('\n');
       }
-      return `${tabs}<${shapeName}>${toXml(result)}</${shapeName}>`;
+      // return `${tabs}<${shapeName}>${toXml(result)}</${shapeName}>`;
+      return `${toXml({ [shapeName]: result })}`;
     }
     return `${toXml(result, indent)}`;
   }

package/src/amf/shape/ShapeBase.ts

@@ -42,7 +42,7 @@ export abstract class ShapeBase {
     this.opts = Object.freeze({ ...opts });
   }
 
-  protected _scalarValue(schema: IApiScalarShape): string | number | boolean {
+  protected _scalarValue(schema: IApiScalarShape): string | number | boolean | null | undefined {
     const { defaultValue, examples, values, inherits, dataType } = schema;
     // check examples
     if (this.opts.renderExamples && examples && examples.length) {

package/src/amf/shape/ShapeJsonSchemaGenerator.ts

@@ -155,7 +155,8 @@ export class ShapeJsonSchemaGenerator extends ShapeBase {
   }
 
   protected _oneOfUnion(schema: IApiUnionShape): any {
-    let { xone=[], examples=[] } = schema;
+    let { examples=[] } = schema;
+    const { xone=[] } = schema;
     if (Array.isArray(schema.inherits) && schema.inherits) {
       schema.inherits.forEach((parent) => {
         const anyParent = parent as IApiAnyShape;
@@ -192,7 +193,8 @@ export class ShapeJsonSchemaGenerator extends ShapeBase {
    * Combines all properties from both all shapes in the union
    */
   protected _allOfUnion(schema: IApiUnionShape): any {
-    let { examples=[], and=[] } = schema;
+    let { examples=[] } = schema;
+    const { and=[] } = schema;
     if (Array.isArray(schema.inherits) && schema.inherits) {
       schema.inherits.forEach((parent) => {
         const anyParent = parent as IApiAnyShape;