synapse-react-client 3.1.24 → 3.1.25

package/dist/utils/hooks/SynapseAPI/entity/queryKeys.d.ts

@@ -1,93 +0,0 @@
-import { QueryClient } from 'react-query';
-import { EntityBundleRequest, EntityChildrenRequest, QueryBundleRequest } from '../../../synapseTypes';
-/**
- * Co-location of react-query keys for queries related to Synapse entity data. Two objectives of this strategy are
- * - minimize the risk of inappropriate cache key collisions
- * - simplify clearing the approprate query caches when the entity data is updated
- *
- * For more information, see https://tkdodo.eu/blog/leveraging-the-query-function-context
- */
-export declare const entityQueryKeys: {
-    /** Query key for all entities */
-    all: {
-        objectType: string;
-    }[];
-    entity: (id: string) => {
-        id: string;
-        objectType: string;
-    }[];
-    version: (id: string, versionNumber?: string | number) => {
-        versionNumber: string | number | undefined;
-        id: string;
-        objectType: string;
-    }[];
-    versions: (id: string) => {
-        scope: string;
-        id: string;
-        objectType: string;
-    }[];
-    versionsQuery: (id: string, limit: number, offset: number) => {
-        versionQuery: {
-            limit: number;
-            offset: number;
-        };
-        scope: string;
-        id: string;
-        objectType: string;
-    }[];
-    json: (id: string) => {
-        scope: string;
-        id: string;
-        objectType: string;
-    }[];
-    path: (id: string) => {
-        scope: string;
-        id: string;
-        objectType: string;
-    }[];
-    bundle: (id: string, versionNumber: string | number | undefined, bundleRequest: EntityBundleRequest) => {
-        scope: string;
-        entityBundleRequest: EntityBundleRequest;
-        versionNumber: string | number | undefined;
-        id: string;
-        objectType: string;
-    }[];
-    children: (request: EntityChildrenRequest, infinite: boolean) => {
-        scope: string;
-        isInfinite: boolean;
-        entityChildrenRequest: EntityChildrenRequest;
-        id: string;
-        objectType: string;
-    }[];
-    tableQueryResult: (queryBundleRequest: QueryBundleRequest, infinite: boolean) => {
-        scope: string;
-        isInfinite: boolean;
-        tableQueryBundleRequest: QueryBundleRequest;
-        id: string;
-        objectType: string;
-    }[];
-    tableQueryResultWithAsyncStatus: (queryBundleRequest: QueryBundleRequest, infinite: boolean) => {
-        scope: string;
-        isInfinite: boolean;
-        tableQueryBundleRequest: QueryBundleRequest;
-        id: string;
-        objectType: string;
-    }[];
-    fullTableQueryResult: (queryBundleRequest: QueryBundleRequest) => {
-        scope: string;
-        tableQueryBundleRequest: QueryBundleRequest;
-        id: string;
-        objectType: string;
-    }[];
-    boundJSONSchema: (id: string) => {
-        scope: string;
-        id: string;
-        objectType: string;
-    }[];
-    schemaValidationResults: (id: string) => {
-        scope: string;
-        id: string;
-        objectType: string;
-    }[];
-};
-export declare function invalidateAllQueriesForEntity(queryClient: QueryClient, id: string): Promise<void>;

package/dist/utils/hooks/SynapseAPI/entity/queryKeys.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.invalidateAllQueriesForEntity = exports.entityQueryKeys = void 0;
-var tslib_1 = require("tslib");
-/**
- * Co-location of react-query keys for queries related to Synapse entity data. Two objectives of this strategy are
- * - minimize the risk of inappropriate cache key collisions
- * - simplify clearing the approprate query caches when the entity data is updated
- *
- * For more information, see https://tkdodo.eu/blog/leveraging-the-query-function-context
- */
-exports.entityQueryKeys = {
-    /** Query key for all entities */
-    all: [{ objectType: 'entity' }],
-    // Data for an entity
-    entity: function (id) { return [tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.all[0]), { id: id })]; },
-    // Data for a particular version of an entity
-    version: function (id, versionNumber) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(id)[0]), { versionNumber: versionNumber }),
-    ]; },
-    // List of Entity Versions
-    versions: function (id) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(id)[0]), { scope: 'versions' }),
-    ]; },
-    versionsQuery: function (id, limit, offset) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.versions(id)[0]), { versionQuery: {
-                limit: limit,
-                offset: offset,
-            } }),
-    ]; },
-    // JSON Representation of an entity
-    json: function (id) { return [tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(id)[0]), { scope: 'json' })]; },
-    // Entity path
-    path: function (id) { return [tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(id)[0]), { scope: 'path' })]; },
-    // Entity bundle
-    bundle: function (id, versionNumber, bundleRequest) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.version(id, versionNumber)[0]), { scope: 'entityBundle', entityBundleRequest: bundleRequest }),
-    ]; },
-    children: function (request, infinite) {
-        var _a;
-        return [
-            tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity((_a = request.parentId) !== null && _a !== void 0 ? _a : 'root')[0]), { scope: 'children', isInfinite: infinite, entityChildrenRequest: request }),
-        ];
-    },
-    tableQueryResult: function (queryBundleRequest, infinite) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(queryBundleRequest.entityId)[0]), { scope: 'tableQueryResult', isInfinite: infinite, tableQueryBundleRequest: queryBundleRequest }),
-    ]; },
-    tableQueryResultWithAsyncStatus: function (queryBundleRequest, infinite) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(queryBundleRequest.entityId)[0]), { scope: 'tableQueryResultWithAsyncStatus', isInfinite: infinite, tableQueryBundleRequest: queryBundleRequest }),
-    ]; },
-    fullTableQueryResult: function (queryBundleRequest) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(queryBundleRequest.entityId)[0]), { scope: 'fullTableQueryResult', tableQueryBundleRequest: queryBundleRequest }),
-    ]; },
-    boundJSONSchema: function (id) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(id)[0]), { scope: 'boundJSONSchema' }),
-    ]; },
-    schemaValidationResults: function (id) { return [
-        tslib_1.__assign(tslib_1.__assign({}, exports.entityQueryKeys.entity(id)[0]), { scope: 'schemaValidationResults' }),
-    ]; },
-};
-function invalidateAllQueriesForEntity(queryClient, id) {
-    // TODO: Figure out how to handle cases where the change can affect other entities.
-    // Some examples:
-    //  - deleting an entity should invalidate the parent's children
-    //  - moving an entity should invalidate the old and new parent's children
-    return queryClient.invalidateQueries(exports.entityQueryKeys.entity(id));
-}
-exports.invalidateAllQueriesForEntity = invalidateAllQueriesForEntity;
-//# sourceMappingURL=queryKeys.js.map

package/dist/utils/hooks/SynapseAPI/entity/queryKeys.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"queryKeys.js","sourceRoot":"","sources":["../../../../../src/lib/utils/hooks/SynapseAPI/entity/queryKeys.ts"],"names":[],"mappings":";;;;AAOA;;;;;;GAMG;AACU,QAAA,eAAe,GAAG;IAC7B,iCAAiC;IACjC,GAAG,EAAE,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;IAC/B,qBAAqB;IACrB,MAAM,EAAE,UAAC,EAAU,IAAK,OAAA,uCAAM,uBAAe,CAAC,GAAG,CAAC,CAAC,CAAC,KAAE,EAAE,EAAE,EAAE,IAAG,EAAvC,CAAuC;IAC/D,6CAA6C;IAC7C,OAAO,EAAE,UAAC,EAAU,EAAE,aAA+B,IAAK,OAAA;8CAEnD,uBAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAChC,aAAa,EAAE,aAAa;KAE/B,EALyD,CAKzD;IAED,0BAA0B;IAC1B,QAAQ,EAAE,UAAC,EAAU,IAAK,OAAA;8CAEnB,uBAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAChC,KAAK,EAAE,UAAU;KAEpB,EALyB,CAKzB;IACD,aAAa,EAAE,UAAC,EAAU,EAAE,KAAa,EAAE,MAAc,IAAK,OAAA;8CAEvD,uBAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAClC,YAAY,EAAE;gBACZ,KAAK,EAAE,KAAK;gBACZ,MAAM,EAAE,MAAM;aACf;KAEJ,EAR6D,CAQ7D;IAED,mCAAmC;IACnC,IAAI,EAAE,UAAC,EAAU,IAAK,OAAA,uCAAM,uBAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAE,KAAK,EAAE,MAAM,IAAG,EAArD,CAAqD;IAE3E,cAAc;IACd,IAAI,EAAE,UAAC,EAAU,IAAK,OAAA,uCAAM,uBAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAE,KAAK,EAAE,MAAM,IAAG,EAArD,CAAqD;IAE3E,gBAAgB;IAChB,MAAM,EAAE,UACN,EAAU,EACV,aAA0C,EAC1C,aAAkC,IAC/B,OAAA;8CAEE,uBAAe,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,KAChD,KAAK,EAAE,cAAc,EACrB,mBAAmB,EAAE,aAAa;KAErC,EANI,CAMJ;IAED,QAAQ,EAAE,UAAC,OAA8B,EAAE,QAAiB;;QAAK,OAAA;kDAE1D,uBAAe,CAAC,MAAM,CAAC,MAAA,OAAO,CAAC,QAAQ,mCAAI,MAAM,CAAC,CAAC,CAAC,CAAC,KACxD,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,QAAQ,EACpB,qBAAqB,EAAE,OAAO;SAEjC,CAAA;KAAA;IAED,gBAAgB,EAAE,UAChB,kBAAsC,EACtC,QAAiB,IACd,OAAA;8CAEE,uBAAe,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KACzD,KAAK,EAAE,kBAAkB,EACzB,UAAU,EAAE,QAAQ,EACpB,uBAAuB,EAAE,kBAAkB;KAE9C,EAPI,CAOJ;IAED,+BAA+B,EAAE,UAC/B,kBAAsC,EACtC,QAAiB,IACd,OAAA;8CAEE,uBAAe,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KACzD,KAAK,EAAE,iCAAiC,EACxC,UAAU,EAAE,QAAQ,EACpB,uBAAuB,EAAE,kBAAkB;KAE9C,EAPI,CAOJ;IAED,oBAAoB,EAAE,UAAC,kBAAsC,IAAK,OAAA;8CAE3D,uBAAe,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KACzD,KAAK,EAAE,sBAAsB,EAC7B,uBAAuB,EAAE,kBAAkB;KAE9C,EANiE,CAMjE;IAED,eAAe,EAAE,UAAC,EAAU,IAAK,OAAA;8CAE1B,uBAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAChC,KAAK,EAAE,iBAAiB;KAE3B,EALgC,CAKhC;IAED,uBAAuB,EAAE,UAAC,EAAU,IAAK,OAAA;8CAElC,uBAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAChC,KAAK,EAAE,yBAAyB;KAEnC,EALwC,CAKxC;CACF,CAAA;AAED,SAAgB,6BAA6B,CAC3C,WAAwB,EACxB,EAAU;IAEV,mFAAmF;IACnF,iBAAiB;IACjB,gEAAgE;IAChE,0EAA0E;IAC1E,OAAO,WAAW,CAAC,iBAAiB,CAAC,uBAAe,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;AAClE,CAAC;AATD,sEASC"}