@friggframework/core 0.2.31-v1-alpha-package-update.0 → 1.0.1-canary.278.7b20420.0

package/types/module-plugin/index.d.ts

@@ -0,0 +1,293 @@
+declare module "@friggframework/module-plugin" {
+  import { Model } from "mongoose";
+  import { Delegate, IFriggDelegate } from "@friggframework/core";
+
+  export class Credential extends Model {
+    userId: string;
+    auth_is_valid: boolean;
+    subType: string;
+    externalId: string;
+  }
+
+  export class EntityManager implements IFriggEntityManager {
+    static primaryEntityClass: any;
+    static entityManagerClasses: any[];
+    static entityTypes: string[];
+    static getEntitiesForUser(userId: string): Promise<any[]>;
+    static checkIsValidType(entityType: string): boolean;
+    static getEntityManagerClass(entityType?: string): any;
+
+    static getEntityManagerInstanceFromEntityId(
+      entityId: string,
+      userId: string
+    ): Promise<any>;
+  }
+
+  interface IFriggEntityManager {}
+
+  export class Entity extends Model {
+    credentialId: string;
+    subType: string;
+    userId: string;
+    name: string;
+    externalId: string;
+  }
+
+  export type MappedEntity = Entity & { id: string; type: any };
+  export class ModuleManager extends Delegate implements IFriggModuleManager {
+    static Entity: Entity;
+    static Credential: Credential;
+
+    constructor(params: { userId: string });
+
+    static getName(): any;
+    static getInstance(params: any): Promise<any>;
+    static getEntitiesForUserId(userId: string): Promise<MappedEntity[]>;
+
+    batchCreateSyncObjects(syncObjects: any, syncManager: any): Promise<any>;
+    batchUpdateSyncObjects(syncObjects: any, syncManager: any): Promise<any>;
+    findOrCreateEntity(params: any): Promise<any>;
+    getAllSyncObjects(SyncClass: any): Promise<any>;
+    getAuthorizationRequirements(params: any): Promise<any>;
+    getEntityId(): Promise<string>;
+    getEntityOptions(): Promise<any>;
+    markCredentialsInvalid(): Promise<Credential>;
+    processAuthorizationCallback(params: any): Promise<any>;
+    testAuth(params: any): Promise<any>;
+    validateAuthorizationRequirements(): Promise<boolean>;
+  }
+
+  interface IFriggModuleManager extends IFriggDelegate {
+    getEntityId(): Promise<string>;
+    validateAuthorizationRequirements(): Promise<boolean>;
+    getAuthorizationRequirements(params: any): Promise<any>;
+    testAuth(params: any): Promise<any>;
+    processAuthorizationCallback(params: any): Promise<any>;
+    getEntityOptions(): Promise<any>;
+    findOrCreateEntity(params: any): Promise<any>;
+    getAllSyncObjects(SyncClass: any): Promise<any>;
+    batchCreateSyncObjects(syncObjects: any, syncManager: any): Promise<any>;
+    batchUpdateSyncObjects(syncObjects: any, syncManager: any): Promise<any>;
+    markCredentialsInvalid(): Promise<Credential>;
+  }
+
+  export class Requester implements IFriggRequester {
+    DLGT_INVALID_AUTH: string;
+    backOff: number[];
+    fetch: any;
+    isRefreshable: boolean;
+    refreshCount: number;
+
+    _delete(options: RequestOptions): Promise<any>;
+    _get(options: RequestOptions): Promise<any>;
+    _patch(options: RequestOptions): Promise<any>;
+    _post(options: RequestOptions, stringify?: boolean): Promise<any>;
+    _put(options: RequestOptions): Promise<any>;
+    _request(
+      url: string,
+      options: Omit<RequestOptions, "url">,
+      i?: number
+    ): Promise<any>;
+    parseBody(response: any): Promise<any>;
+    refreshAuth(): Promise<any>;
+
+    delegate: any;
+    delegateTypes: any[];
+
+    notify(delegateString: string, object?: any): Promise<any>;
+    receiveNotification(
+      notifier: any,
+      delegateString: string,
+      object?: any
+    ): Promise<any>;
+  }
+
+  interface IFriggRequester extends IFriggDelegate {
+    backOff: number[];
+    isRefreshable: boolean;
+    refreshCount: number;
+    DLGT_INVALID_AUTH: string;
+    fetch: any;
+
+    parseBody(response: any): Promise<any>;
+    _request(
+      url: string,
+      options: Omit<RequestOptions, "url">,
+      i?: number
+    ): Promise<any>;
+    _get(options: RequestOptions): Promise<any>;
+    _post(options: RequestOptions, stringify?: boolean): Promise<any>;
+    _patch(options: RequestOptions): Promise<any>;
+    _put(options: RequestOptions): Promise<any>;
+    _delete(options: RequestOptions): Promise<any>;
+    refreshAuth(): Promise<any>;
+  }
+
+  type RequestOptions = {
+    url: string;
+    headers?: object;
+    query?: object;
+    returnFullRes?: boolean;
+    body?: any;
+  };
+
+  type RequesterConstructor = {
+    backOff?: number[];
+    fetch?: any;
+  };
+
+  export class ApiKeyRequester
+    extends Requester
+    implements IFriggApiKeyRequester
+  {
+    API_KEY_NAME: string;
+    API_KEY_VALUE: any;
+
+    constructor(params: RequesterConstructor);
+    addAuthHeaders(headers: object): Promise<object>;
+    isAuthenticated(): boolean;
+    setApiKey(api_key: any): void;
+  }
+
+  interface IFriggApiKeyRequester extends IFriggRequester {
+    API_KEY_NAME: string;
+    API_KEY_VALUE: string;
+
+    addAuthHeaders(headers: object): Promise<object>;
+    isAuthenticated(): boolean;
+    setApiKey(api_key: string): void;
+  }
+
+  export class BasicAuthRequester
+    extends Requester
+    implements IFriggBasicAuthRequester
+  {
+    password: string;
+    username: string;
+
+    constructor(params: BasicAuthRequesterConstructor);
+    addAuthHeaders(headers: object): Promise<object>;
+    isAuthenticated(): boolean;
+    setPassword(password: string): void;
+    setUsername(username: string): void;
+  }
+
+  interface IFriggBasicAuthRequester extends IFriggRequester {
+    username: string;
+    password: string;
+
+    addAuthHeaders(headers: object): Promise<object>;
+    isAuthenticated(): boolean;
+    setUsername(username: string): void;
+    setPassword(password: string): void;
+  }
+
+  type BasicAuthRequesterConstructor = RequesterConstructor & {
+    username?: string;
+    password?: string;
+  };
+
+  export class OAuth2Requester
+    extends Requester
+    implements IFriggOAuth2Requester
+  {
+    DLGT_TOKEN_DEAUTHORIZED: string;
+    DLGT_TOKEN_UPDATE: string;
+    accessTokenExpire: any;
+    access_token: string;
+    audience: any;
+    authorizationUri: any;
+    baseURL: string;
+    client_id: string;
+    client_secret: string;
+    grant_type: string;
+    password: string;
+    redirect_uri: string;
+    refreshTokenExpire: any;
+    refresh_token: string;
+    scope: string;
+    state: any;
+    username: string;
+
+    constructor(params: OAuth2RequesterConstructor);
+
+    addAuthHeaders(headers: object): Promise<object>;
+    getAuthorizationUri(): string;
+    getTokenFromClientCredentials(): Promise<Token>;
+    getTokenFromCode(code: string): Promise<Token>;
+    getTokenFromCodeBasicAuthHeader(code: string): Promise<Token>;
+    getTokenFromUsernamePassword(): Promise<Token>;
+    isAuthenticated(): boolean;
+    refreshAccessToken(refreshTokenObject: {
+      refresh_token: string;
+    }): Promise<Token>;
+    setTokens(params: Token): Promise<void>;
+  }
+  interface IFriggOAuth2Requester extends IFriggRequester {
+    DLGT_TOKEN_UPDATE: string;
+    DLGT_TOKEN_DEAUTHORIZED: string;
+
+    grant_type?: string;
+    client_id?: string;
+    client_secret?: string;
+    redirect_uri?: string;
+    scope?: string;
+    authorizationUri?: any;
+    baseURL?: string;
+    access_token?: string;
+    refresh_token?: string;
+    accessTokenExpire?: any;
+    refreshTokenExpire?: any;
+    audience?: any;
+    username?: string;
+    password?: string;
+    state?: any;
+
+    setTokens(params: Token): Promise<void>;
+    getAuthorizationUri(): string;
+    getTokenFromCode(code: string): Promise<Token>;
+    getTokenFromCodeBasicAuthHeader(code: string): Promise<Token>;
+    refreshAccessToken(refreshTokenObject: {
+      refresh_token: string;
+    }): Promise<Token>;
+    addAuthHeaders(headers: object): Promise<object>;
+    isAuthenticated(): boolean;
+    refreshAuth(): Promise<void>;
+    getTokenFromUsernamePassword(): Promise<Token>;
+    getTokenFromClientCredentials(): Promise<Token>;
+  }
+
+  type Token = {
+    access_token?: string;
+    refresh_token?: string;
+    expires_in: any;
+    x_refresh_token_expires_in: any;
+  };
+
+  type OAuth2RequesterConstructor = {
+    grant_type?: string;
+    client_id?: string;
+    client_secret?: string;
+    redirect_uri?: string;
+    scope?: string;
+    authorizationUri?: any;
+    baseURL?: string;
+    access_token?: string;
+    refresh_token?: string;
+    accessTokenExpire?: any;
+    refreshTokenExpire?: any;
+    audience?: any;
+    username?: string;
+    password?: string;
+    state?: any;
+  };
+
+  export const ModuleConstants: {
+    authType: {
+      oauth2: "oauth2";
+      oauth1: "oauth1";
+      basic: "basic";
+      apiKey: "apiKey";
+    };
+  };
+}

package/types/prettier-config/index.d.ts

@@ -0,0 +1,6 @@
+declare module "@friggframework/prettier-config" {
+  export const semi: true;
+  export const tabWidth = 4;
+  export const singleQuote = true;
+  export const useTabs: false;
+}

package/types/syncs/index.d.ts

@@ -0,0 +1,128 @@
+declare module "@friggframework/syncs/model" {
+  import { Model } from "mongoose";
+
+  export class Sync extends Model {
+    entities: any[];
+    hash: string;
+    name: string;
+    dataIdentifiers: {
+      entity: any;
+      id: object;
+      hash: string;
+    }[];
+  }
+}
+
+declare module "@friggframework/syncs/manager" {
+  import Sync from "@friggframework/syncs/sync";
+
+  export default class SyncManager implements IFriggSyncManager {
+    ignoreEmptyMatchValues: boolean;
+    integration: any;
+    isUnidirectionalSync: boolean;
+    omitEmptyStringsFromData: boolean;
+    syncObjectClass: Sync;
+    useFirstMatchingDuplicate: boolean;
+
+    constructor(params: SyncManagerConstructor);
+    confirmCreate(
+      syncObj: Sync,
+      createdId: string,
+      moduleManager: any
+    ): Promise<any>;
+    confirmUpdate(syncObj: Sync): Promise<any>;
+    createSyncDBObject(objArr: any[], entities: any[]): Promise<any>;
+    initialSync(): Promise<void>;
+    sync(syncObjects: Sync[]): Promise<any[]>;
+  }
+
+  interface IFriggSyncManager {
+    syncObjectClass: Sync;
+    ignoreEmptyMatchValues: boolean;
+    isUnidirectionalSync: boolean;
+    useFirstMatchingDuplicate: boolean;
+    omitEmptyStringsFromData: boolean;
+    integration: any;
+
+    initialSync(): Promise<void>;
+    createSyncDBObject(objArr: any[], entities: any[]): Promise<any>;
+    sync(syncObjects: Sync[]): Promise<any[]>;
+    confirmCreate(
+      syncObj: Sync,
+      createdId: string,
+      moduleManager: any
+    ): Promise<any>;
+    confirmUpdate(syncObj: Sync): Promise<any>;
+  }
+
+  type SyncManagerConstructor = {
+    syncObjectClass: Sync;
+    ignoreEmptyMatchValues?: boolean;
+    isUnidirectionalSync?: boolean;
+    useFirstMatchingDuplicate?: boolean;
+    omitEmptyStringsFromData?: boolean;
+    integration: any;
+  };
+}
+
+declare module "@friggframework/syncs/sync" {
+  export default class Sync implements IFriggSync {
+    data: object;
+    dataIdentifier: any;
+    dataIdentifierHash: string;
+    matchHash: string;
+    missingMatchData: boolean;
+    moduleName: string;
+    syncId: string;
+    useMapping: boolean;
+
+    static Config: {
+      name: string;
+      keys: any[];
+      matchOn: any[];
+      moduleMap: object;
+      reverseModuleMap: object;
+    };
+
+    static hashJSON(data: any): string;
+
+    constructor(params: SyncConstructor);
+    dataKeyIsReplaceable(key: string): boolean;
+    equals(syncObj: IFriggSync): boolean;
+    getHashData(params: GetHashData): any;
+    getName(): string;
+    isModuleInMap(moduleName: string): any;
+    reverseModuleMap(moduleName: string): any;
+    setSyncId(syncId: string): void;
+  }
+
+  interface IFriggSync {
+    data: object;
+    moduleName: string;
+    dataIdentifier: any;
+    useMapping?: boolean;
+    dataIdentifierHash: string;
+    missingMatchData: boolean;
+    matchHash: string;
+    syncId: string;
+
+    equals(syncObj: IFriggSync): boolean;
+    dataKeyIsReplaceable(key: string): boolean;
+    isModuleInMap(moduleName: string): any;
+    getName(): string;
+    getHashData(params: GetHashData): any;
+    setSyncId(syncId: string): void;
+    reverseModuleMap(moduleName: string): any;
+  }
+
+  type SyncConstructor = {
+    data: any;
+    moduleName: string;
+    dataIdentifier: any;
+    useMapping?: boolean;
+  };
+
+  type GetHashData = {
+    omitEmptyStringsFromData?: boolean;
+  };
+}

package/types/test-environment/index.d.ts

@@ -0,0 +1,17 @@
+declare module "@friggframework/test-environment" {
+  export class TestMongo implements IFriggTestDatabase {
+    #mongoServer: any;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+  }
+
+  interface IFriggTestDatabase {
+    start(): Promise<void>;
+    stop(): Promise<void>;
+  }
+
+  export function overrideEnvironment(overrideByKey: any): void;
+  export function restoreEnvironment(): void;
+  export function globalTeardown(): Promise<void>;
+  export function globalSetup(): Promise<void>;
+}

package/types/tsconfig.json

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "lib": ["es2022"],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}