@qoh/core-react 1.0.0-rc.5 → 1.0.0-rc.6

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# **0.0.1** feature parity _(2023-03-20)_
+
+#### changes:
+
+- use the same features and names as the angular version

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 gravity&storm GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+# Queen of hearts client core package
+
+> [!WARNING] This readme should not be deployed to npm.
+
+This package is providing the core client packages in react.
+
+# Running locally
+
+Run
+
+`npx nx serve server-vercel`
+
+from the root directory.
+
+## Reading Vercel logs from CLI
+
+Vercel logs can be read on the web-interface but vercel also provides a cli-tool that can be setup to show the server logs in the cli.
+
+### installation
+
+`npm i -g vercel`
+
+### Setup team
+
+Make sure you are on the right team by switching to gravityandstorm:
+
+`vercel switch gravityandstorm`
+
+### showing logs in cli
+
+Make sure you get the url of the deployment you want to watch. For example:
+
+`vercel logs queenofhearts-9qnjgvnfw-gravityandstorm.vercel.app`

package/lib/ApiError.d.ts

@@ -0,0 +1,11 @@
+type Body = {
+    id: string;
+    summary: string;
+    details: string;
+};
+export declare class ApiError extends Error {
+    status: number;
+    body: Body;
+    constructor(status: number, body: Body);
+}
+export {};

package/lib/ApiError.js

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ApiError = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/wrapNativeSuper"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2["default"])(o), (0, _possibleConstructorReturn2["default"])(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2["default"])(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+var ApiError = exports.ApiError = /*#__PURE__*/function (_Error) {
+  function ApiError(status, body) {
+    var _this;
+    (0, _classCallCheck2["default"])(this, ApiError);
+    _this = _callSuper(this, ApiError, [body.summary]);
+    (0, _defineProperty2["default"])(_this, "status", void 0);
+    (0, _defineProperty2["default"])(_this, "body", void 0);
+    _this.name = 'ApiError';
+    _this.status = status;
+    _this.body = body;
+    return _this;
+  }
+  (0, _inherits2["default"])(ApiError, _Error);
+  return (0, _createClass2["default"])(ApiError);
+}(/*#__PURE__*/(0, _wrapNativeSuper2["default"])(Error));

package/lib/QueenofheartsService.d.ts

@@ -0,0 +1,78 @@
+import React from 'react';
+import Backend from './backend/Backend';
+export declare enum Filter {
+    eq = "eq",
+    in = "in",
+    neq = "neq",
+    notIn = "notIn"
+}
+export interface QohResponse {
+    pages: any | null;
+    message: string;
+}
+export type ComponentTypes = Array<{
+    typename: string;
+    props: {
+        __typename: string;
+    };
+}>;
+export interface IFCDictionary {
+    [index: string]: ReactFCWithFieldNames;
+}
+export interface ReactFCWithFieldNames {
+    component?: React.FC<any>;
+    fieldNames?: string[];
+    loader?: () => any;
+}
+export declare let componentRegistry: IFCDictionary;
+export declare function unregisterComponent(name: string): void;
+export declare function registerComponent(functionalComponent: React.FC<any>, typeName: string, fieldNames?: string[], overwrite?: false): void;
+export declare function registerLazyComponent(loader: () => any, typeName: string, fieldNames?: string[], overwrite?: boolean): void;
+export declare function getAllregisteredComponents(): IFCDictionary;
+export declare const fetchDynamicComponents: (props: any) => Promise<(string | null)[]>;
+export declare class QueenofheartsService {
+    private static instance;
+    data: any;
+    debug: boolean;
+    backend: Backend;
+    apiToken: string | null;
+    localServer?: string;
+    latestUrl: string;
+    latestData: Object;
+    private constructor();
+    static init(backend: Backend, apiToken: string | null, localServer?: string): void;
+    static getInstance(): QueenofheartsService;
+    findComponentsInProps: (props: any) => string[];
+    fetchDynamicComponents: (componentsToLoad: string[]) => Promise<(string | null)[]>;
+    private loadAsyncComponent;
+    createComponent(props: any): JSX.Element | null;
+    private buildUrl;
+    queryGraphql: (graphqlQuery: string) => Promise<any>;
+    query: (queryName: string, options?: {
+        filter?: {
+            name: string;
+            operator: Filter;
+            value: string;
+        }[] | undefined;
+        components?: string | undefined;
+        ignoreProperties?: string[] | undefined;
+        variables?: {
+            [x: string]: unknown;
+            filter?: {
+                name: string;
+                operator: Filter;
+                value: string;
+            }[] | undefined;
+            locale?: string | undefined;
+        } | undefined;
+        locale?: string | undefined;
+        depth?: number | undefined;
+    } | undefined) => Promise<any>;
+    private getRegisteredComponentsWithFields;
+    getQueries: () => Promise<any>;
+    private injectIds;
+    private sendDebugEvent;
+    private sendQueriesEvent;
+    private sendComponentHTML;
+    private highlightComponent;
+}