@envelop/persisted-operations 4.4.1-alpha-ffbace6f.0 → 4.4.2

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/persisted-operations",
-  "version": "4.4.1-alpha-ffbace6f.0",
+  "version": "4.4.2",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "2.4.1-alpha-ffbace6f.0",
+    "@envelop/core": "^2.4.2",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "repository": {
@@ -23,7 +23,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {
@@ -37,7 +37,7 @@
     },
     "./*": {
       "require": {
-        "types": "./typings/*.d.ts",
+        "types": "./typings/*.d.cts",
         "default": "./cjs/*.js"
       },
       "import": {

package/typings/index.d.cts

@@ -0,0 +1,6 @@
+export * from './types.cjs';
+export * from './utils.cjs';
+export * from './stores/aggregated-store.cjs';
+export * from './stores/inmemory-store.cjs';
+export * from './stores/json-file-store.cjs';
+export * from './plugin.cjs';

package/typings/plugin.d.cts

@@ -0,0 +1,29 @@
+import { Plugin, DefaultContext } from '@envelop/core';
+import { PersistedOperationsFunctionStore, PersistedOperationsStore } from './types.cjs';
+export declare type UsePersistedOperationsOptions<ContextType = DefaultContext> = {
+    /**
+     * Set to `false` to allow running operations that are not available in the store.
+     * Set to `true` to allow running only persisted operations.
+     */
+    onlyPersisted?: boolean;
+    /**
+     * The store to use. You can implement a store that loads data from any source.
+     * You can even support multiple stores and implement a function that returns one of those stores based on context values.
+     */
+    store: PersistedOperationsStore | PersistedOperationsFunctionStore<ContextType>;
+    /**
+     * Function that returns the operation id, e.g. by retrieving it from cusotm properties within context
+     */
+    extractOperationId?: (context: Readonly<ContextType>) => string | undefined;
+    /**
+     * Callback function to notify consumer of missing hash match, f.i. to log, monitor and/or analise these events
+     */
+    onMissingMatch?: (context: Readonly<ContextType>, operationId: string) => void;
+};
+declare const contextProperty: unique symbol;
+export declare type PersistedOperationPluginContext = {
+    [contextProperty]: string;
+};
+export declare function readOperationId(context: PersistedOperationPluginContext): string;
+export declare const usePersistedOperations: (rawOptions: UsePersistedOperationsOptions) => Plugin<PersistedOperationPluginContext>;
+export {};

package/typings/stores/aggregated-store.d.cts

@@ -0,0 +1,7 @@
+import { DocumentNode } from 'graphql';
+import { PersistedOperationsStore } from '../types.cjs';
+export declare class AggregatedStore implements PersistedOperationsStore {
+    private stores;
+    constructor(stores: PersistedOperationsStore[]);
+    get(operationId: string): string | DocumentNode | undefined;
+}

package/typings/stores/inmemory-store.d.cts

@@ -0,0 +1,12 @@
+import { DocumentNode } from 'graphql';
+import { PersistedOperationsStore } from '../types.cjs';
+export declare type InMemoryStoreDataMap = Map<string, DocumentNode | string>;
+export declare class InMemoryStore implements PersistedOperationsStore {
+    private storeData;
+    constructor(options?: {
+        initialData?: InMemoryStoreDataMap;
+    });
+    get(operationId: string): string | DocumentNode | undefined;
+    prime(operationId: string, document: string | DocumentNode): void;
+    clear(operationId: string): void;
+}

package/typings/stores/json-file-store.d.cts

@@ -0,0 +1,9 @@
+import { DocumentNode } from 'graphql';
+import { PersistedOperationsStore } from '../types.cjs';
+export declare type JsonFileStoreDataMap = Map<string, DocumentNode | string>;
+export declare class JsonFileStore implements PersistedOperationsStore {
+    private storeData;
+    get(operationId: string): string | DocumentNode | undefined;
+    loadFromFileSync(path: string): void;
+    loadFromFile(path: string): Promise<void>;
+}

package/typings/types.d.cts

@@ -0,0 +1,12 @@
+import { DefaultContext } from '@envelop/core';
+import { DocumentNode } from 'graphql';
+export interface PersistedOperationsStore {
+    /**
+     * Transfroms a hash/id into a DocumentNode or SDL string.
+     * Prefer returning `DocumentNode` if available to avoid additional parsing phase.
+     * Return `null` in case of a store miss.
+     * @param operationId
+     */
+    get(operationId: string): string | DocumentNode | undefined;
+}
+export declare type PersistedOperationsFunctionStore<ContextType = DefaultContext> = (context: Readonly<ContextType>) => PersistedOperationsStore;

package/typings/utils.d.cts

@@ -0,0 +1,2 @@
+import { Source } from 'graphql';
+export declare function operationIdFromSource(source: string | Source): string | undefined;