@flatfile/sdk - npm Package Compare versions

Comparing version 2.0.0-rc1 to 2.0.0-rc10

dist/errors/FlatfileError.d.ts

 export declare class FlatfileError extends Error {
     code: string;
     debug: string;
+    name: string;
     userMessage: string;
     constructor(message?: string);
 }

dist/Flatfile.d.ts

@@ -1,26 +0,42 @@
-import { ApiService } from './graphql/api';
-import { ImportSession } from './importer/ImportSession';
-import { IEvents, IFlatfileConfig, IFlatfileImporterConfig, IRawToken, JsonWebToken } from './types';
-import { TypedEventManager } from './utils/TypedEventManager';
+import { FlatfileError } from './errors/FlatfileError';
+import { ApiService } from './graphql/ApiService';
+import { IChunkOptions, ImportSession } from './importer/ImportSession';
+import { IteratorCallback } from './lib/RecordChunkIterator';
+import { TypedEventManager } from './lib/TypedEventManager';
+import { UIService } from './service/UIService';
+import { IEvents, IFlatfileConfig, IFlatfileImporterConfig, IImportSessionConfig, IRawToken, JsonWebToken } from './types';
 export declare class Flatfile extends TypedEventManager<IEvents> {
     /**
+     * The configuration of this instance of Flatfile with defaults merged in
+     */
+    readonly config: IFlatfileConfig;
+    /**
      * Reference to a pre-authenticated instance of the API service
      */
-    readonly api: ApiService;
+    api?: ApiService;
+    ui: UIService;
+    constructor(config: IFlatfileImporterConfig);
+    constructor(token: string, config: IFlatfileImporterConfig);
     /**
-     * The configuration of this instance of Flatfile with defaults merged in
+     * Returns / resolves a token or generates a JWT from embedId, user & org
      */
-    readonly config: IFlatfileConfig;
+    token(): Promise<JsonWebToken>;
+    private extractToken;
     /**
-     * JWT for securing user data while interacting with Flatfile
+     * Creates a new pre-authenticated instance of the API service
      */
-    readonly token: JsonWebToken;
-    constructor(token: JsonWebToken, config?: IFlatfileImporterConfig);
+    private initApi;
     /**
      * Start a new import or resume the one that's currently in progress
      */
-    startOrResumeImportSession(options?: {
-        open?: 'iframe' | 'window';
-    }): Promise<ImportSession>;
+    startOrResumeImportSession(options?: IOpenOptions & IChunkOptions & IImportSessionConfig): Promise<ImportSession>;
     /**
+     * Simple function that abstracts away some of the complexity for a single line call
+     * also provides some level of backwards compatability
+     */
+    requestDataFromUser(): void;
+    requestDataFromUser(opts: DataReqOptions): void;
+    requestDataFromUser(cb: IteratorCallback, opts?: DataReqOptions): void;
+    handleError(error: FlatfileError): void;
+    /**
      * Generate a token that only works for an embed development mode.
@@ -35,2 +51,7 @@ * This keeps the "hello world" effort very low but doesn't impact security.
     static getDevelopmentToken(embedId: string, body?: IRawToken, key?: string): Promise<JsonWebToken>;
+    static requestDataFromUser(options?: DataReqOptions & IFlatfileImporterConfig): void;
+    static extractImporterOptions(options: DataReqOptions & IFlatfileImporterConfig): {
+        sessionConfig: DataReqOptions;
+        importerConfig: IFlatfileImporterConfig;
+    };
     /**
@@ -44,1 +65,9 @@ * Merge in any user provided configuration with defaults.
 }
+export declare const SESSION_CONFIG_KEYS: (keyof DataReqOptions)[];
+export declare const IMPORTER_CONFIG_KEYS: (keyof IFlatfileImporterConfig)[];
+interface IOpenOptions {
+    open?: 'iframe' | 'window';
+    autoContinue?: boolean;
+}
+declare type DataReqOptions = IOpenOptions & IChunkOptions & IImportSessionConfig;
+export {};

dist/graphql/queries/GET_FINAL_DATABASE_VIEW.d.ts

@@ -1,2 +0,2 @@
-import { ELevel, ERecordStatus, TRecordData } from '../service/FlatfileRecord';
+import { ELevel, ERecordStatus, TRecordData } from '../../service/FlatfileRecord';
 export interface IRowResponse {
@@ -3,0 +3,0 @@ id: number;

dist/importer/DeprecatedImporter.d.ts

 import { Flatfile } from '../Flatfile';
+import { TypedEventManager } from '../lib/TypedEventManager';
 import { IEvents } from '../types';
-import { TypedEventManager } from '../utils/TypedEventManager';
 export declare class DeprecatedImporter extends TypedEventManager<IEvents> {
@@ -5,0 +5,0 @@ ff: Flatfile;

dist/importer/ImportFrame.d.ts

@@ -1,7 +0,13 @@
-import { ImportSession } from './ImportSession';
-export declare class ImportFrame {
-    private batch;
+import { TypedEventManager } from '../lib/TypedEventManager';
+import { UIService } from '../service/UIService';
+import { ImportSession, IUrlOptions } from './ImportSession';
+export interface IImportFrameEvents {
+    load: void;
+}
+export declare class ImportFrame extends TypedEventManager<IImportFrameEvents> {
+    private session;
+    ui: UIService;
     private $iframe?;
-    constructor(batch: ImportSession);
-    open(): this;
+    constructor(session: ImportSession);
+    open(options?: IUrlOptions): this;
     /**
@@ -12,5 +18,2 @@ * todo: handle the close better, support cleaner transition
     private createIFrameElement;
-    private initializeFlatfileWrapper;
-    private get $close();
-    private get $container();
 }

dist/importer/ImportSession.d.ts

@@ -1,13 +0,18 @@
-import { Flatfile } from '../Flatfile';
+import { Flatfile } from 'Flatfile';
+import { UIService } from 'service/UIService';
+import { ApiService } from '../graphql/ApiService';
 import { GetFinalDatabaseViewResponse } from '../graphql/queries/GET_FINAL_DATABASE_VIEW';
-import { PartialRejection } from '../graphql/service/PartialRejection';
-import { RecordsChunk } from '../graphql/service/RecordsChunk';
-import { TypedEventManager } from '../utils/TypedEventManager';
+import { IteratorCallback, RecordChunkIterator } from '../lib/RecordChunkIterator';
+import { TypedEventManager } from '../lib/TypedEventManager';
+import { TPrimitive } from '../service/FlatfileRecord';
 import { ImportFrame } from './ImportFrame';
-export declare class ImportSession extends TypedEventManager<IBatchEvents> {
+export declare class ImportSession extends TypedEventManager<IImportSessionEvents> {
     flatfile: Flatfile;
     meta: IImportMeta;
+    ui: UIService;
+    api: ApiService;
     private $iframe?;
-    batchId: string;
     constructor(flatfile: Flatfile, meta: IImportMeta);
+    get batchId(): string;
+    init(): IImportMeta;
     /**
@@ -17,4 +22,8 @@ * Open the importer in an iframe (recommended)
      */
-    openInEmbeddedIframe(): ImportFrame;
+    openInEmbeddedIframe(options?: IUrlOptions): ImportFrame;
     /**
+     * Open the import in a new window and listen for data
+     */
+    openInNewWindow(options?: IUrlOptions): Window;
+    /**
      * Returns the iframe helper, useful in more advanced implementations
@@ -24,2 +33,9 @@ */
     /**
+     * Update the environment with unsigned values
+     * @param env
+     */
+    updateEnvironment(env: Record<string, TPrimitive>): Promise<{
+        success: boolean;
+    }>;
+    /**
      * Chunk and handle data response
@@ -29,12 +45,3 @@ * @param cb
      */
-    processPendingRecords(cb: (chunk: RecordsChunk, next: (res?: PartialRejection) => void) => Promise<void> | void, options?: {
-        chunkSize?: number;
-    }): Promise<this>;
-    /**
-     * Open the import in a new window and listen for data
-     */
-    openInNewWindow(): Window;
-    /**
-     * @todo make this less lines and more readable
-     */
+    processPendingRecords(cb: IteratorCallback, options?: IChunkOptions): Promise<RecordChunkIterator>;
     private subscribeToBatchStatus;
@@ -45,6 +52,9 @@ /**
      */
-    get signedImportUrl(): string;
+    signedImportUrl(options?: IUrlOptions): string;
 }
-export interface IBatchEvents {
-    init: IImportMeta;
+export interface IImportSessionEvents {
+    init: {
+        session: ImportSession;
+        meta: IImportMeta;
+    };
     upload: {
@@ -56,2 +66,3 @@ uploadId: string;
     };
+    /** @deprecated */
     launch: {
@@ -69,5 +80,13 @@ batchId: string;
     batchId: string;
+    mountUrl?: string;
     workspaceId: string;
-    workbookId: string;
+    workbookId?: string;
     schemaIds: string[];
 }
+export interface IChunkOptions {
+    chunkSize?: number;
+    chunkTimeout?: number;
+}
+export interface IUrlOptions {
+    autoContinue?: boolean;
+}

dist/index.d.ts

 export * from './types';
-export * from './graphql/api';
 export * from './importer/DeprecatedImporter';
@@ -8,1 +7,10 @@ export * from './importer/ImportFrame';
 export * from './importer/flatfileImporter';
+export * from './graphql/ApiService';
+export * from './service/ClientResponse';
+export * from './service/FlatfileRecord';
+export * from './service/PartialRejection';
+export * from './service/RecordError';
+export * from './service/RecordMutation';
+export * from './service/RecordsChunk';
+export * from './lib/RecordChunkIterator';
+export * from './lib/serializeHook';

dist/types.d.ts

@@ -0,1 +1,4 @@
+import { IImportMeta, IImportSessionEvents, ImportSession } from 'importer/ImportSession';
+import { IteratorCallback } from 'lib/RecordChunkIterator';
+import { FlatfileError } from './errors/FlatfileError';
 import { GetFinalDatabaseViewResponse } from './graphql/queries/GET_FINAL_DATABASE_VIEW';
@@ -5,14 +8,23 @@ export interface IFlatfileImporterConfig {
     apiUrl?: string;
+    token?: JsonWebToken | (() => JsonWebToken | Promise<JsonWebToken>);
+    embedId?: string;
+    user?: IUser;
+    org?: IOrganization;
+    onError?: (payload: {
+        error: FlatfileError;
+    }) => void | Promise<void>;
 }
-export interface IFlatfileConfig {
+export interface IFlatfileConfig extends IFlatfileImporterConfig {
     mountUrl: string;
     apiUrl: string;
 }
+export interface IImportSessionConfig {
+    onInit?: (payload: IImportSessionEvents['init']) => void | Promise<void>;
+    onData?: IteratorCallback;
+    onComplete?: (payload: IImportSessionEvents['complete']) => void | Promise<void>;
+}
 export interface IEvents {
     init: {
-        batchId: string;
-        schemas: {
-            id: number;
-        }[];
-        workspaceId: string;
+        session: ImportSession;
+        meta: IImportMeta;
     };
@@ -23,3 +35,3 @@ upload: {
     error: {
-        error: Error;
+        error: FlatfileError;
     };
@@ -26,0 +38,0 @@ launch: {

package.json

 {
   "name": "@flatfile/sdk",
-  "version": "2.0.0-rc1",
+  "version": "2.0.0-rc10",
   "description": "Flatfile SDK",
@@ -37,8 +37,2 @@ "private": false,
   "license": "ISC",
-  "dependencies": {
-    "eventemitter3": "^4.0.7",
-    "graphql": "^15.5.0",
-    "graphql-request": "^3.4.0",
-    "graphql-subscriptions-client": "^0.16.0"
-  },
   "devDependencies": {
@@ -55,5 +49,6 @@ "@babel/cli": "^7.14.5",
     "@types/backo2": "^1.0.1",
-    "@types/jest": "^26.0.23",
+    "@types/jest": "^27.0.3",
     "@types/react": "^17.0.11",
     "@types/react-dom": "^17.0.8",
+    "@types/simple-mock": "^0.8.2",
     "@types/styled-components": "^5.1.10",
@@ -64,2 +59,4 @@ "@typescript-eslint/eslint-plugin": "^4.28.0",
     "babel-loader": "^8.2.2",
+    "bulma": "^0.9.3",
+    "css-loader": "^6.6.0",
     "cz-conventional-changelog": "^3.3.0",
@@ -71,13 +68,24 @@ "dotenv-webpack": "^7.0.3",
     "eslint-plugin-simple-import-sort": "^7.0.0",
+    "eventemitter3": "^4.0.7",
+    "graphql": "^15.5.0",
+    "graphql-request": "^3.4.0",
+    "graphql-subscriptions-client": "^0.16.0",
     "husky": "^6.0.0",
     "jest": "^27.0.3",
     "lint-staged": "^11.0.0",
-    "minify-graphql-loader": "^1.0.2",
+    "nock": "^13.2.2",
     "nqr": "^1.0.0",
     "prettier": "^2.3.1",
     "react": "^17.0.2",
+    "react-bulma-components": "^4.0.7",
     "react-dom": "^17.0.2",
+    "react-highlight": "^0.14.0",
+    "simple-mock": "^0.8.0",
+    "style-loader": "^3.3.1",
     "styled-components": "^5.3.0",
+    "transferable-function": "^1.0.2",
     "ts-jest": "^27.0.3",
     "tslib": "^2.3.0",
+    "typedoc": "^0.22.11",
+    "typedoc-plugin-markdown": "^3.11.12",
     "typescript": "^4.3.4",
@@ -94,2 +102,3 @@ "webpack": "^5.40.0",
     ],
+    "collectCoverage": false,
     "moduleNameMapper": {
@@ -96,0 +105,0 @@ "src/(.*)": "<rootDir>/src/$1",

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

115438

increased by30.13%

Dependency count

0

decreased by-100%

Number of package files

41

increased by41.38%

Lines of code

960

increased by86.77%

Worsened metrics

Dev dependency count

55

increased by34.15%

Dependency changes

• - Removedeventemitter3@^4.0.7

• - Removedgraphql@^15.5.0

• - Removedgraphql-request@^3.4.0

• - Removedgraphql-subscriptions-client@^0.16.0

• - Removedasynckit@0.4.0(transitive)

• - Removedbacko2@1.0.2(transitive)

• - Removedcombined-stream@1.0.8(transitive)

• - Removedcross-fetch@3.2.0(transitive)

• - Removeddelayed-stream@1.0.0(transitive)

• - Removedeventemitter3@3.1.24.0.7(transitive)

• - Removedextract-files@9.0.0(transitive)

• - Removedform-data@3.0.2(transitive)

• - Removedgraphql@15.10.1(transitive)

• - Removedgraphql-request@3.7.0(transitive)

• - Removedgraphql-subscriptions-client@0.16.4(transitive)

• - Removedmime-db@1.52.0(transitive)

• - Removedmime-types@2.1.35(transitive)

• - Removednode-fetch@2.7.0(transitive)

• - Removedsymbol-observable@1.2.0(transitive)

• - Removedtr46@0.0.3(transitive)

• - Removedwebidl-conversions@3.0.1(transitive)

• - Removedwhatwg-url@5.0.0(transitive)