@restorecommerce/facade 1.3.6 → 1.3.7

package/dist/gql/protos/utils.js

@@ -1,133 +0,0 @@
-import _ from 'lodash';
-import { scalarTypes, recursiveEnumCheck, getNameSpaceTypeName, getTyping } from './registry.js';
-export const capitalizeProtoName = (name) => {
-    return name.replace(/(?:\.|^|_)(\w)/g, v => v.toUpperCase()).replace(/[._]/g, '');
-};
-// converts camelcase entity name to snake case
-export const convertyCamelToSnakeCase = (entity) => {
-    return entity.replace(/(?:^|\.?)([A-Z])/g, (x, y) => { return '_' + y.toLowerCase(); }).replace(/^_/, '');
-};
-export const getKeys = (obj) => {
-    let set = new Set();
-    if (obj) {
-        const keys = Object.keys(obj);
-        for (let key of keys) {
-            if (typeof obj[key] === 'string') {
-                set.add(obj[key]);
-            }
-            else if (Array.isArray(obj[key])) {
-                for (let value of obj[key]) {
-                    set.add(value);
-                }
-            }
-        }
-    }
-    return Array.from(set);
-};
-export const decodeBufferFields = (items, bufferFields) => {
-    if (bufferFields && bufferFields.length > 0 && items && items.length > 0) {
-        for (let item of items) {
-            if (item && item.payload) {
-                const existingBufferFields = _.intersection(Object.keys(item.payload), bufferFields);
-                for (let bufferField of existingBufferFields) {
-                    if (item.payload[bufferField] && item.payload[bufferField].value && item.payload[bufferField].value instanceof Buffer) {
-                        item.payload[bufferField].value = JSON.parse(item.payload[bufferField].value.toString());
-                    }
-                }
-            }
-        }
-        return items;
-    }
-    else {
-        return items;
-    }
-};
-/**
- * recursively find the id and updates the object with given value, this function
- * also takes care to handle if there is an array at any position in the path
- * @param id property of the object
- * @param val value to be updated in Object
- * @param obj Object
- */
-const updateJSON = (id, value, obj) => {
-    for (const [k, v] of Object.entries(obj)) {
-        if (k === id) {
-            const foundObj = value.find((e) => e.name === obj[k]);
-            if (foundObj) {
-                obj[k] = foundObj.number;
-            }
-        }
-        else if (typeof v === 'object') {
-            updateJSON(id, value, v);
-        }
-    }
-};
-/**
- * converts enum string values to integers reading from the inputTyping
- * @param TypingData input typing
- * @param req request object from which the enum strings to be replaced
- */
-export const convertEnumToInt = (inputTyping, req) => {
-    let enumMap = new Map();
-    // enumMap populated with key as enum name space type and value as the path (to replace from request object)
-    if (inputTyping) {
-        const gqlInputObject = inputTyping.input;
-        const gqlFields = gqlInputObject.getFields();
-        if (gqlFields) {
-            const fieldNames = Object.keys(gqlFields);
-            for (let fieldName of fieldNames) {
-                // gql fieldName from input is of format [IIoRestorecommerceResourcebaseSort!]
-                // below check is to remove `[` and `!]`
-                let fieldType = gqlFields[fieldName].type.toString();
-                if (fieldType.startsWith('[') && fieldType.endsWith('!]')) {
-                    fieldType = fieldType.substring(1, fieldType.length - 2);
-                }
-                // if fieldType is not basic type, then check if its fieldType belongs to Enum
-                // if not get the object and make recursive check till no more objects are found
-                if (scalarTypes.indexOf(fieldType) <= -1) {
-                    enumMap = recursiveEnumCheck(fieldType, enumMap, fieldName, []);
-                }
-            }
-        }
-    }
-    for (let [key, val] of enumMap) {
-        const enumNameSpace = getNameSpaceTypeName(key);
-        if (enumNameSpace && typeof enumNameSpace === 'string') {
-            const enumTyping = getTyping(enumNameSpace);
-            const enumIntMapping = (enumTyping === null || enumTyping === void 0 ? void 0 : enumTyping.meta).value;
-            if (enumIntMapping && _.isArray(enumIntMapping) && enumIntMapping.length > 0) {
-                // val refers to property name
-                updateJSON(val, enumIntMapping, req);
-            }
-        }
-    }
-    return req;
-};
-export const capitalize = (s) => {
-    return s.substring(0, 1).toUpperCase() + s.substring(1);
-};
-export const snakeToCamel = (s) => {
-    return s
-        .split('_')
-        .map((word, i) => {
-        if (i === 0) {
-            // if first symbol is "_" then skip it
-            return word ? word[0] + word.substring(1).toLowerCase() : '';
-        }
-        else {
-            return capitalize(word.toLowerCase());
-        }
-    })
-        .join('');
-};
-export const camelToSnake = (serviceName) => {
-    // convert camel case to snake case
-    serviceName = serviceName.replace(/(?:^|\.?)([A-Z])/g, (x, y) => { return '_' + y.toLowerCase(); }).replace(/^_/, '');
-    return serviceName;
-};
-export const getServiceName = (serviceName) => {
-    return serviceName.endsWith('Service') ? camelToSnake(serviceName.substr(0, serviceName.length - 7)) : camelToSnake(serviceName);
-};
-export const camelCase = (s) => s.substring(0, 1).toLowerCase() + s.substring(1);
-export let useSubscriptions = false;
-export const setUseSubscriptions = (value) => useSubscriptions = value;

package/dist/gql/types/AccessControlTypes.d.ts

@@ -1,6 +0,0 @@
-import { GraphQLObjectType, GraphQLInputObjectType, GraphQLEnumType } from 'graphql';
-export declare const AccessControlEffectType: GraphQLEnumType;
-export declare const AccessControlDecisionType: GraphQLEnumType;
-export declare const AttributeType: GraphQLObjectType<any, any>;
-export declare const AttributeInputType: GraphQLInputObjectType;
-export declare const AccessControlTargetType: GraphQLObjectType<any, any>;

package/dist/gql/types/AccessControlTypes.js

@@ -1,97 +0,0 @@
-import { GraphQLObjectType, GraphQLInputObjectType, GraphQLString, GraphQLEnumType, GraphQLList, GraphQLNonNull } from 'graphql';
-// export const AccessControlnputTargetType = new GraphQLInputObjectType({
-//   name: 'AccessControlnputTargetType',
-//   description: 'Generic command resource.',
-//   fields: () => ({
-//     subject: {
-//       type: new GraphQLList(InputAttribute),
-//       description: 'Entity requesting access.',
-//     },
-//     resources: {
-//       type: new GraphQLList(InputAttribute),
-//       description: 'Targeted resources',
-//     },
-//     action: {
-//       type: new GraphQLList(InputAttribute),
-//       description: 'Targeted action',
-//     },
-//   }),
-// });
-export const AccessControlEffectType = new GraphQLEnumType({
-    name: 'AccessControlEffect',
-    description: 'Effect resulting from a rule, policy or policy set',
-    values: {
-        PERMIT: {
-            value: 'PERMIT',
-            description: 'Permit operation',
-        },
-        DENY: {
-            value: 'DENY',
-            description: 'Deny operation',
-        },
-    }
-});
-export const AccessControlDecisionType = new GraphQLEnumType({
-    name: 'AccessControlDecision',
-    description: 'Decision from an access control response',
-    values: {
-        PERMIT: {
-            value: 'PERMIT',
-            description: 'Permit operation',
-        },
-        DENY: {
-            value: 'DENY',
-            description: 'Deny operation',
-        },
-        INDETERMINATE: {
-            value: 'INDETERMINATE',
-            description: 'Indeterminate result (no targets are applicable to request)',
-        }
-    }
-});
-export const AttributeType = new GraphQLObjectType({
-    name: 'Attribute',
-    description: 'An ID-value attribute',
-    fields: () => ({
-        id: {
-            type: new GraphQLNonNull(GraphQLString),
-            description: 'Attribute ID'
-        },
-        value: {
-            type: new GraphQLNonNull(GraphQLString),
-            description: 'Attribute value'
-        }
-    })
-});
-export const AttributeInputType = new GraphQLInputObjectType({
-    name: 'InputAttribute',
-    description: 'Attribute from a Target property',
-    fields: () => ({
-        id: {
-            type: new GraphQLNonNull(GraphQLString),
-            description: 'Attribute ID',
-        },
-        value: {
-            type: new GraphQLNonNull(GraphQLString),
-            description: 'Attribute value'
-        }
-    })
-});
-export const AccessControlTargetType = new GraphQLObjectType({
-    name: 'AccessControlTarget',
-    description: 'Generic command resource.',
-    fields: () => ({
-        subject: {
-            type: new GraphQLList(AttributeType),
-            description: 'Entity requesting access.',
-        },
-        resources: {
-            type: new GraphQLList(AttributeType),
-            description: 'Targeted resources',
-        },
-        action: {
-            type: new GraphQLList(AttributeType),
-            description: 'Targeted action',
-        },
-    }),
-});

package/dist/gql/types/DateType.d.ts

@@ -1,2 +0,0 @@
-import { GraphQLScalarType } from 'graphql';
-export declare const DateType: GraphQLScalarType<any, Date | null>;

package/dist/gql/types/DateType.js

@@ -1,29 +0,0 @@
-import { GraphQLScalarType } from 'graphql';
-import { Kind } from 'graphql/language/index.js';
-export const DateType = new GraphQLScalarType({
-    name: 'Date',
-    description: 'Date custom scalar type',
-    parseValue: (value) => {
-        if (value === 0) {
-            return null;
-        }
-        return new Date(value);
-    },
-    serialize: (value) => {
-        // This is the object received back from the DB
-        if (value === 0) {
-            return null;
-        }
-        let dateObj = new Date(value);
-        return dateObj;
-    },
-    parseLiteral: (ast) => {
-        if (ast.kind === Kind.STRING) {
-            if (ast.value === '0') {
-                return null;
-            }
-            return (new Date(ast.value)).getTime();
-        }
-        return null;
-    },
-});

package/dist/gql/types/FilterType.d.ts

@@ -1,2 +0,0 @@
-import { GraphQLInputObjectType } from 'graphql';
-export declare const FilterOptionsInputType: GraphQLInputObjectType;

package/dist/gql/types/FilterType.js

@@ -1,72 +0,0 @@
-import { GraphQLInputObjectType, GraphQLString, GraphQLEnumType, GraphQLNonNull } from 'graphql';
-const FilterOperationEnumType = new GraphQLEnumType({
-    name: 'FilterOperationEnumType',
-    description: 'Filters the fields based on the operation specified',
-    values: {
-        lt: {
-            value: 'lt',
-            description: 'Filter fields lesser than the the specified value',
-        },
-        lte: {
-            value: 'lte',
-            description: 'Filter fields lesser than or equal to the the specified value',
-        },
-        gt: {
-            value: 'gt',
-            description: 'Filter fields greater than the the specified value',
-        },
-        gte: {
-            value: 'gte',
-            description: 'Filter fields greater than or equal to the the specified value',
-        },
-        eq: {
-            value: 'eq',
-            description: 'Filter fields exactly equal to the the specified value',
-        },
-        isEmpty: {
-            value: 'isEmpty',
-            description: 'Filter fields exactly equal to the the specified value',
-        },
-    }
-});
-const FilterFieldValueEnumType = new GraphQLEnumType({
-    name: 'FilterFieldValueEnumType',
-    description: '',
-    values: {
-        STRING: {
-            value: 'string'
-        },
-        BOOLEAN: {
-            value: 'boolean'
-        },
-        NUMBER: {
-            value: 'number'
-        },
-        DATE: {
-            value: 'date'
-        }
-    }
-});
-export const FilterOptionsInputType = new GraphQLInputObjectType({
-    name: 'FilterOptionsInputType',
-    description: 'Filter options',
-    fields: {
-        field: {
-            type: new GraphQLNonNull(GraphQLString),
-            description: 'Field names based on which the filtering needs to be done',
-        },
-        operation: {
-            type: new GraphQLNonNull(FilterOperationEnumType),
-            description: 'Filter Operation options',
-        },
-        value: {
-            type: new GraphQLNonNull(GraphQLString),
-            description: 'Field value',
-        },
-        type: {
-            type: FilterFieldValueEnumType,
-            description: 'Value type (optional, default is STRING)',
-            defaultValue: 'string'
-        }
-    }
-});

package/dist/gql/types/MetaType.d.ts

@@ -1,2 +0,0 @@
-import { GraphQLObjectType } from 'graphql';
-export declare const MetaType: GraphQLObjectType<any, any>;

package/dist/gql/types/MetaType.js

@@ -1,25 +0,0 @@
-import { GraphQLObjectType, GraphQLString, GraphQLList, GraphQLNonNull } from 'graphql';
-import { DateType } from './DateType.js';
-import { AttributeType } from './AccessControlTypes.js';
-export const MetaType = new GraphQLObjectType({
-    name: 'MetaType',
-    description: 'Meta info common to all resources',
-    fields: () => ({
-        created: {
-            type: new GraphQLNonNull(DateType),
-            description: 'Creation timestamp',
-        },
-        modified: {
-            type: new GraphQLNonNull(DateType),
-            description: 'Last-modification timestamp',
-        },
-        modified_by: {
-            type: GraphQLString,
-            description: 'UUID from last User who modified the resource',
-        },
-        owner: {
-            type: new GraphQLList(new GraphQLNonNull(AttributeType)),
-            description: 'A list of attributes describing the owner\'s entities',
-        }
-    }),
-});

package/dist/gql/types/ScopeType.d.ts

@@ -1,2 +0,0 @@
-import { GraphQLInputObjectType } from 'graphql';
-export declare const ScopeInputType: GraphQLInputObjectType;

package/dist/gql/types/ScopeType.js

@@ -1,13 +0,0 @@
-import { GraphQLInputObjectType, GraphQLString } from 'graphql';
-export const ScopeInputType = new GraphQLInputObjectType({
-    name: 'ScopeInputType',
-    description: 'A role scope',
-    fields: () => ({
-        entity: {
-            type: GraphQLString,
-        },
-        instance: {
-            type: GraphQLString,
-        }
-    }),
-});

package/dist/gql/types/SortType.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLInputObjectType, GraphQLEnumType } from 'graphql';
-export declare const SortEnumType: GraphQLEnumType;
-export declare const SortInputType: GraphQLInputObjectType;

package/dist/gql/types/SortType.js

@@ -1,30 +0,0 @@
-import { GraphQLInputObjectType, GraphQLString, GraphQLEnumType, GraphQLNonNull } from 'graphql';
-export const SortEnumType = new GraphQLEnumType({
-    name: 'SortEnumType',
-    description: 'Sorts the fields in either Ascending or Descending order',
-    values: {
-        ASC: {
-            value: 'asc',
-            description: 'Sort in Ascending order',
-        },
-        DESC: {
-            value: 'desc',
-            description: 'Sort in Descending order',
-        },
-    }
-});
-export const SortInputType = new GraphQLInputObjectType({
-    name: 'SortInputType',
-    description: 'For sotring based on fileds',
-    fields: () => ({
-        field: {
-            type: new GraphQLNonNull(GraphQLString),
-            description: 'Field names to be sorted on',
-        },
-        order: {
-            type: SortEnumType,
-            description: 'Sorting Options',
-            defaultValue: 'asc'
-        },
-    }),
-});

package/dist/gql/types/StatusType.d.ts

@@ -1,2 +0,0 @@
-import { GraphQLObjectType } from 'graphql';
-export declare const OperationStatusType: GraphQLObjectType<any, any>;

package/dist/gql/types/StatusType.js

@@ -1,15 +0,0 @@
-import { GraphQLObjectType, GraphQLString, GraphQLNonNull, GraphQLInt } from 'graphql';
-export const OperationStatusType = new GraphQLObjectType({
-    name: 'StatusType',
-    description: 'Objects with error returned for GraphQL operations',
-    fields: () => ({
-        code: {
-            type: new GraphQLNonNull(GraphQLInt),
-            description: 'Status code',
-        },
-        message: {
-            type: GraphQLString,
-            description: 'Status message description',
-        }
-    }),
-});

package/dist/gql/types/index.d.ts

@@ -1,7 +0,0 @@
-export * from './AccessControlTypes.js';
-export * from './DateType.js';
-export * from './FilterType.js';
-export * from './MetaType.js';
-export * from './ScopeType.js';
-export * from './SortType.js';
-export * from './StatusType.js';

package/dist/gql/types/index.js

@@ -1,7 +0,0 @@
-export * from './AccessControlTypes.js';
-export * from './DateType.js';
-export * from './FilterType.js';
-export * from './MetaType.js';
-export * from './ScopeType.js';
-export * from './SortType.js';
-export * from './StatusType.js';

package/dist/index.d.ts

@@ -1,66 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import { type Logger } from 'winston';
-import { type Server, ServerResponse } from 'node:http';
-import Koa from 'koa';
-import { type AddressInfo } from 'node:net';
-import { type Facade, type FacadeBaseContext, type FacadeModule, type FacadeModuleBase, type FacadeModulesContext, FileUploadOptionsConfig } from './interfaces.js';
-import { type KafkaProviderConfig } from '@restorecommerce/kafka-client';
-export * from './modules/index.js';
-export * from './middlewares/index.js';
-export * from './interfaces.js';
-export * from './utils.js';
-export * from './gql/index.js';
-interface RestoreCommerceFacadeImplConfig {
-    koa: Koa<any, any>;
-    logger: Logger;
-    port?: number;
-    hostname?: string;
-    env?: string;
-    kafka?: KafkaProviderConfig['kafka'];
-    fileUploadOptions?: FileUploadOptionsConfig['fileUploadOptions'];
-}
-export declare class RestoreCommerceFacade<TModules extends FacadeModuleBase[] = []> implements Facade<TModules> {
-    private apolloServices;
-    private allResolvers;
-    private _server?;
-    private _initialized;
-    readonly logger: Logger;
-    readonly port: number;
-    readonly hostname: string;
-    readonly koa: Koa<any, FacadeModulesContext<TModules>>;
-    readonly env: string;
-    readonly modules: FacadeModule[];
-    readonly kafkaConfig?: KafkaProviderConfig['kafka'];
-    readonly fileUploadOptionsConfig?: FileUploadOptionsConfig['fileUploadOptions'];
-    private startFns;
-    private stopFns;
-    constructor({ koa, logger, port, hostname, env, kafka, fileUploadOptions }: RestoreCommerceFacadeImplConfig);
-    get server(): Server<typeof import("http").IncomingMessage, typeof ServerResponse> | undefined;
-    get address(): AddressInfo | undefined;
-    get listening(): boolean;
-    useMiddleware<TNewState extends object = {}, TNewContext extends object = {}>(middleware: Koa.Middleware<TNewState, TNewContext>): any;
-    useModule<TNewModule extends FacadeModule>(module: TNewModule): any;
-    supportsModule<TSupportedModule extends FacadeModuleBase<FacadeBaseContext>>(module: TSupportedModule): this is Facade<[TSupportedModule, ...TModules]> & Facade<[...TModules]>;
-    addApolloService({ name, schema, url }: {
-        name: string;
-        schema: any;
-        url: string;
-    }): void;
-    onStart(fn: () => Promise<void>): void;
-    onStop(fn: () => Promise<void>): void;
-    private runFnQueue;
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    private mountApolloServer;
-}
-export interface FacadeConfig {
-    port?: number;
-    logger?: Logger;
-    hostname?: string;
-    env?: string;
-    keys?: string[];
-    kafka?: KafkaProviderConfig['kafka'];
-    fileUploadOptions?: FileUploadOptionsConfig['fileUploadOptions'];
-}
-export declare const createFacade: (config: FacadeConfig) => Facade;