feat(fdc)!: breaking change - Introduce dataConnectResult field to provide fields that were overridden when spreading data (#172)

* Fixed autocomplete

* Added tsup configuration

* Added tsconfig.json

* WIP

* First pass at angular query

* Fixed auto-reload queries

* second run-through of tanstack query

* Added comments

* Added tracking to fdc

* Removed angular changes

* Upped the required version of firebase

* updated to use 11.3.0

* Used correct enums

* reverted prelude changes

* Removed only

* completed first pass

* First pass at angular framework

* Fixed typings

* Added tracking

* Fixed testing workflow

* Fixed more tests

* Addressed comments

* Fixed react tests

* Added firebase files

* Added custom injector

* Moved firebase files outside of individual folders

* Wrote script to copy package.json

* Added missing file

* Brought back dataconnect-sdk in workspace

* removed unnecessary js files

* Updated to use workspaces

* Fix wrong reporting

* Fix runner

* Fix reading of logs

* Fix angular test

* Miscellaneous cleanup

* Fixed lockfile

* chore: Linting fixes

* chore: Update release flow

* chore: Build flow

* Moved dataconnect to dev deps

* Updated lock file

* Updated package.json to include build scripts

* Update packages/angular/package.json

Co-authored-by: Hassan Bahati  <[email protected]>

* chore: Simplify build flow

* Revert "chore: Simplify build flow"

This reverts commit c348aa4.

* Fixed generation and updated README

* Removed peer dependency on firebase

* Updated lockfile

* Removed copyToBuild file

* Added error log

* Addressed comments

* Updated biome formatting

* Moved tanstack to peer dependency

* First pass at including resultmeta

* Fixed all tests etc.

* Wrote tests for resultMeta

* Cleaned up types

* Removed TODO

* Added types

* WIP

* WIP

* Updated signatures to allow for dataConnectResult

* Rename types

* Addressed concerns

---------

Co-authored-by: Elliot Hesp <[email protected]>
Co-authored-by: Hassan Bahati <[email protected]>

Author: 3 people

dataconnect-sdk/js/default-connector/README.md

@@ -7,7 +7,7 @@ export const connectorConfig = {
 };
 
 export function createMovieRef(dcOrVars, vars) {
-  const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
+  const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true);
   dcInstance._useGeneratedSdk();
   return mutationRef(dcInstance, 'CreateMovie', inputVars);
 }
@@ -17,7 +17,7 @@ export function createMovie(dcOrVars, vars) {
 }
 
 export function upsertMovieRef(dcOrVars, vars) {
-  const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
+  const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true);
   dcInstance._useGeneratedSdk();
   return mutationRef(dcInstance, 'UpsertMovie', inputVars);
 }
@@ -27,7 +27,7 @@ export function upsertMovie(dcOrVars, vars) {
 }
 
 export function deleteMovieRef(dcOrVars, vars) {
-  const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
+  const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true);
   dcInstance._useGeneratedSdk();
   return mutationRef(dcInstance, 'DeleteMovie', inputVars);
 }
@@ -36,8 +36,28 @@ export function deleteMovie(dcOrVars, vars) {
   return executeMutation(deleteMovieRef(dcOrVars, vars));
 }
 
+export function addMetaRef(dc) {
+  const { dc: dcInstance } = validateArgs(connectorConfig, dc, undefined);
+  dcInstance._useGeneratedSdk();
+  return mutationRef(dcInstance, 'AddMeta');
+}
+
+export function addMeta(dc) {
+  return executeMutation(addMetaRef(dc));
+}
+
+export function deleteMetaRef(dcOrVars, vars) {
+  const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true);
+  dcInstance._useGeneratedSdk();
+  return mutationRef(dcInstance, 'DeleteMeta', inputVars);
+}
+
+export function deleteMeta(dcOrVars, vars) {
+  return executeMutation(deleteMetaRef(dcOrVars, vars));
+}
+
 export function listMoviesRef(dc) {
-  const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
+  const { dc: dcInstance } = validateArgs(connectorConfig, dc, undefined);
   dcInstance._useGeneratedSdk();
   return queryRef(dcInstance, 'ListMovies');
 }
@@ -47,7 +67,7 @@ export function listMovies(dc) {
 }
 
 export function getMovieByIdRef(dcOrVars, vars) {
-  const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
+  const { dc: dcInstance, vars: inputVars } = validateArgs(connectorConfig, dcOrVars, vars, true);
   dcInstance._useGeneratedSdk();
   return queryRef(dcInstance, 'GetMovieById', inputVars);
 }
@@ -56,3 +76,13 @@ export function getMovieById(dcOrVars, vars) {
   return executeQuery(getMovieByIdRef(dcOrVars, vars));
 }
 
+export function getMetaRef(dc) {
+  const { dc: dcInstance } = validateArgs(connectorConfig, dc, undefined);
+  dcInstance._useGeneratedSdk();
+  return queryRef(dcInstance, 'GetMeta');
+}
+
+export function getMeta(dc) {
+  return executeQuery(getMetaRef(dc));
+}
+

dataconnect-sdk/js/default-connector/esm/index.esm.js

@@ -12,7 +12,6 @@ exports.createMovieRef = function createMovieRef(dcOrVars, vars) {
   dcInstance._useGeneratedSdk();
   return mutationRef(dcInstance, 'CreateMovie', inputVars);
 }
-
 exports.createMovie = function createMovie(dcOrVars, vars) {
   return executeMutation(createMovieRef(dcOrVars, vars));
 };
@@ -21,7 +20,6 @@ exports.upsertMovieRef = function upsertMovieRef(dcOrVars, vars) {
   dcInstance._useGeneratedSdk();
   return mutationRef(dcInstance, 'UpsertMovie', inputVars);
 }
-
 exports.upsertMovie = function upsertMovie(dcOrVars, vars) {
   return executeMutation(upsertMovieRef(dcOrVars, vars));
 };
@@ -30,16 +28,30 @@ exports.deleteMovieRef = function deleteMovieRef(dcOrVars, vars) {
   dcInstance._useGeneratedSdk();
   return mutationRef(dcInstance, 'DeleteMovie', inputVars);
 }
-
 exports.deleteMovie = function deleteMovie(dcOrVars, vars) {
   return executeMutation(deleteMovieRef(dcOrVars, vars));
 };
+exports.addMetaRef = function addMetaRef(dc) {
+  const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
+  dcInstance._useGeneratedSdk();
+  return mutationRef(dcInstance, 'AddMeta');
+}
+exports.addMeta = function addMeta(dc) {
+  return executeMutation(addMetaRef(dc));
+};
+exports.deleteMetaRef = function deleteMetaRef(dcOrVars, vars) {
+  const { dc: dcInstance, vars: inputVars} = validateArgs(connectorConfig, dcOrVars, vars, true);
+  dcInstance._useGeneratedSdk();
+  return mutationRef(dcInstance, 'DeleteMeta', inputVars);
+}
+exports.deleteMeta = function deleteMeta(dcOrVars, vars) {
+  return executeMutation(deleteMetaRef(dcOrVars, vars));
+};
 exports.listMoviesRef = function listMoviesRef(dc) {
   const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
   dcInstance._useGeneratedSdk();
   return queryRef(dcInstance, 'ListMovies');
 }
-
 exports.listMovies = function listMovies(dc) {
   return executeQuery(listMoviesRef(dc));
 };
@@ -48,7 +60,14 @@ exports.getMovieByIdRef = function getMovieByIdRef(dcOrVars, vars) {
   dcInstance._useGeneratedSdk();
   return queryRef(dcInstance, 'GetMovieById', inputVars);
 }
-
 exports.getMovieById = function getMovieById(dcOrVars, vars) {
   return executeQuery(getMovieByIdRef(dcOrVars, vars));
 };
+exports.getMetaRef = function getMetaRef(dc) {
+  const { dc: dcInstance} = validateArgs(connectorConfig, dc, undefined);
+  dcInstance._useGeneratedSdk();
+  return queryRef(dcInstance, 'GetMeta');
+}
+exports.getMeta = function getMeta(dc) {
+  return executeQuery(getMetaRef(dc));
+};

dataconnect-sdk/js/default-connector/index.cjs.js

@@ -8,6 +8,10 @@ export type Int64String = string;
 export type DateString = string;
 
 
+export interface AddMetaData {
+  ref: Meta_Key;
+}
+
 export interface CreateMovieData {
   movie_insert: Movie_Key;
 }
@@ -18,6 +22,14 @@ export interface CreateMovieVariables {
   imageUrl: string;
 }
 
+export interface DeleteMetaData {
+  ref?: Meta_Key | null;
+}
+
+export interface DeleteMetaVariables {
+  id: UUIDString;
+}
+
 export interface DeleteMovieData {
   movie_delete?: Movie_Key | null;
 }
@@ -26,6 +38,12 @@ export interface DeleteMovieVariables {
   id: UUIDString;
 }
 
+export interface GetMetaData {
+  ref: ({
+    id: UUIDString;
+  } & Meta_Key)[];
+}
+
 export interface GetMovieByIdData {
   movie?: {
     id: UUIDString;
@@ -48,6 +66,11 @@ export interface ListMoviesData {
   } & Movie_Key)[];
 }
 
+export interface Meta_Key {
+  id: UUIDString;
+  __typename?: 'Meta_Key';
+}
+
 export interface MovieMetadata_Key {
   id: UUIDString;
   __typename?: 'MovieMetadata_Key';
@@ -68,7 +91,6 @@ export interface UpsertMovieVariables {
   imageUrl: string;
 }
 
-
 /* Allow users to create refs without passing in DataConnect */
 export function createMovieRef(vars: CreateMovieVariables): MutationRef<CreateMovieData, CreateMovieVariables>;
 /* Allow users to pass in custom DataConnect instances */
@@ -77,7 +99,6 @@ export function createMovieRef(dc: DataConnect, vars: CreateMovieVariables): Mut
 export function createMovie(vars: CreateMovieVariables): MutationPromise<CreateMovieData, CreateMovieVariables>;
 export function createMovie(dc: DataConnect, vars: CreateMovieVariables): MutationPromise<CreateMovieData, CreateMovieVariables>;
 
-
 /* Allow users to create refs without passing in DataConnect */
 export function upsertMovieRef(vars: UpsertMovieVariables): MutationRef<UpsertMovieData, UpsertMovieVariables>;
 /* Allow users to pass in custom DataConnect instances */
@@ -86,7 +107,6 @@ export function upsertMovieRef(dc: DataConnect, vars: UpsertMovieVariables): Mut
 export function upsertMovie(vars: UpsertMovieVariables): MutationPromise<UpsertMovieData, UpsertMovieVariables>;
 export function upsertMovie(dc: DataConnect, vars: UpsertMovieVariables): MutationPromise<UpsertMovieData, UpsertMovieVariables>;
 
-
 /* Allow users to create refs without passing in DataConnect */
 export function deleteMovieRef(vars: DeleteMovieVariables): MutationRef<DeleteMovieData, DeleteMovieVariables>;
 /* Allow users to pass in custom DataConnect instances */
@@ -95,6 +115,21 @@ export function deleteMovieRef(dc: DataConnect, vars: DeleteMovieVariables): Mut
 export function deleteMovie(vars: DeleteMovieVariables): MutationPromise<DeleteMovieData, DeleteMovieVariables>;
 export function deleteMovie(dc: DataConnect, vars: DeleteMovieVariables): MutationPromise<DeleteMovieData, DeleteMovieVariables>;
 
+/* Allow users to create refs without passing in DataConnect */
+export function addMetaRef(): MutationRef<AddMetaData, undefined>;
+/* Allow users to pass in custom DataConnect instances */
+export function addMetaRef(dc: DataConnect): MutationRef<AddMetaData, undefined>;
+
+export function addMeta(): MutationPromise<AddMetaData, undefined>;
+export function addMeta(dc: DataConnect): MutationPromise<AddMetaData, undefined>;
+
+/* Allow users to create refs without passing in DataConnect */
+export function deleteMetaRef(vars: DeleteMetaVariables): MutationRef<DeleteMetaData, DeleteMetaVariables>;
+/* Allow users to pass in custom DataConnect instances */
+export function deleteMetaRef(dc: DataConnect, vars: DeleteMetaVariables): MutationRef<DeleteMetaData, DeleteMetaVariables>;
+
+export function deleteMeta(vars: DeleteMetaVariables): MutationPromise<DeleteMetaData, DeleteMetaVariables>;
+export function deleteMeta(dc: DataConnect, vars: DeleteMetaVariables): MutationPromise<DeleteMetaData, DeleteMetaVariables>;
 
 /* Allow users to create refs without passing in DataConnect */
 export function listMoviesRef(): QueryRef<ListMoviesData, undefined>;
@@ -104,7 +139,6 @@ export function listMoviesRef(dc: DataConnect): QueryRef<ListMoviesData, undefin
 export function listMovies(): QueryPromise<ListMoviesData, undefined>;
 export function listMovies(dc: DataConnect): QueryPromise<ListMoviesData, undefined>;
 
-
 /* Allow users to create refs without passing in DataConnect */
 export function getMovieByIdRef(vars: GetMovieByIdVariables): QueryRef<GetMovieByIdData, GetMovieByIdVariables>;
 /* Allow users to pass in custom DataConnect instances */
@@ -113,3 +147,11 @@ export function getMovieByIdRef(dc: DataConnect, vars: GetMovieByIdVariables): Q
 export function getMovieById(vars: GetMovieByIdVariables): QueryPromise<GetMovieByIdData, GetMovieByIdVariables>;
 export function getMovieById(dc: DataConnect, vars: GetMovieByIdVariables): QueryPromise<GetMovieByIdData, GetMovieByIdVariables>;
 
+/* Allow users to create refs without passing in DataConnect */
+export function getMetaRef(): QueryRef<GetMetaData, undefined>;
+/* Allow users to pass in custom DataConnect instances */
+export function getMetaRef(dc: DataConnect): QueryRef<GetMetaData, undefined>;
+
+export function getMeta(): QueryPromise<GetMetaData, undefined>;
+export function getMeta(dc: DataConnect): QueryPromise<GetMetaData, undefined>;
+

dataconnect-sdk/js/default-connector/index.d.ts

@@ -3,4 +3,3 @@ generate:
   javascriptSdk:
     outputDir: ../../dataconnect-sdk/js/default-connector
     package: "@dataconnect/default-connector"
-    packageJsonDir: ../..

dataconnect/connector/connector.yaml

@@ -17,6 +17,15 @@ mutation DeleteMovie($id: UUID!) @auth(level: PUBLIC) {
   movie_delete(id: $id)
 }
 
+mutation AddMeta @auth(level: PUBLIC) {
+  ref: meta_insert(data: {
+    ref: ""
+  })
+}
+mutation DeleteMeta($id: UUID!) @auth(level: PUBLIC) {
+  ref: meta_delete(id: $id)
+}
+
 # # Upsert (update or insert) a user's username based on their auth.uid
 # mutation UpsertUser($username: String!) @auth(level: USER) {
 #   user_upsert(

dataconnect/connector/mutations.gql

@@ -21,6 +21,12 @@ query GetMovieById($id: UUID!) @auth(level: PUBLIC) {
   }
 }
 
+query GetMeta @auth(level: PUBLIC) {
+  ref: metas {
+    id
+  }
+}
+
 # # List all users, only admins should be able to list all users, so we use NO_ACCESS
 # query ListUsers @auth(level: NO_ACCESS) {
 #   users { id, username }

dataconnect/connector/queries.gql

@@ -34,6 +34,10 @@ type MovieMetadata @table {
   description: String
 }
 
+type Meta @table {
+  ref: String!
+}
+
 # # Reviews
 # type Review @table(name: "Reviews", key: ["movie", "user"]) {
 #   id: UUID! @default(expr: "uuidV4()")