@firebase/data-connect 0.0.1-dataconnect-preview.f2ddc3d7b

package/dist/src/logger.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { LogLevelString } from "@firebase/logger";
+export declare function setLogLevel(logLevel: LogLevelString): void;
+export declare function logDebug(msg: string): void;
+export declare function logError(msg: string): void;

package/dist/src/network/fetch.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function initializeFetch(fetchImpl: typeof fetch): void;
+export declare function dcFetch<T, U>(url: string, body: U, { signal }: AbortController, accessToken: string | null): Promise<{
+    data: T;
+    errors: Error[];
+}>;

package/dist/src/network/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './transport';

package/dist/src/network/transport/index.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
+import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
+export interface DataConnectTransport {
+    invokeQuery<T, U>(queryName: string, body?: U): PromiseLike<{
+        data: T;
+        errors: Error[];
+    }>;
+    invokeMutation<T, U>(queryName: string, body?: U): PromiseLike<{
+        data: T;
+        errors: Error[];
+    }>;
+    useEmulator(host: string, port?: number, sslEnabled?: boolean): void;
+    onTokenChanged: (token: string | null) => void;
+}
+export interface CancellableOperation<T> extends PromiseLike<{
+    data: T;
+}> {
+    cancel: () => void;
+}
+export interface QueryResponse<T> extends CancellableOperation<T> {
+}
+export interface MutationResponse<T> extends CancellableOperation<T> {
+}
+export interface Sender<T> {
+    abort: () => void;
+    send: () => Promise<T>;
+}
+export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+export * from '../../core/FirebaseAuthProvider';

package/dist/src/network/transport/rest.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { DataConnectTransport } from '.';
+import { DataConnectOptions, TransportOptions } from '../../api/DataConnect';
+import { AuthTokenProvider } from '../../core/FirebaseAuthProvider';
+export declare class RESTTransport implements DataConnectTransport {
+    private apiKey?;
+    private authProvider?;
+    private host;
+    private port;
+    private location;
+    private connectorName;
+    private secure;
+    private project;
+    private serviceName;
+    private accessToken;
+    private authInitialized_;
+    constructor(options: DataConnectOptions, apiKey?: string | undefined, authProvider?: AuthTokenProvider | undefined, transportOptions?: TransportOptions | undefined);
+    get endpointUrl(): string;
+    useEmulator(host: string, port?: number, isSecure?: boolean): void;
+    onTokenChanged(newToken: string | null): void;
+    getWithAuth(): Promise<string | null>;
+    invokeQuery: <T, U = unknown>(queryName: string, body: U) => {
+        then: <TResult1 = {
+            data: T;
+            errors: Error[];
+        }, TResult2 = never>(onfulfilled?: ((value: {
+            data: T;
+            errors: Error[];
+        }) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined) => Promise<TResult1 | TResult2>;
+    };
+    invokeMutation: <T, U = unknown>(mutationName: string, body: U) => {
+        then: <TResult1 = {
+            data: T;
+            errors: Error[];
+        }, TResult2 = never>(onfulfilled?: ((value: {
+            data: T;
+            errors: Error[];
+        }) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined) => Promise<TResult1 | TResult2>;
+        cancel: () => void;
+    };
+}

package/dist/src/register.d.ts

@@ -0,0 +1 @@
+export declare function registerDataConnect(variant?: string): void;

package/dist/src/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "0.1.2"
+    }
+  ]
+}

package/dist/src/util/encoder.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare type HmacImpl = (obj: unknown) => string;
+export declare let encoderImpl: HmacImpl;
+export declare function setEncoder(encoder: HmacImpl): void;

package/dist/src/util/map.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare function setIfNotExists<T>(map: Map<string, T>, key: string, val: T): void;

package/dist/src/util/url.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ProjectOptions, TransportOptions } from '../api/DataConnect';
+export declare function urlBuilder(projectConfig: ProjectOptions, transportOptions: TransportOptions): string;
+export declare function addToken(url: string, apiKey?: string): string;

package/dist/test/emulatorSeeder.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ReferenceType } from '../src';
+export interface SeedInfo {
+    type: ReferenceType;
+    name: string;
+}
+export declare function setupQueries(schema: string, seedInfoArray: SeedInfo[], skipSchema?: boolean): Promise<import("node-fetch").Response>;

package/dist/test/queries.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/test/util.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ConnectorConfig } from '../src';
+export declare const USE_EMULATOR = true;
+export declare const EMULATOR_PORT: string | undefined;
+export declare const CONNECTOR_NAME = "c";
+export declare const LOCATION_NAME = "l";
+export declare const SERVICE_NAME = "l";
+export declare const PROJECT_ID = "p";
+export declare function getConnectionConfig(): ConnectorConfig;
+export declare const app: import("@firebase/app").FirebaseApp;
+export declare function initDatabase(): import("../src").DataConnect;

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@firebase/data-connect",
+  "version": "0.0.1-dataconnect-preview.f2ddc3d7b",
+  "description": "",
+  "author": "Firebase <firebase-support@google.com> (https://firebase.google.com/)",
+  "main": "dist/index.node.cjs.js",
+  "browser": "dist/index.esm2017.js",
+  "module": "dist/index.esm2017.js",
+  "esm5": "dist/index.esm5.js",
+  "exports": {
+    ".": {
+      "types": "./dist/public.d.ts",
+      "node": {
+        "import": "./dist/node-esm/index.node.esm.js",
+        "require": "./dist/index.node.cjs.js"
+      },
+      "esm5": "./dist/index.esm5.js",
+      "browser": {
+        "require": "./dist/index.cjs.js",
+        "import": "./dist/index.esm2017.js"
+      },
+      "default": "./dist/index.esm2017.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore' --fix",
+    "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts'  --ignore-path '../../.gitignore'",
+    "build": "rollup -c rollup.config.js && yarn api-report",
+    "prettier": "prettier --write '*.js' '*.ts' '@(src|test)/**/*.ts'",
+    "build:deps": "lerna run --scope @firebase/'{app,data-connect}' --include-dependencies build",
+    "dev": "rollup -c -w",
+    "test": "run-p --npm-path npm lint test:emulator",
+    "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:emulator",
+    "test:all": "npm run test:node",
+    "test:browser": "karma start --single-run",
+    "test:node": "TS_NODE_FILES=true TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file src/index.node.ts --config ../../config/mocharc.node.js",
+    "test:emulator": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/dataconnect-test-runner.ts",
+    "api-report": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package data-connect --packageRoot . --typescriptDts ./dist/src/index.d.ts --rollupDts ./dist/private.d.ts --untrimmedRollupDts ./dist/internal.d.ts --publicDts ./dist/public.d.ts && yarn api-report:api-json",
+    "api-report:api-json": "rm -rf temp && api-extractor run --local --verbose",
+    "doc": "api-documenter markdown --input temp --output docs",
+    "typings:public": "node ../../scripts/build/use_typings.js ./dist/public.d.ts"
+},
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@firebase/auth-interop-types": "0.2.2",
+    "@firebase/component": "0.6.6",
+    "@firebase/logger": "0.4.1",
+    "@firebase/util": "1.9.5",
+    "tslib": "^2.1.0"
+  },
+  "devDependencies": {
+    "@firebase/app": "0.10.2",
+    "rollup": "2.79.1",
+    "rollup-plugin-typescript2": "0.31.2",
+    "typescript": "4.7.4"
+  },
+  "repository": {
+    "directory": "packages/data-connect",
+    "type": "git",
+    "url": "https://github.com/firebase/firebase-js-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/firebase/firebase-js-sdk/issues"
+  },
+  "typings": "dist/src/index.d.ts",
+  "nyc": {
+    "extension": [
+      ".ts"
+    ],
+    "reportDir": "./coverage/node"
+  }
+}